bybrooklyn/zsh
1
0
Fork 0
mirror of https://git.code.sf.net/p/zsh/code synced 2026-04-18 06:53:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

53821: add missing manpage name in cross reference

Browse Source 
and many small improvements. See comments in zman.yo for the usage
of new yodl macros for cross reference.
This commit is contained in:
Jun-ichi Takimoto
2025-07-18 23:26:56 +09:00
parent 9dcd08e585
commit 33aafecc7e
47 changed files with 510 additions and 777 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
ChangeLog
View File

@@ -1,3 +1,24 @@
2025-07-18 Jun-ichi Takimoto <takimoto-j@kba.biglobe.ne.jp>
* 53821: Doc/Zsh/builtins.yo, Doc/Zsh/calsys.yo, Doc/Zsh/compctl.yo,
Doc/Zsh/compsys.yo, Doc/Zsh/compwid.yo, Doc/Zsh/cond.yo,
Doc/Zsh/contrib.yo, Doc/Zsh/exec.yo, Doc/Zsh/expn.yo,
Doc/Zsh/files.yo, Doc/Zsh/func.yo, Doc/Zsh/grammar.yo,
Doc/Zsh/intro.yo, Doc/Zsh/invoke.yo, Doc/Zsh/jobs.yo,
Doc/Zsh/manual.yo, Doc/Zsh/mod_compctl.yo, Doc/Zsh/mod_complete.yo,
Doc/Zsh/mod_complist.yo, Doc/Zsh/mod_computil.yo,
Doc/Zsh/mod_datetime.yo, Doc/Zsh/mod_mathfunc.yo,
Doc/Zsh/mod_newuser.yo, Doc/Zsh/mod_parameter.yo,
Doc/Zsh/mod_private.yo, Doc/Zsh/mod_sched.yo, Doc/Zsh/mod_stat.yo,
Doc/Zsh/mod_tcp.yo, Doc/Zsh/mod_watch.yo, Doc/Zsh/mod_zftp.yo,
Doc/Zsh/mod_zle.yo, Doc/Zsh/mod_zleparameter.yo,
Doc/Zsh/mod_zpty.yo, Doc/Zsh/mod_zutil.yo, Doc/Zsh/modules.yo,
Doc/Zsh/options.yo, Doc/Zsh/params.yo, Doc/Zsh/prompt.yo,
Doc/Zsh/redirect.yo, Doc/Zsh/roadmap.yo, Doc/Zsh/tcpsys.yo,
Doc/Zsh/zftpsys.yo, Doc/Zsh/zle.yo, Doc/zman.yo, Doc/ztexi.yo,
Util/zyodl.vim: add missing manpage name in cross reference,
many small improvements, with four new yodl macros.
2025-07-13 Bart Schaefer <schaefer@zsh.org> 2025-07-13 Bart Schaefer <schaefer@zsh.org>
* 53820: Src/hist.c: detect integer overflow when parsing * 53820: Src/hist.c: detect integer overflow when parsing

134
Doc/Zsh/builtins.yo
View File

