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>
* 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)(\
item(tt(ARG1) var(simple command))(
See ifzman(the section `Precommand Modifiers' in zmanref(zshmisc))\
ifnzman(noderef(Precommand Modifiers)).
See sectref(Precommand Modifiers)(zshmisc).
)\
)\
def(alias)(2)(\
@@ -17,14 +16,12 @@ Same as tt(ARG2).
)\
def(module)(2)(\
item(tt(ARG1))(
See ifzman(the section `The ARG2 Module' in zmanref(zshmodules))\
ifnzman(noderef(The ARG2 Module)).
See sectref(The ARG2 Module)(zshmodules).
)\
)\
def(zlecmd)(1)(\
item(tt(ARG1))(
See ifzman(the section `Zle Builtins' in zmanref(zshzle))\
ifnzman(noderef(Zle Builtins)).
See sectref(Zle Builtins)(zshzle).
)\
)\
@@ -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
which no alias has been defined.
For more on aliases, include common problems, see
ifzman(the section ALIASING in zmanref(zshmisc))\
ifnzman(noderef(Aliasing)).
For more on aliases, including common problems,
see sectref(Aliasing)(zshmisc).
)
findex(autoload)
cindex(functions, autoloading)
cindex(autoloading functions)
item(tt(autoload) [ {tt(PLUS())|tt(-)}tt(RTUXdkmrtWz) ] [ tt(-w) ] [ var(name) ... ])(
vindex(fpath, searching)
See the section `Autoloading Functions' in ifzman(zmanref(zshmisc))\
ifnzman(noderef(Functions)) for full details. The tt(fpath) parameter
See sectref(Autoloading Functions)(zshmisc)
for full details. The tt(fpath) parameter
will be searched to find the function definition when the function is
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
-v).
See also ifzman(the section `Precommand Modifiers' in zmanref(zshmisc))\
ifnzman(noderef(Precommand Modifiers)).
See also sectref(Precommand Modifiers)(zshmisc).
)
module(comparguments)(zsh/computil)
module(compcall)(zsh/compctl)
@@ -362,9 +357,8 @@ item(tt(-c))(
clear the directory stack.
)
item(tt(-l))(
print directory names in full instead of using of using tt(~) expressions (\
ifzman(see em(Dynamic) and em(Static named directories) in zmanref(zshexpn))\
ifnzman(noderef(Filename Expansion))).
print directory names in full instead of using tt(~) expressions
(see sectref(Filename Expansion)(zshexpn)).
)
item(tt(-p))(
print directory entries one per line.
@@ -394,7 +388,7 @@ are disabled. Disabled objects can be enabled with the tt(enable)
command.
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.
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)
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
based on the shell name, see
ifzman(\
the section COMPATIBILITY in zmanref(zsh)
)\
ifnzman(\
noderef(Compatibility)
)\
. In addition to setting shell options, the command also restores
based on the shell name, see sectref(Compatibility)(zsh).
In addition to setting shell options, the command also restores
the pristine state of pattern enables, as if all patterns had been
enabled using tt(enable -p).
@@ -581,8 +569,7 @@ options that may in principle change, not just those that would actually
change.
The var(flags) may be any of the invocation-time flags described in
ifnzman(noderef(Invocation))\
ifzman(the section INVOCATION in zmanref(zsh)),
sectref(Invocation)(zsh),
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.
@@ -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);
with tt(-a) var(argv0) set the tt(argv[0]) string of the command
executed.
See ifzman(the section `Precommand Modifiers' in zmanref(zshmisc))\
ifnzman(noderef(Precommand Modifiers)).
See sectref(Precommand Modifiers)(zshmisc).
If the option tt(POSIX_BUILTINS) is set, var(command) is never
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
the tt(IGNORE_EOF) option is set.
See notes at the end of
ifzman(the section JOBS in zmanref(zshmisc))\
ifnzman(noderef(Jobs & Signals)) for some possibly unexpected interactions
See notes at the end of sectref(Signals)(zshmisc)
for some possibly unexpected interactions
of the tt(exit) command with jobs.
)
findex(export)
@@ -762,8 +747,8 @@ following flags.
startsitem()
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
tt(SHARE_HISTORY) in ifzman(zmanref(zshoptions))\
ifnzman(noderef(Description of Options)) -- note that tt($HISTFILE) is
tt(SHARE_HISTORY) in
nmref(Description of Options)(zshoptions) -- note that tt($HISTFILE) is
considered local when read at startup))
sitem(tt(-m))(takes the first argument as a pattern (which should be
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;
var(fmt) is formatted with the strftime function with the zsh extensions
described for the tt(%D{)var(string)tt(}) prompt format in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)). The resulting formatted string must be
sectref(Simple Prompt Escapes)(zshmisc).
The resulting formatted string must be
no more than 256 characters or will not be printed
)
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
a mathematical function recognised in all forms of arithmetical expressions;
see
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\
ifnzman(noderef(Arithmetic Evaluation))\
. By default var(mathfn) may take
see sectref(Arithmetic Evaluation)(zshmisc).
By default var(mathfn) may take
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
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)
item(tt(let) var(arg) ...)(
Evaluate each var(arg) as an arithmetic expression.
See
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\
ifnzman(noderef(Arithmetic Evaluation))
See sectref(Arithmetic Evaluation)(zshmisc)
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
an error occurred.
@@ -1316,10 +1297,7 @@ tt(-c) and tt(-C) options.
)
item(tt(-b))(
Recognize all the escape sequences defined for the tt(bindkey) command,
see
ifzman(the section `Zle Builtins' in zmanref(zshzle))\
ifnzman(noderef(Zle Builtins))\
.
see sectref(Zle Builtins)(zshzle).
)
item(tt(-c))(
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))(
Perform prompt expansion (see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion))\
).
sectref(Expansion of Prompt Sequences)(zshmisc)).
In combination with `tt(-f)',
prompt escape sequences are parsed only within interpolated arguments,
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,
the numeric value of the following character is used as the number to
print; otherwise the argument is evaluated as an arithmetic expression. See
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\
ifnzman(noderef(Arithmetic Evaluation))
for a description of arithmetic
sectref(Arithmetic Evaluation)(zshmisc) for a description of arithmetic
expressions. With `tt(%n)', the corresponding argument is taken as an
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
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
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
). This flag is ignored when the tt(-k) or tt(-q) flags are present.
nmref(Zsh Line Editor)(zshzle)).
This flag is ignored when the tt(-k) or tt(-q) flags are present.
)
xitem(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
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
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Options))\
. Flags may be specified by name using the tt(-o) option. If no option
nmref(Options)(zshoptions).
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
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
@@ -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
default options for the current emulation (the default emulation being
native tt(zsh), shown as tt(<Z>) in
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Description of Options))).
sectref(Description of Options)(zshoptions)).
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 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) ... ])
item(tt([) [ var(arg) ... ] tt(]))(
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
tt(test) and tt([) builtins are: these commands are not handled
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
(as it is by default), else after each command. Here, a `command' is
what is described as a `sublist' in the shell grammar, see
ifnzman(noderef(Simple Commands & Pipelines))\
ifzman(the section SIMPLE COMMANDS & PIPELINES in zmanref(zshmisc)).
sectref(Simple Commands & Pipelines)(zshmisc).
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
tt(ERR_EXIT); see the description of the tt(ERR_EXIT) option in
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Description of Options)). Also, the shell parameter
nmref(Description of Options)(zshoptions). Also, the shell parameter
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
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
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
function completes. See
ifzman(`Local Parameters' in zmanref(zshparam))\
ifnzman(noderef(Local Parameters))\
. The same rules apply to special shell parameters, which
function completes. See sectref(Local Parameters)(zshparam).
The same rules apply to special shell parameters, which
retain their special attributes when made local.
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
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.
See ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)) and
ifzman(zmanref(zshparam))ifnzman(noderef(Parameters)) for details of the
See sectref(Parameter Expansion)(zshexpn) and
sectref(Named References)(zshparam) for details of the
behavior of named references.
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
(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)
are not printed with `tt(-)tt(p)' because to execute those typeset commands
would cause errors. However, these parameters are printed when they
@@ -2205,9 +2173,7 @@ The following attribute flags may be specified:
startitem()
item(tt(-A))(
The names refer to associative array parameters; see
ifzman(`Array Parameters' in zmanref(zshparam))\
ifnzman(noderef(Array Parameters))\
.
sectref(Array Parameters)(zshparam).
)
item(tt(-L) [ var(n) ])(
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,
use padding with parameter expansion flags
tt(${+LPAR()ml)var(...)tt(RPAR())var(...)tt(}) as described in
`Parameter Expansion Flags' in
ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)).
subref(Parameter Expansion Flags)(zshexpn).
When the parameter is expanded, it is filled on the right with
blanks or truncated if necessary to fit the field.
@@ -2282,9 +2247,8 @@ tt(typeset -fU).
)
item(tt(-h))(
Hide: only useful for special parameters (those marked `<S>' in the table in
ifzman(zmanref(zshparam))\
ifnzman(noderef(Parameters Set By The Shell))\
), and for local parameters with the same name as a special parameter,
sectref(Parameters Set by the Shell)(zshparam)),
and for local parameters with the same name as a special parameter,
though harmless for others. A special parameter with this attribute will
not retain its special effect when made local. Thus after `tt(typeset -h
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
the same directory as the var(file). The shell will load the compiled
file instead of the normal function file when the function
is autoloaded; see
ifzman(\
the section `Autoloading Functions' in zmanref(zshmisc)
)\
ifnzman(\
noderef(Functions)
)\
is autoloaded; see sectref(Autoloading Functions)(zshmisc)
for a description of how autoloaded functions are searched. The
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)
anchor(File and Date Formats)
sect(File and Date Formats)
subsect(Calendar File Format)
The calendar file is by default tt(~/calendar). This can be configured
by the tt(calendar-file) style, see
ifzman(the section STYLES below)\
ifnzman(noderef(Calendar Styles)). The basic format consists
by the tt(calendar-file) style, see sectref(Styles)(below).
The basic format consists
of a series of separate lines, with no indentation, each including
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
the use in glob qualifiers.
subsect(Calendar system functions)
subsect(Calendar System Functions)
startitem()
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.
The timed event usually runs the programme tt(calendar_show) to show
the event, as described in
ifzman(the section UTILITY FUNCTIONS below)\
ifnzman(noderef(Calendar Utility Functions)).
the event, as described in sectref(Utility Functions)(below).
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
@@ -477,8 +475,7 @@ findex(calendar_add)
item(tt(calendar_add) [ tt(-BL) ] var(event) ...)(
Adds a single event to the calendar in the appropriate location.
The event can contain multiple lines, as described in
ifnzman(noderef(Calendar File and Date Formats))\
ifzman(the section `Calendar File Format' above).
sectref(File and Date Formats)(above).
Using this function ensures that the calendar file is sorted in date
and time order. It also makes special arrangements for locking
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()
subsect(Glob qualifiers)
subsect(Glob Qualifiers)
startitem()
item(tt(age))(
@@ -620,8 +617,7 @@ only the builtin tt(zstat).
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
understood by the calendar system, described in
ifzman(the section FILE AND DATE FORMATS above)\
ifnzman(noderef(Calendar File and Date Formats)).
sectref(File and Date Formats)(above).
The function can take one or two arguments, which can be supplied either
directly as command or arguments, or separately as shell parameters.
@@ -699,11 +695,11 @@ print *+LPAR()e-after today:12:00-RPAR())
enditem()
texinode(Calendar Styles)(Calendar Utility Functions)(Calendar System User Functions)(Calendar Function System)
anchor(Styles)
sect(Styles)
The zsh style mechanism using the tt(zstyle) command is describe in
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)). This is the same mechanism
sectref(The zsh/zutil Module)(zshmodules). This is the same mechanism
used in the completion system.
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
if the number is a single digit as described for the
tt(%D{)var(string)tt(}) prompt format in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
sectref(Simple Prompt Escapes)(zshmisc).
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
@@ -766,6 +761,7 @@ enditem()
texinode(Calendar Utility Functions)(Calendar Bugs)(Calendar Styles)(Calendar Function System)
anchor(Utility functions)
sect(Utility functions)
startitem()
@@ -805,9 +801,8 @@ findex(calendar_scandate)
item(tt(calendar_scandate))(
This is a generic function to parse dates and times that may be
used separately from the calendar system. The argument is a date
or time specification as described in
ifzman(the section FILE AND DATE FORMATS above)\
ifnzman(noderef(Calendar File and Date Formats)). The parameter tt(REPLY)
or time specification as described in sectref(File and Date Formats)(above).
The parameter tt(REPLY)
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
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.
The form with tt(-M) as the first and only option defines global
matching specifications (see
ifzman(zshcompwid)\
ifnzman(noderef(Completion Matching Control))\
). The match specifications given will be used for every completion
matching specifications (see sectref(Completion Matching Control)(zshcompwid)).
The match specifications given will be used for every 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
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.
)
item(tt(-o))(
Names of shell options (see
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Options))\
).
Names of shell options (see nmref(Options)(zshoptions)).
)
item(tt(-v))(
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))(
The var(subststring) is split into words and these words are than
expanded using all shell expansion mechanisms (see
ifzman(zmanref(zshexpn))\
ifnzman(noderef(Expansion))\
). The resulting words are taken as possible
nmref(Expansion)(zshexpn)).
The resulting words are taken as possible
completions. The tt(fignore) special parameter is not applied to the
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
only when testing words for the list of flags this flag appears in. The format
of the var(match-spec) string is described in
ifzman(zshcompwid)\
ifnzman(noderef(Completion Matching Control))\
.
sectref(Completion Matching Control)(zshcompwid).
)
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.
For this reason, a user can perform a great many tasks without
knowing any details beyond how to initialize the system, which is
described
ifzman(below in INITIALIZATION)\
ifnzman(in noderef(Initialization)).
described sectref(Initialization)(below).
The context that decides what completion is to be performed may be
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
what order), or which tags are examined. Styles may accept arguments
and are manipulated using the tt(zstyle) command described in
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)).
sectref(The zsh/zutil Module)(zshmodules).
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
@@ -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
description of context handling, which determines how tags and other
elements of the context influence the behaviour of styles, is described
ifzman(below in COMPLETION SYSTEM CONFIGURATION)\
ifnzman(in noderef(Completion System Configuration)).
sectref(Completion System Configuration)(below).
When a completion is requested, a dispatcher function is called;
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
written for bash.
subsect(Autoloaded files)
subsect(Autoloaded Files)
cindex(completion system, autoloaded functions)
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(menu-complete), tt(menu-expand-or-complete), or
tt(reverse-menu-complete). If the tt(zsh/complist) module is loaded (see
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/complist Module))\
) the widget tt(menu-select) is also available.
sectref(The zsh/complist Module)(zshmodules))
the widget tt(menu-select) is also available.
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
@@ -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)
are defined. Styles determine such things as how the matches are
generated, similarly to shell options but with much more control. They
are defined with the tt(zstyle) builtin command (\
ifzman(see zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module))).
are defined with the tt(zstyle) builtin command
(see sectref(The zsh/zutil Module)(zshmodules)).
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
@@ -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;
`tt(complete)' is the simplest, but other completers exist to perform
related tasks such as correction, or to modify the behaviour of a later
completer. See
ifzman(the section `Control Functions' below)\
ifnzman(noderef(Control Functions))
for more information.
completer. See sectref(Control Functions)(below) for more information.
)
itemiz(\
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
available for completion at a particular point. This provides an easy
way of finding information for tt(tag-order) and other styles. It is
described in
ifzman(the section `Bindable Commands' below)\
ifnzman(noderef(Bindable Commands)).
described in sectref(Bindable Commands)(below).
When looking up styles the completion system uses full context names,
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
appear as the argument to a style; this requires some understanding of
the internals of completion functions (see
ifzman(see zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets)))\
). For example,
nmref(Completion Widgets)(zshcompwid)). For example,
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
preferred over patterns (for example, `tt(:completion::complete:::foo)' is
more specific than `tt(:completion::complete:::*')), and longer patterns are
preferred over the pattern `tt(*)'. See
ifzman(zmanref(zmodules))ifnzman(noderef(The zsh/zutil Module))
for details.
preferred over the pattern `tt(*)'. See
sectref(The zsh/zutil Module)(zshmodules) for details.
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
@@ -1103,6 +1089,7 @@ for shell options
)
enditem()
anchor(Standard Styles)
subsect(Standard Styles)
cindex(completion system, styles)
@@ -1309,10 +1296,7 @@ kindex(completer, completion style)
item(tt(completer))(
The strings given as the value of this style provide the names of the
completer functions to use. The available completer functions are
described in
ifzman(the section `Control Functions' below)\
ifnzman(noderef(Control Functions))\
.
described in sectref(Control Functions)(below).
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
@@ -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
what these matches are. This string may also contain the output
attribute sequences understood by tt(compadd -X)
(see
ifzman(zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets))\
).
(see sectref(Completion Builtin Commands)(zshcompwid)).
The style is tested with each tag valid for the current completion
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)'
and similar escape sequences. This is handled by the tt(zformat)
builtin command from the tt(zsh/zutil) module, see
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module))\
.
sectref(The zsh/zutil Module)(zshmodules).
)
kindex(gain-privileges, completion style)
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
color specifications. This mechanism replaces the use of the
tt(ZLS_COLORS) and tt(ZLS_COLOURS) parameters described in
ifzman(the section `The zsh/complist Module' in zmanref(zshmodules))\
ifnzman(noderef(The zsh/complist Module))\
, but the syntax is the same.
sectref(The zsh/complist Module)(zshmodules), but the syntax is the same.
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
@@ -2006,9 +1983,8 @@ kindex(list-prompt, completion style)
item(tt(list-prompt))(
If this style is set for the tt(default) tag,
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))\
ifnzman(noderef(The zsh/complist Module))\
). The value, if not the empty string, will be displayed after every
sectref(The zsh/complist Module)(zshmodules)).
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
set to the empty string,
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
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
ifzman(the section `Completion Matching Control' in zmanref(zshcompwid))\
ifnzman(noderef(Completion Matching Control))\
. For examples of this, see the description of the tt(tag-order) style.
sectref(Completion Matching Control)(zshcompwid).
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
under the description of the tt(tag-order) style.
@@ -2103,9 +2078,7 @@ kindex(matcher-list, completion style)
item(tt(matcher-list))(
This style can be set to a list of match specifications that are to
be applied everywhere. Match specifications are described in
ifzman(the section `Completion Matching Control' in zmanref(zshcompwid))\
ifnzman(noderef(Completion Matching Control))\
.
sectref(Completion Matching Control)(zshcompwid)).
The completion system will try them one after another for each completer
selected. For example, to try first simple completion and, if that
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.
The word `tt(interactive)' in the value causes interactive mode
to be entered immediately when menu selection is started; see
ifzman(the description of the tt(zsh/complist) module in zmanref(zshmodules))\
ifnzman(noderef(The zsh/complist Module))
sectref(The zsh/complist Module)(zshmodules)
for a description of interactive mode. Including the string
`tt(search)' does the same for incremental search mode. To select 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
typed so far is not empty. This is tested using the tt(PREFIX)
special parameter; see
ifzman(zshcompwid)\
ifnzman(noderef(Completion Widgets))
special parameter; see sectref(Completion Special Parameters)(zshcompwid)
for a description of parameters which are special inside completion widgets.
Setting tt(reply) to an empty array provides the default
behaviour of trying all tags at once; setting it to an
@@ -2994,14 +2964,8 @@ findex(_approximate)
item(tt(_approximate))(
This is similar to the basic tt(_complete) completer but allows the
completions to undergo corrections. The maximum number of errors can be
specified by the tt(max-errors) style; see the description of
approximate matching in
ifzman(\
zmanref(zshexpn)
)\
ifnzman(\
noderef(Filename Generation)
)\
specified by the tt(max-errors) style; see
sectref(Approximate Matching)(zshexpn)
for how errors are counted. Normally this completer will only be tried
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).
This function is also a bindable command, see
ifzman(the section `Bindable Commands' below)\
ifnzman(noderef(Bindable Commands)).
sectref(Bindable Commands)(below).
)
findex(_extensions)
item(tt(_extensions))(
@@ -3212,11 +3175,9 @@ item(tt(_history))(
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
tt(_history_complete_word) bindable command, see
ifzman(the section `Bindable Commands' below)\
ifnzman(noderef(Bindable Commands))
sectref(Bindable Commands)(below)
and
ifzman(the section `Completion System Configuration' above)\
ifnzman(noderef(Completion System Configuration)).
sectref(Completion System Configuration)(above).
)
findex(_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
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
ifzman(the section `Completion System Configuration' above)\
ifnzman(noderef(Completion System Configuration)).
sectref(Completion System Configuration)(above).
)
findex(_match)
item(tt(_match))(
@@ -3278,9 +3238,7 @@ list of completions thus generated, instead of producing a new list of
ordinary contextual completions.
It should appear in the list of completers before any of
the widgets which generate matches. It uses two styles: tt(old-list) and
tt(old-menu), see
ifzman(the section `Completion System Configuration' above)\
ifnzman(noderef(Completion System Configuration)).
tt(old-menu), see sectref(Completion System Configuration)(above).
)
findex(_precommand)
item(tt(_precommand))(
@@ -5472,12 +5430,10 @@ the same meaning as for tt(_description).
findex(_widgets)
item(tt(_widgets) [ tt(-g) var(pattern) ])(
This function completes names of zle widgets (see
ifzman(the section `Widgets' in zmanref(zshzle))\
ifnzman(noderef(Zle Widgets))\
). The var(pattern), if present, is matched against values of the tt($widgets)
sectref(Zle Widgets)(zshzle)).
The var(pattern), if present, is matched against values of the tt($widgets)
special parameter, documented in
ifzman(the section `The zsh/zleparameter Module' in zmanref(zshmodules))\
ifnzman(noderef(The zsh/zleparameter Module)).
sectref(The zsh/zleparameter Module)(zshmodules).
)
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,
writing their own DASH()- see dictionary entry for `hubris') should skip
the current section. The older system based on the tt(compctl) builtin
command is described in
ifzman(zmanref(zshcompctl))\
ifnzman(noderef(Completion Using compctl)).
command is described in nmref(Completion Using compctl)(zshcompctl).
Completion widgets are defined by the tt(-C) option to the tt(zle)
builtin command provided by the tt(zsh/zle) module (see
ifzman(zmanref(zshzle))\
ifnzman(noderef(The zsh/zle Module))\
). For example,
sectref(Zle Builtins)(zshzle)). For example,
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
using the tt(bindkey) builtin command defined in the tt(zsh/zle) module
(\
ifzman(see zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
), typing that key will call the shell function `tt(completer)'. This
(see sectref(Zle Builtins)(zshzle)),
typing that key will call the shell function `tt(completer)'. This
function is responsible for generating completion matches using the
builtins described below. As with other ZLE widgets, the function is
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)
are used by the completion mechanism, but are not special. See
ifzman(em(Parameters Used By The Shell) in zmanref(zshparam))\
ifnzman(noderef(Parameters Used By The Shell)).
sectref(Parameters Used by the Shell)(zshparam).
Inside completion widgets, and any functions called from them, some
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.
Within the var(explanation), the following sequences may be used to
specify output attributes
ifnzman((see noderef(Prompt Expansion)))\
ifzman(as described in the section EXPANSION OF PROMPT SEQUENCES in
zmanref(zshmisc)):
specify output attributes as described in
sectref(Expansion of Prompt Sequences)(zshmisc):
`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)',
`tt(%K)', `tt(%H)' and
@@ -607,11 +598,7 @@ argument to `tt(%{)' should be used instead.) The sequence `tt(%%)'
produces a literal `tt(%)'.
These sequences are most often employed by users when customising the
tt(format) style
(see
ifzman(zmanref(zshcompsys))\
ifnzman(noderef(Completion System))\
),
tt(format) style (see subref(Standard Styles)(zshcompsys)),
but they must also be taken into account when writing completion
functions, as passing descriptions with unescaped `tt(%)' characters
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
passed the length of the suffix as an argument and can use the special
parameters available in ordinary (non-completion) zle widgets (see
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
sectref(User-Defined Widgets)(zshzle)
) to analyse and modify the command line.
)
item(tt(-f))(
@@ -921,10 +907,8 @@ enditemize()
This narrow pattern can be broadened selectively by passing a em(match
specification) to the tt(compadd) builtin command through its tt(-M) option
(see
ifzman(`Completion Builtin Commands' above)\
ifnzman(noderef(Completion Builtin Commands))\
). A match specification consists of one or more var(matchers) separated by
(see sectref(Completion Builtin Commands)(above)).
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
left to right. Once all matchers have been applied, completions are compared
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
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
a non-empty value (see
ifzman(`Completion Special Parameters' above)\
ifnzman(noderef(Completion Special Parameters))\
).\
a non-empty value (see sectref(Completion Special Parameters)(above)).
)
itemiz(\
Users of the \
ifzman(completion system (see zmanref(zshcompsys))) \
ifnzman(noderef(Completion System)) \
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)
in
ifzman(\
the documentation for COMPLETION SYSTEM CONFIGURATION in zmanref(zshcompsys))\
ifnzman(noderef(Completion System Configuration))\
).\
tt(matcher-list) and tt(matcher) styles (see
subref(Standard Styles)(zshcompsys)).
)
enditemize()
@@ -977,11 +954,8 @@ startitemize()
itemiz(literal characters (which may be quoted with a `tt(\)'),)
itemiz(question marks (`tt(?)'),)
itemiz(\
bracket expressions (`tt([...])'; see the subsection em(Glob Operators) in
ifnzman(noderef(Filename Generation))\
ifzman(the documentation for GLOB OPERATORS in zmanref(zshexpn))\
), and/or\
)
bracket expressions (`tt([...])'; see subref(Glob Operators)(zshexpn)),
and/or)
itemiz(brace expressions (see below).)
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))(
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.
(See noderef(Specifying Options).)
(See sectref(Specifying Options)(zshoptions).)
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
@@ -162,8 +162,7 @@ item(var(exp1) tt(-eq) var(exp2))(
true if var(exp1) is numerically equal to var(exp2).
Note that for purely numeric comparisons use of the
tt(LPAR()LPAR())var(...)tt(RPAR()RPAR()) builtin described in
ifzman(the section `ARITHMETIC EVALUATION')\
ifnzman(noderef(Arithmetic Evaluation)) is more convenient than
sectref(Arithmetic Evaluation)(above) is more convenient than
conditional expressions.
)
item(var(exp1) tt(-ne) var(exp2))(
@@ -234,13 +233,7 @@ no matching file.
Pattern metacharacters are active for the var(pattern) arguments;
the patterns are the same as those used for filename generation, see
ifzman(\
zmanref(zshexpn)\
)\
ifnzman(\
noderef(Filename Generation)\
)\
, but there is no special behaviour
sectref(Filename Generation)(zshexpn), but there is no special behaviour
of `tt(/)' nor initial dot, and the patterns `tt(**/)' and `tt(***/)' behave
the same as `tt(*/)', in which the `tt(*)' has its standard behaviour
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)
sect(Utilities)
anchor(Accessing On-Line Help)
subsect(Accessing On-Line Help)
cindex(helpfiles utility)
The key sequence tt(ESC h) is normally bound by ZLE to execute the
tt(run-help) widget (see
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
). This invokes the tt(run-help) command with the command word from the
tt(run-help) widget (see nmref(Zsh Line Editor)(zshzle)).
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
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)
@@ -74,12 +73,12 @@ autoload 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
ifzman(zmanref(zshparam))\
ifnzman(noderef(Parameters Used By The Shell))\
). This should already be the case if you have a standard zsh
sectref(Parameters Used by the Shell)(zshparam)).
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
appropriate directory.
anchor(Recompiling Functions)
subsect(Recompiling Functions)
cindex(functions, recompiling)
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
arguments.
anchor(Keyboard Definition)
subsect(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
be in one of the directories named in your tt(fpath) array (see
ifzman(zmanref(zshparam))\
ifnzman(noderef(Parameters Used By The Shell))\
). This should already be the case if you have a standard zsh
sectref(Parameters Used by the Shell)(zshparam)).
This should already be the case if you have a standard zsh
installation; if it is not, copy tt(Functions/Misc/zkbd) to an
appropriate directory.
@@ -217,10 +216,8 @@ cindex(reporter utility)
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
release. Usually it is sufficient to send a description of the
problem to one of the zsh mailing lists (see
ifzman(zmanref(zsh))\
ifnzman(noderef(Mailing Lists))\
), but sometimes one of the zsh developers will need to recreate your
problem to one of the zsh mailing lists (see sectref(Mailing Lists)(zsh)),
but sometimes one of the zsh developers will need to recreate your
environment in order to track the problem down.
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)
dump the tt(functions) state to your startup files with tt(reporter); use
the tt(compdump) function instead (see
ifzman(zmanref(zshcompsys))\
ifnzman(noderef(Completion System))\
).
nmref(Completion System)(zshcompsys)).
startitem()
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.
enditem()
anchor(Manipulating Hook Functions)
subsect(Manipulating Hook Functions)
cindex(hook function utility)
startitem()
findex(add-zsh-hook)
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
ifnzman(Special Functions, noderef(Functions))\
ifzman(SPECIAL FUNCTIONS, see zmanref(zshmisc)),
Several functions are special to the shell, as described in
sectref(Special Functions)(zshmisc),
in that they are automatically called at specific points during shell execution.
Each has an associated array consisting of names of functions to be
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)
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
ifnzman(Special Widgets, noderef(Zle Widgets))\
ifzman(Special Widgets, see zmanref(zshzle)),
Several widget names are special to the line editor, as described in
subref(Special Widgets)(zshzle),
in that they are automatically called at specific points during editing.
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)
@@ -486,8 +480,7 @@ subsect(Configuration)
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
ifzman(see zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)). The context for setting styles
sectref(The zsh/zutil Module)(zshmodules). The context for setting styles
should be tt(':chpwd:*') in case the meaning of the context is extended in
future, for example:
@@ -617,7 +610,7 @@ this.
)
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
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(...)
also works.
subsect(Details of directory handling)
subsect(Details of Directory Handling)
This section is for the curious or confused; most users will not
need to know this information.
@@ -658,10 +651,8 @@ cindex(named directories, dynamic, helper function)
findex(zsh_directory_name_generic)
sect(Abbreviated dynamic references to directories)
The dynamic directory naming system is described in the subsection
em(Dynamic named directories) of
ifzman(the section em(Filename Expansion) in zmanref(zshexpn))\
ifnzman(noderef(Filename Expansion)). In this, a reference to
The dynamic directory naming system is described in
subref(Dynamic Named Directories)(zshexpn). In this, a reference to
tt(~[)var(...)tt(]) is expanded by a function found by the hooks
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
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
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.
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()
@@ -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)
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
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
@@ -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
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))),
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
@@ -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.
This hook is, in concert with tt(set-patch-format), responsible for
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)\
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.
This hook is, in concert with tt(set-patch-format), responsible for
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)\
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
tt(gen-unapplied-string) hooks if they are defined, responsible for
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)\
The tt(quilt) backend passes to this hook the inputs
@@ -1813,7 +1808,7 @@ tt(vcs_info).
enditem()
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.
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
hash to its 12 leading characters. The form is actually
`tt(%)var(min)tt(.)var(max)tt(x)'. More is possible.
See ifzman(the section `The zsh/zutil Module' in zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)) for details.
See sectref(The zsh/zutil Module)(zshmodules) for details.
Use the quicker tt(bzr) backend
example(zstyle ':vcs_info:bzr:*' use-simple true)
@@ -1854,7 +1848,7 @@ example(zstyle ':vcs_info:(svn|bzr):*' \
branchformat '%b%%F{yellow}:%r')
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:
@@ -2058,7 +2052,7 @@ beyond the scope of tt(localoptions), should your function need that.
)
item(Modify hooks)(
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)
are automatically removed when the prompt theme changes or is disabled.
)
@@ -2091,9 +2085,8 @@ sect(ZLE Functions)
subsect(Widgets)
These functions all implement user-defined ZLE widgets (see
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
) which can be bound to keystrokes in interactive shells. To use them,
sectref(User-Defined Widgets)(zshzle))
which can be bound to keystrokes in interactive shells. To use them,
your tt(.zshrc) should contain lines of the form
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),
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
comparison, the widgets described in ifzman(zmanref(zshzle) under Text Objects)\
ifnzman(noderef(Text Objects)) use fixed definitions of words, compatible
comparison, the widgets described in subref(Text Objects)(zshzle)
use fixed definitions of words, compatible
with the tt(vim) editor.
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).
More control can be obtained using the tt(zstyle) command, as described in
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)). Each style is looked up in the
sectref(The zsh/zutil Module)(zshmodules). Each style is looked up in 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
the case of the definitions supplied by tt(select-word-style) the
@@ -2356,8 +2348,7 @@ directly.
)
tindex(bracketed-paste-magic)
item(tt(bracketed-paste-magic))(
The tt(bracketed-paste) widget (see ifzman(the subsection `Miscellaneous' in
zmanref(zshzle))ifnzman(noderef(Miscellaneous) in noderef(Standard Widgets)))
The tt(bracketed-paste) widget (see subref(Miscellaneous)(zshzle))
inserts pasted text literally into the editor buffer rather than interpret
it as keystrokes. This disables some common usages where the self-insert
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-forward-end). These commands work by first
calling the corresponding builtin widget (see
ifzman(`History Control' in zmanref(zshzle))\
ifnzman(noderef(History Control))\
) and then moving the cursor to the end of the line. The original cursor
sectref(History Control)(zshzle))
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
second time, so that the same search is repeated to look farther through
the history.
@@ -3253,8 +3243,7 @@ investigate the command word found. The default is tt(whence -c).
tindex(zcalc-auto-insert)
item(tt(zcalc-auto-insert))(
This function is useful together with the tt(zcalc) function described in
ifzman(the section `Mathematical Functions')\
ifnzman(noderef(Mathematical Functions)).
sectref(Mathematical Functions)(above).
It should be bound to a key representing a binary operator such
as `tt(PLUS())', `tt(-)', `tt(*)' or `tt(/)'. When running in zcalc,
if the key occurs at the start of the line or immediately following
@@ -3554,9 +3543,8 @@ findex(catch)
enditem()
The functions are designed to be used together with the tt(always) construct
described in
ifzman(zmanref(zshmisc))\
ifnzman(noderef(Complex Commands)). This is important as only this
described in sectref(Complex Commands)(zshmisc).
This is important as only this
construct provides the required support for exceptions. A typical example
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 functions use the following styles, which are defined with the
tt(zstyle) builtin command (\
ifzman(see zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module))). They should be defined
tt(zstyle) builtin command (sectref(The zsh/zutil Module)(zshmodules)).
They should be defined
before tt(zsh-mime-setup) is run. The contexts used all
start with tt(:mime:), with additional components in some cases.
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
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
the tt(:P) modifier described in
ifzman(the subsection `Modifiers' in zmanref(zshexpn))\
ifnzman(noderef(Modifiers));
the tt(:P) modifier described in subref(Modifiers)(zshexpn);
this means that symbolic links are resolved where possible, so that
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
facility. The syntax is similar to that of formulae in most programming
languages; see
ifzman(the section `Arithmetic Evaluation' in zmanref(zshmisc))\
ifnzman(noderef(Arithmetic Evaluation)) for details.
sectref(Arithmetic Evaluation)(zshmisc) for details.
Non-programmers should note that, as in many other programming
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
available; see
ifzman(the section `The zsh/mathfunc Module' in zmanref(zshmodules))\
ifnzman(noderef(The zsh/mathfunc Module)). The mathematical functions
sectref(The zsh/mathfunc Module)(zshmodules). The mathematical functions
correspond to the raw system libraries, so trigonometric functions are
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).
Not to be confused with the tt(zsh/mathfunc) module, described in
ifzman(the section `The zsh/mathfunc Module' in zmanref(zshmodules))\
ifnzman(noderef(The zsh/mathfunc Module)).
sectref(The zsh/mathfunc Module)(zshmodules).
)
findex(zmathfuncdef)
item(tt(zmathfuncdef) [ var(mathfunc) [ var(body) ] ])(
@@ -4306,8 +4288,8 @@ findex(colors)
item(tt(colors))(
This function initializes several associative arrays to map color names to
(and from) the ANSI standard eight-color terminal codes. These are used
by the prompt theme system (ifzman(see above)\
ifnzman(noderef(Prompt Themes))). You seldom should need to run
by the prompt theme system (see sectref(Prompt Themes)(above)).
You seldom should need to run
tt(colors) more than once.
The eight base colors are: tt(black), tt(red), tt(green), tt(yellow),
@@ -4412,10 +4394,8 @@ invokes that original.
findex(nslookup)
item(tt(nslookup) [ var(arg) ... ])(
This wrapper function for the tt(nslookup) command requires the
tt(zsh/zpty) module (see
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zpty Module))\
). It behaves exactly like the standard tt(nslookup)
tt(zsh/zpty) module (see sectref(The zsh/zpty Module)(zshmodules)).
It behaves exactly like the standard tt(nslookup)
except that it provides customizable prompts (including a right-side
prompt) and completion of nslookup commands, host names, etc. (if you use
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)
item(tt(run-help) var(cmd))(
This function is designed to be invoked by the tt(run-help) ZLE widget,
in place of the default alias. See `Accessing On-Line Help'
ifzman(above)\
ifnzman((noderef(Utilities))) for setup instructions.
in place of the default alias. See subref(Accessing On-Line Help)(above)
for setup instructions.
In the discussion which follows, if var(cmd) is a file system path, it is
first reduced to its rightmost component (the file name).
@@ -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).
)
item(tt(zkbd))(
See `Keyboard Definition'
ifzman(above)\
ifnzman((noderef(Utilities))).
See subref(Keyboard Definition)(above).
)
findex(zmv)
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.
)
item(tt(zrecompile))(
See `Recompiling Functions'
ifzman(above)\
ifnzman((noderef(Utilities))).
See subref(Recompiling Functions)(above).
)
findex(zstyle+)
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
`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
(see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion))\
).
(see sectref(Expansion of Prompt Sequences)(zshmisc)).
)
enditem()

2
Doc/Zsh/exec.yo
View File

@@ -9,7 +9,7 @@ cindex(command not found, handling of)
findex(command_not_found_handler)
If a command name contains no slashes, the shell attempts to locate
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.
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))(
Aliases are expanded immediately before the command line is parsed as
explained
ifzman(under Aliasing in zmanref(zshmisc))\
ifnzman(in noderef(Aliasing))\
.
explained in sectref(Aliasing)(zshmisc).
)
xitem(em(Process Substitution))
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,
beginning with 1 (one) when the shell starts up. The history number that
you may see in your prompt (see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion))\
) is the number that is to be assigned to the em(next) command.
tt(%h) or tt(%!) prompt escape described in
sectref(Simple Prompt Escapes)(zshmisc))
is the number that is to be assigned to the em(next) command.
startmenu()
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).
The first character is followed by an optional event designator
(ifzman(see )noderef(Event Designators)) and then an optional word
designator (noderef(Word Designators)); if neither of these designators is
(see subref(Event Designators)(below))
and then an optional word designator (subref(Word Designators)(below));
if neither of these designators is
present, no history expansion occurs.
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).
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
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
substitution.
If the shell encounters the character sequence `tt(!")'
in the input, the history mechanism is temporarily disabled until
the current list (see
ifzman(zmanref(zshmisc))\
ifnzman(noderef(Shell Grammar))\
) is fully parsed. The `tt(!")' is removed from the input, and any
the current list (see nmref(Shell Grammar)(zshmisc))
is fully parsed. The `tt(!")' is removed from the input, and any
subsequent `tt(!)' characters have no special significance.
findex(fc, use of)
@@ -150,8 +146,8 @@ startitem()
item(tt(!))(
Start a history expansion, except when followed by a blank, newline,
`tt(=)' or `tt(LPAR())'. If followed immediately by a word designator
(ifzman(see )noderef(Word Designators)), this forms a history reference
with no event designator (ifzman(see )noderef(Overview)).
(ifzman(see )subref(Word Designators)(below)), this forms a history reference
with no event designator (ifzman(see )subref(Overview)(above)).
)
item(tt(!!))(
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
was started with a capital tt(S), var(l) is treated as
a pattern of the usual form described in
ifzman(the section FILENAME GENERATION below)\
ifnzman(noderef(Filename Generation)). This can be used in
a pattern of the usual form described in sectref(Filename Generation)(below).
This can be used in
all the places where modifiers are available; note, however, that
in globbing qualifiers parameter substitution has already taken place,
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
for var(process) to finish and hence an immediately following command
cannot rely on the results being complete. The problem and solution are
the same as described in the section em(MULTIOS) in
ifzman(zmanref(zshmisc))\
ifnzman(noderef(Redirection)). Hence in a simplified
the same as described in the section sectref(Multios)(zshmisc).
Hence in a simplified
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()))
@@ -577,13 +571,7 @@ sect(Parameter Expansion)
cindex(parameter expansion)
cindex(expansion, parameter)
The character `tt($)' is used to introduce parameter expansions.
See
ifzman(\
zmanref(zshparam)
)\
ifnzman(\
noderef(Parameters)
)\
See nmref(Parameters)(zshparam)
for a description of parameters, including arrays, associative arrays,
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
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
parameter expansion, command substitution, and arithmetic expansion.
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
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.
Each var(name) or nested tt(${)...tt(}) in a parameter expansion may
also be followed by a subscript expression as described in
ifzman(em(Array Parameters) in zmanref(zshparam))\
ifnzman(noderef(Array Parameters)).
sectref(Array Parameters)(zshparam).
Note that double quotes may appear around nested expressions, in which
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
before.
anchor(Parameter Expansion Flags)
subsect(Parameter Expansion Flags)
cindex(parameter expansion flags)
cindex(flags, parameter expansion)
@@ -1002,8 +991,7 @@ If the tt(MULTIBYTE) option is set and the number is greater than 127
item(tt(%))(
Expand all tt(%) escapes in the resulting words in the same way as in
prompts (see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion))). If this flag is given twice,
sectref(Expansion of Prompt Sequences)(zshmisc)). If this flag is given twice,
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)
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)
is then quoted so that the whole string can be used as a shell
argument. This is the reverse of `tt(~)' substitution: see
ifnzman(noderef(Filename Expansion))\
ifzman(the section FILENAME EXPANSION below).
sectref(Filename Expansion)(below).
)
item(tt(e))(
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
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
ifzman(Named References in zmanref(zshparam))\
ifnzman(noderef(Named References) under noderef(Parameters))
sectref(Named References)(zshparam)ifnzman( under noderef(Parameters))
for more about placeholders.
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)
exists, in which case the expansion is empty.
See also ifzman(zmanref(zshparam))ifnzman(noderef(Parameters)).
See also nmref(Parameters)(zshparam).
subsect(Rules)
cindex(parameter expansion rules)
@@ -1759,7 +1745,7 @@ returns a scalar because of the quotes).
item(tt(7.) em(Modifiers))(
Any modifiers, as specified by a trailing `tt(#)', `tt(%)', `tt(/)'
(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.
)
item(tt(8.) em(Character evaluation))(
@@ -2050,9 +2036,7 @@ has similar effects.
To combine brace expansion with array expansion, see the
tt(${^)var(spec)tt(}) form described
ifzman(in the section `Parameter Expansion')\
ifnzman(in noderef(Parameter Expansion))
above.
in sectref(Parameter Expansion)() above.
texinode(Filename Expansion)(Filename Generation)(Brace Expansion)(Expansion)
sect(Filename Expansion)
@@ -2086,14 +2070,14 @@ option exchanges the effects of `tt(~PLUS())' and `tt(~-)' where they are
followed by a number.
startmenu()
menu(Dynamic named directories)
menu(Static named directories)
menu(`=' expansion)
menu(Dynamic Named Directories)
menu(Static Named Directories)
menu(`=' Expansion)
menu(Notes)
endmenu()
texinode(Dynamic named directories)(Static named directories)()(Filename Expansion)
subsect(Dynamic named directories)
texinode(Dynamic Named Directories)(Static Named Directories)()(Filename Expansion)
subsect(Dynamic Named Directories)
cindex(directories, named, dynamic)
cindex(named directories, dynamic)
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
complete dynamic names for directories. The code for this should be
as for any other completion function as described in
ifnzman(noderef(Completion System))\
ifzman(zmanref(zshcompsys)).
nmref(Completion System)(zsycompsys).
As a working example, here is a function that expands any dynamic names
beginning with the string tt(p:) to directories below
@@ -2176,8 +2159,8 @@ example(zsh_directory_name+LPAR()RPAR() {
esac
})
texinode(Static named directories)(`=' expansion)(Dynamic named directories)(Filename Expansion)
subsect(Static named directories)
texinode(Static Named Directories)(`=' Expansion)(Dynamic Named Directories)(Filename Expansion)
subsect(Static Named Directories)
cindex(directories, named, static)
cindex(named directories, static)
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.
The parameters tt($PWD) and tt($OLDPWD) are never abbreviated in this fashion.
texinode(`=' expansion)(Notes)(Static named directories)(Filename Expansion)
subsect(`=' expansion)
texinode(`=' Expansion)(Notes)(Static Named Directories)(Filename Expansion)
subsect(`=' Expansion)
If a word begins with an unquoted `tt(=)'
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
by the full pathname of the command.
texinode(Notes)()(`=' expansion)(Filename Expansion)
texinode(Notes)()(`=' Expansion)(Filename Expansion)
subsect(Notes)
cindex(filename expansion, notes)
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
matches the files `tt(.)' or `tt(..)'. In other instances of pattern
matching, the `tt(/)' and `tt(.)' are not treated specially.
anchor(Glob Operators)
subsect(Glob Operators)
cindex(glob operators)
startitem()
@@ -2341,9 +2325,7 @@ tt(IFS) parameter
item(tt([:IFSSPACE:]))(
The character is an IFS white space character; see the documentation
for tt(IFS) in
ifzman(the zmanref(zshparam) manual page)\
ifnzman(noderef(Parameters Used By The Shell))\
.
sectref(Parameters Used by the Shell)(zshparam).
)
item(tt([:INCOMPLETE:]))(
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
not special after a `tt(~)' appearing outside parentheses in a filename
pattern.
anchor(Globbing Flags)
subsect(Globbing Flags)
cindex(globbing 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
tt(LPAR()#i)tt(RPAR()/foo/bar/...) is potentially slow.
anchor(Approximate Matching)
subsect(Approximate Matching)
cindex(approximate matching)
cindex(matching, approximate)
@@ -3184,8 +3168,8 @@ which they are given. These are the qualifiers `tt(M)', `tt(T)',
in brackets (`tt([)var(...)tt(])').
If a `tt(:)' appears in a qualifier list, the remainder of the expression in
parenthesis is interpreted as a modifier (see noderef(Modifiers)
in noderef(History Expansion)). Each modifier must be introduced by a
parenthesis is interpreted as a modifier (see subref(Modifiers)()
in sectref(History Expansion)(above)). Each modifier must be introduced by a
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
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)
chapter(Files)
anchor(Startup/Shutdown Files)
sect(Startup/Shutdown Files)
cindex(files, startup)
cindex(startup files)
@@ -58,13 +59,7 @@ be executed when zsh is invoked with the `tt(-f)' option.
ifnzman(includefile(Zsh/filelist.yo))
Any of these files may be pre-compiled with the tt(zcompile) builtin
command (\
ifzman(\
see zmanref(zshbuiltins)\
)\
ifnzman(\
noderef(Shell Builtin Commands)\
)\
). If a compiled file exists (named for the original file plus the
command (see nmref(Shell Builtin Commands)(zshbuiltins)).
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
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
place of any other parameter having the same name that was assigned or
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
`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.
findex(unfunction, use of)
Functions can be undefined with the tt(unfunction) builtin.
anchor(Autoloading Functions)
sect(Autoloading Functions)
cindex(autoloading functions)
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
function definitions where the definition is silently discarded.
anchor(Special Functions)
sect(Special Functions)
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
before each command; otherwise executed after each command. See
the description of the tt(trap) builtin in
ifnzman(noderef(Shell Builtin Commands))\
ifzman(zmanref(zshbuiltins)) for details of additional features provided
nmref(Shell Builtin Commands)(zshbuiltins)
for details of additional features provided
in debug traps.
)
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
assignments followed by blank-separated words,
with optional redirections interspersed. For a description
of assignment, see the beginning of
ifnzman(noderef(Parameters))\
ifzman(zmanref(zshparam)).
of assignment, see the beginning of nmref(Parameters)(zshparam).
The first word is the command to be executed, and the remaining
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))(
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
when non-zero, var(list) is executed and the arithmetic expression
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)
that matches var(word), if any. The form of the patterns
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
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
are usually only useful for setting traps.
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:
@@ -381,8 +379,7 @@ startitem()
item(-T)(
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
ifzman(zmanref(zshbuiltins))\
ifnzman(noderef(Shell Builtin Commands)).
sectref(Shell Builtin Commands)(zshbuiltins).
)
enditem()
@@ -414,7 +411,7 @@ findex([[)
item(tt([[) var(exp) tt(]]))(
Evaluates the conditional expression var(exp)
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).
)
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
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
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
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
ifnzman(noderef(The zsh/parameter Module))\
ifzman(the section THE ZSH/PARAMETER MODULE in zmanref(zshmodules))).
sectref(The zsh/parameter Module)(zshmodules)).
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
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
does not provide compatibility with POSIX or other shells in its
default operating mode: see
ifnzman(the section noderef(Compatibility))\
ifzman(the section `Compatibility' below).
sectref(Compatibility)(below).
Zsh has command line editing, builtin spelling correction, programmable
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.
For further options, which are common to invocation and the tt(set)
builtin, see
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Options))\
.
builtin, see nmref(Options)(zshoptions).
The long option `tt(-)tt(-emulate)' followed (in a separate word) by an
emulation mode may be passed to the shell.
The emulation modes are those described for the tt(emulate) builtin,
see
ifzman(zmanref(zshbuiltins))\
ifnzman(noderef(Shell Builtin Commands)).
see nmref(Shell Builtin Commands)(zshbuiltins).
The `tt(-)tt(-emulate)' option must precede any other options (which might
otherwise be overridden), but following options are honoured, so
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
use the manref(nohup)(1) command
or the tt(disown) builtin.
anchor(Signals)
sect(Signals)
The tt(INT) and tt(QUIT) signals for an invoked
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
exit without waiting. Examples of such asynchronous jobs are
process substitution, see
ifzman(the section PROCESS SUBSTITUTION in the zmanref(zshexpn) manual page)\
ifnzman(noderef(Process Substitution)), and the handler processes for
multios, see
ifzman(the section MULTIOS in the zmanref(zshmisc) manual page)\
ifnzman(the section em(Multios) in noderef(Redirection)).
sectref(Process Substitution)(zshexpn), and the handler processes for
multios, see sectref(Multios)(zshmisc).

4
Doc/Zsh/manual.yo
View File

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

9
Doc/Zsh/mod_compctl.yo
View File

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

4
Doc/Zsh/mod_complete.yo
View File

@@ -3,6 +3,4 @@ The basic completion code.
!MOD!)
The tt(zsh/complete) module makes available several builtin commands which
can be used in user-defined completion widgets, see
ifzman(zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets))\
.
nmref(Completion Widgets)(zshcompwid).

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
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
and the tt(zsh/complist) module is loaded or linked into the shell,
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)
function from the contribution can be used to get associative arrays
containing the codes for ANSI terminals (see
ifzman(the section `Other Functions' in zmanref(zshcontrib))\
ifnzman(noderef(Other Functions))\
). For example, after loading tt(colors), one could use
sectref(Other Functions)(zshcontrib)).
For example, after loading tt(colors), one could use
`tt($color[red])' to get the code for foreground color red and
`tt($color[bg-green])' for the code for background color green.
If the completion system invoked by compinit is used, these
parameters should not be set directly because the system controls them
itself. Instead, the tt(list-colors) style should be used (see
ifzman(the section `Completion System Configuration' in zmanref(zshcompsys))\
ifnzman(noderef(Completion System Configuration))\
).
sectref(Completion System Configuration)(zshcompsys)).
subsect(Scrolling in completion listings)
subsect(Scrolling in Completion Listings)
To enable scrolling through a completion list, the tt(LISTPROMPT)
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
@@ -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
should be used.
subsect(Menu selection)
subsect(Menu Selection)
cindex(completion, selecting by cursor)
vindex(MENUSELECT)
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
shell is set up to return to the last prompt after showing a
completion list (see the tt(ALWAYS_LAST_PROMPT) option in
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Options))\
).
nmref(Options)(zshoptions)).
Menu selection can be invoked directly by
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
in ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor)).
in nmref(Zsh Line Editor)(zshzle).
Alternatively,
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
(namely the cursor keys, return, and TAB) have sensible defaults. However,
keys in the tt(menuselect) keymap can be modified directly using the
tt(bindkey) builtin command (see
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zle Module))\
). For example, to make the return key leave menu selection without
tt(bindkey) builtin command (see sectref(Zle Builtins)(zshzle)).
For example, to make the return key leave menu selection without
accepting the match currently selected one could call
example(bindkey -M menuselect '^M' send-break)

6
Doc/Zsh/mod_computil.yo
View File

@@ -5,10 +5,8 @@ completion system.
cindex(completion, utility)
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
functions (see
ifzman(zmanref(zshcompsys))\
ifnzman(noderef(Completion System))
). Except for tt(compquote) these builtin commands are very
functions (see nmref(Completion System)(zshcompsys)).
Except for tt(compquote) these builtin commands are very
specialised and thus not very interesting when writing your own
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
additionally be used to specify the number of nanoseconds past the second
(otherwise that number is assumed to be 0).
See manref(strftime)(3) for details. The zsh extensions described in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)) are also available.
See manref(strftime)(3) for details. The zsh extensions described
under tt(%D{)var(string)tt(}) prompt eqcape in
sectref(Simple Prompt Escapes)(zshmisc) are also available.
startitem()
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
but in the tt(zmathfunc) autoloadable function, described in
ifzman(the section `Mathematical Functions' in zmanref(zshcontrib))\
ifnzman(noderef(Mathematical Functions)).
sectref(Mathematical Functions)(zshcontrib).
The following functions take two floating point arguments: tt(copysign),
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
if the module is not installed the function will not be installed either.
The function is documented in
ifnzman(noderef(User Configuration Functions))\
ifzman(the section `User Configuration Functions' in zmanref(zshcontrib)).
sectref(User Configuration Functions)(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
currently defined. The values are strings describing the type of the
parameter, in the same format used by the tt(t) parameter flag, see
ifzman(\
zmanref(zshexpn)
)\
ifnzman(\
noderef(Parameter Expansion)
)\
. The value may also be `tt(undefined)' indicating a parameter that
subref(Parameter Expansion Flags)(zshexpn).
The value may also be `tt(undefined)' indicating a parameter that
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
`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) ] \
[ {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)
(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.
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
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
(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
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
(1970/01/01 00:00); this is useful in combination with the features in
the tt(zsh/datetime) module, see
ifzman(the zsh/datetime module entry in zmanref(zshmodules))\
ifnzman(noderef(The zsh/datetime Module))\
.
sectref(The zsh/datetime Module)(zshmodules).
With no arguments, prints the list of scheduled commands. If 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
tt(KSH_ARRAYS) option is not set). The value of the array
consists of the scheduled time in seconds since the epoch
(see ifnzman(noderef(The zsh/datetime Module))\
ifzman(the section `The zsh/datetime Module') for facilities for
(see sectref(The zsh/datetime Module)(zshmodules) for facilities for
using this number), followed by a colon, followed by any options
(which may be empty but will be preceded by a `tt(-)' otherwise),
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))(
Supplies a tt(strftime) (see manref(strftime)(3)) string for the
formatting of the time elements. The format string supports all of the
zsh extensions described in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
zsh extensions (see the description of tt(%D{)var(string)tt(})
prompt escape in sectref(Simple Prompt Escapes)(zshmisc)).
In particular, tt(-F %s.%N) can be used to show timestamps with nanosecond
precision if supported by the system.
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.
Normally, sockets registered by zftp (see
ifzman(\
zmanref(zshmodules)
)\
ifnzman(\
noderef(The zsh/zftp Module)
)) cannot be closed this way. In order
sectref(The zsh/zftp Module)(zshmodules))
cannot be closed this way. In order
to force such a socket closed, use tt(-f).
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(}))(
The date formatted as var(string) using the tt(strftime) function, with
zsh extensions as described by
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
)
zsh extensions as described for tt(%D{)var(string)tt(}) escape sequence in
sectref(Simple Prompt Escapes)(zshmisc).)
item(tt(%LPAR())var(x)tt(:)var(true-text)tt(:)var(false-text)tt(RPAR()))(
Specifies a ternary expression.
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
access it via shell functions providing a more powerful interface; a set is
provided with the tt(zsh) distribution and is described in
ifzman(zmanref(zshzftpsys))\
ifnzman(noderef(Zftp Function System))\
. However, the tt(zftp) command is entirely usable in its
nmref(Zftp Function System)(zshzftpsys).
However, the tt(zftp) command is entirely usable in its
own right.
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.
!MOD!)
The tt(zsh/zle) module contains the Zsh Line Editor. See
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
.
nmref(Zsh Line Editor)(zshzle).

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)
The tt(zsh/zleparameter) module defines two special parameters that can be
used to access internal information of the Zsh Line Editor (see
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
).
nmref(Zsh Line Editor)(zshzle)).
startitem()
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 master side of the pseudo-terminal. This allows the terminal to be
monitored with ZLE descriptor handlers (see ifzman(zmanref(zshzle))\
ifnzman(noderef(Zle Builtins))) or manipulated with tt(sysread) and
tt(syswrite) (see ifzman(THE ZSH/SYSTEM MODULE in zmanref(zshmodules))\
ifnzman(noderef(The zsh/system Module))). em(Warning): Use of tt(sysread)
monitored with ZLE descriptor handlers (see the description of option
tt(-F) for tt(zle) builtin in sectref(Zle Builtins)(zshzle))
or manipulated with tt(sysread) and tt(syswrite) builtins
(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)
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
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).
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
if the installation supports this feature.
Modules are linked at runtime with the tt(zmodload) command,
see ifzman(zmanref(zshbuiltins))\
ifnzman(noderef(Shell Builtin Commands)).
see nmref(Shell Builtin Commands)(zshbuiltins).
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
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
noderef(Filename Expansion)).
sectref(Filename Expansion)(zshexpn)).
)
pindex(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
to make them more compatible with the POSIX standard. The behaviour with
the option unset is described in the documentation for the tt(cd)
builtin in
ifzman(zmanref(zshbuiltins))\
ifnzman(noderef(Shell Builtin Commands)).
builtin in nmref(Shell Builtin Commands)(zshbuiltins).
If the option is set, the shell does not test for directories beneath
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
@@ -441,7 +439,7 @@ cindex(enable globbing qualifiers)
item(tt(BARE_GLOB_QUAL) <Z>)(
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(~)'
characters. See noderef(Filename Generation).
characters. See sectref(Filename Generation)(zshexpn).
)
pindex(BRACE_CCL)
pindex(NO_BRACE_CCL)
@@ -452,7 +450,7 @@ cindex(expansion, brace, extending)
item(tt(BRACE_CCL))(
Expand expressions in braces which would not otherwise undergo brace
expansion to a lexically ordered list of all the characters. See
noderef(Brace Expansion).
sectref(Brace Expansion)(zshexpn).
)
pindex(CASE_GLOB)
pindex(NO_CASE_GLOB)
@@ -513,7 +511,7 @@ pindex(NOEQUALS)
cindex(filename expansion, =)
item(tt(EQUALS) <Z>)(
Perform tt(=) filename expansion.
(See noderef(Filename Expansion).)
(See sectref(Filename Expansion)(zshexpn).)
)
pindex(EXTENDED_GLOB)
pindex(NO_EXTENDED_GLOB)
@@ -544,7 +542,7 @@ cindex(globbing, enabling)
cindex(enabling globbing)
item(tt(GLOB) (tt(PLUS()F), ksh: tt(PLUS()f)) <D>)(
Perform filename generation (globbing).
(See noderef(Filename Generation).)
(See sectref(Filename Generation)(zshexpn).)
)
pindex(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
with pattern matching instead of string matching. This occurs wherever
history modifiers are valid, including glob qualifiers and parameters.
See
ifzman(the section `Modifiers' in zmanref(zshexpn))\
ifnzman(noderef(Modifiers)).
See subref(Modifiers)(zshexpn).
)
pindex(IGNORE_BRACES)
pindex(NO_IGNORE_BRACES)
@@ -650,7 +646,7 @@ pindex(NOKSHGLOB)
item(tt(KSH_GLOB) <K>)(
In pattern matching, the interpretation of parentheses is affected by
a preceding `tt(@)', `tt(*)', `tt(+)', `tt(?)' or `tt(!)'.
See noderef(Filename Generation).
See sectref(Filename Generation)(zshexpn).
)
pindex(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
tt(.zshenv), tt(zprofile()), tt(.zprofile),
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
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
@@ -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
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
command path. See
ifnzman(noderef(Invocation))\
ifzman(the section INVOCATION in zmanref(zsh)).
command path. See sectref(Invocation)(zsh).
)
pindex(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
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
of the hook functions defined in
ifnzman(the section `Special Functions' in noderef(Functions))\
ifzman(the section SPECIAL FUNCTIONS in zmanref(zshmisc))
of the hook functions defined in sectref(Special Functions)(zshmisc)
is not counted for this purpose.
)
pindex(CHECK_RUNNING_JOBS)
@@ -1584,9 +1576,7 @@ pindex(NOPROMPTBANG)
cindex(prompt, ! expansion)
item(tt(PROMPT_BANG) <K>)(
If set, `tt(!)' is treated specially in prompt expansion.
See
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
See sectref(Expansion of Prompt Sequences)(zshmisc).
)
pindex(PROMPT_CR)
pindex(NO_PROMPT_CR)
@@ -1626,9 +1616,7 @@ pindex(NOPROMPTPERCENT)
cindex(prompt, % expansion)
item(tt(PROMPT_PERCENT) <C> <Z>)(
If set, `tt(%)' is treated specially in prompt expansion.
See
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
See sectref(Expansion of Prompt Sequences)(zshmisc).
)
pindex(PROMPT_SUBST)
pindex(NO_PROMPT_SUBST)
@@ -1707,8 +1695,7 @@ cindex(operator precedence)
item(tt(C_PRECEDENCES))(
This alters the precedence of arithmetic operators to be more
like C and other programming languages;
ifnzman(noderef(Arithmetic Evaluation))\
ifzman(the section ARITHMETIC EVALUATION in zmanref(zshmisc))
sectref(Arithmetic Evaluation)(zshmisc)
has an explicit list.
)
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.
Exiting due to tt(ERR_EXIT) has certain interactions with asynchronous
jobs noted in
ifzman(the section JOBS in zmanref(zshmisc))\
ifnzman(noderef(Jobs & Signals)).
jobs noted in sectref(Signals)(zshmisc).
Note this behaviour is not disabled in interactive shells ---
a non-zero status on the command line causes the shell to exit.
@@ -1914,7 +1899,7 @@ pindex(NO_MULTIOS)
pindex(NOMULTIOS)
item(tt(MULTIOS) <Z>)(
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(NO_OCTAL_ZEROES)
@@ -1995,9 +1980,7 @@ cindex(commands, tracing)
item(tt(XTRACE) (tt(-x), ksh: tt(-x)))(
Print commands and their arguments as they are executed. The
output is preceded by the value of tt($PS4), formatted as described
in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).
in sectref(Expansion of Prompt Sequences)(zshmisc).
)
enditem()
@@ -2051,9 +2034,8 @@ pindex(CONTINUEONERROR)
pindex(NOCONTINUEONERROR)
cindex(error, option to continue script on)
item(tt(CONTINUE_ON_ERROR))(
If a fatal error is encountered (see
ifnzman(noderef(Errors))\
ifzman(the section ERRORS in zmanref(zshmisc))), and the code is running
If a fatal error is encountered (see sectref(Errors)(zshmisc)),
and the code is running
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
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>)(
Do not use the values of tt(NULLCMD) and tt(READNULLCMD)
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(NO_KSH_ARRAYS)
@@ -2204,8 +2186,7 @@ item(tt(POSIX_ALIASES) <K> <S>)(
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,
but the alias will never be expanded. Reserved words are described in
ifnzman(noderef(Reserved Words))\
ifzman(the section RESERVED WORDS in zmanref(zshmisc)).
sectref(Reserved Words)(zshmisc).
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
@@ -2393,7 +2374,7 @@ cindex(redirections with no command, sh)
cindex(redirections with no command, ksh)
item(tt(SH_NULLCMD) <K> <S>)(
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(NO_SH_OPTION_LETTERS)
@@ -2417,9 +2398,7 @@ cindex(sh, field splitting style)
item(tt(SH_WORD_SPLIT) (tt(-y)) <K> <S>)(
Causes field splitting to be performed on unquoted parameter expansions.
Note that this option has nothing to do with word splitting.
(See
ifzman(zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion)).)
(See sectref(Parameter Expansion)(zshexpn).)
)
pindex(TRAPS_ASYNC)
pindex(NO_TRAPS_ASYNC)
@@ -2495,7 +2474,7 @@ item(tt(RESTRICTED) (tt(-r)))(
Enables restricted mode. This option cannot be changed using
tt(unsetopt), and setting it inside a function always changes it
globally regardless of the tt(LOCAL_OPTIONS) option. See
noderef(Restricted Shell).
sectref(Restricted Shell)(zsh).
)
pindex(SHIN_STDIN)
pindex(NO_SHIN_STDIN)
@@ -2727,7 +2706,7 @@ texinode(Single Letter Options)()(Option Aliases)(Options)
sect(Single Letter Options)
cindex(options, single letter)
cindex(single letter options)
subsect(Default set)
subsect(Default Set)
startsitem()
sitem(tt(-0))(CORRECT)
sitem(tt(-1))(PRINT_EXIT_VALUE)
@@ -2784,7 +2763,7 @@ sitem(tt(-w))(CHASE_LINKS)
sitem(tt(-x))(XTRACE)
sitem(tt(-y))(SH_WORD_SPLIT)
endsitem()
subsect(sh/ksh emulation set)
subsect(sh/ksh Emulation Set)
startsitem()
sitem(tt(-C))(em(NO_)CLOBBER)
sitem(tt(-T))(TRAPS_ASYNC)
@@ -2805,7 +2784,7 @@ sitem(tt(-u))(em(NO_)UNSET)
sitem(tt(-v))(VERBOSE)
sitem(tt(-x))(XTRACE)
endsitem()
subsect(Also note)
subsect(Also Note)
startsitem()
sitem(tt(-A))(Used by tt(set) for setting arrays)
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)
or tt(-F), is set for var(name), the var(value) is subject to arithmetic
evaluation. Furthermore, by replacing `tt(=)' with `tt(+=)', a parameter
can be incremented or appended to. See noderef(Array Parameters) and
ifzman(em(Arithmetic Evaluation) LPAR()in zmanref(zshmisc)RPAR())\
ifnzman(noderef(Arithmetic Evaluation))
can be incremented or appended to. See sectref(Array Parameters)(below) and
sectref(Arithmetic Evaluation)(zshmisc)
for additional forms of assignment.
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
`tt(${)var(name)tt(})'. The latter form is required when var(name)
includes a namespace prefix. See
ifzman(em(Parameter Expansion) in zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion))
includes a namespace prefix. See sectref(Parameter Expansion)(zshexpn)
for complete details. That section also explains the effect
of the difference between scalar and array assignment on parameter
expansion.
@@ -103,8 +100,8 @@ menu(Array Parameters)
menu(Positional Parameters)
menu(Local Parameters)
menu(Named References)
menu(Parameters Set By The Shell)
menu(Parameters Used By The Shell)
menu(Parameters Set by the Shell)
menu(Parameters Used by the Shell)
endmenu()
texinode(Array Parameters)(Positional Parameters)()(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
tt(]=), but is otherwise treated as a simple string. The enhanced forms
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.
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
generation); these are as performed by the parameter expansion flag
tt(LPAR()e+RPAR()) as described in
ifzman(zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion)).
subref(Parameter Expansion Flags)(zshexpn).
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
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(var(name)tt(=LPAR()RPAR()))
anchor(Array Subscripts)
subsect(Array Subscripts)
cindex(subscripts)
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
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
the description of the option in ifzman(zmanref(zshoptions))\
ifnzman(noderef(Description of Options)).
the description of the option in nmref(Description of Options)(zshoptions).
The same subscripting syntax is used for associative arrays, except that
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,
in no particular order. Note that this does not substitute
the keys; see the documentation for the `tt(k)' flag under
ifzman(em(Parameter Expansion Flags) in zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion))
subref(Parameter Expansion Flags)(zshexpn)
for complete details.
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)
@@ -472,10 +467,8 @@ for either purpose on the left side of an assignment.
)
enditem()
See em(Parameter Expansion Flags) (\
ifzman(zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion))\
) for additional ways to manipulate the results of array subscripting.
See subref(Parameter Expansion Flags)(zshexpn)
for additional ways to manipulate the results of array subscripting.
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
text between the opening `tt([)' and the closing `tt(])' is interpreted
em(as if) it were in double quotes (\
ifzman(see zmanref(zshmisc))\
ifnzman(noderef(Quoting))\
). However, unlike double quotes which normally cannot nest, subscript
em(as if) it were in double quotes (see sectref(Quoting)(zshmisc)).
However, unlike double quotes which normally cannot nest, subscript
expressions may appear inside double-quoted strings or inside other
subscript expressions (or both!), so the rules have two important
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
reverse subscript, rather than as a pattern,
use `tt(${LPAR()q)tt(RPAR())var(name)tt(})' (\
ifzman(see zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion))\
sectref(Parameter Expansion)(zshexpn)\
) to quote the expanded value.
Note that the `tt(k)' and `tt(K)' flags are reverse subscripting for an
@@ -596,11 +586,11 @@ cindex(parameters, positional)
sect(Positional Parameters)
The positional parameters provide access to the command-line arguments
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,
is the var(n)th positional parameter.
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
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
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(references, named)
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
needs to be backwards-compatible. This is described fully in
the Parameter Expansion Flags section of
ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)). Zsh
subref(Parameter Expansion Flags)(zshexpn). Zsh
versions em(greater than) tt(5.9.0) are required for `tt(typeset -n)'.
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)
initializes the reference, and subsequently any expansions of, or
assignments to, var(pname) act on the referenced parameter. This
is explained in the Named References section of
ifzman(zmanref(zshexpn))ifnzman(noderef(Parameter Expansion)).
is explained in subref(Named References)(zshexpn).
A placeholder var(pname) in a calling function may be initialized in a
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
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)
sect(Parameters Set By The Shell)
texinode(Parameters Set by the Shell)(Parameters Used by the Shell)(Named References)(Parameters)
sect(Parameters Set by the Shell)
In the parameter lists that follow, the mark `<S>' indicates that the
parameter is special. `<Z>' indicates that the parameter does not exist
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
use of tt(typeset). See
the documentation for the builtin tt(typeset) in
ifzman(zmanref(zshbuiltins))\
ifnzman(noderef(Shell Builtin Commands)) for more details.
nmref(Shell Builtin Commands)(zshbuiltins) for more details.
)
vindex(SHLVL)
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
caused an error. The value is 1 to indicate an error, 0 otherwise.
It may be reset, clearing the error condition. See
ifzman(em(Complex Commands) in zmanref(zshmisc))\
ifnzman(noderef(Complex Commands))
sectref(Complex Commands)(zshmisc)
)
vindex(TRY_BLOCK_INTERRUPT)
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).
)
item(tt(zsh_scheduled_events))(
See ifzman(the section `The zsh/sched Module' in zmanref(zshmodules))\
ifnzman(noderef(The zsh/sched Module)).
See sectref(The zsh/sched Module)(zshmodules).
)
vindex(ZSH_SCRIPT)
item(tt(ZSH_SCRIPT))(
@@ -1178,8 +1163,8 @@ item(tt(ZSH_VERSION))(
The version number of the release of zsh.
)
enditem()
texinode(Parameters Used By The Shell)()(Parameters Set By The Shell)(Parameters)
sect(Parameters Used By The Shell)
texinode(Parameters Used by the Shell)()(Parameters Set by the Shell)(Parameters)
sect(Parameters Used by the Shell)
The following parameters are used by the shell. Again, `<S>' indicates
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.
@@ -1474,17 +1459,13 @@ xitem(tt(match))
xitem(tt(mbegin))
item(tt(mend))(
Arrays set by the shell when the tt(b) globbing flag is used in pattern
matches. See the subsection em(Globbing flags) in
ifzman(the documentation for em(Filename Generation) in zmanref(zshexpn))\
ifnzman(noderef(Filename Generation)).
matches. See subref(Globbing Flags)(zshexpn).
)
xitem(tt(MATCH))
xitem(tt(MBEGIN))
item(tt(MEND))(
Set by the shell when the tt(m) globbing flag is used in pattern
matches. See the subsection em(Globbing flags) in
ifzman(the documentation for em(Filename Generation) in zmanref(zshexpn))\
ifnzman(noderef(Filename Generation)).
matches. See subref(Globbing Flags)(zshexpn).
)
vindex(module_path)
vindex(MODULE_PATH)
@@ -1553,9 +1534,8 @@ vindex(PS1)
item(tt(PS1) <S>)(
The primary prompt string, printed before a command is read.
It undergoes a special form of expansion
before being displayed; see
ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)). The default is `tt(%m%# )'.
before being displayed; see sectref(Expansion of Prompt Sequences)(zshmisc).
The default is `tt(%m%# )'.
)
vindex(PS2)
item(tt(PS2) <S>)(
@@ -1796,9 +1776,7 @@ vindex(ZBEEP)
item(tt(ZBEEP))(
If set, this gives a string of characters, which can use all the same codes
as the tt(bindkey) command as described in
ifzman(the zsh/zle module entry in zmanref(zshmodules))\
ifnzman(noderef(The zsh/zle Module))\
, that will be output to the terminal
sectref(The zsh/zle Module)(zshmodules), that will be output to the terminal
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
the effect of flashing reverse video on and off (if you usually use reverse
@@ -1830,8 +1808,7 @@ remains disabled.
vindex(zle_highlight)
item(tt(zle_highlight))(
An array describing contexts in which ZLE should highlight the input text.
See ifzman(em(Character Highlighting) in zmanref(zshzle))\
ifnzman(noderef(Character Highlighting)).
See sectref(Character Highlighting)(zshzle).
)
vindex(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
or replacement behaviour which overrides the values described here.
See the completion system documentation in
ifzman(zmanref(zshcompsys))\
ifnzman(noderef(Completion System)).
nmref(Completion System)(zshcompsys).
)
vindex(ZLE_RPROMPT_INDENT)
item(tt(ZLE_RPROMPT_INDENT) <S>)(

31
Doc/Zsh/prompt.yo
View File

@@ -1,5 +1,6 @@
texinode(Prompt Expansion)(Expansion)(Conditional Expressions)(Top)
chapter(Prompt Expansion)
anchor(Expansion of Prompt Sequences)
sect(Expansion of Prompt Sequences)
cindex(prompt expansion)
cindex(expansion, prompt)
@@ -29,15 +30,18 @@ represented as `tt(!!)'.
pindex(PROMPT_PERCENT, use of)
If the tt(PROMPT_PERCENT) option is set, certain escape sequences that
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
should appear between the `tt(%)' and the next character of the
sequence. More complicated escape sequences are available to provide
conditional expansion.
sequence. More complicated escape sequences
(see sectref(Conditional Substrings in Prompts)(below))
are available to provide conditional expansion.
anchor(Simple Prompt Escapes)
sect(Simple Prompt Escapes)
subsect(Special characters)
subsect(Special Characters)
startitem()
item(tt(%%))(
A `tt(%)'.
@@ -47,7 +51,7 @@ A `tt(RPAR())'.
)
enditem()
subsect(Login information)
subsect(Login Information)
startitem()
item(tt(%l))(
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()
subsect(Shell state)
subsect(Shell State)
startitem()
item(tt(%#))(
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
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 full path;
ifzman(see em(Dynamic) and em(Static named directories) in zmanref(zshexpn))\
ifnzman(noderef(Filename Expansion)).
the full path; see bf(Dynamic) and bf(Static Named Directories) in
sectref(Filename Expansion)(zshexpn).
)
item(tt(%e))(
Evaluation depth of the current sourced file, shell function, or tt(eval).
@@ -162,7 +165,7 @@ the latter two sequences.
)
enditem()
subsect(Date and time)
subsect(Date and Time)
startitem()
item(tt(%D))(
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()
subsect(Visual effects)
subsect(Visual Effects)
startitem()
item(tt(%B) LPAR()tt(%b)RPAR())(
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
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)
attribute;
ifzman(see em(Character Highlighting) in zmanref(zshzle))\
ifnzman(noderef(Character Highlighting)). This means that numeric
attribute; see sectref(Character Highlighting)(zshzle).
This means that numeric
colours are allowed in the second format also.
)
item(tt(%K) LPAR()tt(%k)RPAR())(
@@ -284,6 +286,7 @@ the correct truncation point can be found.
)
enditem()
anchor(Conditional Substrings in Prompts)
sect(Conditional Substrings in Prompts)
startitem()
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).
The `tt(|&)' command separator described in
ifzman(em(Simple Commands & Pipelines) in zmanref(zshmisc))\
ifnzman(noderef(Simple Commands & Pipelines))
sectref(Simple Commands & Pipelines)(zshmisc)
is a shorthand for `tt(2>&1 |)'.
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
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
command represented by var(list). See
ifzman(\
em(Process Substitution) in zmanref(zshexpn))\
ifnzman(\
noderef(Process Substitution)).
command represented by var(list). See sectref(Process Substitution)(zshexpn).
sect(Opening file descriptors using parameters)
cindex(file descriptors, use with parameters)
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
of command arguments and after any redirections to the left on the command
line have been processed.
anchor(Multios)
sect(Multios)
cindex(multios)
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)
When it starts, the shell reads commands from various files. These can
be created or edited to customize the shell. See ifzman(the section
Startup/Shutdown Files in zmanref(zsh))\
ifnzman(noderef(Files)).
be created or edited to customize the shell. See
sectref(Startup/Shutdown Files)(zsh).
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
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
with `tt(autoload -Uz zsh-newuser-install; zsh-newuser-install -f)'.
See also
ifnzman(noderef(User Configuration Functions))\
ifzman(the section `User Configuration Functions' in zmanref(zshcontrib)).
See also sectref(User Configuration Functions)(zshcontrib).
sect(Interactive Use)
Interaction with the shell uses the builtin Zsh Line Editor, ZLE. This is
described in detail in ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor)).
described in detail in nmref(Zsh Line Editor)(zshzle).
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
@@ -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
default is quite small (30 lines). See the description of the shell
variables (referred to in the documentation as parameters) tt(HISTFILE),
tt(HISTSIZE) and tt(SAVEHIST) in ifzman(zmanref(zshparam))\
ifnzman(noderef(Parameters Used By The Shell)). Note that it's
tt(HISTSIZE) and tt(SAVEHIST) in
sectref(Parameters Used by the Shell)(zshparam). Note that it's
currently only possible to read and write files saving history
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
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)
in
ifnzman(noderef(Parameters))\
ifzman(zmanref(zshparam)).
in sectref(Parameters Used by the Shell)(zshparam).
subsect(Completion)
@@ -84,11 +78,9 @@ completions for many commonly used commands; it is therefore to be
preferred.
The completion system must be enabled explicitly when the shell starts.
For more information see
ifzman(zmanref(zshcompsys))\
ifnzman(noderef(Completion System)).
For more information see nmref(Completion System)(zshcompsys).
subsect(Extending the line editor)
subsect(Extending the Line Editor)
Apart from completion, the line editor is highly extensible by means of
shell functions. Some useful functions are provided with the shell; they
@@ -113,24 +105,21 @@ edit the command line with an external editor.
)
enditem()
See ifzman(the section `ZLE Functions' in zmanref(zshcontrib))\
ifnzman(noderef(ZLE Functions)) for descriptions of these.
See sectref(ZLE Functions)(zshcontrib) for descriptions of these.
sect(Options)
The shell has a large number of options for changing its behaviour.
These cover all aspects of the shell; browsing the full documentation is
the only good way to become acquainted with the many possibilities. See
ifzman(zmanref(zshoptions))\
ifnzman(noderef(Options)).
nmref(Options)(zshoptions).
sect(Pattern 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
historical reasons as `globbing') and for use when programming. These are
described in ifzman(the section `Filename Generation' in zmanref(zshexpn))\
ifnzman(noderef(Filename Generation)).
described in sectref(Filename Generation)(zshexpn).
Of particular interest are the following patterns that are not commonly
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
therefore more remotely to the original UNIX shell, the Bourne shell,
its default behaviour does not entirely correspond to those shells.
General shell syntax is introduced in ifzman(the section `Shell Grammar' in
zmanref(zshmisc))\
ifnzman(noderef(Shell Grammar)).
General shell syntax is introduced in sectref(Shell Grammar)(zshmisc).
One commonly encountered difference is that variables substituted onto the
command line are not split into words. See the description of the shell option
tt(SH_WORD_SPLIT) in
ifzman(the section `Parameter Expansion' in zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion)).
tt(SH_WORD_SPLIT) in sectref(Parameter Expansion)(zshexpn).
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
ifzman(the section `Array Parameters' in zmanref(zshparam))\
ifnzman(noderef(Array Parameters)).
sectref(Array Parameters)(zshparam).
sect(Programming)
The most convenient way of adding enhancements to the shell is typically
by writing a shell function and arranging for it to be autoloaded.
Functions are described in ifzman(the section `Functions' in
zmanref(zshmisc))\
ifnzman(noderef(Functions)). Users changing from the C shell and its
Functions are described in sectref(Functions)(zshmisc).
Users changing from the C shell and its
relatives should notice that aliases are less used in zsh as they don't
perform argument substitution, only simple text replacement.
A few general functions, other than those for the line editor described
above, are provided with the shell and are described in
ifzman(zmanref(zshcontrib))\
ifnzman(noderef(User Contributions)). Features include:
nmref(User Contributions)(zshcontrib). Features include:
startitem()
item(tt(promptinit))(
a prompt theme system for changing prompts easily, see ifzman(the section
`Prompt Themes'
)\
ifnzman(noderef(Prompt Themes))
a prompt theme system for changing prompts easily, see
sectref(Prompt Themes)(zshcontrib)
)
item(tt(zsh-mime-setup))(
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
TCP/IP from within the shell; see its description in
ifzman(\
zmanref(zshmodules)\
)\
ifnzman(\
noderef(Zsh Modules)\
). This manual page describes a function suite based on the module.
sectref(The zsh/net/tcp Module)(zshmodules).
This manual page describes a function suite based on the module.
If the module is installed, the functions are usually installed at the
same time, in which case they will be available for
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
timeouts on read operations. For troubleshooting tips, consult the
corresponding advice for the tt(zftp) functions described in
ifzman(\
zmanref(zshzftpsys)\
)\
ifnzman(\
noderef(Zftp Function System)\
).
nmref(Zftp Function System)(zshzftpsys).
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
@@ -426,7 +417,7 @@ installed.
)
enditem()
subsect(`One-shot' file transfer)
subsect(`One-shot' File Transfer)
startitem()
xitem(tt(tcp_point) var(port))
item(tt(tcp_shoot) var(host) var(port))(
@@ -542,13 +533,7 @@ findex(tcp_fd_handler)
item(tt(tcp_fd_handler))(
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
documented for the builtin `tt(zle -F)' in
ifzman(\
zmanref(zshzle)
)\
ifnzman(\
noderef(Zle Builtins)
).
documented for the builtin `tt(zle -F)' in sectref(Zle Builtins)(zshzle).
While active, the function sets the parameter tt(TCP_HANDLER_ACTIVE) to 1.
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.
The prerequisite is that the tt(zftp) command, as described in
ifzman(\
zmanref(zshmodules)
)\
ifnzman(\
noderef(The zsh/zftp Module)
), must be available in the
sectref(The zsh/zftp Module)(zshmodules), must be available in the
version of tt(zsh) installed at your site. If the shell is configured to
load new commands at run time, it probably is: typing `tt(zmodload zsh/zftp)'
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
are treated literally (a single `tt(-)' is treated as an argument).
subsect(Opening a connection)
subsect(Opening a Connection)
startitem()
findex(zfparams)
item(tt(zfparams) [ var(host) [ var(user) [ var(password) ... ] ] ])(
@@ -128,7 +123,7 @@ suitable string.
)
enditem()
subsect(Directory management)
subsect(Directory Management)
startitem()
findex(zfcd)
xitem(tt(zfcd) [ var(dir) ])
@@ -197,7 +192,7 @@ are passed directly to the server. No pager and no caching is used.
)
enditem()
subsect(Status commands)
subsect(Status Commands)
startitem()
findex(zftype)
item(tt(zftype) [ var(type) ])(
@@ -215,7 +210,7 @@ events, too.
)
enditem()
subsect(Retrieving files)
subsect(Retrieving Files)
The commands for retrieving files all take at least two options. tt(-G)
suppresses remote filename expansion which would otherwise be performed
(see below for a more detailed description of that). tt(-t) attempts
@@ -268,7 +263,7 @@ directory semantics.
)
enditem()
subsect(Sending files)
subsect(Sending Files)
startitem()
findex(zfput)
item(tt(zfput) [ tt(-r) ] var(file1) ...)(
@@ -320,7 +315,7 @@ then tt(zfpcp) will retry using the second form.
)
enditem()
subsect(Closing the connection)
subsect(Closing the Connection)
startitem()
findex(zfclose)
item(tt(zfclose))(
@@ -328,7 +323,7 @@ Close the connection.
)
enditem()
subsect(Session management)
subsect(Session Management)
startitem()
findex(zfsession)
item(tt(zfsession) [ tt(-lvod) ] [ var(sessname) ])(
@@ -410,7 +405,7 @@ from the zftp functions.
)
enditem()
subsect(Other functions)
subsect(Other Functions)
Mostly, these functions will not be called directly (apart from
tt(zfinit)), but are described here for completeness. You may wish to
alter tt(zftp_chpwd) and tt(zftp_progress), in particular.
@@ -511,9 +506,7 @@ cindex(zftp function system, styles)
cindex(styles in zftp functions)
Various styles are available using the standard shell style mechanism,
described in
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)). Briefly, the
described in sectref(The zsh/zutil Module)(zshmodules). Briefly, the
command `tt(zstyle ':zftp:*') var(style) var(value) ...'.
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
@@ -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
overwritten.
subsect(Remote globbing)
subsect(Remote Globbing)
cindex(zftp function system, remote globbing)
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
directory contents.
subsect(Automatic and temporary reopening)
subsect(Automatic and Temporary Reopening)
cindex(zftp function system, automatic reopening)
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(LINES, use of)
The parameters tt(BAUD), tt(COLUMNS), and tt(LINES) are also used by the
line editor. See
ifzman(em(Parameters Used By The Shell) in zmanref(zshparam))\
ifnzman(noderef(Parameters Used By The Shell)).
line editor. See sectref(Parameters Used by the Shell)(zshparam).
vindex(zle_highlight, use of)
The parameter tt(zle_highlight) is also used by the line editor; see
ifzman(em(Character Highlighting) below)\
ifnzman(noderef(Character Highlighting)). Highlighting
sectref(Character Highlighting)(below). Highlighting
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)
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
argument causes the next command entered to be repeated the specified
number of times, unless otherwise noted below; this is implemented
by the tt(digit-argument) widget. See also
ifzman(the em(Arguments) subsection of the em(Widgets) section )\
ifnzman(noderef(Arguments))\
by the tt(digit-argument) widget. See also subref(Arguments)(below)
for some other ways the numeric argument can be modified.
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
in user-defined widgets with the tt(read-command) widget, described in
ifzman(the subsection `Miscellaneous' of the section `Standard Widgets' below)\
ifnzman(noderef(Miscellaneous) below)\
.
subref(Miscellaneous)(below).
subsect(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)
is called. If no function name is specified, it defaults to
the same name as the widget. For further information, see
ifzman(the section `Widgets' below)\
ifnzman(noderef(Zle Widgets))\
.
sectref(Zle Widgets)(below).
)
item(tt(-f) var(flag) [ var(flag)... ])(
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
whose name is given as var(completion-widget). To generate the
completions, the shell function var(function) will be called.
For further information, see
ifzman(zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets))\
.
For further information, see nmref(Completion Widgets)(zshcompwid).
)
item(tt(-R) [ tt(-c) ] [ var(display-string) ] [ var(string) ... ])(
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
TCP port is created using the ztcp command; see
ifzman(the description of the tt(zsh/net/tcp) module in zmanref(zshmodules))\
ifnzman(noderef(The zsh/net/tcp Module)). Then a handler is installed
sectref(The zsh/net/tcp Module)(zshmodules). Then a handler is installed
which simply prints out any data which arrives on this connection. Note
that `select' will indicate that the file descriptor needs handling
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.
The standard widgets built into ZLE are listed in
ifzman(the section `Standard Widgets' below)\
ifnzman(noderef(Standard Widgets)).
sectref(Standard Widgets)(below).
Other built-in widgets can be defined by other modules (see
ifzman(zmanref(zshmodules))\
ifnzman(noderef(Zsh Modules))\
). Each built-in widget has two names: its normal canonical name, and the
nmref(Zsh Modules)(zshmodules)).
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
rebound to a different widget. This makes the widget available even when
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
activates the region in line-wise mode with the highlighted text
extending for whole lines only; see
ifzman(em(Character Highlighting) below)\
ifnzman(noderef(Character Highlighting)).
sectref(Character Highlighting)(below).
)
vindex(region_highlight)
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(A highlight specification in the same format as
used for contexts in the parameter tt(zle_highlight), see
ifnzman(noderef(Character Highlighting))\
ifzman(the section `Character Highlighting' below);
sectref(Character Highlighting)(below);
for example, tt(standout) or tt(fg=red,bold).)
itemiz(Optionally, a string of the form `tt(memo=)var(token)'.
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
syntax described in
ifzman(the section `Parameter Expansion' in zmanref(zshexpn))\
ifnzman(noderef(Parameter Expansion)).))
sectref(Parameter Expansion)(zshexpn).))
enditemize()
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)
and tt(zle_highlight); see
ifzman(the section CHARACTER HIGHLIGHTING below)\
ifnzman(noderef(Character Highlighting)) for details.
sectref(Character Highlighting)(below) for details.
)
vindex(registers)
item(tt(registers) (associative array))(
@@ -1144,6 +1125,7 @@ example(if [[ $ZLE_STATE == *globalhistory*insert* ]]; then ...; fi)
)
enditem()
anchor(Special Widgets)
subsect(Special Widgets)
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
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
the tt(KEYTIMEOUT) parameter, see ifzman(zmanref(zshparam))\
ifnzman(noderef(Parameters)).
the tt(KEYTIMEOUT) parameter, see
sectref(Parameters Used by the Shell)(zshparam).
startmenu()
menu(Movement)
menu(History Control)
@@ -1570,9 +1552,8 @@ item(tt(history-incremental-pattern-search-forward))(
These widgets behave similarly to the corresponding widgets with
no tt(-pattern), but the search string typed by the user is treated
as a pattern, respecting the current settings of the various options
affecting pattern matching. See
ifzman(FILENAME GENERATION in zmanref(zshexpn))\
ifnzman(noderef(Filename Generation)) for a description of patterns.
affecting pattern matching. See sectref(Filename Generation)(zshexpn)
for a description of patterns.
If no numeric argument was given lowercase letters in the search
string may match uppercase letters in the history. The string may begin
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
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
tt(zsh/nearcolor) module (see ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/nearcolor Module))\
).
tt(zsh/nearcolor) module (see nmref(The zsh/nearcolor Module)(zshmodules)).
Colour is also known as color.
)

45
Doc/zman.yo
View File

@@ -97,10 +97,51 @@ def(comment)(1)(\
COMMENT(--- cross-references ---)
def(manref)(2)(\
NOTRANS(\fI)ARG1+NOTRANS(\fP)(ARG2)\
bf(ARG1)(ARG2)\
)
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 ---)

7
Doc/ztexi.yo
View File

@@ -156,6 +156,13 @@ def(zmanref)(1)(manref(ARG1)(1))
def(noderef)(1)(\
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 ---)

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="\<item(" end=")" contains=zyodlSpecial,@zyodlInline
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
syn region zyodlComment start="\<comment(" end=")"
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.
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='
syn keyword zyodlKeyword sitem nextgroup=zyodlSItemArg1