From 07e6f6889223068450e3a56ee046563f5ef0e59b Mon Sep 17 00:00:00 2001 From: Marlon Richert Date: Tue, 1 Jun 2021 13:17:29 +0300 Subject: [PATCH] Add missing node refs in contrib.yo & change Utilities subsections to sections --- Doc/Zsh/contrib.yo | 47 +++++++++++++++++++++++++++------------------- Doc/Zsh/manual.yo | 6 +++++- 2 files changed, 33 insertions(+), 20 deletions(-) diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo index a972f08d6..6861e98fd 100644 --- a/Doc/Zsh/contrib.yo +++ b/Doc/Zsh/contrib.yo @@ -10,7 +10,11 @@ these are documented here. For documentation on other contributed items such as shell functions, look for comments in the function source files. startmenu() -menu(Utilities) +menu(Accessing On-Line Help) +menu(Recompiling Functions) +menu(Keyboard Definition) +menu(Dumping Shell State) +menu(Manipulating Hook Functions) menu(Recent Directories) menu(Other Directory Functions) menu(Version Control Information) @@ -23,10 +27,8 @@ menu(User Configuration Functions) menu(Other Functions) endmenu() -texinode(Utilities)(Recent Directories)()(User Contributions) -sect(Utilities) - -subsect(Accessing On-Line Help) +texinode(Accessing On-Line Help)(Recompiling Functions)()(User Contributions) +sect(Accessing On-Line Help) cindex(helpfiles utility) The key sequence tt(ESC h) is normally bound by ZLE to execute the @@ -80,7 +82,8 @@ ifnzman(noderef(Parameters Used By The Shell))\ installation; if it is not, copy tt(Functions/Misc/run-help) to an appropriate directory. -subsect(Recompiling Functions) +texinode(Recompiling Functions)(Keyboard Definition)(Accessing On-Line Help)(User Contributions) +sect(Recompiling Functions) cindex(functions, recompiling) cindex(zrecompile utility) @@ -168,7 +171,8 @@ Once the digests have been created and your tt(fpath) modified to refer to them, you can keep them up to date by running tt(zrecompile) with no arguments. -subsect(Keyboard Definition) +texinode(Keyboard Definition)(Dumping Shell State)(Recompiling Functions)(User Contributions) +sect(Keyboard Definition) cindex(keyboard definition) findex(zkbd) @@ -211,7 +215,8 @@ ifnzman(noderef(Parameters Used By The Shell))\ installation; if it is not, copy tt(Functions/Misc/zkbd) to an appropriate directory. -subsect(Dumping Shell State) +texinode(Dumping Shell State)(Manipulating Hook Functions)(Keyboard Definition)(User Contributions) +sect(Dumping Shell State) cindex(reporter utility) Occasionally you may encounter what appears to be a bug in the shell, @@ -287,7 +292,8 @@ any prefix, even a single letter; thus tt(a) is the same as tt(aliases), tt(z) is the same as tt(zstyles), etc. enditem() -subsect(Manipulating Hook Functions) +texinode(Manipulating Hook Functions)(Recent Directories)(Dumping Shell State)(User Contributions) +sect(Manipulating Hook Functions) cindex(hook function utility) startitem() @@ -378,7 +384,7 @@ hooks, then all hooks should be managed only via this function. ) enditem() -texinode(Recent Directories)(Other Directory Functions)(Utilities)(User Contributions) +texinode(Recent Directories)(Other Directory Functions)(Manipulating Hook Functions)(User Contributions) cindex(recent directories, maintaining list of) cindex(directories, maintaining list of recent) findex(cdr) @@ -4358,9 +4364,10 @@ The return status is 0 if at least one match was performed, else 1. findex(run-help) item(tt(run-help) var(cmd))( This function is designed to be invoked by the tt(run-help) ZLE widget, -in place of the default alias. See `Accessing On-Line Help' -ifzman(above)\ -ifnzman((noderef(Utilities))) for setup instructions. +in place of the default alias. See +ifzman(see the bf(Accessing On-Line Help) section above)\ +ifnzman(noderef(Accessing On-Line Help)) +for setup instructions. In the discussion which follows, if var(cmd) is a file system path, it is first reduced to its rightmost component (the file name). @@ -4580,9 +4587,10 @@ appear in the zsh distribution, but can be created by linking tt(zmv) to the names tt(zcp) and tt(zln) in some directory in your tt(fpath). ) item(tt(zkbd))( -See `Keyboard Definition' -ifzman(above)\ -ifnzman((noderef(Utilities))). +See +ifzman(see the bf(Keyboard Definition) section above)\ +ifnzman(noderef(Keyboard Definition))\ +. ) findex(zmv) redef(SPACES)(0)(tt(ifztexi(NOTRANS(@ @ @ @ ))ifnztexi( ))) @@ -4665,9 +4673,10 @@ tt(zmv) source file, usually located in one of the directories named in your tt(fpath), or in tt(Functions/Misc/zmv) in the zsh distribution. ) item(tt(zrecompile))( -See `Recompiling Functions' -ifzman(above)\ -ifnzman((noderef(Utilities))). +See +ifzman(see the bf(Recompiling Functions) section above)\ +ifnzman(noderef(Recompiling Functions))\ +. ) findex(zstyle+) item(tt(zstyle+) var(context) var(style) var(value) [ tt(+) var(subcontext) var(style) var(value) ... ])( diff --git a/Doc/Zsh/manual.yo b/Doc/Zsh/manual.yo index 119849e4c..7fd670abe 100644 --- a/Doc/Zsh/manual.yo +++ b/Doc/Zsh/manual.yo @@ -162,7 +162,11 @@ menu(Miscellaneous Features) User Contributions -menu(Utilities) +menu(Accessing On-Line Help) +menu(Recompiling Functions) +menu(Keyboard Definition) +menu(Dumping Shell State) +menu(Manipulating Hook Functions) menu(Recent Directories) menu(Other Directory Functions) menu(Version Control Information) -- 2.30.1 (Apple Git-130)