xref: /freebsd/share/man/man1/builtin.1 (revision e6d3cf26485c2f3410273cda3d6e4c1b0d78e2a4)
1c644db6aSSheldon Hearn.\"
2c644db6aSSheldon Hearn.\" Copyright (c) 1999 Sheldon Hearn
3c644db6aSSheldon Hearn.\"
4c644db6aSSheldon Hearn.\" All rights reserved.
5c644db6aSSheldon Hearn.\"
6c644db6aSSheldon Hearn.\" Redistribution and use in source and binary forms, with or without
7c644db6aSSheldon Hearn.\" modification, are permitted provided that the following conditions
8c644db6aSSheldon Hearn.\" are met:
9c644db6aSSheldon Hearn.\" 1. Redistributions of source code must retain the above copyright
10c644db6aSSheldon Hearn.\"    notice, this list of conditions and the following disclaimer.
11c644db6aSSheldon Hearn.\" 2. Redistributions in binary form must reproduce the above copyright
12c644db6aSSheldon Hearn.\"    notice, this list of conditions and the following disclaimer in the
13c644db6aSSheldon Hearn.\"    documentation and/or other materials provided with the distribution.
14c644db6aSSheldon Hearn.\"
15c644db6aSSheldon Hearn.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16c644db6aSSheldon Hearn.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17c644db6aSSheldon Hearn.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18c644db6aSSheldon Hearn.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19c644db6aSSheldon Hearn.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20c644db6aSSheldon Hearn.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21c644db6aSSheldon Hearn.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22c644db6aSSheldon Hearn.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23c644db6aSSheldon Hearn.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24c644db6aSSheldon Hearn.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25c644db6aSSheldon Hearn.\" SUCH DAMAGE.
26c644db6aSSheldon Hearn.\"
27c644db6aSSheldon Hearn.\"	$FreeBSD$
28c644db6aSSheldon Hearn.\"
29c644db6aSSheldon Hearn.Dd September 1, 1999
30c644db6aSSheldon Hearn.Dt BUILTIN 1
31c644db6aSSheldon Hearn.Os
32c644db6aSSheldon Hearn.Sh NAME
33c644db6aSSheldon Hearn.Nm builtin ,
34c644db6aSSheldon Hearn.Nm alias ,
35c644db6aSSheldon Hearn.Nm alloc ,
36c644db6aSSheldon Hearn.Nm bg ,
37c644db6aSSheldon Hearn.Nm break ,
38c644db6aSSheldon Hearn.Nm breaksw ,
39c644db6aSSheldon Hearn.Nm case ,
40c644db6aSSheldon Hearn.Nm cd ,
41c644db6aSSheldon Hearn.Nm chdir ,
42c644db6aSSheldon Hearn.Nm command ,
43c644db6aSSheldon Hearn.Nm continue ,
44c644db6aSSheldon Hearn.Nm cwd ,
45c644db6aSSheldon Hearn.Nm default ,
46c644db6aSSheldon Hearn.Nm dirs ,
47c644db6aSSheldon Hearn.Nm do ,
48c644db6aSSheldon Hearn.Nm done ,
49c644db6aSSheldon Hearn.Nm echo ,
50c644db6aSSheldon Hearn.Nm elif ,
51c644db6aSSheldon Hearn.Nm else ,
52c644db6aSSheldon Hearn.Nm end ,
53c644db6aSSheldon Hearn.Nm endif ,
54c644db6aSSheldon Hearn.Nm endsw ,
55c644db6aSSheldon Hearn.Nm esac ,
56c644db6aSSheldon Hearn.Nm eval ,
57c644db6aSSheldon Hearn.Nm exec ,
58c644db6aSSheldon Hearn.Nm exit ,
59c644db6aSSheldon Hearn.Nm export ,
60c644db6aSSheldon Hearn.Nm fc ,
61c644db6aSSheldon Hearn.Nm fg ,
62c644db6aSSheldon Hearn.Nm fi ,
63c644db6aSSheldon Hearn.Nm for ,
64c644db6aSSheldon Hearn.Nm foreach ,
65c644db6aSSheldon Hearn.Nm getopts ,
66c644db6aSSheldon Hearn.Nm glob ,
67c644db6aSSheldon Hearn.Nm goto ,
68c644db6aSSheldon Hearn.Nm hash ,
69c644db6aSSheldon Hearn.Nm hashstat ,
70c644db6aSSheldon Hearn.Nm history ,
71c644db6aSSheldon Hearn.Nm if ,
72c644db6aSSheldon Hearn.Nm jobid ,
73c644db6aSSheldon Hearn.Nm jobs ,
74c644db6aSSheldon Hearn.Nm kill ,
75c644db6aSSheldon Hearn.Nm limit ,
76c644db6aSSheldon Hearn.Nm login ,
77c644db6aSSheldon Hearn.Nm logout ,
78c644db6aSSheldon Hearn.Nm nice ,
79c644db6aSSheldon Hearn.Nm nohup ,
80c644db6aSSheldon Hearn.Nm notify ,
81c644db6aSSheldon Hearn.Nm onintr ,
82c644db6aSSheldon Hearn.Nm popd ,
83c644db6aSSheldon Hearn.Nm printf ,
84c644db6aSSheldon Hearn.Nm pushd ,
85c644db6aSSheldon Hearn.Nm pwd ,
86c644db6aSSheldon Hearn.Nm readonly ,
87c644db6aSSheldon Hearn.Nm rehash ,
88c644db6aSSheldon Hearn.Nm repeat ,
89c644db6aSSheldon Hearn.Nm set ,
90c644db6aSSheldon Hearn.Nm setenv ,
91c644db6aSSheldon Hearn.Nm setvar ,
92c644db6aSSheldon Hearn.Nm shift ,
93c644db6aSSheldon Hearn.Nm source ,
94c644db6aSSheldon Hearn.Nm stop ,
95c644db6aSSheldon Hearn.Nm suspend ,
96c644db6aSSheldon Hearn.Nm switch ,
97c644db6aSSheldon Hearn.Nm then ,
98c644db6aSSheldon Hearn.Nm time ,
99c644db6aSSheldon Hearn.Nm trap ,
100c644db6aSSheldon Hearn.Nm type ,
101c644db6aSSheldon Hearn.Nm ulimit ,
102c644db6aSSheldon Hearn.Nm umask ,
103c644db6aSSheldon Hearn.Nm unalias ,
104c644db6aSSheldon Hearn.Nm unhash ,
105c644db6aSSheldon Hearn.Nm unlimit ,
106c644db6aSSheldon Hearn.Nm unset ,
107c644db6aSSheldon Hearn.Nm unsetenv ,
108c644db6aSSheldon Hearn.Nm until ,
109c644db6aSSheldon Hearn.Nm wait ,
110c644db6aSSheldon Hearn.Nm which ,
111c644db6aSSheldon Hearn.Nm while
112c644db6aSSheldon Hearn.Nd shell builtin commands
113c644db6aSSheldon Hearn.Sh SYNOPSIS
114c644db6aSSheldon Hearn.Nm builtin
115c644db6aSSheldon Hearn.Op Fl options
116c644db6aSSheldon Hearn.Op Ar args ...
117c644db6aSSheldon Hearn.Sh DESCRIPTION
118c644db6aSSheldon HearnShell builtin commands are commands that can be executed within the
119c644db6aSSheldon Hearnrunning shell's process.
120c644db6aSSheldon HearnNote that, in the case of
121c644db6aSSheldon Hearn.Xr csh 1
122c644db6aSSheldon Hearnbuiltin commands, the command is executed in a subshell if it occurs as
123c644db6aSSheldon Hearnany component of a pipeline except the last.
124c644db6aSSheldon Hearn.Pp
125c644db6aSSheldon HearnIf a command specified to the shell contains a slash
126c644db6aSSheldon Hearn.Dq \&/ ,
127c644db6aSSheldon Hearnthe shell will not execute a builtin command, even if the last component
128e6d3cf26SSheldon Hearnof the specified command matches the name of a builtin command.
129e6d3cf26SSheldon HearnThus, while specifying
130c644db6aSSheldon Hearn.Dq Ic echo
131c644db6aSSheldon Hearncauses a builtin command to be executed under shells that support the
132c644db6aSSheldon Hearnbuiltin echo command,
133c644db6aSSheldon Hearnspecifying
134c644db6aSSheldon Hearn.Dq Pa /bin/echo
135c644db6aSSheldon Hearnor
136c644db6aSSheldon Hearn.Dq Pa ./echo
137c644db6aSSheldon Hearndoes not.
138c644db6aSSheldon Hearn.Pp
139c644db6aSSheldon HearnWhile some builtin commands may exist in more than one shell, their
140c644db6aSSheldon Hearnoperation may be different under each shell which supports them.
141c644db6aSSheldon HearnBelow is a table which lists shell builtin commands, the standard shells
142c644db6aSSheldon Hearnthat support them and whether they exist as standalone utilities.
143c644db6aSSheldon Hearn.Pp
144c644db6aSSheldon HearnOnly builtin commands for the
145c644db6aSSheldon Hearn.Xr csh 1
146c644db6aSSheldon Hearnand
147c644db6aSSheldon Hearn.Xr sh 1
148e6d3cf26SSheldon Hearnshells are listed here.
149e6d3cf26SSheldon HearnConsult the appropriate manual page for
150c644db6aSSheldon Hearndetails on the operation of any given builtin command under those shells.
151c644db6aSSheldon HearnUsers of other shells will need to consult the documentation supplied
152c644db6aSSheldon Hearnwith the other shells.
153c644db6aSSheldon Hearn.Bl -column "continueXX" "ExternalXX" "csh(1)" "sh(1)" -offset indent
154c644db6aSSheldon Hearn.\"
155c644db6aSSheldon Hearn.\" XXX:
156c644db6aSSheldon Hearn.\" The correct table header here can not be rendered with mdoc's current
157c644db6aSSheldon Hearn.\" argument maximum.  When mdoc can handle sufficient arguments, the
158c644db6aSSheldon Hearn.\" correct table header will be as follows:
159c644db6aSSheldon Hearn.\" .It Em Command Ta Em External Ta Xr csh 1 Ta Xr sh 1
160c644db6aSSheldon Hearn.\"
161c644db6aSSheldon Hearn.It Em Command	External	csh	sh
162c644db6aSSheldon Hearn.It Ic alias Ta \&No Ta Yes Ta Yes
163c644db6aSSheldon Hearn.It Ic alloc Ta \&No Ta Yes Ta \&No
164c644db6aSSheldon Hearn.It Ic bg Ta \&No Ta Yes Ta Yes
165c644db6aSSheldon Hearn.It Ic break Ta \&No Ta Yes Ta \&No
166c644db6aSSheldon Hearn.It Ic breaksw Ta \&No Ta Yes Ta \&No
167c644db6aSSheldon Hearn.It Ic case Ta \&No Ta Yes Ta Yes
168c644db6aSSheldon Hearn.It Ic cd Ta \&No Ta Yes Ta Yes
169c644db6aSSheldon Hearn.It Ic chdir Ta \&No Ta Yes Ta \&No
170c644db6aSSheldon Hearn.It Ic command Ta \&No Ta \&No Ta Yes
171c644db6aSSheldon Hearn.It Ic continue Ta \&No Ta Yes Ta \&No
172c644db6aSSheldon Hearn.It Ic cwd Ta \&No Ta Yes Ta \&No
173c644db6aSSheldon Hearn.It Ic default Ta \&No Ta Yes Ta \&No
174c644db6aSSheldon Hearn.It Ic dirs Ta \&No Ta Yes Ta \&No
175c644db6aSSheldon Hearn.It Ic do Ta \&No Ta \&No Ta Yes
176c644db6aSSheldon Hearn.It Ic done Ta \&No Ta \&No Ta Yes
177c644db6aSSheldon Hearn.It Ic echo Ta Yes Ta Yes Ta Yes
178c644db6aSSheldon Hearn.It Ic elif Ta \&No Ta \&No Ta Yes
179c644db6aSSheldon Hearn.It Ic else Ta \&No Ta Yes Ta \&No
180c644db6aSSheldon Hearn.It Ic end Ta \&No Ta Yes Ta \&No
181c644db6aSSheldon Hearn.It Ic endif Ta \&No Ta Yes Ta \&No
182c644db6aSSheldon Hearn.It Ic endsw Ta \&No Ta Yes Ta \&No
183c644db6aSSheldon Hearn.It Ic esac Ta \&No Ta \&No Ta Yes
184c644db6aSSheldon Hearn.It Ic eval Ta \&No Ta Yes Ta Yes
185c644db6aSSheldon Hearn.It Ic exec Ta \&No Ta Yes Ta Yes
186c644db6aSSheldon Hearn.It Ic exit Ta \&No Ta Yes Ta Yes
187c644db6aSSheldon Hearn.It Ic export Ta \&No Ta \&No Ta Yes
188c644db6aSSheldon Hearn.It Ic fc Ta \&No Ta \&No Ta Yes
189c644db6aSSheldon Hearn.It Ic fg Ta \&No Ta Yes Ta Yes
190c644db6aSSheldon Hearn.It Ic fi Ta \&No Ta \&No Ta Yes
191c644db6aSSheldon Hearn.It Ic for Ta \&No Ta \&No Ta Yes
192c644db6aSSheldon Hearn.It Ic foreach Ta \&No Ta Yes Ta \&No
193c644db6aSSheldon Hearn.It Ic getopts Ta \&No Ta \&No Ta Yes
194c644db6aSSheldon Hearn.It Ic glob Ta \&No Ta Yes Ta \&No
195c644db6aSSheldon Hearn.It Ic goto Ta \&No Ta Yes Ta \&No
196c644db6aSSheldon Hearn.It Ic hash Ta \&No Ta \&No Ta Yes
197c644db6aSSheldon Hearn.It Ic hashstat Ta \&No Ta Yes Ta \&No
198c644db6aSSheldon Hearn.It Ic history Ta \&No Ta Yes Ta \&No
199c644db6aSSheldon Hearn.It Ic if Ta \&No Ta Yes Ta \&No
200c644db6aSSheldon Hearn.It Ic jobid Ta \&No Ta \&No Ta Yes
201c644db6aSSheldon Hearn.It Ic jobs Ta \&No Ta Yes Ta Yes
202c644db6aSSheldon Hearn.It Ic kill Ta Yes Ta Yes Ta \&No
203c644db6aSSheldon Hearn.It Ic limit Ta \&No Ta Yes Ta \&No
204c644db6aSSheldon Hearn.It Ic login Ta Yes Ta Yes Ta \&No
205c644db6aSSheldon Hearn.It Ic logout Ta \&No Ta Yes Ta \&No
206c644db6aSSheldon Hearn.It Ic nice Ta Yes Ta Yes Ta \&No
207c644db6aSSheldon Hearn.It Ic nohup Ta Yes Ta Yes Ta \&No
208c644db6aSSheldon Hearn.It Ic notify Ta \&No Ta Yes Ta \&No
209c644db6aSSheldon Hearn.It Ic onintr Ta \&No Ta Yes Ta \&No
210c644db6aSSheldon Hearn.It Ic popd Ta \&No Ta Yes Ta \&No
211c644db6aSSheldon Hearn.It Ic printf Ta Yes Ta Yes Ta Yes
212c644db6aSSheldon Hearn.It Ic pushd Ta \&No Ta Yes Ta \&No
213c644db6aSSheldon Hearn.It Ic pwd Ta Yes Ta \&No Ta Yes
214c644db6aSSheldon Hearn.It Ic readonly Ta \&No Ta \&No Ta Yes
215c644db6aSSheldon Hearn.It Ic rehash Ta \&No Ta Yes Ta \&No
216c644db6aSSheldon Hearn.It Ic repeat Ta \&No Ta Yes Ta \&No
217c644db6aSSheldon Hearn.It Ic set Ta \&No Ta Yes Ta \&No
218c644db6aSSheldon Hearn.It Ic setenv Ta \&No Ta Yes Ta \&No
219c644db6aSSheldon Hearn.It Ic setvar Ta \&No Ta \&No Ta Yes
220c644db6aSSheldon Hearn.It Ic shift Ta \&No Ta Yes Ta Yes
221c644db6aSSheldon Hearn.It Ic source Ta \&No Ta Yes Ta \&No
222c644db6aSSheldon Hearn.It Ic stop Ta \&No Ta Yes Ta \&No
223c644db6aSSheldon Hearn.It Ic suspend Ta \&No Ta Yes Ta \&No
224c644db6aSSheldon Hearn.It Ic switch Ta \&No Ta Yes Ta \&No
225c644db6aSSheldon Hearn.It Ic then Ta \&No Ta \&No Ta Yes
226c644db6aSSheldon Hearn.It Ic time Ta Yes Ta Yes Ta \&No
227c644db6aSSheldon Hearn.It Ic trap Ta \&No Ta \&No Ta Yes
228c644db6aSSheldon Hearn.It Ic type Ta \&No Ta \&No Ta Yes
229c644db6aSSheldon Hearn.It Ic ulimit Ta \&No Ta \&No Ta Yes
230c644db6aSSheldon Hearn.It Ic umask Ta \&No Ta Yes Ta Yes
231c644db6aSSheldon Hearn.It Ic unalias Ta \&No Ta Yes Ta Yes
232c644db6aSSheldon Hearn.It Ic unhash Ta \&No Ta Yes Ta \&No
233c644db6aSSheldon Hearn.It Ic unlimit Ta \&No Ta Yes Ta \&No
234c644db6aSSheldon Hearn.It Ic unset Ta \&No Ta Yes Ta Yes
235c644db6aSSheldon Hearn.It Ic unsetenv Ta \&No Ta Yes Ta \&No
236c644db6aSSheldon Hearn.It Ic until Ta \&No Ta \&No Ta Yes
237c644db6aSSheldon Hearn.It Ic wait Ta \&No Ta Yes Ta Yes
238c644db6aSSheldon Hearn.It Ic which Ta Yes Ta Yes Ta \&No
239c644db6aSSheldon Hearn.It Ic while Ta \&No Ta Yes Ta \&No
240c644db6aSSheldon Hearn.El
241c644db6aSSheldon Hearn.Sh SEE ALSO
242c644db6aSSheldon Hearn.Xr csh 1 ,
243c644db6aSSheldon Hearn.Xr echo 1 ,
244c644db6aSSheldon Hearn.Xr kill 1 ,
245c644db6aSSheldon Hearn.Xr login 1 ,
246c644db6aSSheldon Hearn.Xr nice 1 ,
247c644db6aSSheldon Hearn.Xr nohup 1 ,
248c644db6aSSheldon Hearn.Xr printf 1 ,
249c644db6aSSheldon Hearn.Xr pwd 1 ,
250c644db6aSSheldon Hearn.Xr sh 1 ,
251c644db6aSSheldon Hearn.Xr time 1 ,
252c644db6aSSheldon Hearn.Xr which 1
253c644db6aSSheldon Hearn.Sh HISTORY
254c644db6aSSheldon HearnThe
255c644db6aSSheldon Hearn.Nm
256c644db6aSSheldon Hearnmanual page first appeared in
257c644db6aSSheldon Hearn.Fx 4.0 .
258c644db6aSSheldon Hearn.Sh AUTHORS
259c644db6aSSheldon HearnThis manual page was written by
260c644db6aSSheldon Hearn.An Sheldon Hearn Aq sheldonh@FreeBSD.org .
261