system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-10-15 12:54:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve shell documentation:

Browse source 
* 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
This commit is contained in:
Sheldon Hearn 1999-09-08 15:40:46 +00:00
parent 518dee7dbb
commit c644db6aa2
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=51090
16 changed files with 429 additions and 184 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
bin/csh/Makefile
View file

@ -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

16
bin/csh/csh.1
View file

@ -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

12
bin/echo/echo.1
View file

@ -59,12 +59,22 @@ Do not print the trailing newline character. This may also be
achieved by appending `\ec' to the end of the string, as is done
by iBCS2 compatible systems.
.El
.Pp
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh DIAGNOSTICS
The
.Nm
utility exits 0 on success, and >0 if an error occurs.
.Sh SEE ALSO
.Xr printf 1
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr printf 1 ,
.Xr sh 1
.Sh STANDARDS
The
.Nm

15
bin/kill/kill.1
View file

@ -110,17 +110,14 @@ ALRM (alarm clock)
TERM (software termination signal)
.El
.Pp
.Nm Kill
is a built-in to
.Xr csh 1 ;
it allows job specifiers of the form ``%...'' as arguments
so process id's are not as often used as
Some shells may provide a builtin
.Nm
arguments.
See
.Xr csh 1
for details.
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr killall 1 ,
.Xr ps 1 ,

16
bin/pwd/pwd.1
View file

@ -47,6 +47,13 @@
.Nm Pwd
writes the absolute pathname of the current working directory to
the standard output.
.Pp
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh DIAGNOSTICS
The
.Nm
@ -58,14 +65,17 @@ utility is expected to be
.St -p1003.2
compatible.
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr cd 1 ,
.Xr csh 1 ,
.Xr getcwd 3
.Xr getcwd 3 ,
.Xr sh 1
.Sh BUGS
In
.Xr csh 1
the command
.Ic dirs
is always faster (although it can give a different answer in the rare case
is always faster because it is built into that shell. However,
it can give a different answer in the rare case
that the current directory or a containing directory was moved after
the shell descended into it).
the shell descended into it.

4
bin/sh/Makefile
View file

@ -10,6 +10,10 @@ GENSRCS= builtins.c init.c nodes.c syntax.c
GENHDRS= builtins.h nodes.h syntax.h token.h y.tab.h
SRCS= ${SHSRCS} ${GENSRCS} ${GENHDRS} y.tab.h
# 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/.
DPADD+= ${LIBL} ${LIBEDIT} ${LIBTERMCAP}
LDADD+= -ll -ledit -ltermcap

72
bin/sh/sh.1
View file

@ -68,11 +68,13 @@ The shell is a command that reads lines from
either a file or the terminal, interprets them, and
generally executes other commands. It is the program that is running
when a user logs into the system (although a user can select
a different shell with the chsh(1) command).
a different shell with the
.Xr chsh 1
command).
The shell
implements a language that has flow control constructs,
a macro facility that provides a variety of features in
addition to data storage, along with built in history and line
addition to data storage, along with builtin history and line
editing capabilities. It incorporates many features to
aid interactive use and has the advantage that the interpretative
language is common to both interactive and non-interactive
@ -135,8 +137,8 @@ scripts.
All of the single letter options to
.Nm
have a corresponding name that can be used as an argument to the
.Xr set 1
builtin (described later). These names are provided next to the
.Ic set
builtin command (described later). These names are provided next to the
single letter option in the descriptions below. Specifying a dash
.Dq -
enables the option, while using a plus
@ -155,11 +157,11 @@ Enable asynchronous notification of background job
completion.
.Pq UNIMPLEMENTED
.It Fl C Li noclobber
Don't overwrite existing files with
Do not overwrite existing files with
.Dq > .
.Pq UNIMPLEMENTED
.It Fl E Li emacs
Enable the built-in
Enable the builtin
.Xr emacs 1
command line editor (disables
.Fl V
@ -206,7 +208,7 @@ Read commands from standard input (set automatically
if no file arguments are present). This option has
no effect when set after the shell has already started
running (i.e. when set with the
.Xr set 1
.Ic set
command).
.It Fl T Li asynctraps
When waiting for a child, execute traps immediately. If this option is
@ -226,7 +228,7 @@ to expand a variable that is not set, and if the
shell is not interactive, exit immediately.
.Pq UNIMPLEMENTED
.It Fl V Li vi
Enable the built-in
Enable the builtin
.Xr vi 1
command line editor (disables
.Fl E
@ -297,7 +299,7 @@ for if then until while
.Ed
.Ss Aliases
An alias is a name and corresponding value set using the
.Xr alias 1
.Ic alias
builtin command. Whenever a reserved word may occur (see above),
and after checking for reserved words, the shell
checks the word to see if it matches an alias. If it does,
@ -427,11 +429,11 @@ definition is executed. The positional parameters are
restored to their original values when the command completes.
This all occurs within the current shell.
.Pp
Shell builtins are executed internally to the shell, without
Shell builtin commands are executed internally to the shell, without
spawning a new process.
.Pp
Otherwise, if the command name doesn't match a function
or builtin, the command is searched for as a normal
Otherwise, if the command name does not match a function
or builtin command, the command is searched for as a normal
program in the filesystem (as described in the next section).
When a normal program is executed, the shell runs the program,
passing the arguments and the environment to the
@ -553,7 +555,7 @@ asynchronous execution of the preceding AND-OR-list.
.Pp
Note that unlike some other shells, each process in the
pipeline is a child of the invoking shell (unless it
is a shell builtin, in which case it executes in the
is a shell builtin command, in which case it executes in the
current shell -- but any effect it has on the
environment is wiped).
.Ss Background Commands -- &
@ -740,8 +742,8 @@ or a special character as explained below.
A positional parameter is a parameter denoted by a number (n > 0).
The shell sets these initially to the values of its command line
arguments that follow the name of the shell script. The
.Xr set 1
builtin can also be used to set or reset them.
.Ic set
builtin command can also be used to set or reset them.
.Ss Special Parameters
A special parameter is a parameter denoted by one of the following
special characters. The value of the parameter is listed
@ -991,7 +993,7 @@ a pattern cannot match a string starting with a period
unless the first character of the pattern is a period.
The next section describes the patterns used for both
Pathname Expansion and the
.Xr case 1
.Ic case
command.
.Ss Shell Patterns
A pattern consists of normal characters, which match themselves,
@ -1037,16 +1039,15 @@ character listed (after the
.Dq ! ,
if any). To include a
minus sign, make it the first or last character listed.
.Ss Builtins
This section lists the builtin commands which
.Ss Builtin Commands
This section lists the commands which
are builtin because they need to perform some operation
that can't be performed by a separate process. In addition to
these, there are several other commands that may be
builtin for efficiency (e.g.
.Xr printf 1 ,
.Xr echo 1 ,
.Xr test 1 ,
etc).
that can not be performed by a separate process. In addition to
these, builtin versions of the
.Xr printf 1
and
.Xr echo 1
commands are provided for efficiency.
.Bl -tag -width Ds
.It :
A null command that returns a 0 (true) exit value.
@ -1072,7 +1073,7 @@ If just
is specified, the value of the alias
.Dq name
is printed.
With no arguments, the alias builtin prints the
With no arguments, the alias builtin command prints the
names and values of all defined aliases (see unalias).
.It bg [ job ] ...
Continue the specified jobs (or the current job if no
@ -1085,7 +1086,8 @@ as a builtin command.)
Switch to the specified directory (default $HOME).
If an entry for CDPATH appears in the environment
of the cd command or the shell variable CDPATH is set
and the directory name does not begin with a slash,
and the directory name does not begin with a slash (/),
dot (.) or dot-dot (..),
then the directories listed in CDPATH will be
searched for the specified directory. The format of
CDPATH is the same as that of PATH. In an interactive shell,
@ -1101,7 +1103,7 @@ command.
.It exec [ command arg ... ]
Unless command is omitted, the shell process is
replaced with the specified program (which must be a
real program, not a shell builtin or function). Any
real program, not a shell builtin command or function). Any
redirections on the exec command are marked as permanent,
so that they are not undone when the exec command finishes.
.It exit [ exitstatus ]
@ -1123,7 +1125,7 @@ of all exported variables.
.It fc [-e editor] [first [last]]
.It fc -l [-nr] [first [last]]
.It fc -s [old=new] [first]
The fc builtin lists, or edits and re-executes, commands
The fc builtin command lists, or edits and re-executes, commands
previously entered to an interactive shell.
.Bl -tag -width Ds
.It -e editor
@ -1297,7 +1299,7 @@ Shift the positional parameters n times. A shift
sets the value of $1 to the value of $2, the value of
$2 to the value of $3, and so on, decreasing the
value of $# by one. If there are zero positional
parameters, shifting doesn't do anything.
parameters, shifting does not do anything.
.It trap [ action ] signal ...
Cause the shell to parse and execute action when any
of the specified signals are received. The signals
@ -1311,7 +1313,7 @@ signals that were ignored on entry to the shell.
.It type [name] ...
Interpret each name as a command and print the
resolution of the command search. Possible resolutions are:
shell keyword, alias, shell builtin, command, tracked alias
shell keyword, alias, shell builtin command, command, tracked alias
and not found. For aliases the alias expansion is printed;
for commands and tracked aliases the complete pathname of
the command is printed.
@ -1396,7 +1398,9 @@ and the return an exit status of zero.
When
.Nm
is being used interactively from a terminal, the current command
and the command history (see fc in Builtins) can be edited using vi-mode
and the command history (see fc in
.Sx Builtin Commands )
can be edited using vi-mode
command line editing. This mode uses commands similar
to a subset of those described in the vi man page.
The command 'set -o vi' enables vi-mode editing and places
@ -1409,7 +1413,11 @@ Hitting <return> while in command mode will pass the line to the shell.
Similarly, the 'set -o emacs' command can be used to enable a subset of
emacs-style command line editing features.
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr echo 1 ,
.Xr expr 1 ,
.Xr pwd 1 ,
.Xr printf 1 ,
.Xr test 1
.Sh HISTORY
A

29
share/man/man1/Makefile
View file

@ -1,7 +1,34 @@
# @(#)Makefile 8.1 (Berkeley) 6/5/93
# $FreeBSD$
MAN1= cd.1 intro.1 wait.1
MAN1= builtin.1 intro.1 wait.1
MLINKS= intro.1 introduction.1
# Create MLINKS for Shell built in commands for which there are no userland
# utilities of the same name:
MLINKS= builtin.1 alias.1 builtin.1 alloc.1 builtin.1 bg.1 \
builtin.1 break.1 builtin.1 breaksw.1 builtin.1 case.1 \
builtin.1 cd.1 builtin.1 chdir.1 builtin.1 command.1 \
builtin.1 continue.1 builtin.1 cwd.1 builtin.1 do.1 \
builtin.1 done.1 builtin.1 default.1 \
builtin.1 dirs.1 builtin.1 elif.1 builtin.1 else.1 \
builtin.1 end.1 builtin.1 endif.1 builtin.1 endsw.1 \
builtin.1 esac.1 builtin.1 eval.1 builtin.1 exec.1 \
builtin.1 exit.1 builtin.1 export.1 builtin.1 fc.1 \
builtin.1 fg.1 builtin.1 fi.1 builtin.1 for.1 \
builtin.1 foreach.1 builtin.1 getopts.1 builtin.1 glob.1 \
builtin.1 goto.1 builtin.1 hash.1 builtin.1 hashstat.1 \
builtin.1 history.1 builtin.1 if.1 builtin.1 jobid.1 \
builtin.1 jobs.1 builtin.1 limit.1 builtin.1 logout.1 \
builtin.1 notify.1 builtin.1 onintr.1 builtin.1 popd.1 \
builtin.1 pushd.1 builtin.1 readonly.1 builtin.1 rehash.1 \
builtin.1 repeat.1 builtin.1 set.1 builtin.1 setenv.1 \
builtin.1 setvar.1 builtin.1 shift.1 builtin.1 source.1 \
builtin.1 stop.1 builtin.1 suspend.1 builtin.1 switch.1 \
builtin.1 then.1 builtin.1 trap.1 builtin.1 type.1 \
builtin.1 ulimit.1 builtin.1 umask.1 builtin.1 unalias.1 \
builtin.1 unhash.1 builtin.1 unlimit.1 builtin.1 unset.1 \
builtin.1 unsetenv.1 builtin.1 until.1 builtin.1 wait.1 \
builtin.1 while.1
.include <bsd.prog.mk>

259
share/man/man1/builtin.1 Normal file
View file

@ -0,0 +1,259 @@
.\"
.\" Copyright (c) 1999 Sheldon Hearn
.\"
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd September 1, 1999
.Dt BUILTIN 1
.Os
.Sh NAME
.Nm builtin ,
.Nm alias ,
.Nm alloc ,
.Nm bg ,
.Nm break ,
.Nm breaksw ,
.Nm case ,
.Nm cd ,
.Nm chdir ,
.Nm command ,
.Nm continue ,
.Nm cwd ,
.Nm default ,
.Nm dirs ,
.Nm do ,
.Nm done ,
.Nm echo ,
.Nm elif ,
.Nm else ,
.Nm end ,
.Nm endif ,
.Nm endsw ,
.Nm esac ,
.Nm eval ,
.Nm exec ,
.Nm exit ,
.Nm export ,
.Nm fc ,
.Nm fg ,
.Nm fi ,
.Nm for ,
.Nm foreach ,
.Nm getopts ,
.Nm glob ,
.Nm goto ,
.Nm hash ,
.Nm hashstat ,
.Nm history ,
.Nm if ,
.Nm jobid ,
.Nm jobs ,
.Nm kill ,
.Nm limit ,
.Nm login ,
.Nm logout ,
.Nm nice ,
.Nm nohup ,
.Nm notify ,
.Nm onintr ,
.Nm popd ,
.Nm printf ,
.Nm pushd ,
.Nm pwd ,
.Nm readonly ,
.Nm rehash ,
.Nm repeat ,
.Nm set ,
.Nm setenv ,
.Nm setvar ,
.Nm shift ,
.Nm source ,
.Nm stop ,
.Nm suspend ,
.Nm switch ,
.Nm then ,
.Nm time ,
.Nm trap ,
.Nm type ,
.Nm ulimit ,
.Nm umask ,
.Nm unalias ,
.Nm unhash ,
.Nm unlimit ,
.Nm unset ,
.Nm unsetenv ,
.Nm until ,
.Nm wait ,
.Nm which ,
.Nm while
.Nd shell builtin commands
.Sh SYNOPSIS
.Nm builtin
.Op Fl options
.Op Ar args ...
.Sh DESCRIPTION
Shell builtin commands are commands that can be executed within the
running shell's process.
Note that, in the case of
.Xr csh 1
builtin commands, the command is executed in a subshell if it occurs as
any component of a pipeline except the last.
.Pp
If a command specified to the shell contains a slash
.Dq \&/ ,
the shell will not execute a builtin command, even if the last component
of the specified command matches the name of a builtin command. Thus,
while specifying
.Dq Ic echo
causes a builtin command to be executed under shells that support the
builtin echo command,
specifying
.Dq Pa /bin/echo
or
.Dq Pa ./echo
does not.
.Pp
While some builtin commands may exist in more than one shell, their
operation may be different under each shell which supports them.
Below is a table which lists shell builtin commands, the standard shells
that support them and whether they exist as standalone utilities.
.Pp
Only builtin commands for the
.Xr csh 1
and
.Xr sh 1
shells are listed here. Consult the appropriate manual page for
details on the operation of any given builtin command under those shells.
Users of other shells will need to consult the documentation supplied
with the other shells.
.Bl -column "continueXX" "ExternalXX" "csh(1)" "sh(1)" -offset indent
.\"
.\" XXX:
.\" The correct table header here can not be rendered with mdoc's current
.\" argument maximum. When mdoc can handle sufficient arguments, the
.\" correct table header will be as follows:
.\" .It Em Command Ta Em External Ta Xr csh 1 Ta Xr sh 1
.\"
.It Em Command External csh sh
.It Ic alias Ta \&No Ta Yes Ta Yes
.It Ic alloc Ta \&No Ta Yes Ta \&No
.It Ic bg Ta \&No Ta Yes Ta Yes
.It Ic break Ta \&No Ta Yes Ta \&No
.It Ic breaksw Ta \&No Ta Yes Ta \&No
.It Ic case Ta \&No Ta Yes Ta Yes
.It Ic cd Ta \&No Ta Yes Ta Yes
.It Ic chdir Ta \&No Ta Yes Ta \&No
.It Ic command Ta \&No Ta \&No Ta Yes
.It Ic continue Ta \&No Ta Yes Ta \&No
.It Ic cwd Ta \&No Ta Yes Ta \&No
.It Ic default Ta \&No Ta Yes Ta \&No
.It Ic dirs Ta \&No Ta Yes Ta \&No
.It Ic do Ta \&No Ta \&No Ta Yes
.It Ic done Ta \&No Ta \&No Ta Yes
.It Ic echo Ta Yes Ta Yes Ta Yes
.It Ic elif Ta \&No Ta \&No Ta Yes
.It Ic else Ta \&No Ta Yes Ta \&No
.It Ic end Ta \&No Ta Yes Ta \&No
.It Ic endif Ta \&No Ta Yes Ta \&No
.It Ic endsw Ta \&No Ta Yes Ta \&No
.It Ic esac Ta \&No Ta \&No Ta Yes
.It Ic eval Ta \&No Ta Yes Ta Yes
.It Ic exec Ta \&No Ta Yes Ta Yes
.It Ic exit Ta \&No Ta Yes Ta Yes
.It Ic export Ta \&No Ta \&No Ta Yes
.It Ic fc Ta \&No Ta \&No Ta Yes
.It Ic fg Ta \&No Ta Yes Ta Yes
.It Ic fi Ta \&No Ta \&No Ta Yes
.It Ic for Ta \&No Ta \&No Ta Yes
.It Ic foreach Ta \&No Ta Yes Ta \&No
.It Ic getopts Ta \&No Ta \&No Ta Yes
.It Ic glob Ta \&No Ta Yes Ta \&No
.It Ic goto Ta \&No Ta Yes Ta \&No
.It Ic hash Ta \&No Ta \&No Ta Yes
.It Ic hashstat Ta \&No Ta Yes Ta \&No
.It Ic history Ta \&No Ta Yes Ta \&No
.It Ic if Ta \&No Ta Yes Ta \&No
.It Ic jobid Ta \&No Ta \&No Ta Yes
.It Ic jobs Ta \&No Ta Yes Ta Yes
.It Ic kill Ta Yes Ta Yes Ta \&No
.It Ic limit Ta \&No Ta Yes Ta \&No
.It Ic login Ta Yes Ta Yes Ta \&No
.It Ic logout Ta \&No Ta Yes Ta \&No
.It Ic nice Ta Yes Ta Yes Ta \&No
.It Ic nohup Ta Yes Ta Yes Ta \&No
.It Ic notify Ta \&No Ta Yes Ta \&No
.It Ic onintr Ta \&No Ta Yes Ta \&No
.It Ic popd Ta \&No Ta Yes Ta \&No
.It Ic printf Ta Yes Ta Yes Ta Yes
.It Ic pushd Ta \&No Ta Yes Ta \&No
.It Ic pwd Ta Yes Ta \&No Ta Yes
.It Ic readonly Ta \&No Ta \&No Ta Yes
.It Ic rehash Ta \&No Ta Yes Ta \&No
.It Ic repeat Ta \&No Ta Yes Ta \&No
.It Ic set Ta \&No Ta Yes Ta \&No
.It Ic setenv Ta \&No Ta Yes Ta \&No
.It Ic setvar Ta \&No Ta \&No Ta Yes
.It Ic shift Ta \&No Ta Yes Ta Yes
.It Ic source Ta \&No Ta Yes Ta \&No
.It Ic stop Ta \&No Ta Yes Ta \&No
.It Ic suspend Ta \&No Ta Yes Ta \&No
.It Ic switch Ta \&No Ta Yes Ta \&No
.It Ic then Ta \&No Ta \&No Ta Yes
.It Ic time Ta Yes Ta Yes Ta \&No
.It Ic trap Ta \&No Ta \&No Ta Yes
.It Ic type Ta \&No Ta \&No Ta Yes
.It Ic ulimit Ta \&No Ta \&No Ta Yes
.It Ic umask Ta \&No Ta Yes Ta Yes
.It Ic unalias Ta \&No Ta Yes Ta Yes
.It Ic unhash Ta \&No Ta Yes Ta \&No
.It Ic unlimit Ta \&No Ta Yes Ta \&No
.It Ic unset Ta \&No Ta Yes Ta Yes
.It Ic unsetenv Ta \&No Ta Yes Ta \&No
.It Ic until Ta \&No Ta \&No Ta Yes
.It Ic wait Ta \&No Ta Yes Ta Yes
.It Ic which Ta Yes Ta Yes Ta \&No
.It Ic while Ta \&No Ta Yes Ta \&No
.El
.Sh SEE ALSO
.Xr csh 1 ,
.Xr echo 1 ,
.Xr kill 1 ,
.Xr login 1 ,
.Xr nice 1 ,
.Xr nohup 1 ,
.Xr printf 1 ,
.Xr pwd 1 ,
.Xr sh 1 ,
.Xr time 1 ,
.Xr which 1
.Sh HISTORY
The
.Nm
manual page first appeared in
.Fx 4.0 .
.Sh AUTHORS
This manual page was written by
.An Sheldon Hearn Aq sheldonh@FreeBSD.org .

98
share/man/man1/cd.1
View file

@ -1,98 +0,0 @@
.\" Copyright (c) 1980, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)cd.1 8.1 (Berkeley) 6/5/93
.\" $FreeBSD$
.\"
.Dd June 5, 1993
.Dt CD 1
.Os BSD 4
.Sh NAME
.Nm cd
.Nd change working directory
.Sh SYNOPSIS
.Nm cd
.Ar directory
.Sh DESCRIPTION
.Ar Directory
is an absolute or relative pathname which becomes the new working
directory.
The interpretation of a relative pathname by cd depends on the CDPATH
environment variable (see below).
.Sh ENVIRONMENT
The following environment variables affect the execution of cd:
.Pp
.Bl -tag -width indent
.It Ev CDPATH
If the
.Ar directory
operand does not begin with a slash (/) character, and the first
component is not dot (.) or dot-dot (..),
.Nm cd
searches for the directory relative to each directory named in the
.Ev CDPATH
variable, in the order listed.
The new working directory is set to the first matching directory found.
An empty string in place of a directory pathname represents the current
directory.
If the new working directory was derived from
.Ev CDPATH ,
it will be printed to the standard output.
.It Ev HOME
If
.Nm cd
is invoked without arguments and the
.Ev HOME
environment variable exists and contains a directory name, that directory
becomes the new working directory.
.El
.Pp
See
.Xr csh 1
for more information on environment variables.
.Pp
The
.Nm cd
utility exits 0 on success, and >0 if an error occurs.
.Sh SEE ALSO
.Xr csh 1 ,
.Xr pwd 1 ,
.Xr sh 1 ,
.Xr chdir 2
.Sh STANDARDS
The
.Nm cd
command is expected to be
.St -p1003.2
compatible.

13
usr.bin/login/login.1
View file

@ -143,13 +143,12 @@ The login class also controls the maximum and current process resource
limits granted to a login, process priorities and many other aspects of
a user's login environment.
.Pp
The standard shells,
.Xr csh 1
and
.Xr sh 1 ,
do not fork before executing the
Some shells may provide a builtin
.Nm
utility.
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh FILES
.Bl -tag -width /var/mail/userXXX -compact
.It Pa /etc/fbtab
@ -180,7 +179,9 @@ makes login quieter
configure authentication services
.El
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr chpass 1 ,
.Xr csh 1 ,
.Xr passwd 1 ,
.Xr rlogin 1 ,
.Xr skey 1 ,

26
usr.bin/nice/nice.1
View file

@ -73,6 +73,13 @@ Negative numbers are expressed as
The returned exit status is the exit value from the
command executed by
.Nm nice .
.Pp
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh EXAMPLES
.Pp
$ nice -5 date
@ -89,6 +96,7 @@ Execute command
at priority -19 assuming the priority of the
shell is 0 and you are the super-user.
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr idprio 1 ,
.Xr rtprio 1 ,
@ -100,21 +108,3 @@ A
.Nm
command appeared in
.At v6 .
.Sh BUGS
.Nm Nice
is particular to
.Xr sh 1 .
If you use
.Xr csh 1 ,
then commands executed with ``&'' are automatically immune to hangup
signals while in the background.
.Pp
.Nm Nice
is built into
.Xr csh 1
with a slightly different syntax than described here. The form
.Ql nice +10
nices to positive nice, and
.Ql nice \-10
can be used
by the super-user to give a process more of the processor.

9
usr.bin/nohup/nohup.1
View file

@ -68,6 +68,13 @@ as the standard output.
.Nm Nohup
exits 1 if an error occurs, otherwise the exit status is that of
.Ar command .
.Pp
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh ENVIRONMENT
The following variable is utilized by
.Nm nohup .
@ -82,6 +89,8 @@ utility uses the directory named by
to create the file.
.El
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr signal 3
.Sh STANDARDS
The

12
usr.bin/printf/printf.1
View file

@ -250,11 +250,21 @@ Print a `%'; no argument is used.
In no case does a non-existent or small field width cause truncation of
a field; padding takes place only if the specified field width exceeds
the actual width.
.Pp
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh RETURN VALUES
.Nm Printf
exits 0 on success, 1 on failure.
.Sh SEE ALSO
.Xr printf 3
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr printf 3 ,
.Xr sh 1
.Sh HISTORY
The
.Nm

15
usr.bin/time/time.1
View file

@ -90,14 +90,12 @@ Makes
output POSIX.2 compliant (each time is printed on its own line).
.El
.Pp
Most shells (including
.Xr csh 1 )
have their own and syntactically different builtin version of
.Nm time .
The command described here
is available as
.Pa /usr/bin/time
to users of those shells.
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh DIAGNOSTICS
If
.Ar command
@ -115,6 +113,7 @@ If
encounters any other error, the exit status is between 1 and 125
included.
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr getrusage 2 ,
.Xr wait 2

9
usr.bin/which/which.1
View file

@ -52,12 +52,21 @@ of each).
.It Fl s
No output, just return 0 if any of the executables are found, or 1 if
none are found.
.Pp
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility. Consult
the
.Xr builtin 1
manual page.
.Sh HISTORY
The
.Nm
command first appeared in
.Fx 2.1 .
.Sh SEE ALSO
.Xr builtin 1 ,
.Xr csh 1 ,
.Xr find 1 ,
.Xr locate 1 ,
.Xr perl 1 ,