@@ -5,8 +5,7 @@ sect(Shell Builtin Commands)
)\ )\
def(prefix)(1)(\ def(prefix)(1)(\
item(tt(ARG1) var(simple command))( item(tt(ARG1) var(simple command))(
See ifzman(the section `Precommand Modifiers' in zmanref(zshmisc))\ See sectref(Precommand Modifiers)(zshmisc).
ifnzman(noderef(Precommand Modifiers)).
)\ )\
)\ )\
def(alias)(2)(\ def(alias)(2)(\
@@ -17,14 +16,12 @@ Same as tt(ARG2).
)\ )\
def(module)(2)(\ def(module)(2)(\
item(tt(ARG1))( item(tt(ARG1))(
See ifzman(the section `The ARG2 Module' in zmanref(zshmodules))\ See sectref(The ARG2 Module)(zshmodules).
ifnzman(noderef(The ARG2 Module)).
)\ )\
)\ )\
def(zlecmd)(1)(\ def(zlecmd)(1)(\
item(tt(ARG1))( item(tt(ARG1))(
See ifzman(the section `Zle Builtins' in zmanref(zshzle))\ See sectref(Zle Builtins)(zshzle).
ifnzman(noderef(Zle Builtins)).
)\ )\
)\ )\
@@ -146,17 +143,16 @@ alias in a manner suitable for putting in a startup script. The exit
status is nonzero if a var(name) (with no var(value)) is given for status is nonzero if a var(name) (with no var(value)) is given for
which no alias has been defined. which no alias has been defined.
For more on aliases, include common problems, see For more on aliases, including common problems,
ifzman(the section ALIASING in zmanref(zshmisc))\ see sectref(Aliasing)(zshmisc).
ifnzman(noderef(Aliasing)).
) )
findex(autoload) findex(autoload)
cindex(functions, autoloading) cindex(functions, autoloading)
cindex(autoloading functions) cindex(autoloading functions)
item(tt(autoload) [ {tt(PLUS())|tt(-)}tt(RTUXdkmrtWz) ] [ tt(-w) ] [ var(name) ... ])( item(tt(autoload) [ {tt(PLUS())|tt(-)}tt(RTUXdkmrtWz) ] [ tt(-w) ] [ var(name) ... ])(
vindex(fpath, searching) vindex(fpath, searching)
See the section `Autoloading Functions' in ifzman(zmanref(zshmisc))\ See sectref(Autoloading Functions)(zshmisc)
ifnzman(noderef(Functions)) for full details. The tt(fpath) parameter for full details. The tt(fpath) parameter
will be searched to find the function definition when the function is will be searched to find the function definition when the function is
first referenced. first referenced.
@@ -323,8 +319,7 @@ searched instead of that in tt($path). With the tt(-v) flag, tt(command)
is similar to tt(whence) and with tt(-V), it is equivalent to tt(whence is similar to tt(whence) and with tt(-V), it is equivalent to tt(whence
-v). -v).
See also ifzman(the section `Precommand Modifiers' in zmanref(zshmisc))\ See also sectref(Precommand Modifiers)(zshmisc).
ifnzman(noderef(Precommand Modifiers)).
) )
module(comparguments)(zsh/computil) module(comparguments)(zsh/computil)
module(compcall)(zsh/compctl) module(compcall)(zsh/compctl)
@@ -362,9 +357,8 @@ item(tt(-c))(
clear the directory stack. clear the directory stack.
) )
item(tt(-l))( item(tt(-l))(
print directory names in full instead of using of using tt(~) expressions (\ print directory names in full instead of using tt(~) expressions
ifzman(see em(Dynamic) and em(Static named directories) in zmanref(zshexpn))\ (see sectref(Filename Expansion)(zshexpn)).
ifnzman(noderef(Filename Expansion))).
) )
item(tt(-p))( item(tt(-p))(
print directory entries one per line. print directory entries one per line.
@@ -394,7 +388,7 @@ are disabled. Disabled objects can be enabled with the tt(enable)
command. command.
With the option tt(-p), var(name) ... refer to elements of the With the option tt(-p), var(name) ... refer to elements of the
shell's pattern syntax as described in noderef(Filename Generation). shell's pattern syntax as described in sectref(Filename Generation)(zshexpn).
Certain elements can be disabled separately, as given below. Certain elements can be disabled separately, as given below.
Note that patterns Note that patterns
@@ -540,14 +534,8 @@ bf(csh) will never be fully emulated.
If the argument is not one of the shells listed above, tt(zsh) If the argument is not one of the shells listed above, tt(zsh)
will be used as a default; more precisely, the tests performed on the will be used as a default; more precisely, the tests performed on the
argument are the same as those used to determine the emulation at startup argument are the same as those used to determine the emulation at startup
based on the shell name, see based on the shell name, see sectref(Compatibility)(zsh).
ifzman(\ In addition to setting shell options, the command also restores
the section COMPATIBILITY in zmanref(zsh)
)\
ifnzman(\
noderef(Compatibility)
)\
. In addition to setting shell options, the command also restores
the pristine state of pattern enables, as if all patterns had been the pristine state of pattern enables, as if all patterns had been
enabled using tt(enable -p). enabled using tt(enable -p).
@@ -581,8 +569,7 @@ options that may in principle change, not just those that would actually
change. change.
The var(flags) may be any of the invocation-time flags described in The var(flags) may be any of the invocation-time flags described in
ifnzman(noderef(Invocation))\ sectref(Invocation)(zsh),
ifzman(the section INVOCATION in zmanref(zsh)),
except that `tt(-o EMACS)' and `tt(-o VI)' may not be used. Flags such except that `tt(-o EMACS)' and `tt(-o VI)' may not be used. Flags such
as `tt(+r)'/`tt(+o RESTRICTED)' may be prohibited in some circumstances. as `tt(+r)'/`tt(+o RESTRICTED)' may be prohibited in some circumstances.
@@ -693,8 +680,7 @@ With tt(-c) clear the environment; with tt(-l) prepend tt(-) to the
tt(argv[0]) string of the command executed (to simulate a login shell); tt(argv[0]) string of the command executed (to simulate a login shell);
with tt(-a) var(argv0) set the tt(argv[0]) string of the command with tt(-a) var(argv0) set the tt(argv[0]) string of the command
executed. executed.
See ifzman(the section `Precommand Modifiers' in zmanref(zshmisc))\ See sectref(Precommand Modifiers)(zshmisc).
ifnzman(noderef(Precommand Modifiers)).
If the option tt(POSIX_BUILTINS) is set, var(command) is never If the option tt(POSIX_BUILTINS) is set, var(command) is never
interpreted as a shell builtin command or shell function. This interpreted as a shell builtin command or shell function. This
@@ -715,9 +701,8 @@ pindex(IGNORE_EOF, use of)
An EOF condition will also cause the shell to exit, unless An EOF condition will also cause the shell to exit, unless
the tt(IGNORE_EOF) option is set. the tt(IGNORE_EOF) option is set.
See notes at the end of See notes at the end of sectref(Signals)(zshmisc)
ifzman(the section JOBS in zmanref(zshmisc))\ for some possibly unexpected interactions
ifnzman(noderef(Jobs & Signals)) for some possibly unexpected interactions
of the tt(exit) command with jobs. of the tt(exit) command with jobs.
) )
findex(export) findex(export)
@@ -762,8 +747,8 @@ following flags.
startsitem() startsitem()
sitem(tt(-I))(restricts to only internal events (not from tt($HISTFILE))) sitem(tt(-I))(restricts to only internal events (not from tt($HISTFILE)))
sitem(tt(-L))(restricts to only local events (not from other shells, see sitem(tt(-L))(restricts to only local events (not from other shells, see
tt(SHARE_HISTORY) in ifzman(zmanref(zshoptions))\ tt(SHARE_HISTORY) in
ifnzman(noderef(Description of Options)) -- note that tt($HISTFILE) is nmref(Description of Options)(zshoptions) -- note that tt($HISTFILE) is
considered local when read at startup)) considered local when read at startup))
sitem(tt(-m))(takes the first argument as a pattern (which should be sitem(tt(-m))(takes the first argument as a pattern (which should be
quoted) and only the history events matching this pattern are considered) quoted) and only the history events matching this pattern are considered)
@@ -801,8 +786,8 @@ sitem(tt(-i))(prints full time-date stamps in ISO8601
sitem(tt(-t) var(fmt))(prints time and date stamps in the given format; sitem(tt(-t) var(fmt))(prints time and date stamps in the given format;
var(fmt) is formatted with the strftime function with the zsh extensions var(fmt) is formatted with the strftime function with the zsh extensions
described for the tt(%D{)var(string)tt(}) prompt format in described for the tt(%D{)var(string)tt(}) prompt format in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ sectref(Simple Prompt Escapes)(zshmisc).
ifnzman(noderef(Prompt Expansion)). The resulting formatted string must be The resulting formatted string must be
no more than 256 characters or will not be printed no more than 256 characters or will not be printed
) )
sitem(tt(-D))(prints elapsed times; may be combined with one of the sitem(tt(-D))(prints elapsed times; may be combined with one of the
@@ -905,10 +890,8 @@ handled by tt(typeset -f).
tt(functions -M) var(mathfn) defines var(mathfn) as the name of tt(functions -M) var(mathfn) defines var(mathfn) as the name of
a mathematical function recognised in all forms of arithmetical expressions; a mathematical function recognised in all forms of arithmetical expressions;
see see sectref(Arithmetic Evaluation)(zshmisc).
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\ By default var(mathfn) may take
ifnzman(noderef(Arithmetic Evaluation))\
. By default var(mathfn) may take
any number of comma-separated arguments. If var(min) is given, any number of comma-separated arguments. If var(min) is given,
it must have exactly var(min) args; if var(min) and var(max) are it must have exactly var(min) args; if var(min) and var(max) are
both given, it must have at least var(min) and at most var(max) both given, it must have at least var(min) and at most var(max)
@@ -1179,9 +1162,7 @@ on systems that support tt(sigqueue+LPAR()RPAR()).
findex(let) findex(let)
item(tt(let) var(arg) ...)( item(tt(let) var(arg) ...)(
Evaluate each var(arg) as an arithmetic expression. Evaluate each var(arg) as an arithmetic expression.
See See sectref(Arithmetic Evaluation)(zshmisc)
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\
ifnzman(noderef(Arithmetic Evaluation))
for a description of arithmetic expressions. The exit status is 0 if the for a description of arithmetic expressions. The exit status is 0 if the
value of the last expression is nonzero, 1 if it is zero, and 2 if value of the last expression is nonzero, 1 if it is zero, and 2 if
an error occurred. an error occurred.
@@ -1316,10 +1297,7 @@ tt(-c) and tt(-C) options.
) )
item(tt(-b))( item(tt(-b))(
Recognize all the escape sequences defined for the tt(bindkey) command, Recognize all the escape sequences defined for the tt(bindkey) command,
see see sectref(Zle Builtins)(zshzle).
ifzman(the section `Zle Builtins' in zmanref(zshzle))\
ifnzman(noderef(Zle Builtins))\
.
) )
item(tt(-c))( item(tt(-c))(
Print the arguments in columns. Unless tt(-a) is also given, arguments are Print the arguments in columns. Unless tt(-a) is also given, arguments are
@@ -1367,9 +1345,7 @@ Print the arguments to the input of the coprocess.
) )
item(tt(-P))( item(tt(-P))(
Perform prompt expansion (see Perform prompt expansion (see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ sectref(Expansion of Prompt Sequences)(zshmisc)).
ifnzman(noderef(Prompt Expansion))\
).
In combination with `tt(-f)', In combination with `tt(-f)',
prompt escape sequences are parsed only within interpolated arguments, prompt escape sequences are parsed only within interpolated arguments,
not within the format string. not within the format string.
@@ -1443,9 +1419,7 @@ that allows it to be reused as shell input. With the numeric format
specifiers, if the corresponding argument starts with a quote character, specifiers, if the corresponding argument starts with a quote character,
the numeric value of the following character is used as the number to the numeric value of the following character is used as the number to
print; otherwise the argument is evaluated as an arithmetic expression. See print; otherwise the argument is evaluated as an arithmetic expression. See
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\ sectref(Arithmetic Evaluation)(zshmisc) for a description of arithmetic
ifnzman(noderef(Arithmetic Evaluation))
for a description of arithmetic
expressions. With `tt(%n)', the corresponding argument is taken as an expressions. With `tt(%n)', the corresponding argument is taken as an
identifier which is created as an integer parameter. identifier which is created as an integer parameter.
@@ -1565,9 +1539,8 @@ item(tt(-z))(
Read one entry from the editor buffer stack and assign it to the first Read one entry from the editor buffer stack and assign it to the first
var(name), without word splitting. Text is pushed onto the stack with var(name), without word splitting. Text is pushed onto the stack with
`tt(print -z)' or with tt(push-line) from the line editor (see `tt(print -z)' or with tt(push-line) from the line editor (see
ifzman(zmanref(zshzle))\ nmref(Zsh Line Editor)(zshzle)).
ifnzman(noderef(Zsh Line Editor))\ This flag is ignored when the tt(-k) or tt(-q) flags are present.
). This flag is ignored when the tt(-k) or tt(-q) flags are present.
) )
xitem(tt(-e)) xitem(tt(-e))
item(tt(-E))( item(tt(-E))(
@@ -1695,9 +1668,8 @@ declare and set an array. If the tt(-s) option is given, it causes the
specified arguments to be sorted before assigning them to the positional specified arguments to be sorted before assigning them to the positional
parameters (or to the array var(name) if tt(-A) is used). With tt(PLUS()s) parameters (or to the array var(name) if tt(-A) is used). With tt(PLUS()s)
sort arguments in descending order. For the meaning of the other flags, see sort arguments in descending order. For the meaning of the other flags, see
ifzman(zmanref(zshoptions))\ nmref(Options)(zshoptions).
ifnzman(noderef(Options))\ Flags may be specified by name using the tt(-o) option. If no option
. Flags may be specified by name using the tt(-o) option. If no option
name is supplied with tt(-o), the current option states are printed: see name is supplied with tt(-o), the current option states are printed: see
the description of tt(setopt) below for more information on the format. the description of tt(setopt) below for more information on the format.
With tt(PLUS()o) they are printed in a form that can be used as input With tt(PLUS()o) they are printed in a form that can be used as input
@@ -1748,8 +1720,7 @@ If no arguments are supplied, the names of all options currently set are
printed. The form is chosen so as to minimize the differences from the printed. The form is chosen so as to minimize the differences from the
default options for the current emulation (the default emulation being default options for the current emulation (the default emulation being
native tt(zsh), shown as tt(<Z>) in native tt(zsh), shown as tt(<Z>) in
ifzman(zmanref(zshoptions))\ sectref(Description of Options)(zshoptions)).
ifnzman(noderef(Description of Options))).
Options that are on by default for the emulation are Options that are on by default for the emulation are
shown with the prefix tt(no) only if they are off, while other options are shown with the prefix tt(no) only if they are off, while other options are
shown without the prefix tt(no) and only if they are on. In addition to shown without the prefix tt(no) and only if they are on. In addition to
@@ -1798,7 +1769,8 @@ findex(test)
xitem(tt(test) [ var(arg) ... ]) xitem(tt(test) [ var(arg) ... ])
item(tt([) [ var(arg) ... ] tt(]))( item(tt([) [ var(arg) ... ] tt(]))(
Like the system version of tt(test). Added for compatibility; Like the system version of tt(test). Added for compatibility;
use conditional expressions instead (see noderef(Conditional Expressions)). use conditional expressions instead (see
sectref(Conditional Expressions)(zshmisc)).
The main differences between the conditional expression syntax and the The main differences between the conditional expression syntax and the
tt(test) and tt([) builtins are: these commands are not handled tt(test) and tt([) builtins are: these commands are not handled
syntactically, so for example an empty variable expansion may cause an syntactically, so for example an empty variable expansion may cause an
@@ -1854,13 +1826,11 @@ If var(sig) is tt(DEBUG) then var(arg) will be executed
before each command if the option tt(DEBUG_BEFORE_CMD) is set before each command if the option tt(DEBUG_BEFORE_CMD) is set
(as it is by default), else after each command. Here, a `command' is (as it is by default), else after each command. Here, a `command' is
what is described as a `sublist' in the shell grammar, see what is described as a `sublist' in the shell grammar, see
ifnzman(noderef(Simple Commands & Pipelines))\ sectref(Simple Commands & Pipelines)(zshmisc).
ifzman(the section SIMPLE COMMANDS & PIPELINES in zmanref(zshmisc)).
If tt(DEBUG_BEFORE_CMD) is set various additional features are available. If tt(DEBUG_BEFORE_CMD) is set various additional features are available.
First, it is possible to skip the next command by setting the option First, it is possible to skip the next command by setting the option
tt(ERR_EXIT); see the description of the tt(ERR_EXIT) option in tt(ERR_EXIT); see the description of the tt(ERR_EXIT) option in
ifzman(zmanref(zshoptions))\ nmref(Description of Options)(zshoptions). Also, the shell parameter
ifnzman(noderef(Description of Options)). Also, the shell parameter
tt(ZSH_DEBUG_CMD) is set to the string corresponding to the command tt(ZSH_DEBUG_CMD) is set to the string corresponding to the command
to be executed following the trap. Note that this string is reconstructed to be executed following the trap. Note that this string is reconstructed
from the internal format and may not be formatted the same way as the from the internal format and may not be formatted the same way as the
@@ -1951,10 +1921,8 @@ Except as noted below for control flags that change the behavior,
a parameter is created for each var(name) that does not already refer a parameter is created for each var(name) that does not already refer
to one. When inside a function, a new parameter is created for every to one. When inside a function, a new parameter is created for every
var(name) (even those that already exist), and is unset again when the var(name) (even those that already exist), and is unset again when the
function completes. See function completes. See sectref(Local Parameters)(zshparam).
ifzman(`Local Parameters' in zmanref(zshparam))\ The same rules apply to special shell parameters, which
ifnzman(noderef(Local Parameters))\
. The same rules apply to special shell parameters, which
retain their special attributes when made local. retain their special attributes when made local.
For each var(name)tt(=)var(value) assignment, the parameter For each var(name)tt(=)var(value) assignment, the parameter
@@ -2072,8 +2040,8 @@ is applied to a named reference, the parameter identified by var(value)
is always found in the calling function scope rather than the current is always found in the calling function scope rather than the current
local scope. In this case, if there is no such parameter in the calling local scope. In this case, if there is no such parameter in the calling
scope, assignments to the named reference may fail, setting tt($?) to 1. scope, assignments to the named reference may fail, setting tt($?) to 1.
See ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)) and See sectref(Parameter Expansion)(zshexpn) and
ifzman(zmanref(zshparam))ifnzman(noderef(Parameters)) for details of the sectref(Named References)(zshparam) for details of the
behavior of named references. behavior of named references.
Local function scoping rules for `tt(typeset)' do apply with `tt(-n)', Local function scoping rules for `tt(typeset)' do apply with `tt(-n)',
@@ -2154,7 +2122,7 @@ readability.
The names and values of readonly special parameters The names and values of readonly special parameters
(most of the parameters marked `<S>' in (most of the parameters marked `<S>' in
ifzman(zmanref(zshparam))ifnzman(noderef(Parameters Set By The Shell)), sectref(Parameters Set by the Shell)(zshparam),
except those documented as settable) except those documented as settable)
are not printed with `tt(-)tt(p)' because to execute those typeset commands are not printed with `tt(-)tt(p)' because to execute those typeset commands
would cause errors. However, these parameters are printed when they would cause errors. However, these parameters are printed when they
@@ -2205,9 +2173,7 @@ The following attribute flags may be specified:
startitem() startitem()
item(tt(-A))( item(tt(-A))(
The names refer to associative array parameters; see The names refer to associative array parameters; see
ifzman(`Array Parameters' in zmanref(zshparam))\ sectref(Array Parameters)(zshparam).
ifnzman(noderef(Array Parameters))\
.
) )
item(tt(-L) [ var(n) ])( item(tt(-L) [ var(n) ])(
Left justify and remove leading blanks from the value when the parameter Left justify and remove leading blanks from the value when the parameter
@@ -2223,8 +2189,7 @@ if the tt(MULTIBYTE) option is in effect. Note that the screen
width of the character is not taken into account; if this is required, width of the character is not taken into account; if this is required,
use padding with parameter expansion flags use padding with parameter expansion flags
tt(${+LPAR()ml)var(...)tt(RPAR())var(...)tt(}) as described in tt(${+LPAR()ml)var(...)tt(RPAR())var(...)tt(}) as described in
`Parameter Expansion Flags' in subref(Parameter Expansion Flags)(zshexpn).
ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)).
When the parameter is expanded, it is filled on the right with When the parameter is expanded, it is filled on the right with
blanks or truncated if necessary to fit the field. blanks or truncated if necessary to fit the field.
@@ -2282,9 +2247,8 @@ tt(typeset -fU).
) )
item(tt(-h))( item(tt(-h))(
Hide: only useful for special parameters (those marked `<S>' in the table in Hide: only useful for special parameters (those marked `<S>' in the table in
ifzman(zmanref(zshparam))\ sectref(Parameters Set by the Shell)(zshparam)),
ifnzman(noderef(Parameters Set By The Shell))\ and for local parameters with the same name as a special parameter,
), and for local parameters with the same name as a special parameter,
though harmless for others. A special parameter with this attribute will though harmless for others. A special parameter with this attribute will
not retain its special effect when made local. Thus after `tt(typeset -h not retain its special effect when made local. Thus after `tt(typeset -h
PATH)', a function containing `tt(typeset PATH)' will create an ordinary PATH)', a function containing `tt(typeset PATH)' will create an ordinary
@@ -2645,13 +2609,7 @@ compiled file. If only the var(file) argument is given, the
output file has the name `var(file)tt(.zwc)' and will be placed in output file has the name `var(file)tt(.zwc)' and will be placed in
the same directory as the var(file). The shell will load the compiled the same directory as the var(file). The shell will load the compiled
file instead of the normal function file when the function file instead of the normal function file when the function
is autoloaded; see is autoloaded; see sectref(Autoloading Functions)(zshmisc)
ifzman(\
the section `Autoloading Functions' in zmanref(zshmisc)
)\
ifnzman(\
noderef(Functions)
)\
for a description of how autoloaded functions are searched. The for a description of how autoloaded functions are searched. The
extension tt(.zwc) stands for `zsh word code'. extension tt(.zwc) stands for `zsh word code'.

33
Doc/Zsh/calsys.yo
View File

@@ -33,14 +33,14 @@ endmenu()
texinode(Calendar File and Date Formats)(Calendar System User Functions)()(Calendar Function System) texinode(Calendar File and Date Formats)(Calendar System User Functions)()(Calendar Function System)
anchor(File and Date Formats)
sect(File and Date Formats) sect(File and Date Formats)
subsect(Calendar File Format) subsect(Calendar File Format)
The calendar file is by default tt(~/calendar). This can be configured The calendar file is by default tt(~/calendar). This can be configured
by the tt(calendar-file) style, see by the tt(calendar-file) style, see sectref(Styles)(below).
ifzman(the section STYLES below)\ The basic format consists
ifnzman(noderef(Calendar Styles)). The basic format consists
of a series of separate lines, with no indentation, each including of a series of separate lines, with no indentation, each including
a date and time specification followed by a description of the event. a date and time specification followed by a description of the event.
@@ -316,7 +316,7 @@ directly by the user. The first part describes those functions
associated with the user's calendar; the second part describes associated with the user's calendar; the second part describes
the use in glob qualifiers. the use in glob qualifiers.
subsect(Calendar system functions) subsect(Calendar System Functions)
startitem() startitem()
findex(calendar) findex(calendar)
@@ -393,9 +393,7 @@ only runs if the shell is at an interactive prompt; a foreground task
blocks the scheduled task from running until it is finished. blocks the scheduled task from running until it is finished.
The timed event usually runs the programme tt(calendar_show) to show The timed event usually runs the programme tt(calendar_show) to show
the event, as described in the event, as described in sectref(Utility Functions)(below).
ifzman(the section UTILITY FUNCTIONS below)\
ifnzman(noderef(Calendar Utility Functions)).
By default, a warning of the event is shown five minutes before it is due. By default, a warning of the event is shown five minutes before it is due.
The warning period can be configured by the style tt(warn-time) or The warning period can be configured by the style tt(warn-time) or
@@ -477,8 +475,7 @@ findex(calendar_add)
item(tt(calendar_add) [ tt(-BL) ] var(event) ...)( item(tt(calendar_add) [ tt(-BL) ] var(event) ...)(
Adds a single event to the calendar in the appropriate location. Adds a single event to the calendar in the appropriate location.
The event can contain multiple lines, as described in The event can contain multiple lines, as described in
ifnzman(noderef(Calendar File and Date Formats))\ sectref(File and Date Formats)(above).
ifzman(the section `Calendar File Format' above).
Using this function ensures that the calendar file is sorted in date Using this function ensures that the calendar file is sorted in date
and time order. It also makes special arrangements for locking and time order. It also makes special arrangements for locking
the file while it is altered. The old calendar is left in a file the file while it is altered. The old calendar is left in a file
@@ -607,7 +604,7 @@ left in a file with the suffix tt(.old).
) )
enditem() enditem()
subsect(Glob qualifiers) subsect(Glob Qualifiers)
startitem() startitem()
item(tt(age))( item(tt(age))(
@@ -620,8 +617,7 @@ only the builtin tt(zstat).
tt(age) selects files having a given modification time for use tt(age) selects files having a given modification time for use
as a glob qualifier. The format of the date is the same as that as a glob qualifier. The format of the date is the same as that
understood by the calendar system, described in understood by the calendar system, described in
ifzman(the section FILE AND DATE FORMATS above)\ sectref(File and Date Formats)(above).
ifnzman(noderef(Calendar File and Date Formats)).
The function can take one or two arguments, which can be supplied either The function can take one or two arguments, which can be supplied either
directly as command or arguments, or separately as shell parameters. directly as command or arguments, or separately as shell parameters.
@@ -699,11 +695,11 @@ print *+LPAR()e-after today:12:00-RPAR())
enditem() enditem()
texinode(Calendar Styles)(Calendar Utility Functions)(Calendar System User Functions)(Calendar Function System) texinode(Calendar Styles)(Calendar Utility Functions)(Calendar System User Functions)(Calendar Function System)
anchor(Styles)
sect(Styles) sect(Styles)
The zsh style mechanism using the tt(zstyle) command is describe in The zsh style mechanism using the tt(zstyle) command is describe in
ifzman(zmanref(zshmodules))\ sectref(The zsh/zutil Module)(zshmodules). This is the same mechanism
ifnzman(noderef(The zsh/zutil Module)). This is the same mechanism
used in the completion system. used in the completion system.
The styles below are all examined in the context The styles below are all examined in the context
@@ -720,8 +716,7 @@ A tt(strftime) format string (see manref(strftime)(3)) with the zsh
extensions providing various numbers with no leading zero or space extensions providing various numbers with no leading zero or space
if the number is a single digit as described for the if the number is a single digit as described for the
tt(%D{)var(string)tt(}) prompt format in tt(%D{)var(string)tt(}) prompt format in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ sectref(Simple Prompt Escapes)(zshmisc).
ifnzman(noderef(Prompt Expansion)).
This is used for outputting dates in tt(calendar), both to support This is used for outputting dates in tt(calendar), both to support
the tt(-v) option and when adding recurring events back to the calendar the tt(-v) option and when adding recurring events back to the calendar
@@ -766,6 +761,7 @@ enditem()
texinode(Calendar Utility Functions)(Calendar Bugs)(Calendar Styles)(Calendar Function System) texinode(Calendar Utility Functions)(Calendar Bugs)(Calendar Styles)(Calendar Function System)
anchor(Utility functions)
sect(Utility functions) sect(Utility functions)
startitem() startitem()
@@ -805,9 +801,8 @@ findex(calendar_scandate)
item(tt(calendar_scandate))( item(tt(calendar_scandate))(
This is a generic function to parse dates and times that may be This is a generic function to parse dates and times that may be
used separately from the calendar system. The argument is a date used separately from the calendar system. The argument is a date
or time specification as described in or time specification as described in sectref(File and Date Formats)(above).
ifzman(the section FILE AND DATE FORMATS above)\ The parameter tt(REPLY)
ifnzman(noderef(Calendar File and Date Formats)). The parameter tt(REPLY)
is set to the number of seconds since the epoch corresponding to that date is set to the number of seconds since the epoch corresponding to that date
or time. By default, the date and time may occur anywhere within the given or time. By default, the date and time may occur anywhere within the given
argument. argument.

20
Doc/Zsh/compctl.yo
View File

@@ -134,10 +134,8 @@ the default. In other words, completion will subsequently use the
options specified by the tt(-D) flag. options specified by the tt(-D) flag.
The form with tt(-M) as the first and only option defines global The form with tt(-M) as the first and only option defines global
matching specifications (see matching specifications (see sectref(Completion Matching Control)(zshcompwid)).
ifzman(zshcompwid)\ The match specifications given will be used for every completion
ifnzman(noderef(Completion Matching Control))\
). The match specifications given will be used for every completion
attempt (only when using tt(compctl), not with the new completion attempt (only when using tt(compctl), not with the new completion
system) and are tried in the order in which they are defined until one system) and are tried in the order in which they are defined until one
generates at least one match. E.g.: generates at least one match. E.g.:
@@ -222,10 +220,7 @@ will complete names of functions, builtins, reserved words or aliases
whether or not they are disabled. whether or not they are disabled.
) )
item(tt(-o))( item(tt(-o))(
Names of shell options (see Names of shell options (see nmref(Options)(zshoptions)).
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Options))\
).
) )
item(tt(-v))( item(tt(-v))(
Names of any variable defined in the shell. Names of any variable defined in the shell.
@@ -301,9 +296,8 @@ globbing. Use the syntax `tt((either|or))' to match alternatives.)
item(tt(-s) var(subststring))( item(tt(-s) var(subststring))(
The var(subststring) is split into words and these words are than The var(subststring) is split into words and these words are than
expanded using all shell expansion mechanisms (see expanded using all shell expansion mechanisms (see
ifzman(zmanref(zshexpn))\ nmref(Expansion)(zshexpn)).
ifnzman(noderef(Expansion))\ The resulting words are taken as possible
). The resulting words are taken as possible
completions. The tt(fignore) special parameter is not applied to the completions. The tt(fignore) special parameter is not applied to the
resulting files. Note that tt(-g) is faster for filenames. resulting files. Note that tt(-g) is faster for filenames.
) )
@@ -540,9 +534,7 @@ item(tt(-M) var(match-spec))(
This defines additional matching control specifications that should be used This defines additional matching control specifications that should be used
only when testing words for the list of flags this flag appears in. The format only when testing words for the list of flags this flag appears in. The format
of the var(match-spec) string is described in of the var(match-spec) string is described in
ifzman(zshcompwid)\ sectref(Completion Matching Control)(zshcompwid).
ifnzman(noderef(Completion Matching Control))\
.
) )
enditem() enditem()

114
Doc/Zsh/compsys.yo
View File

@@ -15,9 +15,7 @@ The features are contextual, sensitive to the point at which completion is
started. Many completions are already provided. started. Many completions are already provided.
For this reason, a user can perform a great many tasks without For this reason, a user can perform a great many tasks without
knowing any details beyond how to initialize the system, which is knowing any details beyond how to initialize the system, which is
described described sectref(Initialization)(below).
ifzman(below in INITIALIZATION)\
ifnzman(in noderef(Initialization)).
The context that decides what completion is to be performed may be The context that decides what completion is to be performed may be
startitemize() startitemize()
@@ -49,8 +47,7 @@ Styles modify various operations of the completion system, such as
output formatting, but also what kinds of completers are used (and in output formatting, but also what kinds of completers are used (and in
what order), or which tags are examined. Styles may accept arguments what order), or which tags are examined. Styles may accept arguments
and are manipulated using the tt(zstyle) command described in and are manipulated using the tt(zstyle) command described in
ifzman(zmanref(zshmodules))\ sectref(The zsh/zutil Module)(zshmodules).
ifnzman(noderef(The zsh/zutil Module)).
In summary, tags describe em(what) the completion objects are, and style In summary, tags describe em(what) the completion objects are, and style
tt(how) they are to be completed. At various points of execution, the tt(how) they are to be completed. At various points of execution, the
@@ -58,8 +55,7 @@ completion system checks what styles and/or tags are defined for the
current context, and uses that to modify its behavior. The full current context, and uses that to modify its behavior. The full
description of context handling, which determines how tags and other description of context handling, which determines how tags and other
elements of the context influence the behaviour of styles, is described elements of the context influence the behaviour of styles, is described
ifzman(below in COMPLETION SYSTEM CONFIGURATION)\ sectref(Completion System Configuration)(below).
ifnzman(in noderef(Completion System Configuration)).
When a completion is requested, a dispatcher function is called; When a completion is requested, a dispatcher function is called;
see the description of tt(_main_complete) in the list of control functions see the description of tt(_main_complete) in the list of control functions
@@ -210,7 +206,7 @@ tt(complete) which correspond to the bash builtins with the same names.
It will then be possible to use completion specifications and functions It will then be possible to use completion specifications and functions
written for bash. written for bash.
subsect(Autoloaded files) subsect(Autoloaded Files)
cindex(completion system, autoloaded functions) cindex(completion system, autoloaded functions)
The convention for autoloaded functions used in completion is that they The convention for autoloaded functions used in completion is that they
@@ -274,9 +270,8 @@ completion, namely tt(complete-word), tt(delete-char-or-list),
tt(expand-or-complete), tt(expand-or-complete-prefix), tt(list-choices), tt(expand-or-complete), tt(expand-or-complete-prefix), tt(list-choices),
tt(menu-complete), tt(menu-expand-or-complete), or tt(menu-complete), tt(menu-expand-or-complete), or
tt(reverse-menu-complete). If the tt(zsh/complist) module is loaded (see tt(reverse-menu-complete). If the tt(zsh/complist) module is loaded (see
ifzman(zmanref(zshmodules))\ sectref(The zsh/complist Module)(zshmodules))
ifnzman(noderef(The zsh/complist Module))\ the widget tt(menu-select) is also available.
) the widget tt(menu-select) is also available.
When one of the var(key-sequence)s is typed, the function in the file will When one of the var(key-sequence)s is typed, the function in the file will
be invoked to generate the matches. Note that a key will not be re-bound be invoked to generate the matches. Note that a key will not be re-bound
@@ -567,9 +562,8 @@ The next few paragraphs explain how a context is composed within the
completion function suite. Following that is discussion of how em(styles) completion function suite. Following that is discussion of how em(styles)
are defined. Styles determine such things as how the matches are are defined. Styles determine such things as how the matches are
generated, similarly to shell options but with much more control. They generated, similarly to shell options but with much more control. They
are defined with the tt(zstyle) builtin command (\ are defined with the tt(zstyle) builtin command
ifzman(see zmanref(zshmodules))\ (see sectref(The zsh/zutil Module)(zshmodules)).
ifnzman(noderef(The zsh/zutil Module))).
The context string always consists of a fixed set of fields, separated The context string always consists of a fixed set of fields, separated
by colons and with a leading colon before the first. Fields which are by colons and with a leading colon before the first. Fields which are
@@ -596,10 +590,7 @@ leading underscore and with other underscores converted to hyphens. A
`completer' is in overall control of how completion is to be performed; `completer' is in overall control of how completion is to be performed;
`tt(complete)' is the simplest, but other completers exist to perform `tt(complete)' is the simplest, but other completers exist to perform
related tasks such as correction, or to modify the behaviour of a later related tasks such as correction, or to modify the behaviour of a later
completer. See completer. See sectref(Control Functions)(below) for more information.
ifzman(the section `Control Functions' below)\
ifnzman(noderef(Control Functions))
for more information.
) )
itemiz(\ itemiz(\
The var(command) or a special tt(-)var(context)tt(-), just at it appears The var(command) or a special tt(-)var(context)tt(-), just at it appears
@@ -651,9 +642,7 @@ tags in the given order.
The tt(_complete_help) bindable command shows all the contexts and tags The tt(_complete_help) bindable command shows all the contexts and tags
available for completion at a particular point. This provides an easy available for completion at a particular point. This provides an easy
way of finding information for tt(tag-order) and other styles. It is way of finding information for tt(tag-order) and other styles. It is
described in described in sectref(Bindable Commands)(below).
ifzman(the section `Bindable Commands' below)\
ifnzman(noderef(Bindable Commands)).
When looking up styles the completion system uses full context names, When looking up styles the completion system uses full context names,
including the tag. Looking up the value of a style therefore consists of including the tag. Looking up the value of a style therefore consists of
@@ -694,9 +683,7 @@ example(zstyle ':completion:*:*:kill:*:jobs' verbose no)
The tt(-e) option to tt(zstyle) even allows completion function code to The tt(-e) option to tt(zstyle) even allows completion function code to
appear as the argument to a style; this requires some understanding of appear as the argument to a style; this requires some understanding of
the internals of completion functions (see the internals of completion functions (see
ifzman(see zmanref(zshcompwid))\ nmref(Completion Widgets)(zshcompwid)). For example,
ifnzman(noderef(Completion Widgets)))\
). For example,
example(tt(zstyle -e ':completion:*' hosts 'reply=($myhosts)')) example(tt(zstyle -e ':completion:*' hosts 'reply=($myhosts)'))
@@ -713,9 +700,8 @@ style mechanism uses the most specific possible match for a particular
style to determine the set of values. Strings are style to determine the set of values. Strings are
preferred over patterns (for example, `tt(:completion::complete:::foo)' is preferred over patterns (for example, `tt(:completion::complete:::foo)' is
more specific than `tt(:completion::complete:::*')), and longer patterns are more specific than `tt(:completion::complete:::*')), and longer patterns are
preferred over the pattern `tt(*)'. See preferred over the pattern `tt(*)'. See
ifzman(zmanref(zmodules))ifnzman(noderef(The zsh/zutil Module)) sectref(The zsh/zutil Module)(zshmodules) for details.
for details.
Context patterns that use something other than a wildcard (tt(*)) to match the Context patterns that use something other than a wildcard (tt(*)) to match the
middle parts of the context DASH()- the var(completer), var(command), and middle parts of the context DASH()- the var(completer), var(command), and
@@ -1103,6 +1089,7 @@ for shell options
) )
enditem() enditem()
anchor(Standard Styles)
subsect(Standard Styles) subsect(Standard Styles)
cindex(completion system, styles) cindex(completion system, styles)
@@ -1309,10 +1296,7 @@ kindex(completer, completion style)
item(tt(completer))( item(tt(completer))(
The strings given as the value of this style provide the names of the The strings given as the value of this style provide the names of the
completer functions to use. The available completer functions are completer functions to use. The available completer functions are
described in described in sectref(Control Functions)(below).
ifzman(the section `Control Functions' below)\
ifnzman(noderef(Control Functions))\
.
Each string may be either the name of a completer function or a string Each string may be either the name of a completer function or a string
of the form `var(function)tt(:)var(name)'. In the first case the of the form `var(function)tt(:)var(name)'. In the first case the
@@ -1628,10 +1612,7 @@ string to display above matches in completion lists. The sequence
`tt(%d)' in this string will be replaced with a short description of `tt(%d)' in this string will be replaced with a short description of
what these matches are. This string may also contain the output what these matches are. This string may also contain the output
attribute sequences understood by tt(compadd -X) attribute sequences understood by tt(compadd -X)
(see (see sectref(Completion Builtin Commands)(zshcompwid)).
ifzman(zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets))\
).
The style is tested with each tag valid for the current completion The style is tested with each tag valid for the current completion
before it is tested for the tt(descriptions) tag. Hence different format before it is tested for the tt(descriptions) tag. Hence different format
@@ -1654,9 +1635,7 @@ the same descriptions separated by newlines.
It is possible to use printf-style field width specifiers with `tt(%d)' It is possible to use printf-style field width specifiers with `tt(%d)'
and similar escape sequences. This is handled by the tt(zformat) and similar escape sequences. This is handled by the tt(zformat)
builtin command from the tt(zsh/zutil) module, see builtin command from the tt(zsh/zutil) module, see
ifzman(zmanref(zshmodules))\ sectref(The zsh/zutil Module)(zshmodules).
ifnzman(noderef(The zsh/zutil Module))\
.
) )
kindex(gain-privileges, completion style) kindex(gain-privileges, completion style)
item(tt(gain-privileges))( item(tt(gain-privileges))(
@@ -1955,9 +1934,7 @@ item(tt(list-colors))(
If the tt(zsh/complist) module is loaded, this style can be used to set If the tt(zsh/complist) module is loaded, this style can be used to set
color specifications. This mechanism replaces the use of the color specifications. This mechanism replaces the use of the
tt(ZLS_COLORS) and tt(ZLS_COLOURS) parameters described in tt(ZLS_COLORS) and tt(ZLS_COLOURS) parameters described in
ifzman(the section `The zsh/complist Module' in zmanref(zshmodules))\ sectref(The zsh/complist Module)(zshmodules), but the syntax is the same.
ifnzman(noderef(The zsh/complist Module))\
, but the syntax is the same.
If this style is set for the tt(default) tag, the strings in the value If this style is set for the tt(default) tag, the strings in the value
are taken as specifications that are to be used everywhere. If it is are taken as specifications that are to be used everywhere. If it is
@@ -2006,9 +1983,8 @@ kindex(list-prompt, completion style)
item(tt(list-prompt))( item(tt(list-prompt))(
If this style is set for the tt(default) tag, If this style is set for the tt(default) tag,
completion lists that don't fit on the screen can be scrolled (see completion lists that don't fit on the screen can be scrolled (see
ifzman(the description of the tt(zsh/complist) module in zmanref(zshmodules))\ sectref(The zsh/complist Module)(zshmodules)).
ifnzman(noderef(The zsh/complist Module))\ The value, if not the empty string, will be displayed after every
). The value, if not the empty string, will be displayed after every
screenful and the shell will prompt for a key press; if the style is screenful and the shell will prompt for a key press; if the style is
set to the empty string, set to the empty string,
a default prompt will be used. a default prompt will be used.
@@ -2092,9 +2068,8 @@ This style is tested separately for each tag valid in the current
context. Its value is placed before any match specifications given by the context. Its value is placed before any match specifications given by the
tt(matcher-list) style so can override them via the use of an tt(x:) tt(matcher-list) style so can override them via the use of an tt(x:)
specification. The value should be in the form described in specification. The value should be in the form described in
ifzman(the section `Completion Matching Control' in zmanref(zshcompwid))\ sectref(Completion Matching Control)(zshcompwid).
ifnzman(noderef(Completion Matching Control))\ For examples of this, see the description of the tt(tag-order) style.
. For examples of this, see the description of the tt(tag-order) style.
For notes comparing the use of this and the tt(matcher-list) style, see For notes comparing the use of this and the tt(matcher-list) style, see
under the description of the tt(tag-order) style. under the description of the tt(tag-order) style.
@@ -2103,9 +2078,7 @@ kindex(matcher-list, completion style)
item(tt(matcher-list))( item(tt(matcher-list))(
This style can be set to a list of match specifications that are to This style can be set to a list of match specifications that are to
be applied everywhere. Match specifications are described in be applied everywhere. Match specifications are described in
ifzman(the section `Completion Matching Control' in zmanref(zshcompwid))\ sectref(Completion Matching Control)(zshcompwid)).
ifnzman(noderef(Completion Matching Control))\
.
The completion system will try them one after another for each completer The completion system will try them one after another for each completer
selected. For example, to try first simple completion and, if that selected. For example, to try first simple completion and, if that
generates no matches, case-insensitive completion: generates no matches, case-insensitive completion:
@@ -2262,8 +2235,7 @@ with a number and once with `tt(long)' or `tt(long-list)'.
Finally, it is possible to activate two special modes of menu selection. Finally, it is possible to activate two special modes of menu selection.
The word `tt(interactive)' in the value causes interactive mode The word `tt(interactive)' in the value causes interactive mode
to be entered immediately when menu selection is started; see to be entered immediately when menu selection is started; see
ifzman(the description of the tt(zsh/complist) module in zmanref(zshmodules))\ sectref(The zsh/complist Module)(zshmodules)
ifnzman(noderef(The zsh/complist Module))
for a description of interactive mode. Including the string for a description of interactive mode. Including the string
`tt(search)' does the same for incremental search mode. To select backward `tt(search)' does the same for incremental search mode. To select backward
incremental search, include the string `tt(search-backward)'. incremental search, include the string `tt(search-backward)'.
@@ -2790,9 +2762,7 @@ example(zstyle -e '*:-command-:*' tag-order '
Completion in command position will be attempted only if the string Completion in command position will be attempted only if the string
typed so far is not empty. This is tested using the tt(PREFIX) typed so far is not empty. This is tested using the tt(PREFIX)
special parameter; see special parameter; see sectref(Completion Special Parameters)(zshcompwid)
ifzman(zshcompwid)\
ifnzman(noderef(Completion Widgets))
for a description of parameters which are special inside completion widgets. for a description of parameters which are special inside completion widgets.
Setting tt(reply) to an empty array provides the default Setting tt(reply) to an empty array provides the default
behaviour of trying all tags at once; setting it to an behaviour of trying all tags at once; setting it to an
@@ -2994,14 +2964,8 @@ findex(_approximate)
item(tt(_approximate))( item(tt(_approximate))(
This is similar to the basic tt(_complete) completer but allows the This is similar to the basic tt(_complete) completer but allows the
completions to undergo corrections. The maximum number of errors can be completions to undergo corrections. The maximum number of errors can be
specified by the tt(max-errors) style; see the description of specified by the tt(max-errors) style; see
approximate matching in sectref(Approximate Matching)(zshexpn)
ifzman(\
zmanref(zshexpn)
)\
ifnzman(\
noderef(Filename Generation)
)\
for how errors are counted. Normally this completer will only be tried for how errors are counted. Normally this completer will only be tried
after the normal tt(_complete) completer: after the normal tt(_complete) completer:
@@ -3186,8 +3150,7 @@ completers are called. The types of aliases which are to be expanded can
be controlled with the styles tt(regular), tt(global) and tt(disabled). be controlled with the styles tt(regular), tt(global) and tt(disabled).
This function is also a bindable command, see This function is also a bindable command, see
ifzman(the section `Bindable Commands' below)\ sectref(Bindable Commands)(below).
ifnzman(noderef(Bindable Commands)).
) )
findex(_extensions) findex(_extensions)
item(tt(_extensions))( item(tt(_extensions))(
@@ -3212,11 +3175,9 @@ item(tt(_history))(
Complete words from the shell's command history. This completer Complete words from the shell's command history. This completer
can be controlled by the tt(remove-all-dups), and tt(sort) styles as for the can be controlled by the tt(remove-all-dups), and tt(sort) styles as for the
tt(_history_complete_word) bindable command, see tt(_history_complete_word) bindable command, see
ifzman(the section `Bindable Commands' below)\ sectref(Bindable Commands)(below)
ifnzman(noderef(Bindable Commands))
and and
ifzman(the section `Completion System Configuration' above)\ sectref(Completion System Configuration)(above).
ifnzman(noderef(Completion System Configuration)).
) )
findex(_ignored) findex(_ignored)
item(tt(_ignored))( item(tt(_ignored))(
@@ -3234,8 +3195,7 @@ This completer allows the insertion of matches to be delayed until
completion is attempted a second time without the word on the line completion is attempted a second time without the word on the line
being changed. On the first attempt, only the list of matches will be being changed. On the first attempt, only the list of matches will be
shown. It is affected by the styles tt(condition) and tt(word), see shown. It is affected by the styles tt(condition) and tt(word), see
ifzman(the section `Completion System Configuration' above)\ sectref(Completion System Configuration)(above).
ifnzman(noderef(Completion System Configuration)).
) )
findex(_match) findex(_match)
item(tt(_match))( item(tt(_match))(
@@ -3278,9 +3238,7 @@ list of completions thus generated, instead of producing a new list of
ordinary contextual completions. ordinary contextual completions.
It should appear in the list of completers before any of It should appear in the list of completers before any of
the widgets which generate matches. It uses two styles: tt(old-list) and the widgets which generate matches. It uses two styles: tt(old-list) and
tt(old-menu), see tt(old-menu), see sectref(Completion System Configuration)(above).
ifzman(the section `Completion System Configuration' above)\
ifnzman(noderef(Completion System Configuration)).
) )
findex(_precommand) findex(_precommand)
item(tt(_precommand))( item(tt(_precommand))(
@@ -5472,12 +5430,10 @@ the same meaning as for tt(_description).
findex(_widgets) findex(_widgets)
item(tt(_widgets) [ tt(-g) var(pattern) ])( item(tt(_widgets) [ tt(-g) var(pattern) ])(
This function completes names of zle widgets (see This function completes names of zle widgets (see
ifzman(the section `Widgets' in zmanref(zshzle))\ sectref(Zle Widgets)(zshzle)).
ifnzman(noderef(Zle Widgets))\ The var(pattern), if present, is matched against values of the tt($widgets)
). The var(pattern), if present, is matched against values of the tt($widgets)
special parameter, documented in special parameter, documented in
ifzman(the section `The zsh/zleparameter Module' in zmanref(zshmodules))\ sectref(The zsh/zleparameter Module)(zshmodules).
ifnzman(noderef(The zsh/zleparameter Module)).
) )
enditem() enditem()

58
Doc/Zsh/compwid.yo
View File

@@ -13,15 +13,11 @@ ifnzman(the next chapter, noderef(Completion System)),
and users with no interest in adding to that system (or, potentially, and users with no interest in adding to that system (or, potentially,
writing their own DASH()- see dictionary entry for `hubris') should skip writing their own DASH()- see dictionary entry for `hubris') should skip
the current section. The older system based on the tt(compctl) builtin the current section. The older system based on the tt(compctl) builtin
command is described in command is described in nmref(Completion Using compctl)(zshcompctl).
ifzman(zmanref(zshcompctl))\
ifnzman(noderef(Completion Using compctl)).
Completion widgets are defined by the tt(-C) option to the tt(zle) Completion widgets are defined by the tt(-C) option to the tt(zle)
builtin command provided by the tt(zsh/zle) module (see builtin command provided by the tt(zsh/zle) module (see
ifzman(zmanref(zshzle))\ sectref(Zle Builtins)(zshzle)). For example,
ifnzman(noderef(The zsh/zle Module))\
). For example,
example(zle -C complete expand-or-complete completer) example(zle -C complete expand-or-complete completer)
@@ -35,10 +31,8 @@ work even if the widget in question has been re-bound.
When this newly defined widget is bound to a key When this newly defined widget is bound to a key
using the tt(bindkey) builtin command defined in the tt(zsh/zle) module using the tt(bindkey) builtin command defined in the tt(zsh/zle) module
(\ (see sectref(Zle Builtins)(zshzle)),
ifzman(see zmanref(zshzle))\ typing that key will call the shell function `tt(completer)'. This
ifnzman(noderef(Zsh Line Editor))\
), typing that key will call the shell function `tt(completer)'. This
function is responsible for generating completion matches using the function is responsible for generating completion matches using the
builtins described below. As with other ZLE widgets, the function is builtins described below. As with other ZLE widgets, the function is
called with its standard input closed. called with its standard input closed.
@@ -60,8 +54,7 @@ sect(Completion Special Parameters)
The parameters tt(ZLE_REMOVE_SUFFIX_CHARS) and tt(ZLE_SPACE_SUFFIX_CHARS) The parameters tt(ZLE_REMOVE_SUFFIX_CHARS) and tt(ZLE_SPACE_SUFFIX_CHARS)
are used by the completion mechanism, but are not special. See are used by the completion mechanism, but are not special. See
ifzman(em(Parameters Used By The Shell) in zmanref(zshparam))\ sectref(Parameters Used by the Shell)(zshparam).
ifnzman(noderef(Parameters Used By The Shell)).
Inside completion widgets, and any functions called from them, some Inside completion widgets, and any functions called from them, some
parameters have special meaning; outside these functions they are not parameters have special meaning; outside these functions they are not
@@ -594,10 +587,8 @@ The var(explanation) string will be printed with the list of matches,
above the group currently selected. above the group currently selected.
Within the var(explanation), the following sequences may be used to Within the var(explanation), the following sequences may be used to
specify output attributes specify output attributes as described in
ifnzman((see noderef(Prompt Expansion)))\ sectref(Expansion of Prompt Sequences)(zshmisc):
ifzman(as described in the section EXPANSION OF PROMPT SEQUENCES in
zmanref(zshmisc)):
`tt(%B)', `tt(%S)', `tt(%U)', `tt(%F)', `tt(%K)' and their lower case `tt(%B)', `tt(%S)', `tt(%U)', `tt(%F)', `tt(%K)' and their lower case
counterparts, as well as `tt(%H)' and `tt(%{)...tt(%})'. `tt(%F)', counterparts, as well as `tt(%H)' and `tt(%{)...tt(%})'. `tt(%F)',
`tt(%K)', `tt(%H)' and `tt(%K)', `tt(%H)' and
@@ -607,11 +598,7 @@ argument to `tt(%{)' should be used instead.) The sequence `tt(%%)'
produces a literal `tt(%)'. produces a literal `tt(%)'.
These sequences are most often employed by users when customising the These sequences are most often employed by users when customising the
tt(format) style tt(format) style (see subref(Standard Styles)(zshcompsys)),
(see
ifzman(zmanref(zshcompsys))\
ifnzman(noderef(Completion System))\
),
but they must also be taken into account when writing completion but they must also be taken into account when writing completion
functions, as passing descriptions with unescaped `tt(%)' characters functions, as passing descriptions with unescaped `tt(%)' characters
to utility functions such as tt(_arguments) and tt(_message) may to utility functions such as tt(_arguments) and tt(_message) may
@@ -652,8 +639,7 @@ has been accepted and a suffix has been inserted, the function
var(remove-func) will be called after the next character typed. It is var(remove-func) will be called after the next character typed. It is
passed the length of the suffix as an argument and can use the special passed the length of the suffix as an argument and can use the special
parameters available in ordinary (non-completion) zle widgets (see parameters available in ordinary (non-completion) zle widgets (see
ifzman(zmanref(zshzle))\ sectref(User-Defined Widgets)(zshzle)
ifnzman(noderef(Zsh Line Editor))\
) to analyse and modify the command line. ) to analyse and modify the command line.
) )
item(tt(-f))( item(tt(-f))(
@@ -921,10 +907,8 @@ enditemize()
This narrow pattern can be broadened selectively by passing a em(match This narrow pattern can be broadened selectively by passing a em(match
specification) to the tt(compadd) builtin command through its tt(-M) option specification) to the tt(compadd) builtin command through its tt(-M) option
(see (see sectref(Completion Builtin Commands)(above)).
ifzman(`Completion Builtin Commands' above)\ A match specification consists of one or more var(matchers) separated by
ifnzman(noderef(Completion Builtin Commands))\
). A match specification consists of one or more var(matchers) separated by
whitespace. Matchers in a match specification are applied one at a time, from whitespace. Matchers in a match specification are applied one at a time, from
left to right. Once all matchers have been applied, completions are compared left to right. Once all matchers have been applied, completions are compared
to the final match pattern and non-matching ones are discarded. to the final match pattern and non-matching ones are discarded.
@@ -934,22 +918,15 @@ itemiz(\
Note that the tt(-M) option is ignored if the current word contains a glob Note that the tt(-M) option is ignored if the current word contains a glob
pattern and the shell option tt(GLOB_COMPLETE) is set or if the pattern and the shell option tt(GLOB_COMPLETE) is set or if the
tt(pattern_match) key of the special associative array tt(compstate) is set to tt(pattern_match) key of the special associative array tt(compstate) is set to
a non-empty value (see a non-empty value (see sectref(Completion Special Parameters)(above)).
ifzman(`Completion Special Parameters' above)\
ifnzman(noderef(Completion Special Parameters))\
).\
) )
itemiz(\ itemiz(\
Users of the \ Users of the \
ifzman(completion system (see zmanref(zshcompsys))) \ ifzman(completion system (see zmanref(zshcompsys))) \
ifnzman(noderef(Completion System)) \ ifnzman(noderef(Completion System)) \
should generally not use the tt(-M) option directly, but rather use the should generally not use the tt(-M) option directly, but rather use the
tt(matcher-list) and tt(matcher) styles (see the subsection em(Standard Styles) tt(matcher-list) and tt(matcher) styles (see
in subref(Standard Styles)(zshcompsys)).
ifzman(\
the documentation for COMPLETION SYSTEM CONFIGURATION in zmanref(zshcompsys))\
ifnzman(noderef(Completion System Configuration))\
).\
) )
enditemize() enditemize()
@@ -977,11 +954,8 @@ startitemize()
itemiz(literal characters (which may be quoted with a `tt(\)'),) itemiz(literal characters (which may be quoted with a `tt(\)'),)
itemiz(question marks (`tt(?)'),) itemiz(question marks (`tt(?)'),)
itemiz(\ itemiz(\
bracket expressions (`tt([...])'; see the subsection em(Glob Operators) in bracket expressions (`tt([...])'; see subref(Glob Operators)(zshexpn)),
ifnzman(noderef(Filename Generation))\ and/or)
ifzman(the documentation for GLOB OPERATORS in zmanref(zshexpn))\
), and/or\
)
itemiz(brace expressions (see below).) itemiz(brace expressions (see below).)
enditemize() enditemize()
) )

13
Doc/Zsh/cond.yo
View File

@@ -44,7 +44,7 @@ true if length of var(string) is non-zero.
item(tt(-o) var(option))( item(tt(-o) var(option))(
true if option named var(option) is on. var(option) true if option named var(option) is on. var(option)
may be a single character, in which case it is a single letter option name. may be a single character, in which case it is a single letter option name.
(See noderef(Specifying Options).) (See sectref(Specifying Options)(zshoptions).)
When no option named var(option) exists, and the tt(POSIX_BUILTINS) option When no option named var(option) exists, and the tt(POSIX_BUILTINS) option
hasn't been set, return 3 with a warning. If that option is set, return 1 hasn't been set, return 3 with a warning. If that option is set, return 1
@@ -162,8 +162,7 @@ item(var(exp1) tt(-eq) var(exp2))(
true if var(exp1) is numerically equal to var(exp2). true if var(exp1) is numerically equal to var(exp2).
Note that for purely numeric comparisons use of the Note that for purely numeric comparisons use of the
tt(LPAR()LPAR())var(...)tt(RPAR()RPAR()) builtin described in tt(LPAR()LPAR())var(...)tt(RPAR()RPAR()) builtin described in
ifzman(the section `ARITHMETIC EVALUATION')\ sectref(Arithmetic Evaluation)(above) is more convenient than
ifnzman(noderef(Arithmetic Evaluation)) is more convenient than
conditional expressions. conditional expressions.
) )
item(var(exp1) tt(-ne) var(exp2))( item(var(exp1) tt(-ne) var(exp2))(
@@ -234,13 +233,7 @@ no matching file.
Pattern metacharacters are active for the var(pattern) arguments; Pattern metacharacters are active for the var(pattern) arguments;
the patterns are the same as those used for filename generation, see the patterns are the same as those used for filename generation, see
ifzman(\ sectref(Filename Generation)(zshexpn), but there is no special behaviour
zmanref(zshexpn)\
)\
ifnzman(\
noderef(Filename Generation)\
)\
, but there is no special behaviour
of `tt(/)' nor initial dot, and the patterns `tt(**/)' and `tt(***/)' behave of `tt(/)' nor initial dot, and the patterns `tt(**/)' and `tt(***/)' behave
the same as `tt(*/)', in which the `tt(*)' has its standard behaviour the same as `tt(*/)', in which the `tt(*)' has its standard behaviour
but may also match further `tt(/)' characters. Also, no bare glob but may also match further `tt(/)' characters. Also, no bare glob

154
Doc/Zsh/contrib.yo
View File

@@ -26,14 +26,13 @@ endmenu()
texinode(Utilities)(Recent Directories)()(User Contributions) texinode(Utilities)(Recent Directories)()(User Contributions)
sect(Utilities) sect(Utilities)
anchor(Accessing On-Line Help)
subsect(Accessing On-Line Help) subsect(Accessing On-Line Help)
cindex(helpfiles utility) cindex(helpfiles utility)
The key sequence tt(ESC h) is normally bound by ZLE to execute the The key sequence tt(ESC h) is normally bound by ZLE to execute the
tt(run-help) widget (see tt(run-help) widget (see nmref(Zsh Line Editor)(zshzle)).
ifzman(zmanref(zshzle))\ This invokes the tt(run-help) command with the command word from the
ifnzman(noderef(Zsh Line Editor))\
). This invokes the tt(run-help) command with the command word from the
current input line as its argument. By default, tt(run-help) is an alias current input line as its argument. By default, tt(run-help) is an alias
for the tt(man) command, so this often fails when the command word is a for the tt(man) command, so this often fails when the command word is a
shell builtin or a user-defined function. By redefining the tt(run-help) shell builtin or a user-defined function. By redefining the tt(run-help)
@@ -74,12 +73,12 @@ autoload run-help)
Note that in order for `tt(autoload run-help)' to work, the tt(run-help) Note that in order for `tt(autoload run-help)' to work, the tt(run-help)
file must be in one of the directories named in your tt(fpath) array (see file must be in one of the directories named in your tt(fpath) array (see
ifzman(zmanref(zshparam))\ sectref(Parameters Used by the Shell)(zshparam)).
ifnzman(noderef(Parameters Used By The Shell))\ This should already be the case if you have a standard zsh
). This should already be the case if you have a standard zsh
installation; if it is not, copy tt(Functions/Misc/run-help) to an installation; if it is not, copy tt(Functions/Misc/run-help) to an
appropriate directory. appropriate directory.
anchor(Recompiling Functions)
subsect(Recompiling Functions) subsect(Recompiling Functions)
cindex(functions, recompiling) cindex(functions, recompiling)
cindex(zrecompile utility) cindex(zrecompile utility)
@@ -168,6 +167,7 @@ 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 them, you can keep them up to date by running tt(zrecompile) with no
arguments. arguments.
anchor(Keyboard Definition)
subsect(Keyboard Definition) subsect(Keyboard Definition)
cindex(keyboard definition) cindex(keyboard definition)
@@ -205,9 +205,8 @@ example(source ${ZDOTDIR:-$HOME}/.zkbd/$TERM-$VENDOR-$OSTYPE
Note that in order for `tt(autoload zkbd)' to work, the tt(zkdb) file must Note that in order for `tt(autoload zkbd)' to work, the tt(zkdb) file must
be in one of the directories named in your tt(fpath) array (see be in one of the directories named in your tt(fpath) array (see
ifzman(zmanref(zshparam))\ sectref(Parameters Used by the Shell)(zshparam)).
ifnzman(noderef(Parameters Used By The Shell))\ This should already be the case if you have a standard zsh
). This should already be the case if you have a standard zsh
installation; if it is not, copy tt(Functions/Misc/zkbd) to an installation; if it is not, copy tt(Functions/Misc/zkbd) to an
appropriate directory. appropriate directory.
@@ -217,10 +216,8 @@ cindex(reporter utility)
Occasionally you may encounter what appears to be a bug in the shell, Occasionally you may encounter what appears to be a bug in the shell,
particularly if you are using a beta version of zsh or a development particularly if you are using a beta version of zsh or a development
release. Usually it is sufficient to send a description of the release. Usually it is sufficient to send a description of the
problem to one of the zsh mailing lists (see problem to one of the zsh mailing lists (see sectref(Mailing Lists)(zsh)),
ifzman(zmanref(zsh))\ but sometimes one of the zsh developers will need to recreate your
ifnzman(noderef(Mailing Lists))\
), but sometimes one of the zsh developers will need to recreate your
environment in order to track the problem down. environment in order to track the problem down.
The script named tt(reporter), found in the tt(Util) directory of the The script named tt(reporter), found in the tt(Util) directory of the
@@ -254,9 +251,7 @@ tt(reporter), you should edit the results to remove unnecessary commands.
Note that if you're using the new completion system, you should em(not) Note that if you're using the new completion system, you should em(not)
dump the tt(functions) state to your startup files with tt(reporter); use dump the tt(functions) state to your startup files with tt(reporter); use
the tt(compdump) function instead (see the tt(compdump) function instead (see
ifzman(zmanref(zshcompsys))\ nmref(Completion System)(zshcompsys)).
ifnzman(noderef(Completion System))\
).
startitem() startitem()
item(tt(reporter) [ var(state) ... ])( item(tt(reporter) [ var(state) ... ])(
@@ -287,15 +282,15 @@ any prefix, even a single letter; thus tt(a) is the same as tt(aliases),
tt(z) is the same as tt(zstyles), etc. tt(z) is the same as tt(zstyles), etc.
enditem() enditem()
anchor(Manipulating Hook Functions)
subsect(Manipulating Hook Functions) subsect(Manipulating Hook Functions)
cindex(hook function utility) cindex(hook function utility)
startitem() startitem()
findex(add-zsh-hook) findex(add-zsh-hook)
item(tt(add-zsh-hook) [ tt(-L) | tt(-dD) ] [ tt(-Uzk) ] var(hook) var(function))( item(tt(add-zsh-hook) [ tt(-L) | tt(-dD) ] [ tt(-Uzk) ] var(hook) var(function))(
Several functions are special to the shell, as described in the section Several functions are special to the shell, as described in
ifnzman(Special Functions, noderef(Functions))\ sectref(Special Functions)(zshmisc),
ifzman(SPECIAL FUNCTIONS, see zmanref(zshmisc)),
in that they are automatically called at specific points during shell execution. in that they are automatically called at specific points during shell execution.
Each has an associated array consisting of names of functions to be Each has an associated array consisting of names of functions to be
called at the same point; these are so-called `hook functions'. called at the same point; these are so-called `hook functions'.
@@ -329,9 +324,8 @@ options tt(-Uz) are appropriate.
) )
findex(add-zle-hook-widget) findex(add-zle-hook-widget)
item(tt(add-zle-hook-widget) [ tt(-L) | tt(-dD) ] [ tt(-Uzk) ] var(hook) var(widgetname))( item(tt(add-zle-hook-widget) [ tt(-L) | tt(-dD) ] [ tt(-Uzk) ] var(hook) var(widgetname))(
Several widget names are special to the line editor, as described in the section Several widget names are special to the line editor, as described in
ifnzman(Special Widgets, noderef(Zle Widgets))\ subref(Special Widgets)(zshzle),
ifzman(Special Widgets, see zmanref(zshzle)),
in that they are automatically called at specific points during editing. in that they are automatically called at specific points during editing.
Unlike function hooks, these do not use a predefined array of other names Unlike function hooks, these do not use a predefined array of other names
to call at the same point; the shell function tt(add-zle-hook-widget) to call at the same point; the shell function tt(add-zle-hook-widget)
@@ -486,8 +480,7 @@ subsect(Configuration)
Configuration is by means of the styles mechanism that should be familiar Configuration is by means of the styles mechanism that should be familiar
from completion; if not, see the description of the tt(zstyle) command in from completion; if not, see the description of the tt(zstyle) command in
ifzman(see zmanref(zshmodules))\ sectref(The zsh/zutil Module)(zshmodules). The context for setting styles
ifnzman(noderef(The zsh/zutil Module)). The context for setting styles
should be tt(':chpwd:*') in case the meaning of the context is extended in should be tt(':chpwd:*') in case the meaning of the context is extended in
future, for example: future, for example:
@@ -617,7 +610,7 @@ this.
) )
enditem() enditem()
subsect(Use with dynamic directory naming) subsect(Use with Dynamic Directory Naming)
It is possible to refer to recent directories using the dynamic directory It is possible to refer to recent directories using the dynamic directory
name syntax by using the supplied function tt(zsh_directory_name_cdr) name syntax by using the supplied function tt(zsh_directory_name_cdr)
@@ -630,7 +623,7 @@ When this is done, tt(~[1]) will refer to the most recent
directory other than $PWD, and so on. Completion after tt(~[)var(...) directory other than $PWD, and so on. Completion after tt(~[)var(...)
also works. also works.
subsect(Details of directory handling) subsect(Details of Directory Handling)
This section is for the curious or confused; most users will not This section is for the curious or confused; most users will not
need to know this information. need to know this information.
@@ -658,10 +651,8 @@ cindex(named directories, dynamic, helper function)
findex(zsh_directory_name_generic) findex(zsh_directory_name_generic)
sect(Abbreviated dynamic references to directories) sect(Abbreviated dynamic references to directories)
The dynamic directory naming system is described in the subsection The dynamic directory naming system is described in
em(Dynamic named directories) of subref(Dynamic Named Directories)(zshexpn). In this, a reference to
ifzman(the section em(Filename Expansion) in zmanref(zshexpn))\
ifnzman(noderef(Filename Expansion)). In this, a reference to
tt(~[)var(...)tt(]) is expanded by a function found by the hooks tt(~[)var(...)tt(]) is expanded by a function found by the hooks
mechanism. mechanism.
@@ -785,7 +776,7 @@ actually exist; this allows the system to work across automounted
file systems. The error from the command trying to use a non-existent file systems. The error from the command trying to use a non-existent
directory should be sufficient to indicate the problem. directory should be sufficient to indicate the problem.
subsect(Complete example) subsect(Complete Example)
Here is a full fictitious but usable autoloadable definition of the Here is a full fictitious but usable autoloadable definition of the
example function defined by the code above. So tt(~[gs:p:s]) expands example function defined by the code above. So tt(~[gs:p:s]) expands
@@ -1321,7 +1312,7 @@ When quilt is used (either in `addon' mode or as a `standalone' backend),
this expando is set to the quilt series' tt(patch-format) string. this expando is set to the quilt series' tt(patch-format) string.
The tt(set-patch-format) hook and tt(nopatch-format) style are honoured. The tt(set-patch-format) hook and tt(nopatch-format) style are honoured.
See ifzman(tt(Quilt Support))ifnzman(noderef(vcs_info Quilt Support)) below for details. See ifzman(bf(Quilt Support))ifnzman(noderef(vcs_info Quilt Support)) below for details.
) )
enditem() enditem()
@@ -1377,7 +1368,7 @@ We regret this coupling, but it was required for backwards compatibility.
texinode(vcs_info Quilt Support)(vcs_info API)(vcs_info Oddities)(Version Control Information) texinode(vcs_info Quilt Support)(vcs_info API)(vcs_info Oddities)(Version Control Information)
subsect(Quilt Support) subsect(Quilt Support)
bf(Quilt) is not a version control system, therefore this is not implemented em(Quilt) is not a version control system, therefore this is not implemented
as a backend. It can help keeping track of a series of patches. People use it as a backend. It can help keeping track of a series of patches. People use it
to keep a set of changes they want to use on top of software packages (which to keep a set of changes they want to use on top of software packages (which
is tightly integrated into the package build process - the Debian project is tightly integrated into the package build process - the Debian project
@@ -1419,7 +1410,8 @@ the tt(get-unapplied) style in the appropriate context.
tt(vcs_info) allows for very detailed control over how the gathered tt(vcs_info) allows for very detailed control over how the gathered
information is presented (see information is presented (see
ifzman(the bf(Configuration) and bf(Hooks in vcs_info) sections)\ ifzman(the bf(Configuration) subsection above
and bf(Hooks in vcs_info) subsection below)\
ifnzman(noderef(vcs_info Configuration) and noderef(vcs_info Hooks))), ifnzman(noderef(vcs_info Configuration) and noderef(vcs_info Hooks))),
all of which are documented below. Note there are a number of all of which are documented below. Note there are a number of
other patch tracking systems that work on top of a certain version control other patch tracking systems that work on top of a certain version control
@@ -1668,7 +1660,8 @@ tt(${hook_com[applied-string]}) will be
available as tt(%p) in the tt(patch-format) and tt(nopatch-format) styles. available as tt(%p) in the tt(patch-format) and tt(nopatch-format) styles.
This hook is, in concert with tt(set-patch-format), responsible for This hook is, in concert with tt(set-patch-format), responsible for
tt(%)-escaping that value for use in the prompt. tt(%)-escaping that value for use in the prompt.
(See ifzman(the bf(Oddities) section)ifnzman(noderef(vcs_info Oddities)).) (See ifzman(the bf(Oddities) subsection above)\
ifnzman(noderef(vcs_info Oddities)).)
COMMENT(This paragraph is repeated above/below)\ COMMENT(This paragraph is repeated above/below)\
The tt(quilt) backend passes to this hook the inputs The tt(quilt) backend passes to this hook the inputs
@@ -1691,7 +1684,8 @@ tt(${hook_com[unapplied-string]}) will be available as tt(%u) in the
tt(patch-format) and tt(nopatch-format) styles. tt(patch-format) and tt(nopatch-format) styles.
This hook is, in concert with tt(set-patch-format), responsible for This hook is, in concert with tt(set-patch-format), responsible for
tt(%)-escaping that value for use in the prompt. tt(%)-escaping that value for use in the prompt.
(See ifzman(the bf(Oddities) section)ifnzman(noderef(vcs_info Oddities)).) (See ifzman(the bf(Oddities) subsection above)\
ifnzman(noderef(vcs_info Oddities)).)
COMMENT(This paragraph is repeated above/below)\ COMMENT(This paragraph is repeated above/below)\
The tt(quilt) backend passes to this hook the inputs The tt(quilt) backend passes to this hook the inputs
@@ -1778,7 +1772,8 @@ tt(nopatch-format).
This hook is, in concert with the tt(gen-applied-string) or This hook is, in concert with the tt(gen-applied-string) or
tt(gen-unapplied-string) hooks if they are defined, responsible for tt(gen-unapplied-string) hooks if they are defined, responsible for
tt(%)-escaping the final tt(patch-format) value for use in the prompt. tt(%)-escaping the final tt(patch-format) value for use in the prompt.
(See ifzman(the bf(Oddities) section)ifnzman(noderef(vcs_info Oddities)).) (See ifzman(the bf(Oddities) subsection above)\
ifnzman(noderef(vcs_info Oddities)).)
COMMENT(This paragraph is repeated above/below)\ COMMENT(This paragraph is repeated above/below)\
The tt(quilt) backend passes to this hook the inputs The tt(quilt) backend passes to this hook the inputs
@@ -1813,7 +1808,7 @@ tt(vcs_info).
enditem() enditem()
If all of this sounds rather confusing, take a look at If all of this sounds rather confusing, take a look at
ifzman(the bf(Examples) section below)ifnzman(noderef(vcs_info Examples)) ifzman(the bf(Examples) subsection below)ifnzman(noderef(vcs_info Examples))
and also in the tt(Misc/vcs_info-examples) file in the Zsh source. and also in the tt(Misc/vcs_info-examples) file in the Zsh source.
They contain some explanatory code. They contain some explanatory code.
@@ -1841,8 +1836,7 @@ that is really long to have a fixed width, like a hash in a mercurial
branchformat, you can do this: tt(%12.12i). That'll shrink the 40 character branchformat, you can do this: tt(%12.12i). That'll shrink the 40 character
hash to its 12 leading characters. The form is actually hash to its 12 leading characters. The form is actually
`tt(%)var(min)tt(.)var(max)tt(x)'. More is possible. `tt(%)var(min)tt(.)var(max)tt(x)'. More is possible.
See ifzman(the section `The zsh/zutil Module' in zmanref(zshmodules))\ See sectref(The zsh/zutil Module)(zshmodules) for details.
ifnzman(noderef(The zsh/zutil Module)) for details.
Use the quicker tt(bzr) backend Use the quicker tt(bzr) backend
example(zstyle ':vcs_info:bzr:*' use-simple true) example(zstyle ':vcs_info:bzr:*' use-simple true)
@@ -1854,7 +1848,7 @@ example(zstyle ':vcs_info:(svn|bzr):*' \
branchformat '%b%%F{yellow}:%r') branchformat '%b%%F{yellow}:%r')
The doubled percent sign is explained in The doubled percent sign is explained in
ifzman(the bf(Oddities) section)ifnzman(noderef(vcs_info Oddities)). ifzman(the bf(Oddities) subsection above)ifnzman(noderef(vcs_info Oddities)).
Alternatively, one can use the raw colour codes directly: Alternatively, one can use the raw colour codes directly:
@@ -2058,7 +2052,7 @@ beyond the scope of tt(localoptions), should your function need that.
) )
item(Modify hooks)( item(Modify hooks)(
Use of tt(add-zsh-hook) and tt(add-zle-hook-widget) is recommended (see Use of tt(add-zsh-hook) and tt(add-zle-hook-widget) is recommended (see
the bf(Manipulating Hook Functions) section above). subref(Manipulating Hook Functions)(above)).
All hooks that follow the naming pattern tt(prompt_)var(theme)tt(_)var(hook) All hooks that follow the naming pattern tt(prompt_)var(theme)tt(_)var(hook)
are automatically removed when the prompt theme changes or is disabled. are automatically removed when the prompt theme changes or is disabled.
) )
@@ -2091,9 +2085,8 @@ sect(ZLE Functions)
subsect(Widgets) subsect(Widgets)
These functions all implement user-defined ZLE widgets (see These functions all implement user-defined ZLE widgets (see
ifzman(zmanref(zshzle))\ sectref(User-Defined Widgets)(zshzle))
ifnzman(noderef(Zsh Line Editor))\ which can be bound to keystrokes in interactive shells. To use them,
) which can be bound to keystrokes in interactive shells. To use them,
your tt(.zshrc) should contain lines of the form your tt(.zshrc) should contain lines of the form
example(autoload var(function) example(autoload var(function)
@@ -2137,8 +2130,8 @@ builtin widgets without the suffix. By default they behave in a similar
way. However, by the use of styles and the function tt(select-word-style), way. However, by the use of styles and the function tt(select-word-style),
the way words are matched can be altered. tt(select-word-match) is intended the way words are matched can be altered. tt(select-word-match) is intended
to be used as a text object in vi mode but with custom word styles. For to be used as a text object in vi mode but with custom word styles. For
comparison, the widgets described in ifzman(zmanref(zshzle) under Text Objects)\ comparison, the widgets described in subref(Text Objects)(zshzle)
ifnzman(noderef(Text Objects)) use fixed definitions of words, compatible use fixed definitions of words, compatible
with the tt(vim) editor. with the tt(vim) editor.
The simplest way of configuring the functions is to use The simplest way of configuring the functions is to use
@@ -2183,8 +2176,7 @@ pattern (note that the outer brackets should not be supplied, only
those surrounding named ranges). those surrounding named ranges).
More control can be obtained using the tt(zstyle) command, as described in More control can be obtained using the tt(zstyle) command, as described in
ifzman(zmanref(zshmodules))\ sectref(The zsh/zutil Module)(zshmodules). Each style is looked up in the
ifnzman(noderef(The zsh/zutil Module)). Each style is looked up in the
context tt(:zle:)var(widget) where var(widget) is the name of the context tt(:zle:)var(widget) where var(widget) is the name of the
user-defined widget, not the name of the function implementing it, so in user-defined widget, not the name of the function implementing it, so in
the case of the definitions supplied by tt(select-word-style) the the case of the definitions supplied by tt(select-word-style) the
@@ -2356,8 +2348,7 @@ directly.
) )
tindex(bracketed-paste-magic) tindex(bracketed-paste-magic)
item(tt(bracketed-paste-magic))( item(tt(bracketed-paste-magic))(
The tt(bracketed-paste) widget (see ifzman(the subsection `Miscellaneous' in The tt(bracketed-paste) widget (see subref(Miscellaneous)(zshzle))
zmanref(zshzle))ifnzman(noderef(Miscellaneous) in noderef(Standard Widgets)))
inserts pasted text literally into the editor buffer rather than interpret inserts pasted text literally into the editor buffer rather than interpret
it as keystrokes. This disables some common usages where the self-insert it as keystrokes. This disables some common usages where the self-insert
widget is replaced in order to accomplish some extra processing. An widget is replaced in order to accomplish some extra processing. An
@@ -2558,9 +2549,8 @@ This function implements the widgets
tt(history-beginning-search-backward-end) and tt(history-beginning-search-backward-end) and
tt(history-beginning-search-forward-end). These commands work by first tt(history-beginning-search-forward-end). These commands work by first
calling the corresponding builtin widget (see calling the corresponding builtin widget (see
ifzman(`History Control' in zmanref(zshzle))\ sectref(History Control)(zshzle))
ifnzman(noderef(History Control))\ and then moving the cursor to the end of the line. The original cursor
) and then moving the cursor to the end of the line. The original cursor
position is remembered and restored before calling the builtin widget a position is remembered and restored before calling the builtin widget a
second time, so that the same search is repeated to look farther through second time, so that the same search is repeated to look farther through
the history. the history.
@@ -3253,8 +3243,7 @@ investigate the command word found. The default is tt(whence -c).
tindex(zcalc-auto-insert) tindex(zcalc-auto-insert)
item(tt(zcalc-auto-insert))( item(tt(zcalc-auto-insert))(
This function is useful together with the tt(zcalc) function described in This function is useful together with the tt(zcalc) function described in
ifzman(the section `Mathematical Functions')\ sectref(Mathematical Functions)(above).
ifnzman(noderef(Mathematical Functions)).
It should be bound to a key representing a binary operator such It should be bound to a key representing a binary operator such
as `tt(PLUS())', `tt(-)', `tt(*)' or `tt(/)'. When running in zcalc, as `tt(PLUS())', `tt(-)', `tt(*)' or `tt(/)'. When running in zcalc,
if the key occurs at the start of the line or immediately following if the key occurs at the start of the line or immediately following
@@ -3554,9 +3543,8 @@ findex(catch)
enditem() enditem()
The functions are designed to be used together with the tt(always) construct The functions are designed to be used together with the tt(always) construct
described in described in sectref(Complex Commands)(zshmisc).
ifzman(zmanref(zshmisc))\ This is important as only this
ifnzman(noderef(Complex Commands)). This is important as only this
construct provides the required support for exceptions. A typical example construct provides the required support for exceptions. A typical example
is as follows. is as follows.
@@ -3657,9 +3645,8 @@ tt(copiousoutput); see manref(mailcap)(4) or manref(mailcap)(5)
(the man page's name varies across platforms). (the man page's name varies across platforms).
The functions use the following styles, which are defined with the The functions use the following styles, which are defined with the
tt(zstyle) builtin command (\ tt(zstyle) builtin command (sectref(The zsh/zutil Module)(zshmodules)).
ifzman(see zmanref(zshmodules))\ They should be defined
ifnzman(noderef(The zsh/zutil Module))). They should be defined
before tt(zsh-mime-setup) is run. The contexts used all before tt(zsh-mime-setup) is run. The contexts used all
start with tt(:mime:), with additional components in some cases. start with tt(:mime:), with additional components in some cases.
It is recommended that a trailing tt(*) (suitably quoted) be appended It is recommended that a trailing tt(*) (suitably quoted) be appended
@@ -3726,9 +3713,7 @@ will ensure that any files found in that area will be executed as MIME
types even if they are executable. As this example shows, the complete types even if they are executable. As this example shows, the complete
file name is matched against the pattern, regardless of how the file file name is matched against the pattern, regardless of how the file
was passed to the handler. The file is resolved to a full path using was passed to the handler. The file is resolved to a full path using
the tt(:P) modifier described in the tt(:P) modifier described in subref(Modifiers)(zshexpn);
ifzman(the subsection `Modifiers' in zmanref(zshexpn))\
ifnzman(noderef(Modifiers));
this means that symbolic links are resolved where possible, so that this means that symbolic links are resolved where possible, so that
links into other file systems behave in the correct fashion. links into other file systems behave in the correct fashion.
) )
@@ -3988,8 +3973,7 @@ item(tt(zcalc) [ tt(-erf) ] [ var(expression) ... ])(
A reasonably powerful calculator based on zsh's arithmetic evaluation A reasonably powerful calculator based on zsh's arithmetic evaluation
facility. The syntax is similar to that of formulae in most programming facility. The syntax is similar to that of formulae in most programming
languages; see languages; see
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\ sectref(Arithmetic Evaluation)(zshmisc) for details.
ifnzman(noderef(Arithmetic Evaluation)) for details.
Non-programmers should note that, as in many other programming Non-programmers should note that, as in many other programming
languages, expressions involving only integers (whether constants languages, expressions involving only integers (whether constants
@@ -4009,8 +3993,7 @@ instead of tt($HOME) if it is set.
The mathematical library tt(zsh/mathfunc) will be loaded if it is The mathematical library tt(zsh/mathfunc) will be loaded if it is
available; see available; see
ifzman(the section `The zsh/mathfunc Module' in zmanref(zshmodules))\ sectref(The zsh/mathfunc Module)(zshmodules). The mathematical functions
ifnzman(noderef(The zsh/mathfunc Module)). The mathematical functions
correspond to the raw system libraries, so trigonometric functions are correspond to the raw system libraries, so trigonometric functions are
evaluated using radians, and so on. evaluated using radians, and so on.
@@ -4216,8 +4199,7 @@ one or more arguments. The function tt(sum) takes zero or more arguments.
Arguments can be of different types (ints and floats). Arguments can be of different types (ints and floats).
Not to be confused with the tt(zsh/mathfunc) module, described in Not to be confused with the tt(zsh/mathfunc) module, described in
ifzman(the section `The zsh/mathfunc Module' in zmanref(zshmodules))\ sectref(The zsh/mathfunc Module)(zshmodules).
ifnzman(noderef(The zsh/mathfunc Module)).
) )
findex(zmathfuncdef) findex(zmathfuncdef)
item(tt(zmathfuncdef) [ var(mathfunc) [ var(body) ] ])( item(tt(zmathfuncdef) [ var(mathfunc) [ var(body) ] ])(
@@ -4306,8 +4288,8 @@ findex(colors)
item(tt(colors))( item(tt(colors))(
This function initializes several associative arrays to map color names to This function initializes several associative arrays to map color names to
(and from) the ANSI standard eight-color terminal codes. These are used (and from) the ANSI standard eight-color terminal codes. These are used
by the prompt theme system (ifzman(see above)\ by the prompt theme system (see sectref(Prompt Themes)(above)).
ifnzman(noderef(Prompt Themes))). You seldom should need to run You seldom should need to run
tt(colors) more than once. tt(colors) more than once.
The eight base colors are: tt(black), tt(red), tt(green), tt(yellow), The eight base colors are: tt(black), tt(red), tt(green), tt(yellow),
@@ -4412,10 +4394,8 @@ invokes that original.
findex(nslookup) findex(nslookup)
item(tt(nslookup) [ var(arg) ... ])( item(tt(nslookup) [ var(arg) ... ])(
This wrapper function for the tt(nslookup) command requires the This wrapper function for the tt(nslookup) command requires the
tt(zsh/zpty) module (see tt(zsh/zpty) module (see sectref(The zsh/zpty Module)(zshmodules)).
ifzman(zmanref(zshmodules))\ It behaves exactly like the standard tt(nslookup)
ifnzman(noderef(The zsh/zpty Module))\
). It behaves exactly like the standard tt(nslookup)
except that it provides customizable prompts (including a right-side except that it provides customizable prompts (including a right-side
prompt) and completion of nslookup commands, host names, etc. (if you use prompt) and completion of nslookup commands, host names, etc. (if you use
the function-based completion system). Completion styles may be set with the function-based completion system). Completion styles may be set with
@@ -4451,9 +4431,8 @@ Note that if using POSIX EREs, the tt(^) or word boundary operators
findex(run-help) findex(run-help)
item(tt(run-help) var(cmd))( item(tt(run-help) var(cmd))(
This function is designed to be invoked by the tt(run-help) ZLE widget, 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' in place of the default alias. See subref(Accessing On-Line Help)(above)
ifzman(above)\ for setup instructions.
ifnzman((noderef(Utilities))) for setup instructions.
In the discussion which follows, if var(cmd) is a file system path, it is In the discussion which follows, if var(cmd) is a file system path, it is
first reduced to its rightmost component (the file name). first reduced to its rightmost component (the file name).
@@ -4673,9 +4652,7 @@ 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). the names tt(zcp) and tt(zln) in some directory in your tt(fpath).
) )
item(tt(zkbd))( item(tt(zkbd))(
See `Keyboard Definition' See subref(Keyboard Definition)(above).
ifzman(above)\
ifnzman((noderef(Utilities))).
) )
findex(zmv) findex(zmv)
redef(SPACES)(0)(tt(ifztexi(NOTRANS(@ @ @ @ ))ifnztexi( ))) redef(SPACES)(0)(tt(ifztexi(NOTRANS(@ @ @ @ ))ifnztexi( )))
@@ -4758,9 +4735,7 @@ 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. your tt(fpath), or in tt(Functions/Misc/zmv) in the zsh distribution.
) )
item(tt(zrecompile))( item(tt(zrecompile))(
See `Recompiling Functions' See subref(Recompiling Functions)(above).
ifzman(above)\
ifnzman((noderef(Utilities))).
) )
findex(zstyle+) findex(zstyle+)
item(tt(zstyle+) var(context) var(style) var(value) [ tt(+) var(subcontext) var(style) var(value) ... ])( item(tt(zstyle+) var(context) var(style) var(value) [ tt(+) var(subcontext) var(style) var(value) ... ])(
@@ -4802,9 +4777,6 @@ item(tt(rprompt))(
The tt(nslookup) function looks up this style in the context The tt(nslookup) function looks up this style in the context
`tt(:nslookup)' to set the prompt and the right-side prompt, respectively. `tt(:nslookup)' to set the prompt and the right-side prompt, respectively.
The usual expansions for the tt(PS1) and tt(RPS1) parameters may be used The usual expansions for the tt(PS1) and tt(RPS1) parameters may be used
(see (see sectref(Expansion of Prompt Sequences)(zshmisc)).
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion))\
).
) )
enditem() enditem()

2
Doc/Zsh/exec.yo
View File

@@ -9,7 +9,7 @@ cindex(command not found, handling of)
findex(command_not_found_handler) findex(command_not_found_handler)
If a command name contains no slashes, the shell attempts to locate If a command name contains no slashes, the shell attempts to locate
it. If there exists a shell function by that name, the function it. If there exists a shell function by that name, the function
is invoked as described in noderef(Functions). If there exists is invoked as described in sectref(Functions)(below). If there exists
a shell builtin by that name, the builtin is invoked. a shell builtin by that name, the builtin is invoked.
vindex(path, use of) vindex(path, use of)

106
Doc/Zsh/expn.yo
View File

@@ -11,10 +11,7 @@ This is performed only in interactive shells.
) )
item(em(Alias Expansion))( item(em(Alias Expansion))(
Aliases are expanded immediately before the command line is parsed as Aliases are expanded immediately before the command line is parsed as
explained explained in sectref(Aliasing)(zshmisc).
ifzman(under Aliasing in zmanref(zshmisc))\
ifnzman(in noderef(Aliasing))\
.
) )
xitem(em(Process Substitution)) xitem(em(Process Substitution))
xitem(em(Parameter Expansion)) xitem(em(Parameter Expansion))
@@ -68,9 +65,9 @@ most recent command is always retained in any case. Each saved command in
the history list is called a history em(event) and is assigned a number, the history list is called a history em(event) and is assigned a number,
beginning with 1 (one) when the shell starts up. The history number that beginning with 1 (one) when the shell starts up. The history number that
you may see in your prompt (see you may see in your prompt (see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ tt(%h) or tt(%!) prompt escape described in
ifnzman(noderef(Prompt Expansion))\ sectref(Simple Prompt Escapes)(zshmisc))
) is the number that is to be assigned to the em(next) command. is the number that is to be assigned to the em(next) command.
startmenu() startmenu()
menu(Overview) menu(Overview)
@@ -87,8 +84,9 @@ command line, including inside double quotes (but not inside single quotes
tt('...') or C-style quotes tt($'...') nor when escaped with a backslash). tt('...') or C-style quotes tt($'...') nor when escaped with a backslash).
The first character is followed by an optional event designator The first character is followed by an optional event designator
(ifzman(see )noderef(Event Designators)) and then an optional word (see subref(Event Designators)(below))
designator (noderef(Word Designators)); if neither of these designators is and then an optional word designator (subref(Word Designators)(below));
if neither of these designators is
present, no history expansion occurs. present, no history expansion occurs.
Input lines containing history expansions are echoed after being expanded, Input lines containing history expansions are echoed after being expanded,
@@ -122,16 +120,14 @@ actually the second character of the tt(histchars) parameter)
repeats the last command, replacing the string var(foo) with var(bar). repeats the last command, replacing the string var(foo) with var(bar).
More precisely, the sequence `tt(^)var(foo)tt(^)var(bar)tt(^)' is More precisely, the sequence `tt(^)var(foo)tt(^)var(bar)tt(^)' is
synonymous with `tt(!!:s)tt(^)var(foo)tt(^)var(bar)tt(^)', hence other synonymous with `tt(!!:s)tt(^)var(foo)tt(^)var(bar)tt(^)', hence other
modifiers (see noderef(Modifiers)) may follow the final `tt(^)'. modifiers (see subref(Modifiers)(below)) may follow the final `tt(^)'.
In particular, `tt(^)var(foo)tt(^)var(bar)tt(^:G)' performs a global In particular, `tt(^)var(foo)tt(^)var(bar)tt(^:G)' performs a global
substitution. substitution.
If the shell encounters the character sequence `tt(!")' If the shell encounters the character sequence `tt(!")'
in the input, the history mechanism is temporarily disabled until in the input, the history mechanism is temporarily disabled until
the current list (see the current list (see nmref(Shell Grammar)(zshmisc))
ifzman(zmanref(zshmisc))\ is fully parsed. The `tt(!")' is removed from the input, and any
ifnzman(noderef(Shell Grammar))\
) is fully parsed. The `tt(!")' is removed from the input, and any
subsequent `tt(!)' characters have no special significance. subsequent `tt(!)' characters have no special significance.
findex(fc, use of) findex(fc, use of)
@@ -150,8 +146,8 @@ startitem()
item(tt(!))( item(tt(!))(
Start a history expansion, except when followed by a blank, newline, Start a history expansion, except when followed by a blank, newline,
`tt(=)' or `tt(LPAR())'. If followed immediately by a word designator `tt(=)' or `tt(LPAR())'. If followed immediately by a word designator
(ifzman(see )noderef(Word Designators)), this forms a history reference (ifzman(see )subref(Word Designators)(below)), this forms a history reference
with no event designator (ifzman(see )noderef(Overview)). with no event designator (ifzman(see )subref(Overview)(above)).
) )
item(tt(!!))( item(tt(!!))(
Refer to the previous command. Refer to the previous command.
@@ -384,9 +380,8 @@ var(l) and var(r) sides.
If the option tt(HIST_SUBST_PATTERN) is set or the original substitution If the option tt(HIST_SUBST_PATTERN) is set or the original substitution
was started with a capital tt(S), var(l) is treated as was started with a capital tt(S), var(l) is treated as
a pattern of the usual form described in a pattern of the usual form described in sectref(Filename Generation)(below).
ifzman(the section FILENAME GENERATION below)\ This can be used in
ifnzman(noderef(Filename Generation)). This can be used in
all the places where modifiers are available; note, however, that all the places where modifiers are available; note, however, that
in globbing qualifiers parameter substitution has already taken place, in globbing qualifiers parameter substitution has already taken place,
so parameters in the replacement string should be quoted to ensure so parameters in the replacement string should be quoted to ensure
@@ -527,9 +522,8 @@ There is an additional problem with tt(>LPAR())var(process)tt(RPAR()); when
this is attached to an external command, the parent shell does not wait this is attached to an external command, the parent shell does not wait
for var(process) to finish and hence an immediately following command for var(process) to finish and hence an immediately following command
cannot rely on the results being complete. The problem and solution are cannot rely on the results being complete. The problem and solution are
the same as described in the section em(MULTIOS) in the same as described in the section sectref(Multios)(zshmisc).
ifzman(zmanref(zshmisc))\ Hence in a simplified
ifnzman(noderef(Redirection)). Hence in a simplified
version of the example above: version of the example above:
example(tt(paste <LPAR()cut -f1) var(file1)tt(RPAR() <LPAR()cut -f3) var(file2)tt(RPAR()) tt(> >LPAR())var(process)tt(RPAR())) example(tt(paste <LPAR()cut -f1) var(file1)tt(RPAR() <LPAR()cut -f3) var(file2)tt(RPAR()) tt(> >LPAR())var(process)tt(RPAR()))
@@ -577,13 +571,7 @@ sect(Parameter Expansion)
cindex(parameter expansion) cindex(parameter expansion)
cindex(expansion, parameter) cindex(expansion, parameter)
The character `tt($)' is used to introduce parameter expansions. The character `tt($)' is used to introduce parameter expansions.
See See nmref(Parameters)(zshparam)
ifzman(\
zmanref(zshparam)
)\
ifnzman(\
noderef(Parameters)
)\
for a description of parameters, including arrays, associative arrays, for a description of parameters, including arrays, associative arrays,
and subscript notation to access individual array elements. and subscript notation to access individual array elements.
@@ -620,11 +608,12 @@ only one namespace prefix is allowed.
In the expansions discussed below that require a pattern, the form of In the expansions discussed below that require a pattern, the form of
the pattern is the same as that used for filename generation; the pattern is the same as that used for filename generation;
see noderef(Filename Generation). Note that these patterns, along with see sectref(Filename Generation)(below). Note that these patterns, along with
the replacement text of any substitutions, are themselves subject to the replacement text of any substitutions, are themselves subject to
parameter expansion, command substitution, and arithmetic expansion. parameter expansion, command substitution, and arithmetic expansion.
In addition to the following operations, the colon modifiers described in In addition to the following operations, the colon modifiers described in
noderef(Modifiers) in noderef(History Expansion) can be subref(Modifiers)() in sectref(History Expansion)(above) can be
applied: for example, tt(${i:s/foo/bar/}) performs string applied: for example, tt(${i:s/foo/bar/}) performs string
substitution on the expansion of parameter tt($i). substitution on the expansion of parameter tt($i).
@@ -961,8 +950,7 @@ deleted. The form with tt($LPAR())...tt(RPAR()) is often useful in
combination with the flags described next; see the examples below. combination with the flags described next; see the examples below.
Each var(name) or nested tt(${)...tt(}) in a parameter expansion may Each var(name) or nested tt(${)...tt(}) in a parameter expansion may
also be followed by a subscript expression as described in also be followed by a subscript expression as described in
ifzman(em(Array Parameters) in zmanref(zshparam))\ sectref(Array Parameters)(zshparam).
ifnzman(noderef(Array Parameters)).
Note that double quotes may appear around nested expressions, in which Note that double quotes may appear around nested expressions, in which
case only the part inside is treated as quoted; for example, case only the part inside is treated as quoted; for example,
@@ -973,6 +961,7 @@ tt("${(@f)"$(foo)"}"), there are two sets of quotes, one surrounding the
whole expression, the other (redundant) surrounding the tt($(foo)) as whole expression, the other (redundant) surrounding the tt($(foo)) as
before. before.
anchor(Parameter Expansion Flags)
subsect(Parameter Expansion Flags) subsect(Parameter Expansion Flags)
cindex(parameter expansion flags) cindex(parameter expansion flags)
cindex(flags, parameter expansion) cindex(flags, parameter expansion)
@@ -1002,8 +991,7 @@ If the tt(MULTIBYTE) option is set and the number is greater than 127
item(tt(%))( item(tt(%))(
Expand all tt(%) escapes in the resulting words in the same way as in Expand all tt(%) escapes in the resulting words in the same way as in
prompts (see prompts (see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ sectref(Expansion of Prompt Sequences)(zshmisc)). If this flag is given twice,
ifnzman(noderef(Prompt Expansion))). If this flag is given twice,
full prompt expansion is done on the resulting words, depending on the full prompt expansion is done on the resulting words, depending on the
setting of the tt(PROMPT_PERCENT), tt(PROMPT_SUBST) and tt(PROMPT_BANG) setting of the tt(PROMPT_PERCENT), tt(PROMPT_SUBST) and tt(PROMPT_BANG)
options. options.
@@ -1078,8 +1066,7 @@ to substitute the leading part of these by names. The remainder of
the path (the whole of it if the leading part was not substituted) the path (the whole of it if the leading part was not substituted)
is then quoted so that the whole string can be used as a shell is then quoted so that the whole string can be used as a shell
argument. This is the reverse of `tt(~)' substitution: see argument. This is the reverse of `tt(~)' substitution: see
ifnzman(noderef(Filename Expansion))\ sectref(Filename Expansion)(below).
ifzman(the section FILENAME EXPANSION below).
) )
item(tt(e))( item(tt(e))(
Perform single word shell expansions, namely em(parameter expansion), Perform single word shell expansions, namely em(parameter expansion),
@@ -1561,8 +1548,7 @@ initializes a parameter var(pname) as a reference to a second
parameter var(rname). The var(rname) may also be omitted, in which parameter var(rname). The var(rname) may also be omitted, in which
case var(pname) is a placeholder which, the first time it is assigned, case var(pname) is a placeholder which, the first time it is assigned,
is initialized to an active reference to the assigned var(rname). See is initialized to an active reference to the assigned var(rname). See
ifzman(Named References in zmanref(zshparam))\ sectref(Named References)(zshparam)ifnzman( under noderef(Parameters))
ifnzman(noderef(Named References) under noderef(Parameters))
for more about placeholders. for more about placeholders.
With the few exceptions described here, when With the few exceptions described here, when
@@ -1658,7 +1644,7 @@ the type information of var(rname), unless var(rname) is empty, in which
case the expansion is `tt(nameref)', or when no variable var(rname) case the expansion is `tt(nameref)', or when no variable var(rname)
exists, in which case the expansion is empty. exists, in which case the expansion is empty.
See also ifzman(zmanref(zshparam))ifnzman(noderef(Parameters)). See also nmref(Parameters)(zshparam).
subsect(Rules) subsect(Rules)
cindex(parameter expansion rules) cindex(parameter expansion rules)
@@ -1759,7 +1745,7 @@ returns a scalar because of the quotes).
item(tt(7.) em(Modifiers))( item(tt(7.) em(Modifiers))(
Any modifiers, as specified by a trailing `tt(#)', `tt(%)', `tt(/)' Any modifiers, as specified by a trailing `tt(#)', `tt(%)', `tt(/)'
(possibly doubled) or by a set of modifiers of the form `tt(:...)' (see (possibly doubled) or by a set of modifiers of the form `tt(:...)' (see
noderef(Modifiers) in noderef(History Expansion)), are applied to the words subref(Modifiers)() in sectref(History Expansion)(above)), are applied to the words
of the value at this level. of the value at this level.
) )
item(tt(8.) em(Character evaluation))( item(tt(8.) em(Character evaluation))(
@@ -2050,9 +2036,7 @@ has similar effects.
To combine brace expansion with array expansion, see the To combine brace expansion with array expansion, see the
tt(${^)var(spec)tt(}) form described tt(${^)var(spec)tt(}) form described
ifzman(in the section `Parameter Expansion')\ in sectref(Parameter Expansion)() above.
ifnzman(in noderef(Parameter Expansion))
above.
texinode(Filename Expansion)(Filename Generation)(Brace Expansion)(Expansion) texinode(Filename Expansion)(Filename Generation)(Brace Expansion)(Expansion)
sect(Filename Expansion) sect(Filename Expansion)
@@ -2086,14 +2070,14 @@ option exchanges the effects of `tt(~PLUS())' and `tt(~-)' where they are
followed by a number. followed by a number.
startmenu() startmenu()
menu(Dynamic named directories) menu(Dynamic Named Directories)
menu(Static named directories) menu(Static Named Directories)
menu(`=' expansion) menu(`=' Expansion)
menu(Notes) menu(Notes)
endmenu() endmenu()
texinode(Dynamic named directories)(Static named directories)()(Filename Expansion) texinode(Dynamic Named Directories)(Static Named Directories)()(Filename Expansion)
subsect(Dynamic named directories) subsect(Dynamic Named Directories)
cindex(directories, named, dynamic) cindex(directories, named, dynamic)
cindex(named directories, dynamic) cindex(named directories, dynamic)
cindex(dynamic named directories) cindex(dynamic named directories)
@@ -2147,8 +2131,7 @@ equivalent calls to elements of the array
tt(zsh_directory_name_functions), if it exists, in order to tt(zsh_directory_name_functions), if it exists, in order to
complete dynamic names for directories. The code for this should be complete dynamic names for directories. The code for this should be
as for any other completion function as described in as for any other completion function as described in
ifnzman(noderef(Completion System))\ nmref(Completion System)(zsycompsys).
ifzman(zmanref(zshcompsys)).
As a working example, here is a function that expands any dynamic names As a working example, here is a function that expands any dynamic names
beginning with the string tt(p:) to directories below beginning with the string tt(p:) to directories below
@@ -2176,8 +2159,8 @@ example(zsh_directory_name+LPAR()RPAR() {
esac esac
}) })
texinode(Static named directories)(`=' expansion)(Dynamic named directories)(Filename Expansion) texinode(Static Named Directories)(`=' Expansion)(Dynamic Named Directories)(Filename Expansion)
subsect(Static named directories) subsect(Static Named Directories)
cindex(directories, named, static) cindex(directories, named, static)
cindex(named directories, static) cindex(named directories, static)
cindex(static named directories) cindex(static named directories)
@@ -2203,8 +2186,8 @@ i.e. either the directory name or the full path; the name is used
if they are the same length. if they are the same length.
The parameters tt($PWD) and tt($OLDPWD) are never abbreviated in this fashion. The parameters tt($PWD) and tt($OLDPWD) are never abbreviated in this fashion.
texinode(`=' expansion)(Notes)(Static named directories)(Filename Expansion) texinode(`=' Expansion)(Notes)(Static Named Directories)(Filename Expansion)
subsect(`=' expansion) subsect(`=' Expansion)
If a word begins with an unquoted `tt(=)' If a word begins with an unquoted `tt(=)'
and the tt(EQUALS) option is set, and the tt(EQUALS) option is set,
@@ -2213,7 +2196,7 @@ name of a command. If a command
exists by that name, the word is replaced exists by that name, the word is replaced
by the full pathname of the command. by the full pathname of the command.
texinode(Notes)()(`=' expansion)(Filename Expansion) texinode(Notes)()(`=' Expansion)(Filename Expansion)
subsect(Notes) subsect(Notes)
cindex(filename expansion, notes) cindex(filename expansion, notes)
Filename expansion is performed on the right hand side of a parameter Filename expansion is performed on the right hand side of a parameter
@@ -2259,6 +2242,7 @@ pindex(GLOB_DOTS, use of)
No filename generation pattern No filename generation pattern
matches the files `tt(.)' or `tt(..)'. In other instances of pattern matches the files `tt(.)' or `tt(..)'. In other instances of pattern
matching, the `tt(/)' and `tt(.)' are not treated specially. matching, the `tt(/)' and `tt(.)' are not treated specially.
anchor(Glob Operators)
subsect(Glob Operators) subsect(Glob Operators)
cindex(glob operators) cindex(glob operators)
startitem() startitem()
@@ -2341,9 +2325,7 @@ tt(IFS) parameter
item(tt([:IFSSPACE:]))( item(tt([:IFSSPACE:]))(
The character is an IFS white space character; see the documentation The character is an IFS white space character; see the documentation
for tt(IFS) in for tt(IFS) in
ifzman(the zmanref(zshparam) manual page)\ sectref(Parameters Used by the Shell)(zshparam).
ifnzman(noderef(Parameters Used By The Shell))\
.
) )
item(tt([:INCOMPLETE:]))( item(tt([:INCOMPLETE:]))(
Matches a byte that starts an incomplete multibyte character. Matches a byte that starts an incomplete multibyte character.
@@ -2491,6 +2473,7 @@ than filename generation (for example, in tt(case) statements and tests
within `tt([[)...tt(]])'), a `tt(/)' is not special; and `tt(/)' is also within `tt([[)...tt(]])'), a `tt(/)' is not special; and `tt(/)' is also
not special after a `tt(~)' appearing outside parentheses in a filename not special after a `tt(~)' appearing outside parentheses in a filename
pattern. pattern.
anchor(Globbing Flags)
subsect(Globbing Flags) subsect(Globbing Flags)
cindex(globbing flags) cindex(globbing flags)
cindex(glob flags) cindex(glob flags)
@@ -2687,6 +2670,7 @@ examining whole paths case-insensitively every directory must be
searched for all files which match, so that a pattern of the form searched for all files which match, so that a pattern of the form
tt(LPAR()#i)tt(RPAR()/foo/bar/...) is potentially slow. tt(LPAR()#i)tt(RPAR()/foo/bar/...) is potentially slow.
anchor(Approximate Matching)
subsect(Approximate Matching) subsect(Approximate Matching)
cindex(approximate matching) cindex(approximate matching)
cindex(matching, approximate) cindex(matching, approximate)
@@ -3184,8 +3168,8 @@ which they are given. These are the qualifiers `tt(M)', `tt(T)',
in brackets (`tt([)var(...)tt(])'). in brackets (`tt([)var(...)tt(])').
If a `tt(:)' appears in a qualifier list, the remainder of the expression in If a `tt(:)' appears in a qualifier list, the remainder of the expression in
parenthesis is interpreted as a modifier (see noderef(Modifiers) parenthesis is interpreted as a modifier (see subref(Modifiers)()
in noderef(History Expansion)). Each modifier must be introduced by a in sectref(History Expansion)(above)). Each modifier must be introduced by a
separate `tt(:)'. Note also that the result after modification does not separate `tt(:)'. Note also that the result after modification does not
have to be an existing file. The name of any existing file can be followed have to be an existing file. The name of any existing file can be followed
by a modifier of the form `tt(LPAR():)var(...)tt(RPAR())' by a modifier of the form `tt(LPAR():)var(...)tt(RPAR())'

11
Doc/Zsh/files.yo
View File

@@ -1,5 +1,6 @@
texinode(Files)(Shell Grammar)(Invocation)(Top) texinode(Files)(Shell Grammar)(Invocation)(Top)
chapter(Files) chapter(Files)
anchor(Startup/Shutdown Files)
sect(Startup/Shutdown Files) sect(Startup/Shutdown Files)
cindex(files, startup) cindex(files, startup)
cindex(startup files) cindex(startup files)
@@ -58,13 +59,7 @@ be executed when zsh is invoked with the `tt(-f)' option.
ifnzman(includefile(Zsh/filelist.yo)) ifnzman(includefile(Zsh/filelist.yo))
Any of these files may be pre-compiled with the tt(zcompile) builtin Any of these files may be pre-compiled with the tt(zcompile) builtin
command (\ command (see nmref(Shell Builtin Commands)(zshbuiltins)).
ifzman(\ If a compiled file exists (named for the original file plus the
see zmanref(zshbuiltins)\
)\
ifnzman(\
noderef(Shell Builtin Commands)\
)\
). If a compiled file exists (named for the original file plus the
tt(.zwc) extension) and it is newer than the original file, the compiled tt(.zwc) extension) and it is newer than the original file, the compiled
file will be used instead. file will be used instead.

8
Doc/Zsh/func.yo
View File

@@ -20,7 +20,7 @@ parameter, which extends dynamically to any other functions called by
the declaring function. In most cases, local parameters take the the declaring function. In most cases, local parameters take the
place of any other parameter having the same name that was assigned or place of any other parameter having the same name that was assigned or
declared in an earlier function scope. declared in an earlier function scope.
(See noderef(Local Parameters).) (See sectref(Local Parameters)(zshparam).)
A named parameter declared with the `tt(-n)' option to any of the A named parameter declared with the `tt(-n)' option to any of the
`tt(typeset)' acts as a reference to another parameter, which may `tt(typeset)' acts as a reference to another parameter, which may
@@ -66,6 +66,7 @@ findex(functions, use of)
Function identifiers can be listed with the tt(functions) builtin. Function identifiers can be listed with the tt(functions) builtin.
findex(unfunction, use of) findex(unfunction, use of)
Functions can be undefined with the tt(unfunction) builtin. Functions can be undefined with the tt(unfunction) builtin.
anchor(Autoloading Functions)
sect(Autoloading Functions) sect(Autoloading Functions)
cindex(autoloading functions) cindex(autoloading functions)
cindex(functions, autoloading) cindex(functions, autoloading)
@@ -235,6 +236,7 @@ for example `tt(name=; function $name { )var(...)tt( })', are not
treated as anonymous functions. Instead, they are treated as normal treated as anonymous functions. Instead, they are treated as normal
function definitions where the definition is silently discarded. function definitions where the definition is silently discarded.
anchor(Special Functions)
sect(Special Functions) sect(Special Functions)
Certain functions, if defined, have special meaning to the shell. Certain functions, if defined, have special meaning to the shell.
@@ -383,8 +385,8 @@ item(tt(TRAPDEBUG))(
If the option tt(DEBUG_BEFORE_CMD) is set (as it is by default), executed If the option tt(DEBUG_BEFORE_CMD) is set (as it is by default), executed
before each command; otherwise executed after each command. See before each command; otherwise executed after each command. See
the description of the tt(trap) builtin in the description of the tt(trap) builtin in
ifnzman(noderef(Shell Builtin Commands))\ nmref(Shell Builtin Commands)(zshbuiltins)
ifzman(zmanref(zshbuiltins)) for details of additional features provided for details of additional features provided
in debug traps. in debug traps.
) )
findex(TRAPEXIT) findex(TRAPEXIT)

20
Doc/Zsh/grammar.yo
View File

@@ -20,9 +20,7 @@ cindex(commands, simple)
A em(simple command) is a sequence of optional parameter A em(simple command) is a sequence of optional parameter
assignments followed by blank-separated words, assignments followed by blank-separated words,
with optional redirections interspersed. For a description with optional redirections interspersed. For a description
of assignment, see the beginning of of assignment, see the beginning of nmref(Parameters)(zshparam).
ifnzman(noderef(Parameters))\
ifzman(zmanref(zshparam)).
The first word is the command to be executed, and the remaining The first word is the command to be executed, and the remaining
words, if any, are arguments to the command. words, if any, are arguments to the command.
@@ -209,7 +207,7 @@ in the list, else it will be treated as marking the end of the list.
) )
item(tt(for LPAR()LPAR()) [var(expr1)] tt(;) [var(expr2)] tt(;) [var(expr3)] tt(RPAR()RPAR() do) var(list) tt(done))( item(tt(for LPAR()LPAR()) [var(expr1)] tt(;) [var(expr2)] tt(;) [var(expr3)] tt(RPAR()RPAR() do) var(list) tt(done))(
The arithmetic expression var(expr1) is evaluated first (see The arithmetic expression var(expr1) is evaluated first (see
noderef(Arithmetic Evaluation)). The arithmetic expression sectref(Arithmetic Evaluation)(below)). The arithmetic expression
var(expr2) is repeatedly evaluated until it evaluates to zero and var(expr2) is repeatedly evaluated until it evaluates to zero and
when non-zero, var(list) is executed and the arithmetic expression when non-zero, var(list) is executed and the arithmetic expression
var(expr3) evaluated. If any expression is omitted, then it behaves var(expr3) evaluated. If any expression is omitted, then it behaves
@@ -248,7 +246,7 @@ item(tt(case) var(word) tt(in) [ [tt(LPAR())] var(pattern) [ tt(|) var(pattern)
Execute the var(list) associated with the first var(pattern) Execute the var(list) associated with the first var(pattern)
that matches var(word), if any. The form of the patterns that matches var(word), if any. The form of the patterns
is the same as that used for filename generation. See is the same as that used for filename generation. See
noderef(Filename Generation). sectref(Filename Generation)(zshexpn).
Note further that, unless the tt(SH_GLOB) option is set, the whole Note further that, unless the tt(SH_GLOB) option is set, the whole
pattern with alternatives is treated by the shell as equivalent to a pattern with alternatives is treated by the shell as equivalent to a
@@ -373,7 +371,7 @@ Define a function which is referenced by any one of var(word).
Normally, only one var(word) is provided; multiple var(word)s Normally, only one var(word) is provided; multiple var(word)s
are usually only useful for setting traps. are usually only useful for setting traps.
The body of the function is the var(list) between The body of the function is the var(list) between
the tt({) and tt(}). See noderef(Functions). the tt({) and tt(}). See sectref(Functions)(blow).
The options of tt(function) have the following meanings: The options of tt(function) have the following meanings:
@@ -381,8 +379,7 @@ startitem()
item(-T)( item(-T)(
Enable tracing for this function, as though with tt(functions -T). See the Enable tracing for this function, as though with tt(functions -T). See the
documentation of the tt(-f) option to the tt(typeset) builtin, in documentation of the tt(-f) option to the tt(typeset) builtin, in
ifzman(zmanref(zshbuiltins))\ sectref(Shell Builtin Commands)(zshbuiltins).
ifnzman(noderef(Shell Builtin Commands)).
) )
enditem() enditem()
@@ -414,7 +411,7 @@ findex([[)
item(tt([[) var(exp) tt(]]))( item(tt([[) var(exp) tt(]]))(
Evaluates the conditional expression var(exp) Evaluates the conditional expression var(exp)
and return a zero exit status if it is true. and return a zero exit status if it is true.
See noderef(Conditional Expressions) See sectref(Conditional Expressions)(below)
for a description of var(exp). for a description of var(exp).
) )
enditem() enditem()
@@ -628,7 +625,7 @@ by a character that isn't special, it may be more convenient to quote the
word by starting with a single quote, i.e. tt('foo); completion will word by starting with a single quote, i.e. tt('foo); completion will
automatically add the trailing single quote. automatically add the trailing single quote.
subsect(Alias difficulties) subsect(Alias Difficulties)
Although aliases can be used in ways that bend normal shell syntax, not Although aliases can be used in ways that bend normal shell syntax, not
every string of non-white-space characters can be used as an alias. every string of non-white-space characters can be used as an alias.
@@ -636,8 +633,7 @@ every string of non-white-space characters can be used as an alias.
Any set of characters not listed as a word above is not a word, hence no Any set of characters not listed as a word above is not a word, hence no
attempt is made to expand it as an alias, no matter how it is defined attempt is made to expand it as an alias, no matter how it is defined
(i.e. via the builtin or the special parameter tt(aliases) described in (i.e. via the builtin or the special parameter tt(aliases) described in
ifnzman(noderef(The zsh/parameter Module))\ sectref(The zsh/parameter Module)(zshmodules)).
ifzman(the section THE ZSH/PARAMETER MODULE in zmanref(zshmodules))).
However, as noted in the case of tt(POSIX_ALIASES) above, the shell does However, as noted in the case of tt(POSIX_ALIASES) above, the shell does
not attempt to deduce whether the string corresponds to a word at the not attempt to deduce whether the string corresponds to a word at the
time the alias is created. time the alias is created.

3
Doc/Zsh/intro.yo
View File

@@ -44,8 +44,7 @@ login shell and as a shell script command processor. Of the standard shells,
zsh most closely resembles bf(ksh) but includes many enhancements. It zsh most closely resembles bf(ksh) but includes many enhancements. It
does not provide compatibility with POSIX or other shells in its does not provide compatibility with POSIX or other shells in its
default operating mode: see default operating mode: see
ifnzman(the section noderef(Compatibility))\ sectref(Compatibility)(below).
ifzman(the section `Compatibility' below).
Zsh has command line editing, builtin spelling correction, programmable Zsh has command line editing, builtin spelling correction, programmable
command completion, shell functions (with autoloading), a history command completion, shell functions (with autoloading), a history

9
Doc/Zsh/invoke.yo
View File

@@ -41,17 +41,12 @@ After the first one or two arguments have been appropriated as described above,
the remaining arguments are assigned to the positional parameters. the remaining arguments are assigned to the positional parameters.
For further options, which are common to invocation and the tt(set) For further options, which are common to invocation and the tt(set)
builtin, see builtin, see nmref(Options)(zshoptions).
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Options))\
.
The long option `tt(-)tt(-emulate)' followed (in a separate word) by an The long option `tt(-)tt(-emulate)' followed (in a separate word) by an
emulation mode may be passed to the shell. emulation mode may be passed to the shell.
The emulation modes are those described for the tt(emulate) builtin, The emulation modes are those described for the tt(emulate) builtin,
see see nmref(Shell Builtin Commands)(zshbuiltins).
ifzman(zmanref(zshbuiltins))\
ifnzman(noderef(Shell Builtin Commands)).
The `tt(-)tt(-emulate)' option must precede any other options (which might The `tt(-)tt(-emulate)' option must precede any other options (which might
otherwise be overridden), but following options are honoured, so otherwise be overridden), but following options are honoured, so
may be used to modify the requested emulation mode. Note that certain may be used to modify the requested emulation mode. Note that certain

8
Doc/Zsh/jobs.yo
View File

@@ -113,6 +113,7 @@ findex(disown, use of)
To avoid having the shell terminate the running jobs, either To avoid having the shell terminate the running jobs, either
use the manref(nohup)(1) command use the manref(nohup)(1) command
or the tt(disown) builtin. or the tt(disown) builtin.
anchor(Signals)
sect(Signals) sect(Signals)
The tt(INT) and tt(QUIT) signals for an invoked The tt(INT) and tt(QUIT) signals for an invoked
command are ignored if the command is followed by command are ignored if the command is followed by
@@ -131,8 +132,5 @@ would usually wait for such jobs, an explicit tt(exit) command
or exit due to the option tt(ERR_EXIT) will cause the shell to or exit due to the option tt(ERR_EXIT) will cause the shell to
exit without waiting. Examples of such asynchronous jobs are exit without waiting. Examples of such asynchronous jobs are
process substitution, see process substitution, see
ifzman(the section PROCESS SUBSTITUTION in the zmanref(zshexpn) manual page)\ sectref(Process Substitution)(zshexpn), and the handler processes for
ifnzman(noderef(Process Substitution)), and the handler processes for multios, see sectref(Multios)(zshmisc).
multios, see
ifzman(the section MULTIOS in the zmanref(zshmisc) manual page)\
ifnzman(the section em(Multios) in noderef(Redirection)).

4
Doc/Zsh/manual.yo
View File

@@ -93,8 +93,8 @@ Parameters
menu(Array Parameters) menu(Array Parameters)
menu(Positional Parameters) menu(Positional Parameters)
menu(Local Parameters) menu(Local Parameters)
menu(Parameters Set By The Shell) menu(Parameters Set by the Shell)
menu(Parameters Used By The Shell) menu(Parameters Used by the Shell)
Options Options

9
Doc/Zsh/mod_compctl.yo
View File

@@ -3,11 +3,6 @@ The tt(compctl) builtin for controlling completion.
!MOD!) !MOD!)
The tt(zsh/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 is the old, deprecated way to control completions for ZLE. See
ifzman(zmanref(zshcompctl))\ nmref(Completion Using compctl)(zshcompctl).
ifnzman(noderef(Completion Using compctl))\
.
The other builtin command, tt(compcall) can be used in user-defined The other builtin command, tt(compcall) can be used in user-defined
completion widgets, see completion widgets, see nmref(Completion Widgets)(zshcompwid).
ifzman(zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets))\
.

4
Doc/Zsh/mod_complete.yo
View File

@@ -3,6 +3,4 @@ The basic completion code.
!MOD!) !MOD!)
The tt(zsh/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 can be used in user-defined completion widgets, see
ifzman(zmanref(zshcompwid))\ nmref(Completion Widgets)(zshcompwid).
ifnzman(noderef(Completion Widgets))\
.

28
Doc/Zsh/mod_complist.yo
View File

@@ -8,7 +8,7 @@ The tt(zsh/complist) module offers three extensions to completion listings:
the ability to highlight matches in such a list, the ability to the ability to highlight matches in such a list, the ability to
scroll through long lists and a different style of menu completion. scroll through long lists and a different style of menu completion.
subsect(Colored completion listings) subsect(Colored Completion Listings)
Whenever one of the parameters tt(ZLS_COLORS) or tt(ZLS_COLOURS) is set Whenever one of the parameters tt(ZLS_COLORS) or tt(ZLS_COLOURS) is set
and the tt(zsh/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 completion lists will be colored. Note, however, that tt(complist) will
@@ -150,20 +150,17 @@ vt100 compatible terminals such as tt(xterm)s. On monochrome terminals
the default values will have no visible effect. The tt(colors) the default values will have no visible effect. The tt(colors)
function from the contribution can be used to get associative arrays function from the contribution can be used to get associative arrays
containing the codes for ANSI terminals (see containing the codes for ANSI terminals (see
ifzman(the section `Other Functions' in zmanref(zshcontrib))\ sectref(Other Functions)(zshcontrib)).
ifnzman(noderef(Other Functions))\ For example, after loading tt(colors), one could use
). For example, after loading tt(colors), one could use
`tt($color[red])' to get the code for foreground color red and `tt($color[red])' to get the code for foreground color red and
`tt($color[bg-green])' for the code for background color green. `tt($color[bg-green])' for the code for background color green.
If the completion system invoked by compinit is used, these If the completion system invoked by compinit is used, these
parameters should not be set directly because the system controls them parameters should not be set directly because the system controls them
itself. Instead, the tt(list-colors) style should be used (see itself. Instead, the tt(list-colors) style should be used (see
ifzman(the section `Completion System Configuration' in zmanref(zshcompsys))\ sectref(Completion System Configuration)(zshcompsys)).
ifnzman(noderef(Completion System Configuration))\
).
subsect(Scrolling in completion listings) subsect(Scrolling in Completion Listings)
To enable scrolling through a completion list, the tt(LISTPROMPT) To enable scrolling through a completion list, the tt(LISTPROMPT)
parameter must be set. Its value will be used as the prompt; if it parameter must be set. Its value will be used as the prompt; if it
is the empty string, a default prompt will be used. The value may is the empty string, a default prompt will be used. The value may
@@ -215,7 +212,7 @@ tt(LISTPROMPT) should not be set directly when using the shell
function based completion system. Instead, the tt(list-prompt) style function based completion system. Instead, the tt(list-prompt) style
should be used. should be used.
subsect(Menu selection) subsect(Menu Selection)
cindex(completion, selecting by cursor) cindex(completion, selecting by cursor)
vindex(MENUSELECT) vindex(MENUSELECT)
tindex(menu-select) tindex(menu-select)
@@ -223,15 +220,12 @@ 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 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 shell is set up to return to the last prompt after showing a
completion list (see the tt(ALWAYS_LAST_PROMPT) option in completion list (see the tt(ALWAYS_LAST_PROMPT) option in
ifzman(zmanref(zshoptions))\ nmref(Options)(zshoptions)).
ifnzman(noderef(Options))\
).
Menu selection can be invoked directly by Menu selection can be invoked directly by
the widget tt(menu-select) defined by this module. This is a standard the widget tt(menu-select) defined by this module. This is a standard
ZLE widget that can be bound to a key in the usual way as described ZLE widget that can be bound to a key in the usual way as described
in ifzman(zmanref(zshzle))\ in nmref(Zsh Line Editor)(zshzle).
ifnzman(noderef(Zsh Line Editor)).
Alternatively, Alternatively,
the parameter tt(MENUSELECT) can be set to an integer, which gives the the parameter tt(MENUSELECT) can be set to an integer, which gives the
@@ -406,10 +400,8 @@ tt(undefined-key) is looked up in the keymap currently selected. This
is used to ensure that the most important keys used during selection is used to ensure that the most important keys used during selection
(namely the cursor keys, return, and TAB) have sensible defaults. However, (namely the cursor keys, return, and TAB) have sensible defaults. However,
keys in the tt(menuselect) keymap can be modified directly using the keys in the tt(menuselect) keymap can be modified directly using the
tt(bindkey) builtin command (see tt(bindkey) builtin command (see sectref(Zle Builtins)(zshzle)).
ifzman(zmanref(zshmodules))\ For example, to make the return key leave menu selection without
ifnzman(noderef(The zsh/zle Module))\
). For example, to make the return key leave menu selection without
accepting the match currently selected one could call accepting the match currently selected one could call
example(bindkey -M menuselect '^M' send-break) example(bindkey -M menuselect '^M' send-break)

6
Doc/Zsh/mod_computil.yo
View File

@@ -5,10 +5,8 @@ completion system.
cindex(completion, utility) cindex(completion, utility)
The tt(zsh/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 completion system based on shell some of the completion functions in the completion system based on shell
functions (see functions (see nmref(Completion System)(zshcompsys)).
ifzman(zmanref(zshcompsys))\ Except for tt(compquote) these builtin commands are very
ifnzman(noderef(Completion System))
). Except for tt(compquote) these builtin commands are very
specialised and thus not very interesting when writing your own specialised and thus not very interesting when writing your own
completion functions. In summary, these builtin commands are: completion functions. In summary, these builtin commands are:

6
Doc/Zsh/mod_datetime.yo
View File

@@ -13,9 +13,9 @@ current system date/time is used; optionally, var(epochtime) may be used to
specify the number of seconds since the epoch, and var(nanoseconds) may specify the number of seconds since the epoch, and var(nanoseconds) may
additionally be used to specify the number of nanoseconds past the second additionally be used to specify the number of nanoseconds past the second
(otherwise that number is assumed to be 0). (otherwise that number is assumed to be 0).
See manref(strftime)(3) for details. The zsh extensions described in See manref(strftime)(3) for details. The zsh extensions described
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ under tt(%D{)var(string)tt(}) prompt eqcape in
ifnzman(noderef(Prompt Expansion)) are also available. sectref(Simple Prompt Escapes)(zshmisc) are also available.
startitem() startitem()
item(tt(-n))( item(tt(-n))(

3
Doc/Zsh/mod_mathfunc.yo
View File

@@ -38,8 +38,7 @@ distinct expressions.
The functions tt(min), tt(max), and tt(sum) are defined not in this module The functions tt(min), tt(max), and tt(sum) are defined not in this module
but in the tt(zmathfunc) autoloadable function, described in but in the tt(zmathfunc) autoloadable function, described in
ifzman(the section `Mathematical Functions' in zmanref(zshcontrib))\ sectref(Mathematical Functions)(zshcontrib).
ifnzman(noderef(Mathematical Functions)).
The following functions take two floating point arguments: tt(copysign), The following functions take two floating point arguments: tt(copysign),
tt(fmod), tt(hypot), tt(nextafter). tt(fmod), tt(hypot), tt(nextafter).

3
Doc/Zsh/mod_newuser.yo
View File

@@ -43,5 +43,4 @@ tt(zsh-newuser-install). This may be invoked directly by the user
even if the tt(zsh/newuser) module is disabled. Note, however, that even if the tt(zsh/newuser) module is disabled. Note, however, that
if the module is not installed the function will not be installed either. if the module is not installed the function will not be installed either.
The function is documented in The function is documented in
ifnzman(noderef(User Configuration Functions))\ sectref(User Configuration Functions)(zshcontrib).
ifzman(the section `User Configuration Functions' in zmanref(zshcontrib)).

9
Doc/Zsh/mod_parameter.yo
View File

@@ -119,13 +119,8 @@ item(tt(parameters))(
The keys in this associative array are the names of the parameters The keys in this associative array are the names of the parameters
currently defined. The values are strings describing the type of the currently defined. The values are strings describing the type of the
parameter, in the same format used by the tt(t) parameter flag, see parameter, in the same format used by the tt(t) parameter flag, see
ifzman(\ subref(Parameter Expansion Flags)(zshexpn).
zmanref(zshexpn) The value may also be `tt(undefined)' indicating a parameter that
)\
ifnzman(\
noderef(Parameter Expansion)
)\
. The value may also be `tt(undefined)' indicating a parameter that
may be autoloaded from a module but has not yet been referenced. may be autoloaded from a module but has not yet been referenced.
When the key is the name of a named reference, the value is When the key is the name of a named reference, the value is
`tt(nameref-)' prepended to the type of the referenced parameter, `tt(nameref-)' prepended to the type of the referenced parameter,

4
Doc/Zsh/mod_private.yo
View File

@@ -13,7 +13,7 @@ cindex(private parameter, creating)
item(tt(private) [ {tt(PLUS())|tt(-)}tt(AHUahlmrtux) ] \ item(tt(private) [ {tt(PLUS())|tt(-)}tt(AHUahlmrtux) ] \
[ {tt(PLUS())|tt(-)}tt(EFLRZi) [ var(n) ] ] [ var(name)[tt(=)var(value)] ... ])( [ {tt(PLUS())|tt(-)}tt(EFLRZi) [ var(n) ] ] [ var(name)[tt(=)var(value)] ... ])(
The tt(private) builtin accepts all the same options and arguments as tt(local) The tt(private) builtin accepts all the same options and arguments as tt(local)
(ifzman(zmanref(zshbuiltins))ifnzman(noderef(Shell Builtin Commands))) except (nmref(Shell Builtin Commands)(zshbuiltins)) except
for the `tt(-)tt(T)' option. Tied parameters may not be made private. for the `tt(-)tt(T)' option. Tied parameters may not be made private.
The `tt(-)tt(p)' option is presently disabled because the state of The `tt(-)tt(p)' option is presently disabled because the state of
@@ -24,7 +24,7 @@ outputs a private parameter, it is treated as a local with the
If used at the top level (outside a function scope), tt(private) creates a If used at the top level (outside a function scope), tt(private) creates a
normal parameter in the same manner as tt(declare) or tt(typeset). A normal parameter in the same manner as tt(declare) or tt(typeset). A
warning about this is printed if tt(WARN_CREATE_GLOBAL) is set warning about this is printed if tt(WARN_CREATE_GLOBAL) is set
(ifzman(zmanref(zshoptions))ifnzman(noderef(Options))). Used inside a (nmref(Options)(zshoptions)). Used inside a
function scope, tt(private) creates a local parameter similar to one function scope, tt(private) creates a local parameter similar to one
declared with tt(local), except having special properties noted below. declared with tt(local), except having special properties noted below.

7
Doc/Zsh/mod_sched.yo
View File

@@ -18,9 +18,7 @@ colon, or seconds alone.
An absolute number of seconds indicates the time since the epoch An absolute number of seconds indicates the time since the epoch
(1970/01/01 00:00); this is useful in combination with the features in (1970/01/01 00:00); this is useful in combination with the features in
the tt(zsh/datetime) module, see the tt(zsh/datetime) module, see
ifzman(the zsh/datetime module entry in zmanref(zshmodules))\ sectref(The zsh/datetime Module)(zshmodules).
ifnzman(noderef(The zsh/datetime Module))\
.
With no arguments, prints the list of scheduled commands. If the With no arguments, prints the list of scheduled commands. If the
scheduled command has the tt(-o) flag set, this is shown at the scheduled command has the tt(-o) flag set, this is shown at the
@@ -59,8 +57,7 @@ tt(sched) builtin. The indices of the array correspond to the numbers
shown when tt(sched) is run with no arguments (provided that the shown when tt(sched) is run with no arguments (provided that the
tt(KSH_ARRAYS) option is not set). The value of the array tt(KSH_ARRAYS) option is not set). The value of the array
consists of the scheduled time in seconds since the epoch consists of the scheduled time in seconds since the epoch
(see ifnzman(noderef(The zsh/datetime Module))\ (see sectref(The zsh/datetime Module)(zshmodules) for facilities for
ifzman(the section `The zsh/datetime Module') for facilities for
using this number), followed by a colon, followed by any options using this number), followed by a colon, followed by any options
(which may be empty but will be preceded by a `tt(-)' otherwise), (which may be empty but will be preceded by a `tt(-)' otherwise),
followed by a colon, followed by the command to be executed. followed by a colon, followed by the command to be executed.

5
Doc/Zsh/mod_stat.yo
View File

@@ -115,9 +115,8 @@ named files; no list of file names is allowed in this case.
item(tt(-F) var(fmt))( item(tt(-F) var(fmt))(
Supplies a tt(strftime) (see manref(strftime)(3)) string for the Supplies a tt(strftime) (see manref(strftime)(3)) string for the
formatting of the time elements. The format string supports all of the formatting of the time elements. The format string supports all of the
zsh extensions described in zsh extensions (see the description of tt(%D{)var(string)tt(})
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ prompt escape in sectref(Simple Prompt Escapes)(zshmisc)).
ifnzman(noderef(Prompt Expansion)).
In particular, tt(-F %s.%N) can be used to show timestamps with nanosecond In particular, tt(-F %s.%N) can be used to show timestamps with nanosecond
precision if supported by the system. precision if supported by the system.
The tt(-s) option is implied. The tt(-s) option is implied.

8
Doc/Zsh/mod_tcp.yo
View File

@@ -130,12 +130,8 @@ session table. If var(fd) is not specified,
tt(ztcp) will close everything in the session table. tt(ztcp) will close everything in the session table.
Normally, sockets registered by zftp (see Normally, sockets registered by zftp (see
ifzman(\ sectref(The zsh/zftp Module)(zshmodules))
zmanref(zshmodules) cannot be closed this way. In order
)\
ifnzman(\
noderef(The zsh/zftp Module)
)) cannot be closed this way. In order
to force such a socket closed, use tt(-f). to force such a socket closed, use tt(-f).
In order to elicit more verbose output, use tt(-v). In order to elicit more verbose output, use tt(-v).

6
Doc/Zsh/mod_watch.yo
View File

@@ -98,10 +98,8 @@ The date in `var(yy)tt(-)var(mm)tt(-)var(dd)' format.
) )
item(tt(%D{)var(string)tt(}))( item(tt(%D{)var(string)tt(}))(
The date formatted as var(string) using the tt(strftime) function, with The date formatted as var(string) using the tt(strftime) function, with
zsh extensions as described by zsh extensions as described for tt(%D{)var(string)tt(}) escape sequence in
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ sectref(Simple Prompt Escapes)(zshmisc).)
ifnzman(noderef(Prompt Expansion)).
)
item(tt(%LPAR())var(x)tt(:)var(true-text)tt(:)var(false-text)tt(RPAR()))( item(tt(%LPAR())var(x)tt(:)var(true-text)tt(:)var(false-text)tt(RPAR()))(
Specifies a ternary expression. Specifies a ternary expression.
The character following the var(x) is The character following the var(x) is

5
Doc/Zsh/mod_zftp.yo
View File

@@ -13,9 +13,8 @@ is implemented as a builtin to allow full use of shell command line
editing, file I/O, and job control mechanisms. Often, users will editing, file I/O, and job control mechanisms. Often, users will
access it via shell functions providing a more powerful interface; a set is access it via shell functions providing a more powerful interface; a set is
provided with the tt(zsh) distribution and is described in provided with the tt(zsh) distribution and is described in
ifzman(zmanref(zshzftpsys))\ nmref(Zftp Function System)(zshzftpsys).
ifnzman(noderef(Zftp Function System))\ However, the tt(zftp) command is entirely usable in its
. However, the tt(zftp) command is entirely usable in its
own right. own right.
All commands consist of the command name tt(zftp) followed by the name All commands consist of the command name tt(zftp) followed by the name

4
Doc/Zsh/mod_zle.yo
View File

@@ -2,6 +2,4 @@ COMMENT(!MOD!zsh/zle
The Zsh Line Editor, including the tt(bindkey) and tt(vared) builtins. The Zsh Line Editor, including the tt(bindkey) and tt(vared) builtins.
!MOD!) !MOD!)
The tt(zsh/zle) module contains the Zsh Line Editor. See The tt(zsh/zle) module contains the Zsh Line Editor. See
ifzman(zmanref(zshzle))\ nmref(Zsh Line Editor)(zshzle).
ifnzman(noderef(Zsh Line Editor))\
.

4
Doc/Zsh/mod_zleparameter.yo
View File

@@ -4,9 +4,7 @@ Access to internals of the Zsh Line Editor via parameters.
cindex(parameters, special) cindex(parameters, special)
The tt(zsh/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 used to access internal information of the Zsh Line Editor (see
ifzman(zmanref(zshzle))\ nmref(Zsh Line Editor)(zshzle)).
ifnzman(noderef(Zsh Line Editor))\
).
startitem() startitem()
vindex(keymaps) vindex(keymaps)

9
Doc/Zsh/mod_zpty.yo
View File

@@ -21,10 +21,11 @@ made non-blocking.
The shell parameter tt(REPLY) is set to the file descriptor assigned to The shell parameter tt(REPLY) is set to the file descriptor assigned to
the master side of the pseudo-terminal. This allows the terminal to be the master side of the pseudo-terminal. This allows the terminal to be
monitored with ZLE descriptor handlers (see ifzman(zmanref(zshzle))\ monitored with ZLE descriptor handlers (see the description of option
ifnzman(noderef(Zle Builtins))) or manipulated with tt(sysread) and tt(-F) for tt(zle) builtin in sectref(Zle Builtins)(zshzle))
tt(syswrite) (see ifzman(THE ZSH/SYSTEM MODULE in zmanref(zshmodules))\ or manipulated with tt(sysread) and tt(syswrite) builtins
ifnzman(noderef(The zsh/system Module))). em(Warning): Use of tt(sysread) (see sectref(The zsh/system Module)(zshmodules)).
em(Warning): Use of tt(sysread)
and tt(syswrite) is em(not) recommended; use tt(zpty -r) and tt(zpty -w) and tt(syswrite) is em(not) recommended; use tt(zpty -r) and tt(zpty -w)
unless you know exactly what you are doing. unless you know exactly what you are doing.
) )

4
Doc/Zsh/mod_zutil.yo
View File

@@ -46,7 +46,9 @@ zstyle ':weather:*:Sunday:*' preferred-precipitation snow)
Then the plugin would run under the hood a command such as Then the plugin would run under the hood a command such as
example(zstyle -s ":weather:${continent}:${day_of_week}:${moon_phase}" preferred-precipitation REPLY) example(zstyle -s \
":weather:${continent}:${day_of_week}:${moon_phase}" \
preferred-precipitation REPLY)
in order to retrieve your preference into the scalar variable tt($REPLY). in order to retrieve your preference into the scalar variable tt($REPLY).
On Sundays tt($REPLY) would be set to `tt(snow)'; in Europe it would be set On Sundays tt($REPLY) would be set to `tt(snow)'; in Europe it would be set

3
Doc/Zsh/modules.yo
View File

@@ -8,8 +8,7 @@ shell at build time,
or can be dynamically linked while the shell is running or can be dynamically linked while the shell is running
if the installation supports this feature. if the installation supports this feature.
Modules are linked at runtime with the tt(zmodload) command, Modules are linked at runtime with the tt(zmodload) command,
see ifzman(zmanref(zshbuiltins))\ see nmref(Shell Builtin Commands)(zshbuiltins).
ifnzman(noderef(Shell Builtin Commands)).
The modules that are bundled with the zsh distribution are: The modules that are bundled with the zsh distribution are:

75
Doc/Zsh/options.yo
View File

@@ -89,7 +89,7 @@ item(tt(CDABLE_VARS) (tt(-T)))(
If the argument to a tt(cd) command (or an implied tt(cd) with the If the argument to a tt(cd) command (or an implied tt(cd) with the
tt(AUTO_CD) option set) is not a directory, and does not begin with a tt(AUTO_CD) option set) is not a directory, and does not begin with a
slash, try to expand the expression as if it were preceded by a `tt(~)' (see slash, try to expand the expression as if it were preceded by a `tt(~)' (see
noderef(Filename Expansion)). sectref(Filename Expansion)(zshexpn)).
) )
pindex(CD_SILENT) pindex(CD_SILENT)
pindex(NO_CD_SILENT) pindex(NO_CD_SILENT)
@@ -146,9 +146,7 @@ item(tt(POSIX_CD) <K> <S>)(
Modifies the behaviour of tt(cd), tt(chdir) and tt(pushd) commands Modifies the behaviour of tt(cd), tt(chdir) and tt(pushd) commands
to make them more compatible with the POSIX standard. The behaviour with to make them more compatible with the POSIX standard. The behaviour with
the option unset is described in the documentation for the tt(cd) the option unset is described in the documentation for the tt(cd)
builtin in builtin in nmref(Shell Builtin Commands)(zshbuiltins).
ifzman(zmanref(zshbuiltins))\
ifnzman(noderef(Shell Builtin Commands)).
If the option is set, the shell does not test for directories beneath If the option is set, the shell does not test for directories beneath
the local directory (`tt(.)') until after all directories in tt(cdpath) the local directory (`tt(.)') until after all directories in tt(cdpath)
have been tested, and the tt(cd) and tt(chdir) commands do not recognise have been tested, and the tt(cd) and tt(chdir) commands do not recognise
@@ -441,7 +439,7 @@ cindex(enable globbing qualifiers)
item(tt(BARE_GLOB_QUAL) <Z>)( item(tt(BARE_GLOB_QUAL) <Z>)(
In a glob pattern, treat a trailing set of parentheses as a qualifier In a glob pattern, treat a trailing set of parentheses as a qualifier
list, if it contains no unquoted `tt(|)', `tt(LPAR())' or (if special) `tt(~)' list, if it contains no unquoted `tt(|)', `tt(LPAR())' or (if special) `tt(~)'
characters. See noderef(Filename Generation). characters. See sectref(Filename Generation)(zshexpn).
) )
pindex(BRACE_CCL) pindex(BRACE_CCL)
pindex(NO_BRACE_CCL) pindex(NO_BRACE_CCL)
@@ -452,7 +450,7 @@ cindex(expansion, brace, extending)
item(tt(BRACE_CCL))( item(tt(BRACE_CCL))(
Expand expressions in braces which would not otherwise undergo brace Expand expressions in braces which would not otherwise undergo brace
expansion to a lexically ordered list of all the characters. See expansion to a lexically ordered list of all the characters. See
noderef(Brace Expansion). sectref(Brace Expansion)(zshexpn).
) )
pindex(CASE_GLOB) pindex(CASE_GLOB)
pindex(NO_CASE_GLOB) pindex(NO_CASE_GLOB)
@@ -513,7 +511,7 @@ pindex(NOEQUALS)
cindex(filename expansion, =) cindex(filename expansion, =)
item(tt(EQUALS) <Z>)( item(tt(EQUALS) <Z>)(
Perform tt(=) filename expansion. Perform tt(=) filename expansion.
(See noderef(Filename Expansion).) (See sectref(Filename Expansion)(zshexpn).)
) )
pindex(EXTENDED_GLOB) pindex(EXTENDED_GLOB)
pindex(NO_EXTENDED_GLOB) pindex(NO_EXTENDED_GLOB)
@@ -544,7 +542,7 @@ cindex(globbing, enabling)
cindex(enabling globbing) cindex(enabling globbing)
item(tt(GLOB) (tt(PLUS()F), ksh: tt(PLUS()f)) <D>)( item(tt(GLOB) (tt(PLUS()F), ksh: tt(PLUS()f)) <D>)(
Perform filename generation (globbing). Perform filename generation (globbing).
(See noderef(Filename Generation).) (See sectref(Filename Generation)(zshexpn).)
) )
pindex(GLOB_ASSIGN) pindex(GLOB_ASSIGN)
pindex(NO_GLOB_ASSIGN) pindex(NO_GLOB_ASSIGN)
@@ -604,9 +602,7 @@ item(tt(HIST_SUBST_PATTERN))(
Substitutions using the tt(:s) and tt(:&) history modifiers are performed Substitutions using the tt(:s) and tt(:&) history modifiers are performed
with pattern matching instead of string matching. This occurs wherever with pattern matching instead of string matching. This occurs wherever
history modifiers are valid, including glob qualifiers and parameters. history modifiers are valid, including glob qualifiers and parameters.
See See subref(Modifiers)(zshexpn).
ifzman(the section `Modifiers' in zmanref(zshexpn))\
ifnzman(noderef(Modifiers)).
) )
pindex(IGNORE_BRACES) pindex(IGNORE_BRACES)
pindex(NO_IGNORE_BRACES) pindex(NO_IGNORE_BRACES)
@@ -650,7 +646,7 @@ pindex(NOKSHGLOB)
item(tt(KSH_GLOB) <K>)( item(tt(KSH_GLOB) <K>)(
In pattern matching, the interpretation of parentheses is affected by In pattern matching, the interpretation of parentheses is affected by
a preceding `tt(@)', `tt(*)', `tt(+)', `tt(?)' or `tt(!)'. a preceding `tt(@)', `tt(*)', `tt(+)', `tt(?)' or `tt(!)'.
See noderef(Filename Generation). See sectref(Filename Generation)(zshexpn).
) )
pindex(MAGIC_EQUAL_SUBST) pindex(MAGIC_EQUAL_SUBST)
pindex(NO_MAGIC_EQUAL_SUBST) pindex(NO_MAGIC_EQUAL_SUBST)
@@ -1157,7 +1153,7 @@ item(tt(RCS) (tt(PLUS()f)) <D>)(
After tt(zshenv()) is sourced on startup, source the After tt(zshenv()) is sourced on startup, source the
tt(.zshenv), tt(zprofile()), tt(.zprofile), tt(.zshenv), tt(zprofile()), tt(.zprofile),
tt(zshrc()), tt(.zshrc), tt(zlogin()), tt(.zlogin), and tt(.zlogout) tt(zshrc()), tt(.zshrc), tt(zlogin()), tt(.zlogin), and tt(.zlogout)
files, as described in noderef(Files). files, as described in sectref(Startup/Shutdown Files)(zsh).
If this option is unset, the tt(zshenv()) file is still sourced, but any If this option is unset, the tt(zshenv()) file is still sourced, but any
of the others will not be; it can be set at any time to prevent the of the others will not be; it can be set at any time to prevent the
remaining startup files after the currently executing one from remaining startup files after the currently executing one from
@@ -1353,9 +1349,7 @@ If this option is not set, a script passed as the first non-option argument
to the shell must contain the name of the file to open. If this to the shell must contain the name of the file to open. If this
option is set, and the script does not specify a directory path, option is set, and the script does not specify a directory path,
the script is looked for first in the current directory, then in the the script is looked for first in the current directory, then in the
command path. See command path. See sectref(Invocation)(zsh).
ifnzman(noderef(Invocation))\
ifzman(the section INVOCATION in zmanref(zsh)).
) )
pindex(PRINT_EIGHT_BIT) pindex(PRINT_EIGHT_BIT)
pindex(NO_PRINT_EIGHT_BIT) pindex(NO_PRINT_EIGHT_BIT)
@@ -1491,9 +1485,7 @@ such jobs will be killed automatically.
The check is omitted if the commands run from the previous command line The check is omitted if the commands run from the previous command line
included a `tt(jobs)' command, since it is assumed the user is aware that included a `tt(jobs)' command, since it is assumed the user is aware that
there are background or suspended jobs. A `tt(jobs)' command run from one there are background or suspended jobs. A `tt(jobs)' command run from one
of the hook functions defined in of the hook functions defined in sectref(Special Functions)(zshmisc)
ifnzman(the section `Special Functions' in noderef(Functions))\
ifzman(the section SPECIAL FUNCTIONS in zmanref(zshmisc))
is not counted for this purpose. is not counted for this purpose.
) )
pindex(CHECK_RUNNING_JOBS) pindex(CHECK_RUNNING_JOBS)
@@ -1584,9 +1576,7 @@ pindex(NOPROMPTBANG)
cindex(prompt, ! expansion) cindex(prompt, ! expansion)
item(tt(PROMPT_BANG) <K>)( item(tt(PROMPT_BANG) <K>)(
If set, `tt(!)' is treated specially in prompt expansion. If set, `tt(!)' is treated specially in prompt expansion.
See See sectref(Expansion of Prompt Sequences)(zshmisc).
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
) )
pindex(PROMPT_CR) pindex(PROMPT_CR)
pindex(NO_PROMPT_CR) pindex(NO_PROMPT_CR)
@@ -1626,9 +1616,7 @@ pindex(NOPROMPTPERCENT)
cindex(prompt, % expansion) cindex(prompt, % expansion)
item(tt(PROMPT_PERCENT) <C> <Z>)( item(tt(PROMPT_PERCENT) <C> <Z>)(
If set, `tt(%)' is treated specially in prompt expansion. If set, `tt(%)' is treated specially in prompt expansion.
See See sectref(Expansion of Prompt Sequences)(zshmisc).
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
) )
pindex(PROMPT_SUBST) pindex(PROMPT_SUBST)
pindex(NO_PROMPT_SUBST) pindex(NO_PROMPT_SUBST)
@@ -1707,8 +1695,7 @@ cindex(operator precedence)
item(tt(C_PRECEDENCES))( item(tt(C_PRECEDENCES))(
This alters the precedence of arithmetic operators to be more This alters the precedence of arithmetic operators to be more
like C and other programming languages; like C and other programming languages;
ifnzman(noderef(Arithmetic Evaluation))\ sectref(Arithmetic Evaluation)(zshmisc)
ifzman(the section ARITHMETIC EVALUATION in zmanref(zshmisc))
has an explicit list. has an explicit list.
) )
pindex(DEBUG_BEFORE_CMD) pindex(DEBUG_BEFORE_CMD)
@@ -1755,9 +1742,7 @@ which the tt(DEBUG) trap is being executed is skipped. The option is
restored after the trap exits. restored after the trap exits.
Exiting due to tt(ERR_EXIT) has certain interactions with asynchronous Exiting due to tt(ERR_EXIT) has certain interactions with asynchronous
jobs noted in jobs noted in sectref(Signals)(zshmisc).
ifzman(the section JOBS in zmanref(zshmisc))\
ifnzman(noderef(Jobs & Signals)).
Note this behaviour is not disabled in interactive shells --- Note this behaviour is not disabled in interactive shells ---
a non-zero status on the command line causes the shell to exit. a non-zero status on the command line causes the shell to exit.
@@ -1914,7 +1899,7 @@ pindex(NO_MULTIOS)
pindex(NOMULTIOS) pindex(NOMULTIOS)
item(tt(MULTIOS) <Z>)( item(tt(MULTIOS) <Z>)(
Perform implicit bf(tee)s or bf(cat)s when multiple Perform implicit bf(tee)s or bf(cat)s when multiple
redirections are attempted (see noderef(Redirection)). redirections are attempted (see sectref(Redirection)(zshmisc)).
) )
pindex(OCTAL_ZEROES) pindex(OCTAL_ZEROES)
pindex(NO_OCTAL_ZEROES) pindex(NO_OCTAL_ZEROES)
@@ -1995,9 +1980,7 @@ cindex(commands, tracing)
item(tt(XTRACE) (tt(-x), ksh: tt(-x)))( item(tt(XTRACE) (tt(-x), ksh: tt(-x)))(
Print commands and their arguments as they are executed. The Print commands and their arguments as they are executed. The
output is preceded by the value of tt($PS4), formatted as described output is preceded by the value of tt($PS4), formatted as described
in in sectref(Expansion of Prompt Sequences)(zshmisc).
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
) )
enditem() enditem()
@@ -2051,9 +2034,8 @@ pindex(CONTINUEONERROR)
pindex(NOCONTINUEONERROR) pindex(NOCONTINUEONERROR)
cindex(error, option to continue script on) cindex(error, option to continue script on)
item(tt(CONTINUE_ON_ERROR))( item(tt(CONTINUE_ON_ERROR))(
If a fatal error is encountered (see If a fatal error is encountered (see sectref(Errors)(zshmisc)),
ifnzman(noderef(Errors))\ and the code is running
ifzman(the section ERRORS in zmanref(zshmisc))), and the code is running
in a script, the shell will resume execution at the next statement in a script, the shell will resume execution at the next statement
in the script at the top level, in other words outside all functions in the script at the top level, in other words outside all functions
or shell constructs such as loops and conditions. This mimics the or shell constructs such as loops and conditions. This mimics the
@@ -2108,7 +2090,7 @@ cindex(csh, redirections with no command)
item(tt(CSH_NULLCMD) <C>)( item(tt(CSH_NULLCMD) <C>)(
Do not use the values of tt(NULLCMD) and tt(READNULLCMD) Do not use the values of tt(NULLCMD) and tt(READNULLCMD)
when running redirections with no command. This make when running redirections with no command. This make
such redirections fail (see noderef(Redirection)). such redirections fail (see sectref(Redirection)(zshmisc)).
) )
pindex(KSH_ARRAYS) pindex(KSH_ARRAYS)
pindex(NO_KSH_ARRAYS) pindex(NO_KSH_ARRAYS)
@@ -2204,8 +2186,7 @@ item(tt(POSIX_ALIASES) <K> <S>)(
When this option is set, reserved words are not candidates for When this option is set, reserved words are not candidates for
alias expansion: it is still possible to declare any of them as an alias, alias expansion: it is still possible to declare any of them as an alias,
but the alias will never be expanded. Reserved words are described in but the alias will never be expanded. Reserved words are described in
ifnzman(noderef(Reserved Words))\ sectref(Reserved Words)(zshmisc).
ifzman(the section RESERVED WORDS in zmanref(zshmisc)).
Alias expansion takes place while text is being read; hence when this Alias expansion takes place while text is being read; hence when this
option is set it does not take effect until the end of any function or option is set it does not take effect until the end of any function or
@@ -2393,7 +2374,7 @@ cindex(redirections with no command, sh)
cindex(redirections with no command, ksh) cindex(redirections with no command, ksh)
item(tt(SH_NULLCMD) <K> <S>)( item(tt(SH_NULLCMD) <K> <S>)(
Do not use the values of tt(NULLCMD) and tt(READNULLCMD) Do not use the values of tt(NULLCMD) and tt(READNULLCMD)
when doing redirections, use `tt(:)' instead (see noderef(Redirection)). when doing redirections, use `tt(:)' instead (see sectref(Redirection)(zshmisc)).
) )
pindex(SH_OPTION_LETTERS) pindex(SH_OPTION_LETTERS)
pindex(NO_SH_OPTION_LETTERS) pindex(NO_SH_OPTION_LETTERS)
@@ -2417,9 +2398,7 @@ cindex(sh, field splitting style)
item(tt(SH_WORD_SPLIT) (tt(-y)) <K> <S>)( item(tt(SH_WORD_SPLIT) (tt(-y)) <K> <S>)(
Causes field splitting to be performed on unquoted parameter expansions. Causes field splitting to be performed on unquoted parameter expansions.
Note that this option has nothing to do with word splitting. Note that this option has nothing to do with word splitting.
(See (See sectref(Parameter Expansion)(zshexpn).)
ifzman(zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion)).)
) )
pindex(TRAPS_ASYNC) pindex(TRAPS_ASYNC)
pindex(NO_TRAPS_ASYNC) pindex(NO_TRAPS_ASYNC)
@@ -2495,7 +2474,7 @@ item(tt(RESTRICTED) (tt(-r)))(
Enables restricted mode. This option cannot be changed using Enables restricted mode. This option cannot be changed using
tt(unsetopt), and setting it inside a function always changes it tt(unsetopt), and setting it inside a function always changes it
globally regardless of the tt(LOCAL_OPTIONS) option. See globally regardless of the tt(LOCAL_OPTIONS) option. See
noderef(Restricted Shell). sectref(Restricted Shell)(zsh).
) )
pindex(SHIN_STDIN) pindex(SHIN_STDIN)
pindex(NO_SHIN_STDIN) pindex(NO_SHIN_STDIN)
@@ -2727,7 +2706,7 @@ texinode(Single Letter Options)()(Option Aliases)(Options)
sect(Single Letter Options) sect(Single Letter Options)
cindex(options, single letter) cindex(options, single letter)
cindex(single letter options) cindex(single letter options)
subsect(Default set) subsect(Default Set)
startsitem() startsitem()
sitem(tt(-0))(CORRECT) sitem(tt(-0))(CORRECT)
sitem(tt(-1))(PRINT_EXIT_VALUE) sitem(tt(-1))(PRINT_EXIT_VALUE)
@@ -2784,7 +2763,7 @@ sitem(tt(-w))(CHASE_LINKS)
sitem(tt(-x))(XTRACE) sitem(tt(-x))(XTRACE)
sitem(tt(-y))(SH_WORD_SPLIT) sitem(tt(-y))(SH_WORD_SPLIT)
endsitem() endsitem()
subsect(sh/ksh emulation set) subsect(sh/ksh Emulation Set)
startsitem() startsitem()
sitem(tt(-C))(em(NO_)CLOBBER) sitem(tt(-C))(em(NO_)CLOBBER)
sitem(tt(-T))(TRAPS_ASYNC) sitem(tt(-T))(TRAPS_ASYNC)
@@ -2805,7 +2784,7 @@ sitem(tt(-u))(em(NO_)UNSET)
sitem(tt(-v))(VERBOSE) sitem(tt(-v))(VERBOSE)
sitem(tt(-x))(XTRACE) sitem(tt(-x))(XTRACE)
endsitem() endsitem()
subsect(Also note) subsect(Also Note)
startsitem() startsitem()
sitem(tt(-A))(Used by tt(set) for setting arrays) sitem(tt(-A))(Used by tt(set) for setting arrays)
sitem(tt(-b))(Used on the command line to specify end of option processing) sitem(tt(-b))(Used on the command line to specify end of option processing)

92
Doc/Zsh/params.yo
View File

@@ -80,9 +80,8 @@ not performed unless the option tt(GLOB_ASSIGN) is set.
When the integer attribute, tt(-i), or a floating point attribute, tt(-E) When the integer attribute, tt(-i), or a floating point attribute, tt(-E)
or tt(-F), is set for var(name), the var(value) is subject to arithmetic or tt(-F), is set for var(name), the var(value) is subject to arithmetic
evaluation. Furthermore, by replacing `tt(=)' with `tt(+=)', a parameter evaluation. Furthermore, by replacing `tt(=)' with `tt(+=)', a parameter
can be incremented or appended to. See noderef(Array Parameters) and can be incremented or appended to. See sectref(Array Parameters)(below) and
ifzman(em(Arithmetic Evaluation) LPAR()in zmanref(zshmisc)RPAR())\ sectref(Arithmetic Evaluation)(zshmisc)
ifnzman(noderef(Arithmetic Evaluation))
for additional forms of assignment. for additional forms of assignment.
Note that assignment may implicitly change the attributes of a parameter. Note that assignment may implicitly change the attributes of a parameter.
@@ -92,9 +91,7 @@ pattern to a variable may change its type to an array.
To reference the value of a parameter, write `tt($)var(name)' or To reference the value of a parameter, write `tt($)var(name)' or
`tt(${)var(name)tt(})'. The latter form is required when var(name) `tt(${)var(name)tt(})'. The latter form is required when var(name)
includes a namespace prefix. See includes a namespace prefix. See sectref(Parameter Expansion)(zshexpn)
ifzman(em(Parameter Expansion) in zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion))
for complete details. That section also explains the effect for complete details. That section also explains the effect
of the difference between scalar and array assignment on parameter of the difference between scalar and array assignment on parameter
expansion. expansion.
@@ -103,8 +100,8 @@ menu(Array Parameters)
menu(Positional Parameters) menu(Positional Parameters)
menu(Local Parameters) menu(Local Parameters)
menu(Named References) menu(Named References)
menu(Parameters Set By The Shell) menu(Parameters Set by the Shell)
menu(Parameters Used By The Shell) menu(Parameters Used by the Shell)
endmenu() endmenu()
texinode(Array Parameters)(Positional Parameters)()(Parameters) texinode(Array Parameters)(Positional Parameters)()(Parameters)
cindex(array parameters) cindex(array parameters)
@@ -131,7 +128,7 @@ may be in any order. Note that this syntax is strict: tt([) and tt(]=) must
not be quoted, and var(key) may not consist of the unquoted string not be quoted, and var(key) may not consist of the unquoted string
tt(]=), but is otherwise treated as a simple string. The enhanced forms tt(]=), but is otherwise treated as a simple string. The enhanced forms
of subscript expression that may be used when directly subscripting a of subscript expression that may be used when directly subscripting a
variable name, described in the section `Array Subscripts' below, are not variable name, described in subref(Array Subscripts)(below), are not
available. available.
The syntaxes with and without the explicit key may be mixed. An implicit The syntaxes with and without the explicit key may be mixed. An implicit
@@ -154,8 +151,7 @@ both var(key) and var(value) undergo all forms of expansion
allowed for single word shell expansions (this does not include filename allowed for single word shell expansions (this does not include filename
generation); these are as performed by the parameter expansion flag generation); these are as performed by the parameter expansion flag
tt(LPAR()e+RPAR()) as described in tt(LPAR()e+RPAR()) as described in
ifzman(zmanref(zshexpn))\ subref(Parameter Expansion Flags)(zshexpn).
ifnzman(noderef(Parameter Expansion)).
Nested parentheses may surround var(value) and are included as part of the Nested parentheses may surround var(value) and are included as part of the
value, which is joined into a plain string; this differs from ksh which value, which is joined into a plain string; this differs from ksh which
allows the values themselves to be arrays. A future version of zsh may allows the values themselves to be arrays. A future version of zsh may
@@ -221,6 +217,7 @@ ifzman()
indent(tt(set -A) var(name)) indent(tt(set -A) var(name))
indent(var(name)tt(=LPAR()RPAR())) indent(var(name)tt(=LPAR()RPAR()))
anchor(Array Subscripts)
subsect(Array Subscripts) subsect(Array Subscripts)
cindex(subscripts) cindex(subscripts)
Individual elements of an array may be selected using a subscript. A Individual elements of an array may be selected using a subscript. A
@@ -242,8 +239,7 @@ an array element with a subscript that evaluates to zero return an
empty string, while an attempt to write such an element is treated as empty string, while an attempt to write such an element is treated as
an error. For backward compatibility the tt(KSH_ZERO_SUBSCRIPT) an error. For backward compatibility the tt(KSH_ZERO_SUBSCRIPT)
option can be set to cause subscript values 0 and 1 to be equivalent; see option can be set to cause subscript values 0 and 1 to be equivalent; see
the description of the option in ifzman(zmanref(zshoptions))\ the description of the option in nmref(Description of Options)(zshoptions).
ifnzman(noderef(Description of Options)).
The same subscripting syntax is used for associative arrays, except that The same subscripting syntax is used for associative arrays, except that
no arithmetic expansion is applied to var(exp). However, the parsing no arithmetic expansion is applied to var(exp). However, the parsing
@@ -259,8 +255,7 @@ appear within double quotes.
associative arrays, `tt([*])' or `tt([@])' evaluate to all the values, associative arrays, `tt([*])' or `tt([@])' evaluate to all the values,
in no particular order. Note that this does not substitute in no particular order. Note that this does not substitute
the keys; see the documentation for the `tt(k)' flag under the keys; see the documentation for the `tt(k)' flag under
ifzman(em(Parameter Expansion Flags) in zmanref(zshexpn))\ subref(Parameter Expansion Flags)(zshexpn)
ifnzman(noderef(Parameter Expansion))
for complete details. for complete details.
When an array parameter is referenced as `tt($)var(name)' (with no When an array parameter is referenced as `tt($)var(name)' (with no
subscript) it evaluates to `tt($)var(name)tt([*])', unless the tt(KSH_ARRAYS) subscript) it evaluates to `tt($)var(name)tt([*])', unless the tt(KSH_ARRAYS)
@@ -472,10 +467,8 @@ for either purpose on the left side of an assignment.
) )
enditem() enditem()
See em(Parameter Expansion Flags) (\ See subref(Parameter Expansion Flags)(zshexpn)
ifzman(zmanref(zshexpn))\ for additional ways to manipulate the results of array subscripting.
ifnzman(noderef(Parameter Expansion))\
) for additional ways to manipulate the results of array subscripting.
subsect(Subscript Parsing) subsect(Subscript Parsing)
@@ -491,10 +484,8 @@ example(aa+=('key with "*strange*" characters' 'value string'))
The basic rule to remember when writing a subscript expression is that all The basic rule to remember when writing a subscript expression is that all
text between the opening `tt([)' and the closing `tt(])' is interpreted text between the opening `tt([)' and the closing `tt(])' is interpreted
em(as if) it were in double quotes (\ em(as if) it were in double quotes (see sectref(Quoting)(zshmisc)).
ifzman(see zmanref(zshmisc))\ However, unlike double quotes which normally cannot nest, subscript
ifnzman(noderef(Quoting))\
). However, unlike double quotes which normally cannot nest, subscript
expressions may appear inside double-quoted strings or inside other expressions may appear inside double-quoted strings or inside other
subscript expressions (or both!), so the rules have two important subscript expressions (or both!), so the rules have two important
differences. differences.
@@ -568,8 +559,7 @@ brackets, parentheses, etc., are seen only when the complete expression is
converted to a pattern. To match the value of a parameter literally in a converted to a pattern. To match the value of a parameter literally in a
reverse subscript, rather than as a pattern, reverse subscript, rather than as a pattern,
use `tt(${LPAR()q)tt(RPAR())var(name)tt(})' (\ use `tt(${LPAR()q)tt(RPAR())var(name)tt(})' (\
ifzman(see zmanref(zshexpn))\ sectref(Parameter Expansion)(zshexpn)\
ifnzman(noderef(Parameter Expansion))\
) to quote the expanded value. ) to quote the expanded value.
Note that the `tt(k)' and `tt(K)' flags are reverse subscripting for an Note that the `tt(k)' and `tt(K)' flags are reverse subscripting for an
@@ -596,11 +586,11 @@ cindex(parameters, positional)
sect(Positional Parameters) sect(Positional Parameters)
The positional parameters provide access to the command-line arguments The positional parameters provide access to the command-line arguments
of a shell function, shell script, or the shell itself; see of a shell function, shell script, or the shell itself; see
noderef(Invocation), and also noderef(Functions). sectref(Invocation)(zsh), and also sectref(Functions)(zshmisc).
The parameter var(n), where var(n) is a number, The parameter var(n), where var(n) is a number,
is the var(n)th positional parameter. is the var(n)th positional parameter.
The parameter `tt($0)' is a special case, see The parameter `tt($0)' is a special case, see
noderef(Parameters Set By The Shell). sectref(Parameters Set by the Shell)(below).
The parameters tt(*), tt(@) and tt(argv) are The parameters tt(*), tt(@) and tt(argv) are
arrays containing all the positional parameters; arrays containing all the positional parameters;
@@ -655,7 +645,7 @@ find the programs in tt(/new/directory) inside a function.
Note that the restriction in older versions of zsh that local parameters Note that the restriction in older versions of zsh that local parameters
were never exported has been removed. were never exported has been removed.
texinode(Named References)(Parameters Set By The Shell)(Local Parameters)(Parameters) texinode(Named References)(Parameters Set by the Shell)(Local Parameters)(Parameters)
cindex(named references) cindex(named references)
cindex(references, named) cindex(references, named)
sect(Named References) sect(Named References)
@@ -669,8 +659,7 @@ tt(print -r -- ${)var(pname)tt(}))
The `tt((P))' flag method is older and should be used when a script The `tt((P))' flag method is older and should be used when a script
needs to be backwards-compatible. This is described fully in needs to be backwards-compatible. This is described fully in
the Parameter Expansion Flags section of subref(Parameter Expansion Flags)(zshexpn). Zsh
ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)). Zsh
versions em(greater than) tt(5.9.0) are required for `tt(typeset -n)'. versions em(greater than) tt(5.9.0) are required for `tt(typeset -n)'.
This manual was generated with Zsh tt(version()). This manual was generated with Zsh tt(version()).
@@ -697,8 +686,7 @@ tt(typeset -n )var(pname)tt(=))
acts as a placeholder. The first non-empty assignment to var(pname) acts as a placeholder. The first non-empty assignment to var(pname)
initializes the reference, and subsequently any expansions of, or initializes the reference, and subsequently any expansions of, or
assignments to, var(pname) act on the referenced parameter. This assignments to, var(pname) act on the referenced parameter. This
is explained in the Named References section of is explained in subref(Named References)(zshexpn).
ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)).
A placeholder var(pname) in a calling function may be initialized in a A placeholder var(pname) in a calling function may be initialized in a
called function to reference a local parameter var(rname). In this called function to reference a local parameter var(rname). In this
@@ -709,8 +697,8 @@ therefore may become a reference to another parameter in the calling
function. It is recommended that placeholders be initialized soon function. It is recommended that placeholders be initialized soon
after they are declared, to make it clear what they reference. after they are declared, to make it clear what they reference.
texinode(Parameters Set By The Shell)(Parameters Used By The Shell)(Named References)(Parameters) texinode(Parameters Set by the Shell)(Parameters Used by the Shell)(Named References)(Parameters)
sect(Parameters Set By The Shell) sect(Parameters Set by the Shell)
In the parameter lists that follow, the mark `<S>' indicates that the In the parameter lists that follow, the mark `<S>' indicates that the
parameter is special. `<Z>' indicates that the parameter does not exist parameter is special. `<Z>' indicates that the parameter does not exist
when the shell initializes in tt(sh) or tt(ksh) emulation mode. when the shell initializes in tt(sh) or tt(ksh) emulation mode.
@@ -958,8 +946,7 @@ varies by platform (and probably isn't accurate to 1 ns regardless),
and the shell may show more or fewer digits depending on the and the shell may show more or fewer digits depending on the
use of tt(typeset). See use of tt(typeset). See
the documentation for the builtin tt(typeset) in the documentation for the builtin tt(typeset) in
ifzman(zmanref(zshbuiltins))\ nmref(Shell Builtin Commands)(zshbuiltins) for more details.
ifnzman(noderef(Shell Builtin Commands)) for more details.
) )
vindex(SHLVL) vindex(SHLVL)
item(tt(SHLVL) <S>)( item(tt(SHLVL) <S>)(
@@ -983,8 +970,7 @@ item(tt(TRY_BLOCK_ERROR) <S>)(
In an tt(always) block, indicates whether the preceding list of code In an tt(always) block, indicates whether the preceding list of code
caused an error. The value is 1 to indicate an error, 0 otherwise. caused an error. The value is 1 to indicate an error, 0 otherwise.
It may be reset, clearing the error condition. See It may be reset, clearing the error condition. See
ifzman(em(Complex Commands) in zmanref(zshmisc))\ sectref(Complex Commands)(zshmisc)
ifnzman(noderef(Complex Commands))
) )
vindex(TRY_BLOCK_INTERRUPT) vindex(TRY_BLOCK_INTERRUPT)
item(tt(TRY_BLOCK_INTERRUPT) <S>)( item(tt(TRY_BLOCK_INTERRUPT) <S>)(
@@ -1158,8 +1144,7 @@ hence most users should not use it and should instead rely on
tt($ZSH_VERSION). tt($ZSH_VERSION).
) )
item(tt(zsh_scheduled_events))( item(tt(zsh_scheduled_events))(
See ifzman(the section `The zsh/sched Module' in zmanref(zshmodules))\ See sectref(The zsh/sched Module)(zshmodules).
ifnzman(noderef(The zsh/sched Module)).
) )
vindex(ZSH_SCRIPT) vindex(ZSH_SCRIPT)
item(tt(ZSH_SCRIPT))( item(tt(ZSH_SCRIPT))(
@@ -1178,8 +1163,8 @@ item(tt(ZSH_VERSION))(
The version number of the release of zsh. The version number of the release of zsh.
) )
enditem() enditem()
texinode(Parameters Used By The Shell)()(Parameters Set By The Shell)(Parameters) texinode(Parameters Used by the Shell)()(Parameters Set by the Shell)(Parameters)
sect(Parameters Used By The Shell) sect(Parameters Used by the Shell)
The following parameters are used by the shell. Again, `<S>' indicates The following parameters are used by the shell. Again, `<S>' indicates
that the parameter is special and `<Z>' indicates that the parameter does that the parameter is special and `<Z>' indicates that the parameter does
not exist when the shell initializes in tt(sh) or tt(ksh) emulation mode. not exist when the shell initializes in tt(sh) or tt(ksh) emulation mode.
@@ -1474,17 +1459,13 @@ xitem(tt(match))
xitem(tt(mbegin)) xitem(tt(mbegin))
item(tt(mend))( item(tt(mend))(
Arrays set by the shell when the tt(b) globbing flag is used in pattern Arrays set by the shell when the tt(b) globbing flag is used in pattern
matches. See the subsection em(Globbing flags) in matches. See subref(Globbing Flags)(zshexpn).
ifzman(the documentation for em(Filename Generation) in zmanref(zshexpn))\
ifnzman(noderef(Filename Generation)).
) )
xitem(tt(MATCH)) xitem(tt(MATCH))
xitem(tt(MBEGIN)) xitem(tt(MBEGIN))
item(tt(MEND))( item(tt(MEND))(
Set by the shell when the tt(m) globbing flag is used in pattern Set by the shell when the tt(m) globbing flag is used in pattern
matches. See the subsection em(Globbing flags) in matches. See subref(Globbing Flags)(zshexpn).
ifzman(the documentation for em(Filename Generation) in zmanref(zshexpn))\
ifnzman(noderef(Filename Generation)).
) )
vindex(module_path) vindex(module_path)
vindex(MODULE_PATH) vindex(MODULE_PATH)
@@ -1553,9 +1534,8 @@ vindex(PS1)
item(tt(PS1) <S>)( item(tt(PS1) <S>)(
The primary prompt string, printed before a command is read. The primary prompt string, printed before a command is read.
It undergoes a special form of expansion It undergoes a special form of expansion
before being displayed; see before being displayed; see sectref(Expansion of Prompt Sequences)(zshmisc).
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\ The default is `tt(%m%# )'.
ifnzman(noderef(Prompt Expansion)). The default is `tt(%m%# )'.
) )
vindex(PS2) vindex(PS2)
item(tt(PS2) <S>)( item(tt(PS2) <S>)(
@@ -1796,9 +1776,7 @@ vindex(ZBEEP)
item(tt(ZBEEP))( item(tt(ZBEEP))(
If set, this gives a string of characters, which can use all the same codes If set, this gives a string of characters, which can use all the same codes
as the tt(bindkey) command as described in as the tt(bindkey) command as described in
ifzman(the zsh/zle module entry in zmanref(zshmodules))\ sectref(The zsh/zle Module)(zshmodules), that will be output to the terminal
ifnzman(noderef(The zsh/zle Module))\
, that will be output to the terminal
instead of beeping. This may have a visible instead of an audible effect; instead of beeping. This may have a visible instead of an audible effect;
for example, the string `tt(\e[?5h\e[?5l)' on a vt100 or xterm will have for example, the string `tt(\e[?5h\e[?5l)' on a vt100 or xterm will have
the effect of flashing reverse video on and off (if you usually use reverse the effect of flashing reverse video on and off (if you usually use reverse
@@ -1830,8 +1808,7 @@ remains disabled.
vindex(zle_highlight) vindex(zle_highlight)
item(tt(zle_highlight))( item(tt(zle_highlight))(
An array describing contexts in which ZLE should highlight the input text. An array describing contexts in which ZLE should highlight the input text.
See ifzman(em(Character Highlighting) in zmanref(zshzle))\ See sectref(Character Highlighting)(zshzle).
ifnzman(noderef(Character Highlighting)).
) )
vindex(ZLE_LINE_ABORTED) vindex(ZLE_LINE_ABORTED)
item(tt(ZLE_LINE_ABORTED))( item(tt(ZLE_LINE_ABORTED))(
@@ -1880,8 +1857,7 @@ include `tt(&)' the result is `tt(DIR &)'.
Note that certain completions may provide their own suffix removal Note that certain completions may provide their own suffix removal
or replacement behaviour which overrides the values described here. or replacement behaviour which overrides the values described here.
See the completion system documentation in See the completion system documentation in
ifzman(zmanref(zshcompsys))\ nmref(Completion System)(zshcompsys).
ifnzman(noderef(Completion System)).
) )
vindex(ZLE_RPROMPT_INDENT) vindex(ZLE_RPROMPT_INDENT)
item(tt(ZLE_RPROMPT_INDENT) <S>)( item(tt(ZLE_RPROMPT_INDENT) <S>)(

31
Doc/Zsh/prompt.yo
View File

@@ -1,5 +1,6 @@
texinode(Prompt Expansion)(Expansion)(Conditional Expressions)(Top) texinode(Prompt Expansion)(Expansion)(Conditional Expressions)(Top)
chapter(Prompt Expansion) chapter(Prompt Expansion)
anchor(Expansion of Prompt Sequences)
sect(Expansion of Prompt Sequences) sect(Expansion of Prompt Sequences)
cindex(prompt expansion) cindex(prompt expansion)
cindex(expansion, prompt) cindex(expansion, prompt)
@@ -29,15 +30,18 @@ represented as `tt(!!)'.
pindex(PROMPT_PERCENT, use of) pindex(PROMPT_PERCENT, use of)
If the tt(PROMPT_PERCENT) option is set, certain escape sequences that If the tt(PROMPT_PERCENT) option is set, certain escape sequences that
start with `tt(%)' are expanded. start with `tt(%)' are expanded.
Many escapes are followed by a single character, although some of these Many escapes (see sectref(Simple Prompt Escapes)(below))
are followed by a single character, although some of these
take an optional integer argument that take an optional integer argument that
should appear between the `tt(%)' and the next character of the should appear between the `tt(%)' and the next character of the
sequence. More complicated escape sequences are available to provide sequence. More complicated escape sequences
conditional expansion. (see sectref(Conditional Substrings in Prompts)(below))
are available to provide conditional expansion.
anchor(Simple Prompt Escapes)
sect(Simple Prompt Escapes) sect(Simple Prompt Escapes)
subsect(Special characters) subsect(Special Characters)
startitem() startitem()
item(tt(%%))( item(tt(%%))(
A `tt(%)'. A `tt(%)'.
@@ -47,7 +51,7 @@ A `tt(RPAR())'.
) )
enditem() enditem()
subsect(Login information) subsect(Login Information)
startitem() startitem()
item(tt(%l))( item(tt(%l))(
The line (tty) the user is logged in on, without `tt(/dev/)' prefix. The line (tty) the user is logged in on, without `tt(/dev/)' prefix.
@@ -71,7 +75,7 @@ This does not treat `tt(/dev/tty)' names specially.
) )
enditem() enditem()
subsect(Shell state) subsect(Shell State)
startitem() startitem()
item(tt(%#))( item(tt(%#))(
A `tt(#)' if the shell is running with privileges, a `tt(%)' if not. A `tt(#)' if the shell is running with privileges, a `tt(%)' if not.
@@ -108,9 +112,8 @@ As tt(%d) and tt(%/), but if the current working directory starts with
tt($HOME), that part is replaced by a `tt(~)'. Furthermore, if it has a named tt($HOME), that part is replaced by a `tt(~)'. Furthermore, if it has a named
directory as its prefix, that part is replaced by a `tt(~)' followed by directory as its prefix, that part is replaced by a `tt(~)' followed by
the name of the directory, but only if the result is shorter than the name of the directory, but only if the result is shorter than
the full path; the full path; see bf(Dynamic) and bf(Static Named Directories) in
ifzman(see em(Dynamic) and em(Static named directories) in zmanref(zshexpn))\ sectref(Filename Expansion)(zshexpn).
ifnzman(noderef(Filename Expansion)).
) )
item(tt(%e))( item(tt(%e))(
Evaluation depth of the current sourced file, shell function, or tt(eval). Evaluation depth of the current sourced file, shell function, or tt(eval).
@@ -162,7 +165,7 @@ the latter two sequences.
) )
enditem() enditem()
subsect(Date and time) subsect(Date and Time)
startitem() startitem()
item(tt(%D))( item(tt(%D))(
The date in var(yy)tt(-)var(mm)tt(-)var(dd) format. The date in var(yy)tt(-)var(mm)tt(-)var(dd) format.
@@ -218,7 +221,7 @@ and may work if the system supports them.
) )
enditem() enditem()
subsect(Visual effects) subsect(Visual Effects)
startitem() startitem()
item(tt(%B) LPAR()tt(%b)RPAR())( item(tt(%B) LPAR()tt(%b)RPAR())(
Start (stop) boldface mode. Start (stop) boldface mode.
@@ -238,9 +241,8 @@ by the terminal. The colour may be specified two ways: either
as a numeric argument, as normal, or by a sequence in braces as a numeric argument, as normal, or by a sequence in braces
following the tt(%F), for example tt(%F{red}). In the latter case following the tt(%F), for example tt(%F{red}). In the latter case
the values allowed are as described for the tt(fg) tt(zle_highlight) the values allowed are as described for the tt(fg) tt(zle_highlight)
attribute; attribute; see sectref(Character Highlighting)(zshzle).
ifzman(see em(Character Highlighting) in zmanref(zshzle))\ This means that numeric
ifnzman(noderef(Character Highlighting)). This means that numeric
colours are allowed in the second format also. colours are allowed in the second format also.
) )
item(tt(%K) LPAR()tt(%k)RPAR())( item(tt(%K) LPAR()tt(%k)RPAR())(
@@ -284,6 +286,7 @@ the correct truncation point can be found.
) )
enditem() enditem()
anchor(Conditional Substrings in Prompts)
sect(Conditional Substrings in Prompts) sect(Conditional Substrings in Prompts)
startitem() startitem()
item(tt(%v))( item(tt(%v))(

10
Doc/Zsh/redirect.yo
View File

@@ -152,8 +152,7 @@ with the terminal (assuming file descriptor 1 had been)
and then file descriptor 1 would be associated with file var(fname). and then file descriptor 1 would be associated with file var(fname).
The `tt(|&)' command separator described in The `tt(|&)' command separator described in
ifzman(em(Simple Commands & Pipelines) in zmanref(zshmisc))\ sectref(Simple Commands & Pipelines)(zshmisc)
ifnzman(noderef(Simple Commands & Pipelines))
is a shorthand for `tt(2>&1 |)'. is a shorthand for `tt(2>&1 |)'.
The various forms of process substitution, `tt(<LPAR())var(list)tt(RPAR())', The various forms of process substitution, `tt(<LPAR())var(list)tt(RPAR())',
@@ -161,11 +160,7 @@ and `tt(=LPAR())var(list)tt(RPAR())' for input and
`tt(>LPAR())var(list)tt(RPAR())' for output, are often used together with `tt(>LPAR())var(list)tt(RPAR())' for output, are often used together with
redirection. For example, if var(word) in an output redirection is of the redirection. For example, if var(word) in an output redirection is of the
form `tt(>LPAR())var(list)tt(RPAR())' then the output is piped to the form `tt(>LPAR())var(list)tt(RPAR())' then the output is piped to the
command represented by var(list). See command represented by var(list). See sectref(Process Substitution)(zshexpn).
ifzman(\
em(Process Substitution) in zmanref(zshexpn))\
ifnzman(\
noderef(Process Substitution)).
sect(Opening file descriptors using parameters) sect(Opening file descriptors using parameters)
cindex(file descriptors, use with parameters) cindex(file descriptors, use with parameters)
cindex(parameters, for using file descriptors) cindex(parameters, for using file descriptors)
@@ -220,6 +215,7 @@ Note that the expansion of the variable in the expression tt(>&$myfd)
occurs at the point the redirection is opened. This is after the expansion occurs at the point the redirection is opened. This is after the expansion
of command arguments and after any redirections to the left on the command of command arguments and after any redirections to the left on the command
line have been processed. line have been processed.
anchor(Multios)
sect(Multios) sect(Multios)
cindex(multios) cindex(multios)
pindex(MULTIOS, use of) pindex(MULTIOS, use of)

60
Doc/Zsh/roadmap.yo
View File

@@ -9,25 +9,21 @@ where in the rest of the manual the documentation is to be found.
sect(When the shell starts) sect(When the shell starts)
When it starts, the shell reads commands from various files. These can When it starts, the shell reads commands from various files. These can
be created or edited to customize the shell. See ifzman(the section be created or edited to customize the shell. See
Startup/Shutdown Files in zmanref(zsh))\ sectref(Startup/Shutdown Files)(zsh).
ifnzman(noderef(Files)).
If no personal initialization files exist for the current user, a function If no personal initialization files exist for the current user, a function
is run to help you change some of the most common settings. It won't is run to help you change some of the most common settings. It won't
appear if your administrator has disabled the tt(zsh/newuser) module. appear if your administrator has disabled the tt(zsh/newuser) module.
The function is designed to be self-explanatory. You can run it by hand The function is designed to be self-explanatory. You can run it by hand
with `tt(autoload -Uz zsh-newuser-install; zsh-newuser-install -f)'. with `tt(autoload -Uz zsh-newuser-install; zsh-newuser-install -f)'.
See also See also sectref(User Configuration Functions)(zshcontrib).
ifnzman(noderef(User Configuration Functions))\
ifzman(the section `User Configuration Functions' in zmanref(zshcontrib)).
sect(Interactive Use) sect(Interactive Use)
Interaction with the shell uses the builtin Zsh Line Editor, ZLE. This is Interaction with the shell uses the builtin Zsh Line Editor, ZLE. This is
described in detail in ifzman(zmanref(zshzle))\ described in detail in nmref(Zsh Line Editor)(zshzle).
ifnzman(noderef(Zsh Line Editor)).
The first decision a user must make is whether to use the Emacs or Vi The first decision a user must make is whether to use the Emacs or Vi
editing mode as the keys for editing are substantially different. Emacs editing mode as the keys for editing are substantially different. Emacs
@@ -40,8 +36,8 @@ shells, zsh will not save these lines when the shell exits unless you
set appropriate variables, and the number of history lines retained by set appropriate variables, and the number of history lines retained by
default is quite small (30 lines). See the description of the shell default is quite small (30 lines). See the description of the shell
variables (referred to in the documentation as parameters) tt(HISTFILE), variables (referred to in the documentation as parameters) tt(HISTFILE),
tt(HISTSIZE) and tt(SAVEHIST) in ifzman(zmanref(zshparam))\ tt(HISTSIZE) and tt(SAVEHIST) in
ifnzman(noderef(Parameters Used By The Shell)). Note that it's sectref(Parameters Used by the Shell)(zshparam). Note that it's
currently only possible to read and write files saving history currently only possible to read and write files saving history
when the shell is interactive, i.e. it does not work from scripts. when the shell is interactive, i.e. it does not work from scripts.
@@ -59,9 +55,7 @@ tt(LC_CTYPE) (to affect only the handling of character sets) is set to
an appropriate value. This is true even if you are using a an appropriate value. This is true even if you are using a
single-byte character set including extensions of ASCII such as single-byte character set including extensions of ASCII such as
tt(ISO-8859-1) or tt(ISO-8859-15). See the description of tt(LC_CTYPE) tt(ISO-8859-1) or tt(ISO-8859-15). See the description of tt(LC_CTYPE)
in in sectref(Parameters Used by the Shell)(zshparam).
ifnzman(noderef(Parameters))\
ifzman(zmanref(zshparam)).
subsect(Completion) subsect(Completion)
@@ -84,11 +78,9 @@ completions for many commonly used commands; it is therefore to be
preferred. preferred.
The completion system must be enabled explicitly when the shell starts. The completion system must be enabled explicitly when the shell starts.
For more information see For more information see nmref(Completion System)(zshcompsys).
ifzman(zmanref(zshcompsys))\
ifnzman(noderef(Completion System)).
subsect(Extending the line editor) subsect(Extending the Line Editor)
Apart from completion, the line editor is highly extensible by means of Apart from completion, the line editor is highly extensible by means of
shell functions. Some useful functions are provided with the shell; they shell functions. Some useful functions are provided with the shell; they
@@ -113,24 +105,21 @@ edit the command line with an external editor.
) )
enditem() enditem()
See ifzman(the section `ZLE Functions' in zmanref(zshcontrib))\ See sectref(ZLE Functions)(zshcontrib) for descriptions of these.
ifnzman(noderef(ZLE Functions)) for descriptions of these.
sect(Options) sect(Options)
The shell has a large number of options for changing its behaviour. The shell has a large number of options for changing its behaviour.
These cover all aspects of the shell; browsing the full documentation is These cover all aspects of the shell; browsing the full documentation is
the only good way to become acquainted with the many possibilities. See the only good way to become acquainted with the many possibilities. See
ifzman(zmanref(zshoptions))\ nmref(Options)(zshoptions).
ifnzman(noderef(Options)).
sect(Pattern Matching) sect(Pattern Matching)
The shell has a rich set of patterns which are available for file matching The shell has a rich set of patterns which are available for file matching
(described in the documentation as `filename generation' and also known for (described in the documentation as `filename generation' and also known for
historical reasons as `globbing') and for use when programming. These are historical reasons as `globbing') and for use when programming. These are
described in ifzman(the section `Filename Generation' in zmanref(zshexpn))\ described in sectref(Filename Generation)(zshexpn).
ifnzman(noderef(Filename Generation)).
Of particular interest are the following patterns that are not commonly Of particular interest are the following patterns that are not commonly
supported by other systems of pattern matching: supported by other systems of pattern matching:
@@ -158,41 +147,32 @@ sect(General Comments on Syntax)
Although the syntax of zsh is in ways similar to the Korn shell, and Although the syntax of zsh is in ways similar to the Korn shell, and
therefore more remotely to the original UNIX shell, the Bourne shell, therefore more remotely to the original UNIX shell, the Bourne shell,
its default behaviour does not entirely correspond to those shells. its default behaviour does not entirely correspond to those shells.
General shell syntax is introduced in ifzman(the section `Shell Grammar' in General shell syntax is introduced in sectref(Shell Grammar)(zshmisc).
zmanref(zshmisc))\
ifnzman(noderef(Shell Grammar)).
One commonly encountered difference is that variables substituted onto the One commonly encountered difference is that variables substituted onto the
command line are not split into words. See the description of the shell option command line are not split into words. See the description of the shell option
tt(SH_WORD_SPLIT) in tt(SH_WORD_SPLIT) in sectref(Parameter Expansion)(zshexpn).
ifzman(the section `Parameter Expansion' in zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion)).
In zsh, you can either explicitly request the splitting (e.g. tt(${=foo})) In zsh, you can either explicitly request the splitting (e.g. tt(${=foo}))
or use an array when you want a variable to expand to more than one word. See or use an array when you want a variable to expand to more than one word. See
ifzman(the section `Array Parameters' in zmanref(zshparam))\ sectref(Array Parameters)(zshparam).
ifnzman(noderef(Array Parameters)).
sect(Programming) sect(Programming)
The most convenient way of adding enhancements to the shell is typically The most convenient way of adding enhancements to the shell is typically
by writing a shell function and arranging for it to be autoloaded. by writing a shell function and arranging for it to be autoloaded.
Functions are described in ifzman(the section `Functions' in Functions are described in sectref(Functions)(zshmisc).
zmanref(zshmisc))\ Users changing from the C shell and its
ifnzman(noderef(Functions)). Users changing from the C shell and its
relatives should notice that aliases are less used in zsh as they don't relatives should notice that aliases are less used in zsh as they don't
perform argument substitution, only simple text replacement. perform argument substitution, only simple text replacement.
A few general functions, other than those for the line editor described A few general functions, other than those for the line editor described
above, are provided with the shell and are described in above, are provided with the shell and are described in
ifzman(zmanref(zshcontrib))\ nmref(User Contributions)(zshcontrib). Features include:
ifnzman(noderef(User Contributions)). Features include:
startitem() startitem()
item(tt(promptinit))( item(tt(promptinit))(
a prompt theme system for changing prompts easily, see ifzman(the section a prompt theme system for changing prompts easily, see
`Prompt Themes' sectref(Prompt Themes)(zshcontrib)
)\
ifnzman(noderef(Prompt Themes))
) )
item(tt(zsh-mime-setup))( item(tt(zsh-mime-setup))(
a MIME-handling system which dispatches commands according to the suffix of a MIME-handling system which dispatches commands according to the suffix of

25
Doc/Zsh/tcpsys.yo
View File

@@ -6,24 +6,15 @@ sect(Description)
A module tt(zsh/net/tcp) is provided to provide network I/O over A module tt(zsh/net/tcp) is provided to provide network I/O over
TCP/IP from within the shell; see its description in TCP/IP from within the shell; see its description in
ifzman(\ sectref(The zsh/net/tcp Module)(zshmodules).
zmanref(zshmodules)\ This manual page describes a function suite based on the module.
)\
ifnzman(\
noderef(Zsh Modules)\
). This manual page describes a function suite based on the module.
If the module is installed, the functions are usually installed at the If the module is installed, the functions are usually installed at the
same time, in which case they will be available for same time, in which case they will be available for
autoloading in the default function search path. In addition to the autoloading in the default function search path. In addition to the
tt(zsh/net/tcp) module, the tt(zsh/zselect) module is used to implement tt(zsh/net/tcp) module, the tt(zsh/zselect) module is used to implement
timeouts on read operations. For troubleshooting tips, consult the timeouts on read operations. For troubleshooting tips, consult the
corresponding advice for the tt(zftp) functions described in corresponding advice for the tt(zftp) functions described in
ifzman(\ nmref(Zftp Function System)(zshzftpsys).
zmanref(zshzftpsys)\
)\
ifnzman(\
noderef(Zftp Function System)\
).
There are functions corresponding to the basic I/O operations open, close, There are functions corresponding to the basic I/O operations open, close,
read and send, named tt(tcp_open) etc., as well as a function read and send, named tt(tcp_open) etc., as well as a function
@@ -426,7 +417,7 @@ installed.
) )
enditem() enditem()
subsect(`One-shot' file transfer) subsect(`One-shot' File Transfer)
startitem() startitem()
xitem(tt(tcp_point) var(port)) xitem(tt(tcp_point) var(port))
item(tt(tcp_shoot) var(host) var(port))( item(tt(tcp_shoot) var(host) var(port))(
@@ -542,13 +533,7 @@ findex(tcp_fd_handler)
item(tt(tcp_fd_handler))( item(tt(tcp_fd_handler))(
This is the function installed by tt(tcp_open) for handling input from This is the function installed by tt(tcp_open) for handling input from
within the line editor, if that is required. It is in the format within the line editor, if that is required. It is in the format
documented for the builtin `tt(zle -F)' in documented for the builtin `tt(zle -F)' in sectref(Zle Builtins)(zshzle).
ifzman(\
zmanref(zshzle)
)\
ifnzman(\
noderef(Zle Builtins)
).
While active, the function sets the parameter tt(TCP_HANDLER_ACTIVE) to 1. While active, the function sets the parameter tt(TCP_HANDLER_ACTIVE) to 1.
This allows shell code called internally (for example, by setting This allows shell code called internally (for example, by setting

31
Doc/Zsh/zftpsys.yo
View File

@@ -14,12 +14,7 @@ and so on, are present, and macros are particularly simple to write as they
are just ordinary shell functions. are just ordinary shell functions.
The prerequisite is that the tt(zftp) command, as described in The prerequisite is that the tt(zftp) command, as described in
ifzman(\ sectref(The zsh/zftp Module)(zshmodules), must be available in the
zmanref(zshmodules)
)\
ifnzman(\
noderef(The zsh/zftp Module)
), must be available in the
version of tt(zsh) installed at your site. If the shell is configured to 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 zsh/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 will make sure (if that runs silently, it has worked). If this is not the
@@ -72,7 +67,7 @@ shell's tt(getopts) builtin, for those functions that handle options you
must use `tt(-)tt(-)' rather than `tt(-)' to ensure the remaining arguments must use `tt(-)tt(-)' rather than `tt(-)' to ensure the remaining arguments
are treated literally (a single `tt(-)' is treated as an argument). are treated literally (a single `tt(-)' is treated as an argument).
subsect(Opening a connection) subsect(Opening a Connection)
startitem() startitem()
findex(zfparams) findex(zfparams)
item(tt(zfparams) [ var(host) [ var(user) [ var(password) ... ] ] ])( item(tt(zfparams) [ var(host) [ var(user) [ var(password) ... ] ] ])(
@@ -128,7 +123,7 @@ suitable string.
) )
enditem() enditem()
subsect(Directory management) subsect(Directory Management)
startitem() startitem()
findex(zfcd) findex(zfcd)
xitem(tt(zfcd) [ var(dir) ]) xitem(tt(zfcd) [ var(dir) ])
@@ -197,7 +192,7 @@ are passed directly to the server. No pager and no caching is used.
) )
enditem() enditem()
subsect(Status commands) subsect(Status Commands)
startitem() startitem()
findex(zftype) findex(zftype)
item(tt(zftype) [ var(type) ])( item(tt(zftype) [ var(type) ])(
@@ -215,7 +210,7 @@ events, too.
) )
enditem() enditem()
subsect(Retrieving files) subsect(Retrieving Files)
The commands for retrieving files all take at least two options. tt(-G) The commands for retrieving files all take at least two options. tt(-G)
suppresses remote filename expansion which would otherwise be performed suppresses remote filename expansion which would otherwise be performed
(see below for a more detailed description of that). tt(-t) attempts (see below for a more detailed description of that). tt(-t) attempts
@@ -268,7 +263,7 @@ directory semantics.
) )
enditem() enditem()
subsect(Sending files) subsect(Sending Files)
startitem() startitem()
findex(zfput) findex(zfput)
item(tt(zfput) [ tt(-r) ] var(file1) ...)( item(tt(zfput) [ tt(-r) ] var(file1) ...)(
@@ -320,7 +315,7 @@ then tt(zfpcp) will retry using the second form.
) )
enditem() enditem()
subsect(Closing the connection) subsect(Closing the Connection)
startitem() startitem()
findex(zfclose) findex(zfclose)
item(tt(zfclose))( item(tt(zfclose))(
@@ -328,7 +323,7 @@ Close the connection.
) )
enditem() enditem()
subsect(Session management) subsect(Session Management)
startitem() startitem()
findex(zfsession) findex(zfsession)
item(tt(zfsession) [ tt(-lvod) ] [ var(sessname) ])( item(tt(zfsession) [ tt(-lvod) ] [ var(sessname) ])(
@@ -410,7 +405,7 @@ from the zftp functions.
) )
enditem() enditem()
subsect(Other functions) subsect(Other Functions)
Mostly, these functions will not be called directly (apart from Mostly, these functions will not be called directly (apart from
tt(zfinit)), but are described here for completeness. You may wish to tt(zfinit)), but are described here for completeness. You may wish to
alter tt(zftp_chpwd) and tt(zftp_progress), in particular. alter tt(zftp_chpwd) and tt(zftp_progress), in particular.
@@ -511,9 +506,7 @@ cindex(zftp function system, styles)
cindex(styles in zftp functions) cindex(styles in zftp functions)
Various styles are available using the standard shell style mechanism, Various styles are available using the standard shell style mechanism,
described in described in sectref(The zsh/zutil Module)(zshmodules). Briefly, the
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)). Briefly, the
command `tt(zstyle ':zftp:*') var(style) var(value) ...'. command `tt(zstyle ':zftp:*') var(style) var(value) ...'.
defines the var(style) to have value var(value); more than one value may be defines the var(style) to have value var(value); more than one value may be
given, although that is not useful in the cases described here. These given, although that is not useful in the cases described here. These
@@ -582,7 +575,7 @@ Note that there is also an associative array tt(zfconfig) which contains
values used by the function system. This should not be modified or values used by the function system. This should not be modified or
overwritten. overwritten.
subsect(Remote globbing) subsect(Remote Globbing)
cindex(zftp function system, remote globbing) cindex(zftp function system, remote globbing)
The commands for retrieving files usually perform filename generation The commands for retrieving files usually perform filename generation
@@ -606,7 +599,7 @@ typically UNIX servers will provide support for basic glob patterns. This
may in some cases be faster, as it avoids retrieving the entire list of may in some cases be faster, as it avoids retrieving the entire list of
directory contents. directory contents.
subsect(Automatic and temporary reopening) subsect(Automatic and Temporary Reopening)
cindex(zftp function system, automatic reopening) cindex(zftp function system, automatic reopening)
As described for the tt(zfopen) command, a subsequent tt(zfopen) with no As described for the tt(zfopen) command, a subsequent tt(zfopen) with no

61
Doc/Zsh/zle.yo
View File

@@ -25,14 +25,11 @@ vindex(BAUD, use of)
vindex(COLUMNS, use of) vindex(COLUMNS, use of)
vindex(LINES, use of) vindex(LINES, use of)
The parameters tt(BAUD), tt(COLUMNS), and tt(LINES) are also used by the The parameters tt(BAUD), tt(COLUMNS), and tt(LINES) are also used by the
line editor. See line editor. See sectref(Parameters Used by the Shell)(zshparam).
ifzman(em(Parameters Used By The Shell) in zmanref(zshparam))\
ifnzman(noderef(Parameters Used By The Shell)).
vindex(zle_highlight, use of) vindex(zle_highlight, use of)
The parameter tt(zle_highlight) is also used by the line editor; see The parameter tt(zle_highlight) is also used by the line editor; see
ifzman(em(Character Highlighting) below)\ sectref(Character Highlighting)(below). Highlighting
ifnzman(noderef(Character Highlighting)). Highlighting
of special characters and the region between the cursor and the of special characters and the region between the cursor and the
mark (as set with tt(set-mark-command) in Emacs mode, or by tt(visual-mode) mark (as set with tt(set-mark-command) in Emacs mode, or by tt(visual-mode)
in Vi mode) is enabled in Vi mode) is enabled
@@ -48,9 +45,7 @@ a number, or pressing escape before each digit, and in vi command mode
by typing the number before entering a command. Generally the numeric by typing the number before entering a command. Generally the numeric
argument causes the next command entered to be repeated the specified argument causes the next command entered to be repeated the specified
number of times, unless otherwise noted below; this is implemented number of times, unless otherwise noted below; this is implemented
by the tt(digit-argument) widget. See also by the tt(digit-argument) widget. See also subref(Arguments)(below)
ifzman(the em(Arguments) subsection of the em(Widgets) section )\
ifnzman(noderef(Arguments))\
for some other ways the numeric argument can be modified. for some other ways the numeric argument can be modified.
startmenu() startmenu()
@@ -137,9 +132,7 @@ without a real command being read.
A key sequence typed by the user can be turned into a command name for use A key sequence typed by the user can be turned into a command name for use
in user-defined widgets with the tt(read-command) widget, described in in user-defined widgets with the tt(read-command) widget, described in
ifzman(the subsection `Miscellaneous' of the section `Standard Widgets' below)\ subref(Miscellaneous)(below).
ifnzman(noderef(Miscellaneous) below)\
.
subsect(Local Keymaps) subsect(Local Keymaps)
cindex(local keymaps) cindex(local keymaps)
@@ -467,9 +460,7 @@ specified name, it is overwritten. When the new
widget is invoked from within the editor, the specified shell var(function) widget is invoked from within the editor, the specified shell var(function)
is called. If no function name is specified, it defaults to is called. If no function name is specified, it defaults to
the same name as the widget. For further information, see the same name as the widget. For further information, see
ifzman(the section `Widgets' below)\ sectref(Zle Widgets)(below).
ifnzman(noderef(Zle Widgets))\
.
) )
item(tt(-f) var(flag) [ var(flag)... ])( item(tt(-f) var(flag) [ var(flag)... ])(
Set various flags on the running widget. Possible values for var(flag) are: Set various flags on the running widget. Possible values for var(flag) are:
@@ -499,10 +490,7 @@ Create a user-defined completion widget named var(widget). The
completion widget will behave like the built-in completion-widget completion widget will behave like the built-in completion-widget
whose name is given as var(completion-widget). To generate the whose name is given as var(completion-widget). To generate the
completions, the shell function var(function) will be called. completions, the shell function var(function) will be called.
For further information, see For further information, see nmref(Completion Widgets)(zshcompwid).
ifzman(zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets))\
.
) )
item(tt(-R) [ tt(-c) ] [ var(display-string) ] [ var(string) ... ])( item(tt(-R) [ tt(-c) ] [ var(display-string) ] [ var(string) ... ])(
Redisplay the command line. If a var(display-string) is Redisplay the command line. If a var(display-string) is
@@ -603,8 +591,7 @@ unpredictable behavior.
Here is a simple example of using this feature. A connection to a remote Here is a simple example of using this feature. A connection to a remote
TCP port is created using the ztcp command; see TCP port is created using the ztcp command; see
ifzman(the description of the tt(zsh/net/tcp) module in zmanref(zshmodules))\ sectref(The zsh/net/tcp Module)(zshmodules). Then a handler is installed
ifnzman(noderef(The zsh/net/tcp Module)). Then a handler is installed
which simply prints out any data which arrives on this connection. Note which simply prints out any data which arrives on this connection. Note
that `select' will indicate that the file descriptor needs handling that `select' will indicate that the file descriptor needs handling
if the remote side has closed the connection; we handle that by testing if the remote side has closed the connection; we handle that by testing
@@ -741,12 +728,10 @@ in keymaps are bound to are in fact widgets. Widgets can be user-defined
or built in. or built in.
The standard widgets built into ZLE are listed in The standard widgets built into ZLE are listed in
ifzman(the section `Standard Widgets' below)\ sectref(Standard Widgets)(below).
ifnzman(noderef(Standard Widgets)).
Other built-in widgets can be defined by other modules (see Other built-in widgets can be defined by other modules (see
ifzman(zmanref(zshmodules))\ nmref(Zsh Modules)(zshmodules)).
ifnzman(noderef(Zsh Modules))\ Each built-in widget has two names: its normal canonical name, and the
). Each built-in widget has two names: its normal canonical name, and the
same name preceded by a `tt(.)'. The `tt(.)' name is special: it can't be same name preceded by a `tt(.)'. The `tt(.)' name is special: it can't be
rebound to a different widget. This makes the widget available even when rebound to a different widget. This makes the widget available even when
its usual name has been redefined. its usual name has been redefined.
@@ -972,8 +957,7 @@ Indicates if the region is currently active. It can be assigned 0 or 1
to deactivate and activate the region respectively. A value of 2 to deactivate and activate the region respectively. A value of 2
activates the region in line-wise mode with the highlighted text activates the region in line-wise mode with the highlighted text
extending for whole lines only; see extending for whole lines only; see
ifzman(em(Character Highlighting) below)\ sectref(Character Highlighting)(below).
ifnzman(noderef(Character Highlighting)).
) )
vindex(region_highlight) vindex(region_highlight)
item(tt(region_highlight) (array))( item(tt(region_highlight) (array))(
@@ -995,8 +979,7 @@ itemiz(A start offset in the same units as tt(CURSOR).)
itemiz(An end offset in the same units as tt(CURSOR).) itemiz(An end offset in the same units as tt(CURSOR).)
itemiz(A highlight specification in the same format as itemiz(A highlight specification in the same format as
used for contexts in the parameter tt(zle_highlight), see used for contexts in the parameter tt(zle_highlight), see
ifnzman(noderef(Character Highlighting))\ sectref(Character Highlighting)(below);
ifzman(the section `Character Highlighting' below);
for example, tt(standout) or tt(fg=red,bold).) for example, tt(standout) or tt(fg=red,bold).)
itemiz(Optionally, a string of the form `tt(memo=)var(token)'. itemiz(Optionally, a string of the form `tt(memo=)var(token)'.
The var(token) consists of everything between the `tt(=)' and the next The var(token) consists of everything between the `tt(=)' and the next
@@ -1010,8 +993,7 @@ in order to remove array elements it have added.
(This example uses the `tt(${)var(name)tt(:#)var(pattern)tt(})' array-grepping (This example uses the `tt(${)var(name)tt(:#)var(pattern)tt(})' array-grepping
syntax described in syntax described in
ifzman(the section `Parameter Expansion' in zmanref(zshexpn))\ sectref(Parameter Expansion)(zshexpn).))
ifnzman(noderef(Parameter Expansion)).))
enditemize() enditemize()
For example, For example,
@@ -1034,8 +1016,7 @@ API promise. It's mentioned in the "Incompatibilities" section of README.)
The final highlighting on the command line depends on both tt(region_highlight) The final highlighting on the command line depends on both tt(region_highlight)
and tt(zle_highlight); see and tt(zle_highlight); see
ifzman(the section CHARACTER HIGHLIGHTING below)\ sectref(Character Highlighting)(below) for details.
ifnzman(noderef(Character Highlighting)) for details.
) )
vindex(registers) vindex(registers)
item(tt(registers) (associative array))( item(tt(registers) (associative array))(
@@ -1144,6 +1125,7 @@ example(if [[ $ZLE_STATE == *globalhistory*insert* ]]; then ...; fi)
) )
enditem() enditem()
anchor(Special Widgets)
subsect(Special Widgets) subsect(Special Widgets)
There are a few user-defined widgets which are special to the shell. There are a few user-defined widgets which are special to the shell.
@@ -1229,8 +1211,8 @@ shown in the list are those based on the VT100, common on many modern
terminals, but in fact these are not necessarily bound. In the case of the terminals, but in fact these are not necessarily bound. In the case of the
tt(viins) keymap, the initial escape character of the sequences serves also tt(viins) keymap, the initial escape character of the sequences serves also
to return to the tt(vicmd) keymap: whether this happens is determined by to return to the tt(vicmd) keymap: whether this happens is determined by
the tt(KEYTIMEOUT) parameter, see ifzman(zmanref(zshparam))\ the tt(KEYTIMEOUT) parameter, see
ifnzman(noderef(Parameters)). sectref(Parameters Used by the Shell)(zshparam).
startmenu() startmenu()
menu(Movement) menu(Movement)
menu(History Control) menu(History Control)
@@ -1570,9 +1552,8 @@ item(tt(history-incremental-pattern-search-forward))(
These widgets behave similarly to the corresponding widgets with These widgets behave similarly to the corresponding widgets with
no tt(-pattern), but the search string typed by the user is treated no tt(-pattern), but the search string typed by the user is treated
as a pattern, respecting the current settings of the various options as a pattern, respecting the current settings of the various options
affecting pattern matching. See affecting pattern matching. See sectref(Filename Generation)(zshexpn)
ifzman(FILENAME GENERATION in zmanref(zshexpn))\ for a description of patterns.
ifnzman(noderef(Filename Generation)) for a description of patterns.
If no numeric argument was given lowercase letters in the search If no numeric argument was given lowercase letters in the search
string may match uppercase letters in the history. The string may begin string may match uppercase letters in the history. The string may begin
with `tt(^)' to anchor the search to the beginning of the line. with `tt(^)' to anchor the search to the beginning of the line.
@@ -2771,9 +2752,7 @@ million colours). In this case, the hex triplet format can be used. This
consists of a `tt(#)' followed by either a three or six digit hexadecimal consists of a `tt(#)' followed by either a three or six digit hexadecimal
number describing the red, green and blue components of the colour. Hex number describing the red, green and blue components of the colour. Hex
triplets can also be used with 88 and 256 colour terminals via the triplets can also be used with 88 and 256 colour terminals via the
tt(zsh/nearcolor) module (see ifzman(zmanref(zshmodules))\ tt(zsh/nearcolor) module (see nmref(The zsh/nearcolor Module)(zshmodules)).
ifnzman(noderef(The zsh/nearcolor Module))\
).
Colour is also known as color. Colour is also known as color.
) )

45
Doc/zman.yo
View File

@@ -97,10 +97,51 @@ def(comment)(1)(\
COMMENT(--- cross-references ---) COMMENT(--- cross-references ---)
def(manref)(2)(\ def(manref)(2)(\
NOTRANS(\fI)ARG1+NOTRANS(\fP)(ARG2)\ bf(ARG1)(ARG2)\
) )
def(zmanref)(1)(manref(ARG1)(1)) def(zmanref)(1)(manref(ARG1)(1))
def(noderef)(1)(the section `ARG1') def(noderef)(1)(bf(UPPERCASE(NOTRANS(ARG1))(0)))
COMMENT( nmref(node)(manpage)
Refer to 'node' (texi) or 'manpage' (man).
)
def(nmref)(2)(noderef(ARG2))
COMMENT( sectref(sectname)(manpage)
Refer to 'section' in 'manpage' (man), or a node (texi).
There should be a node (or anchor) with the name 'sectname'.
'manpage' can be "above", "below" or "".
)
def(sectref)(2)(\
IFEMPTY(ARG2)(\
the section noderef(ARG1)\
)(\
IFSTREQUAL(ARG2)(above)(\
noderef(ARG1) above\
)(\
IFSTREQUAL(ARG2)(below)(\
noderef(ARG1) below\
)(\
noderef(ARG1) in zmanref(ARG2)\
)\
)\
)\
)
COMMENT( subref(subsectname)(manpage) )
def(subref)(2)(\
IFEMPTY(ARG2)(\
the subsection bf(ARG1)\
)(\
IFSTREQUAL(ARG2)(above)(\
bf(ARG1) above\
)(\
IFSTREQUAL(ARG2)(below)(\
bf(ARG1) below\
)(\
bf(ARG1) in zmanref(ARG2)\
)\
)\
)\
)
def(anchor)(1)()
COMMENT(--- lists ---) COMMENT(--- lists ---)

7
Doc/ztexi.yo
View File

@@ -156,6 +156,13 @@ def(zmanref)(1)(manref(ARG1)(1))
def(noderef)(1)(\ def(noderef)(1)(\
NOTRANS(@ref{)ARG1+NOTRANS(})\ NOTRANS(@ref{)ARG1+NOTRANS(})\
) )
COMMENT( See comments in zman.yo )
def(nmref)(2)(noderef(ARG1))
def(sectref)(2)(noderef(ARG1))
def(subref)(2)(noderef(ARG1))
def(anchor)(1)(\
NOTRANS(@anchor{)ARG1+NOTRANS(})\
)
COMMENT(--- lists ---) COMMENT(--- lists ---)

5
Util/zyodl.vim
View File

@@ -58,7 +58,7 @@ syn match zyodlNumber "\d\+"
syn region zyodlItem start="\<xitem(" end=")" contains=zyodlSpecial,@zyodlInline syn region zyodlItem start="\<xitem(" end=")" contains=zyodlSpecial,@zyodlInline
syn region zyodlItem start="\<item(" end=")" contains=zyodlSpecial,@zyodlInline syn region zyodlItem start="\<item(" end=")" contains=zyodlSpecial,@zyodlInline
syn region zyodlExample start="\<example(" end=")" contains=zyodlSpecial,zyodlParenthetical syn region zyodlExample start="\<example(" end=")" contains=zyodlSpecial,zyodlParenthetical
syn region zyodlComment start="\<COMMENT(" end=")" contains=zyodlSpecial,@zyodlInline,zyodlParenthetical syn region zyodlComment start="\<COMMENT(" end=")" contains=zyodlSpecial,@zyodlInline,zyodlParenthetical,zyodlRef
" comment that gets output in generated texinfo/roff source " comment that gets output in generated texinfo/roff source
syn region zyodlComment start="\<comment(" end=")" syn region zyodlComment start="\<comment(" end=")"
syn region zyodlTitle start="\<\(chapter\|subsect\|sect\)(" end=")" contains=zyodlSpecial,@zyodlInline,zyodlParenthetical syn region zyodlTitle start="\<\(chapter\|subsect\|sect\)(" end=")" contains=zyodlSpecial,@zyodlInline,zyodlParenthetical
@@ -67,7 +67,8 @@ syn region zyodlParenthetical start="\w\@<!(" end=")" transparent contained cont
" zyodlCond doesn't contain zyodlParenthetical, since section names (probably) don't have parentheticals. " zyodlCond doesn't contain zyodlParenthetical, since section names (probably) don't have parentheticals.
syn region zyodlCond start="\<\(ifzman\|ifnzman\)(" end=")" contains=zyodlRef,zyodlSpecial,@zyodlInline syn region zyodlCond start="\<\(ifzman\|ifnzman\)(" end=")" contains=zyodlRef,zyodlSpecial,@zyodlInline
syn region zyodlRef start="\<\(zmanref\|noderef\)(" end=")" syn region zyodlRef start="\<\(zmanref\|noderef\|anchor\)(" end=")"
syn match zyodlRef "\<\(nm\|sect\|sub\)ref([^)]*)([^)]*)"
" zyodlSItemArg2 should use zyodlParenthetical instead of the 'skip=' " zyodlSItemArg2 should use zyodlParenthetical instead of the 'skip='
syn keyword zyodlKeyword sitem nextgroup=zyodlSItemArg1 syn keyword zyodlKeyword sitem nextgroup=zyodlSItemArg1