c.f. 21071: always use "status" in return and exit status docs

16 files changed, 59 insertions, 52 deletions

diff --git a/ChangeLog b/ChangeLog
index 75a78570c..bd94ed23e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2005-04-01  Peter Stephenson  <pws@csr.com>
 
+	* c.f. 21071: Doc/Zsh/{builtins.yo,compsys.yo,compwid.yo,func.yo,
+	grammar.yo,mod_clone.yo,mod_computil.yo,mod_system.yo,mod_zftp.yo,
+	mod_zpty.yo,mod_zselect.yo,mod_zutil.yo,params.yo,prompt.yo,
+	tcpsys.yo}: use "status" for exit and return status
+	instead of "value" or "code".
+
 	* 21078: Src/init.c, Test/A01grammar.ztst: parse errors didn't
 	cause non-zero exit status.
 
diff --git a/Doc/Zsh/builtins.yo b/Doc/Zsh/builtins.yo
index e4115e3da..87b667f08 100644
--- a/Doc/Zsh/builtins.yo
+++ b/Doc/Zsh/builtins.yo
@@ -55,7 +55,7 @@ cindex(parameters, expanding)
 cindex(doing nothing)
 item(tt(:) [ var(arg) ... ])(
 This command does nothing, although normal argument expansions is performed
-which may have effects on shell parameters.  A zero exit code is returned.
+which may have effects on shell parameters.  A zero exit status is returned.
 )
 findex(alias)
 cindex(aliases, defining)
