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