share/man/man1/builtin.1

   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: src/share/man/man1/builtin.1,v 1.5.2.11 2001/12/15 10:05:19 knu Exp $
  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 false ,
  64 .Nm fc ,
  65 .Nm fg ,
  66 .Nm filetest ,
  67 .Nm fi ,
  68 .Nm for ,
  69 .Nm foreach ,
  70 .Nm getopts ,
  71 .Nm glob ,
  72 .Nm goto ,
  73 .Nm hash ,
  74 .Nm hashstat ,
  75 .Nm history ,
  76 .Nm hup ,
  77 .Nm if ,
  78 .Nm jobid ,
  79 .Nm jobs ,
  80 .Nm kill ,
  81 .Nm limit ,
  82 .Nm log ,
  83 .Nm login ,
  84 .Nm logout ,
  85 .Nm ls-F ,
  86 .Nm nice ,
  87 .Nm nohup ,
  88 .Nm notify ,
  89 .Nm onintr ,
  90 .Nm popd ,
  91 .Nm printenv ,
  92 .Nm printf ,
  93 .Nm pushd ,
  94 .Nm pwd ,
  95 .Nm read ,
  96 .Nm readonly ,
  97 .Nm rehash ,
  98 .Nm repeat ,
  99 .Nm sched ,
 100 .Nm set ,
 101 .Nm setenv ,
 102 .Nm settc ,
 103 .Nm setty ,
 104 .Nm setvar ,
 105 .Nm shift ,
 106 .Nm source ,
 107 .Nm stop ,
 108 .Nm suspend ,
 109 .Nm switch ,
 110 .Nm telltc ,
 111 .Nm test ,
 112 .Nm then ,
 113 .Nm time ,
 114 .Nm trap ,
 115 .Nm true ,
 116 .Nm type ,
 117 .Nm ulimit ,
 118 .Nm umask ,
 119 .Nm unalias ,
 120 .Nm uncomplete ,
 121 .Nm unhash ,
 122 .Nm unlimit ,
 123 .Nm unset ,
 124 .Nm unsetenv ,
 125 .Nm until ,
 126 .Nm wait ,
 127 .Nm where ,
 128 .Nm which ,
 129 .Nm while
 130 .Nd shell builtin commands
 131 .Sh SYNOPSIS
 132 .Nm
 133 .Op Fl options
 134 .Op Ar args ...
 135 .Sh DESCRIPTION
 136 Shell builtin commands are commands that can be executed within the
 137 running shell's process.
 138 Note that, in the case of
 139 .Xr csh 1
 140 builtin commands, the command is executed in a subshell if it occurs as
 141 any component of a pipeline except the last.
 142 .Pp
 143 If a command specified to the shell contains a slash
 144 .Dq \&/ ,
 145 the shell will not execute a builtin command, even if the last component
 146 of the specified command matches the name of a builtin command.
 147 Thus, while specifying
 148 .Dq Ic echo
 149 causes a builtin command to be executed under shells that support the
 150 builtin echo command,
 151 specifying
 152 .Dq Pa /bin/echo
 153 or
 154 .Dq Pa ./echo
 155 does not.
 156 .Pp
 157 While some builtin commands may exist in more than one shell, their
 158 operation may be different under each shell which supports them.
 159 Below is a table which lists shell builtin commands, the standard shells
 160 that support them and whether they exist as standalone utilities.
 161 .Pp
 162 Only builtin commands for the
 163 .Xr csh 1
 164 and
 165 .Xr sh 1
 166 shells are listed here.
 167 Consult the appropriate manual page for
 168 details on the operation of any given builtin command under those shells.
 169 Users of other shells will need to consult the documentation supplied
 170 with the other shells.
 171 .Bl -column ".Ic uncomplete" ".Em External" ".Xr csh 1" ".Xr sh 1" -offset indent
 172 .It Xo
 173 .Em "Command    External" Ta Xr csh 1 Ta Xr sh 1
 174 .Xc
 175 .It Ic alias Ta \&No Ta Yes Ta Yes
 176 .It Ic alloc Ta \&No Ta Yes Ta \&No
 177 .It Ic bg Ta \&No Ta Yes Ta Yes
 178 .It Ic bindkey Ta \&No Ta Yes Ta \&No
 179 .It Ic break Ta \&No Ta Yes Ta \&Yes
 180 .It Ic breaksw Ta \&No Ta Yes Ta \&No
 181 .It Ic builtins Ta \&No Ta Yes Ta \&No
 182 .It Ic case Ta \&No Ta Yes Ta Yes
 183 .It Ic cd Ta \&No Ta Yes Ta Yes
 184 .It Ic chdir Ta \&No Ta Yes Ta \&Yes
 185 .It Ic command Ta \&No Ta \&No Ta Yes
 186 .It Ic complete Ta \&No Ta Yes Ta \&No
 187 .It Ic continue Ta \&No Ta Yes Ta \&Yes
 188 .It Ic default Ta \&No Ta Yes Ta \&No
 189 .It Ic dirs Ta \&No Ta Yes Ta \&No
 190 .It Ic do Ta \&No Ta \&No Ta Yes
 191 .It Ic done Ta \&No Ta \&No Ta Yes
 192 .It Ic echo Ta Yes Ta Yes Ta Yes
 193 .It Ic echotc Ta \&No Ta Yes Ta \&No
 194 .It Ic elif Ta \&No Ta \&No Ta Yes
 195 .It Ic else Ta \&No Ta Yes Ta \&Yes
 196 .It Ic end Ta \&No Ta Yes Ta \&No
 197 .It Ic endif Ta \&No Ta Yes Ta \&No
 198 .It Ic endsw Ta \&No Ta Yes Ta \&No
 199 .It Ic esac Ta \&No Ta \&No Ta Yes
 200 .It Ic eval Ta \&No Ta Yes Ta Yes
 201 .It Ic exec Ta \&No Ta Yes Ta Yes
 202 .It Ic exit Ta \&No Ta Yes Ta Yes
 203 .It Ic export Ta \&No Ta \&No Ta Yes
 204 .It Ic false Ta Yes Ta \&No Ta Yes
 205 .It Ic fc Ta \&No Ta \&No Ta Yes
 206 .It Ic fg Ta \&No Ta Yes Ta Yes
 207 .It Ic filetest Ta \&No Ta Yes Ta \&No
 208 .It Ic fi Ta \&No Ta \&No Ta Yes
 209 .It Ic for Ta \&No Ta \&No Ta Yes
 210 .It Ic foreach Ta \&No Ta Yes Ta \&No
 211 .It Ic getopts Ta \&No Ta \&No Ta Yes
 212 .It Ic glob Ta \&No Ta Yes Ta \&No
 213 .It Ic goto Ta \&No Ta Yes Ta \&No
 214 .It Ic hash Ta \&No Ta \&No Ta Yes
 215 .It Ic hashstat Ta \&No Ta Yes Ta \&No
 216 .It Ic history Ta \&No Ta Yes Ta \&No
 217 .It Ic hup Ta \&No Ta Yes Ta \&No
 218 .It Ic if Ta \&No Ta Yes Ta \&Yes
 219 .It Ic jobid Ta \&No Ta \&No Ta Yes
 220 .It Ic jobs Ta \&No Ta Yes Ta Yes
 221 .It Ic kill Ta Yes Ta Yes Ta \&No
 222 .It Ic limit Ta \&No Ta Yes Ta \&No
 223 .It Ic log Ta \&No Ta Yes Ta \&No
 224 .It Ic login Ta Yes Ta Yes Ta \&No
 225 .It Ic logout Ta \&No Ta Yes Ta \&No
 226 .It Ic ls-F Ta \&No Ta Yes Ta \&No
 227 .It Ic nice Ta Yes Ta Yes Ta \&No
 228 .It Ic nohup Ta Yes Ta Yes Ta \&No
 229 .It Ic notify Ta \&No Ta Yes Ta \&No
 230 .It Ic onintr Ta \&No Ta Yes Ta \&No
 231 .It Ic popd Ta \&No Ta Yes Ta \&No
 232 .It Ic printenv Ta Yes Ta Yes Ta \&No
 233 .It Ic printf Ta Yes Ta \&No Ta Yes
 234 .It Ic pushd Ta \&No Ta Yes Ta \&No
 235 .It Ic pwd Ta Yes Ta \&No Ta Yes
 236 .It Ic read Ta \&No Ta \&No Ta Yes
 237 .It Ic readonly Ta \&No Ta \&No Ta Yes
 238 .It Ic rehash Ta \&No Ta Yes Ta \&No
 239 .It Ic repeat Ta \&No Ta Yes Ta \&No
 240 .It Ic sched Ta \&No Ta Yes Ta \&No
 241 .It Ic set Ta \&No Ta Yes Ta \&Yes
 242 .It Ic setenv Ta \&No Ta Yes Ta \&No
 243 .It Ic settc Ta \&No Ta Yes Ta \&No
 244 .It Ic setty Ta \&No Ta Yes Ta \&No
 245 .It Ic setvar Ta \&No Ta \&No Ta Yes
 246 .It Ic shift Ta \&No Ta Yes Ta Yes
 247 .It Ic source Ta \&No Ta Yes Ta \&No
 248 .It Ic stop Ta \&No Ta Yes Ta \&No
 249 .It Ic suspend Ta \&No Ta Yes Ta \&No
 250 .It Ic switch Ta \&No Ta Yes Ta \&No
 251 .It Ic telltc Ta \&No Ta Yes Ta \&No
 252 .It Ic test Ta Yes Ta \&No Ta Yes
 253 .It Ic then Ta \&No Ta \&No Ta Yes
 254 .It Ic time Ta Yes Ta Yes Ta \&No
 255 .It Ic trap Ta \&No Ta \&No Ta Yes
 256 .It Ic true Ta Yes Ta \&No Ta Yes
 257 .It Ic type Ta \&No Ta \&No Ta Yes
 258 .It Ic ulimit Ta \&No Ta \&No Ta Yes
 259 .It Ic umask Ta \&No Ta Yes Ta Yes
 260 .It Ic unalias Ta \&No Ta Yes Ta Yes
 261 .It Ic uncomplete Ta \&No Ta Yes Ta \&No
 262 .It Ic unhash Ta \&No Ta Yes Ta \&No
 263 .It Ic unlimit Ta \&No Ta Yes Ta \&No
 264 .It Ic unset Ta \&No Ta Yes Ta Yes
 265 .It Ic unsetenv Ta \&No Ta Yes Ta \&No
 266 .It Ic until Ta \&No Ta \&No Ta Yes
 267 .It Ic wait Ta \&No Ta Yes Ta Yes
 268 .It Ic where Ta \&No Ta Yes Ta \&No
 269 .It Ic which Ta Yes Ta Yes Ta \&No
 270 .It Ic while Ta \&No Ta Yes Ta \&Yes
 271 .El
 272 .Sh SEE ALSO
 273 .Xr csh 1 ,
 274 .Xr echo 1 ,
 275 .Xr false 1 ,
 276 .Xr kill 1 ,
 277 .Xr login 1 ,
 278 .Xr nice 1 ,
 279 .Xr nohup 1 ,
 280 .Xr printenv 1 ,
 281 .Xr printf 1 ,
 282 .Xr pwd 1 ,
 283 .Xr sh 1 ,
 284 .Xr test 1 ,
 285 .Xr time 1 ,
 286 .Xr true 1 ,
 287 .Xr which 1
 288 .Sh HISTORY
 289 The
 290 .Nm
 291 manual page first appeared in
 292 .Fx 3.4 .
 293 .Sh AUTHORS
 294 This manual page was written by
 295 .An Sheldon Hearn Aq sheldonh@FreeBSD.org .