diff options
| author | Jari Aalto <jari.aalto@cante.net> | 1998-04-17 19:52:44 +0000 |
|---|---|---|
| committer | Jari Aalto <jari.aalto@cante.net> | 2009-09-12 16:46:51 +0000 |
| commit | cce855bc5b117cb7ae70064131120687bc69fac0 (patch) | |
| tree | 39c7a4ec8f6d22ef03df74f2684e6a04fef10399 /doc | |
| parent | e8ce775db824de329b81293b4e5d8fbd65624528 (diff) | |
| download | android_external_bash-cce855bc5b117cb7ae70064131120687bc69fac0.tar.gz android_external_bash-cce855bc5b117cb7ae70064131120687bc69fac0.tar.bz2 android_external_bash-cce855bc5b117cb7ae70064131120687bc69fac0.zip | |
Imported from ../bash-2.02.tar.gz.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/FAQ | 131 | ||||
| -rw-r--r-- | doc/Makefile.in | 18 | ||||
| -rw-r--r-- | doc/bash.1 | 1515 | ||||
| -rw-r--r-- | doc/bashref.info | 4226 | ||||
| -rw-r--r-- | doc/bashref.texi | 3391 | ||||
| -rwxr-xr-x | doc/htmlpost.sh | 19 | ||||
| -rw-r--r-- | doc/readline.3 | 127 |
7 files changed, 5702 insertions, 3725 deletions
@@ -1,4 +1,4 @@ -This is the Bash FAQ, version 2.5, for Bash version 2.01. +This is the Bash FAQ, version 2.11, for Bash version 2.02. This document contains a set of frequently-asked questions concerning Bash, the GNU Bourne-Again Shell. Bash is a freely-available command @@ -13,7 +13,7 @@ chet@po.cwru.edu. This document is available for anonymous FTP with the URL -ftp://slc2.ins.cwru.edu/pub/bash/FAQ +ftp://ftp.cwru.edu/pub/bash/FAQ ---------- Contents: @@ -34,8 +34,8 @@ Section A: The Basics Section B: The latest version -11) What's new in version 2.01? -12) Are there any user-visible incompatibilities between bash-2.01 and +11) What's new in version 2.02? +12) Are there any user-visible incompatibilities between bash-2.02 and bash-1.14.7? Section C: Differences from other Unix shells @@ -120,23 +120,22 @@ of Case Western Reserve University. 2) What's the latest version? -The latest version is 2.01, first made available on June 6, 1997. +The latest version is 2.02, first made available on Monday, 20 April, 1998. 3) Where can I get it? Bash is the GNU project's shell, and so is available from the master GNU archive site, prep.ai.mit.edu, and its mirrors. The -latest version is also available for FTP from slc2.ins.cwru.edu, -the maintainer's machine. The following URLs tell how to get -version 2.01: +latest version is also available for FTP from ftp.cwru.edu. +The following URLs tell how to get version 2.02: -ftp://prep.ai.mit.edu/pub/gnu/bash-2.01.tar.gz -ftp://slc2.ins.cwru.edu/pub/dist/bash-2.01.tar.gz +ftp://prep.ai.mit.edu/pub/gnu/bash-2.02.tar.gz +ftp://ftp.cwru.edu/pub/bash/bash-2.02.tar.gz Formatted versions of the documentation are available with the URLs: -ftp://prep.ai.mit.edu/pub/gnu/bash-doc-2.01.tar.gz -ftp://slc2.ins.cwru.edu/pub/dist/bash-doc-2.01.tar.gz +ftp://prep.ai.mit.edu/pub/gnu/bash-doc-2.02.tar.gz +ftp://ftp.cwru.edu/pub/bash/bash-doc-2.02.tar.gz 4) On what machines will bash run? @@ -162,8 +161,22 @@ project. For more information about the project, look at the URL http://www.cygnus.com/misc/gnu-win32 -Cygnus has ported bash-1.14.7. Maybe someday they (or I) will port -bash-2.01 (or later) to the GNU-Win32 environment. +Cygnus has ported bash-1.14.7, and their port is part of the current +gnu-win32 release. Cygnus has also done a port of bash-2.01 to the +GNU-Win32 environment, and it should be available as part of their next +release. + +Bash-2.02 should require no local Cygnus changes to build and run under +GNU-WIN32. + +The Cygnus port works only on Intel machines. There is a port of bash +(I don't know which version) to the alpha/NT environment available from + +ftp://ftp.gnustep.org//pub/win32/bash-alpha-nt-1.01.tar.gz + +Softway Systems has ported bash-2.01.1 to their OpenNT system, a +Unix subsystem for NT that replaces the Microsoft POSIX subsystem. +Check out http://www.opennt.com for more information. D. J. Delorie has ported bash-1.14.7 to run under MS-DOS, as part of the DJGPP project. For more information on the project, see @@ -179,11 +192,13 @@ The corresponding source is ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/bsh1147s.zip -A port of bash-1.12 is available for OS/2 from +Ports of bash-1.12 and bash-2.0 are available for OS/2 from -ftp://hobbes.nmsu.edu/os2/unix/bash_112.zip +ftp://hobbes.nmsu.edu/pub/os2/util/shell/bash_112.zip +ftp://hobbes.nmsu.edu/pub/os2/util/shell/bash-2.0(253).zip -I haven't looked at it. +I haven't looked at either, but the second appears to be a binary-only +distribution. Beware. 6) How can I build bash with gcc? @@ -193,11 +208,11 @@ file INSTALL in the distribution for more information. 7) How can I make bash my login shell? Some machines let you use `chsh' to change your login shell. Other -systems use `passwd -s'. If one of these works for you, that's all -you need. Note that many systems require the full pathname to a shell -to appear in /etc/shells before you can make it your login shell. For -this, you may need the assistance of your friendly local system -administrator. +systems use `passwd -s' or `passwd -e'. If one of these works for +you, that's all you need. Note that many systems require the full +pathname to a shell to appear in /etc/shells before you can make it +your login shell. For this, you may need the assistance of your +friendly local system administrator. If you cannot do this, you can still use bash as your login shell, but you need to perform some tricks. The basic idea is to add a command @@ -298,15 +313,37 @@ Reference Manual. Section B: The latest version -11) What's new in version 2.01? +11) What's new in version 2.02? + +Bash-2.02 has a number of new features. Here's a short list: -Bash-2.01 contains only a few new features. +a new version of malloc (based on the old GNU malloc code in previous + bash versions) that is more page-oriented, more conservative + with memory usage, does not `orphan' large blocks when they + are freed, is usable on 64-bit machines, and has allocation + checking turned on unconditionally +POSIX.2-style globbing character classes ([:alpha:], [:alnum:], etc.) +POSIX.2-style globbing equivalence classes +POSIX.2-style globbing collating symbols +the ksh [[...]] extended conditional command +the ksh egrep-style extended pattern matching operators +a new `printf' builtin +the ksh-like $(<filename) command substitution, which is equivalent to + $(cat filename) +new tilde prefixes that expand to directories from the directory stack +new `**' arithmetic operator to do exponentiation +case-insensitive globbing (filename expansion) +menu completion a la tcsh +`magic-space' history expansion function like tcsh +the readline inputrc `language' has a new file inclusion directive ($include) + +Bash-2.01 contained only a few new features: new `GROUPS' builtin array variable containing the user's group list new bindable readline commands: history-and-alias-expand-line and alias-expand-line -Bash-2.0 contains extensive changes and new features from bash-1.14.7. +Bash-2.0 contained extensive changes and new features from bash-1.14.7. Here's a short list: new `time' reserved word to time pipelines, shell builtins, and @@ -344,11 +381,11 @@ grammar tighter and smaller (66 reduce-reduce conflicts gone) lots of code now smaller and faster test suite greatly expanded -12) Are there any user-visible incompatibilities between bash-2.01 and +12) Are there any user-visible incompatibilities between bash-2.02 and bash-1.14.7? -There are a few incompatibilities between version 1.14.7 and version 2.01. -They are detailed in the file COMPAT in the bash-2.01 distribution. +There are a few incompatibilities between version 1.14.7 and version 2.02. +They are detailed in the file COMPAT in the bash-2.02 distribution. Section C: Differences from other Unix shells @@ -494,7 +531,7 @@ Implementation differences: 15) Which new features in ksh-93 are not in bash, and which are? -New things in ksh-93 not in bash-2.01: +New things in ksh-93 not in bash-2.02: associative arrays floating point arithmetic ++, --, comma arithmetic operators @@ -510,12 +547,12 @@ New things in ksh-93 not in bash-2.01: variables: .sh.edchar, .sh.edmode, .sh.edcol, .sh.edtext, HISTEDIT, .sh.version, .sh.name, .sh.subscript, .sh.value backreferences in pattern matching - print -f and printf (bash has loadable versions) + print -f (bash has a loadable version) `fc' has been renamed to `hist' read -t/-d `.' can execute shell functions -New things in ksh-93 present in bash-2.01: +New things in ksh-93 present in bash-2.02: ?: arithmetic operator expansions: ${!param}, ${param:offset[:len]}, ${param/pat[/str]} compound array assignment @@ -808,7 +845,7 @@ and the \] escape to signal the end of such a sequence. 27) How can I find the value of a shell variable whose name is the value of another shell variable? -Bash-2.01 supports this directly. You can use +Bash-2.02 supports this directly. You can use ${!var} @@ -830,7 +867,7 @@ parameter: The expansion of the quoted portions of this expression will be deferred until `eval' runs, while the `$#' will be expanded -before `eval' is executed. In bash-2.01, +before `eval' is executed. In bash-2.02, echo ${!#} @@ -1055,7 +1092,7 @@ is, in fact, a syntax error. Redirections may only precede `simple commands'. A subshell construct such as the above is one of the shell's `compound commands'. A redirection may only follow a compound command. -The file CWRU/sh-redir-hack in the bash-2.01 distribution is an +The file CWRU/sh-redir-hack in the bash-2.02 distribution is an (unofficial) patch to parse.y that will modify the grammar to support this construct. It will not apply with `patch'; you must modify parse.y by hand. Note that if you apply this, you must @@ -1100,34 +1137,30 @@ Postscript files created from the above source are available in the documentation distribution. There is additional documentation available for anonymous FTP from host -slc2.ins.cwru.edu in the `pub/bash' directory. +ftp.cwru.edu in the `pub/bash' directory. Cameron Newham and Bill Rosenblatt have written a book on bash, published by O'Reilly and Associates. The book is based on Bill Rosenblatt's Korn Shell book. The title is ``Learning the Bash Shell'', and the ISBN number is 1-56592-147-X. Look for it in fine bookstores near you. This book covers bash-1.14, but has an appendix describing some of the new features -in bash-2.0. There are rumors of a second edition of this book, describing -bash-2.0 (and 2.01). I do not know what ORA's publication schedule for -this edition is. +in bash-2.0. + +A second edition of this book is available, just published in January, 1998. +The ISBN number is 1-56592-347-2. Look for it in the same fine bookstores +or on the web. 39) What's coming in future versions? These are features I plan to include in a future version of bash. -POSIX.2-style globbing character classes ([:alpha:], [:alnum:], etc.) -POSIX.2-style globbing equivalence classes -POSIX.2-style globbing collating symbols -a bash debugger (a minimally-tested version is included with bash-2.01) +a bash debugger (a minimally-tested version is included with bash-2.02) +Programmable completion a la zsh 40) What's on the bash `wish list' for future versions? These are features that may or may not appear in a future version of bash. -Programmable completion a la zsh -menu completion a la tcsh -the ksh [[...]] extended test command -the ksh egrep-style extended pattern matching operators associative arrays (not really all that hard) breaking some of the shell functionality into embeddable libraries better internationalization using GNU `gettext' @@ -1135,13 +1168,15 @@ an option to use external files for the long `help' text timeouts for the `read' builtin the ksh-93 ${!prefix*} and ${!prefix@} operators arithmetic ++ and -- prefix and postfix operators +date-stamped command history 41) When will the next release appear? -The next version will appear sometime in 1997. Never make predictions. +The next version will appear sometime in 1998. Never make +predictions. -This document is Copyright 1995, 1996 by Chester Ramey. +This document is Copyright 1995, 1996, 1998 by Chester Ramey. Permission is hereby granted, without written agreement and without license or royalty fees, to use, copy, and distribute diff --git a/doc/Makefile.in b/doc/Makefile.in index 98f76b0..62e041d 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -30,6 +30,8 @@ TEX = tex MAKEINFO = makeinfo TEXI2DVI = ${topdir}/support/texi2dvi TEXI2HTML = ${topdir}/support/texi2html +MAN2HTML = ${BUILD_DIR}/support/man2html +HTMLPOST = ${srcdir}/htmlpost.sh QUIETPS = #set this to -q to shut up dvips DVIPS = dvips -D 300 $(QUIETPS) -o $@ # tricky TEXINPUTDIR = $(RL_LIBDIR)/doc @@ -45,7 +47,7 @@ GROFF = groff HSUSER = $(RL_LIBDIR)/doc/hsuser.texinfo RLUSER = $(RL_LIBDIR)/doc/rluser.texinfo -.SUFFIXES: .0 .1 .3 .ms .ps .txt .dvi +.SUFFIXES: .0 .1 .3 .ms .ps .txt .dvi .html .1.ps: $(RM) $@ @@ -55,6 +57,10 @@ RLUSER = $(RL_LIBDIR)/doc/rluser.texinfo $(RM) $@ -${NROFF} -man $< > $@ +.1.html: + $(RM) $@ + -${MAN2HTML} $< | ${HTMLPOST} > $@ + .ms.ps: $(RM) $@ -${GROFF} -ms $< > $@ @@ -71,6 +77,10 @@ RLUSER = $(RL_LIBDIR)/doc/rluser.texinfo $(RM) $@ -${NROFF} -man $< > $@ +.3.html: + $(RM) $@ + -${MAN2HTML} $< > $@ + all: ps info dvi text html nodvi: ps info text html @@ -78,7 +88,7 @@ ps: bash.ps bashbug.ps readline.ps article.ps builtins.ps dvi: bashref.dvi bashref.ps info: bashref.info text: bash.0 bashbug.0 builtins.0 readline.0 -html: bashref.html +html: bashref.html bash.html bashref.dvi: $(srcdir)/bashref.texi $(HSUSER) $(RLUSER) TEXINPUTS=.:$(TEXINPUTDIR):$$TEXINPUTS $(TEXI2DVI) $(srcdir)/bashref.texi @@ -102,6 +112,7 @@ bashman.ps: bash.dvi bash.txt: bash.1 bash.ps: bash.1 +bash.html: bash.1 $(MAN2HTML) bashbug.ps: bashbug.1 builtins.ps: builtins.1 bash.1 bash.0: bash.1 @@ -111,6 +122,9 @@ readline.0: readline.3 readline.ps: readline.3 article.ps: article.ms +$(MAN2HTML): ${topdir}/support/man2html.c + -( cd ${BUILD_DIR}/support ; ${MAKE} ${MFLAGS} man2html) + faq: faq.news faq.news2 faq.mail faq.version faq.version: FAQ.version FAQ @@ -6,11 +6,11 @@ .\" Case Western Reserve University .\" chet@ins.CWRU.Edu .\" -.\" Last Change: Mon May 19 12:45:24 EDT 1997 +.\" Last Change: Wed Apr 1 12:16:09 EST 1998 .\" .\" bash_builtins, strip all but Built-Ins section .if \n(zZ=1 .ig zZ -.TH BASH 1 "1997 May 19" GNU +.TH BASH 1 "1998 Apr 1" GNU .\" .\" There's some problem with having a `@' .\" in a tagged paragraph with the BSD man macros. @@ -61,19 +61,19 @@ also incorporates useful features from the \fIKorn\fP and \fIC\fP shells (\fBksh\fP and \fBcsh\fP). .PP .B Bash -is ultimately intended to be a conformant implementation of the IEEE +is intended to be a conformant implementation of the IEEE POSIX Shell and Tools specification (IEEE Working Group 1003\.2). .SH OPTIONS In addition to the single-character shell options documented in the description of the \fBset\fR builtin command, \fBbash\fR -interprets the following flags when it is invoked: +interprets the following options when it is invoked: .PP .PD 0 .TP 10 .BI \-c "\| string\^" If the .B \-c -flag is present, then commands are read from +option is present, then commands are read from .IR string . If there are arguments after the .IR string , @@ -83,7 +83,7 @@ they are assigned to the positional parameters, starting with .B \-r If the .B \-r -flag is present, the shell becomes +option is present, the shell becomes .I restricted (see .SM @@ -93,13 +93,13 @@ below). .B \-i If the .B \-i -flag is present, the shell is +option is present, the shell is .IR interactive . .TP .B \-s If the .B \-s -flag is present, or if no arguments remain after option +option is present, or if no arguments remain after option processing, then commands are read from the standard input. This option allows the positional parameters to be set when invoking an interactive shell. @@ -130,6 +130,10 @@ single-character options in order for them to be recognized. .PP .PD 0 .TP +.B \-\-dump\-po\-strings +Equivalent to \fB\-D\fP, but the output is in the GNU \fIgettext\fP +\fBpo\fP (portable object) file format. +.TP .B \-\-dump\-strings Equivalent to \fB\-D\fP. .TP @@ -309,8 +313,8 @@ it tries to mimic the startup behavior of historical versions of .B sh as closely as possible, while conforming to the POSIX standard as well. -When invoked as a login shell, it first attempts to read and execute -commands from +When invoked as an interactive login shell, it first attempts to +read and execute commands from .I /etc/profile and .IR ~/.profile , @@ -349,13 +353,12 @@ is started in mode, as with the .B \-\-posix command line option, it follows the POSIX standard for startup files. -In this mode, the +In this mode, interactive shells expand the .SM .B ENV -variable is expanded and commands are read and executed from the file +variable and commands are read and executed from the file whose name is the expanded value. No other startup files are read. -This is done by interactive shells only. .PP .B Bash attempts to determine when it is being run by the remote shell @@ -427,8 +430,8 @@ command: .if t .RS .PP .B -.if n ! case do done elif else esac fi for function if in select then until while { } time -.if t ! case do done elif else esac fi for function if in select then until while { } time +.if n ! case do done elif else esac fi for function if in select then until while { } time [[ ]] +.if t ! case do done elif else esac fi for function if in select then until while { } time [[ ]] .if t .RE .RE .SH "SHELL GRAMMAR" @@ -582,6 +585,67 @@ If the value of the expression is non-zero, the return status is 0; otherwise the return status is 1. This is exactly equivalent to \fBlet "\fIexpression\fP"\fR. .TP +\fB[[\fP \fIexpression\fP \fB]]\fP +Return a status of 0 or 1 depending on the evaluation of +the conditional expression \fIexpression\fP. +Expressions are composed of the primaries described below under +.SM +.BR "CONDITIONAL EXPRESSIONS" . +Word splitting and pathname expansion are not performed on the words +between the \fB[[\fP and \fB]]\fP; tilde expansion, parameter and +variable expansion, arithmetic expansion, command substitution, process +substitution, and quote removal are performed. +.if t .sp 0.5 +.if n .sp 1 +When the \fB==\fP and \fB!=\fP operators are used, the string to the +right of the operator is considered a pattern and matched according +to the rules described below under \fBPattern Matching\fP. +The return value is 0 if the string matches or does not match +the pattern, respectively, and 1 otherwise. +Any part of the pattern may be quoted to force it to be matched as a +string. +.if t .sp 0.5 +.if n .sp 1 +Expressions may be combined using the following operators, listed +in decreasing order of precedence: +.if t .sp 0.5 +.if n .sp 1 +.RS +.PD 0 +.TP +.B ( \fIexpression\fP ) +Returns the value of \fIexpression\fP. +This may be used to override the normal precedence of operators. +.TP +.B ! \fIexpression\fP +True if +.I expression +is false. +.TP +\fIexpression1\fP \fB&&\fP \fIexpression2\fP +True if both +.I expression1 +and +.I expression2 +are true. +.TP +.if t \fIexpression1\fP \fB\(bv\(bv\fP \fIexpression2\fP +.if n \fIexpression1\fP \fB||\fP \fIexpression2\fP +True if either +.I expression1 +or +.I expression2 +is true. +.PD +.RE +.LP +The \fB&&\fP and +.if t \fB\(bv\(bv\fP +.if n \fB||\fP +operators do not execute \fIexpression2\fP if the value of +\fIexpression1\fP is sufficient to determine the return value of +the entire conditional expression. +.TP \fBfor\fP \fIname\fP [ \fBin\fP \fIword\fP; ] \fBdo\fP \fIlist\fP ; \fBdone\fP The list of words following \fBin\fP is expanded, generating a list of items. The variable \fIname\fP is set to each element of this list @@ -591,6 +655,9 @@ once for each positional parameter that is set (see .SM .B PARAMETERS below). +The return status is the exit status of the last command that executes. +If the expansion of the items following \fBin\fP results in an empty +list, no commands are executed, and the return status is 0. .TP \fBselect\fP \fIname\fP [ \fBin\fP \fIword\fP; ] \fBdo\fP \fIlist\fP ; \fBdone\fP The list of words following \fBin\fP is expanded, generating a list @@ -694,7 +761,6 @@ below), a word beginning with causes that word and all remaining characters on that line to be ignored. An interactive shell without the .B interactive_comments -.B shopt option enabled does not allow comments. The .B interactive_comments option is on by default in interactive shells. @@ -717,8 +783,9 @@ A non-quoted backslash (\fB\e\fP) is the .IR "escape character" . It preserves the literal value of the next character that follows, with the exception of <newline>. If a \fB\e\fP<newline> pair -appears, and the backslash is not quoted, the \fB\e\fP<newline> -is treated as a line continuation (that is, it is effectively ignored). +appears, and the backslash is not itself quoted, the \fB\e\fP<newline> +is treated as a line continuation (that is, it is removed from the +input stream and effectively ignored). .PP Enclosing characters in single quotes preserves the literal value of each character within the quotes. A single quote may not occur @@ -791,7 +858,12 @@ vertical tab backslash .TP .B \e\fInnn\fP -the character whose ASCII code is \fInnn\fP (octal) +the character whose ASCII code is the octal value \fInnn\fP +(one to three digits) +.TP +.B \ex\fInnn\fP +the character whose ASCII code is the hexadecimal value \fInnn\fP +(one to three digits) .PD .RE .LP @@ -844,7 +916,7 @@ removal (see .SM .B EXPANSION below). If the variable has its -.B \-i +.B integer attribute set (see .B declare below in @@ -852,8 +924,8 @@ below in .BR "SHELL BUILTIN COMMANDS" ) then .I value -is subject to arithmetic expansion even if the $((...)) syntax does -not appear (see +is subject to arithmetic expansion even if the $((...)) expansion is +not used (see .B "Arithmetic Expansion" below). Word splitting is not performed, with the exception @@ -894,8 +966,8 @@ with the value of each parameter separated by the first character of the .SM .B IFS -special variable. That is, ``\fB$*\fP'' is equivalent -to ``\fB$1\fP\fIc\fP\fB$2\fP\fIc\fP\fB...\fP'', where +special variable. That is, "\fB$*\fP" is equivalent +to "\fB$1\fP\fIc\fP\fB$2\fP\fIc\fP\fB...\fP", where .I c is the first character of the value of the .SM @@ -911,12 +983,10 @@ is null, the parameters are joined without intervening separators. .TP .B @ Expands to the positional parameters, starting from one. When the -expansion occurs within double quotes, each parameter expands as a -separate word. That is, `` -.BR $@ '' -is equivalent to -``\fB$1\fP'' ``\fB$2\fP'' ... -When there are no positional parameters, ``\fB$@\fP'' and +expansion occurs within double quotes, each parameter expands to a +separate word. That is, "\fB$@\fP" is equivalent to +"\fB$1\fP" "\fB$2\fP" ... +When there are no positional parameters, "\fB$@\fP" and .B $@ expand to nothing (i.e., they are removed). .TP @@ -934,7 +1004,7 @@ by the builtin command, or those set by the shell itself (such as the .B \-i -flag). +option). .TP .B $ Expands to the process ID of the shell. In a () subshell, it @@ -980,7 +1050,7 @@ The following variables are set by the shell: .PD 0 .TP .B PPID -The process ID of the shell's parent. +The process ID of the shell's parent. This variable is readonly. .TP .B PWD The current working directory as set by the @@ -999,14 +1069,15 @@ builtin command when no arguments are supplied. .TP .B UID Expands to the user ID of the current user, initialized at shell startup. +This variable is readonly. .TP .B EUID Expands to the effective user ID of the current user, initialized at -shell startup. +shell startup. This variable is readonly. .TP .B GROUPS An array variable containing the list of groups of which the current -user is a member. +user is a member. This variable is readonly. .TP .B BASH Expands to the full file name used to invoke this instance of @@ -1017,8 +1088,8 @@ Expands to a string describing the version of this instance of .BR bash . .TP .B BASH_VERSINFO -An array variable whose members hold version information for this -instance of +A readonly array variable whose members hold version information for +this instance of .BR bash . The values assigned to the array members are as follows: .sp .5 @@ -1219,22 +1290,23 @@ A common value is ``/usr/gnu/bin:/usr/local/bin:/usr/ucb:/bin:/usr/bin:.''. .B HOME The home directory of the current user; the default argument for the \fBcd\fP builtin command. +The value of this variable is also used when performing tilde expansion. .TP .B CDPATH The search path for the .B cd -command. This is a colon-separated -list of directories in which the shell looks for destination directories -specified by the +command. +This is a colon-separated list of directories in which the shell looks +for destination directories specified by the .B cd -command. A sample value is -``.:~:/usr''. +command. +A sample value is ``.:~:/usr''. .TP .B BASH_ENV If this parameter is set when \fBbash\fP is executing a shell script, its value is interpreted as a filename containing commands to initialize the shell, as in -.IR .bashrc . +.IR ~/.bashrc . The value of .SM .B BASH_ENV @@ -1262,8 +1334,10 @@ If this variable is unset, the shell disables mail checking. .TP .B MAILPATH A colon-separated list of file names to be checked for mail. -The message to be printed may be specified by separating the file name from -the message with a `?'. $_ stands for the name of the current mailfile. +The message to be printed when mail arrives in a particular file +may be specified by separating the file name from the message with a `?'. +When used in the text of the message, \fB$_\fP expands to the name of +the current mailfile. Example: .RS .PP @@ -1397,7 +1471,14 @@ This variable overrides the value of \fBLANG\fP and any other .TP .B LC_COLLATE This variable determines the collation order used when sorting the -results of pathname expansion. +results of pathname expansion, and determines the behavior of range +expressions, equivalence classes, and collating sequences within +pathname expansion and pattern matching. +.TP +.B LC_CTYPE +This variable determines the interpretation of characters and the +behavior of character classes within pathname expansion and pattern +matching. .TP .B LC_MESSAGES This variable determines the locale used to translate double-quoted @@ -1487,6 +1568,9 @@ of .BR HISTIGNORE . This variable's function is superseded by .BR HISTIGNORE . +The second and subsequent lines of a multi-line compound command are +not tested, and are added to the history regardless of the value of +.BR HISTCONTROL . .TP .B HISTIGNORE A colon-separated list of patterns used to decide which command lines @@ -1499,6 +1583,9 @@ are applied. In addition to the normal shell pattern matching characters, `\fB&\fP' matches the previous history line. `\fB&\fP' may be escaped using a backslash. The backslash is removed before attempting a match. +The second and subsequent lines of a multi-line compound command are +not tested, and are added to the history regardless of the value of +.BR HISTIGNORE . .TP .B histchars The two or three characters which control history expansion @@ -1507,7 +1594,7 @@ and tokenization (see .B HISTORY EXPANSION below). The first character is the .IR "history expansion character" , -that is, the character which signals the start of a history +the character which signals the start of a history expansion, normally `\fB!\fP'. The second character is the .IR "quick substitution" @@ -1515,7 +1602,7 @@ character, which is used as shorthand for re-running the previous command entered, substituting one string for another in the command. The default is `\fB^\fP'. The optional third character is the character -which signifies that the remainder of the line is a comment when found +which indicates that the remainder of the line is a comment when found as the first character of a word, normally `\fB#\fP'. The history comment character causes history substitution to be skipped for the remaining words on the line. It does not necessarily cause the shell @@ -1623,7 +1710,7 @@ referencing element zero. .PP The .B unset -builtin is used to destroy arrays. \fBunset\fP \fIname\fP[\fIsubscript\fP] +builtin is used to destroy arrays. \fBunset\fP \fBname\fP[\fIsubscript\fP] destroys the array element at index \fIsubscript\fP. \fBunset\fP \fIname\fP, where \fIname\fP is an array, or \fBunset\fP \fIname\fP[\fIsubscript\fP], where @@ -1672,7 +1759,7 @@ Only brace expansion, word splitting, and pathname expansion can change the number of words of the expansion; other expansions expand a single word to a single word. The only exceptions to this are the expansions of -``\fB$@\fP'' and ``\fB${\fP\fIname\fP\fB[@]}\fP'' +"\fB$@\fP" and "\fB${\fP\fIname\fP\fB[@]}\fP" as explained above (see .SM .BR PARAMETERS ). @@ -1687,9 +1774,9 @@ the form of an optional .IR preamble , followed by a series of comma-separated strings between a pair of braces, followed by an optional -.IR postamble . +.IR postscript . The preamble is prefixed to each string contained -within the braces, and the postamble is then appended +within the braces, and the postscript is then appended to each resulting string, expanding left to right. .PP Brace expansions may be nested. The results of each expanded @@ -1753,39 +1840,51 @@ command (see below). .SS Tilde Expansion .PP -If a word begins with a tilde character (`\fB~\fP'), all of the characters -preceding the first slash (or all characters, if there is no slash) -are treated as a possible \fIlogin name\fP. If this \fIlogin name\fP -is the null string, the tilde is replaced with the value of the -parameter +If a word begins with an unquoted tilde character (`\fB~\fP'), all of +the characters preceding the first unquoted slash (or all characters, +if there is no unquoted slash) are considered a \fItilde-prefix\fP. +If none of the characters in the tilde-prefix are quoted, the +characters in the tilde-prefix following the tilde are treated as a +possible \fIlogin name\fP. +If this login name is the null string, the tilde is replaced with the +value of the shell parameter .SM .BR HOME . If .SM .B HOME -is unset, the home directory of -the user executing the shell is substituted instead. +is unset, the home directory of the user executing the shell is +substituted instead. +Otherwise, the tilde-prefix is replaced with the home directory +associated with the specified login name. .PP -If a `+' follows the tilde, the value of +If the tilde-prefix is a `~+', the value of the shell variable .SM .B PWD -replaces the tilde and `+'. If -a `\-' follows, the value of -.SM -.B OLDPWD -is substituted. -If the value following the tilde is a valid \fIlogin name\fP, -the tilde and \fIlogin name\fP are replaced with the home directory -associated with that name. If the name is invalid, or the tilde -expansion fails, the word is unchanged. +replaces the tilde-prefix. +If the tilde-prefix is a `~\-', the value of the shell variable +.SM +.BR OLDPWD , +if it is set, is substituted. +If the characters following the tilde in the tilde-prefix consist +of a number \fIN\fP, optionally prefixed +by a `+' or a `\-', the tilde-prefix is replaced with the corresponding +element from the directory stack, as it would be displayed by the +.B dirs +builtin invoked with the tilde-prefix as an argument. +If the characters following the tilde in the tilde-prefix consist of a +number without a leading `+' or `\-', `+' is assumed. +.PP +If the login name is invalid, or the tilde expansion fails, the word +is unchanged. .PP -Each variable assignment is checked for unquoted -tildes immediately following a +Each variable assignment is checked for unquoted tilde-prefixes immediately +following a .B : or .BR = . -In these cases, tilde substitution is also performed. Consequently, one -may use file names with tildes in assignments to +In these cases, tilde expansion is also performed. +Consequently, one may use file names with tildes in assignments to .SM .BR PATH , .SM @@ -1803,6 +1902,11 @@ are optional but serve to protect the variable to be expanded from characters immediately following it which could be interpreted as part of the name. .PP +When braces are used, the matching ending brace is the first `\fB}\fP' +not escaped by a backslash or within a quoted string, and not within an +embedded arithmetic expansion, command substitution, or paramter +expansion. +.PP .PD 0 .TP ${\fIparameter\fP} @@ -1880,7 +1984,7 @@ ${\fIparameter\fP\fB:\fP\fIoffset\fP\fB:\fP\fIlength\fP} .PD \fBSubstring Expansion.\fP Expands to up to \fIlength\fP characters of \fIparameter\fP, -starting at \fIoffset\fP. +starting at the characters specified by \fIoffset\fP. If \fIlength\fP is omitted, expands to the substring of \fIparameter\fP, starting at the character specified by \fIoffset\fP. \fIlength\fP and \fIoffset\fP are arithmetic expressions (see @@ -1896,8 +2000,8 @@ parameters beginning at \fIoffset\fP. If \fIparameter\fP is an array name indexed by @ or *, the result is the \fIlength\fP members of the array beginning with ${\fIparameter\fP[\fIoffset\fP]}. -Substring indexing is zero-based unless the positional parameters are -used, in which case the indexing starts at 1. +Substring indexing is zero-based unless the positional parameters +are used, in which case the indexing starts at 1. .TP ${\fB#\fP\fIparameter\fP} The length in characters of the value of \fIparameter\fP is substituted. @@ -1907,14 +2011,14 @@ is .B * or .BR @ , -the length substituted is the number of positional parameters. +the value substituted is the number of positional parameters. If .I parameter is an array name subscripted by .B * or .BR @ , -the length substituted is the number of elements in the array. +the value substituted is the number of elements in the array. .TP .PD 0 ${\fIparameter\fP\fB#\fP\fIword\fP} @@ -1927,7 +2031,7 @@ is expanded to produce a pattern just as in pathname expansion. If the pattern matches the beginning of the value of .IR parameter , -then the expansion is the value of +then the result of the expansion is the expanded value of .I parameter with the shortest matching pattern (the ``\fB#\fP'' case) or the longest matching pattern (the ``\fB##\fP'' case) deleted. @@ -1955,9 +2059,9 @@ ${\fIparameter\fP\fB%%\fP\fIword\fP} .PD The \fIword\fP is expanded to produce a pattern just as in pathname expansion. -If the pattern matches a trailing portion of the value of +If the pattern matches a trailing portion of the expanded value of .IR parameter , -then the expansion is the value of +then the result of the expansion is the expanded value of .I parameter with the shortest matching pattern (the ``\fB%\fP'' case) or the longest matching pattern (the ``\fB%%\fP'' case) deleted. @@ -2014,7 +2118,7 @@ the substitution operation is applied to each member of the array in turn, and the expansion is the resultant list. .SS Command Substitution .PP -\fICommand substitution\fP allows the output of a command to replace +\fICommand substitution\fP allows the output of a command to replace the command name. There are two forms: .PP .RS @@ -2030,6 +2134,10 @@ or performs the expansion by executing \fIcommand\fP and replacing the command substitution with the standard output of the command, with any trailing newlines deleted. +Embedded newlines are not deleted, but they may be removed during +word splitting. +The command substitution \fB$(cat \fIfile\fP)\fR can be replaced by +the equivalent but faster \fB$(< \fIfile\fP)\fR. .PP When the old-style backquote form of substitution is used, backslash retains its literal meaning except when followed by @@ -2037,10 +2145,12 @@ backslash retains its literal meaning except when followed by .BR ` , or .BR \e . +The first backquote not preceded by a backslash terminates the +command substitution. When using the $(\^\fIcommand\fP\|) form, all characters between the parentheses make up the command; none are treated specially. .PP -Command substitutions may be nested. To nest when using the old form, +Command substitutions may be nested. To nest when using the backquoted form, escape the inner backquotes with backslashes. .PP If the substitution appears within double quotes, word splitting and @@ -2086,7 +2196,7 @@ the file will provide input for \fIlist\fP. If the \fB<(\fP\fIlist\^\fP\fB)\fP form is used, the file passed as an argument should be read to obtain the output of \fIlist\fP. .PP -On systems that support it, \fIprocess substitution\fP is performed +When available, \fIprocess substitution\fP is performed simultaneously with parameter and variable expansion, command substitution, and arithmetic expansion. @@ -2169,6 +2279,7 @@ option has been set, scans each word for the characters .BR * , .BR ? , +.BR ( , and .BR [ . If one of these characters appears, then the word is @@ -2180,8 +2291,14 @@ If no matching file names are found, and the shell option .B nullglob is disabled, the word is left unchanged. -If the option is set, and no matches are found, +If the +.B nullglob +option is set, and no matches are found, the word is removed. +If the shell option +.B nocaseglob +is enabled, the match is performed without regard to the case +of alphabetic characters. When a pattern is used for pathname expansion, the character .B ``.'' @@ -2189,7 +2306,8 @@ at the start of a name or immediately following a slash must be matched explicitly, unless the shell option .B dotglob is set. -The slash character must always be matched explicitly. +When matching a pathname, the slash character must always be +matched explicitly. In other cases, the .B ``.'' character is not treated specially. @@ -2199,7 +2317,8 @@ below under .SM .B SHELL BUILTIN COMMANDS for a description of the -.B nullglob +.BR nocaseglob , +.BR nullglob , and .B dotglob shell options. @@ -2245,6 +2364,13 @@ option is disabled when .B GLOBIGNORE is unset. .PP +\fBPattern Matching\fP +.PP +Any character that appears in a pattern, other than the special pattern +characters described below, matches itself. The NUL character may not +occur in a pattern. The special pattern characters must be quoted if +they are to be matched literally. +.PP The special pattern characters have the following meanings: .PP .PD 0 @@ -2275,13 +2401,78 @@ A .B ] may be matched by including it as the first character in the set. +.br +.if t .sp 0.5 +.if n .sp 1 +Within +.B [ +and +.BR ] , +\fIcharacter classes\fP can be specified using the syntax +\fB[:\fP\fIclass\fP\fB:]\fP, where \fIclass\fP is one of the +following classes defined in the POSIX.2 standard: +.PP +.RS +.B +.if n alnum alpha ascii blank cntrl digit graph lower print punct space upper xdigit +.if t alnum alpha ascii blank cntrl digit graph lower print punct space upper xdigit +.br +A character class matches any character belonging to that class. +.br +.if t .sp 0.5 +.if n .sp 1 +Within +.B [ +and +.BR ] , +an \fIequivalence class\fP can be specified using the syntax +\fB[=\fP\fIc\fP\fB=]\fP, which matches all characters with the +same collation weight (as defined by the current locale) as +the character \fIc\fP. +.br +.if t .sp 0.5 +.if n .sp 1 +Within +.B [ +and +.BR ] , +the syntax \fB[.\fP\fIsymbol\fP\fB.]\fP matches the collating symbol +\fIsymbol\fP. +.RE +.PD +.PP +If the \fBextglob\fP shell option is enabled using the \fBshopt\fP +builtin, several extended pattern matching operators are recognized. +In the following description, a \fIpattern\-list\fP is a list of one +or more patterns separated by a \fB|\fP. +Composite patterns may be formed using one or more of the following +sub-patterns: +.sp 1 +.PD 0 +.RS +.TP +\fB?(\fP\^\fIpattern-list\^\fP\fB)\fP +Matches zero or one occurrence of the given patterns +.TP +\fB*(\fP\^\fIpattern-list\^\fP\fB)\fP +Matches zero or more occurrences of the given patterns +.TP +\fB+(\fP\^\fIpattern-list\^\fP\fB)\fP +Matches one or more occurrences of the given patterns +.TP +\fB@(\fP\^\fIpattern-list\^\fP\fB)\fP +Matches exactly one of the given patterns +.TP +\fB!(\fP\^\fIpattern-list\^\fP\fB)\fP +Matches anything except one of the given patterns +.RE .PD .SS Quote Removal .PP After the preceding expansions, all unquoted occurrences of the characters .BR \e , -.BR ` , +.BR ' , and \^\f3"\fP\^ that did not result from one of the above expansions are removed. .SH REDIRECTION @@ -2307,11 +2498,11 @@ the redirection refers to the standard input (file descriptor the redirection refers to the standard output (file descriptor 1). .PP -The word that follows the redirection operator in the following -descriptions is subjected to brace expansion, tilde expansion, -parameter expansion, command substitution, arithmetic expansion, -quote removal, and pathname expansion. If it expands to more -than one word, +The word following the redirection operator in the following +descriptions, unless otherwise noted, is subjected to brace expansion, +tilde expansion, parameter expansion, command substitution, arithmetic +expansion, quote removal, and pathname expansion. +If it expands to more than one word, .B bash reports an error. .PP @@ -2335,6 +2526,8 @@ directs only the standard output to file because the standard error was duplicated as standard output before the standard output was redirected to .IR dirlist . +.PP +A failure to open or create a file causes the redirection to fail. .SS Redirecting Input .PP Redirection of input causes the file whose name results from @@ -2372,18 +2565,21 @@ The general format for redirecting output is: If the redirection operator is .BR > , and the -.B \-C +.B noclobber option to the .B set builtin has been enabled, the redirection will fail if the filename -whose name results from the expansion of \fIword\fP exists. +whose name results from the expansion of \fIword\fP exists and is +a regular file. If the redirection operator is .BR >| , -then the value of the -.B \-C +or the redirection operator is +.B > +and the +.B noclobber option to the .B set -builtin command is not tested, and the redirection is attempted even +builtin command is not enabled, the redirection is attempted even if the file named by \fIword\fP exists. .SS Appending Redirected Output .PP @@ -2460,7 +2656,8 @@ are quoted, the .I delimiter is the result of quote removal on .IR word , -and the lines in the here-document are not expanded. Otherwise, +and the lines in the here-document are not expanded. +If \fIword\fP is unquoted, all lines of the here-document are subjected to parameter expansion, command substitution, and arithmetic expansion. In the latter case, the pair @@ -2494,7 +2691,11 @@ If .I word expands to one or more digits, the file descriptor denoted by .I n -is made to be a copy of that file descriptor. If +is made to be a copy of that file descriptor. +If the digits in +.I word +do not specify a file descriptor open for input, a redirection error occurs. +If .I word evaluates to .BR \- , @@ -2513,6 +2714,9 @@ The operator is used similarly to duplicate output file descriptors. If .I n is not specified, the standard output (file descriptor 1) is used. +If the digits in +.I word +do not specify a file descriptor open for output, a redirection error occurs. As a special case, if \fIn\fP is omitted, and \fIword\fP does not expand to one or more digits, the standard output and standard error are redirected as described previously. @@ -2532,6 +2736,8 @@ or on file descriptor 0 if .I n is not specified. If the file does not exist, it is created. .SH ALIASES +Aliases allow a string to be substituted for a word when it is used +as the first word of a simple command. The shell maintains a list of .I aliases that may be set and unset with the @@ -2596,7 +2802,7 @@ command does not take effect until the next line of input is read. The commands following the alias definition on that line are not affected by the new alias. This behavior is also an issue when functions are executed. -Aliases are expanded when the function definition is read, +Aliases are expanded when a function definition is read, not when the function is executed, because a function definition is itself a compound command. As a consequence, aliases defined in a function are not available until after that @@ -2605,7 +2811,7 @@ alias definitions on a separate line, and do not use .B alias in compound commands. .PP -Note that for almost every purpose, aliases are superseded by +For almost every purpose, aliases are superseded by shell functions. .SH FUNCTIONS A shell function, defined as described above under @@ -2644,7 +2850,7 @@ execution resumes with the next command after the function call. When a function completes, the values of the positional parameters and the special parameter .B # -are restored to the values they had prior to function +are restored to the values they had prior to the function's execution. .PP Function names and definitions may be listed with the @@ -2669,6 +2875,258 @@ builtin. .PP Functions may be recursive. No limit is imposed on the number of recursive calls. +.SH "ARITHMETIC EVALUATION" +The shell allows arithmetic expressions to be evaluated, under +certain circumstances (see the \fBlet\fP builtin command and +\fBArithmetic Expansion\fP). +Evaluation is done in long integers with no check for overflow, +though division by 0 is trapped and flagged as an error. +The following list of operators is grouped into levels of +equal-precedence operators. +The levels are listed in order of decreasing precedence. +.PP +.PD 0 +.TP +.B \- + +unary minus and plus +.TP +.B ! ~ +logical and bitwise negation +.TP +.B ** +exponentiation +.TP +.B * / % +multiplication, division, remainder +.TP +.B + \- +addition, subtraction +.TP +.B << >> +left and right bitwise shifts +.TP +.B <= >= < > +comparison +.TP +.B == != +equality and inequality +.TP +.B & +bitwise AND +.TP +.B ^ +bitwise exclusive OR +.TP +.B | +bitwise OR +.TP +.B && +logical AND +.TP +.B || +logical OR +.TP +.B \fIexpr\fP?\fIexpr\fP:\fIexpr\fP +conditional evaluation +.TP +.B = *= /= %= += \-= <<= >>= &= ^= |= +assignment +.PD +.PP +Shell variables are allowed as operands; parameter expansion is +performed before the expression is evaluated. +The value of a parameter is coerced to a long integer within +an expression. A shell variable need not have its integer attribute +turned on to be used in an expression. +.PP +Constants with a leading 0 are interpreted as octal numbers. +A leading 0x or 0X denotes hexadecimal. +Otherwise, numbers take the form [\fIbase#\fP]n, where \fIbase\fP +is a decimal number between 2 and 64 representing the arithmetic +base, and \fIn\fP is a number in that base. +If \fIbase\fP is omitted, then base 10 is used. +The digits greater than 9 are represented by the lowercase letters, +the uppercase letters, _, and @, in that order. +If \fIbase\fP is less than or equal to 36, lowercase and uppercase +letters may be used interchangably to represent numbers between 10 +and 35. +.PP +Operators are evaluated in order of precedence. Sub-expressions in +parentheses are evaluated first and may override the precedence +rules above. +.SH "CONDITIONAL EXPRESSIONS" +Conditional expressions are used by the \fB[[\fP compound command and +the \fBtest\fP and \fB[\fP builtin commands to test file attributes +and perform string and arithmetic comparisons. +Expressions are formed from the following unary or binary primaries. +If any \fIfile\fP argument to one of the primaries is of the form +/dev/fd/\fIn\fP, then file descriptor \fIn\fP is checked. +.sp 1 +.PD 0 +.TP +.B \-a \fIfile\fP +True if \fIfile\fP exists. +.TP +.B \-b \fIfile\fP +True if \fIfile\fP exists and is a block special file. +.TP +.B \-c \fIfile\fP +True if \fIfile\fP exists and is a character special file. +.TP +.B \-d \fIfile\fP +True if \fIfile\fP exists and is a directory. +.TP +.B \-e \fIfile\fP +True if \fIfile\fP exists. +.TP +.B \-f \fIfile\fP +True if \fIfile\fP exists and is a regular file. +.TP +.B \-g \fIfile\fP +True if \fIfile\fP exists and is set-group-id. +.TP +.B \-k \fIfile\fP +True if \fIfile\fP exists and its ``sticky'' bit is set. +.TP +.B \-p \fIfile\fP +True if \fIfile\fP exists and is a named pipe (FIFO). +.TP +.B \-r \fIfile\fP +True if \fIfile\fP exists and is readable. +.TP +.B \-s \fIfile\fP +True if \fIfile\fP exists and has a size greater than zero. +.TP +.B \-t \fIfd\fP +True if file descriptor +.I fd +is open and refers to a terminal. +.TP +.B \-u \fIfile\fP +True if \fIfile\fP exists and its set-user-id bit is set. +.TP +.B \-w \fIfile\fP +True if \fIfile\fP exists and is writable. +.TP +.B \-x \fIfile\fP +True if \fIfile\fP exists and is executable. +.TP +.B \-O \fIfile\fP +True if \fIfile\fP exists and is owned by the effective user id. +.TP +.B \-G \fIfile\fP +True if \fIfile\fP exists and is owned by the effective group id. +.TP +.B \-L \fIfile\fP +True if \fIfile\fP exists and is a symbolic link. +.TP +.B \-S \fIfile\fP +True if \fIfile\fP exists and is a socket. +.TP +.B \-N \fIfile\fP +True if \fIfile\fP exists and has been modified since it was last read. +.TP +\fIfile1\fP \-\fBnt\fP \fIfile2\fP +True if \fIfile1\fP is newer (according to +modification date) than \fIfile2\fP. +.TP +\fIfile1\fP \-\fBot\fP \fIfile2\fP +True if \fIfile1\fP is older than \fIfile2\fP. +.TP +\fIfile1\fP \fB\-ef\fP \fIfile2\fP +True if \fIfile1\fP and \fIfile2\fP have the same device and +inode numbers. +.TP +.B \-o \fIoptname\fP +True if shell option +.I optname +is enabled. +See the list of options under the description of the +.B \-o +option to the +.B set +builtin below. +.TP +.B \-z \fIstring\fP +True if the length of \fIstring\fP is zero. +.TP +.B \-n \fIstring\fP +.TP +\fIstring\fP +True if the length of +.I string +is non-zero. +.TP +\fIstring1\fP \fB==\fP \fIstring2\fP +True if the strings are equal. \fB=\fP may be used in place of +\fB==\fP. +.TP +\fIstring1\fP \fB!=\fP \fIstring2\fP +True if the strings are not equal. +.TP +\fIstring1\fP \fB<\fP \fIstring2\fP +True if \fIstring1\fP sorts before \fIstring2\fP lexicographically +in the current locale. +.TP +\fIstring1\fP \fB>\fP \fIstring2\fP +True if \fIstring1\fP sorts after \fIstring2\fP lexicographically +in the current locale. +.TP +.I \fIarg1\fP \fBOP\fP \fIarg2\fP +.SM +.B OP +is one of +.BR \-eq , +.BR \-ne , +.BR \-lt , +.BR \-le , +.BR \-gt , +or +.BR \-ge . +These arithmetic binary operators return true if \fIarg1\fP +is equal to, not equal to, less than, less than or equal to, +greater than, or greater than or equal to \fIarg2\fP, respectively. +.I Arg1 +and +.I arg2 +may be positive or negative integers. +.PD +.SH "SIMPLE COMMAND EXPANSION" +When a simple command is executed, the shell performs the following +expansions, assignments, and redirections, from left to right. +.IP 1. +The words that the parser has marked as variable assignments (those +preceding the command name) and redirections are saved for later +processing. +.IP 2. +The words that are not variable assignments or redirections are +expanded. If any words remain after expansion, the first word +is taken to be the name of the command and the remaining words are +the arguments. +.IP 3. +Redirections are performed as described above under +.SM +.BR REDIRECTION . +.IP 4. +The text after the \fB=\fP in each variable assignment undergoes tilde +expansion, parameter expansion, command substitution, arithmetic expansion, +and quote removal before being assigned to the variable. +.PP +If no command name results, the variable assignments affect the current +shell environment. Otherwise, the variables are added to the environment +of the executed command and do not affect the current shell environment. +If any of the assignments attempts to assign a value to a readonly variable, +an error occurs, and the command exits with a non-zero status. +.PP +If no command name results, redirections are performed, but do not +affect the current shell environment. A redirection error causes the +command to exit with a non-zero status. +.PP +If there is a command name left after expansion, execution proceeds as +described below. Otherwise, the command exits. If one of the expansions +contained a command substitution, the exit status of the command is +the exit status of the last command substitution performed. If there +were no command substitutions, the command exits with a status of zero. .SH "COMMAND EXECUTION" After a command has been split into words, if it results in a simple command and an optional list of arguments, the following @@ -2703,10 +3161,11 @@ A full search of the directories in .B PATH is performed only if the command is not found in the hash table. If the search is unsuccessful, the shell prints an error -message and returns a non-zero exit status. +message and returns an exit status of 127. .PP If the search is successful, or if the command name contains -one or more slashes, the shell executes the named program. +one or more slashes, the shell executes the named program in a +separate execution environment. Argument 0 is set to the name given, and the remaining arguments to the command are set to the arguments given, if any. .PP @@ -2734,6 +3193,68 @@ interpreter consist of a single optional argument following the interpreter name on the first line of the program, followed by the name of the program, followed by the command arguments, if any. +.SH COMMAND EXECUTION ENVIRONMENT +The shell has an \fIexecution environment\fP, which consists of the +following: +.sp 1 +.IP \(bu +open files inherited by the shell at invocation, as modified by +redirections supplied to the \fBexec\fP builtin +.IP \(bu +the current working directory as set by \fBcd\fP, \fBpushd\fP, or +\fBpopd\fP, or inherited by the shell at invocation +.IP \(bu +the file creation mode mask as set by \fBumask\fP or inherited from +the shell's parent +.IP \(bu +current traps set by \fBtrap\fP +.IP \(bu +shell parameters that are set by variable assignment or with \fBset\fP +or inherited from the shell's parent in the environment +.IP \(bu +shell functions defined during execution or inherited from the shell's +parent in the environment +.IP \(bu +options enabled at invocation (either by default or with command-line +arguments) or by \fBset\fP +.IP \(bu +options enabled by \fBshopt\fP +.IP \(bu +shell aliases defined with \fBalias\fP +.IP \(bu +various process IDs, including those of background jobs, the value +of \fB$$\fP, and the value of \fB$PPID\fP +.PP +When a simple command other than a builtin or shell function +is to be executed, it +is invoked in a separate execution environment that consists of +the following. Unless otherwise noted, the values are inherited +from the shell. +.sp 1 +.IP \(bu +the shell's open files, plus any modifications and additions specified +by redirections to the command +.IP \(bu +the current working directory +.IP \(bu +the file creation mode mask +.IP \(bu +shell variables marked for export, along with variables exported for +the command, passed in the environment +.IP \(bu +traps caught by the shell are reset to the values the inherited +from the shell's parent, and traps ignored by the shell are ignored +.PP +A command invoked in this separate environment cannot affect the +shell's execution environment. +.PP +Command substitution and asynchronous commands are invoked in a +subshell environment that is a duplicate of the shell environment, +except that traps caught by the shell are reset to the values +that the shell inherited from its parent at invocation. Builtin +commands that are invoked as part of a pipeline are also executed in a +subshell environment. Changes made to the subshell environment +cannot affect the shell's execution environment. .SH ENVIRONMENT When a program is invoked it is given an array of strings called the @@ -2777,7 +3298,7 @@ by that command. .PP If the .B \-k -flag is set (see the +option is set (see the .B set builtin command below), then .I all @@ -2791,7 +3312,7 @@ invokes an external command, the variable is set to the full file name of the command and passed to that command in its environment. .SH "EXIT STATUS" -For the purposes of the shell, a command which exits with a +For the shell's purposes, a command which exits with a zero exit status has succeeded. An exit status of zero indicates success. A non-zero exit status indicates failure. When a command terminates on a fatal signal, \fBbash\fP uses @@ -2801,6 +3322,9 @@ If a command is not found, the child process created to execute it returns a status of 127. If a command is found but is not executable, the return status is 126. .PP +If a command fails because of an error during expansion or redirection, +the exit status is greater than zero. +.PP Shell builtin commands return a status of 0 (\fItrue\fP) if successful, and non-zero (\fIfalse\fP) if an error occurs while they execute. @@ -2811,7 +3335,7 @@ executed, unless a syntax error occurs, in which case it exits with a non-zero value. See also the \fBexit\fP builtin command below. .SH SIGNALS -When \fBbash\fP is interactive, it ignores +When \fBbash\fP is interactive, in the absence of any traps, it ignores .SM .B SIGTERM (so that \fBkill 0\fP does not kill an interactive shell), @@ -2833,16 +3357,16 @@ and .SM .BR SIGTSTP . .PP -Synchronous jobs started by \fBbash\fP have signals set to the -values inherited by the shell from its parent. When job control -is not in effect, background jobs (jobs started with -.BR & ) +Synchronous jobs started by \fBbash\fP have signal handlers +set to the values inherited by the shell from its parent. +When job control is not in effect, asynchronous commands ignore .SM .B SIGINT and .SM -.BR SIGQUIT . +.B SIGQUIT +as well. Commands run as a result of command substitution ignore the keyboard-generated job control signals .SM @@ -2859,18 +3383,44 @@ The shell exits by default upon receipt of a Before exiting, it resends the .SM .B SIGHUP -to all jobs, running or stopped. To prevent the shell from -sending the signal to a particular job, remove it from the +to all jobs, running or stopped. +Stopped jobs are sent +.SM +.B SIGCONT +to ensure that they receive the +.SM +.BR SIGHUP . +To prevent the shell from +sending the signal to a particular job, it should be removed from the jobs table with the .B disown builtin (see .SM .B "SHELL BUILTIN COMMANDS" -below) or use -.B "disown \-h" -to mark it to not receive +below) or marked +to not receive .SM -.BR SIGHUP . +.B SIGHUP +using +.BR "disown \-h" . +.PP +If the +.B huponexit +shell option has been set with +.BR shopt , +.B bash +sends a +.SM +.B SIGHUP +to all jobs when an interactive login shell exits. +.PP +When \fBbash\fP receives a signal for which a trap has been set while +waiting for a command to complete, the trap will not be executed until +the command completes. +When \fBbash\fP is waiting for an asynchronous command via the \fBwait\fP +builtin, the reception of a signal for which a trap has been set will +cause the \fBwait\fP builtin to return immediately with an exit status +greater than 128, immediately after which the trap is executed. .SH "JOB CONTROL" .I Job control refers to the ability to selectively stop (\fIsuspend\fP) @@ -2944,7 +3494,7 @@ Control-Y) causes the process to be stopped when it attempts to read input from the terminal, and control to be returned to .BR bash . -You may then manipulate the state of this job, using the +The user may then manipulate the state of this job, using the .B bg command to continue it in the background, the .B fg @@ -2983,7 +3533,7 @@ and refer to the shell's notion of the .IR "current job" , which is the last job stopped while it was in -the foreground. +the foreground or started in the background. The .I "previous job" may be referenced using @@ -3016,7 +3566,7 @@ any other output. If the option to the .B set builtin command -is set, +is enabled, .B bash reports such changes immediately. .PP @@ -3062,6 +3612,9 @@ the hostname .B \en newline .TP +.B \er +carriage return +.TP .B \es the name of the shell, the basename of .B $0 @@ -3245,13 +3798,13 @@ to a string that is inserted when the key is pressed (a \fImacro\fP). .SS "Readline Key Bindings" .PP The syntax for controlling key bindings in the -.I ~/.inputrc +.I inputrc file is simple. All that is required is the name of the command or the text of a macro and a key sequence to which it should be bound. The name may be specified in one of two ways: as a symbolic key name, possibly with \fIMeta\-\fP or \fIControl\-\fP prefixes, or as a key sequence. -When using the form \fBkeyname\fP:\fIfunction\-name\fP or \fImacro\fP, +When using the form \fBkeyname\fP:\^\fIfunction\-name\fP or \fImacro\fP, .I keyname is the name of a key spelled out in English. For example: .sp @@ -3277,7 +3830,7 @@ expressed on the right hand side (that is, to insert the text .I "> output" into the line). .PP -In the second form, \fB"keyseq"\fP:\fIfunction\-name\fP or \fImacro\fP, +In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP, .B keyseq differs from .B keyname @@ -3305,8 +3858,9 @@ and .I "ESC [ 1 1 ~" is bound to insert the text .BR "Function Key 1" . -The full set of escape sequences is +The full set of GNU Emacs style escape sequences is .RS +.PD 0 .TP .B \eC\- control prefix @@ -3326,11 +3880,53 @@ literal " .B \e' literal ' .RE +.PD .PP -When entering the text of a macro, single or double quotes should -be used to indicate a macro definition. Unquoted text -is assumed to be a function name. Backslash -will quote any character in the macro text, including " and '. +In addition to the GNU Emacs style escape sequences, a second +set of backslash escapes is available: +.RS +.PD 0 +.TP +.B \ea +alert (bell) +.TP +.B \eb +backspace +.TP +.B \ed +delete +.TP +.B \ef +form feed +.TP +.B \en +newline +.TP +.B \er +carriage return +.TP +.B \et +horizontal tab +.TP +.B \ev +vertical tab +.TP +.B \e\fInnn\fP +the character whose ASCII code is the octal value \fInnn\fP +(one to three digits) +.TP +.B \ex\fInnn\fP +the character whose ASCII code is the hexadecimal value \fInnn\fP +(one to three digits) +.RE +.PD +.PP +When entering the text of a macro, single or double quotes must +be used to indicate a macro definition. +Unquoted text is assumed to be a function name. +In the macro body, the backslash escapes described above are expanded. +Backslash will quote any other character in the macro text, +including " and '. .PP .B Bash allows the current readline key bindings to be displayed or modified @@ -3381,6 +3977,10 @@ in emacs mode and to .B # in vi command mode. .TP +.B completion\-ignore\-case (Off) +If set to \fBOn\fP, readline performs filename matching and completion +in a case\-insensitive fashion. +.TP .B completion\-query\-items (100) This determines when the user is queried about viewing the number of possible completions @@ -3433,7 +4033,7 @@ regardless of what the terminal claims it can support. The name is a synonym for this variable. .TP .B keymap (emacs) -Set the current readline keymap. The set of legal keymap names is +Set the current readline keymap. The set of valid keymap names is \fIemacs, emacs\-standard, emacs\-meta, emacs\-ctlx, vi, vi\-command\fP, and .IR vi\-insert . @@ -3457,6 +4057,10 @@ If set to \fBOn\fP, readline will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. .TP +.B print\-completions\-horizontally (Off) +If set to \fBOn\fP, readline will display completions with matches +sorted horizontally in alphabetical order, rather than down the screen. +.TP .B show\-all\-if\-ambiguous (Off) This alters the default behavior of the completion functions. If set to @@ -3474,7 +4078,7 @@ completions. Readline implements a facility similar in spirit to the conditional compilation features of the C preprocessor which allows key bindings and variable settings to be performed as the result -of tests. There are three parser directives used. +of tests. There are four parser directives used. .IP \fB$if\fP The .B $if @@ -3495,7 +4099,7 @@ The \fBterm=\fP form may be used to include terminal-specific key bindings, perhaps to bind the key sequences output by the terminal's function keys. The word on the right side of the .B = -is tested against the full name of the terminal and the portion +is tested against the both full name of the terminal and the portion of the terminal name before the first \fB\-\fP. This allows .I sun to match both @@ -3511,6 +4115,7 @@ file can test for a particular value. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word in Bash: +.sp 1 .RS .nf \fB$if\fP Bash @@ -3521,11 +4126,21 @@ key sequence that quotes the current or previous word in Bash: .RE .RE .IP \fB$endif\fP -This command, as you saw in the previous example, terminates an +This command, as seen in the previous example, terminates an \fB$if\fP command. .IP \fB$else\fP Commands in this branch of the \fB$if\fP directive are executed if the test fails. +.IP \fB$include\fP +This directive takes a single filename as an argument and reads commands +and bindings from that file. For example, the following directive +would read \fI/etc/inputrc\fP: +.sp 1 +.RS +.nf +\fB$include\fP \^ \fI/etc/inputrc\fP +.fi +.RE .SS Searching .PP Readline provides commands for searching through the command history @@ -3561,7 +4176,7 @@ the line, thereby executing the command from the history list. .PP Non-incremental searches read the entire search string before starting to search for matching history lines. The search string may be -typed by the user or part of the contents of the current line. +typed by the user or be part of the contents of the current line. .SS "Readline Command Names" .PP The following is a list of the names of the commands and the default @@ -3667,9 +4282,11 @@ yank\-last\-arg (M\-.\^, M\-_\^) Insert the last argument to the previous command (the last word of the previous history entry). With an argument, behave exactly like \fByank\-nth\-arg\fP. +Successive calls to \fByank\-last\-arg\fP move back through the history +list, inserting the last argument of each line in turn. .TP .B shell\-expand\-line (M\-C\-e) -Expand the line the way the shell does when it reads it. This +Expand the line as the shell does. This performs alias and history expansion as well as all of the shell word expansions. See .SM @@ -3683,6 +4300,13 @@ See .B HISTORY EXPANSION below for a description of history expansion. .TP +.B magic\-space +Perform history expansion on the current line and insert a space. +See +.SM +.B HISTORY EXPANSION +below for a description of history expansion. +.TP .B alias\-expand\-line Perform alias expansion on the current line. See @@ -3708,8 +4332,7 @@ argument is ignored. .B delete\-char (C\-d) Delete the character under the cursor. If point is at the beginning of the line, there are no characters in the line, and -the last character typed was not -.BR C\-d , +the last character typed was not bound to \fBdelete\-char\fP, then return .SM .BR EOF . @@ -3719,7 +4342,7 @@ Delete the character behind the cursor. When given a numeric argument, save the deleted text on the kill ring. .TP .B quoted\-insert (C\-q, C\-v) -Add the next character that you type to the line verbatim. This is +Add the next character typed to the line verbatim. This is how to insert characters like \fBC\-q\fP, for example. .TP .B tab\-insert (C\-v TAB) @@ -3739,15 +4362,15 @@ moving the cursor over that word as well. .TP .B upcase\-word (M\-u) Uppercase the current (or following) word. With a negative argument, -do the previous word, but do not move point. +uppercase the previous word, but do not move point. .TP .B downcase\-word (M\-l) Lowercase the current (or following) word. With a negative argument, -do the previous word, but do not move point. +lowercase the previous word, but do not move point. .TP .B capitalize\-word (M\-c) Capitalize the current (or following) word. With a negative argument, -do the previous word, but do not move point. +capitalize the previous word, but do not move point. .PD .SS Killing and Yanking .PP @@ -3761,7 +4384,8 @@ Kill backward to the beginning of the line. .TP .B unix\-line\-discard (C\-u) Kill backward from point to the beginning of the line. -.\" There is no real difference between this and backward-kill-line +The killed text is saved on the kill-ring. +\" There is no real difference between this and backward-kill-line .TP .B kill\-whole\-line Kill all characters on the current line, no matter where the @@ -3792,9 +4416,11 @@ Copy the text in the region to the kill buffer. .TP .B copy\-backward\-word Copy the word before point to the kill buffer. +The word boundaries are the same as \fBbackward\-word\fP. .TP .B copy\-forward\-word Copy the word following point to the kill buffer. +The word boundaries are the same as \fBforward\-word\fP. .TP .B yank (C\-y) Yank the top of the kill ring into the buffer at the cursor. @@ -3848,6 +4474,19 @@ Insert all completions of the text before point that would have been generated by \fBpossible\-completions\fP. .TP +.B menu\-complete +Similar to \fBcomplete\fP, but replaces the word to be completed +with a single match from the list of possible completions. +Repeated execution of \fBmenu\-complete\fP steps through the list +of possible completions, inserting each match in turn. +At the end of the list of completions, the bell is rung and the +original text is restored. +An argument of \fIn\fP moves \fIn\fP positions forward in the list +of matches; a negative argument may be used to move backward +through the list. +This command is intended to be bound to \fBTAB\fP, but is unbound +by default. +.TP .B complete\-filename (M\-/) Attempt filename completion on the text before point. .TP @@ -3883,7 +4522,7 @@ treating it as a hostname. Attempt completion on the text before point, treating it as a command name. Command completion attempts to match the text against aliases, reserved words, shell -functions, builtins, and finally executable filenames, +functions, shell builtins, and finally executable filenames, in that order. .TP .B possible\-command\-completions (C\-x !) @@ -3945,7 +4584,7 @@ is equivalent to Incremental undo, separately remembered for each line. .TP .B revert\-line (M\-r) -Undo all changes made to this line. This is like typing the +Undo all changes made to this line. This is like executing the .B undo command enough times to return the line to its initial state. .TP @@ -4132,16 +4771,16 @@ fix errors in previous commands quickly. History expansion is performed immediately after a complete line is read, before the shell breaks it into words. It takes place in two parts. -The first is to determine which line from the previous history +The first is to determine which line from the history list to use during substitution. The second is to select portions of that line for inclusion into the current one. -The line selected from the previous history is the \fIevent\fP, +The line selected from the history is the \fIevent\fP, and the portions of that line that are acted upon are \fIwords\fP. Various \fImodifiers\fP are available to manipulate the selected words. The line is broken into words in the same fashion as when reading input, so that several \fImetacharacter\fP-separated words surrounded by -quotes are considered as one word. +quotes are considered one word. History expansions are introduced by the appearance of the history expansion character, which is \^\fB!\fP\^ by default. Only backslash (\^\fB\e\fP\^) and single quotes can quote @@ -4240,7 +4879,7 @@ Word designators are used to select desired words from the event. A .B : separates the event specification from the word designator. -It can be omitted if the word designator begins with a +It may be omitted if the word designator begins with a .BR ^ , .BR $ , .BR * , @@ -4359,82 +4998,6 @@ or `\fB:&\fP'. If used with in place of /, and the final delimiter is optional if it is the last character of the event line. .PD -.SH "ARITHMETIC EVALUATION" -The shell allows arithmetic expressions to be evaluated, under -certain circumstances (see the \fBlet\fP builtin command and -\fBArithmetic Expansion\fP). -Evaluation -is done in long integers with no check for overflow, though division -by 0 is trapped and flagged as an error. The following list of -operators is grouped into levels of equal-precedence operators. -The levels are listed in order of decreasing precedence. -.PP -.PD 0 -.TP -.B \- + -unary minus and plus -.TP -.B ! ~ -logical and bitwise negation -.TP -.B * / % -multiplication, division, remainder -.TP -.B + \- -addition, subtraction -.TP -.B << >> -left and right bitwise shifts -.TP -.B <= >= < > -comparison -.TP -.B == != -equality and inequality -.TP -.B & -bitwise AND -.TP -.B ^ -bitwise exclusive OR -.TP -.B | -bitwise OR -.TP -.B && -logical AND -.TP -.B || -logical OR -.TP -.B \fIexpr\fP?\fIexpr\fP:\fIexpr\fP -conditional evaluation -.TP -.B = *= /= %= += \-= <<= >>= &= ^= |= -assignment -.PD -.PP -Shell variables are allowed as operands; parameter expansion is -performed before the expression is evaluated. -The value of a parameter is coerced to a long integer within -an expression. A shell variable need not have its integer attribute -turned on to be used in an expression. -.PP -Constants with a leading 0 are interpreted as octal numbers. -A leading 0x or 0X denotes hexadecimal. -Otherwise, numbers take the form [\fIbase#\fP]n, where \fIbase\fP -is a decimal number between 2 and 64 representing the arithmetic -base, and \fIn\fP is a number in that base. -If \fIbase\fP is omitted, then base 10 is used. -The digits greater than 9 are represented by the lowercase letters, -the uppercase letters, _, and @, in that order. -If \fIbase\fP is less than or equal to 36, lowercase and uppercase -letters may be used interchangably to represent numbers between 10 -and 35. -.PP -Operators are evaluated in order of precedence. Sub-expressions in -parentheses are evaluated first and may override the precedence -rules above. .SH "SHELL BUILTIN COMMANDS" .\" start of bash_builtins .zZ @@ -4494,7 +5057,7 @@ parameters are unchanged. The return status is the status of the last command exited within the script (0 if no commands are executed), and false if .I filename -is not found. +is not found or cannot be read. .TP \fBalias\fP [\fB\-p\fP] [\fIname\fP[=\fIvalue\fP] ...] \fBAlias\fP with no arguments or with the @@ -4511,7 +5074,8 @@ is supplied, the name and value of the alias is printed. no alias has been defined. .TP \fBbg\fP [\fIjobspec\fP] -Place \fIjobspec\fP in the background, as if it had been started with +Resume the suspended job \fIjobspec\fP in the background, as if it +had been started with .BR & . If \fIjobspec\fP is not present, the shell's notion of the \fIcurrent job\fP is used. @@ -4522,7 +5086,9 @@ job control enabled, if \fIjobspec\fP was not found or started without job control. .TP .PD 0 -\fBbind\fP [\fB\-m\fP \fIkeymap\fP] [\fB\-lpsvPSV\fP] [\fB\-q\fP \fIname\fP] [\fB\-r\fP \fIkeyseq\fP] +\fBbind\fP [\fB\-m\fP \fIkeymap\fP] [\fB\-lpsvPSV\fP] +.TP +\fBbind\fP [\fB\-m\fP \fIkeymap\fP] [\fB\-q\fP \fIfunction\fP] [\fB\-u\fP \fIfunction\fP] [\fB\-r\fP \fIkeyseq\fP] .TP \fBbind\fP [\fB\-m\fP \fIkeymap\fP] \fB\-f\fP \fIfilename\fP .TP @@ -4584,6 +5150,9 @@ Read key bindings from \fIfilename\fP. .B \-q \fIfunction\fP Query about which keys invoke the named \fIfunction\fP. .TP +.B \-u \fIfunction\fP +Unbind all keys bound to the named \fIfunction\fP. +.TP .B \-r \fIkeyseq\fP Remove any current binding for \fIkeyseq\fP. .PD @@ -4613,11 +5182,11 @@ is executed. Execute the specified shell builtin, passing it .IR arguments , and return its exit status. -This is useful when you wish to define a +This is useful when defining a function whose name is the same as a shell builtin, -but need the functionality of the -builtin within the function itself. The \fBcd\fP builtin is -commonly redefined this way. The return status is false if +retaining the functionality of the builtin within the function. +The \fBcd\fP builtin is commonly redefined this way. +The return status is false if .I shell\-builtin is not a shell builtin command. .TP @@ -4689,7 +5258,7 @@ is printed. The option causes a single word indicating the command or file name used to invoke .I command -to be printed; the +to be displayed; the .B \-V option produces a more verbose description. If the @@ -4770,7 +5339,7 @@ is performed when the variable is assigned a value. .TP .B \-r Make \fIname\fPs readonly. These names cannot then be assigned values -by subsequent assignment statements. +by subsequent assignment statements or unset. .TP .B \-x Mark \fIname\fPs for export to subsequent commands via the environment. @@ -4782,13 +5351,13 @@ may not be used to destroy an array variable. When used in a function, makes each \fIname\fP local, as with the .B local -command. The return value is 0 unless an illegal option is encountered, +command. The return value is 0 unless an invalid option is encountered, an attempt is made to define a function using "\-f foo=bar", an attempt is made to assign a value to a readonly variable, an attempt is made to assign a value to an array variable without using the compound assignment syntax (see .B Arrays -above), one of the \fInames\fP is not a legal shell variable name, +above), one of the \fInames\fP is not a valid shell variable name, an attempt is made to turn off readonly status for a readonly variable, an attempt is made to turn off array status for an array variable, or an attempt is made to display a non-existent function with \-f. @@ -4834,16 +5403,17 @@ prefixing each entry with its index in the stack. .PD .PP The return value is 0 unless an -illegal option is supplied or \fIn\fP indexes beyond the end +invalid option is supplied or \fIn\fP indexes beyond the end of the directory stack. .RE .TP -\fBdisown\fP [\fB\-h\fP] [\fIjobspec\fP ...] +\fBdisown\fP [\fB\-ar\fP] [\fB\-h\fP] [\fIjobspec\fP ...] Without options, each .I jobspec is removed from the table of active jobs. -If the \fB\-h\fP option is given, the job is not removed from the table, -but is marked so that +If the \fB\-h\fP option is given, each +.I jobspec +is not removed from the table, but is marked so that .SM .B SIGHUP is not sent to the job if the shell receives a @@ -4851,8 +5421,21 @@ is not sent to the job if the shell receives a .BR SIGHUP . If no .I jobspec -is present, the \fIcurrent job\fP is used. The return value is -0 unless a +is present, and neither the +.B \-a +nor the +.B \-r +option is supplied, the \fIcurrent job\fP is used. +If no +.I jobspec +is supplied, the +.B \-a +option means to remove or mark all jobs; the +.B \-r +option without a +.I jobspec +argument restricts operation to running jobs. +The return value is 0 unless a .I jobspec does not specify a valid job. .TP @@ -4904,15 +5487,21 @@ vertical tab .B \e\e backslash .TP -.B \ennn -the character whose ASCII code is \fInnn\fP (octal) +.B \e\fInnn\fP +the character whose ASCII code is the octal value \fInnn\fP +(one to three digits) +.TP +.B \ex\fInnn\fP +the character whose ASCII code is the hexadecimal value \fInnn\fP +(one to three digits) .PD .RE .TP \fBenable\fP [\fB\-adnps\fP] [\fB\-f\fP \fIfilename\fP] [\fIname\fP ...] -Enable and disable builtin shell commands. This allows -the execution of a disk command which has the same name as a shell -builtin without specifying a full file name. +Enable and disable builtin shell commands. +Disabling a builtin allows a disk command which has the same name +as a shell builtin to be executed with specifying a full pathname, +even though the shell normally searches for builtins before disk commands. If \fB\-n\fP is used, each \fIname\fP is disabled; otherwise, \fInames\fP are enabled. For example, to use the @@ -4958,7 +5547,7 @@ or only null arguments, .B eval returns 0. .TP -\fBexec\fP [\fB\-cl\fP] [\fB\-a\fP \fIname\fP] [\fIcommand\fP] [\fIarguments\fP] +\fBexec\fP [\fB\-cl\fP] [\fB\-a\fP \fIname\fP] [\fIcommand\fP [\fIarguments\fP]] If .I command is specified, it replaces the shell. @@ -4990,7 +5579,8 @@ An interactive shell returns failure if the file cannot be executed. If .I command is not specified, any redirections take effect in the current shell, -and the return status is 0. +and the return status is 0. If there is a redirection error, the +return status is 1. .TP \fBexit\fP [\fIn\fP] Cause the shell to exit @@ -5028,9 +5618,9 @@ The option causes the export property to be removed from the named variables. .B export -returns an exit status of 0 unless an illegal option is +returns an exit status of 0 unless an invalid option is encountered, -one of the \fInames\fP is not a legal shell variable name, or +one of the \fInames\fP is not a valid shell variable name, or .B \-f is supplied with a .I name @@ -5067,13 +5657,13 @@ command for editing and \-16 for listing. .sp 1 The .B \-n -flag suppresses +option suppresses the command numbers when listing. The .B \-r -flag reverses the order of +option reverses the order of the commands. If the .B \-l -flag is given, +option is given, the commands are listed on standard output. Otherwise, the editor given by .I ename @@ -5112,7 +5702,7 @@ and typing .if t \f(CWr\fP re-executes the last command. .sp 1 -If the first form is used, the return value is 0 unless an illegal +If the first form is used, the return value is 0 unless an invalid option is encountered or .I first or @@ -5130,9 +5720,10 @@ does not specify a valid history line, in which case returns failure. .TP \fBfg\fP [\fIjobspec\fP] -Place +Resume .I jobspec -in the foreground, and make it the current job. If +in the foreground, and make it the current job. +If .I jobspec is not present, the shell's notion of the \fIcurrent job\fP is used. The return value is that of the command placed into the foreground, @@ -5178,23 +5769,35 @@ calls to within the same shell invocation if a new set of parameters is to be used. .sp 1 +When the end of options is encountered, \fBgetopts\fP exits with a +return value greater than zero. +\fBOPTIND\fP is set to the index of the first non-option argument, +and \fBname\fP is set to ?. +.sp 1 +.B getopts +normally parses the positional parameters, but if more arguments are +given in +.IR args , +.B getopts +parses those instead. +.sp 1 .B getopts can report errors in two ways. If the first character of .I optstring is a colon, .I silent error reporting is used. In normal operation diagnostic messages -are printed when illegal options or missing option arguments are +are printed when invalid options or missing option arguments are encountered. If the variable .SM .B OPTERR -is set to 0, no error message will be displayed, even if the first +is set to 0, no error messages will be displayed, even if the first character of .I optstring is not a colon. .sp 1 -If an illegal option is seen, +If an invalid option is seen, .B getopts places ? into .I name @@ -5227,12 +5830,6 @@ and is set to the option character found. .sp 1 .B getopts -normally parses the positional parameters, but if more arguments are -given in -.IR args , -.B getopts -parses those instead. -.B getopts returns true if an option, specified or unspecified, is found. It returns false if the end of options is encountered or an error occurs. @@ -5256,7 +5853,7 @@ remembered locations. If no arguments are given, information about remembered commands is printed. The return status is true unless a .I name -is not found or an illegal option is supplied. +is not found or an invalid option is supplied. .TP \fBhelp\fP [\fIpattern\fP] Display helpful information about builtin commands. If @@ -5330,7 +5927,7 @@ history list is removed before the are added. .PD .PP -The return value is 0 unless an illegal option is encountered or an +The return value is 0 unless an invalid option is encountered or an error occurs while reading or writing the history file. .RE .TP @@ -5366,8 +5963,8 @@ Restrict output to stopped jobs. If .I jobspec is given, output is restricted to information about that job. -The return status is 0 unless an illegal option is encountered -or an illegal +The return status is 0 unless an invalid option is encountered +or an invalid .I jobspec is supplied. .PP @@ -5391,7 +5988,7 @@ returning its exit status. .PD 0 \fBkill\fP [\fB\-s\fP \fIsigspec\fP | \fB\-n\fP \fIsignum\fP | \fB\-\fP\fIsigspec\fP] [\fIpid\fP | \fIjobspec\fP] ... .TP -\fBkill\fP \fB\-l\fP [\fIsignum\fP | \fIsigspec\fP] +\fBkill\fP \fB\-l\fP [\fIsigspec\fP | \fIexit_status\fP] .PD Send the signal named by .I sigspec @@ -5419,18 +6016,21 @@ If is not present, then .SM .B SIGTERM -is assumed. An argument of +is assumed. +An argument of .B \-l -lists the signal names. If any arguments are supplied when +lists the signal names. +If any arguments are supplied when .B \-l -is given, the names of the specified signals are listed, and -the return status is 0. The arguments to +is given, the names of the signals corresponding to the arguments are +listed, and the return status is 0. +The \fIexit_status\fP argument to .B \-l -may be either signal names or signal numbers; if signal names -are given, the corresponding signal number is displayed. +is a number specifying either a signal number or the exit status of +a process terminated by a signal. .B kill returns true if at least one signal was successfully sent, or false -if an error occurs or an illegal option is encountered. +if an error occurs or an invalid option is encountered. .TP \fBlet\fP \fIarg\fP [\fIarg\fP ...] Each @@ -5445,9 +6045,9 @@ evaluates to 0, returns 1; 0 is returned otherwise. .TP \fBlocal\fP [\fIname\fP[=\fIvalue\fP] ...] -For each argument, create a local variable named -.IR name , -and assign it +For each argument, a local variable named +.I name +is created, and assigned .IR value . When .B local @@ -5461,7 +6061,7 @@ an error to use .B local when not within a function. The return status is 0 unless .B local -is used outside a function, or an illegal +is used outside a function, or an invalid .I name is supplied. .TP @@ -5502,11 +6102,29 @@ command is successful, a .B dirs is performed as well, and the return status is 0. .B popd -returns false if an illegal option is encountered, the directory stack +returns false if an invalid option is encountered, the directory stack is empty, a non-existent directory stack entry is specified, or the directory change fails. .RE .TP +\fBprintf\fP \fIformat\fP [\fIarguments\fP] +Write the formatted \fIarguments\fP to the standard output under the +control of the \fIformat\fP. +The \fIformat\fP is a character string which contains three types of objects: +plain characters, which are simply copied to standard output, character +escape sequences, which are converted and copied to the standard output, and +format specifications, each of which causes printing of the next successive +\fIargument\fP. +In addition to the standard \fIprintf\fP(1) formats, %b causes +\fBprintf\fP to expand backslash escape sequences in the corresponding +\fIargument\fP, and %q causes \fBprintf\fP to output the corresponding +\fIargument\fP in a format that can be reused as shell input. +.sp 1 +The \fIformat\fP is reused as necessary to consume all of the \fIarguments\fP. +If the \fIformat\fP requires more \fIarguments\fP than are supplied, the +extra format specifications behave as if a zero value or null string, as +appropriate, had been supplied. +.TP .PD 0 \fBpushd\fP [\fB\-n\fP] [\fIdir\fP] .TP @@ -5574,7 +6192,8 @@ If the .B \-L option is used, symbolic links are followed. The return status is 0 unless an error occurs while -reading the name of the current directory. +reading the name of the current directory or an +invalid option is supplied. .TP \fBread\fP [\fB\-er\fP] [\fB\-a\fP \fIaname\fP] [\fB\-p\fP \fIprompt\fP] [\fIname\fP ...] One line is read from the standard input, and the first word @@ -5582,13 +6201,16 @@ is assigned to the first .IR name , the second word to the second .IR name , -and so on, with leftover words assigned to the last +and so on, with leftover words and their intervening separators assigned +to the last .IR name . -Only the characters in +If there are fewer words read from the standard input than names, +the remaining names are assigned empty values. +The characters in .SM .B IFS -are recognized as word delimiters. Options, if supplied, have the -following meanings: +are used to split the line into words. +Options, if supplied, have the following meanings: .RS .PD 0 .TP @@ -5608,6 +6230,7 @@ of the array variable starting at 0. .I aname is unset before any new values are assigned. +Other \fIname\fP arguments are ignored. .TP .B \-e If the standard input @@ -5646,10 +6269,13 @@ If no arguments are given, or if the .B \-p option is supplied, a list of all readonly names is printed. -The return status is 0 unless an illegal option is encountered, +The +.B \-p +option causes output to be displayed in a format thatmay be reused as input. +The return status is 0 unless an invalid option is encountered, one of the .I names -is not a legal shell variable name, or +is not a valid shell variable name, or .B \-f is supplied with a .I name @@ -5674,7 +6300,8 @@ the return status is false. .TP \fBset\fP [\fB\-\-abefhkmnptuvxBCHP\fP] [\fB\-o\fP \fIoption\fP] [\fIarg\fP ...] Without options, the name and value of each shell variable are displayed -in a format that can be re-used as input. +in a format that can be reused as input. +The output is sorted according to the current locale. When options are specified, they set or unset shell attributes. Any arguments remaining after the options are processed are treated as values for the positional parameters and are assigned, in order, to @@ -5720,7 +6347,7 @@ Disable pathname expansion. .TP 8 .B \-h Remember the location of commands as they are looked up for execution. -This is on by default. +This is enabled by default. .TP 8 .B \-k All arguments in the form of assignment statements @@ -5728,7 +6355,7 @@ are placed in the environment for a command, not just those that precede the command name. .TP 8 .B \-m -Monitor mode. Job control is enabled. This flag is on +Monitor mode. Job control is enabled. This option is on by default for interactive shells on systems that support it (see .SM @@ -5860,10 +6487,12 @@ Turn on .I privileged mode. In this mode, the .B $ENV -file is not processed, and shell functions -are not inherited from the environment. This is enabled automatically -on startup if the effective user (group) id is not equal to the real -user (group) id. Turning this option off causes the effective user +file is not processed, shell functions are not inherited from the +environment, and the variable +The \fBSHELLOPTS\fP variable, if it appears in the environment, is ignored. +This is enabled automatically on startup if the effective user (group) +id is not equal to the real user (group) id. +Turning this option off causes the effective user and group ids to be set to the real user and group ids. .TP 8 .B \-t @@ -5907,7 +6536,7 @@ instead of .B \-H Enable .B ! -style history substitution. This flag is on by +style history substitution. This option is on by default when the shell is interactive. .TP 8 .B \-P @@ -5921,7 +6550,7 @@ follows the logical chain of directories when performing commands which change the current directory. .TP 8 .B \-\- -If no arguments follow this flag, then the positional parameters are +If no arguments follow this option, then the positional parameters are unset. Otherwise, the positional parameters are set to the \fIarg\fPs, even if some of them begin with a .BR \- . @@ -5937,16 +6566,13 @@ If there are no \fIarg\fPs, the positional parameters remain unchanged. .PD .PP -The flags are off by default -unless otherwise noted. -Using + rather than \- causes these flags -to be turned off. The -flags can also be specified as options to an -invocation of the shell. The current -set of flags may be found in +The options are off by default unless otherwise noted. +Using + rather than \- causes these options to be turned off. +The options can also be specified as arguments to an invocation of +the shell. +The current set of options may be found in .BR $\- . -The return status is always true -unless an illegal option is encountered. +The return status is always true unless an invalid option is encountered. .RE .TP \fBshift\fP [\fIn\fP] @@ -5977,8 +6603,10 @@ Toggle the values of variables controlling optional shell behavior. With no options, or with the .B \-p option, a list of all settable options is displayed, with -an indication of whether or not each is set. Other options have -the following meanings: +an indication of whether or not each is set. +The \fB\-p\fP option causes output to be displayed in a form that +may be reused as input. +Other options have the following meanings: .RS .PD 0 .TP @@ -6015,7 +6643,7 @@ by default. .PP The return status when listing options is zero if all \fIoptnames\fP are enabled, non-zero otherwise. When setting or unsetting options, -the return status is zero unless an \fIoptname\fP is not a legal shell +the return status is zero unless an \fIoptname\fP is not a valid shell option. .PP The list of \fBshopt\fP options is: @@ -6081,6 +6709,10 @@ If set, aliases are expanded as described above under .BR ALIASES . This option is enabled by default for interactive shells. .TP 8 +.B extglob +If set, the extended pattern matching features described above under +\fBPathname Expansion\fP are enabled. +.TP 8 .B histappend If set, the history list is appended to the file named by the value of the @@ -6103,8 +6735,8 @@ the \fBreadline\fP editing buffer, allowing further modification. .B hostcomplete If set, and .B readline -is being used, bash will attempt to perform hostname completion when a -word beginning with \fB@\fP is being completed (see +is being used, \fBbash\fP will attempt to perform hostname completion when a +word containing a \fB@\fP is being completed (see .B Completing under .SM @@ -6112,6 +6744,12 @@ under above). This is enabled by default. .TP 8 +.B huponexit +If set, \fBbash\fP will send +.SM +.B SIGHUP +to all jobs when an interactive login shell exits. +.TP 8 .B interactive_comments If set, allow a word beginning with .B # @@ -6132,6 +6770,14 @@ If set, and a file that \fBbash\fP is checking for mail has been accessed since the last time it was checked, the message ``The mail in \fImailfile\fP has been read'' is displayed. .TP 8 +.B nocaseglob +If set, +.B bash +matches filenames in a case\-insensitive fashion when performing pathname +expansion (see +.B Pathname Expansion +above). +.TP 8 .B nullglob If set, .B bash @@ -6160,7 +6806,7 @@ If set, the .SM .B PATH to find the directory containing the file supplied as an argument. -This is enabled by default. +This option is enabled by default. .RE .TP \fBsuspend\fP [\fB\-f\fP] @@ -6182,154 +6828,91 @@ is not supplied, or if job control is not enabled. Return a status of 0 or 1 depending on the evaluation of the conditional expression .IR expr . -Expressions may be unary or binary. Unary -expressions are often used to examine the status of a file. There -are string operators and numeric comparison operators as well. Each -operator and operand must be a separate argument. If \fIfile\fP -is of the form /dev/fd/\fIn\fP, then file descriptor \fIn\fP is -checked. Expressions are composed of the following primaries: +Each operator and operand must be a separate argument. +Expressions are composed of the primaries described above under +.SM +.BR "CONDITIONAL EXPRESSIONS" . +.if t .sp 0.5 +.if n .sp 1 +Expressions may be combined using the following operators, listed +in decreasing order of precedence. .RS .PD 0 .TP -.B \-b \fIfile\fP -True if \fIfile\fP exists and is a block special file. -.TP -.B \-c \fIfile\fP -True if \fIfile\fP exists and is a character special file. -.TP -.B \-d \fIfile\fP -True if \fIfile\fP exists and is a directory. -.TP -.B \-e \fIfile\fP -True if \fIfile\fP exists. -.TP -.B \-f \fIfile\fP -True if \fIfile\fP exists and is a regular file. -.TP -.B \-g \fIfile\fP -True if \fIfile\fP exists and is set-group-id. -.TP -.B \-k \fIfile\fP -True if \fIfile\fP has its ``sticky'' bit set. -.TP -.B \-L \fIfile\fP -True if \fIfile\fP exists and is a symbolic link. -.TP -.B \-p \fIfile\fP -True if \fIfile\fP exists and is a named pipe. -.TP -.B \-r \fIfile\fP -True if \fIfile\fP exists and is readable. -.TP -.B \-s \fIfile\fP -True if \fIfile\fP exists and has a size greater than zero. -.TP -.B \-S \fIfile\fP -True if \fIfile\fP exists and is a socket. -.TP -.B \-t \fIfd\fP -True if -.I fd -is opened on a terminal. -.TP -.B \-u \fIfile\fP -True if \fIfile\fP exists and its set-user-id bit is set. -.TP -.B \-w \fIfile\fP -True if \fIfile\fP exists and is writable. -.TP -.B \-x \fIfile\fP -True if \fIfile\fP exists and is executable. -.TP -.B \-O \fIfile\fP -True if \fIfile\fP exists and is owned by the effective user id. -.TP -.B \-G \fIfile\fP -True if \fIfile\fP exists and is owned by the effective group id. -.TP -\fIfile1\fP \-\fBnt\fP \fIfile2\fP -True if \fIfile1\fP is newer (according to -modification date) than \fIfile2\fP. -.TP -\fIfile1\fP \-\fBot\fP \fIfile2\fP -True if \fIfile1\fP is older than \fIfile2\fP. -.TP -\fIfile1\fP \fB\-ef\fP \fIfile2\fP -True if \fIfile1\fP and \fIfile2\fP have the same device and -inode numbers. -.TP -.B \-o \fIoptname\fP -True if shell option -.I optname -is enabled. -See the list of options under the description of the -.B \-o -option to the -.B set -builtin above. -.TP -.B \-z \fIstring\fP -True if the length of \fIstring\fP is zero. -.TP -.B \-n \fIstring\fP -.TP -\fIstring\fP -True if the length of -.I string -is non-zero. -.TP -\fIstring1\fP \fB=\fP \fIstring2\fP -True if the strings are equal. \fB==\fP may be used in place of -\fB=\fP. -.TP -\fIstring1\fP \fB!=\fP \fIstring2\fP -True if the strings are not equal. -.TP -\fIstring1\fP \fB<\fP \fIstring2\fP -True if \fIstring1\fP sorts before \fIstring2\fP lexicographically. -.TP -\fIstring1\fP \fB>\fP \fIstring2\fP -True if \fIstring1\fP sorts after \fIstring2\fP lexicographically. -.TP .B ! \fIexpr\fP True if .I expr is false. .TP +.B ( \fIexpr\fP ) +Returns the value of \fIexpr\fP. +This may be used to override the normal precedence of operators. +.TP \fIexpr1\fP \-\fBa\fP \fIexpr2\fP True if both .I expr1 -AND +and .I expr2 are true. .TP \fIexpr1\fP \-\fBo\fP \fIexpr2\fP True if either .I expr1 -OR +or .I expr2 is true. +.PD +.PP +\fBtest\fP and \fB[\fP evaluate conditional +expressions using a set of rules based on the number of arguments. +.if t .sp 0.5 +.if n .sp 1 +.PD 0 .TP -.I \fIarg1\fP \fBOP\fP \fIarg2\fP +0 arguments +The expression is false. +.TP +1 argument +The expression is true if and only if the argument is not null. +.TP +2 arguments +If the first argument is \fB!\fP, the expression is true if and +only if the second argument is null. +If the first argument is one of the unary conditional operators listed above +under .SM -.B OP -is one of -.BR \-eq , -.BR \-ne , -.BR \-lt , -.BR \-le , -.BR \-gt , -or -.BR \-ge . -These arithmetic binary operators return true if \fIarg1\fP -is equal to, not equal to, less than, less than or equal to, -greater than, or greater than or equal to \fIarg2\fP, respectively. -.I Arg1 -and -.I arg2 -may be positive or negative integers. -.PD +.BR "CONDITIONAL EXPRESSIONS" , +the expression is true if the unary test is true. +If the first argument is not a valid unary conditional operator, the expression +is false. +.TP +3 arguments +If the second argument is one of the binary conditional operators listed above +under +.SM +.BR "CONDITIONAL EXPRESSIONS" , +the result of the expression is the result of the binary test using +the first and third arguments as operands. +If the first argument is \fB!\fP, the value is the negation of +the two-argument test using the second and third arguments. +If the first argument is exactly \fB(\fP and the third argument is +exactly \fB)\fP, the result is the one-argument test of the second +argument. +Otherwise, the expression is false. +The \fB\-a\fP and \fB\-o\fP operators are considered binary operators +in this case. +.TP +4 arguments +If the first argument is \fB!\fP, the result is the negation of +the three-argument expression composed of the remaining arguments. +Otherwise, the expression is parsed and evaluated according to +precedence using the rules listed above. +.TP +5 or more arguments +The expression is parsed and evaluated according to precedence +using the rules listed above. .RE +.PD .TP .B times Print the accumulated user and system times for the shell and @@ -6401,14 +6984,14 @@ is invalid; otherwise .B trap returns true. .TP -\fBtype\fP [\fB\-all\fP] [\fB\-type\fP | \fB\-path\fP] \fIname\fP [\fIname\fP ...] +\fBtype\fP [\fB\-atp\fP] \fIname\fP [\fIname\fP ...] With no options, indicate how each .I name would be interpreted if used as a command name. If the -.B \-type -flag is used, +.B \-t +option is used, .B type prints a string which is one of .IR alias , @@ -6426,49 +7009,36 @@ If the is not found, then nothing is printed, and an exit status of false is returned. If the -.B \-path -flag is used, +.B \-p +option is used, .B type either returns the name of the disk file that would be executed if .I name were specified as a command name, -or nothing if -.B \-type +or nothing if \f(CWtype -t name\fP would not return .IR file . If a command is hashed, -.B \-path +.B \-p prints the hashed value, not necessarily the file that appears first in .SM .BR PATH . If the -.B \-all -flag is used, +.B \-a +option is used, .B type prints all of the places that contain an executable named .IR name . This includes aliases and functions, if and only if the -.B \-path -flag is not also used. +.B \-p +option is not also used. The table of hashed commands is not consulted when using -.BR \-all . -.B type -accepts -.BR \-a , -.BR \-t , -and -.B \-p -in place of -.BR \-all , -.BR \-type , -and -.BR \-path , -respectively. +.BR \-a . .B type returns true if any of the arguments are found, false if none are found. @@ -6550,12 +7120,12 @@ and and .BR \-u , which are unscaled values. The return status is 0 -unless an illegal option is encountered, a non-numeric argument +unless an invalid option is encountered, a non-numeric argument other than \fBunlimited\fP is supplied as \fIlimit\fP, or an error occurs while setting a new limit. .RE .TP -\fBumask\fP [\fB\-S\fP] [\fImode\fP] +\fBumask\fP [\fB\-p\fP] [\fB\-S\fP] [\fImode\fP] The user file-creation mask is set to .IR mode . If @@ -6575,6 +7145,11 @@ The .B \-S option causes the mask to be printed in symbolic form; the default output is an octal number. +If the +.B \-p +option is supplied, and +.I mode +is omitted, the output is in a form that may be reused as input. The return status is 0 if the mode was successfully changed or if no \fImode\fP argument was supplied, and false otherwise. .TP @@ -6652,7 +7227,7 @@ A restricted shell is used to set up an environment more controlled than the standard shell. It behaves identically to .B bash -with the exception that the following are disallowed: +with the exception that the following are disallowed or not performed: .IP \(bu changing directories with \fBcd\fP .IP \(bu @@ -6672,6 +7247,8 @@ builtin command .IP \(bu importing function definitions from the shell environment at startup .IP \(bu +parsing the value of \fBSHELLOPTS\fP from the shell environment at startup +.IP \(bu redirecting output using the >, >|, <>, >&, &>, and >> redirection operators .IP \(bu using the @@ -6693,7 +7270,7 @@ option to the builtin command .IP \(bu turning off restricted mode with -.BR "set +r" . +\fBset +r\fP or \fBset +o restricted\fP. .PP These restrictions are enforced after any startup files are read. .PP @@ -6761,7 +7338,7 @@ Once you have determined that a bug actually exists, use the command to submit a bug report. If you have a fix, you are encouraged to mail that as well! Suggestions and `philosophical' bug reports may be mailed -to \fPbug-bash\fP@\fIprep.ai.MIT.Edu\fP or posted to the Usenet +to \fIbug-bash@gnu.org\fP or posted to the Usenet newsgroup .BR gnu.bash.bug . .PP diff --git a/doc/bashref.info b/doc/bashref.info index 4707a20..2ba11f0 100644 --- a/doc/bashref.info +++ b/doc/bashref.info @@ -1,19 +1,19 @@ This is Info file bashref.info, produced by Makeinfo version 1.67 from -the input file /usr/homes/chet/src/bash/bash-2.01.1/doc/bashref.texi. +the input file /usr/homes/chet/src/bash/src/doc/bashref.texi. INFO-DIR-SECTION Utilities START-INFO-DIR-ENTRY -* Bash: (bash). GNU Bourne-Again SHell +* Bash: (bash). The GNU Bourne-Again SHell. END-INFO-DIR-ENTRY This text is a brief description of the features that are present in the Bash shell. -This is Edition 2.0, last updated 19 May 1997, +This is Edition 2.2, last updated 1 April 1998, of `The GNU Bash Reference Manual', -for `Bash', Version 2.01. +for `Bash', Version 2.02. -Copyright (C) 1991, 1993, 1996 Free Software Foundation, Inc. +Copyright (C) 1991, 1993, 1996, 1997 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -27,7 +27,7 @@ notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved -by the Foundation. +by the Free Software Foundation. File: bashref.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) @@ -38,8 +38,8 @@ Bash Features This text is a brief description of the features that are present in the Bash shell. - This is Edition 2.0, last updated 19 May 1997, of `The GNU Bash -Reference Manual', for `Bash', Version 2.01. + This is Edition 2.2, last updated 1 April 1998, of `The GNU Bash +Reference Manual', for `Bash', Version 2.02. Copyright (C) 1991, 1993, 1996 Free Software Foundation, Inc. @@ -66,12 +66,6 @@ on shell behavior. * Bourne Shell Features:: Features similar to those found in the Bourne shell. -* Csh Features:: Features originally found in the - Berkeley C-Shell. - -* Korn Shell Features:: Features originally found in the Korn - Shell. - * Bash Features:: Features found only in Bash. * Job Control:: A chapter describing what job control is @@ -124,16 +118,16 @@ ancestor of the current Unix shell `/bin/sh', which appeared in the Seventh Edition Bell Labs Research version of Unix. Bash is an `sh'-compatible shell that incorporates useful features -from the Korn shell `ksh' and the C shell `csh'. It is ultimately -intended to be a conformant implementation of the IEEE POSIX Shell and -Tools specification (IEEE Working Group 1003.2). It offers functional +from the Korn shell `ksh' and the C shell `csh'. It is intended to be +a conformant implementation of the IEEE POSIX Shell and Tools +specification (IEEE Working Group 1003.2). It offers functional improvements over `sh' for both interactive and programming use. While the GNU operating system will include a version of `csh', Bash will be the default shell. Like other GNU software, Bash is quite portable. It currently runs on nearly every version of Unix and a few -other operating systems - independently-supported ports exist for OS/2 -and Windows NT. +other operating systems - independently-supported ports exist for +MS-DOS, OS/2, Windows 95, and Windows NT. File: bashref.info, Node: What is a shell?, Prev: What is Bash?, Up: Introduction @@ -144,20 +138,22 @@ What is a shell? At its base, a shell is simply a macro processor that executes commands. A Unix shell is both a command interpreter, which provides the user interface to the rich set of Unix utilities, and a programming -language, allowing these utilitites to be combined. The shell reads -commands either from a terminal or a file. Files containing commands -can be created, and become commands themselves. These new commands -have the same status as system commands in directories like `/bin', -allowing users or groups to establish custom environments. +language, allowing these utilitites to be combined. Files containing +commands can be created, and become commands themselves. These new +commands have the same status as system commands in directories like +`/bin', allowing users or groups to establish custom environments. A shell allows execution of Unix commands, both synchronously and -asynchronously. The "redirection" constructs permit fine-grained -control of the input and output of those commands, and the shell allows -control over the contents of their environment. Unix shells also -provide a small set of built-in commands ("builtins") implementing -functionality impossible (e.g., `cd', `break', `continue', and `exec'), -or inconvenient (`history', `getopts', `kill', or `pwd', for example) -to obtain via separate utilities. Shells may be used interactively or +asynchronously. The shell waits for synchronous commands to complete +before accepting more input; asynchronous commands continue to execute +in parallel with the shell while it reads and executes additional +commands. The "redirection" constructs permit fine-grained control of +the input and output of those commands, and the shell allows control +over the contents of their environment. Unix shells also provide a +small set of built-in commands ("builtins") implementing functionality +impossible (e.g., `cd', `break', `continue', and `exec'), or +inconvenient (`history', `getopts', `kill', or `pwd', for example) to +obtain via separate utilities. Shells may be used interactively or non-interactively: they accept input typed from the keyboard or from a file. All of the shell builtins are described in subsequent sections. @@ -271,7 +267,7 @@ of the Bourne shell builtin commands are available in Bash, and the rules for evaluation and quoting are taken from the POSIX 1003.2 specification for the `standard' Unix shell. - This chapter briefly summarizes the shell's "building blocks": + This chapter briefly summarizes the shell's `building blocks': commands, control structures, shell functions, shell parameters, shell expansions, redirections, which are a way to direct input and output from and to named files, and how the shell executes commands. @@ -279,13 +275,7 @@ from and to named files, and how the shell executes commands. * Menu: * Shell Syntax:: What your input means to the shell. -* Simple Commands:: The most common type of command. -* Pipelines:: Connecting the input and output of several - commands. -* Lists:: How to execute commands sequentially. -* Looping Constructs:: Shell commands for iterative action. -* Conditional Constructs:: Shell commands for conditional execution. -* Command Grouping:: Ways to group commands. +* Shell Commands:: The types of commands you can use. * Shell Functions:: Grouping commands by name. * Shell Parameters:: Special shell variables. * Shell Expansions:: How Bash expands variables and the various @@ -295,7 +285,7 @@ from and to named files, and how the shell executes commands. * Shell Scripts:: Executing files of shell commands. -File: bashref.info, Node: Shell Syntax, Next: Simple Commands, Up: Basic Shell Features +File: bashref.info, Node: Shell Syntax, Next: Shell Commands, Up: Basic Shell Features Shell Syntax ============ @@ -322,11 +312,12 @@ reads and executes a command. Basically, the shell does the following: Invoking Bash::.), or from the user's terminal. 2. Breaks the input into words and operators, obeying the quoting - rules described in *Note Quoting::. Tokens are separated by + rules described in *Note Quoting::. These tokens are separated by `metacharacters'. Alias expansion is performed by this step (*note Aliases::.). - 3. Parses the tokens into simple and compound commands. + 3. Parses the tokens into simple and compound commands (*note Shell + Commands::.). 4. Performs the various shell expansions (*note Shell Expansions::.), breaking the expanded tokens into lists of filenames (*note @@ -339,7 +330,7 @@ reads and executes a command. Basically, the shell does the following: 6. Executes the command (*note Executing Commands::.). 7. Optionally waits for the command to complete and collects its exit - status. + status (*note Exit Status::.). @@ -365,10 +356,10 @@ or words to the shell. Quoting can be used to disable special treatment for special characters, to prevent reserved words from being recognized as such, and to prevent parameter expansion. - Each of the shell `metacharacters' (*note Definitions::.) has -special meaning to the shell and must be quoted if they are to -represent themselves. There are three quoting mechanisms: the ESCAPE -CHARACTER, single quotes, and double quotes. + Each of the shell metacharacters (*note Definitions::.) has special +meaning to the shell and must be quoted if it is to represent itself. +There are three quoting mechanisms: the ESCAPE CHARACTER, single +quotes, and double quotes. File: bashref.info, Node: Escape Character, Next: Single Quotes, Up: Quoting @@ -379,8 +370,9 @@ Escape Character A non-quoted backslash `\' is the Bash escape character. It preserves the literal value of the next character that follows, with the exception of `newline'. If a `\newline' pair appears, and the -backslash is not quoted, the `\newline' is treated as a line -continuation (that is, it is effectively ignored). +backslash itself is not quoted, the `\newline' is treated as a line +continuation (that is, it is removed from the input stream and +effectively ignored). File: bashref.info, Node: Single Quotes, Next: Double Quotes, Prev: Escape Character, Up: Quoting @@ -401,10 +393,13 @@ Double Quotes Enclosing characters in double quotes preserves the literal value of all characters within the quotes, with the exception of `$', ``', and `\'. The characters `$' and ``' retain their special meaning within -double quotes. The backslash retains its special meaning only when -followed by one of the following characters: `$', ``', `"', `\', or -`newline'. A double quote may be quoted within double quotes by -preceding it with a backslash. +double quotes (*note Shell Expansions::.). The backslash retains its +special meaning only when followed by one of the following characters: +`$', ``', `"', `\', or `newline'. Within double quotes, backslashes +that are followed by one of these characters are removed. Backslashes +preceding characters without a special meaning are left unmodified. A +double quote may be quoted within double quotes by preceding it with a +backslash. The special parameters `*' and `@' have special meaning when in double quotes (*note Shell Parameter Expansion::.). @@ -448,7 +443,12 @@ present, are decoded as follows: backslash `\NNN' - the character whose `ASCII' code is NNN in octal + the character whose `ASCII' code is the octal value NNN (one to + three digits) + +`\xNNN' + the character whose `ASCII' code is the hexadecimal value NNN (one + to three digits) The result is single-quoted, as if the dollar sign had not been present. @@ -475,28 +475,45 @@ Bash Builtins::.), a word beginning with `#' causes that word and all remaining characters on that line to be ignored. An interactive shell without the `interactive_comments' option enabled does not allow comments. The `interactive_comments' option is on by default in -interactive shells. +interactive shells. *Note Is This Shell Interactive?::, for a +description of what makes a shell interactive. -File: bashref.info, Node: Simple Commands, Next: Pipelines, Prev: Shell Syntax, Up: Basic Shell Features +File: bashref.info, Node: Shell Commands, Next: Shell Functions, Prev: Shell Syntax, Up: Basic Shell Features + +Shell Commands +============== + +* Menu: + +* Simple Commands:: The most common type of command. +* Pipelines:: Connecting the input and output of several + commands. +* Lists:: How to execute commands sequentially. +* Looping Constructs:: Shell commands for iterative action. +* Conditional Constructs:: Shell commands for conditional execution. +* Command Grouping:: Ways to group commands. + + +File: bashref.info, Node: Simple Commands, Next: Pipelines, Up: Shell Commands Simple Commands -=============== +--------------- - A simple command is the kind of command you'll encounter most often. + A simple command is the kind of command encountered most often. It's just a sequence of words separated by `blank's, terminated by one -of the shell control operators (*note Definitions::.). The first word -generally specifies a command to be executed. +of the shell's control operators (*note Definitions::.). The first +word generally specifies a command to be executed. The return status (*note Exit Status::.) of a simple command is its exit status as provided by the POSIX.1 `waitpid' function, or 128+N if the command was terminated by signal N. -File: bashref.info, Node: Pipelines, Next: Lists, Prev: Simple Commands, Up: Basic Shell Features +File: bashref.info, Node: Pipelines, Next: Lists, Prev: Simple Commands, Up: Shell Commands Pipelines -========= +--------- A `pipeline' is a sequence of simple commands separated by `|'. @@ -508,22 +525,30 @@ the next command. That is, each command reads the previous command's output. The reserved word `time' causes timing statistics to be printed for -the pipeline once it finishes. The `-p' option changes the output -format to that specified by POSIX. The `TIMEFORMAT' variable may be -set to a format string that specifies how the timing information should -be displayed. *Note Bash Variables::, for a description of the -available formats. +the pipeline once it finishes. The statistics currently consist of +elapsed (wall-clock) time and user and system time consumed by the +command's execution. The `-p' option changes the output format to that +specified by POSIX. The `TIMEFORMAT' variable may be set to a format +string that specifies how the timing information should be displayed. +*Note Bash Variables::, for a description of the available formats. +The use of `time' as a reserved word permits the timing of shell +builtins, shell functions, and pipelines. An external `time' command +cannot time these easily. + + If the pipeline is not executed asynchronously (*note Lists::.), the +shell waits for all commands in the pipeline to complete. - Each command in a pipeline is executed in its own subshell. The exit -status of a pipeline is the exit status of the last command in the -pipeline. If the reserved word `!' precedes the pipeline, the exit -status is the logical NOT of the exit status of the last command. + Each command in a pipeline is executed in its own subshell (*note +Command Execution Environment::.). The exit status of a pipeline is +the exit status of the last command in the pipeline. If the reserved +word `!' precedes the pipeline, the exit status is the logical negation +of the exit status of the last command. -File: bashref.info, Node: Lists, Next: Looping Constructs, Prev: Pipelines, Up: Basic Shell Features +File: bashref.info, Node: Lists, Next: Looping Constructs, Prev: Pipelines, Up: Shell Commands Lists of Commands -================= +----------------- A `list' is a sequence of one or more pipelines separated by one of the operators `;', `&', `&&', or `||', and optionally terminated by one @@ -533,11 +558,15 @@ of `;', `&', or a `newline'. followed by `;' and `&', which have equal precedence. If a command is terminated by the control operator `&', the shell -executes the command in the BACKGROUND in a subshell. The shell does -not wait for the command to finish, and the return status is 0 (true). -Commands separated by a `;' are executed sequentially; the shell waits -for each command to terminate in turn. The return status is the exit -status of the last command executed. +executes the command asynchronously in a subshell. This is known as +executing the command in the BACKGROUND. The shell does not wait for +the command to finish, and the return status is 0 (true). The standard +input for asynchronous commands, in the absence of any explicit +redirections, is redirected from `/dev/null'. + + Commands separated by a `;' are executed sequentially; the shell +waits for each command to terminate in turn. The return status is the +exit status of the last command executed. The control operators `&&' and `||' denote AND lists and OR lists, respectively. An AND list has the form @@ -549,52 +578,59 @@ zero. An OR list has the form COMMAND || COMMAND2 -COMMAND2 is executed if and only if COMMAND returns a non-zero exit +COMMAND2 is executed if, and only if, COMMAND returns a non-zero exit status. The return status of AND and OR lists is the exit status of the last command executed in the list. -File: bashref.info, Node: Looping Constructs, Next: Conditional Constructs, Prev: Lists, Up: Basic Shell Features +File: bashref.info, Node: Looping Constructs, Next: Conditional Constructs, Prev: Lists, Up: Shell Commands Looping Constructs -================== - - Note that wherever you see a `;' in the description of a command's -syntax, it may be replaced indiscriminately with one or more newlines. +------------------ Bash supports the following looping constructs. + Note that wherever you see a `;' in the description of a command's +syntax, it may be replaced with one or more newlines. + `until' The syntax of the `until' command is: until TEST-COMMANDS; do CONSEQUENT-COMMANDS; done - Execute CONSEQUENT-COMMANDS as long as the final command in - TEST-COMMANDS has an exit status which is not zero. + Execute CONSEQUENT-COMMANDS as long as TEST-COMMANDS has an exit + status which is not zero. The return status is the exit status of + the last command executed in CONSEQUENT-COMMANDS, or zero if none + was executed. `while' The syntax of the `while' command is: while TEST-COMMANDS; do CONSEQUENT-COMMANDS; done - Execute CONSEQUENT-COMMANDS as long as the final command in - TEST-COMMANDS has an exit status of zero. + Execute CONSEQUENT-COMMANDS as long as TEST-COMMANDS has an exit + status of zero. The return status is the exit status of the last + command executed in CONSEQUENT-COMMANDS, or zero if none was + executed. `for' The syntax of the `for' command is: for NAME [in WORDS ...]; do COMMANDS; done - Execute COMMANDS for each member in WORDS, with NAME bound to the - current member. If `in WORDS' is not present, `in "$@"' is - assumed. + Expand WORDS, and execute COMMANDS once for each member in the + resultant list, with NAME bound to the current member. If `in + WORDS' is not present, `in "$@"' is assumed. The return status is + the exit status of the last command that executes. If there are + no items in the expansion of WORDS, no commands are executed, and + the return status is zero. The `break' and `continue' builtins (*note Bourne Shell Builtins::.) may be used to control loop execution. -File: bashref.info, Node: Conditional Constructs, Next: Command Grouping, Prev: Looping Constructs, Up: Basic Shell Features +File: bashref.info, Node: Conditional Constructs, Next: Command Grouping, Prev: Looping Constructs, Up: Shell Commands Conditional Constructs -====================== +---------------------- `if' The syntax of the `if' command is: @@ -606,21 +642,36 @@ Conditional Constructs [else ALTERNATE-CONSEQUENTS;] fi - Execute CONSEQUENT-COMMANDS only if the final command in - TEST-COMMANDS has an exit status of zero. Otherwise, each `elif' - list is executed in turn, and if its exit status is zero, the - corresponding MORE-CONSEQUENTS is executed and the command - completes. If `else ALTERNATE-CONSEQUENTS' is present, and the - final command in the final `if' or `elif' clause has a non-zero - exit status, then execute ALTERNATE-CONSEQUENTS. + The TEST-COMMANDS list is executed, and if its return status is + zero, the CONSEQUENT-COMMANDS list is executed. If TEST-COMMANDS + returns a non-zero status, each `elif' list is executed in turn, + and if its exit status is zero, the corresponding MORE-CONSEQUENTS + is executed and the command completes. If `else + ALTERNATE-CONSEQUENTS' is present, and the final command in the + final `if' or `elif' clause has a non-zero exit status, then + ALTERNATE-CONSEQUENTS is executed. The return status is the exit + status of the last command executed, or zero if no condition + tested true. `case' The syntax of the `case' command is: - `case WORD in [ ( PATTERN [| PATTERN]...) COMMANDS ;;]... esac' + `case WORD in [ [(] PATTERN [| PATTERN]...) COMMAND-LIST ;;]... esac' - Selectively execute COMMANDS based upon WORD matching PATTERN. - The `|' is used to separate multiple patterns. + `case' will selectively execute the COMMAND-LIST corresponding to + the first PATTERN that matches WORD. The `|' is used to separate + multiple patterns, and the `)' operator terminates a pattern list. + A list of patterns and an associated command-list is known as a + CLAUSE. Each clause must be terminated with `;;'. The WORD + undergoes tilde expansion, parameter expansion, command + substitution, arithmetic expansion, and quote removal before + matching is attempted. Each PATTERN undergoes tilde expansion, + parameter expansion, command substitution, and arithmetic + expansion. + + There may be an arbitrary number of `case' clauses, each terminated + by a `;;'. The first pattern that matches determines the + command-list that is executed. Here is an example using `case' in a script that could be used to describe one interesting feature of an animal: @@ -635,24 +686,96 @@ Conditional Constructs esac echo " legs." + The return status is zero if no PATTERN is matched. Otherwise, the + return status is the exit status of the COMMAND-LIST executed. + +`select' + The `select' construct allows the easy generation of menus. It + has almost the same syntax as the `for' command: + + select NAME [in WORDS ...]; do COMMANDS; done + + The list of words following `in' is expanded, generating a list of + items. The set of expanded words is printed on the standard error + output stream, each preceded by a number. If the `in WORDS' is + omitted, the positional parameters are printed, as if `in "$@"' + had been specifed. The `PS3' prompt is then displayed and a line + is read from the standard input. If the line consists of a number + corresponding to one of the displayed words, then the value of + NAME is set to that word. If the line is empty, the words and + prompt are displayed again. If `EOF' is read, the `select' + command completes. Any other value read causes NAME to be set to + null. The line read is saved in the variable `REPLY'. + + The COMMANDS are executed after each selection until a `break' or + `return' command is executed, at which point the `select' command + completes. + + Here is an example that allows the user to pick a filename from the + current directory, and displays the name and index of the file + selected. + + select fname in *; + do + echo you picked $fname \($REPLY\) + break; + done + `((...))' (( EXPRESSION )) - The EXPRESSION is evaluated according to the rules described below - (*note Arithmetic Evaluation::.). If the value of the expression - is non-zero, the return status is 0; otherwise the return status - is 1. This is exactly equivalent to + The arithmetic EXPRESSION is evaluated according to the rules + described below (*note Shell Arithmetic::.). If the value of the + expression is non-zero, the return status is 0; otherwise the + return status is 1. This is exactly equivalent to let "EXPRESSION" - The `select' construct, which allows users to choose from a list of -items presented as a menu, is also available. *Note Korn Shell -Constructs::, for a full description of `select'. + *Note Bash Builtins::, for a full description of the `let' builtin. + +`[[...]]' + [[ EXPRESSION ]] + + Return a status of 0 or 1 depending on the evaluation of the + conditional expression EXPRESSION. Expressions are composed of + the primaries described below in *Note Bash Conditional + Expressions::. Word splitting and filename expansion are not + performed on the words between the `[[' and `]]'; tilde expansion, + parameter and variable expansion, arithmetic expansion, command + substitution, process substitution, and quote removal are + performed. + + When the `==' and `!=' operators are used, the string to the right + of the operator is considered a pattern and matched according to + the rules described below in *Note Pattern Matching::. The return + value is 0 if the string matches or does not match the pattern, + respectively, and 1 otherwise. Any part of the pattern may be + quoted to force it to be matched as a string. + + Expressions may be combined using the following operators, listed + in decreasing order of precedence: + + `( EXPRESSION )' + Returns the value of EXPRESSION. This may be used to + override the normal precedence of operators. + + `! EXPRESSION' + True if EXPRESSION is false. + + `EXPRESSION1 && EXPRESSION2' + True if both EXPRESSION1 and EXPRESSION2 are true. + + `EXPRESSION1 || EXPRESSION2' + True if either EXPRESSION1 or EXPRESSION2 is true. + + The && and || commands do not execute EXPRESSION2 if the value of + EXPRESSION1 is sufficient to determine the return value of the + entire conditional expression. -File: bashref.info, Node: Command Grouping, Next: Shell Functions, Prev: Conditional Constructs, Up: Basic Shell Features +File: bashref.info, Node: Command Grouping, Prev: Conditional Constructs, Up: Shell Commands Grouping Commands -================= +----------------- Bash provides two ways to group a list of commands to be executed as a unit. When commands are grouped, redirections may be applied to the @@ -663,8 +786,8 @@ the list may be redirected to a single stream. ( LIST ) Placing a list of commands between parentheses causes a subshell - to be created, and each of the commands to be executed in that - subshell. Since the LIST is executed in a subshell, variable + to be created, and each of the commands in LIST to be executed in + that subshell. Since the LIST is executed in a subshell, variable assignments do not remain in effect after the subshell completes. `{}' @@ -672,7 +795,7 @@ the list may be redirected to a single stream. Placing a list of commands between curly braces causes the list to be executed in the current shell context. No subshell is created. - The semicolon following LIST is required. + The semicolon (or newline) following LIST is required. In addition to the creation of a subshell, there is a subtle difference between these two constructs due to historical reasons. The @@ -685,7 +808,7 @@ LIST by whitespace. LIST. -File: bashref.info, Node: Shell Functions, Next: Shell Parameters, Prev: Command Grouping, Up: Basic Shell Features +File: bashref.info, Node: Shell Functions, Next: Shell Parameters, Prev: Shell Commands, Up: Basic Shell Features Shell Functions =============== @@ -699,10 +822,11 @@ context; no new process is created to interpret them. [ `function' ] NAME () { COMMAND-LIST; } This defines a shell function named NAME. The reserved word -`function' is optional. The BODY of the function is the COMMAND-LIST -between { and }. This list is executed whenever NAME is specified as -the name of a command. The exit status of a function is the exit -status of the last command executed in the body. +`function' is optional. If the `function' reserved word is supplied, +the parentheses are optional. The BODY of the function is the +COMMAND-LIST between { and }. This list is executed whenever NAME is +specified as the name of a command. The exit status of a function is +the exit status of the last command executed in the body. When a function is executed, the arguments to the function become the positional parameters during its execution (*note Positional @@ -714,8 +838,10 @@ parameter `0' is unchanged. function completes and execution resumes with the next command after the function call. When a function completes, the values of the positional parameters and the special parameter `#' are restored to the -values they had prior to function execution. If a numeric argument is -given to `return', that is the function return status. +values they had prior to the function's execution. If a numeric +argument is given to `return', that is the function's return status; +otherwise the functions's return status is the exit status of the last +command executed before the `return'. Variables local to the function may be declared with the `local' builtin. These variables are visible only to the function and the @@ -749,12 +875,12 @@ the `unset' builtin command. If VALUE is not given, the variable is assigned the null string. All VALUEs undergo tilde expansion, parameter and variable expansion, command substitution, arithmetic expansion, and quote removal (detailed -below). If the variable has its `-i' attribute set (see the +below). If the variable has its `integer' attribute set (see the description of the `declare' builtin in *Note Bash Builtins::), then -VALUE is subject to arithmetic expansion even if the `$((...))' syntax -does not appear (*note Arithmetic Expansion::.). Word splitting is not -performed, with the exception of `"$@"' as explained below. Filename -expansion is not performed. +VALUE is subject to arithmetic expansion even if the `$((...))' +expansion is not used (*note Arithmetic Expansion::.). Word splitting +is not performed, with the exception of `"$@"' as explained below. +Filename expansion is not performed. File: bashref.info, Node: Positional Parameters, Next: Special Parameters, Up: Shell Parameters @@ -765,10 +891,10 @@ Positional Parameters A POSITIONAL PARAMETER is a parameter denoted by one or more digits, other than the single digit `0'. Positional parameters are assigned from the shell's arguments when it is invoked, and may be reassigned -using the `set' builtin command. Positional parameters may not be -assigned to with assignment statements. The positional parameters are -temporarily replaced when a shell function is executed (*note Shell -Functions::.). +using the `set' builtin command. Positional parameter `N' may be +referenced as `${N}'. Positional parameters may not be assigned to +with assignment statements. The positional parameters are temporarily +replaced when a shell function is executed (*note Shell Functions::.). When a positional parameter consisting of more than a single digit is expanded, it must be enclosed in braces. @@ -794,7 +920,7 @@ only be referenced; assignment to them is not allowed. `@' Expands to the positional parameters, starting from one. When the - expansion occurs within double quotes, each parameter expands as a + expansion occurs within double quotes, each parameter expands to a separate word. That is, `"$@"' is equivalent to `"$1" "$2" ...'. When there are no positional parameters, `"$@"' and `$@' expand to nothing (i.e., they are removed). @@ -813,7 +939,7 @@ only be referenced; assignment to them is not allowed. `$' Expands to the process ID of the shell. In a `()' subshell, it - expands to the process ID of the current shell, not the subshell. + expands to the process ID of the invoking shell, not the subshell. `!' Expands to the process ID of the most recently executed background @@ -821,17 +947,18 @@ only be referenced; assignment to them is not allowed. `0' Expands to the name of the shell or shell script. This is set at - shell initialization. If Bash is invoked with a file of commands, - `$0' is set to the name of that file. If Bash is started with the - `-c' option, then `$0' is set to the first argument after the - string to be executed, if one is present. Otherwise, it is set to - the filename used to invoke Bash, as given by argument zero. + shell initialization. If Bash is invoked with a file of commands + (*note Shell Scripts::.), `$0' is set to the name of that file. + If Bash is started with the `-c' option (*note Invoking Bash::.), + then `$0' is set to the first argument after the string to be + executed, if one is present. Otherwise, it is set to the filename + used to invoke Bash, as given by argument zero. `_' At shell startup, set to the absolute filename of the shell or shell script being executed as passed in the argument list. Subsequently, expands to the last argument to the previous command, - after expansion. Also set to the full filename of each command + after expansion. Also set to the full pathname of each command executed and placed in the environment exported to that command. When checking mail, this parameter holds the name of the mail file. @@ -859,8 +986,11 @@ into `token's. There are seven kinds of expansion performed: * Menu: +* Brace Expansion:: Expansion of expressions within braces. +* Tilde Expansion:: Expansion of the ~ character. * Shell Parameter Expansion:: How Bash expands variables to their values. * Command Substitution:: Using the output of a command as an argument. +* Arithmetic Expansion:: How to use arithmetic in shell expansions. * Process Substitution:: A way to write and read to and from a command. * Word Splitting:: How the results of expansion are split into separate @@ -869,11 +999,6 @@ into `token's. There are seven kinds of expansion performed: * Quote Removal:: How and when quote characters are removed from words. - Brace expansion, tilde expansion, and arithmetic expansion are -described in other sections. For brace expansion, see *Note Brace -Expansion::; for tilde expansion, see *Note Tilde Expansion::; and for -arithmetic expansion, see *Note Arithmetic Expansion::. - The order of expansions is: brace expansion, tilde expansion, parameter, variable, and arithmetic expansion and command substitution (done in a left-to-right fashion), word splitting, and filename @@ -881,7 +1006,7 @@ expansion. On systems that can support it, there is an additional expansion available: PROCESS SUBSTITUTION. This is performed at the same time as -parameter, variable, and arithemtic expansion and command substitution. +parameter, variable, and arithmetic expansion and command substitution. Only brace expansion, word splitting, and filename expansion can change the number of words of the expansion; other expansions expand a @@ -893,7 +1018,106 @@ expansions of `"$@"' (*note Special Parameters::.) and `"${NAME[@]}"' performed. -File: bashref.info, Node: Shell Parameter Expansion, Next: Command Substitution, Up: Shell Expansions +File: bashref.info, Node: Brace Expansion, Next: Tilde Expansion, Up: Shell Expansions + +Brace Expansion +--------------- + + Brace expansion is a mechanism by which arbitrary strings may be +generated. This mechanism is similar to FILENAME EXPANSION (*note +Filename Expansion::.), but the file names generated need not exist. +Patterns to be brace expanded take the form of an optional PREAMBLE, +followed by a series of comma-separated strings between a pair of +braces, followed by an optional POSTSCRIPT. The preamble is prepended +to each string contained within the braces, and the postscript is then +appended to each resulting string, expanding left to right. + + Brace expansions may be nested. The results of each expanded string +are not sorted; left to right order is preserved. For example, + bash$ echo a{d,c,b}e + ade ace abe + + Brace expansion is performed before any other expansions, and any +characters special to other expansions are preserved in the result. It +is strictly textual. Bash does not apply any syntactic interpretation +to the context of the expansion or the text between the braces. + + A correctly-formed brace expansion must contain unquoted opening and +closing braces, and at least one unquoted comma. Any incorrectly +formed brace expansion is left unchanged. + + This construct is typically used as shorthand when the common prefix +of the strings to be generated is longer than in the above example: + mkdir /usr/local/src/bash/{old,new,dist,bugs} + or + chown root /usr/{ucb/{ex,edit},lib/{ex?.?*,how_ex}} + + +File: bashref.info, Node: Tilde Expansion, Next: Shell Parameter Expansion, Prev: Brace Expansion, Up: Shell Expansions + +Tilde Expansion +--------------- + + If a word begins with an unquoted tilde character (`~'), all of the +characters up to the first unquoted slash (or all characters, if there +is no unquoted slash) are considered a TILDE-PREFIX. If none of the +characters in the tilde-prefix are quoted, the characters in the +tilde-prefix following the tilde are treated as a possible LOGIN NAME. +If this login name is the null string, the tilde is replaced with the +value of the `HOME' shell variable. If `HOME' is unset, the home +directory of the user executing the shell is substituted instead. +Otherwise, the tilde-prefix is replaced with the home directory +associated with the specified login name. + + If the tilde-prefix is `~+', the value of the shell variable `PWD' +replaces the tilde-prefix. If the tilde-prefix is `~-', the value of +the shell variable `OLDPWD', if it is set, is substituted. + + If the characters following the tilde in the tilde-prefix consist of +a number N, optionally prefixed by a `+' or a `-', the tilde-prefix is +replaced with the corresponding element from the directory stack, as it +would be displayed by the `dirs' builtin invoked with the characters +following tilde in the tilde-prefix as an argument (*note The Directory +Stack::.). If the tilde-prefix, sans the tilde, consists of a number +without a leading `+' or `-', `+' is assumed. + + If the login name is invalid, or the tilde expansion fails, the word +is left unchanged. + + Each variable assignment is checked for unquoted tilde-prefixes +immediately following a `:' or `='. In these cases, tilde expansion is +also performed. Consequently, one may use file names with tildes in +assignments to `PATH', `MAILPATH', and `CDPATH', and the shell assigns +the expanded value. + + The following table shows how Bash treats unquoted tilde-prefixes: + +`~' + The value of `$HOME' + +`~/foo' + `$HOME/foo' + +`~fred/foo' + The subdirectory `foo' of the home directory of the user `fred' + +`~+/foo' + `$PWD/foo' + +`~-/foo' + `${OLDPWD-'~-'}/foo' + +`~N' + The string that would be displayed by `dirs +N' + +`~+N' + The string that would be displayed by `dirs +N' + +`~-N' + The string that would be displayed by `dirs -N' + + +File: bashref.info, Node: Shell Parameter Expansion, Next: Command Substitution, Prev: Tilde Expansion, Up: Shell Expansions Shell Parameter Expansion ------------------------- @@ -904,6 +1128,11 @@ be expanded may be enclosed in braces, which are optional but serve to protect the variable to be expanded from characters immediately following it which could be interpreted as part of the name. + When braces are used, the matching ending brace is the first `}' not +escaped by a backslash or within a quoted string, and not within an +embedded arithmetic expansion, command substitution, or parameter +expansion. + The basic form of parameter expansion is ${PARAMETER}. The value of PARAMETER is substituted. The braces are required when PARAMETER is a positional parameter with more than one digit, or when PARAMETER is @@ -945,11 +1174,11 @@ parameter that is unset. `${PARAMETER:OFFSET}' `${PARAMETER:OFFSET:LENGTH}' - Expands to up to LENGTH characters of PARAMETER, starting at - OFFSET. If LENGTH is omitted, expands to the substring of - PARAMETER, starting at the character specified by OFFSET. LENGTH - and OFFSET are arithmetic expressions (*note Arithmetic - Evaluation::.). This is referred to as Substring Expansion. + Expands to up to LENGTH characters of PARAMETER, starting at the + character specified by OFFSET. If LENGTH is omitted, expands to + the substring of PARAMETER, starting at the character specified by + OFFSET. LENGTH and OFFSET are arithmetic expressions (*note Shell + Arithmetic::.). This is referred to as Substring Expansion. LENGTH must evaluate to a number greater than or equal to zero. If OFFSET evaluates to a number less than zero, the value is used @@ -957,43 +1186,44 @@ parameter that is unset. is `@', the result is LENGTH positional parameters beginning at OFFSET. If PARAMETER is an array name indexed by `@' or `*', the result is the LENGTH members of the array beginning with - ${PARAMETER[OFFSET]}. Substring indexing is zero-based unless the - positional parameters are used, in which case the indexing starts - at 1. + `${PARAMETER[OFFSET]}'. Substring indexing is zero-based unless + the positional parameters are used, in which case the indexing + starts at 1. `${#PARAMETER}' - The length in characters of the value of PARAMETER is substituted. - If PARAMETER is `*' or `@', the length substituted is the number - of positional parameters. If PARAMETER is an array name - subscripted by `*' or `@', the length substituted is the number of - elements in the array. + The length in characters of the expanded value of PARAMETER is + substituted. If PARAMETER is `*' or `@', the value substituted is + the number of positional parameters. If PARAMETER is an array + name subscripted by `*' or `@', the value substituted is the + number of elements in the array. `${PARAMETER#WORD}' `${PARAMETER##WORD}' The WORD is expanded to produce a pattern just as in filename expansion (*note Filename Expansion::.). If the pattern matches - the beginning of the value of PARAMETER, then the expansion is the - value of PARAMETER with the shortest matching pattern (the `#' - case) or the longest matching pattern (the `##' case) deleted. If - PARAMETER is `@' or `*', the pattern removal operation is applied - to each positional parameter in turn, and the expansion is the - resultant list. If PARAMETER is an array variable subscripted with - `@' or `*', the pattern removal operation is applied to each - member of the array in turn, and the expansion is the resultant - list. + the beginning of the expanded value of PARAMETER, then the result + of the expansion is the expanded value of PARAMETER with the + shortest matching pattern (the `#' case) or the longest matching + pattern (the `##' case) deleted. If PARAMETER is `@' or `*', the + pattern removal operation is applied to each positional parameter + in turn, and the expansion is the resultant list. If PARAMETER is + an array variable subscripted with `@' or `*', the pattern removal + operation is applied to each member of the array in turn, and the + expansion is the resultant list. `${PARAMETER%WORD}' `${PARAMETER%%WORD}' The WORD is expanded to produce a pattern just as in filename - expansion. If the pattern matches a trailing portion of the value - of PARAMETER, then the expansion is the value of PARAMETER with - the shortest matching pattern (the `%' case) or the longest - matching pattern (the `%%' case) deleted. If PARAMETER is `@' or - `*', the pattern removal operation is applied to each positional - parameter in turn, and the expansion is the resultant list. If - PARAMETER is an array variable subscripted with `@' or `*', the - pattern removal operation is applied to each member of the array - in turn, and the expansion is the resultant list. + expansion. If the pattern matches a trailing portion of the + expanded value of PARAMETER, then the result of the expansion is + the value of PARAMETER with the shortest matching pattern (the `%' + case) or the longest matching pattern (the `%%' case) deleted. If + PARAMETER is `@' or `*', the pattern removal operation is applied + to each positional parameter in turn, and the expansion is the + resultant list. If PARAMETER is an array variable subscripted + with `@' or `*', the pattern removal operation is applied to each + member of the array in turn, and the expansion is the resultant + list. `${PARAMETER/PATTERN/STRING}' `${PARAMETER//PATTERN/STRING}' @@ -1013,7 +1243,7 @@ parameter that is unset. is the resultant list. -File: bashref.info, Node: Command Substitution, Next: Process Substitution, Prev: Shell Parameter Expansion, Up: Shell Expansions +File: bashref.info, Node: Command Substitution, Next: Arithmetic Expansion, Prev: Shell Parameter Expansion, Up: Shell Expansions Command Substitution -------------------- @@ -1027,21 +1257,47 @@ or Bash performs the expansion by executing COMMAND and replacing the command substitution with the standard output of the command, with any -trailing newlines deleted. +trailing newlines deleted. Embedded newlines are not deleted, but they +may be removed during word splitting. The command substitution `$(cat +FILE)' can be replaced by the equivalent but faster `$(< FILE)'. When the old-style backquote form of substitution is used, backslash retains its literal meaning except when followed by `$', ``', or `\'. -When using the `$(COMMAND)' form, all characters between the -parentheses make up the command; none are treated specially. +The first backquote not preceded by a backslash terminates the command +substitution. When using the `$(COMMAND)' form, all characters between +the parentheses make up the command; none are treated specially. - Command substitutions may be nested. To nest when using the old -form, escape the inner backquotes with backslashes. + Command substitutions may be nested. To nest when using the +backquoted form, escape the inner backquotes with backslashes. If the substitution appears within double quotes, word splitting and filename expansion are not performed on the results. -File: bashref.info, Node: Process Substitution, Next: Word Splitting, Prev: Command Substitution, Up: Shell Expansions +File: bashref.info, Node: Arithmetic Expansion, Next: Process Substitution, Prev: Command Substitution, Up: Shell Expansions + +Arithmetic Expansion +-------------------- + + Arithmetic expansion allows the evaluation of an arithmetic +expression and the substitution of the result. The format for +arithmetic expansion is: + + $(( EXPRESSION )) + + The expression is treated as if it were within double quotes, but a +double quote inside the parentheses is not treated specially. All +tokens in the expression undergo parameter expansion, command +substitution, and quote removal. Arithmetic substitutions may be +nested. + + The evaluation is performed according to the rules listed below +(*note Shell Arithmetic::.). If the expression is invalid, Bash prints +a message indicating failure to the standard error and no substitution +occurs. + + +File: bashref.info, Node: Process Substitution, Next: Word Splitting, Prev: Arithmetic Expansion, Up: Shell Expansions Process Substitution -------------------- @@ -1061,9 +1317,9 @@ to the current command as the result of the expansion. If the LIST. If the `<(LIST)' form is used, the file passed as an argument should be read to obtain the output of LIST. - On systems that support it, process substitution is performed -simultaneously with parameter and variable expansion, command -substitution, and arithmetic expansion. + When available, process substitution is performed simultaneously with +parameter and variable expansion, command substitution, and arithmetic +expansion. File: bashref.info, Node: Word Splitting, Next: Filename Expansion, Prev: Process Substitution, Up: Shell Expansions @@ -1101,32 +1357,51 @@ File: bashref.info, Node: Filename Expansion, Next: Quote Removal, Prev: Word Filename Expansion ------------------ +* Menu: + +* Pattern Matching:: How the shell matches patterns. + After word splitting, unless the `-f' option has been set (*note The -Set Builtin::.), Bash scans each word for the characters `*', `?', and -`['. If one of these characters appears, then the word is regarded as -a PATTERN, and replaced with an alphabetically sorted list of file +Set Builtin::.), Bash scans each word for the characters `*', `?', `(', +and `['. If one of these characters appears, then the word is regarded +as a PATTERN, and replaced with an alphabetically sorted list of file names matching the pattern. If no matching file names are found, and -the shell option `nullglob' is disabled, the word is left unchanged. If -the option is set, and no matches are found, the word is removed. When -a pattern is used for filename generation, the character `.' at the -start of a filename or immediately following a slash must be matched -explicitly, unless the shell option `dotglob' is set. The slash -character must always be matched explicitly. In other cases, the `.' -character is not treated specially. See the description of `shopt' in -*Note Bash Builtins::, for a description of the `nullglob' and -`dotglob' options. +the shell option `nullglob' is disabled, the word is left unchanged. +If the `nullglob' option is set, and no matches are found, the word is +removed. If the shell option `nocaseglob' is enabled, the match is +performed without regard to the case of alphabetic characters. + + When a pattern is used for filename generation, the character `.' at +the start of a filename or immediately following a slash must be +matched explicitly, unless the shell option `dotglob' is set. When +matching a file name, the slash character must always be matched +explicitly. In other cases, the `.' character is not treated specially. + + See the description of `shopt' in *Note Bash Builtins::, for a +description of the `nocaseglob', `nullglob', and `dotglob' options. The `GLOBIGNORE' shell variable may be used to restrict the set of -filenames matching a PATTERN. If `GLOBIGNORE' is set, each matching +filenames matching a pattern. If `GLOBIGNORE' is set, each matching filename that also matches one of the patterns in `GLOBIGNORE' is removed from the list of matches. The filenames `.' and `..' are -always ignored, even when `GLOBIGNORE'. is set. However, setting +always ignored, even when `GLOBIGNORE' is set. However, setting `GLOBIGNORE' has the effect of enabling the `dotglob' shell option, so all other filenames beginning with a `.' will match. To get the old behavior of ignoring filenames beginning with a `.', make `.*' one of the patterns in `GLOBIGNORE'. The `dotglob' option is disabled when `GLOBIGNORE' is unset. + +File: bashref.info, Node: Pattern Matching, Up: Filename Expansion + +Pattern Matching +................ + + Any character that appears in a pattern, other than the special +pattern characters described below, matches itself. The NUL character +may not occur in a pattern. The special pattern characters must be +quoted if they are to be matched literally. + The special pattern characters have the following meanings: `*' Matches any string, including the null string. @@ -1143,6 +1418,43 @@ the patterns in `GLOBIGNORE'. The `dotglob' option is disabled when the first or last character in the set. A `]' may be matched by including it as the first character in the set. + Within `[' and `]', CHARACTER CLASSES can be specified using the + syntax `[:'CLASS`:]', where CLASS is one of the following classes + defined in the POSIX.2 standard: + alnum alpha ascii blank cntrl digit graph lower + print punct space upper xdigit + + A character class matches any character belonging to that class. + + Within `[' and `]', an EQUIVALENCE CLASS can be specified using + the syntax `[='C`=]', which matches all characters with the same + collation weight (as defined by the current locale) as the + character C. + + Within `[' and `]', the syntax `[.'SYMBOL`.]' matches the + collating symbol SYMBOL. + + If the `extglob' shell option is enabled using the `shopt' builtin, +several extended pattern matching operators are recognized. In the +following description, a PATTERN-LIST is a list of one or more patterns +separated by a `|'. Composite patterns may be formed using one or more +of the following sub-patterns: + +`?(PATTERN-LIST)' + Matches zero or one occurrence of the given patterns. + +`*(PATTERN-LIST)' + Matches zero or more occurrences of the given patterns. + +`+(PATTERN-LIST)' + Matches one or more occurrences of the given patterns. + +`@(PATTERN-LIST)' + Matches exactly one of the given patterns. + +`!(PATTERN-LIST)' + Matches anything except one of the given patterns. + File: bashref.info, Node: Quote Removal, Prev: Filename Expansion, Up: Shell Expansions @@ -1172,11 +1484,11 @@ the redirection refers to the standard input (file descriptor 0). If the first character of the redirection operator is `>', the redirection refers to the standard output (file descriptor 1). - The word that follows the redirection operator in the following -descriptions is subjected to brace expansion, tilde expansion, -parameter expansion, command substitution, arithmetic expansion, quote -removal, and filename expansion. If it expands to more than one word, -Bash reports an error. + The word following the redirection operator in the following +descriptions, unless otherwise noted, is subjected to brace expansion, +tilde expansion, parameter expansion, command substitution, arithmetic +expansion, quote removal, and filename expansion. If it expands to +more than one word, Bash reports an error. Note that the order of redirections is significant. For example, the command @@ -1190,6 +1502,8 @@ directs only the standard output to file DIRLIST, because the standard error was duplicated as standard output before the standard output was redirected to DIRLIST. + A failure to open or create a file causes the redirection to fail. + Redirecting Input ----------------- @@ -1212,12 +1526,12 @@ to zero size. The general format for redirecting output is: [n]>[|]WORD - If the redirection operator is `>', and the `-C' option to the `set' -builtin has been enabled, the redirection will fail if the filename -whose name results from the expansion of WORD exists. If the -redirection operator is `>|', then the value of the `-C' option to the -`set' builtin command is not tested, and the redirection is attempted -even if the file named by WORD exists. + If the redirection operator is `>', and the `noclobber' option to +the `set' builtin has been enabled, the redirection will fail if the +filename whose name results from the expansion of WORD exists and is a +regular file. If the redirection operator is `>|', or the redirection +operator is `>' and the `noclobber' option is not enabled, the +redirection is attempted even if the file named by WORD exists. Appending Redirected Output --------------------------- @@ -1264,11 +1578,11 @@ as the standard input for a command. No parameter expansion, command substitution, filename expansion, or arithmetic expansion is performed on WORD. If any characters in WORD are quoted, the DELIMITER is the result of quote removal on WORD, and -the lines in the here-document are not expanded. Otherwise, all lines -of the here-document are subjected to parameter expansion, command -substitution, and arithmetic expansion. In the latter case, the pair -`\newline' is ignored, and `\' must be used to quote the characters -`\', `$', and ``'. +the lines in the here-document are not expanded. If WORD is unquoted, +all lines of the here-document are subjected to parameter expansion, +command substitution, and arithmetic expansion. In the latter case, +the pair `\newline' is ignored, and `\' must be used to quote the +characters `\', `$', and ``'. If the redirection operator is `<<-', then all leading tab characters are stripped from input lines and the line containing @@ -1283,18 +1597,20 @@ Duplicating File Descriptors is used to duplicate input file descriptors. If WORD expands to one or more digits, the file descriptor denoted by `n' is made to be a copy of -that file descriptor. If WORD evaluates to `-', file descriptor `n' is -closed. If `n' is not specified, the standard input (file descriptor -0) is used. +that file descriptor. If the digits in WORD do not specify a file +descriptor open for input, a redirection error occurs. If WORD +evaluates to `-', file descriptor `n' is closed. If `n' is not +specified, the standard input (file descriptor 0) is used. The operator [n]>&WORD is used similarly to duplicate output file descriptors. If `n' is not -specified, the standard output (file descriptor 1) is used. As a -special case, if `n' is omitted, and WORD does not expand to one or -more digits, the standard output and standard error are redirected as -described previously. +specified, the standard output (file descriptor 1) is used. If the +digits in WORD do not specify a file descriptor open for output, a +redirection error occurs. As a special case, if `n' is omitted, and +WORD does not expand to one or more digits, the standard output and +standard error are redirected as described previously. Opening File Descriptors for Reading and Writing ------------------------------------------------ @@ -1314,8 +1630,15 @@ Executing Commands * Menu: +* Simple Command Expansion:: How Bash expands simple commands before + executing them. + * Command Search and Execution:: How Bash finds commands and runs them. +* Command Execution Environment:: The environment in which Bash + executes commands that are not + shell builtins. + * Environment:: The environment given to a command. * Exit Status:: The status returned by commands and how Bash @@ -1325,7 +1648,50 @@ Executing Commands receives a signal. -File: bashref.info, Node: Command Search and Execution, Next: Environment, Up: Executing Commands +File: bashref.info, Node: Simple Command Expansion, Next: Command Search and Execution, Up: Executing Commands + +Simple Command Expansion +------------------------ + + When a simple command is executed, the shell performs the following +expansions, assignments, and redirections, from left to right. + + 1. The words that the parser has marked as variable assignments (those + preceding the command name) and redirections are saved for later + processing. + + 2. The words that are not variable assignments or redirections are + expanded (*note Shell Expansions::.). If any words remain after + expansion, the first word is taken to be the name of the command + and the remaining words are the arguments. + + 3. Redirections are performed as described above (*note + Redirections::.). + + 4. The text after the `=' in each variable assignment undergoes tilde + expansion, parameter expansion, command substitution, arithmetic + expansion, and quote removal before being assigned to the variable. + + If no command name results, the variable assignments affect the +current shell environment. Otherwise, the variables are added to the +environment of the executed command and do not affect the current shell +environment. If any of the assignments attempts to assign a value to a +readonly variable, an error occurs, and the command exits with a +non-zero status. + + If no command name results, redirections are performed, but do not +affect the current shell environment. A redirection error causes the +command to exit with a non-zero status. + + If there is a command name left after expansion, execution proceeds +as described below. Otherwise, the command exits. If one of the +expansions contained a command substitution, the exit status of the +command is the exit status of the last command substitution performed. +If there were no command substitutions, the command exits with a status +of zero. + + +File: bashref.info, Node: Command Search and Execution, Next: Command Execution Environment, Prev: Simple Command Expansion, Up: Executing Commands Command Search and Execution ---------------------------- @@ -1345,24 +1711,95 @@ taken. 3. If the name is neither a shell function nor a builtin, and contains no slashes, Bash searches each element of `$PATH' for a directory containing an executable file by that name. Bash uses a - hash table to remember the full filenames of executable files (see - the description of `hash' in *Note Bourne Shell Builtins::) to - avoid multiple `PATH' searches. A full search of the directories + hash table to remember the full pathnames of executable files to + avoid multiple `PATH' searches (see the description of `hash' in + *Note Bourne Shell Builtins::). A full search of the directories in `$PATH' is performed only if the command is not found in the hash table. If the search is unsuccessful, the shell prints an - error message and returns a nonzero exit status. + error message and returns an exit status of 127. 4. If the search is successful, or if the command name contains one - or more slashes, the shell executes the named program. Argument 0 - is set to the name given, and the remaining arguments to the - command are set to the arguments supplied, if any. + or more slashes, the shell executes the named program in a + separate execution environment. Argument 0 is set to the name + given, and the remaining arguments to the command are set to the + arguments supplied, if any. 5. If this execution fails because the file is not in executable - format, and the file is not a directory, it is assumed to be SHELL - SCRIPT (*note Shell Scripts::.). + format, and the file is not a directory, it is assumed to be a + SHELL SCRIPT and the shell executes it as described in *Note Shell + Scripts::. + + 6. If the command was not begun asynchronously, the shell waits for + the command to complete and collects its exit status. + -File: bashref.info, Node: Environment, Next: Exit Status, Prev: Command Search and Execution, Up: Executing Commands +File: bashref.info, Node: Command Execution Environment, Next: Environment, Prev: Command Search and Execution, Up: Executing Commands + +Command Execution Environment +----------------------------- + + The shell has an EXECUTION ENVIRONMENT, which consists of the +following: + + * open files inherited by the shell at invocation, as modified by + redirections supplied to the `exec' builtin + + * the current working directory as set by `cd', `pushd', or `popd', + or inherited by the shell at invocation + + * the file creation mode mask as set by `umask' or inherited from + the shell's parent + + * current traps set by `trap' + + * shell parameters that are set by variable assignment or with `set' + or inherited from the shell's parent in the environment + + * shell functions defined during execution or inherited from the + shell's parent in the environment + + * options enabled at invocation (either by default or with + command-line arguments) or by `set' + + * options enabled by `shopt' + + * shell aliases defined with `alias' (*note Aliases::.) + + * various process IDs, including those of background jobs (*note + Lists::.), the value of `$$', and the value of `$PPID' + + When a simple command other than a builtin or shell function is to +be executed, it is invoked in a separate execution environment that +consists of the following. Unless otherwise noted, the values are +inherited from the shell. + + * the shell's open files, plus any modifications and additions + specified by redirections to the command + + * the current working directory + + * the file creation mode mask + + * shell variables marked for export, along with variables exported + for the command, passed in the environment (*note Environment::.) + + * traps caught by the shell are reset to the values inherited from + the shell's parent, and traps ignored by the shell are ignored + + A command invoked in this separate environment cannot affect the +shell's execution environment. + + Command substitution and asynchronous commands are invoked in a +subshell environment that is a duplicate of the shell environment, +except that traps caught by the shell are reset to the values that the +shell inherited from its parent at invocation. Builtin commands that +are invoked as part of a pipeline are also executed in a subshell +environment. Changes made to the subshell environment cannot affect +the shell's execution environment. + + +File: bashref.info, Node: Environment, Next: Exit Status, Prev: Command Execution Environment, Up: Executing Commands Environment ----------- @@ -1380,15 +1817,16 @@ and deleted from the environment. If the value of a parameter in the environment is modified, the new value becomes part of the environment, replacing the old. The environment inherited by any executed command consists of the shell's initial environment, whose values may be -modified in the shell, less any pairs removed by the `unset' command, -plus any additions via the `export' and `declare -x' commands. +modified in the shell, less any pairs removed by the `unset' and +`export -n' commands, plus any additions via the `export' and `declare +-x' commands. The environment for any simple command or function may be augmented temporarily by prefixing it with parameter assignments, as described in *Note Shell Parameters::. These assignment statements affect only the environment seen by that command. - If the `-k' flag is set (*note The Set Builtin::., then all + If the `-k' option is set (*note The Set Builtin::.), then all parameter assignments are placed in the environment for a command, not just those that precede the command name. @@ -1402,24 +1840,28 @@ File: bashref.info, Node: Exit Status, Next: Signals, Prev: Environment, Up: Exit Status ----------- - For the purposes of the shell, a command which exits with a zero -exit status has succeeded. A non-zero exit status indicates failure. -This seemingly counter-intuitive scheme is used so there is one -well-defined way to indicate success and a variety of ways to indicate -various failure modes. When a command terminates on a fatal signal -whose number is N, Bash uses the value 128+N as the exit status. + For the shell's purposes, a command which exits with a zero exit +status has succeeded. A non-zero exit status indicates failure. This +seemingly counter-intuitive scheme is used so there is one well-defined +way to indicate success and a variety of ways to indicate various +failure modes. When a command terminates on a fatal signal whose +number is N, Bash uses the value 128+N as the exit status. If a command is not found, the child process created to execute it returns a status of 127. If a command is found but is not executable, the return status is 126. + If a command fails because of an error during expansion or +redirection, the exit status is greater than zero. + The exit status is used by the Bash conditional commands (*note Conditional Constructs::.) and some of the list constructs (*note Lists::.). All of the Bash builtins return an exit status of zero if they succeed and a non-zero status on failure, so they may be used by the -conditional and list constructs. +conditional and list constructs. All builtins return an exit status of +2 to indicate incorrect usage. File: bashref.info, Node: Signals, Prev: Exit Status, Up: Executing Commands @@ -1427,26 +1869,40 @@ File: bashref.info, Node: Signals, Prev: Exit Status, Up: Executing Commands Signals ------- - When Bash is interactive, it ignores `SIGTERM' (so that `kill 0' -does not kill an interactive shell), and `SIGINT' is caught and handled -(so that the `wait' builtin is interruptible). When Bash receives a -`SIGINT', it breaks out of any executing loops. In all cases, Bash -ignores `SIGQUIT'. If job control is in effect (*note Job Control::.), -Bash ignores `SIGTTIN', `SIGTTOU', and `SIGTSTP'. + When Bash is interactive, in the absence of any traps, it ignores +`SIGTERM' (so that `kill 0' does not kill an interactive shell), and +`SIGINT' is caught and handled (so that the `wait' builtin is +interruptible). When Bash receives a `SIGINT', it breaks out of any +executing loops. In all cases, Bash ignores `SIGQUIT'. If job control +is in effect (*note Job Control::.), Bash ignores `SIGTTIN', `SIGTTOU', +and `SIGTSTP'. - Synchronous jobs started by Bash have signals set to the values + Commands started by Bash have signal handlers set to the values inherited by the shell from its parent. When job control is not in -effect, background jobs (commands terminated with `&') ignore `SIGINT' -and `SIGQUIT'. Commands run as a result of command substitution ignore -the keyboard-generated job control signals `SIGTTIN', `SIGTTOU', and +effect, asynchronous commands ignore `SIGINT' and `SIGQUIT' as well. +Commands run as a result of command substitution ignore the +keyboard-generated job control signals `SIGTTIN', `SIGTTOU', and `SIGTSTP'. The shell exits by default upon receipt of a `SIGHUP'. Before -exiting, it resends the `SIGHUP' to all jobs, running or stopped. To -prevent the shell from sending the `SIGHUP' signal to a particular job, -remove it from the jobs table with the `disown' builtin (*note Job -Control Builtins::.) or use `disown -h' to mark it to not receive -`SIGHUP'. +exiting, it resends the `SIGHUP' to all jobs, running or stopped. +Stopped jobs are sent `SIGCONT' to ensure that they receive the +`SIGHUP'. To prevent the shell from sending the `SIGHUP' signal to a +particular job, it should be removed from the jobs table with the +`disown' builtin (*note Job Control Builtins::.) or marked to not +receive `SIGHUP' using `disown -h'. + + If the `huponexit' shell option has been set with `shopt' (*note +Bash Builtins::.), Bash sends a `SIGHUP' to all jobs when an +interactive login shell exits. + + When Bash receives a signal for which a trap has been set while +waiting for a command to complete, the trap will not be executed until +the command completes. When Bash is waiting for an asynchronous +command via the `wait' builtin, the reception of a signal for which a +trap has been set will cause the `wait' builtin to return immediately +with an exit status greater than 128, immediately after which the trap +is executed. File: bashref.info, Node: Shell Scripts, Prev: Executing Commands, Up: Basic Shell Features @@ -1475,7 +1931,9 @@ is equivalent to executing if `filename' is an executable shell script. This subshell reinitializes itself, so that the effect is as if a new shell had been -invoked to interpret the script. +invoked to interpret the script, with the exception that the locations +of commands remembered by the parent (see the description of `hash' in +*Note Bourne Shell Builtins::) are retained by the child. Most versions of Unix make this a part of the kernel's command execution mechanism. If the first line of a script begins with the two @@ -1489,7 +1947,7 @@ versions of Unix limit the interpreter name and argument to a maximum of 32 characters. -File: bashref.info, Node: Bourne Shell Features, Next: Csh Features, Prev: Basic Shell Features, Up: Top +File: bashref.info, Node: Bourne Shell Features, Next: Bash Features, Prev: Basic Shell Features, Up: Top Bourne Shell Style Features *************************** @@ -1505,7 +1963,8 @@ Bourne Shell Style Features This section briefly summarizes things which Bash inherits from the Bourne Shell: builtins, variables, and other features. It also lists -the significant differences between Bash and the Bourne Shell. +the significant differences between Bash and the Bourne Shell. Many of +the builtins have been extended by POSIX or Bash. File: bashref.info, Node: Bourne Shell Builtins, Next: Bourne Shell Variables, Up: Bourne Shell Features @@ -1520,16 +1979,24 @@ standard. `:' : [ARGUMENTS] Do nothing beyond expanding ARGUMENTS and performing redirections. + The return status is zero. `.' . FILENAME Read and execute commands from the FILENAME argument in the - current shell context. + current shell context. If FILENAME does not contain a slash, the + `$PATH' variable is used to find FILENAME. The current directory + is searched if FILENAME is not found in `$PATH'. The return + status is the exit status of the last command executed, or zero if + no commands are executed. If FILENAME is not found, or cannot be + read, the return status is non-zero. `break' break [N] Exit from a `for', `while', `until', or `select' loop. If N is - supplied, the Nth enclosing loop is exited. + supplied, the Nth enclosing loop is exited. N must be greater + than or equal to 1. The return status is zero unless N is not + greater than or equal to 1. `cd' cd [-LP] [DIRECTORY] @@ -1537,41 +2004,55 @@ standard. is not given, the value of the `HOME' shell variable is used. If the shell variable `CDPATH' exists, it is used as a search path. If DIRECTORY begins with a slash, `CDPATH' is not used. The `-P' - option means to not follow symbolic links; symlinks are followed - by default or with the `-L' option. + option means to not follow symbolic links; symbolic links are + followed by default or with the `-L' option. If DIRECTORY is `-', + it is equivalent to `$OLDPWD'. The return status is zero if the + directory is successfully changed, non-zero otherwise. `continue' continue [N] Resume the next iteration of an enclosing `for', `while', `until', or `select' loop. If N is supplied, the execution of the Nth - enclosing loop is resumed. + enclosing loop is resumed. N must be greater than or equal to 1. + The return status is zero unless N is not greater than or equal to + 1. `eval' eval [ARGUMENTS] The arguments are concatenated together into a single command, - which is then read and executed. + which is then read and executed, and its exit status returned as + the exit status of `eval'. If there are no arguments or only + empty arguments, the return status is zero. `exec' - exec [-cl] [-a NAME] [COMMAND] [ARGUMENTS] - If COMMAND is supplied, it replaces the shell. If the `-l' option - is supplied, the shell places a dash in the zeroth arg passed to - COMMAND. This is what the `login' program does. The `-c' option - causes COMMAND to be executed with an empty environment. If `-a' - is supplied, the shell passes NAME as the zeroth argument to - COMMAND. If no COMMAND is specified, redirections may be used to - affect the current shell environment. + exec [-cl] [-a NAME] [COMMAND [ARGUMENTS]] + If COMMAND is supplied, it replaces the shell without creating a + new process. If the `-l' option is supplied, the shell places a + dash in the zeroth arg passed to COMMAND. This is what the + `login' program does. The `-c' option causes COMMAND to be + executed with an empty environment. If `-a' is supplied, the + shell passes NAME as the zeroth argument to COMMAND. If no + COMMAND is specified, redirections may be used to affect the + current shell environment. If there are no redirection errors, the + return status is zero; otherwise the return status is non-zero. `exit' exit [N] Exit the shell, returning a status of N to the shell's parent. + Any trap on `EXIT' is executed before the shell terminates. `export' export [-fn] [-p] [NAME[=VALUE]] Mark each NAME to be passed to child processes in the environment. If the `-f' option is supplied, the NAMEs refer to shell - functions. The `-n' option means to no longer mark each NAME for - export. If no NAMES are supplied, or if the `-p' option is given, - a list of exported names is displayed. + functions; otherwise the names refer to shell variables. The `-n' + option means to no longer mark each NAME for export. If no NAMES + are supplied, or if the `-p' option is given, a list of exported + names is displayed. The `-p' option displays output in a form + that may be reused as input. The return status is zero unless an + invalid option is supplied, one of the names is not a valid shell + variable name, or `-f' is supplied with a name that is not a shell + function. `getopts' getopts OPTSTRING NAME [ARGS] @@ -1589,14 +2070,21 @@ standard. reset between multiple calls to `getopts' within the same shell invocation if a new set of parameters is to be used. + When the end of options is encountered, `getopts' exits with a + return value greater than zero. `OPTIND' is set to the index of + the first non-option argument, and `name' is set to `?'. + + `getopts' normally parses the positional parameters, but if more + arguments are given in ARGS, `getopts' parses those instead. + `getopts' can report errors in two ways. If the first character of OPTSTRING is a colon, SILENT error reporting is used. In normal - operation diagnostic messages are printed when illegal options or + operation diagnostic messages are printed when invalid options or missing option arguments are encountered. If the variable `OPTERR' - is set to 0, no error message will be displayed, even if the first + is set to 0, no error messages will be displayed, even if the first character of `optstring' is not a colon. - If an illegal option is seen, `getopts' places `?' into NAME and, + If an invalid option is seen, `getopts' places `?' into NAME and, if not silent, prints an error message and unsets `OPTARG'. If `getopts' is silent, the option character found is placed in `OPTARG' and no diagnostic message is printed. @@ -1607,57 +2095,125 @@ standard. colon (`:') is placed in NAME and `OPTARG' is set to the option character found. - `getopts' normally parses the positional parameters, but if more - arguments are given in ARGS, `getopts' parses those instead. - `hash' hash [-r] [-p FILENAME] [NAME] - Remember the full filenames of commands specified as arguments, so - they need not be searched for on subsequent invocations. The - commands are found by searching through the directories listed in - `$PATH'. The `-p' option inhibits the path search, and FILENAME - is used as the location of NAME. The `-r' option causes the shell - to forget all remembered locations. If no arguments are given, - information about remembered commands is printed. + Remember the full pathnames of commands specified as NAME + arguments, so they need not be searched for on subsequent + invocations. The commands are found by searching through the + directories listed in `$PATH'. The `-p' option inhibits the path + search, and FILENAME is used as the location of NAME. The `-r' + option causes the shell to forget all remembered locations. If no + arguments are given, information about remembered commands is + printed. The return status is zero unless a NAME is not found or + an invalid option is supplied. `pwd' pwd [-LP] Print the current working directory. If the `-P' option is supplied, the path printed will not contain symbolic links. If the `-L' option is supplied, the path printed may contain symbolic - links. + links. The return status is zero unless an error is encountered + while determining the name of the current directory or an invalid + option is supplied. `readonly' readonly [-apf] [NAME] ... - Mark each NAME as unchangable. The values of these names may not - be changed by subsequent assignment. If the `-f' option is - supplied, each NAME refers to a shell function. The `-a' option - means each NAME refers to an array variable. If no NAME arguments - are given, or if the `-p' option is supplied, a list of all - readonly names is printed. + Mark each NAME as readonly. The values of these names may not be + changed by subsequent assignment. If the `-f' option is supplied, + each NAME refers to a shell function. The `-a' option means each + NAME refers to an array variable. If no NAME arguments are given, + or if the `-p' option is supplied, a list of all readonly names is + printed. The `-p' option causes output to be displayed in a + format that may be reused as input. The return status is zero + unless an invalid option is supplied, one of the NAME arguments is + not a valid shell variable or function name, or the `-f' option is + supplied with a name that is not a shell function. `return' return [N] - Cause a shell function to exit with value N. This may also be used - to terminate execution of a script being executed with the `.' - builtin. + Cause a shell function to exit with the return value N. This may + also be used to terminate execution of a script being executed + with the `.' builtin, returning either N or the exit status of the + last command executed within the script as the exit status of the + script. The return status is false if `return' is used outside a + function and not during the execution of a script by `.'. `shift' shift [N] - Shift positional parameters to the left by N. The positional - parameters from N+1 ... are renamed to `$1' ... . Parameters - represented by the numbers `$#' to N+1 are unset. N must be a - non-negative number less than or equal to `$#'. + Shift the positional parameters to the left by N. The positional + parameters from N+1 ... `$#' are renamed to `$1' ... `$#'-N+1. + Parameters represented by the numbers `$#' to N+1 are unset. N + must be a non-negative number less than or equal to `$#'. If N is + zero or greater than `$#', the positional parameters are not + changed. The return status is zero unless N is greater than `$#' + or less than zero, non-zero otherwise. `test' `[' - Evaluate a conditional expression (*note Bash Conditional - Expressions::.). + Evaluate a conditional expression EXPR. Each operator and operand + must be a separate argument. Expressions are composed of the + primaries described below in *Note Bash Conditional Expressions::. + + Expressions may be combined using the following operators, listed + in decreasing order of precedence. + + `! EXPR' + True if EXPR is false. + + `( EXPR )' + Returns the value of EXPR. This may be used to override the + normal precedence of operators. + + `EXPR1 -a EXPR2' + True if both EXPR1 and EXPR2 are true. + + `EXPR1 -o EXPR2' + True if either EXPR1 or EXPR2 is true. + + The `test' and `[' builtins evaluate conditional expressions using + a set of rules based on the number of arguments. + + 0 arguments + The expression is false. + + 1 argument + The expression is true if and only if the argument is not + null. + + 2 arguments + If the first argument is `!', the expression is true if and + only if the second argument is null. If the first argument + is one of the unary conditional operators (*note Bash + Conditional Expressions::.), the expression is true if the + unary test is true. If the first argument is not a valid + unary operator, the expression is false. + + 3 arguments + If the second argument is one of the binary conditional + operators (*note Bash Conditional Expressions::.), the result + of the expression is the result of the binary test using the + first and third arguments as operands. If the first argument + is `!', the value is the negation of the two-argument test + using the second and third arguments. If the first argument + is exactly `(' and the third argument is exactly `)', the + result is the one-argument test of the second argument. + Otherwise, the expression is false. The `-a' and `-o' + operators are considered binary operators in this case. + + 4 arguments + If the first argument is `!', the result is the negation of + the three-argument expression composed of the remaining + arguments. Otherwise, the expression is parsed and evaluated + according to precedence using the rules listed above. + + 5 or more arguments + The expression is parsed and evaluated according to precedence + using the rules listed above. `times' times Print out the user and system times used by the shell and its - children. + children. The return status is zero. `trap' trap [-lp] [ARG] [SIGSPEC ...] @@ -1669,33 +2225,42 @@ standard. If ARG is `-p', the shell displays the trap commands associated with each SIGSPEC. If no arguments are supplied, or only `-p' is given, `trap' prints the list of commands associated with each - signal number. Each SIGSPEC is either a signal name such as - `SIGINT' (with or without the `SIG' prefix) or a signal number. - If a SIGSPEC is `0' or `EXIT', ARG is executed when the shell - exits. If a SIGSPEC is `DEBUG', the command ARG is executed after - every simple command. The `-l' option causes the shell to print a - list of signal names and their corresponding numbers. + signal number in a form that may be reused as shell input. Each + SIGSPEC is either a signal name such as `SIGINT' (with or without + the `SIG' prefix) or a signal number. If a SIGSPEC is `0' or + `EXIT', ARG is executed when the shell exits. If a SIGSPEC is + `DEBUG', the command ARG is executed after every simple command. + The `-l' option causes the shell to print a list of signal names + and their corresponding numbers. Signals ignored upon entry to the shell cannot be trapped or reset. Trapped signals are reset to their original values in a child process when it is created. + The return status is zero unless a SIGSPEC does not specify a + valid signal. + `umask' - umask [-S] [MODE] + umask [-p] [-S] [MODE] Set the shell process's file creation mask to MODE. If MODE begins with a digit, it is interpreted as an octal number; if not, it is interpreted as a symbolic mode mask similar to that accepted by the `chmod' command. If MODE is omitted, the current value of the mask is printed. If the `-S' option is supplied without a - MODE argument, the mask is printed in a symbolic format. + MODE argument, the mask is printed in a symbolic format. If the + `-p' option is supplied, and MODE is omitted, the output is in a + form that may be reused as input. The return status is zero if + the mode is successfully changed or if no MODE argument is + supplied, and non-zero otherwise. `unset' unset [-fv] [NAME] Each variable or function NAME is removed. If no options are supplied, or the `-v' option is given, each NAME refers to a shell variable. If the `-f' option is given, the NAMEs refer to shell - functions, and the function definition is removed. Read-only - variables and functions may not be unset. + functions, and the function definition is removed. Readonly + variables and functions may not be unset. The return status is + zero unless a NAME does not exist or is readonly. File: bashref.info, Node: Bourne Shell Variables, Next: Other Bourne Shell Features, Prev: Bourne Shell Builtins, Up: Bourne Shell Features @@ -1706,47 +2271,49 @@ Bourne Shell Variables Bash uses certain shell variables in the same way as the Bourne shell. In some cases, Bash assigns a default value to the variable. -`IFS' - A list of characters that separate fields; used when the shell - splits words as part of expansion. - -`PATH' - A colon-separated list of directories in which the shell looks for - commands. +`CDPATH' + A colon-separated list of directories used as a search path for + the `cd' builtin command. `HOME' The current user's home directory; the default for the `cd' builtin - command. - -`CDPATH' - A colon-separated list of directories used as a search path for - the `cd' command. + command. The value of this variable is also used by tilde + expansion (*note Tilde Expansion::.). -`MAILPATH' - A colon-separated list of files which the shell periodically checks - for new mail. You can also specify what message is printed by - separating the file name from the message with a `?'. When used - in the text of the message, `$_' stands for the name of the - current mailfile. +`IFS' + A list of characters that separate fields; used when the shell + splits words as part of expansion. `MAIL' If this parameter is set to a filename and the `MAILPATH' variable is not set, Bash informs the user of the arrival of mail in the specified file. +`MAILPATH' + A colon-separated list of filenames which the shell periodically + checks for new mail. Each list entry can specify the message that + is printed when new mail arrives in the mail file by separating + the file name from the message with a `?'. When used in the text + of the message, `$_' expands to the name of the current mail file. + +`OPTARG' + The value of the last option argument processed by the `getopts' + builtin. + +`OPTIND' + The index of the last option argument processed by the `getopts' + builtin. + +`PATH' + A colon-separated list of directories in which the shell looks for + commands. + `PS1' The primary prompt string. The default value is `\s-\v\$ '. `PS2' The secondary prompt string. The default value is `> '. -`OPTIND' - The index of the last option processed by the `getopts' builtin. - -`OPTARG' - The value of the last option argument processed by the `getopts' - builtin. - File: bashref.info, Node: Other Bourne Shell Features, Prev: Bourne Shell Variables, Up: Bourne Shell Features @@ -1762,9 +2329,9 @@ Other Bourne Shell Features expansion, redirection, and quoting as the Bourne Shell. Bash uses the POSIX 1003.2 standard as the specification of how these features are to be implemented. There are some differences between the traditional -Bourne shell and the POSIX standard; this section quickly details the -differences of significance. A number of these differences are -explained in greater depth in subsequent sections. +Bourne shell and Bash; this section quickly details the differences of +significance. A number of these differences are explained in greater +depth in subsequent sections. File: bashref.info, Node: Major Differences From The Bourne Shell, Up: Other Bourne Shell Features @@ -1772,202 +2339,233 @@ File: bashref.info, Node: Major Differences From The Bourne Shell, Up: Other B Major Differences From The SVR4.2 Bourne Shell ---------------------------------------------- - Bash is POSIX-conformant, even where the POSIX specification differs -from traditional `sh' behavior. + * Bash is POSIX-conformant, even where the POSIX specification + differs from traditional `sh' behavior. - Bash has multi-character invocation options (*note Invoking Bash::.). + * Bash has multi-character invocation options (*note Invoking + Bash::.). - Bash has command-line editing (*note Command Line Editing::.) and -the `bind' builtin. + * Bash has command-line editing (*note Command Line Editing::.) and + the `bind' builtin. - Bash has command history (*note Bash History Facilities::.) and the -`history' and `fc' builtins to manipulate it. + * Bash has command history (*note Bash History Facilities::.) and the + `history' and `fc' builtins to manipulate it. - Bash implements `csh'-like history expansion (*note History -Interaction::.). + * Bash implements `csh'-like history expansion (*note History + Interaction::.). - Bash has one-dimensional array variables (*note Arrays::.), and the -appropriate variable expansions and assignment syntax to use them. -Some of the Bash builtins take options to act on arrays. Bash provides -some built-in array variables. + * Bash has one-dimensional array variables (*note Arrays::.), and the + appropriate variable expansions and assignment syntax to use them. + Several of the Bash builtins take options to act on arrays. Bash + provides a number of built-in array variables. - Bash implements the `!' keyword to negate the return value of a -pipeline (*note Pipelines::.). Very useful when an `if' statement -needs to act only if a test fails. + * The `$'...'' quoting syntax, which expands ANSI-C + backslash-escaped characters in the text between the single quotes, + is supported (*note ANSI-C Quoting::.). - Bash includes the `select' compound command, which allows the -generation of simple menus (*note Korn Shell Constructs::.). + * Bash supports the `$"..."' quoting syntax to do locale-specific + translation of the characters between the double quotes. The + `-D', `--dump-strings', and `--dump-po-strings' invocation options + list the translatable strings found in a script (*note Locale + Translation::.). - Bash includes brace expansion (*note Brace Expansion::.) and tilde -expansion (*note Tilde Expansion::.). + * Bash implements the `!' keyword to negate the return value of a + pipeline (*note Pipelines::.). Very useful when an `if' statement + needs to act only if a test fails. - Bash implements command aliases and the `alias' and `unalias' -builtins (*note Aliases::.). + * Bash has the `time' reserved word and command timing (*note + Pipelines::.). The display of the timing statistics may be + controlled with the `TIMEFORMAT' variable. - Bash provides shell arithmetic and arithmetic expansion (*note Shell -Arithmetic::.). + * Bash includes the `select' compound command, which allows the + generation of simple menus (*note Conditional Constructs::.). - The POSIX and `ksh'-style `$()' form of command substitution is -implemented (*note Command Substitution::.), and preferred to the -Bourne shell's ```' (which is also implemented for backwards -compatibility). + * Bash includes the `[[' compound command, which makes conditional + testing part of the shell grammar (*note Conditional + Constructs::.). - Variables present in the shell's initial environment are -automatically exported to child processes. The Bourne shell does not -normally do this unless the variables are explicitly marked using the -`export' command. + * Bash includes brace expansion (*note Brace Expansion::.) and tilde + expansion (*note Tilde Expansion::.). - Bash includes the POSIX and `ksh'-style pattern removal `%', `#', -`%%' and `##' constructs to remove leading or trailing substrings from -variable values (*note Shell Parameter Expansion::.). + * Bash implements command aliases and the `alias' and `unalias' + builtins (*note Aliases::.). - The expansion `${#xx}', which returns the length of `$xx', is -supported (*note Shell Parameter Expansion::.). + * Bash provides shell arithmetic, the `((' compound command (*note + Conditional Constructs::.), and arithmetic expansion (*note Shell + Arithmetic::.). - The `$'...'' quoting syntax, which expands ANSI-C backslash-escaped -characters in the text between the single quotes, is supported (*note -ANSI-C Quoting::.). + * Variables present in the shell's initial environment are + automatically exported to child processes. The Bourne shell does + not normally do this unless the variables are explicitly marked + using the `export' command. - Bash supports the `$"..."' quoting syntax to do locale-specific -translation of the characters between the double quotes. The `-D' and -`--dump-strings' invocation options list the translatable strings found -in a script (*note Locale Translation::.). + * Bash includes the POSIX pattern removal `%', `#', `%%' and `##' + expansions to remove leading or trailing substrings from variable + values (*note Shell Parameter Expansion::.). - The expansion `${var:'OFFSET`[:'LENGTH`]}', which expands to the -substring of `var''s value of length LENGTH, optionally beginning at -OFFSET, is present (*note Shell Parameter Expansion::.). + * The expansion `${#xx}', which returns the length of `${xx}', is + supported (*note Shell Parameter Expansion::.). - The expansion `${var/[/]'PATTERN`[/'REPLACEMENT`]}', which matches -PATTERN and replaces it with REPLACEMENT in the value of `var', is -available (*note Shell Parameter Expansion::.). + * The expansion `${var:'OFFSET`[:'LENGTH`]}', which expands to the + substring of `var''s value of length LENGTH, beginning at OFFSET, + is present (*note Shell Parameter Expansion::.). - Bash has INDIRECT variable expansion using `${!word}' (*note Shell -Parameter Expansion::.). + * The expansion `${var/[/]'PATTERN`[/'REPLACEMENT`]}', which matches + PATTERN and replaces it with REPLACEMENT in the value of `var', is + available (*note Shell Parameter Expansion::.). - Bash can expand positional parameters beyond `$9' using `${NUM}'. + * Bash has INDIRECT variable expansion using `${!word}' (*note Shell + Parameter Expansion::.). - Bash has process substitution (*note Process Substitution::.). + * Bash can expand positional parameters beyond `$9' using `${NUM}'. - Bash automatically assigns variables that provide information about -the current user (`UID', `EUID', and `GROUPS'), the current host -(`HOSTTYPE', `OSTYPE', `MACHTYPE', and `HOSTNAME'), and the instance of -Bash that is running (`BASH', `BASH_VERSION', and `BASH_VERSINFO'. -*Note Bash Variables::, for details. + * The POSIX `$()' form of command substitution is implemented (*note + Command Substitution::.), and preferred to the Bourne shell's ```' + (which is also implemented for backwards compatibility). - The `IFS' variable is used to split only the results of expansion, -not all words (*note Word Splitting::.). This closes a longstanding -shell security hole. + * Bash has process substitution (*note Process Substitution::.). - It is possible to have a variable and a function with the same name; -`sh' does not separate the two name spaces. + * Bash automatically assigns variables that provide information + about the current user (`UID', `EUID', and `GROUPS'), the current + host (`HOSTTYPE', `OSTYPE', `MACHTYPE', and `HOSTNAME'), and the + instance of Bash that is running (`BASH', `BASH_VERSION', and + `BASH_VERSINFO'). *Note Bash Variables::, for details. - Bash functions are permitted to have local variables using the -`local' builtin, and thus useful recursive functions may be written. + * The `IFS' variable is used to split only the results of expansion, + not all words (*note Word Splitting::.). This closes a + longstanding shell security hole. - Variable assignments preceding commands affect only that command, -even builtins and functions (*note Environment::.). In `sh', all -variable assignments preceding commands are global unless the command -is executed from the file system. + * Bash implements the full set of POSIX.2 filename expansion + operators, including CHARACTER CLASSES, EQUIVALENCE CLASSES, and + COLLATING SYMBOLS (*note Filename Expansion::.). - Bash performs filename expansion on filenames specified as operands -to output redirection operators. + * Bash implements extended pattern matching features when the + `extglob' shell option is enabled (*note Pattern Matching::.). - Bash contains the `<>' redirection operator, allowing a file to be -opened for both reading and writing, and the `&>' redirection operator, -for directing standard output and standard error to the same file -(*note Redirections::.). + * It is possible to have a variable and a function with the same + name; `sh' does not separate the two name spaces. - The `noclobber' option is available to avoid overwriting existing -files with output redirection (*note The Set Builtin::.). The `>|' -redirection operator may be used to override `noclobber'. + * Bash functions are permitted to have local variables using the + `local' builtin, and thus useful recursive functions may be + written. - Bash interprets special backslash-escaped characters in the prompt -strings when interactive (*note Printing a Prompt::.). + * Variable assignments preceding commands affect only that command, + even builtins and functions (*note Environment::.). In `sh', all + variable assignments preceding commands are global unless the + command is executed from the file system. - Bash allows you to write a function to override a builtin, and -provides access to that builtin's functionality within the function via -the `builtin' and `command' builtins (*note Bash Builtins::.). + * Bash performs filename expansion on filenames specified as operands + to input and output redirection operators. - The `command' builtin allows selective disabling of functions when -command lookup is performed (*note Bash Builtins::.). + * Bash contains the `<>' redirection operator, allowing a file to be + opened for both reading and writing, and the `&>' redirection + operator, for directing standard output and standard error to the + same file (*note Redirections::.). - Individual builtins may be enabled or disabled using the `enable' -builtin (*note Bash Builtins::.). + * The `noclobber' option is available to avoid overwriting existing + files with output redirection (*note The Set Builtin::.). The + `>|' redirection operator may be used to override `noclobber'. - The Bash `hash' builtin allows a name to be associated with an -arbitrary filename, even when that filename cannot be found by -searching the `$PATH', using `hash -p'. + * The Bash `cd' and `pwd' builtins (*note Bourne Shell Builtins::.) + each take `-L' and `-P' builtins to switch between logical and + physical modes. - Shell functions may be exported to children via the environment -(*note Shell Functions::.). + * Bash allows a function to override a builtin with the same name, + and provides access to that builtin's functionality within the + function via the `builtin' and `command' builtins (*note Bash + Builtins::.). - Bash includes a `help' builtin for quick reference to shell -facilities (*note Bash Builtins::.). + * The `command' builtin allows selective disabling of functions when + command lookup is performed (*note Bash Builtins::.). - The Bash `read' builtin (*note Bash Builtins::.) will read a line -ending in `\' with the `-r' option, and will use the `REPLY' variable -as a default if no arguments are supplied. The Bash `read' builtin -also accepts a prompt string with the `-p' option and will use Readline -to obtain the line when given the `-e' option. + * Individual builtins may be enabled or disabled using the `enable' + builtin (*note Bash Builtins::.). - Bash includes the `shopt' builtin, for finer control of shell -optional capabilities (*note Bash Builtins::.). + * The Bash `exec' builtin takes additional options that allow users + to control the contents of the environment passed to the executed + command, and what the zeroth argument to the command is to be + (*note Bourne Shell Builtins::.). - Bash has much more optional behavior controllable with the `set' -builtin (*note The Set Builtin::.). + * Shell functions may be exported to children via the environment + using `export -f' (*note Shell Functions::.). - The `disown' builtin can remove a job from the internal shell job -table (*note Job Control Builtins::.). + * The Bash `export', `readonly', and `declare' builtins can take a + `-f' option to act on shell functions, a `-p' option to display + variables with various attributes set in a format that can be used + as shell input, a `-n' option to remove various variable + attributes, and `name=value' arguments to set variable attributes + and values simultaneously. - The `return' builtin may be used to abort execution of scripts -executed with the `.' or `source' builtins (*note Bourne Shell -Builtins::.). + * The Bash `hash' builtin allows a name to be associated with an + arbitrary filename, even when that filename cannot be found by + searching the `$PATH', using `hash -p' (*note Bourne Shell + Builtins::.). + + * Bash includes a `help' builtin for quick reference to shell + facilities (*note Bash Builtins::.). + + * The `printf' builtin is available to display formatted output + (*note Bash Builtins::.). + + * The Bash `read' builtin (*note Bash Builtins::.) will read a line + ending in `\' with the `-r' option, and will use the `REPLY' + variable as a default if no arguments are supplied. The Bash + `read' builtin also accepts a prompt string with the `-p' option + and will use Readline to obtain the line when given the `-e' + option. - The `test' builtin (*note Bourne Shell Builtins::.) is slightly -different, as it implements the POSIX 1003.2 algorithm, which specifies -the behavior based on the number of arguments. + * The `return' builtin may be used to abort execution of scripts + executed with the `.' or `source' builtins (*note Bourne Shell + Builtins::.). - The `trap' builtin (*note Bourne Shell Builtins::.) allows a `DEBUG' -pseudo-signal specification, similar to `EXIT'. Commands specified -with a `DEBUG' trap are executed after every simple command. The -`DEBUG' trap is not inherited by shell functions. + * Bash includes the `shopt' builtin, for finer control of shell + optional capabilities (*note Bash Builtins::.). - The Bash `export', `readonly', and `declare' builtins can take a -`-f' option to act on shell functions, a `-p' option to display -variables with various attributes set in a format that can be used as -shell input, a `-n' option to remove various variable attributes, and -`name=value' arguments to set variable attributes and values -simultaneously. + * Bash has much more optional behavior controllable with the `set' + builtin (*note The Set Builtin::.). - The Bash `cd' and `pwd' builtins (*note Bourne Shell Builtins::.) -each take `-L' and `-P' builtins to switch between logical and physical -modes. + * The `test' builtin (*note Bourne Shell Builtins::.) is slightly + different, as it implements the POSIX algorithm, which specifies + the behavior based on the number of arguments. - The Bash `type' builtin is more extensive and gives more information -about the names it finds (*note Bash Builtins::.). + * The `trap' builtin (*note Bourne Shell Builtins::.) allows a + `DEBUG' pseudo-signal specification, similar to `EXIT'. Commands + specified with a `DEBUG' trap are executed after every simple + command. The `DEBUG' trap is not inherited by shell functions. - Bash implements a `csh'-like directory stack, and provides the -`pushd', `popd', and `dirs' builtins to manipulate it (*note C Shell -Builtins::.). Bash also makes the directory stack visible as the value -of the `DIRSTACK' shell variable. + * The Bash `type' builtin is more extensive and gives more + information about the names it finds (*note Bash Builtins::.). - The Bash restricted mode is more useful (*note The Restricted -Shell::.); the SVR4.2 shell restricted mode is too limited. + * The Bash `umask' builtin permits a `-p' option to cause the output + to be displayed in the form of a `umask' command that may be + reused as input (*note Bourne Shell Builtins::.). - Bash has the `time' reserved word and command timing (*note -Pipelines::.). The display of the timing statistics may be controlled -with the `TIMEFORMAT' variable. + * Bash implements a `csh'-like directory stack, and provides the + `pushd', `popd', and `dirs' builtins to manipulate it (*note The + Directory Stack::.). Bash also makes the directory stack visible + as the value of the `DIRSTACK' shell variable. - The SVR4.2 shell has two privilege-related builtins (`mldmode' and -`priv') not present in Bash. + * Bash interprets special backslash-escaped characters in the prompt + strings when interactive (*note Printing a Prompt::.). - Bash does not have the `stop' or `newgrp' builtins. + * The Bash restricted mode is more useful (*note The Restricted + Shell::.); the SVR4.2 shell restricted mode is too limited. - Bash does not use the `SHACCT' variable or perform shell accounting. + * The `disown' builtin can remove a job from the internal shell job + table (*note Job Control Builtins::.) or suppress the sending of + `SIGHUP' to a job when the shell exits as the result of a `SIGHUP'. - The SVR4.2 `sh' uses a `TIMEOUT' variable like Bash uses `TMOUT'. + * The SVR4.2 shell has two privilege-related builtins (`mldmode' and + `priv') not present in Bash. - More features unique to Bash may be found in *Note Bash Features::. + * Bash does not have the `stop' or `newgrp' builtins. + + * Bash does not use the `SHACCT' variable or perform shell + accounting. + + * The SVR4.2 `sh' uses a `TIMEOUT' variable like Bash uses `TMOUT'. + +More features unique to Bash may be found in *Note Bash Features::. Implementation Differences From The SVR4.2 Shell ------------------------------------------------ @@ -1985,18 +2583,18 @@ from many of the limitations of the SVR4.2 shell. For instance: * The SVR4.2 shell uses a baroque memory management scheme based on trapping `SIGSEGV'. If the shell is started from a process with `SIGSEGV' blocked (e.g., by using the `system()' C library - function call), the shell misbehaves badly. + function call), it misbehaves badly. * In a questionable attempt at security, the SVR4.2 shell, when invoked without the `-p' option, will alter its real and effective UID and GID if they are less than some magic threshold value, commonly 100. This can lead to unexpected results. - * The SVR4.2 shell does not allow users to trap `SIGALRM' or - `SIGCHLD'. + * The SVR4.2 shell does not allow users to trap `SIGSEGV', + `SIGALRM', or `SIGCHLD'. - * For some reason, the SVR4.2 shell does not allow the `MAILCHECK' - variable to be unset. + * The SVR4.2 shell does not allow the `IFS', `MAILCHECK', `PATH', + `PS1', or `PS2' variables to be unset. * The SVR4.2 shell treats `^' as the undocumented equivalent of `|'. @@ -2013,470 +2611,7 @@ from many of the limitations of the SVR4.2 shell. For instance: turns on job control). -File: bashref.info, Node: Csh Features, Next: Korn Shell Features, Prev: Bourne Shell Features, Up: Top - -C-Shell Style Features -********************** - - The C-Shell ("`csh'") was created by Bill Joy at The University of -California at Berkeley. It is generally considered to have better -features for interactive use than the original Bourne shell. Some of -the `csh' features present in Bash include job control, history -expansion, `protected' redirection, and several variables to control -the interactive behaviour of the shell (e.g., `IGNOREEOF'). - - *Note Using History Interactively::, for details on history -expansion. - -* Menu: - -* Brace Expansion:: Expansion of expressions within braces. -* Tilde Expansion:: Expansion of the ~ character. -* C Shell Builtins:: Builtin commands adopted from the C Shell. -* C Shell Variables:: Variables which Bash uses in essentially - the same way as the C Shell. - - -File: bashref.info, Node: Brace Expansion, Next: Tilde Expansion, Up: Csh Features - -Brace Expansion -=============== - - Brace expansion is a mechanism by which arbitrary strings may be -generated. This mechanism is similar to FILENAME EXPANSION (*note -Filename Expansion::.), but the file names generated need not exist. -Patterns to be brace expanded take the form of an optional PREAMBLE, -followed by a series of comma-separated strings between a pair of -braces, followed by an optional POSTAMBLE. The preamble is prepended -to each string contained within the braces, and the postamble is then -appended to each resulting string, expanding left to right. - - Brace expansions may be nested. The results of each expanded string -are not sorted; left to right order is preserved. For example, - bash$ echo a{d,c,b}e - ade ace abe - - Brace expansion is performed before any other expansions, and any -characters special to other expansions are preserved in the result. It -is strictly textual. Bash does not apply any syntactic interpretation -to the context of the expansion or the text between the braces. - - A correctly-formed brace expansion must contain unquoted opening and -closing braces, and at least one unquoted comma. Any incorrectly -formed brace expansion is left unchanged. - - This construct is typically used as shorthand when the common prefix -of the strings to be generated is longer than in the above example: - mkdir /usr/local/src/bash/{old,new,dist,bugs} - or - chown root /usr/{ucb/{ex,edit},lib/{ex?.?*,how_ex}} - - -File: bashref.info, Node: Tilde Expansion, Next: C Shell Builtins, Prev: Brace Expansion, Up: Csh Features - -Tilde Expansion -=============== - - Bash has tilde (~) expansion, similar, but not identical, to that of -`csh'. The following table shows what unquoted words beginning with a -tilde expand to. - -`~' - The current value of `$HOME'. - -`~/foo' - `$HOME/foo' - -`~fred/foo' - The subdirectory `foo' of the home directory of the user `fred'. - -`~+/foo' - `$PWD/foo' - -`~-/foo' - `$OLDPWD/foo' - - Bash will also tilde expand words following redirection operators -and words following `=' in assignment statements. - - -File: bashref.info, Node: C Shell Builtins, Next: C Shell Variables, Prev: Tilde Expansion, Up: Csh Features - -C Shell Builtins -================ - - Bash has several builtin commands whose definition is very similar -to `csh'. - -`pushd' - pushd [DIR | +N | -N] [-n] - - Save the current directory on a list and then `cd' to DIR. With no - arguments, exchanges the top two directories. - - `+N' - Brings the Nth directory (counting from the left of the list - printed by `dirs', starting with zero) to the top of the list - by rotating the stack. - - `-N' - Brings the Nth directory (counting from the right of the list - printed by `dirs', starting with zero) to the top of the list - by rotating the stack. - - `-n' - Suppresses the normal change of directory when adding - directories to the stack, so that only the stack is - manipulated. - - `DIR' - Makes the current working directory be the top of the stack, - and then `cd's to DIR. You can see the saved directory list - with the `dirs' command. - -`popd' - popd [+N | -N] [-n] - - Pop the directory stack, and `cd' to the new top directory. When - no arguments are given, `popd' removes the top directory from the - stack and performs a `cd' to the new top directory. The elements - are numbered from 0 starting at the first directory listed with - `dirs'; i.e., `popd' is equivalent to `popd +0'. - `+N' - Removes the Nth directory (counting from the left of the list - printed by `dirs'), starting with zero. - - `-N' - Removes the Nth directory (counting from the right of the - list printed by `dirs'), starting with zero. - - `-n' - Suppresses the normal change of directory when removing - directories from the stack, so that only the stack is - manipulated. - -`dirs' - dirs [+N | -N] [-clvp] - Display the list of currently remembered directories. Directories - find their way onto the list with the `pushd' command; you can get - back up through the list with the `popd' command. - `+N' - Displays the Nth directory (counting from the left of the - list printed by `dirs' when invoked without options), starting - with zero. - - `-N' - Displays the Nth directory (counting from the right of the - list printed by `dirs' when invoked without options), starting - with zero. - - `-c' - Clears the directory stack by deleting all of the elements. - - `-l' - Produces a longer listing; the default listing format uses a - tilde to denote the home directory. - - `-p' - Causes `dirs' to print the directory stack with one entry per - line. - - `-v' - Causes `dirs' to print the directory stack with one entry per - line, prepending each entry with its index in the stack. - -`history' - history [-c] [N] - history [-anrw] [FILENAME] - history -ps ARG - - Display the history list with line numbers. Lines prefixed with - with a `*' have been modified. An argument of N says to list only - the last N lines. Options, if supplied, have the following - meanings: - - `-w' - Write out the current history to the history file. - - `-r' - Read the current history file and append its contents to the - history list. - - `-a' - Append the new history lines (history lines entered since the - beginning of the current Bash session) to the history file. - - `-n' - Append the history lines not already read from the history - file to the current history list. These are lines appended - to the history file since the beginning of the current Bash - session. - - `-c' - Clear the history list. This may be combined with the other - options to replace the history list completely. - - `-s' - The ARGs are added to the end of the history list as a single - entry. - - `-p' - Perform history substitution on the ARGs and display the - result on the standard output, without storing the results in - the history list. - - When the `-w', `-r', `-a', or `-n' option is used, if FILENAME is - given, then it is used as the history file. If not, then the - value of the `HISTFILE' variable is used. - -`logout' - Exit a login shell. - -`source' - A synonym for `.' (*note Bourne Shell Builtins::.). - - -File: bashref.info, Node: C Shell Variables, Prev: C Shell Builtins, Up: Csh Features - -C Shell Variables -================= - -`IGNOREEOF' - If this variable is set, its value is used the number of - consecutive `EOF's Bash will read before exiting. By default, - Bash will exit upon reading a single `EOF'. If `IGNOREEOF' is not - set to a numeric value, Bash acts as if its value were 10. - - -File: bashref.info, Node: Korn Shell Features, Next: Bash Features, Prev: Csh Features, Up: Top - -Korn Shell Style Features -************************* - - This section describes features primarily inspired by the Korn Shell -(`ksh'). In some cases, the POSIX 1003.2 standard has adopted these -commands and variables from the Korn Shell; Bash implements those -features using the POSIX standard as a guide. - -* Menu: - -* Korn Shell Constructs:: Shell grammar constructs adopted from the - Korn Shell -* Korn Shell Builtins:: Builtin commands adopted from the Korn Shell. -* Korn Shell Variables:: Variables which Bash uses in essentially - the same way as the Korn Shell. -* Aliases:: Substituting one command for another. - - -File: bashref.info, Node: Korn Shell Constructs, Next: Korn Shell Builtins, Up: Korn Shell Features - -Korn Shell Constructs -===================== - - Bash includes the Korn Shell `select' construct. This construct -allows the easy generation of menus. It has almost the same syntax as -the `for' command. - - The syntax of the `select' command is: - select NAME [in WORDS ...]; do COMMANDS; done - - The list of words following `in' is expanded, generating a list of -items. The set of expanded words is printed on the standard error, -each preceded by a number. If the `in WORDS' is omitted, the -positional parameters are printed. The `PS3' prompt is then displayed -and a line is read from the standard input. If the line consists of a -number corresponding to one of the displayed words, then the value of -NAME is set to that word. If the line is empty, the words and prompt -are displayed again. If `EOF' is read, the `select' command completes. -Any other value read causes NAME to be set to null. The line read is -saved in the variable `REPLY'. - - The COMMANDS are executed after each selection until a `break' or -`return' command is executed, at which point the `select' command -completes. - - Bash also has adopted command timing from the Korn shell. If the -`time' reserved word precedes a pipeline, which may consist of a single -command, timing statistics for the pipeline are displayed when it -completes. The statistics currently consist of elapsed (wall-clock) -time and user and system time consumed by the command's execution. - - The use of `time' as a reserved word permits the timing of shell -builtins, shell functions, and pipelines. An external `time' command -cannot time these easily. - - -File: bashref.info, Node: Korn Shell Builtins, Next: Korn Shell Variables, Prev: Korn Shell Constructs, Up: Korn Shell Features - -Korn Shell Builtins -=================== - - This section describes Bash builtin commands taken from `ksh'. - -`fc' - `fc [-e ENAME] [-nlr] [FIRST] [LAST]' - `fc -s [PAT=REP] [COMMAND]' - - Fix Command. In the first form, a range of commands from FIRST to - LAST is selected from the history list. Both FIRST and LAST may - be specified as a string (to locate the most recent command - beginning with that string) or as a number (an index into the - history list, where a negative number is used as an offset from the - current command number). If LAST is not specified it is set to - FIRST. If FIRST is not specified it is set to the previous - command for editing and -16 for listing. If the `-l' flag is - given, the commands are listed on standard output. The `-n' flag - suppresses the command numbers when listing. The `-r' flag - reverses the order of the listing. Otherwise, the editor given by - ENAME is invoked on a file containing those commands. If ENAME is - not given, the value of the following variable expansion is used: - `${FCEDIT:-${EDITOR:-vi}}'. This says to use the value of the - `FCEDIT' variable if set, or the value of the `EDITOR' variable if - that is set, or `vi' if neither is set. When editing is complete, - the edited commands are echoed and executed. - - In the second form, COMMAND is re-executed after each instance of - PAT in the selected command is replaced by REP. - - A useful alias to use with the `fc' command is `r='fc -s'', so - that typing `r cc' runs the last command beginning with `cc' and - typing `r' re-executes the last command (*note Aliases::.). - -`let' - The `let' builtin allows arithmetic to be performed on shell - variables. For details, refer to *Note Arithmetic Builtins::. - -`typeset' - The `typeset' command is supplied for compatibility with the Korn - shell; however, it has been deprecated in favor of the `declare' - command (*note Bash Builtins::.). - - -File: bashref.info, Node: Korn Shell Variables, Next: Aliases, Prev: Korn Shell Builtins, Up: Korn Shell Features - -Korn Shell Variables -==================== - -`REPLY' - The default variable for the `read' builtin. - -`RANDOM' - Each time this parameter is referenced, a random integer between 0 - and 32767 is generated. Assigning a value to this variable seeds - the random number generator. - -`SECONDS' - This variable expands to the number of seconds since the shell was - started. Assignment to this variable resets the count to the - value assigned, and the expanded value becomes the value assigned - plus the number of seconds since the assignment. - -`PS3' - The value of this variable is used as the prompt for the `select' - command. If this variable is not set, the `select' command - prompts with `#? ' - -`PS4' - This is the prompt printed before the command line is echoed when - the `-x' option is set (*note The Set Builtin::.). The default is - `+ '. - -`PWD' - The current working directory as set by the `cd' builtin. - -`OLDPWD' - The previous working directory as set by the `cd' builtin. - -`TMOUT' - If set to a value greater than zero, the value is interpreted as - the number of seconds to wait for input after issuing the primary - prompt. Bash terminates after that number of seconds if input does - not arrive. - -`LINENO' - The line number in the script or shell function currently - executing. - -`FCEDIT' - The editor used as a default by the `fc' builtin command. - - -File: bashref.info, Node: Aliases, Prev: Korn Shell Variables, Up: Korn Shell Features - -Aliases -======= - -* Menu: - -* Alias Builtins:: Builtins commands to maniuplate aliases. - - The shell maintains a list of ALIASES that may be set and unset with -the `alias' and `unalias' builtin commands. - - The first word of each command, if unquoted, is checked to see if it -has an alias. If so, that word is replaced by the text of the alias. -The alias name and the replacement text may contain any valid shell -input, including shell metacharacters, with the exception that the -alias name may not contain <=>. The first word of the replacement text -is tested for aliases, but a word that is identical to an alias being -expanded is not expanded a second time. This means that one may alias -`ls' to `"ls -F"', for instance, and Bash does not try to recursively -expand the replacement text. If the last character of the alias value -is a space or tab character, then the next command word following the -alias is also checked for alias expansion. - - Aliases are created and listed with the `alias' command, and removed -with the `unalias' command. - - There is no mechanism for using arguments in the replacement text, -as in `csh'. If arguments are needed, a shell function should be used -(*note Shell Functions::.). - - Aliases are not expanded when the shell is not interactive, unless -the `expand_aliases' shell option is set using `shopt' (*note Bash -Builtins::.). - - The rules concerning the definition and use of aliases are somewhat -confusing. Bash always reads at least one complete line of input -before executing any of the commands on that line. Aliases are -expanded when a command is read, not when it is executed. Therefore, an -alias definition appearing on the same line as another command does not -take effect until the next line of input is read. The commands -following the alias definition on that line are not affected by the new -alias. This behavior is also an issue when functions are executed. -Aliases are expanded when the function definition is read, not when the -function is executed, because a function definition is itself a -compound command. As a consequence, aliases defined in a function are -not available until after that function is executed. To be safe, -always put alias definitions on a separate line, and do not use `alias' -in compound commands. - - Note that for almost every purpose, aliases are superseded by shell -functions. - - -File: bashref.info, Node: Alias Builtins, Up: Aliases - -Alias Builtins --------------- - -`alias' - alias [`-p'] [NAME[=VALUE] ...] - - Without arguments or with the `-p' option, `alias' prints the list - of aliases on the standard output in a form that allows them to be - reused as input. If arguments are supplied, an alias is defined - for each NAME whose VALUE is given. If no VALUE is given, the name - and value of the alias is printed. - -`unalias' - unalias [-a] [NAME ... ] - - Remove each NAME from the list of aliases. If `-a' is supplied, - all aliases are removed. - - -File: bashref.info, Node: Bash Features, Next: Job Control, Prev: Korn Shell Features, Up: Top +File: bashref.info, Node: Bash Features, Next: Job Control, Prev: Bourne Shell Features, Up: Top Bash Features ************* @@ -2496,7 +2631,9 @@ Bash Features the `test' builtin. * Bash Variables:: List of variables that exist in Bash. * Shell Arithmetic:: Arithmetic on shell variables. -* Arrays:: Array Variables +* Aliases:: Substituting one command for another. +* Arrays:: Array Variables. +* The Directory Stack:: History of visited directories. * Printing a Prompt:: Controlling the PS1 string. * The Restricted Shell:: A more controlled mode of shell execution. * Bash POSIX Mode:: Making Bash behave more closely to what @@ -2517,6 +2654,10 @@ Invoking Bash that you can use. These options must appear on the command line before the single-character options in order for them to be recognized. +`--dump-po-strings' + Equivalent to `-D', but the output is in the GNU `gettext' PO + (portable object) file format. + `--dump-strings' Equivalent to `-D'. @@ -2526,8 +2667,8 @@ the single-character options in order for them to be recognized. `--login' Make this shell act as if it were directly invoked by login. This is equivalent to `exec -l bash' but can be issued from another - shell, such as `csh'. If you wanted to replace your current login - shell with a Bash login shell, you would say `exec bash --login'. + shell, such as `csh'. `exec bash --login' will replace the + current shell with a Bash login shell. `--noediting' Do not use the GNU Readline library (*note Command Line Editing::.) @@ -2564,8 +2705,8 @@ the single-character options in order for them to be recognized. Show version information for this instance of Bash on the standard output and exit successfully. - There are several single-character options you can give which are -not available with the `set' builtin. + There are several single-character options that may be supplied at +invocation which are not available with the `set' builtin. `-c STRING' Read and execute commands from STRING after processing the @@ -2576,10 +2717,10 @@ not available with the `set' builtin. Force the shell to run interactively. `-r' - Make the shell restricted. + Make the shell a restricted shell (*note The Restricted Shell::.). `-s' - If this flag is present, or if no arguments remain after option + If this option is present, or if no arguments remain after option processing, then commands are read from the standard input. This option allows the positional parameters to be set when invoking an interactive shell. @@ -2591,8 +2732,13 @@ not available with the `set' builtin. (*note Locale Translation::.). This implies the `-n' option; no commands will be executed. +`--' + A `--' signals the end of options and disables further option + processing. Any arguments after the `--' are treated as filenames + and arguments. + An *interactive* shell is one whose input and output are both -connected to terminals (as determined by `isatty()'), or one started +connected to terminals (as determined by `isatty(3)'), or one started with the `-i' option. If arguments remain after option processing, and neither the `-c' @@ -2652,10 +2798,10 @@ name. behavior of historical versions of `sh' as closely as possible, while conforming to the POSIX standard as well. - When invoked as a login shell, it first attempts to read and execute -commands from `/etc/profile' and `~/.profile', in that order. The -`--noprofile' option may be used to inhibit this behavior. When -invoked as an interactive shell with the name `sh', `bash' looks for + When invoked as an interactive login shell, it first attempts to read +and execute commands from `/etc/profile' and `~/.profile', in that +order. The `--noprofile' option may be used to inhibit this behavior. +When invoked as an interactive shell with the name `sh', Bash looks for the variable `ENV', expands its value if it is defined, and uses the expanded value as the name of a file to read and execute. Since a shell invoked as `sh' does not attempt to read and execute commands @@ -2668,16 +2814,16 @@ are read. When Bash is started in POSIX mode, as with the `--posix' command line option, it follows the POSIX standard for startup files. In this -mode, the `ENV' variable is expanded and commands are read and executed -from the file whose name is the expanded value. No other startup files -are read. This is done by interactive shells only. +mode, interactive shells expand the `ENV' variable and commands are +read and executed from the file whose name is the expanded value. No +other startup files are read. Bash attempts to determine when it is being run by the remote shell daemon, usually `rshd'. If Bash determines it is being run by rshd, it reads and executes commands from `~/.bashrc', if that file exists and is readable. It will not do this if invoked as `sh'. The `--norc' option may be used to inhibit this behavior, and the `--rcfile' option -may be used to force another file to be read, but rshd does not +may be used to force another file to be read, but `rshd' does not generally invoke the shell with those options or allow them to be specified. @@ -2691,10 +2837,9 @@ Is This Shell Interactive? whose input and output are both connected to terminals (as determined by `isatty(3)'), or one started with the `-i' option. - You may wish to determine within a startup script whether Bash is -running interactively or not. To do this, examine the variable `$PS1'; -it is unset in non-interactive shells, and set in interactive shells. -Thus: + To determine within a startup script whether Bash is running +interactively or not, examine the variable `$PS1'; it is unset in +non-interactive shells, and set in interactive shells. Thus: if [ -z "$PS1" ]; then echo This shell is not interactive @@ -2702,8 +2847,8 @@ Thus: echo This shell is interactive fi - Alternatively, you may test the value of the `-' special parameter. -It contains `i' when the shell is interactive. For example: + Alternatively, startup scripts may test the value of the `-' special +parameter. It contains `i' when the shell is interactive. For example: case "$-" in *i*) echo This shell is interactive ;; @@ -2720,7 +2865,8 @@ Bash Builtin Commands been extended in Bash. `bind' - bind [-m KEYMAP] [-lpsvPSV] [-q NAME] [-r KEYSEQ] + bind [-m KEYMAP] [-lpsvPSV] + bind [-m KEYMAP] [-q FUNCTION] [-u FUNCTION] [-r KEYSEQ] bind [-m KEYMAP] -f FILENAME bind [-m KEYMAP] KEYSEQ:FUNCTION-NAME @@ -2740,57 +2886,71 @@ been extended in Bash. `vi-command'; `emacs' is equivalent to `emacs-standard'. `-l' - List the names of all Readline functions + List the names of all Readline functions. `-p' Display Readline function names and bindings in such a way - that they can be re-read + that they can be re-read. `-P' - List current Readline function names and bindings + List current Readline function names and bindings. `-v' Display Readline variable names and values in such a way that - they can be re-read + they can be re-read. `-V' - List current Readline variable names and values + List current Readline variable names and values. `-s' Display Readline key sequences bound to macros and the - strings they output in such a way that they can be re-read + strings they output in such a way that they can be re-read. `-S' Display Readline key sequences bound to macros and the - strings they output + strings they output. `-f FILENAME' - Read key bindings from FILENAME + Read key bindings from FILENAME. - `-q' - Query about which keys invoke the named FUNCTION + `-q FUNCTION' + Query about which keys invoke the named FUNCTION. + + `-u FUNCTION' + Unbind all keys bound to the named FUNCTION. `-r KEYSEQ' - Remove any current binding for KEYSEQ + Remove any current binding for KEYSEQ. + + The return status is zero unless an invalid option is supplied or + an error occurs. `builtin' builtin [SHELL-BUILTIN [ARGS]] - Run a shell builtin. This is useful when you wish to define a - shell function with the same name as a shell builtin, but need the - functionality of the builtin within the function itself. + Run a shell builtin, passing it ARGS, and return its exit status. + This is useful when defining a shell function with the same name + as a shell builtin, retaining the functionality of the builtin + within the function. The return status is non-zero if + SHELL-BUILTIN is not a shell builtin command. `command' - command [-pVv] COMMAND [ARGS ...] - Runs COMMAND with ARG ignoring shell functions. If you have a - shell function called `ls', and you wish to call the command `ls', - you can say `command ls'. The `-p' option means to use a default - value for `$PATH' that is guaranteed to find all of the standard - utilities. + command [-pVv] COMMAND [ARGUMENTS ...] + Runs COMMAND with ARGUMENTS ignoring any shell function named + COMMAND. Only shell builtin commands or commands found by + searching the `PATH' are executed. If there is a shell function + named `ls', running `command ls' within the function will execute + the external command `ls' instead of calling the function + recursively. The `-p' option means to use a default value for + `$PATH' that is guaranteed to find all of the standard utilities. + The return status in this case is 127 if COMMAND cannot be found + or an error occurred, and the exit status of COMMAND otherwise. If either the `-V' or `-v' option is supplied, a description of COMMAND is printed. The `-v' option causes a single word indicating the command or file name used to invoke COMMAND to be - printed; the `-V' option produces a more verbose description. + displayed; the `-V' option produces a more verbose description. + In this case, the return status is zero if COMMAND is found, and + non-zero if not. `declare' declare [-afFrxi] [-p] [NAME[=VALUE]] @@ -2818,7 +2978,7 @@ been extended in Bash. `-r' Make NAMEs readonly. These names cannot then be assigned - values by subsequent assignment statements. + values by subsequent assignment statements or unset. `-x' Mark each NAME for export to subsequent commands via the @@ -2828,11 +2988,21 @@ been extended in Bash. used in a function, `declare' makes each NAME local, as with the `local' command. + The return status is zero unless an invalid option is encountered, + an attempt is made to define a function using `-f foo=bar', an + attempt is made to assign a value to a readonly variable, an + attempt is made to assign a value to an array variable without + using the compound assignment syntax (*note Arrays::.), one of the + NAMES is not a valid shell variable name, an attempt is made to + turn off readonly status for a readonly variable, an attempt is + made to turn off array status for an array variable, or an attempt + is made to display a non-existent function with `-f'. + `echo' - echo [-neE] [arg ...] - Output the `arg's, separated by spaces, terminated with a newline. - The return status is always 0. If `-n' is specified, the - trailing newline is suppressed. If the `-e' option is given, + echo [-neE] [ARG ...] + Output the ARGs, separated by spaces, terminated with a newline. + The return status is always 0. If `-n' is specified, the trailing + newline is suppressed. If the `-e' option is given, interpretation of the following backslash-escaped characters is enabled. The `-E' option disables the interpretation of these escape characters, even on systems where they are interpreted by @@ -2867,13 +3037,20 @@ been extended in Bash. `\\' backslash - `\nnn' - the character whose ASCII code is `nnn' (octal) + `\NNN' + the character whose `ASCII' code is the octal value NNN (one + to three digits) + + `\xNNN' + the character whose `ASCII' code is the hexadecimal value NNN + (one to three digits) `enable' enable [-n] [-p] [-f FILENAME] [-ads] [NAME ...] - Enable and disable builtin shell commands. This allows you to use - a disk command which has the same name as a shell builtin. If + Enable and disable builtin shell commands. Disabling a builtin + allows a disk command which has the same name as a shell builtin + to be executed with specifying a full pathname, even though the + shell normally searches for builtins before disk commands. If `-n' is used, the NAMEs become disabled. Otherwise NAMEs are enabled. For example, to use the `test' binary found via `$PATH' instead of the shell builtin version, type `enable -n test'. @@ -2886,39 +3063,73 @@ been extended in Bash. The `-f' option means to load the new builtin command NAME from shared object FILENAME, on systems that support dynamic loading. - The `-d' option will delete a builtin loaded with `-f'. If there - are no options, a list of the shell builtins is displayed. The - `-s' option restricts `enable' to the POSIX.2 special builtins. + The `-d' option will delete a builtin loaded with `-f'. + + If there are no options, a list of the shell builtins is displayed. + The `-s' option restricts `enable' to the POSIX special builtins. If `-s' is used with `-f', the new builtin becomes a special builtin. + The return status is zero unless a NAME is not a shell builtin or + there is an error loading a new builtin from a shared object. + `help' help [PATTERN] Display helpful information about builtin commands. If PATTERN is specified, `help' gives detailed help on all commands matching - PATTERN, otherwise a list of the builtins is printed. + PATTERN, otherwise a list of the builtins is printed. The return + status is zero unless no command matches PATTERN. + +`let' + let EXPRESSION [EXPRESSION] + The `let' builtin allows arithmetic to be performed on shell + variables. Each EXPRESSION is evaluated according to the rules + given below in *Note Shell Arithmetic::. If the last EXPRESSION + evaluates to 0, `let' returns 1; otherwise 0 is returned. `local' local NAME[=VALUE] - For each argument, create a local variable called NAME, and give - it VALUE. `local' can only be used within a function; it makes - the variable NAME have a visible scope restricted to that function - and its children. + For each argument, a local variable named NAME is created, and + assigned VALUE. `local' can only be used within a function; it + makes the variable NAME have a visible scope restricted to that + function and its children. The return status is zero unless + `local' is used outside a function or an invalid NAME is supplied. `logout' logout [N] Exit a login shell, returning a status of N to the shell's parent. +`printf' + `printf' FORMAT [ARGUMENTS] + Write the formatted ARGUMENTS to the standard output under the + control of the FORMAT. The FORMAT is a character string which + contains three types of objects: plain characters, which are + simply copied to standard output, character escape sequences, + which are converted and copied to the standard output, and format + specifications, each of which causes printing of the next + successive ARGUMENT. In addition to the standard `printf(1)' + formats, `%b' causes `printf' to expand backslash escape sequences + in the corresponding ARGUMENT, and `%q' causes `printf' to output + the corresponding ARGUMENT in a format that can be reused as shell + input. + + The FORMAT is reused as necessary to consume all of the ARGUMENTS. + If the FORMAT requires more ARGUMENTS than are supplied, the extra + format specifications behave as if a zero value or null string, as + appropriate, had been supplied. + `read' read [-a ANAME] [-p PROMPT] [-er] [NAME ...] One line is read from the standard input, and the first word is assigned to the first NAME, the second word to the second NAME, - and so on, with leftover words assigned to the last NAME. Only - the characters in the value of the `IFS' variable are recognized - as word delimiters. If no names are supplied, the line read is - assigned to the variable `REPLY'. The return code is zero, unless - end-of-file is encountered. Options, if supplied, have the - following meanings: + and so on, with leftover words and their intervening separators + assigned to the last NAME. If there are fewer words read from the + standard input than names, the remaining names are assigned empty + values. The characters in the value of the `IFS' variable are + used to split the line into words. If no names are supplied, the + line read is assigned to the variable `REPLY'. The return code is + zero, unless end-of-file is encountered. Options, if supplied, + have the following meanings: `-r' If this option is given, a backslash-newline pair is not @@ -2926,13 +3137,15 @@ been extended in Bash. line. `-p PROMPT' - Display `prompt', without a trailing newline, before - attempting to read any input. The prompt is displayed only - if input is coming from a terminal. + Display PROMPT, without a trailing newline, before attempting + to read any input. The prompt is displayed only if input is + coming from a terminal. `-a ANAME' The words are assigned to sequential indices of the array - variable ANAME, starting at 0. + variable ANAME, starting at 0. All elements are removed from + ANAME before the assignment. Other NAME arguments are + ignored. `-e' Readline (*note Command Line Editing::.) is used to obtain @@ -2943,10 +3156,11 @@ been extended in Bash. Toggle the values of variables controlling optional shell behavior. With no options, or with the `-p' option, a list of all settable options is displayed, with an indication of whether or not each is - set. Other options have the following meanings: + set. The `-p' option causes output to be displayed in a form that + may be reused as input. Other options have the following meanings: `-s' - Enable (set) each OPTNAME + Enable (set) each OPTNAME. `-u' Disable (unset) each OPTNAME. @@ -2961,7 +3175,7 @@ been extended in Bash. Restricts the values of OPTNAME to be those defined for the `-o' option to the `set' builtin (*note The Set Builtin::.). - If either of `-s' or `-u' is used with no OPTNAME arguments, the + If either `-s' or `-u' is used with no OPTNAME arguments, the display is limited to those options which are set or unset, respectively. @@ -2970,7 +3184,7 @@ been extended in Bash. The return status when listing options is zero if all OPTNAMES are enabled, non-zero otherwise. When setting or unsetting options, - the return status is zero unless an OPTNAME is not a legal shell + the return status is zero unless an OPTNAME is not a valid shell option. The list of `shopt' options is: @@ -3011,6 +3225,15 @@ been extended in Bash. builtin command. An interactive shell does not exit if `exec' fails. + `expand_aliases' + If set, aliases are expanded as described below< under Aliases + (*note Aliases::.). This option is enabled by default for + interactive shells. + + `extglob' + If set, the extended pattern matching features described above + (*note Pattern Matching::.) are enabled. + `histappend' If set, the history list is appended to the file named by the value of the `HISTFILE' variable when the shell exits, rather @@ -3028,10 +3251,14 @@ been extended in Bash. `hostcomplete' If set, and Readline is being used, Bash will attempt to - perform hostname completion when a word beginning with `@' is + perform hostname completion when a word containing a `@' is being completed (*note Commands For Completion::.). This option is enabled by default. + `huponexit' + If set, Bash will send `SIGHUP' to all jobs when an + interactive login shell exits (*note Signals::.). + `interactive_comments' Allow a word beginning with `#' to cause that word and all remaining characters on that line to be ignored in an @@ -3047,6 +3274,10 @@ been extended in Bash. accessed since the last time it was checked, the message `"The mail in MAILFILE has been read"' is displayed. + `nocaseglob' + If set, Bash matches filenames in a case-insensitive fashion + when performing filename expansion. + `nullglob' If set, Bash allows filename patterns which match no files to expand to a null string, rather than themselves. @@ -3064,29 +3295,44 @@ been extended in Bash. `sourcepath' If set, the `source' builtin uses the value of `PATH' to find the directory containing the file supplied as an argument. - This is enabled by default. + This option is enabled by default. + + The return status when listing options is zero if all OPTNAMES are + enabled, non-zero otherwise. When setting or unsetting options, + the return status is zero unless an OPTNAME is not a valid shell + option. + +`source' + source FILENAME + A synonym for `.' (*note Bourne Shell Builtins::.). `type' - type [-all] [-type | -path] [NAME ...] + type [-atp] [NAME ...] For each NAME, indicate how it would be interpreted if used as a command name. - If the `-type' flag is used, `type' returns a single word which is + If the `-t' option is used, `type' prints a single word which is one of `alias', `function', `builtin', `file' or `keyword', if NAME is an alias, shell function, shell builtin, disk file, or shell reserved word, respectively. If the NAME is not found, then nothing is printed, and `type' returns a failure status. - If the `-path' flag is used, `type' either returns the name of the - disk file that would be executed, or nothing if `-type' would not + If the `-p' option is used, `type' either returns the name of the + disk file that would be executed, or nothing if `-t' would not return `file'. - If the `-all' flag is used, returns all of the places that contain - an executable named FILE. This includes aliases and functions, if - and only if the `-path' flag is not also used. + If the `-a' option is used, `type' returns all of the places that + contain an executable named FILE. This includes aliases and + functions, if and only if the `-p' option is not also used. - `type' accepts `-a', `-t', and `-p' as equivalent to `-all', - `-type', and `-path', respectively. + The return status is zero if any of the NAMES are found, non-zero + if none are found. + +`typeset' + typeset [-afFrxi] [-p] [NAME[=VALUE]] + The `typeset' command is supplied for compatibility with the Korn + shell; however, it has been deprecated in favor of the `declare' + builtin command. `ulimit' ulimit [-acdflmnpstuvSH] [LIMIT] @@ -3094,46 +3340,46 @@ been extended in Bash. started by the shell, on systems that allow such control. If an option is given, it is interpreted as follows: `-S' - change and report the soft limit associated with a resource. + Change and report the soft limit associated with a resource. `-H' - change and report the hard limit associated with a resource. + Change and report the hard limit associated with a resource. `-a' - all current limits are reported. + All current limits are reported. `-c' - the maximum size of core files created. + The maximum size of core files created. `-d' - the maximum size of a process's data segment. + The maximum size of a process's data segment. `-f' - the maximum size of files created by the shell. + The maximum size of files created by the shell. `-l' The maximum size that may be locked into memory. `-m' - the maximum resident set size. + The maximum resident set size. `-n' - the maximum number of open file descriptors. + The maximum number of open file descriptors. `-p' - the pipe buffer size. + The pipe buffer size. `-s' - the maximum stack size. + The maximum stack size. `-t' - the maximum amount of cpu time in seconds. + The maximum amount of cpu time in seconds. `-u' - the maximum number of processes available to a single user. + The maximum number of processes available to a single user. `-v' - the maximum amount of virtual memory available to the process. + The maximum amount of virtual memory available to the process. If LIMIT is given, it is the new value of the specified resource. Otherwise, the current value of the soft limit for the specified @@ -3144,16 +3390,27 @@ been extended in Bash. which is in seconds, `-p', which is in units of 512-byte blocks, and `-n' and `-u', which are unscaled values. + The return status is zero unless an invalid option is supplied, a + non-numeric argument other than `unlimited' is supplied as a + LIMIT, or an error occurs while setting a new limit. + File: bashref.info, Node: The Set Builtin, Next: Bash Conditional Expressions, Prev: Bash Builtins, Up: Bash Features The Set Builtin =============== - This builtin is so overloaded that it deserves its own section. + This builtin is so complicated that it deserves its own section. `set' - set [-abefhkmnptuvxdBCHP] [-o OPTION] [ARGUMENT ...] + set [--abefhkmnptuvxBCHP] [-o OPTION] [ARGUMENT ...] + + If no options or arguments are supplied, `set' displays the names + and values of all shell variables and functions, sorted according + to the current locale, in a format that may be reused as input. + + When options are supplied, they set or unset shell attributes. + Options, if specified, have the following meanings: `-a' Mark variables which are modified or created for export. @@ -3164,15 +3421,18 @@ The Set Builtin prompt. `-e' - Exit immediately if a simple command exits with a non-zero - status. + Exit immediately if a simple command (*note Simple + Commands::.) exits with a non-zero status, unless the command + that fails is part of an `until' or `while' loop, part of an + `if' statement, part of a `&&' or `||' list, or if the + command's return status is being inverted using `!'. `-f' Disable file name generation (globbing). `-h' Locate and remember (hash) commands as they are looked up for - execution. + execution. This option is enabled by default. `-k' All arguments in the form of assignment statements are placed @@ -3183,29 +3443,31 @@ The Set Builtin Job control is enabled (*note Job Control::.). `-n' - Read commands but do not execute them. + Read commands but do not execute them; this may be used to + check a script for syntax errors. This option is ignored by + interactive shells. `-o OPTION-NAME' - Set the flag corresponding to OPTION-NAME: + Set the option corresponding to OPTION-NAME: `allexport' - same as `-a'. + Same as `-a'. `braceexpand' - same as `-B'. + Same as `-B'. `emacs' - use an `emacs'-style line editing interface (*note + Use an `emacs'-style line editing interface (*note Command Line Editing::.). `errexit' - same as `-e'. + Same as `-e'. `hashall' - same as `-h'. + Same as `-h'. `histexpand' - same as `-H'. + Same as `-H'. `history' Enable command history, as described in *Note Bash @@ -3213,84 +3475,91 @@ The Set Builtin interactive shells. `ignoreeof' - the shell will not exit upon reading EOF. + An interactive shell will not exit upon reading EOF. `keyword' - same as `-k'. + Same as `-k'. `monitor' - same as `-m'. + Same as `-m'. `noclobber' - same as `-C'. + Same as `-C'. `noexec' - same as `-n'. + Same as `-n'. `noglob' - same as `-f'. + Same as `-f'. `notify' - same as `-b'. + Same as `-b'. `nounset' - same as `-u'. + Same as `-u'. `onecmd' - same as `-t'. + Same as `-t'. `physical' - same as `-P'. + Same as `-P'. `posix' - change the behavior of Bash where the default operation + Change the behavior of Bash where the default operation differs from the POSIX 1003.2 standard to match the - standard. This is intended to make Bash behave as a - strict superset of that standard. + standard (*note Bash POSIX Mode::.). This is intended + to make Bash behave as a strict superset of that + standard. `privileged' - same as `-p'. + Same as `-p'. `verbose' - same as `-v'. + Same as `-v'. `vi' - use a `vi'-style line editing interface. + Use a `vi'-style line editing interface. `xtrace' - same as `-x'. + Same as `-x'. `-p' - Turn on privileged mode. In this mode, the `$BASH_ENV' file - is not processed, and shell functions are not inherited from - the environment. This is enabled automatically on startup if - the effective user (group) id is not equal to the real user - (group) id. Turning this option off causes the effective user - and group ids to be set to the real user and group ids. + Turn on privileged mode. In this mode, the `$BASH_ENV' and + `$ENV' files are not processed, shell functions are not + inherited from the environment, and the `SHELLOPTS' variable, + if it appears in the environment, is ignored. This is + enabled automatically on startup if the effective user + (group) id is not equal to the real user (group) id. Turning + this option off causes the effective user and group ids to be + set to the real user and group ids. `-t' Exit after reading and executing one command. `-u' - Treat unset variables as an error when substituting. + Treat unset variables as an error when performing parameter + expansion. An error message will be written to the standard + error, and a non-interactive shell will exit. `-v' Print shell input lines as they are read. `-x' - Print commands and their arguments as they are executed. + Print a trace of simple commands and their arguments after + they are expanded and before they are executed. `-B' The shell will perform brace expansion (*note Brace Expansion::.). This option is on by default. `-C' - Disallow output redirection to existing files. + Prevent output redirection using `>', `>&', and `<>' from + overwriting existing files. `-H' Enable `!' style history substitution (*note History - Interaction::.). This flag is on by default for interactive - shells. + Interaction::.). This option is on by default for + interactive shells. `-P' If set, do not follow symbolic links when performing commands @@ -3299,7 +3568,8 @@ The Set Builtin the logical chain of directories when performing commands which change the current directory. - For example, if `/usr/sys' is a link to `/usr/local/sys' then: + For example, if `/usr/sys' is a symbolic link to + `/usr/local/sys' then: $ cd /usr/sys; echo $PWD /usr/sys $ cd ..; pwd @@ -3312,7 +3582,7 @@ The Set Builtin /usr/local `--' - If no arguments follow this flag, then the positional + If no arguments follow this option, then the positional parameters are unset. Otherwise, the positional parameters are set to the ARGUMENTS, even if some of them begin with a `-'. @@ -3323,13 +3593,16 @@ The Set Builtin options are turned off. If there are no arguments, the positional parameters remain unchanged. - Using `+' rather than `-' causes these flags to be turned off. - The flags can also be used upon invocation of the shell. The - current set of flags may be found in `$-'. + Using `+' rather than `-' causes these options to be turned off. + The options can also be used upon invocation of the shell. The + current set of options may be found in `$-'. The remaining N ARGUMENTS are positional parameters and are - assigned, in order, to `$1', `$2', ... `$N'. If no arguments are - given, all shell variables are printed. + assigned, in order, to `$1', `$2', ... `$N'. The special + parameter `#' is set to N. + + The return status is always zero unless an invalid option is + supplied. File: bashref.info, Node: Bash Conditional Expressions, Next: Bash Variables, Prev: The Set Builtin, Up: Bash Features @@ -3337,14 +3610,17 @@ File: bashref.info, Node: Bash Conditional Expressions, Next: Bash Variables, Bash Conditional Expressions ============================ - Conditional expressions are used by the `test' and `[' builtins. + Conditional expressions are used by the `[[' compound command and +the `test' and `[' builtin commands. Expressions may be unary or binary. Unary expressions are often used to examine the status of a file. There are string operators and -numeric comparison operators as well. Each operator and operand must -be a separate argument. If FILE is of the form `/dev/fd/N', then file -descriptor N is checked. Expressions are composed of the following -primaries: +numeric comparison operators as well. If any FILE argument to one of +the primaries is of the form `/dev/fd/N', then file descriptor N is +checked. + +`-a FILE' + True if FILE exists. `-b FILE' True if FILE exists and is a block special file. @@ -3362,16 +3638,13 @@ primaries: True if FILE exists and is a regular file. `-g FILE' - True if FILE exists and is set-group-id. + True if FILE exists and its set-group-id bit is set. `-k FILE' - True if FILE has its "sticky" bit set. - -`-L FILE' - True if FILE exists and is a symbolic link. + True if FILE exists and its "sticky" bit is set. `-p FILE' - True if FILE exists and is a named pipe. + True if FILE exists and is a named pipe (FIFO). `-r FILE' True if FILE exists and is readable. @@ -3379,11 +3652,8 @@ primaries: `-s FILE' True if FILE exists and has a size greater than zero. -`-S FILE' - True if FILE exists and is a socket. - `-t FD' - True if FD is opened on a terminal. + True if file descriptor FD is open and refers to a terminal. `-u FILE' True if FILE exists and its set-user-id bit is set. @@ -3400,6 +3670,15 @@ primaries: `-G FILE' True if FILE exists and is owned by the effective group id. +`-L FILE' + True if FILE exists and is a symbolic link. + +`-S FILE' + True if FILE exists and is a socket. + +`-N FILE' + True if FILE exists and has been modified since it was last read. + `FILE1 -nt FILE2' True if FILE1 is newer (according to modification date) than FILE2. @@ -3421,26 +3700,19 @@ primaries: `STRING' True if the length of STRING is non-zero. -`STRING1 = STRING2' - True if the strings are equal. `==' may be used in place of `='. +`STRING1 == STRING2' + True if the strings are equal. `=' may be used in place of `=='. `STRING1 != STRING2' True if the strings are not equal. `STRING1 < STRING2' - True if STRING1 sorts before STRING2 lexicographically. + True if STRING1 sorts before STRING2 lexicographically in the + current locale. `STRING1 > STRING2' - True if STRING1 sorts after STRING2 lexicographically. - -`! EXPR' - True if EXPR is false. - -`EXPR1 -a EXPR2' - True if both EXPR1 and EXPR2 are true. - -`EXPR1 -o EXPR2' - True if either EXPR1 and EXPR2 is true. + True if STRING1 sorts after STRING2 lexicographically in the + current locale. `ARG1 OP ARG2' `OP' is one of `-eq', `-ne', `-lt', `-le', `-gt', or `-ge'. These @@ -3449,44 +3721,6 @@ primaries: greater than or equal to ARG2, respectively. ARG1 and ARG2 may be positive or negative integers. - The Bash `test' and `[' builtins evaluate conditional expressions -using a set of rules based on the number of arguments. These are the -rules: - -0 arguments - The expression is false. - -1 argument - The expression is true if and only if the argument is not null. - -2 arguments - If the first argument is `!', the expression is true if and only - if the second argument is null. If the first argument is one of - the listed unary operators, the expression is true if the unary - test is true. If the first argument is not a legal unary - operator, the expression is false. - -3 arguments - If the first argument is `!', the value is the negation of the - two-argument test using the second and third arguments. If the - second argument is one of the binary operators, the result of the - expression is the result of the binary test using the first and - third arguments as operands. If the first argument is exactly `(' - and the third argument is exactly `)', the result is the - one-argument test of the second argument. Otherwise, the - expression is false. The `-a' and `-o' operators are considered - binary operators in this case. - -4 arguments - If the first argument is `!', the result is the negation of the - three-argument expression composed of the remaining arguments. - Otherwise, the expression is parsed and evaluated according to - precedence. `-a' has a higher precedence than `-o'. - -5 or more arguments - The expression is parsed and evaluated according to precedence, - with `-a' having a higher precedence than `-o'. - File: bashref.info, Node: Bash Variables, Next: Shell Arithmetic, Prev: Bash Conditional Expressions, Up: Bash Features @@ -3496,49 +3730,95 @@ Bash Variables These variables are set or used by Bash, but other shells do not normally treat them specially. +`BASH' + The full pathname used to execute the current instance of Bash. + `BASH_ENV' If this variable is set when Bash is invoked to execute a shell script, its value is expanded and used as the name of a startup file to read before executing the script. *Note Bash Startup Files::. -`TIMEFORMAT' - The value of this parameter is used as a format string specifying - how the timing information for pipelines prefixed with the `time' - reserved word should be displayed. The `%' character introduces an - escape sequence that is expanded to a time value or other - information. The escape sequences and their meanings are as - follows; the braces denote optional portions. +`BASH_VERSION' + The version number of the current instance of Bash. - `%%' - A literal `%'. +`BASH_VERSINFO' + A readonly array variable whose members hold version information + for this instance of Bash. The values assigned to the array + members are as follows: - `%[P][l]R' - The elapsed time in seconds. + `BASH_VERSINFO[0]' + The major version number (the RELEASE). - `%[P][l]U' - The number of CPU seconds spent in user mode. + `BASH_VERSINFO[1]' + The minor version number (the VERSION). - `%[P][l]S' - The number of CPU seconds spent in system mode. + `BASH_VERSINFO[2]' + The patch level. - `%P' - The CPU percentage, computed as (%U + %S) / %R. + `BASH_VERSINFO[3]' + The build version. - The optional P is a digit specifying the precision, the number of - fractional digits after a decimal point. A value of 0 causes no - decimal point or fraction to be output. At most three places - after the decimal point may be specified; values of P greater than - 3 are changed to 3. If P is not specified, the value 3 is used. + `BASH_VERSINFO[4]' + The release status (e.g., BETA1). - The optional `l' specifies a longer format, including minutes, of - the form MMmSS.FFs. The value of P determines whether or not the - fraction is included. + `BASH_VERSINFO[5]' + The value of `MACHTYPE'. - If this variable is not set, bash acts as if it had the value - `$'\nreal\t%3lR\nuser\t%3lU\nsys\t%3lS''. - If the value is null, no timing information is displayed. A - trailing newline is added when the format string is displayed. +`DIRSTACK' + An array variable (*note Arrays::.) containing the current + contents of the directory stack. Directories appear in the stack + in the order they are displayed by the `dirs' builtin. Assigning + to members of this array variable may be used to modify + directories already in the stack, but the `pushd' and `popd' + builtins must be used to add and remove directories. Assignment + to this variable will not change the current directory. If + `DIRSTACK' is unset, it loses its special properties, even if it + is subsequently reset. + +`EUID' + The numeric effective user id of the current user. This variable + is readonly. + +`FCEDIT' + The editor used as a default by the `-e' option to the `fc' + builtin command. + +`FIGNORE' + A colon-separated list of suffixes to ignore when performing + filename completion. A file name whose suffix matches one of the + entries in `FIGNORE' is excluded from the list of matched file + names. A sample value is `.o:~' + +`GLOBIGNORE' + A colon-separated list of patterns defining the set of filenames to + be ignored by filename expansion. If a filename matched by a + filename expansion pattern also matches one of the patterns in + `GLOBIGNORE', it is removed from the list of matches. + +`GROUPS' + An array variable containing the list of groups of which the + current user is a member. This variable is readonly. + +`histchars' + Up to three characters which control history expansion, quick + substitution, and tokenization (*note History Interaction::.). + The first character is the "history-expansion-char", that is, the + character which signifies the start of a history expansion, + normally `!'. The second character is the character which + signifies `quick substitution' when seen as the first character on + a line, normally `^'. The optional third character is the + character which indicates that the remainder of the line is a + comment when found as the first character of a word, usually `#'. + The history comment character causes history substitution to be + skipped for the remaining words on the line. It does not + necessarily cause the shell parser to treat the rest of the line + as a comment. + +`HISTCMD' + The history number, or index in the history list, of the current + command. If `HISTCMD' is unset, it loses its special properties, + even if it is subsequently reset. `HISTCONTROL' Set to a value of `ignorespace', it means don't enter lines which @@ -3546,7 +3826,9 @@ normally treat them specially. of `ignoredups', it means don't enter lines which match the last entered line. A value of `ignoreboth' combines the two options. Unset, or set to any other value than those above, means to save - all lines on the history list. + all lines on the history list. The second and subsequent lines of + a multi-line compound command are not tested, and are added to the + history regardless of the value of `HISTCONTROL'. `HISTIGNORE' A colon-separated list of patterns used to decide which command @@ -3557,7 +3839,9 @@ normally treat them specially. applied. In addition to the normal shell pattern matching characters, `&' matches the previous history line. `&' may be escaped using a backslash. The backslash is removed before - attempting a match. + attempting a match. The second and subsequent lines of a + multi-line compound command are not tested, and are added to the + history regardless of the value of `HISTIGNORE'. `HISTIGNORE' subsumes the function of `HISTCONTROL'. A pattern of `&' is identical to `ignoredups', and a pattern of `[ ]*' is @@ -3570,8 +3854,8 @@ normally treat them specially. default is `~/.bash_history'. `HISTSIZE' - If set, this is the maximum number of commands to remember in the - history. + The maximum number of commands to remember on the history list. + The default value is 500. `HISTFILESIZE' The maximum number of lines contained in the history file. When @@ -3580,26 +3864,6 @@ normally treat them specially. default value is 500. The history file is also truncated to this size after writing it when an interactive shell exits. -`histchars' - Up to three characters which control history expansion, quick - substitution, and tokenization (*note History Interaction::.). - The first character is the "history-expansion-char", that is, the - character which signifies the start of a history expansion, - normally `!'. The second character is the character which - signifies `quick substitution' when seen as the first character on - a line, normally `^'. The optional third character is the - character which signifies the remainder of the line is a comment, - when found as the first character of a word, usually `#'. The - history comment character causes history substitution to be - skipped for the remaining words on the line. It does not - necessarily cause the shell parser to treat the rest of the line - as a comment. - -`HISTCMD' - The history number, or index in the history list, of the current - command. If `HISTCMD' is unset, it loses its special properties, - even if it is subsequently reset. - `HOSTFILE' Contains the name of a file in the same format as `/etc/hosts' that should be read when the shell needs to complete a hostname. You @@ -3607,165 +3871,180 @@ normally treat them specially. complete a hostname, Bash will add the contents of the new file to the already existing database. -`MAILCHECK' - How often (in seconds) that the shell should check for mail in the - files specified in `MAILPATH'. +`HOSTNAME' + The name of the current host. -`PROMPT_COMMAND' - If present, this contains a string which is a command to execute - before the printing of each primary prompt (`$PS1'). +`HOSTTYPE' + A string describing the machine Bash is running on. -`UID' - The numeric real user id of the current user. +`IGNOREEOF' + Controls the action of the shell on receipt of an `EOF' character + as the sole input. If set, the value denotes the number of + consecutive `EOF' characters that can be read as the first + character on an input line before the shell will exit. If the + variable exists but does not have a numeric value (or has no + value) then the default is 10. If the variable does not exist, + then `EOF' signifies the end of input to the shell. This is only + in effect for interactive shells. -`EUID' - The numeric effective user id of the current user. +`INPUTRC' + The name of the Readline startup file, overriding the default of + `~/.inputrc'. -`GROUPS' - An array variable containing the list of groups of which the - current user is a member. +`LANG' + Used to determine the locale category for any category not + specifically selected with a variable starting with `LC_'. -`PPID' - The process id of the shell's parent process. +`LC_ALL' + This variable overrides the value of `LANG' and any other `LC_' + variable specifying a locale category. -`HOSTNAME' - The name of the current host. +`LC_COLLATE' + This variable determines the collation order used when sorting the + results of filename expansion, and determines the behavior of + range expressions, equivalence classes, and collating sequences + within filename expansion and pattern matching (*note Filename + Expansion::.). -`HOSTTYPE' - A string describing the machine Bash is running on. +`LC_CTYPE' + This variable determines the interpretation of characters and the + behavior of character classes within filename expansion and pattern + matching (*note Filename Expansion::.). -`OSTYPE' - A string describing the operating system Bash is running on. +`LC_MESSAGES' + This variable determines the locale used to translate double-quoted + strings preceded by a `$' (*note Locale Translation::.). + +`LINENO' + The line number in the script or shell function currently + executing. `MACHTYPE' A string that fully describes the system type on which Bash is executing, in the standard GNU CPU-COMPANY-SYSTEM format. -`SHELLOPTS' - A colon-separated list of enabled shell options. Each word in the - list is a valid argument for the `-o' option to the `set' builtin - command (*note The Set Builtin::.). The options appearing in - `SHELLOPTS' are those reported as `on' by `set -o'. If this - variable is in the environment when Bash starts up, each shell - option in the list will be enabled before reading any startup - files. This variable is readonly. +`MAILCHECK' + How often (in seconds) that the shell should check for mail in the + files specified in the `MAILPATH' or `MAIL' variables. -`FIGNORE' - A colon-separated list of suffixes to ignore when performing - filename completion. A file name whose suffix matches one of the - entries in `FIGNORE' is excluded from the list of matched file - names. A sample value is `.o:~' +`OLDPWD' + The previous working directory as set by the `cd' builtin. -`GLOBIGNORE' - A colon-separated list of patterns defining the set of filenames to - be ignored by filename expansion. If a filename matched by a - filename expansion pattern also matches one of the patterns in - `GLOBIGNORE', it is removed from the list of matches. +`OPTERR' + If set to the value 1, Bash displays error messages generated by + the `getopts' builtin command. -`DIRSTACK' - An array variable (*note Arrays::.) containing the current - contents of the directory stack. Directories appear in the stack - in the order they are displayed by the `dirs' builtin. Assigning - to members of this array variable may be used to modify - directories already in the stack, but the `pushd' and `popd' - builtins must be used to add and remove directories. Assignment - to this variable will not change the current directory. If - `DIRSTACK' is unset, it loses its special properties, even if it - is subsequently reset. +`OSTYPE' + A string describing the operating system Bash is running on. `PIPESTATUS' An array variable (*note Arrays::.) containing a list of exit status values from the processes in the most-recently-executed foreground pipeline (which may contain only a single command). -`INPUTRC' - The name of the Readline startup file, overriding the default of - `~/.inputrc'. - -`BASH' - The full filename used to execute the current instance of Bash. +`PPID' + The process id of the shell's parent process. This variable is + readonly. -`BASH_VERSION' - The version number of the current instance of Bash. +`PROMPT_COMMAND' + If present, this contains a string which is a command to execute + before the printing of each primary prompt (`$PS1'). -`BASH_VERSINFO' - An array variable whose members hold version information for this - instance of Bash. The values assigned to the array members are as - follows: +`PS3' + The value of this variable is used as the prompt for the `select' + command. If this variable is not set, the `select' command + prompts with `#? ' - `BASH_VERSINFO[0]' - The major version number (the RELEASE). +`PS4' + This is the prompt printed before the command line is echoed when + the `-x' option is set (*note The Set Builtin::.). The first + character of `PS4' is replicated multiple times, as necessary, to + indicate multiple levels of indirection. The default is `+ '. - `BASH_VERSINFO[1]' - The minor version number (the VERSION). +`PWD' + The current working directory as set by the `cd' builtin. - `BASH_VERSINFO[2]' - The patch level. +`RANDOM' + Each time this parameter is referenced, a random integer between 0 + and 32767 is generated. Assigning a value to this variable seeds + the random number generator. - `BASH_VERSINFO[3]' - The build version. +`REPLY' + The default variable for the `read' builtin. - `BASH_VERSINFO[4]' - The release status (e.g., BETA1). +`SECONDS' + This variable expands to the number of seconds since the shell was + started. Assignment to this variable resets the count to the + value assigned, and the expanded value becomes the value assigned + plus the number of seconds since the assignment. - `BASH_VERSINFO[5]' - The value of `MACHTYPE'. +`SHELLOPTS' + A colon-separated list of enabled shell options. Each word in the + list is a valid argument for the `-o' option to the `set' builtin + command (*note The Set Builtin::.). The options appearing in + `SHELLOPTS' are those reported as `on' by `set -o'. If this + variable is in the environment when Bash starts up, each shell + option in the list will be enabled before reading any startup + files. This variable is readonly. `SHLVL' Incremented by one each time a new instance of Bash is started. This is intended to be a count of how deeply your Bash shells are nested. -`OPTERR' - If set to the value 1, Bash displays error messages generated by - the `getopts' builtin command. +`TIMEFORMAT' + The value of this parameter is used as a format string specifying + how the timing information for pipelines prefixed with the `time' + reserved word should be displayed. The `%' character introduces an + escape sequence that is expanded to a time value or other + information. The escape sequences and their meanings are as + follows; the braces denote optional portions. -`LANG' - Used to determine the locale category for any category not - specifically selected with a variable starting with `LC_'. + `%%' + A literal `%'. -`LC_ALL' - This variable overrides the value of `LANG' and any other `LC_' - variable specifying a locale category. + `%[P][l]R' + The elapsed time in seconds. -`LC_COLLATE' - This variable determines the collation order used when sorting the - results of filename expansion (*note Filename Expansion::.). + `%[P][l]U' + The number of CPU seconds spent in user mode. -`LC_MESSAGES' - This variable determines the locale used to translate double-quoted - strings preceded by a `$' (*note Locale Translation::.). + `%[P][l]S' + The number of CPU seconds spent in system mode. -`IGNOREEOF' - Controls the action of the shell on receipt of an `EOF' character - as the sole input. If set, then the value of it is the number of - consecutive `EOF' characters that can be read as the first - character on an input line before the shell will exit. If the - variable exists but does not have a numeric value (or has no - value) then the default is 10. If the variable does not exist, - then `EOF' signifies the end of input to the shell. This is only - in effect for interactive shells. + `%P' + The CPU percentage, computed as (%U + %S) / %R. - -File: bashref.info, Node: Shell Arithmetic, Next: Arrays, Prev: Bash Variables, Up: Bash Features + The optional P is a digit specifying the precision, the number of + fractional digits after a decimal point. A value of 0 causes no + decimal point or fraction to be output. At most three places + after the decimal point may be specified; values of P greater than + 3 are changed to 3. If P is not specified, the value 3 is used. -Shell Arithmetic -================ + The optional `l' specifies a longer format, including minutes, of + the form MMmSS.FFs. The value of P determines whether or not the + fraction is included. -* Menu: + If this variable is not set, Bash acts as if it had the value + `$'\nreal\t%3lR\nuser\t%3lU\nsys\t%3lS'' + If the value is null, no timing information is displayed. A + trailing newline is added when the format string is displayed. -* Arithmetic Evaluation:: How shell arithmetic works. -* Arithmetic Expansion:: How to use arithmetic in shell expansions. -* Arithmetic Builtins:: Builtin commands that use shell arithmetic. +`TMOUT' + If set to a value greater than zero, the value is interpreted as + the number of seconds to wait for input after issuing the primary + prompt. Bash terminates after that number of seconds if input does + not arrive. - Bash includes several mechanisms to evaluate arithmetic expressions -and display the result or use it as part of a command. +`UID' + The numeric real user id of the current user. This variable is + readonly. -File: bashref.info, Node: Arithmetic Evaluation, Next: Arithmetic Expansion, Up: Shell Arithmetic +File: bashref.info, Node: Shell Arithmetic, Next: Aliases, Prev: Bash Variables, Up: Bash Features -Arithmetic Evaluation ---------------------- +Shell Arithmetic +================ The shell allows arithmetic expressions to be evaluated, as one of the shell expansions or by the `let' builtin. @@ -3781,6 +4060,9 @@ The levels are listed in order of decreasing precedence. `! ~' logical and bitwise negation +`**' + exponentiation + `* / %' multiplication, division, remainder @@ -3838,43 +4120,83 @@ parentheses are evaluated first and may override the precedence rules above. -File: bashref.info, Node: Arithmetic Expansion, Next: Arithmetic Builtins, Prev: Arithmetic Evaluation, Up: Shell Arithmetic +File: bashref.info, Node: Aliases, Next: Arrays, Prev: Shell Arithmetic, Up: Bash Features -Arithmetic Expansion --------------------- +Aliases +======= - Arithmetic expansion allows the evaluation of an arithmetic -expression and the substitution of the result. The format for -arithmetic expansion is: +* Menu: - $(( EXPRESSION )) +* Alias Builtins:: Builtins commands to maniuplate aliases. - The expression is treated as if it were within double quotes, but a -double quote inside the braces or parentheses is not treated specially. -All tokens in the expression undergo parameter expansion, command -substitution, and quote removal. Arithmetic substitutions may be -nested. + Aliases allow a string to be substituted for a word when it is used +as the first word of a simple command. The shell maintains a list of +ALIASES that may be set and unset with the `alias' and `unalias' +builtin commands. + + The first word of each simple command, if unquoted, is checked to see +if it has an alias. If so, that word is replaced by the text of the +alias. The alias name and the replacement text may contain any valid +shell input, including shell metacharacters, with the exception that +the alias name may not contain `='. The first word of the replacement +text is tested for aliases, but a word that is identical to an alias +being expanded is not expanded a second time. This means that one may +alias `ls' to `"ls -F"', for instance, and Bash does not try to +recursively expand the replacement text. If the last character of the +alias value is a space or tab character, then the next command word +following the alias is also checked for alias expansion. + + Aliases are created and listed with the `alias' command, and removed +with the `unalias' command. + + There is no mechanism for using arguments in the replacement text, +as in `csh'. If arguments are needed, a shell function should be used +(*note Shell Functions::.). + + Aliases are not expanded when the shell is not interactive, unless +the `expand_aliases' shell option is set using `shopt' (*note Bash +Builtins::.). + + The rules concerning the definition and use of aliases are somewhat +confusing. Bash always reads at least one complete line of input +before executing any of the commands on that line. Aliases are +expanded when a command is read, not when it is executed. Therefore, an +alias definition appearing on the same line as another command does not +take effect until the next line of input is read. The commands +following the alias definition on that line are not affected by the new +alias. This behavior is also an issue when functions are executed. +Aliases are expanded when a function definition is read, not when the +function is executed, because a function definition is itself a +compound command. As a consequence, aliases defined in a function are +not available until after that function is executed. To be safe, +always put alias definitions on a separate line, and do not use `alias' +in compound commands. - The evaluation is performed according to the rules listed above. If -the expression is invalid, Bash prints a message indicating failure and -no substitution occurs. + For almost every purpose, aliases are superseded by shell functions. -File: bashref.info, Node: Arithmetic Builtins, Prev: Arithmetic Expansion, Up: Shell Arithmetic +File: bashref.info, Node: Alias Builtins, Up: Aliases -Arithmetic Builtins -------------------- +Alias Builtins +-------------- -`let' - let EXPRESSION [EXPRESSION] - The `let' builtin allows arithmetic to be performed on shell - variables. Each EXPRESSION is evaluated according to the rules - given previously (*note Arithmetic Evaluation::.). If the last - EXPRESSION evaluates to 0, `let' returns 1; otherwise 0 is - returned. +`alias' + alias [`-p'] [NAME[=VALUE] ...] + + Without arguments or with the `-p' option, `alias' prints the list + of aliases on the standard output in a form that allows them to be + reused as input. If arguments are supplied, an alias is defined + for each NAME whose VALUE is given. If no VALUE is given, the name + and value of the alias is printed. + +`unalias' + unalias [-a] [NAME ... ] + + Remove each NAME from the list of aliases. If `-a' is supplied, + all aliases are removed. -File: bashref.info, Node: Arrays, Next: Printing a Prompt, Prev: Shell Arithmetic, Up: Bash Features +File: bashref.info, Node: Arrays, Next: The Directory Stack, Prev: Aliases, Up: Bash Features Arrays ====== @@ -3927,9 +4249,9 @@ is the number of elements in the array. Referencing an array variable without a subscript is equivalent to referencing element zero. The `unset' builtin is used to destroy arrays. `unset' -NAME[SUBSCRIPT] destroys the array element at index SUBSCRIPT. `unset' -NAME, where NAME is an array, removes the entire array. A subscript of -`*' or `@' also removes the entire array. +`name[SUBSCRIPT]' destroys the array element at index SUBSCRIPT. +`unset' NAME, where NAME is an array, removes the entire array. A +subscript of `*' or `@' also removes the entire array. The `declare', `local', and `readonly' builtins each accept a `-a' option to specify an array. The `read' builtin accepts a `-a' option @@ -3939,85 +4261,181 @@ The `set' and `declare' builtins display array values in a way that allows them to be reused as input. -File: bashref.info, Node: Printing a Prompt, Next: The Restricted Shell, Prev: Arrays, Up: Bash Features +File: bashref.info, Node: The Directory Stack, Next: Printing a Prompt, Prev: Arrays, Up: Bash Features + +The Directory Stack +=================== + + The directory stack is a list of recently-visited directories. The +`pushd' builtin adds directories to the stack as it changes the current +directory, and the `popd' builtin removes specified directories from +the stack and changes the current directory to the directory removed. +The `dirs' builtin displays the contents of the directory stack. + + The contents of the directory stack are also visible as the value of +the `DIRSTACK' shell variable. + +`dirs' + dirs [+N | -N] [-clvp] + Display the list of currently remembered directories. Directories + are added to the list with the `pushd' command; the `popd' command + removes directories from the list. + `+N' + Displays the Nth directory (counting from the left of the + list printed by `dirs' when invoked without options), starting + with zero. + + `-N' + Displays the Nth directory (counting from the right of the + list printed by `dirs' when invoked without options), starting + with zero. + + `-c' + Clears the directory stack by deleting all of the elements. + + `-l' + Produces a longer listing; the default listing format uses a + tilde to denote the home directory. + + `-p' + Causes `dirs' to print the directory stack with one entry per + line. + + `-v' + Causes `dirs' to print the directory stack with one entry per + line, prefixing each entry with its index in the stack. + +`popd' + popd [+N | -N] [-n] + + Remove the top entry from the directory stack, and `cd' to the new + top directory. When no arguments are given, `popd' removes the + top directory from the stack and performs a `cd' to the new top + directory. The elements are numbered from 0 starting at the first + directory listed with `dirs'; i.e., `popd' is equivalent to `popd + +0'. + `+N' + Removes the Nth directory (counting from the left of the list + printed by `dirs'), starting with zero. + + `-N' + Removes the Nth directory (counting from the right of the + list printed by `dirs'), starting with zero. + + `-n' + Suppresses the normal change of directory when removing + directories from the stack, so that only the stack is + manipulated. + +`pushd' + pushd [DIR | +N | -N] [-n] + + Save the current directory on the top of the directory stack and + then `cd' to DIR. With no arguments, `pushd' exchanges the top + two directories. + + `+N' + Brings the Nth directory (counting from the left of the list + printed by `dirs', starting with zero) to the top of the list + by rotating the stack. + + `-N' + Brings the Nth directory (counting from the right of the list + printed by `dirs', starting with zero) to the top of the list + by rotating the stack. + + `-n' + Suppresses the normal change of directory when adding + directories to the stack, so that only the stack is + manipulated. + + `DIR' + Makes the current working directory be the top of the stack, + and then executes the equivalent of ``cd' DIR'. `cd's to DIR. + + +File: bashref.info, Node: Printing a Prompt, Next: The Restricted Shell, Prev: The Directory Stack, Up: Bash Features Controlling the Prompt ====================== The value of the variable `PROMPT_COMMAND' is examined just before Bash prints each primary prompt. If it is set and non-null, then the -value is executed just as if you had typed it on the command line. +value is executed just as if it had been typed on the command line. In addition, the following table describes the special characters which can appear in the prompt variables: `\a' - a bell character. + A bell character. `\d' - the date, in "Weekday Month Date" format (e.g., "Tue May 26"). + The date, in "Weekday Month Date" format (e.g., "Tue May 26"). `\e' - an escape character. + An escape character. `\h' - the hostname, up to the first `.'. + The hostname, up to the first `.'. `\H' - the hostname. + The hostname. `\n' - newline. + A newline. + +`\r' + A carriage return. `\s' - the name of the shell, the basename of `$0' (the portion following + The name of the shell, the basename of `$0' (the portion following the final slash). `\t' - the time, in 24-hour HH:MM:SS format. + The time, in 24-hour HH:MM:SS format. `\T' - the time, in 12-hour HH:MM:SS format. + The time, in 12-hour HH:MM:SS format. `\@' - the time, in 12-hour am/pm format. + The time, in 12-hour am/pm format. + +`\u' + The username of the current user. `\v' - the version of Bash (e.g., 2.00) + The version of Bash (e.g., 2.00) `\V' - the release of Bash, version + patchlevel (e.g., 2.00.0) + The release of Bash, version + patchlevel (e.g., 2.00.0) `\w' - the current working directory. + The current working directory. `\W' - the basename of `$PWD'. - -`\u' - your username. + The basename of `$PWD'. `\!' - the history number of this command. + The history number of this command. `\#' - the command number of this command. + The command number of this command. `\$' - if the effective uid is 0, `#', otherwise `$'. + If the effective uid is 0, `#', otherwise `$'. -`\nnn' - the character corresponding to the octal number `nnn'. +`\NNN' + The character whose ASCII code is the octal value NNN. `\\' - a backslash. + A backslash. `\[' - begin a sequence of non-printing characters. This could be used to + Begin a sequence of non-printing characters. This could be used to embed a terminal control sequence into the prompt. `\]' - end a sequence of non-printing characters. + End a sequence of non-printing characters. File: bashref.info, Node: The Restricted Shell, Next: Bash POSIX Mode, Prev: Printing a Prompt, Up: Bash Features @@ -4042,6 +4460,9 @@ with the exception that the following are disallowed: * Importing function definitions from the shell environment at startup. + * Parsing the value of `SHELLOPTS' from the shell environment at + startup. + * Redirecting output using the `>', `>|', `<>', `>&', `&>', and `>>' redirection operators. @@ -4052,7 +4473,7 @@ with the exception that the following are disallowed: * Specifying the `-p' option to the `command' builtin. - * Turning off restricted mode with `set +r'. + * Turning off restricted mode with `set +r' or `set +o restricted'. File: bashref.info, Node: Bash POSIX Mode, Prev: The Restricted Shell, Up: Bash Features @@ -4080,11 +4501,11 @@ specified by POSIX.2 in areas where the Bash default differs. 5. The POSIX.2 `PS1' and `PS2' expansions of `!' to the history number and `!!' to `!' are enabled, and parameter expansion is - performed on the value regardless of the setting of the - `promptvars' option. + performed on the values of `PS1' and `PS2' regardless of the + setting of the `promptvars' option. - 6. Interactive comments are enabled by default. (Note that Bash has - them on by default anyway.) + 6. Interactive comments are enabled by default. (Bash has them on by + default anyway.) 7. The POSIX.2 startup files are executed (`$ENV') rather than the normal Bash files. @@ -4101,42 +4522,51 @@ specified by POSIX.2 in areas where the Bash default differs. 11. Non-interactive shells exit if FILENAME in `.' FILENAME is not found. - 12. Redirection operators do not perform filename expansion on the word + 12. Non-interactive shells exit if a syntax error in an arithmetic + expansion results in an invalid expression. + + 13. Redirection operators do not perform filename expansion on the word in the redirection unless the shell is interactive. - 13. Function names must be valid shell `name's. That is, they may not + 14. Function names must be valid shell `name's. That is, they may not contain characters other than letters, digits, and underscores, and - may not start with a digit. Declaring a function with an illegal + may not start with a digit. Declaring a function with an invalid name causes a fatal syntax error in non-interactive shells. - 14. POSIX.2 `special' builtins are found before shell functions during + 15. POSIX.2 `special' builtins are found before shell functions during command lookup. - 15. If a POSIX.2 special builtin returns an error status, a + 16. If a POSIX.2 special builtin returns an error status, a non-interactive shell exits. The fatal errors are those listed in the POSIX.2 standard, and include things like passing incorrect options, redirection errors, variable assignment errors for assignments preceding the command name, and so on. - 16. If the `cd' builtin finds a directory to change to using + 17. If the `cd' builtin finds a directory to change to using `$CDPATH', the value it assigns to the `PWD' variable does not contain any symbolic links, as if `cd -P' had been executed. - 17. A non-interactive shell exits with an error status if a variable + 18. If `$CDPATH' is set, the `cd' builtin will not implicitly append + the current directory to it. This means that `cd' will fail if no + valid directory name can be constructed from any of the entries in + `$CDPATH', even if the a directory with the same name as the name + given as an argument to `cd' exists in the current directory. + + 19. A non-interactive shell exits with an error status if a variable assignment error occurs when no command name follows the assignment statements. A variable assignment error occurs, for example, when - trying to assign a value to a read-only variable. + trying to assign a value to a readonly variable. - 18. A non-interactive shell exits with an error status if the iteration + 20. A non-interactive shell exits with an error status if the iteration variable in a `for' statement or the selection variable in a - `select' statement is a read-only variable. + `select' statement is a readonly variable. - 19. Process substitution is not available. + 21. Process substitution is not available. - 20. Assignment statements preceding POSIX.2 `special' builtins persist + 22. Assignment statements preceding POSIX.2 special builtins persist in the shell environment after the builtin completes. - 21. The `export' and `readonly' builtin commands display their output + 23. The `export' and `readonly' builtin commands display their output in the format required by POSIX.2. @@ -4152,7 +4582,7 @@ File: bashref.info, Node: Job Control, Next: Using History Interactively, Pre Job Control *********** - This chapter disusses what job control is, how it works, and how + This chapter discusses what job control is, how it works, and how Bash allows you to access its facilities. * Menu: @@ -4176,8 +4606,7 @@ interface supplied jointly by the system's terminal driver and Bash. The shell associates a JOB with each pipeline. It keeps a table of currently executing jobs, which may be listed with the `jobs' command. -When Bash starts a job asynchronously (in the background), it prints a -line that looks like: +When Bash starts a job asynchronously, it prints a line that looks like: [1] 25647 indicating that this job is job number 1 and that the process ID of the @@ -4199,16 +4628,17 @@ signal by the terminal driver, which, unless caught, suspends the process. If the operating system on which Bash is running supports job -control, Bash allows you to use it. Typing the SUSPEND character -(typically `^Z', Control-Z) while a process is running causes that -process to be stopped and returns you to Bash. Typing the DELAYED -SUSPEND character (typically `^Y', Control-Y) causes the process to be -stopped when it attempts to read input from the terminal, and control to -be returned to Bash. You may then manipulate the state of this job, -using the `bg' command to continue it in the background, the `fg' -command to continue it in the foreground, or the `kill' command to kill -it. A `^Z' takes effect immediately, and has the additional side -effect of causing pending output and typeahead to be discarded. +control, Bash contains facilities to use it. Typing the SUSPEND +character (typically `^Z', Control-Z) while a process is running causes +that process to be stopped and returns control to Bash. Typing the +DELAYED SUSPEND character (typically `^Y', Control-Y) causes the +process to be stopped when it attempts to read input from the terminal, +and control to be returned to Bash. The user then manipulates the +state of this job, using the `bg' command to continue it in the +background, the `fg' command to continue it in the foreground, or the +`kill' command to kill it. A `^Z' takes effect immediately, and has +the additional side effect of causing pending output and typeahead to +be discarded. There are a number of ways to refer to a job in the shell. The character `%' introduces a job name. Job number `n' may be referred to @@ -4219,10 +4649,10 @@ other hand, refers to any job containing the string `ce' in its command line. If the prefix or substring matches more than one job, Bash reports an error. The symbols `%%' and `%+' refer to the shell's notion of the current job, which is the last job stopped while it was -in the foreground. The previous job may be referenced using `%-'. In -output pertaining to jobs (e.g., the output of the `jobs' command), the -current job is always flagged with a `+', and the previous job with a -`-'. +in the foreground or started in the background. The previous job may +be referenced using `%-'. In output pertaining to jobs (e.g., the +output of the `jobs' command), the current job is always flagged with a +`+', and the previous job with a `-'. Simply naming a job can be used to bring it into the foreground: `%1' is a synonym for `fg %1', bringing job 1 from the background into @@ -4232,14 +4662,14 @@ equivalent to `bg %1' The shell learns immediately whenever a job changes state. Normally, Bash waits until it is about to print a prompt before reporting changes in a job's status so as to not interrupt any other -output. If the the `-b' option to the `set' builtin is set, Bash +output. If the the `-b' option to the `set' builtin is enabled, Bash reports such changes immediately (*note The Set Builtin::.). - If you attempt to exit Bash while jobs are stopped, the shell prints -a message warning you that you have stopped jobs. You may then use the -`jobs' command to inspect their status. If you do this, or try to exit -again immediately, you are not warned again, and the stopped jobs are -terminated. + If an attempt to exit Bash is while jobs are stopped, the shell +prints a message warning that there are stopped jobs. The `jobs' +command may then be used to inspect their status. If a second attempt +to exit is made without an intervening command, Bash does not print +another warning, and the stopped jobs are terminated. File: bashref.info, Node: Job Control Builtins, Next: Job Control Variables, Prev: Job Control Basics, Up: Job Control @@ -4249,27 +4679,35 @@ Job Control Builtins `bg' bg [JOBSPEC] - Place JOBSPEC into the background, as if it had been started with - `&'. If JOBSPEC is not supplied, the current job is used. + Resume the suspended job JOBSPEC in the background, as if it had + been started with `&'. If JOBSPEC is not supplied, the current + job is used. The return status is zero unless it is run when job + control is not enabled, or, when run with job control enabled, if + JOBSPEC was not found or JOBSPEC specifies a job that was started + without job control. `fg' fg [JOBSPEC] - Bring JOBSPEC into the foreground and make it the current job. If - JOBSPEC is not supplied, the current job is used. + Resume the job JOBSPEC in the foreground and make it the current + job. If JOBSPEC is not supplied, the current job is used. The + return status is that of the command placed into the foreground, + or non-zero if run when job control is disabled or, when run with + job control enabled, JOBSPEC does not specify a valid job or + JOBSPEC specifies a job that was started without job control. `jobs' jobs [-lpnrs] [JOBSPEC] - jobs -x COMMAND [JOBSPEC] + jobs -x COMMAND [ARGUMENTS] The first form lists the active jobs. The options have the following meanings: `-l' - List process IDs in addition to the normal information + List process IDs in addition to the normal information. `-n' Display information only about jobs that have changed status - since you were last notified of their status. + since the user was last notified of their status. `-p' List only the process ID of the job's process group leader. @@ -4290,30 +4728,41 @@ Job Control Builtins status. `kill' - kill [-s SIGSPEC] [-n SIGNUM] [-SIGSPEC] JOBSPEC - kill -l [SIGSPEC] + kill [-s SIGSPEC] [-n SIGNUM] [-SIGSPEC] JOBSPEC or PID + kill -l [EXIT_STATUS] Send a signal specified by SIGSPEC or SIGNUM to the process named - by JOBSPEC. SIGSPEC is either a signal name such as `SIGINT' - (with or without the `SIG' prefix) or a signal number; SIGNUM is a - signal number. If SIGSPEC and SIGNUM are not present, `SIGTERM' - is used. The `-l' option lists the signal names, or the signal - name corresponding to SIGSPEC. + by job specification JOBSPEC or process ID PID. SIGSPEC is either + a signal name such as `SIGINT' (with or without the `SIG' prefix) + or a signal number; SIGNUM is a signal number. If SIGSPEC and + SIGNUM are not present, `SIGTERM' is used. The `-l' option lists + the signal names. If any arguments are supplied when `-l' is + given, the names of the signals corresponding to the arguments are + listed, and the return status is zero. EXIT_STATUS is a number + specifying a signal number or the exit status of a process + terminated by a signal. The return status is zero if at least one + signal was successfully sent, or non-zero if an error occurs or an + invalid option is encountered. `wait' wait [JOBSPEC|PID] Wait until the child process specified by process ID PID or job - specification JOBSPEC exits and report its exit status. If a job - spec is given, all processes in the job are waited for. If no - arguments are given, all currently active child processes are - waited for. + specification JOBSPEC exits and return the exit status of the last + command waited for. If a job spec is given, all processes in the + job are waited for. If no arguments are given, all currently + active child processes are waited for, and the return status is + zero. If neither JOBSPEC nor PID specifies an active child process + of the shell, the return status is 127. `disown' - disown [-h] [JOBSPEC ...] + disown [-ar] [-h] [JOBSPEC ...] Without options, each JOBSPEC is removed from the table of active jobs. If the `-h' option is given, the job is not removed from the table, but is marked so that `SIGHUP' is not sent to the job - if the shell receives a `SIGHUP'. If JOBSPEC is not present, the - current job is used. + if the shell receives a `SIGHUP'. If JOBSPEC is not present, and + neither the `-a' nor `-r' option is supplied, the current job is + used. If no JOBSPEC is supplied, the `-a' option means to remove + or mark all jobs; the `-r' option without a JOBSPEC argument + restricts operation to running jobs. `suspend' suspend [-f] @@ -4333,13 +4782,13 @@ Job Control Variables `auto_resume' This variable controls how the shell interacts with the user and job control. If this variable exists then single word simple - commands without redirects are treated as candidates for resumption - of an existing job. There is no ambiguity allowed; if there is - more than one job beginning with the string typed, then the most - recently accessed job will be selected. The name of a stopped - job, in this context, is the command line used to start it. If - this variable is set to the value `exact', the string supplied - must match the name of a stopped job exactly; if set to + commands without redirections are treated as candidates for + resumption of an existing job. There is no ambiguity allowed; if + there is more than one job beginning with the string typed, then + the most recently accessed job will be selected. The name of a + stopped job, in this context, is the command line used to start + it. If this variable is set to the value `exact', the string + supplied must match the name of a stopped job exactly; if set to `substring', the string supplied needs to match a substring of the name of a stopped job. The `substring' value provides functionality analogous to the `%?' job ID (*note Job Control @@ -4355,17 +4804,19 @@ Using History Interactively This chapter describes how to use the GNU History Library interactively, from a user's standpoint. It should be considered a -user's guide. For information on using the GNU History Library in your -own programs, see the GNU Readline Library Manual. +user's guide. For information on using the GNU History Library in +other programs, see the GNU Readline Library Manual. * Menu: * Bash History Facilities:: How Bash lets you manipulate your command history. +* Bash History Builtins:: The Bash builtin commands that manipulate + the command history. * History Interaction:: What it feels like using History as a user. -File: bashref.info, Node: Bash History Facilities, Next: History Interaction, Up: Using History Interactively +File: bashref.info, Node: Bash History Facilities, Next: Bash History Builtins, Up: Using History Interactively Bash History Facilities ======================= @@ -4390,12 +4841,11 @@ saving the history, the history file is truncated to contain no more than `$HISTFILESIZE' lines. If `HISTFILESIZE' is not set, no truncation is performed. - The builtin command `fc' (*note Korn Shell Builtins::.) may be used -to list or edit and re-execute a portion of the history list. The -`history' builtin (*note C Shell Builtins::.) can be used to display or -modify the history list and manipulate the history file. When using -the command-line editing, search commands are available in each editing -mode that provide access to the history list. + The builtin command `fc' may be used to list or edit and re-execute +a portion of the history list. The `history' builtin can be used to +display or modify the history list and manipulate the history file. +When using the command-line editing, search commands are available in +each editing mode that provide access to the history list. The shell allows control over which commands are saved on the history list. The `HISTCONTROL' and `HISTIGNORE' variables may be set to cause @@ -4404,14 +4854,96 @@ shell option, if enabled, causes the shell to attempt to save each line of a multi-line command in the same history entry, adding semicolons where necessary to preserve syntactic correctness. The `lithist' shell option causes the shell to save the command with embedded newlines -instead of semicolons. *Note Bash Builtins:: for a description of +instead of semicolons. *Note Bash Builtins::, for a description of `shopt'. -File: bashref.info, Node: History Interaction, Prev: Bash History Facilities, Up: Using History Interactively +File: bashref.info, Node: Bash History Builtins, Next: History Interaction, Prev: Bash History Facilities, Up: Using History Interactively + +Bash History Builtins +===================== -Interactive History Expansion -============================= + Bash provides two builtin commands that allow you to manipulate the +history list and history file. + +`fc' + `fc [-e ENAME] [-nlr] [FIRST] [LAST]' + `fc -s [PAT=REP] [COMMAND]' + + Fix Command. In the first form, a range of commands from FIRST to + LAST is selected from the history list. Both FIRST and LAST may + be specified as a string (to locate the most recent command + beginning with that string) or as a number (an index into the + history list, where a negative number is used as an offset from the + current command number). If LAST is not specified it is set to + FIRST. If FIRST is not specified it is set to the previous + command for editing and -16 for listing. If the `-l' flag is + given, the commands are listed on standard output. The `-n' flag + suppresses the command numbers when listing. The `-r' flag + reverses the order of the listing. Otherwise, the editor given by + ENAME is invoked on a file containing those commands. If ENAME is + not given, the value of the following variable expansion is used: + `${FCEDIT:-${EDITOR:-vi}}'. This says to use the value of the + `FCEDIT' variable if set, or the value of the `EDITOR' variable if + that is set, or `vi' if neither is set. When editing is complete, + the edited commands are echoed and executed. + + In the second form, COMMAND is re-executed after each instance of + PAT in the selected command is replaced by REP. + + A useful alias to use with the `fc' command is `r='fc -s'', so + that typing `r cc' runs the last command beginning with `cc' and + typing `r' re-executes the last command (*note Aliases::.). + +`history' + history [-c] [N] + history [-anrw] [FILENAME] + history -ps ARG + + Display the history list with line numbers. Lines prefixed with + with a `*' have been modified. An argument of N says to list only + the last N lines. Options, if supplied, have the following + meanings: + + `-w' + Write out the current history to the history file. + + `-r' + Read the current history file and append its contents to the + history list. + + `-a' + Append the new history lines (history lines entered since the + beginning of the current Bash session) to the history file. + + `-n' + Append the history lines not already read from the history + file to the current history list. These are lines appended + to the history file since the beginning of the current Bash + session. + + `-c' + Clear the history list. This may be combined with the other + options to replace the history list completely. + + `-s' + The ARGs are added to the end of the history list as a single + entry. + + `-p' + Perform history substitution on the ARGs and display the + result on the standard output, without storing the results in + the history list. + + When the `-w', `-r', `-a', or `-n' option is used, if FILENAME is + given, then it is used as the history file. If not, then the + value of the `HISTFILE' variable is used. + + +File: bashref.info, Node: History Interaction, Prev: Bash History Builtins, Up: Using History Interactively + +History Expansion +================= The History library provides a history expansion feature that is similar to the history expansion provided by `csh'. This section @@ -4423,17 +4955,16 @@ to a previous command into the current input line, or fix errors in previous commands quickly. History expansion takes place in two parts. The first is to -determine which line from the previous history should be used during +determine which line from the history list should be used during substitution. The second is to select portions of that line for -inclusion into the current one. The line selected from the previous -history is called the "event", and the portions of that line that are -acted upon are called "words". Various "modifiers" are available to -manipulate the selected words. The line is broken into words in the -same fashion that Bash does, so that several English (or Unix) words -surrounded by quotes are considered as one word. History expansions -are introduced by the appearance of the history expansion character, -which is `!' by default. Only `\' and `'' may be used to escape the -history expansion character. +inclusion into the current one. The line selected from the history is +called the "event", and the portions of that line that are acted upon +are called "words". Various "modifiers" are available to manipulate +the selected words. The line is broken into words in the same fashion +that Bash does, so that several words surrounded by quotes are +considered one word. History expansions are introduced by the +appearance of the history expansion character, which is `!' by default. +Only `\' and `'' may be used to escape the history expansion character. Several shell options settable with the `shopt' builtin (*note Bash Builtins::.) may be used to tailor the behavior of history expansion. @@ -4447,7 +4978,8 @@ correction. The `-p' option to the `history' builtin command may be used to see what a history expansion will do before using it. The `-s' option to the `history' builtin may be used to add commands to the end of the history list without actually executing them, so that they are -available for subsequent recall. +available for subsequent recall. This is most useful in conjunction +with Readline. The shell allows control of the various characters used by the history expansion mechanism with the `histchars' variable. @@ -4469,7 +5001,7 @@ history list. `!' Start a history substitution, except when followed by a space, tab, - the end of the line, <=> or <(>. + the end of the line, `=' or `('. `!N' Refer to command line N. @@ -4502,7 +5034,7 @@ Word Designators ---------------- Word designators are used to select desired words from the event. A -`:' separates the event specification from the word designator. It can +`:' separates the event specification from the word designator. It may be omitted if the word designator begins with a `^', `$', `*', `-', or `%'. Words are numbered from the beginning of the line, with the first word being denoted by 0 (zero). Words are inserted into the current @@ -4698,8 +5230,8 @@ Printing characters Insert the character into the line at the cursor. <C-_> - Undo the last thing that you did. You can undo all the way back - to an empty line. + Undo the last editing command. You can undo all the way back to an + empty line. File: bashref.info, Node: Readline Movement Commands, Next: Readline Killing Commands, Prev: Readline Bare Essentials, Up: Readline Interaction @@ -4720,7 +5252,8 @@ about the line. Move to the end of the line. <M-f> - Move forward a word. + Move forward a word, where a word is composed of letters and + digits. <M-b> Move backward a word. @@ -4768,8 +5301,8 @@ available to be yanked back later, when you are typing another line. Kill from the cursor to the previous whitespace. This is different than <M-DEL> because the word boundaries differ. - And, here is how to "yank" the text back into the line. Yanking -means to copy the most-recently-killed text from the kill buffer. + Here is how to "yank" the text back into the line. Yanking means to +copy the most-recently-killed text from the kill buffer. <C-y> Yank the most recently killed text back into the buffer at the @@ -4793,10 +5326,10 @@ act in a backward direction. For example, to kill text back to the start of the line, you might type `M-- C-k'. The general way to pass numeric arguments to a command is to type -meta digits before the command. If the first `digit' you type is a -minus sign (<->), then the sign of the argument will be negative. Once -you have typed one meta digit to get the argument started, you can type -the remainder of the digits, and then the command. For example, to give +meta digits before the command. If the first `digit' typed is a minus +sign (<->), then the sign of the argument will be negative. Once you +have typed one meta digit to get the argument started, you can type the +remainder of the digits, and then the command. For example, to give the <C-d> command an argument of 10, you could type `M-1 0 C-d'. @@ -4811,24 +5344,24 @@ string. There are two search modes: INCREMENTAL and NON-INCREMENTAL. Incremental searches begin before the user has finished typing the search string. As each character of the search string is typed, -readline displays the next entry from the history matching the string +Readline displays the next entry from the history matching the string typed so far. An incremental search requires only as many characters -as needed to find the desired history entry. The Escape character is -used to terminate an incremental search. Control-J will also terminate -the search. Control-G will abort an incremental search and restore the +as needed to find the desired history entry. The <ESC> character is +used to terminate an incremental search. <C-j> will also terminate the +search. <C-g> will abort an incremental search and restore the original line. When the search is terminated, the history entry containing the search string becomes the current line. To find other -matching entries in the history list, type Control-S or Control-R as +matching entries in the history list, type <C-s> or <C-r> as appropriate. This will search backward or forward in the history for the next entry matching the search string typed so far. Any other key -sequence bound to a readline command will terminate the search and -execute that command. For instance, a `newline' will terminate the -search and accept the line, thereby executing the command from the -history list. +sequence bound to a Readline command will terminate the search and +execute that command. For instance, a <RET> will terminate the search +and accept the line, thereby executing the command from the history +list. Non-incremental searches read the entire search string before starting to search for matching history lines. The search string may be -typed by the user or part of the contents of the current line. +typed by the user or be part of the contents of the current line. File: bashref.info, Node: Readline Init File, Next: Bindable Readline Commands, Prev: Readline Interaction, Up: Command Line Editing @@ -4837,12 +5370,11 @@ Readline Init File ================== Although the Readline library comes with a set of `emacs'-like -keybindings installed by default, it is possible that you would like to -use a different set of keybindings. You can customize programs that -use Readline by putting commands in an "inputrc" file in your home -directory. The name of this file is taken from the value of the shell -variable `INPUTRC'. If that variable is unset, the default is -`~/.inputrc'. +keybindings installed by default, it is possible to use a different set +of keybindings. Any user can customize programs that use Readline by +putting commands in an "inputrc" file in his home directory. The name +of this file is taken from the value of the shell variable `INPUTRC'. +If that variable is unset, the default is `~/.inputrc'. When a program which uses the Readline library starts up, the init file is read, and the key bindings are set. @@ -4871,14 +5403,15 @@ comments. Lines beginning with a `$' indicate conditional constructs settings and key bindings. Variable Settings - You can change the state of a few variables in Readline by using - the `set' command within the init file. Here is how you would - specify that you wish to use `vi' line editing commands: + You can modify the run-time behavior of Readline by altering the + values of variables in Readline using the `set' command within the + init file. Here is how to change from the default Emacs-like key + binding to use `vi' line editing commands: set editing-mode vi - Right now, there are only a few variables which can be set; so - few, in fact, that we just list them here: + A great deal of run-time behavior is changeable with the following + variables. `bell-style' Controls what happens when Readline wants to ring the @@ -4892,6 +5425,11 @@ Variable Settings `insert-comment' command is executed. The default value is `"#"'. + `completion-ignore-case' + If set to `on', Readline performs filename matching and + completion in a case-insensitive fashion. The default value + is `off'. + `completion-query-items' The number of possible completions that determines when the user is asked whether he wants to see the list of @@ -4902,23 +5440,23 @@ Variable Settings `convert-meta' If set to `on', Readline will convert characters with the - eigth bit set to an ASCII key sequence by stripping the eigth - bit and prepending an <ESC> character, converting them to a - meta-prefixed key sequence. The default value is `on'. + eighth bit set to an ASCII key sequence by stripping the + eighth bit and prepending an <ESC> character, converting them + to a meta-prefixed key sequence. The default value is `on'. `disable-completion' - If set to `On', readline will inhibit word completion. + If set to `On', Readline will inhibit word completion. Completion characters will be inserted into the line as if they had been mapped to `self-insert'. The default is `off'. `editing-mode' - The `editing-mode' variable controls which editing mode you - are using. By default, Readline starts up in Emacs editing - mode, where the keystrokes are most similar to Emacs. This - variable can be set to either `emacs' or `vi'. + The `editing-mode' variable controls which default set of key + bindings is used. By default, Readline starts up in Emacs + editing mode, where the keystrokes are most similar to Emacs. + This variable can be set to either `emacs' or `vi'. `enable-keypad' - When set to `on', readline will try to enable the application + When set to `on', Readline will try to enable the application keypad when it is called. Some systems need this to enable the arrow keys. The default is `off'. @@ -4928,7 +5466,7 @@ Variable Settings `horizontal-scroll-mode' This variable can be set to either `on' or `off'. Setting it - to `on' means that the text of the lines that you edit will + to `on' means that the text of the lines being edited will scroll horizontally on a single screen line when they are longer than the width of the screen, instead of wrapping onto a new screen line. By default, this variable is set to `off'. @@ -4947,9 +5485,9 @@ Variable Settings appended. The default is `on'. `mark-modified-lines' - This variable, when set to `on', says to display an asterisk - (`*') at the start of history lines which have been modified. - This variable is `off' by default. + This variable, when set to `on', causes Readline to display an + asterisk (`*') at the start of history lines which have been + modified. This variable is `off' by default. `input-meta' If set to `on', Readline will enable eight-bit input (it will @@ -4963,6 +5501,11 @@ Variable Settings eighth bit set directly rather than as a meta-prefixed escape sequence. The default is `off'. + `print-completions-horizontally' + If set to `on', Readline will display completions with matches + sorted horizontally in alphabetical order, rather than down + the screen. The default is `off'. + `show-all-if-ambiguous' This alters the default behavior of the completion functions. If set to `on', words which have more than one possible @@ -4977,9 +5520,9 @@ Variable Settings Key Bindings The syntax for controlling key bindings in the init file is simple. First you have to know the name of the command that you - want to change. The following pages contain tables of the command - name, the default keybinding, and a short description of what the - command does. + want to change. The following sections contain tables of the + command name, the default keybinding, if any, and a short + description of what the command does. Once you know the name of the command, simply place the name of the key you wish to bind the command to, a colon, and then the @@ -4994,8 +5537,8 @@ Key Bindings Meta-Rubout: backward-kill-word Control-o: "> output" - In the above example, `C-u' is bound to the function - `universal-argument', and `C-o' is bound to run the macro + In the above example, <C-u> is bound to the function + `universal-argument', and <C-o> is bound to run the macro expressed on the right hand side (that is, to insert the text `> output' into the line). @@ -5010,38 +5553,76 @@ Key Bindings "\C-x\C-r": re-read-init-file "\e[11~": "Function Key 1" - In the above example, `C-u' is bound to the function + In the above example, <C-u> is bound to the function `universal-argument' (just as it was in the first example), - `C-x C-r' is bound to the function `re-read-init-file', and - `ESC [ 1 1 ~' is bound to insert the text `Function Key 1'. - The following escape sequences are available when specifying - key sequences: + `<C-x> <C-r>' is bound to the function `re-read-init-file', + and `<ESC> <[> <1> <1> <~>' is bound to insert the text + `Function Key 1'. + + The following GNU Emacs style escape sequences are available when + specifying key sequences: + + `\C-' + control prefix + + `\M-' + meta prefix + + `\e' + an escape character - `\C-' - control prefix + `\\' + backslash + + `\"' + <"> + + `\'' + <'> + + In addition to the GNU Emacs style escape sequences, a second set + of backslash escapes is available: - `\M-' - meta prefix + `\a' + alert (bell) + + `\b' + backspace + + `\d' + delete + + `\f' + form feed + + `\n' + newline + + `\r' + carriage return - `\e' - an escape character + `\t' + horizontal tab - `\\' - backslash + `\v' + vertical tab - `\"' - <"> + `\NNN' + the character whose ASCII code is the octal value NNN (one to + three digits) - `\'' - <'> + `\xNNN' + the character whose ASCII code is the hexadecimal value NNN + (one to three digits) - When entering the text of a macro, single or double quotes - should be used to indicate a macro definition. Unquoted text - is assumed to be a function name. Backslash will quote any - character in the macro text, including `"' and `''. For - example, the following binding will make `C-x \' insert a - single `\' into the line: - "\C-x\\": "\\" + When entering the text of a macro, single or double quotes must be + used to indicate a macro definition. Unquoted text is assumed to + be a function name. In the macro body, the backslash escapes + described above are expanded. Backslash will quote any other + character in the macro text, including `"' and `''. For example, + the following binding will make `C-x \' insert a single `\' into + the line: + "\C-x\\": "\\" File: bashref.info, Node: Conditional Init Constructs, Next: Sample Init File, Prev: Readline Init File Syntax, Up: Readline Init File @@ -5052,7 +5633,7 @@ Conditional Init Constructs Readline implements a facility similar in spirit to the conditional compilation features of the C preprocessor which allows key bindings and variable settings to be performed as the result of tests. There -are three parser directives used. +are four parser directives used. `$if' The `$if' construct allows bindings to be made based on the @@ -5072,8 +5653,8 @@ are three parser directives used. The `term=' form may be used to include terminal-specific key bindings, perhaps to bind the key sequences output by the terminal's function keys. The word on the right side of the - `=' is tested against the full name of the terminal and the - portion of the terminal name before the first `-'. This + `=' is tested against both the full name of the terminal and + the portion of the terminal name before the first `-'. This allows `sun' to match both `sun' and `sun-cmd', for instance. `application' @@ -5090,13 +5671,18 @@ are three parser directives used. $endif `$endif' - This command, as you saw in the previous example, terminates an - `$if' command. + This command, as seen in the previous example, terminates an `$if' + command. `$else' Commands in this branch of the `$if' directive are executed if the test fails. +`$include' + This directive takes a single filename as an argument and reads + commands and bindings from that file. + $include /etc/inputrc + File: bashref.info, Node: Sample Init File, Prev: Conditional Init Constructs, Up: Readline Init File @@ -5114,6 +5700,11 @@ binding, variable assignment, and conditional syntax. # You can re-read the inputrc file with C-x C-r. # Lines beginning with '#' are comments. # + # First, include any systemwide bindings and variable assignments from + # /etc/Inputrc + $include /etc/Inputrc + + # # Set various bindings for emacs mode. set editing-mode emacs @@ -5262,8 +5853,8 @@ Commands For Manipulating The History `accept-line (Newline, Return)' Accept the line regardless of where the cursor is. If this line is non-empty, add it to the history list according to the setting of - the `HISTCONTROL' variable. If this line was a history line, then - restore the history line to its original state. + the `HISTCONTROL' and `HISTIGNORE' variables. If this line was a + history line, then restore the history line to its original state. `previous-history (C-p)' Move `up' through the history list. @@ -5275,8 +5866,8 @@ Commands For Manipulating The History Move to the first line in the history. `end-of-history (M->)' - Move to the end of the input history, i.e., the line you are - entering. + Move to the end of the input history, i.e., the line currently + being entered. `reverse-search-history (C-r)' Search backward starting at the current line and moving `up' @@ -5300,7 +5891,7 @@ Commands For Manipulating The History `history-search-forward ()' Search forward through the history for the string of characters between the start of the current line and the current cursor - position (the `point'). This is a non-incremental search. By + position (the POINT). This is a non-incremental search. By default, this command is unbound. `history-search-backward ()' @@ -5318,7 +5909,9 @@ Commands For Manipulating The History `yank-last-arg (M-., M-_)' Insert last argument to the previous command (the last word of the previous history entry). With an argument, behave exactly like - `yank-nth-arg'. + `yank-nth-arg'. Successive calls to `yank-last-arg' move back + through the history list, inserting the last argument of each line + in turn. File: bashref.info, Node: Commands For Text, Next: Commands For Killing, Prev: Commands For History, Up: Bindable Readline Commands @@ -5329,18 +5922,16 @@ Commands For Changing Text `delete-char (C-d)' Delete the character under the cursor. If the cursor is at the beginning of the line, there are no characters in the line, and - the last character typed was not `C-d', then return `EOF'. + the last character typed was not bound to `delete-char', then + return `EOF'. `backward-delete-char (Rubout)' - Delete the character behind the cursor. A numeric arg says to kill - the characters instead of deleting them. + Delete the character behind the cursor. A numeric argument means + to kill the characters instead of deleting them. `quoted-insert (C-q, C-v)' - Add the next character that you type to the line verbatim. This is - how to insert key sequences like <C-q>, for example. - -`tab-insert (M-TAB)' - Insert a tab character. + Add the next character typed to the line verbatim. This is how to + insert key sequences like <C-q>, for example. `self-insert (a, b, A, 1, !, ...)' Insert yourself. @@ -5349,7 +5940,7 @@ Commands For Changing Text Drag the character before the cursor forward over the character at the cursor, moving the cursor forward as well. If the insertion point is at the end of the line, then this transposes the last two - characters of the line. Negative argumentss don't work. + characters of the line. Negative arguments don't work. `transpose-words (M-t)' Drag the word behind the cursor past the word in front of the @@ -5357,15 +5948,15 @@ Commands For Changing Text `upcase-word (M-u)' Uppercase the current (or following) word. With a negative - argument, do the previous word, but do not move the cursor. + argument, uppercase the previous word, but do not move the cursor. `downcase-word (M-l)' Lowercase the current (or following) word. With a negative - argument, do the previous word, but do not move the cursor. + argument, lowercase the previous word, but do not move the cursor. `capitalize-word (M-c)' Capitalize the current (or following) word. With a negative - argument, do the previous word, but do not move the cursor. + argument, capitalize the previous word, but do not move the cursor. File: bashref.info, Node: Commands For Killing, Next: Numeric Arguments, Prev: Commands For Text, Up: Bindable Readline Commands @@ -5382,7 +5973,7 @@ Killing And Yanking `unix-line-discard (C-u)' Kill backward from the cursor to the beginning of the current line. - Save the killed text on the kill-ring. + The killed text is saved on the kill-ring. `kill-whole-line ()' Kill all characters on the current line, no matter where the @@ -5407,20 +5998,22 @@ Killing And Yanking `kill-region ()' Kill the text between the point and the *mark* (saved cursor - position. This text is referred to as the REGION. By default, + position). This text is referred to as the REGION. By default, this command is unbound. `copy-region-as-kill ()' - Copy the text in the region to the kill buffer, so you can yank it + Copy the text in the region to the kill buffer, so it can be yanked right away. By default, this command is unbound. `copy-backward-word ()' - Copy the word before point to the kill buffer. By default, this + Copy the word before point to the kill buffer. The word + boundaries are the same as `backward-word'. By default, this command is unbound. `copy-forward-word ()' - Copy the word following point to the kill buffer. By default, - this command is unbound. + Copy the word following point to the kill buffer. The word + boundaries are the same as `forward-word'. By default, this + command is unbound. `yank (C-y)' Yank the top of the kill ring into the buffer at the current @@ -5463,8 +6056,8 @@ Letting Readline Type For You Attempt to do completion on the text before the cursor. This is application-specific. Generally, if you are typing a filename argument, you can do filename completion; if you are typing a - command, you can do command completion, if you are typing in a - symbol to GDB, you can do symbol name completion, if you are + command, you can do command completion; if you are typing in a + symbol to GDB, you can do symbol name completion; if you are typing in a variable to Bash, you can do variable name completion, and so on. Bash attempts completion treating the text as a variable (if the text begins with `$'), username (if the text @@ -5479,6 +6072,17 @@ Letting Readline Type For You Insert all completions of the text before point that would have been generated by `possible-completions'. +`menu-complete ()' + Similar to `complete', but replaces the word to be completed with + a single match from the list of possible completions. Repeated + execution of `menu-complete' steps through the list of possible + completions, inserting each match in turn. At the end of the list + of completions, the bell is rung and the original text is restored. + An argument of N moves N positions forward in the list of matches; + a negative argument may be used to move backward through the list. + This command is intended to be bound to `TAB', but is unbound by + default. + `complete-filename (M-/)' Attempt filename completion on the text before point. @@ -5513,8 +6117,8 @@ Letting Readline Type For You `complete-command (M-!)' Attempt completion on the text before point, treating it as a command name. Command completion attempts to match the text - against aliases, reserved words, shell functions, builtins, and - finally executable filenames, in that order. + against aliases, reserved words, shell functions, shell builtins, + and finally executable filenames, in that order. `possible-command-completions (C-x !)' List the possible completions of the text before point, treating @@ -5566,16 +6170,15 @@ Some Miscellaneous Commands bound to the corresponding uppercase character. `prefix-meta (ESC)' - Make the next character that you type be metafied. This is for - people without a meta key. Typing `ESC f' is equivalent to typing - `M-f'. + Make the next character typed be metafied. This is for keyboards + without a meta key. Typing `ESC f' is equivalent to typing `M-f'. `undo (C-_, C-x C-u)' Incremental undo, separately remembered for each line. `revert-line (M-r)' - Undo all changes made to this line. This is like typing the `undo' - command enough times to get back to the beginning. + Undo all changes made to this line. This is like executing the + `undo' command enough times to get back to the beginning. `tilde-expand (M-~)' Perform tilde expansion on the current word. @@ -5606,19 +6209,19 @@ Some Miscellaneous Commands comment. `dump-functions ()' - Print all of the functions and their key bindings to the readline + Print all of the functions and their key bindings to the Readline output stream. If a numeric argument is supplied, the output is formatted in such a way that it can be made part of an INPUTRC file. This command is unbound by default. `dump-variables ()' Print all of the settable variables and their values to the - readline output stream. If a numeric argument is supplied, the + Readline output stream. If a numeric argument is supplied, the output is formatted in such a way that it can be made part of an INPUTRC file. This command is unbound by default. `dump-macros ()' - Print all of the readline key sequences bound to macros and the + Print all of the Readline key sequences bound to macros and the strings they ouput. If a numeric argument is supplied, the output is formatted in such a way that it can be made part of an INPUTRC file. This command is unbound by default. @@ -5630,24 +6233,27 @@ Some Miscellaneous Commands `glob-list-expansions (C-x g)' The list of expansions that would have been generated by - `glob-expand-word' is inserted into the line, replacing the word - before point. + `glob-expand-word' is displayed, and the line is redrawn. `display-shell-version (C-x C-v)' Display version information about the current instance of Bash. `shell-expand-line (M-C-e)' - Expand the line the way the shell does when it reads it. This - performs alias and history expansion as well as all of the shell - word expansions. + Expand the line as the shell does. This performs alias and + history expansion as well as all of the shell word expansions + (*note Shell Expansions::.). `history-expand-line (M-^)' Perform history expansion on the current line. -`alias-expand-line' +`magic-space ()' + Perform history expansion on the current line and insert a space + (*note History Interaction::.). + +`alias-expand-line ()' Perform alias expansion on the current line (*note Aliases::.). -`history-and-alias-expand-line' +`history-and-alias-expand-line ()' Perform history and alias expansion on the current line. `insert-last-argument (M-., M-_)' @@ -5692,7 +6298,7 @@ Installing Bash This chapter provides basic instructions for installing Bash on the various supported platforms. The distribution supports nearly every version of Unix (and, someday, GNU). Other independent ports exist for -OS/2, Windows 95, and Windows NT. +MS-DOS, OS/2, Windows 95, and Windows NT. * Menu: @@ -5738,10 +6344,10 @@ compiler output (useful mainly for debugging `configure'). If at some point `config.cache' contains results you don't want to keep, you may remove or edit it. - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether or not to do them, -and mail diffs or instructions to `bash-maintainers@prep.ai.mit.edu' so -they can be considered for the next release. + If you need to do unusual things to compile Bash, please try to +figure out how `configure' could check whether or not to do them, and +mail diffs or instructions to <bash-maintainers@gnu.org> so they can be +considered for the next release. The file `configure.in' is used to create `configure' by a program called Autoconf. You only need `configure.in' if you want to change it @@ -5847,8 +6453,8 @@ than `/usr/local' by giving `configure' the option `--prefix=PATH'. You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you -give `configure' the option `--exec-prefix=PATH', the package will use -`PATH' as the prefix for installing programs and libraries. +give `configure' the option `--exec-prefix=PATH', `make install' will +use `PATH' as the prefix for installing programs and libraries. Documentation and other data files will still use the regular prefix. @@ -5858,9 +6464,9 @@ Specifying the System Type ========================== There may be some features `configure' can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually `configure' can figure that out, but if it prints -a message saying it can not guess the host type, give it the +automatically, but needs to determine by the type of host Bash will run +on. Usually `configure' can figure that out, but if it prints a +message saying it can not guess the host type, give it the `--host=TYPE' option. `TYPE' can either be a short name for the system type, such as `sun4', or a canonical name with three fields: `CPU-COMPANY-SYSTEM' (e.g., `sparc-sun-sunos4.1.2'). @@ -5922,12 +6528,11 @@ Optional Features ================= The Bash `configure' has a number of `--enable-FEATURE' options, -where FEATURE indicates an optional part of the package. There are -also several `--with-PACKAGE' options, where PACKAGE is something like -`gnu-malloc' or `purify' (for the Purify memory allocation checker). To -turn off the default use of a package, use `--without-PACKAGE'. To -configure Bash without a feature that is enabled by default, use -`--disable-FEATURE'. +where FEATURE indicates an optional part of Bash. There are also +several `--with-PACKAGE' options, where PACKAGE is something like +`gnu-malloc' or `purify'. To turn off the default use of a package, use +`--without-PACKAGE'. To configure Bash without a feature that is +enabled by default, use `--disable-FEATURE'. Here is a complete list of the `--enable-' and `--with-' options that the Bash `configure' recognizes. @@ -5942,17 +6547,20 @@ that the Bash `configure' recognizes. `--with-glibc-malloc' Use the GNU libc version of `malloc' in `lib/malloc/gmalloc.c'. - This is somewhat slower than the default `malloc', but wastes - considerably less space. + This is not the version of `malloc' that appears in glibc version + 2, but a modified version of the `malloc' from glibc version 1. + This is somewhat slower than the default `malloc', but wastes less + space on a per-allocation basis, and will return memory to the + operating system under some circumstances. `--with-gnu-malloc' Use the GNU version of `malloc' in `lib/malloc/malloc.c'. This is not the same `malloc' that appears in GNU libc, but an older version derived from the 4.2 BSD `malloc'. This `malloc' is very - fast, but wastes a lot of space. This option is enabled by - default. The `NOTES' file contains a list of systems for which - this should be turned off, and `configure' disables this option - automatically for a number of systems. + fast, but wastes some space on each allocation. This option is + enabled by default. The `NOTES' file contains a list of systems + for which this should be turned off, and `configure' disables this + option automatically for a number of systems. `--with-purify' Define this to use the Purify memory allocation checker from Pure @@ -5962,9 +6570,20 @@ that the Bash `configure' recognizes. This produces a shell with minimal features, close to the historical Bourne shell. -The `minimal-config' option can be used to disable all of the following -options, but it is processed first, so individual options may be -enabled using `enable-FEATURE'. + There are several `--enable-' options that alter how Bash is +compiled and linked, rather than changing run-time features. + +`--enable-profiling' + This builds a Bash binary that produces profiling information to be + processed by `gprof' each time it is executed. + +`--enable-static-link' + This causes Bash to be linked statically, if `gcc' is being used. + This could be used to build a version to use as root's shell. + + The `minimal-config' option can be used to disable all of the +following options, but it is processed first, so individual options may +be enabled using `enable-FEATURE'. All of the following options except for `disabled-builtins' and `usg-echo-default' are enabled by default, unless the operating system @@ -5972,16 +6591,19 @@ does not provide the necessary support. `--enable-alias' Allow alias expansion and include the `alias' and `unalias' - builtins. + builtins (*note Aliases::.). `--enable-array-variables' - Include support for one-dimensional array shell variables. + Include support for one-dimensional array shell variables (*note + Arrays::.). `--enable-bang-history' - Include support for `csh'-like history substitution. + Include support for `csh'-like history substitution (*note History + Interaction::.). `--enable-brace-expansion' Include `csh'-like brace expansion ( `b{a,b}c' ==> `bac bbc' ). + See *Note Brace Expansion::, for a complete description. `--enable-command-timing' Include support for recognizing `time' as a reserved word and for @@ -5989,9 +6611,13 @@ does not provide the necessary support. This allows pipelines as well as shell builtins and functions to be timed. +`--enable-cond-command' + Include support for the `[[' conditional command (*note + Conditional Constructs::.). + `--enable-directory-stack' Include support for a `csh'-like directory stack and the `pushd', - `popd', and `dirs' builtins. + `popd', and `dirs' builtins (*note The Directory Stack::.). `--enable-disabled-builtins' Allow builtin commands to be invoked via `builtin xxx' even after @@ -6000,7 +6626,12 @@ does not provide the necessary support. commands. `--enable-dparen-arithmetic' - Include support for the `ksh' `((...))' command. + Include support for the `((...))' command (*note Conditional + Constructs::.). + +`--enable-extended-glob' + Include support for the extended pattern matching features + described above under *Note Pattern Matching::. `--enable-help-builtin' Include the `help' builtin, which displays help on shell builtins @@ -6011,20 +6642,22 @@ does not provide the necessary support. commands. `--enable-job-control' - This enables job control features, if the OS supports them. + This enables the job control features (*note Job Control::.), if + the operating system supports them. `--enable-process-substitution' This enables process substitution (*note Process Substitution::.) - if the OS provides the necessary support. + if the operating system provides the necessary support. `--enable-prompt-string-decoding' Turn on the interpretation of a number of backslash-escaped characters in the `$PS1', `$PS2', `$PS3', and `$PS4' prompt - strings. + strings. See *Note Printing a Prompt::, for a complete list of + prompt string escape sequences. `--enable-readline' Include support for command-line editing and history with the Bash - version of the Readline library. + version of the Readline library (*note Command Line Editing::.). `--enable-restricted' Include support for a "restricted shell". If this is enabled, @@ -6032,8 +6665,8 @@ does not provide the necessary support. The Restricted Shell::, for a description of restricted mode. `--enable-select' - Include the `ksh' `select' builtin, which allows the generation of - simple menus. + Include the `select' builtin, which allows the generation of simple + menus (*note Conditional Constructs::.). `--enable-usg-echo-default' Make the `echo' builtin expand backslash-escaped characters by @@ -6059,8 +6692,8 @@ of Bash that you have. Once you have determined that a bug actually exists, use the `bashbug' command to submit a bug report. If you have a fix, you are encouraged to mail that as well! Suggestions and `philosophical' bug -reports may be mailed to `bug-bash@prep.ai.MIT.Edu' or posted to the -Usenet newsgroup `gnu.bash.bug'. +reports may be mailed to <bug-bash@gnu.org> or posted to the Usenet +newsgroup `gnu.bash.bug'. All bug reports should include: * The version number of Bash. @@ -6077,8 +6710,7 @@ Usenet newsgroup `gnu.bash.bug'. `bashbug' inserts the first three items automatically into the template it provides for filing a bug report. - Please send all reports concerning this manual to -`chet@ins.CWRU.Edu'. + Please send all reports concerning this manual to <chet@po.CWRU.Edu>. File: bashref.info, Node: Builtin Index, Next: Reserved Word Index, Prev: Reporting Bugs, Up: Top @@ -6100,7 +6732,7 @@ Index of Shell Builtin Commands * command: Bash Builtins. * continue: Bourne Shell Builtins. * declare: Bash Builtins. -* dirs: C Shell Builtins. +* dirs: The Directory Stack. * disown: Job Control Builtins. * echo: Bash Builtins. * enable: Bash Builtins. @@ -6108,21 +6740,20 @@ Index of Shell Builtin Commands * exec: Bourne Shell Builtins. * exit: Bourne Shell Builtins. * export: Bourne Shell Builtins. -* fc: Korn Shell Builtins. +* fc: Bash History Builtins. * fg: Job Control Builtins. * getopts: Bourne Shell Builtins. * hash: Bourne Shell Builtins. * help: Bash Builtins. -* history: C Shell Builtins. +* history: Bash History Builtins. * jobs: Job Control Builtins. * kill: Job Control Builtins. -* let <1>: Arithmetic Builtins. -* let: Korn Shell Builtins. +* let: Bash Builtins. * local: Bash Builtins. -* logout <1>: Bash Builtins. -* logout: C Shell Builtins. -* popd: C Shell Builtins. -* pushd: C Shell Builtins. +* logout: Bash Builtins. +* popd: The Directory Stack. +* printf: Bash Builtins. +* pushd: The Directory Stack. * pwd: Bourne Shell Builtins. * read: Bash Builtins. * readonly: Bourne Shell Builtins. @@ -6130,13 +6761,13 @@ Index of Shell Builtin Commands * set: The Set Builtin. * shift: Bourne Shell Builtins. * shopt: Bash Builtins. -* source: C Shell Builtins. +* source: Bash Builtins. * suspend: Job Control Builtins. * test: Bourne Shell Builtins. * times: Bourne Shell Builtins. * trap: Bourne Shell Builtins. * type: Bash Builtins. -* typeset: Korn Shell Builtins. +* typeset: Bash Builtins. * ulimit: Bash Builtins. * umask: Bourne Shell Builtins. * unalias: Alias Builtins. @@ -6152,6 +6783,8 @@ Shell Reserved Words * Menu: * !: Pipelines. +* [[: Conditional Constructs. +* ]]: Conditional Constructs. * case: Conditional Constructs. * do: Looping Constructs. * done: Looping Constructs. @@ -6163,7 +6796,7 @@ Shell Reserved Words * function: Shell Functions. * if: Conditional Constructs. * in: Conditional Constructs. -* select: Korn Shell Constructs. +* select: Conditional Constructs. * then: Conditional Constructs. * time: Pipelines. * until: Looping Constructs. @@ -6204,7 +6837,7 @@ Parameter and Variable Index * enable-keypad: Readline Init File Syntax. * EUID: Bash Variables. * expand-tilde: Readline Init File Syntax. -* FCEDIT: Korn Shell Variables. +* FCEDIT: Bash Variables. * FIGNORE: Bash Variables. * GLOBIGNORE: Bash Variables. * GROUPS: Bash Variables. @@ -6221,23 +6854,23 @@ Parameter and Variable Index * HOSTNAME: Bash Variables. * HOSTTYPE: Bash Variables. * IFS: Bourne Shell Variables. -* IGNOREEOF <1>: Bash Variables. -* IGNOREEOF: C Shell Variables. +* IGNOREEOF: Bash Variables. * input-meta: Readline Init File Syntax. * INPUTRC: Bash Variables. * keymap: Readline Init File Syntax. * LANG: Bash Variables. * LC_ALL: Bash Variables. * LC_COLLATE: Bash Variables. +* LC_CTYPE: Bash Variables. * LC_MESSAGES: Bash Variables. -* LINENO: Korn Shell Variables. +* LINENO: Bash Variables. * MACHTYPE: Bash Variables. * MAIL: Bourne Shell Variables. * MAILCHECK: Bash Variables. * MAILPATH: Bourne Shell Variables. * mark-modified-lines: Readline Init File Syntax. * meta-flag: Readline Init File Syntax. -* OLDPWD: Korn Shell Variables. +* OLDPWD: Bash Variables. * OPTARG: Bourne Shell Variables. * OPTERR: Bash Variables. * OPTIND: Bourne Shell Variables. @@ -6249,17 +6882,17 @@ Parameter and Variable Index * PROMPT_COMMAND: Bash Variables. * PS1: Bourne Shell Variables. * PS2: Bourne Shell Variables. -* PS3: Korn Shell Variables. -* PS4: Korn Shell Variables. -* PWD: Korn Shell Variables. -* RANDOM: Korn Shell Variables. -* REPLY: Korn Shell Variables. -* SECONDS: Korn Shell Variables. +* PS3: Bash Variables. +* PS4: Bash Variables. +* PWD: Bash Variables. +* RANDOM: Bash Variables. +* REPLY: Bash Variables. +* SECONDS: Bash Variables. * SHELLOPTS: Bash Variables. * SHLVL: Bash Variables. * show-all-if-ambiguous: Readline Init File Syntax. * TIMEFORMAT: Bash Variables. -* TMOUT: Korn Shell Variables. +* TMOUT: Bash Variables. * UID: Bash Variables. * visible-stats: Readline Init File Syntax. @@ -6312,6 +6945,7 @@ Function Index * kill-region (): Commands For Killing. * kill-whole-line (): Commands For Killing. * kill-word (M-d): Commands For Killing. +* menu-complete (): Commands For Completion. * next-history (C-n): Commands For History. * non-incremental-forward-search-history (M-n): Commands For History. * non-incremental-reverse-search-history (M-p): Commands For History. @@ -6326,7 +6960,6 @@ Function Index * self-insert (a, b, A, 1, !, ...): Commands For Text. * set-mark (C-@): Miscellaneous Commands. * start-kbd-macro (C-x (): Keyboard Macros. -* tab-insert (M-TAB): Commands For Text. * tilde-expand (M-~): Miscellaneous Commands. * transpose-chars (C-t): Commands For Text. * transpose-words (M-t): Commands For Text. @@ -6349,7 +6982,7 @@ Concept Index * Menu: * alias expansion: Aliases. -* arithmetic evaluation: Arithmetic Evaluation. +* arithmetic evaluation: Shell Arithmetic. * arithmetic expansion: Arithmetic Expansion. * arithmetic, shell: Shell Arithmetic. * arrays: Arrays. @@ -6361,6 +6994,7 @@ Concept Index * builtin: Definitions. * command editing: Readline Bare Essentials. * command execution: Command Search and Execution. +* command expansion: Simple Command Expansion. * command history: Bash History Facilities. * command search: Command Search and Execution. * command substitution: Command Substitution. @@ -6370,16 +7004,19 @@ Concept Index * commands, lists: Lists. * commands, looping: Looping Constructs. * commands, pipelines: Pipelines. +* commands, shell: Shell Commands. * commands, simple: Simple Commands. * comments, shell: Comments. * configuration: Basic Installation. * control operator: Definitions. +* directory stack: The Directory Stack. * editing command lines: Readline Bare Essentials. * environment: Environment. -* evaluation, arithmetic: Arithmetic Evaluation. +* evaluation, arithmetic: Shell Arithmetic. * event designators: Event Designators. -* exit status <1>: Definitions. -* exit status: Exit Status. +* execution environment: Command Execution Environment. +* exit status <1>: Exit Status. +* exit status: Definitions. * expansion: Shell Expansions. * expansion, arithmetic: Arithmetic Expansion. * expansion, brace: Brace Expansion. @@ -6387,13 +7024,14 @@ Concept Index * expansion, parameter: Shell Parameter Expansion. * expansion, pathname: Filename Expansion. * expansion, tilde: Tilde Expansion. -* expressions, arithmetic: Arithmetic Evaluation. +* expressions, arithmetic: Shell Arithmetic. * expressions, conditional: Bash Conditional Expressions. * field: Definitions. * filename: Definitions. * filename expansion: Filename Expansion. * foreground: Job Control Basics. * functions, shell: Shell Functions. +* history builtins: Bash History Builtins. * history events: Event Designators. * history expansion: History Interaction. * history list: Bash History Facilities. @@ -6410,6 +7048,7 @@ Concept Index * kill ring: Readline Killing Commands. * killing text: Readline Killing Commands. * localization: Locale Translation. +* matching, pattern: Pattern Matching. * metacharacter: Definitions. * name: Definitions. * notation, readline: Readline Bare Essentials. @@ -6419,6 +7058,7 @@ Concept Index * parameters, positional: Positional Parameters. * parameters, special: Special Parameters. * pathname expansion: Filename Expansion. +* pattern matching: Pattern Matching. * pipeline: Pipelines. * POSIX: Definitions. * POSIX Mode: Bash POSIX Mode. @@ -6433,6 +7073,7 @@ Concept Index * reserved word: Definitions. * restricted shell: The Restricted Shell. * return status: Definitions. +* shell arithmetic: Shell Arithmetic. * shell function: Shell Functions. * shell script: Shell Scripts. * shell variable: Shell Parameters. @@ -6451,123 +7092,120 @@ Concept Index Tag Table: -Node: Top1179 -Node: Introduction3283 -Node: What is Bash?3508 -Node: What is a shell?4592 -Node: Definitions6473 -Node: Basic Shell Features9134 -Node: Shell Syntax10655 -Node: Shell Operation10945 -Node: Quoting12179 -Node: Escape Character13214 -Node: Single Quotes13645 -Node: Double Quotes13974 -Node: ANSI-C Quoting14670 -Node: Locale Translation15402 -Node: Comments15823 -Node: Simple Commands16347 -Node: Pipelines16936 -Node: Lists18007 -Node: Looping Constructs19282 -Node: Conditional Constructs20459 -Node: Command Grouping22526 -Node: Shell Functions23912 -Node: Shell Parameters25685 -Node: Positional Parameters27008 -Node: Special Parameters27702 -Node: Shell Expansions30268 -Node: Shell Parameter Expansion32272 -Node: Command Substitution38280 -Node: Process Substitution39280 -Node: Word Splitting40186 -Node: Filename Expansion41638 -Node: Quote Removal44004 -Node: Redirections44290 -Node: Executing Commands50031 -Node: Command Search and Execution50486 -Node: Environment52220 -Node: Exit Status53856 -Node: Signals54873 -Node: Shell Scripts56084 -Node: Bourne Shell Features57953 -Node: Bourne Shell Builtins58623 -Node: Bourne Shell Variables66977 -Node: Other Bourne Shell Features68514 -Node: Major Differences From The Bourne Shell69271 -Node: Csh Features79631 -Node: Brace Expansion80549 -Node: Tilde Expansion82104 -Node: C Shell Builtins82736 -Node: C Shell Variables87292 -Node: Korn Shell Features87700 -Node: Korn Shell Constructs88428 -Node: Korn Shell Builtins90143 -Node: Korn Shell Variables92301 -Node: Aliases93860 -Node: Alias Builtins96326 -Node: Bash Features96942 -Node: Invoking Bash97933 -Node: Bash Startup Files101798 -Node: Is This Shell Interactive?105373 -Node: Bash Builtins106356 -Node: The Set Builtin122211 -Node: Bash Conditional Expressions127586 -Node: Bash Variables132237 -Node: Shell Arithmetic142271 -Node: Arithmetic Evaluation142739 -Node: Arithmetic Expansion144769 -Node: Arithmetic Builtins145573 -Node: Arrays146044 -Node: Printing a Prompt149071 -Node: The Restricted Shell150669 -Node: Bash POSIX Mode151899 -Node: Job Control155583 -Node: Job Control Basics156048 -Node: Job Control Builtins160191 -Node: Job Control Variables163114 -Node: Using History Interactively164261 -Node: Bash History Facilities164850 -Node: History Interaction167248 -Node: Event Designators169810 -Node: Word Designators170737 -Node: Modifiers171986 -Node: Command Line Editing173303 -Node: Introduction and Notation173963 -Node: Readline Interaction175001 -Node: Readline Bare Essentials176193 -Node: Readline Movement Commands177736 -Node: Readline Killing Commands178648 -Node: Readline Arguments180368 -Node: Searching181345 -Node: Readline Init File182981 -Node: Readline Init File Syntax184037 -Node: Conditional Init Constructs191820 -Node: Sample Init File194101 -Node: Bindable Readline Commands197134 -Node: Commands For Moving197884 -Node: Commands For History198731 -Node: Commands For Text201404 -Node: Commands For Killing203148 -Node: Numeric Arguments205174 -Node: Commands For Completion206300 -Node: Keyboard Macros209262 -Node: Miscellaneous Commands209820 -Node: Readline vi Mode214036 -Node: Installing Bash214914 -Node: Basic Installation215983 -Node: Compilers and Options218908 -Node: Compiling For Multiple Architectures219642 -Node: Installation Names221299 -Node: Specifying the System Type222021 -Node: Sharing Defaults222732 -Node: Operation Controls223397 -Node: Optional Features224302 -Node: Reporting Bugs229185 -Node: Builtin Index230265 -Node: Reserved Word Index233732 -Node: Variable Index235059 -Node: Function Index240327 -Node: Concept Index244750 +Node: Top1197 +Node: Introduction3153 +Node: What is Bash?3378 +Node: What is a shell?4472 +Node: Definitions6494 +Node: Basic Shell Features9155 +Node: Shell Syntax10378 +Node: Shell Operation10667 +Node: Quoting11961 +Node: Escape Character12986 +Node: Single Quotes13458 +Node: Double Quotes13787 +Node: ANSI-C Quoting14685 +Node: Locale Translation15554 +Node: Comments15975 +Node: Shell Commands16589 +Node: Simple Commands17100 +Node: Pipelines17659 +Node: Lists19186 +Node: Looping Constructs20641 +Node: Conditional Constructs22246 +Node: Command Grouping28184 +Node: Shell Functions29561 +Node: Shell Parameters31525 +Node: Positional Parameters32851 +Node: Special Parameters33600 +Node: Shell Expansions36221 +Node: Brace Expansion38144 +Node: Tilde Expansion39705 +Node: Shell Parameter Expansion42037 +Node: Command Substitution48379 +Node: Arithmetic Expansion49653 +Node: Process Substitution50498 +Node: Word Splitting51392 +Node: Filename Expansion52844 +Node: Pattern Matching54808 +Node: Quote Removal57197 +Node: Redirections57483 +Node: Executing Commands63553 +Node: Simple Command Expansion64220 +Node: Command Search and Execution66143 +Node: Command Execution Environment68146 +Node: Environment70600 +Node: Exit Status72257 +Node: Signals73454 +Node: Shell Scripts75349 +Node: Bourne Shell Features77385 +Node: Bourne Shell Builtins78115 +Node: Bourne Shell Variables92056 +Node: Other Bourne Shell Features93761 +Node: Major Differences From The Bourne Shell94504 +Node: Bash Features106693 +Node: Invoking Bash107796 +Node: Bash Startup Files111981 +Node: Is This Shell Interactive?115540 +Node: Bash Builtins116511 +Node: The Set Builtin137351 +Node: Bash Conditional Expressions143960 +Node: Bash Variables147033 +Node: Shell Arithmetic159463 +Node: Aliases161511 +Node: Alias Builtins164086 +Node: Arrays164702 +Node: The Directory Stack167723 +Node: Printing a Prompt171073 +Node: The Restricted Shell172736 +Node: Bash POSIX Mode174072 +Node: Job Control178233 +Node: Job Control Basics178699 +Node: Job Control Builtins182898 +Node: Job Control Variables187190 +Node: Using History Interactively188340 +Node: Bash History Facilities189019 +Node: Bash History Builtins191360 +Node: History Interaction194728 +Node: Event Designators197280 +Node: Word Designators198207 +Node: Modifiers199456 +Node: Command Line Editing200773 +Node: Introduction and Notation201433 +Node: Readline Interaction202471 +Node: Readline Bare Essentials203663 +Node: Readline Movement Commands205203 +Node: Readline Killing Commands206168 +Node: Readline Arguments207883 +Node: Searching208857 +Node: Readline Init File210475 +Node: Readline Init File Syntax211514 +Node: Conditional Init Constructs220379 +Node: Sample Init File222817 +Node: Bindable Readline Commands225986 +Node: Commands For Moving226736 +Node: Commands For History227583 +Node: Commands For Text230412 +Node: Commands For Killing232146 +Node: Numeric Arguments234295 +Node: Commands For Completion235421 +Node: Keyboard Macros238991 +Node: Miscellaneous Commands239549 +Node: Readline vi Mode243869 +Node: Installing Bash244747 +Node: Basic Installation245824 +Node: Compilers and Options248734 +Node: Compiling For Multiple Architectures249468 +Node: Installation Names251125 +Node: Specifying the System Type251850 +Node: Sharing Defaults252554 +Node: Operation Controls253219 +Node: Optional Features254124 +Node: Reporting Bugs260319 +Node: Builtin Index261390 +Node: Reserved Word Index264793 +Node: Variable Index266251 +Node: Function Index271456 +Node: Concept Index275885 End Tag Table diff --git a/doc/bashref.texi b/doc/bashref.texi index 2d1717d..854090e 100644 --- a/doc/bashref.texi +++ b/doc/bashref.texi @@ -5,13 +5,13 @@ @c %**end of header @ignore -last change: Mon May 19 12:55:22 EDT 1997 +last change: Wed Mar 25 11:36:48 EST 1998 @end ignore -@set EDITION 2.0 -@set VERSION 2.01 -@set UPDATED 19 May 1997 -@set UPDATE-MONTH May 1997 +@set EDITION 2.2 +@set VERSION 2.02 +@set UPDATED 1 April 1998 +@set UPDATE-MONTH April 1998 @iftex @finalout @@ -22,12 +22,12 @@ last change: Mon May 19 12:55:22 EDT 1997 @defcodeindex rw @set BashFeatures +@ifinfo @dircategory Utilities @direntry -* Bash: (bash). GNU Bourne-Again SHell + * Bash: (bash). The GNU Bourne-Again SHell. @end direntry -@ifinfo @format This text is a brief description of the features that are present in the Bash shell. @@ -36,7 +36,7 @@ This is Edition @value{EDITION}, last updated @value{UPDATED}, of @cite{The GNU Bash Reference Manual}, for @code{Bash}, Version @value{VERSION}. -Copyright (C) 1991, 1993, 1996 Free Software Foundation, Inc. +Copyright (C) 1991, 1993, 1996, 1997 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -57,7 +57,7 @@ notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved -by the Foundation. +by the Free Software Foundation. @end format @end ifinfo @@ -125,12 +125,6 @@ reference on shell behavior. * Bourne Shell Features:: Features similar to those found in the Bourne shell. -* Csh Features:: Features originally found in the - Berkeley C-Shell. - -* Korn Shell Features:: Features originally found in the Korn - Shell. - * Bash Features:: Features found only in Bash. * Job Control:: A chapter describing what job control is @@ -181,16 +175,17 @@ of Unix. Bash is an @code{sh}-compatible shell that incorporates useful features from the Korn shell @code{ksh} and the C shell @code{csh}. -It is ultimately intended to be a -conformant implementation of the @sc{IEEE} @sc{POSIX} Shell and Tools -specification (@sc{IEEE} Working Group 1003.2). It offers functional -improvements over @code{sh} for both interactive and programming use. +It is intended to be a conformant implementation of the @sc{IEEE} +@sc{POSIX} Shell and Tools specification (@sc{IEEE} Working Group 1003.2). +It offers functional improvements over @code{sh} for both interactive and +programming use. While the @sc{GNU} operating system will include a version of @code{csh}, Bash will be the default shell. Like other @sc{GNU} software, Bash is quite portable. It currently runs on nearly every version of Unix and a few other operating systems @minus{} -independently-supported ports exist for @sc{OS/2} and Windows @sc{NT}. +independently-supported ports exist for @sc{MS-DOS}, @sc{OS/2}, +Windows @sc{95}, and Windows @sc{NT}. @node What is a shell? @section What is a shell? @@ -199,14 +194,17 @@ At its base, a shell is simply a macro processor that executes commands. A Unix shell is both a command interpreter, which provides the user interface to the rich set of Unix utilities, and a programming language, allowing these utilitites to be -combined. The shell reads commands either from a terminal or a -file. Files containing commands can be created, and become +combined. Files containing commands can be created, and become commands themselves. These new commands have the same status as system commands in directories like @file{/bin}, allowing users or groups to establish custom environments. A shell allows execution of Unix commands, both synchronously and -asynchronously. The @dfn{redirection} constructs permit +asynchronously. +The shell waits for synchronous commands to complete before accepting +more input; asynchronous commands continue to execute in parallel +with the shell while it reads and executes additional commands. +The @dfn{redirection} constructs permit fine-grained control of the input and output of those commands, and the shell allows control over the contents of their environment. Unix shells also provide a small set of built-in @@ -351,7 +349,7 @@ All of the Bourne shell builtin commands are available in Bash, and the rules for evaluation and quoting are taken from the @sc{POSIX} 1003.2 specification for the `standard' Unix shell. -This chapter briefly summarizes the shell's "building blocks": +This chapter briefly summarizes the shell's `building blocks': commands, control structures, shell functions, shell @i{parameters}, shell expansions, @i{redirections}, which are a way to direct input and output from @@ -359,13 +357,7 @@ and to named files, and how the shell executes commands. @menu * Shell Syntax:: What your input means to the shell. -* Simple Commands:: The most common type of command. -* Pipelines:: Connecting the input and output of several - commands. -* Lists:: How to execute commands sequentially. -* Looping Constructs:: Shell commands for iterative action. -* Conditional Constructs:: Shell commands for conditional execution. -* Command Grouping:: Ways to group commands. +* Shell Commands:: The types of commands you can use. * Shell Functions:: Grouping commands by name. * Shell Parameters:: Special shell variables. * Shell Expansions:: How Bash expands variables and the various @@ -400,12 +392,13 @@ supplied as an argument to the @samp{-c} invocation option @item Breaks the input into words and operators, obeying the quoting rules -described in @ref{Quoting}. Tokens are separated by +described in @ref{Quoting}. These tokens are separated by @code{metacharacters}. Alias expansion is performed by this step (@pxref{Aliases}). @item -Parses the tokens into simple and compound commands. +Parses the tokens into simple and compound commands +(@pxref{Shell Commands}). @item Performs the various shell expansions (@pxref{Shell Expansions}), breaking @@ -421,7 +414,7 @@ Executes the command (@pxref{Executing Commands}). @item Optionally waits for the command to complete and collects its exit -status. +status (@pxref{Exit Status}). @end enumerate @@ -446,9 +439,9 @@ disable special treatment for special characters, to prevent reserved words from being recognized as such, and to prevent parameter expansion. -Each of the shell @code{metacharacters} (@pxref{Definitions}) -has special meaning to the shell and must be quoted if they are to -represent themselves. There are three quoting mechanisms: the +Each of the shell metacharacters (@pxref{Definitions}) +has special meaning to the shell and must be quoted if it is to +represent itself. There are three quoting mechanisms: the @var{escape character}, single quotes, and double quotes. @node Escape Character @@ -456,8 +449,9 @@ represent themselves. There are three quoting mechanisms: the A non-quoted backslash @samp{\} is the Bash escape character. It preserves the literal value of the next character that follows, with the exception of @code{newline}. If a @code{\newline} pair -appears, and the backslash is not quoted, the @code{\newline} -is treated as a line continuation (that is, it is effectively ignored). +appears, and the backslash itself is not quoted, the @code{\newline} +is treated as a line continuation (that is, it is removed from +the input stream and effectively ignored). @node Single Quotes @subsubsection Single Quotes @@ -473,10 +467,13 @@ Enclosing characters in double quotes preserves the literal value of all characters within the quotes, with the exception of @samp{$}, @samp{`}, and @samp{\}. The characters @samp{$} and @samp{`} -retain their special meaning within double quotes. The backslash -retains its special meaning only when followed by one of the following -characters: +retain their special meaning within double quotes (@pxref{Shell Expansions}). +The backslash retains its special meaning only when followed by one of +the following characters: @samp{$}, @samp{`}, @samp{"}, @samp{\}, or @code{newline}. +Within double quotes, backslashes that are followed by one of these +characters are removed. Backslashes preceding characters without a +special meaning are left unmodified. A double quote may be quoted within double quotes by preceding it with a backslash. @@ -512,7 +509,11 @@ vertical tab @item \\ backslash @item \@var{nnn} -the character whose @code{ASCII} code is @var{nnn} in octal +the character whose @code{ASCII} code is the octal value @var{nnn} +(one to three digits) +@item \x@var{nnn} +the character whose @code{ASCII} code is the hexadecimal value @var{nnn} +(one to three digits) @end table @noindent @@ -541,14 +542,29 @@ causes that word and all remaining characters on that line to be ignored. An interactive shell without the @code{interactive_comments} option enabled does not allow comments. The @code{interactive_comments} option is on by default in interactive shells. +@xref{Is This Shell Interactive?}, for a description of what makes +a shell interactive. + +@node Shell Commands +@section Shell Commands +@cindex commands, shell +@menu +* Simple Commands:: The most common type of command. +* Pipelines:: Connecting the input and output of several + commands. +* Lists:: How to execute commands sequentially. +* Looping Constructs:: Shell commands for iterative action. +* Conditional Constructs:: Shell commands for conditional execution. +* Command Grouping:: Ways to group commands. +@end menu @node Simple Commands -@section Simple Commands +@subsection Simple Commands @cindex commands, simple -A simple command is the kind of command you'll encounter most often. +A simple command is the kind of command encountered most often. It's just a sequence of words separated by @code{blank}s, terminated -by one of the shell control operators (@pxref{Definitions}). The +by one of the shell's control operators (@pxref{Definitions}). The first word generally specifies a command to be executed. The return status (@pxref{Exit Status}) of a simple command is @@ -557,7 +573,7 @@ by the @sc{POSIX.1} @code{waitpid} function, or 128+@var{n} if the command was terminated by signal @var{n}. @node Pipelines -@section Pipelines +@subsection Pipelines @cindex pipeline @cindex commands, pipelines @@ -579,19 +595,28 @@ output. The reserved word @code{time} causes timing statistics to be printed for the pipeline once it finishes. +The statistics currently consist of elapsed (wall-clock) time and +user and system time consumed by the command's execution. The @samp{-p} option changes the output format to that specified by @sc{POSIX}. The @code{TIMEFORMAT} variable may be set to a format string that specifies how the timing information should be displayed. @xref{Bash Variables}, for a description of the available formats. +The use of @code{time} as a reserved word permits the timing of +shell builtins, shell functions, and pipelines. An external +@code{time} command cannot time these easily. + +If the pipeline is not executed asynchronously (@pxref{Lists}), the +shell waits for all commands in the pipeline to complete. -Each command in a pipeline is executed in its own subshell. The exit +Each command in a pipeline is executed in its own subshell +(@pxref{Command Execution Environment}). The exit status of a pipeline is the exit status of the last command in the pipeline. If the reserved word @samp{!} precedes the pipeline, the -exit status is the logical @sc{NOT} of the exit status of the last command. +exit status is the logical negation of the exit status of the last command. @node Lists -@section Lists of Commands +@subsection Lists of Commands @cindex commands, lists A @code{list} is a sequence of one or more pipelines separated by one @@ -604,11 +629,15 @@ have equal precedence, followed by @samp{;} and @samp{&}, which have equal precedence. If a command is terminated by the control operator @samp{&}, -the shell executes the command in the @var{background} -in a subshell. The shell does not wait for the command to -finish, and the return status is 0 (true). Commands separated by a -@samp{;} are executed sequentially; the shell waits for each -command to terminate in turn. The return status is the +the shell executes the command asynchronously in a subshell. +This is known as executing the command in the @var{background}. +The shell does not wait for the command to finish, and the return +status is 0 (true). +The standard input for asynchronous commands, in the absence of any +explicit redirections, is redirected from @code{/dev/null}. + +Commands separated by a @samp{;} are executed sequentially; the shell +waits for each command to terminate in turn. The return status is the exit status of the last command executed. The control operators @samp{&&} and @samp{||} @@ -628,7 +657,7 @@ An @sc{OR} list has the form @end example @noindent -@var{command2} is executed if and only if @var{command} +@var{command2} is executed if, and only if, @var{command} returns a non-zero exit status. The return status of @@ -636,15 +665,14 @@ The return status of executed in the list. @node Looping Constructs -@section Looping Constructs +@subsection Looping Constructs @cindex commands, looping -Note that wherever you see a @samp{;} in the description of a -command's syntax, it may be replaced indiscriminately with -one or more newlines. - Bash supports the following looping constructs. +Note that wherever you see a @samp{;} in the description of a +command's syntax, it may be replaced with one or more newlines. + @table @code @item until @rwindex until @@ -654,8 +682,10 @@ The syntax of the @code{until} command is: @example until @var{test-commands}; do @var{consequent-commands}; done @end example -Execute @var{consequent-commands} as long as the final command in +Execute @var{consequent-commands} as long as @var{test-commands} has an exit status which is not zero. +The return status is the exit status of the last command executed +in @var{consequent-commands}, or zero if none was executed. @item while @rwindex while @@ -664,8 +694,10 @@ The syntax of the @code{while} command is: while @var{test-commands}; do @var{consequent-commands}; done @end example -Execute @var{consequent-commands} as long as the final command in +Execute @var{consequent-commands} as long as @var{test-commands} has an exit status of zero. +The return status is the exit status of the last command executed +in @var{consequent-commands}, or zero if none was executed. @item for @rwindex for @@ -674,17 +706,19 @@ The syntax of the @code{for} command is: @example for @var{name} [in @var{words} @dots{}]; do @var{commands}; done @end example -Execute @var{commands} for each member in @var{words}, with @var{name} -bound to the current member. If @samp{in @var{words}} is not -present, @samp{in "$@@"} is assumed. - +Expand @var{words}, and execute @var{commands} once for each member +in the resultant list, with @var{name} bound to the current member. +If @samp{in @var{words}} is not present, @samp{in "$@@"} is assumed. +The return status is the exit status of the last command that executes. +If there are no items in the expansion of @var{words}, no commands are +executed, and the return status is zero. @end table The @code{break} and @code{continue} builtins (@pxref{Bourne Shell Builtins}) may be used to control loop execution. @node Conditional Constructs -@section Conditional Constructs +@subsection Conditional Constructs @cindex commands, conditional @table @code @@ -705,15 +739,17 @@ if @var{test-commands}; then fi @end example -Execute @var{consequent-commands} only if the final command in -@var{test-commands} has an exit status of zero. -Otherwise, each @code{elif} list is executed in turn, -and if its exit status is zero, +The @var{test-commands} list is executed, and if its return status is zero, +the @var{consequent-commands} list is executed. +If @var{test-commands} returns a non-zero status, each @code{elif} list +is executed in turn, and if its exit status is zero, the corresponding @var{more-consequents} is executed and the command completes. If @samp{else @var{alternate-consequents}} is present, and the final command in the final @code{if} or @code{elif} clause -has a non-zero exit status, then execute @var{alternate-consequents}. +has a non-zero exit status, then @var{alternate-consequents} is executed. +The return status is the exit status of the last command executed, or +zero if no condition tested true. @item case @rwindex case @@ -722,11 +758,23 @@ has a non-zero exit status, then execute @var{alternate-consequents}. The syntax of the @code{case} command is: @example -@code{case @var{word} in [ ( @var{pattern} [| @var{pattern}]@dots{}) @var{commands} ;;]@dots{} esac} +@code{case @var{word} in [ [(] @var{pattern} [| @var{pattern}]@dots{}) @var{command-list} ;;]@dots{} esac} @end example -Selectively execute @var{commands} based upon @var{word} matching -@var{pattern}. The @samp{|} is used to separate multiple patterns. +@code{case} will selectively execute the @var{command-list} corresponding to +the first @var{pattern} that matches @var{word}. +The @samp{|} is used to separate multiple patterns, and the @samp{)} +operator terminates a pattern list. +A list of patterns and an associated command-list is known +as a @var{clause}. Each clause must be terminated with @samp{;;}. +The @var{word} undergoes tilde expansion, parameter expansion, command +substitution, arithmetic expansion, and quote removal before matching is +attempted. Each @var{pattern} undergoes tilde expansion, parameter +expansion, command substitution, and arithmetic expansion. + +There may be an arbitrary number of @code{case} clauses, each terminated +by a @samp{;;}. The first pattern that matches determines the +command-list that is executed. Here is an example using @code{case} in a script that could be used to describe one interesting feature of an animal: @@ -743,27 +791,115 @@ esac echo " legs." @end example +@noindent +The return status is zero if no @var{pattern} is matched. Otherwise, the +return status is the exit status of the @var{command-list} executed. + +@item select +@rwindex select + +The @code{select} construct allows the easy generation of menus. +It has almost the same syntax as the @code{for} command: + +@example +select @var{name} [in @var{words} @dots{}]; do @var{commands}; done +@end example + +The list of words following @code{in} is expanded, generating a list +of items. The set of expanded words is printed on the standard +error output stream, each preceded by a number. If the +@samp{in @var{words}} is omitted, the positional parameters are printed, +as if @samp{in "$@@"} had been specifed. +The @code{PS3} prompt is then displayed and a line is read from the +standard input. +If the line consists of a number corresponding to one of the displayed +words, then the value of @var{name} is set to that word. +If the line is empty, the words and prompt are displayed again. +If @code{EOF} is read, the @code{select} command completes. +Any other value read causes @var{name} to be set to null. +The line read is saved in the variable @code{REPLY}. + +The @var{commands} are executed after each selection until a +@code{break} or @code{return} command is executed, at which +point the @code{select} command completes. + +Here is an example that allows the user to pick a filename from the +current directory, and displays the name and index of the file +selected. + +@example +select fname in *; +do + echo you picked $fname \($REPLY\) + break; +done +@end example + @item ((@dots{})) @example (( @var{expression} )) @end example -The @var{expression} is evaluated according to the rules described -below (@pxref{Arithmetic Evaluation}). +The arithmetic @var{expression} is evaluated according to the rules +described below (@pxref{Shell Arithmetic}). If the value of the expression is non-zero, the return status is 0; otherwise the return status is 1. This is exactly equivalent to @example let "@var{expression}" @end example +@noindent +@xref{Bash Builtins}, for a full description of the @code{let} builtin. +@item [[@dots{}]] +@rwindex [[ +@rwindex ]] +@example +[[ @var{expression} ]] +@end example + +Return a status of 0 or 1 depending on the evaluation of +the conditional expression @var{expression}. +Expressions are composed of the primaries described below in +@ref{Bash Conditional Expressions}. +Word splitting and filename expansion are not performed on the words +between the @samp{[[} and @samp{]]}; tilde expansion, parameter and +variable expansion, arithmetic expansion, command substitution, process +substitution, and quote removal are performed. + +When the @samp{==} and @samp{!=} operators are used, the string to the +right of the operator is considered a pattern and matched according +to the rules described below in @ref{Pattern Matching}. +The return value is 0 if the string matches or does not match +the pattern, respectively, and 1 otherwise. +Any part of the pattern may be quoted to force it to be matched as a +string. + +Expressions may be combined using the following operators, listed +in decreasing order of precedence: + +@table @code +@item ( @var{expression} ) +Returns the value of @var{expression}. +This may be used to override the normal precedence of operators. + +@item ! @var{expression} +True if @var{expression} is false. + +@item @var{expression1} && @var{expression2} +True if both @var{expression1} and @var{expression2} are true. + +@item @var{expression1} || @var{expression2} +True if either @var{expression1} or @var{expression2} is true. @end table +@noindent +The && and || commands do not execute @var{expression2} if the +value of @var{expression1} is sufficient to determine the return +value of the entire conditional expression. -The @code{select} construct, which allows users to choose from a list -of items presented as a menu, is also available. -@xref{Korn Shell Constructs}, for a full description of @code{select}. +@end table @node Command Grouping -@section Grouping Commands +@subsection Grouping Commands @cindex commands, grouping Bash provides two ways to group a list of commands to be executed @@ -778,9 +914,9 @@ commands in the list may be redirected to a single stream. @end example Placing a list of commands between parentheses causes a subshell -to be created, and each of the commands to be executed in that -subshell. Since the @var{list} is executed in a subshell, variable -assignments do not remain in effect after the subshell completes. +to be created, and each of the commands in @var{list} to be executed +in that subshell. Since the @var{list} is executed in a subshell, +variable assignments do not remain in effect after the subshell completes. @item @{@} @rwindex @{ @@ -791,7 +927,7 @@ assignments do not remain in effect after the subshell completes. Placing a list of commands between curly braces causes the list to be executed in the current shell context. No subshell is created. -The semicolon following @var{list} is required. +The semicolon (or newline) following @var{list} is required. @end table In addition to the creation of a subshell, there is a subtle difference @@ -821,9 +957,11 @@ Functions are declared using this syntax: @end example This defines a shell function named @var{name}. The reserved -word @code{function} is optional. The @var{body} of the -function is the @var{command-list} between @{ and @}. This list -is executed whenever @var{name} is specified as the +word @code{function} is optional. +If the @code{function} reserved +word is supplied, the parentheses are optional. +The @var{body} of the function is the @var{command-list} between @{ and @}. +This list is executed whenever @var{name} is specified as the name of a command. The exit status of a function is the exit status of the last command executed in the body. @@ -839,9 +977,11 @@ is executed in a function, the function completes and execution resumes with the next command after the function call. When a function completes, the values of the positional parameters and the special parameter @samp{#} -are restored to the values they had prior to function +are restored to the values they had prior to the function's execution. If a numeric argument is given to @code{return}, -that is the function return status. +that is the function's return status; otherwise the functions's +return status is the exit status of the last command executed +before the @code{return}. Variables local to the function may be declared with the @code{local} builtin. These variables are visible only to @@ -880,11 +1020,11 @@ If @var{value} is not given, the variable is assigned the null string. All @var{value}s undergo tilde expansion, parameter and variable expansion, command substitution, arithmetic expansion, and quote -removal (detailed below). If the variable has its @samp{-i} attribute -set (see the description of the @code{declare} builtin in +removal (detailed below). If the variable has its @code{integer} +attribute set (see the description of the @code{declare} builtin in @ref{Bash Builtins}), then @var{value} is subject to arithmetic expansion even if the @code{$((@dots{}))} -syntax does not appear (@pxref{Arithmetic Expansion}). +expansion is not used (@pxref{Arithmetic Expansion}). Word splitting is not performed, with the exception of @code{"$@@"} as explained below. Filename expansion is not performed. @@ -893,12 +1033,12 @@ Filename expansion is not performed. @subsection Positional Parameters @cindex parameters, positional -A @var{positional parameter} -is a parameter denoted by one or more +A @var{positional parameter} is a parameter denoted by one or more digits, other than the single digit @code{0}. Positional parameters are assigned from the shell's arguments when it is invoked, -and may be reassigned using the @code{set} -builtin command. Positional parameters may not be assigned to +and may be reassigned using the @code{set} builtin command. +Positional parameter @code{N} may be referenced as @code{$@{N@}}. +Positional parameters may not be assigned to with assignment statements. The positional parameters are temporarily replaced when a shell function is executed (@pxref{Shell Functions}). @@ -931,7 +1071,7 @@ separators. @item @@ Expands to the positional parameters, starting from one. When the -expansion occurs within double quotes, each parameter expands as a +expansion occurs within double quotes, each parameter expands to a separate word. That is, @code{"$@@"} is equivalent to @code{"$1" "$2" @dots{}}. When there are no positional parameters, @code{"$@@"} and @@ -953,8 +1093,7 @@ builtin command, or those set by the shell itself @item $ Expands to the process @sc{ID} of the shell. In a @code{()} subshell, it -expands to the process @sc{ID} of the current shell, not the -subshell. +expands to the process @sc{ID} of the invoking shell, not the subshell. @item ! Expands to the process @sc{ID} of the most recently executed background @@ -962,10 +1101,10 @@ Expands to the process @sc{ID} of the most recently executed background @item 0 Expands to the name of the shell or shell script. This is set at -shell initialization. If Bash is invoked with a file of commands, -@code{$0} is set to the name of that file. If Bash -is started with the @samp{-c} option, then @code{$0} -is set to the first argument after the string to be +shell initialization. If Bash is invoked with a file of commands +(@pxref{Shell Scripts}), @code{$0} is set to the name of that file. +If Bash is started with the @samp{-c} option (@pxref{Invoking Bash}), +then @code{$0} is set to the first argument after the string to be executed, if one is present. Otherwise, it is set to the filename used to invoke Bash, as given by argument zero. @@ -974,7 +1113,7 @@ At shell startup, set to the absolute filename of the shell or shell script being executed as passed in the argument list. Subsequently, expands to the last argument to the previous command, after expansion. -Also set to the full filename of each command executed and placed in +Also set to the full pathname of each command executed and placed in the environment exported to that command. When checking mail, this parameter holds the name of the mail file. @end vtable @@ -996,8 +1135,11 @@ Expansion is performed on the command line after it has been split into @end itemize @menu +* Brace Expansion:: Expansion of expressions within braces. +* Tilde Expansion:: Expansion of the ~ character. * Shell Parameter Expansion:: How Bash expands variables to their values. * Command Substitution:: Using the output of a command as an argument. +* Arithmetic Expansion:: How to use arithmetic in shell expansions. * Process Substitution:: A way to write and read to and from a command. * Word Splitting:: How the results of expansion are split into separate @@ -1007,11 +1149,6 @@ Expansion is performed on the command line after it has been split into words. @end menu -Brace expansion, tilde expansion, and arithmetic expansion are described -in other sections. For brace expansion, see @ref{Brace Expansion}; for -tilde expansion, see @ref{Tilde Expansion}; and for arithmetic expansion, -see @ref{Arithmetic Expansion}. - The order of expansions is: brace expansion, tilde expansion, parameter, variable, and arithmetic expansion and command substitution @@ -1020,7 +1157,7 @@ expansion. On systems that can support it, there is an additional expansion available: @var{process substitution}. This is performed at the -same time as parameter, variable, and arithemtic expansion and +same time as parameter, variable, and arithmetic expansion and command substitution. Only brace expansion, word splitting, and filename expansion @@ -1033,6 +1170,124 @@ The only exceptions to this are the expansions of After all expansions, @code{quote removal} (@pxref{Quote Removal}) is performed. +@node Brace Expansion +@subsection Brace Expansion +@cindex brace expansion +@cindex expansion, brace + +Brace expansion +is a mechanism by which arbitrary strings +may be generated. This mechanism is similar to +@var{filename expansion} (@pxref{Filename Expansion}), +but the file names generated +need not exist. Patterns to be brace expanded take +the form of an optional @var{preamble}, +followed by a series of comma-separated strings +between a pair of braces, followed by an optional @var{postscript}. +The preamble is prepended to each string contained +within the braces, and the postscript is then appended +to each resulting string, expanding left to right. + +Brace expansions may be nested. The results of each expanded +string are not sorted; left to right order is preserved. +For example, +@example +bash$ echo a@{d,c,b@}e +ade ace abe +@end example + +Brace expansion is performed before any other expansions, +and any characters special to other expansions are preserved +in the result. It is strictly textual. Bash +does not apply any syntactic interpretation to the context of the +expansion or the text between the braces. + +A correctly-formed brace expansion must contain unquoted opening +and closing braces, and at least one unquoted comma. +Any incorrectly formed brace expansion is left unchanged. + +This construct is typically used as shorthand when the common +prefix of the strings to be generated is longer than in the +above example: +@example +mkdir /usr/local/src/bash/@{old,new,dist,bugs@} +@end example +or +@example +chown root /usr/@{ucb/@{ex,edit@},lib/@{ex?.?*,how_ex@}@} +@end example + +@node Tilde Expansion +@subsection Tilde Expansion +@cindex tilde expansion +@cindex expansion, tilde + +If a word begins with an unquoted tilde character (@samp{~}), all of the +characters up to the first unquoted slash (or all characters, +if there is no unquoted slash) are considered a @var{tilde-prefix}. +If none of the characters in the tilde-prefix are quoted, the +characters in the tilde-prefix following the tilde are treated as a +possible @var{login name}. +If this login name is the null string, the tilde is replaced with the +value of the @code{HOME} shell variable. +If @code{HOME} is unset, the home directory of the user executing the +shell is substituted instead. +Otherwise, the tilde-prefix is replaced with the home directory +associated with the specified login name. + +If the tilde-prefix is @samp{~+}, the value of +the shell variable @code{PWD} replaces the tilde-prefix. +If the tilde-prefix is @samp{~-}, the value of the shell variable +@code{OLDPWD}, if it is set, is substituted. + +If the characters following the tilde in the tilde-prefix consist of a +number @var{N}, optionally prefixed by a @samp{+} or a @samp{-}, +the tilde-prefix is replaced with the +corresponding element from the directory stack, as it would be displayed +by the @code{dirs} builtin invoked with the characters following tilde +in the tilde-prefix as an argument (@pxref{The Directory Stack}). +If the tilde-prefix, sans the tilde, consists of a number without a +leading @samp{+} or @samp{-}, @samp{+} is assumed. + +If the login name is invalid, or the tilde expansion fails, the word is +left unchanged. + +Each variable assignment is checked for unquoted tilde-prefixes immediately +following a @samp{:} or @samp{=}. +In these cases, tilde expansion is also performed. +Consequently, one may use file names with tildes in assignments to +@code{PATH}, @code{MAILPATH}, and @code{CDPATH}, +and the shell assigns the expanded value. + +The following table shows how Bash treats unquoted tilde-prefixes: + +@table @code +@item ~ +The value of @code{$HOME} +@item ~/foo +@file{$HOME/foo} + +@item ~fred/foo +The subdirectory @code{foo} of the home directory of the user +@code{fred} + +@item ~+/foo +@file{$PWD/foo} + +@item ~-/foo +@file{$@{OLDPWD-'~-'@}/foo} + +@item ~@var{N} +The string that would be displayed by @samp{dirs +@var{N}} + +@item ~+@var{N} +The string that would be displayed by @samp{dirs +@var{N}} + +@item ~-@var{N} +The string that would be displayed by @samp{dirs -@var{N}} + +@end table + @node Shell Parameter Expansion @subsection Shell Parameter Expansion @cindex parameter expansion @@ -1045,6 +1300,11 @@ are optional but serve to protect the variable to be expanded from characters immediately following it which could be interpreted as part of the name. +When braces are used, the matching ending brace is the first @samp{@}} +not escaped by a backslash or within a quoted string, and not within an +embedded arithmetic expansion, command substitution, or parameter +expansion. + The basic form of parameter expansion is $@{@var{parameter}@}. The value of @var{parameter} is substituted. The braces are required when @var{parameter} @@ -1098,11 +1358,11 @@ is null or unset, nothing is substituted, otherwise the expansion of @item $@{@var{parameter}:@var{offset}@} @itemx $@{@var{parameter}:@var{offset}:@var{length}@} Expands to up to @var{length} characters of @var{parameter}, -starting at @var{offset}. +starting at the character specified by @var{offset}. If @var{length} is omitted, expands to the substring of @var{parameter}, starting at the character specified by @var{offset}. @var{length} and @var{offset} are arithmetic expressions -(@pxref{Arithmetic Evaluation}). +(@pxref{Shell Arithmetic}). This is referred to as Substring Expansion. @var{length} must evaluate to a number greater than or equal to zero. @@ -1112,27 +1372,25 @@ If @var{parameter} is @samp{@@}, the result is @var{length} positional parameters beginning at @var{offset}. If @var{parameter} is an array name indexed by @samp{@@} or @samp{*}, the result is the @var{length} -members of the array beginning with $@{@var{parameter}[@var{offset}]@}. -Substring indexing is zero-based unless the positional parameters are -used, in which case the indexing starts at 1. +members of the array beginning with @code{$@{@var{parameter}[@var{offset}]@}}. +Substring indexing is zero-based unless the positional parameters +are used, in which case the indexing starts at 1. @item $@{#@var{parameter}@} -The length in characters of the value of @var{parameter} is substituted. -If @var{parameter} -is @samp{*} or @samp{@@}, -the length substituted is the number of positional parameters. -If @var{parameter} -is an array name subscripted -by @samp{*} or @samp{@@}, -the length substituted is the number of elements in the array. +The length in characters of the expanded value of @var{parameter} is +substituted. +If @var{parameter} is @samp{*} or @samp{@@}, the value substituted +is the number of positional parameters. +If @var{parameter} is an array name subscripted by @samp{*} or @samp{@@}, +the value substituted is the number of elements in the array. @item $@{@var{parameter}#@var{word}@} @itemx $@{@var{parameter}##@var{word}@} The @var{word} is expanded to produce a pattern just as in filename expansion (@pxref{Filename Expansion}). If the pattern matches -the beginning of the value of @var{parameter}, -then the expansion is the value of @var{parameter} +the beginning of the expanded value of @var{parameter}, +then the result of the expansion is the expanded value of @var{parameter} with the shortest matching pattern (the @samp{#} case) or the longest matching pattern (the @samp{##} case) deleted. If @var{parameter} is @samp{@@} or @samp{*}, @@ -1147,10 +1405,10 @@ array in turn, and the expansion is the resultant list. @itemx $@{@var{parameter}%%@var{word}@} The @var{word} is expanded to produce a pattern just as in filename expansion. -If the pattern matches a trailing portion of the value of -@var{parameter}, then the expansion is the value of @var{parameter} -with the shortest matching pattern (the @samp{%} case) or the -longest matching pattern (the @samp{%%} case) deleted. +If the pattern matches a trailing portion of the expanded value of +@var{parameter}, then the result of the expansion is the value of +@var{parameter} with the shortest matching pattern (the @samp{%} case) +or the longest matching pattern (the @samp{%%} case) deleted. If @var{parameter} is @samp{@@} or @samp{*}, the pattern removal operation is applied to each positional parameter in turn, and the expansion is the resultant list. @@ -1204,19 +1462,48 @@ or Bash performs the expansion by executing @var{command} and replacing the command substitution with the standard output of the command, with any trailing newlines deleted. +Embedded newlines are not deleted, but they may be removed during +word splitting. +The command substitution @code{$(cat @var{file})} can be +replaced by the equivalent but faster @code{$(< @var{file})}. When the old-style backquote form of substitution is used, backslash retains its literal meaning except when followed by -@samp{$}, @samp{`}, or @samp{\}. +@samp{$}, @samp{`}, or @samp{\}. +The first backquote not preceded by a backslash terminates the +command substitution. When using the @code{$(@var{command})} form, all characters between the parentheses make up the command; none are treated specially. -Command substitutions may be nested. To nest when using the old form, -escape the inner backquotes with backslashes. +Command substitutions may be nested. To nest when using the backquoted +form, escape the inner backquotes with backslashes. If the substitution appears within double quotes, word splitting and filename expansion are not performed on the results. +@node Arithmetic Expansion +@subsection Arithmetic Expansion +@cindex expansion, arithmetic +@cindex arithmetic expansion + +Arithmetic expansion allows the evaluation of an arithmetic expression +and the substitution of the result. The format for arithmetic expansion is: + +@example +$(( @var{expression} )) +@end example + +The expression is treated as if it were within double quotes, but +a double quote inside the parentheses is not treated specially. +All tokens in the expression undergo parameter expansion, command +substitution, and quote removal. +Arithmetic substitutions may be nested. + +The evaluation is performed according to the rules listed below +(@pxref{Shell Arithmetic}). +If the expression is invalid, Bash prints a message indicating +failure to the standard error and no substitution occurs. + @node Process Substitution @subsection Process Substitution @cindex process substitution @@ -1241,9 +1528,9 @@ the file will provide input for @var{list}. If the @code{<(@var{list})} form is used, the file passed as an argument should be read to obtain the output of @var{list}. -On systems that support it, process substitution is performed -simultaneously with parameter and variable expansion, -command substitution, and arithmetic expansion. +When available, process substitution is performed simultaneously with +parameter and variable expansion, command substitution, and arithmetic +expansion. @node Word Splitting @subsection Word Splitting @@ -1282,38 +1569,46 @@ is performed. @node Filename Expansion @subsection Filename Expansion +@menu +* Pattern Matching:: How the shell matches patterns. +@end menu @cindex expansion, filename @cindex expansion, pathname @cindex filename expansion @cindex pathname expansion -After word splitting, -unless the @samp{-f} -option has been set (@pxref{The Set Builtin}), -Bash scans each word for the characters -@samp{*}, @samp{?}, and @samp{[}. +After word splitting, unless the @samp{-f} option has been set +(@pxref{The Set Builtin}), Bash scans each word for the characters +@samp{*}, @samp{?}, @samp{(}, and @samp{[}. If one of these characters appears, then the word is regarded as a @var{pattern}, and replaced with an alphabetically sorted list of file names matching the pattern. If no matching file names are found, and the shell option @code{nullglob} is disabled, the word is left -unchanged. If the option is set, and no matches are found, the word -is removed. When a pattern is used for filename generation, -the character @samp{.} +unchanged. +If the @code{nullglob} option is set, and no matches are found, the word +is removed. +If the shell option @code{nocaseglob} is enabled, the match is performed +without regard to the case of alphabetic characters. + +When a pattern is used for filename generation, the character @samp{.} at the start of a filename or immediately following a slash -must be matched explicitly, unless the shell option @code{dotglob} -is set. The slash character must always be matched explicitly. +must be matched explicitly, unless the shell option @code{dotglob} is set. +When matching a file name, the slash character must always be +matched explicitly. In other cases, the @samp{.} character is not treated specially. + See the description of @code{shopt} in @ref{Bash Builtins}, -for a description of the @code{nullglob} and @code{dotglob} options. +for a description of the @code{nocaseglob}, @code{nullglob}, +and @code{dotglob} options. The @code{GLOBIGNORE} shell variable may be used to restrict the set of filenames matching a -@var{pattern}. If @code{GLOBIGNORE} +pattern. If @code{GLOBIGNORE} is set, each matching filename that also matches one of the patterns in @code{GLOBIGNORE} is removed from the list of matches. The filenames @file{.} and @file{..} -are always ignored, even when @code{GLOBIGNORE}. +are always ignored, even when @code{GLOBIGNORE} is set. However, setting @code{GLOBIGNORE} has the effect of enabling the @code{dotglob} shell option, so all other filenames beginning with a @@ -1323,6 +1618,16 @@ To get the old behavior of ignoring filenames beginning with a The @code{dotglob} option is disabled when @code{GLOBIGNORE} is unset. +@node Pattern Matching +@subsubsection Pattern Matching +@cindex pattern matching +@cindex matching, pattern + +Any character that appears in a pattern, other than the special pattern +characters described below, matches itself. The NUL character may not +occur in a pattern. The special pattern characters must be quoted if +they are to be matched literally. + The special pattern characters have the following meanings: @table @code @item * @@ -1339,6 +1644,49 @@ then any character not enclosed is matched. A @samp{@minus{}} may be matched by including it as the first or last character in the set. A @samp{]} may be matched by including it as the first character in the set. + +Within @samp{[} and @samp{]}, @var{character classes} can be specified +using the syntax +@code{[:}@var{class}@code{:]}, where @var{class} is one of the +following classes defined in the @sc{POSIX.2} standard: +@example +alnum alpha ascii blank cntrl digit graph lower +print punct space upper xdigit +@end example +@noindent +A character class matches any character belonging to that class. + +Within @samp{[} and @samp{]}, an @var{equivalence class} can be +specified using the syntax @code{[=}@var{c}@code{=]}, which +matches all characters with the same collation weight (as defined +by the current locale) as the character @var{c}. + +Within @samp{[} and @samp{]}, the syntax @code{[.}@var{symbol}@code{.]} +matches the collating symbol @var{symbol}. +@end table + +If the @code{extglob} shell option is enabled using the @code{shopt} +builtin, several extended pattern matching operators are recognized. +In the following description, a @var{pattern-list} is a list of one +or more patterns separated by a @samp{|}. +Composite patterns may be formed using one or more of the following +sub-patterns: + +@table @code +@item ?(@var{pattern-list}) +Matches zero or one occurrence of the given patterns. + +@item *(@var{pattern-list}) +Matches zero or more occurrences of the given patterns. + +@item +(@var{pattern-list}) +Matches one or more occurrences of the given patterns. + +@item @@(@var{pattern-list}) +Matches exactly one of the given patterns. + +@item !(@var{pattern-list}) +Matches anything except one of the given patterns. @end table @node Quote Removal @@ -1369,11 +1717,11 @@ descriptor 0). If the first character of the redirection operator is @samp{>}, the redirection refers to the standard output (file descriptor 1). -The word that follows the redirection operator in the following -descriptions is subjected to brace expansion, tilde expansion, -parameter expansion, command substitution, arithmetic expansion, -quote removal, and filename expansion. If it expands to more -than one word, Bash reports an error. +The word following the redirection operator in the following +descriptions, unless otherwise noted, is subjected to brace expansion, +tilde expansion, parameter expansion, command substitution, arithmetic +expansion, quote removal, and filename expansion. +If it expands to more than one word, Bash reports an error. Note that the order of redirections is significant. For example, the command @@ -1391,6 +1739,8 @@ directs only the standard output to file @var{dirlist}, because the standard error was duplicated as standard output before the standard output was redirected to @var{dirlist}. +A failure to open or create a file causes the redirection to fail. + @subsection Redirecting Input Redirection of input causes the file whose name results from the expansion of @var{word} @@ -1416,13 +1766,13 @@ The general format for redirecting output is: [n]>[|]@var{word} @end example -If the redirection operator is @samp{>}, and the @samp{-C} option to the -@code{set} builtin has been enabled, the redirection will fail if the -filename whose name results from the expansion of @var{word} exists. -If the redirection operator is @samp{>|}, -then the value of the @samp{-C} option to the @code{set} -builtin command is not tested, and the redirection is attempted even -if the file named by @var{word} exists. +If the redirection operator is @samp{>}, and the @code{noclobber} +option to the @code{set} builtin has been enabled, the redirection +will fail if the filename whose name results from the expansion of +@var{word} exists and is a regular file. +If the redirection operator is @samp{>|}, or the redirection operator is +@samp{>} and the @code{noclobber} option is not enabled, the redirection +is attempted even if the file named by @var{word} exists. @subsection Appending Redirected Output Redirection of output in this fashion @@ -1479,7 +1829,8 @@ No parameter expansion, command substitution, filename expansion, or arithmetic expansion is performed on @var{word}. If any characters in @var{word} are quoted, the @var{delimiter} is the result of quote removal on @var{word}, -and the lines in the here-document are not expanded. Otherwise, +and the lines in the here-document are not expanded. +If @var{word} is unquoted, all lines of the here-document are subjected to parameter expansion, command substitution, and arithmetic expansion. In the latter case, the pair @code{\newline} is ignored, and @samp{\} @@ -1501,7 +1852,10 @@ The redirection operator is used to duplicate input file descriptors. If @var{word} expands to one or more digits, the file descriptor denoted by @code{n} -is made to be a copy of that file descriptor. If @var{word} +is made to be a copy of that file descriptor. +If the digits in @var{word} do not specify a file descriptor open for +input, a redirection error occurs. +If @var{word} evaluates to @samp{-}, file descriptor @code{n} is closed. If @code{n} is not specified, the standard input (file descriptor 0) is used. @@ -1513,6 +1867,8 @@ The operator is used similarly to duplicate output file descriptors. If @code{n} is not specified, the standard output (file descriptor 1) is used. +If the digits in @var{word} do not specify a file descriptor open for +output, a redirection error occurs. As a special case, if @code{n} is omitted, and @var{word} does not expand to one or more digits, the standard output and standard error are redirected as described previously. @@ -1532,8 +1888,15 @@ is not specified. If the file does not exist, it is created. @section Executing Commands @menu +* Simple Command Expansion:: How Bash expands simple commands before + executing them. + * Command Search and Execution:: How Bash finds commands and runs them. +* Command Execution Environment:: The environment in which Bash + executes commands that are not + shell builtins. + * Environment:: The environment given to a command. * Exit Status:: The status returned by commands and how Bash @@ -1541,8 +1904,54 @@ is not specified. If the file does not exist, it is created. * Signals:: What happens when Bash or a command it runs receives a signal. + @end menu +@node Simple Command Expansion +@subsection Simple Command Expansion +@cindex command expansion + +When a simple command is executed, the shell performs the following +expansions, assignments, and redirections, from left to right. + +@enumerate +@item +The words that the parser has marked as variable assignments (those +preceding the command name) and redirections are saved for later +processing. + +@item +The words that are not variable assignments or redirections are +expanded (@pxref{Shell Expansions}). +If any words remain after expansion, the first word +is taken to be the name of the command and the remaining words are +the arguments. + +@item +Redirections are performed as described above (@pxref{Redirections}). + +@item +The text after the @samp{=} in each variable assignment undergoes tilde +expansion, parameter expansion, command substitution, arithmetic expansion, +and quote removal before being assigned to the variable. +@end enumerate + +If no command name results, the variable assignments affect the current +shell environment. Otherwise, the variables are added to the environment +of the executed command and do not affect the current shell environment. +If any of the assignments attempts to assign a value to a readonly variable, +an error occurs, and the command exits with a non-zero status. + +If no command name results, redirections are performed, but do not +affect the current shell environment. A redirection error causes the +command to exit with a non-zero status. + +If there is a command name left after expansion, execution proceeds as +described below. Otherwise, the command exits. If one of the expansions +contained a command substitution, the exit status of the command is +the exit status of the last command substitution performed. If there +were no command substitutions, the command exits with a status of zero. + @node Command Search and Execution @subsection Command Search and Execution @cindex command execution @@ -1568,26 +1977,118 @@ If the name is neither a shell function nor a builtin, and contains no slashes, Bash searches each element of @code{$PATH} for a directory containing an executable file by that name. Bash uses a hash table to remember the full -filenames of executable files (see the description of -@code{hash} in @ref{Bourne Shell Builtins}) to avoid multiple -@code{PATH} searches. +pathnames of executable files to avoid multiple @code{PATH} searches +(see the description of @code{hash} in @ref{Bourne Shell Builtins}). A full search of the directories in @code{$PATH} is performed only if the command is not found in the hash table. If the search is unsuccessful, the shell prints an error -message and returns a nonzero exit status. +message and returns an exit status of 127. @item If the search is successful, or if the command name contains -one or more slashes, the shell executes the named program. +one or more slashes, the shell executes the named program in +a separate execution environment. Argument 0 is set to the name given, and the remaining arguments to the command are set to the arguments supplied, if any. @item If this execution fails because the file is not in executable -format, and the file is not a directory, it is assumed to be -@var{shell script} (@pxref{Shell Scripts}). +format, and the file is not a directory, it is assumed to be a +@var{shell script} and the shell executes it as described in +@ref{Shell Scripts}. + +@item +If the command was not begun asynchronously, the shell waits for +the command to complete and collects its exit status. + @end enumerate +@node Command Execution Environment +@subsection Command Execution Environment +@cindex execution environment + +The shell has an @var{execution environment}, which consists of the +following: + +@itemize @bullet +@item +open files inherited by the shell at invocation, as modified by +redirections supplied to the @code{exec} builtin + +@item +the current working directory as set by @code{cd}, @code{pushd}, or +@code{popd}, or inherited by the shell at invocation + +@item +the file creation mode mask as set by @code{umask} or inherited from +the shell's parent + +@item +current traps set by @code{trap} + +@item +shell parameters that are set by variable assignment or with @code{set} +or inherited from the shell's parent in the environment + +@item +shell functions defined during execution or inherited from the shell's +parent in the environment + +@item +options enabled at invocation (either by default or with command-line +arguments) or by @code{set} + +@item +options enabled by @code{shopt} + +@item +shell aliases defined with @code{alias} (@pxref{Aliases}) + +@item +various process IDs, including those of background jobs +(@pxref{Lists}), the value of @code{$$}, and the value of +@code{$PPID} + +@end itemize + +When a simple command other than a builtin or shell function +is to be executed, it +is invoked in a separate execution environment that consists of +the following. Unless otherwise noted, the values are inherited +from the shell. + +@itemize @bullet +@item +the shell's open files, plus any modifications and additions specified +by redirections to the command + +@item +the current working directory + +@item +the file creation mode mask + +@item +shell variables marked for export, along with variables exported for +the command, passed in the environment (@pxref{Environment}) + +@item +traps caught by the shell are reset to the values inherited from the +shell's parent, and traps ignored by the shell are ignored + +@end itemize + +A command invoked in this separate environment cannot affect the +shell's execution environment. + +Command substitution and asynchronous commands are invoked in a +subshell environment that is a duplicate of the shell environment, +except that traps caught by the shell are reset to the values +that the shell inherited from its parent at invocation. Builtin +commands that are invoked as part of a pipeline are also executed +in a subshell environment. Changes made to the subshell environment +cannot affect the shell's execution environment. + @node Environment @subsection Environment @cindex environment @@ -1608,8 +2109,9 @@ in the environment is modified, the new value becomes part of the environment, replacing the old. The environment inherited by any executed command consists of the shell's initial environment, whose values may be modified in the shell, -less any pairs removed by the @code{unset} command, plus any -additions via the @code{export} and @samp{declare -x} commands. +less any pairs removed by the @code{unset} and @samp{export -n} +commands, plus any additions via the @code{export} and +@samp{declare -x} commands. The environment for any simple command or function may be augmented temporarily by prefixing it with @@ -1617,7 +2119,7 @@ parameter assignments, as described in @ref{Shell Parameters}. These assignment statements affect only the environment seen by that command. -If the @samp{-k} flag is set (@pxref{The Set Builtin}, then all +If the @samp{-k} option is set (@pxref{The Set Builtin}), then all parameter assignments are placed in the environment for a command, not just those that precede the command name. @@ -1629,7 +2131,7 @@ command in its environment. @subsection Exit Status @cindex exit status -For the purposes of the shell, a command which exits with a +For the shell's purposes, a command which exits with a zero exit status has succeeded. A non-zero exit status indicates failure. This seemingly counter-intuitive scheme is used so there @@ -1642,6 +2144,9 @@ If a command is not found, the child process created to execute it returns a status of 127. If a command is found but is not executable, the return status is 126. +If a command fails because of an error during expansion or redirection, +the exit status is greater than zero. + The exit status is used by the Bash conditional commands (@pxref{Conditional Constructs}) and some of the list constructs (@pxref{Lists}). @@ -1649,12 +2154,13 @@ constructs (@pxref{Lists}). All of the Bash builtins return an exit status of zero if they succeed and a non-zero status on failure, so they may be used by the conditional and list constructs. +All builtins return an exit status of 2 to indicate incorrect usage. @node Signals @subsection Signals @cindex signal handling -When Bash is interactive, it ignores +When Bash is interactive, in the absence of any traps, it ignores @code{SIGTERM} (so that @samp{kill 0} does not kill an interactive shell), and @code{SIGINT} is caught and handled (so that the @code{wait} builtin is interruptible). @@ -1663,21 +2169,37 @@ In all cases, Bash ignores @code{SIGQUIT}. If job control is in effect (@pxref{Job Control}), Bash ignores @code{SIGTTIN}, @code{SIGTTOU}, and @code{SIGTSTP}. -Synchronous jobs started by Bash have signals set to the -values inherited by the shell from its parent. When job control -is not in effect, background jobs (commands terminated with @samp{&}) -ignore @code{SIGINT} and @code{SIGQUIT}. -Commands run as a result of command substitution ignore the -keyboard-generated job control signals +Commands started by Bash have signal handlers set to the +values inherited by the shell from its parent. +When job control is not in effect, asynchronous commands +ignore @code{SIGINT} and @code{SIGQUIT} as well. +Commands run as a result of +command substitution ignore the keyboard-generated job control signals @code{SIGTTIN}, @code{SIGTTOU}, and @code{SIGTSTP}. The shell exits by default upon receipt of a @code{SIGHUP}. -Before exiting, it resends the @code{SIGHUP} -to all jobs, running or stopped. To prevent the shell from -sending the @code{SIGHUP} signal to a particular job, remove it -from the jobs table with the @code{disown} builtin -(@pxref{Job Control Builtins}) -or use @code{disown -h} to mark it to not receive @code{SIGHUP}. +Before exiting, it resends the @code{SIGHUP} to all jobs, running +or stopped. +Stopped jobs are sent @code{SIGCONT} to ensure that they receive +the @code{SIGHUP}. +To prevent the shell from sending the @code{SIGHUP} signal to a +particular job, it should be removed +from the jobs table with the @code{disown} +builtin (@pxref{Job Control Builtins}) or marked +to not receive @code{SIGHUP} using @code{disown -h}. + +If the @code{huponexit} shell option has been set with @code{shopt} +(@pxref{Bash Builtins}), Bash sends a @code{SIGHUP} to all jobs when +an interactive login shell exits. + +When Bash receives a signal for which a trap has been set while waiting +for a command to complete, the trap will not be executed until the +command completes. +When Bash is waiting for an asynchronous +command via the @code{wait} builtin, the reception of a signal for +which a trap has been set will cause the @code{wait} builtin to return +immediately with an exit status greater than 128, immediately after +which the trap is executed. @node Shell Scripts @section Shell Scripts @@ -1711,7 +2233,10 @@ bash filename @var{arguments} @noindent if @code{filename} is an executable shell script. This subshell reinitializes itself, so that the effect is as if a -new shell had been invoked to interpret the script. +new shell had been invoked to interpret the script, with the +exception that the locations of commands remembered by the parent +(see the description of @code{hash} in @ref{Bourne Shell Builtins}) +are retained by the child. Most versions of Unix make this a part of the kernel's command execution mechanism. If the first line of a script begins with @@ -1737,9 +2262,9 @@ name and argument to a maximum of 32 characters. @end menu This section briefly summarizes things which Bash inherits from -the Bourne Shell: builtins, variables, -and other features. It also lists the significant differences -between Bash and the Bourne Shell. +the Bourne Shell: builtins, variables, and other features. +It also lists the significant differences between Bash and the Bourne Shell. +Many of the builtins have been extended by @sc{POSIX} or Bash. @node Bourne Shell Builtins @section Bourne Shell Builtins @@ -1755,6 +2280,7 @@ Shell. These commands are implemented as specified by the @sc{POSIX} : [@var{arguments}] @end example Do nothing beyond expanding @var{arguments} and performing redirections. +The return status is zero. @item . @btindex . @@ -1762,7 +2288,13 @@ Do nothing beyond expanding @var{arguments} and performing redirections. . @var{filename} @end example Read and execute commands from the @var{filename} argument in the -current shell context. +current shell context. If @var{filename} does not contain a slash, +the @code{$PATH} variable is used to find +@var{filename}. The current directory is searched if @var{filename} +is not found in @code{$PATH}. +The return status is the exit status of the last command executed, or +zero if no commands are executed. If @var{filename} is not found, or +cannot be read, the return status is non-zero. @item break @btindex break @@ -1771,6 +2303,8 @@ break [@var{n}] @end example Exit from a @code{for}, @code{while}, @code{until}, or @code{select} loop. If @var{n} is supplied, the @var{n}th enclosing loop is exited. +@var{n} must be greater than or equal to 1. +The return status is zero unless @var{n} is not greater than or equal to 1. @item cd @btindex cd @@ -1782,8 +2316,11 @@ is not given, the value of the @code{HOME} shell variable is used. If the shell variable @code{CDPATH} exists, it is used as a search path. If @var{directory} begins with a slash, @code{CDPATH} is not used. The @samp{-P} option means -to not follow symbolic links; symlinks are followed by default or with the -@samp{-L} option. +to not follow symbolic links; symbolic links are followed by default +or with the @samp{-L} option. +If @var{directory} is @samp{-}, it is equivalent to @code{$OLDPWD}. +The return status is zero if the directory is successfully changed, +non-zero otherwise. @item continue @btindex continue @@ -1792,33 +2329,39 @@ continue [@var{n}] @end example Resume the next iteration of an enclosing @code{for}, @code{while}, @code{until}, or @code{select} loop. -If @var{n} is supplied, the execution of the -@var{n}th enclosing loop is resumed. +If @var{n} is supplied, the execution of the @var{n}th enclosing loop +is resumed. +@var{n} must be greater than or equal to 1. +The return status is zero unless @var{n} is not greater than or equal to 1. @item eval @btindex eval @example eval [@var{arguments}] @end example -The arguments are concatenated together into a single -command, which is then read and executed. +The arguments are concatenated together into a single command, which is +then read and executed, and its exit status returned as the exit status +of @code{eval}. +If there are no arguments or only empty arguments, the return status is +zero. @item exec @btindex exec @example -exec [-cl] [-a @var{name}] [@var{command}] [@var{arguments}] +exec [-cl] [-a @var{name}] [@var{command} [@var{arguments}]] @end example If @var{command} -is supplied, it replaces the shell. -If the @samp{-l} option is supplied, -the shell places a dash in the zeroth arg passed to @var{command}. +is supplied, it replaces the shell without creating a new process. +If the @samp{-l} option is supplied, the shell places a dash in the +zeroth arg passed to @var{command}. This is what the @code{login} program does. -The @samp{-c} option causes @var{command} -to be executed with an empty environment. -If @samp{-a} is supplied, the shell passes @var{name} -as the zeroth argument to @var{command}. +The @samp{-c} option causes @var{command} to be executed with an empty +environment. +If @samp{-a} is supplied, the shell passes @var{name} as the zeroth +argument to @var{command}. If no @var{command} is specified, redirections may be used to affect -the current shell environment. +the current shell environment. If there are no redirection errors, the +return status is zero; otherwise the return status is non-zero. @item exit @btindex exit @@ -1826,6 +2369,7 @@ the current shell environment. exit [@var{n}] @end example Exit the shell, returning a status of @var{n} to the shell's parent. +Any trap on @code{EXIT} is executed before the shell terminates. @item export @btindex export @@ -1834,10 +2378,14 @@ export [-fn] [-p] [@var{name}[=@var{value}]] @end example Mark each @var{name} to be passed to child processes in the environment. If the @samp{-f} option is supplied, the @var{name}s -refer to shell functions. The @samp{-n} option means to no longer mark -each @var{name} for export. +refer to shell functions; otherwise the names refer to shell variables. +The @samp{-n} option means to no longer mark each @var{name} for export. If no @var{names} are supplied, or if the @samp{-p} option is given, a list of exported names is displayed. +The @samp{-p} option displays output in a form that may be reused as input. +The return status is zero unless an invalid option is supplied, one of +the names is not a valid shell variable name, or @samp{-f} is supplied +with a name that is not a shell function. @item getopts @btindex getopts @@ -1852,26 +2400,34 @@ Each time it is invoked, @code{getopts} places the next option in the shell variable @var{name}, initializing @var{name} if it does not exist, and the index of the next argument to be processed into the -variable @code{OPTIND}. @code{OPTIND} -is initialized to 1 each time the shell or a shell script -is invoked. When an option requires an argument, +variable @code{OPTIND}. +@code{OPTIND} is initialized to 1 each time the shell or a shell script +is invoked. +When an option requires an argument, @code{getopts} places that argument into the variable @code{OPTARG}. -The shell does not reset @code{OPTIND} -automatically; it must be manually reset between multiple -calls to @code{getopts} -within the same shell invocation if a new set of parameters -is to be used. +The shell does not reset @code{OPTIND} automatically; it must be manually +reset between multiple calls to @code{getopts} within the same shell +invocation if a new set of parameters is to be used. + +When the end of options is encountered, @code{getopts} exits with a +return value greater than zero. +@code{OPTIND} is set to the index of the first non-option argument, +and @code{name} is set to @samp{?}. + +@code{getopts} +normally parses the positional parameters, but if more arguments are +given in @var{args}, @code{getopts} parses those instead. @code{getopts} can report errors in two ways. If the first character of @var{optstring} is a colon, @var{silent} error reporting is used. In normal operation diagnostic messages -are printed when illegal options or missing option arguments are +are printed when invalid options or missing option arguments are encountered. If the variable @code{OPTERR} -is set to 0, no error message will be displayed, even if the first +is set to 0, no error messages will be displayed, even if the first character of @code{optstring} is not a colon. -If an illegal option is seen, +If an invalid option is seen, @code{getopts} places @samp{?} into @var{name} and, if not silent, prints an error message and unsets @code{OPTARG}. If @code{getopts} is silent, the option character found is placed in @@ -1883,72 +2439,152 @@ is not silent, a question mark (@samp{?}) is placed in @var{name}, If @code{getopts} is silent, then a colon (@samp{:}) is placed in @var{name} and @code{OPTARG} is set to the option character found. -@code{getopts} -normally parses the positional parameters, but if more arguments are -given in @var{args}, @code{getopts} parses those instead. - @item hash @btindex hash @example hash [-r] [-p @var{filename}] [@var{name}] @end example -Remember the full filenames of commands specified as arguments, -so they need not be searched for on subsequent invocations. The -commands are found by searching through the directories listed in -@code{$PATH}. The @samp{-p} option inhibits the path search, and -@var{filename} is used as the location of @var{name}. -The @samp{-r} option causes the shell to forget -all remembered locations. If no arguments are given, information -about remembered commands is printed. +Remember the full pathnames of commands specified as @var{name} arguments, +so they need not be searched for on subsequent invocations. +The commands are found by searching through the directories listed in +@code{$PATH}. +The @samp{-p} option inhibits the path search, and @var{filename} is +used as the location of @var{name}. +The @samp{-r} option causes the shell to forget all remembered locations. +If no arguments are given, information about remembered commands is printed. +The return status is zero unless a @var{name} is not found or an invalid +option is supplied. @item pwd @btindex pwd @example pwd [-LP] @end example -Print the current working directory. If the @samp{-P} option is supplied, -the path printed will not contain symbolic links. If the @samp{-L} option -is supplied, the path printed may contain symbolic links. +Print the current working directory. +If the @samp{-P} option is supplied, the path printed will not +contain symbolic links. +If the @samp{-L} option is supplied, the path printed may contain +symbolic links. +The return status is zero unless an error is encountered while +determining the name of the current directory or an invalid option +is supplied. @item readonly @btindex readonly @example readonly [-apf] [@var{name}] @dots{} @end example -Mark each @var{name} as unchangable. The values of these names may not -be changed by subsequent assignment. If the @samp{-f} option is supplied, -each @var{name} refers to a shell function. The @samp{-a} option means -each @var{name} refers to an array variable. +Mark each @var{name} as readonly. +The values of these names may not be changed by subsequent assignment. +If the @samp{-f} option is supplied, each @var{name} refers to a shell +function. +The @samp{-a} option means each @var{name} refers to an array variable. If no @var{name} arguments are given, or if the @samp{-p} option is supplied, a list of all readonly names is printed. +The @samp{-p} option causes output to be displayed in a format that +may be reused as input. +The return status is zero unless an invalid option is supplied, one of +the @var{name} arguments is not a valid shell variable or function name, +or the @samp{-f} option is supplied with a name that is not a shell function. @item return @btindex return @example return [@var{n}] @end example -Cause a shell function to exit with value @var{n}. This may also be used -to terminate execution of a script being executed with the @code{.} -builtin. +Cause a shell function to exit with the return value @var{n}. +This may also be used to terminate execution of a script being executed +with the @code{.} builtin, returning either @var{n} or the exit status +of the last command executed within the script as the exit status of the +script. +The return status is false if @code{return} is used outside a function +and not during the execution of a script by @samp{.}. @item shift @btindex shift @example shift [@var{n}] @end example -Shift positional parameters to the left by @var{n}. -The positional parameters from @var{n}+1 @dots{} -are renamed to -@code{$1} @dots{} . -Parameters represented by the numbers -@code{$#} to @var{n}+1 are unset. @var{n} -must be a non-negative number less than or equal to @code{$#}. +Shift the positional parameters to the left by @var{n}. +The positional parameters from @var{n}+1 @dots{} @code{$#} are +renamed to @code{$1} @dots{} @code{$#}-@var{n}+1. +Parameters represented by the numbers @code{$#} to @var{n}+1 are unset. +@var{n} must be a non-negative number less than or equal to @code{$#}. +If @var{n} is zero or greater than @code{$#}, the positional parameters +are not changed. +The return status is zero unless @var{n} is greater than @code{$#} or +less than zero, non-zero otherwise. @item test @itemx [ @btindex test @btindex [ -Evaluate a conditional expression (@pxref{Bash Conditional Expressions}). +Evaluate a conditional expression @var{expr}. +Each operator and operand must be a separate argument. +Expressions are composed of the primaries described below in +@ref{Bash Conditional Expressions}. + +Expressions may be combined using the following operators, listed in +decreasing order of precedence. + +@table @code +@item ! @var{expr} +True if @var{expr} is false. + +@item ( @var{expr} ) +Returns the value of @var{expr}. +This may be used to override the normal precedence of operators. + +@item @var{expr1} -a @var{expr2} +True if both @var{expr1} and @var{expr2} are true. + +@item @var{expr1} -o @var{expr2} +True if either @var{expr1} or @var{expr2} is true. +@end table + +The @code{test} and @code{[} builtins evaluate conditional +expressions using a set of rules based on the number of arguments. + +@table @asis +@item 0 arguments +The expression is false. + +@item 1 argument +The expression is true if and only if the argument is not null. + +@item 2 arguments +If the first argument is @samp{!}, the expression is true if and +only if the second argument is null. +If the first argument is one of the unary conditional operators +(@pxref{Bash Conditional Expressions}), the expression +is true if the unary test is true. +If the first argument is not a valid unary operator, the expression is +false. + +@item 3 arguments +If the second argument is one of the binary conditional +operators (@pxref{Bash Conditional Expressions}), the +result of the expression is the result of the binary test using the +first and third arguments as operands. +If the first argument is @samp{!}, the value is the negation of +the two-argument test using the second and third arguments. +If the first argument is exactly @samp{(} and the third argument is +exactly @samp{)}, the result is the one-argument test of the second +argument. +Otherwise, the expression is false. +The @samp{-a} and @samp{-o} operators are considered binary operators +in this case. + +@item 4 arguments +If the first argument is @samp{!}, the result is the negation of +the three-argument expression composed of the remaining arguments. +Otherwise, the expression is parsed and evaluated according to +precedence using the rules listed above. + +@item 5 or more arguments +The expression is parsed and evaluated according to precedence +using the rules listed above. +@end table @item times @btindex times @@ -1956,6 +2592,7 @@ Evaluate a conditional expression (@pxref{Bash Conditional Expressions}). times @end example Print out the user and system times used by the shell and its children. +The return status is zero. @item trap @btindex trap @@ -1971,7 +2608,8 @@ each @var{sigspec} is ignored by the shell and commands it invokes. If @var{arg} is @samp{-p}, the shell displays the trap commands associated with each @var{sigspec}. If no arguments are supplied, or only @samp{-p} is given, @code{trap} prints the list of commands -associated with each signal number. +associated with each signal number in a form that may be reused as +shell input. Each @var{sigspec} is either a signal name such as @code{SIGINT} (with or without the @code{SIG} prefix) or a signal number. If a @var{sigspec} @@ -1985,10 +2623,13 @@ Signals ignored upon entry to the shell cannot be trapped or reset. Trapped signals are reset to their original values in a child process when it is created. +The return status is zero unless a @var{sigspec} does not specify a +valid signal. + @item umask @btindex umask @example -umask [-S] [@var{mode}] +umask [-p] [-S] [@var{mode}] @end example Set the shell process's file creation mask to @var{mode}. If @var{mode} begins with a digit, it is interpreted as an octal number; @@ -1997,6 +2638,10 @@ to that accepted by the @code{chmod} command. If @var{mode} is omitted, the current value of the mask is printed. If the @samp{-S} option is supplied without a @var{mode} argument, the mask is printed in a symbolic format. +If the @samp{-p} option is supplied, and @var{mode} +is omitted, the output is in a form that may be reused as input. +The return status is zero if the mode is successfully changed or if +no @var{mode} argument is supplied, and non-zero otherwise. @item unset @btindex unset @@ -2008,8 +2653,9 @@ If no options are supplied, or the @samp{-v} option is given, each @var{name} refers to a shell variable. If the @samp{-f} option is given, the @var{name}s refer to shell functions, and the function definition is removed. -Read-only variables and functions may not be unset. - +Readonly variables and functions may not be unset. +The return status is zero unless a @var{name} does not exist or is +readonly. @end table @node Bourne Shell Variables @@ -2020,48 +2666,50 @@ In some cases, Bash assigns a default value to the variable. @vtable @code -@item IFS -A list of characters that separate fields; used when the shell splits -words as part of expansion. - -@item PATH -A colon-separated list of directories in which the shell looks for -commands. +@item CDPATH +A colon-separated list of directories used as a search path for +the @code{cd} builtin command. @item HOME The current user's home directory; the default for the @code{cd} builtin command. +The value of this variable is also used by tilde expansion +(@pxref{Tilde Expansion}). -@item CDPATH -A colon-separated list of directories used as a search path for -the @code{cd} command. - -@item MAILPATH -A colon-separated list of files which the shell periodically checks -for new mail. You can -also specify what message is printed by separating the file name from -the message with a @samp{?}. When used in the text of the message, -@code{$_} stands for the name of the current mailfile. +@item IFS +A list of characters that separate fields; used when the shell splits +words as part of expansion. @item MAIL If this parameter is set to a filename and the @code{MAILPATH} variable is not set, Bash informs the user of the arrival of mail in the specified file. +@item MAILPATH +A colon-separated list of filenames which the shell periodically checks +for new mail. +Each list entry can specify the message that is printed when new mail +arrives in the mail file by separating the file name from the message with +a @samp{?}. +When used in the text of the message, @code{$_} expands to the name of +the current mail file. + +@item OPTARG +The value of the last option argument processed by the @code{getopts} builtin. + +@item OPTIND +The index of the last option argument processed by the @code{getopts} builtin. + +@item PATH +A colon-separated list of directories in which the shell looks for +commands. + @item PS1 The primary prompt string. The default value is @samp{\s-\v\$ }. @item PS2 The secondary prompt string. The default value is @samp{> }. -@item OPTIND -The index of the last option processed by the -@code{getopts} builtin. - -@item OPTARG -The value of the last option argument processed by the -@code{getopts} builtin. - @end vtable @node Other Bourne Shell Features @@ -2072,155 +2720,235 @@ The value of the last option argument processed by the Bash and the Bourne shell. @end menu -Bash implements essentially the same grammar, parameter and variable -expansion, redirection, and quoting as the Bourne Shell. Bash uses the -@sc{POSIX} 1003.2 standard as the specification of how these features are to be -implemented. There are some differences between the traditional Bourne -shell and the @sc{POSIX} standard; this section quickly details the differences -of significance. A number of these differences are explained in greater -depth in subsequent sections. +Bash implements essentially the same grammar, parameter and +variable expansion, redirection, and quoting as the Bourne Shell. +Bash uses the @sc{POSIX} 1003.2 standard as the specification of +how these features are to be implemented. There are some +differences between the traditional Bourne shell and Bash; this +section quickly details the differences of significance. A +number of these differences are explained in greater depth in +subsequent sections. @node Major Differences From The Bourne Shell @subsection Major Differences From The SVR4.2 Bourne Shell +@itemize @bullet + +@item Bash is @sc{POSIX}-conformant, even where the @sc{POSIX} specification differs from traditional @code{sh} behavior. +@item Bash has multi-character invocation options (@pxref{Invoking Bash}). +@item Bash has command-line editing (@pxref{Command Line Editing}) and the @code{bind} builtin. +@item Bash has command history (@pxref{Bash History Facilities}) and the @code{history} and @code{fc} builtins to manipulate it. -Bash implements @code{csh}-like history expansion (@pxref{History Interaction}). +@item +Bash implements @code{csh}-like history expansion +(@pxref{History Interaction}). +@item Bash has one-dimensional array variables (@pxref{Arrays}), and the appropriate variable expansions and assignment syntax to use them. -Some of the Bash builtins take options to act on arrays. Bash provides -some built-in array variables. +Several of the Bash builtins take options to act on arrays. +Bash provides a number of built-in array variables. + +@item +The @code{$'@dots{}'} quoting syntax, which expands ANSI-C +backslash-escaped characters in the text between the single quotes, +is supported (@pxref{ANSI-C Quoting}). +@item +Bash supports the @code{$"@dots{}"} quoting syntax to do +locale-specific translation of the characters between the double +quotes. The @samp{-D}, @samp{--dump-strings}, and @samp{--dump-po-strings} +invocation options list the translatable strings found in a script +(@pxref{Locale Translation}). + +@item Bash implements the @code{!} keyword to negate the return value of a pipeline (@pxref{Pipelines}). Very useful when an @code{if} statement needs to act only if a test fails. +@item +Bash has the @code{time} reserved word and command timing (@pxref{Pipelines}). +The display of the timing statistics may be controlled with the +@code{TIMEFORMAT} variable. + +@item Bash includes the @code{select} compound command, which allows the -generation of simple menus (@pxref{Korn Shell Constructs}). +generation of simple menus (@pxref{Conditional Constructs}). +@item +Bash includes the @code{[[} compound command, which makes conditional +testing part of the shell grammar (@pxref{Conditional Constructs}). + +@item Bash includes brace expansion (@pxref{Brace Expansion}) and tilde expansion (@pxref{Tilde Expansion}). +@item Bash implements command aliases and the @code{alias} and @code{unalias} builtins (@pxref{Aliases}). -Bash provides shell arithmetic and arithmetic expansion -(@pxref{Shell Arithmetic}). - -The @sc{POSIX} and @code{ksh}-style @code{$()} form of command substitution -is implemented (@pxref{Command Substitution}), -and preferred to the Bourne shell's @code{``} (which -is also implemented for backwards compatibility). +@item +Bash provides shell arithmetic, the @code{((} compound command +(@pxref{Conditional Constructs}), +and arithmetic expansion (@pxref{Shell Arithmetic}). +@item Variables present in the shell's initial environment are automatically exported to child processes. The Bourne shell does not normally do this unless the variables are explicitly marked using the @code{export} command. -Bash includes the @sc{POSIX} and @code{ksh}-style pattern removal -@samp{%}, @samp{#}, @samp{%%} and @samp{##} constructs to remove -leading or trailing substrings from variable values -(@pxref{Shell Parameter Expansion}). +@item +Bash includes the @sc{POSIX} pattern removal @samp{%}, @samp{#}, @samp{%%} +and @samp{##} expansions to remove leading or trailing substrings from +variable values (@pxref{Shell Parameter Expansion}). -The expansion @code{$@{#xx@}}, which returns the length of @code{$xx}, +@item +The expansion @code{$@{#xx@}}, which returns the length of @code{$@{xx@}}, is supported (@pxref{Shell Parameter Expansion}). -The @code{$'@dots{}'} quoting syntax, which expands ANSI-C -backslash-escaped characters in the text between the single quotes, -is supported (@pxref{ANSI-C Quoting}). - -Bash supports the @code{$"@dots{}"} quoting syntax to do -locale-specific translation of the characters between the double -quotes. The @samp{-D} and @samp{--dump-strings} invocation options -list the translatable strings found in a script -(@pxref{Locale Translation}). - +@item The expansion @code{$@{var:}@var{offset}@code{[:}@var{length}@code{]@}}, which expands to the substring of @code{var}'s value of length -@var{length}, optionally beginning at @var{offset}, is present +@var{length}, beginning at @var{offset}, is present (@pxref{Shell Parameter Expansion}). +@item The expansion @code{$@{var/[/]}@var{pattern}@code{[/}@var{replacement}@code{]@}}, which matches @var{pattern} and replaces it with @var{replacement} in the value of @code{var}, is available (@pxref{Shell Parameter Expansion}). +@item Bash has @var{indirect} variable expansion using @code{$@{!word@}} (@pxref{Shell Parameter Expansion}). +@item Bash can expand positional parameters beyond @code{$9} using @code{$@{@var{num}@}}. +@item +The @sc{POSIX} @code{$()} form of command substitution +is implemented (@pxref{Command Substitution}), +and preferred to the Bourne shell's @code{``} (which +is also implemented for backwards compatibility). + +@item Bash has process substitution (@pxref{Process Substitution}). +@item Bash automatically assigns variables that provide information about the current user (@code{UID}, @code{EUID}, and @code{GROUPS}), the current host (@code{HOSTTYPE}, @code{OSTYPE}, @code{MACHTYPE}, and @code{HOSTNAME}), and the instance of Bash that is running (@code{BASH}, -@code{BASH_VERSION}, and @code{BASH_VERSINFO}. @xref{Bash Variables}, +@code{BASH_VERSION}, and @code{BASH_VERSINFO}). @xref{Bash Variables}, for details. +@item The @code{IFS} variable is used to split only the results of expansion, not all words (@pxref{Word Splitting}). This closes a longstanding shell security hole. +@item +Bash implements the full set of @sc{POSIX.2} filename expansion operators, +including @var{character classes}, @var{equivalence classes}, and +@var{collating symbols} (@pxref{Filename Expansion}). + +@item +Bash implements extended pattern matching features when the @code{extglob} +shell option is enabled (@pxref{Pattern Matching}). + +@item It is possible to have a variable and a function with the same name; @code{sh} does not separate the two name spaces. +@item Bash functions are permitted to have local variables using the @code{local} builtin, and thus useful recursive functions may be written. +@item Variable assignments preceding commands affect only that command, even builtins and functions (@pxref{Environment}). In @code{sh}, all variable assignments preceding commands are global unless the command is executed from the file system. +@item Bash performs filename expansion on filenames specified as operands -to output redirection operators. +to input and output redirection operators. +@item Bash contains the @samp{<>} redirection operator, allowing a file to be opened for both reading and writing, and the @samp{&>} redirection operator, for directing standard output and standard error to the same file (@pxref{Redirections}). +@item The @code{noclobber} option is available to avoid overwriting existing files with output redirection (@pxref{The Set Builtin}). The @samp{>|} redirection operator may be used to override @code{noclobber}. -Bash interprets special backslash-escaped characters in the prompt -strings when interactive (@pxref{Printing a Prompt}). +@item +The Bash @code{cd} and @code{pwd} builtins (@pxref{Bourne Shell Builtins}) +each take @samp{-L} and @samp{-P} builtins to switch between logical and +physical modes. -Bash allows you to write a function to override a builtin, and provides +@item +Bash allows a function to override a builtin with the same name, and provides access to that builtin's functionality within the function via the @code{builtin} and @code{command} builtins (@pxref{Bash Builtins}). +@item The @code{command} builtin allows selective disabling of functions when command lookup is performed (@pxref{Bash Builtins}). +@item Individual builtins may be enabled or disabled using the @code{enable} builtin (@pxref{Bash Builtins}). -The Bash @code{hash} builtin allows a name to be associated with -an arbitrary filename, even when that filename cannot be found by -searching the @code{$PATH}, using @samp{hash -p}. +@item +The Bash @code{exec} builtin takes additional options that allow users +to control the contents of the environment passed to the executed +command, and what the zeroth argument to the command is to be +(@pxref{Bourne Shell Builtins}). +@item Shell functions may be exported to children via the environment -(@pxref{Shell Functions}). +using @code{export -f} (@pxref{Shell Functions}). + +@item +The Bash @code{export}, @code{readonly}, and @code{declare} builtins can +take a @samp{-f} option to act on shell functions, a @samp{-p} option to +display variables with various attributes set in a format that can be +used as shell input, a @samp{-n} option to remove various variable +attributes, and @samp{name=value} arguments to set variable attributes +and values simultaneously. +@item +The Bash @code{hash} builtin allows a name to be associated with +an arbitrary filename, even when that filename cannot be found by +searching the @code{$PATH}, using @samp{hash -p} +(@pxref{Bourne Shell Builtins}). + +@item Bash includes a @code{help} builtin for quick reference to shell facilities (@pxref{Bash Builtins}). +@item +The @code{printf} builtin is available to display formatted output +(@pxref{Bash Builtins}). + +@item The Bash @code{read} builtin (@pxref{Bash Builtins}) will read a line ending in @samp{\} with the @samp{-r} option, and will use the @code{REPLY} variable as a @@ -2228,69 +2956,79 @@ default if no arguments are supplied. The Bash @code{read} builtin also accepts a prompt string with the @samp{-p} option and will use Readline to obtain the line when given the @samp{-e} option. +@item +The @code{return} builtin may be used to abort execution of scripts +executed with the @code{.} or @code{source} builtins +(@pxref{Bourne Shell Builtins}). + +@item Bash includes the @code{shopt} builtin, for finer control of shell optional capabilities (@pxref{Bash Builtins}). +@item Bash has much more optional behavior controllable with the @code{set} builtin (@pxref{The Set Builtin}). -The @code{disown} builtin can remove a job from the internal shell -job table (@pxref{Job Control Builtins}). - -The @code{return} builtin may be used to abort execution of scripts -executed with the @code{.} or @code{source} builtins -(@pxref{Bourne Shell Builtins}). - +@item The @code{test} builtin (@pxref{Bourne Shell Builtins}) -is slightly different, as it implements the -@sc{POSIX} 1003.2 algorithm, which specifies the behavior based on the -number of arguments. +is slightly different, as it implements the @sc{POSIX} algorithm, +which specifies the behavior based on the number of arguments. +@item The @code{trap} builtin (@pxref{Bourne Shell Builtins}) allows a @code{DEBUG} pseudo-signal specification, similar to @code{EXIT}. Commands specified with a @code{DEBUG} trap are executed after every simple command. The @code{DEBUG} trap is not inherited by shell functions. -The Bash @code{export}, @code{readonly}, and @code{declare} builtins can -take a @samp{-f} option to act on shell functions, a @samp{-p} option to -display variables with various attributes set in a format that can be -used as shell input, a @samp{-n} option to remove various variable -attributes, and @samp{name=value} arguments to set variable attributes -and values simultaneously. - -The Bash @code{cd} and @code{pwd} builtins (@pxref{Bourne Shell Builtins}) -each take @samp{-L} and @samp{-P} builtins to switch between logical and -physical modes. - +@item The Bash @code{type} builtin is more extensive and gives more information about the names it finds (@pxref{Bash Builtins}). +@item +The Bash @code{umask} builtin permits a @samp{-p} option to cause +the output to be displayed in the form of a @code{umask} command +that may be reused as input (@pxref{Bourne Shell Builtins}). + +@item Bash implements a @code{csh}-like directory stack, and provides the @code{pushd}, @code{popd}, and @code{dirs} builtins to manipulate it -(@pxref{C Shell Builtins}). +(@pxref{The Directory Stack}). Bash also makes the directory stack visible as the value of the @code{DIRSTACK} shell variable. +@item +Bash interprets special backslash-escaped characters in the prompt +strings when interactive (@pxref{Printing a Prompt}). + +@item The Bash restricted mode is more useful (@pxref{The Restricted Shell}); the @sc{SVR4.2} shell restricted mode is too limited. -Bash has the @code{time} reserved word and command timing (@pxref{Pipelines}). -The display of the timing statistics may be controlled with the -@code{TIMEFORMAT} variable. +@item +The @code{disown} builtin can remove a job from the internal shell +job table (@pxref{Job Control Builtins}) or suppress the sending +of @code{SIGHUP} to a job when the shell exits as the result of a +@code{SIGHUP}. +@item The @sc{SVR4.2} shell has two privilege-related builtins (@code{mldmode} and @code{priv}) not present in Bash. +@item Bash does not have the @code{stop} or @code{newgrp} builtins. +@item Bash does not use the @code{SHACCT} variable or perform shell accounting. +@item The @sc{SVR4.2} @code{sh} uses a @code{TIMEOUT} variable like Bash uses @code{TMOUT}. -More features unique to Bash may be found in -@ref{Bash Features}. +@end itemize + +@noindent +More features unique to Bash may be found in @ref{Bash Features}. @subsection Implementation Differences From The SVR4.2 Shell @@ -2313,7 +3051,7 @@ This can be the cause of some hard-to-find errors. The @sc{SVR4.2} shell uses a baroque memory management scheme based on trapping @code{SIGSEGV}. If the shell is started from a process with @code{SIGSEGV} blocked (e.g., by using the @code{system()} C library -function call), the shell misbehaves badly. +function call), it misbehaves badly. @item In a questionable attempt at security, the @sc{SVR4.2} shell, @@ -2323,12 +3061,12 @@ magic threshold value, commonly 100. This can lead to unexpected results. @item -The @sc{SVR4.2} shell does not allow users to trap @code{SIGALRM} or -@code{SIGCHLD}. +The @sc{SVR4.2} shell does not allow users to trap @code{SIGSEGV}, +@code{SIGALRM}, or @code{SIGCHLD}. @item -For some reason, the @sc{SVR4.2} shell does not allow the @code{MAILCHECK} -variable to be unset. +The @sc{SVR4.2} shell does not allow the @code{IFS}, @code{MAILCHECK}, +@code{PATH}, @code{PS1}, or @code{PS2} variables to be unset. @item The @sc{SVR4.2} shell treats @samp{^} as the undocumented equivalent of @@ -2350,515 +3088,6 @@ The @sc{SVR4.2} shell behaves differently when invoked as @code{jsh} (it turns on job control). @end itemize -@node Csh Features -@chapter C-Shell Style Features - -The C-Shell (@dfn{@code{csh}}) was created by Bill Joy at The -University of California at Berkeley. It -is generally considered to have better features for interactive use than -the original Bourne shell. Some of the @code{csh} features present in -Bash include job control, history expansion, `protected' redirection, and -several variables to control the interactive behaviour of the shell -(e.g., @code{IGNOREEOF}). - -@xref{Using History Interactively}, for details on history expansion. - -@menu -* Brace Expansion:: Expansion of expressions within braces. -* Tilde Expansion:: Expansion of the ~ character. -* C Shell Builtins:: Builtin commands adopted from the C Shell. -* C Shell Variables:: Variables which Bash uses in essentially - the same way as the C Shell. -@end menu - -@node Brace Expansion -@section Brace Expansion -@cindex brace expansion -@cindex expansion, brace - -Brace expansion -is a mechanism by which arbitrary strings -may be generated. This mechanism is similar to -@var{filename expansion} (@pxref{Filename Expansion}), -but the file names generated -need not exist. Patterns to be brace expanded take -the form of an optional @var{preamble}, -followed by a series of comma-separated strings -between a pair of braces, followed by an optional @var{postamble}. -The preamble is prepended to each string contained -within the braces, and the postamble is then appended -to each resulting string, expanding left to right. - -Brace expansions may be nested. The results of each expanded -string are not sorted; left to right order is preserved. -For example, -@example -bash$ echo a@{d,c,b@}e -ade ace abe -@end example - -Brace expansion is performed before any other expansions, -and any characters special to other expansions are preserved -in the result. It is strictly textual. Bash -does not apply any syntactic interpretation to the context of the -expansion or the text between the braces. - -A correctly-formed brace expansion must contain unquoted opening -and closing braces, and at least one unquoted comma. -Any incorrectly formed brace expansion is left unchanged. - -This construct is typically used as shorthand when the common -prefix of the strings to be generated is longer than in the -above example: -@example -mkdir /usr/local/src/bash/@{old,new,dist,bugs@} -@end example -or -@example -chown root /usr/@{ucb/@{ex,edit@},lib/@{ex?.?*,how_ex@}@} -@end example - -@node Tilde Expansion -@section Tilde Expansion -@cindex tilde expansion -@cindex expansion, tilde - -Bash has tilde (~) expansion, similar, but not identical, to that of -@code{csh}. The following table shows what unquoted words beginning -with a tilde expand to. - -@table @code -@item ~ -The current value of @code{$HOME}. -@item ~/foo -@file{$HOME/foo} - -@item ~fred/foo -The subdirectory @code{foo} of the home directory of the user -@code{fred}. - -@item ~+/foo -@file{$PWD/foo} - -@item ~-/foo -@file{$OLDPWD/foo} -@end table - -Bash will also tilde expand words following redirection operators -and words following @samp{=} in assignment statements. - -@node C Shell Builtins -@section C Shell Builtins - -Bash has several builtin commands whose definition is very similar -to @code{csh}. - -@table @code -@btindex pushd -@item pushd -@example -pushd [@var{dir} | @var{+N} | @var{-N}] [-n] -@end example - -Save the current directory on a list and then @code{cd} to -@var{dir}. With no -arguments, exchanges the top two directories. - -@table @code -@item +@var{N} -Brings the @var{N}th directory (counting from the left of the -list printed by @code{dirs}, starting with zero) to the top of -the list by rotating the stack. -@item -@var{N} -Brings the @var{N}th directory (counting from the right of the -list printed by @code{dirs}, starting with zero) to the top of -the list by rotating the stack. -@item -n -Suppresses the normal change of directory when adding directories -to the stack, so that only the stack is manipulated. -@item @var{dir} -Makes the current working directory be the top of the stack, and then -@code{cd}s to @var{dir}. You can see the saved directory list -with the @code{dirs} command. -@end table - -@item popd -@btindex popd -@example -popd [+@var{N} | -@var{N}] [-n] -@end example - -Pop the directory stack, and @code{cd} to the new top directory. When -no arguments are given, @code{popd} -removes the top directory from the stack and -performs a @code{cd} to the new top directory. The -elements are numbered from 0 starting at the first directory listed with -@code{dirs}; i.e., @code{popd} is equivalent to @code{popd +0}. -@table @code -@item +@var{N} -Removes the @var{N}th directory (counting from the left of the -list printed by @code{dirs}), starting with zero. -@item -@var{N} -Removes the @var{N}th directory (counting from the right of the -list printed by @code{dirs}), starting with zero. -@item -n -Suppresses the normal change of directory when removing directories -from the stack, so that only the stack is manipulated. -@end table - -@item dirs -@btindex dirs -@example -dirs [+@var{N} | -@var{N}] [-clvp] -@end example -Display the list of currently remembered directories. Directories -find their way onto the list with the @code{pushd} command; you can get -back up through the list with the @code{popd} command. -@table @code -@item +@var{N} -Displays the @var{N}th directory (counting from the left of the -list printed by @code{dirs} when invoked without options), starting -with zero. -@item -@var{N} -Displays the @var{N}th directory (counting from the right of the -list printed by @code{dirs} when invoked without options), starting -with zero. -@item -c -Clears the directory stack by deleting all of the elements. -@item -l -Produces a longer listing; the default listing format uses a -tilde to denote the home directory. -@item -p -Causes @code{dirs} to print the directory stack with one entry per -line. -@item -v -Causes @code{dirs} to print the directory stack with one entry per -line, prepending each entry with its index in the stack. -@end table - -@item history -@btindex history -@example -history [-c] [@var{n}] -history [-anrw] [@var{filename}] -history -ps @var{arg} -@end example - -Display the history list with line numbers. Lines prefixed with -with a @samp{*} have been modified. An argument of @var{n} says -to list only the last @var{n} lines. Options, if supplied, have -the following meanings: - -@table @code -@item -w -Write out the current history to the history file. - -@item -r -Read the current history file and append its contents to -the history list. - -@item -a -Append the new -history lines (history lines entered since the beginning of the -current Bash session) to the history file. - -@item -n -Append the history lines not already read from the history file -to the current history list. These are lines appended to the history -file since the beginning of the current Bash session. - -@item -c -Clear the history list. This may be combined -with the other options to replace the history list completely. - -@item -s -The @var{arg}s are added to the end of -the history list as a single entry. - -@item -p -Perform history substitution on the @var{arg}s and display the result -on the standard output, without storing the results in the history list. -@end table - -When the @samp{-w}, @samp{-r}, @samp{-a}, or @samp{-n} option is -used, if @var{filename} -is given, then it is used as the history file. If not, then -the value of the @code{HISTFILE} variable is used. - -@item logout -@btindex logout -Exit a login shell. - -@item source -@btindex source -A synonym for @code{.} (@pxref{Bourne Shell Builtins}). - -@end table - -@node C Shell Variables -@section C Shell Variables - -@vtable @code - -@item IGNOREEOF -If this variable is set, its value is used the number of consecutive -@code{EOF}s Bash will read before exiting. By default, Bash will exit -upon reading a single @code{EOF}. If @code{IGNOREEOF} is not set to -a numeric value, Bash acts as if its value were 10. - -@end vtable - -@node Korn Shell Features -@chapter Korn Shell Style Features - -This section describes features primarily inspired by the -Korn Shell (@code{ksh}). In some cases, the @sc{POSIX} 1003.2 -standard has adopted these commands and variables from the -Korn Shell; Bash implements those features using the @sc{POSIX} -standard as a guide. - -@menu -* Korn Shell Constructs:: Shell grammar constructs adopted from the - Korn Shell -* Korn Shell Builtins:: Builtin commands adopted from the Korn Shell. -* Korn Shell Variables:: Variables which Bash uses in essentially - the same way as the Korn Shell. -* Aliases:: Substituting one command for another. -@end menu - -@node Korn Shell Constructs -@section Korn Shell Constructs - -Bash includes the Korn Shell @code{select} construct. This construct -allows the easy generation of menus. It has almost the same syntax as -the @code{for} command. - -The syntax of the @code{select} command is: -@rwindex select -@example -select @var{name} [in @var{words} @dots{}]; do @var{commands}; done -@end example - -The list of words following @code{in} is expanded, generating a list -of items. The set of expanded words is printed on the standard -error, each preceded by a number. If the @samp{in @var{words}} -is omitted, the positional parameters are printed. The -@code{PS3} prompt is then displayed and a line is read from the standard -input. If the line consists of a number corresponding to one of -the displayed words, then the value of @var{name} -is set to that word. If the line is empty, the words and prompt -are displayed again. If @code{EOF} is read, the @code{select} -command completes. Any other value read causes @var{name} -to be set to null. The line read is saved in the variable -@code{REPLY}. - -The @var{commands} are executed after each selection until a -@code{break} or @code{return} command is executed, at which -point the @code{select} command completes. - -Bash also has adopted command timing from the Korn shell. If the -@code{time} reserved word precedes a pipeline, which may consist -of a single command, timing statistics for the pipeline are displayed -when it completes. -The statistics currently consist of elapsed (wall-clock) time and -user and system time consumed by the command's execution. - -The use of @code{time} as a reserved word permits the timing of -shell builtins, shell functions, and pipelines. An external -@code{time} command cannot time these easily. - -@node Korn Shell Builtins -@section Korn Shell Builtins - -This section describes Bash builtin commands taken from @code{ksh}. - -@table @code - -@item fc -@btindex fc -@example -@code{fc [-e @var{ename}] [-nlr] [@var{first}] [@var{last}]} -@code{fc -s [@var{pat}=@var{rep}] [@var{command}]} -@end example - -Fix Command. In the first form, a range of commands from @var{first} to -@var{last} is selected from the history list. Both @var{first} and -@var{last} may be specified as a string (to locate the most recent -command beginning with that string) or as a number (an index into the -history list, where a negative number is used as an offset from the -current command number). If @var{last} is not specified it is set to -@var{first}. If @var{first} is not specified it is set to the previous -command for editing and @minus{}16 for listing. If the @samp{-l} flag is -given, the commands are listed on standard output. The @samp{-n} flag -suppresses the command numbers when listing. The @samp{-r} flag -reverses the order of the listing. Otherwise, the editor given by -@var{ename} is invoked on a file containing those commands. If -@var{ename} is not given, the value of the following variable expansion -is used: @code{$@{FCEDIT:-$@{EDITOR:-vi@}@}}. This says to use the -value of the @code{FCEDIT} variable if set, or the value of the -@code{EDITOR} variable if that is set, or @code{vi} if neither is set. -When editing is complete, the edited commands are echoed and executed. - -In the second form, @var{command} is re-executed after each instance -of @var{pat} in the selected command is replaced by @var{rep}. - -A useful alias to use with the @code{fc} command is @code{r='fc -s'}, so -that typing @samp{r cc} runs the last command beginning with @code{cc} -and typing @samp{r} re-executes the last command (@pxref{Aliases}). - -@item let -@btindex let -The @code{let} builtin allows arithmetic to be performed on shell variables. -For details, refer to @ref{Arithmetic Builtins}. - -@item typeset -@btindex typeset -The @code{typeset} command is supplied for compatibility with the Korn -shell; however, it has been deprecated in favor of the -@code{declare} command (@pxref{Bash Builtins}). - -@end table - -@node Korn Shell Variables -@section Korn Shell Variables - -@vtable @code - -@item REPLY -The default variable for the @code{read} builtin. - -@item RANDOM -Each time this parameter is referenced, a random integer -between 0 and 32767 is generated. Assigning a value to this -variable seeds the random number generator. - -@item SECONDS -This variable expands to the number of seconds since the -shell was started. Assignment to this variable resets -the count to the value assigned, and the expanded value -becomes the value assigned plus the number of seconds -since the assignment. - -@item PS3 -The value of this variable is used as the prompt for the -@code{select} command. If this variable is not set, the -@code{select} command prompts with @samp{#? } - -@item PS4 -This is the prompt printed before the command line is echoed -when the @samp{-x} option is set (@pxref{The Set Builtin}). -The default is @samp{+ }. - -@item PWD -The current working directory as set by the @code{cd} builtin. - -@item OLDPWD -The previous working directory as set by the @code{cd} builtin. - -@item TMOUT -If set to a value greater than zero, the value is interpreted as -the number of seconds to wait for input after issuing the primary -prompt. -Bash terminates after that number of seconds if input does -not arrive. - -@item LINENO -The line number in the script or shell function currently executing. - -@item FCEDIT -The editor used as a default by the @code{fc} builtin command. - -@end vtable - -@node Aliases -@section Aliases -@cindex alias expansion - -@menu -* Alias Builtins:: Builtins commands to maniuplate aliases. -@end menu - -The shell maintains a list of @var{aliases} -that may be set and unset with the @code{alias} and -@code{unalias} builtin commands. - -The first word of each command, if unquoted, -is checked to see if it has an -alias. If so, that word is replaced by the text of the alias. -The alias name and the replacement text may contain any valid -shell input, including shell metacharacters, with the exception -that the alias name may not contain @key{=}. -The first word of the replacement text is tested for -aliases, but a word that is identical to an alias being expanded -is not expanded a second time. This means that one may alias -@code{ls} to @code{"ls -F"}, -for instance, and Bash does not try to recursively expand the -replacement text. If the last character of the alias value is a -space or tab character, then the next command word following the -alias is also checked for alias expansion. - -Aliases are created and listed with the @code{alias} -command, and removed with the @code{unalias} command. - -There is no mechanism for using arguments in the replacement text, -as in @code{csh}. -If arguments are needed, a shell function should be used -(@pxref{Shell Functions}). - -Aliases are not expanded when the shell is not interactive, -unless the @code{expand_aliases} shell option is set using -@code{shopt} (@pxref{Bash Builtins}). - -The rules concerning the definition and use of aliases are -somewhat confusing. Bash -always reads at least one complete line -of input before executing any -of the commands on that line. Aliases are expanded when a -command is read, not when it is executed. Therefore, an -alias definition appearing on the same line as another -command does not take effect until the next line of input is read. -The commands following the alias definition -on that line are not affected by the new alias. -This behavior is also an issue when functions are executed. -Aliases are expanded when the function definition is read, -not when the function is executed, because a function definition -is itself a compound command. As a consequence, aliases -defined in a function are not available until after that -function is executed. To be safe, always put -alias definitions on a separate line, and do not use @code{alias} -in compound commands. - -Note that for almost every purpose, aliases are superseded by -shell functions. - -@node Alias Builtins -@subsection Alias Builtins - -@table @code - -@item alias -@btindex alias -@example -alias [@code{-p}] [@var{name}[=@var{value}] @dots{}] -@end example - -Without arguments or with the @samp{-p} option, @code{alias} prints -the list of aliases on the standard output in a form that allows -them to be reused as input. -If arguments are supplied, an alias is defined for each @var{name} -whose @var{value} is given. If no @var{value} is given, the name -and value of the alias is printed. - -@item unalias -@btindex unalias -@example -unalias [-a] [@var{name} @dots{} ] -@end example - -Remove each @var{name} from the list of aliases. If @samp{-a} is -supplied, all aliases are removed. -@end table - @node Bash Features @chapter Bash Features @@ -2876,7 +3105,9 @@ This section describes features unique to Bash. the @code{test} builtin. * Bash Variables:: List of variables that exist in Bash. * Shell Arithmetic:: Arithmetic on shell variables. -* Arrays:: Array Variables +* Aliases:: Substituting one command for another. +* Arrays:: Array Variables. +* The Directory Stack:: History of visited directories. * Printing a Prompt:: Controlling the PS1 string. * The Restricted Shell:: A more controlled mode of shell execution. * Bash POSIX Mode:: Making Bash behave more closely to what @@ -2899,6 +3130,10 @@ line before the single-character options in order for them to be recognized. @table @code +@item --dump-po-strings +Equivalent to @samp{-D}, but the output is in the GNU @code{gettext} +PO (portable object) file format. + @item --dump-strings Equivalent to @samp{-D}. @@ -2908,9 +3143,8 @@ Display a usage message on standard output and exit sucessfully. @item --login Make this shell act as if it were directly invoked by login. This is equivalent to @samp{exec -l bash} but can be issued from -another shell, such as @code{csh}. If you wanted to replace your -current login shell with a Bash login shell, you would say -@samp{exec bash --login}. +another shell, such as @code{csh}. @samp{exec bash --login} +will replace the current shell with a Bash login shell. @item --noediting Do not use the @sc{GNU} Readline library (@pxref{Command Line Editing}) @@ -2950,8 +3184,8 @@ Bash on the standard output and exit successfully. @end table -There are several single-character options you can give which are -not available with the @code{set} builtin. +There are several single-character options that may be supplied at +invocation which are not available with the @code{set} builtin. @table @code @item -c @var{string} @@ -2963,10 +3197,10 @@ positional parameters, starting with @code{$0}. Force the shell to run interactively. @item -r -Make the shell restricted. +Make the shell a restricted shell (@pxref{The Restricted Shell}). @item -s -If this flag is present, or if no arguments remain after option +If this option is present, or if no arguments remain after option processing, then commands are read from the standard input. This option allows the positional parameters to be set when invoking an interactive shell. @@ -2979,11 +3213,16 @@ are subject to language translation when the current locale is not @code{C} or @code{POSIX} (@pxref{Locale Translation}). This implies the @samp{-n} option; no commands will be executed. +@item -- +A @code{--} signals the end of options and disables further option +processing. +Any arguments after the @code{--} are treated as filenames and arguments. + @end table @cindex interactive shell An @emph{interactive} shell is one whose input and output are both -connected to terminals (as determined by @code{isatty()}), or one +connected to terminals (as determined by @code{isatty(3)}), or one started with the @samp{-i} option. If arguments remain after option processing, and neither the @@ -3046,13 +3285,13 @@ If Bash is invoked with the name @code{sh}, it tries to mimic the startup behavior of historical versions of @code{sh} as closely as possible, while conforming to the @sc{POSIX} standard as well. -When invoked as a login shell, it first attempts to read and execute -commands from @file{/etc/profile} and @file{~/.profile}, in that order. +When invoked as an interactive login shell, it first attempts to read +and execute commands from @file{/etc/profile} and @file{~/.profile}, in +that order. The @samp{--noprofile} option may be used to inhibit this behavior. -When invoked as an interactive shell with the name @code{sh}, -@code{bash} looks for the variable @code{ENV}, -expands its value if it is defined, and uses the -expanded value as the name of a file to read and execute. +When invoked as an interactive shell with the name @code{sh}, Bash +looks for the variable @code{ENV}, expands its value if it is defined, +and uses the expanded value as the name of a file to read and execute. Since a shell invoked as @code{sh} does not attempt to read and execute commands from any other startup files, the @samp{--rcfile} option has no effect. @@ -3065,10 +3304,10 @@ the startup files are read. When Bash is started in @sc{POSIX} mode, as with the @samp{--posix} command line option, it follows the @sc{POSIX} standard for startup files. -In this mode, the @code{ENV} variable is expanded and commands are read -and executed from the file whose name is the expanded value. +In this mode, interactive shells expand the @code{ENV} variable +and commands are read and executed from the file whose name is the +expanded value. No other startup files are read. -This is done by interactive shells only. Bash attempts to determine when it is being run by the remote shell daemon, usually @code{rshd}. If Bash determines it is being run by @@ -3077,8 +3316,8 @@ file exists and is readable. It will not do this if invoked as @code{sh}. The @samp{--norc} option may be used to inhibit this behavior, and the @samp{--rcfile} option may be used to force another file to be read, but -rshd does not generally invoke the shell with those options or allow -them to be specified. +@code{rshd} does not generally invoke the shell with those options or +allow them to be specified. @node Is This Shell Interactive? @section Is This Shell Interactive? @@ -3089,8 +3328,8 @@ is one whose input and output are both connected to terminals (as determined by @code{isatty(3)}), or one started with the @samp{-i} option. -You may wish to determine within a startup script whether Bash is -running interactively or not. To do this, examine the variable +To determine within a startup script whether Bash is +running interactively or not, examine the variable @code{$PS1}; it is unset in non-interactive shells, and set in interactive shells. Thus: @@ -3102,7 +3341,8 @@ else fi @end example -Alternatively, you may test the value of the @samp{-} special parameter. +Alternatively, startup scripts may test the value of the @samp{-} +special parameter. It contains @code{i} when the shell is interactive. For example: @example @@ -3123,7 +3363,8 @@ or have been extended in Bash. @item bind @btindex bind @example -bind [-m @var{keymap}] [-lpsvPSV] [-q @var{name}] [-r @var{keyseq}] +bind [-m @var{keymap}] [-lpsvPSV] +bind [-m @var{keymap}] [-q @var{function}] [-u @var{function}] [-r @var{keyseq}] bind [-m @var{keymap}] -f @var{filename} bind [-m @var{keymap}] @var{keyseq:function-name} @end example @@ -3153,65 +3394,83 @@ names are @code{emacs} is equivalent to @code{emacs-standard}. @item -l -List the names of all Readline functions +List the names of all Readline functions. @item -p Display Readline function names and bindings in such a way that they -can be re-read +can be re-read. @item -P -List current Readline function names and bindings +List current Readline function names and bindings. @item -v Display Readline variable names and values in such a way that they -can be re-read +can be re-read. @item -V -List current Readline variable names and values +List current Readline variable names and values. @item -s Display Readline key sequences bound to macros and the strings they output -in such a way that they can be re-read +in such a way that they can be re-read. @item -S -Display Readline key sequences bound to macros and the strings they output +Display Readline key sequences bound to macros and the strings they output. @item -f @var{filename} -Read key bindings from @var{filename} +Read key bindings from @var{filename}. -@item -q -Query about which keys invoke the named @var{function} +@item -q @var{function} +Query about which keys invoke the named @var{function}. + +@item -u @var{function} +Unbind all keys bound to the named @var{function}. @item -r @var{keyseq} -Remove any current binding for @var{keyseq} +Remove any current binding for @var{keyseq}. @end table +@noindent +The return status is zero unless an invalid option is supplied or an +error occurs. + @item builtin @btindex builtin @example builtin [@var{shell-builtin} [@var{args}]] @end example -Run a shell builtin. This is useful when you wish to define a -shell function with the same name as a shell builtin, but need the -functionality of the builtin within the function itself. +Run a shell builtin, passing it @var{args}, and return its exit status. +This is useful when defining a shell function with the same +name as a shell builtin, retaining the functionality of the builtin within +the function. +The return status is non-zero if @var{shell-builtin} is not a shell +builtin command. @item command @btindex command @example -command [-pVv] @var{command} [@var{args} @dots{}] +command [-pVv] @var{command} [@var{arguments} @dots{}] @end example -Runs @var{command} with @var{arg} ignoring shell functions. If -you have a shell function called @code{ls}, and you wish to call -the command @code{ls}, you can say @samp{command ls}. The -@samp{-p} option means to use a default value for @code{$PATH} +Runs @var{command} with @var{arguments} ignoring any shell function +named @var{command}. +Only shell builtin commands or commands found by searching the +@code{PATH} are executed. +If there is a shell function named @code{ls}, running @samp{command ls} +within the function will execute the external command @code{ls} +instead of calling the function recursively. +The @samp{-p} option means to use a default value for @code{$PATH} that is guaranteed to find all of the standard utilities. +The return status in this case is 127 if @var{command} cannot be +found or an error occurred, and the exit status of @var{command} +otherwise. If either the @samp{-V} or @samp{-v} option is supplied, a description of @var{command} is printed. The @samp{-v} option causes a single word indicating the command or file name used to -invoke @var{command} to be printed; the @samp{-V} option produces -a more verbose description. +invoke @var{command} to be displayed; the @samp{-V} option produces +a more verbose description. In this case, the return status is +zero if @var{command} is found, and non-zero if not. @item declare @btindex declare @@ -3244,30 +3503,40 @@ performed when the variable is assigned a value. @item -r Make @var{name}s readonly. These names cannot then be assigned values -by subsequent assignment statements. +by subsequent assignment statements or unset. @item -x Mark each @var{name} for export to subsequent commands via the environment. @end table -Using @samp{+} -instead of @samp{-} turns off the attribute instead. When used in -a function, @code{declare} makes each @var{name} local, as with the -@code{local} command. +Using @samp{+} instead of @samp{-} turns off the attribute instead. +When used in a function, @code{declare} makes each @var{name} local, +as with the @code{local} command. + +The return status is zero unless an invalid option is encountered, +an attempt is made to define a function using @code{-f foo=bar}, +an attempt is made to assign a value to a readonly variable, +an attempt is made to assign a value to an array variable without +using the compound assignment syntax (@pxref{Arrays}), +one of the @var{names} is not a valid shell variable name, +an attempt is made to turn off readonly status for a readonly variable, +an attempt is made to turn off array status for an array variable, +or an attempt is made to display a non-existent function with @samp{-f}. @item echo @btindex echo @example -echo [-neE] [arg @dots{}] +echo [-neE] [@var{arg} @dots{}] @end example -Output the @code{arg}s, separated by spaces, terminated with a -newline. The return status is always 0. If @samp{-n} is -specified, the trailing newline is suppressed. If the @samp{-e} -option is given, interpretation of the following backslash-escaped -characters is enabled. The @samp{-E} option disables the interpretation -of these escape characters, even on systems where they are interpreted -by default. +Output the @var{arg}s, separated by spaces, terminated with a +newline. +The return status is always 0. +If @samp{-n} is specified, the trailing newline is suppressed. +If the @samp{-e} option is given, interpretation of the following +backslash-escaped characters is enabled. +The @samp{-E} option disables the interpretation of these escape characters, +even on systems where they are interpreted by default. @code{echo} interprets the following escape sequences: @table @code @item \a @@ -3290,8 +3559,12 @@ horizontal tab vertical tab @item \\ backslash -@item \nnn -the character whose ASCII code is @code{nnn} (octal) +@item \@var{nnn} +the character whose @code{ASCII} code is the octal value @var{nnn} +(one to three digits) +@item \x@var{nnn} +the character whose @code{ASCII} code is the hexadecimal value @var{nnn} +(one to three digits) @end table @item enable @@ -3299,8 +3572,10 @@ the character whose ASCII code is @code{nnn} (octal) @example enable [-n] [-p] [-f @var{filename}] [-ads] [@var{name} @dots{}] @end example -Enable and disable builtin shell commands. This allows you to -use a disk command which has the same name as a shell builtin. +Enable and disable builtin shell commands. +Disabling a builtin allows a disk command which has the same name +as a shell builtin to be executed with specifying a full pathname, +even though the shell normally searches for builtins before disk commands. If @samp{-n} is used, the @var{name}s become disabled. Otherwise @var{name}s are enabled. For example, to use the @code{test} binary found via @code{$PATH} instead of the shell builtin version, type @@ -3315,31 +3590,48 @@ each builtin with an indication of whether or not it is enabled. The @samp{-f} option means to load the new builtin command @var{name} from shared object @var{filename}, on systems that support dynamic loading. The @samp{-d} option will delete a builtin loaded with @samp{-f}. + If there are no options, a list of the shell builtins is displayed. -The @samp{-s} option restricts @code{enable} to the @sc{POSIX.2} special +The @samp{-s} option restricts @code{enable} to the @sc{POSIX} special builtins. If @samp{-s} is used with @samp{-f}, the new builtin becomes a special builtin. +The return status is zero unless a @var{name} is not a shell builtin +or there is an error loading a new builtin from a shared object. + @item help @btindex help @example help [@var{pattern}] @end example -Display helpful information about builtin commands. If -@var{pattern} is specified, @code{help} gives detailed help +Display helpful information about builtin commands. +If @var{pattern} is specified, @code{help} gives detailed help on all commands matching @var{pattern}, otherwise a list of -the builtins is printed. +the builtins is printed. The return status is zero unless no +command matches @var{pattern}. + +@item let +@btindex let +@example +let @var{expression} [@var{expression}] +@end example +The @code{let} builtin allows arithmetic to be performed on shell +variables. Each @var{expression} is evaluated according to the +rules given below in @ref{Shell Arithmetic}. If the +last @var{expression} evaluates to 0, @code{let} returns 1; +otherwise 0 is returned. @item local @btindex local @example local @var{name}[=@var{value}] @end example -For each argument, create a local variable called @var{name}, and -give it @var{value}. +For each argument, a local variable named @var{name} is created, +and assigned @var{value}. @code{local} can only be used within a function; it makes the variable @var{name} have a visible scope restricted to that function and its -children. +children. The return status is zero unless @code{local} is used outside +a function or an invalid @var{name} is supplied. @item logout @btindex logout @@ -3349,20 +3641,45 @@ logout [@var{n}] Exit a login shell, returning a status of @var{n} to the shell's parent. +@item printf +@btindex printf +@example +@code{printf} @var{format} [@var{arguments}] +@end example +Write the formatted @var{arguments} to the standard output under the +control of the @var{format}. +The @var{format} is a character string which contains three types of objects: +plain characters, which are simply copied to standard output, character +escape sequences, which are converted and copied to the standard output, and +format specifications, each of which causes printing of the next successive +@var{argument}. +In addition to the standard @code{printf(1)} formats, @samp{%b} causes +@code{printf} to expand backslash escape sequences in the corresponding +@var{argument}, and @samp{%q} causes @code{printf} to output the +corresponding @var{argument} in a format that can be reused as shell input. + +The @var{format} is reused as necessary to consume all of the @var{arguments}. +If the @var{format} requires more @var{arguments} than are supplied, the +extra format specifications behave as if a zero value or null string, as +appropriate, had been supplied. + @item read @btindex read @example read [-a @var{aname}] [-p @var{prompt}] [-er] [@var{name} @dots{}] @end example One line is read from the standard input, and the first word -is assigned to the first -@var{name}, the second word to the second @var{name}, -and so on, with leftover words assigned to the last @var{name}. -Only the characters in the value of the @code{IFS} variable -are recognized as word delimiters. If no names -are supplied, the line read is assigned to the variable @code{REPLY}. -The return code is zero, unless end-of-file is encountered. Options, -if supplied, have the following meanings: +is assigned to the first @var{name}, the second word to the second @var{name}, +and so on, with leftover words and their intervening separators assigned +to the last @var{name}. +If there are fewer words read from the standard input than names, +the remaining names are assigned empty values. +The characters in the value of the @code{IFS} variable +are used to split the line into words. +If no names are supplied, the line read is assigned to the +variable @code{REPLY}. +The return code is zero, unless end-of-file is encountered. +Options, if supplied, have the following meanings: @table @code @item -r @@ -3370,13 +3687,15 @@ If this option is given, a backslash-newline pair is not ignored, and the backslash is considered to be part of the line. @item -p @var{prompt} -Display @code{prompt}, without a +Display @var{prompt}, without a trailing newline, before attempting to read any input. The prompt is displayed only if input is coming from a terminal. @item -a @var{aname} -The words are assigned to -sequential indices of the array variable @var{aname}, starting at 0. +The words are assigned to sequential indices of the array variable +@var{aname}, starting at 0. +All elements are removed from @var{aname} before the assignment. +Other @var{name} arguments are ignored. @item -e Readline (@pxref{Command Line Editing}) @@ -3389,14 +3708,15 @@ is used to obtain the line. shopt [-pqsu] [-o] [@var{optname} @dots{}] @end example Toggle the values of variables controlling optional shell behavior. -With no options, or with the @samp{-p} -option, a list of all settable options is displayed, with -an indication of whether or not each is set. Other options have -the following meanings: +With no options, or with the @samp{-p} option, a list of all settable +options is displayed, with an indication of whether or not each is set. +The @samp{-p} option causes output to be displayed in a form that +may be reused as input. +Other options have the following meanings: @table @code @item -s -Enable (set) each @var{optname} +Enable (set) each @var{optname}. @item -u Disable (unset) each @var{optname}. @@ -3414,8 +3734,7 @@ Restricts the values of @code{set} builtin (@pxref{The Set Builtin}). @end table -If either of -@samp{-s} or @samp{-u} +If either @samp{-s} or @samp{-u} is used with no @var{optname} arguments, the display is limited to those options which are set or unset, respectively. @@ -3424,7 +3743,7 @@ by default. The return status when listing options is zero if all @var{optnames} are enabled, non-zero otherwise. When setting or unsetting options, -the return status is zero unless an @var{optname} is not a legal shell +the return status is zero unless an @var{optname} is not a valid shell option. The list of @code{shopt} options is: @@ -3470,6 +3789,15 @@ it cannot execute the file specified as an argument to the @code{exec} builtin command. An interactive shell does not exit if @code{exec} fails. +@item expand_aliases +If set, aliases are expanded as described below< under Aliases +(@pxref{Aliases}). +This option is enabled by default for interactive shells. + +@item extglob +If set, the extended pattern matching features described above +(@pxref{Pattern Matching}) are enabled. + @item histappend If set, the history list is appended to the file named by the value of the @code{HISTFILE} @@ -3488,10 +3816,14 @@ the Readline editing buffer, allowing further modification. @item hostcomplete If set, and Readline is being used, Bash will attempt to perform -hostname completion when a word beginning with @samp{@@} is being +hostname completion when a word containing a @samp{@@} is being completed (@pxref{Commands For Completion}). This option is enabled by default. +@item huponexit +If set, Bash will send @code{SIGHUP} to all jobs when an interactive +login shell exits (@pxref{Signals}). + @item interactive_comments Allow a word beginning with @samp{#} to cause that word and all remaining characters on that @@ -3508,6 +3840,10 @@ If set, and a file that Bash is checking for mail has been accessed since the last time it was checked, the message @code{"The mail in @var{mailfile} has been read"} is displayed. +@item nocaseglob +If set, Bash matches filenames in a case-insensitive fashion when +performing filename expansion. + @item nullglob If set, Bash allows filename patterns which match no files to expand to a null string, rather than themselves. @@ -3525,18 +3861,31 @@ number of positional parameters. @item sourcepath If set, the @code{source} builtin uses the value of @code{PATH} to find the directory containing the file supplied as an argument. -This is enabled by default. +This option is enabled by default. @end table +@noindent +The return status when listing options is zero if all @var{optnames} +are enabled, non-zero otherwise. +When setting or unsetting options, the return status is zero unless an +@var{optname} is not a valid shell option. + +@item source +@btindex source +@example +source @var{filename} +@end example +A synonym for @code{.} (@pxref{Bourne Shell Builtins}). + @item type @btindex type @example -type [-all] [-type | -path] [@var{name} @dots{}] +type [-atp] [@var{name} @dots{}] @end example For each @var{name}, indicate how it would be interpreted if used as a command name. -If the @samp{-type} flag is used, @code{type} returns a single word +If the @samp{-t} option is used, @code{type} prints a single word which is one of @samp{alias}, @samp{function}, @samp{builtin}, @samp{file} or @samp{keyword}, if @var{name} is an alias, shell function, shell builtin, @@ -3544,16 +3893,26 @@ disk file, or shell reserved word, respectively. If the @var{name} is not found, then nothing is printed, and @code{type} returns a failure status. -If the @samp{-path} flag is used, @code{type} either returns the name -of the disk file that would be executed, or nothing if @samp{-type} +If the @samp{-p} option is used, @code{type} either returns the name +of the disk file that would be executed, or nothing if @samp{-t} would not return @samp{file}. -If the @samp{-all} flag is used, returns all of the places that contain -an executable named @var{file}. This includes aliases and functions, -if and only if the @samp{-path} flag is not also used. +If the @samp{-a} option is used, @code{type} returns all of the places +that contain an executable named @var{file}. +This includes aliases and functions, if and only if the @samp{-p} option +is not also used. -@code{type} accepts @samp{-a}, @samp{-t}, and @samp{-p} as equivalent to -@samp{-all}, @samp{-type}, and @samp{-path}, respectively. +The return status is zero if any of the @var{names} are found, non-zero +if none are found. + +@item typeset +@btindex typeset +@example +typeset [-afFrxi] [-p] [@var{name}[=@var{value}]] +@end example +The @code{typeset} command is supplied for compatibility with the Korn +shell; however, it has been deprecated in favor of the @code{declare} +builtin command. @item ulimit @btindex ulimit @@ -3565,46 +3924,46 @@ started by the shell, on systems that allow such control. If an option is given, it is interpreted as follows: @table @code @item -S -change and report the soft limit associated with a resource. +Change and report the soft limit associated with a resource. @item -H -change and report the hard limit associated with a resource. +Change and report the hard limit associated with a resource. @item -a -all current limits are reported. +All current limits are reported. @item -c -the maximum size of core files created. +The maximum size of core files created. @item -d -the maximum size of a process's data segment. +The maximum size of a process's data segment. @item -f -the maximum size of files created by the shell. +The maximum size of files created by the shell. @item -l The maximum size that may be locked into memory. @item -m -the maximum resident set size. +The maximum resident set size. @item -n -the maximum number of open file descriptors. +The maximum number of open file descriptors. @item -p -the pipe buffer size. +The pipe buffer size. @item -s -the maximum stack size. +The maximum stack size. @item -t -the maximum amount of cpu time in seconds. +The maximum amount of cpu time in seconds. @item -u -the maximum number of processes available to a single user. +The maximum number of processes available to a single user. @item -v -the maximum amount of virtual memory available to the process. +The maximum amount of virtual memory available to the process. @end table @@ -3618,20 +3977,31 @@ increments, except for @samp{-t}, which is in seconds, @samp{-p}, which is in units of 512-byte blocks, and @samp{-n} and @samp{-u}, which are unscaled values. +The return status is zero unless an invalid option is supplied, a +non-numeric argument other than @code{unlimited} is supplied as a +@var{limit}, or an error occurs while setting a new limit. + @end table @node The Set Builtin @section The Set Builtin -This builtin is so overloaded that it deserves its own section. +This builtin is so complicated that it deserves its own section. @table @code @item set @btindex set @example -set [-abefhkmnptuvxdBCHP] [-o @var{option}] [@var{argument} @dots{}] +set [--abefhkmnptuvxBCHP] [-o @var{option}] [@var{argument} @dots{}] @end example +If no options or arguments are supplied, @code{set} displays the names +and values of all shell variables and functions, sorted according to the +current locale, in a format that may be reused as input. + +When options are supplied, they set or unset shell attributes. +Options, if specified, have the following meanings: + @table @code @item -a Mark variables which are modified or created for export. @@ -3641,13 +4011,18 @@ Cause the status of terminated background jobs to be reported immediately, rather than before printing the next primary prompt. @item -e -Exit immediately if a simple command exits with a non-zero status. +Exit immediately if a simple command (@pxref{Simple Commands}) exits +with a non-zero status, unless the command that fails is part of an +@code{until} or @code{while} loop, part of an @code{if} statement, +part of a @code{&&} or @code{||} list, or if the command's return +status is being inverted using @code{!}. @item -f Disable file name generation (globbing). @item -h Locate and remember (hash) commands as they are looked up for execution. +This option is enabled by default. @item -k All arguments in the form of assignment statements are placed @@ -3658,89 +4033,94 @@ the command name. Job control is enabled (@pxref{Job Control}). @item -n -Read commands but do not execute them. +Read commands but do not execute them; this may be used to check a +script for syntax errors. +This option is ignored by interactive shells. @item -o @var{option-name} -Set the flag corresponding to @var{option-name}: +Set the option corresponding to @var{option-name}: @table @code @item allexport -same as @code{-a}. +Same as @code{-a}. @item braceexpand -same as @code{-B}. +Same as @code{-B}. @item emacs -use an @code{emacs}-style line editing interface (@pxref{Command Line Editing}). +Use an @code{emacs}-style line editing interface (@pxref{Command Line Editing}). @item errexit -same as @code{-e}. +Same as @code{-e}. @item hashall -same as @code{-h}. +Same as @code{-h}. @item histexpand -same as @code{-H}. +Same as @code{-H}. @item history Enable command history, as described in @ref{Bash History Facilities}. This option is on by default in interactive shells. @item ignoreeof -the shell will not exit upon reading EOF. +An interactive shell will not exit upon reading EOF. @item keyword -same as @code{-k}. +Same as @code{-k}. @item monitor -same as @code{-m}. +Same as @code{-m}. @item noclobber -same as @code{-C}. +Same as @code{-C}. @item noexec -same as @code{-n}. +Same as @code{-n}. @item noglob -same as @code{-f}. +Same as @code{-f}. @item notify -same as @code{-b}. +Same as @code{-b}. @item nounset -same as @code{-u}. +Same as @code{-u}. @item onecmd -same as @code{-t}. +Same as @code{-t}. @item physical -same as @code{-P}. +Same as @code{-P}. @item posix -change the behavior of Bash where the default operation differs -from the @sc{POSIX} 1003.2 standard to match the standard. This -is intended to make Bash behave as a strict superset of that +Change the behavior of Bash where the default operation differs +from the @sc{POSIX} 1003.2 standard to match the standard +(@pxref{Bash POSIX Mode}). +This is intended to make Bash behave as a strict superset of that standard. @item privileged -same as @code{-p}. +Same as @code{-p}. @item verbose -same as @code{-v}. +Same as @code{-v}. @item vi -use a @code{vi}-style line editing interface. +Use a @code{vi}-style line editing interface. @item xtrace -same as @code{-x}. +Same as @code{-x}. @end table @item -p Turn on privileged mode. -In this mode, the @code{$BASH_ENV} -file is not processed, and shell functions -are not inherited from the environment. This is enabled automatically +In this mode, the @code{$BASH_ENV} and @code{$ENV} files are not +processed, shell functions are not inherited from the environment, +and the @code{SHELLOPTS} variable, if it appears in the environment, +is ignored. +This is enabled automatically on startup if the effective user (group) id is not equal to the real user (group) id. Turning this option off causes the effective user and group ids to be set to the real user and group ids. @@ -3749,24 +4129,28 @@ and group ids to be set to the real user and group ids. Exit after reading and executing one command. @item -u -Treat unset variables as an error when substituting. +Treat unset variables as an error when performing parameter expansion. +An error message will be written to the standard error, and a non-interactive +shell will exit. @item -v Print shell input lines as they are read. @item -x -Print commands and their arguments as they are executed. +Print a trace of simple commands and their arguments after they are +expanded and before they are executed. @item -B The shell will perform brace expansion (@pxref{Brace Expansion}). This option is on by default. @item -C -Disallow output redirection to existing files. +Prevent output redirection using @samp{>}, @samp{>&}, and @samp{<>} +from overwriting existing files. @item -H Enable @samp{!} style history substitution (@pxref{History Interaction}). -This flag is on by default for interactive shells. +This option is on by default for interactive shells. @item -P If set, do not follow symbolic links when performing commands such as @@ -3775,7 +4159,8 @@ is used instead. By default, Bash follows the logical chain of directories when performing commands which change the current directory. -For example, if @file{/usr/sys} is a link to @file{/usr/local/sys} then: +For example, if @file{/usr/sys} is a symbolic link to @file{/usr/local/sys} +then: @example $ cd /usr/sys; echo $PWD /usr/sys @@ -3793,7 +4178,7 @@ $ cd ..; pwd @end example @item -- -If no arguments follow this flag, then the positional parameters are +If no arguments follow this option, then the positional parameters are unset. Otherwise, the positional parameters are set to the @var{arguments}, even if some of them begin with a @samp{-}. @@ -3804,29 +4189,34 @@ and @samp{-v} options are turned off. If there are no arguments, the positional parameters remain unchanged. @end table -Using @samp{+} rather than @samp{-} causes these flags to be -turned off. The flags can also be used upon invocation of the -shell. The current set of flags may be found in @code{$-}. +Using @samp{+} rather than @samp{-} causes these options to be +turned off. The options can also be used upon invocation of the +shell. The current set of options may be found in @code{$-}. The remaining N @var{arguments} are positional parameters and are -assigned, in order, to @code{$1}, @code{$2}, @dots{} @code{$N}. If -no arguments are given, all shell variables are printed. +assigned, in order, to @code{$1}, @code{$2}, @dots{} @code{$N}. +The special parameter @code{#} is set to N. + +The return status is always zero unless an invalid option is supplied. @end table @node Bash Conditional Expressions @section Bash Conditional Expressions @cindex expressions, conditional -Conditional expressions are used by the @code{test} and @code{[} builtins. +Conditional expressions are used by the @code{[[} compound command +and the @code{test} and @code{[} builtin commands. -Expressions may be unary or binary. Unary -expressions are often used to examine the status of a file. There -are string operators and numeric comparison operators as well. Each -operator and operand must be a separate argument. If @var{file} -is of the form @file{/dev/fd/@var{N}}, then file descriptor @var{N} is -checked. Expressions are composed of the following primaries: +Expressions may be unary or binary. +Unary expressions are often used to examine the status of a file. +There are string operators and numeric comparison operators as well. +If any @var{file} argument to one of the primaries is of the form +@file{/dev/fd/@var{N}}, then file descriptor @var{N} is checked. @table @code +@item -a @var{file} +True if @var{file} exists. + @item -b @var{file} True if @var{file} exists and is a block special file. @@ -3843,16 +4233,13 @@ True if @var{file} exists. True if @var{file} exists and is a regular file. @item -g @var{file} -True if @var{file} exists and is set-group-id. +True if @var{file} exists and its set-group-id bit is set. @item -k @var{file} -True if @var{file} has its "sticky" bit set. - -@item -L @var{file} -True if @var{file} exists and is a symbolic link. +True if @var{file} exists and its "sticky" bit is set. @item -p @var{file} -True if @var{file} exists and is a named pipe. +True if @var{file} exists and is a named pipe (FIFO). @item -r @var{file} True if @var{file} exists and is readable. @@ -3860,11 +4247,8 @@ True if @var{file} exists and is readable. @item -s @var{file} True if @var{file} exists and has a size greater than zero. -@item -S @var{file} -True if @var{file} exists and is a socket. - @item -t @var{fd} -True if @var{fd} is opened on a terminal. +True if file descriptor @var{fd} is open and refers to a terminal. @item -u @var{file} True if @var{file} exists and its set-user-id bit is set. @@ -3881,6 +4265,15 @@ True if @var{file} exists and is owned by the effective user id. @item -G @var{file} True if @var{file} exists and is owned by the effective group id. +@item -L @var{file} +True if @var{file} exists and is a symbolic link. + +@item -S @var{file} +True if @var{file} exists and is a socket. + +@item -N @var{file} +True if @var{file} exists and has been modified since it was last read. + @item @var{file1} -nt @var{file2} True if @var{file1} is newer (according to modification date) than @var{file2}. @@ -3904,27 +4297,20 @@ True if the length of @var{string} is zero. @itemx @var{string} True if the length of @var{string} is non-zero. -@item @var{string1} = @var{string2} -True if the strings are equal. @samp{==} may be used in place of -@samp{=}. +@item @var{string1} == @var{string2} +True if the strings are equal. +@samp{=} may be used in place of @samp{==}. @item @var{string1} != @var{string2} True if the strings are not equal. @item @var{string1} < @var{string2} -True if @var{string1} sorts before @var{string2} lexicographically. +True if @var{string1} sorts before @var{string2} lexicographically +in the current locale. @item @var{string1} > @var{string2} -True if @var{string1} sorts after @var{string2} lexicographically. - -@item ! @var{expr} -True if @var{expr} is false. - -@item @var{expr1} -a @var{expr2} -True if both @var{expr1} and @var{expr2} are true. - -@item @var{expr1} -o @var{expr2} -True if either @var{expr1} and @var{expr2} is true. +True if @var{string1} sorts after @var{string2} lexicographically +in the current locale. @item @var{arg1} OP @var{arg2} @code{OP} is one of @@ -3937,43 +4323,6 @@ may be positive or negative integers. @end table -The Bash @code{test} and @code{[} builtins evaluate conditional -expressions using a set of rules based on the number of arguments. -These are the rules: - -@table @asis -@item 0 arguments -The expression is false. -@item 1 argument -The expression is true if and only if the argument is not null. -@item 2 arguments -If the first argument is @samp{!}, the expression is true if and -only if the second argument is null. If the first argument is -one of the listed unary operators, the expression is true if the -unary test is true. If the first argument is not a legal unary -operator, the expression is false. -@item 3 arguments -If the first argument is @samp{!}, the value is the negation of -the two-argument test using the second and third arguments. -If the second argument is one of the binary operators, the result -of the expression is the result of the binary test using the first -and third arguments as operands. -If the first argument is exactly @samp{(} and the third argument is -exactly @samp{)}, the result is the one-argument test of the second -argument. -Otherwise, the expression is false. -The @samp{-a} and @samp{-o} operators are considered binary operators -in this case. -@item 4 arguments -If the first argument is @samp{!}, the result is the negation of -the three-argument expression composed of the remaining arguments. -Otherwise, the expression is parsed and evaluated according to -precedence. @samp{-a} has a higher precedence than @samp{-o}. -@item 5 or more arguments -The expression is parsed and evaluated according to precedence, -with @samp{-a} having a higher precedence than @samp{-o}. -@end table - @node Bash Variables @section Bash Variables @@ -3982,56 +4331,101 @@ do not normally treat them specially. @vtable @code +@item BASH +The full pathname used to execute the current instance of Bash. + @item BASH_ENV If this variable is set when Bash is invoked to execute a shell script, its value is expanded and used as the name of a startup file to read before executing the script. @xref{Bash Startup Files}. -@item TIMEFORMAT -The value of this parameter is used as a format string specifying -how the timing information for pipelines prefixed with the @code{time} -reserved word should be displayed. -The @samp{%} character introduces an -escape sequence that is expanded to a time value or other -information. -The escape sequences and their meanings are as -follows; the braces denote optional portions. +@item BASH_VERSION +The version number of the current instance of Bash. + +@item BASH_VERSINFO +A readonly array variable whose members hold version information for +this instance of Bash. +The values assigned to the array members are as follows: @table @code -@item %% -A literal @samp{%}. +@item BASH_VERSINFO[0] +The major version number (the @var{release}). -@item %[@var{p}][l]R -The elapsed time in seconds. +@item BASH_VERSINFO[1] +The minor version number (the @var{version}). -@item %[@var{p}][l]U -The number of CPU seconds spent in user mode. +@item BASH_VERSINFO[2] +The patch level. -@item %[@var{p}][l]S -The number of CPU seconds spent in system mode. +@item BASH_VERSINFO[3] +The build version. + +@item BASH_VERSINFO[4] +The release status (e.g., @var{beta1}). + +@item BASH_VERSINFO[5] +The value of @code{MACHTYPE}. -@item %P -The CPU percentage, computed as (%U + %S) / %R. @end table -The optional @var{p} is a digit specifying the precision, the number of -fractional digits after a decimal point. -A value of 0 causes no decimal point or fraction to be output. -At most three places after the decimal point may be specified; values -of @var{p} greater than 3 are changed to 3. -If @var{p} is not specified, the value 3 is used. +@item DIRSTACK +An array variable (@pxref{Arrays}) +containing the current contents of the directory stack. +Directories appear in the stack in the order they are displayed by the +@code{dirs} builtin. +Assigning to members of this array variable may be used to modify +directories already in the stack, but the @code{pushd} and @code{popd} +builtins must be used to add and remove directories. +Assignment to this variable will not change the current directory. +If @code{DIRSTACK} is unset, it loses its special properties, even if +it is subsequently reset. -The optional @code{l} specifies a longer format, including minutes, of -the form @var{MM}m@var{SS}.@var{FF}s. -The value of @var{p} determines whether or not the fraction is included. +@item EUID +The numeric effective user id of the current user. This variable +is readonly. -If this variable is not set, bash acts as if it had the value -@example -@code{$'\nreal\t%3lR\nuser\t%3lU\nsys\t%3lS'}. -@end example -If the value is null, no timing information is displayed. -A trailing newline is added when the format string is displayed. +@item FCEDIT +The editor used as a default by the @samp{-e} option to the @code{fc} +builtin command. + +@item FIGNORE +A colon-separated list of suffixes to ignore when performing +filename completion. +A file name whose suffix matches one of the entries in +@code{FIGNORE} +is excluded from the list of matched file names. A sample +value is @samp{.o:~} + +@item GLOBIGNORE +A colon-separated list of patterns defining the set of filenames to +be ignored by filename expansion. +If a filename matched by a filename expansion pattern also matches one +of the patterns in @code{GLOBIGNORE}, it is removed from the list +of matches. + +@item GROUPS +An array variable containing the list of groups of which the current +user is a member. This variable is readonly. + +@item histchars +Up to three characters which control history expansion, quick +substitution, and tokenization (@pxref{History Interaction}). +The first character is the +@dfn{history-expansion-char}, that is, the character which signifies the +start of a history expansion, normally @samp{!}. The second character is the +character which signifies `quick substitution' when seen as the first +character on a line, normally @samp{^}. The optional third character is the +character which indicates that the remainder of the line is a comment when +found as the first character of a word, usually @samp{#}. The history +comment character causes history substitution to be skipped for the +remaining words on the line. It does not necessarily cause the shell +parser to treat the rest of the line as a comment. + +@item HISTCMD +The history number, or index in the history list, of the current +command. If @code{HISTCMD} is unset, it loses its special properties, +even if it is subsequently reset. @item HISTCONTROL Set to a value of @samp{ignorespace}, it means don't enter lines which @@ -4040,6 +4434,9 @@ of @samp{ignoredups}, it means don't enter lines which match the last entered line. A value of @samp{ignoreboth} combines the two options. Unset, or set to any other value than those above, means to save all lines on the history list. +The second and subsequent lines of a multi-line compound command are +not tested, and are added to the history regardless of the value of +@code{HISTCONTROL}. @item HISTIGNORE A colon-separated list of patterns used to decide which command @@ -4051,6 +4448,9 @@ are applied. In addition to the normal shell pattern matching characters, @samp{&} matches the previous history line. @samp{&} may be escaped using a backslash. The backslash is removed before attempting a match. +The second and subsequent lines of a multi-line compound command are +not tested, and are added to the history regardless of the value of +@code{HISTIGNORE}. @code{HISTIGNORE} subsumes the function of @code{HISTCONTROL}. A pattern of @samp{&} is identical to @code{ignoredups}, and a @@ -4063,8 +4463,8 @@ The name of the file to which the command history is saved. The default is @file{~/.bash_history}. @item HISTSIZE -If set, this is the maximum number of commands to remember in the -history. +The maximum number of commands to remember on the history list. +The default value is 500. @item HISTFILESIZE The maximum number of lines contained in the history file. When this @@ -4073,25 +4473,6 @@ necessary, to contain no more than that number of lines. The default value is 500. The history file is also truncated to this size after writing it when an interactive shell exits. -@item histchars -Up to three characters which control history expansion, quick -substitution, and tokenization (@pxref{History Interaction}). -The first character is the -@dfn{history-expansion-char}, that is, the character which signifies the -start of a history expansion, normally @samp{!}. The second character is the -character which signifies `quick substitution' when seen as the first -character on a line, normally @samp{^}. The optional third character is the -character which signifies the remainder of the line is a comment, when -found as the first character of a word, usually @samp{#}. The history -comment character causes history substitution to be skipped for the -remaining words on the line. It does not necessarily cause the shell -parser to treat the rest of the line as a comment. - -@item HISTCMD -The history number, or index in the history list, of the current -command. If @code{HISTCMD} is unset, it loses its special properties, -even if it is subsequently reset. - @item HOSTFILE Contains the name of a file in the same format as @file{/etc/hosts} that should be read when the shell needs to complete a hostname. You can @@ -4099,76 +4480,70 @@ change the file interactively; the next time you attempt to complete a hostname, Bash will add the contents of the new file to the already existing database. -@item MAILCHECK -How often (in seconds) that the shell should check for mail -in the files specified in @code{MAILPATH}. +@item HOSTNAME +The name of the current host. -@item PROMPT_COMMAND -If present, this contains a string which is a command to execute -before the printing of each primary prompt (@code{$PS1}). +@item HOSTTYPE +A string describing the machine Bash is running on. -@item UID -The numeric real user id of the current user. +@item IGNOREEOF +Controls the action of the shell on receipt of an @code{EOF} character +as the sole input. If set, the value denotes the number +of consecutive @code{EOF} characters that can be read as the +first character on an input line +before the shell will exit. If the variable exists but does not +have a numeric value (or has no value) then the default is 10. +If the variable does not exist, then @code{EOF} signifies the end of +input to the shell. This is only in effect for interactive shells. -@item EUID -The numeric effective user id of the current user. +@item INPUTRC +The name of the Readline startup file, overriding the default +of @file{~/.inputrc}. -@item GROUPS -An array variable containing the list of groups of which the current -user is a member. +@item LANG +Used to determine the locale category for any category not specifically +selected with a variable starting with @code{LC_}. -@item PPID -The process id of the shell's parent process. +@item LC_ALL +This variable overrides the value of @code{LANG} and any other +@code{LC_} variable specifying a locale category. -@item HOSTNAME -The name of the current host. +@item LC_COLLATE +This variable determines the collation order used when sorting the +results of filename expansion, and +determines the behavior of range expressions, equivalence classes, +and collating sequences within filename expansion and pattern matching +(@pxref{Filename Expansion}). -@item HOSTTYPE -A string describing the machine Bash is running on. +@item LC_CTYPE +This variable determines the interpretation of characters and the +behavior of character classes within filename expansion and pattern +matching (@pxref{Filename Expansion}). -@item OSTYPE -A string describing the operating system Bash is running on. +@item LC_MESSAGES +This variable determines the locale used to translate double-quoted +strings preceded by a @samp{$} (@pxref{Locale Translation}). + +@item LINENO +The line number in the script or shell function currently executing. @item MACHTYPE A string that fully describes the system type on which Bash is executing, in the standard GNU @var{cpu-company-system} format. -@item SHELLOPTS -A colon-separated list of enabled shell options. Each word in -the list is a valid argument for the @samp{-o} option to the -@code{set} builtin command (@pxref{The Set Builtin}). -The options appearing in @code{SHELLOPTS} are those reported -as @samp{on} by @samp{set -o}. -If this variable is in the environment when Bash -starts up, each shell option in the list will be enabled before -reading any startup files. This variable is readonly. +@item MAILCHECK +How often (in seconds) that the shell should check for mail in the +files specified in the @code{MAILPATH} or @code{MAIL} variables. -@item FIGNORE -A colon-separated list of suffixes to ignore when performing -filename completion. -A file name whose suffix matches one of the entries in -@code{FIGNORE} -is excluded from the list of matched file names. A sample -value is @samp{.o:~} +@item OLDPWD +The previous working directory as set by the @code{cd} builtin. -@item GLOBIGNORE -A colon-separated list of patterns defining the set of filenames to -be ignored by filename expansion. -If a filename matched by a filename expansion pattern also matches one -of the patterns in @code{GLOBIGNORE}, it is removed from the list -of matches. +@item OPTERR +If set to the value 1, Bash displays error messages +generated by the @code{getopts} builtin command. -@item DIRSTACK -An array variable (@pxref{Arrays}) -containing the current contents of the directory stack. -Directories appear in the stack in the order they are displayed by the -@code{dirs} builtin. -Assigning to members of this array variable may be used to modify -directories already in the stack, but the @code{pushd} and @code{popd} -builtins must be used to add and remove directories. -Assignment to this variable will not change the current directory. -If @code{DIRSTACK} is unset, it loses its special properties, even if -it is subsequently reset. +@item OSTYPE +A string describing the operating system Bash is running on. @item PIPESTATUS An array variable (@pxref{Arrays}) @@ -4176,94 +4551,120 @@ containing a list of exit status values from the processes in the most-recently-executed foreground pipeline (which may contain only a single command). -@item INPUTRC -The name of the Readline startup file, overriding the default -of @file{~/.inputrc}. - -@item BASH -The full filename used to execute the current instance of Bash. - -@item BASH_VERSION -The version number of the current instance of Bash. - -@item BASH_VERSINFO -An array variable whose members hold version information for this -instance of Bash. -The values assigned to the array members are as follows: +@item PPID +The process id of the shell's parent process. This variable +is readonly. -@table @code +@item PROMPT_COMMAND +If present, this contains a string which is a command to execute +before the printing of each primary prompt (@code{$PS1}). -@item BASH_VERSINFO[0] -The major version number (the @var{release}). +@item PS3 +The value of this variable is used as the prompt for the +@code{select} command. If this variable is not set, the +@code{select} command prompts with @samp{#? } -@item BASH_VERSINFO[1] -The minor version number (the @var{version}). +@item PS4 +This is the prompt printed before the command line is echoed +when the @samp{-x} option is set (@pxref{The Set Builtin}). +The first character of @code{PS4} is replicated multiple times, as +necessary, to indicate multiple levels of indirection. +The default is @samp{+ }. -@item BASH_VERSINFO[2] -The patch level. +@item PWD +The current working directory as set by the @code{cd} builtin. -@item BASH_VERSINFO[3] -The build version. +@item RANDOM +Each time this parameter is referenced, a random integer +between 0 and 32767 is generated. Assigning a value to this +variable seeds the random number generator. -@item BASH_VERSINFO[4] -The release status (e.g., @var{beta1}). +@item REPLY +The default variable for the @code{read} builtin. -@item BASH_VERSINFO[5] -The value of @code{MACHTYPE}. +@item SECONDS +This variable expands to the number of seconds since the +shell was started. Assignment to this variable resets +the count to the value assigned, and the expanded value +becomes the value assigned plus the number of seconds +since the assignment. -@end table +@item SHELLOPTS +A colon-separated list of enabled shell options. Each word in +the list is a valid argument for the @samp{-o} option to the +@code{set} builtin command (@pxref{The Set Builtin}). +The options appearing in @code{SHELLOPTS} are those reported +as @samp{on} by @samp{set -o}. +If this variable is in the environment when Bash +starts up, each shell option in the list will be enabled before +reading any startup files. This variable is readonly. @item SHLVL Incremented by one each time a new instance of Bash is started. This is intended to be a count of how deeply your Bash shells are nested. -@item OPTERR -If set to the value 1, Bash displays error messages -generated by the @code{getopts} builtin command. +@item TIMEFORMAT +The value of this parameter is used as a format string specifying +how the timing information for pipelines prefixed with the @code{time} +reserved word should be displayed. +The @samp{%} character introduces an +escape sequence that is expanded to a time value or other +information. +The escape sequences and their meanings are as +follows; the braces denote optional portions. -@item LANG -Used to determine the locale category for any category not specifically -selected with a variable starting with @code{LC_}. +@table @code -@item LC_ALL -This variable overrides the value of @code{LANG} and any other -@code{LC_} variable specifying a locale category. +@item %% +A literal @samp{%}. -@item LC_COLLATE -This variable determines the collation order used when sorting the -results of filename expansion (@pxref{Filename Expansion}). +@item %[@var{p}][l]R +The elapsed time in seconds. -@item LC_MESSAGES -This variable determines the locale used to translate double-quoted -strings preceded by a @samp{$} (@pxref{Locale Translation}). +@item %[@var{p}][l]U +The number of CPU seconds spent in user mode. -@item IGNOREEOF -Controls the action of the shell on receipt of an @code{EOF} character -as the sole input. If set, then the value of it is the number -of consecutive @code{EOF} characters that can be read as the -first character on an input line -before the shell will exit. If the variable exists but does not -have a numeric value (or has no value) then the default is 10. -If the variable does not exist, then @code{EOF} signifies the end of -input to the shell. This is only in effect for interactive shells. +@item %[@var{p}][l]S +The number of CPU seconds spent in system mode. + +@item %P +The CPU percentage, computed as (%U + %S) / %R. +@end table + +The optional @var{p} is a digit specifying the precision, the number of +fractional digits after a decimal point. +A value of 0 causes no decimal point or fraction to be output. +At most three places after the decimal point may be specified; values +of @var{p} greater than 3 are changed to 3. +If @var{p} is not specified, the value 3 is used. + +The optional @code{l} specifies a longer format, including minutes, of +the form @var{MM}m@var{SS}.@var{FF}s. +The value of @var{p} determines whether or not the fraction is included. + +If this variable is not set, Bash acts as if it had the value +@example +@code{$'\nreal\t%3lR\nuser\t%3lU\nsys\t%3lS'} +@end example +If the value is null, no timing information is displayed. +A trailing newline is added when the format string is displayed. + +@item TMOUT +If set to a value greater than zero, the value is interpreted as +the number of seconds to wait for input after issuing the primary +prompt. +Bash terminates after that number of seconds if input does +not arrive. + +@item UID +The numeric real user id of the current user. This variable is readonly. @end vtable @node Shell Arithmetic @section Shell Arithmetic @cindex arithmetic, shell - -@menu -* Arithmetic Evaluation:: How shell arithmetic works. -* Arithmetic Expansion:: How to use arithmetic in shell expansions. -* Arithmetic Builtins:: Builtin commands that use shell arithmetic. -@end menu - -Bash includes several mechanisms to evaluate arithmetic expressions -and display the result or use it as part of a command. - -@node Arithmetic Evaluation -@subsection Arithmetic Evaluation +@cindex shell arithmetic @cindex expressions, arithmetic @cindex evaluation, arithmetic @cindex arithmetic evaluation @@ -4284,6 +4685,9 @@ unary minus and plus @item ! ~ logical and bitwise negation +@item ** +exponentiation + @item * / % multiplication, division, remainder @@ -4343,43 +4747,95 @@ Operators are evaluated in order of precedence. Sub-expressions in parentheses are evaluated first and may override the precedence rules above. -@node Arithmetic Expansion -@subsection Arithmetic Expansion -@cindex expansion, arithmetic -@cindex arithmetic expansion +@node Aliases +@section Aliases +@cindex alias expansion -Arithmetic expansion allows the evaluation of an arithmetic expression -and the substitution of the result. The format for arithmetic expansion is: +@menu +* Alias Builtins:: Builtins commands to maniuplate aliases. +@end menu -@example -$(( @var{expression} )) -@end example +Aliases allow a string to be substituted for a word when it is used +as the first word of a simple command. +The shell maintains a list of @var{aliases} +that may be set and unset with the @code{alias} and +@code{unalias} builtin commands. -The expression is treated as if it were within double quotes, but -a double quote inside the braces or parentheses is not treated -specially. All tokens in the expression undergo parameter -expansion, command substitution, and quote removal. Arithmetic -substitutions may be nested. +The first word of each simple command, if unquoted, is checked to see +if it has an alias. +If so, that word is replaced by the text of the alias. +The alias name and the replacement text may contain any valid +shell input, including shell metacharacters, with the exception +that the alias name may not contain @samp{=}. +The first word of the replacement text is tested for +aliases, but a word that is identical to an alias being expanded +is not expanded a second time. This means that one may alias +@code{ls} to @code{"ls -F"}, +for instance, and Bash does not try to recursively expand the +replacement text. If the last character of the alias value is a +space or tab character, then the next command word following the +alias is also checked for alias expansion. + +Aliases are created and listed with the @code{alias} +command, and removed with the @code{unalias} command. + +There is no mechanism for using arguments in the replacement text, +as in @code{csh}. +If arguments are needed, a shell function should be used +(@pxref{Shell Functions}). + +Aliases are not expanded when the shell is not interactive, +unless the @code{expand_aliases} shell option is set using +@code{shopt} (@pxref{Bash Builtins}). + +The rules concerning the definition and use of aliases are +somewhat confusing. Bash +always reads at least one complete line +of input before executing any +of the commands on that line. Aliases are expanded when a +command is read, not when it is executed. Therefore, an +alias definition appearing on the same line as another +command does not take effect until the next line of input is read. +The commands following the alias definition +on that line are not affected by the new alias. +This behavior is also an issue when functions are executed. +Aliases are expanded when a function definition is read, +not when the function is executed, because a function definition +is itself a compound command. As a consequence, aliases +defined in a function are not available until after that +function is executed. To be safe, always put +alias definitions on a separate line, and do not use @code{alias} +in compound commands. -The evaluation is performed according to the rules listed above. -If the expression is invalid, Bash -prints a message indicating failure and no substitution occurs. +For almost every purpose, aliases are superseded by +shell functions. -@node Arithmetic Builtins -@subsection Arithmetic Builtins +@node Alias Builtins +@subsection Alias Builtins @table @code -@item let -@btindex let +@item alias +@btindex alias @example -let @var{expression} [@var{expression}] +alias [@code{-p}] [@var{name}[=@var{value}] @dots{}] @end example -The @code{let} builtin allows arithmetic to be performed on shell -variables. Each @var{expression} is evaluated according to the -rules given previously (@pxref{Arithmetic Evaluation}). If the -last @var{expression} evaluates to 0, @code{let} returns 1; -otherwise 0 is returned. + +Without arguments or with the @samp{-p} option, @code{alias} prints +the list of aliases on the standard output in a form that allows +them to be reused as input. +If arguments are supplied, an alias is defined for each @var{name} +whose @var{value} is given. If no @var{value} is given, the name +and value of the alias is printed. + +@item unalias +@btindex unalias +@example +unalias [-a] [@var{name} @dots{} ] +@end example + +Remove each @var{name} from the list of aliases. If @samp{-a} is +supplied, all aliases are removed. @end table @node Arrays @@ -4451,7 +4907,7 @@ Referencing an array variable without a subscript is equivalent to referencing element zero. The @code{unset} builtin is used to destroy arrays. -@code{unset} @var{name[subscript]} +@code{unset} @code{name[@var{subscript}]} destroys the array element at index @var{subscript}. @code{unset} @var{name}, where @var{name} is an array, removes the entire array. A subscript of @samp{*} or @samp{@@} also removes the @@ -4467,64 +4923,167 @@ individual array elements. The @code{set} and @code{declare} builtins display array values in a way that allows them to be reused as input. +@node The Directory Stack +@section The Directory Stack +@cindex directory stack + +The directory stack is a list of recently-visited directories. The +@code{pushd} builtin adds directories to the stack as it changes +the current directory, and the @code{popd} builtin removes specified +directories from the stack and changes the current directory to +the directory removed. The @code{dirs} builtin displays the contents +of the directory stack. + +The contents of the directory stack are also visible +as the value of the @code{DIRSTACK} shell variable. + +@table @code + +@item dirs +@btindex dirs +@example +dirs [+@var{N} | -@var{N}] [-clvp] +@end example +Display the list of currently remembered directories. Directories +are added to the list with the @code{pushd} command; the +@code{popd} command removes directories from the list. +@table @code +@item +@var{N} +Displays the @var{N}th directory (counting from the left of the +list printed by @code{dirs} when invoked without options), starting +with zero. +@item -@var{N} +Displays the @var{N}th directory (counting from the right of the +list printed by @code{dirs} when invoked without options), starting +with zero. +@item -c +Clears the directory stack by deleting all of the elements. +@item -l +Produces a longer listing; the default listing format uses a +tilde to denote the home directory. +@item -p +Causes @code{dirs} to print the directory stack with one entry per +line. +@item -v +Causes @code{dirs} to print the directory stack with one entry per +line, prefixing each entry with its index in the stack. +@end table + +@item popd +@btindex popd +@example +popd [+@var{N} | -@var{N}] [-n] +@end example + +Remove the top entry from the directory stack, and @code{cd} +to the new top directory. +When no arguments are given, @code{popd} +removes the top directory from the stack and +performs a @code{cd} to the new top directory. The +elements are numbered from 0 starting at the first directory listed with +@code{dirs}; i.e., @code{popd} is equivalent to @code{popd +0}. +@table @code +@item +@var{N} +Removes the @var{N}th directory (counting from the left of the +list printed by @code{dirs}), starting with zero. +@item -@var{N} +Removes the @var{N}th directory (counting from the right of the +list printed by @code{dirs}), starting with zero. +@item -n +Suppresses the normal change of directory when removing directories +from the stack, so that only the stack is manipulated. +@end table + +@btindex pushd +@item pushd +@example +pushd [@var{dir} | @var{+N} | @var{-N}] [-n] +@end example + +Save the current directory on the top of the directory stack +and then @code{cd} to @var{dir}. +With no arguments, @code{pushd} exchanges the top two directories. + +@table @code +@item +@var{N} +Brings the @var{N}th directory (counting from the left of the +list printed by @code{dirs}, starting with zero) to the top of +the list by rotating the stack. +@item -@var{N} +Brings the @var{N}th directory (counting from the right of the +list printed by @code{dirs}, starting with zero) to the top of +the list by rotating the stack. +@item -n +Suppresses the normal change of directory when adding directories +to the stack, so that only the stack is manipulated. +@item @var{dir} +Makes the current working directory be the top of the stack, and then +executes the equivalent of `@code{cd} @var{dir}'. +@code{cd}s to @var{dir}. +@end table + +@end table + @node Printing a Prompt @section Controlling the Prompt @cindex prompting The value of the variable @code{PROMPT_COMMAND} is examined just before Bash prints each primary prompt. If it is set and non-null, then the -value is executed just as if you had typed it on the command line. +value is executed just as if it had been typed on the command line. In addition, the following table describes the special characters which can appear in the prompt variables: @table @code @item \a -a bell character. +A bell character. @item \d -the date, in "Weekday Month Date" format (e.g., "Tue May 26"). +The date, in "Weekday Month Date" format (e.g., "Tue May 26"). @item \e -an escape character. +An escape character. @item \h -the hostname, up to the first `.'. +The hostname, up to the first `.'. @item \H -the hostname. +The hostname. @item \n -newline. +A newline. +@item \r +A carriage return. @item \s -the name of the shell, the basename of @code{$0} (the portion +The name of the shell, the basename of @code{$0} (the portion following the final slash). @item \t -the time, in 24-hour HH:MM:SS format. +The time, in 24-hour HH:MM:SS format. @item \T -the time, in 12-hour HH:MM:SS format. +The time, in 12-hour HH:MM:SS format. @item \@@ -the time, in 12-hour am/pm format. +The time, in 12-hour am/pm format. +@item \u +The username of the current user. @item \v -the version of Bash (e.g., 2.00) +The version of Bash (e.g., 2.00) @item \V -the release of Bash, version + patchlevel (e.g., 2.00.0) +The release of Bash, version + patchlevel (e.g., 2.00.0) @item \w -the current working directory. +The current working directory. @item \W -the basename of @code{$PWD}. -@item \u -your username. +The basename of @code{$PWD}. @item \! -the history number of this command. +The history number of this command. @item \# -the command number of this command. +The command number of this command. @item \$ -if the effective uid is 0, @code{#}, otherwise @code{$}. -@item \nnn -the character corresponding to the octal number @code{nnn}. +If the effective uid is 0, @code{#}, otherwise @code{$}. +@item \@var{nnn} +The character whose ASCII code is the octal value @var{nnn}. @item \\ -a backslash. +A backslash. @item \[ -begin a sequence of non-printing characters. This could be used to +Begin a sequence of non-printing characters. This could be used to embed a terminal control sequence into the prompt. @item \] -end a sequence of non-printing characters. +End a sequence of non-printing characters. @end table @node The Restricted Shell @@ -4552,6 +5111,8 @@ builtin command. @item Importing function definitions from the shell environment at startup. @item +Parsing the value of @code{SHELLOPTS} from the shell environment at startup. +@item Redirecting output using the @samp{>}, @samp{>|}, @samp{<>}, @samp{>&}, @samp{&>}, and @samp{>>} redirection operators. @item @@ -4562,7 +5123,7 @@ Adding or deleting builtin commands with the @item Specifying the @samp{-p} option to the @code{command} builtin. @item -Turning off restricted mode with @samp{set +r}. +Turning off restricted mode with @samp{set +r} or @samp{set +o restricted}. @end itemize @node Bash POSIX Mode @@ -4595,12 +5156,12 @@ Reserved words may not be aliased. @item The @sc{POSIX.2} @code{PS1} and @code{PS2} expansions of @samp{!} to the history number and @samp{!!} to @samp{!} are enabled, -and parameter expansion is performed on -the value regardless of the setting of the @code{promptvars} option. +and parameter expansion is performed on the values of @code{PS1} and +@code{PS2} regardless of the setting of the @code{promptvars} option. @item -Interactive comments are enabled by default. (Note that Bash has -them on by default anyway.) +Interactive comments are enabled by default. (Bash has them on by +default anyway.) @item The @sc{POSIX.2} startup files are executed (@code{$ENV}) rather than @@ -4623,13 +5184,17 @@ Non-interactive shells exit if @var{filename} in @code{.} @var{filename} is not found. @item +Non-interactive shells exit if a syntax error in an arithmetic expansion +results in an invalid expression. + +@item Redirection operators do not perform filename expansion on the word in the redirection unless the shell is interactive. @item Function names must be valid shell @code{name}s. That is, they may not contain characters other than letters, digits, and underscores, and -may not start with a digit. Declaring a function with an illegal name +may not start with a digit. Declaring a function with an invalid name causes a fatal syntax error in non-interactive shells. @item @@ -4650,22 +5215,30 @@ value it assigns to the @code{PWD} variable does not contain any symbolic links, as if @samp{cd -P} had been executed. @item +If @code{$CDPATH} is set, the @code{cd} builtin will not implicitly +append the current directory to it. This means that @code{cd} will +fail if no valid directory name can be constructed from +any of the entries in @code{$CDPATH}, even if the a directory with +the same name as the name given as an argument to @code{cd} exists +in the current directory. + +@item A non-interactive shell exits with an error status if a variable assignment error occurs when no command name follows the assignment statements. A variable assignment error occurs, for example, when trying to assign -a value to a read-only variable. +a value to a readonly variable. @item A non-interactive shell exits with an error status if the iteration variable in a @code{for} statement or the selection variable in a -@code{select} statement is a read-only variable. +@code{select} statement is a readonly variable. @item Process substitution is not available. @item -Assignment statements preceding @sc{POSIX.2} @code{special} builtins +Assignment statements preceding @sc{POSIX.2} special builtins persist in the shell environment after the builtin completes. @item @@ -4686,7 +5259,7 @@ builtins, not just special ones. @node Job Control @chapter Job Control -This chapter disusses what job control is, how it works, and how +This chapter discusses what job control is, how it works, and how Bash allows you to access its facilities. @menu @@ -4714,7 +5287,7 @@ by the system's terminal driver and Bash. The shell associates a @var{job} with each pipeline. It keeps a table of currently executing jobs, which may be listed with the @code{jobs} command. When Bash starts a job -asynchronously (in the background), it prints a line that looks +asynchronously, it prints a line that looks like: @example [1] 25647 @@ -4741,13 +5314,13 @@ read from (write to) the terminal are sent a @code{SIGTTIN} caught, suspends the process. If the operating system on which Bash is running supports -job control, Bash allows you to use it. Typing the +job control, Bash contains facilities to use it. Typing the @var{suspend} character (typically @samp{^Z}, Control-Z) while a process is running causes that process to be stopped and returns -you to Bash. Typing the @var{delayed suspend} character +control to Bash. Typing the @var{delayed suspend} character (typically @samp{^Y}, Control-Y) causes the process to be stopped when it attempts to read input from the terminal, and control to -be returned to Bash. You may then manipulate the state of +be returned to Bash. The user then manipulates the state of this job, using the @code{bg} command to continue it in the background, the @code{fg} command to continue it in the foreground, or the @code{kill} command to kill it. A @samp{^Z} @@ -4764,7 +5337,8 @@ other hand, refers to any job containing the string @samp{ce} in its command line. If the prefix or substring matches more than one job, Bash reports an error. The symbols @samp{%%} and @samp{%+} refer to the shell's notion of the current job, which -is the last job stopped while it was in the foreground. The +is the last job stopped while it was in the foreground or started +in the background. The previous job may be referenced using @samp{%-}. In output pertaining to jobs (e.g., the output of the @code{jobs} command), the current job is always flagged with a @samp{+}, and the @@ -4779,15 +5353,14 @@ The shell learns immediately whenever a job changes state. Normally, Bash waits until it is about to print a prompt before reporting changes in a job's status so as to not interrupt any other output. If the -the @samp{-b} option to the @code{set} builtin is set, +the @samp{-b} option to the @code{set} builtin is enabled, Bash reports such changes immediately (@pxref{The Set Builtin}). -If you attempt to exit Bash while jobs are stopped, the -shell prints a message warning you that you have stopped jobs. -You may then use the -@code{jobs} command to inspect their status. If you do this, or -try to exit again immediately, you are not warned again, and the -stopped jobs are terminated. +If an attempt to exit Bash is while jobs are stopped, the +shell prints a message warning that there are stopped jobs. +The @code{jobs} command may then be used to inspect their status. +If a second attempt to exit is made without an intervening command, +Bash does not print another warning, and the stopped jobs are terminated. @node Job Control Builtins @section Job Control Builtins @@ -4799,23 +5372,31 @@ stopped jobs are terminated. @example bg [@var{jobspec}] @end example -Place @var{jobspec} into the background, as if it had been started -with @samp{&}. If @var{jobspec} is not supplied, the current job -is used. +Resume the suspended job @var{jobspec} in the background, as if it +had been started with @samp{&}. +If @var{jobspec} is not supplied, the current job is used. +The return status is zero unless it is run when job control is not +enabled, or, when run with job control enabled, if @var{jobspec} was +not found or @var{jobspec} specifies a job that was started without +job control. @item fg @btindex fg @example fg [@var{jobspec}] @end example -Bring @var{jobspec} into the foreground and make it the current job. +Resume the job @var{jobspec} in the foreground and make it the current job. If @var{jobspec} is not supplied, the current job is used. +The return status is that of the command placed into the foreground, +or non-zero if run when job control is disabled or, when run with +job control enabled, @var{jobspec} does not specify a valid job or +@var{jobspec} specifies a job that was started without job control. @item jobs @btindex jobs @example jobs [-lpnrs] [@var{jobspec}] -jobs -x @var{command} [@var{jobspec}] +jobs -x @var{command} [@var{arguments}] @end example The first form lists the active jobs. The options have the @@ -4823,15 +5404,14 @@ following meanings: @table @code @item -l -List process @sc{ID}s in addition to the normal information +List process @sc{ID}s in addition to the normal information. @item -n Display information only about jobs that have changed status since -you were last notified of their status. +the user was last notified of their status. @item -p -List only the process @sc{ID} of the job's process group -leader. +List only the process @sc{ID} of the job's process group leader. @item -r Restrict output to running jobs. @@ -4853,16 +5433,22 @@ passing it @var{argument}s, returning its exit status. @item kill @btindex kill @example -kill [-s @var{sigspec}] [-n @var{signum}] [-@var{sigspec}] @var{jobspec} -kill -l [@var{sigspec}] +kill [-s @var{sigspec}] [-n @var{signum}] [-@var{sigspec}] @var{jobspec} or @var{pid} +kill -l [@var{exit_status}] @end example Send a signal specified by @var{sigspec} or @var{signum} to the process -named by @var{jobspec}. +named by job specification @var{jobspec} or process ID @var{pid}. @var{sigspec} is either a signal name such as @code{SIGINT} (with or without the @code{SIG} prefix) or a signal number; @var{signum} is a signal number. If @var{sigspec} and @var{signum} are not present, @code{SIGTERM} is used. -The @samp{-l} option lists the signal names, or the signal name -corresponding to @var{sigspec}. +The @samp{-l} option lists the signal names. +If any arguments are supplied when @samp{-l} is given, the names of the +signals corresponding to the arguments are listed, and the return status +is zero. +@var{exit_status} is a number specifying a signal number or the exit +status of a process terminated by a signal. +The return status is zero if at least one signal was successfully sent, +or non-zero if an error occurs or an invalid option is encountered. @item wait @btindex wait @@ -4870,21 +5456,29 @@ corresponding to @var{sigspec}. wait [@var{jobspec}|@var{pid}] @end example Wait until the child process specified by process @sc{ID} @var{pid} or job -specification @var{jobspec} exits and report its exit status. If a job -spec is given, all processes in the job are waited for. If no arguments -are given, all currently active child processes are waited for. +specification @var{jobspec} exits and return the exit status of the last +command waited for. +If a job spec is given, all processes in the job are waited for. +If no arguments are given, all currently active child processes are +waited for, and the return status is zero. +If neither @var{jobspec} nor @var{pid} specifies an active child process +of the shell, the return status is 127. @item disown @btindex disown @example -disown [-h] [@var{jobspec} @dots{}] +disown [-ar] [-h] [@var{jobspec} @dots{}] @end example Without options, each @var{jobspec} is removed from the table of active jobs. If the @samp{-h} option is given, the job is not removed from the table, but is marked so that @code{SIGHUP} is not sent to the job if the shell receives a @code{SIGHUP}. -If @var{jobspec} is not present, the current job is used. +If @var{jobspec} is not present, and neither the @samp{-a} nor @samp{-r} +option is supplied, the current job is used. +If no @var{jobspec} is supplied, the @samp{-a} option means to remove or +mark all jobs; the @samp{-r} option without a @var{jobspec} +argument restricts operation to running jobs. @item suspend @btindex suspend @@ -4909,7 +5503,7 @@ supplied process @sc{ID}s. @item auto_resume This variable controls how the shell interacts with the user and job control. If this variable exists then single word simple -commands without redirects are treated as candidates for resumption +commands without redirections are treated as candidates for resumption of an existing job. There is no ambiguity allowed; if there is more than one job beginning with the string typed, then the most recently accessed job will be selected. @@ -4941,7 +5535,7 @@ analogous to the @samp{%} job @sc{ID}. This chapter provides basic instructions for installing Bash on the various supported platforms. The distribution supports nearly every version of Unix (and, someday, @sc{GNU}). Other independent ports exist for -@sc{OS/2}, Windows 95, and Windows @sc{NT}. +@sc{MS-DOS}, @sc{OS/2}, Windows @sc{95}, and Windows @sc{NT}. @menu * Basic Installation:: Installation instructions. @@ -4991,10 +5585,10 @@ If at some point @file{config.cache} contains results you don't want to keep, you may remove or edit it. -If you need to do unusual things to compile the package, please +If you need to do unusual things to compile Bash, please try to figure out how @code{configure} could check whether or not to do them, and mail diffs or instructions to -@code{bash-maintainers@@prep.ai.mit.edu} so they can be +@email{bash-maintainers@@gnu.org} so they can be considered for the next release. The file @file{configure.in} is used to create @code{configure} @@ -5112,7 +5706,7 @@ giving @code{configure} the option @samp{--prefix=PATH}. You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you give @code{configure} the option -@samp{--exec-prefix=PATH}, the package will use @samp{PATH} as the +@samp{--exec-prefix=PATH}, @samp{make install} will use @samp{PATH} as the prefix for installing programs and libraries. Documentation and other data files will still use the regular prefix. @@ -5120,8 +5714,8 @@ other data files will still use the regular prefix. @section Specifying the System Type There may be some features @code{configure} can not figure out -automatically, but needs to determine by the type of host the -package will run on. Usually @code{configure} can figure that +automatically, but needs to determine by the type of host Bash +will run on. Usually @code{configure} can figure that out, but if it prints a message saying it can not guess the host type, give it the @samp{--host=TYPE} option. @samp{TYPE} can either be a short name for the system type, such as @samp{sun4}, @@ -5182,11 +5776,10 @@ options. @section Optional Features The Bash @code{configure} has a number of @samp{--enable-@var{FEATURE}} -options, where @var{FEATURE} indicates an optional part of the -package. There are also several @samp{--with-@var{PACKAGE}} options, -where @var{PACKAGE} is something like @samp{gnu-malloc} or -@samp{purify} (for the Purify memory allocation checker). To -turn off the default use of a package, use +options, where @var{FEATURE} indicates an optional part of Bash. +There are also several @samp{--with-@var{PACKAGE}} options, +where @var{PACKAGE} is something like @samp{gnu-malloc} or @samp{purify}. +To turn off the default use of a package, use @samp{--without-@var{PACKAGE}}. To configure Bash without a feature that is enabled by default, use @samp{--disable-@var{FEATURE}}. @@ -5204,16 +5797,21 @@ database. @item --with-glibc-malloc Use the @sc{GNU} libc version of @code{malloc} in -@file{lib/malloc/gmalloc.c}. This is somewhat slower than the -default @code{malloc}, but wastes considerably less space. +@file{lib/malloc/gmalloc.c}. This is not the version of @code{malloc} +that appears in glibc version 2, but a modified version of the +@code{malloc} from glibc version 1. This is somewhat slower than the +default @code{malloc}, but wastes less space on a per-allocation +basis, and will return memory to the operating system under +some circumstances. @item --with-gnu-malloc Use the @sc{GNU} version of @code{malloc} in @file{lib/malloc/malloc.c}. This is not the same @code{malloc} that appears in @sc{GNU} libc, but an older version derived from the 4.2 @sc{BSD} @code{malloc}. This @code{malloc} is -very fast, but wastes a lot of space. This option is enabled by -default. The @file{NOTES} file contains a list of systems for +very fast, but wastes some space on each allocation. +This option is enabled by default. +The @file{NOTES} file contains a list of systems for which this should be turned off, and @code{configure} disables this option automatically for a number of systems. @@ -5226,7 +5824,19 @@ This produces a shell with minimal features, close to the historical Bourne shell. @end table -@noindent +There are several @samp{--enable-} options that alter how Bash is +compiled and linked, rather than changing run-time features. + +@table @code +@item --enable-profiling +This builds a Bash binary that produces profiling information to be +processed by @code{gprof} each time it is executed. + +@item --enable-static-link +This causes Bash to be linked statically, if @code{gcc} is being used. +This could be used to build a version to use as root's shell. +@end table + The @samp{minimal-config} option can be used to disable all of the following options, but it is processed first, so individual options may be enabled using @samp{enable-@var{FEATURE}}. @@ -5239,26 +5849,34 @@ necessary support. @table @code @item --enable-alias Allow alias expansion and include the @code{alias} and @code{unalias} -builtins. +builtins (@pxref{Aliases}). @item --enable-array-variables -Include support for one-dimensional array shell variables. +Include support for one-dimensional array shell variables +(@pxref{Arrays}). @item --enable-bang-history -Include support for @code{csh}-like history substitution. +Include support for @code{csh}-like history substitution +(@pxref{History Interaction}). @item --enable-brace-expansion Include @code{csh}-like brace expansion ( @code{b@{a,b@}c} @expansion{} @code{bac bbc} ). +See @ref{Brace Expansion}, for a complete description. @item --enable-command-timing Include support for recognizing @code{time} as a reserved word and for displaying timing statistics for the pipeline following @code{time}. This allows pipelines as well as shell builtins and functions to be timed. +@item --enable-cond-command +Include support for the @code{[[} conditional command +(@pxref{Conditional Constructs}). + @item --enable-directory-stack Include support for a @code{csh}-like directory stack and the -@code{pushd}, @code{popd}, and @code{dirs} builtins. +@code{pushd}, @code{popd}, and @code{dirs} builtins +(@pxref{The Directory Stack}). @item --enable-disabled-builtins Allow builtin commands to be invoked via @samp{builtin xxx} @@ -5267,7 +5885,12 @@ See @ref{Bash Builtins}, for details of the @code{builtin} and @code{enable} builtin commands. @item --enable-dparen-arithmetic -Include support for the @code{ksh} @code{((@dots{}))} command. +Include support for the @code{((@dots{}))} command +(@pxref{Conditional Constructs}). + +@item --enable-extended-glob +Include support for the extended pattern matching features described +above under @ref{Pattern Matching}. @item --enable-help-builtin Include the @code{help} builtin, which displays help on shell builtins and @@ -5278,20 +5901,22 @@ Include command history and the @code{fc} and @code{history} builtin commands. @item --enable-job-control -This enables job control features, if the @sc{OS} supports them. +This enables the job control features (@pxref{Job Control}), +if the operating system supports them. @item --enable-process-substitution This enables process substitution (@pxref{Process Substitution}) if -the @sc{OS} provides the necessary support. +the operating system provides the necessary support. @item --enable-prompt-string-decoding Turn on the interpretation of a number of backslash-escaped characters in the @code{$PS1}, @code{$PS2}, @code{$PS3}, and @code{$PS4} prompt -strings. +strings. See @ref{Printing a Prompt}, for a complete list of prompt +string escape sequences. @item --enable-readline Include support for command-line editing and history with the Bash -version of the Readline library. +version of the Readline library (@pxref{Command Line Editing}). @item --enable-restricted Include support for a @dfn{restricted shell}. If this is enabled, Bash, @@ -5299,8 +5924,8 @@ when called as @code{rbash}, enters a restricted mode. See @ref{The Restricted Shell}, for a description of restricted mode. @item --enable-select -Include the @code{ksh} @code{select} builtin, which allows the -generation of simple menus. +Include the @code{select} builtin, which allows the generation of simple +menus (@pxref{Conditional Constructs}). @item --enable-usg-echo-default Make the @code{echo} builtin expand backslash-escaped characters by default, @@ -5329,7 +5954,7 @@ Once you have determined that a bug actually exists, use the @code{bashbug} command to submit a bug report. If you have a fix, you are encouraged to mail that as well! Suggestions and `philosophical' bug reports may be mailed -to @code{bug-bash@@prep.ai.MIT.Edu} or posted to the Usenet +to @email{bug-bash@@gnu.org} or posted to the Usenet newsgroup @code{gnu.bash.bug}. All bug reports should include: @@ -5352,7 +5977,7 @@ to reproduce it. the template it provides for filing a bug report. Please send all reports concerning this manual to -@code{chet@@ins.CWRU.Edu}. +@email{chet@@po.CWRU.Edu}. @node Builtin Index @appendix Index of Shell Builtin Commands diff --git a/doc/htmlpost.sh b/doc/htmlpost.sh new file mode 100755 index 0000000..aa01542 --- /dev/null +++ b/doc/htmlpost.sh @@ -0,0 +1,19 @@ +#! /bin/sh +# +# Some of these should really be done by man2html +# +# The ~/xxx links don't really work -- netscape doesn't expand the home +# directory of the user running navigator +# + +sed -e 's|<B>gnu.bash.bug</B>|<A HREF="news:gnu.bash.bug">gnu.bash.bug</A>|' \ + -e 's|<I>/bin/bash</I>|<A HREF="file:/bin/bash"><I>/bin/bash</I></A>|' \ + -e 's|<I>/etc/profile</I>|<A HREF="file:/etc/profile"><I>/etc/profile</I></A>|' \ + -e 's|<I>~/.bash_profile</I>|<A HREF="file:~/.bash_profile"><I>~/.bash_profile</I></A>|' \ + -e 's|<I>~/.bash_login</I>|<A HREF="file:~/.bash_login"><I>~/.bash_login</I></A>|' \ + -e 's|<I>~/.profile</I>|<A HREF="file:~/.profile"><I>~/.profile</I></A>|' \ + -e 's|<I>~/.bashrc</I>|<A HREF="file:~/.bashrc"><I>~/.bashrc</I></A>|' \ + -e 's|<I>~/.bash_logout</I>|<A HREF="file:~/.bash_logout"><I>~/.bash_logout</I></A>|' \ + -e 's|<I>~/.bash_history</I>|<A HREF="file:~/.bash_history"><I>~/.bash_history</I></A>|' \ + -e 's|<I>~/.inputrc</I>|<A HREF="file:~/.inputrc"><I>~/.inputrc</I></A>|' \ + -e 's|<I>/etc/inputrc</I>|<A HREF="file:/etc/inputrc"><I>/etc/inputrc</I></A>|' diff --git a/doc/readline.3 b/doc/readline.3 index 3d16168..bb9f759 100644 --- a/doc/readline.3 +++ b/doc/readline.3 @@ -6,9 +6,9 @@ .\" Case Western Reserve University .\" chet@ins.CWRU.Edu .\" -.\" Last Change: Wed Feb 5 14:13:22 EST 1997 +.\" Last Change: Thu Feb 19 10:26:47 EST 1998 .\" -.TH READLINE 3 "1997 Feb 5" GNU +.TH READLINE 3 "1998 Feb 19" GNU .\" .\" File Name macro. This used to be `.PN', for Path Name, .\" but Sun doesn't seem to like that very much. @@ -159,7 +159,7 @@ command or the text of a macro and a key sequence to which it should be bound. The name may be specified in one of two ways: as a symbolic key name, possibly with \fIMeta\-\fP or \fIControl\-\fP prefixes, or as a key sequence. -When using the form \fBkeyname\fP:\fIfunction-name\fP or \fImacro\fP, +When using the form \fBkeyname\fP:\^\fIfunction-name\fP or \fImacro\fP, .I keyname is the name of a key spelled out in English. For example: .sp @@ -185,7 +185,7 @@ expressed on the right hand side (that is, to insert the text .I >&output into the line). .PP -In the second form, \fB"keyseq"\fP:\fIfunction\-name\fP or \fImacro\fP, +In the second form, \fB"keyseq"\fP:\^\fIfunction\-name\fP or \fImacro\fP, .B keyseq differs from .B keyname @@ -213,8 +213,9 @@ and .I "ESC [ 1 1 ~" is bound to insert the text .BR "Function Key 1" . -The full set of escape sequences is +The full set of GNU Emacs style escape sequences is .RS +.PD 0 .TP .B \eC\- control prefix @@ -234,11 +235,53 @@ literal " .B \e' literal ' .RE +.PD +.PP +In addition to the GNU Emacs style escape sequences, a second +set of backslash escapes is available: +.RS +.PD 0 +.TP +.B \ea +alert (bell) +.TP +.B \eb +backspace +.TP +.B \ed +delete +.TP +.B \ef +form feed +.TP +.B \en +newline +.TP +.B \er +carriage return +.TP +.B \et +horizontal tab +.TP +.B \ev +vertical tab +.TP +.B \e\fInnn\fP +the character whose ASCII code is the octal value \fInnn\fP +(one to three digits) +.TP +.B \ex\fInnn\fP +the character whose ASCII code is the hexadecimal value \fInnn\fP +(one to three digits) +.RE +.PD .PP When entering the text of a macro, single or double quotes should be used to indicate a macro definition. Unquoted text -is assumed to be a function name. Backslash -will quote any character in the macro text, including " and '. +is assumed to be a function name. +In the macro body, the backslash escapes described above are expanded. +Backslash will quote any other character in the macro text, +including " and '. .PP .B Bash allows the current readline key bindings to be displayed or modified @@ -288,6 +331,10 @@ This command is bound to in emacs mode and to .B # in vi command mode. +.TP +.B completion\-ignore\-case (Off) +If set to \fBOn\fP, readline performs filename matching and completion +in a case\-insensitive fashion. .TP .B completion\-query\-items (100) This determines when the user is queried about viewing @@ -346,7 +393,7 @@ the value of also affects the default keymap. .TP .B mark\-directories (On) -If set to \fBOn\fP, completed directory names have a slash +If set to \fBOn\fP, complete<d directory names have a slash appended. .TP .B mark\-modified\-lines (Off) @@ -363,6 +410,10 @@ If set to \fBOn\fP, readline will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. .TP +.B print\-completions\-horizontally (Off) +If set to \fBOn\fP, readline will display completions with matches +sorted horizontally in alphabetical order, rather than down the screen. +.TP .B show\-all\-if\-ambiguous (Off) This alters the default behavior of the completion functions. If set to @@ -380,7 +431,7 @@ completions. Readline implements a facility similar in spirit to the conditional compilation features of the C preprocessor which allows key bindings and variable settings to be performed as the result -of tests. There are three parser directives used. +of tests. There are four parser directives used. .IP \fB$if\fP The .B $if @@ -417,6 +468,7 @@ file can test for a particular value. This could be used to bind key sequences to functions useful for a specific program. For instance, the following command adds a key sequence that quotes the current or previous word in Bash: +.sp 1 .RS .nf \fB$if\fP bash @@ -427,11 +479,21 @@ key sequence that quotes the current or previous word in Bash: .RE .RE .IP \fB$endif\fP -This command, as you saw in the previous example, terminates an +This command, as seen in the previous example, terminates an \fB$if\fP command. .IP \fB$else\fP Commands in this branch of the \fB$if\fP directive are executed if the test fails. +.IP \fB$include\fP +This directive takes a single filename as an argument and reads commands +and bindings from that file. For example, the following directive +would read \fI/etc/inputrc\fP: +.sp 1 +.RS +.nf +\fB$include\fP \^ \fI/etc/inputrc\fP +.fi +.RE .SH SEARCHING .PP Readline provides commands for searching through the command history @@ -464,7 +526,7 @@ the line, thereby executing the command from the history list. .PP Non-incremental searches read the entire search string before starting to search for matching history lines. The search string may be -typed by the user or part of the contents of the current line. +typed by the user or be part of the contents of the current line. .SH EDITING COMMANDS .PP The following is a list of the names of the commands and the default @@ -567,6 +629,8 @@ yank\-last\-arg (M\-.\^, M\-_\^) Insert the last argument to the previous command (the last word of the previous history entry). With an argument, behave exactly like \fByank\-nth\-arg\fP. +Successive calls to \fByank\-last\-arg\fP move back through the history +list, inserting the last argument of each line in turn. .PD .SS Commands for Changing Text .PP @@ -575,9 +639,7 @@ behave exactly like \fByank\-nth\-arg\fP. .B delete\-char (C\-d) Delete the character under the cursor. If point is at the beginning of the line, there are no characters in the line, and -the last character typed was not -.BR C\-d , -then return +the last character typed was not bound to \fBBdelete\-char\fP, then return .SM .BR EOF . .TP @@ -606,15 +668,15 @@ moving the cursor over that word as well. .TP .B upcase\-word (M\-u) Uppercase the current (or following) word. With a negative argument, -do the previous word, but do not move point. +uppercase the previous word, but do not move point. .TP .B downcase\-word (M\-l) Lowercase the current (or following) word. With a negative argument, -do the previous word, but do not move point. +lowercase the previous word, but do not move point. .TP .B capitalize\-word (M\-c) Capitalize the current (or following) word. With a negative argument, -do the previous word, but do not move point. +capitalize the previous word, but do not move point. .PD .SS Killing and Yanking .PP @@ -628,6 +690,7 @@ Kill backward to the beginning of the line. .TP .B unix\-line\-discard (C\-u) Kill backward from point to the beginning of the line. +The killed text is saved on the kill-ring. .\" There is no real difference between this and backward-kill-line .TP .B kill\-whole\-line @@ -660,9 +723,11 @@ Copy the text in the region to the kill buffer. .TP .B copy\-backward\-word Copy the word before point to the kill buffer. +The word boundaries are the same as \fBbackward\-word\fP. .TP .B copy\-forward\-word Copy the word following point to the kill buffer. +The word boundaries are the same as \fBforward\-word\fP. .TP .B yank (C\-y) Yank the top of the kill ring into the buffer at the cursor. @@ -720,6 +785,19 @@ List the possible completions of the text before point. Insert all completions of the text before point that would have been generated by \fBpossible\-completions\fP. +.TP +.B menu\-complete +Similar to \fBcomplete\fP, but replaces the word to be completed +with a single match from the list of possible completions. +Repeated execution of \fBmenu\-complete\fP steps through the list +of possible completions, inserting each match in turn. +At the end of the list of completions, the bell is rung and the +original text is restored. +An argument of \fIn\fP moves \fIn\fP positions forward in the list +of matches; a negative argument may be used to move backward +through the list. +This command is intended to be bound to \fBTAB\fP, but is unbound +by default. .PD .SS Keyboard Macros .PP @@ -765,7 +843,7 @@ is equivalent to Incremental undo, separately remembered for each line. .TP .B revert\-line (M\-r) -Undo all changes made to this line. This is like typing the +Undo all changes made to this line. This is like executing the .B undo command enough times to return the line to its initial state. .TP @@ -795,15 +873,6 @@ variable is inserted at the beginning of the current line, and the line is accepted as if a newline had been typed. This makes the current line a shell comment. .TP -.B glob\-expand\-word (C\-x *) -The word before point is treated as a pattern for pathname expansion, -and the list of matching file names is inserted, replacing the word. -.TP -.B glob\-list\-expansions (C\-x g) -The list of expansions that would have been generated by -.B glob\-expand\-word -is inserted into the line, replacing the word before point. -.TP .B dump\-functions Print all of the functions and their key bindings to the readline output stream. If a numeric argument is supplied, @@ -1097,10 +1166,10 @@ version of the library that you have. .PP Once you have determined that a bug actually exists, mail a -bug report to \fIbug\-readline\fP@\fIprep.ai.MIT.Edu\fP. +bug report to \fIbug\-readline\fP@\fIgnu.org\fP. If you have a fix, you are welcome to mail that as well! Suggestions and `philosophical' bug reports may be mailed -to \fPbug-readline\fP@\fIprep.ai.MIT.Edu\fP or posted to the Usenet +to \fPbug-readline\fP@\fIgnu.org\fP or posted to the Usenet newsgroup .BR gnu.bash.bug . .PP |
