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