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