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.Dd December 21, 2010 28.Dt BUILTIN 1 29.Os 30.Sh NAME 31.Nm builtin , 32.Nm \&! , 33.Nm % , 34.Nm \&. , 35.Nm \&: , 36.Nm @ , 37.Nm \&[ , 38.Nm { , 39.Nm } , 40.Nm alias , 41.Nm alloc , 42.Nm bg , 43.Nm bind , 44.Nm bindkey , 45.Nm break , 46.Nm breaksw , 47.Nm builtins , 48.Nm case , 49.Nm cd , 50.Nm chdir , 51.Nm command , 52.Nm complete , 53.Nm continue , 54.Nm default , 55.Nm dirs , 56.Nm do , 57.Nm done , 58.Nm echo , 59.Nm echotc , 60.Nm elif , 61.Nm else , 62.Nm end , 63.Nm endif , 64.Nm endsw , 65.Nm esac , 66.Nm eval , 67.Nm exec , 68.Nm exit , 69.Nm export , 70.Nm false , 71.Nm fc , 72.Nm fg , 73.Nm filetest , 74.Nm fi , 75.Nm for , 76.Nm foreach , 77.Nm getopts , 78.Nm glob , 79.Nm goto , 80.Nm hash , 81.Nm hashstat , 82.Nm history , 83.Nm hup , 84.Nm if , 85.Nm jobid , 86.Nm jobs , 87.Nm kill , 88.Nm limit , 89.Nm local , 90.Nm log , 91.Nm login , 92.Nm logout , 93.Nm ls-F , 94.Nm nice , 95.Nm nohup , 96.Nm notify , 97.Nm onintr , 98.Nm popd , 99.Nm printenv , 100.Nm printf , 101.Nm pushd , 102.Nm pwd , 103.Nm read , 104.Nm readonly , 105.Nm rehash , 106.Nm repeat , 107.Nm return , 108.Nm sched , 109.Nm set , 110.Nm setenv , 111.Nm settc , 112.Nm setty , 113.Nm setvar , 114.Nm shift , 115.Nm source , 116.Nm stop , 117.Nm suspend , 118.Nm switch , 119.Nm telltc , 120.Nm test , 121.Nm then , 122.Nm time , 123.Nm times , 124.Nm trap , 125.Nm true , 126.Nm type , 127.Nm ulimit , 128.Nm umask , 129.Nm unalias , 130.Nm uncomplete , 131.Nm unhash , 132.Nm unlimit , 133.Nm unset , 134.Nm unsetenv , 135.Nm until , 136.Nm wait , 137.Nm where , 138.Nm which , 139.Nm while 140.Nd shell built-in commands 141.Sh SYNOPSIS 142See the built-in command description in the appropriate shell manual page. 143.Sh DESCRIPTION 144Shell builtin commands are commands that can be executed within the 145running shell's process. 146Note that, in the case of 147.Xr csh 1 148builtin commands, the command is executed in a subshell if it occurs as 149any component of a pipeline except the last. 150.Pp 151If a command specified to the shell contains a slash 152.Ql / , 153the shell will not execute a builtin command, even if the last component 154of the specified command matches the name of a builtin command. 155Thus, while specifying 156.Dq Li echo 157causes a builtin command to be executed under shells that support the 158.Nm echo 159builtin command, 160specifying 161.Dq Li /bin/echo 162or 163.Dq Li ./echo 164does not. 165.Pp 166While some builtin commands may exist in more than one shell, their 167operation may be different under each shell which supports them. 168Below is a table which lists shell builtin commands, the standard shells 169that support them and whether they exist as standalone utilities. 170.Pp 171Only builtin commands for the 172.Xr csh 1 173and 174.Xr sh 1 175shells are listed here. 176Consult a shell's manual page for 177details on the operation its builtin commands. 178Beware that the 179.Xr sh 1 180manual page, at least, calls some of these commands 181.Dq built-in commands 182and some of them 183.Dq reserved words . 184Users of other shells may need to consult an 185.Xr info 1 186page or other sources of documentation. 187.Pp 188Commands marked 189.Dq Li No** 190under 191.Em External 192do exist externally, 193but are implemented as scripts using a builtin command of the same name. 194.Bl -column ".Ic uncomplete" ".Em External" ".Xr csh 1" ".Xr sh 1" -offset indent 195.It Em Command Ta Em External Ta Xr csh 1 Ta Xr sh 1 196.It Ic \&! Ta \&No Ta \&No Ta Yes 197.It Ic % Ta \&No Ta Yes Ta \&No 198.It Ic \&. Ta \&No Ta \&No Ta Yes 199.It Ic \&: Ta \&No Ta Yes Ta Yes 200.It Ic @ Ta \&No Ta Yes Ta \&No 201.It Ic \&[ Ta Yes Ta \&No Ta Yes 202.It Ic { Ta \&No Ta \&No Ta Yes 203.It Ic } Ta \&No Ta \&No Ta Yes 204.It Ic alias Ta No** Ta Yes Ta Yes 205.It Ic alloc Ta \&No Ta Yes Ta \&No 206.It Ic bg Ta No** Ta Yes Ta Yes 207.It Ic bind Ta \&No Ta \&No Ta Yes 208.It Ic bindkey Ta \&No Ta Yes Ta \&No 209.It Ic break Ta \&No Ta Yes Ta Yes 210.It Ic breaksw Ta \&No Ta Yes Ta \&No 211.It Ic builtin Ta \&No Ta \&No Ta Yes 212.It Ic builtins Ta \&No Ta Yes Ta \&No 213.It Ic case Ta \&No Ta Yes Ta Yes 214.It Ic cd Ta No** Ta Yes Ta Yes 215.It Ic chdir Ta \&No Ta Yes Ta Yes 216.It Ic command Ta No** Ta \&No Ta Yes 217.It Ic complete Ta \&No Ta Yes Ta \&No 218.It Ic continue Ta \&No Ta Yes Ta Yes 219.It Ic default Ta \&No Ta Yes Ta \&No 220.It Ic dirs Ta \&No Ta Yes Ta \&No 221.It Ic do Ta \&No Ta \&No Ta Yes 222.It Ic done Ta \&No Ta \&No Ta Yes 223.It Ic echo Ta Yes Ta Yes Ta Yes 224.It Ic echotc Ta \&No Ta Yes Ta \&No 225.It Ic elif Ta \&No Ta \&No Ta Yes 226.It Ic else Ta \&No Ta Yes Ta Yes 227.It Ic end Ta \&No Ta Yes Ta \&No 228.It Ic endif Ta \&No Ta Yes Ta \&No 229.It Ic endsw Ta \&No Ta Yes Ta \&No 230.It Ic esac Ta \&No Ta \&No Ta Yes 231.It Ic eval Ta \&No Ta Yes Ta Yes 232.It Ic exec Ta \&No Ta Yes Ta Yes 233.It Ic exit Ta \&No Ta Yes Ta Yes 234.It Ic export Ta \&No Ta \&No Ta Yes 235.It Ic false Ta Yes Ta \&No Ta Yes 236.It Ic fc Ta No** Ta \&No Ta Yes 237.It Ic fg Ta No** Ta Yes Ta Yes 238.It Ic filetest Ta \&No Ta Yes Ta \&No 239.It Ic fi Ta \&No Ta \&No Ta Yes 240.It Ic for Ta \&No Ta \&No Ta Yes 241.It Ic foreach Ta \&No Ta Yes Ta \&No 242.It Ic getopts Ta No** Ta \&No Ta Yes 243.It Ic glob Ta \&No Ta Yes Ta \&No 244.It Ic goto Ta \&No Ta Yes Ta \&No 245.It Ic hash Ta No** Ta \&No Ta Yes 246.It Ic hashstat Ta \&No Ta Yes Ta \&No 247.It Ic history Ta \&No Ta Yes Ta \&No 248.It Ic hup Ta \&No Ta Yes Ta \&No 249.It Ic if Ta \&No Ta Yes Ta Yes 250.It Ic jobid Ta \&No Ta \&No Ta Yes 251.It Ic jobs Ta No** Ta Yes Ta Yes 252.It Ic kill Ta Yes Ta Yes Ta Yes 253.It Ic limit Ta \&No Ta Yes Ta \&No 254.It Ic local Ta \&No Ta \&No Ta Yes 255.It Ic log Ta \&No Ta Yes Ta \&No 256.It Ic login Ta Yes Ta Yes Ta \&No 257.It Ic logout Ta \&No Ta Yes Ta \&No 258.It Ic ls-F Ta \&No Ta Yes Ta \&No 259.It Ic nice Ta Yes Ta Yes Ta \&No 260.It Ic nohup Ta Yes Ta Yes Ta \&No 261.It Ic notify Ta \&No Ta Yes Ta \&No 262.It Ic onintr Ta \&No Ta Yes Ta \&No 263.It Ic popd Ta \&No Ta Yes Ta \&No 264.It Ic printenv Ta Yes Ta Yes Ta \&No 265.It Ic printf Ta Yes Ta \&No Ta Yes 266.It Ic pushd Ta \&No Ta Yes Ta \&No 267.It Ic pwd Ta Yes Ta \&No Ta Yes 268.It Ic read Ta No** Ta \&No Ta Yes 269.It Ic readonly Ta \&No Ta \&No Ta Yes 270.It Ic rehash Ta \&No Ta Yes Ta \&No 271.It Ic repeat Ta \&No Ta Yes Ta \&No 272.It Ic return Ta \&No Ta \&No Ta Yes 273.It Ic sched Ta \&No Ta Yes Ta \&No 274.It Ic set Ta \&No Ta Yes Ta Yes 275.It Ic setenv Ta \&No Ta Yes Ta \&No 276.It Ic settc Ta \&No Ta Yes Ta \&No 277.It Ic setty Ta \&No Ta Yes Ta \&No 278.It Ic setvar Ta \&No Ta \&No Ta Yes 279.It Ic shift Ta \&No Ta Yes Ta Yes 280.It Ic source Ta \&No Ta Yes Ta \&No 281.It Ic stop Ta \&No Ta Yes Ta \&No 282.It Ic suspend Ta \&No Ta Yes Ta \&No 283.It Ic switch Ta \&No Ta Yes Ta \&No 284.It Ic telltc Ta \&No Ta Yes Ta \&No 285.It Ic test Ta Yes Ta \&No Ta Yes 286.It Ic then Ta \&No Ta \&No Ta Yes 287.It Ic time Ta Yes Ta Yes Ta \&No 288.It Ic times Ta \&No Ta \&No Ta Yes 289.It Ic trap Ta \&No Ta \&No Ta Yes 290.It Ic true Ta Yes Ta \&No Ta Yes 291.It Ic type Ta No** Ta \&No Ta Yes 292.It Ic ulimit Ta No** Ta \&No Ta Yes 293.It Ic umask Ta No** Ta Yes Ta Yes 294.It Ic unalias Ta No** Ta Yes Ta Yes 295.It Ic uncomplete Ta \&No Ta Yes Ta \&No 296.It Ic unhash Ta \&No Ta Yes Ta \&No 297.It Ic unlimit Ta \&No Ta Yes Ta \&No 298.It Ic unset Ta \&No Ta Yes Ta Yes 299.It Ic unsetenv Ta \&No Ta Yes Ta \&No 300.It Ic until Ta \&No Ta \&No Ta Yes 301.It Ic wait Ta No** Ta Yes Ta Yes 302.It Ic where Ta \&No Ta Yes Ta \&No 303.It Ic which Ta Yes Ta Yes Ta \&No 304.It Ic while Ta \&No Ta Yes Ta Yes 305.El 306.Sh SEE ALSO 307.Xr csh 1 , 308.Xr echo 1 , 309.Xr false 1 , 310.Xr info 1 , 311.Xr kill 1 , 312.Xr login 1 , 313.Xr nice 1 , 314.Xr nohup 1 , 315.Xr printenv 1 , 316.Xr printf 1 , 317.Xr pwd 1 , 318.Xr sh 1 , 319.Xr test 1 , 320.Xr time 1 , 321.Xr true 1 , 322.Xr which 1 323.Sh HISTORY 324The 325.Nm 326manual page first appeared in 327.Fx 3.4 . 328.Sh AUTHORS 329This manual page was written by 330.An Sheldon Hearn Aq Mt sheldonh@FreeBSD.org . 331