]>
Commit | Line | Data |
---|---|---|
0628567a | 1 | .\" |
726f6388 JA |
2 | .\" MAN PAGE COMMENTS to |
3 | .\" | |
4 | .\" Chet Ramey | |
726f6388 | 5 | .\" Case Western Reserve University |
95732b49 | 6 | .\" chet@po.cwru.edu |
726f6388 | 7 | .\" |
0001803f | 8 | .\" Last Change: Tue Dec 29 15:36:16 EST 2009 |
726f6388 JA |
9 | .\" |
10 | .\" bash_builtins, strip all but Built-Ins section | |
11 | .if \n(zZ=1 .ig zZ | |
bb70624e | 12 | .if \n(zY=1 .ig zY |
0001803f | 13 | .TH BASH 1 "2009 December 29" "GNU Bash-4.1" |
726f6388 JA |
14 | .\" |
15 | .\" There's some problem with having a `@' | |
16 | .\" in a tagged paragraph with the BSD man macros. | |
17 | .\" It has to do with `@' appearing in the }1 macro. | |
18 | .\" This is a problem on 4.3 BSD and Ultrix, but Sun | |
19 | .\" appears to have fixed it. | |
20 | .\" If you're seeing the characters | |
21 | .\" `@u-3p' appearing before the lines reading | |
22 | .\" `possible-hostname-completions | |
23 | .\" and `complete-hostname' down in READLINE, | |
24 | .\" then uncomment this redefinition. | |
25 | .\" | |
26 | .de }1 | |
27 | .ds ]X \&\\*(]B\\ | |
28 | .nr )E 0 | |
29 | .if !"\\$1"" .nr )I \\$1n | |
30 | .}f | |
31 | .ll \\n(LLu | |
32 | .in \\n()Ru+\\n(INu+\\n()Iu | |
33 | .ti \\n(INu | |
34 | .ie !\\n()Iu+\\n()Ru-\w\a\\*(]X\au-3p \{\\*(]X | |
35 | .br\} | |
36 | .el \\*(]X\h\a|\\n()Iu+\\n()Ru\a\c | |
37 | .}f | |
38 | .. | |
39 | .\" | |
40 | .\" File Name macro. This used to be `.PN', for Path Name, | |
41 | .\" but Sun doesn't seem to like that very much. | |
42 | .\" | |
43 | .de FN | |
44 | \fI\|\\$1\|\fP | |
45 | .. | |
46 | .SH NAME | |
ccc6cda3 | 47 | bash \- GNU Bourne-Again SHell |
726f6388 JA |
48 | .SH SYNOPSIS |
49 | .B bash | |
50 | [options] | |
51 | [file] | |
52 | .SH COPYRIGHT | |
3185942a JA |
53 | .if n Bash is Copyright (C) 1989-2009 by the Free Software Foundation, Inc. |
54 | .if t Bash is Copyright \(co 1989-2009 by the Free Software Foundation, Inc. | |
726f6388 JA |
55 | .SH DESCRIPTION |
56 | .B Bash | |
ccc6cda3 | 57 | is an \fBsh\fR-compatible command language interpreter that |
726f6388 JA |
58 | executes commands read from the standard input or from a file. |
59 | .B Bash | |
60 | also incorporates useful features from the \fIKorn\fP and \fIC\fP | |
61 | shells (\fBksh\fP and \fBcsh\fP). | |
62 | .PP | |
63 | .B Bash | |
0628567a JA |
64 | is intended to be a conformant implementation of the |
65 | Shell and Utilities portion of the IEEE POSIX specification | |
66 | (IEEE Standard 1003.1). | |
95732b49 JA |
67 | .B Bash |
68 | can be configured to be POSIX-conformant by default. | |
726f6388 | 69 | .SH OPTIONS |
ccc6cda3 | 70 | In addition to the single-character shell options documented in the |
726f6388 | 71 | description of the \fBset\fR builtin command, \fBbash\fR |
cce855bc | 72 | interprets the following options when it is invoked: |
726f6388 JA |
73 | .PP |
74 | .PD 0 | |
75 | .TP 10 | |
76 | .BI \-c "\| string\^" | |
ccc6cda3 | 77 | If the |
726f6388 | 78 | .B \-c |
cce855bc | 79 | option is present, then commands are read from |
726f6388 JA |
80 | .IR string . |
81 | If there are arguments after the | |
82 | .IR string , | |
83 | they are assigned to the positional parameters, starting with | |
84 | .BR $0 . | |
85 | .TP | |
7117c2d2 JA |
86 | .B \-i |
87 | If the | |
88 | .B \-i | |
89 | option is present, the shell is | |
90 | .IR interactive . | |
91 | .TP | |
92 | .B \-l | |
93 | Make | |
94 | .B bash | |
95 | act as if it had been invoked as a login shell (see | |
96 | .SM | |
97 | .B INVOCATION | |
98 | below). | |
99 | .TP | |
ccc6cda3 JA |
100 | .B \-r |
101 | If the | |
102 | .B \-r | |
cce855bc | 103 | option is present, the shell becomes |
ccc6cda3 JA |
104 | .I restricted |
105 | (see | |
106 | .SM | |
107 | .B "RESTRICTED SHELL" | |
108 | below). | |
109 | .TP | |
726f6388 JA |
110 | .B \-s |
111 | If the | |
112 | .B \-s | |
cce855bc | 113 | option is present, or if no arguments remain after option |
726f6388 JA |
114 | processing, then commands are read from the standard input. |
115 | This option allows the positional parameters to be set | |
116 | when invoking an interactive shell. | |
117 | .TP | |
ccc6cda3 JA |
118 | .B \-D |
119 | A list of all double-quoted strings preceded by \fB$\fP | |
95732b49 | 120 | is printed on the standard output. |
ccc6cda3 JA |
121 | These are the strings that |
122 | are subject to language translation when the current locale | |
28ef6c31 | 123 | is not \fBC\fP or \fBPOSIX\fP. |
ccc6cda3 JA |
124 | This implies the \fB\-n\fP option; no commands will be executed. |
125 | .TP | |
f73dda09 JA |
126 | .B [\-+]O [\fIshopt_option\fP] |
127 | \fIshopt_option\fP is one of the shell options accepted by the | |
128 | \fBshopt\fP builtin (see | |
129 | .SM | |
130 | .B SHELL BUILTIN COMMANDS | |
131 | below). | |
132 | If \fIshopt_option\fP is present, \fB\-O\fP sets the value of that option; | |
133 | \fB+O\fP unsets it. | |
134 | If \fIshopt_option\fP is not supplied, the names and values of the shell | |
135 | options accepted by \fBshopt\fP are printed on the standard output. | |
136 | If the invocation option is \fB+O\fP, the output is displayed in a format | |
137 | that may be reused as input. | |
138 | .TP | |
ccc6cda3 JA |
139 | .B \-\- |
140 | A | |
141 | .B \-\- | |
726f6388 JA |
142 | signals the end of options and disables further option processing. |
143 | Any arguments after the | |
726f6388 | 144 | .B \-\- |
ccc6cda3 JA |
145 | are treated as filenames and arguments. An argument of |
146 | .B \- | |
147 | is equivalent to \fB\-\-\fP. | |
726f6388 JA |
148 | .PD |
149 | .PP | |
150 | .B Bash | |
ccc6cda3 JA |
151 | also interprets a number of multi-character options. |
152 | These options must appear on the command line before the | |
7117c2d2 | 153 | single-character options to be recognized. |
726f6388 JA |
154 | .PP |
155 | .PD 0 | |
726f6388 | 156 | .TP |
b80f6443 JA |
157 | .B \-\-debugger |
158 | Arrange for the debugger profile to be executed before the shell | |
95732b49 JA |
159 | starts. |
160 | Turns on extended debugging mode (see the description of the | |
b80f6443 JA |
161 | .B extdebug |
162 | option to the | |
163 | .B shopt | |
95732b49 JA |
164 | builtin below) |
165 | and shell function tracing (see the description of the | |
b80f6443 JA |
166 | \fB\-o functrace\fP option to the |
167 | .B set | |
168 | builtin below). | |
169 | .TP | |
cce855bc JA |
170 | .B \-\-dump\-po\-strings |
171 | Equivalent to \fB\-D\fP, but the output is in the GNU \fIgettext\fP | |
172 | \fBpo\fP (portable object) file format. | |
173 | .TP | |
ccc6cda3 JA |
174 | .B \-\-dump\-strings |
175 | Equivalent to \fB\-D\fP. | |
176 | .TP | |
177 | .B \-\-help | |
178 | Display a usage message on standard output and exit successfully. | |
179 | .TP | |
28ef6c31 | 180 | \fB\-\-init\-file\fP \fIfile\fP |
7117c2d2 | 181 | .PD 0 |
28ef6c31 JA |
182 | .TP |
183 | \fB\-\-rcfile\fP \fIfile\fP | |
184 | .PD | |
185 | Execute commands from | |
186 | .I file | |
187 | instead of the standard personal initialization file | |
188 | .I ~/.bashrc | |
189 | if the shell is interactive (see | |
190 | .SM | |
191 | .B INVOCATION | |
192 | below). | |
193 | .TP | |
ccc6cda3 | 194 | .B \-\-login |
7117c2d2 | 195 | Equivalent to \fB\-l\fP. |
ccc6cda3 JA |
196 | .TP |
197 | .B \-\-noediting | |
198 | Do not use the GNU | |
199 | .B readline | |
bb70624e | 200 | library to read command lines when the shell is interactive. |
ccc6cda3 JA |
201 | .TP |
202 | .B \-\-noprofile | |
203 | Do not read either the system-wide startup file | |
726f6388 JA |
204 | .FN /etc/profile |
205 | or any of the personal initialization files | |
206 | .IR ~/.bash_profile , | |
207 | .IR ~/.bash_login , | |
208 | or | |
209 | .IR ~/.profile . | |
210 | By default, | |
211 | .B bash | |
ccc6cda3 | 212 | reads these files when it is invoked as a login shell (see |
726f6388 JA |
213 | .SM |
214 | .B INVOCATION | |
215 | below). | |
216 | .TP | |
ccc6cda3 JA |
217 | .B \-\-norc |
218 | Do not read and execute the personal initialization file | |
219 | .I ~/.bashrc | |
220 | if the shell is interactive. | |
221 | This option is on by default if the shell is invoked as | |
222 | .BR sh . | |
223 | .TP | |
224 | .B \-\-posix | |
225 | Change the behavior of \fBbash\fP where the default operation differs | |
0628567a | 226 | from the POSIX standard to match the standard (\fIposix mode\fP). |
726f6388 | 227 | .TP |
ccc6cda3 JA |
228 | .B \-\-restricted |
229 | The shell becomes restricted (see | |
230 | .SM | |
231 | .B "RESTRICTED SHELL" | |
726f6388 JA |
232 | below). |
233 | .TP | |
ccc6cda3 JA |
234 | .B \-\-verbose |
235 | Equivalent to \fB\-v\fP. | |
726f6388 | 236 | .TP |
ccc6cda3 JA |
237 | .B \-\-version |
238 | Show version information for this instance of | |
239 | .B bash | |
240 | on the standard output and exit successfully. | |
726f6388 JA |
241 | .PD |
242 | .SH ARGUMENTS | |
243 | If arguments remain after option processing, and neither the | |
244 | .B \-c | |
245 | nor the | |
246 | .B \-s | |
247 | option has been supplied, the first argument is assumed to | |
ccc6cda3 JA |
248 | be the name of a file containing shell commands. |
249 | If | |
726f6388 JA |
250 | .B bash |
251 | is invoked in this fashion, | |
252 | .B $0 | |
253 | is set to the name of the file, and the positional parameters | |
254 | are set to the remaining arguments. | |
255 | .B Bash | |
256 | reads and executes commands from this file, then exits. | |
ccc6cda3 JA |
257 | \fBBash\fP's exit status is the exit status of the last command |
258 | executed in the script. | |
259 | If no commands are executed, the exit status is 0. | |
f73dda09 JA |
260 | An attempt is first made to open the file in the current directory, and, |
261 | if no file is found, then the shell searches the directories in | |
262 | .SM | |
263 | .B PATH | |
264 | for the script. | |
ccc6cda3 JA |
265 | .SH INVOCATION |
266 | A \fIlogin shell\fP is one whose first character of argument zero is a | |
267 | .BR \- , | |
268 | or one started with the | |
269 | .B \-\-login | |
270 | option. | |
271 | .PP | |
bb70624e JA |
272 | An \fIinteractive\fP shell is one started without non-option arguments |
273 | and without the | |
274 | .B \-c | |
275 | option | |
b80f6443 | 276 | whose standard input and error are |
ccc6cda3 JA |
277 | both connected to terminals (as determined by |
278 | .IR isatty (3)), | |
279 | or one started with the | |
280 | .B \-i | |
281 | option. | |
282 | .SM | |
283 | .B PS1 | |
284 | is set and | |
285 | .B $\- | |
286 | includes | |
287 | .B i | |
288 | if | |
289 | .B bash | |
290 | is interactive, | |
291 | allowing a shell script or a startup file to test this state. | |
292 | .PP | |
293 | The following paragraphs describe how | |
294 | .B bash | |
295 | executes its startup files. | |
296 | If any of the files exist but cannot be read, | |
297 | .B bash | |
298 | reports an error. | |
299 | Tildes are expanded in file names as described below under | |
300 | .B "Tilde Expansion" | |
301 | in the | |
302 | .SM | |
303 | .B EXPANSION | |
304 | section. | |
305 | .PP | |
306 | When | |
307 | .B bash | |
b72432fd JA |
308 | is invoked as an interactive login shell, or as a non-interactive shell |
309 | with the \fB\-\-login\fP option, it first reads and | |
d166f048 JA |
310 | executes commands from the file \fI/etc/profile\fP, if that |
311 | file exists. | |
ccc6cda3 JA |
312 | After reading that file, it looks for \fI~/.bash_profile\fP, |
313 | \fI~/.bash_login\fP, and \fI~/.profile\fP, in that order, and reads | |
314 | and executes commands from the first one that exists and is readable. | |
315 | The | |
316 | .B \-\-noprofile | |
317 | option may be used when the shell is started to inhibit this behavior. | |
318 | .PP | |
319 | When a login shell exits, | |
320 | .B bash | |
321 | reads and executes commands from the file \fI~/.bash_logout\fP, if it | |
322 | exists. | |
323 | .PP | |
324 | When an interactive shell that is not a login shell is started, | |
325 | .B bash | |
326 | reads and executes commands from \fI~/.bashrc\fP, if that file exists. | |
327 | This may be inhibited by using the | |
328 | .B \-\-norc | |
329 | option. | |
330 | The \fB\-\-rcfile\fP \fIfile\fP option will force | |
331 | .B bash | |
332 | to read and execute commands from \fIfile\fP instead of \fI~/.bashrc\fP. | |
333 | .PP | |
334 | When | |
335 | .B bash | |
336 | is started non-interactively, to run a shell script, for example, it | |
337 | looks for the variable | |
338 | .SM | |
339 | .B BASH_ENV | |
340 | in the environment, expands its value if it appears there, and uses the | |
341 | expanded value as the name of a file to read and execute. | |
342 | .B Bash | |
343 | behaves as if the following command were executed: | |
344 | .sp .5 | |
345 | .RS | |
28ef6c31 JA |
346 | .if t \f(CWif [ \-n "$BASH_ENV" ]; then . "$BASH_ENV"; fi\fP |
347 | .if n if [ \-n "$BASH_ENV" ]; then . "$BASH_ENV"; fi | |
ccc6cda3 JA |
348 | .RE |
349 | .sp .5 | |
350 | but the value of the | |
351 | .SM | |
352 | .B PATH | |
353 | variable is not used to search for the file name. | |
354 | .PP | |
355 | If | |
356 | .B bash | |
357 | is invoked with the name | |
358 | .BR sh , | |
359 | it tries to mimic the startup behavior of historical versions of | |
360 | .B sh | |
361 | as closely as possible, | |
362 | while conforming to the POSIX standard as well. | |
b72432fd JA |
363 | When invoked as an interactive login shell, or a non-interactive |
364 | shell with the \fB\-\-login\fP option, it first attempts to | |
cce855bc | 365 | read and execute commands from |
ccc6cda3 JA |
366 | .I /etc/profile |
367 | and | |
368 | .IR ~/.profile , | |
369 | in that order. | |
370 | The | |
371 | .B \-\-noprofile | |
372 | option may be used to inhibit this behavior. | |
373 | When invoked as an interactive shell with the name | |
374 | .BR sh , | |
375 | .B bash | |
376 | looks for the variable | |
377 | .SM | |
378 | .BR ENV , | |
379 | expands its value if it is defined, and uses the | |
380 | expanded value as the name of a file to read and execute. | |
381 | Since a shell invoked as | |
382 | .B sh | |
383 | does not attempt to read and execute commands from any other startup | |
384 | files, the | |
385 | .B \-\-rcfile | |
386 | option has no effect. | |
387 | A non-interactive shell invoked with the name | |
388 | .B sh | |
b72432fd | 389 | does not attempt to read any other startup files. |
ccc6cda3 JA |
390 | When invoked as |
391 | .BR sh , | |
392 | .B bash | |
393 | enters | |
394 | .I posix | |
395 | mode after the startup files are read. | |
396 | .PP | |
397 | When | |
398 | .B bash | |
399 | is started in | |
400 | .I posix | |
401 | mode, as with the | |
402 | .B \-\-posix | |
403 | command line option, it follows the POSIX standard for startup files. | |
cce855bc | 404 | In this mode, interactive shells expand the |
ccc6cda3 JA |
405 | .SM |
406 | .B ENV | |
cce855bc | 407 | variable and commands are read and executed from the file |
ccc6cda3 JA |
408 | whose name is the expanded value. |
409 | No other startup files are read. | |
ccc6cda3 JA |
410 | .PP |
411 | .B Bash | |
3185942a JA |
412 | attempts to determine when it is being run with its standard input |
413 | connected to a a network connection, as if by the remote shell | |
414 | daemon, usually \fIrshd\fP, or the secure shell daemon \fIsshd\fP. | |
ccc6cda3 JA |
415 | If |
416 | .B bash | |
3185942a | 417 | determines it is being run in this fashion, it reads and executes |
ccc6cda3 JA |
418 | commands from \fI~/.bashrc\fP, if that file exists and is readable. |
419 | It will not do this if invoked as \fBsh\fP. | |
420 | The | |
421 | .B \-\-norc | |
422 | option may be used to inhibit this behavior, and the | |
423 | .B \-\-rcfile | |
424 | option may be used to force another file to be read, but | |
425 | \fIrshd\fP does not generally invoke the shell with those options | |
426 | or allow them to be specified. | |
b72432fd JA |
427 | .PP |
428 | If the shell is started with the effective user (group) id not equal to the | |
429 | real user (group) id, and the \fB\-p\fP option is not supplied, no startup | |
f73dda09 JA |
430 | files are read, shell functions are not inherited from the environment, the |
431 | .SM | |
0001803f CR |
432 | .BR SHELLOPTS , |
433 | .SM | |
434 | .BR BASHOPTS , | |
435 | .SM | |
436 | .BR CDPATH , | |
437 | and | |
438 | .SM | |
439 | .B GLOBIGNORE | |
440 | variables, if they appear in the environment, are ignored, | |
b72432fd JA |
441 | and the effective user id is set to the real user id. |
442 | If the \fB\-p\fP option is supplied at invocation, the startup behavior is | |
443 | the same, but the effective user id is not reset. | |
726f6388 | 444 | .SH DEFINITIONS |
ccc6cda3 JA |
445 | .PP |
446 | The following definitions are used throughout the rest of this | |
447 | document. | |
726f6388 JA |
448 | .PD 0 |
449 | .TP | |
450 | .B blank | |
451 | A space or tab. | |
452 | .TP | |
453 | .B word | |
454 | A sequence of characters considered as a single unit by the shell. | |
455 | Also known as a | |
456 | .BR token . | |
457 | .TP | |
458 | .B name | |
459 | A | |
460 | .I word | |
461 | consisting only of alphanumeric characters and underscores, and | |
462 | beginning with an alphabetic character or an underscore. Also | |
463 | referred to as an | |
464 | .BR identifier . | |
465 | .TP | |
466 | .B metacharacter | |
467 | A character that, when unquoted, separates words. One of the following: | |
468 | .br | |
469 | .RS | |
470 | .PP | |
471 | .if t \fB| & ; ( ) < > space tab\fP | |
472 | .if n \fB| & ; ( ) < > space tab\fP | |
473 | .RE | |
474 | .PP | |
475 | .TP | |
476 | .B control operator | |
477 | A \fItoken\fP that performs a control function. It is one of the following | |
478 | symbols: | |
479 | .RS | |
480 | .PP | |
3185942a JA |
481 | .if t \fB\(bv\(bv & && ; ;; ( ) | |& <newline>\fP |
482 | .if n \fB|| & && ; ;; ( ) | |& <newline>\fP | |
726f6388 JA |
483 | .RE |
484 | .PD | |
485 | .SH "RESERVED WORDS" | |
486 | \fIReserved words\fP are words that have a special meaning to the shell. | |
487 | The following words are recognized as reserved when unquoted and either | |
488 | the first word of a simple command (see | |
489 | .SM | |
490 | .B SHELL GRAMMAR | |
491 | below) or the third word of a | |
492 | .B case | |
493 | or | |
494 | .B for | |
495 | command: | |
496 | .if t .RS | |
497 | .PP | |
498 | .B | |
cce855bc JA |
499 | .if n ! case do done elif else esac fi for function if in select then until while { } time [[ ]] |
500 | .if t ! case do done elif else esac fi for function if in select then until while { } time [[ ]] | |
726f6388 | 501 | .if t .RE |
726f6388 JA |
502 | .SH "SHELL GRAMMAR" |
503 | .SS Simple Commands | |
504 | .PP | |
505 | A \fIsimple command\fP is a sequence of optional variable assignments | |
ccc6cda3 | 506 | followed by \fBblank\fP-separated words and redirections, and |
726f6388 | 507 | terminated by a \fIcontrol operator\fP. The first word |
f73dda09 JA |
508 | specifies the command to be executed, and is passed as argument zero. |
509 | The remaining words are passed as arguments to the invoked command. | |
726f6388 JA |
510 | .PP |
511 | The return value of a \fIsimple command\fP is its exit status, or | |
512 | 128+\fIn\^\fP if the command is terminated by signal | |
513 | .IR n . | |
514 | .SS Pipelines | |
515 | .PP | |
516 | A \fIpipeline\fP is a sequence of one or more commands separated by | |
3185942a JA |
517 | one of the control operators |
518 | .B | | |
519 | or \fB|&\fP. | |
726f6388 JA |
520 | The format for a pipeline is: |
521 | .RS | |
522 | .PP | |
3185942a | 523 | [\fBtime\fP [\fB\-p\fP]] [ ! ] \fIcommand\fP [ [\fB|\fP\(bv\fB|&\fP] \fIcommand2\fP ... ] |
726f6388 JA |
524 | .RE |
525 | .PP | |
526 | The standard output of | |
527 | .I command | |
f73dda09 | 528 | is connected via a pipe to the standard input of |
726f6388 JA |
529 | .IR command2 . |
530 | This connection is performed before any redirections specified by the | |
531 | command (see | |
532 | .SM | |
533 | .B REDIRECTION | |
534 | below). | |
3185942a JA |
535 | If \fB|&\fP is used, the standard error of \fIcommand\fP is connected to |
536 | \fIcommand2\fP's standard input through the pipe; it is shorthand for | |
537 | \fB2>&1 |\fP. | |
538 | This implicit redirection of the standard error is performed after any | |
539 | redirections specified by the command. | |
726f6388 | 540 | .PP |
b80f6443 JA |
541 | The return status of a pipeline is the exit status of the last |
542 | command, unless the \fBpipefail\fP option is enabled. | |
543 | If \fBpipefail\fP is enabled, the pipeline's return status is the | |
544 | value of the last (rightmost) command to exit with a non-zero status, | |
545 | or zero if all commands exit successfully. | |
726f6388 JA |
546 | If the reserved word |
547 | .B ! | |
b80f6443 JA |
548 | precedes a pipeline, the exit status of that pipeline is the logical |
549 | negation of the exit status as described above. | |
ccc6cda3 | 550 | The shell waits for all commands in the pipeline to |
726f6388 JA |
551 | terminate before returning a value. |
552 | .PP | |
ccc6cda3 JA |
553 | If the |
554 | .B time | |
555 | reserved word precedes a pipeline, the elapsed as well as user and | |
556 | system time consumed by its execution are reported when the pipeline | |
557 | terminates. | |
558 | The \fB\-p\fP option changes the output format to that specified by POSIX. | |
559 | The | |
560 | .SM | |
561 | .B TIMEFORMAT | |
562 | variable may be set to a format string that specifies how the timing | |
563 | information should be displayed; see the description of | |
564 | .SM | |
565 | .B TIMEFORMAT | |
566 | under | |
567 | .B "Shell Variables" | |
568 | below. | |
569 | .PP | |
726f6388 JA |
570 | Each command in a pipeline is executed as a separate process (i.e., in a |
571 | subshell). | |
572 | .SS Lists | |
573 | .PP | |
574 | A \fIlist\fP is a sequence of one or more pipelines separated by one | |
575 | of the operators | |
576 | .BR ; , | |
577 | .BR & , | |
578 | .BR && , | |
579 | or | |
ccc6cda3 JA |
580 | .BR \(bv\(bv , |
581 | and optionally terminated by one of | |
726f6388 JA |
582 | .BR ; , |
583 | .BR & , | |
584 | or | |
585 | .BR <newline> . | |
586 | .PP | |
587 | Of these list operators, | |
588 | .B && | |
589 | and | |
ccc6cda3 | 590 | .B \(bv\(bv |
726f6388 JA |
591 | have equal precedence, followed by |
592 | .B ; | |
593 | and | |
3185942a | 594 | .BR & , |
726f6388 JA |
595 | which have equal precedence. |
596 | .PP | |
7117c2d2 JA |
597 | A sequence of one or more newlines may appear in a \fIlist\fP instead |
598 | of a semicolon to delimit commands. | |
599 | .PP | |
726f6388 JA |
600 | If a command is terminated by the control operator |
601 | .BR & , | |
602 | the shell executes the command in the \fIbackground\fP | |
603 | in a subshell. The shell does not wait for the command to | |
604 | finish, and the return status is 0. Commands separated by a | |
605 | .B ; | |
606 | are executed sequentially; the shell waits for each | |
607 | command to terminate in turn. The return status is the | |
608 | exit status of the last command executed. | |
609 | .PP | |
3185942a JA |
610 | AND and OR lists are sequences of one of more pipelines separated by the |
611 | \fB&&\fP and \fB\(bv\(bv\fP control operators, respectively. | |
612 | AND and OR lists are executed with left associativity. | |
726f6388 JA |
613 | An AND list has the form |
614 | .RS | |
615 | .PP | |
bb70624e | 616 | \fIcommand1\fP \fB&&\fP \fIcommand2\fP |
726f6388 JA |
617 | .RE |
618 | .PP | |
619 | .I command2 | |
620 | is executed if, and only if, | |
bb70624e | 621 | .I command1 |
726f6388 JA |
622 | returns an exit status of zero. |
623 | .PP | |
624 | An OR list has the form | |
625 | .RS | |
626 | .PP | |
bb70624e | 627 | \fIcommand1\fP \fB\(bv\(bv\fP \fIcommand2\fP |
726f6388 JA |
628 | .PP |
629 | .RE | |
630 | .PP | |
631 | .I command2 | |
632 | is executed if and only if | |
bb70624e | 633 | .I command1 |
3185942a JA |
634 | returns a non-zero exit status. |
635 | The return status of | |
726f6388 JA |
636 | AND and OR lists is the exit status of the last command |
637 | executed in the list. | |
638 | .SS Compound Commands | |
639 | .PP | |
640 | A \fIcompound command\fP is one of the following: | |
641 | .TP | |
642 | (\fIlist\fP) | |
b80f6443 JA |
643 | \fIlist\fP is executed in a subshell environment (see |
644 | .SM | |
645 | \fBCOMMAND EXECUTION ENVIRONMENT\fP | |
646 | below). | |
647 | Variable assignments and builtin | |
726f6388 JA |
648 | commands that affect the shell's environment do not remain in effect |
649 | after the command completes. The return status is the exit status of | |
650 | \fIlist\fP. | |
651 | .TP | |
652 | { \fIlist\fP; } | |
ccc6cda3 JA |
653 | \fIlist\fP is simply executed in the current shell environment. |
654 | \fIlist\fP must be terminated with a newline or semicolon. | |
655 | This is known as a \fIgroup command\fP. | |
656 | The return status is the exit status of | |
726f6388 | 657 | \fIlist\fP. |
b80f6443 | 658 | Note that unlike the metacharacters \fB(\fP and \fB)\fP, \fB{\fP and |
f73dda09 JA |
659 | \fB}\fP are \fIreserved words\fP and must occur where a reserved |
660 | word is permitted to be recognized. Since they do not cause a word | |
3185942a JA |
661 | break, they must be separated from \fIlist\fP by whitespace or another |
662 | shell metacharacter. | |
726f6388 | 663 | .TP |
ccc6cda3 JA |
664 | ((\fIexpression\fP)) |
665 | The \fIexpression\fP is evaluated according to the rules described | |
666 | below under | |
667 | .SM | |
668 | .BR "ARITHMETIC EVALUATION" . | |
669 | If the value of the expression is non-zero, the return status is 0; | |
670 | otherwise the return status is 1. This is exactly equivalent to | |
671 | \fBlet "\fIexpression\fP"\fR. | |
672 | .TP | |
cce855bc JA |
673 | \fB[[\fP \fIexpression\fP \fB]]\fP |
674 | Return a status of 0 or 1 depending on the evaluation of | |
675 | the conditional expression \fIexpression\fP. | |
676 | Expressions are composed of the primaries described below under | |
677 | .SM | |
678 | .BR "CONDITIONAL EXPRESSIONS" . | |
679 | Word splitting and pathname expansion are not performed on the words | |
680 | between the \fB[[\fP and \fB]]\fP; tilde expansion, parameter and | |
681 | variable expansion, arithmetic expansion, command substitution, process | |
682 | substitution, and quote removal are performed. | |
b80f6443 JA |
683 | Conditional operators such as \fB\-f\fP must be unquoted to be recognized |
684 | as primaries. | |
cce855bc JA |
685 | .if t .sp 0.5 |
686 | .if n .sp 1 | |
0001803f CR |
687 | When used with \fB[[\fP, The \fB<\fP and \fB>\fP operators sort |
688 | lexicographically using the current locale. | |
689 | .if t .sp 0.5 | |
690 | .if n .sp 1 | |
cce855bc JA |
691 | When the \fB==\fP and \fB!=\fP operators are used, the string to the |
692 | right of the operator is considered a pattern and matched according | |
693 | to the rules described below under \fBPattern Matching\fP. | |
95732b49 JA |
694 | If the shell option |
695 | .B nocasematch | |
696 | is enabled, the match is performed without regard to the case | |
697 | of alphabetic characters. | |
0628567a JA |
698 | The return value is 0 if the string matches (\fB==\fP) or does not match |
699 | (\fB!=\fP) the pattern, and 1 otherwise. | |
cce855bc JA |
700 | Any part of the pattern may be quoted to force it to be matched as a |
701 | string. | |
702 | .if t .sp 0.5 | |
703 | .if n .sp 1 | |
b80f6443 JA |
704 | An additional binary operator, \fB=~\fP, is available, with the same |
705 | precedence as \fB==\fP and \fB!=\fP. | |
706 | When it is used, the string to the right of the operator is considered | |
707 | an extended regular expression and matched accordingly (as in \fIregex\fP(3)). | |
708 | The return value is 0 if the string matches | |
709 | the pattern, and 1 otherwise. | |
710 | If the regular expression is syntactically incorrect, the conditional | |
711 | expression's return value is 2. | |
712 | If the shell option | |
95732b49 | 713 | .B nocasematch |
b80f6443 JA |
714 | is enabled, the match is performed without regard to the case |
715 | of alphabetic characters. | |
3185942a JA |
716 | Any part of the pattern may be quoted to force it to be matched as a |
717 | string. | |
b80f6443 | 718 | Substrings matched by parenthesized subexpressions within the regular |
0001803f CR |
719 | expression are saved in the array variable |
720 | .SM | |
721 | .BR BASH_REMATCH . | |
722 | The element of | |
723 | .SM | |
724 | .B BASH_REMATCH | |
725 | with index 0 is the portion of the string | |
b80f6443 | 726 | matching the entire regular expression. |
0001803f CR |
727 | The element of |
728 | .SM | |
729 | .B BASH_REMATCH | |
730 | with index \fIn\fP is the portion of the | |
b80f6443 JA |
731 | string matching the \fIn\fPth parenthesized subexpression. |
732 | .if t .sp 0.5 | |
733 | .if n .sp 1 | |
cce855bc JA |
734 | Expressions may be combined using the following operators, listed |
735 | in decreasing order of precedence: | |
736 | .if t .sp 0.5 | |
737 | .if n .sp 1 | |
738 | .RS | |
739 | .PD 0 | |
740 | .TP | |
741 | .B ( \fIexpression\fP ) | |
742 | Returns the value of \fIexpression\fP. | |
743 | This may be used to override the normal precedence of operators. | |
744 | .TP | |
745 | .B ! \fIexpression\fP | |
746 | True if | |
747 | .I expression | |
748 | is false. | |
749 | .TP | |
750 | \fIexpression1\fP \fB&&\fP \fIexpression2\fP | |
751 | True if both | |
752 | .I expression1 | |
753 | and | |
754 | .I expression2 | |
755 | are true. | |
756 | .TP | |
757 | .if t \fIexpression1\fP \fB\(bv\(bv\fP \fIexpression2\fP | |
758 | .if n \fIexpression1\fP \fB||\fP \fIexpression2\fP | |
759 | True if either | |
760 | .I expression1 | |
761 | or | |
762 | .I expression2 | |
763 | is true. | |
764 | .PD | |
cce855bc JA |
765 | .LP |
766 | The \fB&&\fP and | |
767 | .if t \fB\(bv\(bv\fP | |
768 | .if n \fB||\fP | |
7117c2d2 | 769 | operators do not evaluate \fIexpression2\fP if the value of |
cce855bc JA |
770 | \fIexpression1\fP is sufficient to determine the return value of |
771 | the entire conditional expression. | |
f73dda09 | 772 | .RE |
cce855bc | 773 | .TP |
0001803f | 774 | \fBfor\fP \fIname\fP [ [ \fBin\fP [ \fIword ...\fP ] ] ; ] \fBdo\fP \fIlist\fP ; \fBdone\fP |
726f6388 | 775 | The list of words following \fBin\fP is expanded, generating a list |
bb70624e JA |
776 | of items. |
777 | The variable \fIname\fP is set to each element of this list | |
778 | in turn, and \fIlist\fP is executed each time. | |
779 | If the \fBin\fP \fIword\fP is omitted, the \fBfor\fP command executes | |
780 | \fIlist\fP once for each positional parameter that is set (see | |
726f6388 JA |
781 | .SM |
782 | .B PARAMETERS | |
783 | below). | |
cce855bc JA |
784 | The return status is the exit status of the last command that executes. |
785 | If the expansion of the items following \fBin\fP results in an empty | |
786 | list, no commands are executed, and the return status is 0. | |
726f6388 | 787 | .TP |
bb70624e JA |
788 | \fBfor\fP (( \fIexpr1\fP ; \fIexpr2\fP ; \fIexpr3\fP )) ; \fBdo\fP \fIlist\fP ; \fBdone\fP |
789 | First, the arithmetic expression \fIexpr1\fP is evaluated according | |
790 | to the rules described below under | |
791 | .SM | |
792 | .BR "ARITHMETIC EVALUATION" . | |
793 | The arithmetic expression \fIexpr2\fP is then evaluated repeatedly | |
794 | until it evaluates to zero. | |
795 | Each time \fIexpr2\fP evaluates to a non-zero value, \fIlist\fP is | |
796 | executed and the arithmetic expression \fIexpr3\fP is evaluated. | |
797 | If any expression is omitted, it behaves as if it evaluates to 1. | |
798 | The return value is the exit status of the last command in \fIlist\fP | |
799 | that is executed, or false if any of the expressions is invalid. | |
800 | .TP | |
b72432fd | 801 | \fBselect\fP \fIname\fP [ \fBin\fP \fIword\fP ] ; \fBdo\fP \fIlist\fP ; \fBdone\fP |
726f6388 JA |
802 | The list of words following \fBin\fP is expanded, generating a list |
803 | of items. The set of expanded words is printed on the standard | |
804 | error, each preceded by a number. If the \fBin\fP | |
805 | \fIword\fP is omitted, the positional parameters are printed (see | |
806 | .SM | |
807 | .B PARAMETERS | |
808 | below). The | |
0001803f | 809 | .SM |
726f6388 JA |
810 | .B PS3 |
811 | prompt is then displayed and a line read from the standard input. | |
ccc6cda3 | 812 | If the line consists of a number corresponding to one of |
726f6388 JA |
813 | the displayed words, then the value of |
814 | .I name | |
815 | is set to that word. If the line is empty, the words and prompt | |
816 | are displayed again. If EOF is read, the command completes. Any | |
817 | other value read causes | |
818 | .I name | |
819 | to be set to null. The line read is saved in the variable | |
0001803f | 820 | .SM |
726f6388 JA |
821 | .BR REPLY . |
822 | The | |
823 | .I list | |
824 | is executed after each selection until a | |
825 | .B break | |
726f6388 JA |
826 | command is executed. |
827 | The exit status of | |
828 | .B select | |
829 | is the exit status of the last command executed in | |
830 | .IR list , | |
831 | or zero if no commands were executed. | |
832 | .TP | |
bb70624e | 833 | \fBcase\fP \fIword\fP \fBin\fP [ [(] \fIpattern\fP [ \fB|\fP \fIpattern\fP ] \ |
726f6388 JA |
834 | ... ) \fIlist\fP ;; ] ... \fBesac\fP |
835 | A \fBcase\fP command first expands \fIword\fP, and tries to match | |
836 | it against each \fIpattern\fP in turn, using the same matching rules | |
837 | as for pathname expansion (see | |
838 | .B Pathname Expansion | |
95732b49 | 839 | below). |
0628567a JA |
840 | The \fIword\fP is expanded using tilde |
841 | expansion, parameter and variable expansion, arithmetic substitution, | |
842 | command substitution, process substitution and quote removal. | |
843 | Each \fIpattern\fP examined is expanded using tilde | |
844 | expansion, parameter and variable expansion, arithmetic substitution, | |
845 | command substitution, and process substitution. | |
95732b49 JA |
846 | If the shell option |
847 | .B nocasematch | |
848 | is enabled, the match is performed without regard to the case | |
849 | of alphabetic characters. | |
3185942a JA |
850 | When a match is found, the corresponding \fIlist\fP is executed. |
851 | If the \fB;;\fP operator is used, no subsequent matches are attempted after | |
852 | the first pattern match. | |
853 | Using \fB;&\fP in place of \fB;;\fP causes execution to continue with | |
854 | the \fIlist\fP associated with the next set of patterns. | |
855 | Using \fB;;&\fP in place of \fB;;\fP causes the shell to test the next | |
856 | pattern list in the statement, if any, and execute any associated \fIlist\fP | |
857 | on a successful match. | |
858 | The exit status is zero if no | |
ccc6cda3 | 859 | pattern matches. Otherwise, it is the exit status of the |
726f6388 JA |
860 | last command executed in \fIlist\fP. |
861 | .TP | |
ccc6cda3 JA |
862 | \fBif\fP \fIlist\fP; \fBthen\fP \fIlist;\fP \ |
863 | [ \fBelif\fP \fIlist\fP; \fBthen\fP \fIlist\fP; ] ... \ | |
864 | [ \fBelse\fP \fIlist\fP; ] \fBfi\fP | |
726f6388 JA |
865 | The |
866 | .B if | |
867 | .I list | |
868 | is executed. If its exit status is zero, the | |
869 | \fBthen\fP \fIlist\fP is executed. Otherwise, each \fBelif\fP | |
870 | \fIlist\fP is executed in turn, and if its exit status is zero, | |
871 | the corresponding \fBthen\fP \fIlist\fP is executed and the | |
872 | command completes. Otherwise, the \fBelse\fP \fIlist\fP is | |
873 | executed, if present. The exit status is the exit status of the | |
874 | last command executed, or zero if no condition tested true. | |
875 | .TP | |
ccc6cda3 | 876 | \fBwhile\fP \fIlist\fP; \fBdo\fP \fIlist\fP; \fBdone\fP |
7117c2d2 | 877 | .PD 0 |
726f6388 | 878 | .TP |
ccc6cda3 | 879 | \fBuntil\fP \fIlist\fP; \fBdo\fP \fIlist\fP; \fBdone\fP |
726f6388 JA |
880 | .PD |
881 | The \fBwhile\fP command continuously executes the \fBdo\fP | |
882 | \fIlist\fP as long as the last command in \fIlist\fP returns | |
883 | an exit status of zero. The \fBuntil\fP command is identical | |
884 | to the \fBwhile\fP command, except that the test is negated; | |
885 | the | |
886 | .B do | |
887 | .I list | |
888 | is executed as long as the last command in | |
889 | .I list | |
ccc6cda3 | 890 | returns a non-zero exit status. |
726f6388 JA |
891 | The exit status of the \fBwhile\fP and \fBuntil\fP commands |
892 | is the exit status | |
893 | of the last \fBdo\fP \fIlist\fP command executed, or zero if | |
894 | none was executed. | |
3185942a JA |
895 | .SS Coprocesses |
896 | .PP | |
897 | A \fIcoprocess\fP is a shell command preceded by the \fBcoproc\fP reserved | |
898 | word. | |
899 | A coprocess is executed asynchronously in a subshell, as if the command | |
900 | had been terminated with the \fB&\fP control operator, with a two-way pipe | |
901 | established between the executing shell and the coprocess. | |
902 | .PP | |
903 | The format for a coprocess is: | |
904 | .RS | |
905 | .PP | |
906 | \fBcoproc\fP [\fINAME\fP] \fIcommand\fP [\fIredirections\fP] | |
907 | .RE | |
908 | .PP | |
909 | This creates a coprocess named \fINAME\fP. | |
910 | If \fINAME\fP is not supplied, the default name is \fICOPROC\fP. | |
17345e5a JA |
911 | \fINAME\fP must not be supplied if \fIcommand\fP is a \fIsimple |
912 | command\fP (see above); otherwise, it is interpreted as the first word | |
913 | of the simple command. | |
3185942a JA |
914 | When the coproc is executed, the shell creates an array variable (see |
915 | .B Arrays | |
916 | below) named \fINAME\fP in the context of the executing shell. | |
917 | The standard output of | |
918 | .I command | |
919 | is connected via a pipe to a file descriptor in the executing shell, | |
920 | and that file descriptor is assigned to \fINAME\fP[0]. | |
921 | The standard input of | |
922 | .I command | |
923 | is connected via a pipe to a file descriptor in the executing shell, | |
924 | and that file descriptor is assigned to \fINAME\fP[1]. | |
925 | This pipe is established before any redirections specified by the | |
926 | command (see | |
927 | .SM | |
928 | .B REDIRECTION | |
929 | below). | |
930 | The file descriptors can be utilized as arguments to shell commands | |
931 | and redirections using standard word expansions. | |
932 | The process id of the shell spawned to execute the coprocess is | |
933 | available as the value of the variable \fINAME\fP_PID. | |
934 | The \fBwait\fP | |
935 | builtin command may be used to wait for the coprocess to terminate. | |
936 | .PP | |
937 | The return status of a coprocess is the exit status of \fIcommand\fP. | |
b80f6443 JA |
938 | .SS Shell Function Definitions |
939 | .PP | |
940 | A shell function is an object that is called like a simple command and | |
941 | executes a compound command with a new set of positional parameters. | |
942 | Shell functions are declared as follows: | |
943 | .TP | |
944 | [ \fBfunction\fP ] \fIname\fP () \fIcompound\-command\fP [\fIredirection\fP] | |
945 | This defines a function named \fIname\fP. | |
946 | The reserved word \fBfunction\fP is optional. | |
947 | If the \fBfunction\fP reserved word is supplied, the parentheses are optional. | |
948 | The \fIbody\fP of the function is the compound command | |
949 | .I compound\-command | |
950 | (see \fBCompound Commands\fP above). | |
951 | That command is usually a \fIlist\fP of commands between { and }, but | |
952 | may be any command listed under \fBCompound Commands\fP above. | |
953 | \fIcompound\-command\fP is executed whenever \fIname\fP is specified as the | |
954 | name of a simple command. | |
955 | Any redirections (see | |
956 | .SM | |
957 | .B REDIRECTION | |
958 | below) specified when a function is defined are performed | |
959 | when the function is executed. | |
960 | The exit status of a function definition is zero unless a syntax error | |
961 | occurs or a readonly function with the same name already exists. | |
962 | When executed, the exit status of a function is the exit status of the | |
963 | last command executed in the body. (See | |
726f6388 JA |
964 | .SM |
965 | .B FUNCTIONS | |
966 | below.) | |
967 | .SH COMMENTS | |
ccc6cda3 JA |
968 | In a non-interactive shell, or an interactive shell in which the |
969 | .B interactive_comments | |
970 | option to the | |
971 | .B shopt | |
972 | builtin is enabled (see | |
973 | .SM | |
974 | .B "SHELL BUILTIN COMMANDS" | |
975 | below), a word beginning with | |
726f6388 JA |
976 | .B # |
977 | causes that word and all remaining characters on that line to | |
978 | be ignored. An interactive shell without the | |
ccc6cda3 | 979 | .B interactive_comments |
ccc6cda3 JA |
980 | option enabled does not allow comments. The |
981 | .B interactive_comments | |
982 | option is on by default in interactive shells. | |
726f6388 JA |
983 | .SH QUOTING |
984 | \fIQuoting\fP is used to remove the special meaning of certain | |
985 | characters or words to the shell. Quoting can be used to | |
986 | disable special treatment for special characters, to prevent | |
987 | reserved words from being recognized as such, and to prevent | |
988 | parameter expansion. | |
989 | .PP | |
990 | Each of the \fImetacharacters\fP listed above under | |
991 | .SM | |
992 | .B DEFINITIONS | |
bb70624e JA |
993 | has special meaning to the shell and must be quoted if it is to |
994 | represent itself. | |
995 | .PP | |
95732b49 JA |
996 | When the command history expansion facilities are being used |
997 | (see | |
998 | .SM | |
999 | .B HISTORY EXPANSION | |
1000 | below), the | |
bb70624e JA |
1001 | \fIhistory expansion\fP character, usually \fB!\fP, must be quoted |
1002 | to prevent history expansion. | |
1003 | .PP | |
1004 | There are three quoting mechanisms: the | |
726f6388 JA |
1005 | .IR "escape character" , |
1006 | single quotes, and double quotes. | |
1007 | .PP | |
1008 | A non-quoted backslash (\fB\e\fP) is the | |
1009 | .IR "escape character" . | |
1010 | It preserves the literal value of the next character that follows, | |
1011 | with the exception of <newline>. If a \fB\e\fP<newline> pair | |
cce855bc JA |
1012 | appears, and the backslash is not itself quoted, the \fB\e\fP<newline> |
1013 | is treated as a line continuation (that is, it is removed from the | |
1014 | input stream and effectively ignored). | |
726f6388 JA |
1015 | .PP |
1016 | Enclosing characters in single quotes preserves the literal value | |
1017 | of each character within the quotes. A single quote may not occur | |
1018 | between single quotes, even when preceded by a backslash. | |
1019 | .PP | |
1020 | Enclosing characters in double quotes preserves the literal value | |
1021 | of all characters within the quotes, with the exception of | |
1022 | .BR $ , | |
3185942a | 1023 | .BR \` , |
95732b49 JA |
1024 | .BR \e , |
1025 | and, when history expansion is enabled, | |
1026 | .BR ! . | |
726f6388 JA |
1027 | The characters |
1028 | .B $ | |
1029 | and | |
3185942a | 1030 | .B \` |
726f6388 JA |
1031 | retain their special meaning within double quotes. The backslash |
1032 | retains its special meaning only when followed by one of the following | |
1033 | characters: | |
1034 | .BR $ , | |
3185942a | 1035 | .BR \` , |
726f6388 JA |
1036 | \^\fB"\fP\^, |
1037 | .BR \e , | |
1038 | or | |
1039 | .BR <newline> . | |
1040 | A double quote may be quoted within double quotes by preceding it with | |
1041 | a backslash. | |
95732b49 JA |
1042 | If enabled, history expansion will be performed unless an |
1043 | .B ! | |
1044 | appearing in double quotes is escaped using a backslash. | |
1045 | The backslash preceding the | |
1046 | .B ! | |
1047 | is not removed. | |
726f6388 JA |
1048 | .PP |
1049 | The special parameters | |
1050 | .B * | |
1051 | and | |
1052 | .B @ | |
1053 | have special meaning when in double | |
1054 | quotes (see | |
1055 | .SM | |
1056 | .B PARAMETERS | |
1057 | below). | |
ccc6cda3 | 1058 | .PP |
0628567a | 1059 | Words of the form \fB$\fP\(aq\fIstring\fP\(aq are treated specially. The |
ccc6cda3 | 1060 | word expands to \fIstring\fP, with backslash-escaped characters replaced |
95732b49 | 1061 | as specified by the ANSI C standard. Backslash escape sequences, if |
ccc6cda3 JA |
1062 | present, are decoded as follows: |
1063 | .RS | |
1064 | .PD 0 | |
1065 | .TP | |
1066 | .B \ea | |
1067 | alert (bell) | |
1068 | .TP | |
1069 | .B \eb | |
1070 | backspace | |
1071 | .TP | |
1072 | .B \ee | |
0001803f CR |
1073 | .TP |
1074 | .B \eE | |
ccc6cda3 JA |
1075 | an escape character |
1076 | .TP | |
1077 | .B \ef | |
1078 | form feed | |
1079 | .TP | |
1080 | .B \en | |
1081 | new line | |
1082 | .TP | |
1083 | .B \er | |
1084 | carriage return | |
1085 | .TP | |
1086 | .B \et | |
1087 | horizontal tab | |
1088 | .TP | |
1089 | .B \ev | |
1090 | vertical tab | |
1091 | .TP | |
1092 | .B \e\e | |
1093 | backslash | |
bb70624e | 1094 | .TP |
0628567a | 1095 | .B \e\(aq |
bb70624e | 1096 | single quote |
0001803f CR |
1097 | .TP |
1098 | .B \e\(dq | |
1099 | double quote | |
ccc6cda3 JA |
1100 | .TP |
1101 | .B \e\fInnn\fP | |
f73dda09 | 1102 | the eight-bit character whose value is the octal value \fInnn\fP |
cce855bc JA |
1103 | (one to three digits) |
1104 | .TP | |
f73dda09 JA |
1105 | .B \ex\fIHH\fP |
1106 | the eight-bit character whose value is the hexadecimal value \fIHH\fP | |
1107 | (one or two hex digits) | |
7117c2d2 JA |
1108 | .TP |
1109 | .B \ec\fIx\fP | |
1110 | a control-\fIx\fP character | |
ccc6cda3 JA |
1111 | .PD |
1112 | .RE | |
1113 | .LP | |
bb70624e | 1114 | The expanded result is single-quoted, as if the dollar sign had |
ccc6cda3 JA |
1115 | not been present. |
1116 | .PP | |
0001803f CR |
1117 | A double-quoted string preceded by a dollar sign (\fB$\fP\(dq\fIstring\fP\(dq) |
1118 | will cause the string to be translated according to the current locale. | |
ccc6cda3 JA |
1119 | If the current locale is \fBC\fP or \fBPOSIX\fP, the dollar sign |
1120 | is ignored. | |
1121 | If the string is translated and replaced, the replacement is | |
1122 | double-quoted. | |
726f6388 JA |
1123 | .SH PARAMETERS |
1124 | A | |
1125 | .I parameter | |
ccc6cda3 JA |
1126 | is an entity that stores values. |
1127 | It can be a | |
726f6388 JA |
1128 | .IR name , |
1129 | a number, or one of the special characters listed below under | |
1130 | .BR "Special Parameters" . | |
b80f6443 | 1131 | A |
726f6388 JA |
1132 | .I variable |
1133 | is a parameter denoted by a | |
1134 | .IR name . | |
f73dda09 JA |
1135 | A variable has a \fIvalue\fP and zero or more \fIattributes\fP. |
1136 | Attributes are assigned using the | |
1137 | .B declare | |
1138 | builtin command (see | |
1139 | .B declare | |
1140 | below in | |
1141 | .SM | |
1142 | .BR "SHELL BUILTIN COMMANDS" ). | |
726f6388 JA |
1143 | .PP |
1144 | A parameter is set if it has been assigned a value. The null string is | |
1145 | a valid value. Once a variable is set, it may be unset only by using | |
1146 | the | |
1147 | .B unset | |
1148 | builtin command (see | |
1149 | .SM | |
1150 | .B SHELL BUILTIN COMMANDS | |
1151 | below). | |
1152 | .PP | |
1153 | A | |
1154 | .I variable | |
1155 | may be assigned to by a statement of the form | |
1156 | .RS | |
1157 | .PP | |
1158 | \fIname\fP=[\fIvalue\fP] | |
1159 | .RE | |
1160 | .PP | |
1161 | If | |
1162 | .I value | |
1163 | is not given, the variable is assigned the null string. All | |
1164 | .I values | |
bb70624e JA |
1165 | undergo tilde expansion, parameter and variable expansion, |
1166 | command substitution, arithmetic expansion, and quote | |
ccc6cda3 JA |
1167 | removal (see |
1168 | .SM | |
1169 | .B EXPANSION | |
1170 | below). If the variable has its | |
cce855bc | 1171 | .B integer |
f73dda09 | 1172 | attribute set, then |
726f6388 | 1173 | .I value |
b80f6443 | 1174 | is evaluated as an arithmetic expression even if the $((...)) expansion is |
cce855bc | 1175 | not used (see |
ccc6cda3 JA |
1176 | .B "Arithmetic Expansion" |
1177 | below). | |
1178 | Word splitting is not performed, with the exception | |
726f6388 JA |
1179 | of \fB"$@"\fP as explained below under |
1180 | .BR "Special Parameters" . | |
1181 | Pathname expansion is not performed. | |
f73dda09 | 1182 | Assignment statements may also appear as arguments to the |
b80f6443 | 1183 | .BR alias , |
f73dda09 JA |
1184 | .BR declare , |
1185 | .BR typeset , | |
1186 | .BR export , | |
1187 | .BR readonly , | |
1188 | and | |
1189 | .B local | |
1190 | builtin commands. | |
95732b49 JA |
1191 | .PP |
1192 | In the context where an assignment statement is assigning a value | |
1193 | to a shell variable or array index, the += operator can be used to | |
1194 | append to or add to the variable's previous value. | |
1195 | When += is applied to a variable for which the integer attribute has been | |
1196 | set, \fIvalue\fP is evaluated as an arithmetic expression and added to the | |
1197 | variable's current value, which is also evaluated. | |
1198 | When += is applied to an array variable using compound assignment (see | |
1199 | .B Arrays | |
1200 | below), the | |
1201 | variable's value is not unset (as it is when using =), and new values are | |
3185942a JA |
1202 | appended to the array beginning at one greater than the array's maximum index |
1203 | (for indexed arrays) or added as additional key\-value pairs in an | |
1204 | associative array. | |
95732b49 JA |
1205 | When applied to a string-valued variable, \fIvalue\fP is expanded and |
1206 | appended to the variable's value. | |
726f6388 JA |
1207 | .SS Positional Parameters |
1208 | .PP | |
1209 | A | |
1210 | .I positional parameter | |
1211 | is a parameter denoted by one or more | |
1212 | digits, other than the single digit 0. Positional parameters are | |
1213 | assigned from the shell's arguments when it is invoked, | |
1214 | and may be reassigned using the | |
1215 | .B set | |
1216 | builtin command. Positional parameters may not be assigned to | |
1217 | with assignment statements. The positional parameters are | |
1218 | temporarily replaced when a shell function is executed (see | |
1219 | .SM | |
1220 | .B FUNCTIONS | |
1221 | below). | |
1222 | .PP | |
1223 | When a positional parameter consisting of more than a single | |
1224 | digit is expanded, it must be enclosed in braces (see | |
1225 | .SM | |
1226 | .B EXPANSION | |
1227 | below). | |
1228 | .SS Special Parameters | |
1229 | .PP | |
1230 | The shell treats several parameters specially. These parameters may | |
1231 | only be referenced; assignment to them is not allowed. | |
1232 | .PD 0 | |
1233 | .TP | |
1234 | .B * | |
1235 | Expands to the positional parameters, starting from one. When the | |
1236 | expansion occurs within double quotes, it expands to a single word | |
1237 | with the value of each parameter separated by the first character | |
1238 | of the | |
1239 | .SM | |
1240 | .B IFS | |
cce855bc JA |
1241 | special variable. That is, "\fB$*\fP" is equivalent |
1242 | to "\fB$1\fP\fIc\fP\fB$2\fP\fIc\fP\fB...\fP", where | |
726f6388 JA |
1243 | .I c |
1244 | is the first character of the value of the | |
1245 | .SM | |
1246 | .B IFS | |
1247 | variable. If | |
1248 | .SM | |
1249 | .B IFS | |
d166f048 JA |
1250 | is unset, the parameters are separated by spaces. |
1251 | If | |
1252 | .SM | |
1253 | .B IFS | |
1254 | is null, the parameters are joined without intervening separators. | |
726f6388 JA |
1255 | .TP |
1256 | .B @ | |
1257 | Expands to the positional parameters, starting from one. When the | |
cce855bc JA |
1258 | expansion occurs within double quotes, each parameter expands to a |
1259 | separate word. That is, "\fB$@\fP" is equivalent to | |
1260 | "\fB$1\fP" "\fB$2\fP" ... | |
95732b49 JA |
1261 | If the double-quoted expansion occurs within a word, the expansion of |
1262 | the first parameter is joined with the beginning part of the original | |
1263 | word, and the expansion of the last parameter is joined with the last | |
1264 | part of the original word. | |
cce855bc | 1265 | When there are no positional parameters, "\fB$@\fP" and |
726f6388 JA |
1266 | .B $@ |
1267 | expand to nothing (i.e., they are removed). | |
1268 | .TP | |
1269 | .B # | |
1270 | Expands to the number of positional parameters in decimal. | |
1271 | .TP | |
1272 | .B ? | |
3185942a | 1273 | Expands to the exit status of the most recently executed foreground |
726f6388 JA |
1274 | pipeline. |
1275 | .TP | |
1276 | .B \- | |
1277 | Expands to the current option flags as specified upon invocation, | |
1278 | by the | |
1279 | .B set | |
1280 | builtin command, or those set by the shell itself | |
1281 | (such as the | |
1282 | .B \-i | |
cce855bc | 1283 | option). |
726f6388 JA |
1284 | .TP |
1285 | .B $ | |
1286 | Expands to the process ID of the shell. In a () subshell, it | |
1287 | expands to the process ID of the current shell, not the | |
1288 | subshell. | |
1289 | .TP | |
1290 | .B ! | |
1291 | Expands to the process ID of the most recently executed background | |
1292 | (asynchronous) command. | |
1293 | .TP | |
1294 | .B 0 | |
1295 | Expands to the name of the shell or shell script. This is set at | |
1296 | shell initialization. If | |
1297 | .B bash | |
1298 | is invoked with a file of commands, | |
1299 | .B $0 | |
1300 | is set to the name of that file. If | |
1301 | .B bash | |
1302 | is started with the | |
1303 | .B \-c | |
1304 | option, then | |
1305 | .B $0 | |
1306 | is set to the first argument after the string to be | |
1307 | executed, if one is present. Otherwise, it is set | |
ccc6cda3 | 1308 | to the file name used to invoke |
726f6388 JA |
1309 | .BR bash , |
1310 | as given by argument zero. | |
1311 | .TP | |
1312 | .B _ | |
95732b49 JA |
1313 | At shell startup, set to the absolute pathname used to invoke the |
1314 | shell or shell script being executed as passed in the environment | |
1315 | or argument list. | |
ccc6cda3 JA |
1316 | Subsequently, expands to the last argument to the previous command, |
1317 | after expansion. | |
95732b49 JA |
1318 | Also set to the full pathname used to invoke each command executed |
1319 | and placed in the environment exported to that command. | |
ccc6cda3 JA |
1320 | When checking mail, this parameter holds the name of the mail file |
1321 | currently being checked. | |
726f6388 JA |
1322 | .PD |
1323 | .SS Shell Variables | |
1324 | .PP | |
1325 | The following variables are set by the shell: | |
1326 | .PP | |
1327 | .PD 0 | |
1328 | .TP | |
726f6388 | 1329 | .B BASH |
ccc6cda3 | 1330 | Expands to the full file name used to invoke this instance of |
726f6388 JA |
1331 | .BR bash . |
1332 | .TP | |
0001803f CR |
1333 | .B BASHOPTS |
1334 | A colon-separated list of enabled shell options. Each word in | |
1335 | the list is a valid argument for the | |
1336 | .B \-s | |
1337 | option to the | |
1338 | .B shopt | |
1339 | builtin command (see | |
1340 | .SM | |
1341 | .B "SHELL BUILTIN COMMANDS" | |
1342 | below). The options appearing in | |
1343 | .SM | |
1344 | .B BASHOPTS | |
1345 | are those reported as | |
1346 | .I on | |
1347 | by \fBshopt\fP. | |
1348 | If this variable is in the environment when | |
1349 | .B bash | |
1350 | starts up, each shell option in the list will be enabled before | |
1351 | reading any startup files. | |
1352 | This variable is read-only. | |
1353 | .TP | |
3185942a JA |
1354 | .B BASHPID |
1355 | Expands to the process id of the current \fBbash\fP process. | |
1356 | This differs from \fB$$\fP under certain circumstances, such as subshells | |
1357 | that do not require \fBbash\fP to be re-initialized. | |
1358 | .TP | |
1359 | .B BASH_ALIASES | |
1360 | An associative array variable whose members correspond to the internal | |
1361 | list of aliases as maintained by the \fBalias\fP builtin | |
1362 | Elements added to this array appear in the alias list; unsetting array | |
1363 | elements cause aliases to be removed from the alias list. | |
1364 | .TP | |
b80f6443 JA |
1365 | .B BASH_ARGC |
1366 | An array variable whose values are the number of parameters in each | |
3185942a | 1367 | frame of the current \fBbash\fP execution call stack. |
95732b49 | 1368 | The number of |
b80f6443 | 1369 | parameters to the current subroutine (shell function or script executed |
95732b49 JA |
1370 | with \fB.\fP or \fBsource\fP) is at the top of the stack. |
1371 | When a subroutine is executed, the number of parameters passed is pushed onto | |
0001803f CR |
1372 | .SM |
1373 | .BR BASH_ARGC . | |
1374 | The shell sets | |
1375 | .SM | |
1376 | .B BASH_ARGC | |
1377 | only when in extended debugging mode (see the description of the | |
95732b49 JA |
1378 | .B extdebug |
1379 | option to the | |
1380 | .B shopt | |
1381 | builtin below) | |
b80f6443 JA |
1382 | .TP |
1383 | .B BASH_ARGV | |
3185942a | 1384 | An array variable containing all of the parameters in the current \fBbash\fP |
b80f6443 JA |
1385 | execution call stack. The final parameter of the last subroutine call |
1386 | is at the top of the stack; the first parameter of the initial call is | |
1387 | at the bottom. When a subroutine is executed, the parameters supplied | |
0001803f CR |
1388 | are pushed onto |
1389 | .SM | |
1390 | .BR BASH_ARGV . | |
1391 | The shell sets | |
1392 | .SM | |
1393 | .B BASH_ARGV | |
1394 | only when in extended debugging mode | |
95732b49 JA |
1395 | (see the description of the |
1396 | .B extdebug | |
1397 | option to the | |
1398 | .B shopt | |
1399 | builtin below) | |
b80f6443 | 1400 | .TP |
3185942a JA |
1401 | .B BASH_CMDS |
1402 | An associative array variable whose members correspond to the internal | |
1403 | hash table of commands as maintained by the \fBhash\fP builtin. | |
1404 | Elements added to this array appear in the hash table; unsetting array | |
1405 | elements cause commands to be removed from the hash table. | |
1406 | .TP | |
b80f6443 JA |
1407 | .B BASH_COMMAND |
1408 | The command currently being executed or about to be executed, unless the | |
1409 | shell is executing a command as the result of a trap, | |
1410 | in which case it is the command executing at the time of the trap. | |
1411 | .TP | |
1412 | .B BASH_EXECUTION_STRING | |
1413 | The command argument to the \fB\-c\fP invocation option. | |
1414 | .TP | |
1415 | .B BASH_LINENO | |
1416 | An array variable whose members are the line numbers in source files | |
0001803f CR |
1417 | corresponding to each member of |
1418 | .SM | |
1419 | .BR FUNCNAME . | |
b80f6443 | 1420 | \fB${BASH_LINENO[\fP\fI$i\fP\fB]}\fP is the line number in the source |
3185942a JA |
1421 | file where \fB${FUNCNAME[\fP\fI$i\fP\fB]}\fP was called |
1422 | (or \fB${BASH_LINENO[\fP\fI$i-1\fP\fB]}\fP if referenced within another | |
1423 | shell function). | |
17345e5a | 1424 | The corresponding source file name is \fB${BASH_SOURCE[\fP\fI$i\fP\fB]}\fP. |
0001803f CR |
1425 | Use |
1426 | .SM | |
1427 | .B LINENO | |
1428 | to obtain the current line number. | |
b80f6443 JA |
1429 | .TP |
1430 | .B BASH_REMATCH | |
1431 | An array variable whose members are assigned by the \fB=~\fP binary | |
1432 | operator to the \fB[[\fP conditional command. | |
1433 | The element with index 0 is the portion of the string | |
1434 | matching the entire regular expression. | |
1435 | The element with index \fIn\fP is the portion of the | |
1436 | string matching the \fIn\fPth parenthesized subexpression. | |
1437 | This variable is read-only. | |
1438 | .TP | |
1439 | .B BASH_SOURCE | |
1440 | An array variable whose members are the source filenames corresponding | |
0001803f CR |
1441 | to the elements in the |
1442 | .SM | |
1443 | .B FUNCNAME | |
1444 | array variable. | |
b80f6443 JA |
1445 | .TP |
1446 | .B BASH_SUBSHELL | |
1447 | Incremented by one each time a subshell or subshell environment is spawned. | |
1448 | The initial value is 0. | |
1449 | .TP | |
ccc6cda3 | 1450 | .B BASH_VERSINFO |
cce855bc JA |
1451 | A readonly array variable whose members hold version information for |
1452 | this instance of | |
ccc6cda3 JA |
1453 | .BR bash . |
1454 | The values assigned to the array members are as follows: | |
1455 | .sp .5 | |
1456 | .RS | |
1457 | .PD 0 | |
1458 | .TP 24 | |
1459 | .B BASH_VERSINFO[\fR0\fP] | |
1460 | The major version number (the \fIrelease\fP). | |
1461 | .TP | |
1462 | .B BASH_VERSINFO[\fR1\fP] | |
1463 | The minor version number (the \fIversion\fP). | |
1464 | .TP | |
1465 | .B BASH_VERSINFO[\fR2\fP] | |
1466 | The patch level. | |
1467 | .TP | |
1468 | .B BASH_VERSINFO[\fR3\fP] | |
1469 | The build version. | |
1470 | .TP | |
1471 | .B BASH_VERSINFO[\fR4\fP] | |
1472 | The release status (e.g., \fIbeta1\fP). | |
1473 | .TP | |
1474 | .B BASH_VERSINFO[\fR5\fP] | |
0001803f CR |
1475 | The value of |
1476 | .SM | |
1477 | .BR MACHTYPE . | |
ccc6cda3 JA |
1478 | .PD |
1479 | .RE | |
1480 | .TP | |
f73dda09 JA |
1481 | .B BASH_VERSION |
1482 | Expands to a string describing the version of this instance of | |
1483 | .BR bash . | |
726f6388 | 1484 | .TP |
f73dda09 JA |
1485 | .B COMP_CWORD |
1486 | An index into \fB${COMP_WORDS}\fP of the word containing the current | |
1487 | cursor position. | |
1488 | This variable is available only in shell functions invoked by the | |
1489 | programmable completion facilities (see \fBProgrammable Completion\fP | |
1490 | below). | |
1491 | .TP | |
3185942a JA |
1492 | .B COMP_KEY |
1493 | The key (or final key of a key sequence) used to invoke the current | |
1494 | completion function. | |
1495 | .TP | |
f73dda09 JA |
1496 | .B COMP_LINE |
1497 | The current command line. | |
1498 | This variable is available only in shell functions and external | |
1499 | commands invoked by the | |
1500 | programmable completion facilities (see \fBProgrammable Completion\fP | |
1501 | below). | |
1502 | .TP | |
1503 | .B COMP_POINT | |
1504 | The index of the current cursor position relative to the beginning of | |
1505 | the current command. | |
1506 | If the current cursor position is at the end of the current command, | |
1507 | the value of this variable is equal to \fB${#COMP_LINE}\fP. | |
1508 | This variable is available only in shell functions and external | |
1509 | commands invoked by the | |
1510 | programmable completion facilities (see \fBProgrammable Completion\fP | |
1511 | below). | |
1512 | .TP | |
3185942a JA |
1513 | .B COMP_TYPE |
1514 | Set to an integer value corresponding to the type of completion attempted | |
1515 | that caused a completion function to be called: | |
1516 | \fITAB\fP, for normal completion, | |
1517 | \fI?\fP, for listing completions after successive tabs, | |
1518 | \fI!\fP, for listing alternatives on partial word completion, | |
1519 | \fI@\fP, to list completions if the word is not unmodified, | |
1520 | or | |
1521 | \fI%\fP, for menu completion. | |
1522 | This variable is available only in shell functions and external | |
1523 | commands invoked by the | |
1524 | programmable completion facilities (see \fBProgrammable Completion\fP | |
1525 | below). | |
1526 | .TP | |
b80f6443 | 1527 | .B COMP_WORDBREAKS |
17345e5a | 1528 | The set of characters that the \fBreadline\fP library treats as word |
b80f6443 JA |
1529 | separators when performing word completion. |
1530 | If | |
1531 | .SM | |
1532 | .B COMP_WORDBREAKS | |
1533 | is unset, it loses its special properties, even if it is | |
1534 | subsequently reset. | |
1535 | .TP | |
f73dda09 JA |
1536 | .B COMP_WORDS |
1537 | An array variable (see \fBArrays\fP below) consisting of the individual | |
1538 | words in the current command line. | |
17345e5a | 1539 | The line is split into words as \fBreadline\fP would split it, using |
0001803f CR |
1540 | .SM |
1541 | .B COMP_WORDBREAKS | |
1542 | as described above. | |
f73dda09 JA |
1543 | This variable is available only in shell functions invoked by the |
1544 | programmable completion facilities (see \fBProgrammable Completion\fP | |
1545 | below). | |
1546 | .TP | |
1547 | .B DIRSTACK | |
1548 | An array variable (see | |
1549 | .B Arrays | |
1550 | below) containing the current contents of the directory stack. | |
1551 | Directories appear in the stack in the order they are displayed by the | |
1552 | .B dirs | |
1553 | builtin. | |
1554 | Assigning to members of this array variable may be used to modify | |
1555 | directories already in the stack, but the | |
1556 | .B pushd | |
1557 | and | |
1558 | .B popd | |
1559 | builtins must be used to add and remove directories. | |
1560 | Assignment to this variable will not change the current directory. | |
726f6388 JA |
1561 | If |
1562 | .SM | |
f73dda09 | 1563 | .B DIRSTACK |
726f6388 JA |
1564 | is unset, it loses its special properties, even if it is |
1565 | subsequently reset. | |
1566 | .TP | |
f73dda09 JA |
1567 | .B EUID |
1568 | Expands to the effective user ID of the current user, initialized at | |
1569 | shell startup. This variable is readonly. | |
1570 | .TP | |
1571 | .B FUNCNAME | |
b80f6443 JA |
1572 | An array variable containing the names of all shell functions |
1573 | currently in the execution call stack. | |
1574 | The element with index 0 is the name of any currently-executing | |
1575 | shell function. | |
3185942a JA |
1576 | The bottom-most element is |
1577 | .if t \f(CW"main"\fP. | |
1578 | .if n "main". | |
f73dda09 JA |
1579 | This variable exists only when a shell function is executing. |
1580 | Assignments to | |
726f6388 | 1581 | .SM |
f73dda09 JA |
1582 | .B FUNCNAME |
1583 | have no effect and return an error status. | |
726f6388 JA |
1584 | If |
1585 | .SM | |
f73dda09 | 1586 | .B FUNCNAME |
726f6388 JA |
1587 | is unset, it loses its special properties, even if it is |
1588 | subsequently reset. | |
1589 | .TP | |
f73dda09 JA |
1590 | .B GROUPS |
1591 | An array variable containing the list of groups of which the current | |
1592 | user is a member. | |
1593 | Assignments to | |
1594 | .SM | |
1595 | .B GROUPS | |
1596 | have no effect and return an error status. | |
726f6388 JA |
1597 | If |
1598 | .SM | |
f73dda09 | 1599 | .B GROUPS |
726f6388 JA |
1600 | is unset, it loses its special properties, even if it is |
1601 | subsequently reset. | |
1602 | .TP | |
1603 | .B HISTCMD | |
1604 | The history number, or index in the history list, of the current | |
ccc6cda3 JA |
1605 | command. |
1606 | If | |
726f6388 JA |
1607 | .SM |
1608 | .B HISTCMD | |
1609 | is unset, it loses its special properties, even if it is | |
1610 | subsequently reset. | |
1611 | .TP | |
f73dda09 JA |
1612 | .B HOSTNAME |
1613 | Automatically set to the name of the current host. | |
bb70624e | 1614 | .TP |
f73dda09 JA |
1615 | .B HOSTTYPE |
1616 | Automatically set to a string that uniquely | |
1617 | describes the type of machine on which | |
1618 | .B bash | |
1619 | is executing. | |
1620 | The default is system-dependent. | |
1621 | .TP | |
1622 | .B LINENO | |
1623 | Each time this parameter is referenced, the shell substitutes | |
1624 | a decimal number representing the current sequential line number | |
1625 | (starting with 1) within a script or function. When not in a | |
1626 | script or function, the value substituted is not guaranteed to | |
1627 | be meaningful. | |
ccc6cda3 JA |
1628 | If |
1629 | .SM | |
f73dda09 | 1630 | .B LINENO |
ccc6cda3 JA |
1631 | is unset, it loses its special properties, even if it is |
1632 | subsequently reset. | |
1633 | .TP | |
f73dda09 JA |
1634 | .B MACHTYPE |
1635 | Automatically set to a string that fully describes the system | |
1636 | type on which | |
1637 | .B bash | |
1638 | is executing, in the standard GNU \fIcpu-company-system\fP format. | |
1639 | The default is system-dependent. | |
1640 | .TP | |
1641 | .B OLDPWD | |
1642 | The previous working directory as set by the | |
1643 | .B cd | |
1644 | command. | |
ccc6cda3 | 1645 | .TP |
726f6388 JA |
1646 | .B OPTARG |
1647 | The value of the last option argument processed by the | |
1648 | .B getopts | |
1649 | builtin command (see | |
1650 | .SM | |
1651 | .B SHELL BUILTIN COMMANDS | |
1652 | below). | |
1653 | .TP | |
1654 | .B OPTIND | |
1655 | The index of the next argument to be processed by the | |
1656 | .B getopts | |
1657 | builtin command (see | |
1658 | .SM | |
1659 | .B SHELL BUILTIN COMMANDS | |
1660 | below). | |
1661 | .TP | |
726f6388 JA |
1662 | .B OSTYPE |
1663 | Automatically set to a string that | |
1664 | describes the operating system on which | |
1665 | .B bash | |
ccc6cda3 JA |
1666 | is executing. |
1667 | The default is system-dependent. | |
1668 | .TP | |
f73dda09 JA |
1669 | .B PIPESTATUS |
1670 | An array variable (see | |
1671 | .B Arrays | |
1672 | below) containing a list of exit status values from the processes | |
1673 | in the most-recently-executed foreground pipeline (which may | |
1674 | contain only a single command). | |
ccc6cda3 | 1675 | .TP |
f73dda09 JA |
1676 | .B PPID |
1677 | The process ID of the shell's parent. This variable is readonly. | |
1678 | .TP | |
1679 | .B PWD | |
1680 | The current working directory as set by the | |
1681 | .B cd | |
1682 | command. | |
1683 | .TP | |
1684 | .B RANDOM | |
1685 | Each time this parameter is referenced, a random integer between | |
1686 | 0 and 32767 is | |
1687 | generated. The sequence of random numbers may be initialized by assigning | |
1688 | a value to | |
1689 | .SM | |
1690 | .BR RANDOM . | |
1691 | If | |
1692 | .SM | |
1693 | .B RANDOM | |
1694 | is unset, it loses its special properties, even if it is | |
1695 | subsequently reset. | |
1696 | .TP | |
1697 | .B REPLY | |
1698 | Set to the line of input read by the | |
1699 | .B read | |
1700 | builtin command when no arguments are supplied. | |
1701 | .TP | |
1702 | .B SECONDS | |
1703 | Each time this parameter is | |
1704 | referenced, the number of seconds since shell invocation is returned. If a | |
1705 | value is assigned to | |
1706 | .SM | |
1707 | .BR SECONDS , | |
1708 | the value returned upon subsequent | |
1709 | references is | |
1710 | the number of seconds since the assignment plus the value assigned. | |
1711 | If | |
1712 | .SM | |
1713 | .B SECONDS | |
1714 | is unset, it loses its special properties, even if it is | |
1715 | subsequently reset. | |
1716 | .TP | |
1717 | .B SHELLOPTS | |
1718 | A colon-separated list of enabled shell options. Each word in | |
1719 | the list is a valid argument for the | |
1720 | .B \-o | |
1721 | option to the | |
1722 | .B set | |
1723 | builtin command (see | |
1724 | .SM | |
1725 | .B "SHELL BUILTIN COMMANDS" | |
1726 | below). The options appearing in | |
ccc6cda3 JA |
1727 | .SM |
1728 | .B SHELLOPTS | |
1729 | are those reported as | |
1730 | .I on | |
1731 | by \fBset \-o\fP. | |
1732 | If this variable is in the environment when | |
1733 | .B bash | |
1734 | starts up, each shell option in the list will be enabled before | |
1735 | reading any startup files. | |
1736 | This variable is read-only. | |
bb70624e | 1737 | .TP |
f73dda09 JA |
1738 | .B SHLVL |
1739 | Incremented by one each time an instance of | |
1740 | .B bash | |
1741 | is started. | |
bb70624e | 1742 | .TP |
f73dda09 JA |
1743 | .B UID |
1744 | Expands to the user ID of the current user, initialized at shell startup. | |
1745 | This variable is readonly. | |
726f6388 JA |
1746 | .PD |
1747 | .PP | |
1748 | The following variables are used by the shell. In some cases, | |
1749 | .B bash | |
1750 | assigns a default value to a variable; these cases are noted | |
1751 | below. | |
1752 | .PP | |
1753 | .PD 0 | |
1754 | .TP | |
d166f048 | 1755 | .B BASH_ENV |
726f6388 JA |
1756 | If this parameter is set when \fBbash\fP is executing a shell script, |
1757 | its value is interpreted as a filename containing commands to | |
1758 | initialize the shell, as in | |
cce855bc | 1759 | .IR ~/.bashrc . |
726f6388 JA |
1760 | The value of |
1761 | .SM | |
d166f048 | 1762 | .B BASH_ENV |
726f6388 | 1763 | is subjected to parameter expansion, command substitution, and arithmetic |
ccc6cda3 | 1764 | expansion before being interpreted as a file name. |
726f6388 JA |
1765 | .SM |
1766 | .B PATH | |
ccc6cda3 | 1767 | is not used to search for the resultant file name. |
726f6388 | 1768 | .TP |
f73dda09 JA |
1769 | .B CDPATH |
1770 | The search path for the | |
1771 | .B cd | |
1772 | command. | |
1773 | This is a colon-separated list of directories in which the shell looks | |
1774 | for destination directories specified by the | |
1775 | .B cd | |
1776 | command. | |
7117c2d2 JA |
1777 | A sample value is |
1778 | .if t \f(CW".:~:/usr"\fP. | |
1779 | .if n ".:~:/usr". | |
726f6388 | 1780 | .TP |
0001803f CR |
1781 | .B BASH_XTRACEFD |
1782 | If set to an integer corresponding to a valid file descriptor, \fBbash\fP | |
1783 | will write the trace output generated when | |
1784 | .if t \f(CWset -x\fP | |
1785 | .if n \fIset -x\fP | |
1786 | is enabled to that file descriptor. | |
1787 | The file descriptor is closed when | |
1788 | .SM | |
1789 | .B BASH_XTRACEFD | |
1790 | is unset or assigned a new value. | |
1791 | Unsetting | |
1792 | .SM | |
1793 | .B BASH_XTRACEFD | |
1794 | or assigning it the empty string causes the | |
1795 | trace output to be sent to the standard error. | |
1796 | Note that setting | |
1797 | .SM | |
1798 | .B BASH_XTRACEFD | |
1799 | to 2 (the standard error file | |
1800 | descriptor) and then unsetting it will result in the standard error | |
1801 | being closed. | |
1802 | .TP | |
f73dda09 JA |
1803 | .B COLUMNS |
1804 | Used by the \fBselect\fP builtin command to determine the terminal width | |
1805 | when printing selection lists. Automatically set upon receipt of a SIGWINCH. | |
726f6388 | 1806 | .TP |
f73dda09 JA |
1807 | .B COMPREPLY |
1808 | An array variable from which \fBbash\fP reads the possible completions | |
1809 | generated by a shell function invoked by the programmable completion | |
1810 | facility (see \fBProgrammable Completion\fP below). | |
726f6388 | 1811 | .TP |
b80f6443 JA |
1812 | .B EMACS |
1813 | If \fBbash\fP finds this variable in the environment when the shell starts | |
1814 | with value | |
1815 | .if t \f(CWt\fP, | |
1816 | .if n "t", | |
1817 | it assumes that the shell is running in an emacs shell buffer and disables | |
1818 | line editing. | |
1819 | .TP | |
f73dda09 JA |
1820 | .B FCEDIT |
1821 | The default editor for the | |
1822 | .B fc | |
1823 | builtin command. | |
726f6388 | 1824 | .TP |
f73dda09 JA |
1825 | .B FIGNORE |
1826 | A colon-separated list of suffixes to ignore when performing | |
1827 | filename completion (see | |
726f6388 | 1828 | .SM |
f73dda09 JA |
1829 | .B READLINE |
1830 | below). | |
1831 | A filename whose suffix matches one of the entries in | |
726f6388 | 1832 | .SM |
f73dda09 JA |
1833 | .B FIGNORE |
1834 | is excluded from the list of matched filenames. | |
7117c2d2 JA |
1835 | A sample value is |
1836 | .if t \f(CW".o:~"\fP. | |
1837 | .if n ".o:~". | |
ccc6cda3 | 1838 | .TP |
f73dda09 JA |
1839 | .B GLOBIGNORE |
1840 | A colon-separated list of patterns defining the set of filenames to | |
1841 | be ignored by pathname expansion. | |
1842 | If a filename matched by a pathname expansion pattern also matches one | |
1843 | of the patterns in | |
726f6388 | 1844 | .SM |
f73dda09 JA |
1845 | .BR GLOBIGNORE , |
1846 | it is removed from the list of matches. | |
1847 | .TP | |
1848 | .B HISTCONTROL | |
b80f6443 JA |
1849 | A colon-separated list of values controlling how commands are saved on |
1850 | the history list. | |
1851 | If the list of values includes | |
f73dda09 JA |
1852 | .IR ignorespace , |
1853 | lines which begin with a | |
1854 | .B space | |
b80f6443 JA |
1855 | character are not saved in the history list. |
1856 | A value of | |
1857 | .I ignoredups | |
1858 | causes lines matching the previous history entry to not be saved. | |
f73dda09 JA |
1859 | A value of |
1860 | .I ignoreboth | |
b80f6443 JA |
1861 | is shorthand for \fIignorespace\fP and \fIignoredups\fP. |
1862 | A value of | |
1863 | .IR erasedups | |
1864 | causes all previous lines matching the current line to be removed from | |
1865 | the history list before that line is saved. | |
1866 | Any value not in the above list is ignored. | |
0001803f CR |
1867 | If |
1868 | .SM | |
1869 | .B HISTCONTROL | |
1870 | is unset, or does not include a valid value, | |
b80f6443 JA |
1871 | all lines read by the shell parser are saved on the history list, |
1872 | subject to the value of | |
0001803f | 1873 | .SM |
f73dda09 JA |
1874 | .BR HISTIGNORE . |
1875 | The second and subsequent lines of a multi-line compound command are | |
1876 | not tested, and are added to the history regardless of the value of | |
0001803f | 1877 | .SM |
f73dda09 | 1878 | .BR HISTCONTROL . |
726f6388 JA |
1879 | .TP |
1880 | .B HISTFILE | |
ccc6cda3 | 1881 | The name of the file in which command history is saved (see |
726f6388 JA |
1882 | .SM |
1883 | .B HISTORY | |
ccc6cda3 | 1884 | below). The default value is \fI~/.bash_history\fP. If unset, the |
726f6388 JA |
1885 | command history is not saved when an interactive shell exits. |
1886 | .TP | |
1887 | .B HISTFILESIZE | |
1888 | The maximum number of lines contained in the history file. When this | |
1889 | variable is assigned a value, the history file is truncated, if | |
0628567a JA |
1890 | necessary, by removing the oldest entries, |
1891 | to contain no more than that number of lines. The default | |
ccc6cda3 JA |
1892 | value is 500. The history file is also truncated to this size after |
1893 | writing it when an interactive shell exits. | |
726f6388 | 1894 | .TP |
f73dda09 JA |
1895 | .B HISTIGNORE |
1896 | A colon-separated list of patterns used to decide which command lines | |
1897 | should be saved on the history list. Each pattern is anchored at the | |
1898 | beginning of the line and must match the complete line (no implicit | |
1899 | `\fB*\fP' is appended). Each pattern is tested against the line | |
1900 | after the checks specified by | |
0001803f | 1901 | .SM |
f73dda09 JA |
1902 | .B HISTCONTROL |
1903 | are applied. | |
1904 | In addition to the normal shell pattern matching characters, `\fB&\fP' | |
1905 | matches the previous history line. `\fB&\fP' may be escaped using a | |
1906 | backslash; the backslash is removed before attempting a match. | |
1907 | The second and subsequent lines of a multi-line compound command are | |
1908 | not tested, and are added to the history regardless of the value of | |
0001803f | 1909 | .SM |
f73dda09 JA |
1910 | .BR HISTIGNORE . |
1911 | .TP | |
1912 | .B HISTSIZE | |
1913 | The number of commands to remember in the command history (see | |
1914 | .SM | |
1915 | .B HISTORY | |
1916 | below). The default value is 500. | |
1917 | .TP | |
b80f6443 JA |
1918 | .B HISTTIMEFORMAT |
1919 | If this variable is set and not null, its value is used as a format string | |
1920 | for \fIstrftime\fP(3) to print the time stamp associated with each history | |
1921 | entry displayed by the \fBhistory\fP builtin. | |
1922 | If this variable is set, time stamps are written to the history file so | |
1923 | they may be preserved across shell sessions. | |
3185942a JA |
1924 | This uses the history comment character to distinguish timestamps from |
1925 | other history lines. | |
b80f6443 | 1926 | .TP |
f73dda09 JA |
1927 | .B HOME |
1928 | The home directory of the current user; the default argument for the | |
1929 | \fBcd\fP builtin command. | |
1930 | The value of this variable is also used when performing tilde expansion. | |
1931 | .TP | |
1932 | .B HOSTFILE | |
1933 | Contains the name of a file in the same format as | |
1934 | .FN /etc/hosts | |
1935 | that should be read when the shell needs to complete a | |
1936 | hostname. | |
1937 | The list of possible hostname completions may be changed while the | |
1938 | shell is running; | |
1939 | the next time hostname completion is attempted after the | |
1940 | value is changed, | |
726f6388 | 1941 | .B bash |
f73dda09 JA |
1942 | adds the contents of the new file to the existing list. |
1943 | If | |
726f6388 | 1944 | .SM |
f73dda09 | 1945 | .B HOSTFILE |
0001803f CR |
1946 | is set, but has no value, or does not name a readable file, |
1947 | \fBbash\fP attempts to read | |
f73dda09 JA |
1948 | .FN /etc/hosts |
1949 | to obtain the list of possible hostname completions. | |
1950 | When | |
726f6388 | 1951 | .SM |
f73dda09 JA |
1952 | .B HOSTFILE |
1953 | is unset, the hostname list is cleared. | |
1954 | .TP | |
1955 | .B IFS | |
1956 | The | |
1957 | .I Internal Field Separator | |
1958 | that is used | |
1959 | for word splitting after expansion and to | |
1960 | split lines into words with the | |
1961 | .B read | |
1962 | builtin command. The default value is | |
1963 | ``<space><tab><newline>''. | |
1964 | .TP | |
1965 | .B IGNOREEOF | |
1966 | Controls the | |
1967 | action of an interactive shell on receipt of an | |
1968 | .SM | |
1969 | .B EOF | |
1970 | character as the sole input. If set, the value is the number of | |
1971 | consecutive | |
1972 | .SM | |
1973 | .B EOF | |
1974 | characters which must be | |
1975 | typed as the first characters on an input line before | |
1976 | .B bash | |
1977 | exits. If the variable exists but does not have a numeric value, or | |
1978 | has no value, the default value is 10. If it does not exist, | |
1979 | .SM | |
1980 | .B EOF | |
1981 | signifies the end of input to the shell. | |
1982 | .TP | |
1983 | .B INPUTRC | |
1984 | The filename for the | |
1985 | .B readline | |
1986 | startup file, overriding the default of | |
1987 | .FN ~/.inputrc | |
1988 | (see | |
1989 | .SM | |
1990 | .B READLINE | |
1991 | below). | |
726f6388 | 1992 | .TP |
ccc6cda3 JA |
1993 | .B LANG |
1994 | Used to determine the locale category for any category not specifically | |
1995 | selected with a variable starting with \fBLC_\fP. | |
1996 | .TP | |
1997 | .B LC_ALL | |
0001803f CR |
1998 | This variable overrides the value of |
1999 | .SM | |
2000 | .B LANG | |
2001 | and any other | |
ccc6cda3 JA |
2002 | \fBLC_\fP variable specifying a locale category. |
2003 | .TP | |
2004 | .B LC_COLLATE | |
2005 | This variable determines the collation order used when sorting the | |
cce855bc JA |
2006 | results of pathname expansion, and determines the behavior of range |
2007 | expressions, equivalence classes, and collating sequences within | |
2008 | pathname expansion and pattern matching. | |
2009 | .TP | |
2010 | .B LC_CTYPE | |
2011 | This variable determines the interpretation of characters and the | |
2012 | behavior of character classes within pathname expansion and pattern | |
2013 | matching. | |
ccc6cda3 JA |
2014 | .TP |
2015 | .B LC_MESSAGES | |
2016 | This variable determines the locale used to translate double-quoted | |
2017 | strings preceded by a \fB$\fP. | |
2018 | .TP | |
bb70624e JA |
2019 | .B LC_NUMERIC |
2020 | This variable determines the locale category used for number formatting. | |
2021 | .TP | |
28ef6c31 JA |
2022 | .B LINES |
2023 | Used by the \fBselect\fP builtin command to determine the column length | |
0001803f CR |
2024 | for printing selection lists. Automatically set upon receipt of a |
2025 | .SM | |
2026 | .BR SIGWINCH . | |
28ef6c31 | 2027 | .TP |
f73dda09 JA |
2028 | .B MAIL |
2029 | If this parameter is set to a file name and the | |
726f6388 | 2030 | .SM |
f73dda09 JA |
2031 | .B MAILPATH |
2032 | variable is not set, | |
726f6388 | 2033 | .B bash |
f73dda09 | 2034 | informs the user of the arrival of mail in the specified file. |
726f6388 | 2035 | .TP |
f73dda09 JA |
2036 | .B MAILCHECK |
2037 | Specifies how | |
2038 | often (in seconds) | |
2039 | .B bash | |
2040 | checks for mail. The default is 60 seconds. When it is time to check | |
2041 | for mail, the shell does so before displaying the primary prompt. | |
2042 | If this variable is unset, or set to a value that is not a number | |
2043 | greater than or equal to zero, the shell disables mail checking. | |
726f6388 | 2044 | .TP |
f73dda09 JA |
2045 | .B MAILPATH |
2046 | A colon-separated list of file names to be checked for mail. | |
2047 | The message to be printed when mail arrives in a particular file | |
2048 | may be specified by separating the file name from the message with a `?'. | |
2049 | When used in the text of the message, \fB$_\fP expands to the name of | |
2050 | the current mailfile. | |
2051 | Example: | |
2052 | .RS | |
2053 | .PP | |
0628567a | 2054 | \fBMAILPATH\fP=\(aq/var/mail/bfox?"You have mail":~/shell\-mail?"$_ has mail!"\(aq |
f73dda09 JA |
2055 | .PP |
2056 | .B Bash | |
2057 | supplies a default value for this variable, but the location of the user | |
2058 | mail files that it uses is system dependent (e.g., /var/mail/\fB$USER\fP). | |
2059 | .RE | |
726f6388 | 2060 | .TP |
f73dda09 JA |
2061 | .B OPTERR |
2062 | If set to the value 1, | |
2063 | .B bash | |
2064 | displays error messages generated by the | |
2065 | .B getopts | |
2066 | builtin command (see | |
726f6388 | 2067 | .SM |
f73dda09 | 2068 | .B SHELL BUILTIN COMMANDS |
ccc6cda3 | 2069 | below). |
726f6388 | 2070 | .SM |
f73dda09 JA |
2071 | .B OPTERR |
2072 | is initialized to 1 each time the shell is invoked or a shell | |
2073 | script is executed. | |
ccc6cda3 | 2074 | .TP |
f73dda09 JA |
2075 | .B PATH |
2076 | The search path for commands. It | |
2077 | is a colon-separated list of directories in which | |
2078 | the shell looks for commands (see | |
ccc6cda3 | 2079 | .SM |
f73dda09 | 2080 | .B COMMAND EXECUTION |
b80f6443 | 2081 | below). |
0001803f CR |
2082 | A zero-length (null) directory name in the value of |
2083 | .SM | |
2084 | .B PATH | |
2085 | indicates the current directory. | |
b80f6443 JA |
2086 | A null directory name may appear as two adjacent colons, or as an initial |
2087 | or trailing colon. | |
2088 | The default path is system-dependent, | |
f73dda09 JA |
2089 | and is set by the administrator who installs |
2090 | .BR bash . | |
2091 | A common value is | |
b80f6443 JA |
2092 | .if t \f(CW/usr/gnu/bin:/usr/local/bin:/usr/ucb:/bin:/usr/bin\fP. |
2093 | .if n ``/usr/gnu/bin:/usr/local/bin:/usr/ucb:/bin:/usr/bin''. | |
726f6388 | 2094 | .TP |
f73dda09 JA |
2095 | .B POSIXLY_CORRECT |
2096 | If this variable is in the environment when \fBbash\fP starts, the shell | |
2097 | enters \fIposix mode\fP before reading the startup files, as if the | |
2098 | .B \-\-posix | |
2099 | invocation option had been supplied. If it is set while the shell is | |
2100 | running, \fBbash\fP enables \fIposix mode\fP, as if the command | |
2101 | .if t \f(CWset -o posix\fP | |
2102 | .if n \fIset -o posix\fP | |
2103 | had been executed. | |
726f6388 | 2104 | .TP |
f73dda09 JA |
2105 | .B PROMPT_COMMAND |
2106 | If set, the value is executed as a command prior to issuing each primary | |
2107 | prompt. | |
ccc6cda3 | 2108 | .TP |
3185942a JA |
2109 | .B PROMPT_DIRTRIM |
2110 | If set to a number greater than zero, the value is used as the number of | |
0001803f | 2111 | trailing directory components to retain when expanding the \fB\ew\fP and |
3185942a JA |
2112 | \fB\eW\fP prompt string escapes (see |
2113 | .SM | |
2114 | .B PROMPTING | |
2115 | below). Characters removed are replaced with an ellipsis. | |
2116 | .TP | |
f73dda09 JA |
2117 | .B PS1 |
2118 | The value of this parameter is expanded (see | |
2119 | .SM | |
2120 | .B PROMPTING | |
2121 | below) and used as the primary prompt string. The default value is | |
2122 | ``\fB\es\-\ev\e$ \fP''. | |
726f6388 | 2123 | .TP |
f73dda09 JA |
2124 | .B PS2 |
2125 | The value of this parameter is expanded as with | |
0001803f | 2126 | .SM |
f73dda09 JA |
2127 | .B PS1 |
2128 | and used as the secondary prompt string. The default is | |
2129 | ``\fB> \fP''. | |
2130 | .TP | |
2131 | .B PS3 | |
2132 | The value of this parameter is used as the prompt for the | |
2133 | .B select | |
2134 | command (see | |
726f6388 | 2135 | .SM |
f73dda09 JA |
2136 | .B SHELL GRAMMAR |
2137 | above). | |
726f6388 | 2138 | .TP |
f73dda09 JA |
2139 | .B PS4 |
2140 | The value of this parameter is expanded as with | |
0001803f | 2141 | .SM |
f73dda09 JA |
2142 | .B PS1 |
2143 | and the value is printed before each command | |
726f6388 | 2144 | .B bash |
f73dda09 | 2145 | displays during an execution trace. The first character of |
bb70624e | 2146 | .SM |
f73dda09 JA |
2147 | .B PS4 |
2148 | is replicated multiple times, as necessary, to indicate multiple | |
2149 | levels of indirection. The default is ``\fB+ \fP''. | |
2150 | .TP | |
b80f6443 JA |
2151 | .B SHELL |
2152 | The full pathname to the shell is kept in this environment variable. | |
2153 | If it is not set when the shell starts, | |
2154 | .B bash | |
2155 | assigns to it the full pathname of the current user's login shell. | |
2156 | .TP | |
f73dda09 JA |
2157 | .B TIMEFORMAT |
2158 | The value of this parameter is used as a format string specifying | |
2159 | how the timing information for pipelines prefixed with the | |
2160 | .B time | |
2161 | reserved word should be displayed. | |
2162 | The \fB%\fP character introduces an escape sequence that is | |
2163 | expanded to a time value or other information. | |
2164 | The escape sequences and their meanings are as follows; the | |
2165 | braces denote optional portions. | |
2166 | .sp .5 | |
2167 | .RS | |
2168 | .PD 0 | |
2169 | .TP 10 | |
2170 | .B %% | |
2171 | A literal \fB%\fP. | |
2172 | .TP | |
2173 | .B %[\fIp\fP][l]R | |
2174 | The elapsed time in seconds. | |
2175 | .TP | |
2176 | .B %[\fIp\fP][l]U | |
2177 | The number of CPU seconds spent in user mode. | |
2178 | .TP | |
2179 | .B %[\fIp\fP][l]S | |
2180 | The number of CPU seconds spent in system mode. | |
2181 | .TP | |
2182 | .B %P | |
2183 | The CPU percentage, computed as (%U + %S) / %R. | |
2184 | .PD | |
2185 | .RE | |
2186 | .IP | |
2187 | The optional \fIp\fP is a digit specifying the \fIprecision\fP, | |
2188 | the number of fractional digits after a decimal point. | |
2189 | A value of 0 causes no decimal point or fraction to be output. | |
2190 | At most three places after the decimal point may be specified; | |
2191 | values of \fIp\fP greater than 3 are changed to 3. | |
2192 | If \fIp\fP is not specified, the value 3 is used. | |
2193 | .IP | |
2194 | The optional \fBl\fP specifies a longer format, including | |
2195 | minutes, of the form \fIMM\fPm\fISS\fP.\fIFF\fPs. | |
2196 | The value of \fIp\fP determines whether or not the fraction is | |
2197 | included. | |
2198 | .IP | |
2199 | If this variable is not set, \fBbash\fP acts as if it had the | |
0628567a | 2200 | value \fB$\(aq\enreal\et%3lR\enuser\et%3lU\ensys\t%3lS\(aq\fP. |
f73dda09 JA |
2201 | If the value is null, no timing information is displayed. |
2202 | A trailing newline is added when the format string is displayed. | |
2203 | .TP | |
2204 | .B TMOUT | |
0001803f CR |
2205 | If set to a value greater than zero, |
2206 | .SM | |
2207 | .B TMOUT | |
2208 | is treated as the | |
7117c2d2 JA |
2209 | default timeout for the \fBread\fP builtin. |
2210 | The \fBselect\fP command terminates if input does not arrive | |
0001803f CR |
2211 | after |
2212 | .SM | |
2213 | .B TMOUT | |
2214 | seconds when input is coming from a terminal. | |
7117c2d2 | 2215 | In an interactive shell, the value is interpreted as the |
f73dda09 JA |
2216 | number of seconds to wait for input after issuing the primary prompt. |
2217 | .B Bash | |
2218 | terminates after waiting for that number of seconds if input does | |
2219 | not arrive. | |
726f6388 | 2220 | .TP |
95732b49 JA |
2221 | .B TMPDIR |
2222 | If set, \fBBash\fP uses its value as the name of a directory in which | |
2223 | \fBBash\fP creates temporary files for the shell's use. | |
2224 | .TP | |
726f6388 JA |
2225 | .B auto_resume |
2226 | This variable controls how the shell interacts with the user and | |
2227 | job control. If this variable is set, single word simple | |
2228 | commands without redirections are treated as candidates for resumption | |
2229 | of an existing stopped job. There is no ambiguity allowed; if there is | |
2230 | more than one job beginning with the string typed, the job most recently | |
2231 | accessed is selected. The | |
2232 | .I name | |
2233 | of a stopped job, in this context, is the command line used to | |
2234 | start it. | |
2235 | If set to the value | |
2236 | .IR exact , | |
2237 | the string supplied must match the name of a stopped job exactly; | |
2238 | if set to | |
2239 | .IR substring , | |
2240 | the string supplied needs to match a substring of the name of a | |
2241 | stopped job. The | |
2242 | .I substring | |
2243 | value provides functionality analogous to the | |
2244 | .B %? | |
ccc6cda3 | 2245 | job identifier (see |
726f6388 JA |
2246 | .SM |
2247 | .B JOB CONTROL | |
2248 | below). If set to any other value, the supplied string must | |
2249 | be a prefix of a stopped job's name; this provides functionality | |
95732b49 | 2250 | analogous to the \fB%\fP\fIstring\fP job identifier. |
bb70624e | 2251 | .TP |
f73dda09 JA |
2252 | .B histchars |
2253 | The two or three characters which control history expansion | |
2254 | and tokenization (see | |
2255 | .SM | |
2256 | .B HISTORY EXPANSION | |
2257 | below). The first character is the \fIhistory expansion\fP character, | |
2258 | the character which signals the start of a history | |
2259 | expansion, normally `\fB!\fP'. | |
2260 | The second character is the \fIquick substitution\fP | |
2261 | character, which is used as shorthand for re-running the previous | |
2262 | command entered, substituting one string for another in the command. | |
2263 | The default is `\fB^\fP'. | |
2264 | The optional third character is the character | |
2265 | which indicates that the remainder of the line is a comment when found | |
2266 | as the first character of a word, normally `\fB#\fP'. The history | |
2267 | comment character causes history substitution to be skipped for the | |
2268 | remaining words on the line. It does not necessarily cause the shell | |
2269 | parser to treat the rest of the line as a comment. | |
726f6388 | 2270 | .PD |
ccc6cda3 JA |
2271 | .SS Arrays |
2272 | .B Bash | |
3185942a JA |
2273 | provides one-dimensional indexed and associative array variables. |
2274 | Any variable may be used as an indexed array; the | |
ccc6cda3 | 2275 | .B declare |
3185942a JA |
2276 | builtin will explicitly declare an array. |
2277 | There is no maximum | |
ccc6cda3 | 2278 | limit on the size of an array, nor any requirement that members |
3185942a JA |
2279 | be indexed or assigned contiguously. |
2280 | Indexed arrays are referenced using integers (including arithmetic | |
2281 | expressions) and are zero-based; associative arrays are referenced | |
2282 | using arbitrary strings. | |
ccc6cda3 | 2283 | .PP |
3185942a JA |
2284 | An indexed array is created automatically if any variable is assigned to |
2285 | using the syntax \fIname\fP[\fIsubscript\fP]=\fIvalue\fP. The | |
ccc6cda3 JA |
2286 | .I subscript |
2287 | is treated as an arithmetic expression that must evaluate to a number | |
3185942a JA |
2288 | greater than or equal to zero. To explicitly declare an indexed array, |
2289 | use | |
ccc6cda3 JA |
2290 | .B declare \-a \fIname\fP |
2291 | (see | |
2292 | .SM | |
2293 | .B SHELL BUILTIN COMMANDS | |
2294 | below). | |
2295 | .B declare \-a \fIname\fP[\fIsubscript\fP] | |
3185942a JA |
2296 | is also accepted; the \fIsubscript\fP is ignored. |
2297 | .PP | |
2298 | Associative arrays are created using | |
2299 | .BR "declare \-A \fIname\fP" . | |
2300 | .PP | |
2301 | Attributes may be | |
ccc6cda3 JA |
2302 | specified for an array variable using the |
2303 | .B declare | |
2304 | and | |
2305 | .B readonly | |
2306 | builtins. Each attribute applies to all members of an array. | |
2307 | .PP | |
2308 | Arrays are assigned to using compound assignments of the form | |
2309 | \fIname\fP=\fB(\fPvalue\fI1\fP ... value\fIn\fP\fB)\fP, where each | |
3185942a JA |
2310 | \fIvalue\fP is of the form [\fIsubscript\fP]=\fIstring\fP. |
2311 | Indexed array assignments do not require the bracket and subscript. | |
2312 | When assigning to indexed arrays, if the optional brackets and subscript | |
2313 | are supplied, that index is assigned to; | |
ccc6cda3 JA |
2314 | otherwise the index of the element assigned is the last index assigned |
2315 | to by the statement plus one. Indexing starts at zero. | |
3185942a JA |
2316 | .PP |
2317 | When assigning to an associative array, the subscript is required. | |
2318 | .PP | |
ccc6cda3 JA |
2319 | This syntax is also accepted by the |
2320 | .B declare | |
2321 | builtin. Individual array elements may be assigned to using the | |
2322 | \fIname\fP[\fIsubscript\fP]=\fIvalue\fP syntax introduced above. | |
2323 | .PP | |
2324 | Any element of an array may be referenced using | |
2325 | ${\fIname\fP[\fIsubscript\fP]}. The braces are required to avoid | |
2326 | conflicts with pathname expansion. If | |
2327 | \fIsubscript\fP is \fB@\fP or \fB*\fP, the word expands to | |
2328 | all members of \fIname\fP. These subscripts differ only when the | |
2329 | word appears within double quotes. If the word is double-quoted, | |
2330 | ${\fIname\fP[*]} expands to a single | |
2331 | word with the value of each array member separated by the first | |
2332 | character of the | |
2333 | .SM | |
2334 | .B IFS | |
2335 | special variable, and ${\fIname\fP[@]} expands each element of | |
2336 | \fIname\fP to a separate word. When there are no array members, | |
95732b49 JA |
2337 | ${\fIname\fP[@]} expands to nothing. |
2338 | If the double-quoted expansion occurs within a word, the expansion of | |
2339 | the first parameter is joined with the beginning part of the original | |
2340 | word, and the expansion of the last parameter is joined with the last | |
2341 | part of the original word. | |
2342 | This is analogous to the expansion | |
ccc6cda3 JA |
2343 | of the special parameters \fB*\fP and \fB@\fP (see |
2344 | .B Special Parameters | |
2345 | above). ${#\fIname\fP[\fIsubscript\fP]} expands to the length of | |
2346 | ${\fIname\fP[\fIsubscript\fP]}. If \fIsubscript\fP is \fB*\fP or | |
2347 | \fB@\fP, the expansion is the number of elements in the array. | |
2348 | Referencing an array variable without a subscript is equivalent to | |
3185942a | 2349 | referencing the array with a subscript of 0. |
ccc6cda3 | 2350 | .PP |
0001803f CR |
2351 | An array variable is considered set if a subscript has been assigned a |
2352 | value. The null string is a valid value. | |
2353 | .PP | |
ccc6cda3 JA |
2354 | The |
2355 | .B unset | |
bb70624e | 2356 | builtin is used to destroy arrays. \fBunset\fP \fIname\fP[\fIsubscript\fP] |
ccc6cda3 | 2357 | destroys the array element at index \fIsubscript\fP. |
0001803f CR |
2358 | Care must be taken to avoid unwanted side effects caused by pathname |
2359 | expansion. | |
ccc6cda3 JA |
2360 | \fBunset\fP \fIname\fP, where \fIname\fP is an array, or |
2361 | \fBunset\fP \fIname\fP[\fIsubscript\fP], where | |
2362 | \fIsubscript\fP is \fB*\fP or \fB@\fP, removes the entire array. | |
2363 | .PP | |
2364 | The | |
2365 | .BR declare , | |
2366 | .BR local , | |
2367 | and | |
2368 | .B readonly | |
2369 | builtins each accept a | |
2370 | .B \-a | |
3185942a JA |
2371 | option to specify an indexed array and a |
2372 | .B \-A | |
2373 | option to specify an associative array. | |
2374 | The | |
ccc6cda3 JA |
2375 | .B read |
2376 | builtin accepts a | |
2377 | .B \-a | |
2378 | option to assign a list of words read from the standard input | |
2379 | to an array. The | |
2380 | .B set | |
2381 | and | |
2382 | .B declare | |
2383 | builtins display array values in a way that allows them to be | |
2384 | reused as assignments. | |
726f6388 JA |
2385 | .SH EXPANSION |
2386 | Expansion is performed on the command line after it has been split into | |
2387 | words. There are seven kinds of expansion performed: | |
2388 | .IR "brace expansion" , | |
2389 | .IR "tilde expansion" , | |
2390 | .IR "parameter and variable expansion" , | |
2391 | .IR "command substitution" , | |
2392 | .IR "arithmetic expansion" , | |
2393 | .IR "word splitting" , | |
2394 | and | |
2395 | .IR "pathname expansion" . | |
2396 | .PP | |
2397 | The order of expansions is: brace expansion, tilde expansion, | |
ccc6cda3 JA |
2398 | parameter, variable and arithmetic expansion and |
2399 | command substitution | |
2400 | (done in a left-to-right fashion), word splitting, and pathname | |
726f6388 JA |
2401 | expansion. |
2402 | .PP | |
2403 | On systems that can support it, there is an additional expansion | |
2404 | available: \fIprocess substitution\fP. | |
2405 | .PP | |
2406 | Only brace expansion, word splitting, and pathname expansion | |
2407 | can change the number of words of the expansion; other expansions | |
2408 | expand a single word to a single word. | |
ccc6cda3 | 2409 | The only exceptions to this are the expansions of |
cce855bc | 2410 | "\fB$@\fP" and "\fB${\fP\fIname\fP\fB[@]}\fP" |
ccc6cda3 | 2411 | as explained above (see |
726f6388 JA |
2412 | .SM |
2413 | .BR PARAMETERS ). | |
2414 | .SS Brace Expansion | |
2415 | .PP | |
2416 | .I "Brace expansion" | |
2417 | is a mechanism by which arbitrary strings | |
2418 | may be generated. This mechanism is similar to | |
2419 | \fIpathname expansion\fP, but the filenames generated | |
2420 | need not exist. Patterns to be brace expanded take | |
2421 | the form of an optional | |
2422 | .IR preamble , | |
b80f6443 JA |
2423 | followed by either a series of comma-separated strings or |
2424 | a sequence expression between a pair of braces, followed by | |
2425 | an optional | |
cce855bc | 2426 | .IR postscript . |
ccc6cda3 | 2427 | The preamble is prefixed to each string contained |
cce855bc | 2428 | within the braces, and the postscript is then appended |
726f6388 JA |
2429 | to each resulting string, expanding left to right. |
2430 | .PP | |
2431 | Brace expansions may be nested. The results of each expanded | |
2432 | string are not sorted; left to right order is preserved. | |
2433 | For example, a\fB{\fPd,c,b\fB}\fPe expands into `ade ace abe'. | |
2434 | .PP | |
3185942a JA |
2435 | A sequence expression takes the form |
2436 | \fB{\fP\fIx\fP\fB..\fP\fIy\fP\fB[..\fP\fIincr\fP\fB]}\fP, | |
2437 | where \fIx\fP and \fIy\fP are either integers or single characters, | |
2438 | and \fIincr\fP, an optional increment, is an integer. | |
b80f6443 JA |
2439 | When integers are supplied, the expression expands to each number between |
2440 | \fIx\fP and \fIy\fP, inclusive. | |
3185942a JA |
2441 | Supplied integers may be prefixed with \fI0\fP to force each term to have the |
2442 | same width. When either \fIx\fP or \fPy\fP begins with a zero, the shell | |
2443 | attempts to force all generated terms to contain the same number of digits, | |
2444 | zero-padding where necessary. | |
b80f6443 JA |
2445 | When characters are supplied, the expression expands to each character |
2446 | lexicographically between \fIx\fP and \fIy\fP, inclusive. Note that | |
2447 | both \fIx\fP and \fIy\fP must be of the same type. | |
3185942a JA |
2448 | When the increment is supplied, it is used as the difference between |
2449 | each term. The default increment is 1 or -1 as appropriate. | |
b80f6443 | 2450 | .PP |
726f6388 JA |
2451 | Brace expansion is performed before any other expansions, |
2452 | and any characters special to other expansions are preserved | |
2453 | in the result. It is strictly textual. | |
2454 | .B Bash | |
2455 | does not apply any syntactic interpretation to the context of the | |
2456 | expansion or the text between the braces. | |
2457 | .PP | |
2458 | A correctly-formed brace expansion must contain unquoted opening | |
b80f6443 JA |
2459 | and closing braces, and at least one unquoted comma or a valid |
2460 | sequence expression. | |
726f6388 | 2461 | Any incorrectly formed brace expansion is left unchanged. |
ccc6cda3 JA |
2462 | A \fB{\fP or \fB,\fP may be quoted with a backslash to prevent its |
2463 | being considered part of a brace expression. | |
bb70624e JA |
2464 | To avoid conflicts with parameter expansion, the string \fB${\fP |
2465 | is not considered eligible for brace expansion. | |
726f6388 JA |
2466 | .PP |
2467 | This construct is typically used as shorthand when the common | |
2468 | prefix of the strings to be generated is longer than in the | |
2469 | above example: | |
2470 | .RS | |
2471 | .PP | |
2472 | mkdir /usr/local/src/bash/{old,new,dist,bugs} | |
2473 | .RE | |
2474 | or | |
2475 | .RS | |
2476 | chown root /usr/{ucb/{ex,edit},lib/{ex?.?*,how_ex}} | |
2477 | .RE | |
2478 | .PP | |
2479 | Brace expansion introduces a slight incompatibility with | |
ccc6cda3 JA |
2480 | historical versions of |
2481 | .BR sh . | |
726f6388 JA |
2482 | .B sh |
2483 | does not treat opening or closing braces specially when they | |
2484 | appear as part of a word, and preserves them in the output. | |
2485 | .B Bash | |
2486 | removes braces from words as a consequence of brace | |
2487 | expansion. For example, a word entered to | |
2488 | .B sh | |
2489 | as \fIfile{1,2}\fP | |
2490 | appears identically in the output. The same word is | |
2491 | output as | |
2492 | .I file1 file2 | |
2493 | after expansion by | |
2494 | .BR bash . | |
2495 | If strict compatibility with | |
2496 | .B sh | |
2497 | is desired, start | |
2498 | .B bash | |
2499 | with the | |
ccc6cda3 JA |
2500 | .B +B |
2501 | option or disable brace expansion with the | |
2502 | .B +B | |
726f6388 JA |
2503 | option to the |
2504 | .B set | |
2505 | command (see | |
2506 | .SM | |
2507 | .B SHELL BUILTIN COMMANDS | |
2508 | below). | |
2509 | .SS Tilde Expansion | |
2510 | .PP | |
cce855bc JA |
2511 | If a word begins with an unquoted tilde character (`\fB~\fP'), all of |
2512 | the characters preceding the first unquoted slash (or all characters, | |
2513 | if there is no unquoted slash) are considered a \fItilde-prefix\fP. | |
2514 | If none of the characters in the tilde-prefix are quoted, the | |
2515 | characters in the tilde-prefix following the tilde are treated as a | |
2516 | possible \fIlogin name\fP. | |
2517 | If this login name is the null string, the tilde is replaced with the | |
2518 | value of the shell parameter | |
726f6388 JA |
2519 | .SM |
2520 | .BR HOME . | |
2521 | If | |
2522 | .SM | |
2523 | .B HOME | |
cce855bc JA |
2524 | is unset, the home directory of the user executing the shell is |
2525 | substituted instead. | |
2526 | Otherwise, the tilde-prefix is replaced with the home directory | |
2527 | associated with the specified login name. | |
726f6388 | 2528 | .PP |
cce855bc | 2529 | If the tilde-prefix is a `~+', the value of the shell variable |
726f6388 JA |
2530 | .SM |
2531 | .B PWD | |
cce855bc JA |
2532 | replaces the tilde-prefix. |
2533 | If the tilde-prefix is a `~\-', the value of the shell variable | |
2534 | .SM | |
2535 | .BR OLDPWD , | |
2536 | if it is set, is substituted. | |
2537 | If the characters following the tilde in the tilde-prefix consist | |
2538 | of a number \fIN\fP, optionally prefixed | |
2539 | by a `+' or a `\-', the tilde-prefix is replaced with the corresponding | |
2540 | element from the directory stack, as it would be displayed by the | |
2541 | .B dirs | |
2542 | builtin invoked with the tilde-prefix as an argument. | |
2543 | If the characters following the tilde in the tilde-prefix consist of a | |
2544 | number without a leading `+' or `\-', `+' is assumed. | |
2545 | .PP | |
2546 | If the login name is invalid, or the tilde expansion fails, the word | |
2547 | is unchanged. | |
726f6388 | 2548 | .PP |
cce855bc JA |
2549 | Each variable assignment is checked for unquoted tilde-prefixes immediately |
2550 | following a | |
726f6388 | 2551 | .B : |
95732b49 | 2552 | or the first |
726f6388 | 2553 | .BR = . |
cce855bc JA |
2554 | In these cases, tilde expansion is also performed. |
2555 | Consequently, one may use file names with tildes in assignments to | |
726f6388 JA |
2556 | .SM |
2557 | .BR PATH , | |
2558 | .SM | |
2559 | .BR MAILPATH , | |
2560 | and | |
2561 | .SM | |
2562 | .BR CDPATH , | |
2563 | and the shell assigns the expanded value. | |
2564 | .SS Parameter Expansion | |
2565 | .PP | |
2566 | The `\fB$\fP' character introduces parameter expansion, | |
2567 | command substitution, or arithmetic expansion. The parameter name | |
2568 | or symbol to be expanded may be enclosed in braces, which | |
2569 | are optional but serve to protect the variable to be expanded from | |
2570 | characters immediately following it which could be | |
2571 | interpreted as part of the name. | |
2572 | .PP | |
cce855bc JA |
2573 | When braces are used, the matching ending brace is the first `\fB}\fP' |
2574 | not escaped by a backslash or within a quoted string, and not within an | |
95732b49 | 2575 | embedded arithmetic expansion, command substitution, or parameter |
cce855bc JA |
2576 | expansion. |
2577 | .PP | |
726f6388 JA |
2578 | .PD 0 |
2579 | .TP | |
2580 | ${\fIparameter\fP} | |
2581 | The value of \fIparameter\fP is substituted. The braces are required | |
2582 | when | |
2583 | .I parameter | |
2584 | is a positional parameter with more than one digit, | |
2585 | or when | |
2586 | .I parameter | |
2587 | is followed by a character which is not to be | |
2588 | interpreted as part of its name. | |
2589 | .PD | |
2590 | .PP | |
0001803f | 2591 | If the first character of \fIparameter\fP is an exclamation point (\fB!\fP), |
ccc6cda3 JA |
2592 | a level of variable indirection is introduced. |
2593 | \fBBash\fP uses the value of the variable formed from the rest of | |
2594 | \fIparameter\fP as the name of the variable; this variable is then | |
bb70624e | 2595 | expanded and that value is used in the rest of the substitution, rather |
ccc6cda3 JA |
2596 | than the value of \fIparameter\fP itself. |
2597 | This is known as \fIindirect expansion\fP. | |
b80f6443 JA |
2598 | The exceptions to this are the expansions of ${!\fIprefix\fP*} and |
2599 | ${\fB!\fP\fIname\fP[\fI@\fP]} described below. | |
2600 | The exclamation point must immediately follow the left brace in order to | |
2601 | introduce indirection. | |
ccc6cda3 | 2602 | .PP |
726f6388 JA |
2603 | In each of the cases below, \fIword\fP is subject to tilde expansion, |
2604 | parameter expansion, command substitution, and arithmetic expansion. | |
17345e5a JA |
2605 | .PP |
2606 | When not performing substring expansion, using the forms documented below, | |
2607 | \fBbash\fP tests for a parameter that is unset or null. Omitting the colon | |
2608 | results in a test only for a parameter that is unset. | |
726f6388 JA |
2609 | .PP |
2610 | .PD 0 | |
2611 | .TP | |
2612 | ${\fIparameter\fP\fB:\-\fP\fIword\fP} | |
2613 | \fBUse Default Values\fP. If | |
2614 | .I parameter | |
2615 | is unset or null, the expansion of | |
2616 | .I word | |
2617 | is substituted. Otherwise, the value of | |
2618 | .I parameter | |
2619 | is substituted. | |
2620 | .TP | |
2621 | ${\fIparameter\fP\fB:=\fP\fIword\fP} | |
2622 | \fBAssign Default Values\fP. | |
2623 | If | |
2624 | .I parameter | |
2625 | is unset or null, the expansion of | |
2626 | .I word | |
2627 | is assigned to | |
2628 | .IR parameter . | |
2629 | The value of | |
2630 | .I parameter | |
2631 | is then substituted. Positional parameters and special parameters may | |
2632 | not be assigned to in this way. | |
2633 | .TP | |
2634 | ${\fIparameter\fP\fB:?\fP\fIword\fP} | |
2635 | \fBDisplay Error if Null or Unset\fP. | |
2636 | If | |
2637 | .I parameter | |
2638 | is null or unset, the expansion of \fIword\fP (or a message to that effect | |
2639 | if | |
2640 | .I word | |
2641 | is not present) is written to the standard error and the shell, if it | |
2642 | is not interactive, exits. Otherwise, the value of \fIparameter\fP is | |
2643 | substituted. | |
2644 | .TP | |
2645 | ${\fIparameter\fP\fB:+\fP\fIword\fP} | |
2646 | \fBUse Alternate Value\fP. | |
2647 | If | |
2648 | .I parameter | |
2649 | is null or unset, nothing is substituted, otherwise the expansion of | |
2650 | .I word | |
2651 | is substituted. | |
2652 | .TP | |
ccc6cda3 | 2653 | ${\fIparameter\fP\fB:\fP\fIoffset\fP} |
7117c2d2 | 2654 | .PD 0 |
ccc6cda3 JA |
2655 | .TP |
2656 | ${\fIparameter\fP\fB:\fP\fIoffset\fP\fB:\fP\fIlength\fP} | |
2657 | .PD | |
2658 | \fBSubstring Expansion.\fP | |
bb70624e JA |
2659 | Expands to up to \fIlength\fP characters of \fIparameter\fP |
2660 | starting at the character specified by \fIoffset\fP. | |
ccc6cda3 | 2661 | If \fIlength\fP is omitted, expands to the substring of |
bb70624e | 2662 | \fIparameter\fP starting at the character specified by \fIoffset\fP. |
ccc6cda3 JA |
2663 | \fIlength\fP and \fIoffset\fP are arithmetic expressions (see |
2664 | .SM | |
2665 | .B | |
2666 | ARITHMETIC EVALUATION | |
2667 | below). | |
2668 | \fIlength\fP must evaluate to a number greater than or equal to zero. | |
2669 | If \fIoffset\fP evaluates to a number less than zero, the value | |
2670 | is used as an offset from the end of the value of \fIparameter\fP. | |
2671 | If \fIparameter\fP is \fB@\fP, the result is \fIlength\fP positional | |
2672 | parameters beginning at \fIoffset\fP. | |
3185942a | 2673 | If \fIparameter\fP is an indexed array name subscripted by @ or *, |
ccc6cda3 JA |
2674 | the result is the \fIlength\fP |
2675 | members of the array beginning with ${\fIparameter\fP[\fIoffset\fP]}. | |
95732b49 JA |
2676 | A negative \fIoffset\fP is taken relative to one greater than the maximum |
2677 | index of the specified array. | |
3185942a JA |
2678 | Substring expansion applied to an associative array produces undefined |
2679 | results. | |
95732b49 JA |
2680 | Note that a negative offset must be separated from the colon by at least |
2681 | one space to avoid being confused with the :- expansion. | |
cce855bc | 2682 | Substring indexing is zero-based unless the positional parameters |
3185942a JA |
2683 | are used, in which case the indexing starts at 1 by default. |
2684 | If \fIoffset\fP is 0, and the positional parameters are used, \fB$0\fP is | |
2685 | prefixed to the list. | |
ccc6cda3 | 2686 | .TP |
bb70624e | 2687 | ${\fB!\fP\fIprefix\fP\fB*\fP} |
b80f6443 JA |
2688 | .PD 0 |
2689 | .TP | |
2690 | ${\fB!\fP\fIprefix\fP\fB@\fP} | |
2691 | .PD | |
3185942a | 2692 | \fBNames matching prefix.\fP |
bb70624e JA |
2693 | Expands to the names of variables whose names begin with \fIprefix\fP, |
2694 | separated by the first character of the | |
2695 | .SM | |
2696 | .B IFS | |
2697 | special variable. | |
3185942a JA |
2698 | When \fI@\fP is used and the expansion appears within double quotes, each |
2699 | variable name expands to a separate word. | |
bb70624e | 2700 | .TP |
b80f6443 JA |
2701 | ${\fB!\fP\fIname\fP[\fI@\fP]} |
2702 | .PD 0 | |
2703 | .TP | |
2704 | ${\fB!\fP\fIname\fP[\fI*\fP]} | |
2705 | .PD | |
3185942a | 2706 | \fBList of array keys.\fP |
b80f6443 JA |
2707 | If \fIname\fP is an array variable, expands to the list of array indices |
2708 | (keys) assigned in \fIname\fP. | |
2709 | If \fIname\fP is not an array, expands to 0 if \fIname\fP is set and null | |
2710 | otherwise. | |
2711 | When \fI@\fP is used and the expansion appears within double quotes, each | |
2712 | key expands to a separate word. | |
2713 | .TP | |
726f6388 | 2714 | ${\fB#\fP\fIparameter\fP} |
3185942a | 2715 | \fBParameter length.\fP |
726f6388 | 2716 | The length in characters of the value of \fIparameter\fP is substituted. |
ccc6cda3 JA |
2717 | If |
2718 | .I parameter | |
2719 | is | |
726f6388 JA |
2720 | .B * |
2721 | or | |
2722 | .BR @ , | |
cce855bc | 2723 | the value substituted is the number of positional parameters. |
ccc6cda3 JA |
2724 | If |
2725 | .I parameter | |
2726 | is an array name subscripted by | |
726f6388 | 2727 | .B * |
ccc6cda3 JA |
2728 | or |
2729 | .BR @ , | |
cce855bc | 2730 | the value substituted is the number of elements in the array. |
726f6388 | 2731 | .TP |
726f6388 | 2732 | ${\fIparameter\fP\fB#\fP\fIword\fP} |
7117c2d2 | 2733 | .PD 0 |
726f6388 JA |
2734 | .TP |
2735 | ${\fIparameter\fP\fB##\fP\fIword\fP} | |
2736 | .PD | |
3185942a | 2737 | \fBRemove matching prefix pattern.\fP |
726f6388 JA |
2738 | The |
2739 | .I word | |
2740 | is expanded to produce a pattern just as in pathname | |
2741 | expansion. If the pattern matches the beginning of | |
2742 | the value of | |
2743 | .IR parameter , | |
cce855bc | 2744 | then the result of the expansion is the expanded value of |
726f6388 | 2745 | .I parameter |
ccc6cda3 JA |
2746 | with the shortest matching pattern (the ``\fB#\fP'' case) or the |
2747 | longest matching pattern (the ``\fB##\fP'' case) deleted. | |
2748 | If | |
2749 | .I parameter | |
2750 | is | |
2751 | .B @ | |
2752 | or | |
2753 | .BR * , | |
2754 | the pattern removal operation is applied to each positional | |
2755 | parameter in turn, and the expansion is the resultant list. | |
2756 | If | |
2757 | .I parameter | |
2758 | is an array variable subscripted with | |
2759 | .B @ | |
2760 | or | |
2761 | .BR * , | |
2762 | the pattern removal operation is applied to each member of the | |
2763 | array in turn, and the expansion is the resultant list. | |
726f6388 | 2764 | .TP |
726f6388 | 2765 | ${\fIparameter\fP\fB%\fP\fIword\fP} |
7117c2d2 | 2766 | .PD 0 |
726f6388 JA |
2767 | .TP |
2768 | ${\fIparameter\fP\fB%%\fP\fIword\fP} | |
2769 | .PD | |
3185942a | 2770 | \fBRemove matching suffix pattern.\fP |
726f6388 | 2771 | The \fIword\fP is expanded to produce a pattern just as in |
ccc6cda3 | 2772 | pathname expansion. |
cce855bc | 2773 | If the pattern matches a trailing portion of the expanded value of |
726f6388 | 2774 | .IR parameter , |
cce855bc | 2775 | then the result of the expansion is the expanded value of |
726f6388 | 2776 | .I parameter |
ccc6cda3 JA |
2777 | with the shortest matching pattern (the ``\fB%\fP'' case) or the |
2778 | longest matching pattern (the ``\fB%%\fP'' case) deleted. | |
2779 | If | |
2780 | .I parameter | |
2781 | is | |
2782 | .B @ | |
2783 | or | |
2784 | .BR * , | |
2785 | the pattern removal operation is applied to each positional | |
2786 | parameter in turn, and the expansion is the resultant list. | |
2787 | If | |
2788 | .I parameter | |
2789 | is an array variable subscripted with | |
2790 | .B @ | |
2791 | or | |
2792 | .BR * , | |
2793 | the pattern removal operation is applied to each member of the | |
2794 | array in turn, and the expansion is the resultant list. | |
2795 | .TP | |
ccc6cda3 | 2796 | ${\fIparameter\fP\fB/\fP\fIpattern\fP\fB/\fP\fIstring\fP} |
3185942a | 2797 | \fBPattern substitution.\fP |
ccc6cda3 JA |
2798 | The \fIpattern\fP is expanded to produce a pattern just as in |
2799 | pathname expansion. | |
2800 | \fIParameter\fP is expanded and the longest match of \fIpattern\fP | |
2801 | against its value is replaced with \fIstring\fP. | |
3185942a | 2802 | If \fIpattern\fP begins with \fB/\fP, all matches of \fIpattern\fP are |
0628567a | 2803 | replaced with \fIstring\fP. Normally only the first match is replaced. |
ccc6cda3 | 2804 | If \fIpattern\fP begins with \fB#\fP, it must match at the beginning |
b72432fd | 2805 | of the expanded value of \fIparameter\fP. |
ccc6cda3 | 2806 | If \fIpattern\fP begins with \fB%\fP, it must match at the end |
b72432fd | 2807 | of the expanded value of \fIparameter\fP. |
ccc6cda3 JA |
2808 | If \fIstring\fP is null, matches of \fIpattern\fP are deleted |
2809 | and the \fB/\fP following \fIpattern\fP may be omitted. | |
2810 | If | |
2811 | .I parameter | |
2812 | is | |
2813 | .B @ | |
2814 | or | |
2815 | .BR * , | |
2816 | the substitution operation is applied to each positional | |
2817 | parameter in turn, and the expansion is the resultant list. | |
2818 | If | |
2819 | .I parameter | |
2820 | is an array variable subscripted with | |
2821 | .B @ | |
2822 | or | |
2823 | .BR * , | |
2824 | the substitution operation is applied to each member of the | |
2825 | array in turn, and the expansion is the resultant list. | |
3185942a JA |
2826 | .TP |
2827 | ${\fIparameter\fP\fB^\fP\fIpattern\fP} | |
2828 | .PD 0 | |
2829 | .TP | |
2830 | ${\fIparameter\fP\fB^^\fP\fIpattern\fP} | |
2831 | .TP | |
2832 | ${\fIparameter\fP\fB,\fP\fIpattern\fP} | |
2833 | .TP | |
2834 | ${\fIparameter\fP\fB,,\fP\fIpattern\fP} | |
2835 | .PD | |
2836 | \fBCase modification.\fP | |
2837 | This expansion modifies the case of alphabetic characters in \fIparameter\fP. | |
2838 | The \fIpattern\fP is expanded to produce a pattern just as in | |
2839 | pathname expansion. | |
2840 | The \fB^\fP operator converts lowercase letters matching \fIpattern\fP | |
2841 | to uppercase; the \fB,\fP operator converts matching uppercase letters | |
2842 | to lowercase. | |
2843 | The \fB^^\fP and \fB,,\fP expansions convert each matched character in the | |
2844 | expanded value; the \fB^\fP and \fB,\fP expansions match and convert only | |
17345e5a | 2845 | the first character in the expanded value.. |
3185942a JA |
2846 | If \fIpattern\fP is omitted, it is treated like a \fB?\fP, which matches |
2847 | every character. | |
2848 | If | |
2849 | .I parameter | |
2850 | is | |
2851 | .B @ | |
2852 | or | |
2853 | .BR * , | |
2854 | the case modification operation is applied to each positional | |
2855 | parameter in turn, and the expansion is the resultant list. | |
2856 | If | |
2857 | .I parameter | |
2858 | is an array variable subscripted with | |
2859 | .B @ | |
2860 | or | |
2861 | .BR * , | |
2862 | the case modification operation is applied to each member of the | |
2863 | array in turn, and the expansion is the resultant list. | |
726f6388 JA |
2864 | .SS Command Substitution |
2865 | .PP | |
cce855bc | 2866 | \fICommand substitution\fP allows the output of a command to replace |
726f6388 JA |
2867 | the command name. There are two forms: |
2868 | .PP | |
2869 | .RS | |
2870 | .PP | |
2871 | \fB$(\fP\fIcommand\fP\|\fB)\fP | |
2872 | .RE | |
2873 | or | |
2874 | .RS | |
3185942a | 2875 | \fB\`\fP\fIcommand\fP\fB\`\fP |
726f6388 JA |
2876 | .RE |
2877 | .PP | |
ccc6cda3 | 2878 | .B Bash |
726f6388 JA |
2879 | performs the expansion by executing \fIcommand\fP and |
2880 | replacing the command substitution with the standard output of the | |
2881 | command, with any trailing newlines deleted. | |
cce855bc JA |
2882 | Embedded newlines are not deleted, but they may be removed during |
2883 | word splitting. | |
2884 | The command substitution \fB$(cat \fIfile\fP)\fR can be replaced by | |
2885 | the equivalent but faster \fB$(< \fIfile\fP)\fR. | |
726f6388 | 2886 | .PP |
ccc6cda3 | 2887 | When the old-style backquote form of substitution is used, |
726f6388 JA |
2888 | backslash retains its literal meaning except when followed by |
2889 | .BR $ , | |
3185942a | 2890 | .BR \` , |
726f6388 JA |
2891 | or |
2892 | .BR \e . | |
cce855bc JA |
2893 | The first backquote not preceded by a backslash terminates the |
2894 | command substitution. | |
726f6388 JA |
2895 | When using the $(\^\fIcommand\fP\|) form, all characters between the |
2896 | parentheses make up the command; none are treated specially. | |
2897 | .PP | |
cce855bc | 2898 | Command substitutions may be nested. To nest when using the backquoted form, |
726f6388 JA |
2899 | escape the inner backquotes with backslashes. |
2900 | .PP | |
2901 | If the substitution appears within double quotes, word splitting and | |
2902 | pathname expansion are not performed on the results. | |
2903 | .SS Arithmetic Expansion | |
2904 | .PP | |
2905 | Arithmetic expansion allows the evaluation of an arithmetic expression | |
ccc6cda3 | 2906 | and the substitution of the result. The format for arithmetic expansion is: |
726f6388 JA |
2907 | .RS |
2908 | .PP | |
726f6388 JA |
2909 | \fB$((\fP\fIexpression\fP\fB))\fP |
2910 | .RE | |
2911 | .PP | |
2912 | The | |
2913 | .I expression | |
2914 | is treated as if it were within double quotes, but a double quote | |
ccc6cda3 JA |
2915 | inside the parentheses is not treated specially. |
2916 | All tokens in the expression undergo parameter expansion, string | |
2917 | expansion, command substitution, and quote removal. | |
b80f6443 | 2918 | Arithmetic expansions may be nested. |
726f6388 JA |
2919 | .PP |
2920 | The evaluation is performed according to the rules listed below under | |
2921 | .SM | |
2922 | .BR "ARITHMETIC EVALUATION" . | |
2923 | If | |
2924 | .I expression | |
2925 | is invalid, | |
2926 | .B bash | |
2927 | prints a message indicating failure and no substitution occurs. | |
2928 | .SS Process Substitution | |
2929 | .PP | |
2930 | \fIProcess substitution\fP is supported on systems that support named | |
2931 | pipes (\fIFIFOs\fP) or the \fB/dev/fd\fP method of naming open files. | |
2932 | It takes the form of | |
2933 | \fB<(\fP\fIlist\^\fP\fB)\fP | |
2934 | or | |
2935 | \fB>(\fP\fIlist\^\fP\fB)\fP. | |
2936 | The process \fIlist\fP is run with its input or output connected to a | |
2937 | \fIFIFO\fP or some file in \fB/dev/fd\fP. The name of this file is | |
2938 | passed as an argument to the current command as the result of the | |
2939 | expansion. If the \fB>(\fP\fIlist\^\fP\fB)\fP form is used, writing to | |
2940 | the file will provide input for \fIlist\fP. If the | |
2941 | \fB<(\fP\fIlist\^\fP\fB)\fP form is used, the file passed as an | |
2942 | argument should be read to obtain the output of \fIlist\fP. | |
2943 | .PP | |
bb70624e | 2944 | When available, process substitution is performed |
ccc6cda3 JA |
2945 | simultaneously with parameter and variable expansion, |
2946 | command substitution, | |
2947 | and arithmetic expansion. | |
726f6388 JA |
2948 | .SS Word Splitting |
2949 | .PP | |
2950 | The shell scans the results of | |
2951 | parameter expansion, | |
2952 | command substitution, | |
2953 | and | |
2954 | arithmetic expansion | |
2955 | that did not occur within double quotes for | |
2956 | .IR "word splitting" . | |
2957 | .PP | |
2958 | The shell treats each character of | |
2959 | .SM | |
2960 | .B IFS | |
2961 | as a delimiter, and splits the results of the other | |
ccc6cda3 | 2962 | expansions into words on these characters. If |
726f6388 JA |
2963 | .SM |
2964 | .B IFS | |
ccc6cda3 JA |
2965 | is unset, or its |
2966 | value is exactly | |
726f6388 JA |
2967 | .BR <space><tab><newline> , |
2968 | the default, then | |
3185942a JA |
2969 | sequences of |
2970 | .BR <space> , | |
2971 | .BR <tab> , | |
2972 | and | |
2973 | .B <newline> | |
2974 | at the beginning and end of the results of the previous | |
2975 | expansions are ignored, and | |
726f6388 JA |
2976 | any sequence of |
2977 | .SM | |
2978 | .B IFS | |
3185942a JA |
2979 | characters not at the beginning or end serves to delimit words. |
2980 | If | |
726f6388 JA |
2981 | .SM |
2982 | .B IFS | |
2983 | has a value other than the default, then sequences of | |
2984 | the whitespace characters | |
2985 | .B space | |
2986 | and | |
2987 | .B tab | |
2988 | are ignored at the beginning and end of the | |
2989 | word, as long as the whitespace character is in the | |
2990 | value of | |
2991 | .SM | |
2992 | .BR IFS | |
2993 | (an | |
2994 | .SM | |
2995 | .B IFS | |
2996 | whitespace character). | |
2997 | Any character in | |
2998 | .SM | |
2999 | .B IFS | |
3000 | that is not | |
3001 | .SM | |
3002 | .B IFS | |
3003 | whitespace, along with any adjacent | |
3004 | .SM | |
3005 | .B IFS | |
3006 | whitespace characters, delimits a field. | |
3007 | A sequence of | |
3008 | .SM | |
3009 | .B IFS | |
3010 | whitespace characters is also treated as a delimiter. | |
3011 | If the value of | |
3012 | .SM | |
3013 | .B IFS | |
3014 | is null, no word splitting occurs. | |
726f6388 | 3015 | .PP |
0628567a | 3016 | Explicit null arguments (\^\f3"\^"\fP or \^\f3\(aq\^\(aq\fP\^) are retained. |
ccc6cda3 | 3017 | Unquoted implicit null arguments, resulting from the expansion of |
bb70624e | 3018 | parameters that have no values, are removed. |
ccc6cda3 JA |
3019 | If a parameter with no value is expanded within double quotes, a |
3020 | null argument results and is retained. | |
726f6388 JA |
3021 | .PP |
3022 | Note that if no expansion occurs, no splitting | |
3023 | is performed. | |
3024 | .SS Pathname Expansion | |
3025 | .PP | |
3026 | After word splitting, | |
3027 | unless the | |
3028 | .B \-f | |
3029 | option has been set, | |
3030 | .B bash | |
ccc6cda3 | 3031 | scans each word for the characters |
726f6388 JA |
3032 | .BR * , |
3033 | .BR ? , | |
3034 | and | |
3035 | .BR [ . | |
3036 | If one of these characters appears, then the word is | |
3037 | regarded as a | |
3038 | .IR pattern , | |
3039 | and replaced with an alphabetically sorted list of | |
ccc6cda3 JA |
3040 | file names matching the pattern. |
3041 | If no matching file names are found, | |
3042 | and the shell option | |
3043 | .B nullglob | |
3185942a | 3044 | is not enabled, the word is left unchanged. |
cce855bc JA |
3045 | If the |
3046 | .B nullglob | |
3047 | option is set, and no matches are found, | |
726f6388 | 3048 | the word is removed. |
b80f6443 JA |
3049 | If the |
3050 | .B failglob | |
3051 | shell option is set, and no matches are found, an error message | |
3052 | is printed and the command is not executed. | |
cce855bc JA |
3053 | If the shell option |
3054 | .B nocaseglob | |
3055 | is enabled, the match is performed without regard to the case | |
3056 | of alphabetic characters. | |
ccc6cda3 | 3057 | When a pattern is used for pathname expansion, |
726f6388 JA |
3058 | the character |
3059 | .B ``.'' | |
3060 | at the start of a name or immediately following a slash | |
ccc6cda3 JA |
3061 | must be matched explicitly, unless the shell option |
3062 | .B dotglob | |
3063 | is set. | |
cce855bc JA |
3064 | When matching a pathname, the slash character must always be |
3065 | matched explicitly. | |
ccc6cda3 | 3066 | In other cases, the |
726f6388 JA |
3067 | .B ``.'' |
3068 | character is not treated specially. | |
ccc6cda3 JA |
3069 | See the description of |
3070 | .B shopt | |
3071 | below under | |
3072 | .SM | |
3073 | .B SHELL BUILTIN COMMANDS | |
3074 | for a description of the | |
cce855bc JA |
3075 | .BR nocaseglob , |
3076 | .BR nullglob , | |
b80f6443 | 3077 | .BR failglob , |
ccc6cda3 JA |
3078 | and |
3079 | .B dotglob | |
3080 | shell options. | |
3081 | .PP | |
3082 | The | |
3083 | .SM | |
3084 | .B GLOBIGNORE | |
3085 | shell variable may be used to restrict the set of file names matching a | |
3086 | .IR pattern . | |
3087 | If | |
3088 | .SM | |
3089 | .B GLOBIGNORE | |
3090 | is set, each matching file name that also matches one of the patterns in | |
3091 | .SM | |
3092 | .B GLOBIGNORE | |
3093 | is removed from the list of matches. | |
3094 | The file names | |
3095 | .B ``.'' | |
3096 | and | |
3097 | .B ``..'' | |
b80f6443 | 3098 | are always ignored when |
ccc6cda3 JA |
3099 | .SM |
3100 | .B GLOBIGNORE | |
b80f6443 | 3101 | is set and not null. However, setting |
ccc6cda3 JA |
3102 | .SM |
3103 | .B GLOBIGNORE | |
b80f6443 | 3104 | to a non-null value has the effect of enabling the |
ccc6cda3 JA |
3105 | .B dotglob |
3106 | shell option, so all other file names beginning with a | |
3107 | .B ``.'' | |
3108 | will match. | |
3109 | To get the old behavior of ignoring file names beginning with a | |
3110 | .BR ``.'' , | |
3111 | make | |
3112 | .B ``.*'' | |
3113 | one of the patterns in | |
3114 | .SM | |
3115 | .BR GLOBIGNORE . | |
3116 | The | |
3117 | .B dotglob | |
3118 | option is disabled when | |
3119 | .SM | |
3120 | .B GLOBIGNORE | |
3121 | is unset. | |
726f6388 | 3122 | .PP |
cce855bc JA |
3123 | \fBPattern Matching\fP |
3124 | .PP | |
3125 | Any character that appears in a pattern, other than the special pattern | |
3126 | characters described below, matches itself. The NUL character may not | |
b80f6443 JA |
3127 | occur in a pattern. A backslash escapes the following character; the |
3128 | escaping backslash is discarded when matching. | |
3129 | The special pattern characters must be quoted if | |
cce855bc JA |
3130 | they are to be matched literally. |
3131 | .PP | |
726f6388 JA |
3132 | The special pattern characters have the following meanings: |
3133 | .PP | |
3134 | .PD 0 | |
3135 | .TP | |
3136 | .B * | |
3137 | Matches any string, including the null string. | |
3185942a | 3138 | When the \fBglobstar\fP shell option is enabled, and \fB*\fP is used in |
0001803f | 3139 | a pathname expansion context, two adjacent \fB*\fPs used as a single |
3185942a JA |
3140 | pattern will match all files and zero or more directories and |
3141 | subdirectories. | |
3142 | If followed by a \fB/\fP, two adjacent \fB*\fPs will match only directories | |
3143 | and subdirectories. | |
726f6388 JA |
3144 | .TP |
3145 | .B ? | |
3146 | Matches any single character. | |
3147 | .TP | |
3148 | .B [...] | |
3149 | Matches any one of the enclosed characters. A pair of characters | |
28ef6c31 JA |
3150 | separated by a hyphen denotes a |
3151 | \fIrange expression\fP; | |
3152 | any character that sorts between those two characters, inclusive, | |
3153 | using the current locale's collating sequence and character set, | |
726f6388 JA |
3154 | is matched. If the first character following the |
3155 | .B [ | |
3156 | is a | |
3157 | .B ! | |
3158 | or a | |
3159 | .B ^ | |
ccc6cda3 | 3160 | then any character not enclosed is matched. |
28ef6c31 | 3161 | The sorting order of characters in range expressions is determined by |
0001803f CR |
3162 | the current locale and the value of the |
3163 | .SM | |
3164 | .B LC_COLLATE | |
3165 | shell variable, | |
28ef6c31 | 3166 | if set. |
ccc6cda3 | 3167 | A |
726f6388 | 3168 | .B \- |
726f6388 JA |
3169 | may be matched by including it as the first or last character |
3170 | in the set. | |
ccc6cda3 JA |
3171 | A |
3172 | .B ] | |
3173 | may be matched by including it as the first character | |
3174 | in the set. | |
cce855bc JA |
3175 | .br |
3176 | .if t .sp 0.5 | |
3177 | .if n .sp 1 | |
3178 | Within | |
3179 | .B [ | |
3180 | and | |
3181 | .BR ] , | |
3182 | \fIcharacter classes\fP can be specified using the syntax | |
3183 | \fB[:\fP\fIclass\fP\fB:]\fP, where \fIclass\fP is one of the | |
0628567a | 3184 | following classes defined in the POSIX standard: |
cce855bc JA |
3185 | .PP |
3186 | .RS | |
3187 | .B | |
7117c2d2 JA |
3188 | .if n alnum alpha ascii blank cntrl digit graph lower print punct space upper word xdigit |
3189 | .if t alnum alpha ascii blank cntrl digit graph lower print punct space upper word xdigit | |
cce855bc JA |
3190 | .br |
3191 | A character class matches any character belonging to that class. | |
7117c2d2 | 3192 | The \fBword\fP character class matches letters, digits, and the character _. |
cce855bc JA |
3193 | .br |
3194 | .if t .sp 0.5 | |
3195 | .if n .sp 1 | |
3196 | Within | |
3197 | .B [ | |
3198 | and | |
3199 | .BR ] , | |
3200 | an \fIequivalence class\fP can be specified using the syntax | |
3201 | \fB[=\fP\fIc\fP\fB=]\fP, which matches all characters with the | |
3202 | same collation weight (as defined by the current locale) as | |
3203 | the character \fIc\fP. | |
3204 | .br | |
3205 | .if t .sp 0.5 | |
3206 | .if n .sp 1 | |
3207 | Within | |
3208 | .B [ | |
3209 | and | |
3210 | .BR ] , | |
3211 | the syntax \fB[.\fP\fIsymbol\fP\fB.]\fP matches the collating symbol | |
3212 | \fIsymbol\fP. | |
3213 | .RE | |
3214 | .PD | |
3215 | .PP | |
3216 | If the \fBextglob\fP shell option is enabled using the \fBshopt\fP | |
3217 | builtin, several extended pattern matching operators are recognized. | |
bb70624e | 3218 | In the following description, a \fIpattern-list\fP is a list of one |
cce855bc JA |
3219 | or more patterns separated by a \fB|\fP. |
3220 | Composite patterns may be formed using one or more of the following | |
3221 | sub-patterns: | |
3222 | .sp 1 | |
3223 | .PD 0 | |
3224 | .RS | |
3225 | .TP | |
3226 | \fB?(\fP\^\fIpattern-list\^\fP\fB)\fP | |
3227 | Matches zero or one occurrence of the given patterns | |
3228 | .TP | |
3229 | \fB*(\fP\^\fIpattern-list\^\fP\fB)\fP | |
3230 | Matches zero or more occurrences of the given patterns | |
3231 | .TP | |
3232 | \fB+(\fP\^\fIpattern-list\^\fP\fB)\fP | |
3233 | Matches one or more occurrences of the given patterns | |
3234 | .TP | |
3235 | \fB@(\fP\^\fIpattern-list\^\fP\fB)\fP | |
95732b49 | 3236 | Matches one of the given patterns |
cce855bc JA |
3237 | .TP |
3238 | \fB!(\fP\^\fIpattern-list\^\fP\fB)\fP | |
3239 | Matches anything except one of the given patterns | |
3240 | .RE | |
726f6388 JA |
3241 | .PD |
3242 | .SS Quote Removal | |
3243 | .PP | |
3244 | After the preceding expansions, all unquoted occurrences of the | |
3245 | characters | |
3246 | .BR \e , | |
0628567a | 3247 | .BR \(aq , |
ccc6cda3 JA |
3248 | and \^\f3"\fP\^ that did not result from one of the above |
3249 | expansions are removed. | |
726f6388 JA |
3250 | .SH REDIRECTION |
3251 | Before a command is executed, its input and output | |
3252 | may be | |
3253 | .I redirected | |
3254 | using a special notation interpreted by the shell. | |
3255 | Redirection may also be used to open and close files for the | |
3256 | current shell execution environment. The following redirection | |
3257 | operators may precede or appear anywhere within a | |
3258 | .I simple command | |
3259 | or may follow a | |
3260 | .IR command . | |
3261 | Redirections are processed in the order they appear, from | |
3262 | left to right. | |
3263 | .PP | |
0001803f CR |
3264 | Each redirection that may be preceded by a file descriptor number |
3265 | may instead be preceded by a word of the form {\fIvarname\fP}. | |
3266 | In this case, for each redirection operator except | |
3267 | >&- and <&-, the shell will allocate a file descriptor greater | |
3268 | than 10 and assign it to \fIvarname\fP. If >&- or <&- is preceded | |
3269 | by {\fIvarname\fP}, the value of \fIvarname\fP defines the file | |
3270 | descriptor to close. | |
3271 | .PP | |
726f6388 JA |
3272 | In the following descriptions, if the file descriptor number is |
3273 | omitted, and the first character of the redirection operator is | |
3274 | .BR < , | |
3275 | the redirection refers to the standard input (file descriptor | |
3276 | 0). If the first character of the redirection operator is | |
3277 | .BR > , | |
3278 | the redirection refers to the standard output (file descriptor | |
3279 | 1). | |
3280 | .PP | |
cce855bc JA |
3281 | The word following the redirection operator in the following |
3282 | descriptions, unless otherwise noted, is subjected to brace expansion, | |
3283 | tilde expansion, parameter expansion, command substitution, arithmetic | |
bb70624e | 3284 | expansion, quote removal, pathname expansion, and word splitting. |
cce855bc | 3285 | If it expands to more than one word, |
726f6388 JA |
3286 | .B bash |
3287 | reports an error. | |
3288 | .PP | |
3289 | Note that the order of redirections is significant. For example, | |
3290 | the command | |
3291 | .RS | |
3292 | .PP | |
3293 | ls \fB>\fP dirlist 2\fB>&\fP1 | |
3294 | .RE | |
3295 | .PP | |
3296 | directs both standard output and standard error to the file | |
3297 | .IR dirlist , | |
3298 | while the command | |
3299 | .RS | |
3300 | .PP | |
3301 | ls 2\fB>&\fP1 \fB>\fP dirlist | |
3302 | .RE | |
3303 | .PP | |
3304 | directs only the standard output to file | |
3305 | .IR dirlist , | |
17345e5a | 3306 | because the standard error was duplicated from the standard output |
726f6388 JA |
3307 | before the standard output was redirected to |
3308 | .IR dirlist . | |
cce855bc | 3309 | .PP |
bb70624e JA |
3310 | \fBBash\fP handles several filenames specially when they are used in |
3311 | redirections, as described in the following table: | |
3312 | .RS | |
3313 | .PP | |
3314 | .PD 0 | |
3315 | .TP | |
3316 | .B /dev/fd/\fIfd\fP | |
3317 | If \fIfd\fP is a valid integer, file descriptor \fIfd\fP is duplicated. | |
3318 | .TP | |
3319 | .B /dev/stdin | |
3320 | File descriptor 0 is duplicated. | |
3321 | .TP | |
3322 | .B /dev/stdout | |
3323 | File descriptor 1 is duplicated. | |
3324 | .TP | |
3325 | .B /dev/stderr | |
3326 | File descriptor 2 is duplicated. | |
3327 | .TP | |
3328 | .B /dev/tcp/\fIhost\fP/\fIport\fP | |
3329 | If \fIhost\fP is a valid hostname or Internet address, and \fIport\fP | |
f73dda09 JA |
3330 | is an integer port number or service name, \fBbash\fP attempts to open |
3331 | a TCP connection to the corresponding socket. | |
bb70624e JA |
3332 | .TP |
3333 | .B /dev/udp/\fIhost\fP/\fIport\fP | |
3334 | If \fIhost\fP is a valid hostname or Internet address, and \fIport\fP | |
f73dda09 JA |
3335 | is an integer port number or service name, \fBbash\fP attempts to open |
3336 | a UDP connection to the corresponding socket. | |
bb70624e JA |
3337 | .PD |
3338 | .RE | |
3339 | .PP | |
cce855bc | 3340 | A failure to open or create a file causes the redirection to fail. |
95732b49 JA |
3341 | .PP |
3342 | Redirections using file descriptors greater than 9 should be used with | |
3343 | care, as they may conflict with file descriptors the shell uses | |
3344 | internally. | |
726f6388 JA |
3345 | .SS Redirecting Input |
3346 | .PP | |
3347 | Redirection of input causes the file whose name results from | |
3348 | the expansion of | |
3349 | .I word | |
3350 | to be opened for reading on file descriptor | |
3351 | .IR n , | |
3352 | or the standard input (file descriptor 0) if | |
3353 | .I n | |
3354 | is not specified. | |
3355 | .PP | |
3356 | The general format for redirecting input is: | |
3357 | .RS | |
3358 | .PP | |
3359 | [\fIn\fP]\fB<\fP\fIword\fP | |
3360 | .RE | |
3361 | .SS Redirecting Output | |
3362 | .PP | |
3363 | Redirection of output causes the file whose name results from | |
3364 | the expansion of | |
3365 | .I word | |
3366 | to be opened for writing on file descriptor | |
3367 | .IR n , | |
3368 | or the standard output (file descriptor 1) if | |
3369 | .I n | |
3370 | is not specified. If the file does not exist it is created; | |
3371 | if it does exist it is truncated to zero size. | |
3372 | .PP | |
3373 | The general format for redirecting output is: | |
3374 | .RS | |
3375 | .PP | |
3376 | [\fIn\fP]\fB>\fP\fIword\fP | |
3377 | .RE | |
3378 | .PP | |
3379 | If the redirection operator is | |
ccc6cda3 JA |
3380 | .BR > , |
3381 | and the | |
cce855bc | 3382 | .B noclobber |
ccc6cda3 JA |
3383 | option to the |
3384 | .B set | |
bb70624e | 3385 | builtin has been enabled, the redirection will fail if the file |
cce855bc JA |
3386 | whose name results from the expansion of \fIword\fP exists and is |
3387 | a regular file. | |
ccc6cda3 | 3388 | If the redirection operator is |
726f6388 | 3389 | .BR >| , |
cce855bc JA |
3390 | or the redirection operator is |
3391 | .B > | |
3392 | and the | |
3393 | .B noclobber | |
726f6388 JA |
3394 | option to the |
3395 | .B set | |
cce855bc | 3396 | builtin command is not enabled, the redirection is attempted even |
ccc6cda3 | 3397 | if the file named by \fIword\fP exists. |
726f6388 JA |
3398 | .SS Appending Redirected Output |
3399 | .PP | |
3400 | Redirection of output in this fashion | |
3401 | causes the file whose name results from | |
3402 | the expansion of | |
3403 | .I word | |
3404 | to be opened for appending on file descriptor | |
3405 | .IR n , | |
3406 | or the standard output (file descriptor 1) if | |
3407 | .I n | |
3408 | is not specified. If the file does not exist it is created. | |
3409 | .PP | |
3410 | The general format for appending output is: | |
3411 | .RS | |
3412 | .PP | |
3413 | [\fIn\fP]\fB>>\fP\fIword\fP | |
3414 | .RE | |
3415 | .PP | |
3416 | .SS Redirecting Standard Output and Standard Error | |
3417 | .PP | |
3185942a | 3418 | This construct allows both the |
726f6388 JA |
3419 | standard output (file descriptor 1) and |
3420 | the standard error output (file descriptor 2) | |
3421 | to be redirected to the file whose name is the | |
3422 | expansion of | |
3185942a | 3423 | .IR word . |
726f6388 JA |
3424 | .PP |
3425 | There are two formats for redirecting standard output and | |
3426 | standard error: | |
3427 | .RS | |
3428 | .PP | |
3429 | \fB&>\fP\fIword\fP | |
3430 | .RE | |
3431 | and | |
3432 | .RS | |
3433 | \fB>&\fP\fIword\fP | |
3434 | .RE | |
3435 | .PP | |
3436 | Of the two forms, the first is preferred. | |
3437 | This is semantically equivalent to | |
3438 | .RS | |
3439 | .PP | |
3440 | \fB>\fP\fIword\fP 2\fB>&\fP1 | |
3441 | .RE | |
3185942a JA |
3442 | .PP |
3443 | .SS Appending Standard Output and Standard Error | |
3444 | .PP | |
3445 | This construct allows both the | |
3446 | standard output (file descriptor 1) and | |
3447 | the standard error output (file descriptor 2) | |
3448 | to be appended to the file whose name is the | |
3449 | expansion of | |
3450 | .IR word . | |
3451 | .PP | |
3452 | The format for appending standard output and standard error is: | |
3453 | .RS | |
3454 | .PP | |
3455 | \fB&>>\fP\fIword\fP | |
3456 | .RE | |
3457 | .PP | |
3458 | This is semantically equivalent to | |
3459 | .RS | |
3460 | .PP | |
3461 | \fB>>\fP\fIword\fP 2\fB>&\fP1 | |
3462 | .RE | |
726f6388 JA |
3463 | .SS Here Documents |
3464 | .PP | |
3465 | This type of redirection instructs the shell to read input from the | |
3466 | current source until a line containing only | |
3185942a | 3467 | .I delimiter |
726f6388 JA |
3468 | (with no trailing blanks) |
3469 | is seen. All of | |
3470 | the lines read up to that point are then used as the standard | |
3471 | input for a command. | |
3472 | .PP | |
7117c2d2 | 3473 | The format of here-documents is: |
726f6388 JA |
3474 | .RS |
3475 | .PP | |
3476 | .nf | |
3477 | \fB<<\fP[\fB\-\fP]\fIword\fP | |
f73dda09 | 3478 | \fIhere-document\fP |
726f6388 JA |
3479 | \fIdelimiter\fP |
3480 | .fi | |
3481 | .RE | |
3482 | .PP | |
bb70624e JA |
3483 | No parameter expansion, command substitution, arithmetic expansion, |
3484 | or pathname expansion is performed on | |
726f6388 JA |
3485 | .IR word . |
3486 | If any characters in | |
3487 | .I word | |
3488 | are quoted, the | |
3489 | .I delimiter | |
3490 | is the result of quote removal on | |
3491 | .IR word , | |
cce855bc JA |
3492 | and the lines in the here-document are not expanded. |
3493 | If \fIword\fP is unquoted, | |
726f6388 JA |
3494 | all lines of the here-document are subjected to parameter expansion, |
3495 | command substitution, and arithmetic expansion. In the latter | |
bb70624e | 3496 | case, the character sequence |
726f6388 JA |
3497 | .B \e<newline> |
3498 | is ignored, and | |
3499 | .B \e | |
3500 | must be used to quote the characters | |
3501 | .BR \e , | |
3502 | .BR $ , | |
3503 | and | |
3185942a | 3504 | .BR \` . |
726f6388 JA |
3505 | .PP |
3506 | If the redirection operator is | |
3507 | .BR <<\- , | |
3508 | then all leading tab characters are stripped from input lines and the | |
3509 | line containing | |
3510 | .IR delimiter . | |
3511 | This allows | |
3512 | here-documents within shell scripts to be indented in a | |
3513 | natural fashion. | |
7117c2d2 JA |
3514 | .SS "Here Strings" |
3515 | A variant of here documents, the format is: | |
3516 | .RS | |
3517 | .PP | |
3518 | .nf | |
3519 | \fB<<<\fP\fIword\fP | |
3520 | .fi | |
3521 | .RE | |
3522 | .PP | |
3523 | The \fIword\fP is expanded and supplied to the command on its standard | |
3524 | input. | |
726f6388 JA |
3525 | .SS "Duplicating File Descriptors" |
3526 | .PP | |
3527 | The redirection operator | |
3528 | .RS | |
3529 | .PP | |
3530 | [\fIn\fP]\fB<&\fP\fIword\fP | |
3531 | .RE | |
3532 | .PP | |
3533 | is used to duplicate input file descriptors. | |
3534 | If | |
3535 | .I word | |
3536 | expands to one or more digits, the file descriptor denoted by | |
3537 | .I n | |
cce855bc JA |
3538 | is made to be a copy of that file descriptor. |
3539 | If the digits in | |
3540 | .I word | |
3541 | do not specify a file descriptor open for input, a redirection error occurs. | |
3542 | If | |
726f6388 JA |
3543 | .I word |
3544 | evaluates to | |
3545 | .BR \- , | |
3546 | file descriptor | |
3547 | .I n | |
3548 | is closed. If | |
3549 | .I n | |
3550 | is not specified, the standard input (file descriptor 0) is used. | |
3551 | .PP | |
3552 | The operator | |
3553 | .RS | |
3554 | .PP | |
3555 | [\fIn\fP]\fB>&\fP\fIword\fP | |
3556 | .RE | |
3557 | .PP | |
3558 | is used similarly to duplicate output file descriptors. If | |
3559 | .I n | |
3560 | is not specified, the standard output (file descriptor 1) is used. | |
cce855bc JA |
3561 | If the digits in |
3562 | .I word | |
3563 | do not specify a file descriptor open for output, a redirection error occurs. | |
726f6388 JA |
3564 | As a special case, if \fIn\fP is omitted, and \fIword\fP does not |
3565 | expand to one or more digits, the standard output and standard | |
3566 | error are redirected as described previously. | |
7117c2d2 JA |
3567 | .SS "Moving File Descriptors" |
3568 | .PP | |
3569 | The redirection operator | |
3570 | .RS | |
3571 | .PP | |
3572 | [\fIn\fP]\fB<&\fP\fIdigit\fP\fB\-\fP | |
3573 | .RE | |
3574 | .PP | |
3575 | moves the file descriptor \fIdigit\fP to file descriptor | |
3576 | .IR n , | |
3577 | or the standard input (file descriptor 0) if \fIn\fP is not specified. | |
3578 | \fIdigit\fP is closed after being duplicated to \fIn\fP. | |
3579 | .PP | |
3580 | Similarly, the redirection operator | |
3581 | .RS | |
3582 | .PP | |
3583 | [\fIn\fP]\fB>&\fP\fIdigit\fP\fB\-\fP | |
3584 | .RE | |
3585 | .PP | |
3586 | moves the file descriptor \fIdigit\fP to file descriptor | |
3587 | .IR n , | |
3588 | or the standard output (file descriptor 1) if \fIn\fP is not specified. | |
726f6388 JA |
3589 | .SS "Opening File Descriptors for Reading and Writing" |
3590 | .PP | |
3591 | The redirection operator | |
3592 | .RS | |
3593 | .PP | |
3594 | [\fIn\fP]\fB<>\fP\fIword\fP | |
3595 | .RE | |
3596 | .PP | |
3597 | causes the file whose name is the expansion of | |
3598 | .I word | |
3599 | to be opened for both reading and writing on file descriptor | |
3600 | .IR n , | |
ccc6cda3 | 3601 | or on file descriptor 0 if |
726f6388 JA |
3602 | .I n |
3603 | is not specified. If the file does not exist, it is created. | |
726f6388 | 3604 | .SH ALIASES |
bb70624e | 3605 | \fIAliases\fP allow a string to be substituted for a word when it is used |
cce855bc | 3606 | as the first word of a simple command. |
bb70624e | 3607 | The shell maintains a list of aliases that may be set and unset with the |
726f6388 JA |
3608 | .B alias |
3609 | and | |
3610 | .B unalias | |
3611 | builtin commands (see | |
3612 | .SM | |
3613 | .B SHELL BUILTIN COMMANDS | |
3614 | below). | |
b80f6443 | 3615 | The first word of each simple command, if unquoted, |
726f6388 JA |
3616 | is checked to see if it has an |
3617 | alias. If so, that word is replaced by the text of the alias. | |
3185942a | 3618 | The characters \fB/\fP, \fB$\fP, \fB\`\fP, and \fB=\fP and |
b80f6443 JA |
3619 | any of the shell \fImetacharacters\fP or quoting characters |
3620 | listed above may not appear in an alias name. | |
3621 | The replacement text may contain any valid shell input, | |
3622 | including shell metacharacters. | |
3623 | The first word of the replacement text is tested | |
726f6388 | 3624 | for aliases, but a word that is identical to an alias being expanded |
b80f6443 JA |
3625 | is not expanded a second time. |
3626 | This means that one may alias | |
726f6388 JA |
3627 | .B ls |
3628 | to | |
3629 | .BR "ls \-F" , | |
3630 | for instance, and | |
3631 | .B bash | |
3632 | does not try to recursively expand the replacement text. | |
3633 | If the last character of the alias value is a | |
3634 | .IR blank , | |
3635 | then the next command | |
3636 | word following the alias is also checked for alias expansion. | |
3637 | .PP | |
3638 | Aliases are created and listed with the | |
3639 | .B alias | |
3640 | command, and removed with the | |
3641 | .B unalias | |
3642 | command. | |
3643 | .PP | |
ccc6cda3 | 3644 | There is no mechanism for using arguments in the replacement text. |
bb70624e JA |
3645 | If arguments are needed, a shell function should be used (see |
3646 | .SM | |
3647 | .B FUNCTIONS | |
3648 | below). | |
726f6388 | 3649 | .PP |
ccc6cda3 JA |
3650 | Aliases are not expanded when the shell is not interactive, unless |
3651 | the | |
3652 | .B expand_aliases | |
3653 | shell option is set using | |
3654 | .B shopt | |
3655 | (see the description of | |
3656 | .B shopt | |
3657 | under | |
3658 | .SM | |
3659 | \fBSHELL BUILTIN COMMANDS\fP | |
3660 | below). | |
726f6388 JA |
3661 | .PP |
3662 | The rules concerning the definition and use of aliases are | |
3663 | somewhat confusing. | |
3664 | .B Bash | |
3665 | always reads at least one complete line | |
3666 | of input before executing any | |
3667 | of the commands on that line. Aliases are expanded when a | |
3668 | command is read, not when it is executed. Therefore, an | |
3669 | alias definition appearing on the same line as another | |
3670 | command does not take effect until the next line of input is read. | |
ccc6cda3 | 3671 | The commands following the alias definition |
726f6388 JA |
3672 | on that line are not affected by the new alias. |
3673 | This behavior is also an issue when functions are executed. | |
cce855bc | 3674 | Aliases are expanded when a function definition is read, |
726f6388 JA |
3675 | not when the function is executed, because a function definition |
3676 | is itself a compound command. As a consequence, aliases | |
3677 | defined in a function are not available until after that | |
3678 | function is executed. To be safe, always put | |
3679 | alias definitions on a separate line, and do not use | |
3680 | .B alias | |
3681 | in compound commands. | |
3682 | .PP | |
cce855bc | 3683 | For almost every purpose, aliases are superseded by |
726f6388 | 3684 | shell functions. |
ccc6cda3 JA |
3685 | .SH FUNCTIONS |
3686 | A shell function, defined as described above under | |
3687 | .SM | |
3688 | .BR "SHELL GRAMMAR" , | |
3689 | stores a series of commands for later execution. | |
bb70624e JA |
3690 | When the name of a shell function is used as a simple command name, |
3691 | the list of commands associated with that function name is executed. | |
ccc6cda3 JA |
3692 | Functions are executed in the context of the |
3693 | current shell; no new process is created to interpret | |
3694 | them (contrast this with the execution of a shell script). | |
3695 | When a function is executed, the arguments to the | |
3696 | function become the positional parameters | |
bb70624e JA |
3697 | during its execution. |
3698 | The special parameter | |
ccc6cda3 | 3699 | .B # |
b80f6443 | 3700 | is updated to reflect the change. Special parameter 0 |
bb70624e | 3701 | is unchanged. |
b80f6443 | 3702 | The first element of the |
bb70624e JA |
3703 | .SM |
3704 | .B FUNCNAME | |
3705 | variable is set to the name of the function while the function | |
3706 | is executing. | |
0001803f | 3707 | .PP |
bb70624e | 3708 | All other aspects of the shell execution |
ccc6cda3 | 3709 | environment are identical between a function and its caller |
0001803f | 3710 | with these exceptions: the |
ccc6cda3 JA |
3711 | .SM |
3712 | .B DEBUG | |
95732b49 JA |
3713 | and |
3714 | .B RETURN | |
3715 | traps (see the description of the | |
ccc6cda3 JA |
3716 | .B trap |
3717 | builtin under | |
3718 | .SM | |
3719 | .B SHELL BUILTIN COMMANDS | |
95732b49 | 3720 | below) are not inherited unless the function has been given the |
7117c2d2 JA |
3721 | \fBtrace\fP attribute (see the description of the |
3722 | .SM | |
3723 | .B declare | |
b80f6443 JA |
3724 | builtin below) or the |
3725 | \fB\-o functrace\fP shell option has been enabled with | |
3726 | the \fBset\fP builtin | |
0001803f CR |
3727 | (in which case all functions inherit the \fBDEBUG\fP and \fBRETURN\fP traps), |
3728 | and the | |
3729 | .SM | |
3730 | .B ERR | |
3731 | trap is not inherited unless the \fB\-o errtrace\fP shell option has | |
3732 | been enabled. | |
726f6388 | 3733 | .PP |
ccc6cda3 JA |
3734 | Variables local to the function may be declared with the |
3735 | .B local | |
3736 | builtin command. Ordinarily, variables and their values | |
3737 | are shared between the function and its caller. | |
726f6388 | 3738 | .PP |
ccc6cda3 JA |
3739 | If the builtin command |
3740 | .B return | |
3741 | is executed in a function, the function completes and | |
3742 | execution resumes with the next command after the function | |
b80f6443 JA |
3743 | call. |
3744 | Any command associated with the \fBRETURN\fP trap is executed | |
3745 | before execution resumes. | |
3746 | When a function completes, the values of the | |
ccc6cda3 JA |
3747 | positional parameters and the special parameter |
3748 | .B # | |
cce855bc | 3749 | are restored to the values they had prior to the function's |
ccc6cda3 | 3750 | execution. |
726f6388 | 3751 | .PP |
ccc6cda3 JA |
3752 | Function names and definitions may be listed with the |
3753 | .B \-f | |
726f6388 | 3754 | option to the |
ccc6cda3 JA |
3755 | .B declare |
3756 | or | |
3757 | .B typeset | |
3758 | builtin commands. The | |
3759 | .B \-F | |
3760 | option to | |
3761 | .B declare | |
3762 | or | |
3763 | .B typeset | |
b80f6443 JA |
3764 | will list the function names only |
3765 | (and optionally the source file and line number, if the \fBextdebug\fP | |
3766 | shell option is enabled). | |
ccc6cda3 JA |
3767 | Functions may be exported so that subshells |
3768 | automatically have them defined with the | |
3769 | .B \-f | |
3770 | option to the | |
3771 | .B export | |
3772 | builtin. | |
0628567a JA |
3773 | A function definition may be deleted using the \fB\-f\fP option to |
3774 | the | |
3775 | .B unset | |
3776 | builtin. | |
b80f6443 JA |
3777 | Note that shell functions and variables with the same name may result |
3778 | in multiple identically-named entries in the environment passed to the | |
3779 | shell's children. | |
3780 | Care should be taken in cases where this may cause a problem. | |
726f6388 | 3781 | .PP |
ccc6cda3 JA |
3782 | Functions may be recursive. No limit is imposed on the number |
3783 | of recursive calls. | |
cce855bc JA |
3784 | .SH "ARITHMETIC EVALUATION" |
3785 | The shell allows arithmetic expressions to be evaluated, under | |
b80f6443 JA |
3786 | certain circumstances (see the \fBlet\fP and \fBdeclare\fP builtin |
3787 | commands and \fBArithmetic Expansion\fP). | |
7117c2d2 | 3788 | Evaluation is done in fixed-width integers with no check for overflow, |
cce855bc | 3789 | though division by 0 is trapped and flagged as an error. |
b80f6443 JA |
3790 | The operators and their precedence, associativity, and values |
3791 | are the same as in the C language. | |
cce855bc JA |
3792 | The following list of operators is grouped into levels of |
3793 | equal-precedence operators. | |
3794 | The levels are listed in order of decreasing precedence. | |
726f6388 | 3795 | .PP |
cce855bc JA |
3796 | .PD 0 |
3797 | .TP | |
bb70624e JA |
3798 | .B \fIid\fP++ \fIid\fP\-\- |
3799 | variable post-increment and post-decrement | |
3800 | .TP | |
3801 | .B ++\fIid\fP \-\-\fIid\fP | |
3802 | variable pre-increment and pre-decrement | |
3803 | .TP | |
cce855bc JA |
3804 | .B \- + |
3805 | unary minus and plus | |
3806 | .TP | |
3807 | .B ! ~ | |
3808 | logical and bitwise negation | |
3809 | .TP | |
3810 | .B ** | |
3811 | exponentiation | |
3812 | .TP | |
3813 | .B * / % | |
3814 | multiplication, division, remainder | |
3815 | .TP | |
3816 | .B + \- | |
3817 | addition, subtraction | |
3818 | .TP | |
3819 | .B << >> | |
3820 | left and right bitwise shifts | |
3821 | .TP | |
3822 | .B <= >= < > | |
3823 | comparison | |
3824 | .TP | |
3825 | .B == != | |
3826 | equality and inequality | |
3827 | .TP | |
3828 | .B & | |
3829 | bitwise AND | |
3830 | .TP | |
3831 | .B ^ | |
3832 | bitwise exclusive OR | |
3833 | .TP | |
3834 | .B | | |
3835 | bitwise OR | |
3836 | .TP | |
3837 | .B && | |
3838 | logical AND | |
3839 | .TP | |
3840 | .B || | |
3841 | logical OR | |
3842 | .TP | |
3843 | .B \fIexpr\fP?\fIexpr\fP:\fIexpr\fP | |
b80f6443 | 3844 | conditional operator |
cce855bc JA |
3845 | .TP |
3846 | .B = *= /= %= += \-= <<= >>= &= ^= |= | |
3847 | assignment | |
bb70624e JA |
3848 | .TP |
3849 | .B \fIexpr1\fP , \fIexpr2\fP | |
3850 | comma | |
cce855bc | 3851 | .PD |
ccc6cda3 | 3852 | .PP |
cce855bc | 3853 | Shell variables are allowed as operands; parameter expansion is |
bb70624e JA |
3854 | performed before the expression is evaluated. |
3855 | Within an expression, shell variables may also be referenced by name | |
3856 | without using the parameter expansion syntax. | |
b80f6443 JA |
3857 | A shell variable that is null or unset evaluates to 0 when referenced |
3858 | by name without using the parameter expansion syntax. | |
bb70624e | 3859 | The value of a variable is evaluated as an arithmetic expression |
b80f6443 JA |
3860 | when it is referenced, or when a variable which has been given the |
3861 | \fIinteger\fP attribute using \fBdeclare -i\fP is assigned a value. | |
3862 | A null value evaluates to 0. | |
bb70624e | 3863 | A shell variable need not have its integer attribute |
cce855bc | 3864 | turned on to be used in an expression. |
ccc6cda3 | 3865 | .PP |
cce855bc JA |
3866 | Constants with a leading 0 are interpreted as octal numbers. |
3867 | A leading 0x or 0X denotes hexadecimal. | |
3868 | Otherwise, numbers take the form [\fIbase#\fP]n, where \fIbase\fP | |
3869 | is a decimal number between 2 and 64 representing the arithmetic | |
3870 | base, and \fIn\fP is a number in that base. | |
bb70624e | 3871 | If \fIbase#\fP is omitted, then base 10 is used. |
cce855bc | 3872 | The digits greater than 9 are represented by the lowercase letters, |
f73dda09 | 3873 | the uppercase letters, @, and _, in that order. |
cce855bc | 3874 | If \fIbase\fP is less than or equal to 36, lowercase and uppercase |
95732b49 | 3875 | letters may be used interchangeably to represent numbers between 10 |
cce855bc | 3876 | and 35. |
ccc6cda3 | 3877 | .PP |
cce855bc JA |
3878 | Operators are evaluated in order of precedence. Sub-expressions in |
3879 | parentheses are evaluated first and may override the precedence | |
3880 | rules above. | |
3881 | .SH "CONDITIONAL EXPRESSIONS" | |
3882 | Conditional expressions are used by the \fB[[\fP compound command and | |
3883 | the \fBtest\fP and \fB[\fP builtin commands to test file attributes | |
3884 | and perform string and arithmetic comparisons. | |
3885 | Expressions are formed from the following unary or binary primaries. | |
3886 | If any \fIfile\fP argument to one of the primaries is of the form | |
bb70624e JA |
3887 | \fI/dev/fd/n\fP, then file descriptor \fIn\fP is checked. |
3888 | If the \fIfile\fP argument to one of the primaries is one of | |
3889 | \fI/dev/stdin\fP, \fI/dev/stdout\fP, or \fI/dev/stderr\fP, file | |
3890 | descriptor 0, 1, or 2, respectively, is checked. | |
95732b49 JA |
3891 | .PP |
3892 | Unless otherwise specified, primaries that operate on files follow symbolic | |
3893 | links and operate on the target of the link, rather than the link itself. | |
0001803f CR |
3894 | .if t .sp 0.5 |
3895 | .if n .sp 1 | |
3896 | When used with \fB[[\fP, The \fB<\fP and \fB>\fP operators sort | |
3897 | lexicographically using the current locale. | |
cce855bc JA |
3898 | .sp 1 |
3899 | .PD 0 | |
3900 | .TP | |
3901 | .B \-a \fIfile\fP | |
3902 | True if \fIfile\fP exists. | |
3903 | .TP | |
3904 | .B \-b \fIfile\fP | |
3905 | True if \fIfile\fP exists and is a block special file. | |
3906 | .TP | |
3907 | .B \-c \fIfile\fP | |
3908 | True if \fIfile\fP exists and is a character special file. | |
3909 | .TP | |
3910 | .B \-d \fIfile\fP | |
3911 | True if \fIfile\fP exists and is a directory. | |
3912 | .TP | |
3913 | .B \-e \fIfile\fP | |
3914 | True if \fIfile\fP exists. | |
3915 | .TP | |
3916 | .B \-f \fIfile\fP | |
3917 | True if \fIfile\fP exists and is a regular file. | |
3918 | .TP | |
3919 | .B \-g \fIfile\fP | |
3920 | True if \fIfile\fP exists and is set-group-id. | |
3921 | .TP | |
b72432fd JA |
3922 | .B \-h \fIfile\fP |
3923 | True if \fIfile\fP exists and is a symbolic link. | |
3924 | .TP | |
cce855bc JA |
3925 | .B \-k \fIfile\fP |
3926 | True if \fIfile\fP exists and its ``sticky'' bit is set. | |
3927 | .TP | |
3928 | .B \-p \fIfile\fP | |
3929 | True if \fIfile\fP exists and is a named pipe (FIFO). | |
3930 | .TP | |
3931 | .B \-r \fIfile\fP | |
3932 | True if \fIfile\fP exists and is readable. | |
3933 | .TP | |
3934 | .B \-s \fIfile\fP | |
3935 | True if \fIfile\fP exists and has a size greater than zero. | |
3936 | .TP | |
3937 | .B \-t \fIfd\fP | |
3938 | True if file descriptor | |
3939 | .I fd | |
3940 | is open and refers to a terminal. | |
3941 | .TP | |
3942 | .B \-u \fIfile\fP | |
3943 | True if \fIfile\fP exists and its set-user-id bit is set. | |
3944 | .TP | |
3945 | .B \-w \fIfile\fP | |
3946 | True if \fIfile\fP exists and is writable. | |
3947 | .TP | |
3948 | .B \-x \fIfile\fP | |
3949 | True if \fIfile\fP exists and is executable. | |
3950 | .TP | |
3951 | .B \-O \fIfile\fP | |
3952 | True if \fIfile\fP exists and is owned by the effective user id. | |
3953 | .TP | |
3954 | .B \-G \fIfile\fP | |
3955 | True if \fIfile\fP exists and is owned by the effective group id. | |
3956 | .TP | |
3957 | .B \-L \fIfile\fP | |
3958 | True if \fIfile\fP exists and is a symbolic link. | |
3959 | .TP | |
3960 | .B \-S \fIfile\fP | |
3961 | True if \fIfile\fP exists and is a socket. | |
3962 | .TP | |
3963 | .B \-N \fIfile\fP | |
3964 | True if \fIfile\fP exists and has been modified since it was last read. | |
3965 | .TP | |
3966 | \fIfile1\fP \-\fBnt\fP \fIfile2\fP | |
7117c2d2 JA |
3967 | True if \fIfile1\fP is newer (according to modification date) than \fIfile2\fP, |
3968 | or if \fIfile1\fP exists and \fPfile2\fP does not. | |
cce855bc JA |
3969 | .TP |
3970 | \fIfile1\fP \-\fBot\fP \fIfile2\fP | |
7117c2d2 JA |
3971 | True if \fIfile1\fP is older than \fIfile2\fP, or if \fIfile2\fP exists |
3972 | and \fIfile1\fP does not. | |
cce855bc JA |
3973 | .TP |
3974 | \fIfile1\fP \fB\-ef\fP \fIfile2\fP | |
7117c2d2 | 3975 | True if \fIfile1\fP and \fIfile2\fP refer to the same device and |
cce855bc JA |
3976 | inode numbers. |
3977 | .TP | |
3978 | .B \-o \fIoptname\fP | |
3979 | True if shell option | |
3980 | .I optname | |
3981 | is enabled. | |
3982 | See the list of options under the description of the | |
3983 | .B \-o | |
3984 | option to the | |
3985 | .B set | |
3986 | builtin below. | |
3987 | .TP | |
3988 | .B \-z \fIstring\fP | |
3989 | True if the length of \fIstring\fP is zero. | |
3990 | .TP | |
cce855bc | 3991 | \fIstring\fP |
b80f6443 JA |
3992 | .PD 0 |
3993 | .TP | |
3994 | .B \-n \fIstring\fP | |
3995 | .PD | |
cce855bc JA |
3996 | True if the length of |
3997 | .I string | |
3998 | is non-zero. | |
3999 | .TP | |
4000 | \fIstring1\fP \fB==\fP \fIstring2\fP | |
0001803f CR |
4001 | .PD 0 |
4002 | .TP | |
4003 | \fIstring1\fP \fB=\fP \fIstring2\fP | |
4004 | .PD | |
4005 | True if the strings are equal. \fB=\fP should be used | |
4006 | with the \fBtest\fP command for POSIX conformance. | |
cce855bc JA |
4007 | .TP |
4008 | \fIstring1\fP \fB!=\fP \fIstring2\fP | |
4009 | True if the strings are not equal. | |
4010 | .TP | |
4011 | \fIstring1\fP \fB<\fP \fIstring2\fP | |
0001803f | 4012 | True if \fIstring1\fP sorts before \fIstring2\fP lexicographically. |
cce855bc JA |
4013 | .TP |
4014 | \fIstring1\fP \fB>\fP \fIstring2\fP | |
0001803f | 4015 | True if \fIstring1\fP sorts after \fIstring2\fP lexicographically. |
cce855bc JA |
4016 | .TP |
4017 | .I \fIarg1\fP \fBOP\fP \fIarg2\fP | |
4018 | .SM | |
4019 | .B OP | |
4020 | is one of | |
4021 | .BR \-eq , | |
4022 | .BR \-ne , | |
4023 | .BR \-lt , | |
4024 | .BR \-le , | |
4025 | .BR \-gt , | |
4026 | or | |
4027 | .BR \-ge . | |
4028 | These arithmetic binary operators return true if \fIarg1\fP | |
4029 | is equal to, not equal to, less than, less than or equal to, | |
4030 | greater than, or greater than or equal to \fIarg2\fP, respectively. | |
4031 | .I Arg1 | |
4032 | and | |
4033 | .I arg2 | |
4034 | may be positive or negative integers. | |
4035 | .PD | |
4036 | .SH "SIMPLE COMMAND EXPANSION" | |
4037 | When a simple command is executed, the shell performs the following | |
4038 | expansions, assignments, and redirections, from left to right. | |
4039 | .IP 1. | |
4040 | The words that the parser has marked as variable assignments (those | |
4041 | preceding the command name) and redirections are saved for later | |
4042 | processing. | |
4043 | .IP 2. | |
4044 | The words that are not variable assignments or redirections are | |
4045 | expanded. If any words remain after expansion, the first word | |
4046 | is taken to be the name of the command and the remaining words are | |
4047 | the arguments. | |
4048 | .IP 3. | |
4049 | Redirections are performed as described above under | |
4050 | .SM | |
4051 | .BR REDIRECTION . | |
4052 | .IP 4. | |
4053 | The text after the \fB=\fP in each variable assignment undergoes tilde | |
4054 | expansion, parameter expansion, command substitution, arithmetic expansion, | |
4055 | and quote removal before being assigned to the variable. | |
4056 | .PP | |
4057 | If no command name results, the variable assignments affect the current | |
4058 | shell environment. Otherwise, the variables are added to the environment | |
4059 | of the executed command and do not affect the current shell environment. | |
4060 | If any of the assignments attempts to assign a value to a readonly variable, | |
4061 | an error occurs, and the command exits with a non-zero status. | |
4062 | .PP | |
4063 | If no command name results, redirections are performed, but do not | |
4064 | affect the current shell environment. A redirection error causes the | |
4065 | command to exit with a non-zero status. | |
4066 | .PP | |
4067 | If there is a command name left after expansion, execution proceeds as | |
4068 | described below. Otherwise, the command exits. If one of the expansions | |
4069 | contained a command substitution, the exit status of the command is | |
4070 | the exit status of the last command substitution performed. If there | |
4071 | were no command substitutions, the command exits with a status of zero. | |
4072 | .SH "COMMAND EXECUTION" | |
4073 | After a command has been split into words, if it results in a | |
4074 | simple command and an optional list of arguments, the following | |
4075 | actions are taken. | |
4076 | .PP | |
4077 | If the command name contains no slashes, the shell attempts to | |
4078 | locate it. If there exists a shell function by that name, that | |
4079 | function is invoked as described above in | |
4080 | .SM | |
4081 | .BR FUNCTIONS . | |
4082 | If the name does not match a function, the shell searches for | |
4083 | it in the list of shell builtins. If a match is found, that | |
4084 | builtin is invoked. | |
4085 | .PP | |
4086 | If the name is neither a shell function nor a builtin, | |
4087 | and contains no slashes, | |
4088 | .B bash | |
4089 | searches each element of the | |
4090 | .SM | |
4091 | .B PATH | |
4092 | for a directory containing an executable file by that name. | |
4093 | .B Bash | |
bb70624e | 4094 | uses a hash table to remember the full pathnames of executable |
cce855bc JA |
4095 | files (see |
4096 | .B hash | |
4097 | under | |
4098 | .SM | |
4099 | .B "SHELL BUILTIN COMMANDS" | |
4100 | below). | |
4101 | A full search of the directories in | |
4102 | .SM | |
4103 | .B PATH | |
4104 | is performed only if the command is not found in the hash table. | |
3185942a JA |
4105 | If the search is unsuccessful, the shell searches for a defined shell |
4106 | function named \fBcommand_not_found_handle\fP. | |
4107 | If that function exists, it is invoked with the original command and | |
4108 | the original command's arguments as its arguments, and the function's | |
4109 | exit status becomes the exit status of the shell. | |
4110 | If that function is not defined, the shell prints an error | |
cce855bc JA |
4111 | message and returns an exit status of 127. |
4112 | .PP | |
4113 | If the search is successful, or if the command name contains | |
4114 | one or more slashes, the shell executes the named program in a | |
4115 | separate execution environment. | |
4116 | Argument 0 is set to the name given, and the remaining arguments | |
4117 | to the command are set to the arguments given, if any. | |
4118 | .PP | |
4119 | If this execution fails because the file is not in executable | |
4120 | format, and the file is not a directory, it is assumed to be | |
4121 | a \fIshell script\fP, a file | |
4122 | containing shell commands. A subshell is spawned to execute | |
4123 | it. This subshell reinitializes itself, so | |
4124 | that the effect is as if a new shell had been invoked | |
4125 | to handle the script, with the exception that the locations of | |
4126 | commands remembered by the parent (see | |
4127 | .B hash | |
4128 | below under | |
4129 | .SM | |
4130 | \fBSHELL BUILTIN COMMANDS\fP) | |
4131 | are retained by the child. | |
4132 | .PP | |
4133 | If the program is a file beginning with | |
4134 | .BR #! , | |
4135 | the remainder of the first line specifies an interpreter | |
4136 | for the program. The shell executes the | |
4137 | specified interpreter on operating systems that do not | |
4138 | handle this executable format themselves. The arguments to the | |
4139 | interpreter consist of a single optional argument following the | |
4140 | interpreter name on the first line of the program, followed | |
4141 | by the name of the program, followed by the command | |
4142 | arguments, if any. | |
4143 | .SH COMMAND EXECUTION ENVIRONMENT | |
4144 | The shell has an \fIexecution environment\fP, which consists of the | |
4145 | following: | |
0001803f | 4146 | .if n .sp 1 |
cce855bc JA |
4147 | .IP \(bu |
4148 | open files inherited by the shell at invocation, as modified by | |
4149 | redirections supplied to the \fBexec\fP builtin | |
4150 | .IP \(bu | |
4151 | the current working directory as set by \fBcd\fP, \fBpushd\fP, or | |
4152 | \fBpopd\fP, or inherited by the shell at invocation | |
4153 | .IP \(bu | |
4154 | the file creation mode mask as set by \fBumask\fP or inherited from | |
4155 | the shell's parent | |
4156 | .IP \(bu | |
4157 | current traps set by \fBtrap\fP | |
4158 | .IP \(bu | |
4159 | shell parameters that are set by variable assignment or with \fBset\fP | |
4160 | or inherited from the shell's parent in the environment | |
4161 | .IP \(bu | |
4162 | shell functions defined during execution or inherited from the shell's | |
4163 | parent in the environment | |
4164 | .IP \(bu | |
4165 | options enabled at invocation (either by default or with command-line | |
4166 | arguments) or by \fBset\fP | |
4167 | .IP \(bu | |
4168 | options enabled by \fBshopt\fP | |
4169 | .IP \(bu | |
4170 | shell aliases defined with \fBalias\fP | |
4171 | .IP \(bu | |
4172 | various process IDs, including those of background jobs, the value | |
0001803f CR |
4173 | of \fB$$\fP, and the value of |
4174 | .SM | |
4175 | .B PPID | |
cce855bc JA |
4176 | .PP |
4177 | When a simple command other than a builtin or shell function | |
4178 | is to be executed, it | |
4179 | is invoked in a separate execution environment that consists of | |
4180 | the following. Unless otherwise noted, the values are inherited | |
4181 | from the shell. | |
0001803f | 4182 | .if n .sp 1 |
cce855bc JA |
4183 | .IP \(bu |
4184 | the shell's open files, plus any modifications and additions specified | |
4185 | by redirections to the command | |
4186 | .IP \(bu | |
4187 | the current working directory | |
4188 | .IP \(bu | |
4189 | the file creation mode mask | |
4190 | .IP \(bu | |
b80f6443 JA |
4191 | shell variables and functions marked for export, along with variables |
4192 | exported for the command, passed in the environment | |
cce855bc | 4193 | .IP \(bu |
b80f6443 JA |
4194 | traps caught by the shell are reset to the values inherited from the |
4195 | shell's parent, and traps ignored by the shell are ignored | |
cce855bc JA |
4196 | .PP |
4197 | A command invoked in this separate environment cannot affect the | |
4198 | shell's execution environment. | |
4199 | .PP | |
b80f6443 JA |
4200 | Command substitution, commands grouped with parentheses, |
4201 | and asynchronous commands are invoked in a | |
cce855bc JA |
4202 | subshell environment that is a duplicate of the shell environment, |
4203 | except that traps caught by the shell are reset to the values | |
4204 | that the shell inherited from its parent at invocation. Builtin | |
4205 | commands that are invoked as part of a pipeline are also executed in a | |
4206 | subshell environment. Changes made to the subshell environment | |
4207 | cannot affect the shell's execution environment. | |
f73dda09 | 4208 | .PP |
3185942a JA |
4209 | Subshells spawned to execute command substitutions inherit the value of |
4210 | the \fB\-e\fP option from the parent shell. When not in posix mode, | |
4211 | Bash clears the \fB\-e\fP option in such subshells. | |
4212 | .PP | |
f73dda09 JA |
4213 | If a command is followed by a \fB&\fP and job control is not active, the |
4214 | default standard input for the command is the empty file \fI/dev/null\fP. | |
4215 | Otherwise, the invoked command inherits the file descriptors of the calling | |
4216 | shell as modified by redirections. | |
cce855bc JA |
4217 | .SH ENVIRONMENT |
4218 | When a program is invoked it is given an array of strings | |
4219 | called the | |
4220 | .IR environment . | |
4221 | This is a list of | |
4222 | \fIname\fP\-\fIvalue\fP pairs, of the form | |
4223 | .IR "name\fR=\fPvalue" . | |
4224 | .PP | |
bb70624e JA |
4225 | The shell provides several ways to manipulate the environment. |
4226 | On invocation, the shell scans its own environment and | |
cce855bc JA |
4227 | creates a parameter for each name found, automatically marking |
4228 | it for | |
4229 | .I export | |
4230 | to child processes. Executed commands inherit the environment. | |
4231 | The | |
4232 | .B export | |
4233 | and | |
4234 | .B declare \-x | |
4235 | commands allow parameters and functions to be added to and | |
4236 | deleted from the environment. If the value of a parameter | |
4237 | in the environment is modified, the new value becomes part | |
4238 | of the environment, replacing the old. The environment | |
4239 | inherited by any executed command consists of the shell's | |
4240 | initial environment, whose values may be modified in the shell, | |
4241 | less any pairs removed by the | |
4242 | .B unset | |
4243 | command, plus any additions via the | |
4244 | .B export | |
4245 | and | |
4246 | .B declare \-x | |
4247 | commands. | |
4248 | .PP | |
4249 | The environment for any | |
4250 | .I simple command | |
4251 | or function may be augmented temporarily by prefixing it with | |
4252 | parameter assignments, as described above in | |
4253 | .SM | |
4254 | .BR PARAMETERS . | |
4255 | These assignment statements affect only the environment seen | |
4256 | by that command. | |
4257 | .PP | |
4258 | If the | |
4259 | .B \-k | |
4260 | option is set (see the | |
4261 | .B set | |
4262 | builtin command below), then | |
4263 | .I all | |
4264 | parameter assignments are placed in the environment for a command, | |
4265 | not just those that precede the command name. | |
4266 | .PP | |
4267 | When | |
4268 | .B bash | |
4269 | invokes an external command, the variable | |
4270 | .B _ | |
4271 | is set to the full file name of the command and passed to that | |
ccc6cda3 JA |
4272 | command in its environment. |
4273 | .SH "EXIT STATUS" | |
3185942a JA |
4274 | .PP |
4275 | The exit status of an executed command is the value returned by the | |
4276 | \fIwaitpid\fP system call or equivalent function. Exit statuses | |
4277 | fall between 0 and 255, though, as explained below, the shell may | |
4278 | use values above 125 specially. Exit statuses from shell builtins and | |
4279 | compound commands are also limited to this range. Under certain | |
4280 | circumstances, the shell will use special values to indicate specific | |
4281 | failure modes. | |
4282 | .PP | |
cce855bc | 4283 | For the shell's purposes, a command which exits with a |
ccc6cda3 JA |
4284 | zero exit status has succeeded. An exit status of zero |
4285 | indicates success. A non-zero exit status indicates failure. | |
bb70624e JA |
4286 | When a command terminates on a fatal signal \fIN\fP, \fBbash\fP uses |
4287 | the value of 128+\fIN\fP as the exit status. | |
ccc6cda3 JA |
4288 | .PP |
4289 | If a command is not found, the child process created to | |
4290 | execute it returns a status of 127. If a command is found | |
4291 | but is not executable, the return status is 126. | |
4292 | .PP | |
cce855bc JA |
4293 | If a command fails because of an error during expansion or redirection, |
4294 | the exit status is greater than zero. | |
4295 | .PP | |
ccc6cda3 JA |
4296 | Shell builtin commands return a status of 0 (\fItrue\fP) if |
4297 | successful, and non-zero (\fIfalse\fP) if an error occurs | |
4298 | while they execute. | |
4299 | All builtins return an exit status of 2 to indicate incorrect usage. | |
4300 | .PP | |
4301 | \fBBash\fP itself returns the exit status of the last command | |
4302 | executed, unless a syntax error occurs, in which case it exits | |
4303 | with a non-zero value. See also the \fBexit\fP builtin | |
4304 | command below. | |
4305 | .SH SIGNALS | |
cce855bc | 4306 | When \fBbash\fP is interactive, in the absence of any traps, it ignores |
ccc6cda3 JA |
4307 | .SM |
4308 | .B SIGTERM | |
4309 | (so that \fBkill 0\fP does not kill an interactive shell), | |
4310 | and | |
4311 | .SM | |
4312 | .B SIGINT | |
4313 | is caught and handled (so that the \fBwait\fP builtin is interruptible). | |
4314 | In all cases, \fBbash\fP ignores | |
4315 | .SM | |
4316 | .BR SIGQUIT . | |
4317 | If job control is in effect, | |
4318 | .B bash | |
4319 | ignores | |
4320 | .SM | |
4321 | .BR SIGTTIN , | |
4322 | .SM | |
4323 | .BR SIGTTOU , | |
4324 | and | |
4325 | .SM | |
4326 | .BR SIGTSTP . | |
4327 | .PP | |
b80f6443 | 4328 | Non-builtin commands run by \fBbash\fP have signal handlers |
cce855bc JA |
4329 | set to the values inherited by the shell from its parent. |
4330 | When job control is not in effect, asynchronous commands | |
ccc6cda3 JA |
4331 | ignore |
4332 | .SM | |
4333 | .B SIGINT | |
4334 | and | |
4335 | .SM | |
cce855bc | 4336 | .B SIGQUIT |
b80f6443 | 4337 | in addition to these inherited handlers. |
ccc6cda3 JA |
4338 | Commands run as a result of command substitution ignore the |
4339 | keyboard-generated job control signals | |
4340 | .SM | |
4341 | .BR SIGTTIN , | |
4342 | .SM | |
4343 | .BR SIGTTOU , | |
4344 | and | |
4345 | .SM | |
4346 | .BR SIGTSTP . | |
4347 | .PP | |
4348 | The shell exits by default upon receipt of a | |
4349 | .SM | |
4350 | .BR SIGHUP . | |
f73dda09 | 4351 | Before exiting, an interactive shell resends the |
ccc6cda3 JA |
4352 | .SM |
4353 | .B SIGHUP | |
cce855bc JA |
4354 | to all jobs, running or stopped. |
4355 | Stopped jobs are sent | |
4356 | .SM | |
4357 | .B SIGCONT | |
4358 | to ensure that they receive the | |
4359 | .SM | |
4360 | .BR SIGHUP . | |
4361 | To prevent the shell from | |
4362 | sending the signal to a particular job, it should be removed from the | |
ccc6cda3 JA |
4363 | jobs table with the |
4364 | .B disown | |
4365 | builtin (see | |
4366 | .SM | |
4367 | .B "SHELL BUILTIN COMMANDS" | |
cce855bc JA |
4368 | below) or marked |
4369 | to not receive | |
ccc6cda3 | 4370 | .SM |
cce855bc JA |
4371 | .B SIGHUP |
4372 | using | |
4373 | .BR "disown \-h" . | |
4374 | .PP | |
4375 | If the | |
4376 | .B huponexit | |
4377 | shell option has been set with | |
4378 | .BR shopt , | |
4379 | .B bash | |
4380 | sends a | |
4381 | .SM | |
4382 | .B SIGHUP | |
4383 | to all jobs when an interactive login shell exits. | |
4384 | .PP | |
95732b49 | 4385 | If \fBbash\fP is waiting for a command to complete and receives a signal |
b80f6443 JA |
4386 | for which a trap has been set, the trap will not be executed until |
4387 | the command completes. | |
cce855bc JA |
4388 | When \fBbash\fP is waiting for an asynchronous command via the \fBwait\fP |
4389 | builtin, the reception of a signal for which a trap has been set will | |
4390 | cause the \fBwait\fP builtin to return immediately with an exit status | |
4391 | greater than 128, immediately after which the trap is executed. | |
ccc6cda3 JA |
4392 | .SH "JOB CONTROL" |
4393 | .I Job control | |
4394 | refers to the ability to selectively stop (\fIsuspend\fP) | |
4395 | the execution of processes and continue (\fIresume\fP) | |
4396 | their execution at a later point. A user typically employs | |
4397 | this facility via an interactive interface supplied jointly | |
0001803f | 4398 | by the operating system kernel's terminal driver and |
ccc6cda3 JA |
4399 | .BR bash . |
4400 | .PP | |
4401 | The shell associates a | |
4402 | .I job | |
4403 | with each pipeline. It keeps a table of currently executing | |
4404 | jobs, which may be listed with the | |
4405 | .B jobs | |
4406 | command. When | |
4407 | .B bash | |
4408 | starts a job asynchronously (in the | |
4409 | .IR background ), | |
4410 | it prints a line that looks like: | |
4411 | .RS | |
4412 | .PP | |
4413 | [1] 25647 | |
4414 | .RE | |
4415 | .PP | |
4416 | indicating that this job is job number 1 and that the process ID | |
4417 | of the last process in the pipeline associated with this job is 25647. | |
4418 | All of the processes in a single pipeline are members of the same job. | |
4419 | .B Bash | |
4420 | uses the | |
4421 | .I job | |
4422 | abstraction as the basis for job control. | |
4423 | .PP | |
4424 | To facilitate the implementation of the user interface to job | |
bb70624e | 4425 | control, the operating system maintains the notion of a \fIcurrent terminal |
ccc6cda3 JA |
4426 | process group ID\fP. Members of this process group (processes whose |
4427 | process group ID is equal to the current terminal process group ID) | |
4428 | receive keyboard-generated signals such as | |
4429 | .SM | |
4430 | .BR SIGINT . | |
4431 | These processes are said to be in the | |
4432 | .IR foreground . | |
4433 | .I Background | |
4434 | processes are those whose process group ID differs from the terminal's; | |
4435 | such processes are immune to keyboard-generated signals. | |
0001803f CR |
4436 | Only foreground processes are allowed to read from or, if the |
4437 | user so specifies with \f(CWstty tostop\fP, write to the | |
4438 | terminal. | |
4439 | Background processes which attempt to read from (write to when | |
4440 | \f(CWstty tostop\fP is in effect) the | |
ccc6cda3 JA |
4441 | terminal are sent a |
4442 | .SM | |
4443 | .B SIGTTIN (SIGTTOU) | |
0001803f | 4444 | signal by the kernel's terminal driver, |
ccc6cda3 JA |
4445 | which, unless caught, suspends the process. |
4446 | .PP | |
4447 | If the operating system on which | |
4448 | .B bash | |
4449 | is running supports | |
4450 | job control, | |
4451 | .B bash | |
bb70624e | 4452 | contains facilities to use it. |
ccc6cda3 JA |
4453 | Typing the |
4454 | .I suspend | |
4455 | character (typically | |
4456 | .BR ^Z , | |
4457 | Control-Z) while a process is running | |
bb70624e | 4458 | causes that process to be stopped and returns control to |
ccc6cda3 JA |
4459 | .BR bash . |
4460 | Typing the | |
4461 | .I "delayed suspend" | |
4462 | character (typically | |
4463 | .BR ^Y , | |
4464 | Control-Y) causes the process to be stopped when it | |
4465 | attempts to read input from the terminal, and control to | |
4466 | be returned to | |
4467 | .BR bash . | |
cce855bc | 4468 | The user may then manipulate the state of this job, using the |
ccc6cda3 JA |
4469 | .B bg |
4470 | command to continue it in the background, the | |
4471 | .B fg | |
4472 | command to continue it in the foreground, or | |
4473 | the | |
4474 | .B kill | |
4475 | command to kill it. A \fB^Z\fP takes effect immediately, | |
4476 | and has the additional side effect of causing pending output | |
4477 | and typeahead to be discarded. | |
4478 | .PP | |
4479 | There are a number of ways to refer to a job in the shell. | |
4480 | The character | |
4481 | .B % | |
3185942a | 4482 | introduces a job specification (\fIjobspec\fP). Job number |
ccc6cda3 JA |
4483 | .I n |
4484 | may be referred to as | |
4485 | .BR %n . | |
4486 | A job may also be referred to using a prefix of the name used to | |
4487 | start it, or using a substring that appears in its command line. | |
4488 | For example, | |
4489 | .B %ce | |
4490 | refers to a stopped | |
4491 | .B ce | |
4492 | job. If a prefix matches more than one job, | |
4493 | .B bash | |
4494 | reports an error. Using | |
4495 | .BR %?ce , | |
4496 | on the other hand, refers to any job containing the string | |
4497 | .B ce | |
4498 | in its command line. If the substring matches more than one job, | |
4499 | .B bash | |
4500 | reports an error. The symbols | |
4501 | .B %% | |
4502 | and | |
4503 | .B %+ | |
4504 | refer to the shell's notion of the | |
4505 | .IR "current job" , | |
4506 | which is the last job stopped while it was in | |
cce855bc | 4507 | the foreground or started in the background. |
ccc6cda3 JA |
4508 | The |
4509 | .I "previous job" | |
4510 | may be referenced using | |
4511 | .BR %\- . | |
3185942a JA |
4512 | If there is only a single job, \fB%+\fP and \fB%\-\fP can both be used |
4513 | to refer to that job. | |
ccc6cda3 JA |
4514 | In output pertaining to jobs (e.g., the output of the |
4515 | .B jobs | |
4516 | command), the current job is always flagged with a | |
4517 | .BR + , | |
4518 | and the previous job with a | |
4519 | .BR \- . | |
95732b49 JA |
4520 | A single % (with no accompanying job specification) also refers to the |
4521 | current job. | |
726f6388 | 4522 | .PP |
ccc6cda3 JA |
4523 | Simply naming a job can be used to bring it into the |
4524 | foreground: | |
4525 | .B %1 | |
4526 | is a synonym for | |
4527 | \fB``fg %1''\fP, | |
4528 | bringing job 1 from the background into the foreground. | |
4529 | Similarly, | |
4530 | .B ``%1 &'' | |
4531 | resumes job 1 in the background, equivalent to | |
4532 | \fB``bg %1''\fP. | |
726f6388 | 4533 | .PP |
ccc6cda3 JA |
4534 | The shell learns immediately whenever a job changes state. |
4535 | Normally, | |
4536 | .B bash | |
4537 | waits until it is about to print a prompt before reporting | |
4538 | changes in a job's status so as to not interrupt | |
4539 | any other output. If the | |
4540 | .B \-b | |
4541 | option to the | |
726f6388 | 4542 | .B set |
ccc6cda3 | 4543 | builtin command |
cce855bc | 4544 | is enabled, |
726f6388 | 4545 | .B bash |
ccc6cda3 | 4546 | reports such changes immediately. |
f73dda09 JA |
4547 | Any trap on |
4548 | .SM | |
4549 | .B SIGCHLD | |
4550 | is executed for each child that exits. | |
726f6388 | 4551 | .PP |
ccc6cda3 JA |
4552 | If an attempt to exit |
4553 | .B bash | |
3185942a JA |
4554 | is made while jobs are stopped (or, if the \fBcheckjobs\fP shell option has |
4555 | been enabled using the \fBshopt\fP builtin, running), the shell prints a | |
4556 | warning message, and, if the \fBcheckjobs\fP option is enabled, lists the | |
4557 | jobs and their statuses. | |
4558 | The | |
ccc6cda3 | 4559 | .B jobs |
3185942a | 4560 | command may then be used to inspect their status. |
ccc6cda3 | 4561 | If a second attempt to exit is made without an intervening command, |
3185942a | 4562 | the shell does not print another warning, and any stopped |
ccc6cda3 | 4563 | jobs are terminated. |
726f6388 JA |
4564 | .SH PROMPTING |
4565 | When executing interactively, | |
4566 | .B bash | |
4567 | displays the primary prompt | |
4568 | .SM | |
4569 | .B PS1 | |
4570 | when it is ready to read a command, and the secondary prompt | |
4571 | .SM | |
4572 | .B PS2 | |
4573 | when it needs more input to complete a command. | |
4574 | .B Bash | |
4575 | allows these prompt strings to be customized by inserting a number of | |
4576 | backslash-escaped special characters that are decoded as follows: | |
4577 | .RS | |
4578 | .PD 0 | |
4579 | .TP | |
ccc6cda3 JA |
4580 | .B \ea |
4581 | an ASCII bell character (07) | |
726f6388 JA |
4582 | .TP |
4583 | .B \ed | |
4584 | the date in "Weekday Month Date" format (e.g., "Tue May 26") | |
4585 | .TP | |
7117c2d2 JA |
4586 | .B \eD{\fIformat\fP} |
4587 | the \fIformat\fP is passed to \fIstrftime\fP(3) and the result is inserted | |
4588 | into the prompt string; an empty \fIformat\fP results in a locale-specific | |
4589 | time representation. The braces are required | |
4590 | .TP | |
ccc6cda3 JA |
4591 | .B \ee |
4592 | an ASCII escape character (033) | |
4593 | .TP | |
4594 | .B \eh | |
4595 | the hostname up to the first `.' | |
4596 | .TP | |
4597 | .B \eH | |
4598 | the hostname | |
4599 | .TP | |
bb70624e JA |
4600 | .B \ej |
4601 | the number of jobs currently managed by the shell | |
4602 | .TP | |
4603 | .B \el | |
4604 | the basename of the shell's terminal device name | |
4605 | .TP | |
726f6388 JA |
4606 | .B \en |
4607 | newline | |
4608 | .TP | |
cce855bc JA |
4609 | .B \er |
4610 | carriage return | |
4611 | .TP | |
726f6388 JA |
4612 | .B \es |
4613 | the name of the shell, the basename of | |
4614 | .B $0 | |
4615 | (the portion following the final slash) | |
4616 | .TP | |
ccc6cda3 JA |
4617 | .B \et |
4618 | the current time in 24-hour HH:MM:SS format | |
726f6388 | 4619 | .TP |
ccc6cda3 JA |
4620 | .B \eT |
4621 | the current time in 12-hour HH:MM:SS format | |
4622 | .TP | |
4623 | .B \e@ | |
4624 | the current time in 12-hour am/pm format | |
726f6388 | 4625 | .TP |
f73dda09 JA |
4626 | .B \eA |
4627 | the current time in 24-hour HH:MM format | |
4628 | .TP | |
726f6388 JA |
4629 | .B \eu |
4630 | the username of the current user | |
4631 | .TP | |
ccc6cda3 JA |
4632 | .B \ev |
4633 | the version of \fBbash\fP (e.g., 2.00) | |
726f6388 | 4634 | .TP |
ccc6cda3 | 4635 | .B \eV |
b80f6443 | 4636 | the release of \fBbash\fP, version + patch level (e.g., 2.00.0) |
ccc6cda3 JA |
4637 | .TP |
4638 | .B \ew | |
0001803f CR |
4639 | the current working directory, with |
4640 | .SM | |
4641 | .B $HOME | |
4642 | abbreviated with a tilde | |
4643 | (uses the value of the | |
4644 | .SM | |
4645 | .B PROMPT_DIRTRIM | |
4646 | variable) | |
ccc6cda3 JA |
4647 | .TP |
4648 | .B \eW | |
0001803f CR |
4649 | the basename of the current working directory, with |
4650 | .SM | |
4651 | .B $HOME | |
b80f6443 | 4652 | abbreviated with a tilde |
726f6388 JA |
4653 | .TP |
4654 | .B \e! | |
4655 | the history number of this command | |
4656 | .TP | |
ccc6cda3 JA |
4657 | .B \e# |
4658 | the command number of this command | |
4659 | .TP | |
726f6388 JA |
4660 | .B \e$ |
4661 | if the effective UID is 0, a | |
4662 | .BR # , | |
4663 | otherwise a | |
4664 | .B $ | |
4665 | .TP | |
ccc6cda3 JA |
4666 | .B \e\fInnn\fP |
4667 | the character corresponding to the octal number \fInnn\fP | |
726f6388 JA |
4668 | .TP |
4669 | .B \e\e | |
4670 | a backslash | |
4671 | .TP | |
4672 | .B \e[ | |
4673 | begin a sequence of non-printing characters, which could be used to | |
4674 | embed a terminal control sequence into the prompt | |
4675 | .TP | |
4676 | .B \e] | |
4677 | end a sequence of non-printing characters | |
4678 | .PD | |
4679 | .RE | |
4680 | .PP | |
4681 | The command number and the history number are usually different: | |
4682 | the history number of a command is its position in the history | |
4683 | list, which may include commands restored from the history file | |
4684 | (see | |
4685 | .SM | |
4686 | .B HISTORY | |
4687 | below), while the command number is the position in the sequence | |
4688 | of commands executed during the current shell session. | |
4689 | After the string is decoded, it is expanded via | |
bb70624e JA |
4690 | parameter expansion, command substitution, arithmetic |
4691 | expansion, and quote removal, subject to the value of the | |
ccc6cda3 JA |
4692 | .B promptvars |
4693 | shell option (see the description of the | |
4694 | .B shopt | |
4695 | command under | |
4696 | .SM | |
4697 | .B "SHELL BUILTIN COMMANDS" | |
4698 | below). | |
726f6388 JA |
4699 | .SH READLINE |
4700 | This is the library that handles reading input when using an interactive | |
4701 | shell, unless the | |
d166f048 | 4702 | .B \-\-noediting |
ccc6cda3 | 4703 | option is given at shell invocation. |
3185942a JA |
4704 | Line editing is also used when using the \fB\-e\fP option to the |
4705 | \fBread\fP builtin. | |
ccc6cda3 | 4706 | By default, the line editing commands are similar to those of emacs. |
726f6388 | 4707 | A vi-style line editing interface is also available. |
3185942a JA |
4708 | Line editing can be enabled at any time using the |
4709 | .B \-o emacs | |
ccc6cda3 | 4710 | or |
3185942a | 4711 | .B \-o vi |
ccc6cda3 JA |
4712 | options to the |
4713 | .B set | |
4714 | builtin (see | |
4715 | .SM | |
4716 | .B SHELL BUILTIN COMMANDS | |
4717 | below). | |
3185942a JA |
4718 | To turn off line editing after the shell is running, use the |
4719 | .B +o emacs | |
4720 | or | |
4721 | .B +o vi | |
4722 | options to the | |
4723 | .B set | |
4724 | builtin. | |
ccc6cda3 | 4725 | .SS "Readline Notation" |
726f6388 JA |
4726 | .PP |
4727 | In this section, the emacs-style notation is used to denote | |
4728 | keystrokes. Control keys are denoted by C\-\fIkey\fR, e.g., C\-n | |
4729 | means Control\-N. Similarly, | |
4730 | .I meta | |
4731 | keys are denoted by M\-\fIkey\fR, so M\-x means Meta\-X. (On keyboards | |
4732 | without a | |
4733 | .I meta | |
4734 | key, M\-\fIx\fP means ESC \fIx\fP, i.e., press the Escape key | |
4735 | then the | |
4736 | .I x | |
4737 | key. This makes ESC the \fImeta prefix\fP. | |
4738 | The combination M\-C\-\fIx\fP means ESC\-Control\-\fIx\fP, | |
4739 | or press the Escape key | |
4740 | then hold the Control key while pressing the | |
4741 | .I x | |
4742 | key.) | |
4743 | .PP | |
ccc6cda3 JA |
4744 | Readline commands may be given numeric |
4745 | .IR arguments , | |
4746 | which normally act as a repeat count. | |
4747 | Sometimes, however, it is the sign of the argument that is significant. | |
4748 | Passing a negative argument to a command that acts in the forward | |
4749 | direction (e.g., \fBkill\-line\fP) causes that command to act in a | |
4750 | backward direction. | |
4751 | Commands whose behavior with arguments deviates from this are noted | |
4752 | below. | |
4753 | .PP | |
4754 | When a command is described as \fIkilling\fP text, the text | |
4755 | deleted is saved for possible future retrieval | |
4756 | (\fIyanking\fP). The killed text is saved in a | |
4757 | \fIkill ring\fP. Consecutive kills cause the text to be | |
4758 | accumulated into one unit, which can be yanked all at once. | |
4759 | Commands which do not kill text separate the chunks of text | |
4760 | on the kill ring. | |
4761 | .SS "Readline Initialization" | |
4762 | .PP | |
4763 | Readline is customized by putting commands in an initialization | |
4764 | file (the \fIinputrc\fP file). | |
4765 | The name of this file is taken from the value of the | |
726f6388 | 4766 | .SM |
ccc6cda3 JA |
4767 | .B INPUTRC |
4768 | variable. If that variable is unset, the default is | |
726f6388 | 4769 | .IR ~/.inputrc . |
ccc6cda3 JA |
4770 | When a program which uses the readline library starts up, the |
4771 | initialization file is read, and the key bindings and variables | |
4772 | are set. | |
4773 | There are only a few basic constructs allowed in the | |
4774 | readline initialization file. | |
4775 | Blank lines are ignored. | |
4776 | Lines beginning with a \fB#\fP are comments. | |
4777 | Lines beginning with a \fB$\fP indicate conditional constructs. | |
4778 | Other lines denote key bindings and variable settings. | |
4779 | .PP | |
4780 | The default key-bindings may be changed with an | |
4781 | .I inputrc | |
4782 | file. | |
726f6388 JA |
4783 | Other programs that use this library may add their own commands |
4784 | and bindings. | |
4785 | .PP | |
4786 | For example, placing | |
4787 | .RS | |
4788 | .PP | |
4789 | M\-Control\-u: universal\-argument | |
4790 | .RE | |
4791 | or | |
4792 | .RS | |
4793 | C\-Meta\-u: universal\-argument | |
4794 | .RE | |
4795 | into the | |
ccc6cda3 | 4796 | .I inputrc |
726f6388 JA |
4797 | would make M\-C\-u execute the readline command |
4798 | .IR universal\-argument . | |
4799 | .PP | |
4800 | The following symbolic character names are recognized: | |
4801 | .IR RUBOUT , | |
4802 | .IR DEL , | |
4803 | .IR ESC , | |
4804 | .IR LFD , | |
4805 | .IR NEWLINE , | |
4806 | .IR RET , | |
4807 | .IR RETURN , | |
4808 | .IR SPC , | |
4809 | .IR SPACE , | |
4810 | and | |
4811 | .IR TAB . | |
bb70624e | 4812 | .PP |
726f6388 JA |
4813 | In addition to command names, readline allows keys to be bound |
4814 | to a string that is inserted when the key is pressed (a \fImacro\fP). | |
ccc6cda3 | 4815 | .SS "Readline Key Bindings" |
726f6388 JA |
4816 | .PP |
4817 | The syntax for controlling key bindings in the | |
cce855bc | 4818 | .I inputrc |
726f6388 JA |
4819 | file is simple. All that is required is the name of the |
4820 | command or the text of a macro and a key sequence to which | |
4821 | it should be bound. The name may be specified in one of two ways: | |
ccc6cda3 | 4822 | as a symbolic key name, possibly with \fIMeta\-\fP or \fIControl\-\fP |
726f6388 | 4823 | prefixes, or as a key sequence. |
28ef6c31 | 4824 | .PP |
cce855bc | 4825 | When using the form \fBkeyname\fP:\^\fIfunction\-name\fP or \fImacro\fP, |
726f6388 JA |
4826 | .I keyname |
4827 | is the name of a key spelled out in English. For example: | |
4828 | .sp | |
4829 | .RS | |
4830 | Control-u: universal\-argument | |
4831 | .br | |
4832 | Meta-Rubout: backward-kill-word | |
4833 | .br | |
ccc6cda3 | 4834 | Control-o: "> output" |
726f6388 JA |
4835 | .RE |
4836 | .LP | |
4837 | In the above example, | |
ccc6cda3 | 4838 | .I C\-u |
726f6388 JA |
4839 | is bound to the function |
4840 | .BR universal\-argument , | |
ccc6cda3 | 4841 | .I M\-DEL |
726f6388 JA |
4842 | is bound to the function |
4843 | .BR backward\-kill\-word , | |
4844 | and | |
ccc6cda3 | 4845 | .I C\-o |
726f6388 JA |
4846 | is bound to run the macro |
4847 | expressed on the right hand side (that is, to insert the text | |
28ef6c31 JA |
4848 | .if t \f(CW> output\fP |
4849 | .if n ``> output'' | |
726f6388 JA |
4850 | into the line). |
4851 | .PP | |
cce855bc | 4852 | In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP, |
726f6388 JA |
4853 | .B keyseq |
4854 | differs from | |
4855 | .B keyname | |
4856 | above in that strings denoting | |
4857 | an entire key sequence may be specified by placing the sequence | |
4858 | within double quotes. Some GNU Emacs style key escapes can be | |
28ef6c31 JA |
4859 | used, as in the following example, but the symbolic character names |
4860 | are not recognized. | |
726f6388 JA |
4861 | .sp |
4862 | .RS | |
ccc6cda3 | 4863 | "\eC\-u": universal\-argument |
726f6388 | 4864 | .br |
ccc6cda3 | 4865 | "\eC\-x\eC\-r": re\-read\-init\-file |
726f6388 JA |
4866 | .br |
4867 | "\ee[11~": "Function Key 1" | |
4868 | .RE | |
4869 | .PP | |
4870 | In this example, | |
ccc6cda3 | 4871 | .I C\-u |
726f6388 JA |
4872 | is again bound to the function |
4873 | .BR universal\-argument . | |
ccc6cda3 | 4874 | .I "C\-x C\-r" |
726f6388 JA |
4875 | is bound to the function |
4876 | .BR re\-read\-init\-file , | |
4877 | and | |
4878 | .I "ESC [ 1 1 ~" | |
4879 | is bound to insert the text | |
28ef6c31 JA |
4880 | .if t \f(CWFunction Key 1\fP. |
4881 | .if n ``Function Key 1''. | |
4882 | .PP | |
cce855bc | 4883 | The full set of GNU Emacs style escape sequences is |
726f6388 | 4884 | .RS |
cce855bc | 4885 | .PD 0 |
726f6388 JA |
4886 | .TP |
4887 | .B \eC\- | |
4888 | control prefix | |
4889 | .TP | |
ccc6cda3 | 4890 | .B \eM\- |
726f6388 JA |
4891 | meta prefix |
4892 | .TP | |
4893 | .B \ee | |
4894 | an escape character | |
4895 | .TP | |
4896 | .B \e\e | |
4897 | backslash | |
4898 | .TP | |
4899 | .B \e" | |
4900 | literal " | |
4901 | .TP | |
0628567a JA |
4902 | .B \e\(aq |
4903 | literal \(aq | |
726f6388 | 4904 | .RE |
cce855bc JA |
4905 | .PD |
4906 | .PP | |
4907 | In addition to the GNU Emacs style escape sequences, a second | |
4908 | set of backslash escapes is available: | |
4909 | .RS | |
4910 | .PD 0 | |
4911 | .TP | |
4912 | .B \ea | |
4913 | alert (bell) | |
4914 | .TP | |
4915 | .B \eb | |
4916 | backspace | |
4917 | .TP | |
4918 | .B \ed | |
4919 | delete | |
4920 | .TP | |
4921 | .B \ef | |
4922 | form feed | |
4923 | .TP | |
4924 | .B \en | |
4925 | newline | |
4926 | .TP | |
4927 | .B \er | |
4928 | carriage return | |
4929 | .TP | |
4930 | .B \et | |
4931 | horizontal tab | |
4932 | .TP | |
4933 | .B \ev | |
4934 | vertical tab | |
4935 | .TP | |
4936 | .B \e\fInnn\fP | |
f73dda09 | 4937 | the eight-bit character whose value is the octal value \fInnn\fP |
cce855bc JA |
4938 | (one to three digits) |
4939 | .TP | |
f73dda09 JA |
4940 | .B \ex\fIHH\fP |
4941 | the eight-bit character whose value is the hexadecimal value \fIHH\fP | |
4942 | (one or two hex digits) | |
cce855bc JA |
4943 | .RE |
4944 | .PD | |
726f6388 | 4945 | .PP |
cce855bc JA |
4946 | When entering the text of a macro, single or double quotes must |
4947 | be used to indicate a macro definition. | |
4948 | Unquoted text is assumed to be a function name. | |
4949 | In the macro body, the backslash escapes described above are expanded. | |
4950 | Backslash will quote any other character in the macro text, | |
0628567a | 4951 | including " and \(aq. |
726f6388 JA |
4952 | .PP |
4953 | .B Bash | |
4954 | allows the current readline key bindings to be displayed or modified | |
4955 | with the | |
4956 | .B bind | |
4957 | builtin command. The editing mode may be switched during interactive | |
4958 | use by using the | |
4959 | .B \-o | |
4960 | option to the | |
4961 | .B set | |
4962 | builtin command (see | |
4963 | .SM | |
4964 | .B SHELL BUILTIN COMMANDS | |
4965 | below). | |
ccc6cda3 | 4966 | .SS "Readline Variables" |
726f6388 JA |
4967 | .PP |
4968 | Readline has variables that can be used to further customize its | |
4969 | behavior. A variable may be set in the | |
4970 | .I inputrc | |
4971 | file with a statement of the form | |
4972 | .RS | |
4973 | .PP | |
4974 | \fBset\fP \fIvariable\-name\fP \fIvalue\fP | |
4975 | .RE | |
4976 | .PP | |
4977 | Except where noted, readline variables can take the values | |
4978 | .B On | |
4979 | or | |
95732b49 JA |
4980 | .B Off |
4981 | (without regard to case). | |
4982 | Unrecognized variable names are ignored. | |
4983 | When a variable value is read, empty or null values, "on" (case-insensitive), | |
4984 | and "1" are equivalent to \fBOn\fP. All other values are equivalent to | |
4985 | \fBOff\fP. | |
726f6388 JA |
4986 | The variables and their default values are: |
4987 | .PP | |
4988 | .PD 0 | |
4989 | .TP | |
726f6388 JA |
4990 | .B bell\-style (audible) |
4991 | Controls what happens when readline wants to ring the terminal bell. | |
4992 | If set to \fBnone\fP, readline never rings the bell. If set to | |
4993 | \fBvisible\fP, readline uses a visible bell if one is available. | |
4994 | If set to \fBaudible\fP, readline attempts to ring the terminal's bell. | |
4995 | .TP | |
95732b49 JA |
4996 | .B bind\-tty\-special\-chars (On) |
4997 | If set to \fBOn\fP, readline attempts to bind the control characters | |
4998 | treated specially by the kernel's terminal driver to their readline | |
4999 | equivalents. | |
5000 | .TP | |
726f6388 | 5001 | .B comment\-begin (``#'') |
bb70624e | 5002 | The string that is inserted when the readline |
ccc6cda3 | 5003 | .B insert\-comment |
726f6388 | 5004 | command is executed. |
ccc6cda3 JA |
5005 | This command is bound to |
5006 | .B M\-# | |
5007 | in emacs mode and to | |
5008 | .B # | |
5009 | in vi command mode. | |
726f6388 | 5010 | .TP |
cce855bc JA |
5011 | .B completion\-ignore\-case (Off) |
5012 | If set to \fBOn\fP, readline performs filename matching and completion | |
5013 | in a case\-insensitive fashion. | |
5014 | .TP | |
3185942a JA |
5015 | .B completion\-prefix\-display\-length (0) |
5016 | The length in characters of the common prefix of a list of possible | |
5017 | completions that is displayed without modification. When set to a | |
5018 | value greater than zero, common prefixes longer than this value are | |
5019 | replaced with an ellipsis when displaying possible completions. | |
5020 | .TP | |
726f6388 JA |
5021 | .B completion\-query\-items (100) |
5022 | This determines when the user is queried about viewing | |
5023 | the number of possible completions | |
5024 | generated by the \fBpossible\-completions\fP command. | |
5025 | It may be set to any integer value greater than or equal to | |
5026 | zero. If the number of possible completions is greater than | |
5027 | or equal to the value of this variable, the user is asked whether | |
5028 | or not he wishes to view them; otherwise they are simply listed | |
5029 | on the terminal. | |
5030 | .TP | |
ccc6cda3 JA |
5031 | .B convert\-meta (On) |
5032 | If set to \fBOn\fP, readline will convert characters with the | |
5033 | eighth bit set to an ASCII key sequence | |
bb70624e | 5034 | by stripping the eighth bit and prefixing an |
ccc6cda3 JA |
5035 | escape character (in effect, using escape as the \fImeta prefix\fP). |
5036 | .TP | |
5037 | .B disable\-completion (Off) | |
5038 | If set to \fBOn\fP, readline will inhibit word completion. Completion | |
5039 | characters will be inserted into the line as if they had been | |
5040 | mapped to \fBself-insert\fP. | |
5041 | .TP | |
5042 | .B editing\-mode (emacs) | |
5043 | Controls whether readline begins with a set of key bindings similar | |
5044 | to \fIemacs\fP or \fIvi\fP. | |
5045 | .B editing\-mode | |
5046 | can be set to either | |
5047 | .B emacs | |
5048 | or | |
5049 | .BR vi . | |
5050 | .TP | |
0001803f CR |
5051 | .B echo\-control\-characters (On) |
5052 | When set to \fBOn\fP, on operating systems that indicate they support it, | |
5053 | readline echoes a character corresponding to a signal generated from the | |
5054 | keyboard. | |
5055 | .TP | |
ccc6cda3 JA |
5056 | .B enable\-keypad (Off) |
5057 | When set to \fBOn\fP, readline will try to enable the application | |
5058 | keypad when it is called. Some systems need this to enable the | |
5059 | arrow keys. | |
5060 | .TP | |
0001803f CR |
5061 | .B enable\-meta\-key (On) |
5062 | When set to \fBOn\fP, readline will try to enable any meta modifier | |
5063 | key the terminal claims to support when it is called. On many terminals, | |
5064 | the meta key is used to send eight-bit characters. | |
5065 | .TP | |
ccc6cda3 JA |
5066 | .B expand\-tilde (Off) |
5067 | If set to \fBon\fP, tilde expansion is performed when readline | |
5068 | attempts word completion. | |
5069 | .TP | |
95732b49 | 5070 | .B history\-preserve\-point (Off) |
f73dda09 | 5071 | If set to \fBon\fP, the history code attempts to place point at the |
95732b49 | 5072 | same location on each history line retrieved with \fBprevious-history\fP |
f73dda09 JA |
5073 | or \fBnext-history\fP. |
5074 | .TP | |
3185942a JA |
5075 | .B history\-size (0) |
5076 | Set the maximum number of history entries saved in the history list. If | |
5077 | set to zero, the number of entries in the history list is not limited. | |
5078 | .TP | |
ccc6cda3 JA |
5079 | .B horizontal\-scroll\-mode (Off) |
5080 | When set to \fBOn\fP, makes readline use a single line for display, | |
5081 | scrolling the input horizontally on a single screen line when it | |
5082 | becomes longer than the screen width rather than wrapping to a new line. | |
5083 | .TP | |
5084 | .B input\-meta (Off) | |
5085 | If set to \fBOn\fP, readline will enable eight-bit input (that is, | |
5086 | it will not strip the high bit from the characters it reads), | |
5087 | regardless of what the terminal claims it can support. The name | |
5088 | .B meta\-flag | |
5089 | is a synonym for this variable. | |
5090 | .TP | |
b72432fd JA |
5091 | .B isearch\-terminators (``C\-[C\-J'') |
5092 | The string of characters that should terminate an incremental | |
5093 | search without subsequently executing the character as a command. | |
5094 | If this variable has not been given a value, the characters | |
5095 | \fIESC\fP and \fIC\-J\fP will terminate an incremental search. | |
5096 | .TP | |
726f6388 | 5097 | .B keymap (emacs) |
cce855bc | 5098 | Set the current readline keymap. The set of valid keymap names is |
ccc6cda3 JA |
5099 | \fIemacs, emacs\-standard, emacs\-meta, emacs\-ctlx, vi, |
5100 | vi\-command\fP, and | |
5101 | .IR vi\-insert . | |
5102 | \fIvi\fP is equivalent to \fIvi\-command\fP; \fIemacs\fP is | |
5103 | equivalent to \fIemacs\-standard\fP. The default value is | |
726f6388 JA |
5104 | .IR emacs ; |
5105 | the value of | |
5106 | .B editing\-mode | |
5107 | also affects the default keymap. | |
5108 | .TP | |
ccc6cda3 JA |
5109 | .B mark\-directories (On) |
5110 | If set to \fBOn\fP, completed directory names have a slash | |
5111 | appended. | |
5112 | .TP | |
5113 | .B mark\-modified\-lines (Off) | |
5114 | If set to \fBOn\fP, history lines that have been modified are displayed | |
5115 | with a preceding asterisk (\fB*\fP). | |
5116 | .TP | |
7117c2d2 JA |
5117 | .B mark\-symlinked\-directories (Off) |
5118 | If set to \fBOn\fP, completed names which are symbolic links to directories | |
5119 | have a slash appended (subject to the value of | |
5120 | \fBmark\-directories\fP). | |
5121 | .TP | |
f73dda09 JA |
5122 | .B match\-hidden\-files (On) |
5123 | This variable, when set to \fBOn\fP, causes readline to match files whose | |
5124 | names begin with a `.' (hidden files) when performing filename | |
5125 | completion, unless the leading `.' is | |
5126 | supplied by the user in the filename to be completed. | |
5127 | .TP | |
ccc6cda3 JA |
5128 | .B output\-meta (Off) |
5129 | If set to \fBOn\fP, readline will display characters with the | |
5130 | eighth bit set directly rather than as a meta-prefixed escape | |
5131 | sequence. | |
5132 | .TP | |
7117c2d2 JA |
5133 | .B page\-completions (On) |
5134 | If set to \fBOn\fP, readline uses an internal \fImore\fP-like pager | |
5135 | to display a screenful of possible completions at a time. | |
5136 | .TP | |
cce855bc JA |
5137 | .B print\-completions\-horizontally (Off) |
5138 | If set to \fBOn\fP, readline will display completions with matches | |
5139 | sorted horizontally in alphabetical order, rather than down the screen. | |
3185942a JA |
5140 | .TP |
5141 | .B revert\-all\-at\-newline (Off) | |
5142 | If set to \fBon\fP, readline will undo all changes to history lines | |
5143 | before returning when \fBaccept\-line\fP is executed. By default, | |
5144 | history lines may be modified and retain individual undo lists across | |
5145 | calls to \fBreadline\fP. | |
cce855bc | 5146 | .TP |
726f6388 JA |
5147 | .B show\-all\-if\-ambiguous (Off) |
5148 | This alters the default behavior of the completion functions. If | |
5149 | set to | |
5150 | .BR on , | |
5151 | words which have more than one possible completion cause the | |
5152 | matches to be listed immediately instead of ringing the bell. | |
5153 | .TP | |
b80f6443 JA |
5154 | .B show\-all\-if\-unmodified (Off) |
5155 | This alters the default behavior of the completion functions in | |
5156 | a fashion similar to \fBshow\-all\-if\-ambiguous\fP. | |
5157 | If set to | |
5158 | .BR on , | |
5159 | words which have more than one possible completion without any | |
5160 | possible partial completion (the possible completions don't share | |
5161 | a common prefix) cause the matches to be listed immediately instead | |
5162 | of ringing the bell. | |
5163 | .TP | |
0001803f CR |
5164 | .B skip\-completed\-text (Off) |
5165 | If set to \fBOn\fP, this alters the default completion behavior when | |
5166 | inserting a single match into the line. It's only active when | |
5167 | performing completion in the middle of a word. If enabled, readline | |
5168 | does not insert characters from the completion that match characters | |
5169 | after point in the word being completed, so portions of the word | |
5170 | following the cursor are not duplicated. | |
5171 | .TP | |
ccc6cda3 JA |
5172 | .B visible\-stats (Off) |
5173 | If set to \fBOn\fP, a character denoting a file's type as reported | |
5174 | by \fIstat\fP(2) is appended to the filename when listing possible | |
5175 | completions. | |
726f6388 | 5176 | .PD |
ccc6cda3 | 5177 | .SS "Readline Conditional Constructs" |
726f6388 JA |
5178 | .PP |
5179 | Readline implements a facility similar in spirit to the conditional | |
5180 | compilation features of the C preprocessor which allows key | |
5181 | bindings and variable settings to be performed as the result | |
cce855bc | 5182 | of tests. There are four parser directives used. |
726f6388 JA |
5183 | .IP \fB$if\fP |
5184 | The | |
5185 | .B $if | |
5186 | construct allows bindings to be made based on the | |
5187 | editing mode, the terminal being used, or the application using | |
5188 | readline. The text of the test extends to the end of the line; | |
5189 | no characters are required to isolate it. | |
5190 | .RS | |
5191 | .IP \fBmode\fP | |
5192 | The \fBmode=\fP form of the \fB$if\fP directive is used to test | |
5193 | whether readline is in emacs or vi mode. | |
5194 | This may be used in conjunction | |
5195 | with the \fBset keymap\fP command, for instance, to set bindings in | |
ccc6cda3 | 5196 | the \fIemacs\-standard\fP and \fIemacs\-ctlx\fP keymaps only if |
726f6388 JA |
5197 | readline is starting out in emacs mode. |
5198 | .IP \fBterm\fP | |
5199 | The \fBterm=\fP form may be used to include terminal-specific | |
5200 | key bindings, perhaps to bind the key sequences output by the | |
5201 | terminal's function keys. The word on the right side of the | |
5202 | .B = | |
cce855bc | 5203 | is tested against the both full name of the terminal and the portion |
726f6388 JA |
5204 | of the terminal name before the first \fB\-\fP. This allows |
5205 | .I sun | |
5206 | to match both | |
5207 | .I sun | |
5208 | and | |
5209 | .IR sun\-cmd , | |
5210 | for instance. | |
5211 | .IP \fBapplication\fP | |
5212 | The \fBapplication\fP construct is used to include | |
ccc6cda3 | 5213 | application-specific settings. Each program using the readline |
726f6388 JA |
5214 | library sets the \fIapplication name\fP, and an initialization |
5215 | file can test for a particular value. | |
5216 | This could be used to bind key sequences to functions useful for | |
5217 | a specific program. For instance, the following command adds a | |
5218 | key sequence that quotes the current or previous word in Bash: | |
cce855bc | 5219 | .sp 1 |
726f6388 JA |
5220 | .RS |
5221 | .nf | |
5222 | \fB$if\fP Bash | |
5223 | # Quote the current or previous word | |
ccc6cda3 | 5224 | "\eC\-xq": "\eeb\e"\eef\e"" |
726f6388 JA |
5225 | \fB$endif\fP |
5226 | .fi | |
5227 | .RE | |
5228 | .RE | |
5229 | .IP \fB$endif\fP | |
cce855bc | 5230 | This command, as seen in the previous example, terminates an |
726f6388 JA |
5231 | \fB$if\fP command. |
5232 | .IP \fB$else\fP | |
5233 | Commands in this branch of the \fB$if\fP directive are executed if | |
5234 | the test fails. | |
cce855bc JA |
5235 | .IP \fB$include\fP |
5236 | This directive takes a single filename as an argument and reads commands | |
5237 | and bindings from that file. For example, the following directive | |
5238 | would read \fI/etc/inputrc\fP: | |
5239 | .sp 1 | |
5240 | .RS | |
5241 | .nf | |
5242 | \fB$include\fP \^ \fI/etc/inputrc\fP | |
5243 | .fi | |
5244 | .RE | |
ccc6cda3 | 5245 | .SS Searching |
726f6388 | 5246 | .PP |
ccc6cda3 JA |
5247 | Readline provides commands for searching through the command history |
5248 | (see | |
5249 | .SM | |
5250 | .B HISTORY | |
5251 | below) for lines containing a specified string. | |
5252 | There are two search modes: | |
5253 | .I incremental | |
5254 | and | |
5255 | .IR non-incremental . | |
5256 | .PP | |
5257 | Incremental searches begin before the user has finished typing the | |
5258 | search string. | |
5259 | As each character of the search string is typed, readline displays | |
5260 | the next entry from the history matching the string typed so far. | |
5261 | An incremental search requires only as many characters as needed to | |
5262 | find the desired history entry. | |
bb70624e | 5263 | The characters present in the value of the \fBisearch-terminators\fP |
b72432fd JA |
5264 | variable are used to terminate an incremental search. |
5265 | If that variable has not been assigned a value the Escape and | |
5266 | Control-J characters will terminate an incremental search. | |
ccc6cda3 JA |
5267 | Control-G will abort an incremental search and restore the original |
5268 | line. | |
5269 | When the search is terminated, the history entry containing the | |
5270 | search string becomes the current line. | |
bb70624e | 5271 | .PP |
ccc6cda3 JA |
5272 | To find other matching entries in the history list, type Control-S or |
5273 | Control-R as appropriate. | |
5274 | This will search backward or forward in the history for the next | |
5275 | entry matching the search string typed so far. | |
5276 | Any other key sequence bound to a readline command will terminate | |
5277 | the search and execute that command. | |
5278 | For instance, a \fInewline\fP will terminate the search and accept | |
5279 | the line, thereby executing the command from the history list. | |
5280 | .PP | |
f73dda09 JA |
5281 | Readline remembers the last incremental search string. If two |
5282 | Control-Rs are typed without any intervening characters defining a | |
5283 | new search string, any remembered search string is used. | |
5284 | .PP | |
ccc6cda3 JA |
5285 | Non-incremental searches read the entire search string before starting |
5286 | to search for matching history lines. The search string may be | |
cce855bc | 5287 | typed by the user or be part of the contents of the current line. |
ccc6cda3 | 5288 | .SS "Readline Command Names" |
726f6388 JA |
5289 | .PP |
5290 | The following is a list of the names of the commands and the default | |
5291 | key sequences to which they are bound. | |
ccc6cda3 | 5292 | Command names without an accompanying key sequence are unbound by default. |
bb70624e JA |
5293 | In the following descriptions, \fIpoint\fP refers to the current cursor |
5294 | position, and \fImark\fP refers to a cursor position saved by the | |
5295 | \fBset\-mark\fP command. | |
5296 | The text between the point and mark is referred to as the \fIregion\fP. | |
726f6388 JA |
5297 | .SS Commands for Moving |
5298 | .PP | |
5299 | .PD 0 | |
5300 | .TP | |
5301 | .B beginning\-of\-line (C\-a) | |
5302 | Move to the start of the current line. | |
5303 | .TP | |
5304 | .B end\-of\-line (C\-e) | |
5305 | Move to the end of the line. | |
5306 | .TP | |
5307 | .B forward\-char (C\-f) | |
5308 | Move forward a character. | |
5309 | .TP | |
5310 | .B backward\-char (C\-b) | |
5311 | Move back a character. | |
5312 | .TP | |
5313 | .B forward\-word (M\-f) | |
5314 | Move forward to the end of the next word. Words are composed of | |
5315 | alphanumeric characters (letters and digits). | |
5316 | .TP | |
5317 | .B backward\-word (M\-b) | |
3185942a JA |
5318 | Move back to the start of the current or previous word. |
5319 | Words are composed of alphanumeric characters (letters and digits). | |
5320 | .TP | |
5321 | .B shell\-forward\-word | |
5322 | Move forward to the end of the next word. | |
5323 | Words are delimited by non-quoted shell metacharacters. | |
5324 | .TP | |
5325 | .B shell\-backward\-word | |
5326 | Move back to the start of the current or previous word. | |
5327 | Words are delimited by non-quoted shell metacharacters. | |
726f6388 JA |
5328 | .TP |
5329 | .B clear\-screen (C\-l) | |
5330 | Clear the screen leaving the current line at the top of the screen. | |
5331 | With an argument, refresh the current line without clearing the | |
5332 | screen. | |
5333 | .TP | |
5334 | .B redraw\-current\-line | |
ccc6cda3 | 5335 | Refresh the current line. |
726f6388 JA |
5336 | .PD |
5337 | .SS Commands for Manipulating the History | |
5338 | .PP | |
5339 | .PD 0 | |
5340 | .TP | |
5341 | .B accept\-line (Newline, Return) | |
5342 | Accept the line regardless of where the cursor is. If this line is | |
ccc6cda3 | 5343 | non-empty, add it to the history list according to the state of the |
726f6388 JA |
5344 | .SM |
5345 | .B HISTCONTROL | |
5346 | variable. If the line is a modified history | |
5347 | line, then restore the history line to its original state. | |
5348 | .TP | |
5349 | .B previous\-history (C\-p) | |
5350 | Fetch the previous command from the history list, moving back in | |
5351 | the list. | |
5352 | .TP | |
5353 | .B next\-history (C\-n) | |
5354 | Fetch the next command from the history list, moving forward in the | |
5355 | list. | |
5356 | .TP | |
5357 | .B beginning\-of\-history (M\-<) | |
5358 | Move to the first line in the history. | |
5359 | .TP | |
5360 | .B end\-of\-history (M\->) | |
5361 | Move to the end of the input history, i.e., the line currently being | |
5362 | entered. | |
5363 | .TP | |
5364 | .B reverse\-search\-history (C\-r) | |
5365 | Search backward starting at the current line and moving `up' through | |
5366 | the history as necessary. This is an incremental search. | |
5367 | .TP | |
5368 | .B forward\-search\-history (C\-s) | |
5369 | Search forward starting at the current line and moving `down' through | |
5370 | the history as necessary. This is an incremental search. | |
5371 | .TP | |
5372 | .B non\-incremental\-reverse\-search\-history (M\-p) | |
5373 | Search backward through the history starting at the current line | |
ccc6cda3 | 5374 | using a non-incremental search for a string supplied by the user. |
726f6388 JA |
5375 | .TP |
5376 | .B non\-incremental\-forward\-search\-history (M\-n) | |
ccc6cda3 | 5377 | Search forward through the history using a non-incremental search for |
726f6388 JA |
5378 | a string supplied by the user. |
5379 | .TP | |
5380 | .B history\-search\-forward | |
5381 | Search forward through the history for the string of characters | |
bb70624e | 5382 | between the start of the current line and the point. |
ccc6cda3 | 5383 | This is a non-incremental search. |
726f6388 JA |
5384 | .TP |
5385 | .B history\-search\-backward | |
5386 | Search backward through the history for the string of characters | |
ccc6cda3 JA |
5387 | between the start of the current line and the point. |
5388 | This is a non-incremental search. | |
726f6388 JA |
5389 | .TP |
5390 | .B yank\-nth\-arg (M\-C\-y) | |
5391 | Insert the first argument to the previous command (usually | |
28ef6c31 JA |
5392 | the second word on the previous line) at point. |
5393 | With an argument | |
726f6388 JA |
5394 | .IR n , |
5395 | insert the \fIn\fPth word from the previous command (the words | |
5396 | in the previous command begin with word 0). A negative argument | |
5397 | inserts the \fIn\fPth word from the end of the previous command. | |
95732b49 JA |
5398 | Once the argument \fIn\fP is computed, the argument is extracted |
5399 | as if the "!\fIn\fP" history expansion had been specified. | |
726f6388 JA |
5400 | .TP |
5401 | .B | |
5402 | yank\-last\-arg (M\-.\^, M\-_\^) | |
ccc6cda3 JA |
5403 | Insert the last argument to the previous command (the last word of |
5404 | the previous history entry). With an argument, | |
5405 | behave exactly like \fByank\-nth\-arg\fP. | |
cce855bc JA |
5406 | Successive calls to \fByank\-last\-arg\fP move back through the history |
5407 | list, inserting the last argument of each line in turn. | |
95732b49 JA |
5408 | The history expansion facilities are used to extract the last argument, |
5409 | as if the "!$" history expansion had been specified. | |
726f6388 JA |
5410 | .TP |
5411 | .B shell\-expand\-line (M\-C\-e) | |
cce855bc | 5412 | Expand the line as the shell does. This |
726f6388 JA |
5413 | performs alias and history expansion as well as all of the shell |
5414 | word expansions. See | |
5415 | .SM | |
5416 | .B HISTORY EXPANSION | |
5417 | below for a description of history expansion. | |
5418 | .TP | |
5419 | .B history\-expand\-line (M\-^) | |
d166f048 JA |
5420 | Perform history expansion on the current line. |
5421 | See | |
726f6388 JA |
5422 | .SM |
5423 | .B HISTORY EXPANSION | |
5424 | below for a description of history expansion. | |
5425 | .TP | |
cce855bc JA |
5426 | .B magic\-space |
5427 | Perform history expansion on the current line and insert a space. | |
5428 | See | |
5429 | .SM | |
5430 | .B HISTORY EXPANSION | |
5431 | below for a description of history expansion. | |
5432 | .TP | |
d166f048 JA |
5433 | .B alias\-expand\-line |
5434 | Perform alias expansion on the current line. | |
5435 | See | |
5436 | .SM | |
5437 | .B ALIASES | |
5438 | above for a description of alias expansion. | |
5439 | .TP | |
5440 | .B history\-and\-alias\-expand\-line | |
5441 | Perform history and alias expansion on the current line. | |
5442 | .TP | |
726f6388 JA |
5443 | .B insert\-last\-argument (M\-.\^, M\-_\^) |
5444 | A synonym for \fByank\-last\-arg\fP. | |
5445 | .TP | |
ccc6cda3 | 5446 | .B operate\-and\-get\-next (C\-o) |
726f6388 JA |
5447 | Accept the current line for execution and fetch the next line |
5448 | relative to the current line from the history for editing. Any | |
5449 | argument is ignored. | |
7117c2d2 JA |
5450 | .TP |
5451 | .B edit\-and\-execute\-command (C\-xC\-e) | |
5452 | Invoke an editor on the current command line, and execute the result as shell | |
5453 | commands. | |
5454 | \fBBash\fP attempts to invoke | |
5455 | .SM | |
3185942a | 5456 | .BR $VISUAL , |
7117c2d2 JA |
5457 | .SM |
5458 | .BR $EDITOR , | |
5459 | and \fIemacs\fP as the editor, in that order. | |
726f6388 JA |
5460 | .PD |
5461 | .SS Commands for Changing Text | |
5462 | .PP | |
5463 | .PD 0 | |
5464 | .TP | |
5465 | .B delete\-char (C\-d) | |
28ef6c31 | 5466 | Delete the character at point. If point is at the |
726f6388 | 5467 | beginning of the line, there are no characters in the line, and |
cce855bc | 5468 | the last character typed was not bound to \fBdelete\-char\fP, |
726f6388 JA |
5469 | then return |
5470 | .SM | |
5471 | .BR EOF . | |
5472 | .TP | |
5473 | .B backward\-delete\-char (Rubout) | |
5474 | Delete the character behind the cursor. When given a numeric argument, | |
ccc6cda3 | 5475 | save the deleted text on the kill ring. |
726f6388 | 5476 | .TP |
b72432fd JA |
5477 | .B forward\-backward\-delete\-char |
5478 | Delete the character under the cursor, unless the cursor is at the | |
5479 | end of the line, in which case the character behind the cursor is | |
f73dda09 | 5480 | deleted. |
b72432fd | 5481 | .TP |
726f6388 | 5482 | .B quoted\-insert (C\-q, C\-v) |
cce855bc | 5483 | Add the next character typed to the line verbatim. This is |
726f6388 JA |
5484 | how to insert characters like \fBC\-q\fP, for example. |
5485 | .TP | |
ccc6cda3 | 5486 | .B tab\-insert (C\-v TAB) |
726f6388 JA |
5487 | Insert a tab character. |
5488 | .TP | |
5489 | .B self\-insert (a,\ b,\ A,\ 1,\ !,\ ...) | |
5490 | Insert the character typed. | |
5491 | .TP | |
5492 | .B transpose\-chars (C\-t) | |
28ef6c31 JA |
5493 | Drag the character before point forward over the character at point, |
5494 | moving point forward as well. | |
5495 | If point is at the end of the line, then this transposes | |
5496 | the two characters before point. | |
bb70624e | 5497 | Negative arguments have no effect. |
726f6388 JA |
5498 | .TP |
5499 | .B transpose\-words (M\-t) | |
bb70624e | 5500 | Drag the word before point past the word after point, |
28ef6c31 | 5501 | moving point over that word as well. |
f73dda09 JA |
5502 | If point is at the end of the line, this transposes |
5503 | the last two words on the line. | |
726f6388 JA |
5504 | .TP |
5505 | .B upcase\-word (M\-u) | |
5506 | Uppercase the current (or following) word. With a negative argument, | |
cce855bc | 5507 | uppercase the previous word, but do not move point. |
726f6388 JA |
5508 | .TP |
5509 | .B downcase\-word (M\-l) | |
5510 | Lowercase the current (or following) word. With a negative argument, | |
cce855bc | 5511 | lowercase the previous word, but do not move point. |
726f6388 JA |
5512 | .TP |
5513 | .B capitalize\-word (M\-c) | |
5514 | Capitalize the current (or following) word. With a negative argument, | |
cce855bc | 5515 | capitalize the previous word, but do not move point. |
7117c2d2 JA |
5516 | .TP |
5517 | .B overwrite\-mode | |
5518 | Toggle overwrite mode. With an explicit positive numeric argument, | |
5519 | switches to overwrite mode. With an explicit non-positive numeric | |
5520 | argument, switches to insert mode. This command affects only | |
5521 | \fBemacs\fP mode; \fBvi\fP mode does overwrite differently. | |
5522 | Each call to \fIreadline()\fP starts in insert mode. | |
5523 | In overwrite mode, characters bound to \fBself\-insert\fP replace | |
5524 | the text at point rather than pushing the text to the right. | |
5525 | Characters bound to \fBbackward\-delete\-char\fP replace the character | |
5526 | before point with a space. By default, this command is unbound. | |
726f6388 JA |
5527 | .PD |
5528 | .SS Killing and Yanking | |
5529 | .PP | |
5530 | .PD 0 | |
5531 | .TP | |
5532 | .B kill\-line (C\-k) | |
bb70624e | 5533 | Kill the text from point to the end of the line. |
726f6388 | 5534 | .TP |
ccc6cda3 | 5535 | .B backward\-kill\-line (C\-x Rubout) |
726f6388 JA |
5536 | Kill backward to the beginning of the line. |
5537 | .TP | |
5538 | .B unix\-line\-discard (C\-u) | |
5539 | Kill backward from point to the beginning of the line. | |
cce855bc | 5540 | The killed text is saved on the kill-ring. |
bb70624e | 5541 | .\" There is no real difference between this and backward-kill-line |
726f6388 JA |
5542 | .TP |
5543 | .B kill\-whole\-line | |
bb70624e | 5544 | Kill all characters on the current line, no matter where point is. |
726f6388 JA |
5545 | .TP |
5546 | .B kill\-word (M\-d) | |
bb70624e JA |
5547 | Kill from point to the end of the current word, or if between |
5548 | words, to the end of the next word. | |
5549 | Word boundaries are the same as those used by \fBforward\-word\fP. | |
726f6388 JA |
5550 | .TP |
5551 | .B backward\-kill\-word (M\-Rubout) | |
bb70624e JA |
5552 | Kill the word behind point. |
5553 | Word boundaries are the same as those used by \fBbackward\-word\fP. | |
726f6388 | 5554 | .TP |
3185942a JA |
5555 | .B shell\-kill\-word (M\-d) |
5556 | Kill from point to the end of the current word, or if between | |
5557 | words, to the end of the next word. | |
5558 | Word boundaries are the same as those used by \fBshell\-forward\-word\fP. | |
5559 | .TP | |
5560 | .B shell\-backward\-kill\-word (M\-Rubout) | |
5561 | Kill the word behind point. | |
5562 | Word boundaries are the same as those used by \fBshell\-backward\-word\fP. | |
5563 | .TP | |
726f6388 | 5564 | .B unix\-word\-rubout (C\-w) |
bb70624e | 5565 | Kill the word behind point, using white space as a word boundary. |
bb70624e | 5566 | The killed text is saved on the kill-ring. |
ccc6cda3 | 5567 | .TP |
b80f6443 JA |
5568 | .B unix\-filename\-rubout |
5569 | Kill the word behind point, using white space and the slash character | |
5570 | as the word boundaries. | |
5571 | The killed text is saved on the kill-ring. | |
5572 | .TP | |
ccc6cda3 JA |
5573 | .B delete\-horizontal\-space (M\-\e) |
5574 | Delete all spaces and tabs around point. | |
5575 | .TP | |
5576 | .B kill\-region | |
bb70624e | 5577 | Kill the text in the current region. |
ccc6cda3 JA |
5578 | .TP |
5579 | .B copy\-region\-as\-kill | |
5580 | Copy the text in the region to the kill buffer. | |
726f6388 | 5581 | .TP |
ccc6cda3 JA |
5582 | .B copy\-backward\-word |
5583 | Copy the word before point to the kill buffer. | |
cce855bc | 5584 | The word boundaries are the same as \fBbackward\-word\fP. |
ccc6cda3 JA |
5585 | .TP |
5586 | .B copy\-forward\-word | |
5587 | Copy the word following point to the kill buffer. | |
cce855bc | 5588 | The word boundaries are the same as \fBforward\-word\fP. |
726f6388 JA |
5589 | .TP |
5590 | .B yank (C\-y) | |
28ef6c31 | 5591 | Yank the top of the kill ring into the buffer at point. |
726f6388 JA |
5592 | .TP |
5593 | .B yank\-pop (M\-y) | |
ccc6cda3 | 5594 | Rotate the kill ring, and yank the new top. Only works following |
726f6388 JA |
5595 | .B yank |
5596 | or | |
5597 | .BR yank\-pop . | |
5598 | .PD | |
5599 | .SS Numeric Arguments | |
5600 | .PP | |
5601 | .PD 0 | |
5602 | .TP | |
5603 | .B digit\-argument (M\-0, M\-1, ..., M\-\-) | |
5604 | Add this digit to the argument already accumulating, or start a new | |
5605 | argument. M\-\- starts a negative argument. | |
5606 | .TP | |
5607 | .B universal\-argument | |
d166f048 JA |
5608 | This is another way to specify an argument. |
5609 | If this command is followed by one or more digits, optionally with a | |
5610 | leading minus sign, those digits define the argument. | |
5611 | If the command is followed by digits, executing | |
5612 | .B universal\-argument | |
5613 | again ends the numeric argument, but is otherwise ignored. | |
5614 | As a special case, if this command is immediately followed by a | |
5615 | character that is neither a digit or minus sign, the argument count | |
5616 | for the next command is multiplied by four. | |
726f6388 | 5617 | The argument count is initially one, so executing this function the |
d166f048 JA |
5618 | first time makes the argument count four, a second time makes the |
5619 | argument count sixteen, and so on. | |
726f6388 JA |
5620 | .PD |
5621 | .SS Completing | |
5622 | .PP | |
5623 | .PD 0 | |
5624 | .TP | |
5625 | .B complete (TAB) | |
5626 | Attempt to perform completion on the text before point. | |
5627 | .B Bash | |
5628 | attempts completion treating the text as a variable (if the | |
5629 | text begins with \fB$\fP), username (if the text begins with | |
5630 | \fB~\fP), hostname (if the text begins with \fB@\fP), or | |
5631 | command (including aliases and functions) in turn. If none | |
5632 | of these produces a match, filename completion is attempted. | |
5633 | .TP | |
ccc6cda3 | 5634 | .B possible\-completions (M\-?) |
726f6388 JA |
5635 | List the possible completions of the text before point. |
5636 | .TP | |
ccc6cda3 | 5637 | .B insert\-completions (M\-*) |
726f6388 JA |
5638 | Insert all completions of the text before point |
5639 | that would have been generated by | |
ccc6cda3 | 5640 | \fBpossible\-completions\fP. |
726f6388 | 5641 | .TP |
cce855bc JA |
5642 | .B menu\-complete |
5643 | Similar to \fBcomplete\fP, but replaces the word to be completed | |
5644 | with a single match from the list of possible completions. | |
5645 | Repeated execution of \fBmenu\-complete\fP steps through the list | |
5646 | of possible completions, inserting each match in turn. | |
28ef6c31 | 5647 | At the end of the list of completions, the bell is rung |
f73dda09 | 5648 | (subject to the setting of \fBbell\-style\fP) |
28ef6c31 | 5649 | and the original text is restored. |
cce855bc JA |
5650 | An argument of \fIn\fP moves \fIn\fP positions forward in the list |
5651 | of matches; a negative argument may be used to move backward | |
5652 | through the list. | |
5653 | This command is intended to be bound to \fBTAB\fP, but is unbound | |
5654 | by default. | |
5655 | .TP | |
0001803f CR |
5656 | .B menu\-complete-\backward |
5657 | Identical to \fBmenu\-complete\fP, but moves backward through the list | |
5658 | of possible completions, as if \fBmenu\-complete\fP had been given a | |
5659 | negative argument. This command is unbound by default. | |
5660 | .TP | |
b72432fd JA |
5661 | .B delete\-char\-or\-list |
5662 | Deletes the character under the cursor if not at the beginning or | |
bb70624e | 5663 | end of the line (like \fBdelete\-char\fP). |
b72432fd | 5664 | If at the end of the line, behaves identically to |
bb70624e | 5665 | \fBpossible\-completions\fP. |
b72432fd JA |
5666 | This command is unbound by default. |
5667 | .TP | |
726f6388 JA |
5668 | .B complete\-filename (M\-/) |
5669 | Attempt filename completion on the text before point. | |
5670 | .TP | |
5671 | .B possible\-filename\-completions (C\-x /) | |
5672 | List the possible completions of the text before point, | |
5673 | treating it as a filename. | |
5674 | .TP | |
5675 | .B complete\-username (M\-~) | |
5676 | Attempt completion on the text before point, treating | |
5677 | it as a username. | |
5678 | .TP | |
5679 | .B possible\-username\-completions (C\-x ~) | |
5680 | List the possible completions of the text before point, | |
5681 | treating it as a username. | |
5682 | .TP | |
5683 | .B complete\-variable (M\-$) | |
5684 | Attempt completion on the text before point, treating | |
5685 | it as a shell variable. | |
5686 | .TP | |
5687 | .B possible\-variable\-completions (C\-x $) | |
5688 | List the possible completions of the text before point, | |
5689 | treating it as a shell variable. | |
5690 | .TP | |
5691 | .B complete\-hostname (M\-@) | |
5692 | Attempt completion on the text before point, treating | |
5693 | it as a hostname. | |
5694 | .TP | |
5695 | .B possible\-hostname\-completions (C\-x @) | |
5696 | List the possible completions of the text before point, | |
5697 | treating it as a hostname. | |
5698 | .TP | |
5699 | .B complete\-command (M\-!) | |
5700 | Attempt completion on the text before point, treating | |
5701 | it as a command name. Command completion attempts to | |
5702 | match the text against aliases, reserved words, shell | |
cce855bc | 5703 | functions, shell builtins, and finally executable filenames, |
726f6388 JA |
5704 | in that order. |
5705 | .TP | |
5706 | .B possible\-command\-completions (C\-x !) | |
5707 | List the possible completions of the text before point, | |
5708 | treating it as a command name. | |
5709 | .TP | |
ccc6cda3 | 5710 | .B dynamic\-complete\-history (M\-TAB) |
726f6388 JA |
5711 | Attempt completion on the text before point, comparing |
5712 | the text against lines from the history list for possible | |
5713 | completion matches. | |
5714 | .TP | |
3185942a JA |
5715 | .B dabbrev\-expand |
5716 | Attempt menu completion on the text before point, comparing | |
5717 | the text against lines from the history list for possible | |
5718 | completion matches. | |
5719 | .TP | |
726f6388 | 5720 | .B complete\-into\-braces (M\-{) |
bb70624e | 5721 | Perform filename completion and insert the list of possible completions |
726f6388 JA |
5722 | enclosed within braces so the list is available to the shell (see |
5723 | .B Brace Expansion | |
5724 | above). | |
5725 | .PD | |
5726 | .SS Keyboard Macros | |
5727 | .PP | |
5728 | .PD 0 | |
5729 | .TP | |
ccc6cda3 | 5730 | .B start\-kbd\-macro (C\-x (\^) |
726f6388 JA |
5731 | Begin saving the characters typed into the current keyboard macro. |
5732 | .TP | |
ccc6cda3 | 5733 | .B end\-kbd\-macro (C\-x )\^) |
726f6388 | 5734 | Stop saving the characters typed into the current keyboard macro |
ccc6cda3 | 5735 | and store the definition. |
726f6388 | 5736 | .TP |
ccc6cda3 | 5737 | .B call\-last\-kbd\-macro (C\-x e) |
726f6388 JA |
5738 | Re-execute the last keyboard macro defined, by making the characters |
5739 | in the macro appear as if typed at the keyboard. | |
5740 | .PD | |
5741 | .SS Miscellaneous | |
5742 | .PP | |
5743 | .PD 0 | |
5744 | .TP | |
5745 | .B re\-read\-init\-file (C\-x C\-r) | |
ccc6cda3 | 5746 | Read in the contents of the \fIinputrc\fP file, and incorporate |
726f6388 JA |
5747 | any bindings or variable assignments found there. |
5748 | .TP | |
5749 | .B abort (C\-g) | |
5750 | Abort the current editing command and | |
5751 | ring the terminal's bell (subject to the setting of | |
5752 | .BR bell\-style ). | |
5753 | .TP | |
ccc6cda3 JA |
5754 | .B do\-uppercase\-version (M\-a, M\-b, M\-\fIx\fP, ...) |
5755 | If the metafied character \fIx\fP is lowercase, run the command | |
5756 | that is bound to the corresponding uppercase character. | |
726f6388 JA |
5757 | .TP |
5758 | .B prefix\-meta (ESC) | |
5759 | Metafy the next character typed. | |
5760 | .SM | |
5761 | .B ESC | |
5762 | .B f | |
5763 | is equivalent to | |
5764 | .BR Meta\-f . | |
5765 | .TP | |
5766 | .B undo (C\-_, C\-x C\-u) | |
5767 | Incremental undo, separately remembered for each line. | |
5768 | .TP | |
5769 | .B revert\-line (M\-r) | |
cce855bc | 5770 | Undo all changes made to this line. This is like executing the |
726f6388 JA |
5771 | .B undo |
5772 | command enough times to return the line to its initial state. | |
5773 | .TP | |
b72432fd | 5774 | .B tilde\-expand (M\-&) |
726f6388 JA |
5775 | Perform tilde expansion on the current word. |
5776 | .TP | |
ccc6cda3 | 5777 | .B set\-mark (C\-@, M\-<space>) |
28ef6c31 | 5778 | Set the mark to the point. If a |
ccc6cda3 JA |
5779 | numeric argument is supplied, the mark is set to that position. |
5780 | .TP | |
5781 | .B exchange\-point\-and\-mark (C\-x C\-x) | |
5782 | Swap the point with the mark. The current cursor position is set to | |
5783 | the saved position, and the old cursor position is saved as the mark. | |
5784 | .TP | |
5785 | .B character\-search (C\-]) | |
5786 | A character is read and point is moved to the next occurrence of that | |
5787 | character. A negative count searches for previous occurrences. | |
5788 | .TP | |
5789 | .B character\-search\-backward (M\-C\-]) | |
5790 | A character is read and point is moved to the previous occurrence of that | |
5791 | character. A negative count searches for subsequent occurrences. | |
5792 | .TP | |
0001803f CR |
5793 | .B skip\-csi\-sequence () |
5794 | Read enough characters to consume a multi-key sequence such as those | |
5795 | defined for keys like Home and End. Such sequences begin with a | |
5796 | Control Sequence Indicator (CSI), usually ESC\-[. If this sequence is | |
5797 | bound to "\e[", keys producing such sequences will have no effect | |
5798 | unless explicitly bound to a readline command, instead of inserting | |
5799 | stray characters into the editing buffer. This is unbound by default, | |
5800 | but usually bound to ESC\-[. | |
5801 | .TP | |
ccc6cda3 | 5802 | .B insert\-comment (M\-#) |
7117c2d2 | 5803 | Without a numeric argument, the value of the readline |
ccc6cda3 | 5804 | .B comment\-begin |
7117c2d2 JA |
5805 | variable is inserted at the beginning of the current line. |
5806 | If a numeric argument is supplied, this command acts as a toggle: if | |
5807 | the characters at the beginning of the line do not match the value | |
5808 | of \fBcomment\-begin\fP, the value is inserted, otherwise | |
17345e5a | 5809 | the characters in \fBcomment\-begin\fP are deleted from the beginning of |
7117c2d2 JA |
5810 | the line. |
5811 | In either case, the line is accepted as if a newline had been typed. | |
5812 | The default value of | |
bb70624e | 5813 | \fBcomment\-begin\fP causes this command to make the current line |
ccc6cda3 | 5814 | a shell comment. |
7117c2d2 JA |
5815 | If a numeric argument causes the comment character to be removed, the line |
5816 | will be executed by the shell. | |
5817 | .TP | |
5818 | .B glob\-complete\-word (M\-g) | |
5819 | The word before point is treated as a pattern for pathname expansion, | |
5820 | with an asterisk implicitly appended. This pattern is used to | |
5821 | generate a list of matching file names for possible completions. | |
ccc6cda3 JA |
5822 | .TP |
5823 | .B glob\-expand\-word (C\-x *) | |
5824 | The word before point is treated as a pattern for pathname expansion, | |
5825 | and the list of matching file names is inserted, replacing the word. | |
7117c2d2 JA |
5826 | If a numeric argument is supplied, an asterisk is appended before |
5827 | pathname expansion. | |
ccc6cda3 JA |
5828 | .TP |
5829 | .B glob\-list\-expansions (C\-x g) | |
5830 | The list of expansions that would have been generated by | |
5831 | .B glob\-expand\-word | |
5832 | is displayed, and the line is redrawn. | |
7117c2d2 JA |
5833 | If a numeric argument is supplied, an asterisk is appended before |
5834 | pathname expansion. | |
ccc6cda3 | 5835 | .TP |
726f6388 JA |
5836 | .B dump\-functions |
5837 | Print all of the functions and their key bindings to the | |
5838 | readline output stream. If a numeric argument is supplied, | |
5839 | the output is formatted in such a way that it can be made part | |
5840 | of an \fIinputrc\fP file. | |
5841 | .TP | |
ccc6cda3 JA |
5842 | .B dump\-variables |
5843 | Print all of the settable readline variables and their values to the | |
5844 | readline output stream. If a numeric argument is supplied, | |
5845 | the output is formatted in such a way that it can be made part | |
5846 | of an \fIinputrc\fP file. | |
5847 | .TP | |
5848 | .B dump\-macros | |
5849 | Print all of the readline key sequences bound to macros and the | |
95732b49 | 5850 | strings they output. If a numeric argument is supplied, |
ccc6cda3 JA |
5851 | the output is formatted in such a way that it can be made part |
5852 | of an \fIinputrc\fP file. | |
5853 | .TP | |
726f6388 JA |
5854 | .B display\-shell\-version (C\-x C\-v) |
5855 | Display version information about the current instance of | |
5856 | .BR bash . | |
5857 | .PD | |
bb70624e JA |
5858 | .SS Programmable Completion |
5859 | .PP | |
5860 | When word completion is attempted for an argument to a command for | |
5861 | which a completion specification (a \fIcompspec\fP) has been defined | |
5862 | using the \fBcomplete\fP builtin (see | |
5863 | .SM | |
5864 | .B "SHELL BUILTIN COMMANDS" | |
5865 | below), the programmable completion facilities are invoked. | |
5866 | .PP | |
5867 | First, the command name is identified. | |
0001803f CR |
5868 | If the command word is the empty string (completion attempted at the |
5869 | beginning of an empty line), any compspec defined with | |
5870 | the \fB\-E\fP option to \fBcomplete\fP is used. | |
bb70624e JA |
5871 | If a compspec has been defined for that command, the |
5872 | compspec is used to generate the list of possible completions for the word. | |
5873 | If the command word is a full pathname, a compspec for the full | |
5874 | pathname is searched for first. | |
5875 | If no compspec is found for the full pathname, an attempt is made to | |
5876 | find a compspec for the portion following the final slash. | |
0001803f CR |
5877 | If those searches to not result in a compspec, any compspec defined with |
5878 | the \fB\-D\fP option to \fBcomplete\fP is used as the default. | |
bb70624e JA |
5879 | .PP |
5880 | Once a compspec has been found, it is used to generate the list of | |
5881 | matching words. | |
5882 | If a compspec is not found, the default \fBbash\fP completion as | |
5883 | described above under \fBCompleting\fP is performed. | |
5884 | .PP | |
5885 | First, the actions specified by the compspec are used. | |
5886 | Only matches which are prefixed by the word being completed are | |
5887 | returned. | |
5888 | When the | |
5889 | .B \-f | |
5890 | or | |
5891 | .B \-d | |
5892 | option is used for filename or directory name completion, the shell | |
5893 | variable | |
5894 | .SM | |
5895 | .B FIGNORE | |
5896 | is used to filter the matches. | |
5897 | .PP | |
0001803f | 5898 | Any completions specified by a pathname expansion pattern to the |
bb70624e JA |
5899 | \fB\-G\fP option are generated next. |
5900 | The words generated by the pattern need not match the word | |
5901 | being completed. | |
5902 | The | |
5903 | .SM | |
5904 | .B GLOBIGNORE | |
5905 | shell variable is not used to filter the matches, but the | |
5906 | .SM | |
5907 | .B FIGNORE | |
5908 | variable is used. | |
5909 | .PP | |
5910 | Next, the string specified as the argument to the \fB\-W\fP option | |
5911 | is considered. | |
5912 | The string is first split using the characters in the | |
5913 | .SM | |
5914 | .B IFS | |
5915 | special variable as delimiters. | |
5916 | Shell quoting is honored. | |
5917 | Each word is then expanded using | |
5918 | brace expansion, tilde expansion, parameter and variable expansion, | |
95732b49 | 5919 | command substitution, and arithmetic expansion, |
bb70624e JA |
5920 | as described above under |
5921 | .SM | |
5922 | .BR EXPANSION . | |
5923 | The results are split using the rules described above under | |
5924 | \fBWord Splitting\fP. | |
5925 | The results of the expansion are prefix-matched against the word being | |
5926 | completed, and the matching words become the possible completions. | |
5927 | .PP | |
5928 | After these matches have been generated, any shell function or command | |
5929 | specified with the \fB\-F\fP and \fB\-C\fP options is invoked. | |
5930 | When the command or function is invoked, the | |
5931 | .SM | |
3185942a JA |
5932 | .BR COMP_LINE , |
5933 | .SM | |
5934 | .BR COMP_POINT , | |
5935 | .SM | |
5936 | .BR COMP_KEY , | |
bb70624e JA |
5937 | and |
5938 | .SM | |
3185942a | 5939 | .B COMP_TYPE |
bb70624e JA |
5940 | variables are assigned values as described above under |
5941 | \fBShell Variables\fP. | |
5942 | If a shell function is being invoked, the | |
5943 | .SM | |
5944 | .B COMP_WORDS | |
5945 | and | |
5946 | .SM | |
5947 | .B COMP_CWORD | |
5948 | variables are also set. | |
5949 | When the function or command is invoked, the first argument is the | |
5950 | name of the command whose arguments are being completed, the | |
5951 | second argument is the word being completed, and the third argument | |
5952 | is the word preceding the word being completed on the current command line. | |
5953 | No filtering of the generated completions against the word being completed | |
5954 | is performed; the function or command has complete freedom in generating | |
5955 | the matches. | |
5956 | .PP | |
5957 | Any function specified with \fB\-F\fP is invoked first. | |
5958 | The function may use any of the shell facilities, including the | |
5959 | \fBcompgen\fP builtin described below, to generate the matches. | |
5960 | It must put the possible completions in the | |
5961 | .SM | |
5962 | .B COMPREPLY | |
5963 | array variable. | |
5964 | .PP | |
5965 | Next, any command specified with the \fB\-C\fP option is invoked | |
5966 | in an environment equivalent to command substitution. | |
5967 | It should print a list of completions, one per line, to the | |
5968 | standard output. | |
5969 | Backslash may be used to escape a newline, if necessary. | |
5970 | .PP | |
5971 | After all of the possible completions are generated, any filter | |
5972 | specified with the \fB\-X\fP option is applied to the list. | |
5973 | The filter is a pattern as used for pathname expansion; a \fB&\fP | |
5974 | in the pattern is replaced with the text of the word being completed. | |
5975 | A literal \fB&\fP may be escaped with a backslash; the backslash | |
5976 | is removed before attempting a match. | |
5977 | Any completion that matches the pattern will be removed from the list. | |
5978 | A leading \fB!\fP negates the pattern; in this case any completion | |
5979 | not matching the pattern will be removed. | |
5980 | .PP | |
5981 | Finally, any prefix and suffix specified with the \fB\-P\fP and \fB\-S\fP | |
5982 | options are added to each member of the completion list, and the result is | |
5983 | returned to the readline completion code as the list of possible | |
5984 | completions. | |
5985 | .PP | |
28ef6c31 JA |
5986 | If the previously-applied actions do not generate any matches, and the |
5987 | \fB\-o dirnames\fP option was supplied to \fBcomplete\fP when the | |
5988 | compspec was defined, directory name completion is attempted. | |
5989 | .PP | |
b80f6443 JA |
5990 | If the \fB\-o plusdirs\fP option was supplied to \fBcomplete\fP when the |
5991 | compspec was defined, directory name completion is attempted and any | |
5992 | matches are added to the results of the other actions. | |
5993 | .PP | |
28ef6c31 JA |
5994 | By default, if a compspec is found, whatever it generates is returned |
5995 | to the completion code as the full set of possible completions. | |
bb70624e JA |
5996 | The default \fBbash\fP completions are not attempted, and the readline |
5997 | default of filename completion is disabled. | |
b80f6443 JA |
5998 | If the \fB\-o bashdefault\fP option was supplied to \fBcomplete\fP when |
5999 | the compspec was defined, the \fBbash\fP default completions are attempted | |
28ef6c31 | 6000 | if the compspec generates no matches. |
b80f6443 JA |
6001 | If the \fB\-o default\fP option was supplied to \fBcomplete\fP when the |
6002 | compspec was defined, readline's default completion will be performed | |
6003 | if the compspec (and, if attempted, the default \fBbash\fP completions) | |
6004 | generate no matches. | |
7117c2d2 JA |
6005 | .PP |
6006 | When a compspec indicates that directory name completion is desired, | |
6007 | the programmable completion functions force readline to append a slash | |
6008 | to completed names which are symbolic links to directories, subject to | |
6009 | the value of the \fBmark\-directories\fP readline variable, regardless | |
6010 | of the setting of the \fBmark-symlinked\-directories\fP readline variable. | |
0001803f CR |
6011 | .PP |
6012 | There is some support for dynamically modifying completions. This is | |
6013 | most useful when used in combination with a default completion specified | |
6014 | with \fBcomplete -D\fP. | |
6015 | It's possible for shell functions executed as completion | |
6016 | handlers to indicate that completion should be retried by returning an | |
6017 | exit status of 124. If a shell function returns 124, and changes | |
6018 | the compspec associated with the command on which completion is being | |
6019 | attempted (supplied as the first argument when the function is executed), | |
6020 | programmable completion restarts from the beginning, with an | |
6021 | attempt to find a compspec for that command. This allows a set of | |
6022 | completions to be built dynamically as completion is attempted, rather than | |
6023 | being loaded all at once. | |
6024 | .PP | |
6025 | For instance, assuming that there is a library of compspecs, each kept in a | |
6026 | file corresponding to the name of the command, the following default | |
6027 | completion function would load completions dynamically: | |
6028 | .PP | |
6029 | \f(CW_completion_loader() | |
6030 | .br | |
6031 | { | |
6032 | .br | |
6033 | . "/etc/bash_completion.d/$1.sh" >/dev/null 2>&1 && return 124 | |
6034 | .br | |
6035 | } | |
6036 | .br | |
6037 | complete -D -F _completion_loader | |
6038 | .br | |
6039 | \fP | |
726f6388 | 6040 | .SH HISTORY |
ccc6cda3 | 6041 | When the |
d166f048 | 6042 | .B \-o history |
ccc6cda3 JA |
6043 | option to the |
6044 | .B set | |
6045 | builtin is enabled, the shell provides access to the | |
6046 | \fIcommand history\fP, | |
bb70624e | 6047 | the list of commands previously typed. |
0001803f CR |
6048 | The value of the |
6049 | .SM | |
6050 | .B HISTSIZE | |
6051 | variable is used as the | |
bb70624e JA |
6052 | number of commands to save in a history list. |
6053 | The text of the last | |
726f6388 JA |
6054 | .SM |
6055 | .B HISTSIZE | |
bb70624e | 6056 | commands (default 500) is saved. The shell |
726f6388 JA |
6057 | stores each command in the history list prior to parameter and |
6058 | variable expansion (see | |
6059 | .SM | |
6060 | .B EXPANSION | |
6061 | above) but after history expansion is performed, subject to the | |
6062 | values of the shell variables | |
ccc6cda3 JA |
6063 | .SM |
6064 | .B HISTIGNORE | |
726f6388 JA |
6065 | and |
6066 | .SM | |
6067 | .BR HISTCONTROL . | |
bb70624e | 6068 | .PP |
726f6388 JA |
6069 | On startup, the history is initialized from the file named by |
6070 | the variable | |
6071 | .SM | |
6072 | .B HISTFILE | |
6073 | (default \fI~/.bash_history\fP). | |
bb70624e | 6074 | The file named by the value of |
726f6388 JA |
6075 | .SM |
6076 | .B HISTFILE | |
6077 | is truncated, if necessary, to contain no more than | |
bb70624e | 6078 | the number of lines specified by the value of |
726f6388 | 6079 | .SM |
bb70624e | 6080 | .BR HISTFILESIZE . |
3185942a JA |
6081 | When the history file is read, |
6082 | lines beginning with the history comment character followed immediately | |
6083 | by a digit are interpreted as timestamps for the preceding history line. | |
6084 | These timestamps are optionally displayed depending on the value of the | |
6085 | .SM | |
6086 | .B HISTTIMEFORMAT | |
6087 | variable. | |
ccc6cda3 JA |
6088 | When an interactive shell exits, the last |
6089 | .SM | |
bb70624e | 6090 | .B $HISTSIZE |
ccc6cda3 JA |
6091 | lines are copied from the history list to |
6092 | .SM | |
bb70624e | 6093 | .BR $HISTFILE . |
ccc6cda3 JA |
6094 | If the |
6095 | .B histappend | |
6096 | shell option is enabled | |
6097 | (see the description of | |
6098 | .B shopt | |
6099 | under | |
6100 | .SM | |
6101 | .B "SHELL BUILTIN COMMANDS" | |
6102 | below), the lines are appended to the history file, | |
6103 | otherwise the history file is overwritten. | |
6104 | If | |
6105 | .SM | |
6106 | .B HISTFILE | |
6107 | is unset, or if the history file is unwritable, the history is | |
3185942a JA |
6108 | not saved. |
6109 | If the | |
6110 | .SM | |
0001803f | 6111 | .B HISTTIMEFORMAT |
3185942a JA |
6112 | variable is set, time stamps are written to the history file, marked |
6113 | with the history comment character, so | |
6114 | they may be preserved across shell sessions. | |
6115 | This uses the history comment character to distinguish timestamps from | |
6116 | other history lines. | |
6117 | After saving the history, the history file is truncated | |
ccc6cda3 JA |
6118 | to contain no more than |
6119 | .SM | |
6120 | .B HISTFILESIZE | |
6121 | lines. If | |
6122 | .SM | |
6123 | .B HISTFILESIZE | |
6124 | is not set, no truncation is performed. | |
6125 | .PP | |
726f6388 JA |
6126 | The builtin command |
6127 | .B fc | |
6128 | (see | |
6129 | .SM | |
6130 | .B SHELL BUILTIN COMMANDS | |
6131 | below) may be used to list or edit and re-execute a portion of | |
6132 | the history list. | |
6133 | The | |
6134 | .B history | |
bb70624e | 6135 | builtin may be used to display or modify the history list and |
ccc6cda3 | 6136 | manipulate the history file. |
bb70624e | 6137 | When using command-line editing, search commands |
726f6388 | 6138 | are available in each editing mode that provide access to the |
ccc6cda3 JA |
6139 | history list. |
6140 | .PP | |
6141 | The shell allows control over which commands are saved on the history | |
6142 | list. The | |
726f6388 | 6143 | .SM |
ccc6cda3 JA |
6144 | .B HISTCONTROL |
6145 | and | |
726f6388 | 6146 | .SM |
ccc6cda3 JA |
6147 | .B HISTIGNORE |
6148 | variables may be set to cause the shell to save only a subset of the | |
6149 | commands entered. | |
6150 | The | |
6151 | .B cmdhist | |
6152 | shell option, if enabled, causes the shell to attempt to save each | |
6153 | line of a multi-line command in the same history entry, adding | |
6154 | semicolons where necessary to preserve syntactic correctness. | |
6155 | The | |
6156 | .B lithist | |
6157 | shell option causes the shell to save the command with embedded newlines | |
6158 | instead of semicolons. See the description of the | |
6159 | .B shopt | |
6160 | builtin below under | |
6161 | .SM | |
6162 | .B "SHELL BUILTIN COMMANDS" | |
6163 | for information on setting and unsetting shell options. | |
726f6388 JA |
6164 | .SH "HISTORY EXPANSION" |
6165 | .PP | |
6166 | The shell supports a history expansion feature that | |
6167 | is similar to the history expansion in | |
6168 | .BR csh. | |
6169 | This section describes what syntax features are available. This | |
6170 | feature is enabled by default for interactive shells, and can be | |
6171 | disabled using the | |
6172 | .B \+H | |
6173 | option to the | |
6174 | .B set | |
6175 | builtin command (see | |
6176 | .SM | |
6177 | .B SHELL BUILTIN COMMANDS | |
ccc6cda3 JA |
6178 | below). Non-interactive shells do not perform history expansion |
6179 | by default. | |
6180 | .PP | |
6181 | History expansions introduce words from the history list into | |
6182 | the input stream, making it easy to repeat commands, insert the | |
6183 | arguments to a previous command into the current input line, or | |
6184 | fix errors in previous commands quickly. | |
726f6388 JA |
6185 | .PP |
6186 | History expansion is performed immediately after a complete line | |
6187 | is read, before the shell breaks it into words. | |
ccc6cda3 | 6188 | It takes place in two parts. |
cce855bc | 6189 | The first is to determine which line from the history list |
ccc6cda3 JA |
6190 | to use during substitution. |
6191 | The second is to select portions of that line for inclusion into | |
6192 | the current one. | |
cce855bc | 6193 | The line selected from the history is the \fIevent\fP, |
ccc6cda3 JA |
6194 | and the portions of that line that are acted upon are \fIwords\fP. |
6195 | Various \fImodifiers\fP are available to manipulate the selected words. | |
6196 | The line is broken into words in the same fashion as when reading input, | |
6197 | so that several \fImetacharacter\fP-separated words surrounded by | |
cce855bc | 6198 | quotes are considered one word. |
ccc6cda3 JA |
6199 | History expansions are introduced by the appearance of the |
6200 | history expansion character, which is \^\fB!\fP\^ by default. | |
6201 | Only backslash (\^\fB\e\fP\^) and single quotes can quote | |
6202 | the history expansion character. | |
6203 | .PP | |
b80f6443 JA |
6204 | Several characters inhibit history expansion if found immediately |
6205 | following the history expansion character, even if it is unquoted: | |
6206 | space, tab, newline, carriage return, and \fB=\fP. | |
6207 | If the \fBextglob\fP shell option is enabled, \fB(\fP will also | |
6208 | inhibit expansion. | |
6209 | .PP | |
ccc6cda3 JA |
6210 | Several shell options settable with the |
6211 | .B shopt | |
6212 | builtin may be used to tailor the behavior of history expansion. | |
6213 | If the | |
6214 | .B histverify | |
6215 | shell option is enabled (see the description of the | |
6216 | .B shopt | |
0001803f | 6217 | builtin below), and |
ccc6cda3 JA |
6218 | .B readline |
6219 | is being used, history substitutions are not immediately passed to | |
6220 | the shell parser. | |
6221 | Instead, the expanded line is reloaded into the | |
6222 | .B readline | |
6223 | editing buffer for further modification. | |
6224 | If | |
6225 | .B readline | |
6226 | is being used, and the | |
6227 | .B histreedit | |
6228 | shell option is enabled, a failed history substitution will be reloaded | |
6229 | into the | |
6230 | .B readline | |
6231 | editing buffer for correction. | |
6232 | The | |
6233 | .B \-p | |
6234 | option to the | |
6235 | .B history | |
6236 | builtin command may be used to see what a history expansion will | |
6237 | do before using it. | |
6238 | The | |
6239 | .B \-s | |
6240 | option to the | |
6241 | .B history | |
6242 | builtin may be used to add commands to the end of the history list | |
6243 | without actually executing them, so that they are available for | |
6244 | subsequent recall. | |
726f6388 JA |
6245 | .PP |
6246 | The shell allows control of the various characters used by the | |
6247 | history expansion mechanism (see the description of | |
6248 | .B histchars | |
6249 | above under | |
6250 | .BR "Shell Variables" ). | |
3185942a JA |
6251 | The shell uses |
6252 | the history comment character to mark history timestamps when | |
6253 | writing the history file. | |
726f6388 JA |
6254 | .SS Event Designators |
6255 | .PP | |
6256 | An event designator is a reference to a command line entry in the | |
6257 | history list. | |
6258 | .PP | |
6259 | .PD 0 | |
6260 | .TP | |
6261 | .B ! | |
6262 | Start a history substitution, except when followed by a | |
6263 | .BR blank , | |
b80f6443 JA |
6264 | newline, carriage return, = |
6265 | or ( (when the \fBextglob\fP shell option is enabled using | |
6266 | the \fBshopt\fP builtin). | |
726f6388 | 6267 | .TP |
726f6388 JA |
6268 | .B !\fIn\fR |
6269 | Refer to command line | |
6270 | .IR n . | |
6271 | .TP | |
6272 | .B !\-\fIn\fR | |
6273 | Refer to the current command line minus | |
6274 | .IR n . | |
6275 | .TP | |
ccc6cda3 JA |
6276 | .B !! |
6277 | Refer to the previous command. This is a synonym for `!\-1'. | |
6278 | .TP | |
726f6388 JA |
6279 | .B !\fIstring\fR |
6280 | Refer to the most recent command starting with | |
6281 | .IR string . | |
6282 | .TP | |
6283 | .B !?\fIstring\fR\fB[?]\fR | |
6284 | Refer to the most recent command containing | |
6285 | .IR string . | |
ccc6cda3 JA |
6286 | The trailing \fB?\fP may be omitted if |
6287 | .I string | |
6288 | is followed immediately by a newline. | |
726f6388 JA |
6289 | .TP |
6290 | .B \d\s+2^\s-2\u\fIstring1\fP\d\s+2^\s-2\u\fIstring2\fP\d\s+2^\s-2\u | |
6291 | Quick substitution. Repeat the last command, replacing | |
6292 | .I string1 | |
6293 | with | |
6294 | .IR string2 . | |
6295 | Equivalent to | |
6296 | ``!!:s/\fIstring1\fP/\fIstring2\fP/'' | |
6297 | (see \fBModifiers\fP below). | |
6298 | .TP | |
6299 | .B !# | |
6300 | The entire command line typed so far. | |
6301 | .PD | |
6302 | .SS Word Designators | |
6303 | .PP | |
ccc6cda3 | 6304 | Word designators are used to select desired words from the event. |
726f6388 JA |
6305 | A |
6306 | .B : | |
ccc6cda3 | 6307 | separates the event specification from the word designator. |
cce855bc | 6308 | It may be omitted if the word designator begins with a |
726f6388 JA |
6309 | .BR ^ , |
6310 | .BR $ , | |
6311 | .BR * , | |
ccc6cda3 | 6312 | .BR \- , |
726f6388 JA |
6313 | or |
6314 | .BR % . | |
6315 | Words are numbered from the beginning of the line, | |
ccc6cda3 JA |
6316 | with the first word being denoted by 0 (zero). |
6317 | Words are inserted into the current line separated by single spaces. | |
726f6388 JA |
6318 | .PP |
6319 | .PD 0 | |
6320 | .TP | |
6321 | .B 0 (zero) | |
6322 | The zeroth word. For the shell, this is the command | |
6323 | word. | |
6324 | .TP | |
6325 | .I n | |
6326 | The \fIn\fRth word. | |
6327 | .TP | |
6328 | .B ^ | |
6329 | The first argument. That is, word 1. | |
6330 | .TP | |
6331 | .B $ | |
6332 | The last argument. | |
6333 | .TP | |
6334 | .B % | |
6335 | The word matched by the most recent `?\fIstring\fR?' search. | |
6336 | .TP | |
6337 | .I x\fB\-\fPy | |
6338 | A range of words; `\-\fIy\fR' abbreviates `0\-\fIy\fR'. | |
6339 | .TP | |
6340 | .B * | |
6341 | All of the words but the zeroth. This is a synonym | |
6342 | for `\fI1\-$\fP'. It is not an error to use | |
6343 | .B * | |
6344 | if there is just one | |
6345 | word in the event; the empty string is returned in that case. | |
6346 | .TP | |
6347 | .B x* | |
6348 | Abbreviates \fIx\-$\fP. | |
6349 | .TP | |
6350 | .B x\- | |
6351 | Abbreviates \fIx\-$\fP like \fBx*\fP, but omits the last word. | |
6352 | .PD | |
ccc6cda3 JA |
6353 | .PP |
6354 | If a word designator is supplied without an event specification, the | |
6355 | previous command is used as the event. | |
726f6388 JA |
6356 | .SS Modifiers |
6357 | .PP | |
ccc6cda3 JA |
6358 | After the optional word designator, there may appear a sequence of |
6359 | one or more of the following modifiers, each preceded by a `:'. | |
726f6388 JA |
6360 | .PP |
6361 | .PD 0 | |
6362 | .PP | |
6363 | .TP | |
6364 | .B h | |
ccc6cda3 JA |
6365 | Remove a trailing file name component, leaving only the head. |
6366 | .TP | |
6367 | .B t | |
6368 | Remove all leading file name components, leaving the tail. | |
726f6388 JA |
6369 | .TP |
6370 | .B r | |
6371 | Remove a trailing suffix of the form \fI.xxx\fP, leaving the | |
6372 | basename. | |
6373 | .TP | |
6374 | .B e | |
6375 | Remove all but the trailing suffix. | |
6376 | .TP | |
726f6388 JA |
6377 | .B p |
6378 | Print the new command but do not execute it. | |
6379 | .TP | |
6380 | .B q | |
6381 | Quote the substituted words, escaping further substitutions. | |
6382 | .TP | |
cce855bc JA |
6383 | .B x |
6384 | Quote the substituted words as with | |
6385 | .BR q , | |
6386 | but break into words at | |
6387 | .B blanks | |
6388 | and newlines. | |
726f6388 | 6389 | .TP |
cce855bc JA |
6390 | .B s/\fIold\fP/\fInew\fP/ |
6391 | Substitute | |
6392 | .I new | |
6393 | for the first occurrence of | |
6394 | .I old | |
6395 | in the event line. Any delimiter can be used in place of /. The | |
6396 | final delimiter is optional if it is the last character of the | |
6397 | event line. The delimiter may be quoted in | |
6398 | .I old | |
6399 | and | |
6400 | .I new | |
6401 | with a single backslash. If & appears in | |
6402 | .IR new , | |
6403 | it is replaced by | |
6404 | .IR old . | |
6405 | A single backslash will quote the &. If | |
6406 | .I old | |
6407 | is null, it is set to the last | |
6408 | .I old | |
6409 | substituted, or, if no previous history substitutions took place, | |
6410 | the last | |
6411 | .I string | |
6412 | in a | |
6413 | .B !?\fIstring\fR\fB[?]\fR | |
6414 | search. | |
ccc6cda3 | 6415 | .TP |
cce855bc JA |
6416 | .B & |
6417 | Repeat the previous substitution. | |
6418 | .TP | |
6419 | .B g | |
6420 | Cause changes to be applied over the entire event line. This is | |
6421 | used in conjunction with `\fB:s\fP' (e.g., `\fB:gs/\fIold\fP/\fInew\fP/\fR') | |
6422 | or `\fB:&\fP'. If used with | |
6423 | `\fB:s\fP', any delimiter can be used | |
6424 | in place of /, and the final delimiter is optional | |
6425 | if it is the last character of the event line. | |
b80f6443 JA |
6426 | An \fBa\fP may be used as a synonym for \fBg\fP. |
6427 | .TP | |
6428 | .B G | |
6429 | Apply the following `\fBs\fP' modifier once to each word in the event line. | |
726f6388 | 6430 | .PD |
726f6388 JA |
6431 | .SH "SHELL BUILTIN COMMANDS" |
6432 | .\" start of bash_builtins | |
6433 | .zZ | |
ccc6cda3 JA |
6434 | .PP |
6435 | Unless otherwise noted, each builtin command documented in this | |
6436 | section as accepting options preceded by | |
6437 | .B \- | |
6438 | accepts | |
6439 | .B \-\- | |
6440 | to signify the end of the options. | |
0001803f CR |
6441 | The \fB:\fP, \fBtrue\fP, \fBfalse\fP, and \fBtest\fP builtins |
6442 | do not accept options and do not treat \fB\-\-\fP specially. | |
6443 | The \fBexit\fP, \fBlogout\fP, \fBbreak\fP, \fBcontinue\fP, \fBlet\fP, | |
6444 | and \fBshift\fP builtins accept and process arguments beginning with | |
6445 | \fB\-\fP without requiring \fB\-\-\fP. | |
6446 | Other builtins that accept arguments but are not specified as accepting | |
6447 | options interpret arguments beginning with \fB\-\fP as invalid options and | |
6448 | require \fB\-\-\fP to prevent this interpretation. | |
ccc6cda3 | 6449 | .sp .5 |
726f6388 JA |
6450 | .PD 0 |
6451 | .TP | |
6452 | \fB:\fP [\fIarguments\fP] | |
6453 | .PD | |
6454 | No effect; the command does nothing beyond expanding | |
6455 | .I arguments | |
6456 | and performing any specified | |
6457 | redirections. A zero exit code is returned. | |
6458 | .TP | |
726f6388 | 6459 | \fB .\| \fP \fIfilename\fP [\fIarguments\fP] |
7117c2d2 | 6460 | .PD 0 |
726f6388 JA |
6461 | .TP |
6462 | \fBsource\fP \fIfilename\fP [\fIarguments\fP] | |
6463 | .PD | |
6464 | Read and execute commands from | |
6465 | .I filename | |
6466 | in the current | |
6467 | shell environment and return the exit status of the last command | |
6468 | executed from | |
6469 | .IR filename . | |
6470 | If | |
6471 | .I filename | |
ccc6cda3 | 6472 | does not contain a slash, file names in |
726f6388 JA |
6473 | .SM |
6474 | .B PATH | |
6475 | are used to find the directory containing | |
6476 | .IR filename . | |
6477 | The file searched for in | |
6478 | .SM | |
6479 | .B PATH | |
28ef6c31 JA |
6480 | need not be executable. |
6481 | When \fBbash\fP is not in \fIposix mode\fP, the current directory is | |
726f6388 JA |
6482 | searched if no file is found in |
6483 | .SM | |
6484 | .BR PATH . | |
ccc6cda3 JA |
6485 | If the |
6486 | .B sourcepath | |
6487 | option to the | |
6488 | .B shopt | |
6489 | builtin command is turned off, the | |
6490 | .SM | |
6491 | .B PATH | |
6492 | is not searched. | |
726f6388 | 6493 | If any \fIarguments\fP are supplied, they become the positional |
ccc6cda3 | 6494 | parameters when \fIfilename\fP is executed. Otherwise the positional |
726f6388 JA |
6495 | parameters are unchanged. |
6496 | The return status is the status of the last command exited within | |
6497 | the script (0 if no commands are executed), and false if | |
6498 | .I filename | |
cce855bc | 6499 | is not found or cannot be read. |
726f6388 | 6500 | .TP |
ccc6cda3 JA |
6501 | \fBalias\fP [\fB\-p\fP] [\fIname\fP[=\fIvalue\fP] ...] |
6502 | \fBAlias\fP with no arguments or with the | |
6503 | .B \-p | |
6504 | option prints the list of aliases in the form | |
6505 | \fBalias\fP \fIname\fP=\fIvalue\fP on standard output. | |
6506 | When arguments are supplied, an alias is defined for | |
6507 | each \fIname\fP whose \fIvalue\fP is given. | |
6508 | A trailing space in \fIvalue\fP causes the next word to be | |
6509 | checked for alias substitution when the alias is expanded. | |
6510 | For each \fIname\fP in the argument list for which no \fIvalue\fP | |
6511 | is supplied, the name and value of the alias is printed. | |
6512 | \fBAlias\fP returns true unless a \fIname\fP is given for which | |
6513 | no alias has been defined. | |
726f6388 | 6514 | .TP |
95732b49 JA |
6515 | \fBbg\fP [\fIjobspec\fP ...] |
6516 | Resume each suspended job \fIjobspec\fP in the background, as if it | |
cce855bc | 6517 | had been started with |
726f6388 | 6518 | .BR & . |
3185942a JA |
6519 | If |
6520 | .I jobspec | |
6521 | is not present, the shell's notion of the \fIcurrent job\fP is used. | |
726f6388 JA |
6522 | .B bg |
6523 | .I jobspec | |
6524 | returns 0 unless run when job control is disabled or, when run with | |
95732b49 JA |
6525 | job control enabled, any specified \fIjobspec\fP was not found |
6526 | or was started without job control. | |
726f6388 | 6527 | .TP |
cce855bc | 6528 | \fBbind\fP [\fB\-m\fP \fIkeymap\fP] [\fB\-lpsvPSV\fP] |
7117c2d2 | 6529 | .PD 0 |
cce855bc JA |
6530 | .TP |
6531 | \fBbind\fP [\fB\-m\fP \fIkeymap\fP] [\fB\-q\fP \fIfunction\fP] [\fB\-u\fP \fIfunction\fP] [\fB\-r\fP \fIkeyseq\fP] | |
726f6388 | 6532 | .TP |
ccc6cda3 | 6533 | \fBbind\fP [\fB\-m\fP \fIkeymap\fP] \fB\-f\fP \fIfilename\fP |
726f6388 | 6534 | .TP |
bb70624e JA |
6535 | \fBbind\fP [\fB\-m\fP \fIkeymap\fP] \fB\-x\fP \fIkeyseq\fP:\fIshell\-command\fP |
6536 | .TP | |
ccc6cda3 | 6537 | \fBbind\fP [\fB\-m\fP \fIkeymap\fP] \fIkeyseq\fP:\fIfunction\-name\fP |
7117c2d2 JA |
6538 | .TP |
6539 | \fBbind\fP \fIreadline\-command\fP | |
726f6388 JA |
6540 | .PD |
6541 | Display current | |
6542 | .B readline | |
7117c2d2 | 6543 | key and function bindings, bind a key sequence to a |
726f6388 | 6544 | .B readline |
7117c2d2 JA |
6545 | function or macro, or set a |
6546 | .B readline | |
6547 | variable. | |
6548 | Each non-option argument is a command as it would appear in | |
726f6388 | 6549 | .IR .inputrc , |
7117c2d2 JA |
6550 | but each binding or command must be passed as a separate argument; |
6551 | e.g., '"\eC\-x\eC\-r": re\-read\-init\-file'. | |
6552 | Options, if supplied, have the following meanings: | |
726f6388 JA |
6553 | .RS |
6554 | .PD 0 | |
6555 | .TP | |
6556 | .B \-m \fIkeymap\fP | |
6557 | Use | |
6558 | .I keymap | |
6559 | as the keymap to be affected by the subsequent bindings. | |
6560 | Acceptable | |
6561 | .I keymap | |
6562 | names are | |
ccc6cda3 | 6563 | \fIemacs, emacs\-standard, emacs\-meta, emacs\-ctlx, vi, |
28ef6c31 | 6564 | vi\-move, vi\-command\fP, and |
ccc6cda3 JA |
6565 | .IR vi\-insert . |
6566 | \fIvi\fP is equivalent to \fIvi\-command\fP; \fIemacs\fP is | |
6567 | equivalent to \fIemacs\-standard\fP. | |
726f6388 JA |
6568 | .TP |
6569 | .B \-l | |
ccc6cda3 JA |
6570 | List the names of all \fBreadline\fP functions. |
6571 | .TP | |
6572 | .B \-p | |
6573 | Display \fBreadline\fP function names and bindings in such a way | |
6574 | that they can be re-read. | |
6575 | .TP | |
6576 | .B \-P | |
6577 | List current \fBreadline\fP function names and bindings. | |
726f6388 | 6578 | .TP |
ccc6cda3 JA |
6579 | .B \-s |
6580 | Display \fBreadline\fP key sequences bound to macros and the strings | |
6581 | they output in such a way that they can be re-read. | |
6582 | .TP | |
6583 | .B \-S | |
6584 | Display \fBreadline\fP key sequences bound to macros and the strings | |
6585 | they output. | |
726f6388 | 6586 | .TP |
3185942a JA |
6587 | .B \-v |
6588 | Display \fBreadline\fP variable names and values in such a way that they | |
6589 | can be re-read. | |
6590 | .TP | |
6591 | .B \-V | |
6592 | List current \fBreadline\fP variable names and values. | |
6593 | .TP | |
726f6388 | 6594 | .B \-f \fIfilename\fP |
ccc6cda3 | 6595 | Read key bindings from \fIfilename\fP. |
726f6388 JA |
6596 | .TP |
6597 | .B \-q \fIfunction\fP | |
ccc6cda3 JA |
6598 | Query about which keys invoke the named \fIfunction\fP. |
6599 | .TP | |
cce855bc JA |
6600 | .B \-u \fIfunction\fP |
6601 | Unbind all keys bound to the named \fIfunction\fP. | |
6602 | .TP | |
ccc6cda3 JA |
6603 | .B \-r \fIkeyseq\fP |
6604 | Remove any current binding for \fIkeyseq\fP. | |
bb70624e JA |
6605 | .TP |
6606 | .B \-x \fIkeyseq\fP:\fIshell\-command\fP | |
6607 | Cause \fIshell\-command\fP to be executed whenever \fIkeyseq\fP is | |
6608 | entered. | |
3185942a | 6609 | When \fIshell\-command\fP is executed, the shell sets the |
0001803f | 6610 | .SM |
3185942a JA |
6611 | .B READLINE_LINE |
6612 | variable to the contents of the \fBreadline\fP line buffer and the | |
0001803f | 6613 | .SM |
3185942a JA |
6614 | .B READLINE_POINT |
6615 | variable to the current location of the insertion point. | |
6616 | If the executed command changes the value of | |
0001803f | 6617 | .SM |
3185942a JA |
6618 | .B READLINE_LINE |
6619 | or | |
0001803f | 6620 | .SM |
3185942a JA |
6621 | .BR READLINE_POINT , |
6622 | those new values will be reflected in the editing state. | |
726f6388 JA |
6623 | .PD |
6624 | .PP | |
6625 | The return value is 0 unless an unrecognized option is given or an | |
6626 | error occurred. | |
6627 | .RE | |
6628 | .TP | |
6629 | \fBbreak\fP [\fIn\fP] | |
6630 | Exit from within a | |
6631 | .BR for , | |
6632 | .BR while , | |
ccc6cda3 | 6633 | .BR until , |
726f6388 | 6634 | or |
ccc6cda3 | 6635 | .B select |
726f6388 JA |
6636 | loop. If \fIn\fP is specified, break \fIn\fP levels. |
6637 | .I n | |
6638 | must be \(>= 1. If | |
6639 | .I n | |
6640 | is greater than the number of enclosing loops, all enclosing loops | |
3185942a JA |
6641 | are exited. |
6642 | The return value is 0 unless \fIn\fP is not greater than or equal to 1. | |
726f6388 JA |
6643 | .TP |
6644 | \fBbuiltin\fP \fIshell\-builtin\fP [\fIarguments\fP] | |
6645 | Execute the specified shell builtin, passing it | |
6646 | .IR arguments , | |
6647 | and return its exit status. | |
cce855bc | 6648 | This is useful when defining a |
726f6388 | 6649 | function whose name is the same as a shell builtin, |
cce855bc JA |
6650 | retaining the functionality of the builtin within the function. |
6651 | The \fBcd\fP builtin is commonly redefined this way. | |
6652 | The return status is false if | |
726f6388 JA |
6653 | .I shell\-builtin |
6654 | is not a shell builtin command. | |
6655 | .TP | |
3185942a JA |
6656 | \fBcaller\fP [\fIexpr\fP] |
6657 | Returns the context of any active subroutine call (a shell function or | |
6658 | a script executed with the \fB.\fP or \fBsource\fP builtins. | |
6659 | Without \fIexpr\fP, \fBcaller\fP displays the line number and source | |
6660 | filename of the current subroutine call. | |
6661 | If a non-negative integer is supplied as \fIexpr\fP, \fBcaller\fP | |
6662 | displays the line number, subroutine name, and source file corresponding | |
6663 | to that position in the current execution call stack. This extra | |
6664 | information may be used, for example, to print a stack trace. The | |
6665 | current frame is frame 0. | |
6666 | The return value is 0 unless the shell is not executing a subroutine | |
6667 | call or \fIexpr\fP does not correspond to a valid position in the | |
6668 | call stack. | |
6669 | .TP | |
7117c2d2 | 6670 | \fBcd\fP [\fB\-L|-P\fP] [\fIdir\fP] |
726f6388 JA |
6671 | Change the current directory to \fIdir\fP. The variable |
6672 | .SM | |
6673 | .B HOME | |
6674 | is the | |
6675 | default | |
6676 | .IR dir . | |
6677 | The variable | |
6678 | .SM | |
6679 | .B CDPATH | |
ccc6cda3 | 6680 | defines the search path for the directory containing |
726f6388 | 6681 | .IR dir . |
ccc6cda3 JA |
6682 | Alternative directory names in |
6683 | .SM | |
6684 | .B CDPATH | |
6685 | are separated by a colon (:). A null directory name in | |
726f6388 JA |
6686 | .SM |
6687 | .B CDPATH | |
ccc6cda3 | 6688 | is the same as the current directory, i.e., ``\fB.\fP''. If |
726f6388 JA |
6689 | .I dir |
6690 | begins with a slash (/), | |
6691 | then | |
6692 | .SM | |
6693 | .B CDPATH | |
ccc6cda3 JA |
6694 | is not used. The |
6695 | .B \-P | |
6696 | option says to use the physical directory structure instead of | |
6697 | following symbolic links (see also the | |
6698 | .B \-P | |
6699 | option to the | |
6700 | .B set | |
6701 | builtin command); the | |
6702 | .B \-L | |
6703 | option forces symbolic links to be followed. An argument of | |
726f6388 JA |
6704 | .B \- |
6705 | is equivalent to | |
6706 | .SM | |
6707 | .BR $OLDPWD . | |
0001803f CR |
6708 | If a non-empty directory name from |
6709 | .SM | |
6710 | .B CDPATH | |
6711 | is used, or if | |
b80f6443 JA |
6712 | \fB\-\fP is the first argument, and the directory change is |
6713 | successful, the absolute pathname of the new working directory is | |
6714 | written to the standard output. | |
726f6388 JA |
6715 | The return value is true if the directory was successfully changed; |
6716 | false otherwise. | |
6717 | .TP | |
ccc6cda3 | 6718 | \fBcommand\fP [\fB\-pVv\fP] \fIcommand\fP [\fIarg\fP ...] |
726f6388 JA |
6719 | Run |
6720 | .I command | |
6721 | with | |
6722 | .I args | |
6723 | suppressing the normal shell function lookup. Only builtin | |
6724 | commands or commands found in the | |
6725 | .SM | |
6726 | .B PATH | |
6727 | are executed. If the | |
6728 | .B \-p | |
6729 | option is given, the search for | |
6730 | .I command | |
6731 | is performed using a default value for | |
0001803f | 6732 | .SM |
726f6388 JA |
6733 | .B PATH |
6734 | that is guaranteed to find all of the standard utilities. | |
6735 | If either the | |
6736 | .B \-V | |
6737 | or | |
6738 | .B \-v | |
6739 | option is supplied, a description of | |
6740 | .I command | |
6741 | is printed. The | |
6742 | .B \-v | |
ccc6cda3 | 6743 | option causes a single word indicating the command or file name |
726f6388 JA |
6744 | used to invoke |
6745 | .I command | |
cce855bc | 6746 | to be displayed; the |
726f6388 JA |
6747 | .B \-V |
6748 | option produces a more verbose description. | |
726f6388 JA |
6749 | If the |
6750 | .B \-V | |
6751 | or | |
6752 | .B \-v | |
6753 | option is supplied, the exit status is 0 if | |
6754 | .I command | |
6755 | was found, and 1 if not. If neither option is supplied and | |
6756 | an error occurred or | |
6757 | .I command | |
6758 | cannot be found, the exit status is 127. Otherwise, the exit status of the | |
6759 | .B command | |
6760 | builtin is the exit status of | |
6761 | .IR command . | |
6762 | .TP | |
bb70624e JA |
6763 | \fBcompgen\fP [\fIoption\fP] [\fIword\fP] |
6764 | Generate possible completion matches for \fIword\fP according to | |
6765 | the \fIoption\fPs, which may be any option accepted by the | |
6766 | .B complete | |
6767 | builtin with the exception of \fB\-p\fP and \fB\-r\fP, and write | |
6768 | the matches to the standard output. | |
6769 | When using the \fB\-F\fP or \fB\-C\fP options, the various shell variables | |
6770 | set by the programmable completion facilities, while available, will not | |
6771 | have useful values. | |
6772 | .sp 1 | |
6773 | The matches will be generated in the same way as if the programmable | |
6774 | completion code had generated them directly from a completion specification | |
6775 | with the same flags. | |
6776 | If \fIword\fP is specified, only those completions matching \fIword\fP | |
6777 | will be displayed. | |
6778 | .sp 1 | |
6779 | The return value is true unless an invalid option is supplied, or no | |
6780 | matches were generated. | |
6781 | .TP | |
0001803f | 6782 | \fBcomplete\fP [\fB\-abcdefgjksuv\fP] [\fB\-o\fP \fIcomp-option\fP] [\fB\-DE\fP] [\fB\-A\fP \fIaction\fP] [\fB\-G\fP \fIglobpat\fP] [\fB\-W\fP \fIwordlist\fP] [\fB\-F\fP \fIfunction\fP] [\fB\-C\fP \fIcommand\fP] |
bb70624e | 6783 | .br |
3185942a | 6784 | [\fB\-X\fP \fIfilterpat\fP] [\fB\-P\fP \fIprefix\fP] [\fB\-S\fP \fIsuffix\fP] \fIname\fP [\fIname ...\fP] |
7117c2d2 | 6785 | .PD 0 |
bb70624e | 6786 | .TP |
0001803f | 6787 | \fBcomplete\fP \fB\-pr\fP [\fB\-DE\fP] [\fIname\fP ...] |
bb70624e JA |
6788 | .PD |
6789 | Specify how arguments to each \fIname\fP should be completed. | |
6790 | If the \fB\-p\fP option is supplied, or if no options are supplied, | |
6791 | existing completion specifications are printed in a way that allows | |
6792 | them to be reused as input. | |
6793 | The \fB\-r\fP option removes a completion specification for | |
6794 | each \fIname\fP, or, if no \fIname\fPs are supplied, all | |
6795 | completion specifications. | |
0001803f CR |
6796 | The \fB\-D\fP option indicates that the remaining options and actions should |
6797 | apply to the ``default'' command completion; that is, completion attempted | |
6798 | on a command for which no completion has previously been defined. | |
3185942a JA |
6799 | The \fB\-E\fP option indicates that the remaining options and actions should |
6800 | apply to ``empty'' command completion; that is, completion attempted on a | |
6801 | blank line. | |
bb70624e JA |
6802 | .sp 1 |
6803 | The process of applying these completion specifications when word completion | |
6804 | is attempted is described above under \fBProgrammable Completion\fP. | |
6805 | .sp 1 | |
6806 | Other options, if specified, have the following meanings. | |
6807 | The arguments to the \fB\-G\fP, \fB\-W\fP, and \fB\-X\fP options | |
6808 | (and, if necessary, the \fB\-P\fP and \fB\-S\fP options) | |
6809 | should be quoted to protect them from expansion before the | |
6810 | .B complete | |
6811 | builtin is invoked. | |
6812 | .RS | |
6813 | .PD 0 | |
6814 | .TP 8 | |
28ef6c31 JA |
6815 | \fB\-o\fP \fIcomp-option\fP |
6816 | The \fIcomp-option\fP controls several aspects of the compspec's behavior | |
6817 | beyond the simple generation of completions. | |
6818 | \fIcomp-option\fP may be one of: | |
6819 | .RS | |
6820 | .TP 8 | |
b80f6443 JA |
6821 | .B bashdefault |
6822 | Perform the rest of the default \fBbash\fP completions if the compspec | |
6823 | generates no matches. | |
6824 | .TP 8 | |
28ef6c31 | 6825 | .B default |
7117c2d2 JA |
6826 | Use readline's default filename completion if the compspec generates |
6827 | no matches. | |
28ef6c31 JA |
6828 | .TP 8 |
6829 | .B dirnames | |
6830 | Perform directory name completion if the compspec generates no matches. | |
6831 | .TP 8 | |
6832 | .B filenames | |
6833 | Tell readline that the compspec generates filenames, so it can perform any | |
3185942a JA |
6834 | filename\-specific processing (like adding a slash to directory names, |
6835 | quoting special characters, or suppressing trailing spaces). | |
6836 | Intended to be used with shell functions. | |
7117c2d2 JA |
6837 | .TP 8 |
6838 | .B nospace | |
6839 | Tell readline not to append a space (the default) to words completed at | |
6840 | the end of the line. | |
95732b49 JA |
6841 | .TP 8 |
6842 | .B plusdirs | |
6843 | After any matches defined by the compspec are generated, | |
6844 | directory name completion is attempted and any | |
6845 | matches are added to the results of the other actions. | |
28ef6c31 JA |
6846 | .RE |
6847 | .TP 8 | |
bb70624e JA |
6848 | \fB\-A\fP \fIaction\fP |
6849 | The \fIaction\fP may be one of the following to generate a list of possible | |
6850 | completions: | |
6851 | .RS | |
6852 | .TP 8 | |
6853 | .B alias | |
6854 | Alias names. May also be specified as \fB\-a\fP. | |
6855 | .TP 8 | |
6856 | .B arrayvar | |
6857 | Array variable names. | |
6858 | .TP 8 | |
6859 | .B binding | |
6860 | \fBReadline\fP key binding names. | |
6861 | .TP 8 | |
6862 | .B builtin | |
6863 | Names of shell builtin commands. May also be specified as \fB\-b\fP. | |
6864 | .TP 8 | |
6865 | .B command | |
6866 | Command names. May also be specified as \fB\-c\fP. | |
6867 | .TP 8 | |
6868 | .B directory | |
6869 | Directory names. May also be specified as \fB\-d\fP. | |
6870 | .TP 8 | |
6871 | .B disabled | |
6872 | Names of disabled shell builtins. | |
6873 | .TP 8 | |
6874 | .B enabled | |
6875 | Names of enabled shell builtins. | |
6876 | .TP 8 | |
6877 | .B export | |
6878 | Names of exported shell variables. May also be specified as \fB\-e\fP. | |
6879 | .TP 8 | |
6880 | .B file | |
6881 | File names. May also be specified as \fB\-f\fP. | |
6882 | .TP 8 | |
6883 | .B function | |
6884 | Names of shell functions. | |
6885 | .TP 8 | |
f73dda09 JA |
6886 | .B group |
6887 | Group names. May also be specified as \fB\-g\fP. | |
6888 | .TP 8 | |
bb70624e JA |
6889 | .B helptopic |
6890 | Help topics as accepted by the \fBhelp\fP builtin. | |
6891 | .TP 8 | |
6892 | .B hostname | |
6893 | Hostnames, as taken from the file specified by the | |
6894 | .SM | |
6895 | .B HOSTFILE | |
6896 | shell variable. | |
6897 | .TP 8 | |
6898 | .B job | |
6899 | Job names, if job control is active. May also be specified as \fB\-j\fP. | |
6900 | .TP 8 | |
6901 | .B keyword | |
6902 | Shell reserved words. May also be specified as \fB\-k\fP. | |
6903 | .TP 8 | |
6904 | .B running | |
6905 | Names of running jobs, if job control is active. | |
6906 | .TP 8 | |
7117c2d2 JA |
6907 | .B service |
6908 | Service names. May also be specified as \fB\-s\fP. | |
6909 | .TP 8 | |
bb70624e JA |
6910 | .B setopt |
6911 | Valid arguments for the \fB\-o\fP option to the \fBset\fP builtin. | |
6912 | .TP 8 | |
6913 | .B shopt | |
6914 | Shell option names as accepted by the \fBshopt\fP builtin. | |
6915 | .TP 8 | |
6916 | .B signal | |
6917 | Signal names. | |
6918 | .TP 8 | |
6919 | .B stopped | |
6920 | Names of stopped jobs, if job control is active. | |
6921 | .TP 8 | |
6922 | .B user | |
6923 | User names. May also be specified as \fB\-u\fP. | |
6924 | .TP 8 | |
6925 | .B variable | |
6926 | Names of all shell variables. May also be specified as \fB\-v\fP. | |
6927 | .RE | |
6928 | .TP 8 | |
6929 | \fB\-G\fP \fIglobpat\fP | |
0001803f | 6930 | The pathname expansion pattern \fIglobpat\fP is expanded to generate |
bb70624e JA |
6931 | the possible completions. |
6932 | .TP 8 | |
6933 | \fB\-W\fP \fIwordlist\fP | |
6934 | The \fIwordlist\fP is split using the characters in the | |
6935 | .SM | |
6936 | .B IFS | |
6937 | special variable as delimiters, and each resultant word is expanded. | |
6938 | The possible completions are the members of the resultant list which | |
6939 | match the word being completed. | |
6940 | .TP 8 | |
6941 | \fB\-C\fP \fIcommand\fP | |
6942 | \fIcommand\fP is executed in a subshell environment, and its output is | |
6943 | used as the possible completions. | |
6944 | .TP 8 | |
6945 | \fB\-F\fP \fIfunction\fP | |
6946 | The shell function \fIfunction\fP is executed in the current shell | |
6947 | environment. | |
6948 | When it finishes, the possible completions are retrieved from the value | |
6949 | of the | |
6950 | .SM | |
6951 | .B COMPREPLY | |
6952 | array variable. | |
6953 | .TP 8 | |
6954 | \fB\-X\fP \fIfilterpat\fP | |
0001803f | 6955 | \fIfilterpat\fP is a pattern as used for pathname expansion. |
bb70624e JA |
6956 | It is applied to the list of possible completions generated by the |
6957 | preceding options and arguments, and each completion matching | |
6958 | \fIfilterpat\fP is removed from the list. | |
6959 | A leading \fB!\fP in \fIfilterpat\fP negates the pattern; in this | |
6960 | case, any completion not matching \fIfilterpat\fP is removed. | |
6961 | .TP 8 | |
6962 | \fB\-P\fP \fIprefix\fP | |
6963 | \fIprefix\fP is added at the beginning of each possible completion | |
6964 | after all other options have been applied. | |
6965 | .TP 8 | |
6966 | \fB\-S\fP \fIsuffix\fP | |
6967 | \fIsuffix\fP is appended to each possible completion | |
6968 | after all other options have been applied. | |
6969 | .PD | |
6970 | .PP | |
6971 | The return value is true unless an invalid option is supplied, an option | |
6972 | other than \fB\-p\fP or \fB\-r\fP is supplied without a \fIname\fP | |
6973 | argument, an attempt is made to remove a completion specification for | |
6974 | a \fIname\fP for which no specification exists, or | |
6975 | an error occurs adding a completion specification. | |
6976 | .RE | |
6977 | .TP | |
0001803f | 6978 | \fBcompopt\fP [\fB\-o\fP \fIoption\fP] [\fB\-DE\fP] [\fB+o\fP \fIoption\fP] [\fIname\fP] |
3185942a JA |
6979 | Modify completion options for each \fIname\fP according to the |
6980 | \fIoption\fPs, or for the | |
6981 | currently-execution completion if no \fIname\fPs are supplied. | |
6982 | If no \fIoption\fPs are given, display the completion options for each | |
6983 | \fIname\fP or the current completion. | |
6984 | The possible values of \fIoption\fP are those valid for the \fBcomplete\fP | |
6985 | builtin described above. | |
0001803f CR |
6986 | The \fB\-D\fP option indicates that the remaining options should |
6987 | apply to the ``default'' command completion; that is, completion attempted | |
6988 | on a command for which no completion has previously been defined. | |
6989 | The \fB\-E\fP option indicates that the remaining options should | |
6990 | apply to ``empty'' command completion; that is, completion attempted on a | |
6991 | blank line. | |
3185942a JA |
6992 | .PP |
6993 | The return value is true unless an invalid option is supplied, an attempt | |
6994 | is made to modify the options for a \fIname\fP for which no completion | |
6995 | specification exists, or an output error occurs. | |
6996 | .TP | |
726f6388 JA |
6997 | \fBcontinue\fP [\fIn\fP] |
6998 | Resume the next iteration of the enclosing | |
6999 | .BR for , | |
7000 | .BR while , | |
ccc6cda3 | 7001 | .BR until , |
726f6388 | 7002 | or |
ccc6cda3 | 7003 | .B select |
726f6388 JA |
7004 | loop. |
7005 | If | |
7006 | .I n | |
7007 | is specified, resume at the \fIn\fPth enclosing loop. | |
7008 | .I n | |
7009 | must be \(>= 1. If | |
7010 | .I n | |
7011 | is greater than the number of enclosing loops, the last enclosing loop | |
3185942a JA |
7012 | (the ``top-level'' loop) is resumed. |
7013 | The return value is 0 unless \fIn\fP is not greater than or equal to 1. | |
726f6388 | 7014 | .TP |
3185942a | 7015 | \fBdeclare\fP [\fB\-aAfFilrtux\fP] [\fB\-p\fP] [\fIname\fP[=\fIvalue\fP] ...] |
726f6388 | 7016 | .PD 0 |
726f6388 | 7017 | .TP |
3185942a | 7018 | \fBtypeset\fP [\fB\-aAfFilrtux\fP] [\fB\-p\fP] [\fIname\fP[=\fIvalue\fP] ...] |
726f6388 | 7019 | .PD |
ccc6cda3 JA |
7020 | Declare variables and/or give them attributes. |
7021 | If no \fIname\fPs are given then display the values of variables. | |
7022 | The | |
7023 | .B \-p | |
7024 | option will display the attributes and values of each | |
7025 | .IR name . | |
7026 | When | |
7027 | .B \-p | |
3185942a JA |
7028 | is used with \fIname\fP arguments, additional options are ignored. |
7029 | When | |
7030 | .B \-p | |
7031 | is supplied without \fIname\fP arguments, it will display the attributes | |
7032 | and values of all variables having the attributes specified by the | |
7033 | additional options. | |
7034 | If no other options are supplied with \fB\-p\fP, \fBdeclare\fP will display | |
7035 | the attributes and values of all shell variables. The \fB\-f\fP option | |
7036 | will restrict the display to shell functions. | |
ccc6cda3 JA |
7037 | The |
7038 | .B \-F | |
7039 | option inhibits the display of function definitions; only the | |
7040 | function name and attributes are printed. | |
b80f6443 JA |
7041 | If the \fBextdebug\fP shell option is enabled using \fBshopt\fP, |
7042 | the source file name and line number where the function is defined | |
7043 | are displayed as well. The | |
ccc6cda3 JA |
7044 | .B \-F |
7045 | option implies | |
7046 | .BR \-f . | |
7047 | The following options can | |
7048 | be used to restrict output to variables with the specified attribute or | |
7049 | to give variables attributes: | |
726f6388 JA |
7050 | .RS |
7051 | .PD 0 | |
7052 | .TP | |
ccc6cda3 | 7053 | .B \-a |
3185942a JA |
7054 | Each \fIname\fP is an indexed array variable (see |
7055 | .B Arrays | |
7056 | above). | |
7057 | .TP | |
7058 | .B \-A | |
7059 | Each \fIname\fP is an associative array variable (see | |
ccc6cda3 JA |
7060 | .B Arrays |
7061 | above). | |
7062 | .TP | |
726f6388 | 7063 | .B \-f |
ccc6cda3 JA |
7064 | Use function names only. |
7065 | .TP | |
7066 | .B \-i | |
7067 | The variable is treated as an integer; arithmetic evaluation (see | |
7068 | .SM | |
0001803f CR |
7069 | .B "ARITHMETIC EVALUATION" |
7070 | above) is performed when the variable is assigned a value. | |
726f6388 | 7071 | .TP |
3185942a JA |
7072 | .B \-l |
7073 | When the variable is assigned a value, all upper-case characters are | |
7074 | converted to lower-case. | |
7075 | The upper-case attribute is disabled. | |
7076 | .TP | |
726f6388 JA |
7077 | .B \-r |
7078 | Make \fIname\fPs readonly. These names cannot then be assigned values | |
cce855bc | 7079 | by subsequent assignment statements or unset. |
726f6388 | 7080 | .TP |
7117c2d2 JA |
7081 | .B \-t |
7082 | Give each \fIname\fP the \fItrace\fP attribute. | |
95732b49 JA |
7083 | Traced functions inherit the \fBDEBUG\fP and \fBRETURN\fP traps from |
7084 | the calling shell. | |
7117c2d2 JA |
7085 | The trace attribute has no special meaning for variables. |
7086 | .TP | |
3185942a JA |
7087 | .B \-u |
7088 | When the variable is assigned a value, all lower-case characters are | |
7089 | converted to upper-case. | |
7090 | The lower-case attribute is disabled. | |
7091 | .TP | |
726f6388 JA |
7092 | .B \-x |
7093 | Mark \fIname\fPs for export to subsequent commands via the environment. | |
726f6388 JA |
7094 | .PD |
7095 | .PP | |
7096 | Using `+' instead of `\-' | |
3185942a JA |
7097 | turns off the attribute instead, |
7098 | with the exceptions that \fB+a\fP | |
0001803f | 7099 | may not be used to destroy an array variable and \fB+r\fP will not |
3185942a JA |
7100 | remove the readonly attribute. |
7101 | When used in a function, | |
ccc6cda3 JA |
7102 | makes each |
7103 | \fIname\fP local, as with the | |
726f6388 | 7104 | .B local |
b80f6443 JA |
7105 | command. |
7106 | If a variable name is followed by =\fIvalue\fP, the value of | |
7107 | the variable is set to \fIvalue\fP. | |
7108 | The return value is 0 unless an invalid option is encountered, | |
bb70624e JA |
7109 | an attempt is made to define a function using |
7110 | .if n ``\-f foo=bar'', | |
7111 | .if t \f(CW\-f foo=bar\fP, | |
ccc6cda3 JA |
7112 | an attempt is made to assign a value to a readonly variable, |
7113 | an attempt is made to assign a value to an array variable without | |
7114 | using the compound assignment syntax (see | |
7115 | .B Arrays | |
cce855bc | 7116 | above), one of the \fInames\fP is not a valid shell variable name, |
726f6388 | 7117 | an attempt is made to turn off readonly status for a readonly variable, |
ccc6cda3 | 7118 | an attempt is made to turn off array status for an array variable, |
bb70624e | 7119 | or an attempt is made to display a non-existent function with \fB\-f\fP. |
726f6388 JA |
7120 | .RE |
7121 | .TP | |
3185942a | 7122 | .B dirs [+\fIn\fP] [\-\fIn\fP] [\fB\-cplv\fP] |
ccc6cda3 JA |
7123 | Without options, displays the list of currently remembered directories. |
7124 | The default display is on a single line with directory names separated | |
7125 | by spaces. | |
7126 | Directories are added to the list with the | |
726f6388 JA |
7127 | .B pushd |
7128 | command; the | |
7129 | .B popd | |
ccc6cda3 | 7130 | command removes entries from the list. |
726f6388 JA |
7131 | .RS |
7132 | .PD 0 | |
7133 | .TP | |
ccc6cda3 JA |
7134 | \fB+\fP\fIn\fP |
7135 | Displays the \fIn\fPth entry counting from the left of the list | |
726f6388 JA |
7136 | shown by |
7137 | .B dirs | |
7138 | when invoked without options, starting with zero. | |
7139 | .TP | |
ccc6cda3 JA |
7140 | \fB\-\fP\fIn\fP |
7141 | Displays the \fIn\fPth entry counting from the right of the list | |
726f6388 JA |
7142 | shown by |
7143 | .B dirs | |
7144 | when invoked without options, starting with zero. | |
7145 | .TP | |
ccc6cda3 JA |
7146 | .B \-c |
7147 | Clears the directory stack by deleting all of the entries. | |
7148 | .TP | |
726f6388 | 7149 | .B \-l |
ccc6cda3 | 7150 | Produces a longer listing; the default listing format uses a |
726f6388 | 7151 | tilde to denote the home directory. |
ccc6cda3 JA |
7152 | .TP |
7153 | .B \-p | |
7154 | Print the directory stack with one entry per line. | |
7155 | .TP | |
7156 | .B \-v | |
7157 | Print the directory stack with one entry per line, | |
7158 | prefixing each entry with its index in the stack. | |
726f6388 JA |
7159 | .PD |
7160 | .PP | |
7161 | The return value is 0 unless an | |
cce855bc | 7162 | invalid option is supplied or \fIn\fP indexes beyond the end |
726f6388 JA |
7163 | of the directory stack. |
7164 | .RE | |
7165 | .TP | |
cce855bc | 7166 | \fBdisown\fP [\fB\-ar\fP] [\fB\-h\fP] [\fIjobspec\fP ...] |
ccc6cda3 JA |
7167 | Without options, each |
7168 | .I jobspec | |
7169 | is removed from the table of active jobs. | |
3185942a JA |
7170 | If |
7171 | .I jobspec | |
0001803f | 7172 | is not present, and neither \fB\-a\fP nor \fB\-r\fP is supplied, |
3185942a | 7173 | the shell's notion of the \fIcurrent job\fP is used. |
cce855bc JA |
7174 | If the \fB\-h\fP option is given, each |
7175 | .I jobspec | |
7176 | is not removed from the table, but is marked so that | |
ccc6cda3 JA |
7177 | .SM |
7178 | .B SIGHUP | |
7179 | is not sent to the job if the shell receives a | |
7180 | .SM | |
7181 | .BR SIGHUP . | |
7182 | If no | |
7183 | .I jobspec | |
cce855bc JA |
7184 | is present, and neither the |
7185 | .B \-a | |
7186 | nor the | |
7187 | .B \-r | |
7188 | option is supplied, the \fIcurrent job\fP is used. | |
7189 | If no | |
7190 | .I jobspec | |
7191 | is supplied, the | |
7192 | .B \-a | |
7193 | option means to remove or mark all jobs; the | |
7194 | .B \-r | |
7195 | option without a | |
7196 | .I jobspec | |
7197 | argument restricts operation to running jobs. | |
7198 | The return value is 0 unless a | |
ccc6cda3 JA |
7199 | .I jobspec |
7200 | does not specify a valid job. | |
7201 | .TP | |
726f6388 | 7202 | \fBecho\fP [\fB\-neE\fP] [\fIarg\fP ...] |
ccc6cda3 JA |
7203 | Output the \fIarg\fPs, separated by spaces, followed by a newline. |
7204 | The return status is always 0. | |
7205 | If \fB\-n\fP is specified, the trailing newline is | |
726f6388 JA |
7206 | suppressed. If the \fB\-e\fP option is given, interpretation of |
7207 | the following backslash-escaped characters is enabled. The | |
7208 | .B \-E | |
7209 | option disables the interpretation of these escape characters, | |
7210 | even on systems where they are interpreted by default. | |
28ef6c31 | 7211 | The \fBxpg_echo\fP shell option may be used to |
bb70624e JA |
7212 | dynamically determine whether or not \fBecho\fP expands these |
7213 | escape characters by default. | |
ccc6cda3 | 7214 | .B echo |
95732b49 | 7215 | does not interpret \fB\-\-\fP to mean the end of options. |
ccc6cda3 JA |
7216 | .B echo |
7217 | interprets the following escape sequences: | |
726f6388 JA |
7218 | .RS |
7219 | .PD 0 | |
7220 | .TP | |
7221 | .B \ea | |
7222 | alert (bell) | |
7223 | .TP | |
7224 | .B \eb | |
7225 | backspace | |
7226 | .TP | |
7227 | .B \ec | |
3185942a | 7228 | suppress further output |
726f6388 | 7229 | .TP |
ccc6cda3 JA |
7230 | .B \ee |
7231 | an escape character | |
7232 | .TP | |
726f6388 JA |
7233 | .B \ef |
7234 | form feed | |
7235 | .TP | |
7236 | .B \en | |
7237 | new line | |
7238 | .TP | |
7239 | .B \er | |
7240 | carriage return | |
7241 | .TP | |
7242 | .B \et | |
7243 | horizontal tab | |
7244 | .TP | |
7245 | .B \ev | |
7246 | vertical tab | |
7247 | .TP | |
7248 | .B \e\e | |
7249 | backslash | |
7250 | .TP | |
7117c2d2 JA |
7251 | .B \e0\fInnn\fP |
7252 | the eight-bit character whose value is the octal value \fInnn\fP | |
7253 | (zero to three octal digits) | |
7254 | .TP | |
f73dda09 JA |
7255 | .B \ex\fIHH\fP |
7256 | the eight-bit character whose value is the hexadecimal value \fIHH\fP | |
7257 | (one or two hex digits) | |
726f6388 JA |
7258 | .PD |
7259 | .RE | |
7260 | .TP | |
3185942a | 7261 | \fBenable\fP [\fB\-a\fP] [\fB\-dnps\fP] [\fB\-f\fP \fIfilename\fP] [\fIname\fP ...] |
cce855bc JA |
7262 | Enable and disable builtin shell commands. |
7263 | Disabling a builtin allows a disk command which has the same name | |
bb70624e | 7264 | as a shell builtin to be executed without specifying a full pathname, |
cce855bc | 7265 | even though the shell normally searches for builtins before disk commands. |
726f6388 JA |
7266 | If \fB\-n\fP is used, each \fIname\fP |
7267 | is disabled; otherwise, | |
7268 | \fInames\fP are enabled. For example, to use the | |
7269 | .B test | |
7270 | binary found via the | |
7271 | .SM | |
7272 | .B PATH | |
ccc6cda3 | 7273 | instead of the shell builtin version, run |
28ef6c31 JA |
7274 | .if t \f(CWenable -n test\fP. |
7275 | .if n ``enable -n test''. | |
ccc6cda3 JA |
7276 | The |
7277 | .B \-f | |
7278 | option means to load the new builtin command | |
7279 | .I name | |
7280 | from shared object | |
7281 | .IR filename , | |
7282 | on systems that support dynamic loading. The | |
7283 | .B \-d | |
7284 | option will delete a builtin previously loaded with | |
7285 | .BR \-f . | |
7286 | If no \fIname\fP arguments are given, or if the | |
7287 | .B \-p | |
7288 | option is supplied, a list of shell builtins is printed. | |
7289 | With no other option arguments, the list consists of all enabled | |
7290 | shell builtins. | |
7291 | If \fB\-n\fP is supplied, only disabled builtins are printed. | |
7292 | If \fB\-a\fP is supplied, the list printed includes all builtins, with an | |
726f6388 | 7293 | indication of whether or not each is enabled. |
ccc6cda3 JA |
7294 | If \fB\-s\fP is supplied, the output is restricted to the POSIX |
7295 | \fIspecial\fP builtins. | |
726f6388 JA |
7296 | The return value is 0 unless a |
7297 | .I name | |
bb70624e | 7298 | is not a shell builtin or there is an error loading a new builtin |
ccc6cda3 | 7299 | from a shared object. |
726f6388 JA |
7300 | .TP |
7301 | \fBeval\fP [\fIarg\fP ...] | |
7302 | The \fIarg\fPs are read and concatenated together into a single | |
7303 | command. This command is then read and executed by the shell, and | |
ccc6cda3 JA |
7304 | its exit status is returned as the value of |
7305 | .BR eval . | |
7306 | If there are no | |
726f6388 JA |
7307 | .IR args , |
7308 | or only null arguments, | |
7309 | .B eval | |
ccc6cda3 | 7310 | returns 0. |
726f6388 | 7311 | .TP |
cce855bc | 7312 | \fBexec\fP [\fB\-cl\fP] [\fB\-a\fP \fIname\fP] [\fIcommand\fP [\fIarguments\fP]] |
726f6388 JA |
7313 | If |
7314 | .I command | |
7315 | is specified, it replaces the shell. | |
7316 | No new process is created. The | |
7317 | .I arguments | |
7318 | become the arguments to \fIcommand\fP. | |
ccc6cda3 JA |
7319 | If the |
7320 | .B \-l | |
7321 | option is supplied, | |
3185942a | 7322 | the shell places a dash at the beginning of the zeroth argument passed to |
726f6388 | 7323 | .IR command . |
ccc6cda3 JA |
7324 | This is what |
7325 | .IR login (1) | |
7326 | does. The | |
7327 | .B \-c | |
7328 | option causes | |
7329 | .I command | |
7330 | to be executed with an empty environment. If | |
7331 | .B \-a | |
7332 | is supplied, the shell passes | |
7333 | .I name | |
7334 | as the zeroth argument to the executed command. If | |
7335 | .I command | |
726f6388 | 7336 | cannot be executed for some reason, a non-interactive shell exits, |
ccc6cda3 JA |
7337 | unless the shell option |
7338 | .B execfail | |
7339 | is enabled, in which case it returns failure. | |
7340 | An interactive shell returns failure if the file cannot be executed. | |
726f6388 JA |
7341 | If |
7342 | .I command | |
7343 | is not specified, any redirections take effect in the current shell, | |
cce855bc JA |
7344 | and the return status is 0. If there is a redirection error, the |
7345 | return status is 1. | |
726f6388 JA |
7346 | .TP |
7347 | \fBexit\fP [\fIn\fP] | |
7348 | Cause the shell to exit | |
7349 | with a status of \fIn\fP. If | |
7350 | .I n | |
7351 | is omitted, the exit status | |
7352 | is that of the last command executed. | |
7353 | A trap on | |
7354 | .SM | |
7355 | .B EXIT | |
7356 | is executed before the shell terminates. | |
7357 | .TP | |
ccc6cda3 | 7358 | \fBexport\fP [\fB\-fn\fP\^] [\fIname\fP[=\fIword\fP]] ... |
7117c2d2 | 7359 | .PD 0 |
726f6388 JA |
7360 | .TP |
7361 | .B export \-p | |
7362 | .PD | |
7363 | The supplied | |
7364 | .I names | |
7365 | are marked for automatic export to the environment of | |
7366 | subsequently executed commands. If the | |
7367 | .B \-f | |
7368 | option is given, | |
7369 | the | |
7370 | .I names | |
7371 | refer to functions. | |
7372 | If no | |
7373 | .I names | |
7374 | are given, or if the | |
7375 | .B \-p | |
7376 | option is supplied, a list | |
7377 | of all names that are exported in this shell is printed. | |
7378 | The | |
7379 | .B \-n | |
b80f6443 JA |
7380 | option causes the export property to be removed from each |
7381 | \fIname\fP. | |
7382 | If a variable name is followed by =\fIword\fP, the value of | |
7383 | the variable is set to \fIword\fP. | |
726f6388 | 7384 | .B export |
cce855bc | 7385 | returns an exit status of 0 unless an invalid option is |
726f6388 | 7386 | encountered, |
cce855bc | 7387 | one of the \fInames\fP is not a valid shell variable name, or |
726f6388 JA |
7388 | .B \-f |
7389 | is supplied with a | |
7390 | .I name | |
7391 | that is not a function. | |
7392 | .TP | |
3185942a | 7393 | \fBfc\fP [\fB\-e\fP \fIename\fP] [\fB\-lnr\fP] [\fIfirst\fP] [\fIlast\fP] |
7117c2d2 | 7394 | .PD 0 |
726f6388 JA |
7395 | .TP |
7396 | \fBfc\fP \fB\-s\fP [\fIpat\fP=\fIrep\fP] [\fIcmd\fP] | |
7397 | .PD | |
7398 | Fix Command. In the first form, a range of commands from | |
7399 | .I first | |
7400 | to | |
7401 | .I last | |
7402 | is selected from the history list. | |
7403 | .I First | |
7404 | and | |
7405 | .I last | |
7406 | may be specified as a string (to locate the last command beginning | |
7407 | with that string) or as a number (an index into the history list, | |
7408 | where a negative number is used as an offset from the current | |
7409 | command number). If | |
7410 | .I last | |
7411 | is not specified it is set to | |
7412 | the current command for listing (so that | |
bb70624e JA |
7413 | .if n ``fc \-l \-10'' |
7414 | .if t \f(CWfc \-l \-10\fP | |
726f6388 JA |
7415 | prints the last 10 commands) and to |
7416 | .I first | |
7417 | otherwise. | |
7418 | If | |
7419 | .I first | |
7420 | is not specified it is set to the previous | |
7421 | command for editing and \-16 for listing. | |
7422 | .sp 1 | |
7423 | The | |
7424 | .B \-n | |
cce855bc | 7425 | option suppresses |
726f6388 JA |
7426 | the command numbers when listing. The |
7427 | .B \-r | |
cce855bc | 7428 | option reverses the order of |
726f6388 JA |
7429 | the commands. If the |
7430 | .B \-l | |
cce855bc | 7431 | option is given, |
726f6388 JA |
7432 | the commands are listed on |
7433 | standard output. Otherwise, the editor given by | |
7434 | .I ename | |
7435 | is invoked | |
7436 | on a file containing those commands. If | |
7437 | .I ename | |
7438 | is not given, the | |
7439 | value of the | |
7440 | .SM | |
7441 | .B FCEDIT | |
7442 | variable is used, and | |
7443 | the value of | |
7444 | .SM | |
7445 | .B EDITOR | |
7446 | if | |
7447 | .SM | |
7448 | .B FCEDIT | |
7449 | is not set. If neither variable is set, | |
7450 | .FN vi | |
7451 | is used. When editing is complete, the edited commands are | |
7452 | echoed and executed. | |
7453 | .sp 1 | |
7454 | In the second form, \fIcommand\fP is re-executed after each instance | |
7455 | of \fIpat\fP is replaced by \fIrep\fP. | |
ccc6cda3 | 7456 | A useful alias to use with this is |
b80f6443 | 7457 | .if n ``r="fc -s"'', |
ccc6cda3 JA |
7458 | .if t \f(CWr='fc \-s'\fP, |
7459 | so that typing | |
7460 | .if n ``r cc'' | |
7461 | .if t \f(CWr cc\fP | |
7462 | runs the last command beginning with | |
7463 | .if n ``cc'' | |
7464 | .if t \f(CWcc\fP | |
7465 | and typing | |
7466 | .if n ``r'' | |
7467 | .if t \f(CWr\fP | |
726f6388 JA |
7468 | re-executes the last command. |
7469 | .sp 1 | |
cce855bc | 7470 | If the first form is used, the return value is 0 unless an invalid |
726f6388 JA |
7471 | option is encountered or |
7472 | .I first | |
7473 | or | |
7474 | .I last | |
7475 | specify history lines out of range. | |
7476 | If the | |
7477 | .B \-e | |
7478 | option is supplied, the return value is the value of the last | |
7479 | command executed or failure if an error occurs with the temporary | |
7480 | file of commands. If the second form is used, the return status | |
7481 | is that of the command re-executed, unless | |
7482 | .I cmd | |
7483 | does not specify a valid history line, in which case | |
7484 | .B fc | |
7485 | returns failure. | |
7486 | .TP | |
7487 | \fBfg\fP [\fIjobspec\fP] | |
cce855bc | 7488 | Resume |
726f6388 | 7489 | .I jobspec |
cce855bc JA |
7490 | in the foreground, and make it the current job. |
7491 | If | |
726f6388 JA |
7492 | .I jobspec |
7493 | is not present, the shell's notion of the \fIcurrent job\fP is used. | |
7494 | The return value is that of the command placed into the foreground, | |
7495 | or failure if run when job control is disabled or, when run with | |
7496 | job control enabled, if | |
7497 | .I jobspec | |
7498 | does not specify a valid job or | |
7499 | .I jobspec | |
7500 | specifies a job that was started without job control. | |
7501 | .TP | |
7502 | \fBgetopts\fP \fIoptstring\fP \fIname\fP [\fIargs\fP] | |
7503 | .B getopts | |
7504 | is used by shell procedures to parse positional parameters. | |
7505 | .I optstring | |
bb70624e | 7506 | contains the option characters to be recognized; if a character |
726f6388 JA |
7507 | is followed by a colon, the option is expected to have an |
7508 | argument, which should be separated from it by white space. | |
bb70624e JA |
7509 | The colon and question mark characters may not be used as |
7510 | option characters. | |
726f6388 JA |
7511 | Each time it is invoked, |
7512 | .B getopts | |
7513 | places the next option in the shell variable | |
7514 | .IR name , | |
7515 | initializing | |
7516 | .I name | |
7517 | if it does not exist, | |
7518 | and the index of the next argument to be processed into the | |
7519 | variable | |
7520 | .SM | |
7521 | .BR OPTIND . | |
7522 | .SM | |
7523 | .B OPTIND | |
7524 | is initialized to 1 each time the shell or a shell script | |
7525 | is invoked. When an option requires an argument, | |
7526 | .B getopts | |
7527 | places that argument into the variable | |
7528 | .SM | |
7529 | .BR OPTARG . | |
7530 | The shell does not reset | |
7531 | .SM | |
7532 | .B OPTIND | |
7533 | automatically; it must be manually reset between multiple | |
7534 | calls to | |
7535 | .B getopts | |
7536 | within the same shell invocation if a new set of parameters | |
7537 | is to be used. | |
7538 | .sp 1 | |
cce855bc JA |
7539 | When the end of options is encountered, \fBgetopts\fP exits with a |
7540 | return value greater than zero. | |
0001803f CR |
7541 | .SM |
7542 | .B OPTIND | |
7543 | is set to the index of the first non-option argument, | |
cce855bc JA |
7544 | and \fBname\fP is set to ?. |
7545 | .sp 1 | |
7546 | .B getopts | |
7547 | normally parses the positional parameters, but if more arguments are | |
7548 | given in | |
7549 | .IR args , | |
7550 | .B getopts | |
7551 | parses those instead. | |
7552 | .sp 1 | |
726f6388 JA |
7553 | .B getopts |
7554 | can report errors in two ways. If the first character of | |
7555 | .I optstring | |
7556 | is a colon, | |
7557 | .I silent | |
7558 | error reporting is used. In normal operation diagnostic messages | |
cce855bc | 7559 | are printed when invalid options or missing option arguments are |
726f6388 JA |
7560 | encountered. |
7561 | If the variable | |
7562 | .SM | |
7563 | .B OPTERR | |
cce855bc | 7564 | is set to 0, no error messages will be displayed, even if the first |
726f6388 JA |
7565 | character of |
7566 | .I optstring | |
7567 | is not a colon. | |
7568 | .sp 1 | |
cce855bc | 7569 | If an invalid option is seen, |
726f6388 JA |
7570 | .B getopts |
7571 | places ? into | |
7572 | .I name | |
7573 | and, if not silent, | |
7574 | prints an error message and unsets | |
7575 | .SM | |
7576 | .BR OPTARG . | |
7577 | If | |
7578 | .B getopts | |
7579 | is silent, | |
7580 | the option character found is placed in | |
7581 | .SM | |
7582 | .B OPTARG | |
7583 | and no diagnostic message is printed. | |
7584 | .sp 1 | |
7585 | If a required argument is not found, and | |
7586 | .B getopts | |
7587 | is not silent, | |
7588 | a question mark (\^\fB?\fP\^) is placed in | |
7589 | .IR name , | |
f73dda09 | 7590 | .SM |
726f6388 JA |
7591 | .B OPTARG |
7592 | is unset, and a diagnostic message is printed. | |
7593 | If | |
7594 | .B getopts | |
7595 | is silent, then a colon (\^\fB:\fP\^) is placed in | |
7596 | .I name | |
7597 | and | |
7598 | .SM | |
7599 | .B OPTARG | |
7600 | is set to the option character found. | |
7601 | .sp 1 | |
7602 | .B getopts | |
726f6388 JA |
7603 | returns true if an option, specified or unspecified, is found. |
7604 | It returns false if the end of options is encountered or an | |
7605 | error occurs. | |
7606 | .TP | |
7117c2d2 | 7607 | \fBhash\fP [\fB\-lr\fP] [\fB\-p\fP \fIfilename\fP] [\fB\-dt\fP] [\fIname\fP] |
726f6388 JA |
7608 | For each |
7609 | .IR name , | |
ccc6cda3 JA |
7610 | the full file name of the command is determined by searching |
7611 | the directories in | |
7612 | .B $PATH | |
7613 | and remembered. | |
7614 | If the | |
7615 | .B \-p | |
7616 | option is supplied, no path search is performed, and | |
7617 | .I filename | |
7618 | is used as the full file name of the command. | |
7619 | The | |
726f6388 JA |
7620 | .B \-r |
7621 | option causes the shell to forget all | |
f73dda09 | 7622 | remembered locations. |
7117c2d2 JA |
7623 | The |
7624 | .B \-d | |
7625 | option causes the shell to forget the remembered location of each \fIname\fP. | |
f73dda09 JA |
7626 | If the |
7627 | .B \-t | |
7628 | option is supplied, the full pathname to which each \fIname\fP corresponds | |
7629 | is printed. If multiple \fIname\fP arguments are supplied with \fB\-t\fP, | |
7630 | the \fIname\fP is printed before the hashed full pathname. | |
7117c2d2 JA |
7631 | The |
7632 | .B \-l | |
7633 | option causes output to be displayed in a format that may be reused as input. | |
7634 | If no arguments are given, or if only \fB\-l\fP is supplied, | |
7635 | information about remembered commands is printed. | |
ccc6cda3 | 7636 | The return status is true unless a |
726f6388 | 7637 | .I name |
cce855bc | 7638 | is not found or an invalid option is supplied. |
726f6388 | 7639 | .TP |
3185942a | 7640 | \fBhelp\fP [\fB\-dms\fP] [\fIpattern\fP] |
726f6388 JA |
7641 | Display helpful information about builtin commands. If |
7642 | .I pattern | |
7643 | is specified, | |
7644 | .B help | |
7645 | gives detailed help on all commands matching | |
7646 | .IR pattern ; | |
ccc6cda3 | 7647 | otherwise help for all the builtins and shell control structures |
bb70624e | 7648 | is printed. |
3185942a JA |
7649 | .RS |
7650 | .PD 0 | |
7651 | .TP | |
7652 | .B \-d | |
7653 | Display a short description of each \fIpattern\fP | |
7654 | .TP | |
0001803f | 7655 | .B \-m |
3185942a JA |
7656 | Display the description of each \fIpattern\fP in a manpage-like format |
7657 | .TP | |
7658 | .B \-s | |
7659 | Display only a short usage synopsis for each \fIpattern\fP | |
7660 | .PD | |
7661 | .RE | |
bb70624e | 7662 | The return status is 0 unless no command matches |
726f6388 JA |
7663 | .IR pattern . |
7664 | .TP | |
bb70624e | 7665 | \fBhistory [\fIn\fP] |
7117c2d2 | 7666 | .PD 0 |
bb70624e JA |
7667 | .TP |
7668 | \fBhistory\fP \fB\-c\fP | |
7669 | .TP | |
7670 | \fBhistory \-d\fP \fIoffset\fP | |
ccc6cda3 JA |
7671 | .TP |
7672 | \fBhistory\fP \fB\-anrw\fP [\fIfilename\fP] | |
726f6388 | 7673 | .TP |
ccc6cda3 JA |
7674 | \fBhistory\fP \fB\-p\fP \fIarg\fP [\fIarg ...\fP] |
7675 | .TP | |
7676 | \fBhistory\fP \fB\-s\fP \fIarg\fP [\fIarg ...\fP] | |
726f6388 JA |
7677 | .PD |
7678 | With no options, display the command | |
7679 | history list with line numbers. Lines listed | |
7680 | with a | |
7681 | .B * | |
7682 | have been modified. An argument of | |
7683 | .I n | |
7684 | lists only the last | |
7685 | .I n | |
b80f6443 | 7686 | lines. |
0001803f CR |
7687 | If the shell variable |
7688 | .SM | |
7689 | .B HISTTIMEFORMAT | |
7690 | is set and not null, | |
b80f6443 JA |
7691 | it is used as a format string for \fIstrftime\fP(3) to display |
7692 | the time stamp associated with each displayed history entry. | |
7693 | No intervening blank is printed between the formatted time stamp | |
7694 | and the history line. | |
7695 | If \fIfilename\fP is supplied, it is used as the | |
726f6388 JA |
7696 | name of the history file; if not, the value of |
7697 | .SM | |
7698 | .B HISTFILE | |
7699 | is used. Options, if supplied, have the following meanings: | |
7700 | .RS | |
7701 | .PD 0 | |
7702 | .TP | |
bb70624e JA |
7703 | .B \-c |
7704 | Clear the history list by deleting all the entries. | |
7705 | .TP | |
7706 | \fB\-d\fP \fIoffset\fP | |
7707 | Delete the history entry at position \fIoffset\fP. | |
7708 | .TP | |
726f6388 JA |
7709 | .B \-a |
7710 | Append the ``new'' history lines (history lines entered since the | |
ccc6cda3 | 7711 | beginning of the current \fBbash\fP session) to the history file. |
726f6388 JA |
7712 | .TP |
7713 | .B \-n | |
7714 | Read the history lines not already read from the history | |
7715 | file into the current history list. These are lines | |
7716 | appended to the history file since the beginning of the | |
7717 | current \fBbash\fP session. | |
7718 | .TP | |
7719 | .B \-r | |
7720 | Read the contents of the history file | |
ccc6cda3 | 7721 | and use them as the current history. |
726f6388 JA |
7722 | .TP |
7723 | .B \-w | |
7724 | Write the current history to the history file, overwriting the | |
7725 | history file's contents. | |
ccc6cda3 | 7726 | .TP |
ccc6cda3 JA |
7727 | .B \-p |
7728 | Perform history substitution on the following \fIargs\fP and display | |
7729 | the result on the standard output. | |
7730 | Does not store the results in the history list. | |
7731 | Each \fIarg\fP must be quoted to disable normal history expansion. | |
7732 | .TP | |
7733 | .B \-s | |
7734 | Store the | |
7735 | .I args | |
7736 | in the history list as a single entry. The last command in the | |
7737 | history list is removed before the | |
7738 | .I args | |
7739 | are added. | |
726f6388 JA |
7740 | .PD |
7741 | .PP | |
0001803f CR |
7742 | If the |
7743 | .SM | |
7744 | .B HISTTIMEFORMAT | |
7745 | variable is set, the time stamp information | |
3185942a JA |
7746 | associated with each history entry is written to the history file, |
7747 | marked with the history comment character. | |
7748 | When the history file is read, lines beginning with the history | |
7749 | comment character followed immediately by a digit are interpreted | |
7750 | as timestamps for the previous history line. | |
bb70624e JA |
7751 | The return value is 0 unless an invalid option is encountered, an |
7752 | error occurs while reading or writing the history file, an invalid | |
7753 | \fIoffset\fP is supplied as an argument to \fB\-d\fP, or the | |
7754 | history expansion supplied as an argument to \fB\-p\fP fails. | |
726f6388 JA |
7755 | .RE |
7756 | .TP | |
ccc6cda3 | 7757 | \fBjobs\fP [\fB\-lnprs\fP] [ \fIjobspec\fP ... ] |
7117c2d2 | 7758 | .PD 0 |
726f6388 JA |
7759 | .TP |
7760 | \fBjobs\fP \fB\-x\fP \fIcommand\fP [ \fIargs\fP ... ] | |
7761 | .PD | |
ccc6cda3 JA |
7762 | The first form lists the active jobs. The options have the following |
7763 | meanings: | |
7764 | .RS | |
7765 | .PD 0 | |
7766 | .TP | |
726f6388 | 7767 | .B \-l |
ccc6cda3 JA |
7768 | List process IDs |
7769 | in addition to the normal information. | |
7770 | .TP | |
726f6388 | 7771 | .B \-p |
ccc6cda3 JA |
7772 | List only the process ID of the job's process group |
7773 | leader. | |
7774 | .TP | |
726f6388 | 7775 | .B \-n |
ccc6cda3 JA |
7776 | Display information only about jobs that have changed status since |
7777 | the user was last notified of their status. | |
7778 | .TP | |
7779 | .B \-r | |
7780 | Restrict output to running jobs. | |
7781 | .TP | |
7782 | .B \-s | |
7783 | Restrict output to stopped jobs. | |
7784 | .PD | |
7785 | .PP | |
7786 | If | |
726f6388 JA |
7787 | .I jobspec |
7788 | is given, output is restricted to information about that job. | |
cce855bc JA |
7789 | The return status is 0 unless an invalid option is encountered |
7790 | or an invalid | |
726f6388 JA |
7791 | .I jobspec |
7792 | is supplied. | |
ccc6cda3 | 7793 | .PP |
726f6388 JA |
7794 | If the |
7795 | .B \-x | |
7796 | option is supplied, | |
7797 | .B jobs | |
7798 | replaces any | |
7799 | .I jobspec | |
7800 | found in | |
7801 | .I command | |
7802 | or | |
7803 | .I args | |
7804 | with the corresponding process group ID, and executes | |
7805 | .I command | |
7806 | passing it | |
7807 | .IR args , | |
7808 | returning its exit status. | |
ccc6cda3 | 7809 | .RE |
726f6388 | 7810 | .TP |
ccc6cda3 | 7811 | \fBkill\fP [\fB\-s\fP \fIsigspec\fP | \fB\-n\fP \fIsignum\fP | \fB\-\fP\fIsigspec\fP] [\fIpid\fP | \fIjobspec\fP] ... |
7117c2d2 | 7812 | .PD 0 |
726f6388 | 7813 | .TP |
cce855bc | 7814 | \fBkill\fP \fB\-l\fP [\fIsigspec\fP | \fIexit_status\fP] |
726f6388 JA |
7815 | .PD |
7816 | Send the signal named by | |
7817 | .I sigspec | |
ccc6cda3 JA |
7818 | or |
7819 | .I signum | |
726f6388 JA |
7820 | to the processes named by |
7821 | .I pid | |
7822 | or | |
7823 | .IR jobspec . | |
7824 | .I sigspec | |
b80f6443 | 7825 | is either a case-insensitive signal name such as |
726f6388 JA |
7826 | .SM |
7827 | .B SIGKILL | |
b80f6443 | 7828 | (with or without the |
726f6388 JA |
7829 | .SM |
7830 | .B SIG | |
b80f6443 JA |
7831 | prefix) or a signal number; |
7832 | .I signum | |
7833 | is a signal number. | |
726f6388 JA |
7834 | If |
7835 | .I sigspec | |
7836 | is not present, then | |
7837 | .SM | |
7838 | .B SIGTERM | |
cce855bc JA |
7839 | is assumed. |
7840 | An argument of | |
726f6388 | 7841 | .B \-l |
cce855bc JA |
7842 | lists the signal names. |
7843 | If any arguments are supplied when | |
726f6388 | 7844 | .B \-l |
cce855bc JA |
7845 | is given, the names of the signals corresponding to the arguments are |
7846 | listed, and the return status is 0. | |
7847 | The \fIexit_status\fP argument to | |
ccc6cda3 | 7848 | .B \-l |
cce855bc JA |
7849 | is a number specifying either a signal number or the exit status of |
7850 | a process terminated by a signal. | |
726f6388 JA |
7851 | .B kill |
7852 | returns true if at least one signal was successfully sent, or false | |
cce855bc | 7853 | if an error occurs or an invalid option is encountered. |
726f6388 JA |
7854 | .TP |
7855 | \fBlet\fP \fIarg\fP [\fIarg\fP ...] | |
7856 | Each | |
7857 | .I arg | |
7858 | is an arithmetic expression to be evaluated (see | |
7859 | .SM | |
0001803f CR |
7860 | .B "ARITHMETIC EVALUATION" |
7861 | above). | |
726f6388 JA |
7862 | If the last |
7863 | .I arg | |
7864 | evaluates to 0, | |
7865 | .B let | |
7866 | returns 1; 0 is returned otherwise. | |
7867 | .TP | |
bb70624e | 7868 | \fBlocal\fP [\fIoption\fP] [\fIname\fP[=\fIvalue\fP] ...] |
cce855bc JA |
7869 | For each argument, a local variable named |
7870 | .I name | |
7871 | is created, and assigned | |
726f6388 | 7872 | .IR value . |
bb70624e | 7873 | The \fIoption\fP can be any of the options accepted by \fBdeclare\fP. |
726f6388 JA |
7874 | When |
7875 | .B local | |
7876 | is used within a function, it causes the variable | |
7877 | .I name | |
7878 | to have a visible scope restricted to that function and its children. | |
7879 | With no operands, | |
7880 | .B local | |
7881 | writes a list of local variables to the standard output. It is | |
7882 | an error to use | |
7883 | .B local | |
7884 | when not within a function. The return status is 0 unless | |
7885 | .B local | |
bb70624e | 7886 | is used outside a function, an invalid |
726f6388 | 7887 | .I name |
bb70624e JA |
7888 | is supplied, or |
7889 | \fIname\fP is a readonly variable. | |
726f6388 JA |
7890 | .TP |
7891 | .B logout | |
7892 | Exit a login shell. | |
7893 | .TP | |
3185942a | 7894 | \fBmapfile\fP [\fB\-n\fP \fIcount\fP] [\fB\-O\fP \fIorigin\fP] [\fB\-s\fP \fIcount\fP] [\fB\-t\fP] [\fB\-u\fP \fIfd\fP] [\fB\-C\fP \fIcallback\fP] [\fB\-c\fP \fIquantum\fP] [\fIarray\fP] |
17345e5a JA |
7895 | .PD 0 |
7896 | .TP | |
7897 | \fBreadarray\fP [\fB\-n\fP \fIcount\fP] [\fB\-O\fP \fIorigin\fP] [\fB\-s\fP \fIcount\fP] [\fB\-t\fP] [\fB\-u\fP \fIfd\fP] [\fB\-C\fP \fIcallback\fP] [\fB\-c\fP \fIquantum\fP] [\fIarray\fP] | |
7898 | .PD | |
0001803f | 7899 | Read lines from the standard input into the indexed array variable |
3185942a JA |
7900 | .IR array , |
7901 | or from file descriptor | |
7902 | .IR fd | |
7903 | if the | |
7904 | .B \-u | |
7905 | option is supplied. | |
0001803f CR |
7906 | The variable |
7907 | .SM | |
7908 | .B MAPFILE | |
7909 | is the default \fIarray\fP. | |
3185942a JA |
7910 | Options, if supplied, have the following meanings: |
7911 | .RS | |
7912 | .PD 0 | |
7913 | .TP | |
7914 | .B \-n | |
7915 | Copy at most | |
7916 | .I count | |
7917 | lines. If \fIcount\fP is 0, all lines are copied. | |
7918 | .TP | |
7919 | .B \-O | |
7920 | Begin assigning to | |
7921 | .I array | |
7922 | at index | |
7923 | .IR origin . | |
7924 | The default index is 0. | |
7925 | .TP | |
7926 | .B \-s | |
7927 | Discard the first \fIcount\fP lines read. | |
7928 | .TP | |
7929 | .B \-t | |
0001803f | 7930 | Remove a trailing newline from each line read. |
3185942a JA |
7931 | .TP |
7932 | .B \-u | |
7933 | Read lines from file descriptor \fIfd\fP instead of the standard input. | |
7934 | .TP | |
7935 | .B \-C | |
7936 | Evaluate | |
7937 | .I callback | |
7938 | each time \fIquantum\fP lines are read. The \fB\-c\fP option specifies | |
7939 | .IR quantum . | |
7940 | .TP | |
7941 | .B \-c | |
7942 | Specify the number of lines read between each call to | |
7943 | .IR callback . | |
7944 | .PD | |
7945 | .PP | |
7946 | If | |
7947 | .B \-C | |
7948 | is specified without | |
7949 | .BR \-c , | |
7950 | the default quantum is 5000. | |
17345e5a JA |
7951 | When \fIcallback\fP is evaluated, it is supplied the index of the next |
7952 | array element to be assigned as an additional argument. | |
7953 | \fIcallback\fP is evaluated after the line is read but before the | |
7954 | array element is assigned. | |
3185942a JA |
7955 | .PP |
7956 | If not supplied with an explicit origin, \fBmapfile\fP will clear \fIarray\fP | |
7957 | before assigning to it. | |
7958 | .PP | |
7959 | \fBmapfile\fP returns successfully unless an invalid option or option | |
0001803f CR |
7960 | argument is supplied, \fIarray\fP is invalid or unassignable, or if |
7961 | \fIarray\fP is not an indexed array. | |
3185942a JA |
7962 | .RE |
7963 | .TP | |
ccc6cda3 | 7964 | \fBpopd\fP [\-\fBn\fP] [+\fIn\fP] [\-\fIn\fP] |
726f6388 JA |
7965 | Removes entries from the directory stack. With no arguments, |
7966 | removes the top directory from the stack, and performs a | |
7967 | .B cd | |
7968 | to the new top directory. | |
ccc6cda3 | 7969 | Arguments, if supplied, have the following meanings: |
726f6388 JA |
7970 | .RS |
7971 | .PD 0 | |
7972 | .TP | |
3185942a JA |
7973 | .B \-n |
7974 | Suppresses the normal change of directory when removing directories | |
7975 | from the stack, so that only the stack is manipulated. | |
7976 | .TP | |
ccc6cda3 JA |
7977 | \fB+\fP\fIn\fP |
7978 | Removes the \fIn\fPth entry counting from the left of the list | |
726f6388 JA |
7979 | shown by |
7980 | .BR dirs , | |
bb70624e JA |
7981 | starting with zero. For example: |
7982 | .if n ``popd +0'' | |
7983 | .if t \f(CWpopd +0\fP | |
7984 | removes the first directory, | |
7985 | .if n ``popd +1'' | |
7986 | .if t \f(CWpopd +1\fP | |
7987 | the second. | |
726f6388 | 7988 | .TP |
ccc6cda3 JA |
7989 | \fB\-\fP\fIn\fP |
7990 | Removes the \fIn\fPth entry counting from the right of the list | |
726f6388 JA |
7991 | shown by |
7992 | .BR dirs , | |
bb70624e JA |
7993 | starting with zero. For example: |
7994 | .if n ``popd -0'' | |
7995 | .if t \f(CWpopd -0\fP | |
7996 | removes the last directory, | |
7997 | .if n ``popd -1'' | |
7998 | .if t \f(CWpopd -1\fP | |
7999 | the next to last. | |
726f6388 JA |
8000 | .PD |
8001 | .PP | |
8002 | If the | |
8003 | .B popd | |
8004 | command is successful, a | |
8005 | .B dirs | |
8006 | is performed as well, and the return status is 0. | |
8007 | .B popd | |
cce855bc | 8008 | returns false if an invalid option is encountered, the directory stack |
726f6388 JA |
8009 | is empty, a non-existent directory stack entry is specified, or the |
8010 | directory change fails. | |
8011 | .RE | |
8012 | .TP | |
95732b49 | 8013 | \fBprintf\fP [\fB\-v\fP \fIvar\fP] \fIformat\fP [\fIarguments\fP] |
cce855bc JA |
8014 | Write the formatted \fIarguments\fP to the standard output under the |
8015 | control of the \fIformat\fP. | |
8016 | The \fIformat\fP is a character string which contains three types of objects: | |
8017 | plain characters, which are simply copied to standard output, character | |
8018 | escape sequences, which are converted and copied to the standard output, and | |
8019 | format specifications, each of which causes printing of the next successive | |
8020 | \fIargument\fP. | |
f73dda09 | 8021 | In addition to the standard \fIprintf\fP(1) formats, \fB%b\fP causes |
cce855bc | 8022 | \fBprintf\fP to expand backslash escape sequences in the corresponding |
b80f6443 | 8023 | \fIargument\fP (except that \fB\ec\fP terminates output, backslashes in |
0628567a | 8024 | \fB\e\(aq\fP, \fB\e"\fP, and \fB\e?\fP are not removed, and octal escapes |
b80f6443 JA |
8025 | beginning with \fB\e0\fP may contain up to four digits), |
8026 | and \fB%q\fP causes \fBprintf\fP to output the corresponding | |
cce855bc JA |
8027 | \fIargument\fP in a format that can be reused as shell input. |
8028 | .sp 1 | |
95732b49 JA |
8029 | The \fB\-v\fP option causes the output to be assigned to the variable |
8030 | \fIvar\fP rather than being printed to the standard output. | |
8031 | .sp 1 | |
cce855bc JA |
8032 | The \fIformat\fP is reused as necessary to consume all of the \fIarguments\fP. |
8033 | If the \fIformat\fP requires more \fIarguments\fP than are supplied, the | |
8034 | extra format specifications behave as if a zero value or null string, as | |
bb70624e JA |
8035 | appropriate, had been supplied. The return value is zero on success, |
8036 | non-zero on failure. | |
cce855bc | 8037 | .TP |
3185942a | 8038 | \fBpushd\fP [\fB\-n\fP] [+\fIn\fP] [\-\fIn\fP] |
7117c2d2 | 8039 | .PD 0 |
726f6388 | 8040 | .TP |
3185942a | 8041 | \fBpushd\fP [\fB\-n\fP] [\fIdir\fP] |
726f6388 JA |
8042 | .PD |
8043 | Adds a directory to the top of the directory stack, or rotates | |
8044 | the stack, making the new top of the stack the current working | |
8045 | directory. With no arguments, exchanges the top two directories | |
8046 | and returns 0, unless the directory stack is empty. | |
ccc6cda3 | 8047 | Arguments, if supplied, have the following meanings: |
726f6388 JA |
8048 | .RS |
8049 | .PD 0 | |
8050 | .TP | |
3185942a JA |
8051 | .B \-n |
8052 | Suppresses the normal change of directory when adding directories | |
8053 | to the stack, so that only the stack is manipulated. | |
8054 | .TP | |
ccc6cda3 | 8055 | \fB+\fP\fIn\fP |
726f6388 JA |
8056 | Rotates the stack so that the \fIn\fPth directory |
8057 | (counting from the left of the list shown by | |
d166f048 JA |
8058 | .BR dirs , |
8059 | starting with zero) | |
726f6388 JA |
8060 | is at the top. |
8061 | .TP | |
ccc6cda3 | 8062 | \fB\-\fP\fIn\fP |
726f6388 | 8063 | Rotates the stack so that the \fIn\fPth directory |
d166f048 JA |
8064 | (counting from the right of the list shown by |
8065 | .BR dirs , | |
8066 | starting with zero) is at the top. | |
726f6388 | 8067 | .TP |
bb70624e | 8068 | .I dir |
ccc6cda3 | 8069 | Adds |
726f6388 JA |
8070 | .I dir |
8071 | to the directory stack at the top, making it the | |
8072 | new current working directory. | |
8073 | .PD | |
8074 | .PP | |
8075 | If the | |
8076 | .B pushd | |
8077 | command is successful, a | |
8078 | .B dirs | |
8079 | is performed as well. | |
8080 | If the first form is used, | |
8081 | .B pushd | |
8082 | returns 0 unless the cd to | |
8083 | .I dir | |
8084 | fails. With the second form, | |
8085 | .B pushd | |
8086 | returns 0 unless the directory stack is empty, | |
ccc6cda3 | 8087 | a non-existent directory stack element is specified, |
726f6388 JA |
8088 | or the directory change to the specified new current directory |
8089 | fails. | |
8090 | .RE | |
8091 | .TP | |
ccc6cda3 | 8092 | \fBpwd\fP [\fB\-LP\fP] |
bb70624e JA |
8093 | Print the absolute pathname of the current working directory. |
8094 | The pathname printed contains no symbolic links if the | |
726f6388 | 8095 | .B \-P |
ccc6cda3 JA |
8096 | option is supplied or the |
8097 | .B \-o physical | |
726f6388 JA |
8098 | option to the |
8099 | .B set | |
ccc6cda3 JA |
8100 | builtin command is enabled. |
8101 | If the | |
8102 | .B \-L | |
bb70624e | 8103 | option is used, the pathname printed may contain symbolic links. |
ccc6cda3 | 8104 | The return status is 0 unless an error occurs while |
cce855bc JA |
8105 | reading the name of the current directory or an |
8106 | invalid option is supplied. | |
726f6388 | 8107 | .TP |
0001803f | 8108 | \fBread\fP [\fB\-ers\fP] [\fB\-a\fP \fIaname\fP] [\fB\-d\fP \fIdelim\fP] [\fB\-i\fP \fItext\fP] [\fB\-n\fP \fInchars\fP] [\fB\-N\fP \fInchars\fP] [\fB\-p\fP \fIprompt\fP] [\fB\-t\fP \fItimeout\fP] [\fB\-u\fP \fIfd\fP] [\fIname\fP ...] |
7117c2d2 JA |
8109 | One line is read from the standard input, or from the file descriptor |
8110 | \fIfd\fP supplied as an argument to the \fB\-u\fP option, and the first word | |
726f6388 JA |
8111 | is assigned to the first |
8112 | .IR name , | |
8113 | the second word to the second | |
8114 | .IR name , | |
cce855bc JA |
8115 | and so on, with leftover words and their intervening separators assigned |
8116 | to the last | |
726f6388 | 8117 | .IR name . |
7117c2d2 | 8118 | If there are fewer words read from the input stream than names, |
cce855bc JA |
8119 | the remaining names are assigned empty values. |
8120 | The characters in | |
726f6388 JA |
8121 | .SM |
8122 | .B IFS | |
cce855bc | 8123 | are used to split the line into words. |
b72432fd JA |
8124 | The backslash character (\fB\e\fP) may be used to remove any special |
8125 | meaning for the next character read and for line continuation. | |
cce855bc | 8126 | Options, if supplied, have the following meanings: |
ccc6cda3 JA |
8127 | .RS |
8128 | .PD 0 | |
8129 | .TP | |
bb70624e | 8130 | .B \-a \fIaname\fP |
ccc6cda3 JA |
8131 | The words are assigned to sequential indices |
8132 | of the array variable | |
8133 | .IR aname , | |
8134 | starting at 0. | |
8135 | .I aname | |
8136 | is unset before any new values are assigned. | |
cce855bc | 8137 | Other \fIname\fP arguments are ignored. |
ccc6cda3 | 8138 | .TP |
bb70624e JA |
8139 | .B \-d \fIdelim\fP |
8140 | The first character of \fIdelim\fP is used to terminate the input line, | |
8141 | rather than newline. | |
8142 | .TP | |
ccc6cda3 JA |
8143 | .B \-e |
8144 | If the standard input | |
8145 | is coming from a terminal, | |
8146 | .B readline | |
8147 | (see | |
8148 | .SM | |
8149 | .B READLINE | |
8150 | above) is used to obtain the line. | |
3185942a JA |
8151 | Readline uses the current (or default, if line editing was not previously |
8152 | active) editing settings. | |
8153 | .TP | |
8154 | .B \-i \fItext\fP | |
8155 | If | |
8156 | .B readline | |
8157 | is being used to read the line, \fItext\fP is placed into the editing | |
8158 | buffer before editing begins. | |
bb70624e JA |
8159 | .TP |
8160 | .B \-n \fInchars\fP | |
8161 | \fBread\fP returns after reading \fInchars\fP characters rather than | |
0001803f CR |
8162 | waiting for a complete line of input, but honor a delimiter if fewer |
8163 | than \fInchars\fP characters are read before the delimiter. | |
8164 | .TP | |
8165 | .B \-N \fInchars\fP | |
8166 | \fBread\fP returns after reading exactly \fInchars\fP characters rather | |
8167 | than waiting for a complete line of input, unless EOF is encountered or | |
8168 | \fBread\fP times out. | |
8169 | Delimiter characters encountered in the input are | |
8170 | not treated specially and do not cause \fBread\fP to return until | |
8171 | \fInchars\fP characters are read. | |
bb70624e JA |
8172 | .TP |
8173 | .B \-p \fIprompt\fP | |
f73dda09 | 8174 | Display \fIprompt\fP on standard error, without a |
bb70624e JA |
8175 | trailing newline, before attempting to read any input. The prompt |
8176 | is displayed only if input is coming from a terminal. | |
8177 | .TP | |
8178 | .B \-r | |
8179 | Backslash does not act as an escape character. | |
8180 | The backslash is considered to be part of the line. | |
8181 | In particular, a backslash-newline pair may not be used as a line | |
8182 | continuation. | |
8183 | .TP | |
8184 | .B \-s | |
8185 | Silent mode. If input is coming from a terminal, characters are | |
8186 | not echoed. | |
8187 | .TP | |
8188 | .B \-t \fItimeout\fP | |
8189 | Cause \fBread\fP to time out and return failure if a complete line of | |
8190 | input is not read within \fItimeout\fP seconds. | |
3185942a JA |
8191 | \fItimeout\fP may be a decimal number with a fractional portion following |
8192 | the decimal point. | |
8193 | This option is only effective if \fBread\fP is reading input from a | |
8194 | terminal, pipe, or other special file; it has no effect when reading | |
8195 | from regular files. | |
8196 | If \fItimeout\fP is 0, \fBread\fP returns success if input is available on | |
8197 | the specified file descriptor, failure otherwise. | |
8198 | The exit status is greater than 128 if the timeout is exceeded. | |
7117c2d2 | 8199 | .TP |
95732b49 | 8200 | .B \-u \fIfd\fP |
7117c2d2 | 8201 | Read input from file descriptor \fIfd\fP. |
ccc6cda3 JA |
8202 | .PD |
8203 | .PP | |
8204 | If no | |
726f6388 JA |
8205 | .I names |
8206 | are supplied, the line read is assigned to the variable | |
8207 | .SM | |
8208 | .BR REPLY . | |
7117c2d2 | 8209 | The return code is zero, unless end-of-file is encountered, \fBread\fP |
3185942a JA |
8210 | times out (in which case the return code is greater than 128), or an |
8211 | invalid file descriptor is supplied as the argument to \fB\-u\fP. | |
ccc6cda3 | 8212 | .RE |
726f6388 | 8213 | .TP |
3185942a | 8214 | \fBreadonly\fP [\fB\-aApf\fP] [\fIname\fP[=\fIword\fP] ...] |
726f6388 JA |
8215 | .PD |
8216 | The given | |
ccc6cda3 JA |
8217 | \fInames\fP are marked readonly; the values of these |
8218 | .I names | |
726f6388 JA |
8219 | may not be changed by subsequent assignment. |
8220 | If the | |
8221 | .B \-f | |
8222 | option is supplied, the functions corresponding to the | |
8223 | \fInames\fP are so | |
ccc6cda3 JA |
8224 | marked. |
8225 | The | |
8226 | .B \-a | |
3185942a JA |
8227 | option restricts the variables to indexed arrays; the |
8228 | .B \-A | |
8229 | option restricts the variables to associative arrays. | |
ccc6cda3 JA |
8230 | If no |
8231 | .I name | |
8232 | arguments are given, or if the | |
726f6388 | 8233 | .B \-p |
ccc6cda3 | 8234 | option is supplied, a list of all readonly names is printed. |
cce855bc JA |
8235 | The |
8236 | .B \-p | |
bb70624e JA |
8237 | option causes output to be displayed in a format that |
8238 | may be reused as input. | |
b80f6443 JA |
8239 | If a variable name is followed by =\fIword\fP, the value of |
8240 | the variable is set to \fIword\fP. | |
cce855bc | 8241 | The return status is 0 unless an invalid option is encountered, |
ccc6cda3 JA |
8242 | one of the |
8243 | .I names | |
cce855bc | 8244 | is not a valid shell variable name, or |
726f6388 JA |
8245 | .B \-f |
8246 | is supplied with a | |
8247 | .I name | |
8248 | that is not a function. | |
8249 | .TP | |
8250 | \fBreturn\fP [\fIn\fP] | |
8251 | Causes a function to exit with the return value specified by | |
8252 | .IR n . | |
8253 | If | |
8254 | .I n | |
8255 | is omitted, the return status is that of the last command | |
8256 | executed in the function body. If used outside a function, | |
8257 | but during execution of a script by the | |
8258 | .B . | |
8259 | (\fBsource\fP) command, it causes the shell to stop executing | |
8260 | that script and return either | |
8261 | .I n | |
8262 | or the exit status of the last command executed within the | |
8263 | script as the exit status of the script. If used outside a | |
8264 | function and not during execution of a script by \fB.\fP\^, | |
8265 | the return status is false. | |
b80f6443 JA |
8266 | Any command associated with the \fBRETURN\fP trap is executed |
8267 | before execution resumes after the function or script. | |
726f6388 | 8268 | .TP |
3185942a JA |
8269 | \fBset\fP [\fB\-\-abefhkmnptuvxBCEHPT\fP] [\fB\-o\fP \fIoption\fP] [\fIarg\fP ...] |
8270 | .PD 0 | |
8271 | .TP | |
8272 | \fBset\fP [\fB+abefhkmnptuvxBCEHPT\fP] [\fB+o\fP \fIoption\fP] [\fIarg\fP ...] | |
8273 | .PD | |
ccc6cda3 | 8274 | Without options, the name and value of each shell variable are displayed |
95732b49 JA |
8275 | in a format that can be reused as input |
8276 | for setting or resetting the currently-set variables. | |
8277 | Read-only variables cannot be reset. | |
8278 | In \fIposix mode\fP, only shell variables are listed. | |
cce855bc | 8279 | The output is sorted according to the current locale. |
ccc6cda3 | 8280 | When options are specified, they set or unset shell attributes. |
3185942a | 8281 | Any arguments remaining after option processing are treated |
ccc6cda3 JA |
8282 | as values for the positional parameters and are assigned, in order, to |
8283 | .BR $1 , | |
8284 | .BR $2 , | |
8285 | .B ... | |
8286 | .BR $\fIn\fP . | |
8287 | Options, if specified, have the following meanings: | |
726f6388 JA |
8288 | .RS |
8289 | .PD 0 | |
8290 | .TP 8 | |
8291 | .B \-a | |
b80f6443 JA |
8292 | Automatically mark variables and functions which are modified or |
8293 | created for export to the environment of subsequent commands. | |
726f6388 JA |
8294 | .TP 8 |
8295 | .B \-b | |
ccc6cda3 JA |
8296 | Report the status of terminated background jobs |
8297 | immediately, rather than before the next primary prompt. This is | |
8298 | effective only when job control is enabled. | |
726f6388 JA |
8299 | .TP 8 |
8300 | .B \-e | |
17345e5a JA |
8301 | Exit immediately if a \fIpipeline\fP (which may consist of a single |
8302 | \fIsimple command\fP), a \fIsubshell\fP command enclosed in parentheses, | |
8303 | or one of the commands executed as part of a command list enclosed | |
8304 | by braces (see | |
726f6388 JA |
8305 | .SM |
8306 | .B SHELL GRAMMAR | |
b80f6443 JA |
8307 | above) exits with a non-zero status. |
8308 | The shell does not exit if the | |
8309 | command that fails is part of the command list immediately following a | |
8310 | .B while | |
726f6388 | 8311 | or |
b80f6443 JA |
8312 | .B until |
8313 | keyword, | |
17345e5a | 8314 | part of the test following the |
3185942a | 8315 | .B if |
17345e5a JA |
8316 | or |
8317 | .B elif | |
8318 | reserved words, part of any command executed in a | |
726f6388 JA |
8319 | .B && |
8320 | or | |
ccc6cda3 | 8321 | .B \(bv\(bv |
17345e5a | 8322 | list except the command following the final \fB&&\fP or \fB\(bv\(bv\fP, |
3185942a JA |
8323 | any command in a pipeline but the last, |
8324 | or if the command's return value is | |
17345e5a | 8325 | being inverted with |
726f6388 | 8326 | .BR ! . |
f73dda09 | 8327 | A trap on \fBERR\fP, if set, is executed before the shell exits. |
17345e5a JA |
8328 | This option applies to the shell environment and each subshell environment |
8329 | separately (see | |
0001803f | 8330 | .SM |
17345e5a JA |
8331 | .B "COMMAND EXECUTION ENVIRONMENT" |
8332 | above), and may cause | |
8333 | subshells to exit before executing all the commands in the subshell. | |
726f6388 JA |
8334 | .TP 8 |
8335 | .B \-f | |
8336 | Disable pathname expansion. | |
8337 | .TP 8 | |
8338 | .B \-h | |
ccc6cda3 | 8339 | Remember the location of commands as they are looked up for execution. |
cce855bc | 8340 | This is enabled by default. |
726f6388 JA |
8341 | .TP 8 |
8342 | .B \-k | |
ccc6cda3 JA |
8343 | All arguments in the form of assignment statements |
8344 | are placed in the environment for a command, not just | |
8345 | those that precede the command name. | |
726f6388 JA |
8346 | .TP 8 |
8347 | .B \-m | |
cce855bc | 8348 | Monitor mode. Job control is enabled. This option is on |
726f6388 JA |
8349 | by default for interactive shells on systems that support |
8350 | it (see | |
8351 | .SM | |
8352 | .B JOB CONTROL | |
8353 | above). Background processes run in a separate process | |
8354 | group and a line containing their exit status is printed | |
8355 | upon their completion. | |
8356 | .TP 8 | |
8357 | .B \-n | |
8358 | Read commands but do not execute them. This may be used to | |
ccc6cda3 | 8359 | check a shell script for syntax errors. This is ignored by |
726f6388 JA |
8360 | interactive shells. |
8361 | .TP 8 | |
ccc6cda3 JA |
8362 | .B \-o \fIoption\-name\fP |
8363 | The \fIoption\-name\fP can be one of the following: | |
726f6388 JA |
8364 | .RS |
8365 | .TP 8 | |
8366 | .B allexport | |
8367 | Same as | |
8368 | .BR \-a . | |
8369 | .TP 8 | |
8370 | .B braceexpand | |
ccc6cda3 JA |
8371 | Same as |
8372 | .BR \-B . | |
726f6388 JA |
8373 | .TP 8 |
8374 | .B emacs | |
8375 | Use an emacs-style command line editing interface. This is enabled | |
8376 | by default when the shell is interactive, unless the shell is started | |
8377 | with the | |
ccc6cda3 | 8378 | .B \-\-noediting |
726f6388 | 8379 | option. |
3185942a | 8380 | This also affects the editing interface used for \fBread \-e\fP. |
726f6388 | 8381 | .TP 8 |
0001803f CR |
8382 | .B errexit |
8383 | Same as | |
8384 | .BR \-e . | |
8385 | .TP 8 | |
b80f6443 JA |
8386 | .B errtrace |
8387 | Same as | |
8388 | .BR \-E . | |
8389 | .TP 8 | |
8390 | .B functrace | |
8391 | Same as | |
8392 | .BR \-T . | |
8393 | .TP 8 | |
ccc6cda3 JA |
8394 | .B hashall |
8395 | Same as | |
8396 | .BR \-h . | |
8397 | .TP 8 | |
726f6388 JA |
8398 | .B histexpand |
8399 | Same as | |
8400 | .BR \-H . | |
8401 | .TP 8 | |
ccc6cda3 JA |
8402 | .B history |
8403 | Enable command history, as described above under | |
8404 | .SM | |
8405 | .BR HISTORY . | |
8406 | This option is on by default in interactive shells. | |
8407 | .TP 8 | |
726f6388 | 8408 | .B ignoreeof |
28ef6c31 JA |
8409 | The effect is as if the shell command |
8410 | .if t \f(CWIGNOREEOF=10\fP | |
8411 | .if n ``IGNOREEOF=10'' | |
8412 | had been executed | |
726f6388 JA |
8413 | (see |
8414 | .B Shell Variables | |
8415 | above). | |
8416 | .TP 8 | |
ccc6cda3 JA |
8417 | .B keyword |
8418 | Same as | |
8419 | .BR \-k . | |
726f6388 JA |
8420 | .TP 8 |
8421 | .B monitor | |
8422 | Same as | |
8423 | .BR \-m . | |
8424 | .TP 8 | |
8425 | .B noclobber | |
8426 | Same as | |
8427 | .BR \-C . | |
8428 | .TP 8 | |
8429 | .B noexec | |
8430 | Same as | |
8431 | .BR \-n . | |
8432 | .TP 8 | |
8433 | .B noglob | |
8434 | Same as | |
8435 | .BR \-f . | |
3185942a | 8436 | .TP 8 |
f73dda09 JA |
8437 | .B nolog |
8438 | Currently ignored. | |
726f6388 | 8439 | .TP 8 |
726f6388 JA |
8440 | .B notify |
8441 | Same as | |
8442 | .BR \-b . | |
8443 | .TP 8 | |
8444 | .B nounset | |
8445 | Same as | |
8446 | .BR \-u . | |
8447 | .TP 8 | |
ccc6cda3 JA |
8448 | .B onecmd |
8449 | Same as | |
8450 | .BR \-t . | |
8451 | .TP 8 | |
726f6388 JA |
8452 | .B physical |
8453 | Same as | |
8454 | .BR \-P . | |
8455 | .TP 8 | |
b80f6443 JA |
8456 | .B pipefail |
8457 | If set, the return value of a pipeline is the value of the last | |
8458 | (rightmost) command to exit with a non-zero status, or zero if all | |
8459 | commands in the pipeline exit successfully. | |
8460 | This option is disabled by default. | |
8461 | .TP 8 | |
726f6388 | 8462 | .B posix |
ccc6cda3 JA |
8463 | Change the behavior of |
8464 | .B bash | |
8465 | where the default operation differs | |
0628567a | 8466 | from the POSIX standard to match the standard (\fIposix mode\fP). |
726f6388 JA |
8467 | .TP 8 |
8468 | .B privileged | |
8469 | Same as | |
8470 | .BR \-p . | |
8471 | .TP 8 | |
8472 | .B verbose | |
8473 | Same as | |
8474 | .BR \-v . | |
8475 | .TP 8 | |
8476 | .B vi | |
8477 | Use a vi-style command line editing interface. | |
3185942a | 8478 | This also affects the editing interface used for \fBread \-e\fP. |
726f6388 JA |
8479 | .TP 8 |
8480 | .B xtrace | |
8481 | Same as | |
8482 | .BR \-x . | |
ccc6cda3 | 8483 | .sp .5 |
726f6388 | 8484 | .PP |
ccc6cda3 JA |
8485 | If |
8486 | .B \-o | |
8487 | is supplied with no \fIoption\-name\fP, the values of the current options are | |
726f6388 | 8488 | printed. |
ccc6cda3 JA |
8489 | If |
8490 | .B +o | |
8491 | is supplied with no \fIoption\-name\fP, a series of | |
8492 | .B set | |
8493 | commands to recreate the current option settings is displayed on | |
8494 | the standard output. | |
726f6388 JA |
8495 | .RE |
8496 | .TP 8 | |
8497 | .B \-p | |
8498 | Turn on | |
8499 | .I privileged | |
8500 | mode. In this mode, the | |
bb70624e | 8501 | .SM |
726f6388 | 8502 | .B $ENV |
b72432fd | 8503 | and |
bb70624e | 8504 | .SM |
b72432fd JA |
8505 | .B $BASH_ENV |
8506 | files are not processed, shell functions are not inherited from the | |
bb70624e JA |
8507 | environment, and the |
8508 | .SM | |
3185942a | 8509 | .BR SHELLOPTS , |
0001803f CR |
8510 | .SM |
8511 | .BR BASHOPTS , | |
8512 | .SM | |
3185942a JA |
8513 | .BR CDPATH , |
8514 | and | |
0001803f | 8515 | .SM |
3185942a JA |
8516 | .B GLOBIGNORE |
8517 | variables, if they appear in the environment, are ignored. | |
b72432fd JA |
8518 | If the shell is started with the effective user (group) id not equal to the |
8519 | real user (group) id, and the \fB\-p\fP option is not supplied, these actions | |
8520 | are taken and the effective user id is set to the real user id. | |
8521 | If the \fB\-p\fP option is supplied at startup, the effective user id is | |
8522 | not reset. | |
cce855bc | 8523 | Turning this option off causes the effective user |
726f6388 JA |
8524 | and group ids to be set to the real user and group ids. |
8525 | .TP 8 | |
8526 | .B \-t | |
8527 | Exit after reading and executing one command. | |
8528 | .TP 8 | |
8529 | .B \-u | |
89a92869 CR |
8530 | Treat unset variables and parameters other than the special |
8531 | parameters "@" and "*" as an error when performing | |
726f6388 | 8532 | parameter expansion. If expansion is attempted on an |
89a92869 | 8533 | unset variable or parameter, the shell prints an error message, and, |
ccc6cda3 | 8534 | if not interactive, exits with a non-zero status. |
726f6388 JA |
8535 | .TP 8 |
8536 | .B \-v | |
8537 | Print shell input lines as they are read. | |
8538 | .TP 8 | |
8539 | .B \-x | |
ccc6cda3 | 8540 | After expanding each \fIsimple command\fP, |
b80f6443 JA |
8541 | \fBfor\fP command, \fBcase\fP command, \fBselect\fP command, or |
8542 | arithmetic \fBfor\fP command, display the expanded value of | |
726f6388 JA |
8543 | .SM |
8544 | .BR PS4 , | |
b80f6443 JA |
8545 | followed by the command and its expanded arguments |
8546 | or associated word list. | |
726f6388 | 8547 | .TP 8 |
ccc6cda3 JA |
8548 | .B \-B |
8549 | The shell performs brace expansion (see | |
8550 | .B Brace Expansion | |
8551 | above). This is on by default. | |
726f6388 JA |
8552 | .TP 8 |
8553 | .B \-C | |
ccc6cda3 JA |
8554 | If set, |
8555 | .B bash | |
8556 | does not overwrite an existing file with the | |
8557 | .BR > , | |
8558 | .BR >& , | |
8559 | and | |
8560 | .B <> | |
8561 | redirection operators. This may be overridden when | |
8562 | creating output files by using the redirection operator | |
8563 | .B >| | |
8564 | instead of | |
8565 | .BR > . | |
726f6388 | 8566 | .TP 8 |
b80f6443 JA |
8567 | .B \-E |
8568 | If set, any trap on \fBERR\fP is inherited by shell functions, command | |
8569 | substitutions, and commands executed in a subshell environment. | |
8570 | The \fBERR\fP trap is normally not inherited in such cases. | |
8571 | .TP 8 | |
726f6388 JA |
8572 | .B \-H |
8573 | Enable | |
8574 | .B ! | |
cce855bc | 8575 | style history substitution. This option is on by |
726f6388 JA |
8576 | default when the shell is interactive. |
8577 | .TP 8 | |
8578 | .B \-P | |
ccc6cda3 JA |
8579 | If set, the shell does not follow symbolic links when executing |
8580 | commands such as | |
726f6388 | 8581 | .B cd |
ccc6cda3 JA |
8582 | that change the current working directory. It uses the |
8583 | physical directory structure instead. By default, | |
8584 | .B bash | |
8585 | follows the logical chain of directories when performing commands | |
8586 | which change the current directory. | |
726f6388 | 8587 | .TP 8 |
b80f6443 | 8588 | .B \-T |
95732b49 JA |
8589 | If set, any traps on \fBDEBUG\fP and \fBRETURN\fP are inherited by shell |
8590 | functions, command substitutions, and commands executed in a | |
8591 | subshell environment. | |
8592 | The \fBDEBUG\fP and \fBRETURN\fP traps are normally not inherited | |
8593 | in such cases. | |
b80f6443 | 8594 | .TP 8 |
726f6388 | 8595 | .B \-\- |
cce855bc | 8596 | If no arguments follow this option, then the positional parameters are |
726f6388 JA |
8597 | unset. Otherwise, the positional parameters are set to the |
8598 | \fIarg\fPs, even if some of them begin with a | |
8599 | .BR \- . | |
8600 | .TP 8 | |
8601 | .B \- | |
8602 | Signal the end of options, cause all remaining \fIarg\fPs to be | |
8603 | assigned to the positional parameters. The | |
8604 | .B \-x | |
8605 | and | |
8606 | .B \-v | |
8607 | options are turned off. | |
8608 | If there are no \fIarg\fPs, | |
8609 | the positional parameters remain unchanged. | |
8610 | .PD | |
8611 | .PP | |
cce855bc JA |
8612 | The options are off by default unless otherwise noted. |
8613 | Using + rather than \- causes these options to be turned off. | |
8614 | The options can also be specified as arguments to an invocation of | |
8615 | the shell. | |
8616 | The current set of options may be found in | |
726f6388 | 8617 | .BR $\- . |
cce855bc | 8618 | The return status is always true unless an invalid option is encountered. |
726f6388 JA |
8619 | .RE |
8620 | .TP | |
8621 | \fBshift\fP [\fIn\fP] | |
8622 | The positional parameters from \fIn\fP+1 ... are renamed to | |
8623 | .B $1 | |
8624 | .B .... | |
8625 | Parameters represented by the numbers \fB$#\fP | |
8626 | down to \fB$#\fP\-\fIn\fP+1 are unset. | |
ccc6cda3 JA |
8627 | .I n |
8628 | must be a non-negative number less than or equal to \fB$#\fP. | |
726f6388 JA |
8629 | If |
8630 | .I n | |
8631 | is 0, no parameters are changed. | |
8632 | If | |
8633 | .I n | |
8634 | is not given, it is assumed to be 1. | |
726f6388 JA |
8635 | If |
8636 | .I n | |
8637 | is greater than \fB$#\fP, the positional parameters are not changed. | |
ccc6cda3 | 8638 | The return status is greater than zero if |
726f6388 JA |
8639 | .I n |
8640 | is greater than | |
8641 | .B $# | |
ccc6cda3 JA |
8642 | or less than zero; otherwise 0. |
8643 | .TP | |
8644 | \fBshopt\fP [\fB\-pqsu\fP] [\fB\-o\fP] [\fIoptname\fP ...] | |
8645 | Toggle the values of variables controlling optional shell behavior. | |
8646 | With no options, or with the | |
8647 | .B \-p | |
8648 | option, a list of all settable options is displayed, with | |
cce855bc JA |
8649 | an indication of whether or not each is set. |
8650 | The \fB\-p\fP option causes output to be displayed in a form that | |
8651 | may be reused as input. | |
8652 | Other options have the following meanings: | |
ccc6cda3 JA |
8653 | .RS |
8654 | .PD 0 | |
8655 | .TP | |
8656 | .B \-s | |
8657 | Enable (set) each \fIoptname\fP. | |
8658 | .TP | |
8659 | .B \-u | |
8660 | Disable (unset) each \fIoptname\fP. | |
8661 | .TP | |
8662 | .B \-q | |
8663 | Suppresses normal output (quiet mode); the return status indicates | |
8664 | whether the \fIoptname\fP is set or unset. | |
8665 | If multiple \fIoptname\fP arguments are given with | |
8666 | .BR \-q , | |
8667 | the return status is zero if all \fIoptnames\fP are enabled; non-zero | |
8668 | otherwise. | |
8669 | .TP | |
8670 | .B \-o | |
8671 | Restricts the values of \fIoptname\fP to be those defined for the | |
8672 | .B \-o | |
8673 | option to the | |
8674 | .B set | |
8675 | builtin. | |
8676 | .PD | |
8677 | .PP | |
8678 | If either | |
8679 | .B \-s | |
8680 | or | |
8681 | .B \-u | |
8682 | is used with no \fIoptname\fP arguments, the display is limited to | |
8683 | those options which are set or unset, respectively. | |
8684 | Unless otherwise noted, the \fBshopt\fP options are disabled (unset) | |
8685 | by default. | |
8686 | .PP | |
8687 | The return status when listing options is zero if all \fIoptnames\fP | |
8688 | are enabled, non-zero otherwise. When setting or unsetting options, | |
cce855bc | 8689 | the return status is zero unless an \fIoptname\fP is not a valid shell |
ccc6cda3 JA |
8690 | option. |
8691 | .PP | |
8692 | The list of \fBshopt\fP options is: | |
8693 | .if t .sp .5v | |
8694 | .if n .sp 1v | |
8695 | .PD 0 | |
8696 | .TP 8 | |
3185942a JA |
8697 | .B autocd |
8698 | If set, a command name that is the name of a directory is executed as if | |
8699 | it were the argument to the \fBcd\fP command. | |
8700 | This option is only used by interactive shells. | |
8701 | .TP 8 | |
ccc6cda3 JA |
8702 | .B cdable_vars |
8703 | If set, an argument to the | |
8704 | .B cd | |
8705 | builtin command that | |
8706 | is not a directory is assumed to be the name of a variable whose | |
8707 | value is the directory to change to. | |
8708 | .TP 8 | |
8709 | .B cdspell | |
8710 | If set, minor errors in the spelling of a directory component in a | |
8711 | .B cd | |
8712 | command will be corrected. | |
8713 | The errors checked for are transposed characters, | |
8714 | a missing character, and one character too many. | |
8715 | If a correction is found, the corrected file name is printed, | |
8716 | and the command proceeds. | |
d166f048 | 8717 | This option is only used by interactive shells. |
ccc6cda3 JA |
8718 | .TP 8 |
8719 | .B checkhash | |
8720 | If set, \fBbash\fP checks that a command found in the hash | |
8721 | table exists before trying to execute it. If a hashed command no | |
8722 | longer exists, a normal path search is performed. | |
8723 | .TP 8 | |
3185942a JA |
8724 | .B checkjobs |
8725 | If set, \fBbash\fP lists the status of any stopped and running jobs before | |
8726 | exiting an interactive shell. If any jobs are running, this causes | |
8727 | the exit to be deferred until a second exit is attempted without an | |
0001803f CR |
8728 | intervening command (see |
8729 | .SM | |
8730 | .B "JOB CONTROL" | |
8731 | above). The shell always | |
3185942a JA |
8732 | postpones exiting if any jobs are stopped. |
8733 | .TP 8 | |
ccc6cda3 JA |
8734 | .B checkwinsize |
8735 | If set, \fBbash\fP checks the window size after each command | |
8736 | and, if necessary, updates the values of | |
8737 | .SM | |
8738 | .B LINES | |
8739 | and | |
8740 | .SM | |
8741 | .BR COLUMNS . | |
8742 | .TP 8 | |
8743 | .B cmdhist | |
8744 | If set, | |
8745 | .B bash | |
8746 | attempts to save all lines of a multiple-line | |
8747 | command in the same history entry. This allows | |
8748 | easy re-editing of multi-line commands. | |
8749 | .TP 8 | |
f1be666c JA |
8750 | .B compat31 |
8751 | If set, | |
8752 | .B bash | |
8753 | changes its behavior to that of version 3.1 with respect to quoted | |
8754 | arguments to the conditional command's =~ operator. | |
8755 | .TP 8 | |
0001803f CR |
8756 | .B compat32 |
8757 | If set, | |
8758 | .B bash | |
8759 | changes its behavior to that of version 3.2 with respect to locale-specific | |
8760 | string comparison when using the conditional command's < and > operators. | |
8761 | .TP 8 | |
8762 | .B compat40 | |
8763 | If set, | |
8764 | .B bash | |
8765 | changes its behavior to that of version 4.0 with respect to locale-specific | |
8766 | string comparison when using the conditional command's < and > operators | |
8767 | and the effect of interrupting a command list. | |
8768 | .TP 8 | |
3185942a JA |
8769 | .B dirspell |
8770 | If set, | |
8771 | .B bash | |
8772 | attempts spelling correction on directory names during word completion | |
8773 | if the directory name initially supplied does not exist. | |
8774 | .TP 8 | |
ccc6cda3 JA |
8775 | .B dotglob |
8776 | If set, | |
8777 | .B bash | |
8778 | includes filenames beginning with a `.' in the results of pathname | |
8779 | expansion. | |
8780 | .TP 8 | |
8781 | .B execfail | |
8782 | If set, a non-interactive shell will not exit if | |
8783 | it cannot execute the file specified as an argument to the | |
8784 | .B exec | |
8785 | builtin command. An interactive shell does not exit if | |
8786 | .B exec | |
8787 | fails. | |
8788 | .TP 8 | |
8789 | .B expand_aliases | |
8790 | If set, aliases are expanded as described above under | |
8791 | .SM | |
8792 | .BR ALIASES . | |
8793 | This option is enabled by default for interactive shells. | |
8794 | .TP 8 | |
b80f6443 JA |
8795 | .B extdebug |
8796 | If set, behavior intended for use by debuggers is enabled: | |
8797 | .RS | |
8798 | .TP | |
8799 | .B 1. | |
8800 | The \fB\-F\fP option to the \fBdeclare\fP builtin displays the source | |
8801 | file name and line number corresponding to each function name supplied | |
8802 | as an argument. | |
8803 | .TP | |
8804 | .B 2. | |
8805 | If the command run by the \fBDEBUG\fP trap returns a non-zero value, the | |
8806 | next command is skipped and not executed. | |
8807 | .TP | |
8808 | .B 3. | |
8809 | If the command run by the \fBDEBUG\fP trap returns a value of 2, and the | |
8810 | shell is executing in a subroutine (a shell function or a shell script | |
8811 | executed by the \fB.\fP or \fBsource\fP builtins), a call to | |
8812 | \fBreturn\fP is simulated. | |
95732b49 JA |
8813 | .TP |
8814 | .B 4. | |
0001803f CR |
8815 | .SM |
8816 | .B BASH_ARGC | |
8817 | and | |
8818 | .SM | |
8819 | .B BASH_ARGV | |
8820 | are updated as described in their descriptions above. | |
95732b49 JA |
8821 | .TP |
8822 | .B 5. | |
8823 | Function tracing is enabled: command substitution, shell functions, and | |
8824 | subshells invoked with \fB(\fP \fIcommand\fP \fB)\fP inherit the | |
8825 | \fBDEBUG\fP and \fBRETURN\fP traps. | |
8826 | .TP | |
8827 | .B 6. | |
8828 | Error tracing is enabled: command substitution, shell functions, and | |
8829 | subshells invoked with \fB(\fP \fIcommand\fP \fB)\fP inherit the | |
8830 | \fBERROR\fP trap. | |
b80f6443 JA |
8831 | .RE |
8832 | .TP 8 | |
cce855bc JA |
8833 | .B extglob |
8834 | If set, the extended pattern matching features described above under | |
8835 | \fBPathname Expansion\fP are enabled. | |
8836 | .TP 8 | |
b80f6443 | 8837 | .B extquote |
0628567a | 8838 | If set, \fB$\fP\(aq\fIstring\fP\(aq and \fB$\fP"\fIstring\fP" quoting is |
b80f6443 JA |
8839 | performed within \fB${\fP\fIparameter\fP\fB}\fP expansions |
8840 | enclosed in double quotes. This option is enabled by default. | |
8841 | .TP 8 | |
8842 | .B failglob | |
8843 | If set, patterns which fail to match filenames during pathname expansion | |
8844 | result in an expansion error. | |
8845 | .TP 8 | |
8846 | .B force_fignore | |
0001803f CR |
8847 | If set, the suffixes specified by the |
8848 | .SM | |
8849 | .B FIGNORE | |
8850 | shell variable | |
b80f6443 JA |
8851 | cause words to be ignored when performing word completion even if |
8852 | the ignored words are the only possible completions. | |
8853 | See | |
8854 | .SM | |
8855 | \fBSHELL VARIABLES\fP | |
0001803f CR |
8856 | above for a description of |
8857 | .SM | |
8858 | .BR FIGNORE . | |
b80f6443 JA |
8859 | This option is enabled by default. |
8860 | .TP 8 | |
3185942a | 8861 | .B globstar |
0001803f | 8862 | If set, the pattern \fB**\fP used in a pathname expansion context will |
3185942a JA |
8863 | match a files and zero or more directories and subdirectories. |
8864 | If the pattern is followed by a \fB/\fP, only directories and | |
8865 | subdirectories match. | |
8866 | .TP 8 | |
b80f6443 JA |
8867 | .B gnu_errfmt |
8868 | If set, shell error messages are written in the standard GNU error | |
8869 | message format. | |
8870 | .TP 8 | |
ccc6cda3 JA |
8871 | .B histappend |
8872 | If set, the history list is appended to the file named by the value | |
8873 | of the | |
0001803f | 8874 | .SM |
ccc6cda3 JA |
8875 | .B HISTFILE |
8876 | variable when the shell exits, rather than overwriting the file. | |
8877 | .TP 8 | |
8878 | .B histreedit | |
8879 | If set, and | |
8880 | .B readline | |
8881 | is being used, a user is given the opportunity to re-edit a | |
8882 | failed history substitution. | |
8883 | .TP 8 | |
8884 | .B histverify | |
8885 | If set, and | |
8886 | .B readline | |
8887 | is being used, the results of history substitution are not immediately | |
8888 | passed to the shell parser. Instead, the resulting line is loaded into | |
8889 | the \fBreadline\fP editing buffer, allowing further modification. | |
8890 | .TP 8 | |
8891 | .B hostcomplete | |
8892 | If set, and | |
8893 | .B readline | |
cce855bc JA |
8894 | is being used, \fBbash\fP will attempt to perform hostname completion when a |
8895 | word containing a \fB@\fP is being completed (see | |
ccc6cda3 JA |
8896 | .B Completing |
8897 | under | |
8898 | .SM | |
8899 | .B READLINE | |
8900 | above). | |
8901 | This is enabled by default. | |
8902 | .TP 8 | |
cce855bc JA |
8903 | .B huponexit |
8904 | If set, \fBbash\fP will send | |
8905 | .SM | |
8906 | .B SIGHUP | |
8907 | to all jobs when an interactive login shell exits. | |
8908 | .TP 8 | |
ccc6cda3 JA |
8909 | .B interactive_comments |
8910 | If set, allow a word beginning with | |
8911 | .B # | |
8912 | to cause that word and all remaining characters on that | |
8913 | line to be ignored in an interactive shell (see | |
8914 | .SM | |
8915 | .B COMMENTS | |
8916 | above). This option is enabled by default. | |
8917 | .TP 8 | |
8918 | .B lithist | |
8919 | If set, and the | |
8920 | .B cmdhist | |
8921 | option is enabled, multi-line commands are saved to the history with | |
8922 | embedded newlines rather than using semicolon separators where possible. | |
8923 | .TP 8 | |
f73dda09 JA |
8924 | .B login_shell |
8925 | The shell sets this option if it is started as a login shell (see | |
8926 | .SM | |
8927 | .B "INVOCATION" | |
8928 | above). | |
8929 | The value may not be changed. | |
8930 | .TP 8 | |
ccc6cda3 JA |
8931 | .B mailwarn |
8932 | If set, and a file that \fBbash\fP is checking for mail has been | |
8933 | accessed since the last time it was checked, the message ``The mail in | |
8934 | \fImailfile\fP has been read'' is displayed. | |
8935 | .TP 8 | |
bb70624e JA |
8936 | .B no_empty_cmd_completion |
8937 | If set, and | |
8938 | .B readline | |
8939 | is being used, | |
8940 | .B bash | |
0001803f CR |
8941 | will not attempt to search the |
8942 | .SM | |
8943 | .B PATH | |
8944 | for possible completions when | |
bb70624e JA |
8945 | completion is attempted on an empty line. |
8946 | .TP 8 | |
cce855bc JA |
8947 | .B nocaseglob |
8948 | If set, | |
8949 | .B bash | |
8950 | matches filenames in a case\-insensitive fashion when performing pathname | |
8951 | expansion (see | |
8952 | .B Pathname Expansion | |
8953 | above). | |
8954 | .TP 8 | |
95732b49 JA |
8955 | .B nocasematch |
8956 | If set, | |
8957 | .B bash | |
8958 | matches patterns in a case\-insensitive fashion when performing matching | |
8959 | while executing \fBcase\fP or \fB[[\fP conditional commands. | |
8960 | .TP 8 | |
ccc6cda3 JA |
8961 | .B nullglob |
8962 | If set, | |
8963 | .B bash | |
8964 | allows patterns which match no | |
8965 | files (see | |
8966 | .B Pathname Expansion | |
8967 | above) | |
8968 | to expand to a null string, rather than themselves. | |
8969 | .TP 8 | |
bb70624e JA |
8970 | .B progcomp |
8971 | If set, the programmable completion facilities (see | |
8972 | \fBProgrammable Completion\fP above) are enabled. | |
8973 | This option is enabled by default. | |
8974 | .TP 8 | |
ccc6cda3 | 8975 | .B promptvars |
b80f6443 JA |
8976 | If set, prompt strings undergo |
8977 | parameter expansion, command substitution, arithmetic | |
8978 | expansion, and quote removal after being expanded as described in | |
ccc6cda3 JA |
8979 | .SM |
8980 | .B PROMPTING | |
8981 | above. This option is enabled by default. | |
8982 | .TP 8 | |
b72432fd JA |
8983 | .B restricted_shell |
8984 | The shell sets this option if it is started in restricted mode (see | |
8985 | .SM | |
8986 | .B "RESTRICTED SHELL" | |
8987 | below). | |
8988 | The value may not be changed. | |
8989 | This is not reset when the startup files are executed, allowing | |
8990 | the startup files to discover whether or not a shell is restricted. | |
8991 | .TP 8 | |
ccc6cda3 JA |
8992 | .B shift_verbose |
8993 | If set, the | |
8994 | .B shift | |
8995 | builtin prints an error message when the shift count exceeds the | |
8996 | number of positional parameters. | |
8997 | .TP 8 | |
8998 | .B sourcepath | |
8999 | If set, the | |
9000 | \fBsource\fP (\fB.\fP) builtin uses the value of | |
9001 | .SM | |
9002 | .B PATH | |
9003 | to find the directory containing the file supplied as an argument. | |
cce855bc | 9004 | This option is enabled by default. |
bb70624e JA |
9005 | .TP 8 |
9006 | .B xpg_echo | |
9007 | If set, the \fBecho\fP builtin expands backslash-escape sequences | |
9008 | by default. | |
ccc6cda3 | 9009 | .RE |
726f6388 JA |
9010 | .TP |
9011 | \fBsuspend\fP [\fB\-f\fP] | |
9012 | Suspend the execution of this shell until it receives a | |
9013 | .SM | |
9014 | .B SIGCONT | |
3185942a | 9015 | signal. A login shell cannot be suspended; the |
726f6388 | 9016 | .B \-f |
3185942a JA |
9017 | option can be used to override this and force the suspension. |
9018 | The return status is 0 unless the shell is a login shell and | |
726f6388 JA |
9019 | .B \-f |
9020 | is not supplied, or if job control is not enabled. | |
9021 | .TP | |
726f6388 | 9022 | \fBtest\fP \fIexpr\fP |
7117c2d2 | 9023 | .PD 0 |
726f6388 JA |
9024 | .TP |
9025 | \fB[\fP \fIexpr\fP \fB]\fP | |
ccc6cda3 | 9026 | Return a status of 0 or 1 depending on |
726f6388 JA |
9027 | the evaluation of the conditional expression |
9028 | .IR expr . | |
cce855bc JA |
9029 | Each operator and operand must be a separate argument. |
9030 | Expressions are composed of the primaries described above under | |
9031 | .SM | |
9032 | .BR "CONDITIONAL EXPRESSIONS" . | |
95732b49 JA |
9033 | \fBtest\fP does not accept any options, nor does it accept and ignore |
9034 | an argument of \fB\-\-\fP as signifying the end of options. | |
cce855bc JA |
9035 | .if t .sp 0.5 |
9036 | .if n .sp 1 | |
9037 | Expressions may be combined using the following operators, listed | |
9038 | in decreasing order of precedence. | |
3185942a | 9039 | The evaluation depends on the number of arguments; see below. |
726f6388 JA |
9040 | .RS |
9041 | .PD 0 | |
9042 | .TP | |
726f6388 JA |
9043 | .B ! \fIexpr\fP |
9044 | True if | |
9045 | .I expr | |
9046 | is false. | |
9047 | .TP | |
cce855bc JA |
9048 | .B ( \fIexpr\fP ) |
9049 | Returns the value of \fIexpr\fP. | |
9050 | This may be used to override the normal precedence of operators. | |
9051 | .TP | |
726f6388 JA |
9052 | \fIexpr1\fP \-\fBa\fP \fIexpr2\fP |
9053 | True if both | |
9054 | .I expr1 | |
cce855bc | 9055 | and |
726f6388 JA |
9056 | .I expr2 |
9057 | are true. | |
9058 | .TP | |
9059 | \fIexpr1\fP \-\fBo\fP \fIexpr2\fP | |
9060 | True if either | |
9061 | .I expr1 | |
cce855bc | 9062 | or |
726f6388 JA |
9063 | .I expr2 |
9064 | is true. | |
cce855bc JA |
9065 | .PD |
9066 | .PP | |
9067 | \fBtest\fP and \fB[\fP evaluate conditional | |
9068 | expressions using a set of rules based on the number of arguments. | |
9069 | .if t .sp 0.5 | |
9070 | .if n .sp 1 | |
9071 | .PD 0 | |
726f6388 | 9072 | .TP |
cce855bc JA |
9073 | 0 arguments |
9074 | The expression is false. | |
9075 | .TP | |
9076 | 1 argument | |
9077 | The expression is true if and only if the argument is not null. | |
9078 | .TP | |
9079 | 2 arguments | |
9080 | If the first argument is \fB!\fP, the expression is true if and | |
9081 | only if the second argument is null. | |
9082 | If the first argument is one of the unary conditional operators listed above | |
9083 | under | |
726f6388 | 9084 | .SM |
cce855bc JA |
9085 | .BR "CONDITIONAL EXPRESSIONS" , |
9086 | the expression is true if the unary test is true. | |
9087 | If the first argument is not a valid unary conditional operator, the expression | |
9088 | is false. | |
9089 | .TP | |
9090 | 3 arguments | |
9091 | If the second argument is one of the binary conditional operators listed above | |
9092 | under | |
9093 | .SM | |
9094 | .BR "CONDITIONAL EXPRESSIONS" , | |
9095 | the result of the expression is the result of the binary test using | |
9096 | the first and third arguments as operands. | |
3185942a JA |
9097 | The \fB\-a\fP and \fB\-o\fP operators are considered binary operators |
9098 | when there are three arguments. | |
cce855bc JA |
9099 | If the first argument is \fB!\fP, the value is the negation of |
9100 | the two-argument test using the second and third arguments. | |
9101 | If the first argument is exactly \fB(\fP and the third argument is | |
9102 | exactly \fB)\fP, the result is the one-argument test of the second | |
9103 | argument. | |
9104 | Otherwise, the expression is false. | |
cce855bc JA |
9105 | .TP |
9106 | 4 arguments | |
9107 | If the first argument is \fB!\fP, the result is the negation of | |
9108 | the three-argument expression composed of the remaining arguments. | |
9109 | Otherwise, the expression is parsed and evaluated according to | |
9110 | precedence using the rules listed above. | |
9111 | .TP | |
9112 | 5 or more arguments | |
9113 | The expression is parsed and evaluated according to precedence | |
9114 | using the rules listed above. | |
726f6388 | 9115 | .RE |
cce855bc | 9116 | .PD |
726f6388 JA |
9117 | .TP |
9118 | .B times | |
9119 | Print the accumulated user and system times for the shell and | |
9120 | for processes run from the shell. The return status is 0. | |
9121 | .TP | |
b80f6443 | 9122 | \fBtrap\fP [\fB\-lp\fP] [[\fIarg\fP] \fIsigspec\fP ...] |
726f6388 JA |
9123 | The command |
9124 | .I arg | |
9125 | is to be read and executed when the shell receives | |
9126 | signal(s) | |
9127 | .IR sigspec . | |
9128 | If | |
9129 | .I arg | |
b80f6443 | 9130 | is absent (and there is a single \fIsigspec\fP) or |
726f6388 | 9131 | .BR \- , |
b80f6443 JA |
9132 | each specified signal is |
9133 | reset to its original disposition (the value it had | |
d166f048 JA |
9134 | upon entrance to the shell). |
9135 | If | |
726f6388 | 9136 | .I arg |
d166f048 JA |
9137 | is the null string the signal specified by each |
9138 | .I sigspec | |
9139 | is ignored by the shell and by the commands it invokes. | |
ccc6cda3 JA |
9140 | If |
9141 | .I arg | |
bb70624e | 9142 | is not present and |
ccc6cda3 | 9143 | .B \-p |
bb70624e | 9144 | has been supplied, then the trap commands associated with each |
ccc6cda3 | 9145 | .I sigspec |
bb70624e JA |
9146 | are displayed. |
9147 | If no arguments are supplied or if only | |
ccc6cda3 JA |
9148 | .B \-p |
9149 | is given, | |
9150 | .B trap | |
b80f6443 JA |
9151 | prints the list of commands associated with each signal. |
9152 | The | |
9153 | .B \-l | |
9154 | option causes the shell to print a list of signal names and | |
9155 | their corresponding numbers. | |
d166f048 | 9156 | Each |
726f6388 JA |
9157 | .I sigspec |
9158 | is either | |
d166f048 | 9159 | a signal name defined in <\fIsignal.h\fP>, or a signal number. |
b80f6443 | 9160 | Signal names are case insensitive and the SIG prefix is optional. |
0001803f CR |
9161 | .if t .sp 0.5 |
9162 | .if n .sp 1 | |
d166f048 | 9163 | If a |
726f6388 JA |
9164 | .I sigspec |
9165 | is | |
9166 | .SM | |
9167 | .B EXIT | |
9168 | (0) the command | |
9169 | .I arg | |
f73dda09 JA |
9170 | is executed on exit from the shell. |
9171 | If a | |
ccc6cda3 JA |
9172 | .I sigspec |
9173 | is | |
9174 | .SM | |
9175 | .BR DEBUG , | |
9176 | the command | |
9177 | .I arg | |
b80f6443 JA |
9178 | is executed before every \fIsimple command\fP, \fIfor\fP command, |
9179 | \fIcase\fP command, \fIselect\fP command, every arithmetic \fIfor\fP | |
9180 | command, and before the first command executes in a shell function (see | |
ccc6cda3 JA |
9181 | .SM |
9182 | .B SHELL GRAMMAR | |
9183 | above). | |
95732b49 | 9184 | Refer to the description of the \fBextdebug\fP option to the |
b80f6443 | 9185 | \fBshopt\fP builtin for details of its effect on the \fBDEBUG\fP trap. |
f73dda09 JA |
9186 | If a |
9187 | .I sigspec | |
9188 | is | |
9189 | .SM | |
0001803f CR |
9190 | .BR RETURN , |
9191 | the command | |
9192 | .I arg | |
9193 | is executed each time a shell function or a script executed with the | |
9194 | \fB.\fP or \fBsource\fP builtins finishes executing. | |
9195 | .if t .sp 0.5 | |
9196 | .if n .sp 1 | |
9197 | If a | |
9198 | .I sigspec | |
9199 | is | |
9200 | .SM | |
f73dda09 JA |
9201 | .BR ERR , |
9202 | the command | |
9203 | .I arg | |
b80f6443 JA |
9204 | is executed whenever a simple command has a non\-zero exit status, |
9205 | subject to the following conditions. | |
f73dda09 JA |
9206 | The |
9207 | .SM | |
b80f6443 JA |
9208 | .B ERR |
9209 | trap is not executed if the failed | |
9210 | command is part of the command list immediately following a | |
9211 | .B while | |
f73dda09 | 9212 | or |
b80f6443 JA |
9213 | .B until |
9214 | keyword, | |
9215 | part of the test in an | |
f73dda09 | 9216 | .I if |
3185942a | 9217 | statement, part of a command executed in a |
f73dda09 JA |
9218 | .B && |
9219 | or | |
9220 | .B \(bv\(bv | |
9221 | list, or if the command's return value is | |
9222 | being inverted via | |
9223 | .BR ! . | |
b80f6443 | 9224 | These are the same conditions obeyed by the \fBerrexit\fP option. |
0001803f CR |
9225 | .if t .sp 0.5 |
9226 | .if n .sp 1 | |
726f6388 | 9227 | Signals ignored upon entry to the shell cannot be trapped or reset. |
0628567a | 9228 | Trapped signals that are not being ignored are reset to their original |
0001803f | 9229 | values in a subshell or subshell environment when one is created. |
d166f048 | 9230 | The return status is false if any |
ccc6cda3 JA |
9231 | .I sigspec |
9232 | is invalid; otherwise | |
726f6388 JA |
9233 | .B trap |
9234 | returns true. | |
9235 | .TP | |
7117c2d2 | 9236 | \fBtype\fP [\fB\-aftpP\fP] \fIname\fP [\fIname\fP ...] |
726f6388 JA |
9237 | With no options, |
9238 | indicate how each | |
9239 | .I name | |
9240 | would be interpreted if used as a command name. | |
9241 | If the | |
cce855bc JA |
9242 | .B \-t |
9243 | option is used, | |
726f6388 | 9244 | .B type |
ccc6cda3 | 9245 | prints a string which is one of |
726f6388 JA |
9246 | .IR alias , |
9247 | .IR keyword , | |
9248 | .IR function , | |
9249 | .IR builtin , | |
9250 | or | |
9251 | .I file | |
9252 | if | |
9253 | .I name | |
9254 | is an alias, shell reserved word, function, builtin, or disk file, | |
ccc6cda3 JA |
9255 | respectively. |
9256 | If the | |
9257 | .I name | |
9258 | is not found, then nothing is printed, and an exit status of false | |
9259 | is returned. | |
726f6388 | 9260 | If the |
cce855bc JA |
9261 | .B \-p |
9262 | option is used, | |
726f6388 JA |
9263 | .B type |
9264 | either returns the name of the disk file | |
9265 | that would be executed if | |
9266 | .I name | |
9267 | were specified as a command name, | |
28ef6c31 JA |
9268 | or nothing if |
9269 | .if t \f(CWtype -t name\fP | |
9270 | .if n ``type -t name'' | |
726f6388 JA |
9271 | would not return |
9272 | .IR file . | |
7117c2d2 JA |
9273 | The |
9274 | .B \-P | |
9275 | option forces a | |
9276 | .SM | |
9277 | .B PATH | |
9278 | search for each \fIname\fP, even if | |
9279 | .if t \f(CWtype -t name\fP | |
9280 | .if n ``type -t name'' | |
9281 | would not return | |
9282 | .IR file . | |
726f6388 | 9283 | If a command is hashed, |
cce855bc | 9284 | .B \-p |
7117c2d2 JA |
9285 | and |
9286 | .B \-P | |
9287 | print the hashed value, not necessarily the file that appears | |
726f6388 JA |
9288 | first in |
9289 | .SM | |
9290 | .BR PATH . | |
9291 | If the | |
cce855bc JA |
9292 | .B \-a |
9293 | option is used, | |
726f6388 JA |
9294 | .B type |
9295 | prints all of the places that contain | |
9296 | an executable named | |
9297 | .IR name . | |
9298 | This includes aliases and functions, | |
9299 | if and only if the | |
cce855bc JA |
9300 | .B \-p |
9301 | option is not also used. | |
726f6388 JA |
9302 | The table of hashed commands is not consulted |
9303 | when using | |
cce855bc | 9304 | .BR \-a . |
7117c2d2 JA |
9305 | The |
9306 | .B \-f | |
9307 | option suppresses shell function lookup, as with the \fBcommand\fP builtin. | |
726f6388 | 9308 | .B type |
3185942a JA |
9309 | returns true if all of the arguments are found, false if |
9310 | any are not found. | |
726f6388 | 9311 | .TP |
3185942a | 9312 | \fBulimit\fP [\fB\-HSTabcdefilmnpqrstuvx\fP [\fIlimit\fP]] |
ccc6cda3 | 9313 | Provides control over the resources available to the shell and to |
f73dda09 | 9314 | processes started by it, on systems that allow such control. |
ccc6cda3 | 9315 | The \fB\-H\fP and \fB\-S\fP options specify that the hard or soft limit is |
3185942a JA |
9316 | set for the given resource. |
9317 | A hard limit cannot be increased by a non-root user once it is set; | |
9318 | a soft limit may be increased up to the value of the hard limit. | |
ccc6cda3 JA |
9319 | If neither \fB\-H\fP nor \fB\-S\fP is specified, both the soft and hard |
9320 | limits are set. | |
f73dda09 JA |
9321 | The value of |
9322 | .I limit | |
9323 | can be a number in the unit specified for the resource | |
9324 | or one of the special values | |
9325 | .BR hard , | |
9326 | .BR soft , | |
9327 | or | |
9328 | .BR unlimited , | |
9329 | which stand for the current hard limit, the current soft limit, and | |
9330 | no limit, respectively. | |
ccc6cda3 | 9331 | If |
726f6388 JA |
9332 | .I limit |
9333 | is omitted, the current value of the soft limit of the resource is | |
ccc6cda3 JA |
9334 | printed, unless the \fB\-H\fP option is given. When more than one |
9335 | resource is specified, the limit name and unit are printed before the value. | |
726f6388 JA |
9336 | Other options are interpreted as follows: |
9337 | .RS | |
9338 | .PD 0 | |
9339 | .TP | |
9340 | .B \-a | |
ccc6cda3 | 9341 | All current limits are reported |
726f6388 | 9342 | .TP |
3185942a JA |
9343 | .B \-b |
9344 | The maximum socket buffer size | |
9345 | .TP | |
726f6388 | 9346 | .B \-c |
ccc6cda3 | 9347 | The maximum size of core files created |
726f6388 JA |
9348 | .TP |
9349 | .B \-d | |
ccc6cda3 | 9350 | The maximum size of a process's data segment |
726f6388 | 9351 | .TP |
0628567a JA |
9352 | .B \-e |
9353 | The maximum scheduling priority ("nice") | |
9354 | .TP | |
726f6388 | 9355 | .B \-f |
0628567a JA |
9356 | The maximum size of files written by the shell and its children |
9357 | .TP | |
9358 | .B \-i | |
9359 | The maximum number of pending signals | |
726f6388 | 9360 | .TP |
ccc6cda3 JA |
9361 | .B \-l |
9362 | The maximum size that may be locked into memory | |
726f6388 | 9363 | .TP |
ccc6cda3 | 9364 | .B \-m |
17345e5a | 9365 | The maximum resident set size (many systems do not honor this limit) |
726f6388 | 9366 | .TP |
ccc6cda3 JA |
9367 | .B \-n |
9368 | The maximum number of open file descriptors (most systems do not | |
9369 | allow this value to be set) | |
726f6388 JA |
9370 | .TP |
9371 | .B \-p | |
ccc6cda3 | 9372 | The pipe size in 512-byte blocks (this may not be set) |
726f6388 | 9373 | .TP |
0628567a JA |
9374 | .B \-q |
9375 | The maximum number of bytes in POSIX message queues | |
9376 | .TP | |
9377 | .B \-r | |
9378 | The maximum real-time scheduling priority | |
9379 | .TP | |
ccc6cda3 JA |
9380 | .B \-s |
9381 | The maximum stack size | |
9382 | .TP | |
9383 | .B \-t | |
9384 | The maximum amount of cpu time in seconds | |
726f6388 JA |
9385 | .TP |
9386 | .B \-u | |
ccc6cda3 | 9387 | The maximum number of processes available to a single user |
726f6388 JA |
9388 | .TP |
9389 | .B \-v | |
9390 | The maximum amount of virtual memory available to the shell | |
0628567a JA |
9391 | .TP |
9392 | .B \-x | |
9393 | The maximum number of file locks | |
3185942a JA |
9394 | .TP |
9395 | .B \-T | |
9396 | The maximum number of threads | |
726f6388 JA |
9397 | .PD |
9398 | .PP | |
ccc6cda3 | 9399 | If |
726f6388 JA |
9400 | .I limit |
9401 | is given, it is the new value of the specified resource (the | |
9402 | .B \-a | |
9403 | option is display only). | |
9404 | If no option is given, then | |
9405 | .B \-f | |
9406 | is assumed. Values are in 1024-byte increments, except for | |
9407 | .BR \-t , | |
9408 | which is in seconds, | |
9409 | .BR \-p , | |
9410 | which is in units of 512-byte blocks, | |
9411 | and | |
3185942a JA |
9412 | .BR \-T , |
9413 | .BR \-b , | |
9414 | .BR \-n , | |
726f6388 JA |
9415 | and |
9416 | .BR \-u , | |
f73dda09 JA |
9417 | which are unscaled values. |
9418 | The return status is 0 unless an invalid option or argument is supplied, | |
9419 | or an error occurs while setting a new limit. | |
726f6388 JA |
9420 | .RE |
9421 | .TP | |
cce855bc | 9422 | \fBumask\fP [\fB\-p\fP] [\fB\-S\fP] [\fImode\fP] |
726f6388 JA |
9423 | The user file-creation mask is set to |
9424 | .IR mode . | |
9425 | If | |
9426 | .I mode | |
9427 | begins with a digit, it | |
9428 | is interpreted as an octal number; otherwise | |
9429 | it is interpreted as a symbolic mode mask similar | |
9430 | to that accepted by | |
9431 | .IR chmod (1). | |
9432 | If | |
9433 | .I mode | |
bb70624e | 9434 | is omitted, the current value of the mask is printed. |
ccc6cda3 | 9435 | The |
726f6388 JA |
9436 | .B \-S |
9437 | option causes the mask to be printed in symbolic form; the | |
9438 | default output is an octal number. | |
cce855bc JA |
9439 | If the |
9440 | .B \-p | |
9441 | option is supplied, and | |
9442 | .I mode | |
9443 | is omitted, the output is in a form that may be reused as input. | |
ccc6cda3 | 9444 | The return status is 0 if the mode was successfully changed or if |
726f6388 JA |
9445 | no \fImode\fP argument was supplied, and false otherwise. |
9446 | .TP | |
9447 | \fBunalias\fP [\-\fBa\fP] [\fIname\fP ...] | |
bb70624e | 9448 | Remove each \fIname\fP from the list of defined aliases. If |
726f6388 JA |
9449 | .B \-a |
9450 | is supplied, all alias definitions are removed. The return | |
9451 | value is true unless a supplied | |
9452 | .I name | |
9453 | is not a defined alias. | |
9454 | .TP | |
9455 | \fBunset\fP [\-\fBfv\fP] [\fIname\fP ...] | |
9456 | For each | |
9457 | .IR name , | |
ccc6cda3 JA |
9458 | remove the corresponding variable or function. |
9459 | If no options are supplied, or the | |
9460 | .B \-v | |
9461 | option is given, each | |
9462 | .I name | |
9463 | refers to a shell variable. | |
9464 | Read-only variables may not be unset. | |
9465 | If | |
726f6388 | 9466 | .B \-f |
95732b49 | 9467 | is specified, each |
ccc6cda3 JA |
9468 | .I name |
9469 | refers to a shell function, and the function definition | |
9470 | is removed. | |
9471 | Each unset variable or function is removed from the environment | |
9472 | passed to subsequent commands. | |
9473 | If any of | |
726f6388 | 9474 | .SM |
0001803f CR |
9475 | .BR COMP_WORDBREAKS , |
9476 | .SM | |
726f6388 JA |
9477 | .BR RANDOM , |
9478 | .SM | |
9479 | .BR SECONDS , | |
9480 | .SM | |
9481 | .BR LINENO , | |
ccc6cda3 JA |
9482 | .SM |
9483 | .BR HISTCMD , | |
bb70624e JA |
9484 | .SM |
9485 | .BR FUNCNAME , | |
9486 | .SM | |
9487 | .BR GROUPS , | |
726f6388 JA |
9488 | or |
9489 | .SM | |
ccc6cda3 | 9490 | .B DIRSTACK |
726f6388 JA |
9491 | are unset, they lose their special properties, even if they are |
9492 | subsequently reset. The exit status is true unless a | |
9493 | .I name | |
b80f6443 | 9494 | is readonly. |
726f6388 | 9495 | .TP |
95732b49 JA |
9496 | \fBwait\fP [\fIn ...\fP] |
9497 | Wait for each specified process and return its termination status. | |
9498 | Each | |
726f6388 JA |
9499 | .I n |
9500 | may be a process | |
9501 | ID or a job specification; if a job spec is given, all processes | |
9502 | in that job's pipeline are waited for. If | |
9503 | .I n | |
9504 | is not given, all currently active child processes | |
9505 | are waited for, and the return status is zero. If | |
9506 | .I n | |
ccc6cda3 | 9507 | specifies a non-existent process or job, the return status is |
726f6388 JA |
9508 | 127. Otherwise, the return status is the exit status of the last |
9509 | process or job waited for. | |
9510 | .\" bash_builtins | |
9511 | .if \n(zZ=1 .ig zZ | |
ccc6cda3 | 9512 | .SH "RESTRICTED SHELL" |
bb70624e JA |
9513 | .\" rbash.1 |
9514 | .zY | |
726f6388 | 9515 | .PP |
ccc6cda3 | 9516 | If |
726f6388 | 9517 | .B bash |
ccc6cda3 JA |
9518 | is started with the name |
9519 | .BR rbash , | |
9520 | or the | |
9521 | .B \-r | |
9522 | option is supplied at invocation, | |
9523 | the shell becomes restricted. | |
9524 | A restricted shell is used to | |
9525 | set up an environment more controlled than the standard shell. | |
9526 | It behaves identically to | |
9527 | .B bash | |
cce855bc | 9528 | with the exception that the following are disallowed or not performed: |
ccc6cda3 JA |
9529 | .IP \(bu |
9530 | changing directories with \fBcd\fP | |
9531 | .IP \(bu | |
9532 | setting or unsetting the values of | |
0001803f | 9533 | .SM |
b72432fd | 9534 | .BR SHELL , |
0001803f | 9535 | .SM |
b72432fd | 9536 | .BR PATH , |
0001803f | 9537 | .SM |
b72432fd | 9538 | .BR ENV , |
ccc6cda3 | 9539 | or |
0001803f | 9540 | .SM |
b72432fd | 9541 | .B BASH_ENV |
ccc6cda3 JA |
9542 | .IP \(bu |
9543 | specifying command names containing | |
9544 | .B / | |
9545 | .IP \(bu | |
9546 | specifying a file name containing a | |
9547 | .B / | |
9548 | as an argument to the | |
9549 | .B . | |
9550 | builtin command | |
9551 | .IP \(bu | |
bb70624e JA |
9552 | Specifying a filename containing a slash as an argument to the |
9553 | .B \-p | |
9554 | option to the | |
9555 | .B hash | |
9556 | builtin command | |
9557 | .IP \(bu | |
ccc6cda3 JA |
9558 | importing function definitions from the shell environment at startup |
9559 | .IP \(bu | |
0001803f CR |
9560 | parsing the value of |
9561 | .SM | |
9562 | .B SHELLOPTS | |
9563 | from the shell environment at startup | |
cce855bc | 9564 | .IP \(bu |
ccc6cda3 JA |
9565 | redirecting output using the >, >|, <>, >&, &>, and >> redirection operators |
9566 | .IP \(bu | |
9567 | using the | |
9568 | .B exec | |
9569 | builtin command to replace the shell with another command | |
9570 | .IP \(bu | |
9571 | adding or deleting builtin commands with the | |
9572 | .B \-f | |
726f6388 | 9573 | and |
ccc6cda3 JA |
9574 | .B \-d |
9575 | options to the | |
9576 | .B enable | |
9577 | builtin command | |
9578 | .IP \(bu | |
7117c2d2 JA |
9579 | Using the \fBenable\fP builtin command to enable disabled shell builtins |
9580 | .IP \(bu | |
ccc6cda3 JA |
9581 | specifying the |
9582 | .B \-p | |
9583 | option to the | |
9584 | .B command | |
9585 | builtin command | |
9586 | .IP \(bu | |
9587 | turning off restricted mode with | |
cce855bc | 9588 | \fBset +r\fP or \fBset +o restricted\fP. |
726f6388 | 9589 | .PP |
ccc6cda3 JA |
9590 | These restrictions are enforced after any startup files are read. |
9591 | .PP | |
b80f6443 JA |
9592 | .ie \n(zY=1 When a command that is found to be a shell script is executed, |
9593 | .el \{ When a command that is found to be a shell script is executed | |
9594 | (see | |
ccc6cda3 JA |
9595 | .SM |
9596 | .B "COMMAND EXECUTION" | |
9597 | above), | |
b80f6443 | 9598 | \} |
ccc6cda3 JA |
9599 | .B rbash |
9600 | turns off any restrictions in the shell spawned to execute the | |
9601 | script. | |
bb70624e JA |
9602 | .\" end of rbash.1 |
9603 | .if \n(zY=1 .ig zY | |
726f6388 JA |
9604 | .SH "SEE ALSO" |
9605 | .PD 0 | |
9606 | .TP | |
bb70624e | 9607 | \fIBash Reference Manual\fP, Brian Fox and Chet Ramey |
726f6388 JA |
9608 | .TP |
9609 | \fIThe Gnu Readline Library\fP, Brian Fox and Chet Ramey | |
9610 | .TP | |
9611 | \fIThe Gnu History Library\fP, Brian Fox and Chet Ramey | |
9612 | .TP | |
726f6388 JA |
9613 | \fIPortable Operating System Interface (POSIX) Part 2: Shell and Utilities\fP, IEEE |
9614 | .TP | |
9615 | \fIsh\fP(1), \fIksh\fP(1), \fIcsh\fP(1) | |
9616 | .TP | |
9617 | \fIemacs\fP(1), \fIvi\fP(1) | |
9618 | .TP | |
9619 | \fIreadline\fP(3) | |
9620 | .PD | |
9621 | .SH FILES | |
9622 | .PD 0 | |
9623 | .TP | |
9624 | .FN /bin/bash | |
9625 | The \fBbash\fP executable | |
9626 | .TP | |
9627 | .FN /etc/profile | |
9628 | The systemwide initialization file, executed for login shells | |
9629 | .TP | |
9630 | .FN ~/.bash_profile | |
9631 | The personal initialization file, executed for login shells | |
9632 | .TP | |
9633 | .FN ~/.bashrc | |
9634 | The individual per-interactive-shell startup file | |
9635 | .TP | |
b72432fd JA |
9636 | .FN ~/.bash_logout |
9637 | The individual login shell cleanup file, executed when a login shell exits | |
9638 | .TP | |
726f6388 JA |
9639 | .FN ~/.inputrc |
9640 | Individual \fIreadline\fP initialization file | |
9641 | .PD | |
9642 | .SH AUTHORS | |
ccc6cda3 | 9643 | Brian Fox, Free Software Foundation |
726f6388 | 9644 | .br |
bb70624e | 9645 | bfox@gnu.org |
726f6388 JA |
9646 | .PP |
9647 | Chet Ramey, Case Western Reserve University | |
9648 | .br | |
17345e5a | 9649 | chet.ramey@case.edu |
726f6388 JA |
9650 | .SH BUG REPORTS |
9651 | If you find a bug in | |
9652 | .B bash, | |
9653 | you should report it. But first, you should | |
9654 | make sure that it really is a bug, and that it appears in the latest | |
9655 | version of | |
b80f6443 JA |
9656 | .BR bash . |
9657 | The latest version is always available from | |
9658 | \fIftp://ftp.gnu.org/pub/bash/\fP. | |
726f6388 JA |
9659 | .PP |
9660 | Once you have determined that a bug actually exists, use the | |
9661 | .I bashbug | |
9662 | command to submit a bug report. | |
d166f048 | 9663 | If you have a fix, you are encouraged to mail that as well! |
726f6388 | 9664 | Suggestions and `philosophical' bug reports may be mailed |
cce855bc | 9665 | to \fIbug-bash@gnu.org\fP or posted to the Usenet |
726f6388 JA |
9666 | newsgroup |
9667 | .BR gnu.bash.bug . | |
9668 | .PP | |
9669 | ALL bug reports should include: | |
9670 | .PP | |
9671 | .PD 0 | |
9672 | .TP 20 | |
9673 | The version number of \fBbash\fR | |
9674 | .TP | |
9675 | The hardware and operating system | |
9676 | .TP | |
9677 | The compiler used to compile | |
9678 | .TP | |
9679 | A description of the bug behaviour | |
9680 | .TP | |
9681 | A short script or `recipe' which exercises the bug | |
9682 | .PD | |
9683 | .PP | |
9684 | .I bashbug | |
9685 | inserts the first three items automatically into the template | |
9686 | it provides for filing a bug report. | |
9687 | .PP | |
9688 | Comments and bug reports concerning | |
9689 | this manual page should be directed to | |
95732b49 | 9690 | .IR chet@po.cwru.edu . |
726f6388 JA |
9691 | .SH BUGS |
9692 | .PP | |
9693 | It's too big and too slow. | |
9694 | .PP | |
9695 | There are some subtle differences between | |
9696 | .B bash | |
9697 | and traditional versions of | |
9698 | .BR sh , | |
9699 | mostly because of the | |
9700 | .SM | |
9701 | .B POSIX | |
9702 | specification. | |
9703 | .PP | |
9704 | Aliases are confusing in some uses. | |
ccc6cda3 JA |
9705 | .PP |
9706 | Shell builtin commands and functions are not stoppable/restartable. | |
9707 | .PP | |
9708 | Compound commands and command sequences of the form `a ; b ; c' | |
9709 | are not handled gracefully when process suspension is attempted. | |
9710 | When a process is stopped, the shell immediately executes the next | |
9711 | command in the sequence. | |
9712 | It suffices to place the sequence of commands between | |
9713 | parentheses to force it into a subshell, which may be stopped as | |
9714 | a unit. | |
9715 | .PP | |
ccc6cda3 | 9716 | Array variables may not (yet) be exported. |
3185942a JA |
9717 | .PP |
9718 | There may be only one active coprocess at a time. | |
726f6388 | 9719 | .zZ |
bb70624e | 9720 | .zY |