@@ -368,8 +368,8 @@ command in the current shell process.
 prefix(exec)
 findex(exit)
 item(tt(exit) [ var(n) ])(
-Exit the shell with the exit code specified by var(n); if none
-is specified, use the exit code from the last command executed.
+Exit the shell with the exit status specified by var(n); if none
+is specified, use the exit status from the last command executed.
 pindex(IGNORE_EOF, use of)
 An EOF condition will also cause the shell to exit, unless
 the tt(IGNORE_EOF) option is set.
@@ -385,7 +385,7 @@ already exist, it is created in the global scope.
 findex(false)
 cindex(doing nothing, unsuccessfully)
 item(tt(false) [ var(arg) ... ])(
-Do nothing and return an exit code of 1.
+Do nothing and return an exit status of 1.
 )
 findex(fc)
 cindex(history, editing)
@@ -933,7 +933,7 @@ not work with the tt(-q) option.
 item(tt(-q))(
 Read only one character from the terminal and set var(name) to
 `tt(y)' if this character was `tt(y)' or `tt(Y)' and to `tt(n)' otherwise.
-With this flag set the return value is zero only if the character was
+With this flag set the return status is zero only if the character was
 `tt(y)' or `tt(Y)'.  Note that this always reads from the terminal, even
 if used with the tt(-p) or tt(-u) or tt(-z) flags or with redirected input.
 This option may also be used within zle widgets.
@@ -1202,7 +1202,7 @@ users stick exclusively to one name or another.
 findex(true)
 cindex(doing nothing, successfully)
 item(tt(true) [ var(arg) ... ])(
-Do nothing and return an exit code of 0.
+Do nothing and return an exit status of 0.
 )
 findex(ttyctl)
 cindex(tty, freezing)
@@ -1687,7 +1687,7 @@ compiled file.  Without further arguments, the names of the original
 files compiled into it are listed.  The first line of output shows
 the version of the shell which compiled the file and how the file
 will be used (i.e. by reading it directly or by mapping it into memory).
-With arguments, nothing is output and the return value is set to zero if
+With arguments, nothing is output and the return status is set to zero if
 definitions for em(all) var(name)s were found in the compiled
 file, and non-zero if the definition for at least one var(name) was not
 found.
diff --git a/Doc/Zsh/compsys.yo b/Doc/Zsh/compsys.yo
index d9630b2bc..89e5078bc 100644
--- a/Doc/Zsh/compsys.yo
+++ b/Doc/Zsh/compsys.yo
@@ -2534,9 +2534,9 @@ example(zstyle ':completion:*' completer _complete _correct)
 after calling tt(compinit). The default value for this style is
 `tt(_complete _ignored)', i.e. normally only ordinary completion is tried,
 first with the effect of the tt(ignored-patterns) style and then without
-it.  The tt(_main_complete) function uses the return value of the completer
+it.  The tt(_main_complete) function uses the return status of the completer
 functions to decide if other completers should be called.  If the return
-value is zero, no other completers are tried and the tt(_main_complete)
+status is zero, no other completers are tried and the tt(_main_complete)
 function returns.
 
 If the first argument to tt(_main_complete) is a single hyphen, the
@@ -3026,7 +3026,7 @@ useful when writing completion functions.  If functions are installed in
 subdirectories, most of these reside in the
 tt(Base) subdirectory.  Like the example 
 functions for commands in the distribution, the utility functions
-generating matches all follow the convention of returning zero if they
+generating matches all follow the convention of returning status zero if they
 generated completions and non-zero if no matching completions could be 
 added.
 
@@ -3334,7 +3334,7 @@ tt(state) to the set of all var(strings)s for which an action is to be
 performed.
 
 By default and in common with all other well behaved completion
-functions, _arguments returns zero if it was able to add matches and
+functions, _arguments returns status zero if it was able to add matches and
 non-zero otherwise. However, if the tt(-R) option is given,
 tt(_arguments) will instead return a status of 300 to indicate that
 tt($state) is to be handled.
@@ -3621,7 +3621,7 @@ var(args).  The var(return) argument gives the name of a parameter in which
 the return status from the function var(name); if var(return) is empty or a
 single hyphen it is ignored.
 
-The return value of tt(_call_function) itself is zero if the function
+The return status of tt(_call_function) itself is zero if the function
 var(name) exists and was called and non-zero otherwise.
 )
 findex(_call_program)
@@ -3631,7 +3631,7 @@ external command.  It looks up the tt(command) style with the supplied
 var(tag).  If the style is set, its value is used as the command to
 execute.  The var(string)s from the call to tt(_call_program), or from the
 style if set, are concatenated with spaces between them and the resulting
-string is evaluated.  The return value is the return value of the command
+string is evaluated.  The return status is the return status of the command
 called.
 )
 findex(_combination)
@@ -3819,10 +3819,10 @@ findex(_guard)
 item(tt(_guard) [ var(options) ] var(pattern descr))(
 This function is intended to be used in the var(action) for
 the specifications passed to tt(_arguments) and similar functions.  It
-returns immediately with a non-zero return value if
+returns immediately with a non-zero return status if
 the string to be completed does not match the var(pattern).  If the
 pattern matches, the var(descr) is displayed; the function then returns
-zero if the word to complete is not empty, non-zero otherwise.
+status zero if the word to complete is not empty, non-zero otherwise.
 
 The var(pattern) may be preceded by any of the options understood by
 tt(compadd) that are passed down from tt(_description), namely tt(-M),
@@ -4168,7 +4168,7 @@ findex(_retrieve_cache)
 item(tt(_retrieve_cache) var(cache_identifier))(
 This function retrieves completion information from the file given by
 var(cache_identifier), stored in a directory specified by the
-tt(cache-path) style which defaults to tt(~/.zcompcache).  The return value
+tt(cache-path) style which defaults to tt(~/.zcompcache).  The return status
 is zero if retrieval was successful.  It will only attempt retrieval
 if the tt(use-cache) style is set, so you can call this function
 without worrying about whether the user wanted to use the caching
@@ -4221,7 +4221,7 @@ dumped to.  The file is stored in a directory specified by the
 tt(cache-path) style which defaults to tt(~/.zcompcache).  The remaining
 var(params) arguments are the parameters to dump to the file.
 
-The return value is zero if storage was successful.  The function will
+The return status is zero if storage was successful.  The function will
 only attempt storage if the tt(use-cache) style is set, so you can
 call this function without worrying about whether the user wanted to
 use the caching layer.
@@ -4243,7 +4243,7 @@ internally and sorted by using the tt(tag-order) style.
 
 Next, tt(_tags) is called repeatedly without arguments from the same
 completion function.  This successively selects the first, second,
-etc. set of tags requested by the user.  The return value is zero if at
+etc. set of tags requested by the user.  The return status is zero if at
 least one of the tags is requested and non-zero otherwise.  To test if a
 particular tag is to be tried, the tt(_requested) function should be
 called (see above).
diff --git a/Doc/Zsh/compwid.yo b/Doc/Zsh/compwid.yo
index 4129a2eda..d8a628bcb 100644
--- a/Doc/Zsh/compwid.yo
+++ b/Doc/Zsh/compwid.yo
@@ -449,7 +449,7 @@ item([ tt(-M) var(match-spec) ] [ tt(--) ] [ var(words) ... ])(
 
 This builtin command can be used to add matches directly and control
 all the information the completion code stores with each possible
-match. The return value is zero if at least one match was added and
+match. The return status is zero if at least one match was added and
 non-zero if no matches were added.
 
 The completion code breaks the string to complete into seven fields in
@@ -704,7 +704,7 @@ xitem(tt(compset -n) var(begin) [ var(end) ])
 xitem(tt(compset -N) var(beg-pat) [ var(end-pat) ])
 item(tt(compset -q))(
 This command simplifies modification of the special parameters,
-while its return value allows tests on them to be carried out.
+while its return status allows tests on them to be carried out.
 
 The options are:
 
@@ -775,7 +775,7 @@ reflect the word part that is completed.
 )
 enditem()
 
-In all the above cases the return value is zero if the test succeeded
+In all the above cases the return status is zero if the test succeeded
 and the parameters were modified and non-zero otherwise. This allows
 one to use this builtin in tests such as:
 
@@ -794,7 +794,7 @@ option of tt(compctl) and/or the default completion (whether defined by
 tt(compctl -D) or the builtin default) in the appropriate places, the
 tt(-T) and/or tt(-D) flags can be passed to tt(compcall).
 
-The return value can be used to test if a matching tt(compctl)
+The return status can be used to test if a matching tt(compctl)
 definition was found. It is non-zero if a tt(compctl) was found and
 zero otherwise.
 
diff --git a/Doc/Zsh/func.yo b/Doc/Zsh/func.yo
index 3399ae7b6..bf5a9b2ae 100644
--- a/Doc/Zsh/func.yo
+++ b/Doc/Zsh/func.yo
@@ -194,7 +194,7 @@ The signal number will be passed as the first parameter to the function.
 If a function of this form is defined and null,
 the shell and processes spawned by it will ignore tt(SIG)var(NAL).
 
-The return value from the function is handled specially.  If it is
+The return status from the function is handled specially.  If it is
 zero, the signal is assumed to have been handled, and execution continues
 normally.  Otherwise, the normal effect of the signal is produced;
 if this causes execution to terminate, the status returned to the shell is
diff --git a/Doc/Zsh/grammar.yo b/Doc/Zsh/grammar.yo
index 49126b9ee..d1f3996ef 100644
--- a/Doc/Zsh/grammar.yo
+++ b/Doc/Zsh/grammar.yo
@@ -63,8 +63,8 @@ cindex(sublist)
 A em(sublist) is either a single pipeline, or a sequence of two or more
 pipelines separated by `tt(&&)' or `tt(||)'.  If two pipelines are separated
 by `tt(&&)', the second pipeline is executed only if the first succeeds
-(returns a zero value).  If two pipelines are separated by `tt(||)', the
-second is executed only if the first fails (returns a nonzero value).
+(returns a zero status).  If two pipelines are separated by `tt(||)', the
+second is executed only if the first fails (returns a nonzero status).
 Both operators have equal precedence and are left associative.
 The value of the sublist is the value of the last pipeline executed.
 For example,
@@ -73,8 +73,8 @@ example(dmesg | grep panic && print yes)
 
 is a sublist consisting of two pipelines, the second just a simple command
 which will be executed if and only if the tt(grep) command returns a zero
-value.  If it does not, the value of the sublist is that return value, else
-it is the value returned by the tt(print) (almost certainly zero).
+status.  If it does not, the value of the sublist is that return status, else
+it is the status returned by the tt(print) (almost certainly zero).
 
 cindex(list)
 A em(list) is a sequence of zero or more sublists, in which each sublist
@@ -142,9 +142,10 @@ cindex(if construct)
 item(tt(if) var(list) tt(then) var(list) [ tt(elif) var(list) tt(then) var(list) ] ... [ tt(else) var(list) ] tt(fi))(
 The tt(if) var(list) is executed, and if it returns a zero exit status,
 the tt(then) var(list) is executed.
-Otherwise, the tt(elif) var(list) is executed and if its value is zero,
+Otherwise, the tt(elif) var(list) is executed and if its status is zero,
 the tt(then) var(list) is executed.
-If each tt(elif) var(list) returns nonzero, the tt(else) var(list) is executed.
+If each tt(elif) var(list) returns nonzero status, the tt(else) var(list)
+is executed.
 )
 findex(for)
 cindex(for loops)
diff --git a/Doc/Zsh/mod_clone.yo b/Doc/Zsh/mod_clone.yo
index 1791a6df9..1124958f2 100644
--- a/Doc/Zsh/mod_clone.yo
+++ b/Doc/Zsh/mod_clone.yo
@@ -14,7 +14,7 @@ var(tty).  In the new shell, the tt(PID), tt(PPID) and tt(TTY) special
 parameters are changed appropriately.  tt($!) is set to zero in the new
 shell, and to the new shell's PID in the original shell.
 
-The return value of the builtin is zero in both shells if successful,
+The return status of the builtin is zero in both shells if successful,
 and non-zero on error.
 
 The target of tt(clone) should be an unused terminal, such as an unused virtual
diff --git a/Doc/Zsh/mod_computil.yo b/Doc/Zsh/mod_computil.yo
index d4ca8e61d..593f85ad3 100644
--- a/Doc/Zsh/mod_computil.yo
+++ b/Doc/Zsh/mod_computil.yo
@@ -73,7 +73,7 @@ innermost quoting level.  If the tt(-p) option is given, quoting is
 done as if there is some prefix before the values of the parameters,
 so that a leading equal sign will not be quoted.
 
-The return value is non-zero in case of an error and zero otherwise.
+The return status is non-zero in case of an error and zero otherwise.
 )
 findex(comptags)
 findex(comptry)
diff --git a/Doc/Zsh/mod_system.yo b/Doc/Zsh/mod_system.yo
index fa097eb82..ca15fb5ec 100644
--- a/Doc/Zsh/mod_system.yo
+++ b/Doc/Zsh/mod_system.yo
@@ -22,10 +22,10 @@ message, with no intervening space.
 If var(errvar) is supplied, the entire message, without a newline, is
 assigned to the parameter names var(errvar) and nothing is output.
 
-A return value of 0 indicates the message was successfully printed
+A return status of 0 indicates the message was successfully printed
 (although it may not be useful if the error number was out of the
-system's range), a return value of 1 indicates an error in the
-parameters, and a return value of 2 indicates the error name was
+system's range), a return status of 1 indicates an error in the
+parameters, and a return status of 2 indicates the error name was
 not recognised (no message is printed for this).
 )
 findex(sysread)
@@ -59,7 +59,7 @@ The error tt(EINTR) (interrupted system call) is handled internally so
 that shell interrupts are transparent to the caller.  Any other error
 causes a return.
 
-The possible return values are
+The possible return statuses are
 startitem()
 item(0)(
 At least one byte of data was successfully read and, if appropriate,
diff --git a/Doc/Zsh/mod_zftp.yo b/Doc/Zsh/mod_zftp.yo
index 3f5d91a9b..66699db1b 100644
--- a/Doc/Zsh/mod_zftp.yo
+++ b/Doc/Zsh/mod_zftp.yo
@@ -75,7 +75,7 @@ item(tt(params) tt(-))(
 Store the given parameters for a later tt(open) command with no
 arguments.  Only those given on the command line will be remembered.
 If no arguments are given, the parameters currently set are printed,
-although the password will appear as a line of stars; the return value is
+although the password will appear as a line of stars; the return status is
 one if no parameters were set, zero otherwise.
 
 Any of the parameters may be specified as a `tt(?)', which
diff --git a/Doc/Zsh/mod_zpty.yo b/Doc/Zsh/mod_zpty.yo
index 24139a83f..39347c116 100644
--- a/Doc/Zsh/mod_zpty.yo
+++ b/Doc/Zsh/mod_zpty.yo
@@ -43,33 +43,33 @@ The tt(-r) option can be used to read the output of the command var(name).
 With only a var(name) argument, the output read is copied to the standard
 output.  Unless the pseudo-terminal is non-blocking, copying continues
 until the command under the pseudo-terminal exits; when non-blocking, only
-as much output as is immediately available is copied.  The return value is
+as much output as is immediately available is copied.  The return status is
 zero if any output is copied.
 
 When also given a var(param) argument, at most one line is read and stored
 in the parameter named var(param).  Less than a full line may be read if
-the pseudo-terminal is non-blocking.  The return value is zero if at least
+the pseudo-terminal is non-blocking.  The return status is zero if at least
 one character is stored in var(param).
 
 If a var(pattern) is given as well, output is read until the whole string
 read matches the var(pattern), even in the non-blocking case.  The return
-value is zero if the string read matches the pattern, or if the command
+status is zero if the string read matches the pattern, or if the command
 has exited but at least one character could still be read.  As of this
 writing, a maximum of one megabyte of output can be consumed this way; if
-a full megabyte is read without matching the pattern, the return value is
+a full megabyte is read without matching the pattern, the return status is
 non-zero.
 
-In all cases, the return value is non-zero if nothing could be read, and
+In all cases, the return status is non-zero if nothing could be read, and
 is tt(2) if this is because the command has finished.
 
 If the tt(-r) option is combined with the tt(-t) option, tt(zpty) tests
 whether output is available before trying to read.  If no output is
-available, tt(zpty) immediately returns the value tt(1).
+available, tt(zpty) immediately returns the status tt(1).
 )
 item(tt(zpty) tt(-t) var(name))(
 The tt(-t) option without the tt(-r) option can be used to test
 whether the command var(name) is still running.  It returns a zero
-value if the command is running and a non-zero value otherwise.
+status if the command is running and a non-zero value otherwise.
 )
 item(tt(zpty) [ tt(-L) ])(
 The last form, without any arguments, is used to list the commands
diff --git a/Doc/Zsh/mod_zselect.yo b/Doc/Zsh/mod_zselect.yo
index 9a120e5e3..43f010a10 100644
--- a/Doc/Zsh/mod_zselect.yo
+++ b/Doc/Zsh/mod_zselect.yo
@@ -57,9 +57,9 @@ 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 0 if some file descriptors are ready for reading.  If
-the operation timed out, or a timeout of 0 was given and no file
-descriptors were ready, or there was an error, it returns status 1 and
+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
+file descriptors were ready, or there was an error, it returns status 1 and
 the array will not be set (nor modified in any way).  If there was an error
 in the select operation the appropriate error message is printed.
 )
diff --git a/Doc/Zsh/mod_zutil.yo b/Doc/Zsh/mod_zutil.yo
index 3dc4b25a6..d97bc7a48 100644
--- a/Doc/Zsh/mod_zutil.yo
+++ b/Doc/Zsh/mod_zutil.yo
@@ -93,7 +93,7 @@ at least one of the var(strings) is equal to at least one of the strings
 in the value. If the style is not defined, the status is tt(2).
 
 The tt(-T) option tests the values of the style like tt(-t), but it
-returns zero (rather than tt(2)) if the style is not defined for any
+returns status zero (rather than tt(2)) if the style is not defined for any
 matching pattern.
 )
 item(tt(zstyle -m) var(context) var(style) var(pattern))(
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index be178c042..75464dc94 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -475,7 +475,7 @@ Same as tt(argv[@]), even when tt(argv) is not set.
 )
 vindex(?)
 item(tt(?) <S>)(
-The exit value returned by the last command.
+The exit status returned by the last command.
 )
 vindex(0)
 item(tt(0) <S>)(
@@ -489,7 +489,7 @@ Same as tt(?).
 )
 vindex(pipestatus)
 item(tt(pipestatus) <S> <Z>)(
-An array containing the exit values returned by all commands in the
+An array containing the exit statuses returned by all commands in the
 last pipeline.
 )
 vindex(_)
