]> CyberLeo.Net >> Repos - FreeBSD/stable/8.git/blob - bin/sh/sh.1
MFC r308437 and r308461:
[FreeBSD/stable/8.git] / bin / sh / sh.1
1 .\"-
2 .\" Copyright (c) 1991, 1993
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\"
5 .\" This code is derived from software contributed to Berkeley by
6 .\" Kenneth Almquist.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     from: @(#)sh.1  8.6 (Berkeley) 5/4/95
33 .\" $FreeBSD$
34 .\"
35 .Dd November 5, 2011
36 .Dt SH 1
37 .Os
38 .Sh NAME
39 .Nm sh
40 .Nd command interpreter (shell)
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl /+abCEefIimnPpTuVvx
44 .Op Fl /+o Ar longname
45 .Oo
46 .Ar script
47 .Op Ar arg ...
48 .Oc
49 .Nm
50 .Op Fl /+abCEefIimnPpTuVvx
51 .Op Fl /+o Ar longname
52 .Fl c Ar string
53 .Oo
54 .Ar name
55 .Op Ar arg ...
56 .Oc
57 .Nm
58 .Op Fl /+abCEefIimnPpTuVvx
59 .Op Fl /+o Ar longname
60 .Fl s
61 .Op Ar arg ...
62 .Sh DESCRIPTION
63 The
64 .Nm
65 utility is the standard command interpreter for the system.
66 The current version of
67 .Nm
68 is in the process of being changed to
69 conform with the
70 .St -p1003.2
71 specification for the shell.
72 This version has many features which make
73 it appear
74 similar in some respects to the Korn shell, but it is not a Korn
75 shell clone like
76 .Nm pdksh .
77 Only features
78 designated by
79 .Tn POSIX ,
80 plus a few Berkeley extensions, are being
81 incorporated into this shell.
82 This man page is not intended to be a tutorial nor a complete
83 specification of the shell.
84 .Ss Overview
85 The shell is a command that reads lines from
86 either a file or the terminal, interprets them, and
87 generally executes other commands.
88 It is the program that is started when a user logs into the system,
89 although a user can select a different shell with the
90 .Xr chsh 1
91 command.
92 The shell
93 implements a language that has flow control constructs,
94 a macro facility that provides a variety of features in
95 addition to data storage, along with built-in history and line
96 editing capabilities.
97 It incorporates many features to
98 aid interactive use and has the advantage that the interpretative
99 language is common to both interactive and non-interactive
100 use (shell scripts).
101 That is, commands can be typed directly
102 to the running shell or can be put into a file,
103 which can be executed directly by the shell.
104 .Ss Invocation
105 .\"
106 .\" XXX This next sentence is incredibly confusing.
107 .\"
108 If no arguments are present and if the standard input of the shell
109 is connected to a terminal
110 (or if the
111 .Fl i
112 option is set),
113 the shell is considered an interactive shell.
114 An interactive shell
115 generally prompts before each command and handles programming
116 and command errors differently (as described below).
117 When first starting, the shell inspects argument 0, and
118 if it begins with a dash
119 .Pq Ql - ,
120 the shell is also considered a login shell.
121 This is normally done automatically by the system
122 when the user first logs in.
123 A login shell first reads commands
124 from the files
125 .Pa /etc/profile
126 and then
127 .Pa .profile
128 in a user's home directory,
129 if they exist.
130 If the environment variable
131 .Ev ENV
132 is set on entry to a shell, or is set in the
133 .Pa .profile
134 of a login shell, the shell then reads commands from the file named in
135 .Ev ENV .
136 Therefore, a user should place commands that are to be executed only
137 at login time in the
138 .Pa .profile
139 file, and commands that are executed for every shell inside the
140 .Ev ENV
141 file.
142 The user can set the
143 .Ev ENV
144 variable to some file by placing the following line in the file
145 .Pa .profile
146 in the home directory,
147 substituting for
148 .Pa .shinit
149 the filename desired:
150 .Pp
151 .Dl "ENV=$HOME/.shinit; export ENV"
152 .Pp
153 The first non-option argument specified on the command line
154 will be treated as the
155 name of a file from which to read commands (a shell script), and
156 the remaining arguments are set as the positional parameters
157 of the shell
158 .Li ( $1 , $2 ,
159 etc.).
160 Otherwise, the shell reads commands
161 from its standard input.
162 .Pp
163 Unlike older versions of
164 .Nm
165 the
166 .Ev ENV
167 script is only sourced on invocation of interactive shells.
168 This
169 closes a well-known, and sometimes easily exploitable security
170 hole related to poorly thought out
171 .Ev ENV
172 scripts.
173 .Ss Argument List Processing
174 All of the single letter options to
175 .Nm
176 have a corresponding long name,
177 with the exception of
178 .Fl c
179 and
180 .Fl /+o .
181 These long names are provided next to the single letter options
182 in the descriptions below.
183 The long name for an option may be specified as an argument to the
184 .Fl /+o
185 option of
186 .Nm .
187 Once the shell is running,
188 the long name for an option may be specified as an argument to the
189 .Fl /+o
190 option of the
191 .Ic set
192 built-in command
193 (described later in the section called
194 .Sx Built-in Commands ) .
195 Introducing an option with a dash
196 .Pq Ql -
197 enables the option,
198 while using a plus
199 .Pq Ql +
200 disables the option.
201 A
202 .Dq Li --
203 or plain
204 .Ql -
205 will stop option processing and will force the remaining
206 words on the command line to be treated as arguments.
207 The
208 .Fl /+o
209 and
210 .Fl c
211 options do not have long names.
212 They take arguments and are described after the single letter options.
213 .Bl -tag -width indent
214 .It Fl a Li allexport
215 Flag variables for export when assignments are made to them.
216 .It Fl b Li notify
217 Enable asynchronous notification of background job
218 completion.
219 (UNIMPLEMENTED)
220 .It Fl C Li noclobber
221 Do not overwrite existing files with
222 .Ql > .
223 .It Fl E Li emacs
224 Enable the built-in
225 .Xr emacs 1
226 command line editor (disables the
227 .Fl V
228 option if it has been set).
229 .It Fl e Li errexit
230 Exit immediately if any untested command fails in non-interactive mode.
231 The exit status of a command is considered to be
232 explicitly tested if the command is part of the list used to control
233 an
234 .Ic if , elif , while ,
235 or
236 .Ic until ;
237 if the command is the left
238 hand operand of an
239 .Dq Li &&
240 or
241 .Dq Li ||
242 operator; or if the command is a pipeline preceded by the
243 .Ic !\&
244 operator.
245 If a shell function is executed and its exit status is explicitly
246 tested, all commands of the function are considered to be tested as
247 well.
248 .It Fl f Li noglob
249 Disable pathname expansion.
250 .It Fl I Li ignoreeof
251 Ignore
252 .Dv EOF Ap s
253 from input when in interactive mode.
254 .It Fl i Li interactive
255 Force the shell to behave interactively.
256 .It Fl m Li monitor
257 Turn on job control (set automatically when interactive).
258 .It Fl n Li noexec
259 If not interactive, read commands but do not
260 execute them.
261 This is useful for checking the
262 syntax of shell scripts.
263 .It Fl P Li physical
264 Change the default for the
265 .Ic cd
266 and
267 .Ic pwd
268 commands from
269 .Fl L
270 (logical directory layout)
271 to
272 .Fl P
273 (physical directory layout).
274 .It Fl p Li privileged
275 Turn on privileged mode.
276 This mode is enabled on startup
277 if either the effective user or group ID is not equal to the
278 real user or group ID.
279 Turning this mode off sets the
280 effective user and group IDs to the real user and group IDs.
281 When this mode is enabled for interactive shells, the file
282 .Pa /etc/suid_profile
283 is sourced instead of
284 .Pa ~/.profile
285 after
286 .Pa /etc/profile
287 is sourced, and the contents of the
288 .Ev ENV
289 variable are ignored.
290 .It Fl s Li stdin
291 Read commands from standard input (set automatically
292 if no file arguments are present).
293 This option has
294 no effect when set after the shell has already started
295 running (i.e., when set with the
296 .Ic set
297 command).
298 .It Fl T Li trapsasync
299 When waiting for a child, execute traps immediately.
300 If this option is not set,
301 traps are executed after the child exits,
302 as specified in
303 .St -p1003.2 .
304 This nonstandard option is useful for putting guarding shells around
305 children that block signals.
306 The surrounding shell may kill the child
307 or it may just return control to the tty and leave the child alone,
308 like this:
309 .Bd -literal -offset indent
310 sh -T -c "trap 'exit 1' 2 ; some-blocking-program"
311 .Ed
312 .It Fl u Li nounset
313 Write a message to standard error when attempting
314 to expand a variable, a positional parameter or
315 the special parameter
316 .Va \&!
317 that is not set, and if the
318 shell is not interactive, exit immediately.
319 .It Fl V Li vi
320 Enable the built-in
321 .Xr vi 1
322 command line editor (disables
323 .Fl E
324 if it has been set).
325 .It Fl v Li verbose
326 The shell writes its input to standard error
327 as it is read.
328 Useful for debugging.
329 .It Fl x Li xtrace
330 Write each command
331 (preceded by the value of the
332 .Va PS4
333 variable)
334 to standard error before it is executed.
335 Useful for debugging.
336 .El
337 .Pp
338 The
339 .Fl c
340 option causes the commands to be read from the
341 .Ar string
342 operand instead of from the standard input.
343 Keep in mind that this option only accepts a single string as its
344 argument, hence multi-word strings must be quoted.
345 .Pp
346 The
347 .Fl /+o
348 option takes as its only argument the long name of an option
349 to be enabled or disabled.
350 For example, the following two invocations of
351 .Nm
352 both enable the built-in
353 .Xr emacs 1
354 command line editor:
355 .Bd -literal -offset indent
356 set -E
357 set -o emacs
358 .Ed
359 .Pp
360 If used without an argument, the
361 .Fl o
362 option displays the current option settings in a human-readable format.
363 If
364 .Cm +o
365 is used without an argument, the current option settings are output
366 in a format suitable for re-input into the shell.
367 .Ss Lexical Structure
368 The shell reads input in terms of lines from a file and breaks
369 it up into words at whitespace (blanks and tabs), and at
370 certain sequences of
371 characters called
372 .Dq operators ,
373 which are special to the shell.
374 There are two types of operators: control operators and
375 redirection operators (their meaning is discussed later).
376 The following is a list of valid operators:
377 .Bl -tag -width indent
378 .It Control operators:
379 .Bl -column "XXX" "XXX" "XXX" "XXX" "XXX" -offset center -compact
380 .It Li & Ta Li && Ta Li ( Ta Li ) Ta Li \en
381 .It Li ;; Ta Li ; Ta Li | Ta Li ||
382 .El
383 .It Redirection operators:
384 .Bl -column "XXX" "XXX" "XXX" "XXX" "XXX" -offset center -compact
385 .It Li < Ta Li > Ta Li << Ta Li >> Ta Li <>
386 .It Li <& Ta Li >& Ta Li <<- Ta Li >|
387 .El
388 .El
389 .Pp
390 The character
391 .Ql #
392 introduces a comment if used at the beginning of a word.
393 The word starting with
394 .Ql #
395 and the rest of the line are ignored.
396 .Pp
397 .Tn ASCII
398 .Dv NUL
399 characters (character code 0) are not allowed in shell input.
400 .Ss Quoting
401 Quoting is used to remove the special meaning of certain characters
402 or words to the shell, such as operators, whitespace, keywords,
403 or alias names.
404 .Pp
405 There are three types of quoting: matched single quotes,
406 matched double quotes, and backslash.
407 .Bl -tag -width indent
408 .It Single Quotes
409 Enclosing characters in single quotes preserves the literal
410 meaning of all the characters (except single quotes, making
411 it impossible to put single-quotes in a single-quoted string).
412 .It Double Quotes
413 Enclosing characters within double quotes preserves the literal
414 meaning of all characters except dollar sign
415 .Pq Ql $ ,
416 backquote
417 .Pq Ql ` ,
418 and backslash
419 .Pq Ql \e .
420 The backslash inside double quotes is historically weird.
421 It remains literal unless it precedes the following characters,
422 which it serves to quote:
423 .Bl -column "XXX" "XXX" "XXX" "XXX" "XXX" -offset center -compact
424 .It Li $ Ta Li ` Ta Li \&" Ta Li \e\  Ta Li \en
425 .El
426 .It Backslash
427 A backslash preserves the literal meaning of the following
428 character, with the exception of the newline character
429 .Pq Ql \en .
430 A backslash preceding a newline is treated as a line continuation.
431 .El
432 .Ss Keywords
433 Keywords or reserved words are words that have special meaning to the
434 shell and are recognized at the beginning of a line and
435 after a control operator.
436 The following are keywords:
437 .Bl -column "doneXX" "elifXX" "elseXX" "untilXX" "whileX" -offset center
438 .It Li \&! Ta { Ta } Ta Ic case Ta Ic do
439 .It Ic done Ta Ic elif Ta Ic else Ta Ic esac Ta Ic fi
440 .It Ic for Ta Ic if Ta Ic then Ta Ic until Ta Ic while
441 .El
442 .Ss Aliases
443 An alias is a name and corresponding value set using the
444 .Ic alias
445 built-in command.
446 Whenever a keyword may occur (see above),
447 and after checking for keywords, the shell
448 checks the word to see if it matches an alias.
449 If it does, it replaces it in the input stream with its value.
450 For example, if there is an alias called
451 .Dq Li lf
452 with the value
453 .Dq Li "ls -F" ,
454 then the input
455 .Pp
456 .Dl "lf foobar"
457 .Pp
458 would become
459 .Pp
460 .Dl "ls -F foobar"
461 .Pp
462 Aliases provide a convenient way for naive users to
463 create shorthands for commands without having to learn how
464 to create functions with arguments.
465 Using aliases in scripts is discouraged
466 because the command that defines them must be executed
467 before the code that uses them is parsed.
468 This is fragile and not portable.
469 .Pp
470 An alias name may be escaped in a command line, so that it is not
471 replaced by its alias value, by using quoting characters within or
472 adjacent to the alias name.
473 This is most often done by prefixing
474 an alias name with a backslash to execute a function, built-in, or
475 normal program with the same name.
476 See the
477 .Sx Quoting
478 subsection.
479 .Ss Commands
480 The shell interprets the words it reads according to a
481 language, the specification of which is outside the scope
482 of this man page (refer to the BNF in the
483 .St -p1003.2
484 document).
485 Essentially though, a line is read and if
486 the first word of the line (or after a control operator)
487 is not a keyword, then the shell has recognized a
488 simple command.
489 Otherwise, a complex command or some
490 other special construct may have been recognized.
491 .Ss Simple Commands
492 If a simple command has been recognized, the shell performs
493 the following actions:
494 .Bl -enum
495 .It
496 Leading words of the form
497 .Dq Li name=value
498 are stripped off and assigned to the environment of
499 the simple command.
500 Redirection operators and
501 their arguments (as described below) are stripped
502 off and saved for processing.
503 .It
504 The remaining words are expanded as described in
505 the section called
506 .Sx Word Expansions ,
507 and the first remaining word is considered the command
508 name and the command is located.
509 The remaining
510 words are considered the arguments of the command.
511 If no command name resulted, then the
512 .Dq Li name=value
513 variable assignments recognized in 1) affect the
514 current shell.
515 .It
516 Redirections are performed as described in
517 the next section.
518 .El
519 .Ss Redirections
520 Redirections are used to change where a command reads its input
521 or sends its output.
522 In general, redirections open, close, or
523 duplicate an existing reference to a file.
524 The overall format
525 used for redirection is:
526 .Pp
527 .D1 Oo Ar n Oc Ar redir-op file
528 .Pp
529 The
530 .Ar redir-op
531 is one of the redirection operators mentioned
532 previously.
533 The following gives some examples of how these
534 operators can be used.
535 Note that stdin and stdout are commonly used abbreviations
536 for standard input and standard output respectively.
537 .Bl -tag -width "1234567890XX" -offset indent
538 .It Oo Ar n Oc Ns Li > Ar file
539 redirect stdout (or file descriptor
540 .Ar n )
541 to
542 .Ar file
543 .It Oo Ar n Oc Ns Li >| Ar file
544 same as above, but override the
545 .Fl C
546 option
547 .It Oo Ar n Oc Ns Li >> Ar file
548 append stdout (or file descriptor
549 .Ar n )
550 to
551 .Ar file
552 .It Oo Ar n Oc Ns Li < Ar file
553 redirect stdin (or file descriptor
554 .Ar n )
555 from
556 .Ar file
557 .It Oo Ar n Oc Ns Li <> Ar file
558 redirect stdin (or file descriptor
559 .Ar n )
560 to and from
561 .Ar file
562 .It Oo Ar n1 Oc Ns Li <& Ns Ar n2
563 duplicate stdin (or file descriptor
564 .Ar n1 )
565 from file descriptor
566 .Ar n2
567 .It Oo Ar n Oc Ns Li <&-
568 close stdin (or file descriptor
569 .Ar n )
570 .It Oo Ar n1 Oc Ns Li >& Ns Ar n2
571 duplicate stdout (or file descriptor
572 .Ar n1 )
573 to file descriptor
574 .Ar n2
575 .It Oo Ar n Oc Ns Li >&-
576 close stdout (or file descriptor
577 .Ar n )
578 .El
579 .Pp
580 The following redirection is often called a
581 .Dq here-document .
582 .Bd -unfilled -offset indent
583 .Oo Ar n Oc Ns Li << Ar delimiter
584 .D1 Ar here-doc-text
585 .D1 ...
586 .Ar delimiter
587 .Ed
588 .Pp
589 All the text on successive lines up to the delimiter is
590 saved away and made available to the command on standard
591 input, or file descriptor
592 .Ar n
593 if it is specified.
594 If the
595 .Ar delimiter
596 as specified on the initial line is quoted, then the
597 .Ar here-doc-text
598 is treated literally, otherwise the text is subjected to
599 parameter expansion, command substitution, and arithmetic
600 expansion (as described in the section on
601 .Sx Word Expansions ) .
602 If the operator is
603 .Dq Li <<-
604 instead of
605 .Dq Li << ,
606 then leading tabs
607 in the
608 .Ar here-doc-text
609 are stripped.
610 .Ss Search and Execution
611 There are three types of commands: shell functions,
612 built-in commands, and normal programs.
613 The command is searched for (by name) in that order.
614 The three types of commands are all executed in a different way.
615 .Pp
616 When a shell function is executed, all of the shell positional
617 parameters (except
618 .Li $0 ,
619 which remains unchanged) are
620 set to the arguments of the shell function.
621 The variables which are explicitly placed in the environment of
622 the command (by placing assignments to them before the
623 function name) are made local to the function and are set
624 to the values given.
625 Then the command given in the function definition is executed.
626 The positional parameters are restored to their original values
627 when the command completes.
628 This all occurs within the current shell.
629 .Pp
630 Shell built-in commands are executed internally to the shell, without
631 spawning a new process.
632 There are two kinds of built-in commands: regular and special.
633 Assignments before special builtins persist after they finish
634 executing and assignment errors, redirection errors and certain
635 operand errors cause a script to be aborted.
636 Both regular and special builtins can affect the shell in ways
637 normal programs cannot.
638 .Pp
639 Otherwise, if the command name does not match a function
640 or built-in command, the command is searched for as a normal
641 program in the file system (as described in the next section).
642 When a normal program is executed, the shell runs the program,
643 passing the arguments and the environment to the program.
644 If the program is not a normal executable file
645 (i.e., if it does not begin with the
646 .Dq "magic number"
647 whose
648 .Tn ASCII
649 representation is
650 .Dq Li #! ,
651 resulting in an
652 .Er ENOEXEC
653 return value from
654 .Xr execve 2 )
655 the shell will interpret the program in a subshell.
656 The child shell will reinitialize itself in this case,
657 so that the effect will be
658 as if a new shell had been invoked to handle the ad-hoc shell script,
659 except that the location of hashed commands located in
660 the parent shell will be remembered by the child
661 (see the description of the
662 .Ic hash
663 built-in command below).
664 .Pp
665 Note that previous versions of this document
666 and the source code itself misleadingly and sporadically
667 refer to a shell script without a magic number
668 as a
669 .Dq "shell procedure" .
670 .Ss Path Search
671 When locating a command, the shell first looks to see if
672 it has a shell function by that name.
673 Then it looks for a
674 built-in command by that name.
675 If a built-in command is not found,
676 one of two things happen:
677 .Bl -enum
678 .It
679 Command names containing a slash are simply executed without
680 performing any searches.
681 .It
682 The shell searches each entry in the
683 .Va PATH
684 variable
685 in turn for the command.
686 The value of the
687 .Va PATH
688 variable should be a series of
689 entries separated by colons.
690 Each entry consists of a
691 directory name.
692 The current directory
693 may be indicated implicitly by an empty directory name,
694 or explicitly by a single period.
695 .El
696 .Ss Command Exit Status
697 Each command has an exit status that can influence the behavior
698 of other shell commands.
699 The paradigm is that a command exits
700 with zero for normal or success, and non-zero for failure,
701 error, or a false indication.
702 The man page for each command
703 should indicate the various exit codes and what they mean.
704 Additionally, the built-in commands return exit codes, as does
705 an executed shell function.
706 .Pp
707 If a command is terminated by a signal, its exit status is 128 plus
708 the signal number.
709 Signal numbers are defined in the header file
710 .In sys/signal.h .
711 .Ss Complex Commands
712 Complex commands are combinations of simple commands
713 with control operators or keywords, together creating a larger complex
714 command.
715 More generally, a command is one of the following:
716 .Bl -item -offset indent
717 .It
718 simple command
719 .It
720 pipeline
721 .It
722 list or compound-list
723 .It
724 compound command
725 .It
726 function definition
727 .El
728 .Pp
729 Unless otherwise stated, the exit status of a command is
730 that of the last simple command executed by the command.
731 .Ss Pipelines
732 A pipeline is a sequence of one or more commands separated
733 by the control operator
734 .Ql \&| .
735 The standard output of all but
736 the last command is connected to the standard input
737 of the next command.
738 The standard output of the last
739 command is inherited from the shell, as usual.
740 .Pp
741 The format for a pipeline is:
742 .Pp
743 .D1 Oo Li \&! Oc Ar command1 Op Li \&| Ar command2 ...
744 .Pp
745 The standard output of
746 .Ar command1
747 is connected to the standard input of
748 .Ar command2 .
749 The standard input, standard output, or
750 both of a command is considered to be assigned by the
751 pipeline before any redirection specified by redirection
752 operators that are part of the command.
753 .Pp
754 Note that unlike some other shells,
755 .Nm
756 executes each process in a pipeline with more than one command
757 in a subshell environment and as a child of the
758 .Nm
759 process.
760 .Pp
761 If the pipeline is not in the background (discussed later),
762 the shell waits for all commands to complete.
763 .Pp
764 If the keyword
765 .Ic !\&
766 does not precede the pipeline, the
767 exit status is the exit status of the last command specified
768 in the pipeline.
769 Otherwise, the exit status is the logical
770 NOT of the exit status of the last command.
771 That is, if
772 the last command returns zero, the exit status is 1; if
773 the last command returns greater than zero, the exit status
774 is zero.
775 .Pp
776 Because pipeline assignment of standard input or standard
777 output or both takes place before redirection, it can be
778 modified by redirection.
779 For example:
780 .Pp
781 .Dl "command1 2>&1 | command2"
782 .Pp
783 sends both the standard output and standard error of
784 .Ar command1
785 to the standard input of
786 .Ar command2 .
787 .Pp
788 A
789 .Ql \&;
790 or newline terminator causes the preceding
791 AND-OR-list
792 (described below in the section called
793 .Sx Short-Circuit List Operators )
794 to be executed sequentially;
795 an
796 .Ql &
797 causes asynchronous execution of the preceding AND-OR-list.
798 .Ss Background Commands (&)
799 If a command is terminated by the control operator ampersand
800 .Pq Ql & ,
801 the shell executes the command asynchronously;
802 the shell does not wait for the command to finish
803 before executing the next command.
804 .Pp
805 The format for running a command in background is:
806 .Pp
807 .D1 Ar command1 Li & Op Ar command2 Li & Ar ...
808 .Pp
809 If the shell is not interactive, the standard input of an
810 asynchronous command is set to
811 .Pa /dev/null .
812 .Ss Lists (Generally Speaking)
813 A list is a sequence of zero or more commands separated by
814 newlines, semicolons, or ampersands,
815 and optionally terminated by one of these three characters.
816 The commands in a
817 list are executed in the order they are written.
818 If command is followed by an ampersand, the shell starts the
819 command and immediately proceeds onto the next command;
820 otherwise it waits for the command to terminate before
821 proceeding to the next one.
822 .Ss Short-Circuit List Operators
823 .Dq Li &&
824 and
825 .Dq Li ||
826 are AND-OR list operators.
827 .Dq Li &&
828 executes the first command, and then executes the second command
829 if the exit status of the first command is zero.
830 .Dq Li ||
831 is similar, but executes the second command if the exit
832 status of the first command is nonzero.
833 .Dq Li &&
834 and
835 .Dq Li ||
836 both have the same priority.
837 .Ss Flow-Control Constructs (if, while, for, case)
838 The syntax of the
839 .Ic if
840 command is:
841 .Bd -unfilled -offset indent -compact
842 .Ic if Ar list
843 .Ic then Ar list
844 .Oo Ic elif Ar list
845 .Ic then Ar list Oc Ar ...
846 .Op Ic else Ar list
847 .Ic fi
848 .Ed
849 .Pp
850 The syntax of the
851 .Ic while
852 command is:
853 .Bd -unfilled -offset indent -compact
854 .Ic while Ar list
855 .Ic do Ar list
856 .Ic done
857 .Ed
858 .Pp
859 The two lists are executed repeatedly while the exit status of the
860 first list is zero.
861 The
862 .Ic until
863 command is similar, but has the word
864 .Ic until
865 in place of
866 .Ic while ,
867 which causes it to
868 repeat until the exit status of the first list is zero.
869 .Pp
870 The syntax of the
871 .Ic for
872 command is:
873 .Bd -unfilled -offset indent -compact
874 .Ic for Ar variable Op Ic in Ar word ...
875 .Ic do Ar list
876 .Ic done
877 .Ed
878 .Pp
879 If
880 .Ic in
881 and the following words are omitted,
882 .Ic in Li \&"$@\&"
883 is used instead.
884 The words are expanded, and then the list is executed
885 repeatedly with the variable set to each word in turn.
886 The
887 .Ic do
888 and
889 .Ic done
890 commands may be replaced with
891 .Ql {
892 and
893 .Ql } .
894 .Pp
895 The syntax of the
896 .Ic break
897 and
898 .Ic continue
899 commands is:
900 .D1 Ic break Op Ar num
901 .D1 Ic continue Op Ar num
902 .Pp
903 The
904 .Ic break
905 command terminates the
906 .Ar num
907 innermost
908 .Ic for
909 or
910 .Ic while
911 loops.
912 The
913 .Ic continue
914 command continues with the next iteration of the innermost loop.
915 These are implemented as special built-in commands.
916 .Pp
917 The syntax of the
918 .Ic case
919 command is:
920 .Bd -unfilled -offset indent -compact
921 .Ic case Ar word Ic in
922 .Ar pattern Ns Li ) Ar list Li ;;
923 .Ar ...
924 .Ic esac
925 .Ed
926 .Pp
927 The pattern can actually be one or more patterns
928 (see
929 .Sx Shell Patterns
930 described later),
931 separated by
932 .Ql \&|
933 characters.
934 The exit code of the
935 .Ic case
936 command is the exit code of the last command executed in the list or
937 zero if no patterns were matched.
938 .Ss Grouping Commands Together
939 Commands may be grouped by writing either
940 .Pp
941 .D1 Li \&( Ns Ar list Ns Li \%)
942 .Pp
943 or
944 .Pp
945 .D1 Li { Ar list Ns Li \&; }
946 .Pp
947 The first form executes the commands in a subshell.
948 Note that built-in commands thus executed do not affect the current shell.
949 The second form does not fork another shell,
950 so it is slightly more efficient.
951 Grouping commands together this way allows the user to
952 redirect their output as though they were one program:
953 .Bd -literal -offset indent
954 { echo -n "hello"; echo " world"; } > greeting
955 .Ed
956 .Ss Functions
957 The syntax of a function definition is
958 .Pp
959 .D1 Ar name Li \&( \&) Ar command
960 .Pp
961 A function definition is an executable statement; when
962 executed it installs a function named
963 .Ar name
964 and returns an
965 exit status of zero.
966 The
967 .Ar command
968 is normally a list
969 enclosed between
970 .Ql {
971 and
972 .Ql } .
973 .Pp
974 Variables may be declared to be local to a function by
975 using the
976 .Ic local
977 command.
978 This should appear as the first statement of a function,
979 and the syntax is:
980 .Pp
981 .D1 Ic local Oo Ar variable ... Oc Op Fl
982 .Pp
983 The
984 .Ic local
985 command is implemented as a built-in command.
986 .Pp
987 When a variable is made local, it inherits the initial
988 value and exported and readonly flags from the variable
989 with the same name in the surrounding scope, if there is
990 one.
991 Otherwise, the variable is initially unset.
992 The shell
993 uses dynamic scoping, so that if the variable
994 .Va x
995 is made local to function
996 .Em f ,
997 which then calls function
998 .Em g ,
999 references to the variable
1000 .Va x
1001 made inside
1002 .Em g
1003 will refer to the variable
1004 .Va x
1005 declared inside
1006 .Em f ,
1007 not to the global variable named
1008 .Va x .
1009 .Pp
1010 The only special parameter that can be made local is
1011 .Ql - .
1012 Making
1013 .Ql -
1014 local causes any shell options that are
1015 changed via the
1016 .Ic set
1017 command inside the function to be
1018 restored to their original values when the function
1019 returns.
1020 .Pp
1021 The syntax of the
1022 .Ic return
1023 command is
1024 .Pp
1025 .D1 Ic return Op Ar exitstatus
1026 .Pp
1027 It terminates the current executional scope, returning from the previous
1028 nested function, sourced script, or shell instance, in that order.
1029 The
1030 .Ic return
1031 command is implemented as a special built-in command.
1032 .Ss Variables and Parameters
1033 The shell maintains a set of parameters.
1034 A parameter
1035 denoted by a name is called a variable.
1036 When starting up,
1037 the shell turns all the environment variables into shell
1038 variables.
1039 New variables can be set using the form
1040 .Pp
1041 .D1 Ar name Ns = Ns Ar value
1042 .Pp
1043 Variables set by the user must have a name consisting solely
1044 of alphabetics, numerics, and underscores.
1045 The first letter of a variable name must not be numeric.
1046 A parameter can also be denoted by a number
1047 or a special character as explained below.
1048 .Pp
1049 Assignments are expanded differently from other words:
1050 tilde expansion is also performed after the equals sign and after any colon
1051 and usernames are also terminated by colons,
1052 and field splitting and pathname expansion are not performed.
1053 .Ss Positional Parameters
1054 A positional parameter is a parameter denoted by a number greater than zero.
1055 The shell sets these initially to the values of its command line
1056 arguments that follow the name of the shell script.
1057 The
1058 .Ic set
1059 built-in command can also be used to set or reset them.
1060 .Ss Special Parameters
1061 Special parameters are parameters denoted by a single special character
1062 or the digit zero.
1063 They are shown in the following list, exactly as they would appear in input
1064 typed by the user or in the source of a shell script.
1065 .Bl -hang
1066 .It Li $*
1067 Expands to the positional parameters, starting from one.
1068 When
1069 the expansion occurs within a double-quoted string
1070 it expands to a single field with the value of each parameter
1071 separated by the first character of the
1072 .Va IFS
1073 variable,
1074 or by a space if
1075 .Va IFS
1076 is unset.
1077 .It Li $@
1078 Expands to the positional parameters, starting from one.
1079 When
1080 the expansion occurs within double-quotes, each positional
1081 parameter expands as a separate argument.
1082 If there are no positional parameters, the
1083 expansion of
1084 .Li @
1085 generates zero arguments, even when
1086 .Li @
1087 is double-quoted.
1088 What this basically means, for example, is
1089 if
1090 .Li $1
1091 is
1092 .Dq Li abc
1093 and
1094 .Li $2
1095 is
1096 .Dq Li "def ghi" ,
1097 then
1098 .Li \&"$@\&"
1099 expands to
1100 the two arguments:
1101 .Bd -literal -offset indent
1102 "abc"   "def ghi"
1103 .Ed
1104 .It Li $#
1105 Expands to the number of positional parameters.
1106 .It Li $?
1107 Expands to the exit status of the most recent pipeline.
1108 .It Li $-
1109 (hyphen) Expands to the current option flags (the single-letter
1110 option names concatenated into a string) as specified on
1111 invocation, by the
1112 .Ic set
1113 built-in command, or implicitly
1114 by the shell.
1115 .It Li $$
1116 Expands to the process ID of the invoked shell.
1117 A subshell
1118 retains the same value of
1119 .Va $
1120 as its parent.
1121 .It Li $!
1122 Expands to the process ID of the most recent background
1123 command executed from the current shell.
1124 For a
1125 pipeline, the process ID is that of the last command in the
1126 pipeline.
1127 .It Li $0
1128 (zero) Expands to the name of the shell script if passed on the command line,
1129 the
1130 .Ar name
1131 operand if given (with
1132 .Fl c )
1133 or otherwise argument 0 passed to the shell.
1134 .El
1135 .Ss Special Variables
1136 The following variables are set by the shell or
1137 have special meaning to it:
1138 .Bl -tag -width ".Va HISTSIZE"
1139 .It Va CDPATH
1140 The search path used with the
1141 .Ic cd
1142 built-in.
1143 .It Va EDITOR
1144 The fallback editor used with the
1145 .Ic fc
1146 built-in.
1147 If not set, the default editor is
1148 .Xr ed 1 .
1149 .It Va FCEDIT
1150 The default editor used with the
1151 .Ic fc
1152 built-in.
1153 .It Va HISTSIZE
1154 The number of previous commands that are accessible.
1155 .It Va HOME
1156 The user's home directory,
1157 used in tilde expansion and as a default directory for the
1158 .Ic cd
1159 built-in.
1160 .It Va IFS
1161 Input Field Separators.
1162 The default value is
1163 .Aq space ,
1164 .Aq tab ,
1165 and
1166 .Aq newline
1167 in that order.
1168 This default also applies if
1169 .Va IFS
1170 is unset, but not if it is set to the empty string.
1171 See the
1172 .Sx White Space Splitting
1173 section for more details.
1174 .It Va LINENO
1175 The current line number in the script or function.
1176 .It Va MAIL
1177 The name of a mail file, that will be checked for the arrival of new
1178 mail.
1179 Overridden by
1180 .Va MAILPATH .
1181 .It Va MAILPATH
1182 A colon
1183 .Pq Ql \&:
1184 separated list of file names, for the shell to check for incoming
1185 mail.
1186 This variable overrides the
1187 .Va MAIL
1188 setting.
1189 There is a maximum of 10 mailboxes that can be monitored at once.
1190 .It Va PATH
1191 The default search path for executables.
1192 See the
1193 .Sx Path Search
1194 section for details.
1195 .It Va PPID
1196 The parent process ID of the invoked shell.
1197 This is set at startup
1198 unless this variable is in the environment.
1199 A later change of parent process ID is not reflected.
1200 A subshell retains the same value of
1201 .Va PPID .
1202 .It Va PS1
1203 The primary prompt string, which defaults to
1204 .Dq Li "$ " ,
1205 unless you are the superuser, in which case it defaults to
1206 .Dq Li "# " .
1207 .It Va PS2
1208 The secondary prompt string, which defaults to
1209 .Dq Li "> " .
1210 .It Va PS4
1211 The prefix for the trace output (if
1212 .Fl x
1213 is active).
1214 The default is
1215 .Dq Li "+ " .
1216 .El
1217 .Ss Word Expansions
1218 This clause describes the various expansions that are
1219 performed on words.
1220 Not all expansions are performed on
1221 every word, as explained later.
1222 .Pp
1223 Tilde expansions, parameter expansions, command substitutions,
1224 arithmetic expansions, and quote removals that occur within
1225 a single word expand to a single field.
1226 It is only field
1227 splitting or pathname expansion that can create multiple
1228 fields from a single word.
1229 The single exception to this rule is
1230 the expansion of the special parameter
1231 .Va @
1232 within double-quotes,
1233 as was described above.
1234 .Pp
1235 The order of word expansion is:
1236 .Bl -enum
1237 .It
1238 Tilde Expansion, Parameter Expansion, Command Substitution,
1239 Arithmetic Expansion (these all occur at the same time).
1240 .It
1241 Field Splitting is performed on fields generated by step (1)
1242 unless the
1243 .Va IFS
1244 variable is null.
1245 .It
1246 Pathname Expansion (unless the
1247 .Fl f
1248 option is in effect).
1249 .It
1250 Quote Removal.
1251 .El
1252 .Pp
1253 The
1254 .Ql $
1255 character is used to introduce parameter expansion, command
1256 substitution, or arithmetic expansion.
1257 .Ss Tilde Expansion (substituting a user's home directory)
1258 A word beginning with an unquoted tilde character
1259 .Pq Ql ~
1260 is
1261 subjected to tilde expansion.
1262 All the characters up to a slash
1263 .Pq Ql /
1264 or the end of the word are treated as a username
1265 and are replaced with the user's home directory.
1266 If the
1267 username is missing (as in
1268 .Pa ~/foobar ) ,
1269 the tilde is replaced with the value of the
1270 .Va HOME
1271 variable (the current user's home directory).
1272 .Ss Parameter Expansion
1273 The format for parameter expansion is as follows:
1274 .Pp
1275 .D1 Li ${ Ns Ar expression Ns Li }
1276 .Pp
1277 where
1278 .Ar expression
1279 consists of all characters until the matching
1280 .Ql } .
1281 Any
1282 .Ql }
1283 escaped by a backslash or within a quoted string, and characters in
1284 embedded arithmetic expansions, command substitutions, and variable
1285 expansions, are not examined in determining the matching
1286 .Ql } .
1287 .Pp
1288 The simplest form for parameter expansion is:
1289 .Pp
1290 .D1 Li ${ Ns Ar parameter Ns Li }
1291 .Pp
1292 The value, if any, of
1293 .Ar parameter
1294 is substituted.
1295 .Pp
1296 The parameter name or symbol can be enclosed in braces, which are
1297 optional except for positional parameters with more than one digit or
1298 when parameter is followed by a character that could be interpreted as
1299 part of the name.
1300 If a parameter expansion occurs inside double-quotes:
1301 .Bl -enum
1302 .It
1303 Field splitting is not performed on the results of the
1304 expansion, with the exception of the special parameter
1305 .Va @ .
1306 .It
1307 Pathname expansion is not performed on the results of the
1308 expansion.
1309 .El
1310 .Pp
1311 In addition, a parameter expansion can be modified by using one of the
1312 following formats.
1313 .Bl -tag -width indent
1314 .It Li ${ Ns Ar parameter Ns Li :- Ns Ar word Ns Li }
1315 Use Default Values.
1316 If
1317 .Ar parameter
1318 is unset or null, the expansion of
1319 .Ar word
1320 is substituted; otherwise, the value of
1321 .Ar parameter
1322 is substituted.
1323 .It Li ${ Ns Ar parameter Ns Li := Ns Ar word Ns Li }
1324 Assign Default Values.
1325 If
1326 .Ar parameter
1327 is unset or null, the expansion of
1328 .Ar word
1329 is assigned to
1330 .Ar parameter .
1331 In all cases, the
1332 final value of
1333 .Ar parameter
1334 is substituted.
1335 Quoting inside
1336 .Ar word
1337 does not prevent field splitting or pathname expansion.
1338 Only variables, not positional
1339 parameters or special parameters, can be
1340 assigned in this way.
1341 .It Li ${ Ns Ar parameter Ns Li :? Ns Oo Ar word Oc Ns Li }
1342 Indicate Error if Null or Unset.
1343 If
1344 .Ar parameter
1345 is unset or null, the expansion of
1346 .Ar word
1347 (or a message indicating it is unset if
1348 .Ar word
1349 is omitted) is written to standard
1350 error and the shell exits with a nonzero
1351 exit status.
1352 Otherwise, the value of
1353 .Ar parameter
1354 is substituted.
1355 An
1356 interactive shell need not exit.
1357 .It Li ${ Ns Ar parameter Ns Li :+ Ns Ar word Ns Li }
1358 Use Alternate Value.
1359 If
1360 .Ar parameter
1361 is unset or null, null is substituted;
1362 otherwise, the expansion of
1363 .Ar word
1364 is substituted.
1365 .El
1366 .Pp
1367 In the parameter expansions shown previously, use of the colon in the
1368 format results in a test for a parameter that is unset or null; omission
1369 of the colon results in a test for a parameter that is only unset.
1370 .Bl -tag -width indent
1371 .It Li ${# Ns Ar parameter Ns Li }
1372 String Length.
1373 The length in characters of
1374 the value of
1375 .Ar parameter .
1376 .El
1377 .Pp
1378 The following four varieties of parameter expansion provide for substring
1379 processing.
1380 In each case, pattern matching notation
1381 (see
1382 .Sx Shell Patterns ) ,
1383 rather than regular expression notation,
1384 is used to evaluate the patterns.
1385 If parameter is one of the special parameters
1386 .Va *
1387 or
1388 .Va @ ,
1389 the result of the expansion is unspecified.
1390 Enclosing the full parameter expansion string in double-quotes does not
1391 cause the following four varieties of pattern characters to be quoted,
1392 whereas quoting characters within the braces has this effect.
1393 .Bl -tag -width indent
1394 .It Li ${ Ns Ar parameter Ns Li % Ns Ar word Ns Li }
1395 Remove Smallest Suffix Pattern.
1396 The
1397 .Ar word
1398 is expanded to produce a pattern.
1399 The
1400 parameter expansion then results in
1401 .Ar parameter ,
1402 with the smallest portion of the
1403 suffix matched by the pattern deleted.
1404 .It Li ${ Ns Ar parameter Ns Li %% Ns Ar word Ns Li }
1405 Remove Largest Suffix Pattern.
1406 The
1407 .Ar word
1408 is expanded to produce a pattern.
1409 The
1410 parameter expansion then results in
1411 .Ar parameter ,
1412 with the largest portion of the
1413 suffix matched by the pattern deleted.
1414 .It Li ${ Ns Ar parameter Ns Li # Ns Ar word Ns Li }
1415 Remove Smallest Prefix Pattern.
1416 The
1417 .Ar word
1418 is expanded to produce a pattern.
1419 The
1420 parameter expansion then results in
1421 .Ar parameter ,
1422 with the smallest portion of the
1423 prefix matched by the pattern deleted.
1424 .It Li ${ Ns Ar parameter Ns Li ## Ns Ar word Ns Li }
1425 Remove Largest Prefix Pattern.
1426 The
1427 .Ar word
1428 is expanded to produce a pattern.
1429 The
1430 parameter expansion then results in
1431 .Ar parameter ,
1432 with the largest portion of the
1433 prefix matched by the pattern deleted.
1434 .El
1435 .Ss Command Substitution
1436 Command substitution allows the output of a command to be substituted in
1437 place of the command name itself.
1438 Command substitution occurs when
1439 the command is enclosed as follows:
1440 .Pp
1441 .D1 Li $( Ns Ar command Ns Li )\&
1442 .Pp
1443 or the backquoted version:
1444 .Pp
1445 .D1 Li ` Ns Ar command Ns Li `
1446 .Pp
1447 The shell expands the command substitution by executing command in a
1448 subshell environment and replacing the command substitution
1449 with the standard output of the command,
1450 removing sequences of one or more newlines at the end of the substitution.
1451 Embedded newlines before the end of the output are not removed;
1452 however, during field splitting, they may be translated into spaces
1453 depending on the value of
1454 .Va IFS
1455 and the quoting that is in effect.
1456 .Ss Arithmetic Expansion
1457 Arithmetic expansion provides a mechanism for evaluating an arithmetic
1458 expression and substituting its value.
1459 The format for arithmetic expansion is as follows:
1460 .Pp
1461 .D1 Li $(( Ns Ar expression Ns Li ))
1462 .Pp
1463 The
1464 .Ar expression
1465 is treated as if it were in double-quotes, except
1466 that a double-quote inside the expression is not treated specially.
1467 The
1468 shell expands all tokens in the
1469 .Ar expression
1470 for parameter expansion,
1471 command substitution,
1472 arithmetic expansion
1473 and quote removal.
1474 .Pp
1475 The allowed expressions are a subset of C expressions,
1476 summarized below.
1477 .Bl -tag -width "Variables" -offset indent
1478 .It Values
1479 All values are of type
1480 .Ft intmax_t .
1481 .It Constants
1482 Decimal, octal (starting with
1483 .Li 0 )
1484 and hexadecimal (starting with 
1485 .Li 0x )
1486 integer constants.
1487 .It Variables
1488 Shell variables can be read and written
1489 and contain integer constants.
1490 .It Unary operators
1491 .Li "! ~ + -"
1492 .It Binary operators
1493 .Li "* / % + - << >> < <= > >= == != & ^ | && ||"
1494 .It Assignment operators
1495 .Li "= += -= *= /= %= <<= >>= &= ^= |="
1496 .It Short-circuit evaluation
1497 The
1498 .Li &&
1499 and
1500 .Li ||
1501 operators always evaluate both sides.
1502 This is a bug.
1503 .El
1504 .Pp
1505 The result of the expression is substituted in decimal.
1506 .Ss White Space Splitting (Field Splitting)
1507 In certain contexts,
1508 after parameter expansion, command substitution, and
1509 arithmetic expansion the shell scans the results of
1510 expansions and substitutions that did not occur in double-quotes for
1511 field splitting and multiple fields can result.
1512 .Pp
1513 Characters in
1514 .Va IFS
1515 that are whitespace
1516 .Po
1517 .Aq space ,
1518 .Aq tab ,
1519 and
1520 .Aq newline
1521 .Pc
1522 are treated differently from other characters in
1523 .Va IFS .
1524 .Pp
1525 Whitespace in
1526 .Va IFS
1527 at the beginning or end of a word is discarded.
1528 .Pp
1529 Subsequently, a field is delimited by either
1530 .Bl -enum
1531 .It
1532 a non-whitespace character in
1533 .Va IFS
1534 with any whitespace in
1535 .Va IFS
1536 surrounding it, or
1537 .It
1538 one or more whitespace characters in
1539 .Va IFS .
1540 .El
1541 .Pp
1542 If a word ends with a non-whitespace character in
1543 .Va IFS ,
1544 there is no empty field after this character.
1545 .Pp
1546 If no field is delimited, the word is discarded.
1547 In particular, if a word consists solely of an unquoted substitution
1548 and the result of the substitution is null,
1549 it is removed by field splitting even if
1550 .Va IFS
1551 is null.
1552 .Ss Pathname Expansion (File Name Generation)
1553 Unless the
1554 .Fl f
1555 option is set,
1556 file name generation is performed
1557 after word splitting is complete.
1558 Each word is
1559 viewed as a series of patterns, separated by slashes.
1560 The
1561 process of expansion replaces the word with the names of
1562 all existing files whose names can be formed by replacing
1563 each pattern with a string that matches the specified pattern.
1564 There are two restrictions on this: first, a pattern cannot match
1565 a string containing a slash, and second,
1566 a pattern cannot match a string starting with a period
1567 unless the first character of the pattern is a period.
1568 The next section describes the patterns used for
1569 Pathname Expansion,
1570 the four varieties of parameter expansion for substring processing and the
1571 .Ic case
1572 command.
1573 .Ss Shell Patterns
1574 A pattern consists of normal characters, which match themselves,
1575 and meta-characters.
1576 The meta-characters are
1577 .Ql * ,
1578 .Ql \&? ,
1579 and
1580 .Ql \&[ .
1581 These characters lose their special meanings if they are quoted.
1582 When command or variable substitution is performed and the dollar sign
1583 or back quotes are not double-quoted, the value of the
1584 variable or the output of the command is scanned for these
1585 characters and they are turned into meta-characters.
1586 .Pp
1587 An asterisk
1588 .Pq Ql *
1589 matches any string of characters.
1590 A question mark
1591 .Pq Ql \&?
1592 matches any single character.
1593 A left bracket
1594 .Pq Ql \&[
1595 introduces a character class.
1596 The end of the character class is indicated by a
1597 .Ql \&] ;
1598 if the
1599 .Ql \&]
1600 is missing then the
1601 .Ql \&[
1602 matches a
1603 .Ql \&[
1604 rather than introducing a character class.
1605 A character class matches any of the characters between the square brackets.
1606 A locale-dependent range of characters may be specified using a minus sign.
1607 The character class may be complemented by making an exclamation point
1608 .Pq Ql !\&
1609 the first character of the character class.
1610 A caret
1611 .Pq Ql ^
1612 has the same effect but is non-standard.
1613 .Pp
1614 To include a
1615 .Ql \&]
1616 in a character class, make it the first character listed
1617 (after the
1618 .Ql \&!
1619 or
1620 .Ql ^ ,
1621 if any).
1622 To include a
1623 .Ql - ,
1624 make it the first or last character listed.
1625 .Ss Built-in Commands
1626 This section lists the built-in commands.
1627 .Bl -tag -width indent
1628 .It Ic \&:
1629 A null command that returns a 0 (true) exit value.
1630 .It Ic \&. Ar file
1631 The commands in the specified file are read and executed by the shell.
1632 The
1633 .Ic return
1634 command may be used to return to the
1635 .Ic \&.
1636 command's caller.
1637 If
1638 .Ar file
1639 contains any
1640 .Ql /
1641 characters, it is used as is.
1642 Otherwise, the shell searches the
1643 .Va PATH
1644 for the file.
1645 If it is not found in the
1646 .Va PATH ,
1647 it is sought in the current working directory.
1648 .It Ic \&[
1649 A built-in equivalent of
1650 .Xr test 1 .
1651 .It Ic alias Oo Ar name Ns Oo = Ns Ar string Oc ... Oc
1652 If
1653 .Ar name Ns = Ns Ar string
1654 is specified, the shell defines the alias
1655 .Ar name
1656 with value
1657 .Ar string .
1658 If just
1659 .Ar name
1660 is specified, the value of the alias
1661 .Ar name
1662 is printed.
1663 With no arguments, the
1664 .Ic alias
1665 built-in command prints the names and values of all defined aliases
1666 (see
1667 .Ic unalias ) .
1668 Alias values are written with appropriate quoting so that they are
1669 suitable for re-input to the shell.
1670 Also see the
1671 .Sx Aliases
1672 subsection.
1673 .It Ic bg Op Ar job ...
1674 Continue the specified jobs
1675 (or the current job if no jobs are given)
1676 in the background.
1677 .It Ic bind Oo Fl aeklrsv Oc Oo Ar key Oo Ar command Oc Oc
1678 List or alter key bindings for the line editor.
1679 This command is documented in
1680 .Xr editrc 5 .
1681 .It Ic break Op Ar num
1682 See the
1683 .Sx Flow-Control Constructs
1684 subsection.
1685 .It Ic builtin Ar cmd Op Ar arg ...
1686 Execute the specified built-in command,
1687 .Ar cmd .
1688 This is useful when the user wishes to override a shell function
1689 with the same name as a built-in command.
1690 .It Ic cd Oo Fl L | P Oc Op Ar directory
1691 Switch to the specified
1692 .Ar directory ,
1693 or to the directory specified in the
1694 .Va HOME
1695 environment variable if no
1696 .Ar directory
1697 is specified.
1698 If
1699 .Ar directory
1700 does not begin with
1701 .Pa / , \&. ,
1702 or
1703 .Pa .. ,
1704 then the directories listed in the
1705 .Va CDPATH
1706 variable will be
1707 searched for the specified
1708 .Ar directory .
1709 If
1710 .Va CDPATH
1711 is unset, the current directory is searched.
1712 The format of
1713 .Va CDPATH
1714 is the same as that of
1715 .Va PATH .
1716 In an interactive shell,
1717 the
1718 .Ic cd
1719 command will print out the name of the directory
1720 that it actually switched to
1721 if this is different from the name that the user gave.
1722 These may be different either because the
1723 .Va CDPATH
1724 mechanism was used or because a symbolic link was crossed.
1725 .Pp
1726 If the
1727 .Fl P
1728 option is specified,
1729 .Pa ..
1730 is handled physically and symbolic links are resolved before
1731 .Pa ..
1732 components are processed.
1733 If the
1734 .Fl L
1735 option is specified,
1736 .Pa ..
1737 is handled logically.
1738 This is the default.
1739 .It Ic chdir
1740 A synonym for the
1741 .Ic cd
1742 built-in command.
1743 .It Ic command Oo Fl p Oc Op Ar utility Op Ar argument ...
1744 .It Ic command Oo Fl v | V Oc Op Ar utility
1745 The first form of invocation executes the specified
1746 .Ar utility
1747 as a simple command (see the
1748 .Sx Simple Commands
1749 section).
1750 .Pp
1751 If the
1752 .Fl p
1753 option is specified, the command search is performed using a
1754 default value of
1755 .Va PATH
1756 that is guaranteed to find all of the standard utilities.
1757 .Pp
1758 If the
1759 .Fl v
1760 option is specified,
1761 .Ar utility
1762 is not executed but a description of its interpretation by the shell is
1763 printed.
1764 For ordinary commands the output is the path name; for shell built-in
1765 commands, shell functions and keywords only the name is written.
1766 Aliases are printed as
1767 .Dq Ic alias Ar name Ns = Ns Ar value .
1768 .Pp
1769 The
1770 .Fl V
1771 option is identical to
1772 .Fl v
1773 except for the output.
1774 It prints
1775 .Dq Ar utility Ic is Ar description
1776 where
1777 .Ar description
1778 is either
1779 the path name to
1780 .Ar utility ,
1781 a special shell builtin,
1782 a shell builtin,
1783 a shell function,
1784 a shell keyword
1785 or
1786 an alias for
1787 .Ar value .
1788 .It Ic continue Op Ar num
1789 See the
1790 .Sx Flow-Control Constructs
1791 subsection.
1792 .It Ic echo Oo Fl e | n Oc Op Ar string ...
1793 Print a space-separated list of the arguments to the standard output
1794 and append a newline character.
1795 .Bl -tag -width indent
1796 .It Fl n
1797 Suppress the output of the trailing newline.
1798 .It Fl e
1799 Process C-style backslash escape sequences.
1800 The
1801 .Ic echo
1802 command understands the following character escapes:
1803 .Bl -tag -width indent
1804 .It \ea
1805 Alert (ring the terminal bell)
1806 .It \eb
1807 Backspace
1808 .It \ec
1809 Suppress the trailing newline (this has the side-effect of truncating the
1810 line if it is not the last character)
1811 .It \ee
1812 The ESC character
1813 .Tn ( ASCII
1814 0x1b)
1815 .It \ef
1816 Formfeed
1817 .It \en
1818 Newline
1819 .It \er
1820 Carriage return
1821 .It \et
1822 Horizontal tab
1823 .It \ev
1824 Vertical tab
1825 .It \e\e
1826 Literal backslash
1827 .It \e0nnn
1828 (Zero) The character whose octal value is
1829 .Ar nnn
1830 .El
1831 .Pp
1832 If
1833 .Ar string
1834 is not enclosed in quotes then the backslash itself must be escaped
1835 with a backslash to protect it from the shell.
1836 For example
1837 .Bd -literal -offset indent
1838 $ echo -e "a\evb"
1839 a
1840  b
1841 $ echo -e a\e\evb
1842 a
1843  b
1844 $ echo -e "a\e\eb"
1845 a\eb
1846 $ echo -e a\e\e\e\eb
1847 a\eb
1848 .Ed
1849 .El
1850 .Pp
1851 Only one of the
1852 .Fl e
1853 and
1854 .Fl n
1855 options may be specified.
1856 .It Ic eval Ar string ...
1857 Concatenate all the arguments with spaces.
1858 Then re-parse and execute the command.
1859 .It Ic exec Op Ar command Op arg ...
1860 Unless
1861 .Ar command
1862 is omitted,
1863 the shell process is replaced with the specified program
1864 (which must be a real program, not a shell built-in command or function).
1865 Any redirections on the
1866 .Ic exec
1867 command are marked as permanent,
1868 so that they are not undone when the
1869 .Ic exec
1870 command finishes.
1871 .It Ic exit Op Ar exitstatus
1872 Terminate the shell process.
1873 If
1874 .Ar exitstatus
1875 is given
1876 it is used as the exit status of the shell;
1877 otherwise the exit status of the preceding command is used.
1878 The exit status should be an integer between 0 and 255.
1879 .It Ic export Ar name ...
1880 .It Ic export Op Fl p
1881 The specified names are exported so that they will
1882 appear in the environment of subsequent commands.
1883 The only way to un-export a variable is to
1884 .Ic unset
1885 it.
1886 The shell allows the value of a variable to be set
1887 at the same time as it is exported by writing
1888 .Pp
1889 .D1 Ic export Ar name Ns = Ns Ar value
1890 .Pp
1891 With no arguments the
1892 .Ic export
1893 command lists the names
1894 of all exported variables.
1895 If the
1896 .Fl p
1897 option is specified, the exported variables are printed as
1898 .Dq Ic export Ar name Ns = Ns Ar value
1899 lines, suitable for re-input to the shell.
1900 .It Ic false
1901 A null command that returns a non-zero (false) exit value.
1902 .It Ic fc Oo Fl e Ar editor Oc Op Ar first Op Ar last
1903 .It Ic fc Fl l Oo Fl nr Oc Op Ar first Op Ar last
1904 .It Ic fc Fl s Oo Ar old Ns = Ns Ar new Oc Op Ar first
1905 The
1906 .Ic fc
1907 built-in command lists, or edits and re-executes,
1908 commands previously entered to an interactive shell.
1909 .Bl -tag -width indent
1910 .It Fl e Ar editor
1911 Use the editor named by
1912 .Ar editor
1913 to edit the commands.
1914 The
1915 .Ar editor
1916 string is a command name,
1917 subject to search via the
1918 .Va PATH
1919 variable.
1920 The value in the
1921 .Va FCEDIT
1922 variable is used as a default when
1923 .Fl e
1924 is not specified.
1925 If
1926 .Va FCEDIT
1927 is null or unset, the value of the
1928 .Va EDITOR
1929 variable is used.
1930 If
1931 .Va EDITOR
1932 is null or unset,
1933 .Xr ed 1
1934 is used as the editor.
1935 .It Fl l No (ell)
1936 List the commands rather than invoking
1937 an editor on them.
1938 The commands are written in the
1939 sequence indicated by the
1940 .Ar first
1941 and
1942 .Ar last
1943 operands, as affected by
1944 .Fl r ,
1945 with each command preceded by the command number.
1946 .It Fl n
1947 Suppress command numbers when listing with
1948 .Fl l .
1949 .It Fl r
1950 Reverse the order of the commands listed
1951 (with
1952 .Fl l )
1953 or edited
1954 (with neither
1955 .Fl l
1956 nor
1957 .Fl s ) .
1958 .It Fl s
1959 Re-execute the command without invoking an editor.
1960 .It Ar first
1961 .It Ar last
1962 Select the commands to list or edit.
1963 The number of previous commands that can be accessed
1964 are determined by the value of the
1965 .Va HISTSIZE
1966 variable.
1967 The value of
1968 .Ar first
1969 or
1970 .Ar last
1971 or both are one of the following:
1972 .Bl -tag -width indent
1973 .It Oo Cm + Oc Ns Ar num
1974 A positive number representing a command number;
1975 command numbers can be displayed with the
1976 .Fl l
1977 option.
1978 .It Fl Ar num
1979 A negative decimal number representing the
1980 command that was executed
1981 .Ar num
1982 of
1983 commands previously.
1984 For example, \-1 is the immediately previous command.
1985 .It Ar string
1986 A string indicating the most recently entered command
1987 that begins with that string.
1988 If the
1989 .Ar old Ns = Ns Ar new
1990 operand is not also specified with
1991 .Fl s ,
1992 the string form of the first operand cannot contain an embedded equal sign.
1993 .El
1994 .El
1995 .Pp
1996 The following variables affect the execution of
1997 .Ic fc :
1998 .Bl -tag -width ".Va HISTSIZE"
1999 .It Va FCEDIT
2000 Name of the editor to use for history editing.
2001 .It Va HISTSIZE
2002 The number of previous commands that are accessible.
2003 .El
2004 .It Ic fg Op Ar job
2005 Move the specified
2006 .Ar job
2007 or the current job to the foreground.
2008 .It Ic getopts Ar optstring var
2009 The
2010 .Tn POSIX
2011 .Ic getopts
2012 command.
2013 The
2014 .Ic getopts
2015 command deprecates the older
2016 .Xr getopt 1
2017 command.
2018 The first argument should be a series of letters, each possibly
2019 followed by a colon which indicates that the option takes an argument.
2020 The specified variable is set to the parsed option.
2021 The index of
2022 the next argument is placed into the shell variable
2023 .Va OPTIND .
2024 If an option takes an argument, it is placed into the shell variable
2025 .Va OPTARG .
2026 If an invalid option is encountered,
2027 .Ar var
2028 is set to
2029 .Ql \&? .
2030 It returns a false value (1) when it encounters the end of the options.
2031 .It Ic hash Oo Fl rv Oc Op Ar command ...
2032 The shell maintains a hash table which remembers the locations of commands.
2033 With no arguments whatsoever, the
2034 .Ic hash
2035 command prints out the contents of this table.
2036 Entries which have not been looked at since the last
2037 .Ic cd
2038 command are marked with an asterisk;
2039 it is possible for these entries to be invalid.
2040 .Pp
2041 With arguments, the
2042 .Ic hash
2043 command removes each specified
2044 .Ar command
2045 from the hash table (unless they are functions) and then locates it.
2046 With the
2047 .Fl v
2048 option,
2049 .Ic hash
2050 prints the locations of the commands as it finds them.
2051 The
2052 .Fl r
2053 option causes the
2054 .Ic hash
2055 command to delete all the entries in the hash table except for functions.
2056 .It Ic jobid Op Ar job
2057 Print the process IDs of the processes in the specified
2058 .Ar job .
2059 If the
2060 .Ar job
2061 argument is omitted, use the current job.
2062 .It Ic jobs Oo Fl lps Oc Op Ar job ...
2063 Print information about the specified jobs, or all jobs if no
2064 .Ar job
2065 argument is given.
2066 The information printed includes job ID, status and command name.
2067 .Pp
2068 If the
2069 .Fl l
2070 option is specified, the PID of each job is also printed.
2071 If the
2072 .Fl p
2073 option is specified, only the process IDs for the process group leaders
2074 are printed, one per line.
2075 If the
2076 .Fl s
2077 option is specified, only the PIDs of the job commands are printed, one per
2078 line.
2079 .It Ic local Oo Ar variable ... Oc Op Fl
2080 See the
2081 .Sx Functions
2082 subsection.
2083 .It Ic pwd Op Fl L | P
2084 Print the path of the current directory.
2085 The built-in command may
2086 differ from the program of the same name because the
2087 built-in command remembers what the current directory
2088 is rather than recomputing it each time.
2089 This makes
2090 it faster.
2091 However, if the current directory is
2092 renamed,
2093 the built-in version of
2094 .Xr pwd 1
2095 will continue to print the old name for the directory.
2096 .Pp
2097 If the
2098 .Fl P
2099 option is specified, symbolic links are resolved.
2100 If the
2101 .Fl L
2102 option is specified, the shell's notion of the current directory
2103 is printed (symbolic links are not resolved).
2104 This is the default.
2105 .It Ic read Oo Fl p Ar prompt Oc Oo
2106 .Fl t Ar timeout Oc Oo Fl er Oc Ar variable ...
2107 The
2108 .Ar prompt
2109 is printed if the
2110 .Fl p
2111 option is specified
2112 and the standard input is a terminal.
2113 Then a line is
2114 read from the standard input.
2115 The trailing newline
2116 is deleted from the line and the line is split as
2117 described in the section on
2118 .Sx White Space Splitting (Field Splitting)
2119 above, and
2120 the pieces are assigned to the variables in order.
2121 If there are more pieces than variables, the remaining
2122 pieces (along with the characters in
2123 .Va IFS
2124 that separated them)
2125 are assigned to the last variable.
2126 If there are more variables than pieces, the remaining
2127 variables are assigned the null string.
2128 .Pp
2129 Backslashes are treated specially, unless the
2130 .Fl r
2131 option is
2132 specified.
2133 If a backslash is followed by
2134 a newline, the backslash and the newline will be
2135 deleted.
2136 If a backslash is followed by any other
2137 character, the backslash will be deleted and the following
2138 character will be treated as though it were not in
2139 .Va IFS ,
2140 even if it is.
2141 .Pp
2142 If the
2143 .Fl t
2144 option is specified and the
2145 .Ar timeout
2146 elapses before a complete line of input is supplied,
2147 the
2148 .Ic read
2149 command will return an exit status of 1 without assigning any values.
2150 The
2151 .Ar timeout
2152 value may optionally be followed by one of
2153 .Ql s ,
2154 .Ql m
2155 or
2156 .Ql h
2157 to explicitly specify seconds, minutes or hours.
2158 If none is supplied,
2159 .Ql s
2160 is assumed.
2161 .Pp
2162 The
2163 .Fl e
2164 option exists only for backward compatibility with older scripts.
2165 .It Ic readonly Oo Fl p Oc Op Ar name ...
2166 Each specified
2167 .Ar name
2168 is marked as read only,
2169 so that it cannot be subsequently modified or unset.
2170 The shell allows the value of a variable to be set
2171 at the same time as it is marked read only
2172 by using the following form:
2173 .Pp
2174 .D1 Ic readonly Ar name Ns = Ns Ar value
2175 .Pp
2176 With no arguments the
2177 .Ic readonly
2178 command lists the names of all read only variables.
2179 If the
2180 .Fl p
2181 option is specified, the read-only variables are printed as
2182 .Dq Ic readonly Ar name Ns = Ns Ar value
2183 lines, suitable for re-input to the shell.
2184 .It Ic return Op Ar exitstatus
2185 See the
2186 .Sx Functions
2187 subsection.
2188 .It Ic set Oo Fl /+abCEefIimnpTuVvx Oc Oo Fl /+o Ar longname Oc Oo
2189 .Fl c Ar string Oc Op Fl - Ar arg ...
2190 The
2191 .Ic set
2192 command performs three different functions:
2193 .Bl -item
2194 .It
2195 With no arguments, it lists the values of all shell variables.
2196 .It
2197 If options are given,
2198 either in short form or using the long
2199 .Dq Fl /+o Ar longname
2200 form,
2201 it sets or clears the specified options as described in the section called
2202 .Sx Argument List Processing .
2203 .It
2204 If the
2205 .Dq Fl -
2206 option is specified,
2207 .Ic set
2208 will replace the shell's positional parameters with the subsequent
2209 arguments.
2210 If no arguments follow the
2211 .Dq Fl -
2212 option,
2213 all the positional parameters will be cleared,
2214 which is equivalent to executing the command
2215 .Dq Li "shift $#" .
2216 The
2217 .Dq Fl -
2218 flag may be omitted when specifying arguments to be used
2219 as positional replacement parameters.
2220 This is not recommended,
2221 because the first argument may begin with a dash
2222 .Pq Ql -
2223 or a plus
2224 .Pq Ql + ,
2225 which the
2226 .Ic set
2227 command will interpret as a request to enable or disable options.
2228 .El
2229 .It Ic setvar Ar variable value
2230 Assigns the specified
2231 .Ar value
2232 to the specified
2233 .Ar variable .
2234 The
2235 .Ic setvar
2236 command is intended to be used in functions that
2237 assign values to variables whose names are passed as parameters.
2238 In general it is better to write
2239 .Dq Ar variable Ns = Ns Ar value
2240 rather than using
2241 .Ic setvar .
2242 .It Ic shift Op Ar n
2243 Shift the positional parameters
2244 .Ar n
2245 times, or once if
2246 .Ar n
2247 is not specified.
2248 A shift sets the value of
2249 .Li $1
2250 to the value of
2251 .Li $2 ,
2252 the value of
2253 .Li $2
2254 to the value of
2255 .Li $3 ,
2256 and so on,
2257 decreasing the value of
2258 .Li $#
2259 by one.
2260 If there are zero positional parameters, shifting does not do anything.
2261 .It Ic test
2262 A built-in equivalent of
2263 .Xr test 1 .
2264 .It Ic times
2265 Print the amount of time spent executing the shell and its children.
2266 The first output line shows the user and system times for the shell
2267 itself, the second one contains the user and system times for the
2268 children.
2269 .It Ic trap Oo Ar action Oc Ar signal ...
2270 .It Ic trap Fl l
2271 Cause the shell to parse and execute
2272 .Ar action
2273 when any specified
2274 .Ar signal
2275 is received.
2276 The signals are specified by name or number.
2277 In addition, the pseudo-signal
2278 .Cm EXIT
2279 may be used to specify an
2280 .Ar action
2281 that is performed when the shell terminates.
2282 The
2283 .Ar action
2284 may be an empty string or a dash
2285 .Pq Ql - ;
2286 the former causes the specified signal to be ignored
2287 and the latter causes the default action to be taken.
2288 Omitting the
2289 .Ar action
2290 is another way to request the default action, for compatibility reasons this
2291 usage is not recommended though.
2292 When the shell forks off a subshell,
2293 it resets trapped (but not ignored) signals to the default action.
2294 The
2295 .Ic trap
2296 command has no effect on signals that were ignored on entry to the shell.
2297 .Pp
2298 Option
2299 .Fl l
2300 causes the
2301 .Ic trap
2302 command to display a list of valid signal names.
2303 .It Ic true
2304 A null command that returns a 0 (true) exit value.
2305 .It Ic type Op Ar name ...
2306 Interpret each
2307 .Ar name
2308 as a command and print the resolution of the command search.
2309 Possible resolutions are:
2310 shell keyword, alias, special shell builtin, shell builtin, command,
2311 tracked alias
2312 and not found.
2313 For aliases the alias expansion is printed;
2314 for commands and tracked aliases
2315 the complete pathname of the command is printed.
2316 .It Ic ulimit Oo Fl HSabcdflmnpstuvw Oc Op Ar limit
2317 Set or display resource limits (see
2318 .Xr getrlimit 2 ) .
2319 If
2320 .Ar limit
2321 is specified, the named resource will be set;
2322 otherwise the current resource value will be displayed.
2323 .Pp
2324 If
2325 .Fl H
2326 is specified, the hard limits will be set or displayed.
2327 While everybody is allowed to reduce a hard limit,
2328 only the superuser can increase it.
2329 The
2330 .Fl S
2331 option
2332 specifies the soft limits instead.
2333 When displaying limits,
2334 only one of
2335 .Fl S
2336 or
2337 .Fl H
2338 can be given.
2339 The default is to display the soft limits,
2340 and to set both the hard and the soft limits.
2341 .Pp
2342 Option
2343 .Fl a
2344 causes the
2345 .Ic ulimit
2346 command to display all resources.
2347 The parameter
2348 .Ar limit
2349 is not acceptable in this mode.
2350 .Pp
2351 The remaining options specify which resource value is to be
2352 displayed or modified.
2353 They are mutually exclusive.
2354 .Bl -tag -width indent
2355 .It Fl b Ar sbsize
2356 The maximum size of socket buffer usage, in bytes.
2357 .It Fl c Ar coredumpsize
2358 The maximal size of core dump files, in 512-byte blocks.
2359 .It Fl d Ar datasize
2360 The maximal size of the data segment of a process, in kilobytes.
2361 .It Fl f Ar filesize
2362 The maximal size of a file, in 512-byte blocks.
2363 .It Fl l Ar lockedmem
2364 The maximal size of memory that can be locked by a process, in
2365 kilobytes.
2366 .It Fl m Ar memoryuse
2367 The maximal resident set size of a process, in kilobytes.
2368 .It Fl n Ar nofiles
2369 The maximal number of descriptors that could be opened by a process.
2370 .It Fl p Ar pseudoterminals
2371 The maximal number of pseudo-terminals for this user ID.
2372 .It Fl s Ar stacksize
2373 The maximal size of the stack segment, in kilobytes.
2374 .It Fl t Ar time
2375 The maximal amount of CPU time to be used by each process, in seconds.
2376 .It Fl u Ar userproc
2377 The maximal number of simultaneous processes for this user ID.
2378 .It Fl v Ar virtualmem
2379 The maximal virtual size of a process, in kilobytes.
2380 .It Fl w Ar swapuse
2381 The maximum amount of swap space reserved or used for this user ID,
2382 in kilobytes.
2383 .El
2384 .It Ic umask Oo Fl S Oc Op Ar mask
2385 Set the file creation mask (see
2386 .Xr umask 2 )
2387 to the octal or symbolic (see
2388 .Xr chmod 1 )
2389 value specified by
2390 .Ar mask .
2391 If the argument is omitted, the current mask value is printed.
2392 If the
2393 .Fl S
2394 option is specified, the output is symbolic, otherwise the output is octal.
2395 .It Ic unalias Oo Fl a Oc Op Ar name ...
2396 The specified alias names are removed.
2397 If
2398 .Fl a
2399 is specified, all aliases are removed.
2400 .It Ic unset Oo Fl fv Oc Ar name ...
2401 The specified variables or functions are unset and unexported.
2402 If the
2403 .Fl v
2404 option is specified or no options are given, the
2405 .Ar name
2406 arguments are treated as variable names.
2407 If the
2408 .Fl f
2409 option is specified, the
2410 .Ar name
2411 arguments are treated as function names.
2412 .It Ic wait Op Ar job
2413 Wait for the specified
2414 .Ar job
2415 to complete and return the exit status of the last process in the
2416 .Ar job .
2417 If the argument is omitted, wait for all jobs to complete
2418 and return an exit status of zero.
2419 .El
2420 .Ss Commandline Editing
2421 When
2422 .Nm
2423 is being used interactively from a terminal, the current command
2424 and the command history
2425 (see
2426 .Ic fc
2427 in
2428 .Sx Built-in Commands )
2429 can be edited using
2430 .Nm vi Ns -mode
2431 command line editing.
2432 This mode uses commands similar
2433 to a subset of those described in the
2434 .Xr vi 1
2435 man page.
2436 The command
2437 .Dq Li "set -o vi"
2438 (or
2439 .Dq Li "set -V" )
2440 enables
2441 .Nm vi Ns -mode
2442 editing and places
2443 .Nm
2444 into
2445 .Nm vi
2446 insert mode.
2447 With
2448 .Nm vi Ns -mode
2449 enabled,
2450 .Nm
2451 can be switched between insert mode and command mode by typing
2452 .Aq ESC .
2453 Hitting
2454 .Aq return
2455 while in command mode will pass the line to the shell.
2456 .Pp
2457 Similarly, the
2458 .Dq Li "set -o emacs"
2459 (or
2460 .Dq Li "set -E" )
2461 command can be used to enable a subset of
2462 .Nm emacs Ns -style
2463 command line editing features.
2464 .Sh ENVIRONMENT
2465 The following environment variables affect the execution of
2466 .Nm :
2467 .Bl -tag -width ".Ev LANGXXXXXX"
2468 .It Ev ENV
2469 Initialization file for interactive shells.
2470 .It Ev LANG , Ev LC_*
2471 Locale settings.
2472 These are inherited by children of the shell,
2473 and is used in a limited manner by the shell itself.
2474 .It Ev PWD
2475 An absolute pathname for the current directory,
2476 possibly containing symbolic links.
2477 This is used and updated by the shell.
2478 .It Ev TERM
2479 The default terminal setting for the shell.
2480 This is inherited by children of the shell, and is used in the history
2481 editing modes.
2482 .El
2483 .Pp
2484 Additionally, all environment variables are turned into shell variables
2485 at startup,
2486 which may affect the shell as described under
2487 .Sx Special Variables .
2488 .Sh EXIT STATUS
2489 Errors that are detected by the shell, such as a syntax error, will
2490 cause the shell to exit with a non-zero exit status.
2491 If the shell is not an interactive shell, the execution of the shell
2492 file will be aborted.
2493 Otherwise the shell will return the exit status of the last command
2494 executed, or if the
2495 .Ic exit
2496 builtin is used with a numeric argument, it
2497 will return the argument.
2498 .Sh SEE ALSO
2499 .Xr builtin 1 ,
2500 .Xr chsh 1 ,
2501 .Xr echo 1 ,
2502 .Xr ed 1 ,
2503 .Xr emacs 1 ,
2504 .Xr pwd 1 ,
2505 .Xr test 1 ,
2506 .Xr vi 1 ,
2507 .Xr execve 2 ,
2508 .Xr getrlimit 2 ,
2509 .Xr umask 2 ,
2510 .Xr editrc 5
2511 .Sh HISTORY
2512 A
2513 .Nm
2514 command, the Thompson shell, appeared in
2515 .At v1 .
2516 It was superseded in
2517 .At v7
2518 by the Bourne shell, which inherited the name
2519 .Nm .
2520 .Pp
2521 This version of
2522 .Nm
2523 was rewritten in 1989 under the
2524 .Bx
2525 license after the Bourne shell from
2526 .At V.4 .
2527 .Sh AUTHORS
2528 This version of
2529 .Nm
2530 was originally written by
2531 .An Kenneth Almquist .
2532 .Sh BUGS
2533 The
2534 .Nm
2535 utility does not recognize multibyte characters.