zsh-workers/9023

23 files changed, 108 insertions, 161 deletions

diff --git a/Doc/Makefile.in b/Doc/Makefile.in
index f3122437a..41675a330 100644
--- a/Doc/Makefile.in
+++ b/Doc/Makefile.in
@@ -50,17 +50,24 @@ zshexpn.1 zshmisc.1 zshmodules.1 \
 zshoptions.1 zshparam.1 zshzftpsys.1 zshzle.1 zshall.1
 
 # yodl documentation
+
 YODLDOC = $(MAN) zsh.texi
+
+MODDOCSRC = \
+Zsh/mod_cap.yo Zsh/mod_clone.yo \
+Zsh/mod_compctl.yo Zsh/mod_complete.yo Zsh/mod_complist.yo \
+Zsh/mod_computil.yo \
+Zsh/mod_deltochar.yo Zsh/mod_example.yo Zsh/mod_files.yo \
+Zsh/mod_mapfile.yo Zsh/mod_mathfunc.yo Zsh/mod_parameter.yo Zsh/mod_sched.yo \
+Zsh/mod_stat.yo Zsh/mod_zftp.yo Zsh/mod_zle.yo Zsh/mod_zleparameter.yo \
+Zsh/mod_zutil.yo
+
 YODLSRC = zmacros.yo zman.yo ztexi.yo Zsh/arith.yo Zsh/builtins.yo \
 Zsh/compat.yo Zsh/compctl.yo Zsh/compsys.yo Zsh/compwid.yo Zsh/cond.yo \
 Zsh/exec.yo Zsh/expn.yo \
 Zsh/filelist.yo Zsh/files.yo Zsh/func.yo Zsh/grammar.yo Zsh/manual.yo \
 Zsh/index.yo Zsh/intro.yo Zsh/invoke.yo Zsh/jobs.yo Zsh/metafaq.yo \
-Zsh/modules.yo Zsh/mod_cap.yo \
-Zsh/mod_clone.yo Zsh/mod_complete.yo Zsh/mod_compctl.yo Zsh/mod_complist.yo \
-Zsh/mod_deltochar.yo Zsh/mod_example.yo Zsh/mod_files.yo \
-Zsh/mod_mapfile.yo Zsh/mod_mathfunc.yo Zsh/mod_parameter.yo Zsh/mod_sched.yo \
-Zsh/mod_stat.yo Zsh/mod_zftp.yo Zsh/mod_zle.yo Zsh/mod_zleparameter.yo \
+Zsh/modules.yo Zsh/modlist.yo Zsh/modmenu.yo $(MODDOCSRC) \
 Zsh/options.yo Zsh/params.yo Zsh/prompt.yo Zsh/redirect.yo Zsh/restricted.yo \
 Zsh/seealso.yo Zsh/zftpsys.yo Zsh/zle.yo
 
@@ -142,11 +149,7 @@ zshmisc.1: Zsh/grammar.yo Zsh/redirect.yo Zsh/exec.yo Zsh/func.yo \
            Zsh/jobs.yo Zsh/arith.yo Zsh/cond.yo Zsh/compat.yo \
            Zsh/prompt.yo Zsh/restricted.yo
 
-zshmodules.1: Zsh/modules.yo Zsh/mod_cap.yo Zsh/mod_clone.yo \
-              Zsh/mod_complete.yo Zsh/mod_complist.yo Zsh/mod_compctl.yo \
-              Zsh/mod_deltochar.yo Zsh/mod_example.yo Zsh/mod_files.yo \
-              Zsh/mod_mapfile.yo Zsh/mod_mathfunc.yo Zsh/mod_sched.yo \
-              Zsh/mod_stat.yo Zsh/mod_zftp.yo Zsh/mod_zle.yo
+zshmodules.1: Zsh/modules.yo Zsh/modlist.yo Zsh/modmenu.yo $(MODDOCSRC)
 
 zshoptions.1: Zsh/options.yo
 
