diff options
author | sheldonh <sheldonh@FreeBSD.org> | 1999-09-08 15:40:46 +0000 |
---|---|---|
committer | sheldonh <sheldonh@FreeBSD.org> | 1999-09-08 15:40:46 +0000 |
commit | 4000b20086a217a75f246e176f2d220b6e8eeffa (patch) | |
tree | 60b6258ec72b0294c12843bbe00547545be80b8d /bin/csh | |
parent | bca542bac3fb5d5874b9ed3bbf6243272a8492c0 (diff) | |
download | FreeBSD-src-4000b20086a217a75f246e176f2d220b6e8eeffa.zip FreeBSD-src-4000b20086a217a75f246e176f2d220b6e8eeffa.tar.gz |
Improve shell documentation:
* Consistently misspell built-in as builtin.
* Add a builtin(1) manpage and create builtin(1) MLINKS for all shell
builtin commands for which no standalone utility exists. These MLINKS
replace those that were created for csh(1).
* Add appropriate xrefs for builtin(1) to the csh(1) and sh(1) manpages,
as well as to the manpages of standalone utilities which are supported
as shell builtin commands in at least one of the shells. In such
manpages, explain that similar functionality may be provided as a
shell builtin command.
* Improve sh(1)'s description of the cd builtin command. Csh(1) already
describes it adequately. Replace the cd(1) manpage with a builtin(1)
MLINKS link.
* Clean up some mdoc problems: use Xr instead of literal "foo(n)"; use
Ic instead of Xr for shell builtin commands.
* Undo English contractions.
Reviewed by: mpp, rgrimes
Diffstat (limited to 'bin/csh')
-rw-r--r-- | bin/csh/Makefile | 8 | ||||
-rw-r--r-- | bin/csh/csh.1 | 16 |
2 files changed, 17 insertions, 7 deletions
diff --git a/bin/csh/Makefile b/bin/csh/Makefile index cd05e53..3ebbb1e 100644 --- a/bin/csh/Makefile +++ b/bin/csh/Makefile @@ -15,10 +15,10 @@ SRCS= alloc.c char.c const.c csh.c dir.c dol.c err.c exec.c exp.c file.c \ .PATH: ${.CURDIR}/../../usr.bin/printf MAN1= csh.1 -MLINKS= csh.1 limit.1 csh.1 alias.1 csh.1 bg.1 csh.1 dirs.1 csh.1 fg.1 \ - csh.1 foreach.1 csh.1 history.1 csh.1 jobs.1 csh.1 popd.1 \ - csh.1 pushd.1 csh.1 rehash.1 csh.1 repeat.1 csh.1 suspend.1 \ - csh.1 stop.1 csh.1 source.1 +# MLINKS for Shell built in commands for which there are no userland +# utilities of the same name are handled with the associated manpage, +# builtin.1 in share/man/man1/. + CLEANFILES+=const.h errnum.h const.h: errnum.h diff --git a/bin/csh/csh.1 b/bin/csh/csh.1 index af0fc3e..a6f1dd0 100644 --- a/bin/csh/csh.1 +++ b/bin/csh/csh.1 @@ -322,7 +322,9 @@ be set. It is an artifact from a implementation of the tty driver that allows generation of interrupt characters from -the keyboard to tell jobs to stop. See stty(1) for details +the keyboard to tell jobs to stop. See +.Xr stty 1 +for details on setting options in the new tty driver. .Ss Status reporting This shell learns immediately whenever a process changes state. @@ -1487,7 +1489,7 @@ entry in the stack. The members of the directory stack are numbered from the top starting at 0. .Pp .It Ic printf Ar format-string values -Invokes a built-in version of +Invokes a builtin version of .Ic printf after evaluating the .Ar format-string @@ -2134,9 +2136,17 @@ To detect looping, the shell restricts the number of .Ic alias substitutions on a single line to 20. .Sh SEE ALSO +.Xr builtin 1 , +.Xr echo 1 , +.Xr kill 1 , +.Xr login 1 , +.Xr nice 1 , +.Xr nohup 1 , .Xr printf 1 , .Xr sh 1 , .Xr su 1 , +.Xr time 1 , +.Xr which 1 , .Xr access 2 , .Xr execve 2 , .Xr fork 2 , @@ -2194,7 +2204,7 @@ shell procedures should be provided instead of aliases. Commands within loops, prompted for by `?', are not placed on the .Ic history list. -Control structure should be parsed instead of being recognized as built-in +Control structure should be parsed instead of being recognized as builtin commands. This would allow control commands to be placed anywhere, to be combined with `\&|', and to be used with `&' and `;' metasyntax. .Pp |