summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2006-03-20 11:06:22 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2006-03-20 11:06:22 +0000
commit40df7069cb3f0bcac939eab2337511a5ac5ef510 (patch)
tree979d870a872f3b99f3e59c3ad8e8c75ab20f940f /Doc/Zsh
parentb37a0f000058dc91fbc87e803ae91486c8396a9e (diff)
downloadzsh-40df7069cb3f0bcac939eab2337511a5ac5ef510.tar.gz
zsh-40df7069cb3f0bcac939eab2337511a5ac5ef510.tar.xz
zsh-40df7069cb3f0bcac939eab2337511a5ac5ef510.zip
22360, 22365: support version 2 of Yodl
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/builtins.yo2
-rw-r--r--Doc/Zsh/compsys.yo7
-rw-r--r--Doc/Zsh/contrib.yo3
-rw-r--r--Doc/Zsh/expn.yo21
-rw-r--r--Doc/Zsh/files.yo3
-rw-r--r--Doc/Zsh/func.yo8
-rw-r--r--Doc/Zsh/index.yo2
-rw-r--r--Doc/Zsh/mod_mathfunc.yo12
-rw-r--r--Doc/Zsh/mod_zftp.yo11
-rw-r--r--Doc/Zsh/mod_zselect.yo13
-rw-r--r--Doc/Zsh/options.yo6
-rw-r--r--Doc/Zsh/tcpsys.yo4
-rw-r--r--Doc/Zsh/zftpsys.yo2
-rw-r--r--Doc/Zsh/zle.yo6
14 files changed, 55 insertions, 45 deletions
diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo
index b0de7e391..99b3238bd 100644
--- a/Doc/Zsh/builtins.yo
+++ b/Doc/Zsh/builtins.yo
@@ -1212,7 +1212,7 @@ example(trap 'print $LINENO' DEBUG)
 
 will print the line number of a command executed after it has run, while
 
-example(TRAPDEBUG() { print $LINENO; })
+example(TRAPDEBUG+LPAR()RPAR() { print $LINENO; })
 
 will always print the number zero.
 
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index 5c844e133..f798bd759 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -1308,7 +1308,8 @@ which are not used.  Its value consists of elements of the form
 such specifications separated by spaces.
 
 The var(pattern) is a pattern that is to be used to generate filenames.
-Any occurrence of the sequence `tt(%p)' is replaced by any pattern(s)
+Any occurrence of the sequence `tt(%p)' is replaced by any
+pattern+LPAR()s+RPAR()
 passed by the function calling tt(_files).  Colons in the pattern must
 be preceded by a backslash to make them distinguishable from the colon
 before the var(tag).  If more than one pattern is needed, the patterns
@@ -2467,7 +2468,7 @@ files are completed separately, so if the tt(hosts) style is set hosts
 can be completed without reference to the tt(urls) style.
 
 See the description in the function tt(_urls) itself