diff --git a/Doc/Zsh/prompt.yo b/Doc/Zsh/prompt.yo
index 2745abb1d..17d17fbbb 100644
--- a/Doc/Zsh/prompt.yo
+++ b/Doc/Zsh/prompt.yo
@@ -80,7 +80,7 @@ at least one capability is raised in either the Effective or Inheritable
 capability vectors.
 )
 item(tt(%?))(
-The return code of the last command executed just before the prompt.
+The return status of the last command executed just before the prompt.
 )
 item(tt(%_))(
 The status of the parser, i.e. the shell constructs (like `tt(if)' and
diff --git a/Doc/Zsh/tcpsys.yo b/Doc/Zsh/tcpsys.yo
index a8a77e2f9..b6fe1ab60 100644
--- a/Doc/Zsh/tcpsys.yo
+++ b/Doc/Zsh/tcpsys.yo
@@ -179,8 +179,8 @@ between tt(-t) and tt(-T).
 The function does not print informational messages, but if the option
 tt(-q) is given, no error message is printed for a non-existent session.
 
-A return value of 2 indicates a timeout or no data to read.  Any other
-non-zero return value indicates some error condition.
+A return status of 2 indicates a timeout or no data to read.  Any other
+non-zero return status indicates some error condition.
 
 See tt(tcp_log) for how to control where data is sent by tt(tcp_read).
 )