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