@@ -164,6 +167,36 @@ version.yo: $(sdir_top)/Config/version.mk
 	  echo 'ENDDEF()#' | tr '#' '\\'; \
 	) > $(sdir)/version.yo
 
+Zsh/modlist.yo: $(MODDOCSRC)
+	( \
+	    modules=`echo '' $(MODDOCSRC) '' | sed 's| Zsh/mod_| |g;s|\.yo | |g'`; \
+	    echo "startitem()"; \
+	    for mod in $$modules; do \
+		echo "item(tt($$mod))("; \
+		sed -n '1d;/^!MOD!)$$/q;p' < $(sdir)/Zsh/mod_$${mod}.yo; \
+		echo ")"; \
+	    done; \
+	    echo "enditem()"; \
+	    echo "startmenu()"; \
+	    echo "includefile(Zsh/modmenu.yo)
"; \
+	    echo "endmenu()"; \
+	    set '' $$modules; \
+	    while test ".$$2" != .; do \
+		echo "texinode(The $$2 Module)($${3+The $$3 Module})($${1:+The $$1 Module})(Zsh Modules)"; \
+		echo "sect(The $$2 Module)"; \
+		echo "includefile(Zsh/mod_$${2}.yo)
"; \
+		shift; \
+	    done \
+	) > $(sdir)/Zsh/modlist.yo
+
+Zsh/modmenu.yo: $(MODDOCSRC)
+	( \
+	    modules=`echo '' $(MODDOCSRC) '' | sed 's| Zsh/mod_| |g;s|\.yo | |g'`; \
+	    for mod in $$modules; do \
+		echo "menu(The $$mod Module)"; \
+	    done \
+	) > $(sdir)/Zsh/modmenu.yo
+
 # ========== DEPENDENCIES FOR INSTALLING ==========
 
 # install just installs the manual pages
@@ -233,6 +266,7 @@ distclean-here: clean-here
 	rm -f Makefile
 
 realclean-here: distclean-here
+	cd $(sdir) && rm -f Zsh/modlist.yo Zsh/modmenu.yo
 	cd $(sdir) && rm -f version.yo ../META-FAQ zsh.texi $(MAN)
 
 @CLEAN_MK@
diff --git a/Doc/Zsh/.cvsignore b/Doc/Zsh/.cvsignore
new file mode 100644
index 000000000..991e04aca
--- /dev/null
+++ b/Doc/Zsh/.cvsignore
@@ -0,0 +1,2 @@
+modlist.yo
+modmenu.yo
diff --git a/Doc/Zsh/.distfiles b/Doc/Zsh/.distfiles
index 11d761230..eebed573c 100644
--- a/Doc/Zsh/.distfiles
+++ b/Doc/Zsh/.distfiles
@@ -1,12 +1,13 @@
 DISTFILES_SRC='
-    .distfiles
+    .cvsignore .distfiles
     arith.yo builtins.yo compat.yo compctl.yo compsys.yo compwid.yo
     cond.yo exec.yo expn.yo filelist.yo files.yo func.yo grammar.yo
     index.yo intro.yo invoke.yo jobs.yo manual.yo metafaq.yo mod_cap.yo
     mod_clone.yo mod_compctl.yo mod_complete.yo mod_complist.yo
     mod_computil.yo mod_deltochar.yo mod_example.yo mod_files.yo
     mod_mapfile.yo mod_mathfunc.yo mod_parameter.yo mod_sched.yo
-    mod_stat.yo mod_zftp.yo mod_zle.yo mod_zleparameter.yo modules.yo
+    mod_stat.yo mod_zftp.yo mod_zle.yo mod_zleparameter.yo mod_zutil.yo
+    modules.yo modlist.yo modmenu.yo
     options.yo params.yo prompt.yo redirect.yo restricted.yo seealso.yo
     zftpsys.yo zle.yo
 '
diff --git a/Doc/Zsh/manual.yo b/Doc/Zsh/manual.yo
index 30c8a0345..19497386a 100644
--- a/Doc/Zsh/manual.yo
+++ b/Doc/Zsh/manual.yo
@@ -115,22 +115,7 @@ menu(Examples)
 
 Zsh Modules
 
-menu(The cap Module)
-menu(The clone Module)
-menu(The complete Module)
-menu(The compctl Module)
-menu(The complist Module)
-menu(The deltochar Module)
-menu(The example Module)
-menu(The files Module)
-menu(The mapfile Module)
-menu(The mathfunc Module)
-menu(The parameter Module)
-menu(The sched Module)
-menu(The stat Module)
-menu(The zftp Module)
-menu(The zle Module)
-menu(The zleparameter Module)
+includefile(Zsh/modmenu.yo)

 endmenu()
 texinode(The Z Shell Manual)(Introduction)(Top)(Top)
 chapter(The Z Shell Manual)
diff --git a/Doc/Zsh/mod_cap.yo b/Doc/Zsh/mod_cap.yo
index f6513b314..0bb2b813a 100644
--- a/Doc/Zsh/mod_cap.yo
+++ b/Doc/Zsh/mod_cap.yo
@@ -1,5 +1,6 @@
-texinode(The cap Module)(The clone Module)()(Zsh Modules)
-sect(The cap Module)
+COMMENT(!MOD!
+Builtins for manipulating POSIX.1e (POSIX.6) capability (privilege) sets.
+!MOD!)
 The tt(cap) module is used for manipulating POSIX.1e (POSIX.6) capability
 sets.  If the operating system does not support this interface, the
 builtins defined by this module will do nothing.
diff --git a/Doc/Zsh/mod_clone.yo b/Doc/Zsh/mod_clone.yo
index 996462b7b..5bc8068dc 100644
--- a/Doc/Zsh/mod_clone.yo
+++ b/Doc/Zsh/mod_clone.yo
@@ -1,5 +1,6 @@
-texinode(The clone Module)(The zutil Module)(The cap Module)(Zsh Modules)
-sect(The clone Module)
+COMMENT(!MOD!
+A builtin that can clone a running shell onto another terminal.
+!MOD!)
 The tt(clone) module makes available one builtin command:
 
 startitem()
diff --git a/Doc/Zsh/mod_compctl.yo b/Doc/Zsh/mod_compctl.yo
index b69ae1e7d..99d523cd1 100644
--- a/Doc/Zsh/mod_compctl.yo
+++ b/Doc/Zsh/mod_compctl.yo
@@ -1,5 +1,7 @@
-texinode(The compctl Module)(The complist Module)(The complete Module)(Zsh Modules)
-sect(The compctl Module)
+COMMENT(!MOD!
+The tt(compctl) builtin for controlling completion and the builtins for
+completion widgets.
+!MOD!)
 The tt(compctl) module makes available two builtin commands. tt(compctl),
 is the old, deprecated way to control completions for ZLE.  See
 ifzman(zmanref(zshcompctl))\
diff --git a/Doc/Zsh/mod_complete.yo b/Doc/Zsh/mod_complete.yo
index 418e54d28..2c421eb8b 100644
--- a/Doc/Zsh/mod_complete.yo
+++ b/Doc/Zsh/mod_complete.yo
@@ -1,5 +1,6 @@
-texinode(The complete Module)(The compctl Module)(The zutil Module)(Zsh Modules)
-sect(The complete Module)
+COMMENT(!MOD!
+The basic completion code.
+!MOD!)
 The tt(complete) module makes available several builtin commands which
 can be used in user-defined completion widgets, see
 ifzman(zmanref(zshcompwid))\
diff --git a/Doc/Zsh/mod_complist.yo b/Doc/Zsh/mod_complist.yo
index f04483268..d9e29e752 100644
--- a/Doc/Zsh/mod_complist.yo
+++ b/Doc/Zsh/mod_complist.yo
@@ -1,5 +1,6 @@
-texinode(The complist Module)(The computil Module)(The compctl Module)(Zsh Modules)
-sect(The complist Module)
+COMMENT(!MOD!
+Completion listing extensions.
+!MOD!)
 cindex(completion, listing)
 cindex(completion, coloured listings)
 The tt(complist) module offers two extensions to completion listings:
diff --git a/Doc/Zsh/mod_computil.yo b/Doc/Zsh/mod_computil.yo
index 51922b13f..c7397c646 100644
--- a/Doc/Zsh/mod_computil.yo
+++ b/Doc/Zsh/mod_computil.yo
@@ -1,5 +1,7 @@
-texinode(The computil Module)(The deltochar Module)(The complist Module)(Zsh Modules)
-sect(The computil Module)
+COMMENT(!MOD!
+A module with utility builtins needed for the shell function based
+completion system.
+!MOD!)
 cindex(completion, utility)
 The tt(computil) module adds several builtin commands that are used by
 some of the completion functions in the shell function based
diff --git a/Doc/Zsh/mod_deltochar.yo b/Doc/Zsh/mod_deltochar.yo
index 20b66a49d..d8f847f1b 100644
--- a/Doc/Zsh/mod_deltochar.yo
+++ b/Doc/Zsh/mod_deltochar.yo
@@ -1,5 +1,6 @@
-texinode(The deltochar Module)(The example Module)(The computil Module)(Zsh Modules)
-sect(The deltochar Module)
+COMMENT(!MOD!
+A ZLE function duplicating EMACS' tt(zap-to-char).
+!MOD!)
 The tt(deltochar) module makes available two ZLE functions:
 
 startitem()
diff --git a/Doc/Zsh/mod_example.yo b/Doc/Zsh/mod_example.yo
index 5339253d9..852f60189 100644
--- a/Doc/Zsh/mod_example.yo
+++ b/Doc/Zsh/mod_example.yo
@@ -1,5 +1,6 @@
-texinode(The example Module)(The files Module)(The deltochar Module)(Zsh Modules)
-sect(The example Module)
+COMMENT(!MOD!
+An example of how to write a module.
+!MOD!)
 The tt(example) module makes available one builtin command:
 
 startitem()
diff --git a/Doc/Zsh/mod_files.yo b/Doc/Zsh/mod_files.yo
index d5c87b6d1..be0ad9f09 100644
--- a/Doc/Zsh/mod_files.yo
+++ b/Doc/Zsh/mod_files.yo
@@ -1,5 +1,6 @@
-texinode(The files Module)(The mapfile Module)(The example Module)(Zsh Modules)
-sect(The files Module)
+COMMENT(!MOD!
+Some basic file manipulation commands as builtins.
+!MOD!)
 cindex(files, manipulating)
 The tt(files) module makes some standard commands available as builtins:
 
diff --git a/Doc/Zsh/mod_mapfile.yo b/Doc/Zsh/mod_mapfile.yo
index ad8497027..ea360de82 100644
--- a/Doc/Zsh/mod_mapfile.yo
+++ b/Doc/Zsh/mod_mapfile.yo
@@ -1,5 +1,6 @@
-texinode(The mapfile Module)(The mathfunc Module)(The files Module)(Zsh Modules)
-sect(The mapfile Module)
+COMMENT(!MOD!
+Access to external files via a special associative array.
+!MOD!)
 cindex(parameter, file access via)
 The tt(mapfile) module provides one special associative array parameter of
 the same name.
diff --git a/Doc/Zsh/mod_mathfunc.yo b/Doc/Zsh/mod_mathfunc.yo
index bc69d2b20..d22394eb7 100644
--- a/Doc/Zsh/mod_mathfunc.yo
+++ b/Doc/Zsh/mod_mathfunc.yo
@@ -1,5 +1,6 @@
-texinode(The mathfunc Module)(The parameter Module)(The mapfile Module)(Zsh Modules)
-sect(The mathfunc Module)
+COMMENT(!MOD!
+Standard scientific functions for use in mathematical evaluations.
+!MOD!)
 cindex(functions, mathematical)
 cindex(mathematical functions)
 The tt(mathfunc) module provides standard mathematical functions for use when
diff --git a/Doc/Zsh/mod_parameter.yo b/Doc/Zsh/mod_parameter.yo
index 7071e20db..43ee7394f 100644
--- a/Doc/Zsh/mod_parameter.yo
+++ b/Doc/Zsh/mod_parameter.yo
@@ -1,5 +1,6 @@
-texinode(The parameter Module)(The sched Module)(The mathfunc Module)(Zsh Modules)
-sect(The parameter Module)
+COMMENT(!MOD!
+Access to internal hash tables via special associative arrays.
+!MOD!)
 cindex(parameters, special)
 The tt(parameter) module gives access to some of the internal hash
 tables used by the shell by defining some special parameters.
diff --git a/Doc/Zsh/mod_sched.yo b/Doc/Zsh/mod_sched.yo
index 18ea87db5..18c91c2a1 100644
--- a/Doc/Zsh/mod_sched.yo
+++ b/Doc/Zsh/mod_sched.yo
@@ -1,5 +1,6 @@
-texinode(The sched Module)(The stat Module)(The parameter Module)(Zsh Modules)
-sect(The sched Module)
+COMMENT(!MOD!
+A builtin that provides a timed execution facility within the shell.
+!MOD!)
 The tt(sched) module makes available one builtin command:
 
 startitem()
diff --git a/Doc/Zsh/mod_stat.yo b/Doc/Zsh/mod_stat.yo
index d0c7acfe1..a5455a19d 100644
--- a/Doc/Zsh/mod_stat.yo
+++ b/Doc/Zsh/mod_stat.yo
@@ -1,5 +1,6 @@
-texinode(The stat Module)(The zftp Module)(The sched Module)(Zsh Modules)
-sect(The stat Module)
+COMMENT(!MOD!
+A builtin command interface to the tt(stat) system call.
+!MOD!)
 The tt(stat) module makes available one builtin command:
 
 startitem()
diff --git a/Doc/Zsh/mod_zftp.yo b/Doc/Zsh/mod_zftp.yo
index e5dc8ec2f..adbf331e4 100644
--- a/Doc/Zsh/mod_zftp.yo
+++ b/Doc/Zsh/mod_zftp.yo
@@ -1,5 +1,6 @@
-texinode(The zftp Module)(The zle Module)(The stat Module)(Zsh Modules)
-sect(The zftp Module)
+COMMENT(!MOD!
+A builtin FTP client.
+!MOD!)
 The tt(zftp) module makes available one builtin command:
 
 startitem()
diff --git a/Doc/Zsh/mod_zle.yo b/Doc/Zsh/mod_zle.yo
index a346ab279..d25c5ba1d 100644
--- a/Doc/Zsh/mod_zle.yo
+++ b/Doc/Zsh/mod_zle.yo
@@ -1,5 +1,6 @@
-texinode(The zle Module)(The zleparameter Module)(The zftp Module)(Zsh Modules)
-sect(The zle Module)
+COMMENT(!MOD!
+The Zsh Line Editor, including the tt(bindkey) and tt(vared) builtins.
+!MOD!)
 The tt(zle) module contains the Zsh Line Editor.  See
 ifzman(zmanref(zshzle))\
 ifnzman(noderef(Zsh Line Editor))\
diff --git a/Doc/Zsh/mod_zleparameter.yo b/Doc/Zsh/mod_zleparameter.yo
index 2f5f96367..e3d4924c7 100644
--- a/Doc/Zsh/mod_zleparameter.yo
+++ b/Doc/Zsh/mod_zleparameter.yo
@@ -1,5 +1,6 @@
-texinode(The zleparameter Module)()(The zle Module)(Zsh Modules)
-sect(The zleparameter Module)
+COMMENT(!MOD!
+Access to internals of the Zsh Line Editor via parameters.
+!MOD!)
 cindex(parameters, special)
 The tt(zleparameter) module defines two special parameters that can be 
 used to access internal information of the Zsh Line Editor (see
diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo
index 477f955eb..405b88e1e 100644
--- a/Doc/Zsh/mod_zutil.yo
+++ b/Doc/Zsh/mod_zutil.yo
@@ -1,5 +1,7 @@
-texinode(The zutil Module)(The complete Module)(The clone Module)(Zsh Modules)
-sect(The zutil Module)
+COMMENT(!MOD!
+Some utility builtins, e.g. the one for supporting configuration via 
+styles.
+!MOD!)
 cindex(builtins, utility)
 The tt(zutil) module only adds some builtins:
 
diff --git a/Doc/Zsh/modules.yo b/Doc/Zsh/modules.yo
index 89c1f7246..7a404fd79 100644
--- a/Doc/Zsh/modules.yo
+++ b/Doc/Zsh/modules.yo
@@ -8,100 +8,4 @@ shell at build time,
 or can be dynamically linked while the shell is running
 if the installation supports this feature.  The modules available are:
 
-startitem()
-item(tt(cap))(
-Builtins for manipulating POSIX.1e (POSIX.6) capability (privilege) sets.
-)
-item(tt(clone))(
-A builtin that can clone a running shell onto another terminal.
-)
-item(tt(zutil))(
-Some utility builtins, e.g. the one for supporting configuration via 
-styles.
-)
-item(tt(complete))(
-The basic completion code.
-)
-item(tt(compctl))(
-The tt(compctl) builtin for controlling completion and the builtins for
-completion widgets.
-)
-item(tt(complist))(
-Completion listing extensions.
-)
-item(tt(computil))(
-A module with utility builtins needed for the shell function based
-completion system.
-)
-item(tt(deltochar))(
-A ZLE function duplicating EMACS' tt(zap-to-char).
-)
-item(tt(example))(
-An example of how to write a module.
-)
-item(tt(files))(
-Some basic file manipulation commands as builtins.
-)
-item(tt(mapfile))(
-Access to external files via a special associative array.
-)
-item(tt(mathfunc))(
-Standard scientific functions for use in mathematical evaluations.
-)
-item(tt(parameter))(
-Access to internal hash tables via special associative arrays.
-)
-item(tt(sched))(
-A builtin that provides a timed execution facility within the shell.
-)
-item(tt(stat))(
-A builtin command interface to the tt(stat) system call.
-)
-item(tt(zftp))(
-A builtin FTP client.
-)
-item(tt(zle))(
-The Zsh Line Editor, including the tt(bindkey) and tt(vared) builtins.
-)
-item(tt(zleparameter))(
-Access to internals of the Zsh Line Editor via parameters.
-)
-enditem()
-startmenu()
-menu(The cap Module)
-menu(The clone Module)
-menu(The zutil Module)
-menu(The complete Module)
-menu(The compctl Module)
-menu(The complist Module)
-menu(The computil Module)
-menu(The deltochar Module)
-menu(The example Module)
-menu(The files Module)
-menu(The mapfile Module)
-menu(The mathfunc Module)
-menu(The parameter Module)
-menu(The sched Module)
-menu(The stat Module)
-menu(The zftp Module)
-menu(The zle Module)
-menu(The zleparameter Module)
-endmenu()
-includefile(Zsh/mod_cap.yo)

-includefile(Zsh/mod_clone.yo)

-includefile(Zsh/mod_zutil.yo)

-includefile(Zsh/mod_complete.yo)

-includefile(Zsh/mod_compctl.yo)

-includefile(Zsh/mod_complist.yo)

-includefile(Zsh/mod_computil.yo)

-includefile(Zsh/mod_deltochar.yo)

-includefile(Zsh/mod_example.yo)

-includefile(Zsh/mod_files.yo)

-includefile(Zsh/mod_mapfile.yo)

-includefile(Zsh/mod_mathfunc.yo)

-includefile(Zsh/mod_parameter.yo)

-includefile(Zsh/mod_sched.yo)

-includefile(Zsh/mod_stat.yo)

-includefile(Zsh/mod_zftp.yo)

-includefile(Zsh/mod_zle.yo)

-includefile(Zsh/mod_zleparameter.yo)

+includefile(Zsh/modlist.yo)