-for more information (e.g. `tt(more $^fpath/_urls(N))').
+for more information (e.g. `tt(more $^fpath/_urls+LPAR()N+RPAR())').
 )
 kindex(use-cache, completion style)
 item(tt(use-cache))(
@@ -3195,7 +3196,7 @@ combined in a single word even if one or more of the options take
 arguments.  For example, if tt(-a) takes an argument, with no
 tt(-s) `tt(-ab)' is considered as a single (unhandled) option; with
 tt(-s) tt(-ab) is an option with the argument `tt(b)'; with both tt(-s)
-and tt(-w), tt(-ab) may be the option tt(-a) and the option(-b) with
+and tt(-w), tt(-ab) may be the option tt(-a) and the option tt(-b) with
 arguments still to come.
 
 The option tt(-W) takes this a stage further:  it is possible to
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 534c8d4de..bf83a69e2 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -1032,7 +1032,8 @@ For example, starting from the line:
 
 example(print This line contains fan and fond)
 
-and invoking tt(replace-pattern) with the source string `tt(f(?)n)' and
+and invoking tt(replace-pattern) with the source string
+`tt(f+LPAR()?+RPAR()n)' and
 the replacment string `tt(c\1r)' produces the not very useful line:
 
 example(print This line contains car and cord)
diff --git a/Doc/Zsh/expn.yo b/Doc/Zsh/expn.yo
index 4d9df9895..2c705a141 100644
--- a/Doc/Zsh/expn.yo
+++ b/Doc/Zsh/expn.yo
@@ -1507,7 +1507,8 @@ parentheses may be nested.  There are special rules for parentheses followed
 by `tt(#)' or `tt(##)'.  Only the last match of the parenthesis is
 remembered: for example, in `tt([[ abab = (#b)([ab])# ]])', only the final
 `tt(b)' is stored in tt(match[1]).  Thus extra parentheses may be necessary
-to match the complete segment: for example, use `tt(X((ab|cd)#)Y)' to match
+to match the complete segment: for example, use
+`tt(X+LPAR()(ab|cd)#+RPAR()Y)' to match
 a whole string of either `tt(ab)' or `tt(cd)' between `tt(X)' and `tt(Y)',
 using the value of tt($match[1]) rather than tt($match[2]).
 
@@ -1561,12 +1562,13 @@ The `tt((#s))' flag succeeds only at the start of the test string, and the
 correspond to `tt(^)' and `tt($)' in standard regular expressions.  They
 are useful for matching path segments in patterns other than those in
 filename generation (where path segments are in any case treated
-separately).  For example, `tt(*((#s)|/)test((#e)|/)*)' matches a path
-segment `tt(test)' in any of the following strings: tt(test),
+separately).  For example, `tt(*((#s)|/)test+LPAR()(#e)|/+RPAR()*)' matches
+a path segment `tt(test)' in any of the following strings: tt(test),
 tt(test/at/start), tt(at/end/test), tt(in/test/middle).
 
 Another use is in parameter substitution; for example
-`tt(${array/(#s)A*Z(#e)})' will remove only elements of an array which
+`tt(${array/(#s)A*Z+LPAR()#e+RPAR()})' will remove only elements of an
+array which
 match the complete pattern `tt(A*Z)'.  There are other ways of performing
 many operations of this type, however the combination of the substitution
 operations `tt(/)' and `tt(//)' with the `tt((#s))' and `tt((#e))' flags
@@ -1582,7 +1584,8 @@ item(tt(q))(
 A `tt(q)' and everything up to the closing parenthesis of the globbing
 flags are ignored by the pattern matching code.  This is intended to
 support the use of glob qualifiers, see below.  The result is that
-the pattern `tt((#b)(*).c(#q.))' can be used both for globbing and for
+the pattern `tt((#b)(*).c+LPAR()#q.+RPAR())' can be used both for globbing
+and for
 matching against a string.  In the former case, the `tt((#q.))' will be
 treated as a glob qualifier and the `tt((#b))' will not be useful, while in
 the latter case the `tt((#b))' is useful for backreferences and the
@@ -1662,8 +1665,8 @@ the pattern
 tt(LPAR()#a1)tt(RPAR()cat)tt(LPAR()#a0)tt(RPAR()dog)tt(LPAR()#a1)tt(RPAR()fox)
 is equivalent.  Note that the point at which an error is first found is the
 crucial one for establishing whether to use approximation; for example,
-tt((#a1)abc(#a0)xyz) will not match tt(abcdxyz), because the error occurs
-at the `tt(x)', where approximation is turned off.
+tt((#a1)abc+LPAR()#a0+RPAR()xyz) will not match tt(abcdxyz), because the
+error occurs at the `tt(x)', where approximation is turned off.
 
 Entire path segments may be matched approximately, so that
 `tt((#a1)/foo/d/is/available/at/the/bar)' allows one error in any path
@@ -1871,7 +1874,7 @@ characters following the tt(PLUS()) that are alphanumeric or underscore.
 Typically var(cmd) will be the name of a shell function that contains the
 appropriate test.  For example,
 
-example(nt() { [[ $REPLY -nt $NTREF ]] }
+example(nt+LPAR()RPAR() { [[ $REPLY -nt $NTREF ]] }
 NTREF=reffile
 ls -l *(+nt))
 
@@ -2032,7 +2035,7 @@ lists all files having a link count of one whose names contain a dot
 (but not those starting with a dot, since tt(GLOB_DOTS) is explicitly
 switched off) except for tt(lex.c), tt(lex.h), tt(parse.c) and tt(parse.h).
 
-example(print b*.pro(#q:s/pro/shmo/)(#q.:s/builtin/shmiltin/))
+example(print b*.pro+LPAR()#q:s/pro/shmo/+RPAR()(#q.:s/builtin/shmiltin/))
 
 demonstrates how colon modifiers and other qualifiers may be chained
 together.  The ordinary qualifier `tt(.)' is applied first, then the colon
diff --git a/Doc/Zsh/files.yo b/Doc/Zsh/files.yo
index ba4330644..658d09e1f 100644
--- a/Doc/Zsh/files.yo
+++ b/Doc/Zsh/files.yo
@@ -15,7 +15,8 @@ Commands are first read from tt(/etc/zshenv); this cannot be overridden.
 Subsequent behaviour is modified by the tt(RCS) and
 tt(GLOBAL_RCS) options; the former affects all startup files, while the
 second only affects those in the tt(/etc) directory.  If one of the options
-is unset at any point, any subsequent startup file(s) of the corresponding
+is unset at any point, any subsequent startup file+LPAR()s+RPAR()
+of the corresponding
 type will not be read.  It is also possible for a file in tt($ZDOTDIR) to
 re-enable tt(GLOBAL_RCS). Both tt(RCS) and tt(GLOBAL_RCS) are set by
 default.
diff --git a/Doc/Zsh/func.yo b/Doc/Zsh/func.yo
index f596afef5..471954c25 100644
--- a/Doc/Zsh/func.yo
+++ b/Doc/Zsh/func.yo
@@ -110,7 +110,7 @@ arguments, at the end.
 
 For example, suppose the autoload file tt(func) contains
 
-example(func() { print This is func; }
+example(func+LPAR()RPAR() { print This is func; }
 print func is initialized
 )
 
@@ -125,7 +125,7 @@ but which loads its own definition by searching tt(fpath), by using
 `tt(autoload -X)' within a shell function.  For example, the following are
 equivalent:
 
-example(myfunc() {
+example(myfunc+LPAR()RPAR() {
   autoload -X
 }
 myfunc args...)
@@ -203,7 +203,7 @@ Programs terminated by uncaught signals typically return the status 128
 plus the signal number.  Hence the following causes the handler for
 tt(SIGINT) to print a message, then mimic the usual effect of the signal.
 
-example(TRAPINT() {
+example(TRAPINT+LPAR()RPAR() {
   print "Caught SIGINT, aborting."
   return $(( 128 + $1 ))
 })
@@ -239,7 +239,7 @@ run in the environment of the calling process, rather than in their own
 function environment.  Apart from the difference in calling procedure and
 the fact that the function form appears in lists of functions, the forms
 
-example(TRAPNAL() { 
+example(TRAPNAL+LPAR()RPAR() { 
  # code
 })
 
diff --git a/Doc/Zsh/index.yo b/Doc/Zsh/index.yo
index 9555b5d41..191e0f2f9 100644
--- a/Doc/Zsh/index.yo
+++ b/Doc/Zsh/index.yo
@@ -1,7 +1,7 @@
 ifztexi(\
 def(printindex)(2)(\
   texipage()NL()\
-  NOTRANS(@unnumbered) ARG1NL()\
+  NOTRANS(@unnumbered) ARG1+NL()\
   NL()\
   NOTRANS(@printindex) ARG2\
 )\
diff --git a/Doc/Zsh/mod_mathfunc.yo b/Doc/Zsh/mod_mathfunc.yo
index 637c22d8f..dda4f36fd 100644
--- a/Doc/Zsh/mod_mathfunc.yo
+++ b/Doc/Zsh/mod_mathfunc.yo
@@ -8,7 +8,7 @@ mathematical functions for use when
 evaluating mathematical formulae.  The syntax agrees with normal C and
 FORTRAN conventions, for example,
 
-example((( f = sin(0.3) )))
+example((( f = sin+LPAR()0.3+RPAR() )))
 
 assigns the sine of 0.3 to the parameter f.
 
@@ -33,8 +33,8 @@ returns an integer.
 The function tt(signgam) takes no arguments, and returns an integer, which
 is the C variable of the same name, as described in manref(gamma)(3).  Note
 that it is therefore only useful immediately after a call to tt(gamma) or
-tt(lgamma).  Note also that `tt(signgam())' and `tt(signgam)' are distinct
-expressions.
+tt(lgamma).  Note also that `tt(signgam+LPAR()RPAR)' and `tt(signgam)' are
+distinct expressions.
 
 The following functions take two floating point arguments: tt(copysign),
 tt(fmod), tt(hypot), tt(nextafter).
@@ -58,7 +58,8 @@ has the function tt(erand48(3)).  It returns a pseudo-random floating point
 number between 0 and 1.  It takes a single string optional argument.
 
 If the argument is not present, the random number seed is initialised by
-three calls to the tt(rand(3)) function --- this produces the same random
+three calls to the tt(rand+LPAR()3+RPAR()) function --- this produces the
+same random
 numbers as the next three values of tt($RANDOM).
 
 If the argument is present, it gives the name of a scalar parameter where
@@ -80,7 +81,8 @@ print $(( rand48(seed) )))
 
 Assuming tt($seed) does not exist, it will be initialised by the first
 call.  In the second call, the default seed is initialised; note, however,
-that because of the properties of tt(rand()) there is a correlation between
+that because of the properties of tt(rand+LPAR()RPAR()) there is a
+correlation between
 the seeds used for the two initialisations, so for more secure uses, you
 should generate your own 12-byte seed.  The third call returns to the same
 sequence of random numbers used in the first call, unaffected by the
diff --git a/Doc/Zsh/mod_zftp.yo b/Doc/Zsh/mod_zftp.yo
index 66699db1b..de53cdbb3 100644
--- a/Doc/Zsh/mod_zftp.yo
+++ b/Doc/Zsh/mod_zftp.yo
@@ -112,8 +112,9 @@ silent, apart from messages printed by the tt($ZFTP_VERBOSE)
 mechanism, or error messages if the connection closes.  There is no
 network overhead for this test.
 
-The test is only supported on systems with either the tt(select(2)) or
-tt(poll(2)) system calls; otherwise the message `tt(not
+The test is only supported on systems with either the
+tt(select+LPAR()2+RPAR()) or
+tt(poll+LPAR()2+RPAR()) system calls; otherwise the message `tt(not
 supported on this system)' is printed instead.
 
 The tt(test) subcommand will automatically be called at the start of any
@@ -496,6 +497,6 @@ all connections, and deleting a session changes the ordering of that
 information.
 
 On some operating systems, the control connection is not valid after a
-fork(), so that operations in subshells, on the left hand side of a
-pipeline, or in the background are not possible, as they should be.  This
-is presumably a bug in the operating system.
+fork+LPAR()RPAR(), so that operations in subshells, on the left hand side
+of a pipeline, or in the background are not possible, as they should be.
+This is presumably a bug in the operating system.
diff --git a/Doc/Zsh/mod_zselect.yo b/Doc/Zsh/mod_zselect.yo
index 43f010a10..23beef1e8 100644
--- a/Doc/Zsh/mod_zselect.yo
+++ b/Doc/Zsh/mod_zselect.yo
@@ -40,7 +40,8 @@ finer-grained replacement for `sleep'; not, however, the return status is
 always 1 for a timeout.
 
 The option `tt(-a) var(array)' indicates that tt(array) should be set to
-indicate the file descriptor(s) which are ready.  If the option is not
+indicate the file descriptor+LPAR()s+RPAR() which are ready.  If the option
+is not
 given, the array tt(reply) will be used for this purpose.  The array will
 contain a string similar to the arguments for tt(zselect).  For example,
 
@@ -51,11 +52,11 @@ might return immediately with status 0 and tt($reply) containing `tt(-r 0 -w
 operations.
 
 The option `tt(-A) var(assoc)' indicates that the associative array
-tt(assoc) should be set to indicate the file descriptor(s) which are
-ready.  This option overrides the option tt(-a), nor will tt(reply) be
-modified.  The keys of tt(assoc) are the file descriptors, and the
-corresponding values are any of the characters `tt(rwe)' to indicate the
-condition.
+tt(assoc) should be set to indicate the file descriptor+LPAR()s+LPAR()
+which are ready.  This option overrides the option tt(-a), nor will
+tt(reply) be modified.  The keys of tt(assoc) are the file descriptors, and
+the corresponding values are any of the characters `tt(rwe)' to indicate
+the condition.
 
 The command returns status 0 if some file descriptors are ready for
 reading.  If the operation timed out, or a timeout of 0 was given and no
diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo
index 1d0c7a24f..74f8b4c84 100644
--- a/Doc/Zsh/options.yo
+++ b/Doc/Zsh/options.yo
@@ -315,8 +315,8 @@ item(tt(CASE_GLOB) <D>)(
 Make globbing (filename generation) sensitive to case.  Note that other
 uses of patterns are always sensitive to case.  If the option is unset,
 the presence of any character which is special to filename generation
-will cause case-insensitive matching.  For example, tt(cvs(/)) can
-match the directory tt(CVS) owing to the presence of the globbing flag
+will cause case-insensitive matching.  For example, tt(cvs+LPAR()/+RPAR())
+can match the directory tt(CVS) owing to the presence of the globbing flag
 (unless the option tt(BARE_GLOB_QUAL) is unset).
 )
 pindex(CSH_NULL_GLOB)
@@ -1039,7 +1039,7 @@ For example,
 
 example(unsetopt localtraps
 trap - INT
-fn() { setopt localtraps; trap '' INT; sleep 3; })
+fn+LPAR()RPAR() { setopt localtraps; trap '' INT; sleep 3; })
 
 will restore normally handling of tt(SIGINT) after the function exits.
 )
diff --git a/Doc/Zsh/tcpsys.yo b/Doc/Zsh/tcpsys.yo
index bf04be4db..f8f65b634 100644
--- a/Doc/Zsh/tcpsys.yo
+++ b/Doc/Zsh/tcpsys.yo
@@ -202,8 +202,8 @@ tt(tcp_send); they are simply passed down to tt(print -r).
 
 If the parameter tt($TCP_OUTPUT) is a non-empty string and logging is
 enabled then the data sent to each session will be echoed to the log
-file(s) with tt($TCP_OUTPUT) in front where appropriate, much in the manner
-of tt($TCP_PROMPT).
+file+LPAR()s+RPAR() with tt($TCP_OUTPUT) in front where appropriate, much
+in the manner of tt($TCP_PROMPT).
 )
 enditem()
 
diff --git a/Doc/Zsh/zftpsys.yo b/Doc/Zsh/zftpsys.yo
index 95cb6f5d2..627e0582d 100644
--- a/Doc/Zsh/zftpsys.yo
+++ b/Doc/Zsh/zftpsys.yo
@@ -477,7 +477,7 @@ local and remote hostnames and current directories.  It works best when
 combined with the function tt(chpwd).  In particular, a function of 
 the form
 
-example(chpwd() {
+example(chpwd+LPAR()RPAR() {
   if [[ -n $ZFTP_USER ]]; then
     zftp_chpwd
   else
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index f0808314a..fb6f508a0 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -482,7 +482,7 @@ if the remote side has closed the connection; we handle that by testing
 for a failed read.
 example(if ztcp pwspc 2811; then
   tcpfd=$REPLY
-  handler() {
+  handler+LPAR()RPAR() {
     zle -I
     local line
     if ! read -r line <&$1; then
@@ -774,7 +774,7 @@ Executed every time the line editor is started to read a new line
 of input.  The following example puts the line editor into vi command
 mode when it starts up.
 
-example(zle-line-init() { zle -K vicmd; }
+example(zle-line-init+LPAR()RPAR() { zle -K vicmd; }
 zle -N zle-line-init)
 
 (The command inside the function sets the keymap directly; it is
@@ -1776,7 +1776,7 @@ the command line or key bindings temporarily.
 
 
 The following widget, tt(caps-lock), serves as an example.
-example(self-insert-ucase() {
+example(self-insert-ucase+LPAR()RPAR() {
   LBUFFER+=${(U)KEYS[-1]}
 }