commit 57c2e46ca6138eb29282d29f47feeaa44404b656
parent e68007b56849e44233537e2dc76cface0f7c88a9
Author: tjg <tjg>
Date: Wed, 9 Dec 1998 11:46:06 +0000
Documentation: document all the flags to `whatis'.
Diffstat:
| M | rc.1 | | | 31 | ++++++++++++++++++++----------- |
1 file changed, 20 insertions(+), 11 deletions(-)
diff --git a/rc.1 b/rc.1
@@ -1633,19 +1633,28 @@ is specified,
.I rc
waits for all child processes to exit.
.TP
-\fBwhatis \fR[\fB\-s\fR] [\fB\-\|\-\fR] [\fIname ...\fR]
+\fBwhatis \fR[\fB\-b\fR] \fR[\fB\-f\fR] \fR[\fB\-p\fR] \fR[\fB\-s\fR] \fR[\fB\-v\fR] [\fB\-\|\-\fR] [\fIname ...\fR]
Prints a definition of the named objects.
-For variables, their values
-are printed; for functions, their definitions are; and for executable
-files, path names are printed.
+For builtins,
+.B builtin
+.I foo
+is printed; for functions, including signal handlers, their definitions
+are printed; for executable files, path names are printed; and for
+variables, their values are printed.
+The options restrict output to builtins, functions, executable
+programs, signal handlers, and variables, respectively. If no
+.IR name s
+are specified,
+.I rc
+lists all objects of that type. (This is not permitted for
+.BR -p .)
Without arguments,
.B whatis
-prints the values of all shell variables and functions.
-With a
-.Cr \-s
-argument,
-.B whatis
-also prints out a list of available signals and their handlers (if any).
+is equivalent to
+.BR "whatis -fv" ,
+and prints the values of all shell variables and functions.
+.TP
+\&
Note that
.B whatis
output is suitable for input to
@@ -1831,7 +1840,7 @@ notation for flattening should allow for using an arbitrary
separating character, not just space.
.PP
Bug reports should be mailed to
-.Cr "<tgoodwin@cygnus.co.uk>" .
+.Cr "<tjg@star.le.ac.uk>" .
.SH INCOMPATIBILITIES
Here is a list of features which distinguish this incarnation of
.I rc
