diff options
author | Tanaka Akira <akr@users.sourceforge.net> | 1999-12-16 14:26:16 +0000 |
---|---|---|
committer | Tanaka Akira <akr@users.sourceforge.net> | 1999-12-16 14:26:16 +0000 |
commit | 02c0df21747e5795197510f15da73bd0c287e978 (patch) | |
tree | cb14653880f6e9aed25c179c7dbc301f287e9242 /Doc | |
parent | 77d48c89e05417ef40abc917ec7e2713779f8951 (diff) | |
download | zsh-02c0df21747e5795197510f15da73bd0c287e978.tar.gz zsh-02c0df21747e5795197510f15da73bd0c287e978.tar.xz zsh-02c0df21747e5795197510f15da73bd0c287e978.zip |
manual/9083
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/Makefile.in | 8 | ||||
-rw-r--r-- | Doc/Zsh/builtins.yo | 11 | ||||
-rw-r--r-- | Doc/Zsh/mod_cap.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_clone.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_compctl.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_complete.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_complist.yo | 10 | ||||
-rw-r--r-- | Doc/Zsh/mod_computil.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_deltochar.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_example.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_files.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_mapfile.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_mathfunc.yo | 3 | ||||
-rw-r--r-- | Doc/Zsh/mod_parameter.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_sched.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_stat.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_zftp.yo | 6 | ||||
-rw-r--r-- | Doc/Zsh/mod_zle.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_zleparameter.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/mod_zutil.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/modules.yo | 3 | ||||
-rw-r--r-- | Doc/Zsh/options.yo | 3 | ||||
-rw-r--r-- | Doc/Zsh/restricted.yo | 2 | ||||
-rw-r--r-- | Doc/Zsh/zftpsys.yo | 2 |
24 files changed, 38 insertions, 40 deletions
diff --git a/Doc/Makefile.in b/Doc/Makefile.in index 41675a330..6d7e76fce 100644 --- a/Doc/Makefile.in +++ b/Doc/Makefile.in @@ -172,7 +172,7 @@ 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))("; \ + echo "item(tt(zsh/$$mod))("; \ sed -n '1d;/^!MOD!)$$/q;p' < $(sdir)/Zsh/mod_$${mod}.yo; \ echo ")"; \ done; \ @@ -182,8 +182,8 @@ Zsh/modlist.yo: $(MODDOCSRC) 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 "texinode(The zsh/$$2 Module)($${3+The $$3 Module})($${1:+The $$1 Module})(Zsh Modules)"; \ + echo "sect(The zsh/$$2 Module)"; \ echo "includefile(Zsh/mod_$${2}.yo)"; \ shift; \ done \ @@ -193,7 +193,7 @@ 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)"; \ + echo "menu(The zsh/$$mod Module)"; \ done \ ) > $(sdir)/Zsh/modmenu.yo diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo index 072316256..9513eb22c 100644 --- a/Doc/Zsh/builtins.yo +++ b/Doc/Zsh/builtins.yo @@ -1303,16 +1303,15 @@ xitem(tt(zmodload) [ tt(-i) ] var(name) ... ) item(tt(zmodload) tt(-u) [ tt(-i) ] var(name) ...)( In the simplest case, tt(zmodload) loads a binary module. The module must be in a file with a name consisting of the specified var(name) followed by -a standard suffix, usually `tt(.so)'. If this can't be found, the -var(name) is tried without the suffix. If the module to be loaded is +a standard suffix, usually `tt(.so)'. +If the module to be loaded is already loaded and the tt(-i) option is given, the duplicate module is ignored. Otherwise tt(zmodload) prints an error message. The var(name)d module is searched for in the same way a command is, using -tt($module_path) instead of tt($path). If var(name) contains a `tt(/)', -it will be used as-is, and a path search will be performed otherwise. -This behaviour can be modified by the tt(PATH_DIRS) option. -cindex(PATH_DIRS, use of) +tt($module_path) instead of tt($path). However, the path search is +performed even when the module name contains a `tt(/)', which it usually does. +There is no way to prevent the path search. With tt(-u), tt(zmodload) unloads modules. The same var(name) must be given that was given when the module was loaded, but it is not diff --git a/Doc/Zsh/mod_cap.yo b/Doc/Zsh/mod_cap.yo index 0bb2b813a..3dec78b00 100644 --- a/Doc/Zsh/mod_cap.yo +++ b/Doc/Zsh/mod_cap.yo @@ -1,7 +1,7 @@ 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 +The tt(zsh/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. The builtins in this module are: diff --git a/Doc/Zsh/mod_clone.yo b/Doc/Zsh/mod_clone.yo index 5bc8068dc..9dd710cca 100644 --- a/Doc/Zsh/mod_clone.yo +++ b/Doc/Zsh/mod_clone.yo @@ -1,7 +1,7 @@ COMMENT(!MOD! A builtin that can clone a running shell onto another terminal. !MOD!) -The tt(clone) module makes available one builtin command: +The tt(zsh/clone) module makes available one builtin command: startitem() findex(clone) diff --git a/Doc/Zsh/mod_compctl.yo b/Doc/Zsh/mod_compctl.yo index 4379f4fa9..5dfa880a4 100644 --- a/Doc/Zsh/mod_compctl.yo +++ b/Doc/Zsh/mod_compctl.yo @@ -1,7 +1,7 @@ COMMENT(!MOD! The tt(compctl) builtin for controlling completion. !MOD!) -The tt(compctl) module makes available two builtin commands. tt(compctl), +The tt(zsh/compctl) module makes available two builtin commands. tt(compctl), is the old, deprecated way to control completions for ZLE. See ifzman(zmanref(zshcompctl))\ ifnzman(noderef(Programmable Completion Using compctl))\ diff --git a/Doc/Zsh/mod_complete.yo b/Doc/Zsh/mod_complete.yo index 2c421eb8b..18f4f8ebc 100644 --- a/Doc/Zsh/mod_complete.yo +++ b/Doc/Zsh/mod_complete.yo @@ -1,7 +1,7 @@ COMMENT(!MOD! The basic completion code. !MOD!) -The tt(complete) module makes available several builtin commands which +The tt(zsh/complete) module makes available several builtin commands which can be used in user-defined completion widgets, see ifzman(zmanref(zshcompwid))\ ifnzman(noderef(Completion Widgets))\ diff --git a/Doc/Zsh/mod_complist.yo b/Doc/Zsh/mod_complist.yo index d9e29e752..c5fa9fac1 100644 --- a/Doc/Zsh/mod_complist.yo +++ b/Doc/Zsh/mod_complist.yo @@ -3,15 +3,15 @@ Completion listing extensions. !MOD!) cindex(completion, listing) cindex(completion, coloured listings) -The tt(complist) module offers two extensions to completion listings: +The tt(zsh/complist) module offers two extensions to completion listings: the ability to highlight matches in such a list and a different style of menu-completion. Whenever one of the parameters tt(ZLS_COLORS) or tt(ZLS_COLOURS) is set -and the tt(complist) module is loaded or linked into the shell, +and the tt(zsh/complist) module is loaded or linked into the shell, completion lists will be colored. Note, however, that tt(complist) will not automatically be loaded if it is not linked in: on systems with -dynamic loading, `tt(zmodload complist)' is required. +dynamic loading, `tt(zmodload zsh/complist)' is required. subsect(Parameters) vindex(ZLS_COLORS) @@ -130,7 +130,7 @@ subsect(Menu selection) cindex(completion, selecting by cursor) vindex(SELECTMIN) tindex(menu-select) -The tt(complist) module also offers an alternative style of selecting +The tt(zsh/complist) module also offers an alternative style of selecting matches from a list, called menu-selection, which can be used if the shell is set up to return to the last prompt after showing a completion list (see the tt(ALWAYS_LAST_PROMPT) option in @@ -211,4 +211,4 @@ continue with normal menu-completion one can call indent(tt(bindkey -M menuselect '^M' send-break)) -after loading the tt(complist) module. +after loading the tt(zsh/complist) module. diff --git a/Doc/Zsh/mod_computil.yo b/Doc/Zsh/mod_computil.yo index c7397c646..26a8d25eb 100644 --- a/Doc/Zsh/mod_computil.yo +++ b/Doc/Zsh/mod_computil.yo @@ -3,7 +3,7 @@ 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 +The tt(zsh/computil) module adds several builtin commands that are used by some of the completion functions in the shell function based completions system (see ifzman(zmanref(zshcompsys))\ diff --git a/Doc/Zsh/mod_deltochar.yo b/Doc/Zsh/mod_deltochar.yo index d8f847f1b..334babbde 100644 --- a/Doc/Zsh/mod_deltochar.yo +++ b/Doc/Zsh/mod_deltochar.yo @@ -1,7 +1,7 @@ COMMENT(!MOD! A ZLE function duplicating EMACS' tt(zap-to-char). !MOD!) -The tt(deltochar) module makes available two ZLE functions: +The tt(zsh/deltochar) module makes available two ZLE functions: startitem() tindex(delete-to-char) diff --git a/Doc/Zsh/mod_example.yo b/Doc/Zsh/mod_example.yo index 852f60189..03b795bc0 100644 --- a/Doc/Zsh/mod_example.yo +++ b/Doc/Zsh/mod_example.yo @@ -1,7 +1,7 @@ COMMENT(!MOD! An example of how to write a module. !MOD!) -The tt(example) module makes available one builtin command: +The tt(zsh/example) module makes available one builtin command: startitem() findex(example) diff --git a/Doc/Zsh/mod_files.yo b/Doc/Zsh/mod_files.yo index be0ad9f09..10e9123ff 100644 --- a/Doc/Zsh/mod_files.yo +++ b/Doc/Zsh/mod_files.yo @@ -2,7 +2,7 @@ COMMENT(!MOD! Some basic file manipulation commands as builtins. !MOD!) cindex(files, manipulating) -The tt(files) module makes some standard commands available as builtins: +The tt(zsh/files) module makes some standard commands available as builtins: startitem() findex(chgrp) diff --git a/Doc/Zsh/mod_mapfile.yo b/Doc/Zsh/mod_mapfile.yo index ea360de82..d3dd2a041 100644 --- a/Doc/Zsh/mod_mapfile.yo +++ b/Doc/Zsh/mod_mapfile.yo @@ -2,7 +2,7 @@ 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 tt(zsh/mapfile) module provides one special associative array parameter of the same name. startitem() diff --git a/Doc/Zsh/mod_mathfunc.yo b/Doc/Zsh/mod_mathfunc.yo index d22394eb7..2c87e873f 100644 --- a/Doc/Zsh/mod_mathfunc.yo +++ b/Doc/Zsh/mod_mathfunc.yo @@ -3,7 +3,8 @@ 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 +The tt(zsh/mathfunc) module provides standard +mathematical functions for use when evaluating mathematical formulae. The syntax agrees with normal C and FORTRAN conventions, for example, diff --git a/Doc/Zsh/mod_parameter.yo b/Doc/Zsh/mod_parameter.yo index dc00cdf46..6d58dd8f0 100644 --- a/Doc/Zsh/mod_parameter.yo +++ b/Doc/Zsh/mod_parameter.yo @@ -2,7 +2,7 @@ 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 +The tt(zsh/parameter) module gives access to some of the internal hash tables used by the shell by defining some special parameters. startitem() diff --git a/Doc/Zsh/mod_sched.yo b/Doc/Zsh/mod_sched.yo index 18c91c2a1..faf94cbcc 100644 --- a/Doc/Zsh/mod_sched.yo +++ b/Doc/Zsh/mod_sched.yo @@ -1,7 +1,7 @@ COMMENT(!MOD! A builtin that provides a timed execution facility within the shell. !MOD!) -The tt(sched) module makes available one builtin command: +The tt(zsh/sched) module makes available one builtin command: startitem() findex(sched) diff --git a/Doc/Zsh/mod_stat.yo b/Doc/Zsh/mod_stat.yo index a5455a19d..0d2f709db 100644 --- a/Doc/Zsh/mod_stat.yo +++ b/Doc/Zsh/mod_stat.yo @@ -1,7 +1,7 @@ COMMENT(!MOD! A builtin command interface to the tt(stat) system call. !MOD!) -The tt(stat) module makes available one builtin command: +The tt(zsh/stat) module makes available one builtin command: startitem() findex(stat) diff --git a/Doc/Zsh/mod_zftp.yo b/Doc/Zsh/mod_zftp.yo index adbf331e4..708122bd8 100644 --- a/Doc/Zsh/mod_zftp.yo +++ b/Doc/Zsh/mod_zftp.yo @@ -1,14 +1,14 @@ COMMENT(!MOD! A builtin FTP client. !MOD!) -The tt(zftp) module makes available one builtin command: +The tt(zsh/zftp) module makes available one builtin command: startitem() findex(zftp) cindex(FTP) cindex(files, transferring) item(tt(zftp) var(subcommand) [ var(args) ])( -The tt(zftp) module is a client for FTP (file transfer protocol). It +The tt(zsh/zftp) module is a client for FTP (file transfer protocol). It is implemented as a builtin to allow full use of shell command line editing, file I/O, and job control mechanisms. Often, users will access it via shell functions providing a more powerful interface; a set is @@ -84,7 +84,7 @@ are deleted. In that case, calling tt(open) with no arguments will cause an error. The list of parameters is not deleted after a tt(close), however it -will be deleted if the tt(zftp) module is unloaded. +will be deleted if the tt(zsh/zftp) module is unloaded. For example, diff --git a/Doc/Zsh/mod_zle.yo b/Doc/Zsh/mod_zle.yo index d25c5ba1d..0230dcaad 100644 --- a/Doc/Zsh/mod_zle.yo +++ b/Doc/Zsh/mod_zle.yo @@ -1,7 +1,7 @@ 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 +The tt(zsh/zle) module contains the Zsh Line Editor. See ifzman(zmanref(zshzle))\ ifnzman(noderef(Zsh Line Editor))\ . It also contains three related builtin commands: diff --git a/Doc/Zsh/mod_zleparameter.yo b/Doc/Zsh/mod_zleparameter.yo index e3d4924c7..287e3bdb3 100644 --- a/Doc/Zsh/mod_zleparameter.yo +++ b/Doc/Zsh/mod_zleparameter.yo @@ -2,7 +2,7 @@ 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 +The tt(zsh/zleparameter) module defines two special parameters that can be used to access internal information of the Zsh Line Editor (see ifzman(zmanref(zshzle))\ ifnzman(noderef(Zsh Line Editor))\ diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo index 405b88e1e..2232551fe 100644 --- a/Doc/Zsh/mod_zutil.yo +++ b/Doc/Zsh/mod_zutil.yo @@ -3,7 +3,7 @@ Some utility builtins, e.g. the one for supporting configuration via styles. !MOD!) cindex(builtins, utility) -The tt(zutil) module only adds some builtins: +The tt(zsh/zutil) module only adds some builtins: startitem() xitem(tt(zstyle) [ tt(-L) ]) diff --git a/Doc/Zsh/modules.yo b/Doc/Zsh/modules.yo index 7a404fd79..afd2b5c1c 100644 --- a/Doc/Zsh/modules.yo +++ b/Doc/Zsh/modules.yo @@ -6,6 +6,7 @@ Some optional parts of zsh are in modules, separate from the core of the shell. Each of these modules may be linked in to the shell at build time, or can be dynamically linked while the shell is running -if the installation supports this feature. The modules available are: +if the installation supports this feature. The modules that +are bundled with the zsh distribution are: includefile(Zsh/modlist.yo) diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo index 795d37a22..f16d36cd3 100644 --- a/Doc/Zsh/options.yo +++ b/Doc/Zsh/options.yo @@ -758,8 +758,7 @@ Thus if `tt(/usr/local/bin)' is in the user's path, and he types (assuming it exists). Commands explicitly beginning with `tt(/)', `tt(./)' or `tt(../)' are not subject to the path search. -This also applies to the tt(.) builtin, -and to searches for modules performed by the tt(zmodload) builtin. +This also applies to the tt(.) builtin. ) pindex(POSIX_BUILTINS) item(tt(POSIX_BUILTINS) <K> <S>)( diff --git a/Doc/Zsh/restricted.yo b/Doc/Zsh/restricted.yo index a61fd4955..45c664eec 100644 --- a/Doc/Zsh/restricted.yo +++ b/Doc/Zsh/restricted.yo @@ -29,8 +29,6 @@ itemiz(using the tt(ARGV0) parameter to override tt(argv[0]) for external commands) itemiz(turning off restricted mode with tt(set +r) or tt(unsetopt RESTRICTED)) -itemiz(specifying modules to be loaded with an explicitly given -pathname containing slashes) enditemize() These restrictions are enforced after processing the startup files. The diff --git a/Doc/Zsh/zftpsys.yo b/Doc/Zsh/zftpsys.yo index b1f703ec6..fa50fd15e 100644 --- a/Doc/Zsh/zftpsys.yo +++ b/Doc/Zsh/zftpsys.yo @@ -21,7 +21,7 @@ ifnzman(\ noderef(The zftp Module) ), must be available in the version of tt(zsh) installed at your site. If the shell is configured to -load new commands at run time, it probably is: typing `tt(zmodload zftp)' +load new commands at run time, it probably is: typing `tt(zmodload zsh/zftp)' will make sure (if that runs silently, it has worked). If this is not the case, it is possible tt(zftp) was linked into the shell anyway: to test this, type `tt(which zftp)' and if tt(zftp) is available you will get the |