From 7a698806d1332fdb69ed7eaf1d0ce0519dbf0923 Mon Sep 17 00:00:00 2001 From: Chet Ramey Date: Wed, 11 Oct 2023 11:40:08 -0400 Subject: [PATCH] changes to quoting for some globbing characters; regularize error behavior of builtins that take numeric arguments and complain about too many arguments --- CWRU/CWRU.chlog | 47 + MANIFEST | 1 + builtins/break.def | 6 +- builtins/cd.def | 2 +- builtins/common.c | 26 +- builtins/common.h | 2 +- builtins/exit.def | 4 +- builtins/history.def | 2 +- builtins/return.def | 8 +- builtins/shift.def | 2 +- builtins/suspend.def | 2 +- doc/bash.0 | 6135 ++++++++++++++++++++-------------------- doc/bash.1 | 23 +- doc/bash.html | 22 +- doc/bash.info | 182 +- doc/bash.pdf | Bin 385486 -> 385486 bytes doc/bashref.html | 4 +- doc/bashref.info | 182 +- doc/bashref.log | 28 +- doc/bashref.pdf | Bin 813995 -> 813993 bytes doc/bashref.texi | 4 +- doc/builtins.0 | 2070 +++++++------- pathexp.c | 49 +- tests/builtins.right | 3 +- tests/builtins.tests | 5 +- tests/builtins11.sub | 2 +- tests/errors.right | 41 +- tests/errors.tests | 3 + tests/errors10.sub | 70 + tests/invocation.right | 1 + tests/invocation.tests | 6 +- 31 files changed, 4563 insertions(+), 4369 deletions(-) create mode 100644 tests/errors10.sub diff --git a/CWRU/CWRU.chlog b/CWRU/CWRU.chlog index 4a1ce283..773912d1 100644 --- a/CWRU/CWRU.chlog +++ b/CWRU/CWRU.chlog @@ -7778,3 +7778,50 @@ builtins/read.def we need to free ifs_chars and free it before returning. Reported by Robert Elz in https://www.austingroupbugs.net/view.php?id=1778#c6513 + + 10/7 + ---- +pathexp.c + - glob_char_p: add more of the extglob pattern characters; it doesn't + hurt to quote them + Report and patch from Grisha Levit + - unquoted_glob_pattern_p: don't treat a `(' immediately following a + `/' as a potential globbing character + - unquoted_glob_pattern_p: only treat the extended glob characters + followed by a `(' as a glob pattern if extended_glob is enabled + - unquoted_glob_pattern_p: an unquoted backslash isn't treated + specially any more, but if it's followed by a CTLESC, you still + don't treat the next character as an unquoted globbing char + Report and patch from Grisha Levit + + 10/9 + ---- +builtins/common.c + - get_numeric_arg: if fatal > 0, set the exit status to EX_USAGE + and call jump_to_top_level with EXITPROG or DISCARD. We don't + need to do everything that throw_to_top_level() does here (it's + really meant for signals and other exceptional failure conditions). + +builtins/cd.def + - cd_builtin: exit with EX_USAGE on too many arguments + +builtins/shift.def + - shift_builtin: return EX_USAGE if get_numeric_arg returns 0, + indicating that the argument wasn't a valid number + +builtins/history.def + - shift_builtin: return EX_USAGE if get_numeric_arg returns 0 + +builtins/exit.def + - exit_or_logout: if get_exitstat (which calls get_numeric_arg) returns + a value > EX_SHERRBASE, indicating an error, just return that to + the caller and let the caller deal with it. This means that + `exit xyz' is no longer a fatal error, but can potentially cause a + non-interactive posix-mode shell to exit because exit is a special + builtin + +builtins/return.def + - return_builtin: if a non-interactive shell in posix mode gets an + invalid numeric arg from get_exitstat, return immediately and let + the caller deal with exiting + All prompted by a report by Martin Schulte diff --git a/MANIFEST b/MANIFEST index e2bb18bf..4c738cce 100644 --- a/MANIFEST +++ b/MANIFEST @@ -1141,6 +1141,7 @@ tests/errors6.sub f tests/errors7.sub f tests/errors8.sub f tests/errors9.sub f +tests/errors10.sub f tests/execscript f tests/exec.right f tests/exec1.sub f 755 diff --git a/builtins/break.def b/builtins/break.def index 3a2fb851..b0c0a780 100644 --- a/builtins/break.def +++ b/builtins/break.def @@ -69,7 +69,8 @@ break_builtin (WORD_LIST *list) if (check_loop_level () == 0) return (EXECUTION_SUCCESS); - (void)get_numeric_arg (list, 1, &newbreak); + /* This will not return if an error is encountered. */ + (void)get_numeric_arg (list, interactive_shell ? 2 : 1, &newbreak); if (newbreak <= 0) { @@ -113,7 +114,8 @@ continue_builtin (WORD_LIST *list) if (check_loop_level () == 0) return (EXECUTION_SUCCESS); - (void)get_numeric_arg (list, 1, &newcont); + /* This will not return if an error is encountered. */ + (void)get_numeric_arg (list, interactive_shell ? 2 : 1, &newcont); if (newcont <= 0) { diff --git a/builtins/cd.def b/builtins/cd.def index c9d58e56..3e6bf402 100644 --- a/builtins/cd.def +++ b/builtins/cd.def @@ -327,7 +327,7 @@ cd_builtin (WORD_LIST *list) else if (list->next) { builtin_error (_("too many arguments")); - return (EXECUTION_FAILURE); + return (EX_USAGE); } #endif #if 0 diff --git a/builtins/common.c b/builtins/common.c index 35fd710a..11aa8c23 100644 --- a/builtins/common.c +++ b/builtins/common.c @@ -136,13 +136,18 @@ builtin_usage (void) /* Return if LIST is NULL else barf and jump to top_level. Used by some builtins that do not accept arguments. */ void -no_args (WORD_LIST *list) +no_args (WORD_LIST *list, int fatal) { if (list) { builtin_error (_("too many arguments")); top_level_cleanup (); - jump_to_top_level (DISCARD); + set_exit_status (EX_BADUSAGE); + /* for now, the caller determines whether this is a fatal error */ + if (interactive_shell == 0 && fatal) + jump_to_top_level (EXITPROG); + else + jump_to_top_level (DISCARD); } } @@ -491,15 +496,12 @@ get_numeric_arg (WORD_LIST *list, int fatal, intmax_t *count) sh_neednumarg (list->word->word ? list->word->word : "`'"); if (fatal == 0) return 0; - else if (fatal == 1) /* fatal == 1; abort */ - throw_to_top_level (); - else /* fatal == 2; discard current command */ - { - top_level_cleanup (); - jump_to_top_level (DISCARD); - } + set_exit_status (EX_BADUSAGE); + /* fatal == 1: abort; fatal == 2: discard current command */ + top_level_cleanup (); + jump_to_top_level ((fatal == 1) ? EXITPROG : DISCARD); } - no_args (list->next); + no_args (list->next, 0); } return (1); @@ -536,9 +538,9 @@ get_exitstat (WORD_LIST *list) if (arg == 0 || legal_number (arg, &sval) == 0) { sh_neednumarg (list->word->word ? list->word->word : "`'"); - return EX_BADUSAGE; + return EX_USAGE; } - no_args (list->next); + no_args (list->next, 0); status = sval & 255; return status; diff --git a/builtins/common.h b/builtins/common.h index aced205f..81ce259d 100644 --- a/builtins/common.h +++ b/builtins/common.h @@ -84,7 +84,7 @@ do { \ extern void builtin_error (const char *, ...) __attribute__((__format__ (printf, 1, 2))); extern void builtin_warning (const char *, ...) __attribute__((__format__ (printf, 1, 2))); extern void builtin_usage (void); -extern void no_args (WORD_LIST *); +extern void no_args (WORD_LIST *, int); extern int no_options (WORD_LIST *); /* common error message functions */ diff --git a/builtins/exit.def b/builtins/exit.def index 72816a80..94c2bf3f 100644 --- a/builtins/exit.def +++ b/builtins/exit.def @@ -1,7 +1,7 @@ This file is exit.def, from which is created exit.c. It implements the builtins "exit", and "logout" in Bash. -Copyright (C) 1987-2022 Free Software Foundation, Inc. +Copyright (C) 1987-2023 Free Software Foundation, Inc. This file is part of GNU Bash, the Bourne Again SHell. @@ -140,6 +140,8 @@ exit_or_logout (WORD_LIST *list) (list == 0), use the exit status we saved before running the trap commands (trap_saved_exit_value). */ exit_value = (running_trap == 1 && list == 0) ? trap_saved_exit_value : get_exitstat (list); + if (exit_value > EX_SHERRBASE) /* some kind of error */ + return (exit_value); bash_logout (); diff --git a/builtins/history.def b/builtins/history.def index 7c0013bd..bc64ad71 100644 --- a/builtins/history.def +++ b/builtins/history.def @@ -362,7 +362,7 @@ display_history (WORD_LIST *list) if (list) { if (get_numeric_arg (list, 0, &limit) == 0) - return (EXECUTION_FAILURE); + return (EX_USAGE); if (limit < 0) limit = -limit; diff --git a/builtins/return.def b/builtins/return.def index 2cc37cde..049446dc 100644 --- a/builtins/return.def +++ b/builtins/return.def @@ -1,7 +1,7 @@ This file is return.def, from which is created return.c. It implements the builtin "return" in Bash. -Copyright (C) 1987-2015 Free Software Foundation, Inc. +Copyright (C) 1987-2023 Free Software Foundation, Inc. This file is part of GNU Bash, the Bourne Again SHell. @@ -59,6 +59,12 @@ return_builtin (WORD_LIST *list) CHECK_HELPOPT (list); return_catch_value = get_exitstat (list); + /* return is a special builtin, so non-interactive shells in posix mode + exit on an invalid numeric argument. We have to do it this way because + the return_catch targets aren't set up to deal with EXITSHELL, so we + just jump_to_top_level directly. */ + if (interactive_shell == 0 && posixly_correct && executing_command_builtin == 0 && return_catch_value > EX_SHERRBASE) + return (return_catch_value); if (return_catch_flag) sh_longjmp (return_catch, 1); diff --git a/builtins/shift.def b/builtins/shift.def index b8a4d8ff..34bf9c8a 100644 --- a/builtins/shift.def +++ b/builtins/shift.def @@ -62,7 +62,7 @@ shift_builtin (WORD_LIST *list) CHECK_HELPOPT (list); if (get_numeric_arg (list, 0, ×) == 0) - return (EXECUTION_FAILURE); + return (EX_USAGE); if (times == 0) return (EXECUTION_SUCCESS); diff --git a/builtins/suspend.def b/builtins/suspend.def index b1db8031..73922ef3 100644 --- a/builtins/suspend.def +++ b/builtins/suspend.def @@ -96,7 +96,7 @@ suspend_builtin (WORD_LIST *list) } list = loptend; - no_args (list); + no_args (list, 0); if (force == 0) { diff --git a/doc/bash.0 b/doc/bash.0 index fe4b08d2..6645a9e6 100644 --- a/doc/bash.0 +++ b/doc/bash.0 @@ -13,24 +13,24 @@ CCOOPPYYRRIIGGHHTT DDEESSCCRRIIPPTTIIOONN BBaasshh is an sshh-compatible command language interpreter that executes - commands read from the standard input or from a file. BBaasshh also incor- + commands read from the standard input or from a file. BBaasshh also incor- porates useful features from the _K_o_r_n and _C shells (kksshh and ccsshh). BBaasshh is intended to be a conformant implementation of the Shell and Utilities portion of the IEEE POSIX specification (IEEE Standard - 1003.1). BBaasshh can be configured to be POSIX-conformant by default. + 1003.1). BBaasshh can be configured to be POSIX-conformant by default. OOPPTTIIOONNSS All of the single-character shell options documented in the description of the sseett builtin command, including --oo, can be used as options when - the shell is invoked. In addition, bbaasshh interprets the following op- + the shell is invoked. In addition, bbaasshh interprets the following op- tions when it is invoked: --cc If the --cc option is present, then commands are read from the - first non-option argument _c_o_m_m_a_n_d___s_t_r_i_n_g. If there are argu- + first non-option argument _c_o_m_m_a_n_d___s_t_r_i_n_g. If there are argu- ments after the _c_o_m_m_a_n_d___s_t_r_i_n_g, the first argument is as- signed to $$00 and any remaining arguments are assigned to the - positional parameters. The assignment to $$00 sets the name of + positional parameters. The assignment to $$00 sets the name of the shell, which is used in warning and error messages. --ii If the --ii option is present, the shell is _i_n_t_e_r_a_c_t_i_v_e. --ll Make bbaasshh act as if it had been invoked as a login shell (see @@ -39,34 +39,34 @@ OOPPTTIIOONNSS (see RREESSTTRRIICCTTEEDD SSHHEELLLL below). --ss If the --ss 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 or when reading input + input. This option allows the positional parameters to be + set when invoking an interactive shell or when reading input through a pipe. --DD A list of all double-quoted strings preceded by $$ is printed - on the standard output. These are the strings that are sub- + on the standard output. These are the strings that are sub- ject to language translation when the current locale is not CC - or PPOOSSIIXX. This implies the --nn option; no commands will be ex- - ecuted. + or PPOOSSIIXX. This implies the --nn option; no commands will be + executed. [[--++]]OO [[_s_h_o_p_t___o_p_t_i_o_n]] _s_h_o_p_t___o_p_t_i_o_n is one of the shell options accepted by the - sshhoopptt builtin (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). If + sshhoopptt builtin (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). If _s_h_o_p_t___o_p_t_i_o_n is present, --OO sets the value of that option; ++OO - unsets it. If _s_h_o_p_t___o_p_t_i_o_n is not supplied, the names and + unsets it. If _s_h_o_p_t___o_p_t_i_o_n is not supplied, the names and values of the shell options accepted by sshhoopptt are printed on - the standard output. If the invocation option is ++OO, the out- - put is displayed in a format that may be reused as input. + the standard output. If the invocation option is ++OO, the + output is displayed in a format that may be reused as input. ---- A ---- signals the end of options and disables further option - processing. Any arguments after the ---- are treated as file- - names and arguments. An argument of -- is equivalent to ----. + processing. Any arguments after the ---- are treated as file- + names and arguments. An argument of -- is equivalent to ----. - BBaasshh also interprets a number of multi-character options. These options - must appear on the command line before the single-character options to - be recognized. + BBaasshh also interprets a number of multi-character options. These op- + tions must appear on the command line before the single-character op- + tions to be recognized. ----ddeebbuuggggeerr Arrange for the debugger profile to be executed before the shell - starts. Turns on extended debugging mode (see the description of - the eexxttddeebbuugg option to the sshhoopptt builtin below). + starts. Turns on extended debugging mode (see the description + of the eexxttddeebbuugg option to the sshhoopptt builtin below). ----dduummpp--ppoo--ssttrriinnggss Equivalent to --DD, but the output is in the GNU _g_e_t_t_e_x_t ppoo (por- table object) file format. @@ -90,17 +90,18 @@ OOPPTTIIOONNSS ----nnoopprrooffiillee Do not read either the system-wide startup file _/_e_t_c_/_p_r_o_f_i_l_e or any of the personal initialization files _~_/_._b_a_s_h___p_r_o_f_i_l_e, - _~_/_._b_a_s_h___l_o_g_i_n, or _~_/_._p_r_o_f_i_l_e. By default, bbaasshh reads these files - when it is invoked as a login shell (see IINNVVOOCCAATTIIOONN below). + _~_/_._b_a_s_h___l_o_g_i_n, or _~_/_._p_r_o_f_i_l_e. By default, bbaasshh reads these + files when it is invoked as a login shell (see IINNVVOOCCAATTIIOONN be- + low). ----nnoorrcc Do not read and execute the personal initialization file - _~_/_._b_a_s_h_r_c if the shell is interactive. This option is on by de- + _~_/_._b_a_s_h_r_c if the shell is interactive. This option is on by de- fault if the shell is invoked as sshh. ----ppoossiixx - Change the behavior of bbaasshh where the default operation differs + Change the behavior of bbaasshh where the default operation differs from the POSIX standard to match the standard (_p_o_s_i_x _m_o_d_e). See - SSEEEE AALLSSOO below for a reference to a document that details how + SSEEEE AALLSSOO below for a reference to a document that details how posix mode affects bash's behavior. ----rreessttrriicctteedd @@ -110,312 +111,313 @@ OOPPTTIIOONNSS Equivalent to --vv. ----vveerrssiioonn - Show version information for this instance of bbaasshh on the stan- + Show version information for this instance of bbaasshh on the stan- dard output and exit successfully. AARRGGUUMMEENNTTSS If arguments remain after option processing, and neither the --cc nor the - --ss option has been supplied, the first argument is assumed to be the - name of a file containing shell commands. If bbaasshh is invoked in this - fashion, $$00 is set to the name of the file, and the positional parame- - ters are set to the remaining arguments. BBaasshh reads and executes com- - mands from this file, then exits. BBaasshh's exit status is the exit status - of the last command executed in the script. If no commands are exe- - cuted, the exit status is 0. An attempt is first made to open the file - in the current directory, and, if no file is found, then the shell + --ss option has been supplied, the first argument is assumed to be the + name of a file containing shell commands. If bbaasshh is invoked in this + fashion, $$00 is set to the name of the file, and the positional parame- + ters are set to the remaining arguments. BBaasshh reads and executes com- + mands from this file, then exits. BBaasshh's exit status is the exit sta- + tus of the last command executed in the script. If no commands are ex- + ecuted, the exit status is 0. An attempt is first made to open the + file in the current directory, and, if no file is found, then the shell searches the directories in PPAATTHH for the script. IINNVVOOCCAATTIIOONN - A _l_o_g_i_n _s_h_e_l_l is one whose first character of argument zero is a --, or + A _l_o_g_i_n _s_h_e_l_l is one whose first character of argument zero is a --, or one started with the ----llooggiinn option. - An _i_n_t_e_r_a_c_t_i_v_e shell is one started without non-option arguments (un- - less --ss is specified) and without the --cc option, whose standard input + An _i_n_t_e_r_a_c_t_i_v_e shell is one started without non-option arguments (un- + less --ss is specified) and without the --cc option, whose standard input and error are both connected to terminals (as determined by _i_s_a_t_t_y(3)), - or one started with the --ii option. PPSS11 is set and $$-- includes ii if bbaasshh - is interactive, allowing a shell script or a startup file to test this - state. + or one started with the --ii option. PPSS11 is set and $$-- includes ii if + bbaasshh is interactive, allowing a shell script or a startup file to test + this state. - The following paragraphs describe how bbaasshh executes its startup files. - If any of the files exist but cannot be read, bbaasshh reports an error. - Tildes are expanded in filenames as described below under TTiillddee EExxppaann-- + The following paragraphs describe how bbaasshh executes its startup files. + If any of the files exist but cannot be read, bbaasshh reports an error. + Tildes are expanded in filenames as described below under TTiillddee EExxppaann-- ssiioonn in the EEXXPPAANNSSIIOONN section. - When bbaasshh is invoked as an interactive login shell, or as a non-inter- - active shell with the ----llooggiinn option, it first reads and executes com- - mands from the file _/_e_t_c_/_p_r_o_f_i_l_e, if that file exists. After reading + When bbaasshh is invoked as an interactive login shell, or as a non-inter- + active shell with the ----llooggiinn option, it first reads and executes com- + mands from the file _/_e_t_c_/_p_r_o_f_i_l_e, if that file exists. After reading that file, it looks for _~_/_._b_a_s_h___p_r_o_f_i_l_e, _~_/_._b_a_s_h___l_o_g_i_n, and _~_/_._p_r_o_f_i_l_e, - in that order, and reads and executes commands from the first one that - exists and is readable. The ----nnoopprrooffiillee option may be used when the + in that order, and reads and executes commands from the first one that + exists and is readable. The ----nnoopprrooffiillee option may be used when the shell is started to inhibit this behavior. When an interactive login shell exits, or a non-interactive login shell - executes the eexxiitt builtin command, bbaasshh reads and executes commands + executes the eexxiitt builtin command, bbaasshh reads and executes commands from the file _~_/_._b_a_s_h___l_o_g_o_u_t, if it exists. - When an interactive shell that is not a login shell is started, bbaasshh - reads and executes commands from _~_/_._b_a_s_h_r_c, if that file exists. This - may be inhibited by using the ----nnoorrcc option. The ----rrccffiillee _f_i_l_e option - will force bbaasshh to read and execute commands from _f_i_l_e instead of + When an interactive shell that is not a login shell is started, bbaasshh + reads and executes commands from _~_/_._b_a_s_h_r_c, if that file exists. This + may be inhibited by using the ----nnoorrcc option. The ----rrccffiillee _f_i_l_e option + will force bbaasshh to read and execute commands from _f_i_l_e instead of _~_/_._b_a_s_h_r_c. - When bbaasshh is started non-interactively, to run a shell script, for ex- - ample, it looks for the variable BBAASSHH__EENNVV in the environment, expands - its value if it appears there, and uses the expanded value as the name - of a file to read and execute. BBaasshh behaves as if the following command - were executed: + When bbaasshh is started non-interactively, to run a shell script, for ex- + ample, it looks for the variable BBAASSHH__EENNVV in the environment, expands + its value if it appears there, and uses the expanded value as the name + of a file to read and execute. BBaasshh behaves as if the following com- + mand were executed: if [ -n "$BASH_ENV" ]; then . "$BASH_ENV"; fi - but the value of the PPAATTHH variable is not used to search for the file- + but the value of the PPAATTHH variable is not used to search for the file- name. - If bbaasshh is invoked with the name sshh, it tries to mimic the startup be- - havior of historical versions of sshh as closely as possible, while con- - forming to the POSIX standard as well. When invoked as an interactive - login shell, or a non-interactive shell with the ----llooggiinn option, it - first attempts to read and execute commands from _/_e_t_c_/_p_r_o_f_i_l_e and - _~_/_._p_r_o_f_i_l_e, in that order. The ----nnoopprrooffiillee option may be used to in- - hibit this behavior. When invoked as an interactive shell with the name - sshh, bbaasshh looks for the variable EENNVV, expands its value if it is de- - fined, and uses the expanded value as the name of a file to read and + If bbaasshh is invoked with the name sshh, it tries to mimic the startup be- + havior of historical versions of sshh as closely as possible, while con- + forming to the POSIX standard as well. When invoked as an interactive + login shell, or a non-interactive shell with the ----llooggiinn option, it + first attempts to read and execute commands from _/_e_t_c_/_p_r_o_f_i_l_e and + _~_/_._p_r_o_f_i_l_e, in that order. The ----nnoopprrooffiillee option may be used to in- + hibit this behavior. When invoked as an interactive shell with the + name sshh, bbaasshh looks for the variable EENNVV, 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 sshh does not attempt to read and exe- - cute commands from any other startup files, the ----rrccffiillee option has no - effect. A non-interactive shell invoked with the name sshh does not at- - tempt to read any other startup files. When invoked as sshh, bbaasshh enters + cute commands from any other startup files, the ----rrccffiillee option has no + effect. A non-interactive shell invoked with the name sshh does not at- + tempt to read any other startup files. When invoked as sshh, bbaasshh enters _p_o_s_i_x mode after the startup files are read. - When bbaasshh is started in _p_o_s_i_x mode, as with the ----ppoossiixx command line - option, it follows the POSIX standard for startup files. In this mode, - interactive shells expand the EENNVV variable and commands are read and - executed from the file whose name is the expanded value. No other + When bbaasshh is started in _p_o_s_i_x mode, as with the ----ppoossiixx command line + option, it follows the POSIX standard for startup files. In this mode, + interactive shells expand the EENNVV variable and commands are read and + executed from the file whose name is the expanded value. No other startup files are read. BBaasshh attempts to determine when it is being run with its standard input - connected to a network connection, as when executed by the historical - remote shell daemon, usually _r_s_h_d, or the secure shell daemon _s_s_h_d. If - bbaasshh determines it is being run non-interactively in this fashion, it - reads and executes commands from _~_/_._b_a_s_h_r_c, if that file exists and is - readable. It will not do this if invoked as sshh. The ----nnoorrcc option may - be used to inhibit this behavior, and the ----rrccffiillee option may be used - to force another file to be read, but neither _r_s_h_d nor _s_s_h_d generally + connected to a network connection, as when executed by the historical + remote shell daemon, usually _r_s_h_d, or the secure shell daemon _s_s_h_d. If + bbaasshh determines it is being run non-interactively in this fashion, it + reads and executes commands from _~_/_._b_a_s_h_r_c, if that file exists and is + readable. It will not do this if invoked as sshh. The ----nnoorrcc option may + be used to inhibit this behavior, and the ----rrccffiillee option may be used + to force another file to be read, but neither _r_s_h_d nor _s_s_h_d generally invoke the shell with those options or allow them to be specified. If the shell is started with the effective user (group) id not equal to the real user (group) id, and the --pp option is not supplied, no startup files are read, shell functions are not inherited from the environment, - the SSHHEELLLLOOPPTTSS, BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if they ap- - pear in the environment, are ignored, and the effective user id is set - to the real user id. If the --pp option is supplied at invocation, the + the SSHHEELLLLOOPPTTSS, BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if they ap- + pear in the environment, are ignored, and the effective user id is set + to the real user id. If the --pp option is supplied at invocation, the startup behavior is the same, but the effective user id is not reset. DDEEFFIINNIITTIIOONNSS - The following definitions are used throughout the rest of this docu- + The following definitions are used throughout the rest of this docu- ment. bbllaannkk A space or tab. - wwoorrdd A sequence of characters considered as a single unit by the - shell. Also known as a ttookkeenn. - nnaammee A _w_o_r_d consisting only of alphanumeric characters and under- - scores, and beginning with an alphabetic character or an under- - score. Also referred to as an iiddeennttiiffiieerr. + wwoorrdd A sequence of characters considered as a single unit by the + shell. Also known as a ttookkeenn. + nnaammee A _w_o_r_d consisting only of alphanumeric characters and under- + scores, and beginning with an alphabetic character or an under- + score. Also referred to as an iiddeennttiiffiieerr. mmeettaacchhaarraacctteerr - A character that, when unquoted, separates words. One of the + A character that, when unquoted, separates words. One of the following: || && ;; (( )) << >> ssppaaccee ttaabb nneewwlliinnee ccoonnttrrooll ooppeerraattoorr - A _t_o_k_e_n that performs a control function. It is one of the fol- + A _t_o_k_e_n that performs a control function. It is one of the fol- lowing symbols: |||| && &&&& ;; ;;;; ;;&& ;;;;&& (( )) || ||&& <> RREESSEERRVVEEDD WWOORRDDSS - _R_e_s_e_r_v_e_d _w_o_r_d_s are words that have a special meaning to the shell. The + _R_e_s_e_r_v_e_d _w_o_r_d_s are words that have a special meaning to the shell. The following words are recognized as reserved when unquoted and either the - first word of a command (see SSHHEELLLL GGRRAAMMMMAARR below), the third word of a - ccaassee or sseelleecctt command (only iinn is valid), or the third word of a ffoorr + first word of a command (see SSHHEELLLL GGRRAAMMMMAARR below), the third word of a + ccaassee or sseelleecctt command (only iinn is valid), or the third word of a ffoorr command (only iinn and ddoo are valid): - !! ccaassee ccoopprroocc ddoo ddoonnee eelliiff eellssee eessaacc ffii ffoorr ffuunnccttiioonn iiff iinn sseelleecctt + !! ccaassee ccoopprroocc ddoo ddoonnee eelliiff eellssee eessaacc ffii ffoorr ffuunnccttiioonn iiff iinn sseelleecctt tthheenn uunnttiill wwhhiillee {{ }} ttiimmee [[[[ ]]]] SSHHEELLLL GGRRAAMMMMAARR - This section describes the syntax of the various forms of shell com- + This section describes the syntax of the various forms of shell com- mands. SSiimmppllee CCoommmmaannddss - A _s_i_m_p_l_e _c_o_m_m_a_n_d is a sequence of optional variable assignments fol- - lowed by bbllaannkk-separated words and redirections, and terminated by a - _c_o_n_t_r_o_l _o_p_e_r_a_t_o_r. The first word specifies the command to be executed, - and is passed as argument zero. The remaining words are passed as argu- - ments to the invoked command. + A _s_i_m_p_l_e _c_o_m_m_a_n_d is a sequence of optional variable assignments fol- + lowed by bbllaannkk-separated words and redirections, and terminated by a + _c_o_n_t_r_o_l _o_p_e_r_a_t_o_r. The first word specifies the command to be executed, + and is passed as argument zero. The remaining words are passed as ar- + guments to the invoked command. - The return value of a _s_i_m_p_l_e _c_o_m_m_a_n_d is its exit status, or 128+_n if + The return value of a _s_i_m_p_l_e _c_o_m_m_a_n_d is its exit status, or 128+_n if the command is terminated by signal _n. PPiippeelliinneess - A _p_i_p_e_l_i_n_e is a sequence of one or more commands separated by one of - the control operators || or ||&&. The format for a pipeline is: + A _p_i_p_e_l_i_n_e is a sequence of one or more commands separated by one of + the control operators || or ||&&. The format for a pipeline is: [ttiimmee [--pp]] [ ! ] _c_o_m_m_a_n_d_1 [ [|||||&&] _c_o_m_m_a_n_d_2 ... ] The standard output of _c_o_m_m_a_n_d_1 is connected via a pipe to the standard - input of _c_o_m_m_a_n_d_2. This connection is performed before any redirections - specified by the _c_o_m_m_a_n_d_1(see RREEDDIIRREECCTTIIOONN below). If ||&& is used, _c_o_m_- - _m_a_n_d_1's standard error, in addition to its standard output, is con- - nected to _c_o_m_m_a_n_d_2's standard input through the pipe; it is shorthand - for 22>>&&11 ||. This implicit redirection of the standard error to the - standard output is performed after any redirections specified by _c_o_m_- + input of _c_o_m_m_a_n_d_2. This connection is performed before any redirec- + tions specified by the _c_o_m_m_a_n_d_1(see RREEDDIIRREECCTTIIOONN below). If ||&& is used, + _c_o_m_m_a_n_d_1's standard error, in addition to its standard output, is con- + nected to _c_o_m_m_a_n_d_2's standard input through the pipe; it is shorthand + for 22>>&&11 ||. This implicit redirection of the standard error to the + standard output is performed after any redirections specified by _c_o_m_- _m_a_n_d_1. The return status of a pipeline is the exit status of the last command, - unless the ppiippeeffaaiill option is enabled. If ppiippeeffaaiill is enabled, the - pipeline's return status is the value of the last (rightmost) command - to exit with a non-zero status, or zero if all commands exit success- - fully. If the reserved word !! precedes a pipeline, the exit status of - that pipeline is the logical negation of the exit status as described - above. The shell waits for all commands in the pipeline to terminate + unless the ppiippeeffaaiill option is enabled. If ppiippeeffaaiill is enabled, the + pipeline's return status is the value of the last (rightmost) command + to exit with a non-zero status, or zero if all commands exit success- + fully. If the reserved word !! precedes a pipeline, the exit status of + that pipeline is the logical negation of the exit status as described + above. The shell waits for all commands in the pipeline to terminate before returning a value. - If the ttiimmee reserved word precedes a pipeline, the elapsed as well as - user and system time consumed by its execution are reported when the - pipeline terminates. The --pp option changes the output format to that - specified by POSIX. When the shell is in _p_o_s_i_x _m_o_d_e, it does not recog- - nize ttiimmee as a reserved word if the next token begins with a `-'. The - TTIIMMEEFFOORRMMAATT variable may be set to a format string that specifies how - the timing information should be displayed; see the description of + If the ttiimmee reserved word precedes a pipeline, the elapsed as well as + user and system time consumed by its execution are reported when the + pipeline terminates. The --pp option changes the output format to that + specified by POSIX. When the shell is in _p_o_s_i_x _m_o_d_e, it does not rec- + ognize ttiimmee as a reserved word if the next token begins with a `-'. + The TTIIMMEEFFOORRMMAATT variable may be set to a format string that specifies + how the timing information should be displayed; see the description of TTIIMMEEFFOORRMMAATT under SShheellll VVaarriiaabblleess below. When the shell is in _p_o_s_i_x _m_o_d_e, ttiimmee may be followed by a newline. In - this case, the shell displays the total user and system time consumed - by the shell and its children. The TTIIMMEEFFOORRMMAATT variable specifies the + this case, the shell displays the total user and system time consumed + by the shell and its children. The TTIIMMEEFFOORRMMAATT variable specifies the format of the time information. - Each command in a multi-command pipeline, where pipes are created, is - executed in a _s_u_b_s_h_e_l_l, which is a separate process. See CCOOMMMMAANNDD EEXXEECCUU-- - TTIIOONN EENNVVIIRROONNMMEENNTT for a description of subshells and a subshell environ- - ment. If the llaassttppiippee option is enabled using the sshhoopptt builtin (see - the description of sshhoopptt below), the last element of a pipeline may be - run by the shell process when job control is not active. + Each command in a multi-command pipeline, where pipes are created, is + executed in a _s_u_b_s_h_e_l_l, which is a separate process. See CCOOMMMMAANNDD EEXXEE-- + CCUUTTIIOONN EENNVVIIRROONNMMEENNTT for a description of subshells and a subshell envi- + ronment. If the llaassttppiippee option is enabled using the sshhoopptt builtin + (see the description of sshhoopptt below), the last element of a pipeline + may be run by the shell process when job control is not active. LLiissttss - A _l_i_s_t is a sequence of one or more pipelines separated by one of the + A _l_i_s_t is a sequence of one or more pipelines separated by one of the operators ;;, &&, &&&&, or ||||, and optionally terminated by one of ;;, &&, or <>. Of these list operators, &&&& and |||| have equal precedence, followed by ;; and &&, which have equal precedence. - A sequence of one or more newlines may appear in a _l_i_s_t instead of a + A sequence of one or more newlines may appear in a _l_i_s_t instead of a semicolon to delimit commands. - If a command is terminated by the control operator &&, the shell exe- - cutes the command in the _b_a_c_k_g_r_o_u_n_d in a subshell. The shell does not - wait for the command to finish, and the return status is 0. These are - referred to as _a_s_y_n_c_h_r_o_n_o_u_s commands. Commands separated by a ;; are ex- - ecuted sequentially; the shell waits for each command to terminate in - turn. The return status is the exit status of the last command exe- + If a command is terminated by the control operator &&, the shell exe- + cutes the command in the _b_a_c_k_g_r_o_u_n_d in a subshell. The shell does not + wait for the command to finish, and the return status is 0. These are + referred to as _a_s_y_n_c_h_r_o_n_o_u_s commands. 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 exe- cuted. - AND and OR lists are sequences of one or more pipelines separated by - the &&&& and |||| control operators, respectively. AND and OR lists are ex- - ecuted with left associativity. An AND list has the form + AND and OR lists are sequences of one or more pipelines separated by + the &&&& and |||| control operators, respectively. AND and OR lists are + executed with left associativity. An AND list has the form _c_o_m_m_a_n_d_1 &&&& _c_o_m_m_a_n_d_2 - _c_o_m_m_a_n_d_2 is executed if, and only if, _c_o_m_m_a_n_d_1 returns an exit status + _c_o_m_m_a_n_d_2 is executed if, and only if, _c_o_m_m_a_n_d_1 returns an exit status of zero (success). An OR list has the form _c_o_m_m_a_n_d_1 |||| _c_o_m_m_a_n_d_2 - _c_o_m_m_a_n_d_2 is executed if, and only if, _c_o_m_m_a_n_d_1 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. + _c_o_m_m_a_n_d_2 is executed if, and only if, _c_o_m_m_a_n_d_1 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. CCoommppoouunndd CCoommmmaannddss - A _c_o_m_p_o_u_n_d _c_o_m_m_a_n_d is one of the following. In most cases a _l_i_s_t in a - command's description may be separated from the rest of the command by - one or more newlines, and may be followed by a newline in place of a + A _c_o_m_p_o_u_n_d _c_o_m_m_a_n_d is one of the following. In most cases a _l_i_s_t in a + command's description may be separated from the rest of the command by + one or more newlines, and may be followed by a newline in place of a semicolon. - (_l_i_s_t) _l_i_s_t is executed in a subshell (see CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONN-- - MMEENNTT below for a description of a subshell environment). Vari- - able assignments and builtin commands that affect the shell's + (_l_i_s_t) _l_i_s_t is executed in a subshell (see CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONN-- + MMEENNTT below for a description of a subshell environment). Vari- + able assignments and builtin commands that affect the shell's environment do not remain in effect after the command completes. The return status is the exit status of _l_i_s_t. { _l_i_s_t; } - _l_i_s_t is simply executed in the current shell environment. _l_i_s_t - must be terminated with a newline or semicolon. This is known as - a _g_r_o_u_p _c_o_m_m_a_n_d. The return status is the exit status of _l_i_s_t. - Note that unlike the metacharacters (( and )), {{ and }} are _r_e_- - _s_e_r_v_e_d _w_o_r_d_s and must occur where a reserved word is permitted - to be recognized. Since they do not cause a word break, they - must be separated from _l_i_s_t by whitespace or another shell + _l_i_s_t is simply executed in the current shell environment. _l_i_s_t + must be terminated with a newline or semicolon. This is known + as a _g_r_o_u_p _c_o_m_m_a_n_d. The return status is the exit status of + _l_i_s_t. Note that unlike the metacharacters (( and )), {{ and }} are + _r_e_s_e_r_v_e_d _w_o_r_d_s and must occur where a reserved word is permitted + to be recognized. Since they do not cause a word break, they + must be separated from _l_i_s_t by whitespace or another shell metacharacter. ((_e_x_p_r_e_s_s_i_o_n)) The _e_x_p_r_e_s_s_i_o_n is evaluated according to the rules described be- - low under AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN. If the value of the expression + low under AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN. If the value of the expression is non-zero, the return status is 0; otherwise the return status - is 1. The _e_x_p_r_e_s_s_i_o_n undergoes the same expansions as if it were - within double quotes, but double quote characters in _e_x_p_r_e_s_s_i_o_n - are not treated specially and are removed. + is 1. The _e_x_p_r_e_s_s_i_o_n undergoes the same expansions as if it + were within double quotes, but double quote characters in _e_x_- + _p_r_e_s_s_i_o_n are not treated specially and are removed. [[[[ _e_x_p_r_e_s_s_i_o_n ]]]] - Return a status of 0 or 1 depending on the evaluation of the - conditional expression _e_x_p_r_e_s_s_i_o_n. Expressions are composed of - the primaries described below under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS. The - words between the [[[[ and ]]]] do not undergo word splitting and - pathname expansion. The shell performs tilde expansion, parame- - ter and variable expansion, arithmetic expansion, command sub- - stitution, process substitution, and quote removal on those - words (the expansions that would occur if the words were en- - closed in double quotes). Conditional operators such as --ff must + Return a status of 0 or 1 depending on the evaluation of the + conditional expression _e_x_p_r_e_s_s_i_o_n. Expressions are composed of + the primaries described below under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS. + The words between the [[[[ and ]]]] do not undergo word splitting + and pathname expansion. The shell performs tilde expansion, pa- + rameter and variable expansion, arithmetic expansion, command + substitution, process substitution, and quote removal on those + words (the expansions that would occur if the words were en- + closed in double quotes). Conditional operators such as --ff must be unquoted to be recognized as primaries. - When used with [[[[, the << and >> operators sort lexicographically + When used with [[[[, the << and >> operators sort lexicographically using the current locale. - When the ==== and !!== operators are used, the string to the right + 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 under PPaatttteerrnn MMaattcchhiinngg, as if the eexxtt-- - gglloobb shell option were enabled. The == operator is equivalent to - ====. If the nnooccaasseemmaattcchh shell option is enabled, the match is - performed without regard to the case of alphabetic characters. - The return value is 0 if the string matches (====) or does not - match (!!==) the pattern, and 1 otherwise. Any part of the pattern - may be quoted to force the quoted portion to be matched as a - string. + gglloobb shell option were enabled. The == operator is equivalent to + ====. If the nnooccaasseemmaattcchh shell option is enabled, the match is + performed without regard to the case of alphabetic characters. + The return value is 0 if the string matches (====) or does not + match (!!==) the pattern, and 1 otherwise. Any part of the pat- + tern may be quoted to force the quoted portion to be matched as + a string. - An additional binary operator, ==~~, is available, with the same - precedence as ==== and !!==. When it is used, the string to the + An additional binary operator, ==~~, is available, with the same + precedence as ==== and !!==. When it is used, the string to the right of the operator is considered a POSIX extended regular ex- - pression and matched accordingly (using the POSIX _r_e_g_c_o_m_p and - _r_e_g_e_x_e_c interfaces usually described in _r_e_g_e_x(3)). The return - value is 0 if the string matches the pattern, and 1 otherwise. + pression and matched accordingly (using the POSIX _r_e_g_c_o_m_p and + _r_e_g_e_x_e_c interfaces usually described in _r_e_g_e_x(3)). The return + value is 0 if the string matches the pattern, and 1 otherwise. If the regular expression is syntactically incorrect, the condi- - tional expression's return value is 2. If the nnooccaasseemmaattcchh shell - option is enabled, the match is performed without regard to the - case of alphabetic characters. If any part of the pattern is - quoted, the quoted portion is matched literally. This means ev- - ery character in the quoted portion matches itself, instead of - having any special pattern matching meaning. If the pattern is - stored in a shell variable, quoting the variable expansion - forces the entire pattern to be matched literally. Treat bracket - expressions in regular expressions carefully, since normal quot- - ing and pattern characters lose their meanings between brackets. + tional expression's return value is 2. If the nnooccaasseemmaattcchh shell + option is enabled, the match is performed without regard to the + case of alphabetic characters. If any part of the pattern is + quoted, the quoted portion is matched literally. This means ev- + ery character in the quoted portion matches itself, instead of + having any special pattern matching meaning. If the pattern is + stored in a shell variable, quoting the variable expansion + forces the entire pattern to be matched literally. Treat + bracket expressions in regular expressions carefully, since nor- + mal quoting and pattern characters lose their meanings between + brackets. - The pattern will match if it matches any part of the string. An- - chor the pattern using the ^^ and $$ regular expression operators - to force it to match the entire string. The array variable + The pattern will match if it matches any part of the string. + Anchor the pattern using the ^^ and $$ regular expression opera- + tors to force it to match the entire string. The array variable BBAASSHH__RREEMMAATTCCHH records which parts of the string matched the pat- - tern. The element of BBAASSHH__RREEMMAATTCCHH with index 0 contains the por- - tion of the string matching the entire regular expression. Sub- - strings matched by parenthesized subexpressions within the regu- - lar expression are saved in the remaining BBAASSHH__RREEMMAATTCCHH indices. - The element of BBAASSHH__RREEMMAATTCCHH with index _n is the portion of the - string matching the _nth parenthesized subexpression. BBaasshh sets - BBAASSHH__RREEMMAATTCCHH in the global scope; declaring it as a local vari- - able will lead to unexpected results. + tern. The element of BBAASSHH__RREEMMAATTCCHH with index 0 contains the + portion of the string matching the entire regular expression. + Substrings matched by parenthesized subexpressions within the + regular expression are saved in the remaining BBAASSHH__RREEMMAATTCCHH in- + dices. The element of BBAASSHH__RREEMMAATTCCHH with index _n is the portion + of the string matching the _nth parenthesized subexpression. + BBaasshh sets BBAASSHH__RREEMMAATTCCHH in the global scope; declaring it as a + local variable will lead to unexpected results. Expressions may be combined using the following operators, listed in decreasing order of precedence: @@ -437,211 +439,212 @@ SSHHEELLLL GGRRAAMMMMAARR ffoorr _n_a_m_e [ [ iinn [ _w_o_r_d _._._. ] ] ; ] ddoo _l_i_s_t ; ddoonnee The list of words following iinn is expanded, generating a list of items. The variable _n_a_m_e is set to each element of this list in - turn, and _l_i_s_t is executed each time. If the iinn _w_o_r_d is omitted, - the ffoorr command executes _l_i_s_t once for each positional parameter - that is set (see PPAARRAAMMEETTEERRSS below). The return status is the - exit status of the last command that executes. If the expansion - of the items following iinn results in an empty list, no commands - are executed, and the return status is 0. + turn, and _l_i_s_t is executed each time. If the iinn _w_o_r_d is omit- + ted, the ffoorr command executes _l_i_s_t once for each positional pa- + rameter that is set (see PPAARRAAMMEETTEERRSS below). The return status + is the exit status of the last command that executes. If the + expansion of the items following iinn results in an empty list, no + commands are executed, and the return status is 0. ffoorr (( _e_x_p_r_1 ; _e_x_p_r_2 ; _e_x_p_r_3 )) ; ddoo _l_i_s_t ; ddoonnee First, the arithmetic expression _e_x_p_r_1 is evaluated according to - the rules described below under AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN. The + the rules described below under AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN. The arithmetic expression _e_x_p_r_2 is then evaluated repeatedly until - it evaluates to zero. Each time _e_x_p_r_2 evaluates to a non-zero + it evaluates to zero. Each time _e_x_p_r_2 evaluates to a non-zero value, _l_i_s_t is executed and the arithmetic expression _e_x_p_r_3 is - evaluated. If any expression is omitted, it behaves as if it - evaluates to 1. The return value is the exit status of the last + evaluated. If any expression is omitted, it behaves as if it + evaluates to 1. The return value is the exit status of the last command in _l_i_s_t that is executed, or false if any of the expres- sions is invalid. sseelleecctt _n_a_m_e [ iinn _w_o_r_d ] ; ddoo _l_i_s_t ; ddoonnee The list of words following iinn is expanded, generating a list of items, and the set of expanded words is printed on the standard - error, each preceded by a number. If the iinn _w_o_r_d is omitted, the - positional parameters are printed (see PPAARRAAMMEETTEERRSS below). sseelleecctt - then displays the PPSS33 prompt and reads a line from the standard - input. If the line consists of a number corresponding to one of - the displayed words, then the value of _n_a_m_e is set to that word. - If the line is empty, the words and prompt are displayed again. - If EOF is read, the sseelleecctt command completes and returns 1. Any - other value read causes _n_a_m_e to be set to null. The line read is - saved in the variable RREEPPLLYY. The _l_i_s_t is executed after each se- - lection until a bbrreeaakk command is executed. The exit status of - sseelleecctt is the exit status of the last command executed in _l_i_s_t, - or zero if no commands were executed. + error, each preceded by a number. If the iinn _w_o_r_d is omitted, + the positional parameters are printed (see PPAARRAAMMEETTEERRSS below). + sseelleecctt then displays the PPSS33 prompt and reads a line from the + standard input. If the line consists of a number corresponding + to one of the displayed words, then the value of _n_a_m_e is set to + that word. If the line is empty, the words and prompt are dis- + played again. If EOF is read, the sseelleecctt command completes and + returns 1. Any other value read causes _n_a_m_e to be set to null. + The line read is saved in the variable RREEPPLLYY. The _l_i_s_t is exe- + cuted after each selection until a bbrreeaakk command is executed. + The exit status of sseelleecctt is the exit status of the last command + executed in _l_i_s_t, or zero if no commands were executed. ccaassee _w_o_r_d iinn [ [(] _p_a_t_t_e_r_n [ || _p_a_t_t_e_r_n ] ... ) _l_i_s_t ;; ] ... eessaacc A ccaassee command first expands _w_o_r_d, and tries to match it against each _p_a_t_t_e_r_n in turn, using the matching rules described under - PPaatttteerrnn MMaattcchhiinngg below. The _w_o_r_d is expanded using tilde expan- + PPaatttteerrnn MMaattcchhiinngg below. The _w_o_r_d is expanded using tilde expan- sion, parameter and variable expansion, arithmetic expansion, command substitution, process substitution and quote removal. Each _p_a_t_t_e_r_n examined is expanded using tilde expansion, parame- ter and variable expansion, arithmetic expansion, command sub- - stitution, process substitution, and quote removal. If the nnoo-- + stitution, process substitution, and quote removal. If the nnoo-- ccaasseemmaattcchh shell option is enabled, the match is performed with- - out regard to the case of alphabetic characters. When a match is - found, the corresponding _l_i_s_t is executed. If the ;;;; operator is - used, no subsequent matches are attempted after the first pat- - tern match. Using ;;&& in place of ;;;; causes execution to continue - with the _l_i_s_t associated with the next set of patterns. Using - ;;;;&& in place of ;;;; causes the shell to test the next pattern - list in the statement, if any, and execute any associated _l_i_s_t - on a successful match, continuing the case statement execution - as if the pattern list had not matched. The exit status is zero - if no pattern matches. Otherwise, it is the exit status of the - last command executed in _l_i_s_t. + out regard to the case of alphabetic characters. When a match + is found, the corresponding _l_i_s_t is executed. If the ;;;; opera- + tor is used, no subsequent matches are attempted after the first + pattern match. Using ;;&& in place of ;;;; causes execution to con- + tinue with the _l_i_s_t associated with the next set of patterns. + Using ;;;;&& in place of ;;;; causes the shell to test the next pat- + tern list in the statement, if any, and execute any associated + _l_i_s_t on a successful match, continuing the case statement execu- + tion as if the pattern list had not matched. The exit status is + zero if no pattern matches. Otherwise, it is the exit status of + the last command executed in _l_i_s_t. iiff _l_i_s_t; tthheenn _l_i_s_t; [ eelliiff _l_i_s_t; tthheenn _l_i_s_t; ] ... [ eellssee _l_i_s_t; ] ffii - The iiff _l_i_s_t is executed. If its exit status is zero, the tthheenn - _l_i_s_t is executed. Otherwise, each eelliiff _l_i_s_t is executed in turn, - and if its exit status is zero, the corresponding tthheenn _l_i_s_t is - executed and the command completes. Otherwise, the eellssee _l_i_s_t is - executed, if present. The exit status is the exit status of the - last command executed, or zero if no condition tested true. + The iiff _l_i_s_t is executed. If its exit status is zero, the tthheenn + _l_i_s_t is executed. Otherwise, each eelliiff _l_i_s_t is executed in + turn, and if its exit status is zero, the corresponding tthheenn + _l_i_s_t is executed and the command completes. Otherwise, the eellssee + _l_i_s_t is executed, if present. The exit status is the exit sta- + tus of the last command executed, or zero if no condition tested + true. wwhhiillee _l_i_s_t_-_1; ddoo _l_i_s_t_-_2; ddoonnee uunnttiill _l_i_s_t_-_1; ddoo _l_i_s_t_-_2; ddoonnee - The wwhhiillee command continuously executes the list _l_i_s_t_-_2 as long + The wwhhiillee command continuously executes the list _l_i_s_t_-_2 as long as the last command in the list _l_i_s_t_-_1 returns an exit status of - zero. The uunnttiill command is identical to the wwhhiillee command, ex- + zero. The uunnttiill command is identical to the wwhhiillee command, ex- cept that the test is negated: _l_i_s_t_-_2 is executed as long as the - last command in _l_i_s_t_-_1 returns a non-zero exit status. The exit + last command in _l_i_s_t_-_1 returns a non-zero exit status. The exit status of the wwhhiillee and uunnttiill commands is the exit status of the last command executed in _l_i_s_t_-_2, or zero if none was executed. CCoopprroocceesssseess A _c_o_p_r_o_c_e_s_s is a shell command preceded by the ccoopprroocc reserved word. A - coprocess is executed asynchronously in a subshell, as if the command - had been terminated with the && control operator, with a two-way pipe + coprocess is executed asynchronously in a subshell, as if the command + had been terminated with the && control operator, with a two-way pipe established between the executing shell and the coprocess. The syntax for a coprocess is: ccoopprroocc [_N_A_M_E] _c_o_m_m_a_n_d [_r_e_d_i_r_e_c_t_i_o_n_s] - This creates a coprocess named _N_A_M_E. _c_o_m_m_a_n_d may be either a simple - command or a compound command (see above). _N_A_M_E is a shell variable - name. If _N_A_M_E is not supplied, the default name is CCOOPPRROOCC. + This creates a coprocess named _N_A_M_E. _c_o_m_m_a_n_d may be either a simple + command or a compound command (see above). _N_A_M_E is a shell variable + name. If _N_A_M_E is not supplied, the default name is CCOOPPRROOCC. The recommended form to use for a coprocess is ccoopprroocc _N_A_M_E { _c_o_m_m_a_n_d [_r_e_d_i_r_e_c_t_i_o_n_s]; } - This form is recommended because simple commands result in the copro- - cess always being named CCOOPPRROOCC, and it is simpler to use and more com- + This form is recommended because simple commands result in the copro- + cess always being named CCOOPPRROOCC, and it is simpler to use and more com- plete than the other compound commands. - If _c_o_m_m_a_n_d is a compound command, _N_A_M_E is optional. The word following - ccoopprroocc determines whether that word is interpreted as a variable name: - it is interpreted as _N_A_M_E if it is not a reserved word that introduces - a compound command. If _c_o_m_m_a_n_d is a simple command, _N_A_M_E is not al- - lowed; this is to avoid confusion between _N_A_M_E and the first word of + If _c_o_m_m_a_n_d is a compound command, _N_A_M_E is optional. The word following + ccoopprroocc determines whether that word is interpreted as a variable name: + it is interpreted as _N_A_M_E if it is not a reserved word that introduces + a compound command. If _c_o_m_m_a_n_d is a simple command, _N_A_M_E is not al- + lowed; this is to avoid confusion between _N_A_M_E and the first word of the simple command. - When the coprocess is executed, the shell creates an array variable - (see AArrrraayyss below) named _N_A_M_E in the context of the executing shell. - The standard output of _c_o_m_m_a_n_d is connected via a pipe to a file de- - scriptor in the executing shell, and that file descriptor is assigned - to _N_A_M_E[0]. The standard input of _c_o_m_m_a_n_d is connected via a pipe to a + When the coprocess is executed, the shell creates an array variable + (see AArrrraayyss below) named _N_A_M_E in the context of the executing shell. + The standard output of _c_o_m_m_a_n_d is connected via a pipe to a file de- + scriptor in the executing shell, and that file descriptor is assigned + to _N_A_M_E[0]. The standard input of _c_o_m_m_a_n_d is connected via a pipe to a file descriptor in the executing shell, and that file descriptor is as- - signed to _N_A_M_E[1]. This pipe is established before any redirections - specified by the command (see RREEDDIIRREECCTTIIOONN below). The file descriptors - can be utilized as arguments to shell commands and redirections using - standard word expansions. Other than those created to execute command - and process substitutions, the file descriptors are not available in + signed to _N_A_M_E[1]. This pipe is established before any redirections + specified by the command (see RREEDDIIRREECCTTIIOONN below). The file descriptors + can be utilized as arguments to shell commands and redirections using + standard word expansions. Other than those created to execute command + and process substitutions, the file descriptors are not available in subshells. - The process ID of the shell spawned to execute the coprocess is avail- - able as the value of the variable _N_A_M_E_PID. The wwaaiitt builtin command + The process ID of the shell spawned to execute the coprocess is avail- + able as the value of the variable _N_A_M_E_PID. The wwaaiitt builtin command may be used to wait for the coprocess to terminate. - Since the coprocess is created as an asynchronous command, the ccoopprroocc - command always returns success. The return status of a coprocess is the - exit status of _c_o_m_m_a_n_d. + Since the coprocess is created as an asynchronous command, the ccoopprroocc + command always returns success. The return status of a coprocess is + the exit status of _c_o_m_m_a_n_d. SShheellll FFuunnccttiioonn DDeeffiinniittiioonnss - A shell function is an object that is called like a simple command and - executes a compound command with a new set of positional parameters. + A shell function is an object that is called like a simple command and + executes a compound command with a new set of positional parameters. Shell functions are declared as follows: _f_n_a_m_e () _c_o_m_p_o_u_n_d_-_c_o_m_m_a_n_d [_r_e_d_i_r_e_c_t_i_o_n] ffuunnccttiioonn _f_n_a_m_e [()] _c_o_m_p_o_u_n_d_-_c_o_m_m_a_n_d [_r_e_d_i_r_e_c_t_i_o_n] - This defines a function named _f_n_a_m_e. The reserved word ffuunnccttiioonn - is optional. If the ffuunnccttiioonn reserved word is supplied, the - parentheses are optional. The _b_o_d_y of the function is the com- - pound command _c_o_m_p_o_u_n_d_-_c_o_m_m_a_n_d (see CCoommppoouunndd CCoommmmaannddss above). - That command is usually a _l_i_s_t of commands between { and }, but - may be any command listed under CCoommppoouunndd CCoommmmaannddss above. If the + This defines a function named _f_n_a_m_e. The reserved word ffuunnccttiioonn + is optional. If the ffuunnccttiioonn reserved word is supplied, the + parentheses are optional. The _b_o_d_y of the function is the com- + pound command _c_o_m_p_o_u_n_d_-_c_o_m_m_a_n_d (see CCoommppoouunndd CCoommmmaannddss above). + That command is usually a _l_i_s_t of commands between { and }, but + may be any command listed under CCoommppoouunndd CCoommmmaannddss above. If the ffuunnccttiioonn reserved word is used, but the parentheses are not sup- - plied, the braces are recommended. _c_o_m_p_o_u_n_d_-_c_o_m_m_a_n_d is executed - whenever _f_n_a_m_e is specified as the name of a simple command. + plied, the braces are recommended. _c_o_m_p_o_u_n_d_-_c_o_m_m_a_n_d is executed + whenever _f_n_a_m_e is specified as the name of a simple command. When in _p_o_s_i_x _m_o_d_e, _f_n_a_m_e must be a valid shell _n_a_m_e and may not - be the name of one of the POSIX _s_p_e_c_i_a_l _b_u_i_l_t_i_n_s. In default - mode, a function name can be any unquoted shell word that does - not contain $$. Any redirections (see RREEDDIIRREECCTTIIOONN below) speci- - fied when a function is defined are performed when the function - is executed. The exit status of a function definition is zero - unless a syntax error occurs or a readonly function with the - same name already exists. When executed, the exit status of a - function is the exit status of the last command executed in the - body. (See FFUUNNCCTTIIOONNSS below.) + be the name of one of the POSIX _s_p_e_c_i_a_l _b_u_i_l_t_i_n_s. In default + mode, a function name can be any unquoted shell word that does + not contain $$. Any redirections (see RREEDDIIRREECCTTIIOONN below) speci- + fied when a function is defined are performed when the function + is executed. The exit status of a function definition is zero + unless a syntax error occurs or a readonly function with the + same name already exists. When executed, the exit status of a + function is the exit status of the last command executed in the + body. (See FFUUNNCCTTIIOONNSS below.) CCOOMMMMEENNTTSS In a non-interactive shell, or an interactive shell in which the iinntteerr-- - aaccttiivvee__ccoommmmeennttss option to the sshhoopptt builtin is enabled (see SSHHEELLLL - BBUUIILLTTIINN CCOOMMMMAANNDDSS below), a word beginning with ## causes that word and - all remaining characters on that line to be ignored. An interactive - shell without the iinntteerraaccttiivvee__ccoommmmeennttss option enabled does not allow - comments. The iinntteerraaccttiivvee__ccoommmmeennttss option is on by default in interac- + aaccttiivvee__ccoommmmeennttss option to the sshhoopptt builtin is enabled (see SSHHEELLLL + BBUUIILLTTIINN CCOOMMMMAANNDDSS below), a word beginning with ## causes that word and + all remaining characters on that line to be ignored. An interactive + shell without the iinntteerraaccttiivvee__ccoommmmeennttss option enabled does not allow + comments. The iinntteerraaccttiivvee__ccoommmmeennttss option is on by default in interac- tive shells. QQUUOOTTIINNGG - _Q_u_o_t_i_n_g is used to remove the special meaning of certain characters or - words to the shell. Quoting can be used to disable special treatment + _Q_u_o_t_i_n_g is used to remove the special meaning of certain characters 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 _m_e_t_a_c_h_a_r_a_c_t_e_r_s listed above under DDEEFFIINNIITTIIOONNSS has special + Each of the _m_e_t_a_c_h_a_r_a_c_t_e_r_s listed above under DDEEFFIINNIITTIIOONNSS has special meaning to the shell and must be quoted if it is to represent itself. - When the command history expansion facilities are being used (see HHIISS-- + When the command history expansion facilities are being used (see HHIISS-- TTOORRYY EEXXPPAANNSSIIOONN below), the _h_i_s_t_o_r_y _e_x_p_a_n_s_i_o_n character, usually !!, must be quoted to prevent history expansion. - There are three quoting mechanisms: the _e_s_c_a_p_e _c_h_a_r_a_c_t_e_r, single + There are three quoting mechanisms: the _e_s_c_a_p_e _c_h_a_r_a_c_t_e_r, single quotes, and double quotes. - A non-quoted backslash (\\) is the _e_s_c_a_p_e _c_h_a_r_a_c_t_e_r. It preserves the + A non-quoted backslash (\\) is the _e_s_c_a_p_e _c_h_a_r_a_c_t_e_r. It preserves the literal value of the next character that follows, with the exception of - . If a \\ pair appears, and the backslash is not it- + . If a \\ pair appears, and the backslash is not it- self quoted, the \\ is treated as a line continuation (that is, it is removed from the input stream and effectively ignored). - Enclosing characters in single quotes preserves the literal value of - each character within the quotes. A single quote may not occur between + Enclosing characters in single quotes preserves the literal value of + each character within the quotes. A single quote may not occur between single quotes, even when preceded by a backslash. - Enclosing characters in double quotes preserves the literal value of - all characters within the quotes, with the exception of $$, ``, \\, and, - when history expansion is enabled, !!. When the shell is in _p_o_s_i_x _m_o_d_e, - the !! has no special meaning within double quotes, even when history - expansion is enabled. The characters $$ and `` retain their special mean- - ing within double quotes. The backslash retains its special meaning - only when followed by one of the following characters: $$, ``, "", \\, or - <>. A double quote may be quoted within double quotes by preced- - ing it with a backslash. If enabled, history expansion will be per- - formed unless an !! appearing in double quotes is escaped using a back- - slash. The backslash preceding the !! is not removed. + Enclosing characters in double quotes preserves the literal value of + all characters within the quotes, with the exception of $$, ``, \\, and, + when history expansion is enabled, !!. When the shell is in _p_o_s_i_x _m_o_d_e, + the !! has no special meaning within double quotes, even when history + expansion is enabled. The characters $$ and `` retain their special + meaning within double quotes. The backslash retains its special mean- + ing only when followed by one of the following characters: $$, ``, "", \\, + or <>. A double quote may be quoted within double quotes by + preceding it with a backslash. If enabled, history expansion will be + performed unless an !! appearing in double quotes is escaped using a + backslash. The backslash preceding the !! is not removed. - The special parameters ** and @@ have special meaning when in double + The special parameters ** and @@ have special meaning when in double quotes (see PPAARRAAMMEETTEERRSS below). - Character sequences of the form $$'_s_t_r_i_n_g' are treated as a special - variant of single quotes. The sequence expands to _s_t_r_i_n_g, with back- - slash-escaped characters in _s_t_r_i_n_g replaced as specified by the ANSI C - standard. Backslash escape sequences, if present, are decoded as fol- + Character sequences of the form $$'_s_t_r_i_n_g' are treated as a special + variant of single quotes. The sequence expands to _s_t_r_i_n_g, with back- + slash-escaped characters in _s_t_r_i_n_g replaced as specified by the ANSI C + standard. Backslash escape sequences, if present, are decoded as fol- lows: \\aa alert (bell) \\bb backspace @@ -656,284 +659,284 @@ QQUUOOTTIINNGG \\'' single quote \\"" double quote \\?? question mark - \\_n_n_n the eight-bit character whose value is the octal value + \\_n_n_n the eight-bit character whose value is the octal value _n_n_n (one to three octal digits) - \\xx_H_H the eight-bit character whose value is the hexadecimal + \\xx_H_H the eight-bit character whose value is the hexadecimal value _H_H (one or two hex digits) - \\uu_H_H_H_H the Unicode (ISO/IEC 10646) character whose value is the + \\uu_H_H_H_H the Unicode (ISO/IEC 10646) character whose value is the hexadecimal value _H_H_H_H (one to four hex digits) \\UU_H_H_H_H_H_H_H_H - the Unicode (ISO/IEC 10646) character whose value is the + the Unicode (ISO/IEC 10646) character whose value is the hexadecimal value _H_H_H_H_H_H_H_H (one to eight hex digits) \\cc_x a control-_x character - The expanded result is single-quoted, as if the dollar sign had not + The expanded result is single-quoted, as if the dollar sign had not been present. A double-quoted string preceded by a dollar sign ($$"_s_t_r_i_n_g") will cause - the string to be translated according to the current locale. The _g_e_t_- - _t_e_x_t infrastructure performs the lookup and translation, using the - LLCC__MMEESSSSAAGGEESS, TTEEXXTTDDOOMMAAIINNDDIIRR, and TTEEXXTTDDOOMMAAIINN shell variables. If the cur- - rent locale is CC or PPOOSSIIXX, if there are no translations available, or - if the string is not translated, the dollar sign is ignored. This is a - form of double quoting, so the string remains double-quoted by default, - whether or not it is translated and replaced. If the nnooeexxppaanndd__ttrraannssllaa-- - ttiioonn option is enabled using the sshhoopptt builtin, translated strings are - single-quoted instead of double-quoted. See the description of sshhoopptt - below under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS. + the string to be translated according to the current locale. The _g_e_t_- + _t_e_x_t infrastructure performs the lookup and translation, using the + LLCC__MMEESSSSAAGGEESS, TTEEXXTTDDOOMMAAIINNDDIIRR, and TTEEXXTTDDOOMMAAIINN shell variables. If the + current locale is CC or PPOOSSIIXX, if there are no translations available, + or if the string is not translated, the dollar sign is ignored. This + is a form of double quoting, so the string remains double-quoted by de- + fault, whether or not it is translated and replaced. If the nnooeexx-- + ppaanndd__ttrraannssllaattiioonn option is enabled using the sshhoopptt builtin, translated + strings are single-quoted instead of double-quoted. See the descrip- + tion of sshhoopptt below under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS. PPAARRAAMMEETTEERRSS - A _p_a_r_a_m_e_t_e_r is an entity that stores values. It can be a _n_a_m_e, a num- + A _p_a_r_a_m_e_t_e_r is an entity that stores values. It can be a _n_a_m_e, a num- ber, or one of the special characters listed below under SSppeecciiaall PPaarraamm-- - eetteerrss. A _v_a_r_i_a_b_l_e is a parameter denoted by a _n_a_m_e. A variable has a - _v_a_l_u_e and zero or more _a_t_t_r_i_b_u_t_e_s. Attributes are assigned using the + eetteerrss. A _v_a_r_i_a_b_l_e is a parameter denoted by a _n_a_m_e. A variable has a + _v_a_l_u_e and zero or more _a_t_t_r_i_b_u_t_e_s. Attributes are assigned using the ddeeccllaarree builtin command (see ddeeccllaarree below in SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS). - A parameter is set if it has been assigned a value. The null string is - a valid value. Once a variable is set, it may be unset only by using + A parameter is set if it has been assigned a value. The null string is + a valid value. Once a variable is set, it may be unset only by using the uunnsseett builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). A _v_a_r_i_a_b_l_e may be assigned to by a statement of the form _n_a_m_e=[_v_a_l_u_e] - If _v_a_l_u_e is not given, the variable is assigned the null string. All - _v_a_l_u_e_s undergo tilde expansion, parameter and variable expansion, com- - mand substitution, arithmetic expansion, and quote removal (see EEXXPPAANN-- - SSIIOONN below). If the variable has its iinntteeggeerr attribute set, then _v_a_l_u_e + If _v_a_l_u_e is not given, the variable is assigned the null string. All + _v_a_l_u_e_s undergo tilde expansion, parameter and variable expansion, com- + mand substitution, arithmetic expansion, and quote removal (see EEXXPPAANN-- + SSIIOONN below). If the variable has its iinntteeggeerr attribute set, then _v_a_l_u_e is evaluated as an arithmetic expression even if the $((...)) expansion - is not used (see AArriitthhmmeettiicc EExxppaannssiioonn below). Word splitting and path- - name expansion are not performed. Assignment statements may also appear - as arguments to the aalliiaass, ddeeccllaarree, ttyyppeesseett, eexxppoorrtt, rreeaaddoonnllyy, and lloo-- - ccaall builtin commands (_d_e_c_l_a_r_a_t_i_o_n commands). When in _p_o_s_i_x _m_o_d_e, these - builtins may appear in a command after one or more instances of the - ccoommmmaanndd builtin and retain these assignment statement properties. + is not used (see AArriitthhmmeettiicc EExxppaannssiioonn below). Word splitting and path- + name expansion are not performed. Assignment statements may also ap- + pear as arguments to the aalliiaass, ddeeccllaarree, ttyyppeesseett, eexxppoorrtt, rreeaaddoonnllyy, and + llooccaall builtin commands (_d_e_c_l_a_r_a_t_i_o_n commands). When in _p_o_s_i_x _m_o_d_e, + these builtins may appear in a command after one or more instances of + the ccoommmmaanndd builtin and retain these assignment statement properties. - In the context where an assignment statement is assigning a value to a + In the context where an assignment statement is assigning a value to a shell variable or array index, the += operator can be used to append to - or add to the variable's previous value. This includes arguments to - builtin commands such as ddeeccllaarree that accept assignment statements - (_d_e_c_l_a_r_a_t_i_o_n commands). When += is applied to a variable for which the + or add to the variable's previous value. This includes arguments to + builtin commands such as ddeeccllaarree that accept assignment statements + (_d_e_c_l_a_r_a_t_i_o_n commands). When += is applied to a variable for which the iinntteeggeerr attribute has been set, _v_a_l_u_e is evaluated as an arithmetic ex- pression and added to the variable's current value, which is also eval- - uated. When += is applied to an array variable using compound assign- - ment (see AArrrraayyss below), the variable's value is not unset (as it is - when using =), and new values are appended to the array beginning at - one greater than the array's maximum index (for indexed arrays) or - added as additional key-value pairs in an associative array. When ap- - plied to a string-valued variable, _v_a_l_u_e is expanded and appended to + uated. When += is applied to an array variable using compound assign- + ment (see AArrrraayyss below), the variable's value is not unset (as it is + when using =), and new values are appended to the array beginning at + one greater than the array's maximum index (for indexed arrays) or + added as additional key-value pairs in an associative array. When ap- + plied to a string-valued variable, _v_a_l_u_e is expanded and appended to the variable's value. A variable can be assigned the _n_a_m_e_r_e_f attribute using the --nn option to - the ddeeccllaarree or llooccaall builtin commands (see the descriptions of ddeeccllaarree - and llooccaall below) to create a _n_a_m_e_r_e_f, or a reference to another vari- - able. This allows variables to be manipulated indirectly. Whenever the - nameref variable is referenced, assigned to, unset, or has its at- - tributes modified (other than using or changing the _n_a_m_e_r_e_f attribute - itself), the operation is actually performed on the variable specified - by the nameref variable's value. A nameref is commonly used within + the ddeeccllaarree or llooccaall builtin commands (see the descriptions of ddeeccllaarree + and llooccaall below) to create a _n_a_m_e_r_e_f, or a reference to another vari- + able. This allows variables to be manipulated indirectly. Whenever + the nameref variable is referenced, assigned to, unset, or has its at- + tributes modified (other than using or changing the _n_a_m_e_r_e_f attribute + itself), the operation is actually performed on the variable specified + by the nameref variable's value. A nameref is commonly used within shell functions to refer to a variable whose name is passed as an argu- - ment to the function. For instance, if a variable name is passed to a + ment to the function. For instance, if a variable name is passed to a shell function as its first argument, running declare -n ref=$1 - inside the function creates a nameref variable rreeff whose value is the - variable name passed as the first argument. References and assignments - to rreeff, and changes to its attributes, are treated as references, as- - signments, and attribute modifications to the variable whose name was - passed as $$11. If the control variable in a ffoorr loop has the nameref at- - tribute, the list of words can be a list of shell variables, and a name - reference will be established for each word in the list, in turn, when - the loop is executed. Array variables cannot be given the nnaammeerreeff at- - tribute. However, nameref variables can reference array variables and - subscripted array variables. Namerefs can be unset using the --nn option - to the uunnsseett builtin. Otherwise, if uunnsseett is executed with the name of - a nameref variable as an argument, the variable referenced by the - nameref variable will be unset. + inside the function creates a nameref variable rreeff whose value is the + variable name passed as the first argument. References and assignments + to rreeff, and changes to its attributes, are treated as references, as- + signments, and attribute modifications to the variable whose name was + passed as $$11. If the control variable in a ffoorr loop has the nameref + attribute, the list of words can be a list of shell variables, and a + name reference will be established for each word in the list, in turn, + when the loop is executed. Array variables cannot be given the nnaammeerreeff + attribute. However, nameref variables can reference array variables + and subscripted array variables. Namerefs can be unset using the --nn + option to the uunnsseett builtin. Otherwise, if uunnsseett is executed with the + name of a nameref variable as an argument, the variable referenced by + the nameref variable will be unset. PPoossiittiioonnaall PPaarraammeetteerrss - A _p_o_s_i_t_i_o_n_a_l _p_a_r_a_m_e_t_e_r 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 sseett builtin command. Positional parameters may not be assigned to - with assignment statements. The positional parameters are temporarily + A _p_o_s_i_t_i_o_n_a_l _p_a_r_a_m_e_t_e_r 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 sseett builtin command. Positional parameters may not be assigned to + with assignment statements. The positional parameters are temporarily replaced when a shell function is executed (see FFUUNNCCTTIIOONNSS below). - When a positional parameter consisting of more than a single digit is + When a positional parameter consisting of more than a single digit is expanded, it must be enclosed in braces (see EEXXPPAANNSSIIOONN below). SSppeecciiaall PPaarraammeetteerrss - The shell treats several parameters specially. These parameters may + The shell treats several parameters specially. These parameters may only be referenced; assignment to them is not allowed. - ** Expands to the positional parameters, starting from one. When - the expansion is not within double quotes, each positional pa- - rameter expands to a separate word. In contexts where it is per- - formed, those words are subject to further word splitting and - pathname expansion. When the expansion occurs within double - quotes, it expands to a single word with the value of each pa- - rameter separated by the first character of the IIFFSS special - variable. That is, "$$**" is equivalent to "$$11_c$$22_c......", where _c is - the first character of the value of the IIFFSS variable. If IIFFSS is - unset, the parameters are separated by spaces. If IIFFSS is null, - the parameters are joined without intervening separators. - @@ Expands to the positional parameters, starting from one. In con- - texts where word splitting is performed, this expands each posi- - tional parameter to a separate word; if not within double - quotes, these words are subject to word splitting. In contexts - where word splitting is not performed, this expands to a single - word with each positional parameter separated by a space. When - the expansion occurs within double quotes, each parameter ex- - pands to a separate word. That is, "$$@@" is equivalent to "$$11" - "$$22" ... If the double-quoted expansion occurs within a word, - the expansion of the first parameter is joined with the begin- - ning part of the original word, and the expansion of the last - parameter is joined with the last part of the original word. - When there are no positional parameters, "$$@@" and $$@@ expand to + ** Expands to the positional parameters, starting from one. When + the expansion is not within double quotes, each positional pa- + rameter expands to a separate word. In contexts where it is + performed, those words are subject to further word splitting and + pathname expansion. When the expansion occurs within double + quotes, it expands to a single word with the value of each pa- + rameter separated by the first character of the IIFFSS special + variable. That is, "$$**" is equivalent to "$$11_c$$22_c......", where _c + is the first character of the value of the IIFFSS variable. If IIFFSS + is unset, the parameters are separated by spaces. If IIFFSS is + null, the parameters are joined without intervening separators. + @@ Expands to the positional parameters, starting from one. In + contexts where word splitting is performed, this expands each + positional parameter to a separate word; if not within double + quotes, these words are subject to word splitting. In contexts + where word splitting is not performed, this expands to a single + word with each positional parameter separated by a space. When + the expansion occurs within double quotes, each parameter ex- + pands to a separate word. That is, "$$@@" is equivalent to "$$11" + "$$22" ... If the double-quoted expansion occurs within a word, + the expansion of the first parameter is joined with the begin- + ning part of the original word, and the expansion of the last + parameter is joined with the last part of the original word. + When there are no positional parameters, "$$@@" and $$@@ expand to nothing (i.e., they are removed). ## Expands to the number of positional parameters in decimal. - ?? Expands to the exit status of the most recently executed fore- + ?? Expands to the exit status of the most recently executed fore- ground pipeline. - -- Expands to the current option flags as specified upon invoca- - tion, by the sseett builtin command, or those set by the shell it- + -- Expands to the current option flags as specified upon invoca- + tion, by the sseett builtin command, or those set by the shell it- self (such as the --ii option). - $$ Expands to the process ID of the shell. In a subshell, it ex- + $$ Expands to the process ID of the shell. In a subshell, it ex- pands to the process ID of the current shell, not the subshell. - !! Expands to the process ID of the job most recently placed into - the background, whether executed as an asynchronous command or + !! Expands to the process ID of the job most recently placed into + the background, whether executed as an asynchronous command or using the bbgg builtin (see JJOOBB CCOONNTTRROOLL below). - 00 Expands to the name of the shell or shell script. This is set at - shell initialization. If bbaasshh is invoked with a file of com- - mands, $$00 is set to the name of that file. If bbaasshh is started - with the --cc option, then $$00 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 bbaasshh, as given by argument + 00 Expands to the name of the shell or shell script. This is set + at shell initialization. If bbaasshh is invoked with a file of com- + mands, $$00 is set to the name of that file. If bbaasshh is started + with the --cc option, then $$00 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 bbaasshh, as given by argument zero. SShheellll VVaarriiaabblleess The following variables are set by the shell: - __ At shell startup, set to the pathname used to invoke the shell - or shell script being executed as passed in the environment or - argument list. Subsequently, expands to the last argument to the - previous simple command executed in the foreground, after expan- - sion. Also set to the full pathname used to invoke each command - executed and placed in the environment exported to that command. - When checking mail, this parameter holds the name of the mail - file currently being checked. - BBAASSHH Expands to the full filename used to invoke this instance of + __ At shell startup, set to the pathname used to invoke the shell + or shell script being executed as passed in the environment or + argument list. Subsequently, expands to the last argument to + the previous simple command executed in the foreground, after + expansion. Also set to the full pathname used to invoke each + command executed and placed in the environment exported to that + command. When checking mail, this parameter holds the name of + the mail file currently being checked. + BBAASSHH Expands to the full filename used to invoke this instance of bbaasshh. BBAASSHHOOPPTTSS - A colon-separated list of enabled shell options. Each word in - the list is a valid argument for the --ss option to the sshhoopptt - builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). The options - appearing in BBAASSHHOOPPTTSS are those reported as _o_n by sshhoopptt. If this - variable is in the environment when bbaasshh starts up, each shell - option in the list will be enabled before reading any startup - files. This variable is read-only. + A colon-separated list of enabled shell options. Each word in + the list is a valid argument for the --ss option to the sshhoopptt + builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). The options + appearing in BBAASSHHOOPPTTSS are those reported as _o_n by sshhoopptt. If + this variable is in the environment when bbaasshh starts up, each + shell option in the list will be enabled before reading any + startup files. This variable is read-only. BBAASSHHPPIIDD - Expands to the process ID of the current bbaasshh process. This dif- - fers from $$$$ under certain circumstances, such as subshells that - do not require bbaasshh to be re-initialized. Assignments to BBAASSHHPPIIDD - have no effect. If BBAASSHHPPIIDD is unset, it loses its special prop- - erties, even if it is subsequently reset. + Expands to the process ID of the current bbaasshh process. This + differs from $$$$ under certain circumstances, such as subshells + that do not require bbaasshh to be re-initialized. Assignments to + BBAASSHHPPIIDD have no effect. If BBAASSHHPPIIDD is unset, it loses its spe- + cial properties, even if it is subsequently reset. BBAASSHH__AALLIIAASSEESS - An associative array variable whose members correspond to the - internal list of aliases as maintained by the aalliiaass builtin. El- - ements added to this array appear in the alias list; however, - unsetting array elements currently does not cause aliases to be - removed from the alias list. If BBAASSHH__AALLIIAASSEESS is unset, it loses + An associative array variable whose members correspond to the + internal list of aliases as maintained by the aalliiaass builtin. + Elements added to this array appear in the alias list; however, + unsetting array elements currently does not cause aliases to be + removed from the alias list. If BBAASSHH__AALLIIAASSEESS is unset, it loses its special properties, even if it is subsequently reset. BBAASSHH__AARRGGCC - An array variable whose values are the number of parameters in - each frame of the current bbaasshh execution call stack. The number - of parameters to the current subroutine (shell function or - script executed with .. or ssoouurrccee) is at the top of the stack. - When a subroutine is executed, the number of parameters passed - is pushed onto BBAASSHH__AARRGGCC. The shell sets BBAASSHH__AARRGGCC only when in + An array variable whose values are the number of parameters in + each frame of the current bbaasshh execution call stack. The number + of parameters to the current subroutine (shell function or + script executed with .. or ssoouurrccee) is at the top of the stack. + When a subroutine is executed, the number of parameters passed + is pushed onto BBAASSHH__AARRGGCC. The shell sets BBAASSHH__AARRGGCC only when in extended debugging mode (see the description of the eexxttddeebbuugg op- - tion to the sshhoopptt builtin below). Setting eexxttddeebbuugg after the + tion to the sshhoopptt builtin below). Setting eexxttddeebbuugg after the shell has started to execute a script, or referencing this vari- - able when eexxttddeebbuugg is not set, may result in inconsistent val- - ues. Assignments to BBAASSHH__AARRGGCC have no effect, and it may not be + able when eexxttddeebbuugg is not set, may result in inconsistent val- + ues. Assignments to BBAASSHH__AARRGGCC have no effect, and it may not be unset. BBAASSHH__AARRGGVV - An array variable containing all of the parameters in the cur- - rent bbaasshh execution call stack. The final parameter of the last - subroutine call is at the top of the stack; the first parameter - of the initial call is at the bottom. When a subroutine is exe- - cuted, the parameters supplied are pushed onto BBAASSHH__AARRGGVV. The - shell sets BBAASSHH__AARRGGVV only when in extended debugging mode (see - the description of the eexxttddeebbuugg option to the sshhoopptt builtin be- - low). Setting eexxttddeebbuugg after the shell has started to execute a - script, or referencing this variable when eexxttddeebbuugg is not set, - may result in inconsistent values. Assignments to BBAASSHH__AARRGGVV have - no effect, and it may not be unset. + An array variable containing all of the parameters in the cur- + rent bbaasshh execution call stack. The final parameter of the last + subroutine call is at the top of the stack; the first parameter + of the initial call is at the bottom. When a subroutine is exe- + cuted, the parameters supplied are pushed onto BBAASSHH__AARRGGVV. The + shell sets BBAASSHH__AARRGGVV only when in extended debugging mode (see + the description of the eexxttddeebbuugg option to the sshhoopptt builtin be- + low). Setting eexxttddeebbuugg after the shell has started to execute a + script, or referencing this variable when eexxttddeebbuugg is not set, + may result in inconsistent values. Assignments to BBAASSHH__AARRGGVV + have no effect, and it may not be unset. BBAASSHH__AARRGGVV00 - When referenced, this variable expands to the name of the shell + When referenced, this variable expands to the name of the shell or shell script (identical to $$00; see the description of special - parameter 0 above). Assignment to BBAASSHH__AARRGGVV00 causes the value - assigned to also be assigned to $$00. If BBAASSHH__AARRGGVV00 is unset, it + parameter 0 above). Assignment to BBAASSHH__AARRGGVV00 causes the value + assigned to also be assigned to $$00. If BBAASSHH__AARRGGVV00 is unset, it loses its special properties, even if it is subsequently reset. BBAASSHH__CCMMDDSS - An associative array variable whose members correspond to the - internal hash table of commands as maintained by the hhaasshh + An associative array variable whose members correspond to the + internal hash table of commands as maintained by the hhaasshh builtin. Elements added to this array appear in the hash table; - however, unsetting array elements currently does not cause com- - mand names to be removed from the hash table. If BBAASSHH__CCMMDDSS is - unset, it loses its special properties, even if it is subse- + however, unsetting array elements currently does not cause com- + mand names to be removed from the hash table. If BBAASSHH__CCMMDDSS is + unset, it loses its special properties, even if it is subse- quently reset. BBAASSHH__CCOOMMMMAANNDD - The command currently being executed or about to be executed, + The command currently being executed or about to be executed, unless the shell is executing a command as the result of a trap, - in which case it is the command executing at the time of the - trap. If BBAASSHH__CCOOMMMMAANNDD is unset, it loses its special properties, - even if it is subsequently reset. + in which case it is the command executing at the time of the + trap. If BBAASSHH__CCOOMMMMAANNDD is unset, it loses its special proper- + ties, even if it is subsequently reset. BBAASSHH__EEXXEECCUUTTIIOONN__SSTTRRIINNGG The command argument to the --cc invocation option. BBAASSHH__LLIINNEENNOO - An array variable whose members are the line numbers in source - files where each corresponding member of FFUUNNCCNNAAMMEE was invoked. + An array variable whose members are the line numbers in source + files where each corresponding member of FFUUNNCCNNAAMMEE was invoked. $${{BBAASSHH__LLIINNEENNOO[[_$_i]]}} is the line number in the source file ($${{BBAASSHH__SSOOUURRCCEE[[_$_i_+_1]]}}) where $${{FFUUNNCCNNAAMMEE[[_$_i]]}} was called (or - $${{BBAASSHH__LLIINNEENNOO[[_$_i_-_1]]}} if referenced within another shell func- - tion). Use LLIINNEENNOO to obtain the current line number. Assignments - to BBAASSHH__LLIINNEENNOO have no effect, and it may not be unset. + $${{BBAASSHH__LLIINNEENNOO[[_$_i_-_1]]}} if referenced within another shell func- + tion). Use LLIINNEENNOO to obtain the current line number. Assign- + ments to BBAASSHH__LLIINNEENNOO have no effect, and it may not be unset. BBAASSHH__LLOOAADDAABBLLEESS__PPAATTHH - A colon-separated list of directories in which the shell looks - for dynamically loadable builtins specified by the eennaabbllee com- + A colon-separated list of directories in which the shell looks + for dynamically loadable builtins specified by the eennaabbllee com- mand. BBAASSHH__RREEMMAATTCCHH - An array variable whose members are assigned by the ==~~ binary - operator to the [[[[ conditional command. The element with index 0 - is the portion of the string matching the entire regular expres- - sion. The element with index _n is the portion of the string + An array variable whose members are assigned by the ==~~ binary + operator to the [[[[ conditional command. The element with index + 0 is the portion of the string matching the entire regular ex- + pression. The element with index _n is the portion of the string matching the _nth parenthesized subexpression. BBAASSHH__MMOONNOOSSEECCOONNDDSS - Each time this variable is referenced, it expands to the value - returned by the system's monotonic clock, if one is available. - If there is no monotonic clock, this is equivalent to EEPPOOCCHHSSEECC-- - OONNDDSS. If BBAASSHH__MMOONNOOSSEECCOONNDDSS is unset, it loses its special proper- - ties, even if it is subsequently reset. + Each time this variable is referenced, it expands to the value + returned by the system's monotonic clock, if one is available. + If there is no monotonic clock, this is equivalent to EEPPOOCCHHSSEECC-- + OONNDDSS. If BBAASSHH__MMOONNOOSSEECCOONNDDSS is unset, it loses its special prop- + erties, even if it is subsequently reset. BBAASSHH__SSOOUURRCCEE - An array variable whose members are the source filenames where - the corresponding shell function names in the FFUUNNCCNNAAMMEE array - variable are defined. The shell function $${{FFUUNNCCNNAAMMEE[[_$_i]]}} is de- - fined in the file $${{BBAASSHH__SSOOUURRCCEE[[_$_i]]}} and called from - $${{BBAASSHH__SSOOUURRCCEE[[_$_i_+_1]]}}. Assignments to BBAASSHH__SSOOUURRCCEE have no effect, - and it may not be unset. + An array variable whose members are the source filenames where + the corresponding shell function names in the FFUUNNCCNNAAMMEE array + variable are defined. The shell function $${{FFUUNNCCNNAAMMEE[[_$_i]]}} is de- + fined in the file $${{BBAASSHH__SSOOUURRCCEE[[_$_i]]}} and called from + $${{BBAASSHH__SSOOUURRCCEE[[_$_i_+_1]]}}. Assignments to BBAASSHH__SSOOUURRCCEE have no ef- + fect, and it may not be unset. BBAASSHH__SSUUBBSSHHEELLLL - Incremented by one within each subshell or subshell environment - when the shell begins executing in that environment. The initial - value is 0. If BBAASSHH__SSUUBBSSHHEELLLL is unset, it loses its special - properties, even if it is subsequently reset. + Incremented by one within each subshell or subshell environment + when the shell begins executing in that environment. The ini- + tial value is 0. If BBAASSHH__SSUUBBSSHHEELLLL is unset, it loses its spe- + cial properties, even if it is subsequently reset. BBAASSHH__TTRRAAPPSSIIGG - Set to the signal number corresponding to the trap action being - executed during its execution. See the description of ttrraapp under - SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below for information about signal num- - bers and trap execution. + Set to the signal number corresponding to the trap action being + executed during its execution. See the description of ttrraapp un- + der SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below for information about signal + numbers and trap execution. BBAASSHH__VVEERRSSIINNFFOO A readonly array variable whose members hold version information - for this instance of bbaasshh. The values assigned to the array mem- - bers are as follows: + for this instance of bbaasshh. The values assigned to the array + members are as follows: BBAASSHH__VVEERRSSIINNFFOO[[0]] The major version number (the _r_e_l_e_a_s_e). BBAASSHH__VVEERRSSIINNFFOO[[1]] The minor version number (the _v_e_r_s_i_o_n). BBAASSHH__VVEERRSSIINNFFOO[[2]] The patch level. @@ -941,113 +944,116 @@ PPAARRAAMMEETTEERRSS BBAASSHH__VVEERRSSIINNFFOO[[4]] The release status (e.g., _b_e_t_a_1). BBAASSHH__VVEERRSSIINNFFOO[[5]] The value of MMAACCHHTTYYPPEE. BBAASSHH__VVEERRSSIIOONN - Expands to a string describing the version of this instance of + Expands to a string describing the version of this instance of bbaasshh. CCOOMMPP__CCWWOORRDD - An index into $${{CCOOMMPP__WWOORRDDSS}} of the word containing the current - cursor position. This variable is available only in shell func- - tions invoked by the programmable completion facilities (see + An index into $${{CCOOMMPP__WWOORRDDSS}} of the word containing the current + cursor position. This variable is available only in shell func- + tions invoked by the programmable completion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). CCOOMMPP__KKEEYY The key (or final key of a key sequence) used to invoke the cur- rent completion function. CCOOMMPP__LLIINNEE - The current command line. This variable is available only in - shell functions and external commands invoked by the program- + The current command line. This variable is available only in + shell functions and external commands invoked by the program- mable completion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). CCOOMMPP__PPOOIINNTT - The index of the current cursor position relative to the begin- - ning of the current command. If the current cursor position is + The index of the current cursor position relative to the begin- + ning of the current command. If the current cursor position is at the end of the current command, the value of this variable is - equal to $${{##CCOOMMPP__LLIINNEE}}. This variable is available only in shell - functions and external commands invoked by the programmable com- - pletion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). + equal to $${{##CCOOMMPP__LLIINNEE}}. This variable is available only in + shell functions and external commands invoked by the program- + mable completion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). CCOOMMPP__TTYYPPEE - Set to an integer value corresponding to the type of completion - attempted that caused a completion function to be called: _T_A_B, - for normal completion, _?, for listing completions after succes- - sive tabs, _!, for listing alternatives on partial word comple- - tion, _@, to list completions if the word is not unmodified, or - _%, for menu completion. This variable is available only in shell - functions and external commands invoked by the programmable com- - pletion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). + Set to an integer value corresponding to the type of completion + attempted that caused a completion function to be called: _T_A_B, + for normal completion, _?, for listing completions after succes- + sive tabs, _!, for listing alternatives on partial word comple- + tion, _@, to list completions if the word is not unmodified, or + _%, for menu completion. This variable is available only in + shell functions and external commands invoked by the program- + mable completion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). CCOOMMPP__WWOORRDDBBRREEAAKKSS - The set of characters that the rreeaaddlliinnee library treats as word - separators when performing word completion. If CCOOMMPP__WWOORRDDBBRREEAAKKSS - is unset, it loses its special properties, even if it is subse- + The set of characters that the rreeaaddlliinnee library treats as word + separators when performing word completion. If CCOOMMPP__WWOORRDDBBRREEAAKKSS + is unset, it loses its special properties, even if it is subse- quently reset. CCOOMMPP__WWOORRDDSS - An array variable (see AArrrraayyss below) consisting of the individ- - ual words in the current command line. The line is split into - words as rreeaaddlliinnee would split it, using CCOOMMPP__WWOORRDDBBRREEAAKKSS as de- - scribed above. This variable is available only in shell func- - tions invoked by the programmable completion facilities (see + An array variable (see AArrrraayyss below) consisting of the individ- + ual words in the current command line. The line is split into + words as rreeaaddlliinnee would split it, using CCOOMMPP__WWOORRDDBBRREEAAKKSS as de- + scribed above. This variable is available only in shell func- + tions invoked by the programmable completion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). - CCOOPPRROOCC An array variable (see AArrrraayyss below) created to hold the file - descriptors for output from and input to an unnamed coprocess + CCOOPPRROOCC An array variable (see AArrrraayyss below) created to hold the file + descriptors for output from and input to an unnamed coprocess (see CCoopprroocceesssseess above). DDIIRRSSTTAACCKK An array variable (see AArrrraayyss below) containing the current con- - tents of the directory stack. Directories appear in the stack in - the order they are displayed by the ddiirrss builtin. Assigning to - members of this array variable may be used to modify directories - already in the stack, but the ppuusshhdd and ppooppdd builtins must be - used to add and remove directories. Assignment to this variable - will not change the current directory. If DDIIRRSSTTAACCKK is unset, it - loses its special properties, even if it is subsequently reset. + tents of the directory stack. Directories appear in the stack + in the order they are displayed by the ddiirrss builtin. Assigning + to members of this array variable may be used to modify directo- + ries already in the stack, but the ppuusshhdd and ppooppdd builtins must + be used to add and remove directories. Assignment to this vari- + able will not change the current directory. If DDIIRRSSTTAACCKK is un- + set, it loses its special properties, even if it is subsequently + reset. EEPPOOCCHHRREEAALLTTIIMMEE Each time this parameter is referenced, it expands to the number of seconds since the Unix Epoch (see _t_i_m_e(3)) as a floating - point value with micro-second granularity. Assignments to - EEPPOOCCHHRREEAALLTTIIMMEE are ignored. If EEPPOOCCHHRREEAALLTTIIMMEE is unset, it loses + point value with micro-second granularity. Assignments to + EEPPOOCCHHRREEAALLTTIIMMEE are ignored. If EEPPOOCCHHRREEAALLTTIIMMEE is unset, it loses its special properties, even if it is subsequently reset. EEPPOOCCHHSSEECCOONNDDSS Each time this parameter is referenced, it expands to the number - of seconds since the Unix Epoch (see _t_i_m_e(3)). Assignments to - EEPPOOCCHHSSEECCOONNDDSS are ignored. If EEPPOOCCHHSSEECCOONNDDSS is unset, it loses its - special properties, even if it is subsequently reset. + of seconds since the Unix Epoch (see _t_i_m_e(3)). Assignments to + EEPPOOCCHHSSEECCOONNDDSS are ignored. If EEPPOOCCHHSSEECCOONNDDSS is unset, it loses + its special properties, even if it is subsequently reset. EEUUIIDD Expands to the effective user ID of the current user, initial- - ized at shell startup. This variable is readonly. + ized at shell startup. This variable is readonly. FFUUNNCCNNAAMMEE An array variable containing the names of all shell functions - currently in the execution call stack. The element with index 0 - is the name of any currently-executing shell function. The bot- + currently in the execution call stack. The element with index 0 + is the name of any currently-executing shell function. The bot- tom-most element (the one with the highest index) is "main". This variable exists only when a shell function is executing. - Assignments to FFUUNNCCNNAAMMEE have no effect. If FFUUNNCCNNAAMMEE is unset, it - loses its special properties, even if it is subsequently reset. + Assignments to FFUUNNCCNNAAMMEE have no effect. If FFUUNNCCNNAAMMEE is unset, + it loses its special properties, even if it is subsequently re- + set. - This variable can be used with BBAASSHH__LLIINNEENNOO and BBAASSHH__SSOOUURRCCEE. Each - element of FFUUNNCCNNAAMMEE has corresponding elements in BBAASSHH__LLIINNEENNOO - and BBAASSHH__SSOOUURRCCEE to describe the call stack. For instance, - $${{FFUUNNCCNNAAMMEE[[_$_i]]}} was called from the file $${{BBAASSHH__SSOOUURRCCEE[[_$_i_+_1]]}} at - line number $${{BBAASSHH__LLIINNEENNOO[[_$_i]]}}. The ccaalllleerr builtin displays the - current call stack using this information. + This variable can be used with BBAASSHH__LLIINNEENNOO and BBAASSHH__SSOOUURRCCEE. + Each element of FFUUNNCCNNAAMMEE has corresponding elements in + BBAASSHH__LLIINNEENNOO and BBAASSHH__SSOOUURRCCEE to describe the call stack. For in- + stance, $${{FFUUNNCCNNAAMMEE[[_$_i]]}} was called from the file + $${{BBAASSHH__SSOOUURRCCEE[[_$_i_+_1]]}} at line number $${{BBAASSHH__LLIINNEENNOO[[_$_i]]}}. The + ccaalllleerr builtin displays the current call stack using this infor- + mation. GGRROOUUPPSS An array variable containing the list of groups of which the - current user is a member. Assignments to GGRROOUUPPSS have no effect. + current user is a member. Assignments to GGRROOUUPPSS have no effect. If GGRROOUUPPSS is unset, it loses its special properties, even if it is subsequently reset. HHIISSTTCCMMDD The history number, or index in the history list, of the current - command. Assignments to HHIISSTTCCMMDD are ignored. If HHIISSTTCCMMDD is un- + command. Assignments to HHIISSTTCCMMDD are ignored. If HHIISSTTCCMMDD is un- set, it loses its special properties, even if it is subsequently reset. HHOOSSTTNNAAMMEE Automatically set to the name of the current host. HHOOSSTTTTYYPPEE Automatically set to a string that uniquely describes the type - of machine on which bbaasshh is executing. The default is system-de- - pendent. + of machine on which bbaasshh is executing. The default is system- + dependent. LLIINNEENNOO Each time this parameter is referenced, the shell substitutes a decimal number representing the current sequential line number - (starting with 1) within a script or function. When not in a + (starting with 1) within a script or function. When not in a script or function, the value substituted is not guaranteed to - be meaningful. If LLIINNEENNOO is unset, it loses its special proper- + be meaningful. If LLIINNEENNOO is unset, it loses its special proper- ties, even if it is subsequently reset. MMAACCHHTTYYPPEE Automatically set to a string that fully describes the system type on which bbaasshh is executing, in the standard GNU _c_p_u_-_c_o_m_- - _p_a_n_y_-_s_y_s_t_e_m format. The default is system-dependent. + _p_a_n_y_-_s_y_s_t_e_m format. The default is system-dependent. MMAAPPFFIILLEE An array variable (see AArrrraayyss below) created to hold the text read by the mmaappffiillee builtin when no variable name is supplied. @@ -1057,15 +1063,17 @@ PPAARRAAMMEETTEERRSS OOPPTTIINNDD The index of the next argument to be processed by the ggeettooppttss builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). OOSSTTYYPPEE Automatically set to a string that describes the operating sys- - tem on which bbaasshh is executing. The default is system-dependent. + tem on which bbaasshh is executing. The default is system-depen- + dent. PPIIPPEESSTTAATTUUSS - An array variable (see AArrrraayyss below) containing a list of exit - status values from the processes in the most-recently-executed + An array variable (see AArrrraayyss below) containing a list of exit + status values from the processes in the most-recently-executed foreground pipeline (which may contain only a single command). - PPPPIIDD The process ID of the shell's parent. This variable is readonly. + PPPPIIDD The process ID of the shell's parent. This variable is read- + only. PPWWDD The current working directory as set by the ccdd command. RRAANNDDOOMM Each time this parameter is referenced, it expands to a random - integer between 0 and 32767. Assigning a value to RRAANNDDOOMM ini- + integer between 0 and 32767. Assigning a value to RRAANNDDOOMM ini- tializes (seeds) the sequence of random numbers. If RRAANNDDOOMM is unset, it loses its special properties, even if it is subse- quently reset. @@ -1088,21 +1096,21 @@ PPAARRAAMMEETTEERRSS no arguments are supplied. SSEECCOONNDDSS Each time this parameter is referenced, it expands to the number - of seconds since shell invocation. If a value is assigned to + of seconds since shell invocation. If a value is assigned to SSEECCOONNDDSS, the value returned upon subsequent references is the number of seconds since the assignment plus the value assigned. The number of seconds at shell invocation and the current time - are always determined by querying the system clock. If SSEECCOONNDDSS + are always determined by querying the system clock. If SSEECCOONNDDSS is unset, it loses its special properties, even if it is subse- quently reset. SSHHEELLLLOOPPTTSS - A colon-separated list of enabled shell options. Each word in + A colon-separated list of enabled shell options. Each word in the list is a valid argument for the --oo option to the sseett - builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). The options - appearing in SSHHEELLLLOOPPTTSS are those reported as _o_n by sseett --oo. If + builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). The options + appearing in SSHHEELLLLOOPPTTSS are those reported as _o_n by sseett --oo. If this variable is in the environment when bbaasshh starts up, each shell option in the list will be enabled before reading any - startup files. This variable is read-only. + startup files. This variable is read-only. SSHHLLVVLL Incremented by one each time an instance of bbaasshh is started. SSRRAANNDDOOMM This variable expands to a 32-bit pseudo-random number each time @@ -1110,65 +1118,65 @@ PPAARRAAMMEETTEERRSS systems that support /dev/urandom or _a_r_c_4_r_a_n_d_o_m, so each re- turned number has no relationship to the numbers preceding it. The random number generator cannot be seeded, so assignments to - this variable have no effect. If SSRRAANNDDOOMM is unset, it loses its + this variable have no effect. If SSRRAANNDDOOMM is unset, it loses its special properties, even if it is subsequently reset. UUIIDD Expands to the user ID of the current user, initialized at shell - startup. This variable is readonly. + startup. This variable is readonly. - The following variables are used by the shell. In some cases, bbaasshh as- + The following variables are used by the shell. In some cases, bbaasshh as- signs a default value to a variable; these cases are noted below. BBAASSHH__CCOOMMPPAATT - The value is used to set the shell's compatibility level. See + The value is used to set the shell's compatibility level. See SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE below for a description of the various - compatibility levels and their effects. The value may be a deci- - mal number (e.g., 4.2) or an integer (e.g., 42) corresponding to - the desired compatibility level. If BBAASSHH__CCOOMMPPAATT is unset or set - to the empty string, the compatibility level is set to the de- - fault for the current version. If BBAASSHH__CCOOMMPPAATT is set to a value - that is not one of the valid compatibility levels, the shell - prints an error message and sets the compatibility level to the - default for the current version. The valid values correspond to - the compatibility levels described below under SSHHEELLLL CCOOMMPPAATTIIBBIILL-- - IITTYY MMOODDEE. For example, 4.2 and 42 are valid values that corre- - spond to the ccoommppaatt4422 sshhoopptt option and set the compatibility - level to 42. The current version is also a valid value. + compatibility levels and their effects. The value may be a dec- + imal number (e.g., 4.2) or an integer (e.g., 42) corresponding + to the desired compatibility level. If BBAASSHH__CCOOMMPPAATT is unset or + set to the empty string, the compatibility level is set to the + default for the current version. If BBAASSHH__CCOOMMPPAATT is set to a + value that is not one of the valid compatibility levels, the + shell prints an error message and sets the compatibility level + to the default for the current version. The valid values corre- + spond to the compatibility levels described below under SSHHEELLLL + CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE. For example, 4.2 and 42 are valid values + that correspond to the ccoommppaatt4422 sshhoopptt option and set the compat- + ibility level to 42. The current version is also a valid value. BBAASSHH__EENNVV If this parameter is set when bbaasshh is executing a shell script, its value is interpreted as a filename containing commands to - initialize the shell, as in _~_/_._b_a_s_h_r_c. The value of BBAASSHH__EENNVV is + initialize the shell, as in _~_/_._b_a_s_h_r_c. The value of BBAASSHH__EENNVV is subjected to parameter expansion, command substitution, and arithmetic expansion before being interpreted as a filename. PPAATTHH is not used to search for the resultant filename. BBAASSHH__XXTTRRAACCEEFFDD If set to an integer corresponding to a valid file descriptor, bbaasshh will write the trace output generated when _s_e_t _-_x is en- - abled to that file descriptor. The file descriptor is closed - when BBAASSHH__XXTTRRAACCEEFFDD is unset or assigned a new value. Unsetting + abled to that file descriptor. The file descriptor is closed + when BBAASSHH__XXTTRRAACCEEFFDD is unset or assigned a new value. Unsetting BBAASSHH__XXTTRRAACCEEFFDD or assigning it the empty string causes the trace - output to be sent to the standard error. Note that setting + output to be sent to the standard error. Note that setting BBAASSHH__XXTTRRAACCEEFFDD to 2 (the standard error file descriptor) and then unsetting it will result in the standard error being closed. - CCDDPPAATTHH The search path for the ccdd command. This is a colon-separated + CCDDPPAATTHH The search path for the ccdd command. This is a colon-separated list of directories in which the shell looks for destination di- - rectories specified by the ccdd command. A sample value is + rectories specified by the ccdd command. A sample value is ".:~:/usr". CCHHIILLDD__MMAAXX Set the number of exited child status values for the shell to - remember. BBaasshh will not allow this value to be decreased below a - POSIX-mandated minimum, and there is a maximum value (currently - 8192) that this may not exceed. The minimum value is system-de- - pendent. + remember. BBaasshh will not allow this value to be decreased below + a POSIX-mandated minimum, and there is a maximum value (cur- + rently 8192) that this may not exceed. The minimum value is + system-dependent. CCOOLLUUMMNNSS Used by the sseelleecctt compound command to determine the terminal - width when printing selection lists. Automatically set if the + width when printing selection lists. Automatically set if the cchheecckkwwiinnssiizzee option is enabled or in an interactive shell upon receipt of a SSIIGGWWIINNCCHH. CCOOMMPPRREEPPLLYY An array variable from which bbaasshh reads the possible completions generated by a shell function invoked by the programmable com- - pletion facility (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). Each array - element contains one possible completion. + pletion facility (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn below). Each ar- + ray element contains one possible completion. EEMMAACCSS If bbaasshh finds this variable in the environment when the shell starts with value "t", it assumes that the shell is running in an Emacs shell buffer and disables line editing. @@ -1177,20 +1185,20 @@ PPAARRAAMMEETTEERRSS EEXXEECCIIGGNNOORREE A colon-separated list of shell patterns (see PPaatttteerrnn MMaattcchhiinngg) defining the list of filenames to be ignored by command search - using PPAATTHH. Files whose full pathnames match one of these pat- + using PPAATTHH. Files whose full pathnames match one of these pat- terns are not considered executable files for the purposes of - completion and command execution via PPAATTHH lookup. This does not - affect the behavior of the [[, tteesstt, and [[[[ commands. Full path- + completion and command execution via PPAATTHH lookup. This does not + affect the behavior of the [[, tteesstt, and [[[[ commands. Full path- names in the command hash table are not subject to EEXXEECCIIGGNNOORREE. Use this variable to ignore shared library files that have the - executable bit set, but are not executable files. The pattern + executable bit set, but are not executable files. The pattern matching honors the setting of the eexxttgglloobb shell option. FFCCEEDDIITT The default editor for the ffcc builtin command. FFIIGGNNOORREE A colon-separated list of suffixes to ignore when performing - filename completion (see RREEAADDLLIINNEE below). A filename whose suf- + filename completion (see RREEAADDLLIINNEE below). A filename whose suf- fix matches one of the entries in FFIIGGNNOORREE is excluded from the - list of matched filenames. A sample value is ".o:~". + list of matched filenames. A sample value is ".o:~". FFUUNNCCNNEESSTT If set to a numeric value greater than 0, defines a maximum function nesting level. Function invocations that exceed this @@ -1201,31 +1209,31 @@ PPAARRAAMMEETTEERRSS matched by a pathname expansion pattern also matches one of the patterns in GGLLOOBBIIGGNNOORREE, it is removed from the list of matches. GGLLOOBBSSOORRTT - Control how the results of pathname expansion are sorted. The + Control how the results of pathname expansion are sorted. The value of this variable specifies the sort criteria and sort or- - der for the results of pathname expansion. If this variable is + der for the results of pathname expansion. If this variable is unset or set to the null string, pathname expansion uses the - historial behavior of sorting by name. If set, a valid value be- - gins with an optional _+, which is ignored, or _-, which reverses - the sort order from ascending to descending, followed by a sort - specifier. The valid sort specifiers are _n_a_m_e, _s_i_z_e, _m_t_i_m_e, - _a_t_i_m_e, _c_t_i_m_e, and _b_l_o_c_k_s, which sort the files on name, file - size, modification time, access time, inode change time, and - number of blocks, respectively. For example, a value of _-_m_t_i_m_e - sorts the results in descending order by modification time (new- - est first). A sort specifier of _n_o_s_o_r_t disables sorting com- - pletely; the results are returned in the order they are read - from the file system,. If the sort specifier is missing, it de- - faults to _n_a_m_e, so a value of _+ is equivalent to the null - string, and a value of _- sorts by name in descending order. Any + historial behavior of sorting by name. If set, a valid value + begins with an optional _+, which is ignored, or _-, which re- + verses the sort order from ascending to descending, followed by + a sort specifier. The valid sort specifiers are _n_a_m_e, _s_i_z_e, + _m_t_i_m_e, _a_t_i_m_e, _c_t_i_m_e, and _b_l_o_c_k_s, which sort the files on name, + file size, modification time, access time, inode change time, + and number of blocks, respectively. For example, a value of + _-_m_t_i_m_e sorts the results in descending order by modification + time (newest first). A sort specifier of _n_o_s_o_r_t disables sort- + ing completely; the results are returned in the order they are + read from the file system,. If the sort specifier is missing, + it defaults to _n_a_m_e, so a value of _+ is equivalent to the null + string, and a value of _- sorts by name in descending order. Any invalid value restores the historical sorting behavior. HHIISSTTCCOONNTTRROOLL A colon-separated list of values controlling how commands are - saved on the history list. If the list of values includes _i_g_- + saved on the history list. If the list of values includes _i_g_- _n_o_r_e_s_p_a_c_e, lines which begin with a ssppaaccee character are not - saved in the history list. A value of _i_g_n_o_r_e_d_u_p_s causes lines - matching the previous history entry to not be saved. A value of - _i_g_n_o_r_e_b_o_t_h is shorthand for _i_g_n_o_r_e_s_p_a_c_e and _i_g_n_o_r_e_d_u_p_s. A value + saved in the history list. A value of _i_g_n_o_r_e_d_u_p_s causes lines + matching the previous history entry to not be saved. A value of + _i_g_n_o_r_e_b_o_t_h is shorthand for _i_g_n_o_r_e_s_p_a_c_e and _i_g_n_o_r_e_d_u_p_s. A value of _e_r_a_s_e_d_u_p_s causes all previous lines matching the current line to be removed from the history list before that line is saved. Any value not in the above list is ignored. If HHIISSTTCCOONNTTRROOLL is @@ -1236,49 +1244,49 @@ PPAARRAAMMEETTEERRSS regardless of the value of HHIISSTTCCOONNTTRROOLL. HHIISSTTFFIILLEE The name of the file in which command history is saved (see HHIISS-- - TTOORRYY below). BBaasshh assigns a default value of _~_/_._b_a_s_h___h_i_s_t_o_r_y. If - HHIISSTTFFIILLEE is unset or null, the command history is not saved when - a shell exits. + TTOORRYY below). BBaasshh assigns a default value of _~_/_._b_a_s_h___h_i_s_t_o_r_y. + If HHIISSTTFFIILLEE is unset or null, the command history is not saved + when a shell exits. HHIISSTTFFIILLEESSIIZZEE The maximum number of lines contained in the history file. When this variable is assigned a value, the history file is trun- cated, if necessary, to contain no more than that number of - lines by removing the oldest entries. The history file is also - truncated to this size after writing it when a shell exits. If - the value is 0, the history file is truncated to zero size. Non- - numeric values and numeric values less than zero inhibit trunca- - tion. The shell sets the default value to the value of HHIISSTTSSIIZZEE - after reading any startup files. + lines by removing the oldest entries. The history file is also + truncated to this size after writing it when a shell exits. If + the value is 0, the history file is truncated to zero size. + Non-numeric values and numeric values less than zero inhibit + truncation. The shell sets the default value to the value of + HHIISSTTSSIIZZEE after reading any startup files. HHIISSTTIIGGNNOORREE A colon-separated list of patterns used to decide which command - lines should be saved on the history list. Each pattern is an- + lines should be saved on the history list. Each pattern is an- chored at the beginning of the line and must match the complete line (no implicit `**' is appended). Each pattern is tested against the line after the checks specified by HHIISSTTCCOONNTTRROOLL are applied. In addition to the normal shell pattern matching char- - acters, `&&' matches the previous history line. `&&' may be es- + acters, `&&' matches the previous history line. `&&' may be es- caped using a backslash; the backslash is removed before at- - tempting a match. The second and subsequent lines of a multi- + tempting a match. The second and subsequent lines of a multi- line compound command are not tested, and are added to the his- - tory regardless of the value of HHIISSTTIIGGNNOORREE. The pattern matching - honors the setting of the eexxttgglloobb shell option. + tory regardless of the value of HHIISSTTIIGGNNOORREE. The pattern match- + ing honors the setting of the eexxttgglloobb shell option. HHIISSTTSSIIZZEE The number of commands to remember in the command history (see - HHIISSTTOORRYY below). If the value is 0, commands are not saved in the - history list. Numeric values less than zero result in every com- - mand being saved on the history list (there is no limit). The - shell sets the default value to 500 after reading any startup - files. + HHIISSTTOORRYY below). If the value is 0, commands are not saved in + the history list. Numeric values less than zero result in every + command being saved on the history list (there is no limit). + The shell sets the default value to 500 after reading any + startup files. HHIISSTTTTIIMMEEFFOORRMMAATT If this variable is set and not null, its value is used as a format string for _s_t_r_f_t_i_m_e(3) to print the time stamp associated - with each history entry displayed by the hhiissttoorryy builtin. If + with each history entry displayed by the hhiissttoorryy builtin. If this variable is set, time stamps are written to the history file so they may be preserved across shell sessions. This uses the history comment character to distinguish timestamps from other history lines. HHOOMMEE The home directory of the current user; the default argument for - the ccdd builtin command. The value of this variable is also used + the ccdd builtin command. The value of this variable is also used when performing tilde expansion. HHOOSSTTFFIILLEE Contains the name of a file in the same format as _/_e_t_c_/_h_o_s_t_s @@ -1286,130 +1294,131 @@ PPAARRAAMMEETTEERRSS The list of possible hostname completions may be changed while the shell is running; the next time hostname completion is at- tempted after the value is changed, bbaasshh adds the contents of - the new file to the existing list. If HHOOSSTTFFIILLEE is set, but has + the new file to the existing list. If HHOOSSTTFFIILLEE is set, but has no value, or does not name a readable file, bbaasshh attempts to read _/_e_t_c_/_h_o_s_t_s to obtain the list of possible hostname comple- - tions. When HHOOSSTTFFIILLEE is unset, the hostname list is cleared. + tions. When HHOOSSTTFFIILLEE is unset, the hostname list is cleared. IIFFSS The _I_n_t_e_r_n_a_l _F_i_e_l_d _S_e_p_a_r_a_t_o_r that is used for word splitting af- ter expansion and to split lines into words with the rreeaadd - builtin command. The default value is ``''. + builtin command. The default value is ``''. IIGGNNOORREEEEOOFF Controls the action of an interactive shell on receipt of an EEOOFF - character as the sole input. If set, the value is the number of - consecutive EEOOFF characters which must be typed as the first - characters on an input line before bbaasshh exits. If the variable - exists but does not have a numeric value, or has no value, the - default value is 10. If it does not exist, EEOOFF signifies the end - of input to the shell. + character as the sole input. If set, the value is the number of + consecutive EEOOFF characters which must be typed as the first + characters on an input line before bbaasshh exits. If the variable + exists but does not have a numeric value, or has no value, the + default value is 10. If it does not exist, EEOOFF signifies the + end of input to the shell. IINNPPUUTTRRCC - The filename for the rreeaaddlliinnee startup file, overriding the de- + The filename for the rreeaaddlliinnee startup file, overriding the de- fault of _~_/_._i_n_p_u_t_r_c (see RREEAADDLLIINNEE below). IINNSSIIDDEE__EEMMAACCSS - If this variable appears in the environment when the shell - starts, bbaasshh assumes that it is running inside an Emacs shell - buffer and may disable line editing, depending on the value of + If this variable appears in the environment when the shell + starts, bbaasshh assumes that it is running inside an Emacs shell + buffer and may disable line editing, depending on the value of TTEERRMM. - LLAANNGG Used to determine the locale category for any category not + LLAANNGG Used to determine the locale category for any category not specifically selected with a variable starting with LLCC__. - LLCC__AALLLL This variable overrides the value of LLAANNGG and any other LLCC__ + LLCC__AALLLL This variable overrides the value of LLAANNGG and any other LLCC__ variable specifying a locale category. LLCC__CCOOLLLLAATTEE - This variable determines the collation order used when sorting - the results of pathname expansion, and determines the behavior - of range expressions, equivalence classes, and collating se- + This variable determines the collation order used when sorting + the results of pathname expansion, and determines the behavior + of range expressions, equivalence classes, and collating se- quences within pathname expansion and pattern matching. LLCC__CCTTYYPPEE - This variable determines the interpretation of characters and - the behavior of character classes within pathname expansion and + This variable determines the interpretation of characters and + the behavior of character classes within pathname expansion and pattern matching. LLCC__MMEESSSSAAGGEESS - This variable determines the locale used to translate double- + This variable determines the locale used to translate double- quoted strings preceded by a $$. LLCC__NNUUMMEERRIICC - This variable determines the locale category used for number + This variable determines the locale category used for number formatting. LLCC__TTIIMMEE - This variable determines the locale category used for data and + This variable determines the locale category used for data and time formatting. - LLIINNEESS Used by the sseelleecctt compound command to determine the column - length for printing selection lists. Automatically set if the - cchheecckkwwiinnssiizzee option is enabled or in an interactive shell upon + LLIINNEESS Used by the sseelleecctt compound command to determine the column + length for printing selection lists. Automatically set if the + cchheecckkwwiinnssiizzee option is enabled or in an interactive shell upon receipt of a SSIIGGWWIINNCCHH. - MMAAIILL If this parameter is set to a file or directory name and the - MMAAIILLPPAATTHH variable is not set, bbaasshh informs the user of the ar- + MMAAIILL If this parameter is set to a file or directory name and the + MMAAIILLPPAATTHH variable is not set, bbaasshh informs the user of the ar- rival of mail in the specified file or Maildir-format directory. MMAAIILLCCHHEECCKK - Specifies how often (in seconds) bbaasshh checks for mail. The de- - fault is 60 seconds. When it is time to check for mail, the - shell does so before displaying the primary prompt. If this - variable is unset, or set to a value that is not a number + Specifies how often (in seconds) bbaasshh checks for mail. The de- + fault is 60 seconds. When it is time to check for mail, the + shell does so before displaying the primary prompt. If this + variable is unset, or set to a value that is not a number greater than or equal to zero, the shell disables mail checking. MMAAIILLPPAATTHH - A colon-separated list of filenames to be checked for mail. The + A colon-separated list of filenames to be checked for mail. The message to be printed when mail arrives in a particular file may - be specified by separating the filename from the message with a - `?'. When used in the text of the message, $$__ expands to the - name of the current mailfile. Example: + be specified by separating the filename from the message with a + `?'. When used in the text of the message, $$__ expands to the + name of the current mailfile. Example: MMAAIILLPPAATTHH='/var/mail/bfox?"You have mail":~/shell-mail?"$_ has mail!"' - BBaasshh can be configured to supply a default value for this vari- - able (there is no value by default), but the location of the + BBaasshh can be configured to supply a default value for this vari- + able (there is no value by default), but the location of the user mail files that it uses is system dependent (e.g., /var/mail/$$UUSSEERR). OOPPTTEERRRR If set to the value 1, bbaasshh displays error messages generated by - the ggeettooppttss builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). - OOPPTTEERRRR is initialized to 1 each time the shell is invoked or a + the ggeettooppttss builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). + OOPPTTEERRRR is initialized to 1 each time the shell is invoked or a shell script is executed. - PPAATTHH The search path for commands. It is a colon-separated list of - directories in which the shell looks for commands (see CCOOMMMMAANNDD - EEXXEECCUUTTIIOONN below). A zero-length (null) directory name in the - value of PPAATTHH indicates the current directory. A null directory - name may appear as two adjacent colons, or as an initial or - trailing colon. The default path is system-dependent, and is set - by the administrator who installs bbaasshh. A common value is + PPAATTHH The search path for commands. It is a colon-separated list of + directories in which the shell looks for commands (see CCOOMMMMAANNDD + EEXXEECCUUTTIIOONN below). A zero-length (null) directory name in the + value of PPAATTHH indicates the current directory. A null directory + name may appear as two adjacent colons, or as an initial or + trailing colon. The default path is system-dependent, and is + set by the administrator who installs bbaasshh. A common value is ``/usr/local/bin:/usr/lo- cal/sbin:/usr/bin:/usr/sbin:/bin:/sbin''. PPOOSSIIXXLLYY__CCOORRRREECCTT - If this variable is in the environment when bbaasshh starts, the - shell enters _p_o_s_i_x _m_o_d_e before reading the startup files, as if - the ----ppoossiixx invocation option had been supplied. If it is set - while the shell is running, bbaasshh enables _p_o_s_i_x _m_o_d_e, as if the - command _s_e_t _-_o _p_o_s_i_x had been executed. When the shell enters + If this variable is in the environment when bbaasshh starts, the + shell enters _p_o_s_i_x _m_o_d_e before reading the startup files, as if + the ----ppoossiixx invocation option had been supplied. If it is set + while the shell is running, bbaasshh enables _p_o_s_i_x _m_o_d_e, as if the + command _s_e_t _-_o _p_o_s_i_x had been executed. When the shell enters _p_o_s_i_x _m_o_d_e, it sets this variable if it was not already set. PPRROOMMPPTT__CCOOMMMMAANNDD - If this variable is set, and is an array, the value of each set - element is executed as a command prior to issuing each primary - prompt. If this is set but not an array variable, its value is + If this variable is set, and is an array, the value of each set + element is executed as a command prior to issuing each primary + prompt. If this is set but not an array variable, its value is used as a command to execute instead. PPRROOMMPPTT__DDIIRRTTRRIIMM - If set to a number greater than zero, the value is used as the + If set to a number greater than zero, the value is used as the number of trailing directory components to retain when expanding - the \\ww and \\WW prompt string escapes (see PPRROOMMPPTTIINNGG below). Char- - acters removed are replaced with an ellipsis. - PPSS00 The value of this parameter is expanded (see PPRROOMMPPTTIINNGG below) - and displayed by interactive shells after reading a command and + the \\ww and \\WW prompt string escapes (see PPRROOMMPPTTIINNGG below). + Characters removed are replaced with an ellipsis. + PPSS00 The value of this parameter is expanded (see PPRROOMMPPTTIINNGG below) + and displayed by interactive shells after reading a command and before the command is executed. - PPSS11 The value of this parameter is expanded (see PPRROOMMPPTTIINNGG below) - and used as the primary prompt string. The default value is + PPSS11 The value of this parameter is expanded (see PPRROOMMPPTTIINNGG below) + and used as the primary prompt string. The default value is ``\\ss--\\vv\\$$ ''. - PPSS22 The value of this parameter is expanded as with PPSS11 and used as - the secondary prompt string. The default is ``>> ''. + PPSS22 The value of this parameter is expanded as with PPSS11 and used as + the secondary prompt string. The default is ``>> ''. PPSS33 The value of this parameter is used as the prompt for the sseelleecctt command (see SSHHEELLLL GGRRAAMMMMAARR above). - PPSS44 The value of this parameter is expanded as with PPSS11 and the + PPSS44 The value of this parameter is expanded as with PPSS11 and the value is printed before each command bbaasshh displays during an ex- - ecution trace. The first character of the expanded value of PPSS44 + ecution trace. The first character of the expanded value of PPSS44 is replicated multiple times, as necessary, to indicate multiple - levels of indirection. The default is ``++ ''. - SSHHEELLLL This variable expands to the full pathname to the shell. If it - is not set when the shell starts, bbaasshh assigns to it the full + levels of indirection. The default is ``++ ''. + SSHHEELLLL This variable expands to the full pathname to the shell. If it + is not set when the shell starts, bbaasshh assigns to it the full pathname of the current user's login shell. TTIIMMEEFFOORRMMAATT - The value of this parameter is used as a format string specify- - ing how the timing information for pipelines prefixed with the - ttiimmee reserved word should be displayed. The %% character intro- - duces an escape sequence that is expanded to a time value or - other information. The escape sequences and their meanings are + The value of this parameter is used as a format string specify- + ing how the timing information for pipelines prefixed with the + ttiimmee reserved word should be displayed. The %% character intro- + duces 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. %%%% A literal %%. %%[[_p]][[ll]]RR The elapsed time in seconds. @@ -1417,238 +1426,238 @@ PPAARRAAMMEETTEERRSS %%[[_p]][[ll]]SS The number of CPU seconds spent in system mode. %%PP The CPU percentage, computed as (%U + %S) / %R. - The optional _p is a digit specifying the _p_r_e_c_i_s_i_o_n, the number - of fractional digits after a decimal point. A value of 0 causes - no decimal point or fraction to be output. At most six places - after the decimal point may be specified; values of _p greater - than 6 are changed to 6. If _p is not specified, the value 3 is + The optional _p is a digit specifying the _p_r_e_c_i_s_i_o_n, the number + of fractional digits after a decimal point. A value of 0 causes + no decimal point or fraction to be output. At most six places + after the decimal point may be specified; values of _p greater + than 6 are changed to 6. If _p is not specified, the value 3 is used. - The optional ll specifies a longer format, including minutes, of - the form _M_Mm_S_S._F_Fs. The value of _p determines whether or not the - fraction is included. + The optional ll specifies a longer format, including minutes, of + the form _M_Mm_S_S._F_Fs. The value of _p determines whether or not + the fraction is included. - If this variable is not set, bbaasshh acts as if it had the value - $$''\\nnrreeaall\\tt%%33llRR\\nnuusseerr\\tt%%33llUU\\nnssyyss\\tt%%33llSS''. If the value is null, - bbaasshh does not display any timing information. A trailing newline - is added when the format string is displayed. + If this variable is not set, bbaasshh acts as if it had the value + $$''\\nnrreeaall\\tt%%33llRR\\nnuusseerr\\tt%%33llUU\\nnssyyss\\tt%%33llSS''. If the value is null, + bbaasshh does not display any timing information. A trailing new- + line is added when the format string is displayed. TTMMOOUUTT If set to a value greater than zero, TTMMOOUUTT is treated as the de- - fault timeout for the rreeaadd builtin. The sseelleecctt command termi- + fault timeout for the rreeaadd builtin. The sseelleecctt command termi- nates if input does not arrive after TTMMOOUUTT seconds when input is - coming from a terminal. In an interactive shell, the value is + coming from a terminal. In an interactive shell, the value is interpreted as the number of seconds to wait for a line of input - after issuing the primary prompt. BBaasshh terminates after waiting - for that number of seconds if a complete line of input does not + after issuing the primary prompt. BBaasshh terminates after waiting + for that number of seconds if a complete line of input does not arrive. - TTMMPPDDIIRR If set, bbaasshh uses its value as the name of a directory in which + TTMMPPDDIIRR If set, bbaasshh uses its value as the name of a directory in which bbaasshh creates temporary files for the shell's use. aauuttoo__rreessuummee This variable controls how the shell interacts with the user and - job control. If this variable is set, single word simple com- + job control. If this variable is set, single word simple com- mands without redirections are treated as candidates for resump- - tion of an existing stopped job. There is no ambiguity allowed; - if there is more than one job beginning with the string typed, - the job most recently accessed is selected. The _n_a_m_e of a - stopped job, in this context, is the command line used to start - it. If set to the value _e_x_a_c_t, the string supplied must match - the name of a stopped job exactly; if set to _s_u_b_s_t_r_i_n_g, the - string supplied needs to match a substring of the name of a - stopped job. The _s_u_b_s_t_r_i_n_g value provides functionality analo- - gous to the %%?? job identifier (see JJOOBB CCOONNTTRROOLL below). If set to - any other value, the supplied string must be a prefix of a + tion of an existing stopped job. There is no ambiguity allowed; + if there is more than one job beginning with the string typed, + the job most recently accessed is selected. The _n_a_m_e of a + stopped job, in this context, is the command line used to start + it. If set to the value _e_x_a_c_t, the string supplied must match + the name of a stopped job exactly; if set to _s_u_b_s_t_r_i_n_g, the + string supplied needs to match a substring of the name of a + stopped job. The _s_u_b_s_t_r_i_n_g value provides functionality analo- + gous to the %%?? job identifier (see JJOOBB CCOONNTTRROOLL below). If set + to any other value, the supplied string must be a prefix of a stopped job's name; this provides functionality analogous to the %%_s_t_r_i_n_g job identifier. hhiissttcchhaarrss - The two or three characters which control history expansion and - tokenization (see HHIISSTTOORRYY EEXXPPAANNSSIIOONN below). The first character - is the _h_i_s_t_o_r_y _e_x_p_a_n_s_i_o_n character, the character which signals - the start of a history expansion, normally `!!'. The second char- - acter is the _q_u_i_c_k _s_u_b_s_t_i_t_u_t_i_o_n character, which is used as - shorthand for re-running the previous command entered, substi- - tuting one string for another in the command. The default is - `^^'. The optional third character is the character which indi- - cates that the remainder of the line is a comment when found as - the first character of a word, normally `##'. The history comment - character causes history substitution to be skipped for the re- - maining words on the line. It does not necessarily cause the + The two or three characters which control history expansion and + tokenization (see HHIISSTTOORRYY EEXXPPAANNSSIIOONN below). The first character + is the _h_i_s_t_o_r_y _e_x_p_a_n_s_i_o_n character, the character which signals + the start of a history expansion, normally `!!'. The second + character is the _q_u_i_c_k _s_u_b_s_t_i_t_u_t_i_o_n character, which is used as + shorthand for re-running the previous command entered, substi- + tuting one string for another in the command. The default is + `^^'. The optional third character is the character which indi- + cates that the remainder of the line is a comment when found as + the first character of a word, normally `##'. The history com- + ment 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. AArrrraayyss - BBaasshh provides one-dimensional indexed and associative array variables. - Any variable may be used as an indexed array; the ddeeccllaarree builtin will - explicitly declare an array. There is no maximum limit on the size of - an array, nor any requirement that members be indexed or assigned con- - tiguously. Indexed arrays are referenced using integers (including + BBaasshh provides one-dimensional indexed and associative array variables. + Any variable may be used as an indexed array; the ddeeccllaarree builtin will + explicitly declare an array. There is no maximum limit on the size of + an array, nor any requirement that members be indexed or assigned con- + tiguously. Indexed arrays are referenced using integers (including arithmetic expressions) and are zero-based; associative arrays are ref- - erenced using arbitrary strings. Unless otherwise noted, indexed array + erenced using arbitrary strings. Unless otherwise noted, indexed array indices must be non-negative integers. - An indexed array is created automatically if any variable is assigned - to using the syntax _n_a_m_e[_s_u_b_s_c_r_i_p_t]=_v_a_l_u_e. The _s_u_b_s_c_r_i_p_t is treated as - an arithmetic expression that must evaluate to a number. To explicitly - declare an indexed array, use ddeeccllaarree --aa _n_a_m_e (see SSHHEELLLL BBUUIILLTTIINN CCOOMM-- - MMAANNDDSS below). ddeeccllaarree --aa _n_a_m_e[[_s_u_b_s_c_r_i_p_t]] is also accepted; the _s_u_b_- + An indexed array is created automatically if any variable is assigned + to using the syntax _n_a_m_e[_s_u_b_s_c_r_i_p_t]=_v_a_l_u_e. The _s_u_b_s_c_r_i_p_t is treated as + an arithmetic expression that must evaluate to a number. To explicitly + declare an indexed array, use ddeeccllaarree --aa _n_a_m_e (see SSHHEELLLL BBUUIILLTTIINN CCOOMM-- + MMAANNDDSS below). ddeeccllaarree --aa _n_a_m_e[[_s_u_b_s_c_r_i_p_t]] is also accepted; the _s_u_b_- _s_c_r_i_p_t is ignored. Associative arrays are created using ddeeccllaarree --AA _n_a_m_e. Attributes may be specified for an array variable using the ddeeccllaarree and - rreeaaddoonnllyy builtins. Each attribute applies to all members of an array. + rreeaaddoonnllyy builtins. Each attribute applies to all members of an array. - Arrays are assigned to using compound assignments of the form - _n_a_m_e=((value_1 ... value_n)), where each _v_a_l_u_e may be of the form [_s_u_b_- - _s_c_r_i_p_t]=_s_t_r_i_n_g. Indexed array assignments do not require anything but - _s_t_r_i_n_g. Each _v_a_l_u_e in the list is expanded using the shell expansions + Arrays are assigned to using compound assignments of the form + _n_a_m_e=((value_1 ... value_n)), where each _v_a_l_u_e may be of the form [_s_u_b_- + _s_c_r_i_p_t]=_s_t_r_i_n_g. Indexed array assignments do not require anything but + _s_t_r_i_n_g. Each _v_a_l_u_e in the list is expanded using the shell expansions described below under EEXXPPAANNSSIIOONN, but _v_a_l_u_es that are valid variable as- signments including the brackets and subscript do not undergo brace ex- - pansion and word splitting, as with individual variable assignments. - When assigning to indexed arrays, if the optional brackets and sub- - script are supplied, that index is assigned to; otherwise the index of - the element assigned is the last index assigned to by the statement - plus one. Indexing starts at zero. + pansion and word splitting, as with individual variable assignments. + When assigning to indexed arrays, if the optional brackets and sub- + script are supplied, that index is assigned to; otherwise the index of + the element assigned is the last index assigned to by the statement + plus one. Indexing starts at zero. When assigning to an associative array, the words in a compound assign- - ment may be either assignment statements, for which the subscript is - required, or a list of words that is interpreted as a sequence of al- - ternating keys and values: _n_a_m_e=(( _k_e_y_1 _v_a_l_u_e_1 _k_e_y_2 _v_a_l_u_e_2 ...)). These - are treated identically to _n_a_m_e=(( [_k_e_y_1]=_v_a_l_u_e_1 [_k_e_y_2]=_v_a_l_u_e_2 ...)). The - first word in the list determines how the remaining words are inter- - preted; all assignments in a list must be of the same type. When using - key/value pairs, the keys may not be missing or empty; a final missing - value is treated like the empty string. + ment may be either assignment statements, for which the subscript is + required, or a list of words that is interpreted as a sequence of al- + ternating keys and values: _n_a_m_e=(( _k_e_y_1 _v_a_l_u_e_1 _k_e_y_2 _v_a_l_u_e_2 ...)). These + are treated identically to _n_a_m_e=(( [_k_e_y_1]=_v_a_l_u_e_1 [_k_e_y_2]=_v_a_l_u_e_2 ...)). + The first word in the list determines how the remaining words are in- + terpreted; all assignments in a list must be of the same type. When + using key/value pairs, the keys may not be missing or empty; a final + missing value is treated like the empty string. - This syntax is also accepted by the ddeeccllaarree builtin. Individual array - elements may be assigned to using the _n_a_m_e[_s_u_b_s_c_r_i_p_t]=_v_a_l_u_e syntax in- - troduced above. When assigning to an indexed array, if _n_a_m_e is sub- - scripted by a negative number, that number is interpreted as relative - to one greater than the maximum index of _n_a_m_e, so negative indices + This syntax is also accepted by the ddeeccllaarree builtin. Individual array + elements may be assigned to using the _n_a_m_e[_s_u_b_s_c_r_i_p_t]=_v_a_l_u_e syntax in- + troduced above. When assigning to an indexed array, if _n_a_m_e is sub- + scripted by a negative number, that number is interpreted as relative + to one greater than the maximum index of _n_a_m_e, so negative indices count back from the end of the array, and an index of -1 references the last element. - The += operator will append to an array variable when assigning using + The += operator will append to an array variable when assigning using the compound assignment syntax; see PPAARRAAMMEETTEERRSS above. - Any element of an array may be referenced using ${_n_a_m_e[_s_u_b_s_c_r_i_p_t]}. The - braces are required to avoid conflicts with pathname expansion. If _s_u_b_- - _s_c_r_i_p_t is @@ or **, the word expands to all members of _n_a_m_e, unless noted - in the description of a builtin or word expansion. These subscripts - differ only when the word appears within double quotes. If the word is - double-quoted, ${_n_a_m_e[*]} expands to a single word with the value of - each array member separated by the first character of the IIFFSS special - variable, and ${_n_a_m_e[@]} expands each element of _n_a_m_e to a separate - word. When there are no array members, ${_n_a_m_e[@]} expands to nothing. - If the double-quoted expansion occurs within a word, the expansion of - the first parameter is joined with the beginning part of the original - word, and the expansion of the last parameter is joined with the last - part of the original word. This is analogous to the expansion of the - special parameters ** and @@ (see SSppeecciiaall PPaarraammeetteerrss above). ${#_n_a_m_e[_s_u_b_- - _s_c_r_i_p_t]} expands to the length of ${_n_a_m_e[_s_u_b_s_c_r_i_p_t]}. If _s_u_b_s_c_r_i_p_t is ** - or @@, the expansion is the number of elements in the array. If the _s_u_b_- - _s_c_r_i_p_t used to reference an element of an indexed array evaluates to a - number less than zero, it is interpreted as relative to one greater - than the maximum index of the array, so negative indices count back - from the end of the array, and an index of -1 references the last ele- - ment. + Any element of an array may be referenced using ${_n_a_m_e[_s_u_b_s_c_r_i_p_t]}. + The braces are required to avoid conflicts with pathname expansion. If + _s_u_b_s_c_r_i_p_t is @@ or **, the word expands to all members of _n_a_m_e, unless + noted in the description of a builtin or word expansion. These sub- + scripts differ only when the word appears within double quotes. If the + word is double-quoted, ${_n_a_m_e[*]} expands to a single word with the + value of each array member separated by the first character of the IIFFSS + special variable, and ${_n_a_m_e[@]} expands each element of _n_a_m_e to a sep- + arate word. When there are no array members, ${_n_a_m_e[@]} expands to + nothing. If the double-quoted expansion occurs within a word, the ex- + pansion of the first parameter is joined with the beginning part of the + original word, and the expansion of the last parameter is joined with + the last part of the original word. This is analogous to the expansion + of the special parameters ** and @@ (see SSppeecciiaall PPaarraammeetteerrss above). + ${#_n_a_m_e[_s_u_b_s_c_r_i_p_t]} expands to the length of ${_n_a_m_e[_s_u_b_s_c_r_i_p_t]}. If + _s_u_b_s_c_r_i_p_t is ** or @@, the expansion is the number of elements in the ar- + ray. If the _s_u_b_s_c_r_i_p_t used to reference an element of an indexed array + evaluates to a number less than zero, it is interpreted as relative to + one greater than the maximum index of the array, so negative indices + count back from the end of the array, and an index of -1 references the + last element. Referencing an array variable without a subscript is equivalent to ref- - erencing the array with a subscript of 0. Any reference to a variable + erencing the array with a subscript of 0. Any reference to a variable using a valid subscript is valid, and bbaasshh will create an array if nec- essary. - An array variable is considered set if a subscript has been assigned a - value. The null string is a valid value. + An array variable is considered set if a subscript has been assigned a + value. The null string is a valid value. - It is possible to obtain the keys (indices) of an array as well as the - values. ${!!_n_a_m_e[_@]} and ${!!_n_a_m_e[_*]} expand to the indices assigned in - array variable _n_a_m_e. The treatment when in double quotes is similar to + It is possible to obtain the keys (indices) of an array as well as the + values. ${!!_n_a_m_e[_@]} and ${!!_n_a_m_e[_*]} expand to the indices assigned in + array variable _n_a_m_e. The treatment when in double quotes is similar to the expansion of the special parameters _@ and _* within double quotes. - The uunnsseett builtin is used to destroy arrays. uunnsseett _n_a_m_e[_s_u_b_s_c_r_i_p_t] de- + The uunnsseett builtin is used to destroy arrays. uunnsseett _n_a_m_e[_s_u_b_s_c_r_i_p_t] de- stroys the array element at index _s_u_b_s_c_r_i_p_t, for both indexed and asso- - ciative arrays. Negative subscripts to indexed arrays are interpreted - as described above. Unsetting the last element of an array variable - does not unset the variable. uunnsseett _n_a_m_e, where _n_a_m_e is an array, re- - moves the entire array. uunnsseett _n_a_m_e[_s_u_b_s_c_r_i_p_t], where _s_u_b_s_c_r_i_p_t is ** or + ciative arrays. Negative subscripts to indexed arrays are interpreted + as described above. Unsetting the last element of an array variable + does not unset the variable. uunnsseett _n_a_m_e, where _n_a_m_e is an array, re- + moves the entire array. uunnsseett _n_a_m_e[_s_u_b_s_c_r_i_p_t], where _s_u_b_s_c_r_i_p_t is ** or @@, behaves differently depending on whether _n_a_m_e is an indexed or asso- - ciative array. If _n_a_m_e is an associative array, this unsets the element - with subscript ** or @@. If _n_a_m_e is an indexed array, unset removes all - of the elements but does not remove the array itself. + ciative array. If _n_a_m_e is an associative array, this unsets the ele- + ment with subscript ** or @@. If _n_a_m_e is an indexed array, unset removes + all of the elements but does not remove the array itself. - When using a variable name with a subscript as an argument to a com- - mand, such as with uunnsseett, without using the word expansion syntax de- - scribed above, the argument is subject to pathname expansion. If path- + When using a variable name with a subscript as an argument to a com- + mand, such as with uunnsseett, without using the word expansion syntax de- + scribed above, the argument is subject to pathname expansion. If path- name expansion is not desired, the argument should be quoted. - The ddeeccllaarree, llooccaall, and rreeaaddoonnllyy builtins each accept a --aa option to - specify an indexed array and a --AA option to specify an associative ar- - ray. If both options are supplied, --AA takes precedence. The rreeaadd - builtin accepts a --aa option to assign a list of words read from the - standard input to an array. The sseett and ddeeccllaarree builtins display array + The ddeeccllaarree, llooccaall, and rreeaaddoonnllyy builtins each accept a --aa option to + specify an indexed array and a --AA option to specify an associative ar- + ray. If both options are supplied, --AA takes precedence. The rreeaadd + builtin accepts a --aa option to assign a list of words read from the + standard input to an array. The sseett and ddeeccllaarree builtins display array values in a way that allows them to be reused as assignments. EEXXPPAANNSSIIOONN Expansion is performed on the command line after it has been split into - words. There are seven kinds of expansion performed: _b_r_a_c_e _e_x_p_a_n_s_i_o_n, - _t_i_l_d_e _e_x_p_a_n_s_i_o_n, _p_a_r_a_m_e_t_e_r _a_n_d _v_a_r_i_a_b_l_e _e_x_p_a_n_s_i_o_n, _c_o_m_m_a_n_d _s_u_b_s_t_i_t_u_- + words. There are seven kinds of expansion performed: _b_r_a_c_e _e_x_p_a_n_s_i_o_n, + _t_i_l_d_e _e_x_p_a_n_s_i_o_n, _p_a_r_a_m_e_t_e_r _a_n_d _v_a_r_i_a_b_l_e _e_x_p_a_n_s_i_o_n, _c_o_m_m_a_n_d _s_u_b_s_t_i_t_u_- _t_i_o_n, _a_r_i_t_h_m_e_t_i_c _e_x_p_a_n_s_i_o_n, _w_o_r_d _s_p_l_i_t_t_i_n_g, and _p_a_t_h_n_a_m_e _e_x_p_a_n_s_i_o_n. The order of expansions is: brace expansion; tilde expansion, parameter - and variable expansion, arithmetic expansion, and command substitution - (done in a left-to-right fashion); word splitting; and pathname expan- + and variable expansion, arithmetic expansion, and command substitution + (done in a left-to-right fashion); word splitting; and pathname expan- sion. On systems that can support it, there is an additional expansion avail- - able: _p_r_o_c_e_s_s _s_u_b_s_t_i_t_u_t_i_o_n. This is performed at the same time as - tilde, parameter, variable, and arithmetic expansion and command sub- + able: _p_r_o_c_e_s_s _s_u_b_s_t_i_t_u_t_i_o_n. This is performed at the same time as + tilde, parameter, variable, and arithmetic expansion and command sub- stitution. - After these expansions are performed, quote characters present in the - original word are removed unless they have been quoted themselves + After these expansions are performed, quote characters present in the + original word are removed unless they have been quoted themselves (_q_u_o_t_e _r_e_m_o_v_a_l). - Only brace expansion, word splitting, and pathname expansion can in- - crease the number of words of the expansion; other expansions expand a - single word to a single word. The only exceptions to this are the ex- + Only brace expansion, word splitting, and pathname expansion can in- + crease the number of words of the expansion; other expansions expand a + single word to a single word. The only exceptions to this are the ex- pansions of "$$@@" and "$${{_n_a_m_e[[@@]]}}", and, in most cases, $$** and $${{_n_a_m_e[[**]]}} as explained above (see PPAARRAAMMEETTEERRSS). BBrraaccee EExxppaannssiioonn _B_r_a_c_e _e_x_p_a_n_s_i_o_n is a mechanism by which arbitrary strings may be gener- - ated. This mechanism is similar to _p_a_t_h_n_a_m_e _e_x_p_a_n_s_i_o_n, but the file- - names generated need not exist. Patterns to be brace expanded take the + ated. This mechanism is similar to _p_a_t_h_n_a_m_e _e_x_p_a_n_s_i_o_n, but the file- + names generated need not exist. Patterns to be brace expanded take the form of an optional _p_r_e_a_m_b_l_e, followed by either a series of comma-sep- - arated strings or a sequence expression between a pair of braces, fol- - lowed by an optional _p_o_s_t_s_c_r_i_p_t. The preamble is prefixed to each + arated strings or a sequence expression between a pair of braces, fol- + lowed by an optional _p_o_s_t_s_c_r_i_p_t. The preamble is prefixed 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, a{{d,c,b}}e - expands into `ade ace abe'. + Brace expansions may be nested. The results of each expanded string + are not sorted; left to right order is preserved. For example, + a{{d,c,b}}e expands into `ade ace abe'. - A sequence expression takes the form {{_x...._y[[...._i_n_c_r]]}}, where _x and _y are - either integers or single letters, and _i_n_c_r, an optional increment, is - an integer. When integers are supplied, the expression expands to each - number between _x and _y, inclusive. Supplied integers may be prefixed - with _0 to force each term to have the same width. When either _x or _y - begins with a zero, the shell attempts to force all generated terms to - contain the same number of digits, zero-padding where necessary. When - letters are supplied, the expression expands to each character lexico- - graphically between _x and _y, inclusive, using the default C locale. - Note that both _x and _y must be of the same type (integer or letter). - When the increment is supplied, it is used as the difference between - each term. The default increment is 1 or -1 as appropriate. + A sequence expression takes the form {{_x...._y[[...._i_n_c_r]]}}, where _x and _y are + either integers or single letters, and _i_n_c_r, an optional increment, is + an integer. When integers are supplied, the expression expands to each + number between _x and _y, inclusive. Supplied integers may be prefixed + with _0 to force each term to have the same width. When either _x or _y + begins with a zero, the shell attempts to force all generated terms to + contain the same number of digits, zero-padding where necessary. When + letters are supplied, the expression expands to each character lexico- + graphically between _x and _y, inclusive, using the default C locale. + Note that both _x and _y must be of the same type (integer or letter). + When the increment is supplied, it is used as the difference between + each term. The default increment is 1 or -1 as appropriate. Brace expansion is performed before any other expansions, and any char- - acters special to other expansions are preserved in the result. It is - strictly textual. BBaasshh does not apply any syntactic interpretation to + acters special to other expansions are preserved in the result. It is + strictly textual. BBaasshh 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 + A correctly-formed brace expansion must contain unquoted opening and closing braces, and at least one unquoted comma or a valid sequence ex- - pression. Any incorrectly formed brace expansion is left unchanged. A {{ - or ,, may be quoted with a backslash to prevent its being considered - part of a brace expression. To avoid conflicts with parameter expan- + pression. Any incorrectly formed brace expansion is left unchanged. A + {{ or ,, may be quoted with a backslash to prevent its being considered + part of a brace expression. To avoid conflicts with parameter expan- sion, the string $${{ is not considered eligible for brace expansion, and inhibits brace expansion until the closing }}. @@ -1659,230 +1668,233 @@ EEXXPPAANNSSIIOONN or chown root /usr/{ucb/{ex,edit},lib/{ex?.?*,how_ex}} - Brace expansion introduces a slight incompatibility with historical - versions of sshh. sshh does not treat opening or closing braces specially - when they appear as part of a word, and preserves them in the output. - BBaasshh removes braces from words as a consequence of brace expansion. For - example, a word entered to sshh as _f_i_l_e_{_1_,_2_} appears identically in the - output. The same word is output as _f_i_l_e_1 _f_i_l_e_2 after expansion by bbaasshh. - If strict compatibility with sshh is desired, start bbaasshh with the ++BB op- - tion or disable brace expansion with the ++BB option to the sseett command - (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). + Brace expansion introduces a slight incompatibility with historical + versions of sshh. sshh does not treat opening or closing braces specially + when they appear as part of a word, and preserves them in the output. + BBaasshh removes braces from words as a consequence of brace expansion. + For example, a word entered to sshh as _f_i_l_e_{_1_,_2_} appears identically in + the output. The same word is output as _f_i_l_e_1 _f_i_l_e_2 after expansion by + bbaasshh. If strict compatibility with sshh is desired, start bbaasshh with the + ++BB option or disable brace expansion with the ++BB option to the sseett com- + mand (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). TTiillddee EExxppaannssiioonn - If a word begins with an unquoted tilde character (`~~'), all of the - characters preceding the first unquoted slash (or all characters, if - there is no unquoted slash) are considered a _t_i_l_d_e_-_p_r_e_f_i_x. 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 _l_o_g_i_n _n_a_m_e. - If this login name is the null string, the tilde is replaced with the - value of the shell parameter HHOOMMEE. If HHOOMMEE 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 a word begins with an unquoted tilde character (`~~'), all of the + characters preceding the first unquoted slash (or all characters, if + there is no unquoted slash) are considered a _t_i_l_d_e_-_p_r_e_f_i_x. 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 _l_o_g_i_n _n_a_m_e. + If this login name is the null string, the tilde is replaced with the + value of the shell parameter HHOOMMEE. If HHOOMMEE is unset, the home direc- + tory of the user executing the shell is substituted instead. Other- + wise, the tilde-prefix is replaced with the home directory associated + with the specified login name. - If the tilde-prefix is a `~+', the value of the shell variable PPWWDD re- - places the tilde-prefix. If the tilde-prefix is a `~-', the value of - the shell variable OOLLDDPPWWDD, if it is set, is substituted. If the charac- - ters following the tilde in the tilde-prefix consist of a number _N, op- - tionally prefixed by a `+' or a `-', the tilde-prefix is replaced with - the corresponding element from the directory stack, as it would be dis- - played by the ddiirrss builtin invoked with the tilde-prefix as an argu- - ment. If the characters following the tilde in the tilde-prefix consist - of a number without a leading `+' or `-', `+' is assumed. + If the tilde-prefix is a `~+', the value of the shell variable PPWWDD re- + places the tilde-prefix. If the tilde-prefix is a `~-', the value of + the shell variable OOLLDDPPWWDD, if it is set, is substituted. If the char- + acters 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 ddiirrss builtin invoked with the tilde-prefix as an argu- + ment. If the characters following the tilde in the tilde-prefix con- + sist of a number without a leading `+' or `-', `+' is assumed. If the login name is invalid, or the tilde expansion fails, the word is unchanged. Each variable assignment is checked for unquoted tilde-prefixes immedi- - ately following a :: or the first ==. In these cases, tilde expansion is - also performed. Consequently, one may use filenames with tildes in as- - signments to PPAATTHH, MMAAIILLPPAATTHH, and CCDDPPAATTHH, and the shell assigns the ex- + ately following a :: or the first ==. In these cases, tilde expansion is + also performed. Consequently, one may use filenames with tildes in as- + signments to PPAATTHH, MMAAIILLPPAATTHH, and CCDDPPAATTHH, and the shell assigns the ex- panded value. - BBaasshh also performs tilde expansion on words satisfying the conditions + BBaasshh also performs tilde expansion on words satisfying the conditions of variable assignments (as described above under PPAARRAAMMEETTEERRSS) when they - appear as arguments to simple commands. BBaasshh does not do this, except + appear as arguments to simple commands. BBaasshh does not do this, except for the _d_e_c_l_a_r_a_t_i_o_n commands listed above, when in _p_o_s_i_x _m_o_d_e. PPaarraammeetteerr EExxppaannssiioonn The `$$' character introduces parameter expansion, command substitution, - or arithmetic expansion. The parameter name or symbol to 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 + or arithmetic expansion. The parameter name or symbol to 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 + 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 em- - bedded arithmetic expansion, command substitution, or parameter expan- + bedded arithmetic expansion, command substitution, or parameter expan- sion. ${_p_a_r_a_m_e_t_e_r} - The value of _p_a_r_a_m_e_t_e_r is substituted. The braces are required - when _p_a_r_a_m_e_t_e_r is a positional parameter with more than one + The value of _p_a_r_a_m_e_t_e_r is substituted. The braces are required + when _p_a_r_a_m_e_t_e_r is a positional parameter with more than one digit, or when _p_a_r_a_m_e_t_e_r is followed by a character which is not - to be interpreted as part of its name. The _p_a_r_a_m_e_t_e_r is a shell - parameter as described above PPAARRAAMMEETTEERRSS) or an array reference + to be interpreted as part of its name. The _p_a_r_a_m_e_t_e_r is a shell + parameter as described above PPAARRAAMMEETTEERRSS) or an array reference (AArrrraayyss). - If the first character of _p_a_r_a_m_e_t_e_r is an exclamation point (!!), and - _p_a_r_a_m_e_t_e_r is not a _n_a_m_e_r_e_f, it introduces a level of indirection. BBaasshh + If the first character of _p_a_r_a_m_e_t_e_r is an exclamation point (!!), and + _p_a_r_a_m_e_t_e_r is not a _n_a_m_e_r_e_f, it introduces a level of indirection. BBaasshh uses the value formed by expanding the rest of _p_a_r_a_m_e_t_e_r as the new _p_a_- - _r_a_m_e_t_e_r; this is then expanded and that value is used in the rest of - the expansion, rather than the expansion of the original _p_a_r_a_m_e_t_e_r. - This is known as _i_n_d_i_r_e_c_t _e_x_p_a_n_s_i_o_n. The value is subject to tilde ex- - pansion, parameter expansion, command substitution, and arithmetic ex- - pansion. If _p_a_r_a_m_e_t_e_r is a nameref, this expands to the name of the pa- - rameter referenced by _p_a_r_a_m_e_t_e_r instead of performing the complete in- - direct expansion. The exceptions to this are the expansions of ${!!_p_r_e_- - _f_i_x**} and ${!!_n_a_m_e[_@]} described below. The exclamation point must imme- - diately follow the left brace in order to introduce indirection. + _r_a_m_e_t_e_r; this is then expanded and that value is used in the rest of + the expansion, rather than the expansion of the original _p_a_r_a_m_e_t_e_r. + This is known as _i_n_d_i_r_e_c_t _e_x_p_a_n_s_i_o_n. The value is subject to tilde ex- + pansion, parameter expansion, command substitution, and arithmetic ex- + pansion. If _p_a_r_a_m_e_t_e_r is a nameref, this expands to the name of the + parameter referenced by _p_a_r_a_m_e_t_e_r instead of performing the complete + indirect expansion. The exceptions to this are the expansions of + ${!!_p_r_e_f_i_x**} and ${!!_n_a_m_e[_@]} described below. The exclamation point + must immediately follow the left brace in order to introduce indirec- + tion. In each of the cases below, _w_o_r_d is subject to tilde expansion, parame- ter expansion, command substitution, and arithmetic expansion. When not performing substring expansion, using the forms documented be- - low (e.g., ::--), bbaasshh tests for a parameter that is unset or null. Omit- - ting the colon results in a test only for a parameter that is unset. + low (e.g., ::--), bbaasshh tests for a parameter that is unset or null. + Omitting the colon results in a test only for a parameter that is un- + set. ${_p_a_r_a_m_e_t_e_r::--_w_o_r_d} - UUssee DDeeffaauulltt VVaalluueess. If _p_a_r_a_m_e_t_e_r is unset or null, the expansion - of _w_o_r_d is substituted. Otherwise, the value of _p_a_r_a_m_e_t_e_r is - substituted. + UUssee DDeeffaauulltt VVaalluueess. If _p_a_r_a_m_e_t_e_r is unset or null, the expan- + sion of _w_o_r_d is substituted. Otherwise, the value of _p_a_r_a_m_e_t_e_r + is substituted. ${_p_a_r_a_m_e_t_e_r::==_w_o_r_d} - AAssssiiggnn DDeeffaauulltt VVaalluueess. If _p_a_r_a_m_e_t_e_r is unset or null, the expan- - sion of _w_o_r_d is assigned to _p_a_r_a_m_e_t_e_r. The value of _p_a_r_a_m_e_t_e_r is - then substituted. Positional parameters and special parameters - may not be assigned to in this way. + AAssssiiggnn DDeeffaauulltt VVaalluueess. If _p_a_r_a_m_e_t_e_r is unset or null, the ex- + pansion of _w_o_r_d is assigned to _p_a_r_a_m_e_t_e_r. The value of _p_a_r_a_m_e_- + _t_e_r is then substituted. Positional parameters and special pa- + rameters may not be assigned to in this way. ${_p_a_r_a_m_e_t_e_r::??_w_o_r_d} - DDiissppllaayy EErrrroorr iiff NNuullll oorr UUnnsseett. If _p_a_r_a_m_e_t_e_r is null or unset, - the expansion of _w_o_r_d (or a message to that effect if _w_o_r_d is - not present) is written to the standard error and the shell, if - it is not interactive, exits. Otherwise, the value of _p_a_r_a_m_e_t_e_r + DDiissppllaayy EErrrroorr iiff NNuullll oorr UUnnsseett. If _p_a_r_a_m_e_t_e_r is null or unset, + the expansion of _w_o_r_d (or a message to that effect if _w_o_r_d is + not present) is written to the standard error and the shell, if + it is not interactive, exits. Otherwise, the value of _p_a_r_a_m_e_t_e_r is substituted. ${_p_a_r_a_m_e_t_e_r::++_w_o_r_d} - UUssee AAlltteerrnnaattee VVaalluuee. If _p_a_r_a_m_e_t_e_r is null or unset, nothing is + UUssee AAlltteerrnnaattee VVaalluuee. If _p_a_r_a_m_e_t_e_r is null or unset, nothing is substituted, otherwise the expansion of _w_o_r_d is substituted. ${_p_a_r_a_m_e_t_e_r::_o_f_f_s_e_t} ${_p_a_r_a_m_e_t_e_r::_o_f_f_s_e_t::_l_e_n_g_t_h} - SSuubbssttrriinngg EExxppaannssiioonn. Expands to up to _l_e_n_g_t_h characters of the - value of _p_a_r_a_m_e_t_e_r starting at the character specified by _o_f_f_- - _s_e_t. If _p_a_r_a_m_e_t_e_r is @@ or **, an indexed array subscripted by @@ - or **, or an associative array name, the results differ as de- - scribed below. If _l_e_n_g_t_h is omitted, expands to the substring of - the value of _p_a_r_a_m_e_t_e_r starting at the character specified by - _o_f_f_s_e_t and extending to the end of the value. _l_e_n_g_t_h and _o_f_f_s_e_t + SSuubbssttrriinngg EExxppaannssiioonn. Expands to up to _l_e_n_g_t_h characters of the + value of _p_a_r_a_m_e_t_e_r starting at the character specified by _o_f_f_- + _s_e_t. If _p_a_r_a_m_e_t_e_r is @@ or **, an indexed array subscripted by @@ + or **, or an associative array name, the results differ as de- + scribed below. If _l_e_n_g_t_h is omitted, expands to the substring + of the value of _p_a_r_a_m_e_t_e_r starting at the character specified by + _o_f_f_s_e_t and extending to the end of the value. _l_e_n_g_t_h and _o_f_f_s_e_t are arithmetic expressions (see AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN below). - If _o_f_f_s_e_t evaluates to a number less than zero, the value is + If _o_f_f_s_e_t evaluates to a number less than zero, the value is used as an offset in characters from the end of the value of _p_a_- - _r_a_m_e_t_e_r. If _l_e_n_g_t_h evaluates to a number less than zero, it is + _r_a_m_e_t_e_r. If _l_e_n_g_t_h evaluates to a number less than zero, it is interpreted as an offset in characters from the end of the value - of _p_a_r_a_m_e_t_e_r rather than a number of characters, and the expan- - sion is the characters between _o_f_f_s_e_t and that result. Note that - a negative offset must be separated from the colon by at least - one space to avoid being confused with the ::-- expansion. + of _p_a_r_a_m_e_t_e_r rather than a number of characters, and the expan- + sion is the characters between _o_f_f_s_e_t and that result. Note + that a negative offset must be separated from the colon by at + least one space to avoid being confused with the ::-- expansion. - If _p_a_r_a_m_e_t_e_r is @@ or **, the result is _l_e_n_g_t_h positional parame- - ters beginning at _o_f_f_s_e_t. A negative _o_f_f_s_e_t is taken relative to - one greater than the greatest positional parameter, so an offset - of -1 evaluates to the last positional parameter (or 0 if there - are no positional parameters). It is an expansion error if - _l_e_n_g_t_h evaluates to a number less than zero. + If _p_a_r_a_m_e_t_e_r is @@ or **, the result is _l_e_n_g_t_h positional parame- + ters beginning at _o_f_f_s_e_t. A negative _o_f_f_s_e_t is taken relative + to one greater than the greatest positional parameter, so an + offset of -1 evaluates to the last positional parameter (or 0 if + there are no positional parameters). It is an expansion error + if _l_e_n_g_t_h evaluates to a number less than zero. If _p_a_r_a_m_e_t_e_r is an indexed array name subscripted by @ or *, the - result is the _l_e_n_g_t_h members of the array beginning with ${_p_a_- - _r_a_m_e_t_e_r[_o_f_f_s_e_t]}. A negative _o_f_f_s_e_t is taken relative to one - greater than the maximum index of the specified array. It is an + result is the _l_e_n_g_t_h members of the array beginning with ${_p_a_- + _r_a_m_e_t_e_r[_o_f_f_s_e_t]}. A negative _o_f_f_s_e_t is taken relative to one + greater than the maximum index of the specified array. It is an expansion error if _l_e_n_g_t_h evaluates to a number less than zero. Substring expansion applied to an associative array produces un- defined results. - Substring indexing is zero-based unless the positional parame- - ters are used, in which case the indexing starts at 1 by de- - fault. If _o_f_f_s_e_t is 0, and the positional parameters are used, + Substring indexing is zero-based unless the positional parame- + ters are used, in which case the indexing starts at 1 by de- + fault. If _o_f_f_s_e_t is 0, and the positional parameters are used, $$00 is prefixed to the list. ${!!_p_r_e_f_i_x**} ${!!_p_r_e_f_i_x@@} - NNaammeess mmaattcchhiinngg pprreeffiixx. Expands to the names of variables whose + NNaammeess mmaattcchhiinngg pprreeffiixx. Expands to the names of variables whose names begin with _p_r_e_f_i_x, separated by the first character of the - IIFFSS special variable. When _@ is used and the expansion appears - within double quotes, each variable name expands to a separate + IIFFSS special variable. When _@ is used and the expansion appears + within double quotes, each variable name expands to a separate word. ${!!_n_a_m_e[_@]} ${!!_n_a_m_e[_*]} - LLiisstt ooff aarrrraayy kkeeyyss. If _n_a_m_e is an array variable, expands to the - list of array indices (keys) assigned in _n_a_m_e. If _n_a_m_e is not an - array, expands to 0 if _n_a_m_e is set and null otherwise. When _@ is - used and the expansion appears within double quotes, each key - expands to a separate word. + LLiisstt ooff aarrrraayy kkeeyyss. If _n_a_m_e is an array variable, expands to + the list of array indices (keys) assigned in _n_a_m_e. If _n_a_m_e is + not an array, expands to 0 if _n_a_m_e is set and null otherwise. + When _@ is used and the expansion appears within double quotes, + each key expands to a separate word. ${##_p_a_r_a_m_e_t_e_r} - PPaarraammeetteerr lleennggtthh. The length in characters of the value of _p_a_- - _r_a_m_e_t_e_r is substituted. If _p_a_r_a_m_e_t_e_r is ** or @@, the value sub- - stituted is the number of positional parameters. If _p_a_r_a_m_e_t_e_r is - an array name subscripted by ** or @@, the value substituted is - the number of elements in the array. If _p_a_r_a_m_e_t_e_r is an indexed - array name subscripted by a negative number, that number is in- - terpreted as relative to one greater than the maximum index of - _p_a_r_a_m_e_t_e_r, so negative indices count back from the end of the + PPaarraammeetteerr lleennggtthh. The length in characters of the value of _p_a_- + _r_a_m_e_t_e_r is substituted. If _p_a_r_a_m_e_t_e_r is ** or @@, the value sub- + stituted is the number of positional parameters. If _p_a_r_a_m_e_t_e_r + is an array name subscripted by ** or @@, the value substituted is + the number of elements in the array. If _p_a_r_a_m_e_t_e_r is an indexed + array name subscripted by a negative number, that number is in- + terpreted as relative to one greater than the maximum index of + _p_a_r_a_m_e_t_e_r, so negative indices count back from the end of the array, and an index of -1 references the last element. ${_p_a_r_a_m_e_t_e_r##_w_o_r_d} ${_p_a_r_a_m_e_t_e_r####_w_o_r_d} - RReemmoovvee mmaattcchhiinngg pprreeffiixx ppaatttteerrnn. The _w_o_r_d is expanded to produce + RReemmoovvee mmaattcchhiinngg pprreeffiixx ppaatttteerrnn. The _w_o_r_d is expanded to produce a pattern just as in pathname expansion, and matched against the expanded value of _p_a_r_a_m_e_t_e_r using the rules described under PPaatt-- - tteerrnn MMaattcchhiinngg below. If the pattern matches the beginning of the - value of _p_a_r_a_m_e_t_e_r, then the result of the expansion is the ex- - panded value of _p_a_r_a_m_e_t_e_r with the shortest matching pattern - (the ``##'' case) or the longest matching pattern (the ``####'' - case) deleted. If _p_a_r_a_m_e_t_e_r is @@ or **, the pattern removal oper- - ation is applied to each positional parameter in turn, and the - expansion is the resultant list. If _p_a_r_a_m_e_t_e_r is an array vari- - able subscripted with @@ or **, the pattern removal operation is - applied to each member of the array in turn, and the expansion + tteerrnn MMaattcchhiinngg below. If the pattern matches the beginning of + the value of _p_a_r_a_m_e_t_e_r, then the result of the expansion is the + expanded value of _p_a_r_a_m_e_t_e_r with the shortest matching pattern + (the ``##'' case) or the longest matching pattern (the ``####'' + case) deleted. If _p_a_r_a_m_e_t_e_r is @@ or **, the pattern removal op- + eration is applied to each positional parameter in turn, and the + expansion is the resultant list. If _p_a_r_a_m_e_t_e_r is an array vari- + able subscripted with @@ or **, the pattern removal operation is + applied to each member of the array in turn, and the expansion is the resultant list. ${_p_a_r_a_m_e_t_e_r%%_w_o_r_d} ${_p_a_r_a_m_e_t_e_r%%%%_w_o_r_d} - RReemmoovvee mmaattcchhiinngg ssuuffffiixx ppaatttteerrnn. The _w_o_r_d is expanded to produce + RReemmoovvee mmaattcchhiinngg ssuuffffiixx ppaatttteerrnn. The _w_o_r_d is expanded to produce a pattern just as in pathname expansion, and matched against the expanded value of _p_a_r_a_m_e_t_e_r using the rules described under PPaatt-- - tteerrnn MMaattcchhiinngg below. If the pattern matches a trailing portion - of the expanded value of _p_a_r_a_m_e_t_e_r, then the result of the ex- - pansion is the expanded value of _p_a_r_a_m_e_t_e_r with the shortest - matching pattern (the ``%%'' case) or the longest matching pat- - tern (the ``%%%%'' case) deleted. If _p_a_r_a_m_e_t_e_r is @@ or **, the pat- - tern removal operation is applied to each positional parameter - in turn, and the expansion is the resultant list. If _p_a_r_a_m_e_t_e_r - is an array variable subscripted with @@ or **, the pattern re- - moval operation is applied to each member of the array in turn, - and the expansion is the resultant list. + tteerrnn MMaattcchhiinngg below. If the pattern matches a trailing portion + of the expanded value of _p_a_r_a_m_e_t_e_r, then the result of the ex- + pansion is the expanded value of _p_a_r_a_m_e_t_e_r with the shortest + matching pattern (the ``%%'' case) or the longest matching pat- + tern (the ``%%%%'' case) deleted. If _p_a_r_a_m_e_t_e_r is @@ or **, the + pattern removal operation is applied to each positional parame- + ter in turn, and the expansion is the resultant list. If _p_a_r_a_m_- + _e_t_e_r 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. ${_p_a_r_a_m_e_t_e_r//_p_a_t_t_e_r_n//_s_t_r_i_n_g} ${_p_a_r_a_m_e_t_e_r////_p_a_t_t_e_r_n//_s_t_r_i_n_g} ${_p_a_r_a_m_e_t_e_r//##_p_a_t_t_e_r_n//_s_t_r_i_n_g} ${_p_a_r_a_m_e_t_e_r//%%_p_a_t_t_e_r_n//_s_t_r_i_n_g} - PPaatttteerrnn ssuubbssttiittuuttiioonn. The _p_a_t_t_e_r_n is expanded to produce a pat- - tern just as in pathname expansion. _P_a_r_a_m_e_t_e_r is expanded and - the longest match of _p_a_t_t_e_r_n against its value is replaced with - _s_t_r_i_n_g. _s_t_r_i_n_g undergoes tilde expansion, parameter and variable - expansion, arithmetic expansion, command and process substitu- - tion, and quote removal. The match is performed using the rules - described under PPaatttteerrnn MMaattcchhiinngg below. In the first form above, - only the first match is replaced. If there are two slashes sepa- - rating _p_a_r_a_m_e_t_e_r and _p_a_t_t_e_r_n (the second form above), all - matches of _p_a_t_t_e_r_n are replaced with _s_t_r_i_n_g. If _p_a_t_t_e_r_n is pre- - ceded by ## (the third form above), it must match at the begin- - ning of the expanded value of _p_a_r_a_m_e_t_e_r. If _p_a_t_t_e_r_n is preceded - by %% (the fourth form above), it must match at the end of the - expanded value of _p_a_r_a_m_e_t_e_r. If the expansion of _s_t_r_i_n_g is null, - matches of _p_a_t_t_e_r_n are deleted. If _s_t_r_i_n_g is null, matches of - _p_a_t_t_e_r_n are deleted and the // following _p_a_t_t_e_r_n may be omitted. + PPaatttteerrnn ssuubbssttiittuuttiioonn. The _p_a_t_t_e_r_n is expanded to produce a pat- + tern just as in pathname expansion. _P_a_r_a_m_e_t_e_r is expanded and + the longest match of _p_a_t_t_e_r_n against its value is replaced with + _s_t_r_i_n_g. _s_t_r_i_n_g undergoes tilde expansion, parameter and vari- + able expansion, arithmetic expansion, command and process sub- + stitution, and quote removal. The match is performed using the + rules described under PPaatttteerrnn MMaattcchhiinngg below. In the first form + above, only the first match is replaced. If there are two + slashes separating _p_a_r_a_m_e_t_e_r and _p_a_t_t_e_r_n (the second form + above), all matches of _p_a_t_t_e_r_n are replaced with _s_t_r_i_n_g. If + _p_a_t_t_e_r_n is preceded by ## (the third form above), it must match + at the beginning of the expanded value of _p_a_r_a_m_e_t_e_r. If _p_a_t_t_e_r_n + is preceded by %% (the fourth form above), it must match at the + end of the expanded value of _p_a_r_a_m_e_t_e_r. If the expansion of + _s_t_r_i_n_g is null, matches of _p_a_t_t_e_r_n are deleted. If _s_t_r_i_n_g is + null, matches of _p_a_t_t_e_r_n are deleted and the // following _p_a_t_t_e_r_n + may be omitted. If the ppaattssuubb__rreeppllaacceemmeenntt shell option is enabled using sshhoopptt, any unquoted instances of && in _s_t_r_i_n_g are replaced with the @@ -1890,97 +1902,98 @@ EEXXPPAANNSSIIOONN Quoting any part of _s_t_r_i_n_g inhibits replacement in the expansion of the quoted portion, including replacement strings stored in - shell variables. Backslash will escape && in _s_t_r_i_n_g; the back- + shell variables. Backslash will escape && in _s_t_r_i_n_g; the back- slash is removed in order to permit a literal && in the replace- - ment string. Backslash can also be used to escape a backslash; - \\\\ results in a literal backslash in the replacement. Users + ment string. Backslash can also be used to escape a backslash; + \\\\ results in a literal backslash in the replacement. Users should take care if _s_t_r_i_n_g is double-quoted to avoid unwanted interactions between the backslash and double-quoting, since - backslash has special meaning within double quotes. Pattern sub- - stitution performs the check for unquoted && after expanding + backslash has special meaning within double quotes. Pattern + substitution performs the check for unquoted && after expanding _s_t_r_i_n_g; shell programmers should quote any occurrences of && they want to be taken literally in the replacement and ensure any in- stances of && they want to be replaced are unquoted. If the nnooccaasseemmaattcchh shell option is enabled, the match is per- - formed without regard to the case of alphabetic characters. If + formed without regard to the case of alphabetic characters. If _p_a_r_a_m_e_t_e_r is @@ or **, the substitution operation is applied to each positional parameter in turn, and the expansion is the re- - sultant list. If _p_a_r_a_m_e_t_e_r is an array variable subscripted with - @@ or **, the substitution operation is applied to each member of - the array in turn, and the expansion is the resultant list. + sultant list. If _p_a_r_a_m_e_t_e_r is an array variable subscripted + with @@ or **, the substitution operation is applied to each mem- + ber of the array in turn, and the expansion is the resultant + list. ${_p_a_r_a_m_e_t_e_r^^_p_a_t_t_e_r_n} ${_p_a_r_a_m_e_t_e_r^^^^_p_a_t_t_e_r_n} ${_p_a_r_a_m_e_t_e_r,,_p_a_t_t_e_r_n} ${_p_a_r_a_m_e_t_e_r,,,,_p_a_t_t_e_r_n} - CCaassee mmooddiiffiiccaattiioonn. This expansion modifies the case of alpha- - betic characters in _p_a_r_a_m_e_t_e_r. The _p_a_t_t_e_r_n is expanded to pro- - duce a pattern just as in pathname expansion. Each character in - the expanded value of _p_a_r_a_m_e_t_e_r is tested against _p_a_t_t_e_r_n, and, - if it matches the pattern, its case is converted. The pattern - should not attempt to match more than one character. The ^^ oper- - ator converts lowercase letters matching _p_a_t_t_e_r_n to uppercase; + CCaassee mmooddiiffiiccaattiioonn. This expansion modifies the case of alpha- + betic characters in _p_a_r_a_m_e_t_e_r. The _p_a_t_t_e_r_n is expanded to pro- + duce a pattern just as in pathname expansion. Each character in + the expanded value of _p_a_r_a_m_e_t_e_r is tested against _p_a_t_t_e_r_n, and, + if it matches the pattern, its case is converted. The pattern + should not attempt to match more than one character. The ^^ op- + erator converts lowercase letters matching _p_a_t_t_e_r_n to uppercase; the ,, operator converts matching uppercase letters to lowercase. - The ^^^^ and ,,,, expansions convert each matched character in the - expanded value; the ^^ and ,, expansions match and convert only - the first character in the expanded value. If _p_a_t_t_e_r_n is omit- - ted, it is treated like a ??, which matches every character. If - _p_a_r_a_m_e_t_e_r is @@ or **, the case modification operation is applied - to each positional parameter in turn, and the expansion is the - resultant list. If _p_a_r_a_m_e_t_e_r is an array variable subscripted - with @@ or **, the case modification operation is applied to each - member of the array in turn, and the expansion is the resultant + The ^^^^ and ,,,, expansions convert each matched character in the + expanded value; the ^^ and ,, expansions match and convert only + the first character in the expanded value. If _p_a_t_t_e_r_n is omit- + ted, it is treated like a ??, which matches every character. If + _p_a_r_a_m_e_t_e_r is @@ or **, the case modification operation is applied + to each positional parameter in turn, and the expansion is the + resultant list. If _p_a_r_a_m_e_t_e_r is an array variable subscripted + with @@ or **, the case modification operation is applied to each + member of the array in turn, and the expansion is the resultant list. ${_p_a_r_a_m_e_t_e_r@@_o_p_e_r_a_t_o_r} - PPaarraammeetteerr ttrraannssffoorrmmaattiioonn. The expansion is either a transforma- - tion of the value of _p_a_r_a_m_e_t_e_r or information about _p_a_r_a_m_e_t_e_r - itself, depending on the value of _o_p_e_r_a_t_o_r. Each _o_p_e_r_a_t_o_r is a + PPaarraammeetteerr ttrraannssffoorrmmaattiioonn. The expansion is either a transforma- + tion of the value of _p_a_r_a_m_e_t_e_r or information about _p_a_r_a_m_e_t_e_r + itself, depending on the value of _o_p_e_r_a_t_o_r. Each _o_p_e_r_a_t_o_r is a single letter: - UU The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r - with lowercase alphabetic characters converted to upper- + UU The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r + with lowercase alphabetic characters converted to upper- case. - uu The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r + uu The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r with the first character converted to uppercase, if it is alphabetic. - LL The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r - with uppercase alphabetic characters converted to lower- + LL The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r + with uppercase alphabetic characters converted to lower- case. - QQ The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r + QQ The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r quoted in a format that can be reused as input. - EE The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r - with backslash escape sequences expanded as with the + EE The expansion is a string that is the value of _p_a_r_a_m_e_t_e_r + with backslash escape sequences expanded as with the $$''......'' quoting mechanism. PP The expansion is a string that is the result of expanding the value of _p_a_r_a_m_e_t_e_r as if it were a prompt string (see PPRROOMMPPTTIINNGG below). - AA The expansion is a string in the form of an assignment - statement or ddeeccllaarree command that, if evaluated, will + AA The expansion is a string in the form of an assignment + statement or ddeeccllaarree command that, if evaluated, will recreate _p_a_r_a_m_e_t_e_r with its attributes and value. KK Produces a possibly-quoted version of the value of _p_a_r_a_m_- _e_t_e_r, except that it prints the values of indexed and as- - sociative arrays as a sequence of quoted key-value pairs + sociative arrays as a sequence of quoted key-value pairs (see AArrrraayyss above). - aa The expansion is a string consisting of flag values rep- + aa The expansion is a string consisting of flag values rep- resenting _p_a_r_a_m_e_t_e_r's attributes. - kk Like the K transformation, but expands the keys and val- - ues of indexed and associative arrays to separate words + kk Like the K transformation, but expands the keys and val- + ues of indexed and associative arrays to separate words after word splitting. - If _p_a_r_a_m_e_t_e_r is @@ or **, the operation is applied to each posi- - tional parameter in turn, and the expansion is the resultant - list. If _p_a_r_a_m_e_t_e_r is an array variable subscripted with @@ or **, - the operation is applied to each member of the array in turn, + If _p_a_r_a_m_e_t_e_r is @@ or **, the operation is applied to each posi- + tional parameter in turn, and the expansion is the resultant + list. If _p_a_r_a_m_e_t_e_r is an array variable subscripted with @@ or + **, the operation is applied to each member of the array in turn, and the expansion is the resultant list. - The result of the expansion is subject to word splitting and + The result of the expansion is subject to word splitting and pathname expansion as described below. CCoommmmaanndd SSuubbssttiittuuttiioonn _C_o_m_m_a_n_d _s_u_b_s_t_i_t_u_t_i_o_n allows the output of a command to replace the com- - mand itself. There are two standard forms: + mand itself. There are two standard forms: $$((_c_o_m_m_a_n_d)) or (deprecated) @@ -1988,197 +2001,200 @@ EEXXPPAANNSSIIOONN BBaasshh performs the expansion by executing _c_o_m_m_a_n_d in a subshell environ- ment 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 $$((ccaatt _f_i_l_e)) can be replaced by the equivalent but faster - $$((<< _f_i_l_e)). + the command, with any trailing newlines deleted. Embedded newlines are + not deleted, but they may be removed during word splitting. The com- + mand substitution $$((ccaatt _f_i_l_e)) can be replaced by the equivalent but + faster $$((<< _f_i_l_e)). - With the old-style backquote form of substitution, backslash retains - its literal meaning except when followed by $$, ``, or \\. The first back- - quote not preceded by a backslash terminates the command substitution. - When using the $(_c_o_m_m_a_n_d) form, all characters between the parentheses - make up the command; none are treated specially. + With the old-style backquote form of substitution, backslash retains + its literal meaning except when followed by $$, ``, or \\. The first + backquote not preceded by a backslash terminates the command substitu- + tion. When using the $(_c_o_m_m_a_n_d) form, all characters between the + parentheses make up the command; none are treated specially. There is an alternate form of command substitution: $${{_c _c_o_m_m_a_n_d;;}} - which executes _c_o_m_m_a_n_d in the current execution environment and cap- + which executes _c_o_m_m_a_n_d in the current execution environment and cap- tures its output, again with trailing newlines removed. The character _c following the open brace must be a space, tab, newline, - or ||, and the close brace must be in a position where a reserved word - may appear (i.e., preceded by a command terminator such as semicolon). + or ||, and the close brace must be in a position where a reserved word + may appear (i.e., preceded by a command terminator such as semicolon). BBaasshh allows the close brace to be joined to the remaining characters in - the word without being followed by a shell metacharacter as a reserved + the word without being followed by a shell metacharacter as a reserved word would usually require. Any side effects of _c_o_m_m_a_n_d take effect immediately in the current exe- - cution environment and persist in the current environment after the + cution environment and persist in the current environment after the command completes (e.g., the eexxiitt builtin will exit the shell). - This type of command substitution superficially resembles executing an - unnamed shell function: local variables are created as when a shell - function is executing, and the rreettuurrnn builtin forces _c_o_m_m_a_n_d to com- - plete; however, the rest of the execution environment, including the + This type of command substitution superficially resembles executing an + unnamed shell function: local variables are created as when a shell + function is executing, and the rreettuurrnn builtin forces _c_o_m_m_a_n_d to com- + plete; however, the rest of the execution environment, including the positional parameters, is shared with the caller. - If the first character following the open brace is a ||, the construct - expands to the value of the RREEPPLLYY shell variable after _c_o_m_m_a_n_d exe- - cutes, without removing any trailing newlines, and the standard output - of _c_o_m_m_a_n_d remains the same as in the calling shell. BBaasshh creates RREEPPLLYY - as an initially-unset local variable when _c_o_m_m_a_n_d executes, and re- - stores RREEPPLLYY to the value it had before the command substitution after + If the first character following the open brace is a ||, the construct + expands to the value of the RREEPPLLYY shell variable after _c_o_m_m_a_n_d exe- + cutes, without removing any trailing newlines, and the standard output + of _c_o_m_m_a_n_d remains the same as in the calling shell. BBaasshh creates RREE-- + PPLLYY as an initially-unset local variable when _c_o_m_m_a_n_d executes, and re- + stores RREEPPLLYY to the value it had before the command substitution after _c_o_m_m_a_n_d completes, as with any local variable. - Command substitutions may be nested. To nest when using the backquoted + 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, bbaasshh does not perform word splitting and pathname expansion on the results. AArriitthhmmeettiicc EExxppaannssiioonn - Arithmetic expansion allows the evaluation of an arithmetic expression - and the substitution of the result. The format for arithmetic expansion - is: + Arithmetic expansion allows the evaluation of an arithmetic expression + and the substitution of the result. The format for arithmetic expan- + sion is: $$((((_e_x_p_r_e_s_s_i_o_n)))) - The _e_x_p_r_e_s_s_i_o_n undergoes the same expansions as if it were within dou- - ble quotes, but double quote characters in _e_x_p_r_e_s_s_i_o_n are not treated - specially and are removed. All tokens in the expression undergo parame- - ter and variable expansion, command substitution, and quote removal. - The result is treated as the arithmetic expression to be evaluated. + The _e_x_p_r_e_s_s_i_o_n undergoes the same expansions as if it were within dou- + ble quotes, but double quote characters in _e_x_p_r_e_s_s_i_o_n are not treated + specially and are removed. All tokens in the expression undergo param- + eter and variable expansion, command substitution, and quote removal. + The result is treated as the arithmetic expression to be evaluated. Arithmetic expansions may be nested. - The evaluation is performed according to the rules listed below under - AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN. If _e_x_p_r_e_s_s_i_o_n is invalid, bbaasshh prints a message + The evaluation is performed according to the rules listed below under + AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN. If _e_x_p_r_e_s_s_i_o_n is invalid, bbaasshh prints a message indicating failure and no substitution occurs. PPrroocceessss SSuubbssttiittuuttiioonn - _P_r_o_c_e_s_s _s_u_b_s_t_i_t_u_t_i_o_n allows a process's input or output to be referred - to using a filename. It takes the form of <<((_l_i_s_t)) or >>((_l_i_s_t)). The - process _l_i_s_t is run asynchronously, and its input or output appears as - a filename. This filename is passed as an argument to the current com- - mand as the result of the expansion. If the >>((_l_i_s_t)) form is used, writ- - ing to the file will provide input for _l_i_s_t. If the <<((_l_i_s_t)) form is - used, the file passed as an argument should be read to obtain the out- - put of _l_i_s_t. Process substitution is supported on systems that support - named pipes (_F_I_F_O_s) or the //ddeevv//ffdd method of naming open files. + _P_r_o_c_e_s_s _s_u_b_s_t_i_t_u_t_i_o_n allows a process's input or output to be referred + to using a filename. It takes the form of <<((_l_i_s_t)) or >>((_l_i_s_t)). The + process _l_i_s_t is run asynchronously, and its input or output appears as + a filename. This filename is passed as an argument to the current com- + mand as the result of the expansion. If the >>((_l_i_s_t)) form is used, + writing to the file will provide input for _l_i_s_t. If the <<((_l_i_s_t)) form + is used, the file passed as an argument should be read to obtain the + output of _l_i_s_t. Process substitution is supported on systems that sup- + port named pipes (_F_I_F_O_s) or the //ddeevv//ffdd method of naming open files. - When available, process substitution is performed simultaneously with - parameter and variable expansion, command substitution, and arithmetic + When available, process substitution is performed simultaneously with + parameter and variable expansion, command substitution, and arithmetic expansion. WWoorrdd SSpplliittttiinngg - The shell scans the results of parameter expansion, command substitu- - tion, and arithmetic expansion that did not occur within double quotes + The shell scans the results of parameter expansion, command substitu- + tion, and arithmetic expansion that did not occur within double quotes for _w_o_r_d _s_p_l_i_t_t_i_n_g. - The shell treats each character of IIFFSS as a delimiter, and splits the - results of the other expansions into words using these characters as + The shell treats each character of IIFFSS as a delimiter, and splits the + results of the other expansions into words using these characters as field terminators. If IIFFSS is unset, or its value is exactly <><><>, the de- - fault, then sequences of ssppaaccee, ttaabb, and nneewwlliinnee at the beginning and - end of the results of the previous expansions are ignored, and any se- - quence of IIFFSS characters not at the beginning or end serves to delimit - words. If IIFFSS has a value other than the default, then sequences of the - whitespace characters ssppaaccee, ttaabb, and nneewwlliinnee are ignored at the begin- - ning and end of the word, as long as the whitespace character is in the - value of IIFFSS (an IIFFSS whitespace character). Any character in IIFFSS that - is not IIFFSS whitespace, along with any adjacent IIFFSS whitespace charac- - ters, delimits a field. A sequence of IIFFSS whitespace characters is also - treated as a delimiter. + fault, then sequences of ssppaaccee, ttaabb, and nneewwlliinnee at the beginning and + end of the results of the previous expansions are ignored, and any se- + quence of IIFFSS characters not at the beginning or end serves to delimit + words. If IIFFSS has a value other than the default, then sequences of + the whitespace characters ssppaaccee, ttaabb, and nneewwlliinnee are ignored at the + beginning and end of the word, as long as the whitespace character is + in the value of IIFFSS (an IIFFSS whitespace character). Any character in + IIFFSS that is not IIFFSS whitespace, along with any adjacent IIFFSS whitespace + characters, delimits a field. A sequence of IIFFSS whitespace characters + is also treated as a delimiter. - If the value of IIFFSS is null, no word splitting occurs. If IIFFSS is unset, - word splitting behaves as if it contained the default value of + If the value of IIFFSS is null, no word splitting occurs. If IIFFSS is un- + set, word splitting behaves as if it contained the default value of <><><>. - Explicit null arguments ("""" or '''') are retained and passed to commands - as empty strings. Unquoted implicit null arguments, resulting from the - expansion of parameters that have no values, are removed. If a parame- + Explicit null arguments ("""" or '''') are retained and passed to commands + as empty strings. Unquoted implicit null arguments, resulting from the + expansion of parameters that have no values, are removed. If a parame- ter with no value is expanded within double quotes, a null argument re- - sults and is retained and passed to a command as an empty string. When - a quoted null argument appears as part of a word whose expansion is - non-null, the null argument is removed. That is, the word -d'' becomes + sults and is retained and passed to a command as an empty string. When + a quoted null argument appears as part of a word whose expansion is + non-null, the null argument is removed. That is, the word -d'' becomes -d after word splitting and null argument removal. Note that if no expansion occurs, no splitting is performed. PPaatthhnnaammee EExxppaannssiioonn - After word splitting, unless the --ff option has been set, bbaasshh scans - each word for the characters **, ??, and [[. If one of these characters + After word splitting, unless the --ff option has been set, bbaasshh scans + each word for the characters **, ??, and [[. If one of these characters appears, and is not quoted, then the word is regarded as a _p_a_t_t_e_r_n, and - replaced with an alphabetically sorted list of filenames matching the - pattern (see PPaatttteerrnn MMaattcchhiinngg below). If no matching filenames are - found, and the shell option nnuullllgglloobb is not enabled, the word is left - unchanged. If the nnuullllgglloobb option is set, and no matches are found, the - word is removed. If the ffaaiillgglloobb shell option is set, and no matches - are found, an error message is printed and the command is not executed. - If the shell option nnooccaasseegglloobb is enabled, the match is performed with- - out regard to the case of alphabetic characters. When a pattern is used - for pathname expansion, the character ````..'''' at the start of a name or - immediately following a slash must be matched explicitly, unless the - shell option ddoottgglloobb is set. In order to match the filenames ````..'''' and - ````....'''', the pattern must begin with ``.'' (for example, ``.?''), even - if ddoottgglloobb is set. If the gglloobbsskkiippddoottss shell option is enabled, the - filenames ````..'''' and ````....'''' are never matched, even if the pattern be- - gins with a ````..''''. When not matching pathnames, the ````..'''' character is - not treated specially. When matching a pathname, the slash character - must always be matched explicitly by a slash in the pattern, but in - other matching contexts it can be matched by a special pattern charac- - ter as described below under PPaatttteerrnn MMaattcchhiinngg. See the description of - sshhoopptt below under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS for a description of the nnoo-- - ccaasseegglloobb, nnuullllgglloobb, gglloobbsskkiippddoottss, ffaaiillgglloobb, and ddoottgglloobb shell options. + replaced with an alphabetically sorted list of filenames matching the + pattern (see PPaatttteerrnn MMaattcchhiinngg below). If no matching filenames are + found, and the shell option nnuullllgglloobb is not enabled, the word is left + unchanged. If the nnuullllgglloobb option is set, and no matches are found, + the word is removed. If the ffaaiillgglloobb shell option is set, and no + matches are found, an error message is printed and the command is not + executed. If the shell option nnooccaasseegglloobb is enabled, the match is per- + formed without regard to the case of alphabetic characters. When a + pattern is used for pathname expansion, the character ````..'''' at the + start of a name or immediately following a slash must be matched ex- + plicitly, unless the shell option ddoottgglloobb is set. In order to match + the filenames ````..'''' and ````....'''', the pattern must begin with ``.'' (for + example, ``.?''), even if ddoottgglloobb is set. If the gglloobbsskkiippddoottss shell + option is enabled, the filenames ````..'''' and ````....'''' are never matched, + even if the pattern begins with a ````..''''. When not matching pathnames, + the ````..'''' character is not treated specially. When matching a path- + name, the slash character must always be matched explicitly by a slash + in the pattern, but in other matching contexts it can be matched by a + special pattern character as described below under PPaatttteerrnn MMaattcchhiinngg. + See the description of sshhoopptt below under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS for a + description of the nnooccaasseegglloobb, nnuullllgglloobb, gglloobbsskkiippddoottss, ffaaiillgglloobb, and + ddoottgglloobb shell options. The GGLLOOBBIIGGNNOORREE shell variable may be used to restrict the set of file - names matching a _p_a_t_t_e_r_n. If GGLLOOBBIIGGNNOORREE is set, each matching file name - that also matches one of the patterns in GGLLOOBBIIGGNNOORREE is removed from the - list of matches. If the nnooccaasseegglloobb option is set, the matching against - the patterns in GGLLOOBBIIGGNNOORREE is performed without regard to case. The - filenames ````..'''' and ````....'''' are always ignored when GGLLOOBBIIGGNNOORREE is set - and not null. However, setting GGLLOOBBIIGGNNOORREE to a non-null value has the - effect of enabling the ddoottgglloobb shell option, so all other filenames be- - ginning with a ````..'''' will match. To get the old behavior of ignoring - filenames beginning with a ````..'''', make ````..**'''' one of the patterns in - GGLLOOBBIIGGNNOORREE. The ddoottgglloobb option is disabled when GGLLOOBBIIGGNNOORREE is unset. - The pattern matching honors the setting of the eexxttgglloobb shell option. + names matching a _p_a_t_t_e_r_n. If GGLLOOBBIIGGNNOORREE is set, each matching file + name that also matches one of the patterns in GGLLOOBBIIGGNNOORREE is removed + from the list of matches. If the nnooccaasseegglloobb option is set, the match- + ing against the patterns in GGLLOOBBIIGGNNOORREE is performed without regard to + case. The filenames ````..'''' and ````....'''' are always ignored when GGLLOOBBIIGG-- + NNOORREE is set and not null. However, setting GGLLOOBBIIGGNNOORREE to a non-null + value has the effect of enabling the ddoottgglloobb 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 GGLLOOBBIIGGNNOORREE. The ddoottgglloobb option is disabled when GGLLOOBBIIGGNNOORREE + is unset. The pattern matching honors the setting of the eexxttgglloobb shell + option. - The GGLLOOBBSSOORRTT variable controls how the results of pathname expansion + The GGLLOOBBSSOORRTT variable controls how the results of pathname expansion are sorted, as described above. PPaatttteerrnn MMaattcchhiinngg 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. A backslash escapes the following character; the - escaping backslash is discarded when matching. The special pattern + characters described below, matches itself. The NUL character may not + occur in a pattern. A backslash escapes the following character; the + escaping backslash is discarded when matching. 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. When the - gglloobbssttaarr shell option is enabled, and ** is used in a - pathname expansion context, two adjacent **s used as a - single pattern will match all files and zero or more di- - rectories and subdirectories. If followed by a //, two ad- - jacent **s will match only directories and subdirectories. + ** Matches any string, including the null string. When the + gglloobbssttaarr shell option is enabled, and ** is used in a + pathname expansion context, two adjacent **s used as a + single pattern will match all files and zero or more di- + rectories and subdirectories. If followed by a //, two + adjacent **s will match only directories and subdirecto- + ries. ?? Matches any single character. - [[......]] Matches any one of the enclosed characters. A pair of + [[......]] Matches any one of the enclosed characters. A pair of characters separated by a hyphen denotes a _r_a_n_g_e _e_x_p_r_e_s_- _s_i_o_n; any character that falls between those two charac- ters, inclusive, using the current locale's collating se- - quence and character set, is matched. If the first char- - acter following the [[ is a !! or a ^^ then any character - not enclosed is matched. The sorting order of characters + quence and character set, is matched. If the first char- + acter following the [[ is a !! or a ^^ then any character + not enclosed is matched. The sorting order of characters in range expressions, and the characters included in the range, are determined by the current locale and the val- ues of the LLCC__CCOOLLLLAATTEE or LLCC__AALLLL shell variables, if set. To obtain the traditional interpretation of range expres- sions, where [[aa--dd]] is equivalent to [[aabbccdd]], set value of the LLCC__AALLLL shell variable to CC, or enable the gglloobbaassccii-- - iirraannggeess shell option. A -- may be matched by including it + iirraannggeess shell option. A -- may be matched by including it as the first or last character in the set. A ]] may be matched by including it as the first character in the set. @@ -2189,7 +2205,7 @@ EEXXPPAANNSSIIOONN aallnnuumm aallpphhaa aasscciiii bbllaannkk ccnnttrrll ddiiggiitt ggrraapphh lloowweerr pprriinntt ppuunncctt ssppaaccee uuppppeerr wwoorrdd xxddiiggiitt A character class matches any character belonging to that - class. The wwoorrdd character class matches letters, digits, + class. The wwoorrdd character class matches letters, digits, and the character _. Within [[ and ]], an _e_q_u_i_v_a_l_e_n_c_e _c_l_a_s_s can be specified us- @@ -2201,10 +2217,10 @@ EEXXPPAANNSSIIOONN ing symbol _s_y_m_b_o_l. If the eexxttgglloobb shell option is enabled using the sshhoopptt builtin, the - shell recognizes several extended pattern matching operators. In the + shell recognizes several extended pattern matching operators. In the following description, a _p_a_t_t_e_r_n_-_l_i_s_t 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: + separated by a ||. Composite patterns may be formed using one or more + of the following sub-patterns: ??((_p_a_t_t_e_r_n_-_l_i_s_t)) Matches zero or one occurrence of the given patterns @@ -2218,8 +2234,8 @@ EEXXPPAANNSSIIOONN Matches anything except one of the given patterns The eexxttgglloobb option changes the behavior of the parser, since the paren- - theses are normally treated as operators with syntactic meaning. To en- - sure that extended matching patterns are parsed correctly, make sure + theses are normally treated as operators with syntactic meaning. To + ensure that extended matching patterns are parsed correctly, make sure that eexxttgglloobb is enabled before parsing constructs containing the pat- terns, including shell functions and command substitutions. @@ -2228,12 +2244,12 @@ EEXXPPAANNSSIIOONN names includes all files beginning with ``.'', but ``.'' and ``..'' must be matched by a pattern or sub-pattern that begins with a dot; when it is disabled, the set does not include any filenames beginning - with ``.'' unless the pattern or sub-pattern begins with a ``.''. As + with ``.'' unless the pattern or sub-pattern begins with a ``.''. As above, ``.'' only has a special meaning when matching filenames. Complicated extended pattern matching against long strings is slow, es- pecially when the patterns contain alternations and the strings contain - multiple matches. Using separate matches against shorter strings, or + multiple matches. Using separate matches against shorter strings, or using arrays of strings instead of a single long string, may be faster. QQuuoottee RReemmoovvaall @@ -2243,28 +2259,28 @@ EEXXPPAANNSSIIOONN RREEDDIIRREECCTTIIOONN Before a command is executed, its input and output may be _r_e_d_i_r_e_c_t_e_d - using a special notation interpreted by the shell. _R_e_d_i_r_e_c_t_i_o_n allows + using a special notation interpreted by the shell. _R_e_d_i_r_e_c_t_i_o_n allows commands' file handles to be duplicated, opened, closed, made to refer to different files, and can change the files the command reads from and - writes to. Redirection may also be used to modify file handles in the - current shell execution environment. The following redirection opera- + writes to. Redirection may also be used to modify file handles in the + current shell execution environment. The following redirection opera- tors may precede or appear anywhere within a _s_i_m_p_l_e _c_o_m_m_a_n_d or may fol- - low a _c_o_m_m_a_n_d. Redirections are processed in the order they appear, + low a _c_o_m_m_a_n_d. Redirections are processed in the order they appear, from left to right. Each redirection that may be preceded by a file descriptor number may - instead be preceded by a word of the form {_v_a_r_n_a_m_e}. In this case, for + instead be preceded by a word of the form {_v_a_r_n_a_m_e}. In this case, for each redirection operator except >&- and <&-, the shell will allocate a file descriptor greater than or equal to 10 and assign it to _v_a_r_n_a_m_e. If >&- or <&- is preceded by {_v_a_r_n_a_m_e}, the value of _v_a_r_n_a_m_e defines - the file descriptor to close. If {_v_a_r_n_a_m_e} is supplied, the redirection - persists beyond the scope of the command, allowing the shell programmer - to manage the file descriptor's lifetime manually. The vvaarrrreeddiirr__cclloossee - shell option manages this behavior. + the file descriptor to close. If {_v_a_r_n_a_m_e} is supplied, the redirect- + ion persists beyond the scope of the command, allowing the shell pro- + grammer to manage the file descriptor's lifetime manually. The + vvaarrrreeddiirr__cclloossee shell option manages this behavior. In the following descriptions, if the file descriptor number is omit- ted, and the first character of the redirection operator is <<, the re- - direction refers to the standard input (file descriptor 0). If the + direction 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). @@ -2272,7 +2288,7 @@ RREEDDIIRREECCTTIIOONN tions, unless otherwise noted, is subjected to brace expansion, tilde expansion, parameter and variable expansion, command substitution, arithmetic expansion, quote removal, pathname expansion, and word - splitting. If it expands to more than one word, bbaasshh reports an error. + splitting. If it expands to more than one word, bbaasshh reports an error. Note that the order of redirections is significant. For example, the command @@ -2289,7 +2305,7 @@ RREEDDIIRREECCTTIIOONN put was redirected to _d_i_r_l_i_s_t. BBaasshh handles several filenames specially when they are used in redirec- - tions, as described in the following table. If the operating system on + tions, as described in the following table. If the operating system on which bbaasshh is running provides these special files, bash will use them; otherwise it will emulate them internally with the behavior described below. @@ -2330,7 +2346,7 @@ RREEDDIIRREECCTTIIOONN RReeddiirreeccttiinngg OOuuttppuutt Redirection of output causes the file whose name results from the ex- pansion of _w_o_r_d to be opened for writing on file descriptor _n, or the - standard output (file descriptor 1) if _n is not specified. If the file + standard output (file descriptor 1) if _n is not specified. If the file does not exist it is created; if it does exist it is truncated to zero size. @@ -2349,7 +2365,7 @@ RREEDDIIRREECCTTIIOONN Redirection of output in this fashion causes the file whose name re- sults from the expansion of _w_o_r_d to be opened for appending on file de- scriptor _n, or the standard output (file descriptor 1) if _n is not - specified. If the file does not exist it is created. + specified. If the file does not exist it is created. The general format for appending output is: @@ -2367,14 +2383,14 @@ RREEDDIIRREECCTTIIOONN and >>&&_w_o_r_d - Of the two forms, the first is preferred. This is semantically equiva- + Of the two forms, the first is preferred. This is semantically equiva- lent to >>_w_o_r_d 2>>&&1 - When using the second form, _w_o_r_d may not expand to a number or --. If it - does, other redirection operators apply (see DDuupplliiccaattiinngg FFiillee DDeessccrriipp-- - ttoorrss below) for compatibility reasons. + When using the second form, _w_o_r_d may not expand to a number or --. If + it does, other redirection operators apply (see DDuupplliiccaattiinngg FFiillee DDee-- + ssccrriippttoorrss below) for compatibility reasons. AAppppeennddiinngg SSttaannddaarrdd OOuuttppuutt aanndd SSttaannddaarrdd EErrrroorr This construct allows both the standard output (file descriptor 1) and @@ -2393,8 +2409,8 @@ RREEDDIIRREECCTTIIOONN HHeerree DDooccuummeennttss This type of redirection instructs the shell to read input from the - current source until a line containing only _d_e_l_i_m_i_t_e_r (with no trailing - blanks) is seen. All of the lines read up to that point are then used + current source until it reads a line containing only _d_e_l_i_m_i_t_e_r (with no + trailing blanks). All of the lines read up to that point are then used as the standard input (or file descriptor _n if _n is specified) for a command. @@ -2408,7 +2424,7 @@ RREEDDIIRREECCTTIIOONN expansion, or pathname expansion is performed on _w_o_r_d. If any part of _w_o_r_d is quoted, the _d_e_l_i_m_i_t_e_r is the result of quote re- - moval on _w_o_r_d, and the lines in the here-document are not expanded. If + moval on _w_o_r_d, and the lines in the here-document are not expanded. If _w_o_r_d is unquoted, the _d_e_l_i_m_i_t_e_r is _w_o_r_d itself, all lines of the here- document are subjected to parameter expansion, command substitution, and arithmetic expansion, the character sequence \\<> is ignored, @@ -2425,33 +2441,33 @@ RREEDDIIRREECCTTIIOONN [_n]<<<<<<_w_o_r_d The _w_o_r_d undergoes tilde expansion, parameter and variable expansion, - command substitution, arithmetic expansion, and quote removal. Pathname - expansion and word splitting are not performed. The result is supplied - as a single string, with a newline appended, to the command on its - standard input (or file descriptor _n if _n is specified). + command substitution, arithmetic expansion, and quote removal. Path- + name expansion and word splitting are not performed. The result is + supplied as a single string, with a newline appended, to the command on + its standard input (or file descriptor _n if _n is specified). DDuupplliiccaattiinngg FFiillee DDeessccrriippttoorrss The redirection operator [_n]<<&&_w_o_r_d - is used to duplicate input file descriptors. If _w_o_r_d expands to one or + is used to duplicate input file descriptors. If _w_o_r_d expands to one or more digits, the file descriptor denoted by _n is made to be a copy of - that file descriptor. If the digits in _w_o_r_d do not specify a file de- - scriptor open for input, a redirection error occurs. If _w_o_r_d evaluates - to --, file descriptor _n is closed. If _n is not specified, the standard + that file descriptor. If the digits in _w_o_r_d do not specify a file de- + scriptor open for input, a redirection error occurs. If _w_o_r_d evaluates + to --, file descriptor _n is closed. If _n is not specified, the standard input (file descriptor 0) is used. The operator [_n]>>&&_w_o_r_d - is used similarly to duplicate output file descriptors. If _n is not - specified, the standard output (file descriptor 1) is used. If the dig- - its in _w_o_r_d do not specify a file descriptor open for output, a redi- - rection error occurs. If _w_o_r_d evaluates to --, file descriptor _n is - closed. As a special case, if _n is omitted, and _w_o_r_d does not expand to - one or more digits or --, the standard output and standard error are + is used similarly to duplicate output file descriptors. If _n is not + specified, the standard output (file descriptor 1) is used. If the + digits in _w_o_r_d do not specify a file descriptor open for output, a re- + direction error occurs. If _w_o_r_d evaluates to --, file descriptor _n is + closed. As a special case, if _n is omitted, and _w_o_r_d does not expand + to one or more digits or --, the standard output and standard error are redirected as described previously. MMoovviinngg FFiillee DDeessccrriippttoorrss @@ -2460,7 +2476,7 @@ RREEDDIIRREECCTTIIOONN [_n]<<&&_d_i_g_i_t-- moves the file descriptor _d_i_g_i_t to file descriptor _n, or the standard - input (file descriptor 0) if _n is not specified. _d_i_g_i_t is closed after + input (file descriptor 0) if _n is not specified. _d_i_g_i_t is closed after being duplicated to _n. Similarly, the redirection operator @@ -2477,7 +2493,7 @@ RREEDDIIRREECCTTIIOONN causes the file whose name is the expansion of _w_o_r_d to be opened for both reading and writing on file descriptor _n, or on file descriptor 0 - if _n is not specified. If the file does not exist, it is created. + if _n is not specified. If the file does not exist, it is created. AALLIIAASSEESS _A_l_i_a_s_e_s allow a string to be substituted for a word that is in a posi- @@ -2489,15 +2505,15 @@ AALLIIAASSEESS If the shell reads an unquoted word in the right position, it checks the word to see if it matches an alias name. If it matches, the shell replaces the word with the alias value, and reads that value as if it - had been read instead of the word. The shell doesn't look at any char- + had been read instead of the word. The shell doesn't look at any char- acters following the word before attempting alias substitution. The characters //, $$, ``, and == and any of the shell _m_e_t_a_c_h_a_r_a_c_t_e_r_s or - quoting characters listed above may not appear in an alias name. The + quoting characters listed above may not appear in an alias name. The replacement text may contain any valid shell input, including shell - metacharacters. The first word of the replacement text is tested for + metacharacters. 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 llss to llss --FF, for + expanded a second time. This means that one may alias llss to llss --FF, for instance, and bbaasshh does not try to recursively expand the replacement text. @@ -2507,7 +2523,7 @@ AALLIIAASSEESS Aliases are created and listed with the aalliiaass command, and removed with the uunnaalliiaass command. - There is no mechanism for using arguments in the replacement text. If + There is no mechanism for using arguments in the replacement text. If arguments are needed, use a shell function (see FFUUNNCCTTIIOONNSS below). Aliases are not expanded when the shell is not interactive, unless the @@ -2515,32 +2531,32 @@ AALLIIAASSEESS sshhoopptt under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). The rules concerning the definition and use of aliases are somewhat - confusing. BBaasshh always reads at least one complete line of input, and + confusing. BBaasshh always reads at least one complete line of input, and all lines that make up a compound command, before executing any of the - commands on that line or the compound command. Aliases are expanded + commands on that line or the compound command. 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 ex- - panded when a function definition is read, not when the function is ex- - ecuted, because a function definition is itself a command. As a conse- - quence, 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 aalliiaass in compound commands. + 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 command. As a + consequence, aliases defined in a function are not available until af- + ter that function is executed. To be safe, always put alias defini- + tions on a separate line, and do not use aalliiaass in compound commands. For almost every purpose, aliases are superseded by shell functions. FFUUNNCCTTIIOONNSS A shell function, defined as described above under SSHHEELLLL GGRRAAMMMMAARR, - stores a series of commands for later execution. When the name of a + stores a series of commands for later execution. When the name of a shell function is used as a simple command name, the list of commands - associated with that function name is executed. Functions are executed + associated with that function name is executed. Functions are executed in the context of the current shell; no new process is created to in- - terpret them (contrast this with the execution of a shell script). When - a function is executed, the arguments to the function become the posi- - tional parameters during its execution. The special parameter ## is up- - dated to reflect the change. Special parameter 00 is unchanged. The + terpret them (contrast this with the execution of a shell script). + When a function is executed, the arguments to the function become the + positional parameters during its execution. The special parameter ## is + updated to reflect the change. Special parameter 00 is unchanged. The first element of the FFUUNNCCNNAAMMEE variable is set to the name of the func- tion while the function is executing. @@ -2555,30 +2571,30 @@ FFUUNNCCTTIIOONNSS option has been enabled. Variables local to the function may be declared with the llooccaall builtin - command (_l_o_c_a_l _v_a_r_i_a_b_l_e_s). Ordinarily, variables and their values are - shared between the function and its caller. If a variable is declared + command (_l_o_c_a_l _v_a_r_i_a_b_l_e_s). Ordinarily, variables and their values are + shared between the function and its caller. If a variable is declared llooccaall, the variable's visible scope is restricted to that function and its children (including the functions it calls). In the following description, the _c_u_r_r_e_n_t _s_c_o_p_e is a currently- execut- - ing function. Previous scopes consist of that function's caller and so + ing function. Previous scopes consist of that function's caller and so on, back to the "global" scope, where the shell is not executing any - shell function. Consequently, a local variable at the current scope is + shell function. Consequently, a local variable at the current scope is a variable declared using the llooccaall or ddeeccllaarree builtins in the function that is currently executing. Local variables "shadow" variables with the same name declared at pre- - vious scopes. For instance, a local variable declared in a function + vious scopes. For instance, a local variable declared in a function hides a global variable of the same name: references and assignments refer to the local variable, leaving the global variable unmodified. When the function returns, the global variable is once again visible. The shell uses _d_y_n_a_m_i_c _s_c_o_p_i_n_g to control a variable's visibility - within functions. With dynamic scoping, visible variables and their + within functions. With dynamic scoping, visible variables and their values are a result of the sequence of function calls that caused exe- - cution to reach the current function. The value of a variable that a + cution to reach the current function. The value of a variable that a function sees depends on its value within its caller, if any, whether - that caller is the "global" scope or another shell function. This is + that caller is the "global" scope or another shell function. This is also the value that a local variable declaration "shadows", and the value that is restored when the function returns. @@ -2590,48 +2606,48 @@ FFUUNNCCTTIIOONNSS The uunnsseett builtin also acts using the same dynamic scope: if a variable is local to the current scope, uunnsseett will unset it; otherwise the unset will refer to the variable found in any calling scope as described - above. If a variable at the current local scope is unset, it will re- + above. If a variable at the current local scope is unset, it will re- main so (appearing as unset) until it is reset in that scope or until the function returns. Once the function returns, any instance of the - variable at a previous scope will become visible. If the unset acts on + variable at a previous scope will become visible. If the unset acts on a variable at a previous scope, any instance of a variable with that name that had been shadowed will become visible (see below how the lloo-- ccaallvvaarr__uunnsseett shell option changes this behavior). The FFUUNNCCNNEESSTT variable, if set to a numeric value greater than 0, de- - fines a maximum function nesting level. Function invocations that ex- + fines a maximum function nesting level. Function invocations that ex- ceed the limit cause the entire command to abort. If the builtin command rreettuurrnn is executed in a function, the function completes and execution resumes with the next command after the func- - tion call. Any command associated with the RREETTUURRNN trap is executed be- - fore execution resumes. When a function completes, the values of the + tion call. Any command associated with the RREETTUURRNN trap is executed be- + fore execution resumes. When a function completes, the values of the positional parameters and the special parameter ## are restored to the values they had prior to the function's execution. Function names and definitions may be listed with the --ff option to the - ddeeccllaarree or ttyyppeesseett builtin commands. The --FF option to ddeeccllaarree or ttyyppee-- + ddeeccllaarree or ttyyppeesseett builtin commands. The --FF option to ddeeccllaarree or ttyyppee-- sseett will list the function names only (and optionally the source file - and line number, if the eexxttddeebbuugg shell option is enabled). Functions + and line number, if the eexxttddeebbuugg shell option is enabled). Functions may be exported so that child shell processes (those created when exe- cuting a separate shell invocation) automatically have them defined - with the --ff option to the eexxppoorrtt builtin. A function definition may be + with the --ff option to the eexxppoorrtt builtin. A function definition may be deleted using the --ff option to the uunnsseett builtin. - Functions may be recursive. The FFUUNNCCNNEESSTT variable may be used to limit + Functions may be recursive. The FFUUNNCCNNEESSTT variable may be used to limit the depth of the function call stack and restrict the number of func- - tion invocations. By default, no limit is imposed on the number of re- + tion invocations. By default, no limit is imposed on the number of re- cursive calls. AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN The shell allows arithmetic expressions to be evaluated, under certain circumstances (see the lleett and ddeeccllaarree builtin commands, the (((( com- - pound command, and AArriitthhmmeettiicc EExxppaannssiioonn). Evaluation is done in fixed- + pound command, and AArriitthhmmeettiicc EExxppaannssiioonn). Evaluation is done in fixed- width integers with no check for overflow, though division by 0 is - trapped and flagged as an error. The operators and their precedence, - associativity, and values are the same as in the C language. The fol- + trapped and flagged as an error. The operators and their precedence, + associativity, and values are the same as in the C language. The fol- lowing list of operators is grouped into levels of equal-precedence op- - erators. The levels are listed in order of decreasing precedence. + erators. The levels are listed in order of decreasing precedence. _i_d++++ _i_d---- variable post-increment and post-decrement @@ -2659,45 +2675,45 @@ AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN comma Shell variables are allowed as operands; parameter expansion is per- - formed before the expression is evaluated. Within an expression, shell + formed before the expression is evaluated. Within an expression, shell variables may also be referenced by name without using the parameter - expansion syntax. A shell variable that is null or unset evaluates to 0 - when referenced by name without using the parameter expansion syntax. + expansion syntax. A shell variable that is null or unset evaluates to + 0 when referenced by name without using the parameter expansion syntax. The value of a variable is evaluated as an arithmetic expression when it is referenced, or when a variable which has been given the _i_n_t_e_g_e_r - attribute using ddeeccllaarree --ii is assigned a value. A null value evaluates - to 0. A shell variable need not have its _i_n_t_e_g_e_r attribute turned on to - be used in an expression. + attribute using ddeeccllaarree --ii is assigned a value. A null value evaluates + to 0. A shell variable need not have its _i_n_t_e_g_e_r attribute turned on + to be used in an expression. Integer constants follow the C language definition, without suffixes or - character constants. Constants with a leading 0 are interpreted as oc- - tal numbers. A leading 0x or 0X denotes hexadecimal. Otherwise, numbers - take the form [_b_a_s_e_#]n, where the optional _b_a_s_e is a decimal number be- - tween 2 and 64 representing the arithmetic base, and _n is a number in - that base. If _b_a_s_e_# is omitted, then base 10 is used. When specifying - _n, if a non-digit is required, the digits greater than 9 are repre- - sented by the lowercase letters, the uppercase letters, @, and _, in - that order. If _b_a_s_e is less than or equal to 36, lowercase and upper- - case letters may be used interchangeably to represent numbers between - 10 and 35. + character constants. Constants with a leading 0 are interpreted as oc- + tal numbers. A leading 0x or 0X denotes hexadecimal. Otherwise, num- + bers take the form [_b_a_s_e_#]n, where the optional _b_a_s_e is a decimal num- + ber between 2 and 64 representing the arithmetic base, and _n is a num- + ber in that base. If _b_a_s_e_# is omitted, then base 10 is used. When + specifying _n, if a non-digit is required, the digits greater than 9 are + represented by the lowercase letters, the uppercase letters, @, and _, + in that order. If _b_a_s_e is less than or equal to 36, lowercase and up- + percase letters may be used interchangeably to represent numbers be- + tween 10 and 35. - Operators are evaluated in order of precedence. Sub-expressions in + Operators are evaluated in order of precedence. Sub-expressions in parentheses are evaluated first and may override the precedence rules above. CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS Conditional expressions are used by the [[[[ compound command and the tteesstt and [[ builtin commands to test file attributes and perform string - and arithmetic comparisons. The tteesstt and [[ commands determine their be- - havior based on the number of arguments; see the descriptions of those - commands for any other command-specific actions. + and arithmetic comparisons. The tteesstt and [[ commands determine their + behavior based on the number of arguments; see the descriptions of + those commands for any other command-specific actions. Expressions are formed from the following unary or binary primaries. BBaasshh handles several filenames specially when they are used in expres- - sions. If the operating system on which bbaasshh is running provides these + sions. If the operating system on which bbaasshh is running provides these special files, bash will use them; otherwise it will emulate them in- ternally with this behavior: If any _f_i_l_e argument to one of the pri- - maries is of the form _/_d_e_v_/_f_d_/_n, then file descriptor _n is checked. If + maries is of the form _/_d_e_v_/_f_d_/_n, then file descriptor _n is checked. If the _f_i_l_e argument to one of the primaries is one of _/_d_e_v_/_s_t_d_i_n, _/_d_e_v_/_s_t_d_o_u_t, or _/_d_e_v_/_s_t_d_e_r_r, file descriptor 0, 1, or 2, respectively, is checked. @@ -2707,8 +2723,9 @@ CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS itself. When used with [[[[, or when the shell is in _p_o_s_i_x _m_o_d_e, the << and >> op- - erators sort lexicographically using the current locale. When the shell - is not in _p_o_s_i_x _m_o_d_e, the tteesstt command sorts using ASCII ordering. + erators sort lexicographically using the current locale. When the + shell is not in _p_o_s_i_x _m_o_d_e, the tteesstt command sorts using ASCII order- + ing. --aa _f_i_l_e True if _f_i_l_e exists. @@ -2746,31 +2763,32 @@ CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS --LL _f_i_l_e True if _f_i_l_e exists and is a symbolic link. --NN _f_i_l_e - True if _f_i_l_e exists and has been modified since it was last + True if _f_i_l_e exists and has been modified since it was last read. --OO _f_i_l_e True if _f_i_l_e exists and is owned by the effective user id. --SS _f_i_l_e True if _f_i_l_e exists and is a socket. _f_i_l_e_1 --eeff _f_i_l_e_2 - True if _f_i_l_e_1 and _f_i_l_e_2 refer to the same device and inode num- + True if _f_i_l_e_1 and _f_i_l_e_2 refer to the same device and inode num- bers. _f_i_l_e_1 -nntt _f_i_l_e_2 - True if _f_i_l_e_1 is newer (according to modification date) than + True if _f_i_l_e_1 is newer (according to modification date) than _f_i_l_e_2, or if _f_i_l_e_1 exists and _f_i_l_e_2 does not. _f_i_l_e_1 -oott _f_i_l_e_2 - True if _f_i_l_e_1 is older than _f_i_l_e_2, or if _f_i_l_e_2 exists and _f_i_l_e_1 + True if _f_i_l_e_1 is older than _f_i_l_e_2, or if _f_i_l_e_2 exists and _f_i_l_e_1 does not. --oo _o_p_t_n_a_m_e - True if the shell option _o_p_t_n_a_m_e is enabled. See the list of op- - tions under the description of the --oo option to the sseett builtin - below. + True if the shell option _o_p_t_n_a_m_e is enabled. See the list of + options under the description of the --oo option to the sseett + builtin below. --vv _v_a_r_n_a_m_e - True if the shell variable _v_a_r_n_a_m_e is set (has been assigned a - value). If _v_a_r_n_a_m_e is an indexed array variable name subscripted - by _@ or _*, this returns true if the array has any set elements. - If _v_a_r_n_a_m_e is an associative array variable name subscripted by - _@ or _*, this returns true if an element with that key is set. + True if the shell variable _v_a_r_n_a_m_e is set (has been assigned a + value). If _v_a_r_n_a_m_e is an indexed array variable name sub- + scripted by _@ or _*, this returns true if the array has any set + elements. If _v_a_r_n_a_m_e is an associative array variable name sub- + scripted by _@ or _*, this returns true if an element with that + key is set. --RR _v_a_r_n_a_m_e True if the shell variable _v_a_r_n_a_m_e is set and is a name refer- ence. @@ -2782,8 +2800,8 @@ CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS _s_t_r_i_n_g_1 ==== _s_t_r_i_n_g_2 _s_t_r_i_n_g_1 == _s_t_r_i_n_g_2 - True if the strings are equal. == should be used with the tteesstt - command for POSIX conformance. When used with the [[[[ command, + True if the strings are equal. == should be used with the tteesstt + command for POSIX conformance. When used with the [[[[ command, this performs pattern matching as described above (CCoommppoouunndd CCoomm-- mmaannddss). @@ -2800,10 +2818,10 @@ CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS OOPP is one of --eeqq, --nnee, --lltt, --llee, --ggtt, or --ggee. These arithmetic binary operators return true if _a_r_g_1 is equal to, not equal to, less than, less than or equal to, greater than, or greater than - or equal to _a_r_g_2, respectively. _A_r_g_1 and _a_r_g_2 may be positive or - negative integers. When used with the [[[[ command, _A_r_g_1 and _A_r_g_2 - are evaluated as arithmetic expressions (see AARRIITTHHMMEETTIICC EEVVAALLUUAA-- - TTIIOONN above). + or equal to _a_r_g_2, respectively. _A_r_g_1 and _a_r_g_2 may be positive + or negative integers. When used with the [[[[ command, _A_r_g_1 and + _A_r_g_2 are evaluated as arithmetic expressions (see AARRIITTHHMMEETTIICC + EEVVAALLUUAATTIIOONN above). SSIIMMPPLLEE CCOOMMMMAANNDD EEXXPPAANNSSIIOONN When a simple command is executed, the shell performs the following ex- @@ -2815,9 +2833,9 @@ SSIIMMPPLLEE CCOOMMMMAANNDD EEXXPPAANNSSIIOONN for later processing. 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. + 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. 3. Redirections are performed as described above under RREEDDIIRREECCTTIIOONN. @@ -2827,82 +2845,83 @@ SSIIMMPPLLEE CCOOMMMMAANNDD EEXXPPAANNSSIIOONN able. If no command name results, the variable assignments affect the current - shell environment. In the case of such a command (one that consists + shell environment. In the case of such a command (one that consists only of assignment statements and redirections), assignment statements - are performed before redirections. Otherwise, the variables are added + are performed before redirections. Otherwise, the variables are added to the environment of the executed command and do not affect the cur- - rent shell environment. If any of the assignments attempts to assign a + rent 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 af- - fect the current shell environment. A redirection error causes the com- - mand to exit with a non-zero status. + fect 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. + described below. Otherwise, the command exits. If one of the expan- + sions 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. CCOOMMMMAANNDD EEXXEECCUUTTIIOONN - After a command has been split into words, if it results in a simple - command and an optional list of arguments, the shell performs the fol- + After a command has been split into words, if it results in a simple + command and an optional list of arguments, the shell performs the fol- lowing actions. - If the command name contains no slashes, the shell attempts to locate - it. If there exists a shell function by that name, that function is in- - voked as described above in FFUUNNCCTTIIOONNSS. If the name does not match a - function, the shell searches for it in the list of shell builtins. If a - match is found, that builtin is invoked. + If the command name contains no slashes, the shell attempts to locate + it. If there exists a shell function by that name, that function is + invoked as described above in FFUUNNCCTTIIOONNSS. If the name does not match a + function, the shell searches for it in the list of shell builtins. If + a match is found, that builtin is invoked. - If the name is neither a shell function nor a builtin, and contains no - slashes, bbaasshh searches each element of the PPAATTHH for a directory con- - taining an executable file by that name. BBaasshh uses a hash table to re- - member the full pathnames of executable files (see hhaasshh under SSHHEELLLL - BBUUIILLTTIINN CCOOMMMMAANNDDSS below). A full search of the directories in PPAATTHH is - performed only if the command is not found in the hash table. If the + If the name is neither a shell function nor a builtin, and contains no + slashes, bbaasshh searches each element of the PPAATTHH for a directory con- + taining an executable file by that name. BBaasshh uses a hash table to re- + member the full pathnames of executable files (see hhaasshh under SSHHEELLLL + BBUUIILLTTIINN CCOOMMMMAANNDDSS below). A full search of the directories in PPAATTHH is + performed only if the command is not found in the hash table. If the search is unsuccessful, the shell searches for a defined shell function - named ccoommmmaanndd__nnoott__ffoouunndd__hhaannddllee. If that function exists, it is invoked - in a separate execution environment with the original command and the - original command's arguments as its arguments, and the function's exit - status becomes the exit status of that subshell. If that function is + named ccoommmmaanndd__nnoott__ffoouunndd__hhaannddllee. If that function exists, it is invoked + in a separate execution environment with the original command and the + original command's arguments as its arguments, and the function's exit + status becomes the exit status of that subshell. If that function is not defined, the shell prints an error message and returns an exit sta- tus of 127. - If the search is successful, or if the command name contains one or + If the search is successful, or if the command name contains one or more slashes, the shell executes the named program in a separate execu- - tion environment. Argument 0 is set to the name given, and the remain- + tion environment. Argument 0 is set to the name given, and the remain- ing arguments to the command are set to the arguments given, if any. - If this execution fails because the file is not in executable format, - and the file is not a directory, it is assumed to be a _s_h_e_l_l _s_c_r_i_p_t, a + If this execution fails because the file is not in executable format, + and the file is not a directory, it is assumed to be a _s_h_e_l_l _s_c_r_i_p_t, a file containing shell commands, and the shell creates a new instance of - itself to execute it. This subshell reinitializes itself, so that the + itself to execute it. This subshell reinitializes itself, so that the effect is as if a new shell had been invoked to handle the script, with - the exception that the locations of commands remembered by the parent - (see hhaasshh below under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS) are retained by the + the exception that the locations of commands remembered by the parent + (see hhaasshh below under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS) are retained by the child. - If the program is a file beginning with ##!!, the remainder of the first - line specifies an interpreter for the program. The shell executes the + If the program is a file beginning with ##!!, the remainder of the first + line specifies an interpreter for the program. The shell executes the specified interpreter on operating systems that do not handle this exe- - cutable format themselves. The arguments to the 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 + cutable format themselves. The arguments to the 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. CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONNMMEENNTT - The shell has an _e_x_e_c_u_t_i_o_n _e_n_v_i_r_o_n_m_e_n_t, which consists of the follow- + The shell has an _e_x_e_c_u_t_i_o_n _e_n_v_i_r_o_n_m_e_n_t, which consists of the follow- ing: - +o open files inherited by the shell at invocation, as modified by + +o open files inherited by the shell at invocation, as modified by redirections supplied to the eexxeecc builtin - +o the current working directory as set by ccdd, ppuusshhdd, or ppooppdd, or + +o the current working directory as set by ccdd, ppuusshhdd, or ppooppdd, or inherited by the shell at invocation - +o the file creation mode mask as set by uummaasskk or inherited from + +o the file creation mode mask as set by uummaasskk or inherited from the shell's parent +o current traps set by ttrraapp @@ -2910,280 +2929,283 @@ CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONNMMEENN +o shell parameters that are set by variable assignment or with sseett or inherited from the shell's parent in the environment - +o shell functions defined during execution or inherited from the + +o shell functions defined during execution or inherited from the shell's parent in the environment - +o options enabled at invocation (either by default or with com- + +o options enabled at invocation (either by default or with com- mand-line arguments) or by sseett +o options enabled by sshhoopptt +o shell aliases defined with aalliiaass - +o various process IDs, including those of background jobs, the + +o various process IDs, including those of background jobs, the value of $$$$, and the value of PPPPIIDD - When a simple command other than a builtin or shell function is to be - executed, it is invoked in a separate execution environment that con- - sists of the following. Unless otherwise noted, the values are inher- + When a simple command other than a builtin or shell function is to be + executed, it is invoked in a separate execution environment that con- + sists of the following. Unless otherwise noted, the values are inher- ited from the shell. - +o the shell's open files, plus any modifications and additions + +o the shell's open files, plus any modifications and additions specified by redirections to the command +o the current working directory +o the file creation mode mask - +o shell variables and functions marked for export, along with + +o shell variables and functions marked for export, along with variables exported for the command, passed in the environment +o 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 + A command invoked in this separate environment cannot affect the shell's execution environment. A _s_u_b_s_h_e_l_l is a copy of the shell process. - Command substitution, commands grouped with parentheses, and asynchro- + Command substitution, commands grouped with parentheses, and asynchro- nous commands are invoked in a subshell environment that is a duplicate of the shell environment, except that traps caught by the shell are re- - set to the values that the shell inherited from its parent at invoca- - tion. Builtin commands that are invoked as part of a pipeline are also - executed in a subshell environment. Changes made to the subshell envi- + set to the values that the shell inherited from its parent at invoca- + tion. Builtin commands that are invoked as part of a pipeline are also + executed in a subshell environment. Changes made to the subshell envi- ronment cannot affect the shell's execution environment. Subshells spawned to execute command substitutions inherit the value of - the --ee option from the parent shell. When not in _p_o_s_i_x _m_o_d_e, bbaasshh + the --ee option from the parent shell. When not in _p_o_s_i_x _m_o_d_e, bbaasshh clears the --ee option in such subshells. - If a command is followed by a && and job control is not active, the de- - fault standard input for the command is the empty file _/_d_e_v_/_n_u_l_l. Oth- - erwise, the invoked command inherits the file descriptors of the call- + If a command is followed by a && and job control is not active, the de- + fault standard input for the command is the empty file _/_d_e_v_/_n_u_l_l. Oth- + erwise, the invoked command inherits the file descriptors of the call- ing shell as modified by redirections. EENNVVIIRROONNMMEENNTT - When a program is invoked it is given an array of strings called the - _e_n_v_i_r_o_n_m_e_n_t. This is a list of _n_a_m_e-_v_a_l_u_e pairs, of the form + When a program is invoked it is given an array of strings called the + _e_n_v_i_r_o_n_m_e_n_t. This is a list of _n_a_m_e-_v_a_l_u_e pairs, of the form _n_a_m_e=_v_a_l_u_e. - The shell provides several ways to manipulate the environment. On invo- - cation, the shell scans its own environment and creates a parameter for - each name found, automatically marking it for _e_x_p_o_r_t to child pro- - cesses. Executed commands inherit the environment. The eexxppoorrtt and ddee-- - ccllaarree --xx commands allow parameters and functions to be added to and - deleted from the environment. If the value of a parameter in the envi- + The shell provides several ways to manipulate the environment. On in- + vocation, the shell scans its own environment and creates a parameter + for each name found, automatically marking it for _e_x_p_o_r_t to child pro- + cesses. Executed commands inherit the environment. The eexxppoorrtt and ddee-- + ccllaarree --xx commands allow parameters and functions to be added to and + deleted from the environment. If the value of a parameter in the envi- ronment is modified, the new value becomes part of the environment, re- - placing the old. The environment inherited by any executed command con- - sists of the shell's initial environment, whose values may be modified - in the shell, less any pairs removed by the uunnsseett command, plus any ad- - ditions via the eexxppoorrtt and ddeeccllaarree --xx commands. + placing the old. The environment inherited by any executed command + consists of the shell's initial environment, whose values may be modi- + fied in the shell, less any pairs removed by the uunnsseett command, plus + any additions via the eexxppoorrtt and ddeeccllaarree --xx commands. - The environment for any _s_i_m_p_l_e _c_o_m_m_a_n_d or function may be augmented - temporarily by prefixing it with parameter assignments, as described - above in PPAARRAAMMEETTEERRSS. These assignment statements affect only the envi- + The environment for any _s_i_m_p_l_e _c_o_m_m_a_n_d or function may be augmented + temporarily by prefixing it with parameter assignments, as described + above in PPAARRAAMMEETTEERRSS. These assignment statements affect only the envi- ronment seen by that command. - If the --kk option is set (see the sseett builtin command below), then _a_l_l - parameter assignments are placed in the environment for a command, not + If the --kk option is set (see the sseett builtin command below), then _a_l_l + parameter assignments are placed in the environment for a command, not just those that precede the command name. - When bbaasshh invokes an external command, the variable __ is set to the + When bbaasshh invokes an external command, the variable __ is set to the full filename of the command and passed to that command in its environ- ment. EEXXIITT SSTTAATTUUSS - The exit status of an executed command is the value returned by the - _w_a_i_t_p_i_d system call or equivalent function. Exit statuses fall between - 0 and 255, though, as explained below, the shell may use values above - 125 specially. Exit statuses from shell builtins and compound commands - are also limited to this range. Under certain circumstances, the shell + The exit status of an executed command is the value returned by the + _w_a_i_t_p_i_d system call or equivalent function. Exit statuses fall between + 0 and 255, though, as explained below, the shell may use values above + 125 specially. Exit statuses from shell builtins and compound commands + are also limited to this range. Under certain circumstances, the shell will use special values to indicate specific failure modes. 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 + has succeeded. An exit status of zero indicates success. A non-zero + exit status indicates failure. When a command terminates on a fatal signal _N, bbaasshh uses the value of 128+_N as the exit status. - If a command is not found, the child process created to execute it re- - turns a status of 127. If a command is found but is not executable, the - return status is 126. + If a command is not found, the child process created to execute it re- + turns 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. - Shell builtin commands return a status of 0 (_t_r_u_e) if successful, and - non-zero (_f_a_l_s_e) if an error occurs while they execute. All builtins - return an exit status of 2 to indicate incorrect usage, generally in- + Shell builtin commands return a status of 0 (_t_r_u_e) if successful, and + non-zero (_f_a_l_s_e) if an error occurs while they execute. All builtins + return an exit status of 2 to indicate incorrect usage, generally in- valid options or missing arguments. The exit status of the last command is available in the special parame- ter $?. - BBaasshh itself returns the exit status of the last command executed, un- - less a syntax error occurs, in which case it exits with a non-zero - value. See also the eexxiitt builtin command below. + BBaasshh itself returns the exit status of the last command executed, un- + less a syntax error occurs, in which case it exits with a non-zero + value. See also the eexxiitt builtin command below. SSIIGGNNAALLSS - When bbaasshh is interactive, in the absence of any traps, it ignores + When bbaasshh is interactive, in the absence of any traps, it ignores SSIIGGTTEERRMM (so that kkiillll 00 does not kill an interactive shell), and SSIIGGIINNTT - is caught and handled (so that the wwaaiitt builtin is interruptible). In - all cases, bbaasshh ignores SSIIGGQQUUIITT. If job control is in effect, bbaasshh ig- + is caught and handled (so that the wwaaiitt builtin is interruptible). In + all cases, bbaasshh ignores SSIIGGQQUUIITT. If job control is in effect, bbaasshh ig- nores SSIIGGTTTTIINN, SSIIGGTTTTOOUU, and SSIIGGTTSSTTPP. Non-builtin commands run by bbaasshh have signal handlers set to the values - inherited by the shell from its parent. When job control is not in ef- - fect, asynchronous commands ignore SSIIGGIINNTT and SSIIGGQQUUIITT in addition to - these inherited handlers. Commands run as a result of command substitu- - tion ignore the keyboard-generated job control signals SSIIGGTTTTIINN, SSIIGGTT-- + inherited by the shell from its parent. When job control is not in ef- + fect, asynchronous commands ignore SSIIGGIINNTT and SSIIGGQQUUIITT in addition to + these inherited handlers. Commands run as a result of command substi- + tution ignore the keyboard-generated job control signals SSIIGGTTTTIINN, SSIIGGTT-- TTOOUU, and SSIIGGTTSSTTPP. - The shell exits by default upon receipt of a SSIIGGHHUUPP. Before exiting, an - interactive shell resends the SSIIGGHHUUPP to all jobs, running or stopped. - Stopped jobs are sent SSIIGGCCOONNTT to ensure that they receive the SSIIGGHHUUPP. - To prevent the shell from sending the signal to a particular job, it - should be removed from the jobs table with the ddiissoowwnn builtin (see - SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) or marked to not receive SSIIGGHHUUPP using - ddiissoowwnn --hh. + The shell exits by default upon receipt of a SSIIGGHHUUPP. Before exiting, + an interactive shell resends the SSIIGGHHUUPP to all jobs, running or + stopped. Stopped jobs are sent SSIIGGCCOONNTT to ensure that they receive the + SSIIGGHHUUPP. To prevent the shell from sending the signal to a particular + job, it should be removed from the jobs table with the ddiissoowwnn builtin + (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) or marked to not receive SSIIGGHHUUPP us- + ing ddiissoowwnn --hh. - If the hhuuppoonneexxiitt shell option has been set with sshhoopptt, bbaasshh sends a + If the hhuuppoonneexxiitt shell option has been set with sshhoopptt, bbaasshh sends a SSIIGGHHUUPP to all jobs when an interactive login shell exits. - If bbaasshh is waiting for a command to complete and receives a signal for + If bbaasshh is waiting for a command to complete and receives a signal for which a trap has been set, the trap will not be executed until the com- - mand completes. When bbaasshh is waiting for an asynchronous command via - the wwaaiitt builtin, the reception of a signal for which a trap has been + mand completes. When bbaasshh is waiting for an asynchronous command via + the wwaaiitt builtin, the reception of a signal for which a trap has been set will cause the wwaaiitt builtin to return immediately with an exit sta- tus greater than 128, immediately after which the trap is executed. - When job control is not enabled, and bbaasshh is waiting for a foreground + When job control is not enabled, and bbaasshh is waiting for a foreground command to complete, the shell receives keyboard-generated signals such - as SSIIGGIINNTT (usually generated by ^^CC) that users commonly intend to send - to that command. This happens because the shell and the command are in + as SSIIGGIINNTT (usually generated by ^^CC) that users commonly intend to send + to that command. This happens because the shell and the command are in the same process group as the terminal, and ^^CC sends SSIIGGIINNTT to all pro- cesses in that process group. - When bbaasshh is running without job control enabled and receives SSIIGGIINNTT - while waiting for a foreground command, it waits until that foreground + When bbaasshh is running without job control enabled and receives SSIIGGIINNTT + while waiting for a foreground command, it waits until that foreground command terminates and then decides what to do about the SSIIGGIINNTT: 1. If the command terminates due to the SSIIGGIINNTT, bbaasshh concludes that - the user meant to end the entire script, and acts on the SSIIGGIINNTT + the user meant to end the entire script, and acts on the SSIIGGIINNTT (e.g., by running a SSIIGGIINNTT trap or exiting itself); - 2. If the command does not terminate due to SSIIGGIINNTT, the program - handled the SSIIGGIINNTT itself and did not treat it as a fatal sig- - nal. In that case, bbaasshh does not treat SSIIGGIINNTT as a fatal signal, - either, instead assuming that the SSIIGGIINNTT was used as part of the - program's normal operation (e.g., emacs uses it to abort editing - commands) or deliberately discarded. However, bbaasshh will run any - trap set on SSIIGGIINNTT, as it does with any other trapped signal it - receives while it is waiting for the foreground command to com- - plete, for compatibility. + 2. If the command does not terminate due to SSIIGGIINNTT, the program + handled the SSIIGGIINNTT itself and did not treat it as a fatal sig- + nal. In that case, bbaasshh does not treat SSIIGGIINNTT as a fatal sig- + nal, either, instead assuming that the SSIIGGIINNTT was used as part + of the program's normal operation (e.g., emacs uses it to abort + editing commands) or deliberately discarded. However, bbaasshh will + run any trap set on SSIIGGIINNTT, as it does with any other trapped + signal it receives while it is waiting for the foreground com- + mand to complete, for compatibility. JJOOBB CCOONNTTRROOLL _J_o_b _c_o_n_t_r_o_l refers to the ability to selectively stop (_s_u_s_p_e_n_d) the ex- - ecution of processes and continue (_r_e_s_u_m_e) their execution at a later - point. A user typically employs this facility via an interactive inter- - face supplied jointly by the operating system kernel's terminal driver - and bbaasshh. + ecution of processes and continue (_r_e_s_u_m_e) their execution at a later + point. A user typically employs this facility via an interactive in- + terface supplied jointly by the operating system kernel's terminal + driver and bbaasshh. - The shell associates a _j_o_b with each pipeline. It keeps a table of cur- - rently executing jobs, which may be listed with the jjoobbss command. When - bbaasshh starts a job asynchronously (in the _b_a_c_k_g_r_o_u_n_d), it prints a line - that looks like: + The shell associates a _j_o_b with each pipeline. It keeps a table of + currently executing jobs, which may be listed with the jjoobbss command. + When bbaasshh starts a job asynchronously (in the _b_a_c_k_g_r_o_u_n_d), it prints a + line that looks like: [1] 25647 indicating that this job is job number 1 and that the process ID of the - last process in the pipeline associated with this job is 25647. All of - the processes in a single pipeline are members of the same job. BBaasshh + last process in the pipeline associated with this job is 25647. All of + the processes in a single pipeline are members of the same job. BBaasshh uses the _j_o_b abstraction as the basis for job control. - To facilitate the implementation of the user interface to job control, + To facilitate the implementation of the user interface to job control, the operating system maintains the notion of a _c_u_r_r_e_n_t _t_e_r_m_i_n_a_l _p_r_o_c_e_s_s - _g_r_o_u_p _I_D. Members of this process group (processes whose process group + _g_r_o_u_p _I_D. Members of this process group (processes whose process group ID is equal to the current terminal process group ID) receive keyboard- - generated signals such as SSIIGGIINNTT. These processes are said to be in the - _f_o_r_e_g_r_o_u_n_d. _B_a_c_k_g_r_o_u_n_d processes are those whose process group ID dif- - fers from the terminal's; such processes are immune to keyboard-gener- - ated signals. Only foreground processes are allowed to read from or, if - the user so specifies with stty tostop, write to the terminal. Back- - ground processes which attempt to read from (write to when stty tostop - is in effect) the terminal are sent a SSIIGGTTTTIINN ((SSIIGGTTTTOOUU)) signal by the - kernel's terminal driver, which, unless caught, suspends the process. + generated signals such as SSIIGGIINNTT. These processes are said to be in + the _f_o_r_e_g_r_o_u_n_d. _B_a_c_k_g_r_o_u_n_d processes are those whose process group ID + differs from the terminal's; such processes are immune to keyboard-gen- + erated signals. Only foreground processes are allowed to read from or, + if the user so specifies with stty tostop, write to the terminal. + Background processes which attempt to read from (write to when stty + tostop is in effect) the terminal are sent a SSIIGGTTTTIINN ((SSIIGGTTTTOOUU)) signal + by the kernel's terminal driver, which, unless caught, suspends the + process. If the operating system on which bbaasshh is running supports job control, - bbaasshh contains facilities to use it. Typing the _s_u_s_p_e_n_d character (typi- - cally ^^ZZ, Control-Z) while a process is running causes that process to - be stopped and returns control to bbaasshh. Typing the _d_e_l_a_y_e_d _s_u_s_p_e_n_d + bbaasshh contains facilities to use it. Typing the _s_u_s_p_e_n_d character (typ- + ically ^^ZZ, Control-Z) while a process is running causes that process to + be stopped and returns control to bbaasshh. Typing the _d_e_l_a_y_e_d _s_u_s_p_e_n_d character (typically ^^YY, Control-Y) causes the process to be stopped when it attempts to read input from the terminal, and control to be re- - turned to bbaasshh. The user may then manipulate the state of this job, us- - ing the bbgg command to continue it in the background, the ffgg command to - continue it in the foreground, or the kkiillll command to kill it. A ^^ZZ + turned to bbaasshh. The user may then manipulate the state of this job, + using the bbgg command to continue it in the background, the ffgg command + to continue it in the foreground, or the kkiillll command to kill it. A ^^ZZ 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 charac- - ter %% introduces a job specification (_j_o_b_s_p_e_c). Job number _n may be re- - ferred to as %%nn. A job may also be referred to using a prefix of the + There are a number of ways to refer to a job in the shell. The charac- + ter %% introduces a job specification (_j_o_b_s_p_e_c). Job number _n may be + referred to as %%nn. A job may also be referred to using a prefix of the name used to start it, or using a substring that appears in its command - line. For example, %%ccee refers to a stopped job whose command name be- + line. For example, %%ccee refers to a stopped job whose command name be- gins with ccee. If a prefix matches more than one job, bbaasshh reports an - error. Using %%??ccee, on the other hand, refers to any job containing the - string ccee in its command line. If the substring matches more than one - job, bbaasshh reports an error. The symbols %%%% and %%++ refer to the shell's + error. Using %%??ccee, on the other hand, refers to any job containing the + string ccee in its command line. If the substring matches more than one + job, bbaasshh reports an error. The symbols %%%% and %%++ refer to the shell's notion of the _c_u_r_r_e_n_t _j_o_b, which is the last job stopped while it was - in the foreground or started in the background. The _p_r_e_v_i_o_u_s _j_o_b may be - referenced using %%--. If there is only a single job, %%++ and %%-- can both - be used to refer to that job. In output pertaining to jobs (e.g., the - output of the jjoobbss command), the current job is always flagged with a - ++, and the previous job with a --. A single % (with no accompanying job - specification) also refers to the current job. + in the foreground or started in the background. The _p_r_e_v_i_o_u_s _j_o_b may + be referenced using %%--. If there is only a single job, %%++ and %%-- can + both be used to refer to that job. In output pertaining to jobs (e.g., + the output of the jjoobbss command), the current job is always flagged with + a ++, and the previous job with a --. A single % (with no accompanying + job specification) also refers to the current job. Simply naming a job can be used to bring it into the foreground: %%11 is a synonym for ````ffgg %%11'''', bringing job 1 from the background into the - foreground. Similarly, ````%%11 &&'''' resumes job 1 in the background, equiv- - alent to ````bbgg %%11''''. + foreground. Similarly, ````%%11 &&'''' resumes job 1 in the background, + equivalent to ````bbgg %%11''''. - The shell learns immediately whenever a job changes state. Normally, + The shell learns immediately whenever a job changes state. Normally, bbaasshh 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 --bb option to the sseett builtin command is enabled, bbaasshh reports such changes - immediately. Any trap on SSIIGGCCHHLLDD is executed for each child that exits. + immediately. Any trap on SSIIGGCCHHLLDD is executed for each child that ex- + its. - If an attempt to exit bbaasshh is made while jobs are stopped (or, if the - cchheecckkjjoobbss shell option has been enabled using the sshhoopptt builtin, run- + If an attempt to exit bbaasshh is made while jobs are stopped (or, if the + cchheecckkjjoobbss shell option has been enabled using the sshhoopptt builtin, run- ning), the shell prints a warning message, and, if the cchheecckkjjoobbss option - is enabled, lists the jobs and their statuses. The jjoobbss command may - then be used to inspect their status. If a second attempt to exit is - made without an intervening command, the shell does not print another + is enabled, lists the jobs and their statuses. The jjoobbss command may + then be used to inspect their status. If a second attempt to exit is + made without an intervening command, the shell does not print another warning, and any stopped jobs are terminated. - When the shell is waiting for a job or process using the wwaaiitt builtin, - and job control is enabled, wwaaiitt will return when the job changes - state. The --ff option causes wwaaiitt to wait until the job or process ter- + When the shell is waiting for a job or process using the wwaaiitt builtin, + and job control is enabled, wwaaiitt will return when the job changes + state. The --ff option causes wwaaiitt to wait until the job or process ter- minates before returning. PPRROOMMPPTTIINNGG When executing interactively, bbaasshh displays the primary prompt PPSS11 when - it is ready to read a command, and the secondary prompt PPSS22 when it - needs more input to complete a command. BBaasshh displays PPSS00 after it - reads a command but before executing it. BBaasshh displays PPSS44 as described - above before tracing each command when the --xx option is enabled. BBaasshh - allows these prompt strings to be customized by inserting a number of - backslash-escaped special characters that are decoded as follows: + it is ready to read a command, and the secondary prompt PPSS22 when it + needs more input to complete a command. BBaasshh displays PPSS00 after it + reads a command but before executing it. BBaasshh displays PPSS44 as de- + scribed above before tracing each command when the --xx option is en- + abled. BBaasshh allows these prompt strings to be customized by inserting + a number of backslash-escaped special characters that are decoded as + follows: \\aa an ASCII bell character (07) \\dd the date in "Weekday Month Date" format (e.g., "Tue May 26") \\DD{{_f_o_r_m_a_t}} the _f_o_r_m_a_t is passed to _s_t_r_f_t_i_m_e(3) and the result is in- serted into the prompt string; an empty _f_o_r_m_a_t results in - a locale-specific time representation. The braces are re- - quired + a locale-specific time representation. The braces are + required \\ee an ASCII escape character (033) \\hh the hostname up to the first `.' \\HH the hostname @@ -3218,11 +3240,11 @@ PPRROOMMPPTTIINNGG history number of a command is its position in the history list, which may include commands restored from the history file (see HHIISSTTOORRYY be- low), while the command number is the position in the sequence of com- - mands executed during the current shell session. After the string is + mands executed during the current shell session. After the string is decoded, it is expanded via parameter expansion, command substitution, arithmetic expansion, and quote removal, subject to the value of the pprroommppttvvaarrss shell option (see the description of the sshhoopptt command under - SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). This can have unwanted side effects if + SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). This can have unwanted side effects if escaped portions of the string appear within command substitution or contain characters special to word expansion. @@ -3230,48 +3252,49 @@ RREEAADDLLIINNEE This is the library that handles reading input when using an interac- tive shell, unless the ----nnooeeddiittiinngg option is given at shell invocation. Line editing is also used when using the --ee option to the rreeaadd builtin. - By default, the line editing commands are similar to those of Emacs. A - vi-style line editing interface is also available. Line editing can be + By default, the line editing commands are similar to those of Emacs. A + vi-style line editing interface is also available. Line editing can be enabled at any time using the --oo eemmaaccss or --oo vvii options to the sseett - builtin (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). To turn off line editing + builtin (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). To turn off line editing after the shell is running, use the ++oo eemmaaccss or ++oo vvii options to the sseett builtin. RReeaaddlliinnee NNoottaattiioonn In this section, the Emacs-style notation is used to denote keystrokes. - Control keys are denoted by C-_k_e_y, e.g., C-n means Control-N. Simi- - larly, _m_e_t_a keys are denoted by M-_k_e_y, so M-x means Meta-X. (On key- + Control keys are denoted by C-_k_e_y, e.g., C-n means Control-N. Simi- + larly, _m_e_t_a keys are denoted by M-_k_e_y, so M-x means Meta-X. (On key- boards without a _m_e_t_a key, M-_x means ESC _x, i.e., press the Escape key - then the _x key. This makes ESC the _m_e_t_a _p_r_e_f_i_x. The combination M-C-_x + then the _x key. This makes ESC the _m_e_t_a _p_r_e_f_i_x. The combination M-C-_x means ESC-Control-_x, or press the Escape key then hold the Control key while pressing the _x key.) Readline commands may be given numeric _a_r_g_u_m_e_n_t_s, which normally act as - a repeat count. Sometimes, however, it is the sign of the argument that - is significant. Passing a negative argument to a command that acts in - the forward direction (e.g., kkiillll--lliinnee) causes that command to act in a - backward direction. Commands whose behavior with arguments deviates - from this are noted below. + a repeat count. Sometimes, however, it is the sign of the argument + that is significant. Passing a negative argument to a command that + acts in the forward direction (e.g., kkiillll--lliinnee) causes that command to + act in a backward direction. Commands whose behavior with arguments + deviates from this are noted below. When a command is described as _k_i_l_l_i_n_g text, the text deleted is saved - for possible future retrieval (_y_a_n_k_i_n_g). The killed text is saved in a - _k_i_l_l _r_i_n_g. Consecutive kills cause the text to be accumulated into one - unit, which can be yanked all at once. Commands which do not kill text + for possible future retrieval (_y_a_n_k_i_n_g). The killed text is saved in a + _k_i_l_l _r_i_n_g. Consecutive kills cause the text to be accumulated into one + unit, which can be yanked all at once. Commands which do not kill text separate the chunks of text on the kill ring. RReeaaddlliinnee IInniittiiaalliizzaattiioonn Readline is customized by putting commands in an initialization file - (the _i_n_p_u_t_r_c file). The name of this file is taken from the value of - the IINNPPUUTTRRCC variable. If that variable is unset, the default is _~_/_._i_n_- - _p_u_t_r_c. If that file does not exist or cannot be read, the ultimate de- - fault is _/_e_t_c_/_i_n_p_u_t_r_c. When a program which uses the readline library - starts up, the initialization file is read, and the key bindings and - variables are set. There are only a few basic constructs allowed in the - readline initialization file. Blank lines are ignored. Lines beginning - with a ## are comments. Lines beginning with a $$ indicate conditional - constructs. Other lines denote key bindings and variable settings. + (the _i_n_p_u_t_r_c file). The name of this file is taken from the value of + the IINNPPUUTTRRCC variable. If that variable is unset, the default is _~_/_._i_n_- + _p_u_t_r_c. If that file does not exist or cannot be read, the ultimate + default is _/_e_t_c_/_i_n_p_u_t_r_c. When a program which uses the readline li- + brary starts up, the initialization file is read, and the key bindings + and variables are set. There are only a few basic constructs allowed + in the readline initialization file. Blank lines are ignored. Lines + beginning with a ## are comments. Lines beginning with a $$ indicate + conditional constructs. Other lines denote key bindings and variable + settings. - The default key-bindings may be changed with an _i_n_p_u_t_r_c file. Other + The default key-bindings may be changed with an _i_n_p_u_t_r_c file. Other programs that use this library may add their own commands and bindings. For example, placing @@ -3279,38 +3302,38 @@ RREEAADDLLIINNEE M-Control-u: universal-argument or C-Meta-u: universal-argument - into the _i_n_p_u_t_r_c would make M-C-u execute the readline command _u_n_i_v_e_r_- + into the _i_n_p_u_t_r_c would make M-C-u execute the readline command _u_n_i_v_e_r_- _s_a_l_-_a_r_g_u_m_e_n_t. - The following symbolic character names are recognized: _R_U_B_O_U_T, _D_E_L, + The following symbolic character names are recognized: _R_U_B_O_U_T, _D_E_L, _E_S_C, _L_F_D, _N_E_W_L_I_N_E, _R_E_T, _R_E_T_U_R_N, _S_P_C, _S_P_A_C_E, and _T_A_B. - In addition to command names, readline allows keys to be bound to a + In addition to command names, readline allows keys to be bound to a string that is inserted when the key is pressed (a _m_a_c_r_o). RReeaaddlliinnee KKeeyy BBiinnddiinnggss - The syntax for controlling key bindings in the _i_n_p_u_t_r_c 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 speci- + The syntax for controlling key bindings in the _i_n_p_u_t_r_c 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 speci- fied in one of two ways: as a symbolic key name, possibly with _M_e_t_a_- or _C_o_n_t_r_o_l_- prefixes, or as a key sequence. When using the form kkeeyynnaammee:_f_u_n_c_t_i_o_n_-_n_a_m_e or _m_a_c_r_o, _k_e_y_n_a_m_e is the name - of a key spelled out in English. For example: + of a key spelled out in English. For example: Control-u: universal-argument Meta-Rubout: backward-kill-word Control-o: "> output" - In the above example, _C_-_u is bound to the function uunniivveerrssaall--aarrgguummeenntt, - _M_-_D_E_L is bound to the function bbaacckkwwaarrdd--kkiillll--wwoorrdd, and _C_-_o is bound to - run the macro expressed on the right hand side (that is, to insert the + In the above example, _C_-_u is bound to the function uunniivveerrssaall--aarrgguummeenntt, + _M_-_D_E_L is bound to the function bbaacckkwwaarrdd--kkiillll--wwoorrdd, 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). - In the second form, ""kkeeyysseeqq"":_f_u_n_c_t_i_o_n_-_n_a_m_e or _m_a_c_r_o, kkeeyysseeqq differs - from kkeeyynnaammee above in that strings denoting an entire key sequence may - be specified by placing the sequence within double quotes. Some GNU - Emacs style key escapes can be used, as in the following example, but + In the second form, ""kkeeyysseeqq"":_f_u_n_c_t_i_o_n_-_n_a_m_e or _m_a_c_r_o, kkeeyysseeqq differs + from kkeeyynnaammee above in that strings denoting an entire key sequence may + be specified by placing the sequence within double quotes. Some GNU + Emacs style key escapes can be used, as in the following example, but the symbolic character names are not recognized. "\C-u": universal-argument @@ -3318,7 +3341,7 @@ RREEAADDLLIINNEE "\e[11~": "Function Key 1" In this example, _C_-_u is again bound to the function uunniivveerrssaall--aarrgguummeenntt. - _C_-_x _C_-_r is bound to the function rree--rreeaadd--iinniitt--ffiillee, and _E_S_C _[ _1 _1 _~ is + _C_-_x _C_-_r is bound to the function rree--rreeaadd--iinniitt--ffiillee, and _E_S_C _[ _1 _1 _~ is bound to insert the text ``Function Key 1''. The full set of GNU Emacs style escape sequences is @@ -3329,7 +3352,7 @@ RREEAADDLLIINNEE \\"" literal " \\'' literal ' - In addition to the GNU Emacs style escape sequences, a second set of + In addition to the GNU Emacs style escape sequences, a second set of backslash escapes is available: \\aa alert (bell) \\bb backspace @@ -3339,20 +3362,20 @@ RREEAADDLLIINNEE \\rr carriage return \\tt horizontal tab \\vv vertical tab - \\_n_n_n the eight-bit character whose value is the octal value + \\_n_n_n the eight-bit character whose value is the octal value _n_n_n (one to three digits) - \\xx_H_H the eight-bit character whose value is the hexadecimal + \\xx_H_H the eight-bit character whose value is the hexadecimal value _H_H (one or two hex digits) 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 func- - tion name. In the macro body, the backslash escapes described above are - expanded. Backslash will quote any other character in the macro text, - including " and '. + to indicate a macro definition. Unquoted text is assumed to be a func- + tion name. In the macro body, the backslash escapes described above + are expanded. Backslash will quote any other character in the macro + text, including " and '. - BBaasshh allows the current readline key bindings to be displayed or modi- - fied with the bbiinndd builtin command. The editing mode may be switched - during interactive use by using the --oo option to the sseett builtin com- + BBaasshh allows the current readline key bindings to be displayed or modi- + fied with the bbiinndd builtin command. The editing mode may be switched + during interactive use by using the --oo option to the sseett builtin com- mand (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). RReeaaddlliinnee VVaarriiaabblleess @@ -3363,71 +3386,72 @@ RREEAADDLLIINNEE sseett _v_a_r_i_a_b_l_e_-_n_a_m_e _v_a_l_u_e or using the bbiinndd builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). - Except where noted, readline variables can take the values OOnn or OOffff - (without regard to case). Unrecognized variable names are ignored. When - a variable value is read, empty or null values, "on" (case-insensi- - tive), and "1" are equivalent to OOnn. All other values are equivalent to - OOffff. The variables and their default values are: + Except where noted, readline variables can take the values OOnn or OOffff + (without regard to case). Unrecognized variable names are ignored. + When a variable value is read, empty or null values, "on" (case-insen- + sitive), and "1" are equivalent to OOnn. All other values are equivalent + to OOffff. The variables and their default values are: aaccttiivvee--rreeggiioonn--ssttaarrtt--ccoolloorr - A string variable that controls the text color and background - when displaying the text in the active region (see the descrip- - tion of eennaabbllee--aaccttiivvee--rreeggiioonn below). This string must not take + A string variable that controls the text color and background + when displaying the text in the active region (see the descrip- + tion of eennaabbllee--aaccttiivvee--rreeggiioonn below). This string must not take up any physical character positions on the display, so it should - consist only of terminal escape sequences. It is output to the - terminal before displaying the text in the active region. This - variable is reset to the default value whenever the terminal - type changes. The default value is the string that puts the ter- - minal in standout mode, as obtained from the terminal's terminfo - description. A sample value might be "\e[01;33m". + consist only of terminal escape sequences. It is output to the + terminal before displaying the text in the active region. This + variable is reset to the default value whenever the terminal + type changes. The default value is the string that puts the + terminal in standout mode, as obtained from the terminal's ter- + minfo description. A sample value might be "\e[01;33m". aaccttiivvee--rreeggiioonn--eenndd--ccoolloorr - A string variable that "undoes" the effects of aaccttiivvee--rree-- - ggiioonn--ssttaarrtt--ccoolloorr and restores "normal" terminal display appear- - ance after displaying text in the active region. This string - must not take up any physical character positions on the dis- - play, so it should consist only of terminal escape sequences. It - is output to the terminal after displaying the text in the ac- - tive region. This variable is reset to the default value when- - ever the terminal type changes. The default value is the string - that restores the terminal from standout mode, as obtained from - the terminal's terminfo description. A sample value might be - "\e[0m". + A string variable that "undoes" the effects of aaccttiivvee--rree-- + ggiioonn--ssttaarrtt--ccoolloorr and restores "normal" terminal display appear- + ance after displaying text in the active region. This string + must not take up any physical character positions on the dis- + play, so it should consist only of terminal escape sequences. + It is output to the terminal after displaying the text in the + active region. This variable is reset to the default value + whenever the terminal type changes. The default value is the + string that restores the terminal from standout mode, as ob- + tained from the terminal's terminfo description. A sample value + might be "\e[0m". bbeellll--ssttyyllee ((aauuddiibbllee)) - Controls what happens when readline wants to ring the terminal - bell. If set to nnoonnee, readline never rings the bell. If set to - vviissiibbllee, readline uses a visible bell if one is available. If + Controls what happens when readline wants to ring the terminal + bell. If set to nnoonnee, readline never rings the bell. If set to + vviissiibbllee, readline uses a visible bell if one is available. If set to aauuddiibbllee, readline attempts to ring the terminal's bell. bbiinndd--ttttyy--ssppeecciiaall--cchhaarrss ((OOnn)) - If set to OOnn (the default), readline attempts to bind the con- - trol characters that are treated specially by the kernel's ter- - minal driver to their readline equivalents. These override the - default readline bindings described here. Type stty -a at a bash - prompt to see your current terminal settings, including the spe- - cial control characters (usually cccchhaarrss). + If set to OOnn (the default), readline attempts to bind the con- + trol characters that are treated specially by the kernel's ter- + minal driver to their readline equivalents. These override the + default readline bindings described here. Type stty -a at a + bash prompt to see your current terminal settings, including the + special control characters (usually cccchhaarrss). bblliinnkk--mmaattcchhiinngg--ppaarreenn ((OOffff)) If set to OOnn, readline attempts to briefly move the cursor to an opening parenthesis when a closing parenthesis is inserted. ccoolloorreedd--ccoommpplleettiioonn--pprreeffiixx ((OOffff)) - If set to OOnn, when listing completions, readline displays the + If set to OOnn, when listing completions, readline displays the common prefix of the set of possible completions using a differ- - ent color. The color definitions are taken from the value of the - LLSS__CCOOLLOORRSS environment variable. If there is a color definition - in $$LLSS__CCOOLLOORRSS for the custom suffix "readline-colored-comple- - tion-prefix", readline uses this color for the common prefix in- - stead of its default. + ent color. The color definitions are taken from the value of + the LLSS__CCOOLLOORRSS environment variable. If there is a color defini- + tion in $$LLSS__CCOOLLOORRSS for the custom suffix "readline-colored-com- + pletion-prefix", readline uses this color for the common prefix + instead of its default. ccoolloorreedd--ssttaattss ((OOffff)) - If set to OOnn, readline displays possible completions using dif- - ferent colors to indicate their file type. The color definitions - are taken from the value of the LLSS__CCOOLLOORRSS environment variable. + If set to OOnn, readline displays possible completions using dif- + ferent colors to indicate their file type. The color defini- + tions are taken from the value of the LLSS__CCOOLLOORRSS environment + variable. ccoommmmeenntt--bbeeggiinn ((````##'''')) The string that is inserted when the readline iinnsseerrtt--ccoommmmeenntt - command is executed. This command is bound to MM--## in emacs mode + command is executed. This command is bound to MM--## in emacs mode and to ## in vi command mode. ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh ((--11)) The number of screen columns used to display possible matches - when performing completion. The value is ignored if it is less - than 0 or greater than the terminal screen width. A value of 0 - will cause matches to be displayed one per line. The default + when performing completion. The value is ignored if it is less + than 0 or greater than the terminal screen width. A value of 0 + will cause matches to be displayed one per line. The default value is -1. ccoommpplleettiioonn--iiggnnoorree--ccaassee ((OOffff)) If set to OOnn, readline performs filename matching and completion @@ -3438,7 +3462,7 @@ RREEAADDLLIINNEE forming case-insensitive filename matching and completion. ccoommpplleettiioonn--pprreeffiixx--ddiissppllaayy--lleennggtthh ((00)) The length in characters of the common prefix of a list of pos- - sible completions that is displayed without modification. When + sible completions that is displayed without modification. When set to a value greater than zero, common prefixes longer than this value are replaced with an ellipsis when displaying possi- ble completions. @@ -3446,19 +3470,19 @@ RREEAADDLLIINNEE This determines when the user is queried about viewing the num- ber of possible completions generated by the ppoossssiibbllee--ccoommppllee-- ttiioonnss command. It may be set to any integer value greater than - or equal to zero. If the number of possible completions is + or equal to zero. If the number of possible completions is greater than or equal to the value of this variable, readline will ask whether or not the user wishes to view them; otherwise - they are simply listed on the terminal. A zero value means read- - line should never ask; negative values are treated as zero. + they are simply listed on the terminal. A zero value means + readline should never ask; negative values are treated as zero. ccoonnvveerrtt--mmeettaa ((OOnn)) If set to OOnn, readline will convert characters with the eighth bit set to an ASCII key sequence by stripping the eighth bit and prefixing an escape character (in effect, using escape as the - _m_e_t_a _p_r_e_f_i_x). The default is _O_n, but readline will set it to _O_f_f - if the locale contains eight-bit characters. This variable is - dependent on the LLCC__CCTTYYPPEE locale category, and may change if the - locale is changed. + _m_e_t_a _p_r_e_f_i_x). The default is _O_n, but readline will set it to + _O_f_f if the locale contains eight-bit characters. This variable + is dependent on the LLCC__CCTTYYPPEE locale category, and may change if + the locale is changed. ddiissaabbllee--ccoommpplleettiioonn ((OOffff)) If set to OOnn, readline will inhibit word completion. Completion characters will be inserted into the line as if they had been @@ -3469,41 +3493,41 @@ RREEAADDLLIINNEE ated from the keyboard. eeddiittiinngg--mmooddee ((eemmaaccss)) Controls whether readline begins with a set of key bindings sim- - ilar to _E_m_a_c_s or _v_i. eeddiittiinngg--mmooddee can be set to either eemmaaccss or + ilar to _E_m_a_c_s or _v_i. eeddiittiinngg--mmooddee can be set to either eemmaaccss or vvii. eemmaaccss--mmooddee--ssttrriinngg ((@@)) If the _s_h_o_w_-_m_o_d_e_-_i_n_-_p_r_o_m_p_t variable is enabled, this string is displayed immediately before the last line of the primary prompt - when emacs editing mode is active. The value is expanded like a + when emacs editing mode is active. The value is expanded like a key binding, so the standard set of meta- and control prefixes - and backslash escape sequences is available. Use the \1 and \2 + and backslash escape sequences is available. Use the \1 and \2 escapes to begin and end sequences of non-printing characters, which can be used to embed a terminal control sequence into the mode string. eennaabbllee--aaccttiivvee--rreeggiioonn ((OOnn)) The _p_o_i_n_t is the current cursor position, and _m_a_r_k refers to a - saved cursor position. The text between the point and mark is + saved cursor position. The text between the point and mark is referred to as the _r_e_g_i_o_n. When this variable is set to _O_n, readline allows certain commands to designate the region as _a_c_- - _t_i_v_e. When the region is active, readline highlights the text in - the region using the value of the aaccttiivvee--rreeggiioonn--ssttaarrtt--ccoolloorr, + _t_i_v_e. When the region is active, readline highlights the text + in the region using the value of the aaccttiivvee--rreeggiioonn--ssttaarrtt--ccoolloorr, which defaults to the string that enables the terminal's stand- - out mode. The active region shows the text inserted by brack- + out mode. The active region shows the text inserted by brack- eted-paste and any matching text found by incremental and non- incremental history searches. eennaabbllee--bbrraacckkeetteedd--ppaassttee ((OOnn)) When set to OOnn, readline configures the terminal to insert each paste into the editing buffer as a single string of characters, instead of treating each character as if it had been read from - the keyboard. This prevents readline from executing any editing + the keyboard. This prevents readline from executing any editing commands bound to key sequences appearing in the pasted text. eennaabbllee--kkeeyyppaadd ((OOffff)) When set to OOnn, readline will try to enable the application key- - pad when it is called. Some systems need this to enable the ar- + pad when it is called. Some systems need this to enable the ar- row keys. eennaabbllee--mmeettaa--kkeeyy ((OOnn)) When set to OOnn, readline will try to enable any meta modifier - key the terminal claims to support when it is called. On many + key the terminal claims to support when it is called. On many terminals, the meta key is used to send eight-bit characters. eexxppaanndd--ttiillddee ((OOffff)) If set to OOnn, tilde expansion is performed when readline at- @@ -3514,47 +3538,47 @@ RREEAADDLLIINNEE ttoorryy or nneexxtt--hhiissttoorryy. hhiissttoorryy--ssiizzee ((uunnsseett)) Set the maximum number of history entries saved in the history - list. If set to zero, any existing history entries are deleted - and no new entries are saved. If set to a value less than zero, + list. If set to zero, any existing history entries are deleted + and no new entries are saved. If set to a value less than zero, the number of history entries is not limited. By default, the number of history entries is set to the value of the HHIISSTTSSIIZZEE - shell variable. If an attempt is made to set _h_i_s_t_o_r_y_-_s_i_z_e to a + shell variable. If an attempt is made to set _h_i_s_t_o_r_y_-_s_i_z_e to a non-numeric value, the maximum number of history entries will be set to 500. hhoorriizzoonnttaall--ssccrroollll--mmooddee ((OOffff)) When set to OOnn, makes readline use a single line for display, scrolling the input horizontally on a single screen line when it becomes longer than the screen width rather than wrapping to a - new line. This setting is automatically enabled for terminals of - height 1. + new line. This setting is automatically enabled for terminals + of height 1. iinnppuutt--mmeettaa ((OOffff)) If set to OOnn, readline will enable eight-bit input (that is, it will not strip the eighth bit from the characters it reads), re- - gardless of what the terminal claims it can support. The name - mmeettaa--ffllaagg is a synonym for this variable. The default is _O_f_f, + gardless of what the terminal claims it can support. The name + mmeettaa--ffllaagg is a synonym for this variable. The default is _O_f_f, but readline will set it to _O_n if the locale contains eight-bit - characters. This variable is dependent on the LLCC__CCTTYYPPEE locale + characters. This variable is dependent on the LLCC__CCTTYYPPEE locale category, and may change if the locale is changed. iisseeaarrcchh--tteerrmmiinnaattoorrss ((````CC--[[CC--JJ'''')) The string of characters that should terminate an incremental search without subsequently executing the character as a com- - mand. If this variable has not been given a value, the charac- + mand. If this variable has not been given a value, the charac- ters _E_S_C and _C_-_J will terminate an incremental search. kkeeyymmaapp ((eemmaaccss)) - Set the current readline keymap. The set of valid keymap names + Set the current readline keymap. The set of valid keymap names is _e_m_a_c_s_, _e_m_a_c_s_-_s_t_a_n_d_a_r_d_, _e_m_a_c_s_-_m_e_t_a_, _e_m_a_c_s_-_c_t_l_x_, _v_i_, _v_i_-_c_o_m_- _m_a_n_d, and _v_i_-_i_n_s_e_r_t. _v_i is equivalent to _v_i_-_c_o_m_m_a_n_d; _e_m_a_c_s is - equivalent to _e_m_a_c_s_-_s_t_a_n_d_a_r_d. The default value is _e_m_a_c_s; the + equivalent to _e_m_a_c_s_-_s_t_a_n_d_a_r_d. The default value is _e_m_a_c_s; the value of eeddiittiinngg--mmooddee also affects the default keymap. kkeeyysseeqq--ttiimmeeoouutt ((550000)) Specifies the duration _r_e_a_d_l_i_n_e will wait for a character when reading an ambiguous key sequence (one that can form a complete key sequence using the input read so far, or can take additional - input to complete a longer key sequence). If no input is re- + input to complete a longer key sequence). If no input is re- ceived within the timeout, _r_e_a_d_l_i_n_e will use the shorter but - complete key sequence. The value is specified in milliseconds, + complete key sequence. The value is specified in milliseconds, so a value of 1000 means that _r_e_a_d_l_i_n_e will wait one second for - additional input. If this variable is set to a value less than + additional input. If this variable is set to a value less than or equal to zero, or to a non-numeric value, _r_e_a_d_l_i_n_e will wait until another key is pressed to decide which key sequence to complete. @@ -3570,8 +3594,8 @@ RREEAADDLLIINNEE mmaattcchh--hhiiddddeenn--ffiilleess ((OOnn)) This variable, when set to OOnn, causes readline to match files whose names begin with a `.' (hidden files) when performing - filename completion. If set to OOffff, the leading `.' must be sup- - plied by the user in the filename to be completed. + filename completion. If set to OOffff, the leading `.' must be + supplied by the user in the filename to be completed. mmeennuu--ccoommpplleettee--ddiissppllaayy--pprreeffiixx ((OOffff)) If set to OOnn, menu completion displays the common prefix of the list of possible completions (which may be empty) before cycling @@ -3580,8 +3604,8 @@ RREEAADDLLIINNEE If set to OOnn, readline will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. The default is _O_f_f, but readline will set it to _O_n if the locale - contains eight-bit characters. This variable is dependent on the - LLCC__CCTTYYPPEE locale category, and may change if the locale is + contains eight-bit characters. This variable is dependent on + the LLCC__CCTTYYPPEE locale category, and may change if the locale is changed. ppaaggee--ccoommpplleettiioonnss ((OOnn)) If set to OOnn, readline uses an internal _m_o_r_e-like pager to dis- @@ -3592,40 +3616,40 @@ RREEAADDLLIINNEE screen. rreevveerrtt--aallll--aatt--nneewwlliinnee ((OOffff)) If set to OOnn, readline will undo all changes to history lines - before returning when aacccceepptt--lliinnee is executed. By default, his- + before returning when aacccceepptt--lliinnee is executed. By default, his- tory lines may be modified and retain individual undo lists across calls to rreeaaddlliinnee. sseeaarrcchh--iiggnnoorree--ccaassee ((OOffff)) If set to OOnn, readline performs incremental and non-incremental history list searches in a case-insensitive fashion. sshhooww--aallll--iiff--aammbbiigguuoouuss ((OOffff)) - This alters the default behavior of the completion functions. If - set to OOnn, words which have more than one possible completion + This alters the default behavior of the completion functions. + If set to OOnn, words which have more than one possible completion cause the matches to be listed immediately instead of ringing the bell. sshhooww--aallll--iiff--uunnmmooddiiffiieedd ((OOffff)) This alters the default behavior of the completion functions in - a fashion similar to sshhooww--aallll--iiff--aammbbiigguuoouuss. If set to OOnn, words + a fashion similar to sshhooww--aallll--iiff--aammbbiigguuoouuss. If set to OOnn, words which have more than one possible completion without any possi- ble partial completion (the possible completions don't share a common prefix) cause the matches to be listed immediately in- stead of ringing the bell. sshhooww--mmooddee--iinn--pprroommpptt ((OOffff)) If set to OOnn, add a string to the beginning of the prompt indi- - cating the editing mode: emacs, vi command, or vi insertion. The - mode strings are user-settable (e.g., _e_m_a_c_s_-_m_o_d_e_-_s_t_r_i_n_g). + cating the editing mode: emacs, vi command, or vi insertion. + The mode strings are user-settable (e.g., _e_m_a_c_s_-_m_o_d_e_-_s_t_r_i_n_g). sskkiipp--ccoommpplleetteedd--tteexxtt ((OOffff)) If set to OOnn, this alters the default completion behavior when - inserting a single match into the line. It's only active when - performing completion in the middle of a word. If enabled, read- - line does not insert characters from the completion that match - characters after point in the word being completed, so portions - of the word following the cursor are not duplicated. + inserting a single match into the line. It's only active when + performing completion in the middle of a word. If enabled, + readline does not insert characters from the completion that + match characters after point in the word being completed, so + portions of the word following the cursor are not duplicated. vvii--ccmmdd--mmooddee--ssttrriinngg ((((ccmmdd)))) If the _s_h_o_w_-_m_o_d_e_-_i_n_-_p_r_o_m_p_t variable is enabled, this string is displayed immediately before the last line of the primary prompt - when vi editing mode is active and in command mode. The value is - expanded like a key binding, so the standard set of meta- and + when vi editing mode is active and in command mode. The value + is expanded like a key binding, so the standard set of meta- and control prefixes and backslash escape sequences is available. Use the \1 and \2 escapes to begin and end sequences of non- printing characters, which can be used to embed a terminal con- @@ -3633,7 +3657,7 @@ RREEAADDLLIINNEE vvii--iinnss--mmooddee--ssttrriinngg ((((iinnss)))) If the _s_h_o_w_-_m_o_d_e_-_i_n_-_p_r_o_m_p_t variable is enabled, this string is displayed immediately before the last line of the primary prompt - when vi editing mode is active and in insertion mode. The value + when vi editing mode is active and in insertion mode. The value is expanded like a key binding, so the standard set of meta- and control prefixes and backslash escape sequences is available. Use the \1 and \2 escapes to begin and end sequences of non- @@ -3647,49 +3671,50 @@ RREEAADDLLIINNEE RReeaaddlliinnee CCoonnddiittiioonnaall CCoonnssttrruuccttss 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 - four parser directives used. + and variable settings to be performed as the result of tests. There + are four parser directives used. $$iiff The $$iiff construct allows bindings to be made based on the edit- ing mode, the terminal being used, or the application using - readline. The text of the test, after any comparison operator, + readline. The text of the test, after any comparison operator, extends to the end of the line; unless otherwise noted, no char- acters are required to isolate it. mmooddee The mmooddee== form of the $$iiff directive is used to test - whether readline is in emacs or vi mode. This may be used - in conjunction with the sseett kkeeyymmaapp command, for instance, - to set bindings in the _e_m_a_c_s_-_s_t_a_n_d_a_r_d and _e_m_a_c_s_-_c_t_l_x - keymaps only if readline is starting out in emacs mode. + whether readline is in emacs or vi mode. This may be + used in conjunction with the sseett kkeeyymmaapp command, for in- + stance, to set bindings in the _e_m_a_c_s_-_s_t_a_n_d_a_r_d and + _e_m_a_c_s_-_c_t_l_x keymaps only if readline is starting out in + emacs mode. - tteerrmm The tteerrmm== form may be used to include terminal-specific + tteerrmm The tteerrmm== 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 + the terminal's function keys. The word on the right side of the == is tested against both the full name of the ter- - minal and the portion of the terminal name before the - first --. This allows _s_u_n to match both _s_u_n and _s_u_n_-_c_m_d, + minal and the portion of the terminal name before the + first --. This allows _s_u_n to match both _s_u_n and _s_u_n_-_c_m_d, for instance. vveerrssiioonn - The vveerrssiioonn test may be used to perform comparisons - against specific readline versions. The vveerrssiioonn expands - to the current readline version. The set of comparison - operators includes ==, (and ====), !!==, <<==, >>==, <<, and >>. The - version number supplied on the right side of the operator - consists of a major version number, an optional decimal - point, and an optional minor version (e.g., 77..11). If the - minor version is omitted, it is assumed to be 00. The op- - erator may be separated from the string vveerrssiioonn and from - the version number argument by whitespace. + The vveerrssiioonn test may be used to perform comparisons + against specific readline versions. The vveerrssiioonn expands + to the current readline version. The set of comparison + operators includes ==, (and ====), !!==, <<==, >>==, <<, and >>. + The version number supplied on the right side of the op- + erator consists of a major version number, an optional + decimal point, and an optional minor version (e.g., 77..11). + If the minor version is omitted, it is assumed to be 00. + The operator may be separated from the string vveerrssiioonn and + from the version number argument by whitespace. aapppplliiccaattiioonn The aapppplliiccaattiioonn construct is used to include application- - specific settings. Each program using the readline li- - brary sets the _a_p_p_l_i_c_a_t_i_o_n _n_a_m_e, and an initialization - 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 + specific settings. Each program using the readline li- + brary sets the _a_p_p_l_i_c_a_t_i_o_n _n_a_m_e, and an initialization + 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 bbaasshh: $$iiff Bash @@ -3699,12 +3724,12 @@ RREEAADDLLIINNEE _v_a_r_i_a_b_l_e The _v_a_r_i_a_b_l_e construct provides simple equality tests for - readline variables and values. The permitted comparison - operators are _=, _=_=, and _!_=. The variable name must be + readline variables and values. The permitted comparison + operators are _=, _=_=, and _!_=. The variable name must be separated from the comparison operator by whitespace; the - operator may be separated from the value on the right - hand side by whitespace. Both string and boolean vari- - ables may be tested. Boolean variables must be tested + operator may be separated from the value on the right + hand side by whitespace. Both string and boolean vari- + ables may be tested. Boolean variables must be tested against the values _o_n and _o_f_f. $$eennddiiff This command, as seen in the previous example, terminates an $$iiff @@ -3714,51 +3739,51 @@ RREEAADDLLIINNEE test fails. $$iinncclluuddee - This directive takes a single filename as an argument and reads - commands and bindings from that file. For example, the following - directive would read _/_e_t_c_/_i_n_p_u_t_r_c: + This directive takes a single filename as an argument and reads + commands and bindings from that file. For example, the follow- + ing directive would read _/_e_t_c_/_i_n_p_u_t_r_c: $$iinncclluuddee _/_e_t_c_/_i_n_p_u_t_r_c SSeeaarrcchhiinngg - Readline provides commands for searching through the command history - (see HHIISSTTOORRYY below) for lines containing a specified string. There are + Readline provides commands for searching through the command history + (see HHIISSTTOORRYY below) for lines containing a specified string. There are two search modes: _i_n_c_r_e_m_e_n_t_a_l and _n_o_n_-_i_n_c_r_e_m_e_n_t_a_l. - Incremental searches begin before the user has finished typing the - search string. As each character of the search string is typed, read- + Incremental searches begin before the user has finished typing the + search string. As each character of the search string is typed, read- line 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 characters present in the - value of the iisseeaarrcchh--tteerrmmiinnaattoorrss variable are used to terminate an in- - cremental search. If that variable has not been assigned a value the - Escape and Control-J characters will terminate an incremental search. - Control-G will abort an incremental search and restore the original - line. When the search is terminated, the history entry containing the + so far. An incremental search requires only as many characters as + needed to find the desired history entry. The characters present in + the value of the iisseeaarrcchh--tteerrmmiinnaattoorrss variable are used to terminate an + incremental search. If that variable has not been assigned a value the + Escape and Control-J characters will terminate an incremental search. + Control-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 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 _n_e_w_l_i_n_e will terminate - the search and accept the line, thereby executing the command from the - history list. + To find other matching entries in the history list, type Control-S or + Control-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 _n_e_w_l_i_n_e will termi- + nate the search and accept the line, thereby executing the command from + the history list. - Readline remembers the last incremental search string. If two Control- - Rs are typed without any intervening characters defining a new search + Readline remembers the last incremental search string. If two Control- + Rs are typed without any intervening characters defining a new search string, any remembered search string is used. - 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 be part of the contents of the current line. + 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 be part of the contents of the current line. RReeaaddlliinnee CCoommmmaanndd NNaammeess - The following is a list of the names of the commands and the default - key sequences to which they are bound. Command names without an accom- - panying key sequence are unbound by default. In the following descrip- - tions, _p_o_i_n_t refers to the current cursor position, and _m_a_r_k refers to - a cursor position saved by the sseett--mmaarrkk command. The text between the + The following is a list of the names of the commands and the default + key sequences to which they are bound. Command names without an accom- + panying key sequence are unbound by default. In the following descrip- + tions, _p_o_i_n_t refers to the current cursor position, and _m_a_r_k refers to + a cursor position saved by the sseett--mmaarrkk command. The text between the point and mark is referred to as the _r_e_g_i_o_n. CCoommmmaannddss ffoorr MMoovviinngg @@ -3771,194 +3796,196 @@ RREEAADDLLIINNEE bbaacckkwwaarrdd--cchhaarr ((CC--bb)) Move back a character. ffoorrwwaarrdd--wwoorrdd ((MM--ff)) - Move forward to the end of the next word. Words are composed of + Move forward to the end of the next word. Words are composed of alphanumeric characters (letters and digits). bbaacckkwwaarrdd--wwoorrdd ((MM--bb)) - Move back to the start of the current or previous word. Words + Move back to the start of the current or previous word. Words are composed of alphanumeric characters (letters and digits). sshheellll--ffoorrwwaarrdd--wwoorrdd - Move forward to the end of the next word. Words are delimited by - non-quoted shell metacharacters. + Move forward to the end of the next word. Words are delimited + by non-quoted shell metacharacters. sshheellll--bbaacckkwwaarrdd--wwoorrdd - Move back to the start of the current or previous word. Words + Move back to the start of the current or previous word. Words are delimited by non-quoted shell metacharacters. pprreevviioouuss--ssccrreeeenn--lliinnee - Attempt to move point to the same physical screen column on the - previous physical screen line. This will not have the desired - effect if the current readline line does not take up more than - one physical line or if point is not greater than the length of + Attempt to move point to the same physical screen column on the + previous physical screen line. This will not have the desired + effect if the current readline line does not take up more than + one physical line or if point is not greater than the length of the prompt plus the screen width. nneexxtt--ssccrreeeenn--lliinnee - Attempt to move point to the same physical screen column on the + Attempt to move point to the same physical screen column on the next physical screen line. This will not have the desired effect - if the current readline line does not take up more than one - physical line or if the length of the current readline line is + if the current readline line does not take up more than one + physical line or if the length of the current readline line is not greater than the length of the prompt plus the screen width. cclleeaarr--ddiissppllaayy ((MM--CC--ll)) - Clear the screen and, if possible, the terminal's scrollback - buffer, then redraw the current line, leaving the current line + Clear the screen and, if possible, the terminal's scrollback + buffer, then redraw the current line, leaving the current line at the top of the screen. cclleeaarr--ssccrreeeenn ((CC--ll)) Clear the screen, then redraw the current line, leaving the cur- - rent line at the top of the screen. With an argument, refresh + rent line at the top of the screen. With an argument, refresh the current line without clearing the screen. rreeddrraaww--ccuurrrreenntt--lliinnee Refresh the current line. CCoommmmaannddss ffoorr MMaanniippuullaattiinngg tthhee HHiissttoorryy aacccceepptt--lliinnee ((NNeewwlliinnee,, RReettuurrnn)) - Accept the line regardless of where the cursor is. If this line - is non-empty, add it to the history list according to the state - of the HHIISSTTCCOONNTTRROOLL variable. If the line is a modified history + Accept the line regardless of where the cursor is. If this line + is non-empty, add it to the history list according to the state + of the HHIISSTTCCOONNTTRROOLL variable. If the line is a modified history line, then restore the history line to its original state. pprreevviioouuss--hhiissttoorryy ((CC--pp)) Fetch the previous command from the history list, moving back in the list. nneexxtt--hhiissttoorryy ((CC--nn)) - Fetch the next command from the history list, moving forward in + Fetch the next command from the history list, moving forward in the list. bbeeggiinnnniinngg--ooff--hhiissttoorryy ((MM--<<)) Move to the first line in the history. eenndd--ooff--hhiissttoorryy ((MM-->>)) - Move to the end of the input history, i.e., the line currently + Move to the end of the input history, i.e., the line currently being entered. ooppeerraattee--aanndd--ggeett--nneexxtt ((CC--oo)) - Accept the current line for execution and fetch the next line - relative to the current line from the history for editing. A nu- - meric argument, if supplied, specifies the history entry to use - instead of the current line. + Accept the current line for execution and fetch the next line + relative to the current line from the history for editing. A + numeric argument, if supplied, specifies the history entry to + use instead of the current line. ffeettcchh--hhiissttoorryy - With a numeric argument, fetch that entry from the history list - and make it the current line. Without an argument, move back to + With a numeric argument, fetch that entry from the history list + and make it the current line. Without an argument, move back to the first entry in the history list. rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((CC--rr)) - Search backward starting at the current line and moving `up' - through the history as necessary. This is an incremental search. + Search backward starting at the current line and moving `up' + through the history as necessary. This is an incremental + search. ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((CC--ss)) Search forward starting at the current line and moving `down' - through the history as necessary. This is an incremental search. + through the history as necessary. This is an incremental + search. nnoonn--iinnccrreemmeennttaall--rreevveerrssee--sseeaarrcchh--hhiissttoorryy ((MM--pp)) Search backward through the history starting at the current line - using a non-incremental search for a string supplied by the + using a non-incremental search for a string supplied by the user. nnoonn--iinnccrreemmeennttaall--ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((MM--nn)) - Search forward through the history using a non-incremental + Search forward through the history using a non-incremental search for a string supplied by the user. hhiissttoorryy--sseeaarrcchh--ffoorrwwaarrdd - Search forward through the history for the string of characters - between the start of the current line and the point. This is a + Search forward through the history for the string of characters + between the start of the current line and the point. This is a non-incremental search. hhiissttoorryy--sseeaarrcchh--bbaacckkwwaarrdd Search backward through the history for the string of characters - between the start of the current line and the point. This is a + between the start of the current line and the point. This is a non-incremental search. hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--bbaacckkwwaarrdd Search backward through the history for the string of characters between the start of the current line and the current cursor po- - sition (the _p_o_i_n_t). The search string may match anywhere in a - history line. This is a non-incremental search. + sition (the _p_o_i_n_t). The search string may match anywhere in a + history line. This is a non-incremental search. hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--ffoorrwwaarrdd - Search forward through the history for the string of characters - between the start of the current line and the point. The search - string may match anywhere in a history line. This is a non-in- + Search forward through the history for the string of characters + between the start of the current line and the point. The search + string may match anywhere in a history line. This is a non-in- cremental search. yyaannkk--nntthh--aarrgg ((MM--CC--yy)) - Insert the first argument to the previous command (usually the - second word on the previous line) at point. With an argument _n, - insert the _nth word from the previous command (the words in the - previous command begin with word 0). A negative argument inserts - the _nth word from the end of the previous command. Once the ar- - gument _n is computed, the argument is extracted as if the "!_n" - history expansion had been specified. + Insert the first argument to the previous command (usually the + second word on the previous line) at point. With an argument _n, + insert the _nth word from the previous command (the words in the + previous command begin with word 0). A negative argument in- + serts the _nth word from the end of the previous command. Once + the argument _n is computed, the argument is extracted as if the + "!_n" history expansion had been specified. yyaannkk--llaasstt--aarrgg ((MM--..,, MM--__)) - Insert the last argument to the previous command (the last word - of the previous history entry). With a numeric argument, behave - exactly like yyaannkk--nntthh--aarrgg. Successive calls to yyaannkk--llaasstt--aarrgg - move back through the history list, inserting the last word (or - the word specified by the argument to the first call) of each - line in turn. Any numeric argument supplied to these successive - calls determines the direction to move through the history. A - negative argument switches the direction through the history - (back or forward). The history expansion facilities are used to + Insert the last argument to the previous command (the last word + of the previous history entry). With a numeric argument, behave + exactly like yyaannkk--nntthh--aarrgg. Successive calls to yyaannkk--llaasstt--aarrgg + move back through the history list, inserting the last word (or + the word specified by the argument to the first call) of each + line in turn. Any numeric argument supplied to these successive + calls determines the direction to move through the history. A + negative argument switches the direction through the history + (back or forward). The history expansion facilities are used to extract the last word, as if the "!$" history expansion had been specified. sshheellll--eexxppaanndd--lliinnee ((MM--CC--ee)) - Expand the line by performing shell word expansions. This per- + Expand the line by performing shell word expansions. This per- forms alias and history expansion, $$'_s_t_r_i_n_g' and $$"_s_t_r_i_n_g" quot- - ing, tilde expansion, parameter and variable expansion, arith- - metic expansion, word splitting, and quote removal. See HHIISSTTOORRYY + ing, tilde expansion, parameter and variable expansion, arith- + metic expansion, word splitting, and quote removal. See HHIISSTTOORRYY EEXXPPAANNSSIIOONN below for a description of history expansion. hhiissttoorryy--eexxppaanndd--lliinnee ((MM--^^)) - Perform history expansion on the current line. See HHIISSTTOORRYY EEXX-- + Perform history expansion on the current line. See HHIISSTTOORRYY EEXX-- PPAANNSSIIOONN below for a description of history expansion. mmaaggiicc--ssppaaccee - Perform history expansion on the current line and insert a + Perform history expansion on the current line and insert a space. See HHIISSTTOORRYY EEXXPPAANNSSIIOONN below for a description of history expansion. aalliiaass--eexxppaanndd--lliinnee - Perform alias expansion on the current line. See AALLIIAASSEESS above + Perform alias expansion on the current line. See AALLIIAASSEESS above for a description of alias expansion. hhiissttoorryy--aanndd--aalliiaass--eexxppaanndd--lliinnee Perform history and alias expansion on the current line. iinnsseerrtt--llaasstt--aarrgguummeenntt ((MM--..,, MM--__)) A synonym for yyaannkk--llaasstt--aarrgg. eeddiitt--aanndd--eexxeeccuuttee--ccoommmmaanndd ((CC--xx CC--ee)) - Invoke an editor on the current command line, and execute the - result as shell commands. BBaasshh attempts to invoke $$VVIISSUUAALL, $$EEDDII-- - TTOORR, and _e_m_a_c_s as the editor, in that order. + Invoke an editor on the current command line, and execute the + result as shell commands. BBaasshh attempts to invoke $$VVIISSUUAALL, $$EEDD-- + IITTOORR, and _e_m_a_c_s as the editor, in that order. CCoommmmaannddss ffoorr CChhaannggiinngg TTeexxtt _e_n_d_-_o_f_-_f_i_l_e ((uussuuaallllyy CC--dd)) - The character indicating end-of-file as set, for example, by - ``stty''. If this character is read when there are no characters - on the line, and point is at the beginning of the line, readline - interprets it as the end of input and returns EEOOFF. + The character indicating end-of-file as set, for example, by + ``stty''. If this character is read when there are no charac- + ters on the line, and point is at the beginning of the line, + readline interprets it as the end of input and returns EEOOFF. ddeelleettee--cchhaarr ((CC--dd)) - Delete the character at point. If this function is bound to the + Delete the character at point. If this function is bound to the same character as the tty EEOOFF character, as CC--dd commonly is, see above for the effects. bbaacckkwwaarrdd--ddeelleettee--cchhaarr ((RRuubboouutt)) - Delete the character behind the cursor. When given a numeric ar- - gument, save the deleted text on the kill ring. + Delete the character behind the cursor. When given a numeric + argument, save the deleted text on the kill ring. ffoorrwwaarrdd--bbaacckkwwaarrdd--ddeelleettee--cchhaarr - Delete the character under the cursor, unless the cursor is at + Delete the character under the cursor, unless the cursor is at the end of the line, in which case the character behind the cur- sor is deleted. qquuootteedd--iinnsseerrtt ((CC--qq,, CC--vv)) - Add the next character typed to the line verbatim. This is how + Add the next character typed to the line verbatim. This is how to insert characters like CC--qq, for example. ttaabb--iinnsseerrtt ((CC--vv TTAABB)) Insert a tab character. sseellff--iinnsseerrtt ((aa,, bb,, AA,, 11,, !!,, ......)) Insert the character typed. ttrraannssppoossee--cchhaarrss ((CC--tt)) - Drag the character before point forward over the character at - point, moving point forward as well. If point is at the end of - the line, then this transposes the two characters before point. + Drag the character before point forward over the character at + point, moving point forward as well. If point is at the end of + the line, then this transposes the two characters before point. Negative arguments have no effect. ttrraannssppoossee--wwoorrddss ((MM--tt)) - Drag the word before point past the word after point, moving - point over that word as well. If point is at the end of the + Drag the word before point past the word after point, moving + point over that word as well. If point is at the end of the line, this transposes the last two words on the line. uuppccaassee--wwoorrdd ((MM--uu)) - Uppercase the current (or following) word. With a negative argu- - ment, uppercase the previous word, but do not move point. + Uppercase the current (or following) word. With a negative ar- + gument, uppercase the previous word, but do not move point. ddoowwnnccaassee--wwoorrdd ((MM--ll)) - Lowercase the current (or following) word. With a negative argu- - ment, lowercase the previous word, but do not move point. + Lowercase the current (or following) word. With a negative ar- + gument, lowercase the previous word, but do not move point. ccaappiittaalliizzee--wwoorrdd ((MM--cc)) - Capitalize the current (or following) word. With a negative ar- + Capitalize the current (or following) word. With a negative ar- gument, capitalize the previous word, but do not move point. oovveerrwwrriittee--mmooddee - Toggle overwrite mode. With an explicit positive numeric argu- - ment, switches to overwrite mode. With an explicit non-positive - numeric argument, switches to insert mode. This command affects - only eemmaaccss mode; vvii mode does overwrite differently. Each call - to _r_e_a_d_l_i_n_e_(_) starts in insert mode. In overwrite mode, charac- - ters bound to sseellff--iinnsseerrtt replace the text at point rather than - pushing the text to the right. Characters bound to bbaacckk-- - wwaarrdd--ddeelleettee--cchhaarr replace the character before point with a - space. By default, this command is unbound. + Toggle overwrite mode. With an explicit positive numeric argu- + ment, switches to overwrite mode. With an explicit non-positive + numeric argument, switches to insert mode. This command affects + only eemmaaccss mode; vvii mode does overwrite differently. Each call + to _r_e_a_d_l_i_n_e_(_) starts in insert mode. In overwrite mode, charac- + ters bound to sseellff--iinnsseerrtt replace the text at point rather than + pushing the text to the right. Characters bound to bbaacckk-- + wwaarrdd--ddeelleettee--cchhaarr replace the character before point with a + space. By default, this command is unbound. KKiilllliinngg aanndd YYaannkkiinngg kkiillll--lliinnee ((CC--kk)) @@ -3966,31 +3993,31 @@ RREEAADDLLIINNEE bbaacckkwwaarrdd--kkiillll--lliinnee ((CC--xx RRuubboouutt)) Kill backward to the beginning of the line. uunniixx--lliinnee--ddiissccaarrdd ((CC--uu)) - Kill backward from point to the beginning of the line. The + Kill backward from point to the beginning of the line. The killed text is saved on the kill-ring. kkiillll--wwhhoollee--lliinnee - Kill all characters on the current line, no matter where point + Kill all characters on the current line, no matter where point is. kkiillll--wwoorrdd ((MM--dd)) - Kill from point to the end of the current word, or if between - words, to the end of the next word. Word boundaries are the same - as those used by ffoorrwwaarrdd--wwoorrdd. + Kill from point to the end of the current word, or if between + words, to the end of the next word. Word boundaries are the + same as those used by ffoorrwwaarrdd--wwoorrdd. bbaacckkwwaarrdd--kkiillll--wwoorrdd ((MM--RRuubboouutt)) - Kill the word behind point. Word boundaries are the same as + Kill the word behind point. Word boundaries are the same as those used by bbaacckkwwaarrdd--wwoorrdd. sshheellll--kkiillll--wwoorrdd - Kill from point to the end of the current word, or if between - words, to the end of the next word. Word boundaries are the same - as those used by sshheellll--ffoorrwwaarrdd--wwoorrdd. + Kill from point to the end of the current word, or if between + words, to the end of the next word. Word boundaries are the + same as those used by sshheellll--ffoorrwwaarrdd--wwoorrdd. sshheellll--bbaacckkwwaarrdd--kkiillll--wwoorrdd - Kill the word behind point. Word boundaries are the same as + Kill the word behind point. Word boundaries are the same as those used by sshheellll--bbaacckkwwaarrdd--wwoorrdd. uunniixx--wwoorrdd--rruubboouutt ((CC--ww)) - Kill the word behind point, using white space as a word bound- - ary. The killed text is saved on the kill-ring. + Kill the word behind point, using white space as a word bound- + ary. The killed text is saved on the kill-ring. uunniixx--ffiilleennaammee--rruubboouutt - Kill the word behind point, using white space and the slash - character as the word boundaries. The killed text is saved on + Kill the word behind point, using white space and the slash + character as the word boundaries. The killed text is saved on the kill-ring. ddeelleettee--hhoorriizzoonnttaall--ssppaaccee ((MM--\\)) Delete all spaces and tabs around point. @@ -3999,65 +4026,65 @@ RREEAADDLLIINNEE ccooppyy--rreeggiioonn--aass--kkiillll Copy the text in the region to the kill buffer. ccooppyy--bbaacckkwwaarrdd--wwoorrdd - Copy the word before point to the kill buffer. The word bound- + Copy the word before point to the kill buffer. The word bound- aries are the same as bbaacckkwwaarrdd--wwoorrdd. ccooppyy--ffoorrwwaarrdd--wwoorrdd - Copy the word following point to the kill buffer. The word + Copy the word following point to the kill buffer. The word boundaries are the same as ffoorrwwaarrdd--wwoorrdd. yyaannkk ((CC--yy)) Yank the top of the kill ring into the buffer at point. yyaannkk--ppoopp ((MM--yy)) - Rotate the kill ring, and yank the new top. Only works following - yyaannkk or yyaannkk--ppoopp. + Rotate the kill ring, and yank the new top. Only works follow- + ing yyaannkk or yyaannkk--ppoopp. NNuummeerriicc AArrgguummeennttss ddiiggiitt--aarrgguummeenntt ((MM--00,, MM--11,, ......,, MM----)) - Add this digit to the argument already accumulating, or start a - new argument. M-- starts a negative argument. + Add this digit to the argument already accumulating, or start a + new argument. M-- starts a negative argument. uunniivveerrssaall--aarrgguummeenntt - This is another way to specify an argument. If this command is - followed by one or more digits, optionally with a leading minus - sign, those digits define the argument. If the command is fol- + This is another way to specify an argument. If this command is + followed by one or more digits, optionally with a leading minus + sign, those digits define the argument. If the command is fol- lowed by digits, executing uunniivveerrssaall--aarrgguummeenntt again ends the nu- - meric argument, but is otherwise ignored. As a special case, if + meric argument, but is otherwise ignored. As a special case, if this command is immediately followed by a character that is nei- - ther a digit nor minus sign, the argument count for the next - command is multiplied by four. The argument count is initially - one, so executing this function the first time makes the argu- + ther a digit nor minus sign, the argument count for the next + command is multiplied by four. The argument count is initially + one, so executing this function the first time makes the argu- ment count four, a second time makes the argument count sixteen, and so on. CCoommpplleettiinngg ccoommpplleettee ((TTAABB)) - Attempt to perform completion on the text before point. BBaasshh at- - tempts completion treating the text as a variable (if the text - begins with $$), username (if the text begins with ~~), hostname - (if the text begins with @@), or command (including aliases and - functions) in turn. If none of these produces a match, filename + Attempt to perform completion on the text before point. BBaasshh + attempts completion treating the text as a variable (if the text + begins with $$), username (if the text begins with ~~), hostname + (if the text begins with @@), or command (including aliases and + functions) in turn. If none of these produces a match, filename completion is attempted. ppoossssiibbllee--ccoommpplleettiioonnss ((MM--??)) List the possible completions of the text before point. iinnsseerrtt--ccoommpplleettiioonnss ((MM--**)) - Insert all completions of the text before point that would have + Insert all completions of the text before point that would have been generated by ppoossssiibbllee--ccoommpplleettiioonnss. mmeennuu--ccoommpplleettee - Similar to ccoommpplleettee, but replaces the word to be completed with - a single match from the list of possible completions. Repeated - execution of mmeennuu--ccoommpplleettee steps through the list of possible - completions, inserting each match in turn. At the end of the + Similar to ccoommpplleettee, but replaces the word to be completed with + a single match from the list of possible completions. Repeated + execution of mmeennuu--ccoommpplleettee steps through the list of possible + completions, inserting each match in turn. At the end of the list of completions, the bell is rung (subject to the setting of - bbeellll--ssttyyllee) and the original text is restored. An argument of _n + bbeellll--ssttyyllee) and the original text is restored. An argument of _n moves _n positions forward in the list of matches; a negative ar- - gument may be used to move backward through the list. This com- + gument may be used to move backward through the list. This com- mand is intended to be bound to TTAABB, but is unbound by default. mmeennuu--ccoommpplleettee--bbaacckkwwaarrdd - Identical to mmeennuu--ccoommpplleettee, but moves backward through the list - of possible completions, as if mmeennuu--ccoommpplleettee had been given a - negative argument. This command is unbound by default. + Identical to mmeennuu--ccoommpplleettee, but moves backward through the list + of possible completions, as if mmeennuu--ccoommpplleettee had been given a + negative argument. This command is unbound by default. ddeelleettee--cchhaarr--oorr--lliisstt - Deletes the character under the cursor if not at the beginning - or end of the line (like ddeelleettee--cchhaarr). If at the end of the - line, behaves identically to ppoossssiibbllee--ccoommpplleettiioonnss. This command + Deletes the character under the cursor if not at the beginning + or end of the line (like ddeelleettee--cchhaarr). If at the end of the + line, behaves identically to ppoossssiibbllee--ccoommpplleettiioonnss. This command is unbound by default. ccoommpplleettee--ffiilleennaammee ((MM--//)) Attempt filename completion on the text before point. @@ -4065,272 +4092,272 @@ RREEAADDLLIINNEE List the possible completions of the text before point, treating it as a filename. ccoommpplleettee--uusseerrnnaammee ((MM--~~)) - Attempt completion on the text before point, treating it as a + Attempt completion on the text before point, treating it as a username. ppoossssiibbllee--uusseerrnnaammee--ccoommpplleettiioonnss ((CC--xx ~~)) List the possible completions of the text before point, treating it as a username. ccoommpplleettee--vvaarriiaabbllee ((MM--$$)) - Attempt completion on the text before point, treating it as a + Attempt completion on the text before point, treating it as a shell variable. ppoossssiibbllee--vvaarriiaabbllee--ccoommpplleettiioonnss ((CC--xx $$)) List the possible completions of the text before point, treating it as a shell variable. ccoommpplleettee--hhoossttnnaammee ((MM--@@)) - Attempt completion on the text before point, treating it as a + Attempt completion on the text before point, treating it as a hostname. ppoossssiibbllee--hhoossttnnaammee--ccoommpplleettiioonnss ((CC--xx @@)) List the possible completions of the text before point, treating it as a hostname. ccoommpplleettee--ccoommmmaanndd ((MM--!!)) - 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, shell + 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, shell builtins, and finally executable filenames, in that order. ppoossssiibbllee--ccoommmmaanndd--ccoommpplleettiioonnss ((CC--xx !!)) List the possible completions of the text before point, treating it as a command name. ddyynnaammiicc--ccoommpplleettee--hhiissttoorryy ((MM--TTAABB)) - Attempt completion on the text before point, comparing the text - against lines from the history list for possible completion + Attempt completion on the text before point, comparing the text + against lines from the history list for possible completion matches. ddaabbbbrreevv--eexxppaanndd - Attempt menu completion on the text before point, comparing the + Attempt menu completion on the text before point, comparing the text against lines from the history list for possible completion matches. ccoommpplleettee--iinnttoo--bbrraacceess ((MM--{{)) Perform filename completion and insert the list of possible com- - pletions enclosed within braces so the list is available to the + pletions enclosed within braces so the list is available to the shell (see BBrraaccee EExxppaannssiioonn above). KKeeyybbooaarrdd MMaaccrrooss ssttaarrtt--kkbbdd--mmaaccrroo ((CC--xx (()) - Begin saving the characters typed into the current keyboard + Begin saving the characters typed into the current keyboard macro. eenndd--kkbbdd--mmaaccrroo ((CC--xx )))) Stop saving the characters typed into the current keyboard macro and store the definition. ccaallll--llaasstt--kkbbdd--mmaaccrroo ((CC--xx ee)) - Re-execute the last keyboard macro defined, by making the char- + Re-execute the last keyboard macro defined, by making the char- acters in the macro appear as if typed at the keyboard. pprriinntt--llaasstt--kkbbdd--mmaaccrroo (()) - Print the last keyboard macro defined in a format suitable for + Print the last keyboard macro defined in a format suitable for the _i_n_p_u_t_r_c file. MMiisscceellllaanneeoouuss rree--rreeaadd--iinniitt--ffiillee ((CC--xx CC--rr)) - Read in the contents of the _i_n_p_u_t_r_c file, and incorporate any + Read in the contents of the _i_n_p_u_t_r_c file, and incorporate any bindings or variable assignments found there. aabboorrtt ((CC--gg)) - Abort the current editing command and ring the terminal's bell + Abort the current editing command and ring the terminal's bell (subject to the setting of bbeellll--ssttyyllee). ddoo--lloowweerrccaassee--vveerrssiioonn ((MM--AA,, MM--BB,, MM--_x,, ......)) - If the metafied character _x is uppercase, run the command that + If the metafied character _x is uppercase, run the command that is bound to the corresponding metafied lowercase character. The behavior is undefined if _x is already lowercase. pprreeffiixx--mmeettaa ((EESSCC)) - Metafy the next character typed. EESSCC ff is equivalent to MMeettaa--ff. + Metafy the next character typed. EESSCC ff is equivalent to MMeettaa--ff. uunnddoo ((CC--__,, CC--xx CC--uu)) Incremental undo, separately remembered for each line. rreevveerrtt--lliinnee ((MM--rr)) - Undo all changes made to this line. This is like executing the - uunnddoo command enough times to return the line to its initial + Undo all changes made to this line. This is like executing the + uunnddoo command enough times to return the line to its initial state. ttiillddee--eexxppaanndd ((MM--&&)) Perform tilde expansion on the current word. sseett--mmaarrkk ((CC--@@,, MM--<>)) - Set the mark to the point. If a numeric argument is supplied, + Set the mark to the point. If a numeric argument is supplied, the mark is set to that position. eexxcchhaannggee--ppooiinntt--aanndd--mmaarrkk ((CC--xx CC--xx)) - Swap the point with the mark. The current cursor position is set - to the saved position, and the old cursor position is saved as - the mark. + Swap the point with the mark. The current cursor position is + set to the saved position, and the old cursor position is saved + as the mark. cchhaarraacctteerr--sseeaarrcchh ((CC--]])) A character is read and point is moved to the next occurrence of - that character. A negative argument searches for previous occur- - rences. + that character. A negative argument searches for previous oc- + currences. cchhaarraacctteerr--sseeaarrcchh--bbaacckkwwaarrdd ((MM--CC--]])) - A character is read and point is moved to the previous occur- - rence of that character. A negative argument searches for subse- - quent occurrences. + A character is read and point is moved to the previous occur- + rence of that character. A negative argument searches for sub- + sequent occurrences. sskkiipp--ccssii--sseeqquueennccee - Read enough characters to consume a multi-key sequence such as - those defined for keys like Home and End. Such sequences begin - with a Control Sequence Indicator (CSI), usually ESC-[. If this - sequence is bound to "\[", keys producing such sequences will - have no effect unless explicitly bound to a readline command, - instead of inserting stray characters into the editing buffer. + Read enough characters to consume a multi-key sequence such as + those defined for keys like Home and End. Such sequences begin + with a Control Sequence Indicator (CSI), usually ESC-[. If this + sequence is bound to "\[", keys producing such sequences will + have no effect unless explicitly bound to a readline command, + instead of inserting stray characters into the editing buffer. This is unbound by default, but usually bound to ESC-[. iinnsseerrtt--ccoommmmeenntt ((MM--##)) - Without a numeric argument, the value of the readline ccoomm-- - mmeenntt--bbeeggiinn variable is inserted at the beginning of the current - line. If a numeric argument is supplied, this command acts as a - toggle: if the characters at the beginning of the line do not - match the value of ccoommmmeenntt--bbeeggiinn, the value is inserted, other- + Without a numeric argument, the value of the readline ccoomm-- + mmeenntt--bbeeggiinn variable is inserted at the beginning of the current + line. If a numeric argument is supplied, this command acts as a + toggle: if the characters at the beginning of the line do not + match the value of ccoommmmeenntt--bbeeggiinn, the value is inserted, other- wise the characters in ccoommmmeenntt--bbeeggiinn are deleted from the begin- - ning of the line. In either case, the line is accepted as if a - newline had been typed. The default value of ccoommmmeenntt--bbeeggiinn - causes this command to make the current line a shell comment. If - a numeric argument causes the comment character to be removed, - the line will be executed by the shell. + ning of the line. In either case, the line is accepted as if a + newline had been typed. The default value of ccoommmmeenntt--bbeeggiinn + causes this command to make the current line a shell comment. + If a numeric argument causes the comment character to be re- + moved, the line will be executed by the shell. ssppeellll--ccoorrrreecctt--wwoorrdd ((CC--xx ss)) - Perform spelling correction on the current word, treating it as - a directory or filename, in the same way as the ccddssppeellll shell - option. Word boundaries are the same as those used by sshheellll--ffoorr-- - wwaarrdd--wwoorrdd. + Perform spelling correction on the current word, treating it as + a directory or filename, in the same way as the ccddssppeellll shell + option. Word boundaries are the same as those used by + sshheellll--ffoorrwwaarrdd--wwoorrdd. gglloobb--ccoommpplleettee--wwoorrdd ((MM--gg)) - The word before point is treated as a pattern for pathname ex- - pansion, with an asterisk implicitly appended. This pattern is - used to generate a list of matching filenames for possible com- + The word before point is treated as a pattern for pathname ex- + pansion, with an asterisk implicitly appended. This pattern is + used to generate a list of matching filenames for possible com- pletions. gglloobb--eexxppaanndd--wwoorrdd ((CC--xx **)) - The word before point is treated as a pattern for pathname ex- + The word before point is treated as a pattern for pathname ex- pansion, and the list of matching filenames is inserted, replac- - ing the word. If a numeric argument is supplied, an asterisk is + ing the word. If a numeric argument is supplied, an asterisk is appended before pathname expansion. gglloobb--lliisstt--eexxppaannssiioonnss ((CC--xx gg)) - The list of expansions that would have been generated by - gglloobb--eexxppaanndd--wwoorrdd is displayed, and the line is redrawn. If a nu- - meric argument is supplied, an asterisk is appended before path- - name expansion. + The list of expansions that would have been generated by + gglloobb--eexxppaanndd--wwoorrdd is displayed, and the line is redrawn. If a + numeric argument is supplied, an asterisk is appended before + pathname expansion. dduummpp--ffuunnccttiioonnss - Print all of the functions and their key bindings to the read- - line output stream. If a numeric argument is supplied, the out- - put is formatted in such a way that it can be made part of an + Print all of the functions and their key bindings to the read- + line output stream. If a numeric argument is supplied, the out- + put is formatted in such a way that it can be made part of an _i_n_p_u_t_r_c file. dduummpp--vvaarriiaabblleess Print all of the settable readline variables and their values 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 + 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 _i_n_p_u_t_r_c file. dduummpp--mmaaccrrooss - Print all of the readline key sequences bound to macros and the - strings they output. If a numeric argument is supplied, the out- - put is formatted in such a way that it can be made part of an + Print all of the readline key sequences bound to macros and the + strings they output. If a numeric argument is supplied, the + output is formatted in such a way that it can be made part of an _i_n_p_u_t_r_c file. ddiissppllaayy--sshheellll--vveerrssiioonn ((CC--xx CC--vv)) Display version information about the current instance of bbaasshh. PPrrooggrraammmmaabbllee CCoommpplleettiioonn - When word completion is attempted for an argument to a command for - which a completion specification (a _c_o_m_p_s_p_e_c) has been defined using - the ccoommpplleettee builtin (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below), the program- + When word completion is attempted for an argument to a command for + which a completion specification (a _c_o_m_p_s_p_e_c) has been defined using + the ccoommpplleettee builtin (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below), the program- mable completion facilities are invoked. - First, the command name is identified. If the command word is the empty - string (completion attempted at the beginning of an empty line), any - compspec defined with the --EE option to ccoommpplleettee is used. If a compspec - has been defined for that command, the compspec is used to generate the - list of possible completions for the word. If the command word is a - full pathname, a compspec for the full pathname is searched for first. - If no compspec is found for the full pathname, an attempt is made to - find a compspec for the portion following the final slash. If those - searches do not result in a compspec, any compspec defined with the --DD - option to ccoommpplleettee is used as the default. If there is no default comp- - spec, bbaasshh attempts alias expansion on the command word as a final re- - sort, and attempts to find a compspec for the command word from any - successful expansion. + First, the command name is identified. If the command word is the + empty string (completion attempted at the beginning of an empty line), + any compspec defined with the --EE option to ccoommpplleettee is used. If a + compspec has been defined for that command, the compspec is used to + generate the list of possible completions for the word. If the command + word is a full pathname, a compspec for the full pathname is searched + for first. If no compspec is found for the full pathname, an attempt + is made to find a compspec for the portion following the final slash. + If those searches do not result in a compspec, any compspec defined + with the --DD option to ccoommpplleettee is used as the default. If there is no + default compspec, bbaasshh attempts alias expansion on the command word as + a final resort, and attempts to find a compspec for the command word + from any successful expansion. - Once a compspec has been found, it is used to generate the list of - matching words. If a compspec is not found, the default bbaasshh completion - as described above under CCoommpplleettiinngg is performed. + Once a compspec has been found, it is used to generate the list of + matching words. If a compspec is not found, the default bbaasshh comple- + tion as described above under CCoommpplleettiinngg is performed. - First, the actions specified by the compspec are used. Only matches - which are prefixed by the word being completed are returned. When the - --ff or --dd option is used for filename or directory name completion, the + First, the actions specified by the compspec are used. Only matches + which are prefixed by the word being completed are returned. When the + --ff or --dd option is used for filename or directory name completion, the shell variable FFIIGGNNOORREE is used to filter the matches. Any completions specified by a pathname expansion pattern to the --GG op- - tion are generated next. The words generated by the pattern need not - match the word being completed. The GGLLOOBBIIGGNNOORREE shell variable is not + tion are generated next. The words generated by the pattern need not + match the word being completed. The GGLLOOBBIIGGNNOORREE shell variable is not used to filter the matches, but the FFIIGGNNOORREE variable is used. - Next, the string specified as the argument to the --WW option is consid- - ered. The string is first split using the characters in the IIFFSS special - variable as delimiters. Shell quoting is honored. Each word is then ex- - panded using brace expansion, tilde expansion, parameter and variable - expansion, command substitution, and arithmetic expansion, as described - above under EEXXPPAANNSSIIOONN. The results are split using the rules described - above under WWoorrdd SSpplliittttiinngg. The results of the expansion are prefix- - matched against the word being completed, and the matching words become - the possible completions. + Next, the string specified as the argument to the --WW option is consid- + ered. The string is first split using the characters in the IIFFSS spe- + cial variable as delimiters. Shell quoting is honored. Each word is + then expanded using brace expansion, tilde expansion, parameter and + variable expansion, command substitution, and arithmetic expansion, as + described above under EEXXPPAANNSSIIOONN. The results are split using the rules + described above under WWoorrdd SSpplliittttiinngg. The results of the expansion are + prefix-matched against the word being completed, and the matching words + become the possible completions. - After these matches have been generated, any shell function or command - specified with the --FF and --CC options is invoked. When the command or + After these matches have been generated, any shell function or command + specified with the --FF and --CC options is invoked. When the command or function is invoked, the CCOOMMPP__LLIINNEE, CCOOMMPP__PPOOIINNTT, CCOOMMPP__KKEEYY, and CCOOMMPP__TTYYPPEE variables are assigned values as described above under SShheellll VVaarriiaabblleess. - If a shell function is being invoked, the CCOOMMPP__WWOORRDDSS and CCOOMMPP__CCWWOORRDD - variables are also set. When the function or command is invoked, the - first argument ($$11) is the name of the command whose arguments are be- - ing completed, the second argument ($$22) is the word being completed, - and the third argument ($$33) is the word preceding the word being com- - pleted on the current command line. No filtering of the generated com- + If a shell function is being invoked, the CCOOMMPP__WWOORRDDSS and CCOOMMPP__CCWWOORRDD + variables are also set. When the function or command is invoked, the + first argument ($$11) is the name of the command whose arguments are be- + ing completed, the second argument ($$22) is the word being completed, + and the third argument ($$33) is the word preceding the word being com- + pleted on the current command line. No filtering of the generated com- pletions against the word being completed is performed; the function or command has complete freedom in generating the matches. - Any function specified with --FF is invoked first. The function may use - any of the shell facilities, including the ccoommppggeenn builtin described - below, to generate the matches. It must put the possible completions in - the CCOOMMPPRREEPPLLYY array variable, one per array element. + Any function specified with --FF is invoked first. The function may use + any of the shell facilities, including the ccoommppggeenn builtin described + below, to generate the matches. It must put the possible completions + in the CCOOMMPPRREEPPLLYY array variable, one per array element. - Next, any command specified with the --CC option is invoked in an envi- - ronment equivalent to command substitution. It should print a list of - completions, one per line, to the standard output. Backslash may be + Next, any command specified with the --CC option is invoked in an envi- + ronment equivalent to command substitution. It should print a list of + completions, one per line, to the standard output. Backslash may be used to escape a newline, if necessary. - After all of the possible completions are generated, any filter speci- - fied with the --XX option is applied to the list. The filter is a pattern - as used for pathname expansion; a && in the pattern is replaced with the - text of the word being completed. A literal && may be escaped with a - backslash; the backslash is removed before attempting a match. Any com- - pletion that matches the pattern will be removed from the list. A lead- - ing !! negates the pattern; in this case any completion not matching the - pattern will be removed. If the nnooccaasseemmaattcchh shell option is enabled, - the match is performed without regard to the case of alphabetic charac- - ters. + After all of the possible completions are generated, any filter speci- + fied with the --XX option is applied to the list. The filter is a pat- + tern as used for pathname expansion; a && in the pattern is replaced + with the text of the word being completed. A literal && may be escaped + with a backslash; the backslash is removed before attempting a match. + Any completion that matches the pattern will be removed from the list. + A leading !! negates the pattern; in this case any completion not match- + ing the pattern will be removed. If the nnooccaasseemmaattcchh shell option is + enabled, the match is performed without regard to the case of alpha- + betic characters. Finally, any prefix and suffix specified with the --PP and --SS options are added to each member of the completion list, and the result is returned to the readline completion code as the list of possible completions. - If the previously-applied actions do not generate any matches, and the - --oo ddiirrnnaammeess option was supplied to ccoommpplleettee when the compspec was de- + If the previously-applied actions do not generate any matches, and the + --oo ddiirrnnaammeess option was supplied to ccoommpplleettee when the compspec was de- fined, directory name completion is attempted. - If the --oo pplluussddiirrss option was supplied to ccoommpplleettee when the compspec + If the --oo pplluussddiirrss option was supplied to ccoommpplleettee when the compspec was defined, directory name completion is attempted and any matches are added to the results of the other actions. - By default, if a compspec is found, whatever it generates is returned - to the completion code as the full set of possible completions. The de- - fault bbaasshh completions are not attempted, and the readline default of - filename completion is disabled. If the --oo bbaasshhddeeffaauulltt option was sup- - plied to ccoommpplleettee when the compspec was defined, the bbaasshh default com- - pletions are attempted if the compspec generates no matches. If the --oo - ddeeffaauulltt option was supplied to ccoommpplleettee when the compspec was defined, - readline's default completion will be performed if the compspec (and, + By default, if a compspec is found, whatever it generates is returned + to the completion code as the full set of possible completions. The + default bbaasshh completions are not attempted, and the readline default of + filename completion is disabled. If the --oo bbaasshhddeeffaauulltt option was sup- + plied to ccoommpplleettee when the compspec was defined, the bbaasshh default com- + pletions are attempted if the compspec generates no matches. If the --oo + ddeeffaauulltt option was supplied to ccoommpplleettee when the compspec was defined, + readline's default completion will be performed if the compspec (and, if attempted, the default bbaasshh completions) generate no matches. - When a compspec indicates that directory name completion is desired, - the programmable completion functions force readline to append a slash - to completed names which are symbolic links to directories, subject to - the value of the mmaarrkk--ddiirreeccttoorriieess readline variable, regardless of the + When a compspec indicates that directory name completion is desired, + the programmable completion functions force readline to append a slash + to completed names which are symbolic links to directories, subject to + the value of the mmaarrkk--ddiirreeccttoorriieess readline variable, regardless of the setting of the mmaarrkk--ssyymmlliinnkkeedd--ddiirreeccttoorriieess readline variable. - There is some support for dynamically modifying completions. This is - most useful when used in combination with a default completion speci- - fied with ccoommpplleettee --DD. It's possible for shell functions executed as - completion handlers to indicate that completion should be retried by - returning an exit status of 124. If a shell function returns 124, and + There is some support for dynamically modifying completions. This is + most useful when used in combination with a default completion speci- + fied with ccoommpplleettee --DD. It's possible for shell functions executed as + completion handlers to indicate that completion should be retried by + returning an exit status of 124. If a shell function returns 124, and changes the compspec associated with the command on which completion is - being attempted (supplied as the first argument when the function is + being attempted (supplied as the first argument when the function is executed), programmable completion restarts from the beginning, with an - attempt to find a new compspec for that command. This allows a set of - completions to be built dynamically as completion is attempted, rather + attempt to find a new compspec for that command. This allows a set of + completions to be built dynamically as completion is attempted, rather than being loaded all at once. - For instance, assuming that there is a library of compspecs, each kept - in a file corresponding to the name of the command, the following de- + For instance, assuming that there is a library of compspecs, each kept + in a file corresponding to the name of the command, the following de- fault completion function would load completions dynamically: _completion_loader() @@ -4341,177 +4368,177 @@ RREEAADDLLIINNEE HHIISSTTOORRYY - When the --oo hhiissttoorryy option to the sseett builtin is enabled, the shell + When the --oo hhiissttoorryy option to the sseett builtin is enabled, the shell provides access to the _c_o_m_m_a_n_d _h_i_s_t_o_r_y, the list of commands previously - typed. The value of the HHIISSTTSSIIZZEE variable is used as the number of com- - mands to save in a history list. The text of the last HHIISSTTSSIIZZEE commands - (default 500) is saved. The shell stores each command in the history - list prior to parameter and variable expansion (see EEXXPPAANNSSIIOONN above) - but after history expansion is performed, subject to the values of the - shell variables HHIISSTTIIGGNNOORREE and HHIISSTTCCOONNTTRROOLL. + typed. The value of the HHIISSTTSSIIZZEE variable is used as the number of + commands to save in a history list. The text of the last HHIISSTTSSIIZZEE com- + mands (default 500) is saved. The shell stores each command in the + history list prior to parameter and variable expansion (see EEXXPPAANNSSIIOONN + above) but after history expansion is performed, subject to the values + of the shell variables HHIISSTTIIGGNNOORREE and HHIISSTTCCOONNTTRROOLL. On startup, the history is initialized from the file named by the vari- - able HHIISSTTFFIILLEE (default _~_/_._b_a_s_h___h_i_s_t_o_r_y). The file named by the value of - HHIISSTTFFIILLEE is truncated, if necessary, to contain no more than the number - of lines specified by the value of HHIISSTTFFIILLEESSIIZZEE. If HHIISSTTFFIILLEESSIIZZEE is un- - set, or set to null, a non-numeric value, or a numeric value less than - zero, the history file is not truncated. When the history file is read, - lines beginning with the history comment character followed immediately - by a digit are interpreted as timestamps for the following history - line. These timestamps are optionally displayed depending on the value - of the HHIISSTTTTIIMMEEFFOORRMMAATT variable. When a shell with history enabled ex- - its, the last $$HHIISSTTSSIIZZEE lines are copied from the history list to - $$HHIISSTTFFIILLEE. If the hhiissttaappppeenndd shell option is enabled (see the descrip- - tion of sshhoopptt under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below), the lines are ap- - pended to the history file, otherwise the history file is overwritten. - If HHIISSTTFFIILLEE is unset or null, or if the history file is unwritable, the - history is not saved. If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, time - stamps are written to the history file, marked with the history comment - character, so they may be preserved across shell sessions. This uses - the history comment character to distinguish timestamps from other his- - tory lines. After saving the history, the history file is truncated to - contain no more than HHIISSTTFFIILLEESSIIZZEE lines. If HHIISSTTFFIILLEESSIIZZEE is unset, or - set to null, a non-numeric value, or a numeric value less than zero, - the history file is not truncated. + able HHIISSTTFFIILLEE (default _~_/_._b_a_s_h___h_i_s_t_o_r_y). The file named by the value + of HHIISSTTFFIILLEE is truncated, if necessary, to contain no more than the + number of lines specified by the value of HHIISSTTFFIILLEESSIIZZEE. If HHIISSTTFFIILLEE-- + SSIIZZEE is unset, or set to null, a non-numeric value, or a numeric value + less than zero, the history file is not truncated. When the history + file is read, lines beginning with the history comment character fol- + lowed immediately by a digit are interpreted as timestamps for the fol- + lowing history line. These timestamps are optionally displayed depend- + ing on the value of the HHIISSTTTTIIMMEEFFOORRMMAATT variable. When a shell with + history enabled exits, the last $$HHIISSTTSSIIZZEE lines are copied from the + history list to $$HHIISSTTFFIILLEE. If the hhiissttaappppeenndd shell option is enabled + (see the description of sshhoopptt under SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below), the + lines are appended to the history file, otherwise the history file is + overwritten. If HHIISSTTFFIILLEE is unset or null, or if the history file is + unwritable, the history is not saved. If the HHIISSTTTTIIMMEEFFOORRMMAATT variable + is set, time stamps are written to the history file, marked with the + history comment character, so they may be preserved across shell ses- + sions. This uses the history comment character to distinguish time- + stamps from other history lines. After saving the history, the history + file is truncated to contain no more than HHIISSTTFFIILLEESSIIZZEE lines. If HHIISSTT-- + FFIILLEESSIIZZEE is unset, or set to null, a non-numeric value, or a numeric + value less than zero, the history file is not truncated. - The builtin command ffcc (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) may be used - to list or edit and re-execute a portion of the history list. The hhiiss-- - ttoorryy builtin may be used to display or modify the history list and ma- - nipulate the history file. When using command-line editing, search com- - mands are available in each editing mode that provide access to the + The builtin command ffcc (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) may be used + to list or edit and re-execute a portion of the history list. The hhiiss-- + ttoorryy builtin may be used to display or modify the history list and ma- + nipulate the history file. When using 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 HHIISSTTCCOONNTTRROOLL and HHIISSTTIIGGNNOORREE variables are used to cause the - shell to save only a subset of the commands entered. The ccmmddhhiisstt 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 lliitthhiisstt shell option - causes the shell to save the command with embedded newlines instead of + The shell allows control over which commands are saved on the history + list. The HHIISSTTCCOONNTTRROOLL and HHIISSTTIIGGNNOORREE variables are used to cause the + shell to save only a subset of the commands entered. The ccmmddhhiisstt 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 lliitthhiisstt shell option + causes the shell to save the command with embedded newlines instead of semicolons. See the description of the sshhoopptt builtin below under SSHHEELLLL - BBUUIILLTTIINN CCOOMMMMAANNDDSS for information on setting and unsetting shell op- + BBUUIILLTTIINN CCOOMMMMAANNDDSS for information on setting and unsetting shell op- tions. HHIISSTTOORRYY EEXXPPAANNSSIIOONN - The shell supports a history expansion feature that is similar to the - history expansion in ccsshh. This section describes what syntax features - are available. This feature is enabled by default for interactive + The shell supports a history expansion feature that is similar to the + history expansion in ccsshh. This section describes what syntax features + are available. This feature is enabled by default for interactive shells, and can be disabled using the ++HH option to the sseett builtin com- - mand (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). Non-interactive shells do not + mand (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). Non-interactive shells do not perform history expansion by default. History expansions introduce words from the history list into the input - stream, making it easy to repeat commands, insert the arguments to a + stream, making it easy to repeat commands, insert the arguments to a previous command into the current input line, or fix errors in previous commands quickly. - History expansion is performed immediately after a complete line is - read, before the shell breaks it into words, and is performed on each - line individually without taking quoting on previous lines into ac- - count. It takes place in two parts. 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 history is the _e_v_e_n_t, and the portions of that - line that are acted upon are _w_o_r_d_s. The line is broken into words in - the same fashion as when reading input, so that several _m_e_t_a_c_h_a_r_a_c_t_e_r- - separated words surrounded by quotes are considered one word. The _e_v_e_n_t - _d_e_s_i_g_n_a_t_o_r selects the event, the optional _w_o_r_d _d_e_s_i_g_n_a_t_o_r selects - words from the event, and various optional _m_o_d_i_f_i_e_r_s are available to - manipulate the selected words. + History expansion is performed immediately after a complete line is + read, before the shell breaks it into words, and is performed on each + line individually without taking quoting on previous lines into ac- + count. It takes place in two parts. 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 history is the _e_v_e_n_t, and the portions of + that line that are acted upon are _w_o_r_d_s. The line is broken into words + in the same fashion as when reading input, so that several _m_e_t_a_c_h_a_r_a_c_- + _t_e_r-separated words surrounded by quotes are considered one word. The + _e_v_e_n_t _d_e_s_i_g_n_a_t_o_r selects the event, the optional _w_o_r_d _d_e_s_i_g_n_a_t_o_r se- + lects words from the event, and various optional _m_o_d_i_f_i_e_r_s are avail- + able to manipulate the selected words. - History expansions are introduced by the appearance of the history ex- - pansion character, which is !! by default. History expansions may appear - anywhere in the input, but do not nest. + History expansions are introduced by the appearance of the history ex- + pansion character, which is !! by default. History expansions may ap- + pear anywhere in the input, but do not nest. - Only backslash (\\) and single quotes can quote the history expansion - character, but the history expansion character is also treated as + Only backslash (\\) and single quotes can quote the history expansion + character, but the history expansion character is also treated as quoted if it immediately precedes the closing double quote in a double- quoted string. - Several characters inhibit history expansion if found immediately fol- - lowing the history expansion character, even if it is unquoted: space, - tab, newline, carriage return, ==, and the other shell metacharacters + Several characters inhibit history expansion if found immediately fol- + lowing the history expansion character, even if it is unquoted: space, + tab, newline, carriage return, ==, and the other shell metacharacters defined above. - Several shell options settable with the sshhoopptt builtin may be used to - tailor the behavior of history expansion. If the hhiissttvveerriiffyy shell op- - tion is enabled (see the description of the sshhoopptt builtin below), and - rreeaaddlliinnee is being used, history substitutions are not immediately - passed to the shell parser. Instead, the expanded line is reloaded into - the rreeaaddlliinnee editing buffer for further modification. If rreeaaddlliinnee is - being used, and the hhiissttrreeeeddiitt shell option is enabled, a failed his- - tory substitution will be reloaded into the rreeaaddlliinnee editing buffer for - correction. The --pp option to the hhiissttoorryy builtin command may be used to - see what a history expansion will do before using it. The --ss option to - the hhiissttoorryy builtin may be used to add commands to the end of the his- - tory list without actually executing them, so that they are available - for subsequent recall. + Several shell options settable with the sshhoopptt builtin may be used to + tailor the behavior of history expansion. If the hhiissttvveerriiffyy shell op- + tion is enabled (see the description of the sshhoopptt builtin below), and + rreeaaddlliinnee is being used, history substitutions are not immediately + passed to the shell parser. Instead, the expanded line is reloaded + into the rreeaaddlliinnee editing buffer for further modification. If rreeaaddlliinnee + is being used, and the hhiissttrreeeeddiitt shell option is enabled, a failed + history substitution will be reloaded into the rreeaaddlliinnee editing buffer + for correction. The --pp option to the hhiissttoorryy builtin command may be + used to see what a history expansion will do before using it. The --ss + option to the hhiissttoorryy 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. - The shell allows control of the various characters used by the history + The shell allows control of the various characters used by the history expansion mechanism (see the description of hhiissttcchhaarrss above under SShheellll - VVaarriiaabblleess). The shell uses the history comment character to mark his- + VVaarriiaabblleess). The shell uses the history comment character to mark his- tory timestamps when writing the history file. EEvveenntt DDeessiiggnnaattoorrss - An event designator is a reference to a command line entry in the his- - tory list. The event designator consists of the portion of the word be- - ginning with the history expansion character and ending with the word - designator if present, or the end of the word. Unless the reference is - absolute, events are relative to the current position in the history + An event designator is a reference to a command line entry in the his- + tory list. The event designator consists of the portion of the word + beginning with the history expansion character and ending with the word + designator if present, or the end of the word. Unless the reference is + absolute, events are relative to the current position in the history list. - !! Start a history substitution, except when followed by a bbllaannkk, - newline, carriage return, = or ( (when the eexxttgglloobb shell option + !! Start a history substitution, except when followed by a bbllaannkk, + newline, carriage return, = or ( (when the eexxttgglloobb shell option is enabled using the sshhoopptt builtin). !!_n Refer to command line _n. !!--_n Refer to the current command minus _n. - !!!! Refer to the previous command. This is a synonym for `!-1'. + !!!! Refer to the previous command. This is a synonym for `!-1'. !!_s_t_r_i_n_g - Refer to the most recent command preceding the current position + Refer to the most recent command preceding the current position in the history list starting with _s_t_r_i_n_g. !!??_s_t_r_i_n_g[[??]] - Refer to the most recent command preceding the current position - in the history list containing _s_t_r_i_n_g. The trailing ?? may be - omitted if _s_t_r_i_n_g is followed immediately by a newline. If - _s_t_r_i_n_g is missing, the string from the most recent search is + Refer to the most recent command preceding the current position + in the history list containing _s_t_r_i_n_g. The trailing ?? may be + omitted if _s_t_r_i_n_g is followed immediately by a newline. If + _s_t_r_i_n_g is missing, the string from the most recent search is used; it is an error if there is no previous search string. ^^_s_t_r_i_n_g_1^^_s_t_r_i_n_g_2^^ - Quick substitution. Repeat the previous command, replacing - _s_t_r_i_n_g_1 with _s_t_r_i_n_g_2. Equivalent to ``!!:s^_s_t_r_i_n_g_1^_s_t_r_i_n_g_2^'' + Quick substitution. Repeat the previous command, replacing + _s_t_r_i_n_g_1 with _s_t_r_i_n_g_2. Equivalent to ``!!:s^_s_t_r_i_n_g_1^_s_t_r_i_n_g_2^'' (see MMooddiiffiieerrss below). !!## The entire command line typed so far. WWoorrdd DDeessiiggnnaattoorrss - Word designators are used to select desired words from the event. A :: - 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 line separated - by single spaces. + Word designators are used to select desired words from the event. A :: + 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 line sepa- + rated by single spaces. 00 ((zzeerroo)) - The zeroth word. For the shell, this is the command word. + The zeroth word. For the shell, this is the command word. _n The _nth word. - ^^ The first argument. That is, word 1. - $$ The last word. This is usually the last argument, but will ex- + ^^ The first argument. That is, word 1. + $$ The last word. This is usually the last argument, but will ex- pand to the zeroth word if there is only one word in the line. - %% The first word matched by the most recent `?_s_t_r_i_n_g?' search, if - the search string begins with a character that is part of a + %% The first word matched by the most recent `?_s_t_r_i_n_g?' search, if + the search string begins with a character that is part of a word. _x--_y A range of words; `-_y' abbreviates `0-_y'. - ** All of the words but the zeroth. This is a synonym for `_1_-_$'. It - is not an error to use ** if there is just one word in the event; - the empty string is returned in that case. + ** All of the words but the zeroth. This is a synonym for `_1_-_$'. + It is not an error to use ** if there is just one word in the + event; the empty string is returned in that case. xx** Abbreviates _x_-_$. - xx-- Abbreviates _x_-_$ like xx**, but omits the last word. If xx is miss- + xx-- Abbreviates _x_-_$ like xx**, but omits the last word. If xx is miss- ing, it defaults to 0. - If a word designator is supplied without an event specification, the + If a word designator is supplied without an event specification, the previous command is used as the event. MMooddiiffiieerrss - After the optional word designator, there may appear a sequence of one - or more of the following modifiers, each preceded by a `:'. These mod- + After the optional word designator, there may appear a sequence of one + or more of the following modifiers, each preceded by a `:'. These mod- ify, or edit, the word or words selected from the history event. hh Remove a trailing filename component, leaving only the head. @@ -4520,25 +4547,25 @@ HHIISSTTOORRYY EEXXPPAANNSSIIOONN ee Remove all but the trailing suffix. pp Print the new command but do not execute it. qq Quote the substituted words, escaping further substitutions. - xx Quote the substituted words as with qq, but break into words at - bbllaannkkss and newlines. The qq and xx modifiers are mutually exclu- + xx Quote the substituted words as with qq, but break into words at + bbllaannkkss and newlines. The qq and xx modifiers are mutually exclu- sive; the last one supplied is used. ss//_o_l_d//_n_e_w// - Substitute _n_e_w for the first occurrence of _o_l_d in the event + Substitute _n_e_w for the first occurrence of _o_l_d in the event line. Any character may be used as the delimiter in place of /. - The final delimiter is optional if it is the last character of - the event line. The delimiter may be quoted in _o_l_d and _n_e_w with - a single backslash. If & appears in _n_e_w, it is replaced by _o_l_d. - A single backslash will quote the &. If _o_l_d is null, it is set - to the last _o_l_d substituted, or, if no previous history substi- - tutions took place, the last _s_t_r_i_n_g in a !!??_s_t_r_i_n_g[[??]] search. If - _n_e_w is null, each matching _o_l_d is deleted. + The final delimiter is optional if it is the last character of + the event line. The delimiter may be quoted in _o_l_d and _n_e_w with + a single backslash. If & appears in _n_e_w, it is replaced by _o_l_d. + A single backslash will quote the &. If _o_l_d is null, it is set + to the last _o_l_d substituted, or, if no previous history substi- + tutions took place, the last _s_t_r_i_n_g in a !!??_s_t_r_i_n_g[[??]] search. + If _n_e_w is null, each matching _o_l_d is deleted. && Repeat the previous substitution. - gg Cause changes to be applied over the entire event line. This is - used in conjunction with `::ss' (e.g., `::ggss//_o_l_d//_n_e_w//') or `::&&'. If - used with `::ss', any delimiter can be used in place of /, and the - final delimiter is optional if it is the last character of the - event line. An aa may be used as a synonym for gg. + gg Cause changes to be applied over the entire event line. This is + used in conjunction with `::ss' (e.g., `::ggss//_o_l_d//_n_e_w//') or `::&&'. + If used with `::ss', any delimiter can be used in place of /, and + the final delimiter is optional if it is the last character of + the event line. An aa may be used as a synonym for gg. GG Apply the following `ss' or `&&' modifier once to each word in the event line. @@ -4546,53 +4573,54 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS Unless otherwise noted, each builtin command documented in this section as accepting options preceded by -- accepts ---- to signify the end of the options. The ::, ttrruuee, ffaallssee, and tteesstt/[[ builtins do not accept options - and do not treat ---- specially. The eexxiitt, llooggoouutt, rreettuurrnn, bbrreeaakk, ccoonn-- - ttiinnuuee, lleett, and sshhiifftt builtins accept and process arguments beginning - with -- without requiring ----. Other builtins that accept arguments but - are not specified as accepting options interpret arguments beginning - with -- as invalid options and require ---- to prevent this interpreta- + and do not treat ---- specially. The eexxiitt, llooggoouutt, rreettuurrnn, bbrreeaakk, ccoonn-- + ttiinnuuee, lleett, and sshhiifftt builtins accept and process arguments beginning + with -- without requiring ----. Other builtins that accept arguments but + are not specified as accepting options interpret arguments beginning + with -- as invalid options and require ---- to prevent this interpreta- tion. :: [_a_r_g_u_m_e_n_t_s] - No effect; the command does nothing beyond expanding _a_r_g_u_m_e_n_t_s - and performing any specified redirections. The return status is + No effect; the command does nothing beyond expanding _a_r_g_u_m_e_n_t_s + and performing any specified redirections. The return status is zero. .. _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] ssoouurrccee _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] Read and execute commands from _f_i_l_e_n_a_m_e in the current shell en- - vironment and return the exit status of the last command exe- - cuted from _f_i_l_e_n_a_m_e. If _f_i_l_e_n_a_m_e does not contain a slash, file- - names in PPAATTHH are used to find the directory containing _f_i_l_e_- - _n_a_m_e, but _f_i_l_e_n_a_m_e does not need to be executable. The file - searched for in PPAATTHH need not be executable. When bbaasshh is not in - _p_o_s_i_x _m_o_d_e, it searches the current directory if no file is - found in PPAATTHH. If the ssoouurrcceeppaatthh option to the sshhoopptt builtin - command is turned off, the PPAATTHH is not searched. If any _a_r_g_u_- - _m_e_n_t_s are supplied, they become the positional parameters when - _f_i_l_e_n_a_m_e is executed. Otherwise the positional parameters are - unchanged. If the --TT option is enabled, .. inherits any trap on + vironment and return the exit status of the last command exe- + cuted from _f_i_l_e_n_a_m_e. If _f_i_l_e_n_a_m_e does not contain a slash, + filenames in PPAATTHH are used to find the directory containing + _f_i_l_e_n_a_m_e, but _f_i_l_e_n_a_m_e does not need to be executable. The file + searched for in PPAATTHH need not be executable. When bbaasshh is not + in _p_o_s_i_x _m_o_d_e, it searches the current directory if no file is + found in PPAATTHH. If the ssoouurrcceeppaatthh option to the sshhoopptt builtin + command is turned off, the PPAATTHH is not searched. If any _a_r_g_u_- + _m_e_n_t_s are supplied, they become the positional parameters when + _f_i_l_e_n_a_m_e is executed. Otherwise the positional parameters are + unchanged. If the --TT option is enabled, .. inherits any trap on DDEEBBUUGG; if it is not, any DDEEBBUUGG trap string is saved and restored - around the call to .., and .. unsets the DDEEBBUUGG trap while it exe- + around the call to .., and .. unsets the DDEEBBUUGG trap while it exe- cutes. If --TT is not set, and the sourced file changes the DDEEBBUUGG - trap, the new value is retained when .. completes. The return - status is the status of the last command exited within the + trap, the new value is retained when .. completes. The return + status is the status of the last command exited within the script (0 if no commands are executed), and false if _f_i_l_e_n_a_m_e is not found or cannot be read. aalliiaass [--pp] [_n_a_m_e[=_v_a_l_u_e] ...] AAlliiaass with no arguments or with the --pp option prints the list of - aliases in the form aalliiaass _n_a_m_e=_v_a_l_u_e on standard output. When - arguments are supplied, an alias is defined for each _n_a_m_e whose - _v_a_l_u_e is given. A trailing space in _v_a_l_u_e causes the next word + aliases in the form aalliiaass _n_a_m_e=_v_a_l_u_e on standard output. When + arguments are supplied, an alias is defined for each _n_a_m_e whose + _v_a_l_u_e is given. A trailing space in _v_a_l_u_e causes the next word to be checked for alias substitution when the alias is expanded. - For each _n_a_m_e in the argument list for which no _v_a_l_u_e is sup- - plied, the name and value of the alias is printed. AAlliiaass returns - true unless a _n_a_m_e is given for which no alias has been defined. + For each _n_a_m_e in the argument list for which no _v_a_l_u_e is sup- + plied, the name and value of the alias is printed. AAlliiaass re- + turns true unless a _n_a_m_e is given for which no alias has been + defined. bbgg [_j_o_b_s_p_e_c ...] Resume each suspended job _j_o_b_s_p_e_c in the background, as if it - had been started with &&. If _j_o_b_s_p_e_c is not present, the shell's - notion of the _c_u_r_r_e_n_t _j_o_b is used. bbgg _j_o_b_s_p_e_c returns 0 unless + had been started with &&. If _j_o_b_s_p_e_c is not present, the shell's + notion of the _c_u_r_r_e_n_t _j_o_b is used. bbgg _j_o_b_s_p_e_c returns 0 unless run when job control is disabled or, when run with job control enabled, any specified _j_o_b_s_p_e_c was not found or was started without job control. @@ -4609,24 +4637,25 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS variable. Each non-option argument is a command as it would ap- pear in a rreeaaddlliinnee initialization file such as _._i_n_p_u_t_r_c, but each binding or command must be passed as a separate argument; - e.g., '"\C-x\C-r": re-read-init-file'. Options, if supplied, + e.g., '"\C-x\C-r": re-read-init-file'. Options, if supplied, have the following meanings: --mm _k_e_y_m_a_p Use _k_e_y_m_a_p as the keymap to be affected by the subsequent - bindings. Acceptable _k_e_y_m_a_p names are _e_m_a_c_s_, _e_m_a_c_s_-_s_t_a_n_- + bindings. Acceptable _k_e_y_m_a_p names are _e_m_a_c_s_, _e_m_a_c_s_-_s_t_a_n_- _d_a_r_d_, _e_m_a_c_s_-_m_e_t_a_, _e_m_a_c_s_-_c_t_l_x_, _v_i_, _v_i_-_m_o_v_e_, _v_i_-_c_o_m_m_a_n_d, - and _v_i_-_i_n_s_e_r_t. _v_i is equivalent to _v_i_-_c_o_m_m_a_n_d (_v_i_-_m_o_v_e is - also a synonym); _e_m_a_c_s is equivalent to _e_m_a_c_s_-_s_t_a_n_d_a_r_d. + and _v_i_-_i_n_s_e_r_t. _v_i is equivalent to _v_i_-_c_o_m_m_a_n_d (_v_i_-_m_o_v_e + is also a synonym); _e_m_a_c_s is equivalent to _e_m_a_c_s_-_s_t_a_n_- + _d_a_r_d. --ll List the names of all rreeaaddlliinnee functions. - --pp Display rreeaaddlliinnee function names and bindings in such a + --pp Display rreeaaddlliinnee function names and bindings in such a way that they can be re-read. --PP List current rreeaaddlliinnee function names and bindings. - --ss Display rreeaaddlliinnee key sequences bound to macros and the - strings they output in such a way that they can be re- + --ss Display rreeaaddlliinnee key sequences bound to macros and the + strings they output in such a way that they can be re- read. - --SS Display rreeaaddlliinnee key sequences bound to macros and the + --SS Display rreeaaddlliinnee key sequences bound to macros and the strings they output. - --vv Display rreeaaddlliinnee variable names and values in such a way + --vv Display rreeaaddlliinnee variable names and values in such a way that they can be re-read. --VV List current rreeaaddlliinnee variable names and values. --ff _f_i_l_e_n_a_m_e @@ -4640,120 +4669,121 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --xx _k_e_y_s_e_q[[:: ]]_s_h_e_l_l_-_c_o_m_m_a_n_d Cause _s_h_e_l_l_-_c_o_m_m_a_n_d to be executed whenever _k_e_y_s_e_q is en- tered. The separator between _k_e_y_s_e_q and _s_h_e_l_l_-_c_o_m_m_a_n_d is - either whitespace or a colon optionally followed by - whitespace. If the separator is whitespace, _s_h_e_l_l_-_c_o_m_m_a_n_d - must be enclosed in double quotes and rreeaaddlliinnee expands - any of its special backslash-escapes in _s_h_e_l_l_-_c_o_m_m_a_n_d be- - fore saving it. If the separator is a colon, any enclos- - ing double quotes are optional, and rreeaaddlliinnee does not ex- - pand the command string before saving it. Since the en- - tire key binding expression must be a single argument, it - should be enclosed in quotes. When _s_h_e_l_l_-_c_o_m_m_a_n_d is exe- - cuted, the shell sets the RREEAADDLLIINNEE__LLIINNEE variable to the - contents of the rreeaaddlliinnee line buffer and the RREEAADD-- - LLIINNEE__PPOOIINNTT and RREEAADDLLIINNEE__MMAARRKK variables to the current lo- - cation of the insertion point and the saved insertion - point (the mark), respectively. The shell assigns any nu- - meric argument the user supplied to the RREEAADDLLIINNEE__AARRGGUUMMEENNTT - variable. If there was no argument, that variable is not - set. If the executed command changes the value of any of - RREEAADDLLIINNEE__LLIINNEE, RREEAADDLLIINNEE__PPOOIINNTT, or RREEAADDLLIINNEE__MMAARRKK, those - new values will be reflected in the editing state. - --XX List all key sequences bound to shell commands and the + either whitespace or a colon optionally followed by + whitespace. If the separator is whitespace, _s_h_e_l_l_-_c_o_m_- + _m_a_n_d must be enclosed in double quotes and rreeaaddlliinnee ex- + pands any of its special backslash-escapes in _s_h_e_l_l_-_c_o_m_- + _m_a_n_d before saving it. If the separator is a colon, any + enclosing double quotes are optional, and rreeaaddlliinnee does + not expand the command string before saving it. Since + the entire key binding expression must be a single argu- + ment, it should be enclosed in quotes. When _s_h_e_l_l_-_c_o_m_- + _m_a_n_d is executed, the shell sets the RREEAADDLLIINNEE__LLIINNEE vari- + able to the contents of the rreeaaddlliinnee line buffer and the + RREEAADDLLIINNEE__PPOOIINNTT and RREEAADDLLIINNEE__MMAARRKK variables to the current + location of the insertion point and the saved insertion + point (the mark), respectively. The shell assigns any + numeric argument the user supplied to the RREEAADDLLIINNEE__AARRGGUU-- + MMEENNTT variable. If there was no argument, that variable + is not set. If the executed command changes the value of + any of RREEAADDLLIINNEE__LLIINNEE, RREEAADDLLIINNEE__PPOOIINNTT, or RREEAADDLLIINNEE__MMAARRKK, + those new values will be reflected in the editing state. + --XX List all key sequences bound to shell commands and the associated commands in a format that can be reused as in- put. - The return value is 0 unless an unrecognized option is given or + The return value is 0 unless an unrecognized option is given or an error occurred. bbrreeaakk [_n] - Exit from within a ffoorr, wwhhiillee, uunnttiill, or sseelleecctt loop. If _n is - specified, break _n levels. _n must be >= 1. If _n is greater than - the number of enclosing loops, all enclosing loops are exited. - The return value is 0 unless _n is not greater than or equal to - 1. + Exit from within a ffoorr, wwhhiillee, uunnttiill, or sseelleecctt loop. If _n is + specified, break _n levels. _n must be >= 1. If _n is greater + than the number of enclosing loops, all enclosing loops are ex- + ited. The return value is 0 unless _n is not greater than or + equal to 1. bbuuiillttiinn _s_h_e_l_l_-_b_u_i_l_t_i_n [_a_r_g_u_m_e_n_t_s] - Execute the specified shell builtin, passing it _a_r_g_u_m_e_n_t_s, and - return its exit status. This is useful when defining a function - whose name is the same as a shell builtin, retaining the func- - tionality of the builtin within the function. The ccdd builtin is - commonly redefined this way. The return status is false if + Execute the specified shell builtin, passing it _a_r_g_u_m_e_n_t_s, and + return its exit status. This is useful when defining a function + whose name is the same as a shell builtin, retaining the func- + tionality of the builtin within the function. The ccdd builtin is + commonly redefined this way. The return status is false if _s_h_e_l_l_-_b_u_i_l_t_i_n is not a shell builtin command. ccaalllleerr [_e_x_p_r] Returns the context of any active subroutine call (a shell func- - tion or a script executed with the .. or ssoouurrccee builtins). With- + tion or a script executed with the .. or ssoouurrccee builtins). With- out _e_x_p_r, ccaalllleerr displays the line number and source filename of - the current subroutine call. If a non-negative integer is sup- + the current subroutine call. If a non-negative integer is sup- plied as _e_x_p_r, ccaalllleerr displays the line number, subroutine name, - and source file corresponding to that position in the current - execution call stack. This extra information may be used, for - example, to print a stack trace. The current frame is frame 0. - The return value is 0 unless the shell is not executing a sub- - routine call or _e_x_p_r does not correspond to a valid position in + and source file corresponding to that position in the current + execution call stack. This extra information may be used, for + example, to print a stack trace. The current frame is frame 0. + The return value is 0 unless the shell is not executing a sub- + routine call or _e_x_p_r does not correspond to a valid position in the call stack. ccdd [--LL|[--PP [--ee]]] [-@] [_d_i_r] - Change the current directory to _d_i_r. if _d_i_r is not supplied, the - value of the HHOOMMEE shell variable is the default. The variable - CCDDPPAATTHH defines the search path for the directory containing _d_i_r: - each directory name in CCDDPPAATTHH is searched for _d_i_r. Alternative - directory names in CCDDPPAATTHH are separated by a colon (:). A null - directory name in CCDDPPAATTHH is the same as the current directory, - i.e., ``..''. If _d_i_r begins with a slash (/), then CCDDPPAATTHH is not - used. The --PP option causes ccdd to use the physical directory - structure by resolving symbolic links while traversing _d_i_r and - before processing instances of _._. in _d_i_r (see also the --PP option - to the sseett builtin command); the --LL option forces symbolic links - to be followed by resolving the link after processing instances - of _._. in _d_i_r. If _._. appears in _d_i_r, it is processed by removing - the immediately previous pathname component from _d_i_r, back to a - slash or the beginning of _d_i_r. If the --ee option is supplied with - --PP, and the current working directory cannot be successfully de- - termined after a successful directory change, ccdd will return an - unsuccessful status. On systems that support it, the --@@ option - presents the extended attributes associated with a file as a di- - rectory. An argument of -- is converted to $$OOLLDDPPWWDD before the di- - rectory change is attempted. If a non-empty directory name from - CCDDPPAATTHH is used, or if -- is the first argument, and the directory - change is successful, the absolute pathname of the new working - directory is written to the standard output. If the directory - change is successful, ccdd sets the value of the PPWWDD environment - variable to the new directory name, and sets the OOLLDDPPWWDD environ- - ment variable to the value of the current working directory be- - fore the change. The return value is true if the directory was - successfully changed; false otherwise. + Change the current directory to _d_i_r. if _d_i_r is not supplied, + the value of the HHOOMMEE shell variable is the default. The vari- + able CCDDPPAATTHH defines the search path for the directory containing + _d_i_r: each directory name in CCDDPPAATTHH is searched for _d_i_r. Alter- + native directory names in CCDDPPAATTHH are separated by a colon (:). + A null directory name in CCDDPPAATTHH is the same as the current di- + rectory, i.e., ``..''. If _d_i_r begins with a slash (/), then CCDD-- + PPAATTHH is not used. The --PP option causes ccdd to use the physical + directory structure by resolving symbolic links while traversing + _d_i_r and before processing instances of _._. in _d_i_r (see also the + --PP option to the sseett builtin command); the --LL option forces sym- + bolic links to be followed by resolving the link after process- + ing instances of _._. in _d_i_r. If _._. appears in _d_i_r, it is pro- + cessed by removing the immediately previous pathname component + from _d_i_r, back to a slash or the beginning of _d_i_r. If the --ee + option is supplied with --PP, and the current working directory + cannot be successfully determined after a successful directory + change, ccdd will return an unsuccessful status. On systems that + support it, the --@@ option presents the extended attributes asso- + ciated with a file as a directory. An argument of -- is con- + verted to $$OOLLDDPPWWDD before the directory change is attempted. If + a non-empty directory name from CCDDPPAATTHH is used, or if -- is the + first argument, and the directory change is successful, the ab- + solute pathname of the new working directory is written to the + standard output. If the directory change is successful, ccdd sets + the value of the PPWWDD environment variable to the new directory + name, and sets the OOLLDDPPWWDD environment variable to the value of + the current working directory before the change. The return + value is true if the directory was successfully changed; false + otherwise. ccoommmmaanndd [--ppVVvv] _c_o_m_m_a_n_d [_a_r_g ...] Run _c_o_m_m_a_n_d with _a_r_g_s suppressing the normal shell function lookup. Only builtin commands or commands found in the PPAATTHH are - executed. If the --pp option is given, the search for _c_o_m_m_a_n_d is + executed. If the --pp option is given, the search for _c_o_m_m_a_n_d is performed using a default value for PPAATTHH that is guaranteed to - find all of the standard utilities. If either the --VV or --vv op- - tion is supplied, a description of _c_o_m_m_a_n_d is printed. The --vv + find all of the standard utilities. If either the --VV or --vv op- + tion is supplied, a description of _c_o_m_m_a_n_d is printed. The --vv option causes a single word indicating the command or filename used to invoke _c_o_m_m_a_n_d to be displayed; the --VV option produces a - more verbose description. If the --VV or --vv option is supplied, - the exit status is 0 if _c_o_m_m_a_n_d was found, and 1 if not. If nei- - ther option is supplied and an error occurred or _c_o_m_m_a_n_d cannot - be found, the exit status is 127. Otherwise, the exit status of - the ccoommmmaanndd builtin is the exit status of _c_o_m_m_a_n_d. + more verbose description. If the --VV or --vv option is supplied, + the exit status is 0 if _c_o_m_m_a_n_d was found, and 1 if not. If + neither option is supplied and an error occurred or _c_o_m_m_a_n_d can- + not be found, the exit status is 127. Otherwise, the exit sta- + tus of the ccoommmmaanndd builtin is the exit status of _c_o_m_m_a_n_d. ccoommppggeenn [--VV _v_a_r_n_a_m_e] [_o_p_t_i_o_n] [_w_o_r_d] Generate possible completion matches for _w_o_r_d according to the _o_p_t_i_o_ns, which may be any option accepted by the ccoommpplleettee builtin with the exceptions of --pp, --rr, --DD, --EE, and --II, and write - the matches to the standard output. If the --VV option is sup- + the matches to the standard output. If the --VV option is sup- plied, ccoommppggeenn stores the generated completions into the indexed array variable _v_a_r_n_a_m_e instead of writing them to the standard - output. When using the --FF or --CC options, the various shell vari- - ables set by the programmable completion facilities, while + output. When using the --FF or --CC options, the various shell + variables set by the programmable completion facilities, while available, will not have useful values. The matches will be generated in the same way as if the program- mable completion code had generated them directly from a comple- - tion specification with the same flags. If _w_o_r_d is specified, + tion specification with the same flags. If _w_o_r_d is specified, only those completions matching _w_o_r_d will be displayed. The return value is true unless an invalid option is supplied, @@ -4766,28 +4796,28 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS Specify how arguments to each _n_a_m_e should be completed. If the --pp option is supplied, or if no options are supplied, existing completion specifications are printed in a way that allows them - to be reused as input. The --rr option removes a completion speci- - fication for each _n_a_m_e, or, if no _n_a_m_es are supplied, all com- - pletion specifications. The --DD option indicates that other sup- + to be reused as input. The --rr option removes a completion spec- + ification for each _n_a_m_e, or, if no _n_a_m_es are supplied, all com- + pletion specifications. The --DD option indicates that other sup- plied options and actions should apply to the ``default'' com- mand completion; that is, completion attempted on a command for - which no completion has previously been defined. The --EE option + which no completion has previously been defined. The --EE option indicates that other supplied options and actions should apply to ``empty'' command completion; that is, completion attempted - on a blank line. The --II option indicates that other supplied op- - tions and actions should apply to completion on the initial non- - assignment word on the line, or after a command delimiter such - as ;; or ||, which is usually command name completion. If multiple - options are supplied, the --DD option takes precedence over --EE, - and both take precedence over --II. If any of --DD, --EE, or --II are - supplied, any other _n_a_m_e arguments are ignored; these comple- - tions only apply to the case specified by the option. + on a blank line. The --II option indicates that other supplied + options and actions should apply to completion on the initial + non-assignment word on the line, or after a command delimiter + such as ;; or ||, which is usually command name completion. If + multiple options are supplied, the --DD option takes precedence + over --EE, and both take precedence over --II. If any of --DD, --EE, or + --II are supplied, any other _n_a_m_e arguments are ignored; these + completions only apply to the case specified by the option. The process of applying these completion specifications when word completion is attempted is described above under PPrrooggrraamm-- mmaabbllee CCoommpplleettiioonn. - Other options, if specified, have the following meanings. The + Other options, if specified, have the following meanings. The arguments to the --GG, --WW, and --XX options (and, if necessary, the --PP and --SS options) should be quoted to protect them from expan- sion before the ccoommpplleettee builtin is invoked. @@ -4795,7 +4825,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --oo _c_o_m_p_-_o_p_t_i_o_n The _c_o_m_p_-_o_p_t_i_o_n controls several aspects of the comp- spec's behavior beyond the simple generation of comple- - tions. _c_o_m_p_-_o_p_t_i_o_n may be one of: + tions. _c_o_m_p_-_o_p_t_i_o_n may be one of: bbaasshhddeeffaauulltt Perform the rest of the default bbaasshh completions if the compspec generates no matches. @@ -4809,7 +4839,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS names, so it can perform any filename-specific processing (like adding a slash to directory names, quoting special characters, or suppress- - ing trailing spaces). Intended to be used with + ing trailing spaces). Intended to be used with shell functions. ffuullllqquuoottee Tell readline to quote all the completed words @@ -4830,57 +4860,57 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --AA _a_c_t_i_o_n The _a_c_t_i_o_n may be one of the following to generate a list of possible completions: - aalliiaass Alias names. May also be specified as --aa. + aalliiaass Alias names. May also be specified as --aa. aarrrraayyvvaarr Array variable names. bbiinnddiinngg RReeaaddlliinnee key binding names. - bbuuiillttiinn Names of shell builtin commands. May also be + bbuuiillttiinn Names of shell builtin commands. May also be specified as --bb. - ccoommmmaanndd Command names. May also be specified as --cc. + ccoommmmaanndd Command names. May also be specified as --cc. ddiirreeccttoorryy - Directory names. May also be specified as --dd. + Directory names. May also be specified as --dd. ddiissaabblleedd Names of disabled shell builtins. eennaabblleedd Names of enabled shell builtins. - eexxppoorrtt Names of exported shell variables. May also be + eexxppoorrtt Names of exported shell variables. May also be specified as --ee. - ffiillee File names. May also be specified as --ff. + ffiillee File names. May also be specified as --ff. ffuunnccttiioonn Names of shell functions. - ggrroouupp Group names. May also be specified as --gg. + ggrroouupp Group names. May also be specified as --gg. hheellppttooppiicc Help topics as accepted by the hheellpp builtin. hhoossttnnaammee Hostnames, as taken from the file specified by the HHOOSSTTFFIILLEE shell variable. - jjoobb Job names, if job control is active. May also be - specified as --jj. - kkeeyywwoorrdd Shell reserved words. May also be specified as + jjoobb Job names, if job control is active. May also + be specified as --jj. + kkeeyywwoorrdd Shell reserved words. May also be specified as --kk. rruunnnniinngg Names of running jobs, if job control is active. - sseerrvviiccee Service names. May also be specified as --ss. + sseerrvviiccee Service names. May also be specified as --ss. sseettoopptt Valid arguments for the --oo option to the sseett builtin. sshhoopptt Shell option names as accepted by the sshhoopptt builtin. ssiiggnnaall Signal names. ssttooppppeedd Names of stopped jobs, if job control is active. - uusseerr User names. May also be specified as --uu. + uusseerr User names. May also be specified as --uu. vvaarriiaabbllee - Names of all shell variables. May also be speci- - fied as --vv. + Names of all shell variables. May also be spec- + ified as --vv. --CC _c_o_m_m_a_n_d _c_o_m_m_a_n_d is executed in a subshell environment, and its - output is used as the possible completions. Arguments + output is used as the possible completions. Arguments are passed as with the --FF option. --FF _f_u_n_c_t_i_o_n The shell function _f_u_n_c_t_i_o_n is executed in the current - shell environment. When the function is executed, the + shell environment. When the function is executed, the first argument ($$11) is the name of the command whose ar- guments are being completed, the second argument ($$22) is the word being completed, and the third argument ($$33) is the word preceding the word being completed on the cur- - rent command line. When it finishes, the possible com- + rent command line. When it finishes, the possible com- pletions are retrieved from the value of the CCOOMMPPRREEPPLLYY array variable. --GG _g_l_o_b_p_a_t @@ -4895,7 +4925,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --WW _w_o_r_d_l_i_s_t The _w_o_r_d_l_i_s_t is split using the characters in the IIFFSS special variable as delimiters, and each resultant word - is expanded. Shell quoting is honored within _w_o_r_d_l_i_s_t, + is expanded. Shell quoting is honored within _w_o_r_d_l_i_s_t, in order to provide a mechanism for the words to contain shell metacharacters or characters in the value of IIFFSS. The possible completions are the members of the resul- @@ -4917,19 +4947,19 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS ccoommppoopptt [--oo _o_p_t_i_o_n] [--DDEEII] [++oo _o_p_t_i_o_n] [_n_a_m_e] Modify completion options for each _n_a_m_e according to the _o_p_- _t_i_o_ns, or for the currently-executing completion if no _n_a_m_es are - supplied. If no _o_p_t_i_o_ns are given, display the completion op- - tions for each _n_a_m_e or the current completion. The possible val- - ues of _o_p_t_i_o_n are those valid for the ccoommpplleettee builtin described - above. The --DD option indicates that other supplied options - should apply to the ``default'' command completion; that is, - completion attempted on a command for which no completion has - previously been defined. The --EE option indicates that other sup- - plied options should apply to ``empty'' command completion; that - is, completion attempted on a blank line. The --II option indi- - cates that other supplied options should apply to completion on - the initial non-assignment word on the line, or after a command - delimiter such as ;; or ||, which is usually command name comple- - tion. + supplied. If no _o_p_t_i_o_ns are given, display the completion op- + tions for each _n_a_m_e or the current completion. The possible + values of _o_p_t_i_o_n are those valid for the ccoommpplleettee builtin de- + scribed above. The --DD option indicates that other supplied op- + tions should apply to the ``default'' command completion; that + is, completion attempted on a command for which no completion + has previously been defined. The --EE option indicates that other + supplied options should apply to ``empty'' command completion; + that is, completion attempted on a blank line. The --II option + indicates that other supplied options should apply to completion + on the initial non-assignment word on the line, or after a com- + mand delimiter such as ;; or ||, which is usually command name + completion. The return value is true unless an invalid option is supplied, an attempt is made to modify the options for a _n_a_m_e for which no @@ -4937,37 +4967,37 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS ccoonnttiinnuuee [_n] Resume the next iteration of the enclosing ffoorr, wwhhiillee, uunnttiill, or - sseelleecctt loop. If _n is specified, resume at the _nth enclosing - loop. _n must be >= 1. If _n is greater than the number of enclos- - ing loops, the last enclosing loop (the ``top-level'' loop) is - resumed. The return value is 0 unless _n is not greater than or - equal to 1. + sseelleecctt loop. If _n is specified, resume at the _nth enclosing + loop. _n must be >= 1. If _n is greater than the number of en- + closing loops, the last enclosing loop (the ``top-level'' loop) + is resumed. The return value is 0 unless _n is not greater than + or equal to 1. ddeeccllaarree [--aaAAffFFggiiIIllnnrrttuuxx] [--pp] [_n_a_m_e[=_v_a_l_u_e] ...] ttyyppeesseett [--aaAAffFFggiiIIllnnrrttuuxx] [--pp] [_n_a_m_e[=_v_a_l_u_e] ...] - Declare variables and/or give them attributes. If no _n_a_m_es are - given then display the values of variables. The --pp option will - display the attributes and values of each _n_a_m_e. When --pp is used + Declare variables and/or give them attributes. If no _n_a_m_es are + given then display the values of variables. The --pp option will + display the attributes and values of each _n_a_m_e. When --pp is used with _n_a_m_e arguments, additional options, other than --ff and --FF, - are ignored. When --pp is supplied without _n_a_m_e arguments, it will - display the attributes and values of all variables having the - attributes specified by the additional options. If no other op- - tions are supplied with --pp, ddeeccllaarree will display the attributes - and values of all shell variables. The --ff option will restrict - the display to shell functions. The --FF option inhibits the dis- - play of function definitions; only the function name and at- - tributes are printed. If the eexxttddeebbuugg shell option is enabled + are ignored. When --pp is supplied without _n_a_m_e arguments, it + will display the attributes and values of all variables having + the attributes specified by the additional options. If no other + options are supplied with --pp, ddeeccllaarree will display the at- + tributes and values of all shell variables. The --ff option will + restrict the display to shell functions. The --FF option inhibits + the display of function definitions; only the function name and + attributes are printed. If the eexxttddeebbuugg shell option is enabled using sshhoopptt, the source file name and line number where each - _n_a_m_e is defined are displayed as well. The --FF option implies --ff. - The --gg option forces variables to be created or modified at the - global scope, even when ddeeccllaarree is executed in a shell function. - It is ignored in all other cases. The --II option causes local - variables to inherit the attributes (except the _n_a_m_e_r_e_f attri- - bute) and value of any existing variable with the same _n_a_m_e at a - surrounding scope. If there is no existing variable, the local - variable is initially unset. The following options can be used - to restrict output to variables with the specified attribute or - to give variables attributes: + _n_a_m_e is defined are displayed as well. The --FF option implies + --ff. The --gg option forces variables to be created or modified at + the global scope, even when ddeeccllaarree is executed in a shell func- + tion. It is ignored in all other cases. The --II option causes + local variables to inherit the attributes (except the _n_a_m_e_r_e_f + attribute) and value of any existing variable with the same _n_a_m_e + at a surrounding scope. If there is no existing variable, the + local variable is initially unset. The following options can be + used to restrict output to variables with the specified attri- + bute or to give variables attributes: --aa Each _n_a_m_e is an indexed array variable (see AArrrraayyss above). --AA Each _n_a_m_e is an associative array variable (see AArrrraayyss @@ -4977,37 +5007,37 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS tion (see AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN above) is performed when the variable is assigned a value. --ll When the variable is assigned a value, all upper-case - characters are converted to lower-case. The upper-case + characters are converted to lower-case. The upper-case attribute is disabled. --nn Give each _n_a_m_e the _n_a_m_e_r_e_f attribute, making it a name - reference to another variable. That other variable is de- - fined by the value of _n_a_m_e. All references, assignments, - and attribute modifications to _n_a_m_e, except those using - or changing the --nn attribute itself, are performed on the - variable referenced by _n_a_m_e's value. The nameref attri- - bute cannot be applied to array variables. - --rr Make _n_a_m_es readonly. These names cannot then be assigned + reference to another variable. That other variable is + defined by the value of _n_a_m_e. All references, assign- + ments, and attribute modifications to _n_a_m_e, except those + using or changing the --nn attribute itself, are performed + on the variable referenced by _n_a_m_e's value. The nameref + attribute cannot be applied to array variables. + --rr Make _n_a_m_es readonly. These names cannot then be assigned values by subsequent assignment statements or unset. - --tt Give each _n_a_m_e the _t_r_a_c_e attribute. Traced functions in- + --tt Give each _n_a_m_e the _t_r_a_c_e attribute. Traced functions in- herit the DDEEBBUUGG and RREETTUURRNN traps from the calling shell. The trace attribute has no special meaning for variables. --uu When the variable is assigned a value, all lower-case - characters are converted to upper-case. The lower-case + characters are converted to upper-case. The lower-case attribute is disabled. --xx Mark _n_a_m_es for export to subsequent commands via the en- vironment. Using `+' instead of `-' turns off the attribute instead, with the exceptions that ++aa and ++AA may not be used to destroy array - variables and ++rr will not remove the readonly attribute. When + variables and ++rr will not remove the readonly attribute. When used in a function, ddeeccllaarree and ttyyppeesseett make each _n_a_m_e local, as with the llooccaall command, unless the --gg option is supplied. If a variable name is followed by =_v_a_l_u_e, the value of the variable - is set to _v_a_l_u_e. When using --aa or --AA and the compound assignment - syntax to create array variables, additional attributes do not - take effect until subsequent assignments. 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 + is set to _v_a_l_u_e. When using --aa or --AA and the compound assign- + ment syntax to create array variables, additional attributes do + not take effect until subsequent assignments. 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 as- sign a value to an array variable without using the compound as- signment syntax (see AArrrraayyss above), one of the _n_a_m_e_s is not a @@ -5018,10 +5048,10 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS ddiirrss [[--ccllppvv]] [[++_n]] [[--_n]] Without options, displays the list of currently remembered di- - rectories. The default display is on a single line with direc- - tory names separated by spaces. Directories are added to the + rectories. The default display is on a single line with direc- + tory names separated by spaces. Directories are added to the list with the ppuusshhdd command; the ppooppdd command removes entries - from the list. The current directory is always the first direc- + from the list. The current directory is always the first direc- tory in the stack. --cc Clears the directory stack by deleting all of the en- tries. @@ -5042,27 +5072,27 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS ddiissoowwnn [--aarr] [--hh] [_j_o_b_s_p_e_c ... | _p_i_d ... ] Without options, remove each _j_o_b_s_p_e_c from the table of active - jobs. If _j_o_b_s_p_e_c is not present, and neither the --aa nor the --rr - option is supplied, the _c_u_r_r_e_n_t _j_o_b is used. If the --hh option is - given, each _j_o_b_s_p_e_c is not removed from the table, but is marked - so that SSIIGGHHUUPP is not sent to the job if the shell receives a - SSIIGGHHUUPP. If no _j_o_b_s_p_e_c is supplied, the --aa option means to remove - or mark all jobs; the --rr option without a _j_o_b_s_p_e_c argument re- - stricts operation to running jobs. The return value is 0 unless - a _j_o_b_s_p_e_c does not specify a valid job. + jobs. If _j_o_b_s_p_e_c is not present, and neither the --aa nor the --rr + option is supplied, the _c_u_r_r_e_n_t _j_o_b is used. If the --hh option + is given, each _j_o_b_s_p_e_c is not removed from the table, but is + marked so that SSIIGGHHUUPP is not sent to the job if the shell re- + ceives a SSIIGGHHUUPP. If no _j_o_b_s_p_e_c is supplied, the --aa option means + to remove or mark all jobs; the --rr option without a _j_o_b_s_p_e_c ar- + gument restricts operation to running jobs. The return value is + 0 unless a _j_o_b_s_p_e_c does not specify a valid job. eecchhoo [--nneeEE] [_a_r_g ...] - Output the _a_r_gs, separated by spaces, followed by a newline. The - return status is 0 unless a write error occurs. If --nn is speci- - fied, the trailing newline is suppressed. If the --ee option is - given, interpretation of the following backslash-escaped charac- - ters is enabled. The --EE option disables the interpretation of - these escape characters, even on systems where they are inter- - preted by default. The xxppgg__eecchhoo shell option may be used to dy- - namically determine whether or not eecchhoo interprets any options - and expands these escape characters by default. eecchhoo does not - interpret ---- to mean the end of options. eecchhoo interprets the - following escape sequences: + Output the _a_r_gs, separated by spaces, followed by a newline. + The return status is 0 unless a write error occurs. If --nn is + specified, the trailing newline is suppressed. If the --ee option + is given, interpretation of the following backslash-escaped + characters is enabled. The --EE option disables the interpreta- + tion of these escape characters, even on systems where they are + interpreted by default. The xxppgg__eecchhoo shell option may be used + to dynamically determine whether or not eecchhoo interprets any op- + tions and expands these escape characters by default. eecchhoo does + not interpret ---- to mean the end of options. eecchhoo interprets + the following escape sequences: \\aa alert (bell) \\bb backspace \\cc suppress further output @@ -5085,68 +5115,68 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS hexadecimal value _H_H_H_H_H_H_H_H (one to eight hex digits) eennaabbllee [--aa] [--ddnnppss] [--ff _f_i_l_e_n_a_m_e] [_n_a_m_e ...] - Enable and disable builtin shell commands. Disabling a 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 without specifying a full pathname, even though the shell normally searches for builtins before disk commands. If --nn is used, each _n_a_m_e is disabled; otherwise, _n_a_m_e_s are en- - abled. For example, to use the tteesstt binary found via the PPAATTHH + abled. For example, to use the tteesstt binary found via the PPAATTHH instead of the shell builtin version, run ``enable -n test''. The --ff option means to load the new builtin command _n_a_m_e from shared object _f_i_l_e_n_a_m_e, on systems that support dynamic loading. BBaasshh will use the value of the BBAASSHH__LLOOAADDAABBLLEESS__PPAATTHH variable as a colon-separated list of directories in which to search for _f_i_l_e_- - _n_a_m_e. The default is system-dependent. The --dd option will delete - a builtin previously loaded with --ff. If no _n_a_m_e arguments are - given, or if the --pp option is supplied, a list of shell builtins - is printed. With no other option arguments, the list consists of - all enabled shell builtins. If --nn is supplied, only disabled - builtins are printed. If --aa is supplied, the list printed in- - cludes all builtins, with an indication of whether or not each - is enabled. If --ss is supplied, the output is restricted to the - POSIX _s_p_e_c_i_a_l builtins. If no options are supplied and a _n_a_m_e is - not a shell builtin, eennaabbllee will attempt to load _n_a_m_e from a - shared object named _n_a_m_e, as if the command were ``enable -f - _n_a_m_e _n_a_m_e . The return value is 0 unless a _n_a_m_e is not a shell - builtin or there is an error loading a new builtin from a shared - object. + _n_a_m_e. The default is system-dependent. The --dd option will + delete a builtin previously loaded with --ff. If no _n_a_m_e argu- + ments are given, or if the --pp option is supplied, a list of + shell builtins is printed. With no other option arguments, the + list consists of all enabled shell builtins. If --nn is supplied, + only disabled builtins are printed. If --aa is supplied, the list + printed includes all builtins, with an indication of whether or + not each is enabled. If --ss is supplied, the output is re- + stricted to the POSIX _s_p_e_c_i_a_l builtins. If no options are sup- + plied and a _n_a_m_e is not a shell builtin, eennaabbllee will attempt to + load _n_a_m_e from a shared object named _n_a_m_e, as if the command + were ``enable -f _n_a_m_e _n_a_m_e . The return value is 0 unless a + _n_a_m_e is not a shell builtin or there is an error loading a new + builtin from a shared object. eevvaall [_a_r_g ...] The _a_r_gs are read and concatenated together into a single com- - mand. This command is then read and executed by the shell, and - its exit status is returned as the value of eevvaall. If there are + mand. This command is then read and executed by the shell, and + its exit status is returned as the value of eevvaall. If there are no _a_r_g_s, or only null arguments, eevvaall returns 0. eexxeecc [--ccll] [--aa _n_a_m_e] [_c_o_m_m_a_n_d [_a_r_g_u_m_e_n_t_s]] - If _c_o_m_m_a_n_d is specified, it replaces the shell. No new process - is created. The _a_r_g_u_m_e_n_t_s become the arguments to _c_o_m_m_a_n_d. If + If _c_o_m_m_a_n_d is specified, it replaces the shell. No new process + is created. The _a_r_g_u_m_e_n_t_s become the arguments to _c_o_m_m_a_n_d. If the --ll option is supplied, the shell places a dash at the begin- - ning of the zeroth argument passed to _c_o_m_m_a_n_d. This is what _l_o_- - _g_i_n(1) does. The --cc option causes _c_o_m_m_a_n_d to be executed with an - empty environment. If --aa is supplied, the shell passes _n_a_m_e as - the zeroth argument to the executed command. If _c_o_m_m_a_n_d cannot - be executed for some reason, a non-interactive shell exits, un- - less the eexxeeccffaaiill shell option is enabled. In that case, it re- - turns failure. An interactive shell returns failure if the file - cannot be executed. A subshell exits unconditionally if eexxeecc - fails. If _c_o_m_m_a_n_d is not specified, any redirections take effect - in the current shell, and the return status is 0. If there is a - redirection error, the return status is 1. + ning of the zeroth argument passed to _c_o_m_m_a_n_d. This is what _l_o_- + _g_i_n(1) does. The --cc option causes _c_o_m_m_a_n_d to be executed with + an empty environment. If --aa is supplied, the shell passes _n_a_m_e + as the zeroth argument to the executed command. If _c_o_m_m_a_n_d can- + not be executed for some reason, a non-interactive shell exits, + unless the eexxeeccffaaiill shell option is enabled. In that case, it + returns failure. An interactive shell returns failure if the + file cannot be executed. A subshell exits unconditionally if + eexxeecc fails. If _c_o_m_m_a_n_d is not specified, any redirections take + effect in the current shell, and the return status is 0. If + there is a redirection error, the return status is 1. eexxiitt [_n] - Cause the shell to exit with a status of _n. If _n is omitted, the - exit status is that of the last command executed. A trap on EEXXIITT - is executed before the shell terminates. + Cause the shell to exit with a status of _n. If _n is omitted, + the exit status is that of the last command executed. A trap on + EEXXIITT is executed before the shell terminates. eexxppoorrtt [--ffnn] [_n_a_m_e[=_w_o_r_d]] ... eexxppoorrtt --pp The supplied _n_a_m_e_s are marked for automatic export to the envi- - ronment of subsequently executed commands. If the --ff option is - given, the _n_a_m_e_s refer to functions. If no _n_a_m_e_s are given, or + ronment of subsequently executed commands. If the --ff option is + given, the _n_a_m_e_s refer to functions. If no _n_a_m_e_s are given, or if the --pp option is supplied, a list of names of all exported - variables is printed. The --nn option causes the export property - to be removed from each _n_a_m_e. If a variable name is followed by - =_w_o_r_d, the value of the variable is set to _w_o_r_d. eexxppoorrtt returns + variables is printed. The --nn option causes the export property + to be removed from each _n_a_m_e. If a variable name is followed by + =_w_o_r_d, the value of the variable is set to _w_o_r_d. eexxppoorrtt returns an exit status of 0 unless an invalid option is encountered, one of the _n_a_m_e_s is not a valid shell variable name, or --ff is sup- plied with a _n_a_m_e that is not a function. @@ -5157,38 +5187,38 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS ffcc --ss [_p_a_t=_r_e_p] [_c_m_d] The first form selects a range of commands from _f_i_r_s_t to _l_a_s_t from the history list and displays or edits and re-executes - them. _F_i_r_s_t and _l_a_s_t may be specified as a string (to locate the - last command beginning with that string) or as a number (an in- - dex into the history list, where a negative number is used as an - offset from the current command number). When listing, a _f_i_r_s_t - or _l_a_s_t of 0 is equivalent to -1 and -0 is equivalent to the - current command (usually the ffcc command); otherwise 0 is equiva- - lent to -1 and -0 is invalid. If _l_a_s_t is not specified, it is - set to the current command for listing (so that ``fc -l -10'' - prints the last 10 commands) and to _f_i_r_s_t otherwise. If _f_i_r_s_t is - not specified, it is set to the previous command for editing and - -16 for listing. + them. _F_i_r_s_t and _l_a_s_t may be specified as a string (to locate + the last 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). When listing, a + _f_i_r_s_t or _l_a_s_t of 0 is equivalent to -1 and -0 is equivalent to + the current command (usually the ffcc command); otherwise 0 is + equivalent to -1 and -0 is invalid. If _l_a_s_t is not specified, + it is set to the current command for listing (so that ``fc -l + -10'' prints the last 10 commands) and to _f_i_r_s_t otherwise. If + _f_i_r_s_t is not specified, it is set to the previous command for + editing and -16 for listing. - The --nn option suppresses the command numbers when listing. The - --rr option reverses the order of the commands. If the --ll option - is given, the commands are listed on standard output. Otherwise, - the editor given by _e_n_a_m_e is invoked on a file containing those - commands. If _e_n_a_m_e is not given, the value of the FFCCEEDDIITT vari- - able is used, and the value of EEDDIITTOORR if FFCCEEDDIITT is not set. If - neither variable is set, _v_i is used. When editing is complete, - the edited commands are echoed and executed. + The --nn option suppresses the command numbers when listing. The + --rr option reverses the order of the commands. If the --ll option + is given, the commands are listed on standard output. Other- + wise, the editor given by _e_n_a_m_e is invoked on a file containing + those commands. If _e_n_a_m_e is not given, the value of the FFCCEEDDIITT + variable is used, and the value of EEDDIITTOORR if FFCCEEDDIITT is not set. + If neither variable is set, _v_i is used. When editing is com- + plete, the edited commands are echoed and executed. In the second form, _c_o_m_m_a_n_d is re-executed after each instance - of _p_a_t is replaced by _r_e_p. _C_o_m_m_a_n_d is interpreted the same as - _f_i_r_s_t above. A useful alias to use with this is ``r="fc -s"'', + of _p_a_t is replaced by _r_e_p. _C_o_m_m_a_n_d is interpreted the same as + _f_i_r_s_t above. A useful alias to use with this is ``r="fc -s"'', so that typing ``r cc'' runs the last command beginning with ``cc'' and typing ``r'' re-executes the last command. If the first form is used, the return value is 0 unless an in- valid option is encountered or _f_i_r_s_t or _l_a_s_t specify history - lines out of range. If the --ee option is supplied, the return + lines out of range. If the --ee option is supplied, the return value is the value of the last command executed or failure if an - error occurs with the temporary file of commands. If the second + error occurs with the temporary file of commands. If the second form is used, the return status is that of the command re-exe- cuted, unless _c_m_d does not specify a valid history line, in which case ffcc returns failure. @@ -5196,82 +5226,82 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS ffgg [_j_o_b_s_p_e_c] Resume _j_o_b_s_p_e_c in the foreground, and make it the current job. If _j_o_b_s_p_e_c is not present, the shell's notion of the _c_u_r_r_e_n_t _j_o_b - is used. The return value is that of the command placed into the - foreground, or failure if run when job control is disabled or, - when run with job control enabled, if _j_o_b_s_p_e_c does not specify a - valid job or _j_o_b_s_p_e_c specifies a job that was started without - job control. + is used. The return value is that of the command placed into + the foreground, or failure if run when job control is disabled + or, when run with job control enabled, if _j_o_b_s_p_e_c does not spec- + ify a valid job or _j_o_b_s_p_e_c specifies a job that was started + without job control. ggeettooppttss _o_p_t_s_t_r_i_n_g _n_a_m_e [_a_r_g _._._.] ggeettooppttss is used by shell procedures to parse positional parame- - ters. _o_p_t_s_t_r_i_n_g contains the option characters to be recognized; - if a character is followed by a colon, the option is expected to - have an argument, which should be separated from it by white - space. The colon and question mark characters may not be used as - option characters. Each time it is invoked, ggeettooppttss places the - next option in the shell variable _n_a_m_e, initializing _n_a_m_e if it - does not exist, and the index of the next argument to be pro- - cessed into the variable OOPPTTIINNDD. OOPPTTIINNDD is initialized to 1 each - time the shell or a shell script is invoked. When an option re- - quires an argument, ggeettooppttss places that argument into the vari- - able OOPPTTAARRGG. The shell does not reset OOPPTTIINNDD automatically; it - must be manually reset between multiple calls to ggeettooppttss within - the same shell invocation if a new set of parameters is to be - used. + ters. _o_p_t_s_t_r_i_n_g contains the option characters to be recog- + nized; if a character is followed by a colon, the option is ex- + pected to have an argument, which should be separated from it by + white space. The colon and question mark characters may not be + used as option characters. Each time it is invoked, ggeettooppttss + places the next option in the shell variable _n_a_m_e, initializing + _n_a_m_e if it does not exist, and the index of the next argument to + be processed into the variable OOPPTTIINNDD. OOPPTTIINNDD is initialized to + 1 each time the shell or a shell script is invoked. When an op- + tion requires an argument, ggeettooppttss places that argument into the + variable OOPPTTAARRGG. The shell does not reset OOPPTTIINNDD automatically; + it must be manually reset between multiple calls to ggeettooppttss + within the same shell invocation if a new set of parameters is + to be used. When the end of options is encountered, ggeettooppttss exits with a re- - turn value greater than zero. OOPPTTIINNDD is set to the index of the + turn value greater than zero. OOPPTTIINNDD is set to the index of the first non-option argument, and _n_a_m_e is set to ?. ggeettooppttss normally parses the positional parameters, but if more arguments are supplied as _a_r_g values, ggeettooppttss parses those in- stead. - ggeettooppttss can report errors in two ways. If the first character of - _o_p_t_s_t_r_i_n_g is a colon, _s_i_l_e_n_t error reporting is used. In normal - operation, diagnostic messages are printed when invalid options - or missing option arguments are encountered. If the variable - OOPPTTEERRRR is set to 0, no error messages will be displayed, even if - the first character of _o_p_t_s_t_r_i_n_g is not a colon. + ggeettooppttss can report errors in two ways. If the first character + of _o_p_t_s_t_r_i_n_g is a colon, _s_i_l_e_n_t error reporting is used. In + normal operation, diagnostic messages are printed when invalid + options or missing option arguments are encountered. If the + variable OOPPTTEERRRR is set to 0, no error messages will be dis- + played, even if the first character of _o_p_t_s_t_r_i_n_g is not a colon. If an invalid option is seen, ggeettooppttss places ? into _n_a_m_e and, if - not silent, prints an error message and unsets OOPPTTAARRGG. If + not silent, prints an error message and unsets OOPPTTAARRGG. If ggeettooppttss is silent, the option character found is placed in OOPP-- TTAARRGG and no diagnostic message is printed. If a required argument is not found, and ggeettooppttss is not silent, a question mark (??) is placed in _n_a_m_e, OOPPTTAARRGG is unset, and a - diagnostic message is printed. If ggeettooppttss is silent, then a + diagnostic message is printed. If ggeettooppttss is silent, then a colon (::) is placed in _n_a_m_e and OOPPTTAARRGG is set to the option character found. ggeettooppttss returns true if an option, specified or unspecified, is - found. It returns false if the end of options is encountered or + found. It returns false if the end of options is encountered or an error occurs. hhaasshh [--llrr] [--pp _f_i_l_e_n_a_m_e] [--ddtt] [_n_a_m_e] Each time hhaasshh is invoked, the full pathname of the command _n_a_m_e is determined by searching the directories in $$PPAATTHH and remem- - bered. Any previously-remembered pathname is discarded. If the + bered. Any previously-remembered pathname is discarded. If the --pp option is supplied, hhaasshh uses _f_i_l_e_n_a_m_e as the full filename - of the command. The --rr option causes the shell to forget all re- - membered locations. Assigning to the PPAATTHH variable also clears - all hashed filenames. The --dd option causes the shell to forget - the remembered location of each _n_a_m_e. If the --tt option is sup- - plied, the full pathname to which each _n_a_m_e corresponds is - printed. If multiple _n_a_m_e arguments are supplied with --tt, the - _n_a_m_e is printed before the hashed full pathname. The --ll option + of the command. The --rr option causes the shell to forget all + remembered locations. Assigning to the PPAATTHH variable also + clears all hashed filenames. The --dd option causes the shell to + forget the remembered location of each _n_a_m_e. If the --tt option + is supplied, the full pathname to which each _n_a_m_e corresponds is + printed. If multiple _n_a_m_e arguments are supplied with --tt, the + _n_a_m_e is printed before the hashed full pathname. The --ll option causes output to be displayed in a format that may be reused as - input. If no arguments are given, or if only --ll is supplied, in- - formation about remembered commands is printed. The --tt, --dd, and - --pp options (the options that act on the _n_a_m_e arguments) are mu- - tually exclusive. Only one will be active. If more than one is - supplied, --tt has higher priority than --pp, and both are higher - priority than --dd. The return status is true unless a _n_a_m_e is not - found or an invalid option is supplied. + input. If no arguments are given, or if only --ll is supplied, + information about remembered commands is printed. The --tt, --dd, + and --pp options (the options that act on the _n_a_m_e arguments) are + mutually exclusive. Only one will be active. If more than one + is supplied, --tt has higher priority than --pp, and both are higher + priority than --dd. The return status is true unless a _n_a_m_e is + not found or an invalid option is supplied. hheellpp [--ddmmss] [_p_a_t_t_e_r_n] - Display helpful information about builtin commands. If _p_a_t_t_e_r_n + Display helpful information about builtin commands. If _p_a_t_t_e_r_n is specified, hheellpp gives detailed help on all commands matching _p_a_t_t_e_r_n; otherwise help for all the builtins and shell control structures is printed. @@ -5290,33 +5320,33 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS hhiissttoorryy --pp _a_r_g [_a_r_g _._._.] hhiissttoorryy --ss _a_r_g [_a_r_g _._._.] With no options, display the command history list with line num- - bers. Lines listed with a ** have been modified. An argument of _n - lists only the last _n lines. If the shell variable HHIISSTTTTIIMMEEFFOORR-- - MMAATT is set and not null, it is used as a format string for _s_t_r_f_- - _t_i_m_e(3) to display the time stamp associated with each displayed - history entry. No intervening blank is printed between the for- - matted time stamp and the history line. If _f_i_l_e_n_a_m_e is supplied, - it is used as the name of the history file; if not, the value of - HHIISSTTFFIILLEE is used. If _f_i_l_e_n_a_m_e is not supplied and HHIISSTTFFIILLEE is - unset or null, the --aa,, --nn,, --rr,, and --ww options have no effect. - Options, if supplied, have the following meanings: + bers. Lines listed with a ** have been modified. An argument of + _n lists only the last _n lines. If the shell variable HHIISSTTTTIIMMEE-- + FFOORRMMAATT is set and not null, it is used as a format string for + _s_t_r_f_t_i_m_e(3) to display the time stamp associated with each dis- + played history entry. No intervening blank is printed between + the formatted time stamp and the history line. If _f_i_l_e_n_a_m_e is + supplied, it is used as the name of the history file; if not, + the value of HHIISSTTFFIILLEE is used. If _f_i_l_e_n_a_m_e is not supplied and + HHIISSTTFFIILLEE is unset or null, the --aa,, --nn,, --rr,, and --ww options have + no effect. Options, if supplied, have the following meanings: --cc Clear the history list by deleting all the entries. --dd _o_f_f_s_e_t - Delete the history entry at position _o_f_f_s_e_t. If _o_f_f_s_e_t is - negative, it is interpreted as relative to one greater + Delete the history entry at position _o_f_f_s_e_t. If _o_f_f_s_e_t + is negative, it is interpreted as relative to one greater than the last history position, so negative indices count back from the end of the history, and an index of -1 refers to the current hhiissttoorryy --dd command. --dd _s_t_a_r_t-_e_n_d Delete the range of history entries between positions - _s_t_a_r_t and _e_n_d, inclusive. Positive and negative values + _s_t_a_r_t and _e_n_d, inclusive. Positive and negative values for _s_t_a_r_t and _e_n_d are interpreted as described above. --aa Append the ``new'' history lines to the history file. These are history lines entered since the beginning of the current bbaasshh session, but not already appended to the history file. --nn Read the history lines not already read from the history - file into the current history list. These are lines ap- + file into the current history list. These are lines ap- pended to the history file since the beginning of the current bbaasshh session. --rr Read the contents of the history file and append them to @@ -5324,19 +5354,19 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --ww Write the current history list to the history file, over- writing the history file's contents. --pp Perform history substitution on the following _a_r_g_s and - display the result on the standard output. Does not store - the results in the history list. Each _a_r_g must be quoted - to disable normal history expansion. - --ss Store the _a_r_g_s in the history list as a single entry. The - last command in the history list is removed before the - _a_r_g_s are added. + display the result on the standard output. Does not + store the results in the history list. Each _a_r_g must be + quoted to disable normal history expansion. + --ss Store the _a_r_g_s in the history list as a single entry. + The last command in the history list is removed before + the _a_r_g_s are added. If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, the time stamp informa- tion associated with each history entry is written to the his- tory file, marked with the history comment character. When the history file is read, lines beginning with the history comment character followed immediately by a digit are interpreted as - timestamps for the following history entry. The return value is + timestamps for the following history entry. The return value is 0 unless an invalid option is encountered, an error occurs while reading or writing the history file, an invalid _o_f_f_s_e_t or range is supplied as an argument to --dd, or the history expansion sup- @@ -5344,7 +5374,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS jjoobbss [--llnnpprrss] [ _j_o_b_s_p_e_c ... ] jjoobbss --xx _c_o_m_m_a_n_d [ _a_r_g_s ... ] - The first form lists the active jobs. The options have the fol- + The first form lists the active jobs. The options have the fol- lowing meanings: --ll List process IDs in addition to the normal information. --nn Display information only about jobs that have changed @@ -5355,8 +5385,8 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --ss Display only stopped jobs. If _j_o_b_s_p_e_c is given, output is restricted to information about - that job. The return status is 0 unless an invalid option is en- - countered or an invalid _j_o_b_s_p_e_c is supplied. + that job. The return status is 0 unless an invalid option is + encountered or an invalid _j_o_b_s_p_e_c is supplied. If the --xx option is supplied, jjoobbss replaces any _j_o_b_s_p_e_c found in _c_o_m_m_a_n_d or _a_r_g_s with the corresponding process group ID, and ex- @@ -5365,38 +5395,38 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS kkiillll [--ss _s_i_g_s_p_e_c | --nn _s_i_g_n_u_m | --_s_i_g_s_p_e_c] [_p_i_d | _j_o_b_s_p_e_c] ... kkiillll --ll|--LL [_s_i_g_s_p_e_c | _e_x_i_t___s_t_a_t_u_s] Send the signal named by _s_i_g_s_p_e_c or _s_i_g_n_u_m to the processes - named by _p_i_d or _j_o_b_s_p_e_c. _s_i_g_s_p_e_c is either a case-insensitive + named by _p_i_d or _j_o_b_s_p_e_c. _s_i_g_s_p_e_c is either a case-insensitive signal name such as SSIIGGKKIILLLL (with or without the SSIIGG prefix) or - a signal number; _s_i_g_n_u_m is a signal number. If _s_i_g_s_p_e_c is not - present, then SSIIGGTTEERRMM is assumed. An argument of --ll lists the - signal names. If any arguments are supplied when --ll is given, + a signal number; _s_i_g_n_u_m is a signal number. If _s_i_g_s_p_e_c is not + present, then SSIIGGTTEERRMM is assumed. An argument of --ll lists the + signal names. If any arguments are supplied when --ll is given, the names of the signals corresponding to the arguments are - listed, and the return status is 0. The _e_x_i_t___s_t_a_t_u_s argument to + listed, and the return status is 0. The _e_x_i_t___s_t_a_t_u_s argument to --ll is a number specifying either a signal number or the exit - status of a process terminated by a signal. The --LL option is - equivalent to --ll. kkiillll returns true if at least one signal was + status of a process terminated by a signal. The --LL option is + equivalent to --ll. kkiillll returns true if at least one signal was successfully sent, or false if an error occurs or an invalid op- tion is encountered. lleett _a_r_g [_a_r_g ...] Each _a_r_g is an arithmetic expression to be evaluated (see AARRIITTHH-- - MMEETTIICC EEVVAALLUUAATTIIOONN above). If the last _a_r_g evaluates to 0, lleett re- - turns 1; 0 is returned otherwise. + MMEETTIICC EEVVAALLUUAATTIIOONN above). If the last _a_r_g evaluates to 0, lleett + returns 1; 0 is returned otherwise. llooccaall [_o_p_t_i_o_n] [_n_a_m_e[=_v_a_l_u_e] ... | - ] For each argument, a local variable named _n_a_m_e is created, and - assigned _v_a_l_u_e. The _o_p_t_i_o_n can be any of the options accepted by - ddeeccllaarree. When llooccaall is used within a function, it causes the + assigned _v_a_l_u_e. The _o_p_t_i_o_n can be any of the options accepted + by ddeeccllaarree. When llooccaall is used within a function, it causes the variable _n_a_m_e to have a visible scope restricted to that func- - tion and its children. If _n_a_m_e is -, the set of shell options is - made local to the function in which llooccaall is invoked: shell op- - tions changed using the sseett builtin inside the function after + tion and its children. If _n_a_m_e is -, the set of shell options + is made local to the function in which llooccaall is invoked: shell + options changed using the sseett builtin inside the function after the call to llooccaall are restored to their original values when the - function returns. The restore is effected as if a series of sseett + function returns. The restore is effected as if a series of sseett commands were executed to restore the values that were in place - before the function. With no operands, llooccaall writes a list of - local variables to the standard output. It is an error to use - llooccaall when not within a function. The return status is 0 unless + before the function. With no operands, llooccaall writes a list of + local variables to the standard output. It is an error to use + llooccaall when not within a function. The return status is 0 unless llooccaall is used outside a function, an invalid _n_a_m_e is supplied, or _n_a_m_e is a readonly variable. @@ -5408,31 +5438,31 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS _c_a_l_l_b_a_c_k] [--cc _q_u_a_n_t_u_m] [_a_r_r_a_y] Read lines from the standard input into the indexed array vari- able _a_r_r_a_y, or from file descriptor _f_d if the --uu option is sup- - plied. The variable MMAAPPFFIILLEE is the default _a_r_r_a_y. Options, if + plied. The variable MMAAPPFFIILLEE is the default _a_r_r_a_y. Options, if supplied, have the following meanings: --dd The first character of _d_e_l_i_m is used to terminate each - input line, rather than newline. If _d_e_l_i_m is the empty + input line, rather than newline. If _d_e_l_i_m is the empty string, mmaappffiillee will terminate a line when it reads a NUL character. - --nn Copy at most _c_o_u_n_t lines. If _c_o_u_n_t is 0, all lines are + --nn Copy at most _c_o_u_n_t lines. If _c_o_u_n_t is 0, all lines are copied. - --OO Begin assigning to _a_r_r_a_y at index _o_r_i_g_i_n. The default in- - dex is 0. + --OO Begin assigning to _a_r_r_a_y at index _o_r_i_g_i_n. The default + index is 0. --ss Discard the first _c_o_u_n_t lines read. --tt Remove a trailing _d_e_l_i_m (default newline) from each line read. --uu Read lines from file descriptor _f_d instead of the stan- dard input. - --CC Evaluate _c_a_l_l_b_a_c_k each time _q_u_a_n_t_u_m lines are read. The + --CC Evaluate _c_a_l_l_b_a_c_k each time _q_u_a_n_t_u_m lines are read. The --cc option specifies _q_u_a_n_t_u_m. --cc Specify the number of lines read between each call to _c_a_l_l_b_a_c_k. - If --CC is specified without --cc, the default quantum is 5000. When - _c_a_l_l_b_a_c_k is evaluated, it is supplied the index of the next ar- - ray element to be assigned and the line to be assigned to that - element as additional arguments. _c_a_l_l_b_a_c_k is evaluated after the - line is read but before the array element is assigned. + If --CC is specified without --cc, the default quantum is 5000. + When _c_a_l_l_b_a_c_k is evaluated, it is supplied the index of the next + array element to be assigned and the line to be assigned to that + element as additional arguments. _c_a_l_l_b_a_c_k is evaluated after + the line is read but before the array element is assigned. If not supplied with an explicit origin, mmaappffiillee will clear _a_r_- _r_a_y before assigning to it. @@ -5442,26 +5472,26 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS _a_r_r_a_y is not an indexed array. ppooppdd [-nn] [+_n] [-_n] - Removes entries from the directory stack. The elements are num- + Removes entries from the directory stack. The elements are num- bered from 0 starting at the first directory listed by ddiirrss. With no arguments, ppooppdd removes the top directory from the - stack, and changes to the new top directory. Arguments, if sup- + stack, and changes to the new top directory. Arguments, if sup- plied, have the following meanings: --nn Suppresses the normal change of directory when removing directories from the stack, so that only the stack is ma- nipulated. ++_n Removes the _nth entry counting from the left of the list - shown by ddiirrss, starting with zero, from the stack. For + shown by ddiirrss, starting with zero, from the stack. For example: ``popd +0'' removes the first directory, ``popd +1'' the second. --_n Removes the _nth entry counting from the right of the list - shown by ddiirrss, starting with zero. For example: ``popd + shown by ddiirrss, starting with zero. For example: ``popd -0'' removes the last directory, ``popd -1'' the next to last. If the top element of the directory stack is modified, and the _-_n option was not supplied, ppooppdd uses the ccdd builtin to change - to the directory at the top of the stack. If the ccdd fails, ppooppdd + to the directory at the top of the stack. If the ccdd fails, ppooppdd returns a non-zero value. Otherwise, ppooppdd returns false if an invalid option is encoun- @@ -5474,24 +5504,24 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS pprriinnttff [--vv _v_a_r] _f_o_r_m_a_t [_a_r_g_u_m_e_n_t_s] Write the formatted _a_r_g_u_m_e_n_t_s to the standard output under the - control of the _f_o_r_m_a_t. The --vv option causes the output to be as- - signed to the variable _v_a_r rather than being printed to the + control of the _f_o_r_m_a_t. The --vv option causes the output to be + assigned to the variable _v_a_r rather than being printed to the standard output. The _f_o_r_m_a_t 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 _a_r_g_u_m_e_n_t. In ad- - dition to the standard _p_r_i_n_t_f(3) format characters ccssnnddiioouuxxXXeeEEff-- - FFggGGaaAA, pprriinnttff interprets the following additional format speci- - fiers: + of which causes printing of the next successive _a_r_g_u_m_e_n_t. In + addition to the standard _p_r_i_n_t_f(3) format characters ccssnnddiioouuxxXXee-- + EEffFFggGGaaAA, pprriinnttff interprets the following additional format spec- + ifiers: %%bb causes pprriinnttff to expand backslash escape sequences in the corresponding _a_r_g_u_m_e_n_t in the same way as eecchhoo --ee. %%qq causes pprriinnttff to output the corresponding _a_r_g_u_m_e_n_t in a - format that can be reused as shell input. %%qq and %%QQ use + format that can be reused as shell input. %%qq and %%QQ use the $$'''' quoting style if any characters in the argument - string require it, and backslash quoting otherwise. If + string require it, and backslash quoting otherwise. If the format string uses the _p_r_i_n_t_f alternate form, these two formats quote the argument string using single quotes. @@ -5501,217 +5531,219 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS causes pprriinnttff to output the date-time string resulting from using _d_a_t_e_f_m_t as a format string for _s_t_r_f_t_i_m_e(3). The corresponding _a_r_g_u_m_e_n_t is an integer representing the - number of seconds since the epoch. Two special argument + number of seconds since the epoch. Two special argument values may be used: -1 represents the current time, and - -2 represents the time the shell was invoked. If no argu- - ment is specified, conversion behaves as if -1 had been - given. This is an exception to the usual pprriinnttff behavior. + -2 represents the time the shell was invoked. If no ar- + gument is specified, conversion behaves as if -1 had been + given. This is an exception to the usual pprriinnttff behav- + ior. The %b, %q, and %T format specifiers all use the field width and precision arguments from the format specification and write that - many bytes from (or use that wide a field for) the expanded ar- - gument, which usually contains more characters than the origi- + many bytes from (or use that wide a field for) the expanded ar- + gument, which usually contains more characters than the origi- nal. The %n format specifier accepts a corresponding argument that is treated as a shell variable name. - The %s and %c format specifiers accept an l (long) modifier, + The %s and %c format specifiers accept an l (long) modifier, which forces them to convert the argument string to a wide-char- acter string and apply any supplied field width and precision in terms of characters, not bytes. - Arguments to non-string format specifiers are treated as C con- + Arguments to non-string format specifiers are treated as C con- stants, except that a leading plus or minus sign is allowed, and - if the leading character is a single or double quote, the value + if the leading character is a single or double quote, the value is the ASCII value of the following character. - The _f_o_r_m_a_t is reused as necessary to consume all of the _a_r_g_u_- + The _f_o_r_m_a_t is reused as necessary to consume all of the _a_r_g_u_- _m_e_n_t_s. If the _f_o_r_m_a_t requires more _a_r_g_u_m_e_n_t_s than are supplied, - the extra format specifications behave as if a zero value or - null string, as appropriate, had been supplied. The return value - is zero on success, non-zero if an invalid option is supplied or - a write or assignment error occurs. + the extra format specifications behave as if a zero value or + null string, as appropriate, had been supplied. The return + value is zero on success, non-zero if an invalid option is sup- + plied or a write or assignment error occurs. ppuusshhdd [--nn] [+_n] [-_n] ppuusshhdd [--nn] [_d_i_r] - Adds a directory to the top of the directory stack, or rotates - the stack, making the new top of the stack the current working - directory. With no arguments, ppuusshhdd exchanges the top two ele- - ments of the directory stack. Arguments, if supplied, have the + Adds a directory to the top of the directory stack, or rotates + the stack, making the new top of the stack the current working + directory. With no arguments, ppuusshhdd exchanges the top two ele- + ments of the directory stack. Arguments, if supplied, have the following meanings: - --nn Suppresses the normal change of directory when rotating - or adding directories to the stack, so that only the + --nn Suppresses the normal change of directory when rotating + or adding directories to the stack, so that only the stack is manipulated. - ++_n Rotates the stack so that the _nth directory (counting - from the left of the list shown by ddiirrss, starting with + ++_n Rotates the stack so that the _nth directory (counting + from the left of the list shown by ddiirrss, starting with zero) is at the top. - --_n Rotates the stack so that the _nth directory (counting - from the right of the list shown by ddiirrss, starting with + --_n Rotates the stack so that the _nth directory (counting + from the right of the list shown by ddiirrss, starting with zero) is at the top. _d_i_r Adds _d_i_r to the directory stack at the top After the stack has been modified, if the --nn option was not sup- - plied, ppuusshhdd uses the ccdd builtin to change to the directory at - the top of the stack. If the ccdd fails, ppuusshhdd returns a non-zero + plied, ppuusshhdd uses the ccdd builtin to change to the directory at + the top of the stack. If the ccdd fails, ppuusshhdd returns a non-zero value. - Otherwise, if no arguments are supplied, ppuusshhdd returns 0 unless - the directory stack is empty. When rotating the directory stack, - ppuusshhdd returns 0 unless the directory stack is empty or a non-ex- - istent directory stack element is specified. + Otherwise, if no arguments are supplied, ppuusshhdd returns 0 unless + the directory stack is empty. When rotating the directory + stack, ppuusshhdd returns 0 unless the directory stack is empty or a + non-existent directory stack element is specified. - If the ppuusshhdd command is successful, bash runs ddiirrss to show the + If the ppuusshhdd command is successful, bash runs ddiirrss to show the final contents of the directory stack. ppwwdd [--LLPP] - Print the absolute pathname of the current working directory. + Print the absolute pathname of the current working directory. The pathname printed contains no symbolic links if the --PP option is supplied or the --oo pphhyyssiiccaall option to the sseett builtin command - is enabled. If the --LL option is used, the pathname printed may - contain symbolic links. The return status is 0 unless an error + is enabled. If the --LL option is used, the pathname printed may + contain symbolic links. The return status is 0 unless an error occurs while reading the name of the current directory or an in- valid option is supplied. - rreeaadd [--EEeerrss] [--aa _a_n_a_m_e] [--dd _d_e_l_i_m] [--ii _t_e_x_t] [--nn _n_c_h_a_r_s] [--NN _n_c_h_a_r_s] + rreeaadd [--EEeerrss] [--aa _a_n_a_m_e] [--dd _d_e_l_i_m] [--ii _t_e_x_t] [--nn _n_c_h_a_r_s] [--NN _n_c_h_a_r_s] [--pp _p_r_o_m_p_t] [--tt _t_i_m_e_o_u_t] [--uu _f_d] [_n_a_m_e ...] - One line is read from the standard input, or from the file de- + One line is read from the standard input, or from the file de- scriptor _f_d supplied as an argument to the --uu option, split into - words as described above under WWoorrdd SSpplliittttiinngg, and the first - word is assigned to the first _n_a_m_e, the second word to the sec- - ond _n_a_m_e, and so on. If there are more words than names, the re- - maining words and their intervening delimiters are assigned to - the last _n_a_m_e. If there are fewer words read from the input - stream than names, the remaining names are assigned empty val- - ues. The characters in IIFFSS are used to split the line into words - using the same rules the shell uses for expansion (described - above under WWoorrdd SSpplliittttiinngg). The backslash character (\\) may be - used to remove any special meaning for the next character read - and for line continuation. Options, if supplied, have the fol- - lowing meanings: + words as described above under WWoorrdd SSpplliittttiinngg, and the first + word is assigned to the first _n_a_m_e, the second word to the sec- + ond _n_a_m_e, and so on. If there are more words than names, the + remaining words and their intervening delimiters are assigned to + the last _n_a_m_e. If there are fewer words read from the input + stream than names, the remaining names are assigned empty val- + ues. The characters in IIFFSS are used to split the line into + words using the same rules the shell uses for expansion (de- + scribed above under WWoorrdd SSpplliittttiinngg). The backslash character + (\\) may be used to remove any special meaning for the next char- + acter read and for line continuation. Options, if supplied, + have the following meanings: --aa _a_n_a_m_e The words are assigned to sequential indices of the array - variable _a_n_a_m_e, starting at 0. _a_n_a_m_e is unset before any - new values are assigned. Other _n_a_m_e arguments are ig- + variable _a_n_a_m_e, starting at 0. _a_n_a_m_e is unset before any + new values are assigned. Other _n_a_m_e arguments are ig- nored. --dd _d_e_l_i_m The first character of _d_e_l_i_m is used to terminate the in- - put line, rather than newline. If _d_e_l_i_m is the empty - string, rreeaadd will terminate a line when it reads a NUL + put line, rather than newline. If _d_e_l_i_m is the empty + string, rreeaadd will terminate a line when it reads a NUL character. - --ee If the standard input is coming from a terminal, rreeaadd - uses rreeaaddlliinnee (see RREEAADDLLIINNEE above) to obtain the line. - Readline uses the current (or default, if line editing - was not previously active) editing settings, but uses + --ee If the standard input is coming from a terminal, rreeaadd + uses rreeaaddlliinnee (see RREEAADDLLIINNEE above) to obtain the line. + Readline uses the current (or default, if line editing + was not previously active) editing settings, but uses readline's default filename completion. - --EE If the standard input is coming from a terminal, rreeaadd - uses rreeaaddlliinnee (see RREEAADDLLIINNEE above) to obtain the line. - Readline uses the current (or default, if line editing - was not previously active) editing settings, but uses + --EE If the standard input is coming from a terminal, rreeaadd + uses rreeaaddlliinnee (see RREEAADDLLIINNEE above) to obtain the line. + Readline uses the current (or default, if line editing + was not previously active) editing settings, but uses bash's default completion, including programmable comple- tion. --ii _t_e_x_t - If rreeaaddlliinnee is being used to read the line, _t_e_x_t is + If rreeaaddlliinnee is being used to read the line, _t_e_x_t is placed into the editing buffer before editing begins. --nn _n_c_h_a_r_s - rreeaadd returns after reading _n_c_h_a_r_s characters rather than + rreeaadd returns after reading _n_c_h_a_r_s characters rather than waiting for a complete line of input, but honors a delim- - iter if fewer than _n_c_h_a_r_s characters are read before the + iter if fewer than _n_c_h_a_r_s characters are read before the delimiter. --NN _n_c_h_a_r_s - rreeaadd returns after reading exactly _n_c_h_a_r_s characters - rather than waiting for a complete line of input, unless - EOF is encountered or rreeaadd times out. Delimiter charac- - ters encountered in the input are not treated specially - and do not cause rreeaadd to return until _n_c_h_a_r_s characters - are read. The result is not split on the characters in - IIFFSS; the intent is that the variable is assigned exactly + rreeaadd returns after reading exactly _n_c_h_a_r_s characters + rather than waiting for a complete line of input, unless + EOF is encountered or rreeaadd times out. Delimiter charac- + ters encountered in the input are not treated specially + and do not cause rreeaadd to return until _n_c_h_a_r_s characters + are read. The result is not split on the characters in + IIFFSS; the intent is that the variable is assigned exactly the characters read (with the exception of backslash; see the --rr option below). --pp _p_r_o_m_p_t Display _p_r_o_m_p_t on standard error, without a trailing new- - line, before attempting to read any input. The prompt is + line, before attempting to read any input. The prompt is displayed only if input is coming from a terminal. - --rr Backslash does not act as an escape character. The back- - slash is considered to be part of the line. In particu- - lar, a backslash-newline pair may not then be used as a + --rr Backslash does not act as an escape character. The back- + slash is considered to be part of the line. In particu- + lar, a backslash-newline pair may not then be used as a line continuation. - --ss Silent mode. If input is coming from a terminal, charac- + --ss Silent mode. If input is coming from a terminal, charac- ters are not echoed. --tt _t_i_m_e_o_u_t - Cause rreeaadd to time out and return failure if a complete - line of input (or a specified number of characters) is - not read within _t_i_m_e_o_u_t seconds. _t_i_m_e_o_u_t may be a decimal - number with a fractional portion following the decimal - point. This option is only effective if rreeaadd is reading - input from a terminal, pipe, or other special file; it - has no effect when reading from regular files. If rreeaadd - times out, rreeaadd saves any partial input read into the - specified variable _n_a_m_e. If _t_i_m_e_o_u_t is 0, rreeaadd returns - immediately, without trying to read any data. The exit - status is 0 if input is available on the specified file - descriptor, or the read will return EOF, non-zero other- - wise. The exit status is greater than 128 if the timeout - is exceeded. + Cause rreeaadd to time out and return failure if a complete + line of input (or a specified number of characters) is + not read within _t_i_m_e_o_u_t seconds. _t_i_m_e_o_u_t may be a deci- + mal number with a fractional portion following the deci- + mal point. This option is only effective if rreeaadd is + reading input from a terminal, pipe, or other special + file; it has no effect when reading from regular files. + If rreeaadd times out, rreeaadd saves any partial input read into + the specified variable _n_a_m_e. If _t_i_m_e_o_u_t is 0, rreeaadd re- + turns immediately, without trying to read any data. The + exit status is 0 if input is available on the specified + file descriptor, or the read will return EOF, non-zero + otherwise. The exit status is greater than 128 if the + timeout is exceeded. --uu _f_d Read input from file descriptor _f_d. - If no _n_a_m_e_s are supplied, the line read, without the ending de- - limiter but otherwise unmodified, is assigned to the variable - RREEPPLLYY. The exit status is zero, unless end-of-file is encoun- - tered, rreeaadd times out (in which case the status is greater than - 128), a variable assignment error (such as assigning to a read- + If no _n_a_m_e_s are supplied, the line read, without the ending de- + limiter but otherwise unmodified, is assigned to the variable + RREEPPLLYY. The exit status is zero, unless end-of-file is encoun- + tered, rreeaadd times out (in which case the status is greater than + 128), a variable assignment error (such as assigning to a read- only variable) occurs, or an invalid file descriptor is supplied as the argument to --uu. rreeaaddoonnllyy [--aaAAff] [--pp] [_n_a_m_e[=_w_o_r_d] ...] - The given _n_a_m_e_s are marked readonly; the values of these _n_a_m_e_s - may not be changed by subsequent assignment. If the --ff option is - supplied, the functions corresponding to the _n_a_m_e_s are so - marked. The --aa option restricts the variables to indexed arrays; - the --AA option restricts the variables to associative arrays. If - both options are supplied, --AA takes precedence. If no _n_a_m_e argu- - ments are given, or if the --pp option is supplied, a list of all - readonly names is printed. The other options may be used to re- - strict the output to a subset of the set of readonly names. The - --pp option causes output to be displayed in a format that may be - reused as input. If a variable name is followed by =_w_o_r_d, the - value of the variable is set to _w_o_r_d. The return status is 0 un- - less an invalid option is encountered, one of the _n_a_m_e_s is not a - valid shell variable name, or --ff is supplied with a _n_a_m_e that is - not a function. + The given _n_a_m_e_s are marked readonly; the values of these _n_a_m_e_s + may not be changed by subsequent assignment. If the --ff option + is supplied, the functions corresponding to the _n_a_m_e_s are so + marked. The --aa option restricts the variables to indexed ar- + rays; the --AA option restricts the variables to associative ar- + rays. If both options are supplied, --AA takes precedence. If no + _n_a_m_e arguments are given, or if the --pp option is supplied, a + list of all readonly names is printed. The other options may be + used to restrict the output to a subset of the set of readonly + names. The --pp option causes output to be displayed in a format + that may be reused as input. If a variable name is followed by + =_w_o_r_d, the value of the variable is set to _w_o_r_d. The return + status is 0 unless an invalid option is encountered, one of the + _n_a_m_e_s is not a valid shell variable name, or --ff is supplied with + a _n_a_m_e that is not a function. rreettuurrnn [_n] - Causes a function to stop executing and return the value speci- - fied by _n to its caller. If _n is omitted, the return status is - that of the last command executed in the function body. If rree-- + Causes a function to stop executing and return the value speci- + fied by _n to its caller. If _n is omitted, the return status is + that of the last command executed in the function body. If rree-- ttuurrnn is executed by a trap handler, the last command used to de- - termine the status is the last command executed before the trap - handler. If rreettuurrnn is executed during a DDEEBBUUGG trap, the last - command used to determine the status is the last command exe- - cuted by the trap handler before rreettuurrnn was invoked. If rreettuurrnn - is used outside a function, but during execution of a script by - the .. (ssoouurrccee) command, it causes the shell to stop executing - that script and return either _n or the exit status of the last - command executed within the script as the exit status of the - script. If _n is supplied, the return value is its least signifi- - cant 8 bits. The return status is non-zero if rreettuurrnn is supplied - a non-numeric argument, or is used outside a function and not - during execution of a script by .. or ssoouurrccee. Any command associ- - ated with the RREETTUURRNN trap is executed before execution resumes - after the function or script. + termine the status is the last command executed before the trap + handler. If rreettuurrnn is executed during a DDEEBBUUGG trap, the last + command used to determine the status is the last command exe- + cuted by the trap handler before rreettuurrnn was invoked. If rreettuurrnn + is used outside a function, but during execution of a script by + the .. (ssoouurrccee) command, it causes the shell to stop executing + that script and return either _n or the exit status of the last + command executed within the script as the exit status of the + script. If _n is supplied, the return value is its least signif- + icant 8 bits. The return status is non-zero if rreettuurrnn is sup- + plied a non-numeric argument, or is used outside a function and + not during execution of a script by .. or ssoouurrccee. Any command + associated with the RREETTUURRNN trap is executed before execution re- + sumes after the function or script. sseett [--aabbeeffhhkkmmnnppttuuvvxxBBCCEEHHPPTT] [--oo _o_p_t_i_o_n_-_n_a_m_e] [----] [--] [_a_r_g ...] sseett [++aabbeeffhhkkmmnnppttuuvvxxBBCCEEHHPPTT] [++oo _o_p_t_i_o_n_-_n_a_m_e] [----] [--] [_a_r_g ...] sseett --oo - sseett ++oo Without options, display the name and value of each shell vari- - able in a format that can be reused as input for setting or re- - setting the currently-set variables. Read-only variables cannot - be reset. In _p_o_s_i_x _m_o_d_e, only shell variables are listed. The - output is sorted according to the current locale. When options - are specified, they set or unset shell attributes. Any arguments - remaining after option processing are treated as values for the - positional parameters and are assigned, in order, to $$11, $$22, ...... - $$_n. Options, if specified, have the following meanings: + sseett ++oo Without options, display the name and value of each shell vari- + able in a format that can be reused as input for setting or re- + setting the currently-set variables. Read-only variables cannot + be reset. In _p_o_s_i_x _m_o_d_e, only shell variables are listed. The + output is sorted according to the current locale. When options + are specified, they set or unset shell attributes. Any argu- + ments remaining after option processing are treated as values + for the positional parameters and are assigned, in order, to $$11, + $$22, ...... $$_n. Options, if specified, have the following mean- + ings: --aa Each variable or function that is created or modified is given the export attribute and marked for export to the environment of subsequent commands. @@ -5727,15 +5759,15 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS eelliiff reserved words, part of any command executed in a &&&& or |||| list except the command following the final &&&& or ||||, any command in a pipeline but the last, or if the - command's return value is being inverted with !!. If a + command's return value is being inverted with !!. If a compound command other than a subshell returns a non- zero status because a command failed while --ee was being - ignored, the shell does not exit. A trap on EERRRR, if set, - is executed before the shell exits. This option applies - to the shell environment and each subshell environment - separately (see CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONNMMEENNTT above), - and may cause subshells to exit before executing all the - commands in the subshell. + ignored, the shell does not exit. A trap on EERRRR, if + set, is executed before the shell exits. This option + applies to the shell environment and each subshell envi- + ronment separately (see CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONNMMEENNTT + above), and may cause subshells to exit before executing + all the commands in the subshell. If a compound command or shell function executes in a context where --ee is being ignored, none of the commands @@ -5748,17 +5780,18 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS containing the function call completes. --ff Disable pathname expansion. --hh Remember the location of commands as they are looked up - for execution. This is enabled by default. + for execution. This is enabled by default. --kk All arguments in the form of assignment statements are placed in the environment for a command, not just those that precede the command name. - --mm Monitor mode. Job control is enabled. This option is on - by default for interactive shells on systems that sup- - port it (see JJOOBB CCOONNTTRROOLL above). All processes run in a - separate process group. When a background job completes, - the shell prints a line containing its exit status. - --nn Read commands but do not execute them. This may be used - to check a shell script for syntax errors. This is ig- + --mm Monitor mode. Job control is enabled. This option is + on by default for interactive shells on systems that + support it (see JJOOBB CCOONNTTRROOLL above). All processes run + in a separate process group. When a background job com- + pletes, the shell prints a line containing its exit sta- + tus. + --nn Read commands but do not execute them. This may be used + to check a shell script for syntax errors. This is ig- nored by interactive shells. --oo _o_p_t_i_o_n_-_n_a_m_e The _o_p_t_i_o_n_-_n_a_m_e can be one of the following: @@ -5766,10 +5799,10 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS Same as --aa. bbrraacceeeexxppaanndd Same as --BB. - eemmaaccss Use an emacs-style command line editing inter- - face. This is enabled by default when the shell + eemmaaccss Use an emacs-style command line editing inter- + face. This is enabled by default when the shell is interactive, unless the shell is started with - the ----nnooeeddiittiinngg option. This also affects the + the ----nnooeeddiittiinngg option. This also affects the editing interface used for rreeaadd --ee. eerrrreexxiitt Same as --ee. eerrrrttrraaccee @@ -5780,11 +5813,11 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS hhiisstteexxppaanndd Same as --HH. hhiissttoorryy Enable command history, as described above under - HHIISSTTOORRYY. This option is on by default in inter- + HHIISSTTOORRYY. This option is on by default in inter- active shells. iiggnnoorreeeeooff - The effect is as if the shell command ``IG- - NOREEOF=10'' had been executed (see SShheellll VVaarrii-- + The effect is as if the shell command ``IG- + NOREEOF=10'' had been executed (see SShheellll VVaarrii-- aabblleess above). kkeeyywwoorrdd Same as --kk. mmoonniittoorr Same as --mm. @@ -5799,116 +5832,117 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS pphhyyssiiccaall Same as --PP. ppiippeeffaaiill - If set, the return value of a pipeline is the - value of the last (rightmost) command to exit - with a non-zero status, or zero if all commands - in the pipeline exit successfully. This option + If set, the return value of a pipeline is the + value of the last (rightmost) command to exit + with a non-zero status, or zero if all commands + in the pipeline exit successfully. This option is disabled by default. - ppoossiixx Change the behavior of bbaasshh where the default - operation differs from the POSIX standard to - match the standard (_p_o_s_i_x _m_o_d_e). See SSEEEE AALLSSOO + ppoossiixx Change the behavior of bbaasshh where the default + operation differs from the POSIX standard to + match the standard (_p_o_s_i_x _m_o_d_e). See SSEEEE AALLSSOO below for a reference to a document that details how posix mode affects bash's behavior. pprriivviilleeggeedd Same as --pp. vveerrbboossee Same as --vv. - vvii Use a vi-style command line editing interface. + vvii Use a vi-style command line editing interface. This also affects the editing interface used for rreeaadd --ee. xxttrraaccee Same as --xx. - If --oo is supplied with no _o_p_t_i_o_n_-_n_a_m_e, sseett prints the - current shell option settings. If ++oo is supplied with no - _o_p_t_i_o_n_-_n_a_m_e, sseett prints a series of sseett commands to - recreate the current option settings on the standard + If --oo is supplied with no _o_p_t_i_o_n_-_n_a_m_e, sseett prints the + current shell option settings. If ++oo is supplied with + no _o_p_t_i_o_n_-_n_a_m_e, sseett prints a series of sseett commands to + recreate the current option settings on the standard output. - --pp Turn on _p_r_i_v_i_l_e_g_e_d mode. In this mode, the $$EENNVV and - $$BBAASSHH__EENNVV files are not processed, shell functions are - not inherited from the environment, and the SSHHEELLLLOOPPTTSS, - BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if they ap- - pear in the environment, are ignored. If the shell is - started with the effective user (group) id not equal to - the real user (group) id, and the --pp option is not sup- + --pp Turn on _p_r_i_v_i_l_e_g_e_d mode. In this mode, the $$EENNVV and + $$BBAASSHH__EENNVV files are not processed, shell functions are + not inherited from the environment, and the SSHHEELLLLOOPPTTSS, + BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if they ap- + pear in the environment, are ignored. If the shell is + started with the effective user (group) id not equal to + the real user (group) id, and the --pp option is not sup- plied, these actions are taken and the effective user id - is set to the real user id. If the --pp option is supplied - at startup, the effective user id is not reset. Turning - this option off causes the effective user and group ids - to be set to the real user and group ids. - --rr Enable restricted shell mode. This option cannot be un- + is set to the real user id. If the --pp option is sup- + plied at startup, the effective user id is not reset. + Turning this option off causes the effective user and + group ids to be set to the real user and group ids. + --rr Enable restricted shell mode. This option cannot be un- set once it has been set. --tt Exit after reading and executing one command. --uu Treat unset variables and parameters other than the spe- - cial parameters "@" and "*", or array variables sub- - scripted with "@" or "*", as an error when performing - parameter expansion. If expansion is attempted on an un- - set variable or parameter, the shell prints an error - message, and, if not interactive, exits with a non-zero + cial parameters "@" and "*", or array variables sub- + scripted with "@" or "*", as an error when performing + parameter expansion. If expansion is attempted on an + unset variable or parameter, the shell prints an error + message, and, if not interactive, exits with a non-zero status. --vv Print shell input lines as they are read. - --xx After expanding each _s_i_m_p_l_e _c_o_m_m_a_n_d, ffoorr command, ccaassee + --xx After expanding each _s_i_m_p_l_e _c_o_m_m_a_n_d, ffoorr command, ccaassee command, sseelleecctt command, or arithmetic ffoorr command, dis- - play the expanded value of PPSS44, followed by the command - and its expanded arguments or associated word list, to + play the expanded value of PPSS44, followed by the command + and its expanded arguments or associated word list, to standard error. - --BB The shell performs brace expansion (see BBrraaccee EExxppaannssiioonn - above). This is on by default. - --CC If set, bbaasshh does not overwrite an existing file with - the >>, >>&&, and <<>> redirection operators. This may be + --BB The shell performs brace expansion (see BBrraaccee EExxppaannssiioonn + above). This is on by default. + --CC If set, bbaasshh does not overwrite an existing file with + the >>, >>&&, and <<>> redirection operators. This may be overridden when creating output files by using the redi- rection operator >>|| instead of >>. --EE If set, any trap on EERRRR is inherited by shell functions, - command substitutions, and commands executed in a sub- - shell environment. The EERRRR trap is normally not inher- + command substitutions, and commands executed in a sub- + shell environment. The EERRRR trap is normally not inher- ited in such cases. - --HH Enable !! style history substitution. This option is on + --HH Enable !! style history substitution. This option is on by default when the shell is interactive. - --PP If set, the shell does not resolve symbolic links when - executing commands such as ccdd that change the current - working directory. It uses the physical directory struc- - ture instead. By default, bbaasshh follows the logical chain - of directories when performing commands which change the - current directory. - --TT If set, any traps on DDEEBBUUGG and RREETTUURRNN are inherited by + --PP If set, the shell does not resolve symbolic links when + executing commands such as ccdd that change the current + working directory. It uses the physical directory + structure instead. By default, bbaasshh follows the logical + chain of directories when performing commands which + change the current directory. + --TT If set, any traps on DDEEBBUUGG and RREETTUURRNN are inherited by shell functions, command substitutions, and commands ex- - ecuted in a subshell environment. The DDEEBBUUGG and RREETTUURRNN + ecuted in a subshell environment. The DDEEBBUUGG and RREETTUURRNN traps are normally not inherited in such cases. - ---- If no arguments follow this option, then the positional - parameters are unset. Otherwise, the positional parame- - ters are set to the _a_r_gs, even if some of them begin + ---- If no arguments follow this option, then the positional + parameters are unset. Otherwise, the positional parame- + ters are set to the _a_r_gs, even if some of them begin with a --. - -- Signal the end of options, cause all remaining _a_r_gs to - be assigned to the positional parameters. The --xx and --vv - options are turned off. If there are no _a_r_gs, the posi- + -- Signal the end of options, cause all remaining _a_r_gs to + be assigned to the positional parameters. The --xx and --vv + options are turned off. If there are no _a_r_gs, the posi- tional parameters remain unchanged. - 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 $$--. The return - status is always true unless an invalid option is encountered. + The options are off by default unless otherwise noted. Using + + rather than - causes these options to be turned off. The op- + tions can also be specified as arguments to an invocation of the + shell. The current set of options may be found in $$--. The re- + turn status is always true unless an invalid option is encoun- + tered. sshhiifftt [_n] The positional parameters from _n+1 ... are renamed to $$11 ........ Parameters represented by the numbers $$## down to $$##-_n+1 are un- - set. _n must be a non-negative number less than or equal to $$##. - If _n is 0, no parameters are changed. If _n is not given, it is - assumed to be 1. If _n is greater than $$##, the positional parame- - ters are not changed. The return status is greater than zero if - _n is greater than $$## or less than zero; otherwise 0. + set. _n must be a non-negative number less than or equal to $$##. + If _n is 0, no parameters are changed. If _n is not given, it is + assumed to be 1. If _n is greater than $$##, the positional param- + eters are not changed. The return status is greater than zero + if _n is greater than $$## or less than zero; otherwise 0. sshhoopptt [--ppqqssuu] [--oo] [_o_p_t_n_a_m_e ...] Toggle the values of settings controlling optional shell behav- - ior. The settings can be either those listed below, or, if the + ior. The settings can be either those listed below, or, if the --oo option is used, those available with the --oo option to the sseett - builtin command. With no options, or with the --pp option, a list + builtin command. With no options, or with the --pp option, a list of all settable options is displayed, with an indication of whether or not each is set; if _o_p_t_n_a_m_e_s are supplied, the output - is restricted to those options. The --pp option causes output to - be displayed in a form that may be reused as input. Other op- + is restricted to those options. The --pp option causes output to + be displayed in a form that may be reused as input. Other op- tions have the following meanings: --ss Enable (set) each _o_p_t_n_a_m_e. --uu Disable (unset) each _o_p_t_n_a_m_e. --qq Suppresses normal output (quiet mode); the return status - indicates whether the _o_p_t_n_a_m_e is set or unset. If multi- + indicates whether the _o_p_t_n_a_m_e is set or unset. If multi- ple _o_p_t_n_a_m_e arguments are given with --qq, the return sta- tus is zero if all _o_p_t_n_a_m_e_s are enabled; non-zero other- wise. @@ -5921,7 +5955,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS by default. The return status when listing options is zero if all _o_p_t_n_a_m_e_s - are enabled, non-zero otherwise. When setting or unsetting op- + are enabled, non-zero otherwise. When setting or unsetting op- tions, the return status is zero unless an _o_p_t_n_a_m_e is not a valid shell option. @@ -5937,40 +5971,40 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS Deprecated; a synonym for aarrrraayy__eexxppaanndd__oonnccee. aauuttooccdd If set, a command name that is the name of a directory is executed as if it were the argument to the ccdd com- - mand. This option is only used by interactive shells. + mand. This option is only used by interactive shells. ccddaabbllee__vvaarrss If set, an argument to the ccdd builtin command that is not a directory is assumed to be the name of a variable whose value is the directory to change to. ccddssppeellll If set, minor errors in the spelling of a directory com- - ponent in a ccdd command will be corrected. The errors + ponent in a ccdd command will be corrected. The errors checked for are transposed characters, a missing charac- - ter, and one character too many. If a correction is + ter, and one character too many. If a correction is found, the corrected filename is printed, and the com- mand proceeds. This option is only used by interactive shells. cchheecckkhhaasshh If set, bbaasshh checks that a command found in the hash ta- - ble exists before trying to execute it. If a hashed com- - mand no longer exists, a normal path search is per- + ble exists before trying to execute it. If a hashed + command no longer exists, a normal path search is per- formed. cchheecckkjjoobbss If set, bbaasshh lists the status of any stopped and running jobs before exiting an interactive shell. If any jobs are running, this causes the exit to be deferred until a second exit is attempted without an intervening command - (see JJOOBB CCOONNTTRROOLL above). The shell always postpones ex- + (see JJOOBB CCOONNTTRROOLL above). The shell always postpones ex- iting if any jobs are stopped. cchheecckkwwiinnssiizzee If set, bbaasshh checks the window size after each external (non-builtin) command and, if necessary, updates the - values of LLIINNEESS and CCOOLLUUMMNNSS. This option is enabled by + values of LLIINNEESS and CCOOLLUUMMNNSS. This option is enabled by default. ccmmddhhiisstt If set, bbaasshh attempts to save all lines of a multiple- - line command in the same history entry. This allows easy - re-editing of multi-line commands. This option is en- - abled by default, but only has an effect if command his- - tory is enabled, as described above under HHIISSTTOORRYY. + line command in the same history entry. This allows + easy re-editing of multi-line commands. This option is + enabled by default, but only has an effect if command + history is enabled, as described above under HHIISSTTOORRYY. ccoommppaatt3311 ccoommppaatt3322 ccoommppaatt4400 @@ -5984,25 +6018,25 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS ccoommpplleettee__ffuullllqquuoottee If set, bbaasshh quotes all shell metacharacters in file- - names and directory names when performing completion. If - not set, bbaasshh removes metacharacters such as the dollar - sign from the set of characters that will be quoted in - completed filenames when these metacharacters appear in - shell variable references in words to be completed. This - means that dollar signs in variable names that expand to - directories will not be quoted; however, any dollar - signs appearing in filenames will not be quoted, either. - This is active only when bash is using backslashes to - quote completed filenames. This variable is set by de- - fault, which is the default bash behavior in versions - through 4.2. + names and directory names when performing completion. + If not set, bbaasshh removes metacharacters such as the dol- + lar sign from the set of characters that will be quoted + in completed filenames when these metacharacters appear + in shell variable references in words to be completed. + This means that dollar signs in variable names that ex- + pand to directories will not be quoted; however, any + dollar signs appearing in filenames will not be quoted, + either. This is active only when bash is using back- + slashes to quote completed filenames. This variable is + set by default, which is the default bash behavior in + versions through 4.2. ddiirreexxppaanndd If set, bbaasshh replaces directory names with the results of word expansion when performing filename completion. This changes the contents of the readline editing buf- - fer. If not set, bbaasshh attempts to preserve what the user - typed. + fer. If not set, bbaasshh attempts to preserve what the + user typed. ddiirrssppeellll If set, bbaasshh attempts spelling correction on directory @@ -6010,15 +6044,15 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS tially supplied does not exist. ddoottgglloobb If set, bbaasshh includes filenames beginning with a `.' in - the results of pathname expansion. The filenames ````..'''' - and ````....'''' must always be matched explicitly, even if + the results of pathname expansion. The filenames ````..'''' + and ````....'''' must always be matched explicitly, even if ddoottgglloobb is set. eexxeeccffaaiill If set, a non-interactive shell will not exit if it can- not execute the file specified as an argument to the - eexxeecc builtin command. An interactive shell does not exit - if eexxeecc fails. + eexxeecc builtin command. An interactive shell does not + exit if eexxeecc fails. eexxppaanndd__aalliiaasseess If set, aliases are expanded as described above under @@ -6028,9 +6062,9 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS eexxttddeebbuugg If set at shell invocation, or in a shell startup file, arrange to execute the debugger profile before the shell - starts, identical to the ----ddeebbuuggggeerr option. If set after - invocation, behavior intended for use by debuggers is - enabled: + starts, identical to the ----ddeebbuuggggeerr option. If set af- + ter invocation, behavior intended for use by debuggers + is enabled: 11.. The --FF option to the ddeeccllaarree builtin displays the source file name and line number corresponding to @@ -6063,7 +6097,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS eexxttqquuoottee If set, $$'_s_t_r_i_n_g' and $$"_s_t_r_i_n_g" quoting is performed within $${{_p_a_r_a_m_e_t_e_r}} expansions enclosed in double - quotes. This option is enabled by default. + quotes. This option is enabled by default. ffaaiillgglloobb If set, patterns which fail to match filenames during @@ -6073,27 +6107,28 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS If set, the suffixes specified by the FFIIGGNNOORREE shell variable cause words to be ignored when performing word completion even if the ignored words are the only possi- - ble completions. See SSHHEELLLL VVAARRIIAABBLLEESS above for a de- - scription of FFIIGGNNOORREE. This option is enabled by default. + ble completions. See SSHHEELLLL VVAARRIIAABBLLEESS above for a de- + scription of FFIIGGNNOORREE. This option is enabled by de- + fault. gglloobbaasscciiiirraannggeess - If set, range expressions used in pattern matching - bracket expressions (see PPaatttteerrnn MMaattcchhiinngg above) behave - as if in the traditional C locale when performing com- - parisons. That is, the current locale's collating se- - quence is not taken into account, so bb will not collate - between AA and BB, and upper-case and lower-case ASCII + If set, range expressions used in pattern matching + bracket expressions (see PPaatttteerrnn MMaattcchhiinngg above) behave + as if in the traditional C locale when performing com- + parisons. That is, the current locale's collating se- + quence is not taken into account, so bb will not collate + between AA and BB, and upper-case and lower-case ASCII characters will collate together. gglloobbsskkiippddoottss - If set, pathname expansion will never match the file- - names ````..'''' and ````....'''', even if the pattern begins with - a ````..''''. This option is enabled by default. + If set, pathname expansion will never match the file- + names ````..'''' and ````....'''', even if the pattern begins with + a ````..''''. This option is enabled by default. gglloobbssttaarr If set, the pattern **** used in a pathname expansion con- - text will match all files and zero or more directories - and subdirectories. If the pattern is followed by a //, + text will match all files and zero or more directories + and subdirectories. If the pattern is followed by a //, only directories and subdirectories match. ggnnuu__eerrrrffmmtt @@ -6101,179 +6136,179 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS GNU error message format. hhiissttaappppeenndd - If set, the history list is appended to the file named + If set, the history list is appended to the file named by the value of the HHIISSTTFFIILLEE variable when the shell ex- its, rather than overwriting the file. hhiissttrreeeeddiitt - If set, and rreeaaddlliinnee is being used, a user is given the + If set, and rreeaaddlliinnee is being used, a user is given the opportunity to re-edit a failed history substitution. hhiissttvveerriiffyy - If set, and rreeaaddlliinnee is being used, the results of his- - tory substitution are not immediately passed to the - shell parser. Instead, the resulting line is loaded into - the rreeaaddlliinnee editing buffer, allowing further modifica- - tion. + If set, and rreeaaddlliinnee is being used, the results of his- + tory substitution are not immediately passed to the + shell parser. Instead, the resulting line is loaded + into the rreeaaddlliinnee editing buffer, allowing further modi- + fication. hhoossttccoommpplleettee If set, and rreeaaddlliinnee is being used, bbaasshh will attempt to - perform hostname completion when a word containing a @@ - is being completed (see CCoommpplleettiinngg under RREEAADDLLIINNEE - above). This is enabled by default. + perform hostname completion when a word containing a @@ + is being completed (see CCoommpplleettiinngg under RREEAADDLLIINNEE + above). This is enabled by default. hhuuppoonneexxiitt If set, bbaasshh will send SSIIGGHHUUPP to all jobs when an inter- active login shell exits. iinnhheerriitt__eerrrreexxiitt - If set, command substitution inherits the value of the - eerrrreexxiitt option, instead of unsetting it in the subshell - environment. This option is enabled when _p_o_s_i_x _m_o_d_e is + If set, command substitution inherits the value of the + eerrrreexxiitt option, instead of unsetting it in the subshell + environment. This option is enabled when _p_o_s_i_x _m_o_d_e is enabled. iinntteerraaccttiivvee__ccoommmmeennttss If set, allow a word beginning with ## to cause that word - and all remaining characters on that line to be ignored - in an interactive shell (see CCOOMMMMEENNTTSS above). This op- + and all remaining characters on that line to be ignored + in an interactive shell (see CCOOMMMMEENNTTSS above). This op- tion is enabled by default. llaassttppiippee - If set, and job control is not active, the shell runs + If set, and job control is not active, the shell runs the last command of a pipeline not executed in the back- ground in the current shell environment. - lliitthhiisstt If set, and the ccmmddhhiisstt option is enabled, multi-line + lliitthhiisstt If set, and the ccmmddhhiisstt option is enabled, multi-line commands are saved to the history with embedded newlines rather than using semicolon separators where possible. llooccaallvvaarr__iinnhheerriitt If set, local variables inherit the value and attributes of a variable of the same name that exists at a previous - scope before any new value is assigned. The nameref at- + scope before any new value is assigned. The nameref at- tribute is not inherited. llooccaallvvaarr__uunnsseett - If set, calling uunnsseett on local variables in previous - function scopes marks them so subsequent lookups find - them unset until that function returns. This is identi- - cal to the behavior of unsetting local variables at the + If set, calling uunnsseett on local variables in previous + function scopes marks them so subsequent lookups find + them unset until that function returns. This is identi- + cal to the behavior of unsetting local variables at the current function scope. llooggiinn__sshheellll - The shell sets this option if it is started as a login - shell (see IINNVVOOCCAATTIIOONN above). The value may not be + The shell sets this option if it is started as a login + shell (see IINNVVOOCCAATTIIOONN above). The value may not be changed. mmaaiillwwaarrnn - If set, and a file that bbaasshh is checking for mail has - been accessed since the last time it was checked, the - message ``The mail in _m_a_i_l_f_i_l_e has been read'' is dis- + If set, and a file that bbaasshh is checking for mail has + been accessed since the last time it was checked, the + message ``The mail in _m_a_i_l_f_i_l_e has been read'' is dis- played. nnoo__eemmppttyy__ccmmdd__ccoommpplleettiioonn - If set, and rreeaaddlliinnee is being used, bbaasshh will not at- - tempt to search the PPAATTHH for possible completions when + If set, and rreeaaddlliinnee is being used, bbaasshh will not at- + tempt to search the PPAATTHH for possible completions when completion is attempted on an empty line. nnooccaasseegglloobb - If set, bbaasshh matches filenames in a case-insensitive + If set, bbaasshh matches filenames in a case-insensitive fashion when performing pathname expansion (see PPaatthhnnaammee EExxppaannssiioonn above). nnooccaasseemmaattcchh - If set, bbaasshh matches patterns in a case-insensitive + If set, bbaasshh matches patterns in a case-insensitive fashion when performing matching while executing ccaassee or [[[[ conditional commands, when performing pattern substi- - tution word expansions, or when filtering possible com- + tution word expansions, or when filtering possible com- pletions as part of programmable completion. nnooeexxppaanndd__ttrraannssllaattiioonn - If set, bbaasshh encloses the translated results of $"..." - quoting in single quotes instead of double quotes. If + If set, bbaasshh encloses the translated results of $"..." + quoting in single quotes instead of double quotes. If the string is not translated, this has no effect. nnuullllgglloobb - If set, bbaasshh allows patterns which match no files (see - PPaatthhnnaammee EExxppaannssiioonn above) to expand to a null string, + If set, bbaasshh allows patterns which match no files (see + PPaatthhnnaammee EExxppaannssiioonn above) to expand to a null string, rather than themselves. ppaattssuubb__rreeppllaacceemmeenntt If set, bbaasshh expands occurrences of && in the replacement - string of pattern substitution to the text matched by - the pattern, as described under PPaarraammeetteerr EExxppaannssiioonn - above. This option is enabled by default. + string of pattern substitution to the text matched by + the pattern, as described under PPaarraammeetteerr EExxppaannssiioonn + above. This option is enabled by default. pprrooggccoommpp If set, the programmable completion facilities (see PPrroo-- - ggrraammmmaabbllee CCoommpplleettiioonn above) are enabled. This option is + ggrraammmmaabbllee CCoommpplleettiioonn above) are enabled. This option is enabled by default. pprrooggccoommpp__aalliiaass - If set, and programmable completion is enabled, bbaasshh - treats a command name that doesn't have any completions - as a possible alias and attempts alias expansion. If it - has an alias, bbaasshh attempts programmable completion us- + If set, and programmable completion is enabled, bbaasshh + treats a command name that doesn't have any completions + as a possible alias and attempts alias expansion. If it + has an alias, bbaasshh attempts programmable completion us- ing the command word resulting from the expanded alias. pprroommppttvvaarrss If set, prompt strings undergo parameter expansion, com- - mand substitution, arithmetic expansion, and quote re- - moval after being expanded as described in PPRROOMMPPTTIINNGG - above. This option is enabled by default. + mand substitution, arithmetic expansion, and quote re- + moval after being expanded as described in PPRROOMMPPTTIINNGG + above. This option is enabled by default. rreessttrriicctteedd__sshheellll - The shell sets this option if it is started in re- - stricted mode (see RREESSTTRRIICCTTEEDD SSHHEELLLL below). The value - may not be changed. This is not reset when the startup - files are executed, allowing the startup files to dis- + The shell sets this option if it is started in re- + stricted mode (see RREESSTTRRIICCTTEEDD SSHHEELLLL below). The value + may not be changed. This is not reset when the startup + files are executed, allowing the startup files to dis- cover whether or not a shell is restricted. sshhiifftt__vveerrbboossee - If set, the sshhiifftt builtin prints an error message when + If set, the sshhiifftt builtin prints an error message when the shift count exceeds the number of positional parame- ters. ssoouurrcceeppaatthh If set, the .. (ssoouurrccee) builtin uses the value of PPAATTHH to - find the directory containing the file supplied as an - argument. This option is enabled by default. + find the directory containing the file supplied as an + argument. This option is enabled by default. vvaarrrreeddiirr__cclloossee - If set, the shell automatically closes file descriptors + If set, the shell automatically closes file descriptors assigned using the _{_v_a_r_n_a_m_e_} redirection syntax (see RREE-- - DDIIRREECCTTIIOONN above) instead of leaving them open when the + DDIIRREECCTTIIOONN above) instead of leaving them open when the command completes. xxppgg__eecchhoo - If set, the eecchhoo builtin expands backslash-escape se- - quences by default. If the ppoossiixx shell option is also + If set, the eecchhoo builtin expands backslash-escape se- + quences by default. If the ppoossiixx shell option is also enabled, eecchhoo does not interpret any options. ssuussppeenndd [--ff] - Suspend the execution of this shell until it receives a SSIIGGCCOONNTT - signal. A login shell, or a shell without job control enabled, - cannot be suspended; the --ff option can be used to override this - and force the suspension. The return status is 0 unless the - shell is a login shell or job control is not enabled and --ff is + Suspend the execution of this shell until it receives a SSIIGGCCOONNTT + signal. A login shell, or a shell without job control enabled, + cannot be suspended; the --ff option can be used to override this + and force the suspension. The return status is 0 unless the + shell is a login shell or job control is not enabled and --ff is not supplied. tteesstt _e_x_p_r [[ _e_x_p_r ]] Return a status of 0 (true) or 1 (false) depending on the evalu- - ation of the conditional expression _e_x_p_r. Each operator and op- - erand must be a separate argument. Expressions are composed of - the primaries described above under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS. - tteesstt does not accept any options, nor does it accept and ignore + ation of the conditional expression _e_x_p_r. Each operator and op- + erand must be a separate argument. Expressions are composed of + the primaries described above under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS. + tteesstt does not accept any options, nor does it accept and ignore an argument of ---- as signifying the end of options. - Expressions may be combined using the following operators, - listed in decreasing order of precedence. The evaluation depends - on the number of arguments; see below. Operator precedence is - used when there are five or more arguments. + Expressions may be combined using the following operators, + listed in decreasing order of precedence. The evaluation de- + pends on the number of arguments; see below. Operator prece- + dence is used when there are five or more arguments. !! _e_x_p_r True if _e_x_p_r is false. (( _e_x_p_r )) - Returns the value of _e_x_p_r. This may be used to override + Returns the value of _e_x_p_r. This may be used to override the normal precedence of operators. _e_x_p_r_1 -aa _e_x_p_r_2 True if both _e_x_p_r_1 and _e_x_p_r_2 are true. @@ -6290,83 +6325,84 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS null. 2 arguments If the first argument is !!, the expression is true if and - only if the second argument is null. If the first argu- - ment is one of the unary conditional operators listed - above under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS, the expression is - true if the unary test is true. If the first argument is + only if the second argument is null. If the first argu- + ment is one of the unary conditional operators listed + above under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS, 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. 3 arguments The following conditions are applied in the order listed. - If the second argument is one of the binary conditional + If the second argument is one of the binary conditional operators listed above under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS, the result of the expression is the result of the binary test - using the first and third arguments as operands. The --aa - and --oo operators are considered binary operators when - there are three arguments. 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 + using the first and third arguments as operands. The --aa + and --oo operators are considered binary operators when + there are three arguments. 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. Other- + is the one-argument test of the second argument. Other- wise, the expression is false. 4 arguments The following conditions are applied in the order listed. If the first argument is !!, the result is the negation of - the three-argument expression composed of the remaining - arguments. the two-argument test using the second and - third arguments. If the first argument is exactly (( and - the fourth argument is exactly )), the result is the two- - argument test of the second and third arguments. Other- + the three-argument expression composed of the remaining + arguments. the two-argument test using the second and + third arguments. If the first argument is exactly (( and + the fourth argument is exactly )), the result is the two- + argument test of the second and third arguments. Other- wise, 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 + The expression is parsed and evaluated according to precedence using the rules listed above. If the shell is not in _p_o_s_i_x _m_o_d_e, when used with tteesstt or [[, the - << and >> operators sort lexicographically using ASCII ordering. - When the shell is in _p_o_s_i_x _m_o_d_e, these operators sort using the + << and >> operators sort lexicographically using ASCII ordering. + When the shell is in _p_o_s_i_x _m_o_d_e, these operators sort using the current locale. - ttiimmeess Print the accumulated user and system times for the shell and - for processes run from the shell. The return status is 0. + ttiimmeess Print the accumulated user and system times for the shell and + for processes run from the shell. The return status is 0. ttrraapp [--llpp] [[_a_c_t_i_o_n] _s_i_g_s_p_e_c ...] The _a_c_t_i_o_n is a command that is read and executed when the shell - receives signal(s) _s_i_g_s_p_e_c. If _a_c_t_i_o_n is absent (and there is a - single _s_i_g_s_p_e_c) or --, each specified signal is reset to its - original disposition (the value it had upon entrance to the - shell). If _a_c_t_i_o_n is the null string the signal specified by - each _s_i_g_s_p_e_c is ignored by the shell and by the commands it in- + receives signal(s) _s_i_g_s_p_e_c. If _a_c_t_i_o_n is absent (and there is a + single _s_i_g_s_p_e_c) or --, each specified signal is reset to its + original disposition (the value it had upon entrance to the + shell). If _a_c_t_i_o_n is the null string the signal specified by + each _s_i_g_s_p_e_c is ignored by the shell and by the commands it in- vokes. - If no arguments are supplied, ttrraapp displays the actions associ- + If no arguments are supplied, ttrraapp displays the actions associ- ated with each trapped signal as a set of ttrraapp commands that can - be reused as shell input to restore the current signal disposi- - tions. If --pp is given, and _a_c_t_i_o_n is not present, then ttrraapp dis- - plays the actions associated with each _s_i_g_s_p_e_c or, if none are - supplied, for all trapped signals, as a set of ttrraapp commands - that can be reused as shell input to restore the current signal - dispositions. The --PP option behaves similarly, but displays only - the actions associated with each _s_i_g_s_p_e_c argument. --PP requires - at least one _s_i_g_s_p_e_c argument. The --PP or --pp options to ttrraapp may - be used in a subshell environment (e.g., command substitution) - and, as long as they are used before ttrraapp is used to change a - signal's handling, will display the state of its parent's traps. + be reused as shell input to restore the current signal disposi- + tions. If --pp is given, and _a_c_t_i_o_n is not present, then ttrraapp + displays the actions associated with each _s_i_g_s_p_e_c or, if none + are supplied, for all trapped signals, as a set of ttrraapp commands + that can be reused as shell input to restore the current signal + dispositions. The --PP option behaves similarly, but displays + only the actions associated with each _s_i_g_s_p_e_c argument. --PP re- + quires at least one _s_i_g_s_p_e_c argument. The --PP or --pp options to + ttrraapp may be used in a subshell environment (e.g., command sub- + stitution) and, as long as they are used before ttrraapp is used to + change a signal's handling, will display the state of its par- + ent's traps. The --ll option causes ttrraapp to print a list of signal names and - their corresponding numbers. Each _s_i_g_s_p_e_c is either a signal - name defined in <_s_i_g_n_a_l_._h>, or a signal number. Signal names are - case insensitive and the SSIIGG prefix is optional. + their corresponding numbers. Each _s_i_g_s_p_e_c is either a signal + name defined in <_s_i_g_n_a_l_._h>, or a signal number. Signal names + are case insensitive and the SSIIGG prefix is optional. If a _s_i_g_s_p_e_c is EEXXIITT (0) the command _a_c_t_i_o_n is executed on exit - from the shell. If a _s_i_g_s_p_e_c is DDEEBBUUGG, the command _a_c_t_i_o_n is ex- - ecuted before every _s_i_m_p_l_e _c_o_m_m_a_n_d, _f_o_r command, _c_a_s_e command, + from the shell. If a _s_i_g_s_p_e_c is DDEEBBUUGG, the command _a_c_t_i_o_n is + executed before every _s_i_m_p_l_e _c_o_m_m_a_n_d, _f_o_r command, _c_a_s_e command, _s_e_l_e_c_t command, (( arithmetic command, [[ conditional command, arithmetic _f_o_r command, and before the first command executes in - a shell function (see SSHHEELLLL GGRRAAMMMMAARR above). Refer to the de- + a shell function (see SSHHEELLLL GGRRAAMMMMAARR above). Refer to the de- scription of the eexxttddeebbuugg option to the sshhoopptt builtin for de- - tails of its effect on the DDEEBBUUGG trap. If a _s_i_g_s_p_e_c is RREETTUURRNN, + tails of its effect on the DDEEBBUUGG trap. If a _s_i_g_s_p_e_c is RREETTUURRNN, the command _a_c_t_i_o_n is executed each time a shell function or a script executed with the .. or ssoouurrccee builtins finishes execut- ing. @@ -6384,36 +6420,36 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS tion. When the shell is not interactive, signals ignored upon entry to - the shell cannot be trapped or reset. Interactive shells permit - trapping signals ignored on entry. Trapped signals that are not + the shell cannot be trapped or reset. Interactive shells permit + trapping signals ignored on entry. Trapped signals that are not being ignored are reset to their original values in a subshell - or subshell environment when one is created. The return status + or subshell environment when one is created. The return status is false if any _s_i_g_s_p_e_c is invalid; otherwise ttrraapp returns true. ttrruuee Does nothing, returns a 0 status. ttyyppee [--aaffttppPP] _n_a_m_e [_n_a_m_e ...] With no options, indicate how each _n_a_m_e would be interpreted if - used as a command name. If the --tt option is used, ttyyppee prints a + used as a command name. If the --tt option is used, ttyyppee prints a string which is one of _a_l_i_a_s, _k_e_y_w_o_r_d, _f_u_n_c_t_i_o_n, _b_u_i_l_t_i_n, or _f_i_l_e if _n_a_m_e is an alias, shell reserved word, function, - builtin, or executable disk file, respectively. If the _n_a_m_e is + builtin, or executable disk file, respectively. If the _n_a_m_e is not found, then nothing is printed, and ttyyppee returns a non-zero exit status. If the --pp option is used, ttyyppee either returns the name of the executable file that would be found by searching $$PPAATTHH if _n_a_m_e were specified as a command name, or nothing if - ``type -t name'' would not return _f_i_l_e. The --PP option forces a + ``type -t name'' would not return _f_i_l_e. The --PP option forces a PPAATTHH search for each _n_a_m_e, even if ``type -t name'' would not - return _f_i_l_e. If a command is hashed, --pp and --PP print the hashed + return _f_i_l_e. If a command is hashed, --pp and --PP print the hashed value, which is not necessarily the file that appears first in - PPAATTHH. If the --aa option is used, ttyyppee prints all of the places - that contain a command named _n_a_m_e. This includes aliases, re- + PPAATTHH. If the --aa option is used, ttyyppee prints all of the places + that contain a command named _n_a_m_e. This includes aliases, re- served words, functions, and builtins, but the path search op- tions (--pp and --PP) can be supplied to restrict the output to exe- - cutable files. ttyyppee does not consult the table of hashed com- + cutable files. ttyyppee does not consult the table of hashed com- mands when using --aa with --pp, and only performs a PPAATTHH search for - _n_a_m_e. The --ff option suppresses shell function lookup, as with - the ccoommmmaanndd builtin. ttyyppee returns true if all of the arguments + _n_a_m_e. The --ff option suppresses shell function lookup, as with + the ccoommmmaanndd builtin. ttyyppee returns true if all of the arguments are found, false if any are not found. uulliimmiitt [--HHSS] --aa @@ -6421,17 +6457,17 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS Provides control over the resources available to the shell and to processes started by it, on systems that allow such control. The --HH and --SS options specify that the hard or soft limit is set - for the given resource. A hard limit cannot be increased by a + for the given resource. A hard limit cannot be increased by a non-root user once it is set; a soft limit may be increased up - to the value of the hard limit. If neither --HH nor --SS is speci- - fied, both the soft and hard limits are set. The value of _l_i_m_i_t + to the value of the hard limit. If neither --HH nor --SS is speci- + fied, both the soft and hard limits are set. The value of _l_i_m_i_t can be a number in the unit specified for the resource or one of the special values hhaarrdd, ssoofftt, or uunnlliimmiitteedd, which stand for the current hard limit, the current soft limit, and no limit, re- - spectively. If _l_i_m_i_t is omitted, the current value of the soft + spectively. If _l_i_m_i_t is omitted, the current value of the soft limit of the resource is printed, unless the --HH option is given. When more than one resource is specified, the limit name and - unit, if appropriate, are printed before the value. Other op- + unit, if appropriate, are printed before the value. Other op- tions are interpreted as follows: --aa All current limits are reported; no limits are set --bb The maximum socket buffer size @@ -6463,73 +6499,73 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --TT The maximum number of threads If _l_i_m_i_t is given, and the --aa option is not used, _l_i_m_i_t is the - new value of the specified resource. If no option is given, then - --ff is assumed. Values are in 1024-byte increments, except for - --tt, which is in seconds; --RR, which is in microseconds; --pp, which - is in units of 512-byte blocks; --PP, --TT, --bb, --kk, --nn, and --uu, - which are unscaled values; and, when in posix mode, --cc and --ff, - which are in 512-byte increments. The return status is 0 unless - an invalid option or argument is supplied, or an error occurs - while setting a new limit. + new value of the specified resource. If no option is given, + then --ff is assumed. Values are in 1024-byte increments, except + for --tt, which is in seconds; --RR, which is in microseconds; --pp, + which is in units of 512-byte blocks; --PP, --TT, --bb, --kk, --nn, and + --uu, which are unscaled values; and, when in posix mode, --cc and + --ff, which are in 512-byte increments. The return status is 0 + unless an invalid option or argument is supplied, or an error + occurs while setting a new limit. uummaasskk [--pp] [--SS] [_m_o_d_e] - The user file-creation mask is set to _m_o_d_e. If _m_o_d_e begins with + The user file-creation mask is set to _m_o_d_e. If _m_o_d_e begins with a digit, it is interpreted as an octal number; otherwise it is interpreted as a symbolic mode mask similar to that accepted by - _c_h_m_o_d(1). If _m_o_d_e is omitted, the current value of the mask is - printed. The --SS option causes the mask to be printed in symbolic - form; the default output is an octal number. If the --pp option is - supplied, and _m_o_d_e is omitted, the output is in a form that may - be reused as input. The return status is 0 if the mode was suc- - cessfully changed or if no _m_o_d_e argument was supplied, and false - otherwise. + _c_h_m_o_d(1). If _m_o_d_e is omitted, the current value of the mask is + printed. The --SS option causes the mask to be printed in sym- + bolic form; the default output is an octal number. If the --pp + option is supplied, and _m_o_d_e 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 _m_o_d_e argument was supplied, + and false otherwise. uunnaalliiaass [-aa] [_n_a_m_e ...] - Remove each _n_a_m_e from the list of defined aliases. If --aa is sup- - plied, all alias definitions are removed. The return value is - true unless a supplied _n_a_m_e is not a defined alias. + Remove each _n_a_m_e from the list of defined aliases. If --aa is + supplied, all alias definitions are removed. The return value + is true unless a supplied _n_a_m_e is not a defined alias. uunnsseett [-ffvv] [-nn] [_n_a_m_e ...] - For each _n_a_m_e, remove the corresponding variable or function. If - the --vv option is given, each _n_a_m_e refers to a shell variable, - and that variable is removed. Read-only variables may not be un- - set. If --ff is specified, each _n_a_m_e refers to a shell function, - and the function definition is removed. If the --nn option is sup- - plied, and _n_a_m_e is a variable with the _n_a_m_e_r_e_f attribute, _n_a_m_e - will be unset rather than the variable it references. --nn has no - effect if the --ff option is supplied. If no options are supplied, - each _n_a_m_e refers to a variable; if there is no variable by that - name, a function with that name, if any, is unset. Each unset - variable or function is removed from the environment passed to - subsequent commands. If any of BBAASSHH__AALLIIAASSEESS, BBAASSHH__AARRGGVV00, - BBAASSHH__CCMMDDSS, BBAASSHH__CCOOMMMMAANNDD, BBAASSHH__SSUUBBSSHHEELLLL, BBAASSHHPPIIDD, CCOOMMPP__WWOORRDD-- - BBRREEAAKKSS, DDIIRRSSTTAACCKK, EEPPOOCCHHRREEAALLTTIIMMEE, EEPPOOCCHHSSEECCOONNDDSS, FFUUNNCCNNAAMMEE, GGRROOUUPPSS, - HHIISSTTCCMMDD, LLIINNEENNOO, RRAANNDDOOMM, SSEECCOONNDDSS, or SSRRAANNDDOOMM are unset, they - lose their special properties, even if they are subsequently re- - set. The exit status is true unless a _n_a_m_e is readonly or may - not be unset. + For each _n_a_m_e, remove the corresponding variable or function. + If the --vv option is given, each _n_a_m_e refers to a shell variable, + and that variable is removed. Read-only variables may not be + unset. If --ff is specified, each _n_a_m_e refers to a shell func- + tion, and the function definition is removed. If the --nn option + is supplied, and _n_a_m_e is a variable with the _n_a_m_e_r_e_f attribute, + _n_a_m_e will be unset rather than the variable it references. --nn + has no effect if the --ff option is supplied. If no options are + supplied, each _n_a_m_e refers to a variable; if there is no vari- + able by that name, a function with that name, if any, is unset. + Each unset variable or function is removed from the environment + passed to subsequent commands. If any of BBAASSHH__AALLIIAASSEESS, + BBAASSHH__AARRGGVV00, BBAASSHH__CCMMDDSS, BBAASSHH__CCOOMMMMAANNDD, BBAASSHH__SSUUBBSSHHEELLLL, BBAASSHHPPIIDD, + CCOOMMPP__WWOORRDDBBRREEAAKKSS, DDIIRRSSTTAACCKK, EEPPOOCCHHRREEAALLTTIIMMEE, EEPPOOCCHHSSEECCOONNDDSS, FFUUNNCC-- + NNAAMMEE, GGRROOUUPPSS, HHIISSTTCCMMDD, LLIINNEENNOO, RRAANNDDOOMM, SSEECCOONNDDSS, or SSRRAANNDDOOMM are + unset, they lose their special properties, even if they are sub- + sequently reset. The exit status is true unless a _n_a_m_e is read- + only or may not be unset. wwaaiitt [--ffnn] [--pp _v_a_r_n_a_m_e] [_i_d _._._.] Wait for each specified child process and return its termination - status. Each _i_d may be a process ID or a job specification; if a - job spec is given, all processes in that job's pipeline are - waited for. If _i_d is not given, wwaaiitt waits for all running back- - ground jobs and the last-executed process substitution, if its - process id is the same as $$!!, and the return status is zero. If - the --nn option is supplied, wwaaiitt waits for a single job from the - list of _i_ds or, if no _i_ds are supplied, any job, to complete and - returns its exit status. If none of the supplied arguments is a - child of the shell, or if no arguments are supplied and the - shell has no unwaited-for children, the exit status is 127. If + status. Each _i_d may be a process ID or a job specification; if + a job spec is given, all processes in that job's pipeline are + waited for. If _i_d is not given, wwaaiitt waits for all running + background jobs and the last-executed process substitution, if + its process id is the same as $$!!, and the return status is zero. + If the --nn option is supplied, wwaaiitt waits for a single job from + the list of _i_ds or, if no _i_ds are supplied, any job, to complete + and returns its exit status. If none of the supplied arguments + is a child of the shell, or if no arguments are supplied and the + shell has no unwaited-for children, the exit status is 127. If the --pp option is supplied, the process or job identifier of the job for which the exit status is returned is assigned to the - variable _v_a_r_n_a_m_e named by the option argument. The variable will - be unset initially, before any assignment. This is useful only - when the --nn option is supplied. Supplying the --ff option, when - job control is enabled, forces wwaaiitt to wait for _i_d to terminate - before returning its status, instead of returning when it - changes status. If _i_d specifies a non-existent process or job, - the return status is 127. If wwaaiitt is interrupted by a signal, + variable _v_a_r_n_a_m_e named by the option argument. The variable + will be unset initially, before any assignment. This is useful + only when the --nn option is supplied. Supplying the --ff option, + when job control is enabled, forces wwaaiitt to wait for _i_d to ter- + minate before returning its status, instead of returning when it + changes status. If _i_d specifies a non-existent process or job, + the return status is 127. If wwaaiitt is interrupted by a signal, the return status will be greater than 128, as described under SSIIGGNNAALLSS above. Otherwise, the return status is the exit status of the last process or job waited for. @@ -6537,12 +6573,12 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE Bash-4.0 introduced the concept of a _s_h_e_l_l _c_o_m_p_a_t_i_b_i_l_i_t_y _l_e_v_e_l, speci- fied as a set of options to the shopt builtin ( ccoommppaatt3311, ccoommppaatt3322, - ccoommppaatt4400, ccoommppaatt4411, and so on). There is only one current compatibility - level - each option is mutually exclusive. The compatibility level is - intended to allow users to select behavior from previous versions that - is incompatible with newer versions while they migrate scripts to use - current features and behavior. It's intended to be a temporary solu- - tion. + ccoommppaatt4400, ccoommppaatt4411, and so on). There is only one current compatibil- + ity level -- each option is mutually exclusive. The compatibility + level is intended to allow users to select behavior from previous ver- + sions that is incompatible with newer versions while they migrate + scripts to use current features and behavior. It's intended to be a + temporary solution. This section does not mention behavior that is standard for a particu- lar version (e.g., setting ccoommppaatt3322 means that quoting the rhs of the @@ -6551,15 +6587,15 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE If a user enables, say, ccoommppaatt3322, it may affect the behavior of other compatibility levels up to and including the current compatibility - level. The idea is that each compatibility level controls behavior that - changed in that version of bbaasshh, but that behavior may have been - present in earlier versions. For instance, the change to use locale- + level. The idea is that each compatibility level controls behavior + that changed in that version of bbaasshh, but that behavior may have been + present in earlier versions. For instance, the change to use locale- based comparisons with the [[[[ command came in bash-4.1, and earlier versions used ASCII-based comparisons, so enabling ccoommppaatt3322 will enable - ASCII-based comparisons as well. That granularity may not be sufficient - for all uses, and as a result users should employ compatibility levels - carefully. Read the documentation for a particular feature to find out - the current behavior. + ASCII-based comparisons as well. That granularity may not be suffi- + cient for all uses, and as a result users should employ compatibility + levels carefully. Read the documentation for a particular feature to + find out the current behavior. Bash-4.3 introduced a new shell variable: BBAASSHH__CCOOMMPPAATT. The value as- signed to this variable (a decimal version number like 4.2, or an inte- @@ -6567,7 +6603,7 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE patibility level. Starting with bash-4.4, bbaasshh has begun deprecating older compatibility - levels. Eventually, the options will be removed in favor of BBAASSHH__CCOOMM-- + levels. Eventually, the options will be removed in favor of BBAASSHH__CCOOMM-- PPAATT. Bash-5.0 is the final version for which there will be an individual @@ -6575,10 +6611,10 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE bash-5.0 and later versions. The following table describes the behavior changes controlled by each - compatibility level setting. The ccoommppaatt_N_N tag is used as shorthand for + compatibility level setting. The ccoommppaatt_N_N tag is used as shorthand for setting the compatibility level to _N_N using one of the following mecha- - nisms. For versions prior to bash-5.0, the compatibility level may be - set using the corresponding ccoommppaatt_N_N shopt option. For bash-4.3 and + nisms. For versions prior to bash-5.0, the compatibility level may be + set using the corresponding ccoommppaatt_N_N shopt option. For bash-4.3 and later versions, the BBAASSHH__CCOOMMPPAATT variable is preferred, and it is re- quired for bash-5.1 and later versions. @@ -6594,7 +6630,7 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE ccoommppaatt4400 +o the << and >> operators to the [[[[ command do not consider the current locale when comparing strings; they use ASCII - ordering. BBaasshh versions prior to bash-4.1 use ASCII col- + ordering. BBaasshh versions prior to bash-4.1 use ASCII col- lation and _s_t_r_c_m_p(3); bash-4.1 and later use the current locale's collation sequence and _s_t_r_c_o_l_l(3). @@ -6629,7 +6665,7 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE mode (the default behavior is to make them fatal errors that cause the shell to exit) +o when executing a shell function, the loop state - (while/until/etc.) is not reset, so bbrreeaakk or ccoonnttiinnuuee in + (while/until/etc.) is not reset, so bbrreeaakk or ccoonnttiinnuuee in that function will break or continue loops in the calling context. Bash-4.4 and later reset the loop state to pre- vent this @@ -6677,27 +6713,27 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE can be expanded more than once +o tteesstt --vv, when given an argument of AA[[@@]], where AAPP iiss aann eexxiissttiinngg aassssoocciiaattiivvee aarrrraayy,, wwiillll rreettuurrnn ttrruuee iiff tthhee aarrrraayy - hhaass aannyy sseett eelleemmeennttss.. BBaasshh--55..22 wwiillll llooookk ffoorr aanndd rreeppoorrtt + hhaass aannyy sseett eelleemmeennttss.. BBaasshh--55..22 wwiillll llooookk ffoorr aanndd rreeppoorrtt oonn aa kkeeyy nnaammeedd @@.. ++oo the ${_p_a_r_a_m_e_t_e_r[[::]]==_v_a_l_u_e} word expansion will return _v_a_l_u_e, before any variable-specific transformations have - been performed (e.g., converting to lowercase). Bash-5.2 + been performed (e.g., converting to lowercase). Bash-5.2 will return the final value assigned to the variable. +o Parsing command substitutions will behave as if extended globbing (see the description of the sshhoopptt builtin above) is enabled, so that parsing a command substitution con- taining an extglob pattern (say, as part of a shell func- - tion) will not fail. This assumes the intent is to enable - extglob before the command is executed and word expan- - sions are performed. It will fail at word expansion time - if extglob hasn't been enabled by the time the command is - executed. + tion) will not fail. This assumes the intent is to en- + able extglob before the command is executed and word ex- + pansions are performed. It will fail at word expansion + time if extglob hasn't been enabled by the time the com- + mand is executed. RREESSTTRRIICCTTEEDD SSHHEELLLL If bbaasshh is started with the name rrbbaasshh, or the --rr option is supplied at - invocation, the shell becomes restricted. A restricted shell is used to - set up an environment more controlled than the standard shell. It be- - haves identically to bbaasshh with the exception that the following are + invocation, the shell becomes restricted. A restricted shell is used + to set up an environment more controlled than the standard shell. It + behaves identically to bbaasshh with the exception that the following are disallowed or not performed: +o changing directories with ccdd @@ -6752,7 +6788,7 @@ SSEEEE AALLSSOO _P_o_r_t_a_b_l_e _O_p_e_r_a_t_i_n_g _S_y_s_t_e_m _I_n_t_e_r_f_a_c_e _(_P_O_S_I_X_) _P_a_r_t _2_: _S_h_e_l_l _a_n_d _U_t_i_l_i_- _t_i_e_s, IEEE -- http://pubs.opengroup.org/onlinepubs/9699919799/ - http://tiswww.case.edu/~chet/bash/POSIX - a description of posix mode + http://tiswww.case.edu/~chet/bash/POSIX -- a description of posix mode _s_h(1), _k_s_h(1), _c_s_h(1) _e_m_a_c_s(1), _v_i(1) _r_e_a_d_l_i_n_e(3) @@ -6783,15 +6819,15 @@ AAUUTTHHOORRSS chet.ramey@case.edu BBUUGG RREEPPOORRTTSS - If you find a bug in bbaasshh, you should report it. But first, you should + If you find a bug in bbaasshh, you should report it. But first, you should make sure that it really is a bug, and that it appears in the latest - version of bbaasshh. The latest version is always available from + version of bbaasshh. The latest version is always available from _f_t_p_:_/_/_f_t_p_._g_n_u_._o_r_g_/_p_u_b_/_g_n_u_/_b_a_s_h_/ and _h_t_t_p_:_/_/_g_i_t_._s_a_v_a_n_- _n_a_h_._g_n_u_._o_r_g_/_c_g_i_t_/_b_a_s_h_._g_i_t_/_s_n_a_p_s_h_o_t_/_b_a_s_h_-_m_a_s_t_e_r_._t_a_r_._g_z. Once you have determined that a bug actually exists, use the _b_a_s_h_b_u_g - 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 + 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 _b_u_g_-_b_a_s_h_@_g_n_u_._o_r_g or posted to the Usenet newsgroup ggnnuu..bbaasshh..bbuugg. @@ -6820,10 +6856,11 @@ BBUUGGSS Shell builtin commands and functions are not stoppable/restartable. Compound commands and command sequences of the form `a ; b ; c' are not - handled gracefully when process suspension is attempted. When a process - is stopped, the shell immediately executes the next command in the se- - quence. It suffices to place the sequence of commands between parenthe- - ses to force it into a subshell, which may be stopped as a unit. + handled gracefully when process suspension is attempted. When a + process is stopped, the shell immediately executes the next command in + the sequence. It suffices to place the sequence of commands between + parentheses to force it into a subshell, which may be stopped as a + unit. Array variables may not (yet) be exported. diff --git a/doc/bash.1 b/doc/bash.1 index 24170efe..212c362b 100644 --- a/doc/bash.1 +++ b/doc/bash.1 @@ -5,13 +5,8 @@ .\" Case Western Reserve University .\" chet.ramey@case.edu .\" -.\" Last Change: Fri Oct 6 16:41:20 EDT 2023 +.\" Last Change: Wed Oct 11 10:23:34 EDT 2023 .\" -.\" suggested by Bjarni Ingi Gislason -.if n \{\ -.kern 0 -.ss 12 0 -.\} .\" bash_builtins, strip all but Built-Ins section .\" avoid a warning about an undefined register .\" .if !rzY .nr zY 0 @@ -518,11 +513,7 @@ command (only \fBin\fP and \fBdo\fP are valid): .B .if n ! case coproc do done elif else esac fi for function if in select \ then until while { } time [[ ]] -.if t \{\ -.lg 0 - ! case coproc do done elif else esac fi for function if in select then until while { } time [[ ]] -.lg 1 -.\} +.if t ! case coproc do done elif else esac fi for function if in select then until while { } time [[ ]] .if t .RE .SH "SHELL GRAMMAR" This section describes the syntax of the various forms of shell commands. @@ -4375,9 +4366,9 @@ This is semantically equivalent to (see \fBDuplicating File Descriptors\fP below). .SS Here Documents This type of redirection instructs the shell to read input from the -current source until a line containing only +current source until it reads a line containing only .I delimiter -(with no trailing blanks) is seen. +(with no trailing blanks). All of the lines read up to that point are then used as the standard input (or file descriptor \fIn\fP if \fIn\fP is specified) for a command. .PP @@ -11638,7 +11629,7 @@ specified as a set of options to the shopt builtin ( .BR compat41 , and so on). There is only one current -compatibility level \(en each option is mutually exclusive. +compatibility level \(em each option is mutually exclusive. The compatibility level is intended to allow users to select behavior from previous versions that is incompatible with newer versions while they migrate scripts to use current features and @@ -11980,10 +11971,10 @@ script. .TP \fIThe Gnu History Library\fP, Brian Fox and Chet Ramey .TP -\fIPortable Operating System Interface (POSIX) Part 2: Shell and Utilities\fP, IEEE -- +\fIPortable Operating System Interface (POSIX) Part 2: Shell and Utilities\fP, IEEE \(em http://pubs.opengroup.org/onlinepubs/9699919799/ .TP -http://tiswww.case.edu/\(tichet/bash/POSIX \(en a description of posix mode +http://tiswww.case.edu/\(tichet/bash/POSIX \(em a description of posix mode .TP \fIsh\fP(1), \fIksh\fP(1), \fIcsh\fP(1) .TP diff --git a/doc/bash.html b/doc/bash.html index 51bb727a..6612ca2d 100644 --- a/doc/bash.html +++ b/doc/bash.html @@ -680,13 +680,7 @@ command (only in and do are valid): - - -
 !    case    coproc    do    done    elif    else    esac    fi    for    function    if    in    select    then    until    while    {    }    time    [[    ]] - - - - +! case coproc do done elif else esac fi for function if in select then until while { } time [[ ]] @@ -5497,10 +5491,10 @@ This is semantically equivalent to

Here Documents

This type of redirection instructs the shell to read input from the -current source until a line containing only +current source until it reads a line containing only delimiter -(with no trailing blanks) is seen. +(with no trailing blanks). All of the lines read up to that point are then used as the standard input (or file descriptor n if n is specified) for a command.

@@ -14605,7 +14599,7 @@ specified as a set of options to the shopt builtin ( and so on). There is only one current -compatibility level en each option is mutually exclusive. +compatibility level - each option is mutually exclusive. The compatibility level is intended to allow users to select behavior from previous versions that is incompatible with newer versions while they migrate scripts to use current features and @@ -15007,9 +15001,9 @@ script.

Bash Reference Manual, Brian Fox and Chet Ramey
The Gnu Readline Library, Brian Fox and Chet Ramey
The Gnu History Library, Brian Fox and Chet Ramey
-
Portable Operating System Interface (POSIX) Part 2: Shell and Utilities, IEEE --
+
Portable Operating System Interface (POSIX) Part 2: Shell and Utilities, IEEE -
http://pubs.opengroup.org/onlinepubs/9699919799/ -
http://tiswww.case.edu/tichet/bash/POSIX en a description of posix mode
+
http://tiswww.case.edu/tichet/bash/POSIX - a description of posix mode
sh(1), ksh(1), csh(1)
emacs(1), vi(1)
readline(3)
@@ -15273,7 +15267,7 @@ There may be only one active coprocess at a time.
BUGS
-This document was created by man2html from /usr/local/src/bash/bash-20231004/doc/bash.1.
-Time: 06 October 2023 16:59:04 EDT +This document was created by man2html from /usr/local/src/bash/bash-20231007/doc/bash.1.
+Time: 11 October 2023 10:25:11 EDT diff --git a/doc/bash.info b/doc/bash.info index 91dec38c..63823577 100644 --- a/doc/bash.info +++ b/doc/bash.info @@ -2737,8 +2737,8 @@ This is semantically equivalent to -------------------- This type of redirection instructs the shell to read input from the -current source until a line containing only DELIMITER (with no trailing -blanks) is seen. All of the lines read up to that point are then used +current source until it reads a line containing only DELIMITER (with no +trailing blanks). All of the lines read up to that point are then used as the standard input (or file descriptor N if N is specified) for a command. @@ -12918,95 +12918,95 @@ Node: Filename Expansion104026 Node: Pattern Matching106956 Node: Quote Removal111955 Node: Redirections112247 -Node: Executing Commands121937 -Node: Simple Command Expansion122604 -Node: Command Search and Execution124711 -Node: Command Execution Environment127095 -Node: Environment130127 -Node: Exit Status131787 -Node: Signals133568 -Node: Shell Scripts137014 -Node: Shell Builtin Commands140038 -Node: Bourne Shell Builtins142073 -Node: Bash Builtins165462 -Node: Modifying Shell Behavior198398 -Node: The Set Builtin198740 -Node: The Shopt Builtin209711 -Node: Special Builtins225846 -Node: Shell Variables226822 -Node: Bourne Shell Variables227256 -Node: Bash Variables229357 -Node: Bash Features264422 -Node: Invoking Bash265432 -Node: Bash Startup Files271468 -Node: Interactive Shells276596 -Node: What is an Interactive Shell?277004 -Node: Is this Shell Interactive?277650 -Node: Interactive Shell Behavior278462 -Node: Bash Conditional Expressions282088 -Node: Shell Arithmetic286998 -Node: Aliases289956 -Node: Arrays292847 -Node: The Directory Stack299478 -Node: Directory Stack Builtins300259 -Node: Controlling the Prompt304516 -Node: The Restricted Shell307478 -Node: Bash POSIX Mode310085 -Node: Shell Compatibility Mode326339 -Node: Job Control334584 -Node: Job Control Basics335041 -Node: Job Control Builtins340040 -Node: Job Control Variables345832 -Node: Command Line Editing346985 -Node: Introduction and Notation348653 -Node: Readline Interaction350273 -Node: Readline Bare Essentials351461 -Node: Readline Movement Commands353247 -Node: Readline Killing Commands354204 -Node: Readline Arguments356122 -Node: Searching357163 -Node: Readline Init File359346 -Node: Readline Init File Syntax360604 -Node: Conditional Init Constructs384626 -Node: Sample Init File388819 -Node: Bindable Readline Commands391940 -Node: Commands For Moving393141 -Node: Commands For History395189 -Node: Commands For Text400180 -Node: Commands For Killing404155 -Node: Numeric Arguments406856 -Node: Commands For Completion407992 -Node: Keyboard Macros412180 -Node: Miscellaneous Commands412865 -Node: Readline vi Mode418900 -Node: Programmable Completion419804 -Node: Programmable Completion Builtins427581 -Node: A Programmable Completion Example438698 -Node: Using History Interactively443943 -Node: Bash History Facilities444624 -Node: Bash History Builtins447632 -Node: History Interaction452720 -Node: Event Designators456530 -Node: Word Designators458065 -Node: Modifiers459927 -Node: Installing Bash461732 -Node: Basic Installation462866 -Node: Compilers and Options466585 -Node: Compiling For Multiple Architectures467323 -Node: Installation Names469012 -Node: Specifying the System Type471118 -Node: Sharing Defaults471832 -Node: Operation Controls472502 -Node: Optional Features473457 -Node: Reporting Bugs484673 -Node: Major Differences From The Bourne Shell486004 -Node: GNU Free Documentation License502859 -Node: Indexes528033 -Node: Builtin Index528484 -Node: Reserved Word Index535582 -Node: Variable Index538027 -Node: Function Index555158 -Node: Concept Index568876 +Node: Executing Commands121938 +Node: Simple Command Expansion122605 +Node: Command Search and Execution124712 +Node: Command Execution Environment127096 +Node: Environment130128 +Node: Exit Status131788 +Node: Signals133569 +Node: Shell Scripts137015 +Node: Shell Builtin Commands140039 +Node: Bourne Shell Builtins142074 +Node: Bash Builtins165463 +Node: Modifying Shell Behavior198399 +Node: The Set Builtin198741 +Node: The Shopt Builtin209712 +Node: Special Builtins225847 +Node: Shell Variables226823 +Node: Bourne Shell Variables227257 +Node: Bash Variables229358 +Node: Bash Features264423 +Node: Invoking Bash265433 +Node: Bash Startup Files271469 +Node: Interactive Shells276597 +Node: What is an Interactive Shell?277005 +Node: Is this Shell Interactive?277651 +Node: Interactive Shell Behavior278463 +Node: Bash Conditional Expressions282089 +Node: Shell Arithmetic286999 +Node: Aliases289957 +Node: Arrays292848 +Node: The Directory Stack299479 +Node: Directory Stack Builtins300260 +Node: Controlling the Prompt304517 +Node: The Restricted Shell307479 +Node: Bash POSIX Mode310086 +Node: Shell Compatibility Mode326340 +Node: Job Control334585 +Node: Job Control Basics335042 +Node: Job Control Builtins340041 +Node: Job Control Variables345833 +Node: Command Line Editing346986 +Node: Introduction and Notation348654 +Node: Readline Interaction350274 +Node: Readline Bare Essentials351462 +Node: Readline Movement Commands353248 +Node: Readline Killing Commands354205 +Node: Readline Arguments356123 +Node: Searching357164 +Node: Readline Init File359347 +Node: Readline Init File Syntax360605 +Node: Conditional Init Constructs384627 +Node: Sample Init File388820 +Node: Bindable Readline Commands391941 +Node: Commands For Moving393142 +Node: Commands For History395190 +Node: Commands For Text400181 +Node: Commands For Killing404156 +Node: Numeric Arguments406857 +Node: Commands For Completion407993 +Node: Keyboard Macros412181 +Node: Miscellaneous Commands412866 +Node: Readline vi Mode418901 +Node: Programmable Completion419805 +Node: Programmable Completion Builtins427582 +Node: A Programmable Completion Example438699 +Node: Using History Interactively443944 +Node: Bash History Facilities444625 +Node: Bash History Builtins447633 +Node: History Interaction452721 +Node: Event Designators456531 +Node: Word Designators458066 +Node: Modifiers459928 +Node: Installing Bash461733 +Node: Basic Installation462867 +Node: Compilers and Options466586 +Node: Compiling For Multiple Architectures467324 +Node: Installation Names469013 +Node: Specifying the System Type471119 +Node: Sharing Defaults471833 +Node: Operation Controls472503 +Node: Optional Features473458 +Node: Reporting Bugs484674 +Node: Major Differences From The Bourne Shell486005 +Node: GNU Free Documentation License502860 +Node: Indexes528034 +Node: Builtin Index528485 +Node: Reserved Word Index535583 +Node: Variable Index538028 +Node: Function Index555159 +Node: Concept Index568877  End Tag Table diff --git a/doc/bash.pdf b/doc/bash.pdf index b9d9393584b5cf716a1bd7a06b82cabeda9ff268..d71ddf31732f5a8f0a7cac17d92a7d6c2a398483 100644 GIT binary patch delta 14676 zcmZX51yt4Fwly8n-AFfbItb~K5|EVcmPYa*AT3hTf|PW3N=hS2OA3mlQqtmg{_nnb z?{|-kamIkfI(yGG_gr)BAB;2E&oJ4~P^-*=4Qf!~;H5-;L=X|?Ly^e=s(gFuC|PwK z*}@hOD2DhcR$C0V0YhbQE7r>w+wCTOPY&r_PjG^DRvwRMISRc7n7by%k}B*`5od0h zAGY;BQIGanFY=p^h<-JH>|BT{{PU)I`Js34i`8zQYpXT4?7L@!xEB3up4QKcp38;n z_7Cc+vj(o9DyEW<0mGG(mO~G!GFkw4MI9bPzAfjbG9{d@=$YOgt!k&~yXr6b27g~j z{Z*|f39-2&%#2s=_@i1Y({F`&Uw)PdQxI-{8I}K8 zbH5OtExaPkw{Rj!OZW_R;pY``@7zGTlO%~^hP_l{5+(U&Hru)J(wolm!Nt@B`CD3f z_Njy2Uqg96^lw+7SMBEW+q_4-gcawNRvP*R?`DRq^$(0s=PP%g-JWHxnfytBNt@%- zGQtBXA5ZVcu{nLbFypci)&}LE!}_=TPP+2ZbL!7)8f5OOB~ls*K;$H+yviEai=I zeGo^0yB!3gYF6oZ8+KYMC$cwq78tX>Pg*tE+KOs{@-ql@H=km4V7->{50>ohTPhG~ zSDvY@tg4{bVw`2sv}#*J3=XW;%oy6nJ4%}V^tPH!*!wy}K8Zv*`)<#7OZ;NnC~^B7 z;=;_k4jBm9UI^Ejuq;WDkG4t|R1Z_A?ncszx->a;y!~J~L0!Z>7lX^no3u4|igNf! z|45!W(XKj;bgim8mGofTh=Uv`=XWq!>9{_tNd4$K!uRgP zP^PC+WgP9UkL_lqAA978$(J*mrx&l3tV%SnW@vcIHlloS(-Sq$`RyCWK638SiWVg3 znm*E$p95q^Gzn+_c--vO-cq;<8>u@fjve8%|0cH45c;@`&2K&B<1o`bw#Pob-7>^y zV7uQpMlSMZP5fyL<_ihRALaMD-CRHoF(yhEPgMb{!-3=C_iDjJ!i!_Cn^$|mFJzG_ zN@jBFeFrE>K7)pf%WKKctIOkO-LHR2k(Vj!ez+!}H2(Slq1Z5@;z|u_-{GTRz9G`& zwojAw{NZhEmjnmD#wWG^?P*c+iaJX2dFs2F?NlhGVy_5S_l3M-j9`K;4R6*DBVC)N zPXor3T!&hlX5ur(+{KSe4_aIeyo33TEz^ErsnNHga-)a#c{C@-@gfPduVwLqoE~Pa zPqlzy)4_9H1gRpnBI}|YOJB-KW%*iTN`|6hUOHY#ZS?o#;q~WJ_eDwN#HZ1a6F$pk ze|baM@m;Z*Q-wR0FGn|#x-9~lJUjcn`^SQtD_n3uLn<)2f&2xJmYJ4D^+;q>@ZzHA zCoSYYstq@xNe;PDyy@b6Z({~$a`bx{{tFLk%{XEbC+xk_S_{`tLSOWH_lV?V_JZQ6 zo_bfp6^gx?wR=`Mbju}N;U0JdZ!@?NGb@V7umf)-XDXI2Q1*^Tj{2+$g>+!0)AR0n zI#sCCJloQAjzQ63nXp+oUT+pp=88^dr_6jk%JW_G)w55jFvks^m4`oF9|*T_u{~*D z&vM-5BfWn%ErSc)d~;2_VU`J}5UAl~;5r=8<+p#)Nwhiz!gt3hGcVt~TwH8r?!P*lI8@rcXX63;4=KFuqV(R4Az4i1AX=%P4I+I^NLk_ zqxP33bN%*;9L1|=8{@N}P>$@|Aa@n+l}y$rwD=yHC6<&N9|x0A%oMCQWi!dob++Ew zZ&v%)s1$l6F!+ZXd=;{__iMKqAt57)TU%D|yPxrC-sR*pY<~11F*3fC-~KT~MVCX+ zCUI~FPai!bGZ|DGo9hB)Q{1pJDO)lzGbt zzAiH~6=4gCNGbavMo+%o%5G=+X8U5EqB1O1&p+&<1++*G;z~Yz>zO||9+j|Xjambq zv?23a@MufEsIS(G@PZ5^XpnjC&1F6NB-)fN*;mt)(`@^0wS>=g3OT>2o;nOGrLL^a zTR56(|4?VAR9FuPQyuF4HExIKX4n*n=j(qfNdBi$^0JuLo}EaARik)JEM9@=!KdC7 zzLBSj-C2iN{om4}U1poPSakznwJ7|}2UctgR;O^=s>IQYquS~pU-(R)Q6wESrk7QF zZL!-J5Rpj*7uxw$u~5#HiHMt(L+Z*#-T~^rIB|324qaO4lN7}BExJ|~ylj^4l?&Bm zs#!Q9>C@Tp^La;K`W~nz??Wjs1TT6MKu(3o5RPu@4zHDCD#ntJQ>UZFeum0t+uT0x znw5Q;_>3O<_Sx6jx6i~;g?)uXOxXuHyC42Iwmq27OY6ePk2_b?KVmtGh1ZWQGc03s zrjS0+>M$Y#Y<+nhx}!m|x`w}MZX)AH{_2CApR}s-{VD!B!N|ky6yYn)m{(avihn!m8A@p8t~?tU8NQR^*4Y2gJ4NB{Yr1i*We(ted{;wJO0+Tw5F`;M6@BM^Zw4jRJcG| zkujev<6is2iNdcgL7wFyN?6}$*Qtmotk}S#IH6y@uh(+$mK#$OTa1=Tql(QEL;X%R zcG`x%@8WlSHq+{=pDGGX{9U+`x;T)YyjaAGUqL6*VLV(Pd}z(BOH5~e)2?qwfUqSL zm@$2td%kAJOSwJ-{-(&B`0Z-Lg7>!gDs53k|IFfBUqJ2!7Cr%CnP&ETI9HFQ_pPRy z*#-}y%Yx_T)^t0-2$wHL0wrV)B^E7yb2-Pl)*c_yQ>b$AdQPpJ>Qk|LpFeZH*h?kP zV~%ruhd2g{Xr(du?tYl`aSWWsI)nmsx_foBv7(a(r%j8ni?4tk)!|lony-EMgs}iH)>}2EomB-*I#5if99avVIj;J zP7iCV!z{KEvzViIEY03(%J0~BYB%wjbZFsgtjIlU$+u;fvYdFO7e`tVx%xsEC#iX? z^43V=#@uP!m-VnBecr}I9uRW&TMVWAr2Z^aPW|2SuZE|8_T{q#d%~Ya6quh>Z;6Ez z*5rCxG7aYq2&J}Olj64V!+9<|!b3W)4tC$oC+LhtB@y7DU%2QOUP}@Ieitt`G+j#s zpC4rnZwf0&47c)4uXt_aYbV7pw(GnWd-LG7?)xF^tBHQXv_LekCk4fb*E{#Mq|l4Q zyc@s3PNHG>;h&cb-3-asBzc{!PnC05O&m%i0=j>u@Q@Dv%;pYVHVwL! zzAHwtC?<1RF+@ew4jwSJ@5$gq zH^<;=7N4Tpk30UaI3_zG?gQstZ``+wlZrEA`#OzNIz^yRf3?_H@2F1suX%#0vg`Pk z5Tm7JU5^c0ZI5Jl&a&EeMu1U{dg!xPJ>nK`Bdo?xo{ize1|&ru5C013qmHrw&3o2P!HOC6`oZQPu2-Zk-IC9(%7h0iSO2!os z-d{8r9U!DS+2~o%#fCU@dUNH!%1fj9=H8wow_BH4gH7W1J-5sU)2lPG#n<55W?r6zNqsk6b=_NHio#DeJsO>w4brjHc=z&EunYKlJ8sm%Gy_OO%hL`9>Jtxk%)a)Y!mYQ4<@iu^;b}3v{njNsI4@+iN|d7O18N*mCbd4I5OqdldA7+!KFDH40G<~=atjyyoR5f3FhE;tYuf>_&7ry} zZkb{GBlBB=*2$SWJ}KoSD0!<==3Vn%i_X%o%CmMSqSYs3TCb(_ejaGMkY0M z?>v5gy}>26(JQXvoCykalzhrztxe9vg+Nd}xAN^c$R=1R6&5@hS1Dk!OEuXshb0#{ zCJDvP5c{j%N*v~mIaPDR`&(;K3fl{QQt!{^jC~$4`y1`sOx#OWLz4+L=$fL)TSjGBm}xV?$>}a>Mb&P({a}FK3H* z1e1ca=Cp4H6`{Ws>gU*0ireV62!aNFY(_RpeOMK_sq+UK5FPcJ&)<$Kn#aeip6Y zmCDr;rup{ki*G5bi)3=MQ&0(awR}?G6mP!TzTDjqHF^HLuVb$Q&#aX9flaZf3boKu z^_C&)E|Fag!g57Wy$b-71noT^cc7Q|);Tz~D-lXB>D-BRHQ$PSA)6Wi)F2S4n^3Nu zTkbfS+g2A>SDMWJQMdDY*?175ACXu7J3(?j`LeoZ(2UC*kug`lTn(OQJs`lhNjk1_^*$(Udg?*>hAhcOs<0M;_RF7#I^xD# zx*h6&k`h7|JYNu>08t!mT+I5)TwNcqT9m_INU{(`>QN_Q^ zRP_0j+?J|DuEgdXd;Z2}>v-1vqXlhUJs(g4Gf83y<9#^^=Ii&m6$Ou+kM1@1$6!CL zjjoRb{V;Oi3QwtzA?2a4*05f)CX!35`aF0m(6zBZ5 zN;$V;Q`_=6S;(tWB9e#%$FX_&2*4Mm)OdyaA8%4k9_8Z*?zx&B3%?P)Zzh9uj@6Ig zVEjmG`Y>}b=V#1nwcC@AH&YktgAT%L?+x86s)XkDJhT@JUyP$9!<(d#eQ#7;w7Lvp zIMg^9wAAhSV{oIERU&v}$P1GcvO(7=aC0+rt(fNb`wAI5wog#bOzRbgE-1NIO^~Sv z;#g4b@}fE9zT=+CnfH(QADkuh&{K7dWg=mS)*aZH7Gzo~fv*O@BNrHB9R6jFLxAP6 z)8`QBMy>t<1T88{knY0&aWvqO6hGEnBWQ<45a~c0;Ft-N@mxulz@aMC1PXLJFcpx7 zpIY{o@-M*r$5$9dw%wZj8&Y2b#65vHU%H1PU$|fFB<4Tt)u7}1^ZL6)2Yr>AgHvlo zOF>j>MQ-#ZmYU%lpoLIAXSXu3x2wU(^<_wPPRdNM-xkVZ)bg{g{zb%VwKFQ>e)W-w zhcoHVDTR5gX37+SAlf%FlImyQ2-yv>X#m@L=jE0+s}WC`d_c~#Pp_vhnzApzDL|d% z2Pe;FzbvRl=FN0|w5GIFN)Qe?-r7UOJjkQ08CT0}s1Z4RRz>`Jhh=lGzLzk7n~!^m#O6qN7A<4GZB%8QR}LCHrkF_4qG!G87Q~a#je_Lgv&b2FQWgrHzdA zlLxZ1G*AOUyGD^ink9jha%s07%d|l)CB02VjvP&N!(c~vC-q{{PDP}ARjKJwfv>IoIgl%I3S3qOEi&GabJlAS$wq@RF^p(*xc_W8dZ0 zpi(?#qgutpfOyCd4*+aOnX`;&$qRlMseMpc@JUrVVF&N0MpPP6hdZOXfHHeEgH&Ps zVYNe6toV#18Aaaqd1=s4wNqFDDA)R%0ukU1*am=?Zloi z-NRuN*!0s#r^o}=SiSm6{y@kxhRo%sh}SOrI|cQJ7bohk8_!8~;TbD;UoqGuUPKZ~OD`+J^{Dfr({L zfWjWIftBLx@>SjX2R*kN)yNy*VuVqFNY+U!>MawyA5nkP^apG1@%TP$fJ#LaUUX#OwF_@QxP(R*=AlqvZy0)s2JNXZ=cp0Bfga^I9|Ag+S%q=meC3cRl za|ZvzQFwk?Mtls7jhpSc^~$}tX)g+cV+j%^DdSKorTq#sJ}tW(iM+6A_=Rx~c2e&- z7WWfptunq+c1>~7tMGjDn5-|-N}C+eooH0F8U0mpB+n6->XoneM!Tn`NMIw$d=jX9 z`QAkr!27r~@L7P;Y4}W)1=yW4rrM&=kp93!Ak;!i2-M{BmUAyZ8HZl%HO}_0^B7Lw_LT1KcoVy8){h_btBp4H0s#?JK1|(f~ zL`WHxnK1uzgJOzpTi4?CD`u~I?9PfQOFNY%GQAst+eGlS^iCe^^w@c9tb>yT}yI1p}zI4(szN?b8ZB8FoP$fyEzC@W+mPu1cP+H|b z_G#{Zde-4o-g%KJNrbyJ@K)Bzxv77k#aCo^(x-B~Z_#aGY1Vx8>V8Q0!!E`7VBm_^ z9qNbN=}`;f{;8;5ldJv4CwwMHD>FYy|0pHeU&09kD}?3hg6i6O>ZG+~m9`#Sq4Xn+ z_KjAmZ^h9Uzqw?#D*UoLCU!RDL3aFtR`xB-4;Bc1O)jbg`>RoKPC3QB7SIyQ8N64r zBWRS_Vt*)F5yvpr**?iOXtsZ6aaIJ*>0wq%{^n7ODek+^Vg%gmwr7D>xHlZ12@9|^ zb_v{~j&hxeW`$cv=EX@97;3utGvK;OM9bqPx9iiUjn{7)qUVA48|lA_p#WRp-oPx4M! zINI)u2UBq{Za7Y)`ct(6Rt=e`TtvLBKzy!2DPkNy5JQ>#O4@V$JU7s5W&NRJYh zsrUKkR-=E;zQ?jjxR&(UX;9IjSlfwxm-CaKw9r-Ub&5EpGL){0?!Fz3b8ghAIE{og z%Ebvyv>WwdNyNBjHCi;h5fPm#;C*SbZzM8Sn(iIrHX2)CM*Mqq}u2 zs6pm%w^~r?&+P2JQzYR1_AcYHw^&pMxo`iMi+ba7I>|ST+GBY|0}FZjsDh&qoftmX zAsypy6U?1_A83DuM8rs!jhT{xiquQgkbImA6akNS(!d*=2u968B?G;HpI4^5cVWO|$ylsh@u0bX<9(br(;JmX;f8c<@9R7c|qhCnn^=cAWY9{NpeS57NNCaQM<*K>@oVQ zRx3F-tz6R7WxFsyt>MPn&QIXOu;v2yvqla4PgoT2+76>;!x9}S6n4UmjJX5lMx&7c z5ssysnlOy+Vs$ot!#OCdUPqPS>EzyK%LuVBefUG&KK+!Kdjr)tWO#iwJj>HUYR&;Z z@kyTxL_8Jo2wj#yEIS|Qf^A&x6m!k1)3SM564>3psl!qbCZih2Fa!`azABCsA2skSjoo|65+xi)#%3Ro&HR&}^ZBbY(GuJI&bY;pH;GCUq>03mV(!kX`w=Pb zAIu+q6LupqW71gC&(89M)PFh_a@Dn7_b&TL@h#F>Ac|@}+q2F>-E_j~L7QFrBaY-w zAF%u(2TWd&)2Sp550D1j^J#N6B#0)~a^h28x4IWWz`c*WLyqz$**_*j03R@X3g_(e z5Al>yJ8*D!Or4LWAD2(#FSYAVg;lz(r>RyoTe4KEo`mtbcgPiB%boKqV<=Ul+0 zEXsLIwG11_>ygFvXtS_;s48^~jQQOgN@M3}k+GRYJL`NWq~S9ill3d?fGuUkMThEI zoo9gessgXRed$4^Jmi{yGfvF2_F%<{N@AbRToZ{@NN?d^JeUilpnN4+oXP0`a_jR-RQR48Rr2$1FkA)-(k6nZ}G;H-(ltM5u&J&f7 zeCvGgz92MTd9Z7WR6Ov)8W6taI!KdoXQGC2#f-2;(fcj?22o8!bH^TOG=6@IH?jTD z@A+io1U}^J){hc=qv0OSP>X5NBK&)o!s~8qc`xFvN!!DE{p{0E{JwwqZogJAW?)}q z&aFFu6-rcBiDLDxFmlg#$-=8%GB*?n=(ciXsxO@%)Cc2L`{wzOIDIGU8bstnIX)+L+{mP=4BD9XCLue9vA@2cSUU|4@Dp#Ci4pZ_$^OD9Y zgQ#o3>2r|}(fwFDVy%st?;Y#($AU9G_Wk;JDS-j9y{IL}7m@C&#t(X-rB1erG6 z>c3xRkh10EeI}&NA@)n|PpVi6ii4{oz^aSncbi~fxZ^bU>aJF2xoci&A7PJQB|h=s zX;h~WiP^IgJN&T%y*5kB&~wpNJLZMof(rbTUMym!RAREW*5$EJTS`rv&ztDV;9?X zNSmPBeL}%-i*6#TepC>*e7pE)<)Q<|sMmdaf)Bq} zKcp~rOddcqdQ%xeb#Z-JREAI*3eYhQ%0hzq7%o;Hb70m{&?lb->WOR3$lJxqGClr> zt^Q^;qKA+4Mf2D8xF*b-jxHP0{Cz@@D39B#eapfRt2h0ihs}-R4fl7;Mo1`oatMX> za-&hL2`|H2OTtUiYeKYH$s}VUg4A~Jr>mE^c?}nxWHx4<)J+cTYKrk2eX43QwsrZF z^I7re%EDO=C)`s9CuL4ZHuk=ofVKJe`)p(bC4`0U#(S~`HdSY3IzYsoO4pD@Xj*V2 zkPl1c{+%2TJ{u+$zPSw1F++(Py#U{r$W1e+X0B$D5k(=9+haZgqhiF&U zwIGF)2GOY>;l6-g#s!5wXH5SHtzCDX&X>@%ymLvJ=R+zuIhyJDW_nj4$H?{@9?C4~ z&ksLZ)N<)&Xh{(#e#*19028D5^pgp^!m*Cy;E5#-88N%5vD|A`_d9+RkJvZbR8D zlf<;&Ev`x*hUol85BrCT`1{{vJm+2fP-LH*&YpUP<=$N5{eJQL<_a&EOxmabb&S{4 z-@~Mabu1X6+i>}o(WhVpV%42TJ5V&+=P~xn@J&Grq{DoG0z1Npwf63jkxAvYZ~qT} z@9UQg7#0F#C~!#Cbxn`hiZ8dUN}YSiB*EE9J5`NZQdd<*Y&S4;U}f zCpp~gS$i{5_{!f|50*J&Deus%I7r$AO$m@iWIB(Zr(}T~s~(;J3fiK$L-OwmeQ!%Q zHEgoznDQ1=hA=Nit!kC~bqY>SK0^6dCLyzUJ`-ChH_MqWQLdz_iO;(F*D!}YXh2nw zvkb|B0;o&3em73%wKGrjlkZ%5j9rV>e^`7+)Z~E`3x5+q2O#7(b>q^U4v0Nhl>jbKYwbrhU zCJ-gNlp^h+U-3H3ACDD!=KYFHQ(-|z`zLMu-9MT#5)4CbJV}`pSim3M)R4fCqu=LR zYe6LRr`Wr#)p2(A(yyidc!Y!;+0h=fWi;w0FAP#WQrI<|e<8>E>q#|fc55G7b%LI? z!&6HQr_UN9K7)ZiSROsui`Ba*Tge5pFxm%^J)f*h9Yd_Tfd2D-5Pvb_aw?Cdgj=?$$@`iYL@uFxE@7pk$F zWHd^{F8Q8#8fyhyUNX5XNbj36&o?#c&1p0Q2L-gRh&qwdIeM7B>JYs*sMoJRc$9N< z)hLp&1iG5$QBNMwDB!6(e``8aKQdS->myG$sAi@{XNA^2hD9de>MNlI{^vGQ;Kt`Bt5!c!b@0<2q?wOc@wUyE8LP# z^G_C8f4iUdfBb`G-;NWula786qiI<+#y=+`0s?^m5CjZMUva>f`1emO9FF)APV_Jc z2jHJC4mXZF|MLwH1cxKi+o$n0Q7|~>?_fv-5F-WxLg9bMU%#EQy2oRGQC=d$5WCjXBA~1`CLIFq=?EgoD1_MQap_r(l2s8~Cc`y+4 zucL#3V1FGQ3X2YK5L1LmFyb#TXqh7rC=6PW z2rvMHYBUEx5C${o7zm631_(eijR6K7gJ5dmpH4;opSDo{+mh%Y1e1OsT3a9ts?jkJ z1cPcI5DA3*--7>M4+(-{f(C&>K#cWJ=+eMo%mqPkAQ*E&5F7;kYe6JhuK&#-5QKyw zF_{6Q{RT4+?EnZk$3Ok|A7cW7VGzJyZ-zlZn6&;w3`QkrvcL$;LLd+X9HSM15Ogd4 zyExRp91#dX0O6P$Ll7V&=EhJU7>?1NK(q%SF*O5)f-y}B2!%p0g$_hPk&wSAgd(AT zQHa*jUs`~n?FVF0j5CMVxwFv?N1^g%RfAbKqzqEh^BLAuw2}1W1hA@#( z_+LUtqR`%oDI_EkfN3f~B)Y{g^Z^0@VE_zf&@nisNr34>SMp|9|v@ z0PufW;=eiq1VErat%4B)0{%KrbiFVThWbH3FaWbl&@tfuKZyS4{L!ueg8jQC{?!ra z7#MTDgFxu{gjw-FG+=@TLC_Nh12hN%M`8j5AyH`Hn2AU*rqa`hy8;xGesnYa%c{}!|C@dY+8;3&gunrq?TIb~Ee8zH=$ZeQ7N9`bUjU(C#D7i7 zfA~lHDiVQ-8VZMDsucu9Uve<>V4%O|1_*sOz`QkqU{G{}Vt|H0(fngBh`tA4`aF6Z z0RGYk918ghARKLRf31gv05RGa1V?Z2FCG2o{s%&Uk(ibV`sZ$dNi_n29=;frAP{Kt z$A}?;2pFbV(O&W2Hjm~XJ+RQGj`?OZhZt>#{@552Q%GO{ni-6Z(U)5!5`zWw-4+PM z01ZYf3yAtV2*JFmfPo;iyZ$#obPR+!Bf#ieI_3ox9YX>z7z6{+_V~X?^6&c}Ita#e zJunE}$QXT$jzKZUEEohu`y&QG5DbVp%EABK4gR}e6#7X3i2z_y2u43MV4?;?(e8t> r33}H31rUrtFNl$c9+ZErhkjZDKm{-p(Q^^A5(pdufv3}d!EgP48?+G4 delta 14672 zcmZWu1yq!6(FzG2yQO215|D0?E)f(70qI7%rCS691W5$}|9!vz zi}zhQXU~D*e(ssM=9+8ffw3N%u^yUgc@|7~odOFd8S)uiA$$Uk|8_8mGL+KL_KL_N znUJn6ElE+uf6k%v6OJSEgHB8K<_8(y>04!&S~c2?i3zj%Khr3akcBx$_ear}Y~oI4 z%1CWq{s=l;XP~e!<^Ia}gOu%S{WbO1wOxsFei)_c&k!IpVJZv(E0x5_h=(I@2rcBb-e&d#m<8>OAzzmBifKu&S9DEpk5_@2dVzYE z-a$AEspnO)qHb1u0*iPRrH56@s&jC&)+>68x`#X`p?Ja7qY?|a`ds9Sn_=25Jk9>3 zYC^$)p~1LNl>>@-nmDVmC$^;H?7tA z)Wh1`nb0?9)MzPw`NO@S{CDfpPtGu$-^%RKWgJ~$(jbS`wwbR}e-B8M`BL#}u7Dfv zSqZHQ3J>y8SE`wokMl^1Ukly}#Oq^T(ca!X{Sv_H|KVivSLOKb=(f_RQuWR+ai#9W z-#(tJ1&PQUV9;M*v}MCOx){3IJI=a`Yr#yCE6yZg7z zazgGb90tg?S5W6u!kbbA)2aVlVaN74##!Uh_4bv|`^!r{4wet%*b>>~`S}{JxxQ-` z(qBHVqAw#6!e?_oKr-0HMOM8z(nJ=N7t3lNO|;u5IIa^@&>DB0KlkBa^db~x&ep4D zPr}=S^){J)%ba&#kEk}QiXZ7~thBtf8!`N(>Y9u^GZG-85MnV{(IX4DIPOp@Fqnby z$e+6{Pf0LKnOqo!4kKK(*DqzH zXWK8LPsw&98PPEvJu709!W{5nr*)<9@$*~AS=351)2|xm($KmABDP`X68m`WTvMr> zc_}}*3eJzw!h`j4uenBPOi}&`(w&rWvz&gUl9AZ<O_F$%drT2RZz}#w#t&_tQSl z?)SPaLAj?JBJxd?%^qZGP^y;9HCw6x0GK=TTB)A8T8I3xoJ&_56Hh5WT_&-?dFV?+ zi6U3z#o~=YuKS(+nsv5rG8}ZKArWxMp|?x~hoP{{IKg9}V$)*;X$$5Ct-%+u#&HuQ z{n!~(<`DPZgBA%PBNvup#aL{iysX0)`tM4-1Q{41sS7__Tdd-PcT1IR!;M3c4+$qr z@W$U^u zN0WXV5IYZ#ym5?dD6qq*e9NMxZ>>sOb>U|SW_I4&bB|;#E5Abw4>hqZBdq2#LZ*GJ z-Py=2*~k+8>~gMgfhR0D@j6oR+?jMEcCD3ZNzd!dRWjPV@OOE( z)EviCcB|3`0HSs2-je#NGGCpD@*V=xw}*?oXM-~?)o->ai$XdcJ)1$E4Y?-YXHX%0 z-lm|sV~XFbZ5pnCG2hqBbCUejMb6=J!7+^?auLFT;5nkx8aR6$Nhy~0xfGY|d++O0 zg+WkQd-11W=Mn7U*D6|H6#WYpUZ#Rv6pbdIvO-cuswl982BdIiQlA}iEBMGZi59hn znkcktKVHqLIbrkd8DQu{0(Anjls@OS07W9Phqz4KG5iR*#^AGp3vl;(6PK2>d0BFG<(7G7WHB3zk$#T{B5)F9zD+*t#cVx1rEE9{phd9ddIp=Ez zavmcu#;ERaZFBZoKgrY=spTBudomp8^;@V@!>)O;cm;V3GWu!(_iv14H5viMY#zWk2GWp^?i;wH<%PK+0n#Yo5&VbJ=GG96# z*_{=}MpA5b)K_^Y>LrE142cBw#H|*of5oSbk6t!&a+pyg_R_5d&Gm<4=K@9NZ5Zl= ztRA^Jk&kGr1k?m|ViGG=MJ99WRu@w~6So#Ev&o8ORoxapq2(fNCSrCn- zaq-ohPpp+RO7T)~us??OJZSF504-e#tmxQwi$%Roq`TT<9nD;PU+_j-_u`H8Yfo)c zq~AbzCCPK&^qnxIv0ynUPq#68M7(+9PAo>Q2Zn9$Dh~g%wey?oV!9pyoKNOhrOO7P z6=J@d1&^6#_r7*1SeIbNvKQ$j-rj)cMh|c`%DO7c1{Zp>XV2TdLGW@4Cb%$PXKgVf&-Mme+7rADc+} z;HHgB{a_j80s=atT_URwQfRN#D$<4^9}fe)8!Cf+)qY?S-VyR@V6N?BQ|`75K?EvF ze6lz_Nqfaf@{|9=M2-2q=2jtH-@G$tR(EsVS4$~aJfCc72fjJ{8n7l-p*4LV8T!SN zhh~6H^DE;iBNS<$w8!t@c$5B8W->>|d{>(K1-LW?prrG-+}zMZybZA+(G%i9{vA+) z7d=EPi!C|qSuI0Gm&X1Y13){IKP9BV+I%^9y_({A6KZOClESRdlPo=OJIOGlx~VLy zIyDgrB+N4v(pkXlt%54ohSNKjLACMI8+tdN~S9E*b zQF=F7AKMr4Bab`S2kS+TN}B34&Ami`xQ`?)H%rgR12{o|_fCTuG(_<_jxSMqS&6`) zz2;+Mt>)S{1ufZE=gIamRK(rO^-M~Xu=;2K*dZ_K ze}40M@=Y9)HnKNfo-wsecU3RJ+bTIpYNs^FwYFOXoo<`(bB~njj*#gdhS9e{ zF{PE6Px-PmmBG}7k|BD%tD||}Wj+VMJ+>4KyEF2ok()TjmuzG)hMbFY1s!JB^}Fib zZpV~U)A$z=dBkVxTN93sQZD4n$tOdLEJwRWq)|uA7r0((N&!R3sohBl8q(qYu*h~vyfpG}?waE?`?yX=?g3s_?pXyxE=9kgYSA7$@ z_pt@T23Jv2Cyg zJ4W;*jalq;JP(@(jPQNJOmXHo2|JKp`&rp&!tez9oMK0+I%tfC(zaGRlo__$Sh-ep zOLQKm{`+|ou&l_2HYCUpv9tk7`_$uW6iujd&r}z2qt&XM7vXbqgzmcuq+Y&`her|p0Gd{V# zkdo${IStC^Fy{$gW5V3J-JH(2NATqR^T}`2zx`M$cQUpvKE9Z@q|8`7#3(g5kv!BJ zcWFlk))B6nBq#i8;?RdAavQX5Qn{Wa2bwV__|-cO&iQ@n`Ppb09DIr0bhF21<>uyz z=MD`Dbnj7rTx+mmrp^0ZTaoMBI8l*e+vPlwhS7ymF(%5CfxMgA$8y=@DkG>=9I%e9 zi)8W1Ak1nxa5*2gZ)R0yoH;rv8%ntDnRtbqPI$q1EPCW|AuNIaCQ?+%e^VeY+4lS{ z=1YHfyDhGGP!k?m{K0R&|=JZDj!b3hFQ1h7LdAx?KPu} zjJA_Xhddp`D%NpvzrlI7w6pcmzqqP{3id0OGQcsLQm{#AOE(mLI@Nh^%_p?GFhefg zhL7;nLG`3|W@bx}mv4&kgft0Rq=Ea4CVbM$Sy`qX zrd09BXT4-(=`co_PAlJ^a=>n7>qduqL_BbbJ>k7Y{Y}}on5vHE9Gazh=4j_sP9*ug zm|Z$q%DYvQ&)P76ee4ZSycJf9sISb{?Ft=lZhtQW z{e@U)-daZ_f3~$vZ4=)p6#(!m+ss_N(l-3Qa^=B>OVJ&%(|QM+xqIvdfofY6aI~Gr z+7iersGu+y5i}1w*Cdpi^e$OV@k74ges8Pd7}vyU%cE@u?f$0I**z&!VX9~czXW*M}v5t((17}Zn)K>z=Z)?zruIkiCCWqzv^aFa=Cq* zw~LJoynAauHfX{Q>=c;QIz0QbUbY7?Kj1V3bos0?`+Xu{9ZP#T%|qHMFt>{&;V2|2 zyB`s~z*m(x((>ft1yr-B?^Vs+il@p>%A^Hvs%;83t$xr#n{Q@_a z$U;+QgiWYq!RnKwOskJ%3V|S=8MDA_UR+RSe$Fv=y09{!aP-uJJT@opBPhZ;(NHv_ z!P6~Zro{qJCB&_Cl7VsvpIMv%Nf;$5P&>hcOYih_sKDndTSPJudv>EU3TU76P`6)} zOF5TGwWHO?BHx%q(`C|k3&yE-`w>YaiH^VssfjoF|RA18TL zyV%wzF^#}3_F%Uuud%#x4h<8*Cqr`c*xy^oZihZWY|N;$di$0)#E{`q1&-_~Z4E_( zI4kk}?JVc7xrTe6MbOR@d!2JzB`RikbJz(s7;@KIUcsQ%` zzWpTaWg8IpAzm!3Y-(Ym%WcgqajJiX-A4l#;x(2ivg;G5N!?Q;bc&rD;_}i0+l4Hd zWmSO8&&%^>kKWJ%gC2RvA?;IX`_45y5jRx3E}eI6#sV7tLWlbeks|9>&6U+M`x;i# z%jZR3936>d{lJh^7&!98rp#`fWx@=f15E3I_2zM$B|cT;lVCf7+t7mPrz)P0&1D=b zyCsz(7=c;su5Z>krhWGAiBLo7=9MbI>?#^jcy1vVQ+|k~C!+m+RBxFXGp+;$ye6=uASiDgX#u2w4 zZl2y`n=T?gzSKhnkc1B_WY=NcELN>4InUKC?pLt-b_hy%UFftm$~Qp`s@vG6e3F>d z{q&t;YIm8w-Bm(bnmsbI+f2{)MGT#>j76)gTPgV>xZw9av+UX%x&vuR-k&1!Qn26S zg)k0Qb9rQ|M7J*5m7c#1F;1hrDmsXXX*CqgB3C4*j!iN25}O&G;bj|n_o~A=X!m#j zdCKWsjzrzGhDeRm(bD7fXR)#ftElyL8OoT2Zw;<=Pm8ONB_m+=Xq!w;k5c4xK|hV|Rl%1m_1!Hy~}@K^V@ z!?bpqW|XC`wjwf{$Z#*$XS-gQD?PUsPn#(-Ca(w`r6RkIcg~g@`d-zoV&mxNlY6}ZFilGyIp~ejs0)E}Xz{aB*5{Mbv zEXxkzY*Y%lE9+AonPy{s-)}=hO|8fv34@`1m4-ouTAk&rJ<+vC&JJiTm+6ODOtCBP zA#g|^WsZ+a^-7J5raV?kT&K&jQRuzoyxm?>ps67i(rZDwd4bvwY<>Qr9})e72gXKQ{&mUXT;?boJ_$agj+y$})1c z?tI1yiMYIpW;k^TkW4*~4!e)V>vmVAY{Gi`O9*{A5R`HHfg+6lq?T*V+YU%*_)r7W zgxdGf_ItcNo5nnvy-w!IKKv{JJ4|jLlXI7lZ%D<56!$MmonNyQk=hi5yLBR9_eq{b zCo{cXdw=bmuvc7))tgdA%9z?8_Bp!^Yq;~fh<;Q#sC;f-Rr+N`1)gA(c9jWjxLA9S z@>lyT^=}Vv@cggLhoLqjAFq?PV(bit|J=Xg`5 zPGXS)0Yfm^REM>hy$4mZsSCd5aJoLMwaW&24g?*q zP@HAtycCy`NS?^&S*F6xMax*$gX7+}m9;7E`v%X>dcG4ZPR_%EO?69+Uij271`>CM z$)?Jtx=%|{(6(l%TCw=ucVrtrR}#CwtfY*5i&N@k)25SbP&li~=35u2D$JMGjnA7~ za3tavwb4!n=a@WW*lg#ykt^%6>f8A;)sB16$xp0qM9K3(Wc+3AeG9C~+F91%U7W)k zJe*{ZN@7rg_niLS;>=n;_)@>dd9kM=ROzJ%F}20<2nX-gg;7}&+~r;dXz2& z%FCQpBgZ3cO2StrCppgLpDY`@J=i|o-{+m2&CJ6Gw;g;t62K0m%5&BzZ%)TGQp78; zkuh-1?a6D1w^H93+r>3v&`lsYYWV)ae)~Q0mqi|Y8)z5{|4CHU}QgK$ZtPGItW5ci5#uN{y8~f+1!|tBRk&;# z3$1`TRB4Ua8Lo4y5o?@(B!Q3A{v0fKV0f-=hvnYj>zk<0_7W2J382b7@dL?ra_6

r5Lv&T35j5(kcBS|^yA=mat&QUkq`Fn2!KTw%zH6DWQkz|Iw+Ri>3aq*&|Y-vg)!!*IF>hpB`CAa%3Jn~FcG-AcE z->d8h`Q9t^gt=ML$w2~iY>3E_5|n-;tcSk{?eLE8x2yLGG%O45u-sebR2tU`BP9@k z<0Q1+cTh1*g;Q2qeNz{<#}WcH9lJeTSeVwe-ZCObj(eA^3jUICc4&cY(Lw^cZHRBPOT#$4ge;^V<;R`@ctQV0-=0r z?I`EjUQOY%3MQj?4{vkUl#A0ykk7!^zcCsoiNfB&zvmjMlb$F_{EQ%pPgU$ zckV+%f0iYS-Jxo=n>F&hkMuL@AzvD}2;UCG?GkuNUT<2!huaY!*wG9lxno;&j%Z!J|-7gOPaJ?WUgO#tzHi}pBv-rV)1n0J26?WS*-GH8n3V*T&dow z`o1R0`%ELP4Wy;u9#|eaeBNwI{c6XoYU>AetbaWQd+fY^n@ZjY+y^O+bITI5tsfJh%MBp4xx`!OvgN*5az^Zm-vu90Or{nksf{ zohH-o0fkFi{$%C0G7<_agu>V~$-9KYG1ikz&#~}li`le|ZRu*6_;{ZjPw|F~9jM2Z zn|zYlzc9j6^URY_eItyVBEQL!m|#vZtzMt!rS8=kc#CmrZ?Arxkm9{2aT=;4oQKCl zHHTN|>$L^u0+ESVoe%k;+a|5EFwg zr5g8~f{qU|KI!-!Q}~hLHbkq2&CEJHkAC;fU?z9pASfa8m|)$dB5Y`tiM)Nifwi0bU+@-rYN-#%%977HNBOL4BvbDpuhLQ#r2q8vt_I={N$JR?AtlgR?lW$oWl5R#ya(sz@C(L`#FC214D}pFPVWXvdAmjqM4a5Z z8iabqCg&l(`)*_fmc%*L{a?r`jVJMvXC+&frZg?)6YR|^Rf=ZC7SA}O<5budO@IG< zq)=JA$M+^QeKd@9rUQr9Wc=fUH1^7wR~-8J1EzYP$O;}(>gtvlYS})Iaur(onD;G< zlFS$v#|@ACWO{VFLONljg{2xYd|CBzXUV#fihS=W!-U^+3N2Sm1ykf}9 za+JkQndLQSHaxXc>kXf}0@frClqTexs*~@f-S{VX3Xv?Uiz!- z7gv*<2p9ftK?+yVdR^0~k~Ua;-hx`IY*np`=msfM>h) z+Sn!u&|gTQ{0(~4qS#x1MX5@@;i9l2D39I!&3qd_bT<@Nem-y+yPVQ&Xp{f2PQ$$oP_$Z8ML!azWA&ZNu z3DK+IqDj{zMf2<4rJ{CXJ25?{;c zBce`mM(#+N_GBiVC37TuD2ae$;7f-idDe)e3&G;j!q&KjJfS2xS&~E#(Q$W2J=dlb zzul(K^X0-83dRf^3NUg>RpS@PGYyImwKz_lI)FC^|Lz-=z1ImC>?z7-~(MV^MhaL+@LBOm;&Sm_B*=wli82M8QOS zZ|rze%*a75Ou6`t6vrzjkc1S~d1*9~=!Rf-z*9P6+b&UspTyalgT(QSCh}%6;K4DbmiwDMovlDagrD>pn4yO+s)VdG{F}5kWygW1G09KGxb- zZ3w}Kv037egP^gl8gpH9(h%Rv$Kfj$_z!}*v$=sapC=CT7UBhq?z>9@^WybhrWV|1 z+^g!OYeYPc99dp@&q7E$PeA6h7?Ik^8H}_1cC+r8d+MW?;Gc&F4p)bpmuCmuPrZUK z_Nb<0&oHAtL?Y8}yrI|+C{-!e8d``>Wre6Ag3{Dpi}MxF*J(MPKC-?mv+k%ljGwHi zEB&6;^Sqcbbz~2Gmt>T^Z|FuA^1;wUuNmXMagyL?hLD>YtCP}Ye)+Dt%2pCcG)8QJdh1!=zuH;KTwGf3JPi-HQ>j;-r@Eo{?5Io^_xHnPM zco$xu#@LB0LwwIH9dz(gpZt>85uMBaxoP2ZZ@*n=`$*Pi625CK<3yq3?qNxIlfZLM z9ciM8%+7}_o}V3tG8v^G6s-H{agw;N)6vX7yD)#O88}h$nj8BesVu`>%}HkfyB_t2 zX89$L)KH;it$W*sic`%zV5u&*HU@{qlG8)-WX3gXq{{+HY1!^;?RZetbVF>9n)x|p zx#!Dayi!OsJH!3vsQ1~gFm+lx5WYzD~({dU^c zsi5FlW_UGC4X4soUiWHNm_FqaM}7kB(CAOo(7YRCf?XYqu90BNDpx}H-Q`u|6EL<# zjb3lcAbT4`59ApcbIfvob0PNplIg1jUtgJs<~5(Q7LUD}<{Oh2p?DEcpHrgPsO6AW zc;jh7-S;*0?L7j>kS4)XqvAURSFLQRL219N0A%?GaovigxTbma*{`(v*C${Nm$GvP zXS9)-7%YAV#yu)gAmOMupmA!A%}@SwC$E}~cI1y@?+N>ke$r2bAZCk|<+9H%A2lTD z{GoTXnP#%dc8`9{YnB5pnBGdk2<5ahZ-Z4L#EiUGPw}ak*f8CUOmQ7_zxo}|?Vb?H z+pRv4mVMThtYRU4+51SzCq8fV&NZ!};{B0}paCH@^}Jb&hZQM&q+(%+Og~lD;qx9f zmsRAC;F;!!Z?zn&z7}HD7a!CXATD!kTb&zuUesfq(5o=?If<`08mkchjHl8IsUB@7 z`s51X%Do8Id6?T^tx|)I6gmcI^Fdw+!~HPx4isU&7>W z#KpQjI%IGB1CZmtG|%_n3rcftRA*ogI=3w#XYH2eKYzXFfAx<2O#kZi7yFsmbxHK? zSM3>MY+C`00d6w2^X->bGlcTfQMbW5WVw0-A4%qvZXTq$iWeUXYBGZfqoT95j1uviy;>_YUW}$N90|mtd%4uG^$8C zNF$pyC0&HmrZd0HgAqc1KXAiLiqPoJcUq<7k#m0bWJYCvwSofj+-c+lzt%T%4o4)e zO$hXb;MyoHv!Yy|AxYF(}tbq;P}3`IYR0qDVI z(HmO-mhi>5yv?dES=BKcd+im2NIKK4#0cv5>rGj$ZLQ5e&$r3i(mt+}`H&3etx~w> z74TD=l)pdPcS`$2`&zE;dXrfA;8^lye}igJnzgBGUQUivLmi>CV)j~kpLZBh@Ekx- zQ@@%rm)oodc=U)PwvGkk?({r7ELk^P2lu#Z7 zNlE`Em}b2a+S2+mM$x8M$6Ij_Z(h90D3e=1uOodnR*%Depw6$d!@NQt&)nf2=)ffL z^|$r&sO6rU=nU7@I*}0k>z_$T-|pM9UhiJ(M;|>*o@UMV5o73n-{r+i#~c{ei!Q3# zAFAXqJqQ$*?O?d}_%6}h5Q_Psao7llkQ5&v3>1dK0f3AZI~)|k|Ng0w#U3Zzff@#2 z0sQsF;=)4suWx`L7#xz(JdLAI; zU;r5W|2E|Rf&v2|5IFil2n-DU!v=>S&~0$oACAFr_#ciTUemnjP3-ELKQt~I069r;~dHf`Z)v`20|wx0u28n7z7-MfFRMb zL%_iRG^l|95D91damtN;EdOh6R(0ch+;*`Pr5l0bkUbk6(*7CL8uC`EyxWsI^R;Qvh+ z`TvRtgusC?bjJ`lD#U;C0|-SqK}QCq0e_$Xg@PeyBt+E+0!8{3bN|BsKN^5CLjEHR|FgmVkY!YFLeWJE z2nQh0)e#5>0)gnkz#-7TksA50fdqs@gwccn0EEM#0QB0y;lh7#0VP|1WQ+g-|Hv2t zg@Mqt0*FAOv=yDL2$ayE!-_zlc=OMafB>jMp`An7P_2W04gy2h4-f!?!U1*eFZ}-l zH3$Ivt0n%?5g-6+sG|`HmD?ZnMA?MV#Rmig|DmiX8xZ!lmi<@#K|s{x_-{-6e@CEf zU^p85AP{O;qGyas8J!C#Z4`!~5e{X8p${hz2!TW;jg~P80Y+y!N~8XS8VvpuYA_6e zKCnQjl>~iX0HK=c|79MP|9|0!p!5+Peh3Uz0JH!hFdzaQEtCfQ!38K#_zx~X!EoWf zC;S)wASf6$cF>$aVZ!KaMNNDdI$1%&AP5jWK-6vkLJ#n-?eOo8|MDvgMd6R`7_|pL z(Jw^p0e|oV28H|)APgmOf82*ai8WesFa-499rnNd4+IAz&?OUu+714>uc4xb!vW}% z5@iFT?};D;5DrBrD@rT=Df1}&K?vbLHWic&gpL9j06?G<2@F6XgQjq(`YD-6;l@4V?0MNJq2BPHg-zE9) z{)aN6Ch|Y)gjyFM!f1Vrvi diff --git a/doc/bashref.html b/doc/bashref.html index d9552c82..d12dfd54 100644 --- a/doc/bashref.html +++ b/doc/bashref.html @@ -3716,8 +3716,8 @@ expansion of word.

3.6.6 Here Documents

This type of redirection instructs the shell to read input from the -current source until a line containing only delimiter -(with no trailing blanks) is seen. +current source until it reads a line containing only delimiter +(with no trailing blanks). All of the lines read up to that point are then used as the standard input (or file descriptor n if n is specified) for a command.

diff --git a/doc/bashref.info b/doc/bashref.info index 998e2b05..b17968c8 100644 --- a/doc/bashref.info +++ b/doc/bashref.info @@ -2738,8 +2738,8 @@ This is semantically equivalent to -------------------- This type of redirection instructs the shell to read input from the -current source until a line containing only DELIMITER (with no trailing -blanks) is seen. All of the lines read up to that point are then used +current source until it reads a line containing only DELIMITER (with no +trailing blanks). All of the lines read up to that point are then used as the standard input (or file descriptor N if N is specified) for a command. @@ -12919,95 +12919,95 @@ Node: Filename Expansion104146 Node: Pattern Matching107079 Node: Quote Removal112081 Node: Redirections112376 -Node: Executing Commands122069 -Node: Simple Command Expansion122739 -Node: Command Search and Execution124849 -Node: Command Execution Environment127236 -Node: Environment130271 -Node: Exit Status131934 -Node: Signals133718 -Node: Shell Scripts137167 -Node: Shell Builtin Commands140194 -Node: Bourne Shell Builtins142232 -Node: Bash Builtins165624 -Node: Modifying Shell Behavior198563 -Node: The Set Builtin198908 -Node: The Shopt Builtin209882 -Node: Special Builtins226020 -Node: Shell Variables226999 -Node: Bourne Shell Variables227436 -Node: Bash Variables229540 -Node: Bash Features264608 -Node: Invoking Bash265621 -Node: Bash Startup Files271660 -Node: Interactive Shells276791 -Node: What is an Interactive Shell?277202 -Node: Is this Shell Interactive?277851 -Node: Interactive Shell Behavior278666 -Node: Bash Conditional Expressions282295 -Node: Shell Arithmetic287208 -Node: Aliases290169 -Node: Arrays293063 -Node: The Directory Stack299697 -Node: Directory Stack Builtins300481 -Node: Controlling the Prompt304741 -Node: The Restricted Shell307706 -Node: Bash POSIX Mode310316 -Node: Shell Compatibility Mode326573 -Node: Job Control334821 -Node: Job Control Basics335281 -Node: Job Control Builtins340283 -Node: Job Control Variables346078 -Node: Command Line Editing347234 -Node: Introduction and Notation348905 -Node: Readline Interaction350528 -Node: Readline Bare Essentials351719 -Node: Readline Movement Commands353508 -Node: Readline Killing Commands354468 -Node: Readline Arguments356389 -Node: Searching357433 -Node: Readline Init File359619 -Node: Readline Init File Syntax360880 -Node: Conditional Init Constructs384905 -Node: Sample Init File389101 -Node: Bindable Readline Commands392225 -Node: Commands For Moving393429 -Node: Commands For History395480 -Node: Commands For Text400474 -Node: Commands For Killing404452 -Node: Numeric Arguments407156 -Node: Commands For Completion408295 -Node: Keyboard Macros412486 -Node: Miscellaneous Commands413174 -Node: Readline vi Mode419212 -Node: Programmable Completion420119 -Node: Programmable Completion Builtins427899 -Node: A Programmable Completion Example439019 -Node: Using History Interactively444267 -Node: Bash History Facilities444951 -Node: Bash History Builtins447962 -Node: History Interaction453053 -Node: Event Designators456866 -Node: Word Designators458404 -Node: Modifiers460269 -Node: Installing Bash462077 -Node: Basic Installation463214 -Node: Compilers and Options466936 -Node: Compiling For Multiple Architectures467677 -Node: Installation Names469369 -Node: Specifying the System Type471478 -Node: Sharing Defaults472195 -Node: Operation Controls472868 -Node: Optional Features473826 -Node: Reporting Bugs485045 -Node: Major Differences From The Bourne Shell486379 -Node: GNU Free Documentation License503237 -Node: Indexes528414 -Node: Builtin Index528868 -Node: Reserved Word Index535969 -Node: Variable Index538417 -Node: Function Index555551 -Node: Concept Index569272 +Node: Executing Commands122070 +Node: Simple Command Expansion122740 +Node: Command Search and Execution124850 +Node: Command Execution Environment127237 +Node: Environment130272 +Node: Exit Status131935 +Node: Signals133719 +Node: Shell Scripts137168 +Node: Shell Builtin Commands140195 +Node: Bourne Shell Builtins142233 +Node: Bash Builtins165625 +Node: Modifying Shell Behavior198564 +Node: The Set Builtin198909 +Node: The Shopt Builtin209883 +Node: Special Builtins226021 +Node: Shell Variables227000 +Node: Bourne Shell Variables227437 +Node: Bash Variables229541 +Node: Bash Features264609 +Node: Invoking Bash265622 +Node: Bash Startup Files271661 +Node: Interactive Shells276792 +Node: What is an Interactive Shell?277203 +Node: Is this Shell Interactive?277852 +Node: Interactive Shell Behavior278667 +Node: Bash Conditional Expressions282296 +Node: Shell Arithmetic287209 +Node: Aliases290170 +Node: Arrays293064 +Node: The Directory Stack299698 +Node: Directory Stack Builtins300482 +Node: Controlling the Prompt304742 +Node: The Restricted Shell307707 +Node: Bash POSIX Mode310317 +Node: Shell Compatibility Mode326574 +Node: Job Control334822 +Node: Job Control Basics335282 +Node: Job Control Builtins340284 +Node: Job Control Variables346079 +Node: Command Line Editing347235 +Node: Introduction and Notation348906 +Node: Readline Interaction350529 +Node: Readline Bare Essentials351720 +Node: Readline Movement Commands353509 +Node: Readline Killing Commands354469 +Node: Readline Arguments356390 +Node: Searching357434 +Node: Readline Init File359620 +Node: Readline Init File Syntax360881 +Node: Conditional Init Constructs384906 +Node: Sample Init File389102 +Node: Bindable Readline Commands392226 +Node: Commands For Moving393430 +Node: Commands For History395481 +Node: Commands For Text400475 +Node: Commands For Killing404453 +Node: Numeric Arguments407157 +Node: Commands For Completion408296 +Node: Keyboard Macros412487 +Node: Miscellaneous Commands413175 +Node: Readline vi Mode419213 +Node: Programmable Completion420120 +Node: Programmable Completion Builtins427900 +Node: A Programmable Completion Example439020 +Node: Using History Interactively444268 +Node: Bash History Facilities444952 +Node: Bash History Builtins447963 +Node: History Interaction453054 +Node: Event Designators456867 +Node: Word Designators458405 +Node: Modifiers460270 +Node: Installing Bash462078 +Node: Basic Installation463215 +Node: Compilers and Options466937 +Node: Compiling For Multiple Architectures467678 +Node: Installation Names469370 +Node: Specifying the System Type471479 +Node: Sharing Defaults472196 +Node: Operation Controls472869 +Node: Optional Features473827 +Node: Reporting Bugs485046 +Node: Major Differences From The Bourne Shell486380 +Node: GNU Free Documentation License503238 +Node: Indexes528415 +Node: Builtin Index528869 +Node: Reserved Word Index535970 +Node: Variable Index538418 +Node: Function Index555552 +Node: Concept Index569273  End Tag Table diff --git a/doc/bashref.log b/doc/bashref.log index 66b43f8b..99b84365 100644 --- a/doc/bashref.log +++ b/doc/bashref.log @@ -1,12 +1,12 @@ -This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2021/MacPorts 2021.58693_0) (preloaded format=pdfetex 2021.8.30) 6 OCT 2023 16:58 +This is pdfTeX, Version 3.141592653-2.6-1.40.22 (TeX Live 2021/MacPorts 2021.58693_0) (preloaded format=pdfetex 2021.8.30) 11 OCT 2023 10:24 entering extended mode restricted \write18 enabled. file:line:error style messages enabled. %&-line parsing enabled. -**\input /usr/local/src/bash/bash-20231004/doc/bashref.texi \input /usr/local/s -rc/bash/bash-20231004/doc/bashref.texi -(/usr/local/src/bash/bash-20231004/doc/bashref.texi -(/usr/local/src/bash/bash-20231004/doc/texinfo.tex +**\input /usr/local/src/bash/bash-20231007/doc/bashref.texi \input /usr/local/s +rc/bash/bash-20231007/doc/bashref.texi +(/usr/local/src/bash/bash-20231007/doc/bashref.texi +(/usr/local/src/bash/bash-20231007/doc/texinfo.tex Loading texinfo [version 2015-11-22.14]: \outerhsize=\dimen16 \outervsize=\dimen17 @@ -162,15 +162,15 @@ This is `epsf.tex' v2.7.4 <14 February 2011> texinfo.tex: doing @include of version.texi -(/usr/local/src/bash/bash-20231004/doc/version.texi) [1{/opt/local/var/db/texmf +(/usr/local/src/bash/bash-20231007/doc/version.texi) [1{/opt/local/var/db/texmf /fonts/map/pdftex/updmap/pdftex.map}] [2] -(/usr/local/build/bash/bash-20231004/doc/bashref.toc [-1] [-2] [-3]) [-4] -(/usr/local/build/bash/bash-20231004/doc/bashref.toc) -(/usr/local/build/bash/bash-20231004/doc/bashref.toc) Chapter 1 +(/usr/local/build/bash/bash-20231007/doc/bashref.toc [-1] [-2] [-3]) [-4] +(/usr/local/build/bash/bash-20231007/doc/bashref.toc) +(/usr/local/build/bash/bash-20231007/doc/bashref.toc) Chapter 1 \openout0 = `bashref.toc'. -(/usr/local/build/bash/bash-20231004/doc/bashref.aux) +(/usr/local/build/bash/bash-20231007/doc/bashref.aux) \openout1 = `bashref.aux'. Chapter 2 [1] [2] @@ -262,7 +262,7 @@ Overfull \hbox (38.26585pt too wide) in paragraph at lines 5413--5413 [119] [120] texinfo.tex: doing @include of rluser.texi - (/usr/local/src/bash/bash-20231004/lib/readline/doc/rluser.texi + (/usr/local/src/bash/bash-20231007/lib/readline/doc/rluser.texi Chapter 8 [121] [122] [123] [124] [125] [126] [127] [128] [129] [130] [131] [132] Underfull \hbox (badness 7540) in paragraph at lines 878--884 @@ -312,7 +312,7 @@ gnored[] texinfo.tex: doing @include of hsuser.texi -(/usr/local/src/bash/bash-20231004/lib/readline/doc/hsuser.texi Chapter 9 +(/usr/local/src/bash/bash-20231007/lib/readline/doc/hsuser.texi Chapter 9 [158] [159] [160] [161] [162] [163]) Chapter 10 [164] [165] [166] [167] [168] Underfull \hbox (badness 10000) in paragraph at lines 9749--9758 @@ -344,7 +344,7 @@ extrm '[], `@texttt strict-posix-default[]@textrm '[], and [178] [179] Appendix C [180] texinfo.tex: doing @include of fdl.texi - (/usr/local/src/bash/bash-20231004/doc/fdl.texi + (/usr/local/src/bash/bash-20231007/doc/fdl.texi [181] [182] [183] [184] [185] [186] [187]) Appendix D [188] [189] [190] [191] [192] [193] [194] [195] [196] [197] ) Here is how much of TeX's memory you used: @@ -372,7 +372,7 @@ texlive/fonts/type1/public/amsfonts/cm/cmtt12.pfb> -Output written on bashref.pdf (203 pages, 813995 bytes). +Output written on bashref.pdf (203 pages, 813993 bytes). PDF statistics: 2824 PDF objects out of 2984 (max. 8388607) 2574 compressed objects within 26 object streams diff --git a/doc/bashref.pdf b/doc/bashref.pdf index 905e230e0543cccfb7b6da4dad6281e0c4476bb6..9b6f44c2f55b205bb679a53e6de13626a838af08 100644 GIT binary patch delta 8022 zcmbt&cTiJtw{1c~i=p=}pcJX0OAWn)^xmZkNbisUQl&|aAQEXJ9g!w2ktQ9a1rTY{ zqzFh8P#)jAbKlJO-8c8Wd+#6X?Dbn`&z>{0=lo{vT{Q=LHwQyL1Af3Wrp{w;1M;>+ zQsYs85h!yoA)!lV zQluNwDy-~Gfejaq0@0lI}hioJh(-%VfK z^w0R&M8j27@}@ff(%8w0{;*tArPk%3&pf1pg$oh;x4C4wK?sSuu07YC{QCsG8y_)P z{IsHM3#TzFMYq{8)J#SF@}e9=(cq?trK6VrH78 zb_OmNctCnY&TG>|C7ly+Cpe<|{xoe^kTuh>0JQ9-)l2EbabYo2`8pTDDA`U@f3))U zj2j}vBn~EORF~qy5(J#o2uq%(hURf`XM@ z3%dzlQu@>7FmV_B=N|JqQHkqPr4OjM3Z5RXk8a4{Wqjn+e8wBz_wey!NE1ia&V#OQ zRAzfd-ruw~x4;0wunMAWru5TkcU^EV$XOp@M|Un5wO=fYIT&*J+pHOZI*9B~5pS-a z+P?2^9BVXSq`G@muT+b6iLm<^O}S&(VSW1d^`pqn)T0dri2yHQeZ$lCZsO0-Or4rP znw=oi4*ztg$u`c^PkqM8tJzBn8W!y%7Sorz)2SxJ2eBdkpQ#r>ov3f|OD{7*qdJKZ z=kc_6gHidzp(}G4_))*VqYAWXbMMF~06&ReZqQ*;QNZBuJJL!O3C7=S>4mLU>b>h` z1?{uK>U{%{Ptr(z-~yE*;N)(Hc^msa64{(e`Z`%33Aiecw)cKos^t|^P@yHF2DqO@ zLDwDmTg2#vjpffUBKMx2qJ z_fIi4)ZgQe))KtrrZyK$y5Az{M`9-28ABe5y{BX(5=3(!9S%SqZ$AzgiRLVe<;CzM z=wEagr^Qgq*4L|7rP~jFV~8;VQSX|x*C_>{*R4?@UCCsI1~AfDJ_F8ZuSa!d7AAcXhQ{^hYU&e5$uh~(#M(YBe$95~i=l<;4-zyw`Tx{qKY>g!~d5rIc_)HCr!Ve`Ls;Nn+sVJ&F6jxOgg~6m$)nF>}cV+)yDS6qCpbrt@o-Fe=13!O$ zlL@XZYGC2^rCbbssJGVfDq;Oz+B&XbK+|&z=1a*P#LVq(VfD&#A?;e^}ZkJn)nBofF}d#Y_<0hYF&<|Iabf~+}u-<}Xh z925<#XM)Da*$d$a<1tY_0B9`d3Xc>xIrqt~fh5cKP?kp{TgQlbb{_~oQf9?L-YldN z|0Kp{1%Sez!+3yBxh4oJYS=(dXag(e(P*v-{F9CWjIS`B9@4;v@)h1&EWH${A8R2D z9E;Wz#vhAy7Y4}+-w{MUU!g>Se%S-93Cu7iJ|q__(&k`EjIPfe{^-ROQgecH3}Y+V zK}=8X;)Tm8;unOhlVuMtc14&TWVFKQX8pmO7a3ov*A5DbwnF=ca)(U7n}MDL?bv&* zP)14PeDM_|*WDXA0EvJUXh-f6Wb%#jX>x>K}&03{a88nhbj(H1$6`S6_m}V>E{gS;u|FfP&GgXjTt5@S7y zQN=5M64sz6Anv*AfS|tzjeSOuvDf_ds3&ZwzrrV$!wtU>J=yM^4@w;qOy5$Za>F$< zQ#@x3@=Rtr|GKwh+fR>64R>IrN+l9Rj#p5}PQT z61hKlIqvt;UnL3F>v*!j3d%ZxOhcqVY`>(}8jQr^HQec~HRQ)jKV@q=u?=+{tKp>fcV zmbrqYQ6o=$uik)lf9gf7wBur;O)(BAowV~;&~OiLH;IKKDB4jH2j7!wut;XYayhyt zhEj)PTpT}cF(g}IOl?!tJo6oewmJLLFH3$=UtuL25n*Y($%|N0M}b~0-UDzLsE#`* zZ4H3at3u!&siJASsS-U(8Ld4c z)xar4sH35x_M+_4#}CWxi~SHTtR84hEA=FhCwrmGbjP|Q6<-Mg|J4$Q$cn9 z2m*6qO`pzsFQO2g)7g7wFm2vCMrN0U0^j~+iLiq34+(3!Xf_QJzN8kgH=s8n6V;a@8swce=c7)h;-x!;^%F4QOD#!)^tuhqctfxLjDInI&KjkEmx zz$JO#o(0zF6wVWb)N>3Q@Gi#T&;DAhaA+lb$i98r&Z{dbUZ-~h*Ro7 z<;#brY}?0S^r;nkY14#ZZ?@y75i(NBJsvE5h4Ah@Mqn5USYLpOid*0zjgjjeqcBq6 z!@o)#rFim23VcS@uBcNO0${!ulx0q(%JnI71mg0PA`8&7LIgW4)jr~pQqz&+JxYtE zaD1Pwd<3Sy&vm77k+niS1(|<~fFFs`bC$E_xsM@z9p85t$leh%n`F|Amm%azI(kqc zS1N@+Mzx+}5Dxcc93gkY%^et>VEAE|bkcfU}0D!%$MM=Mq=S-xVaJcQ~iN4YBEE2ZkH1kCnp zlNEJfw6kM}{u60k#I+zyZh$2D<576;1$)ho{*O05soFL6q*ViN`!<*8+iu~M*j-k@ zI-UXRxr~Ez9T9N?=bX1jLtAl=+qOpsy2Z0QBlwTYGo5@ee=K8)q zVmv}6PSYzftjjuKTnGguZ}e);?;y`jB=FKK4$j_}I+MGW!2LI`15H+vz?(lxU zy36d_JLaRST*_g=}=oLos6MbgDtie&g5Xc|Rod}FI9+)T4UGYOZ4dvMxwoKuUoylsy0LQnaz{fR8>4>)|sT93a6kip)?dAE&6 znC_p&MA{SW5hh?*hgI1OvmAWD%=nz>hW@|(;U?kC2;r*Aomn-krVr#5fh$~j`01ab zvAc3d(-uCYDOLwpMMiyK6yB8m7e9qCMVhT>Lcth@;XmUF?;J@-Vux2AOjNFCTCA3M zya&_*1mwJ9?xShqbE)~@cb=&>1}@LKGm>YnkxqmgE{zqx(aQ>Zy#{LRs(O$=@6Rc% zv?Ki_79ss*R(whbl?r`FJG%SXW-g$c#VxbWLQZSW;A8Ee%-YOkOIq%!X`}!6_JjO> ze?*|}bz774OWL@hEbRo?1LBI)4sT_$ z0=WiTUDU{I0O4mF^#f_GxdAM3<6NZTemxw)qPWXrqwwU6>8T06)*MBfy!+XvI>4J<|w-4UC+9_#V3V|rAG*f?7CgfDAb#t z1M;RVLS_xR(>|XTxD;I?^H)-(1>e<0J2#H!m|*=H{~`w^)?1>M_lDbzk0y@m!kfMz zyhwc%`FQdpcP&h^;S3*Q1JR&>Scyh9*}9;@uYX+9B%(=NZkj5RQ{gm!&;xs}MJ9c; zXw^B1;g$}+9AN#_@siU64~wS7M<*FjhVKh}86l3k&WE2QMpr`EM-UcL{S6A;!) z9Z+gQ!)yy{rnXA*02{&;&(lroznd$xQ0?H{xkXyDK34 zCI%w(+9tWxK9@NV(^+u>o7=a-X3l*O(VwOQo0azY5R0`lW_y-}F~p}v8`Cz|xHvQG zPeV;|WXYx%m#vJFv8EW2_njay3y1xIN@s@ovHZqPmVjvQdWrzcRq1`-x_Nl(pL?i5|ojk#gTf?89y6i4PSgP;J*sr3){@ zi4Mv6Xt{YnP|6je%n8zAC^!59-3M9L4rKghU$_RQPntj{t5xos$|(X2sWjmg7{!hw^HD)=0)G&yW6(7F zP0}Q>U_>h~Mi)3ne5i&Lh$%7k%n1RS-hK{}49}Ay#j;@we`f6!;3?S2l=;H0Zw%l` zVV{HiDGDUG&GDH{?s>hinuh_QxZuA4dEnN2sD?H3^aY!>`DsEaZp_2my0yS-%9TX> zZ^_>@3mb@pb&+j&U!1U%tsrm9qlL_cRm2;B6}Sps&OV;QYt}c+Y2Lh6*zyk61(~hB zSaMH(X=pZNvPv{tMS90Lf#zM-M$JWOU67WhgJ^D-Ub#-Lp&2g5`CZTZX$RPk`onUwoC*9RfFe&S){4!`9&1nvh=D%XjP0*Wt(uWB4 zo>C1xs^1I{>A2bA4C`0!QO$^pr9BG$xnIn)nZ+ad~ID~E=HuMhC)?DP+8B*0W&j=;H(tPYJ z#Pl=v@gv<6FW*!#6X5sii=Kgp{#~=hWbT4ImPc=|j6H$Q{(kxuID!R5LO1cZZKcV9 z=sP@KICs4*wo0X!#P^T0W%lspHc#Yg76j02o`jK`&`xcdMWkPh%m~9D)jmW}jH0mp z*l()jouPf$Qvhzfd(kMoU4*{^#H{@*^R)0D2b47QExz5I1Hnyd>te$x00Bf9lxwDK;Q zWK~DDNPa}@t4_!T`NQFa&-3^Q|JQ%=8M7W2+^>?*X7oA}Z1oy@YiGDGXZYljxx-_O zPN5u^pCf<4m{yr+Ef6E}x!{*%XQdlK4SMj^R*?y`t;)^9OLWU_I?H4OeS+Ua6%b46 zA9bQOlc`(F5ka$B#WWK7d#MsfG|{0I)4JeP_KDj#decO#?#%MtABMh51i*duhXkM3 zWvQc7aWa0ThUt=f*?#vMh*;e*4Lbg_Nf+4c+}z#Gw&`AI)m2TvUUM?8IJs*^*_5#x zO|NB^Zs}gEt!mhAa@;&a!Kce&3}rLUX)!T8E6wR3?tF1FmyMKrQiiXeO3^0mT-Iln ztkq`=5H+=YX$n29qN_PU{2-<=`1sMj%r2xZIij)Fw(-kU`>Et-8?&c)T~20C&38z; zYl2!Z56qjtJngiAMQ(JtmbDD6n-Bz<4C>q$`~~09dUu1-%8}^e2qsqbACIt6A4S%U z+I(keUjWYc*OI~y>YtZ7nq}p@UV0wnCDJS%v?QWjkRC?qHnnhU?ABp?Sef`rd zICa<&y|5%1d@oP*eE$5=uab67d<#9IZZnGa9@5Zj2j;)!DLg~Qv>}e?KDsfiWM)e$ z4{5W{2+2ei{rCk)(_q-*{qZ*CJN1&`Gkppn)eh<-!(MF)A;b*+BL!6~_36~;ru?^> z?&p`h6577z$#aHZvmHyRIm_sI`!smfw2mI#u2my4)?%pzj7BmXWa;VJJIN;X(0p^BkY{EjB-{43sYdUs_#l1m=_Juiwv%IswkBWIYWH&jEyI8Jz z?9f~PWcPGKp<4q`E&Ip65(mA+n)2C&w%;xk445}G*ixD;LU(#9ae95yX(uyofWsQM z2=c=?w}^k=#@((!F%H7elk7|7|Mpfb7$ag148}faC7i`X-d){Dy5nM4L0BjgSl6?ax*iJq!3!O2>D z7l-sC>{=$>H-blYNPSd3(AZ~GkgX&p>L*SHA<2ph0jr$P(obHHuX08*s$3BL<3uj6 z^iKrwAEp0^qH%TU9b*MBDOm)lt4MKtqM-PpUcn|l{nXNcZavklF$WRX0-w6I!8}L~ zA2@L<8Uf9Ri@E`8&?Nun^X7ZFpNt*z9)Vsn(QRj%U%Wt42rR_2ka5V z+LPh#T>Nbp0iVT!R_;oHNn`)_l=h$Y#li<@4Za=xQG|C^L|XA4KNsigcCRW$A)1dH z$9J|Lv=T)4u<*w)t#GyC=VH8k2>D}aFhRF-h!0tH^wkOw1C8+WPBu_b`$K=~G@brm zCuL6AX$I12JM{lVP8G}8{z>?cDgTM`77INDM3%BBj0RT`-SUWZ5Zrz zGD{i|l+u^U{GIsyNcm^O>a>$GYGAxwU1^T<{O3L%|E`?GVAx*nFC6Pu1KXI>ooq?) zhxK)U{Z`4qoI^Sbkkv|Gt{EK44QS`<%(`_ruLk5r()E>CWr{m|eQ0$6K`NnH$ig7j zD-Jmcr7%$p$dmv0GcLrF<@ob#m}kcECKk^=_`|@Kefpnq)|V0KHCe1or5&o6T(NZi z!U0J{`abh(v9*%)0eQ}J8y8k9fb3a!$e!piZfv)qWYVeoWx{4Psvt7x$Hn$;38F5& zOaAimmi;@?wj+7t%!gQ2V9e_K8Ks%0KFOS;l8<$qlL7YLJYq+ytRxKHF+&+okN?oeJb3VD}9rmSylXS<;=4c*8*W)CPk zLZ0A=uI9REeD_$g+WpdkW$8mX_i3HZUx6o=oq8++7E|ikZ0Ap{rkn(B{>aRB`~*o` zHgBRW)cIzwLv+=HYkqGO%}rJ|d0qyyEH&o7?4F*?Z;GfdExDRKP6D#X)#nyHlMZvM ziRBD4*{D8!WS}14soVZ@8^_3ERpRtS3z0w3&;)xT7y8z>zw|(?w~+k+>g$>)qx_X& zZHzoPzE$*A(u4XsCQ>QCqCY+(KC=6~$lZ%#?}x%%5^t2Q>DIc*Z{jY5dJ*h@?;P3v ze@lO|;{H}C-T13T|D(tkUG^pFe|r31ipAf7IV7$sLFpV@$$R4HYEHj?Q**WZ-SYJY wM4!pb4RQ8<>>uFg?BMke_SDe>;veAP7ZBp->;jPzmXLY~gWSKbs;>t5Uw+pBNdN!< delta 8048 zcmb_=XH=A1vu1abp~*ReNX|JUQ9y|jB{mI6hUSn2fwu_~n;=M%)Pf?}CP$%>oIz5H zWR;+ZWDyW9=bN?8z4OhiJ2Pv|kLTUbe%@O9$F5qntEyr_vT8vR84GTNnA7E~mk|iI zM9@K~@d5RZx=sCC4U?)o^qaA^Hr%RWvna!>Ii79_lbA1?O4q)o=Q(ym8(+X1?LUpG zT4b#$P7=Gr-qhxwtBM=3Nmh3e_ZXYCY?D<{s}?>sZ3$##NE&bc%{FqtMw&pToNZxN z?70iUn~<)+nufQX$1iF~cz+B&Rz4-zPhUOm5(Fd?uVp319@g$^P?eMs2sPIwcKQ3f z4zf@cR6Nw!*Ap==(ymD4qK<#g&cti!ZbfJ>;HScX`r|f;W?v(@MA3C#_1)$Ri*|+7F3{YAsxFB63~fm~f3)ZRjmw~S%KCTbi{II*qZD75 z7dn6+UNW6Rs+3^{cTc}24Smsc4Py^92?rHq;h(8JEPi^CdjE-cO|V_4=_VXUAwKY< zxLCB|Q+j1q-(ZX1JC+7b-KJf^JAM9a53)!y$K`(?Y*un2$(f{VFP^{KV3U%{w0Slh zNWbc6FlRq>AJ}43WmKgjJgyiFBYf%&xr+J*ym^~^5qIQQOM@A%&+GP~;VgSnEa{w5 zxGNJj%r>_+dtg3&u2!8+R>8cPN(0@hh&=rgjP{vW)E1?+kufvjI7hD ziD#8^S-GjFxt~yrd{ov#cp_iC^ZaFzKoM9#MmuSBpy4@VNm;8&7J*K9+I|nvoN@#_ zJBl6@8uGC;x9NQrW}%2=jgqnv7kzy7iTLFf39WN&+<>l+;PcYn^Y435(yH3Pw6Ij$ zW2tuXtdm#ttHi*>u(MOjyZ&#Ax4Xl%K0T$c{0hECG)Vah7faAyKX|!CcJVc|X6zQ} zorV4#XBN}AC{m*D#`h(r{R=nM0MTi4)hWNTDW#`>xzrM`c9BOi1lZTuaMi z2`437`hwlA940YMP1N!B(=uxEeqJXI1_FMj2Fom!A0EvF35&qZV!y;V%lVQlPX$3l zq~*o(Xr>@FnW0&pvKY#WUpKdM^~mh(&I^>8<38smML!}ILw#lJe+_;rEVP!x?FONX zpJ0RB0PhC)Hz2qH;SGpxKzsv|8<5_BtYv}?TERmsAtxy(s~|0z1E@n;|Jk*as6%Tg zO|`T&B{k)wbQI+kWE2%;q%^cN{*Na1q~ZpyzHWi;TyhFB zIoxevL4Y^k3&Hj%&r1wxE5>8WN_)T8M?)(totaR_6e zwbS;eq?4&v_(_)T6@v4S#RNq(#Lk336ir{Que=Q^M3YrRmeq3{$-{bBFbvgr5inI8 zNG{qC%?U-0!>GK$wmotf_Fa&2j~Iq^7pw&n#}UQ#a3h%5K(4}p#})afN1YS`jAZ@5 zB}jo{6YH~&u@+EWA(V^qfpO*%SoPeaO<|a#EcZbn{imu$)9BU7w!vX5)Chc3bSVtV zhBw$lB0*skO@bgbh@OFw7J%J)WOBhAxddC-Pz2ZxKL^X!3f=6XN6??Gu~>r^ddLy9 zBGI;Ma@LTL9#sVA5}2q4bNb^Ou;t1TM&*sC+@m2uF@dZ?hfe=x4KcJRG$QiGlh-&p zG}=cehLc-U1|tO#%rbuEQeIfFsQT3t&Jaz8M|AEVp`Pnu%^A07A$^Z3%Wf+3035>=`NQTCkW*gBcYa0Ls z2iZo{UMm*gdD;@6Mz)RegIj&UR&}FUKr?f)4v>Oc+6DrFTZv zg-kq(u7Pjl6N9Ln6W+WRg%|cQT~vr+w5yYIjb=EzwW^Dm{F2S(BXe*d$v^t4#}V*P zi3gGTb53D{dtCFK_O>2ZzJ>mzYydNT=POS8*Vg#F@T~;bTR}Izhq&LFjU8M{H>jXQIw0^(&oI@D?W^7b>zneK<3avbv$(xd>ZJB% zefW9ixmVb%AUr;iy`J~kCWFJ>U7}B0xN{~`}Sxv_ea+#>WKQ9P3^!TiK@5xW|r`N0l)uPc$4)Lt#Nm^ zhc(HNTkZN$*#BfCNJS+znR}Q0?H1Mqaub({xk#2HeIu3GmiH?h z>0&}5cXJe6d7G>3*IrmsAv!sCr7nWbD#{lgHdtGV!?Qg4RPNN24Hvi8GJsUSEKdsR zlbM~>X0$i3{C;5js;_4 zawDHA3GCr_Boy+MrQ*m>sXFwkQ#Nj#va2K+w4sJ6#*xEC>GFtwNekz`(>H)XW3>8a zGsXIQVX?Vk4>oSR)8`@>zhNqI*WmQo{vg)BjJ_T)PTU}oFfvdTn<>Dj?Q;n&eN5_J zTOywU4Ph~${%m0a=p8^6?xU>k{sH%UNNAy)9J`ID@f!NJyU$gVZjv3mp>OX&CrFH@ z)cCtFop_WYytOtme#2G5c$cNlHOUHV0dGkVH9hW;gd*c5-TJ1C*0%;O8f$MN<|oxmfZdyN*6#Z#&JXQZuQ<-t>W=zqP0iy~ zZwF^FwdBjkpDBm!94wV%p+Sa9Cc@&>pBbwsjy7#9Jq8l?gAA<^`g>9VGb71eBmUMa zng*0L!xVdCpAsZ_D`qAYCnl8tW?m&gU-?i+!U>gDX#sVXSMZRyy?v(00IchUwYcQ* zICFP3-x4}4m(Lw~P@wOMDPmd~V%`u@SVB2&wDX1Bh>3{iRHm*G<_$%y&RRuoEtSa{x18CvEa? z4!+jIsLeXmQNcpOp!TZ?suAWbMLfAxzo++&J>EG&I^Q0eO2D7m-p|O^C`bd3XQkOV z?Gy+xHML#s=?i!6(kAT~e=9nX2>a_Ku3bN(aw1zQ!@y=lCe!k<$n-lso0Ie~y9}rI zY$2OCxxq=ryOYfHimBrf!kxgWY&&`6&Nr!Xyt2?vfx`>S$1}!(za1Lhv67lU*O(^# zsaR98nMsdkcBXHPw!qfCCxSH1EY%SmL&^fv-Vzvm;c(kLJ-drx4zyj*Tb=PRAmaRq z$BJdZ(C^~MSe_lb&HBpY@Zzuz2+(f5=B1M?GhsZ|NrLo+*RJ?=ttXHMdSnr_yvU?L zm>NU7cH7cJE&hIF zT@eKCbN)Tm$EX)$QK9J9gX9?E#`jYhaAx-?3~c^{ys!++E$EB)j(_fl2n&mh2c4jr z#P{x!lDvo@b6tUD7~nIdz8LrDoVQ_`d#)rDuZ{J^UI@hSP_{~Uhwz@fOsH-r;kn#Y z{j_iJxnX-!*};;d7A@dg6V;WXfm!jsN?m-W>Y1+UxeF>^RX-y9OFq5hCYwsyDxsyD zW9&h;GE`krn<-8WgO*h!nIGHtKy9o;%j!D=_zIq0GSL`W7LNfvq#;(#VpW) zc+XhP9{B;u@Ps9Hfr#k(?1=3GEJK)yns7>-$K3w5=>#U69E2~v}=Q`%` zzd`G)R^w{l%7ejc8H8k$gx}<;+WdQWX*tblJEyU{DNkU-yA2i=m?du&SpE2!&yxJb zC!fm4?*056fLZ%ESj?Tswc+iZnk3TlXrn0t%P5B_r_*_(eQ1%PF{B!Oo}u&PD1AuD@CdVNvNpA+6I%#o3QvMk3_>`!$&1qf&sTf<&lF zA{D&*Id6N$^JwnUZe&o|#^P?N`1Tj8R`CJ+QIC4Vn4mQ9^!?{qNjY=)ez77bEy{wr z2l4pi2PO*S`x*(9ng+BJHXh3%bND<@t%dsZUS_x1ES$r@V-G!SUk&66_i1sTlDxIu zSxYmIdacPDQ)k}l{+d?Y0#jcry{)N22d_nZyeIwBOmve}(oiqEwE<)uA6&n```iN9 zv+>yD&B6TjLnOLBt4pS0pa#v3LG9WR*i;Ap1k6XJ>N92C-1xV_?_i?a%^!rjD}r6# zC|kv-VZh#y{2nFYcbhey@}MDjh%f#h7#UZ^vZDKId2fr38kNQg3(IhMCWvy)@t4tA z7fKuv1+o{$wA=Kd!!fKm26l%DTnhXvHhL5kTwbq+R(v-?@~koCg5F>~5FhSwCeHcN z{9Rd#}&C4 zC3{;uh_VjuA1#FC0;h73{J@MMAhDE-)yF@tOJ?>7ztiz!^{S27GUh10lk%${fyQH+ zEYH_7mGE*fH2x3+T68G(h|m`7s0k6Ff~CW-_wM|OGWtZ(Jf(=^$3lA?kUS6>N|QSZ z_`x&l4MiC%AAY=6D9ApeVK8W5CE59ms4pIQ4gMqlP9NM-0Wzne;%`3bb zna1+DYON@%_?N)uJ$pf`r##kgl|)R~EngWqG#*wl&Kd~{dJlY97|t4g@Qu_KBNAkt ztt4`nouSBR#r3P>Maje*oAyGlcxZ9fs$A6x^bzd!4yG&6+Cr&XsL+mHA({Z)TR-U( zy8R`;`f?Uvuz$`->1D(}$Qphcc*eG|U(@T9vW)=+TGJ^hK7t8uV@?Ckj@K~)f!3#r zinkgz0uH%_uX~Q#Rk}tbX;vQ;vPolH0#jfnx(G*GMs=7z7Z$P_OrO6}BM3t`;@=riw{6D$)x3iS)-#JNsfzOB+!)ZqPfn%{8g&@c0DmVhG0DS+eRiG{#=2tFGD z&n73RoTTTi1Fkod+GVhs{le*ErORjD*I*S0LB#wADR@aI=}t0_>v#=qte2m<313x6!e2| zO*!~SyT!^`a8n0~B{sui<=m+MIP0R;Vud$tfe9zeE1lIU0(mX``UT)J6aDW3t%Z6{b z-u+vTo(LO>AZ8=vxyhl;BflIRvMB-k*qLkcmDUX0Yocko7baRoK~8b z9IeiKE34@qk5|-x?B$PIY5(&0D?se%j=Txq;@HW&a2yZBwS-#D}CXxh*Nyw*h%=ZDUJz zd_KNtKKDMAr&1`|$o=Hwf&rUK8Gq<}E7jrwrJ!al;O~~N}9LmVhk#W(? z-`u{BNBHJkiG6d!iS#-#JB%XC;+{#No;$sQ^0+by_G&S!4ee{hQA#zANod6}OO2&F z#X+TAa=Eq6ZWi1vtrqBVeVKgM`9eG6So(SjO0tmKJx)~0``Js+|FQVR$xCTZNa)4! zNZDm@{}sHlzjs|!MvJ#b618x#Wcm=Xl$>p6@LU|+h@%i9L3VmBH~M6&Ff2~aBF~9vZODU zdw|QI5=$hxlCXeO^ZlG{!Ff^STl%T8TlI}Hmipi>Qez_$$pcs89*6;P_Su5p4-#{J z=iz=ocrKH$FZuV5Cmi(;0sdkC-$>o*$udYDTshDJN=@+BM)AOB(@gL9R<71piw&?I zgjIDFwWyEQN8J*Ll0pFL1g&UN8+BoKydP-1z-Y0X=PiZ(0H6mIzW z>UWqx`8`}XNOQCgOc@6bj=sqYcQGeDz3dH}Km!gn7Fgi8@=QSn;3L~UH zg2n)82BRq;G+TozkUi>AL~z)F7<+gnh{R$-xonpjz5$tkGT@7q#(<&jP4B-J;{^lT z5#4n97-HY3PcRY@yyhojZ;>5q9IccbpfUCKPF{^a_$Rcp#wK_E-^p_$6D5ru{MWSq zNq`$^Iw$f!h5yy$zgP19jyB?AuJGu6lK1@og`oYSyGYLYw)4?`CDdyVPyVo;z}f1) zF&1Z;{9`3h2)H|o-{Ti3L%jyR1x zj6?Z>N+hF-+~Q*k>>ZuQyQ}*+{hd0ud1u|E!NXN&*6J40^vWY#^oHd15zb|!j(g0x zf2%IB*EutBu$Csx9#Is0`-pn@bNq^PZ^dAoL|So38W3BnySMs@(0cxfcg6`$bgNEv z!ud|YAcKG(vHRel8g@cA?QJiIGDM}hD9oGWFclJP6*dSGR!oa<;V6z(3Dyp!U8Bpz z-%U6y11bMdIn@dCjy-;aB*IyLc~*CTQ~L6(<^;#})gBUnT%P7Aj!`|m^Tg#)wb>}l zJN=LW1lWF1sSo5>y;N-uc>EzDO^xFMr4pPM>J8q3`UNPuzHFjqgpmQPxgID&+k1fU@TN@_Q~c6(_8y`YD-^!{`a+2CkwlfXhxXVA-auczT-LEA%8JFmT2u(yJ+zq2_DpNZLh9 z^;bpF>p!37+qZg^Z0hIH_PV3<=Sz6(%XRaNjuoZ!UberS*_WG|^Tc zLmYCqRr-A)^&Sf07OTv&#JoOnBPmF}Poy?NA>e(V_}>H6e#OMjcbTN$=TcuK?>oj` z-@0U6?KNZ8{SPq!;=KR> diff --git a/doc/bashref.texi b/doc/bashref.texi index d4933a7f..8d1c89f4 100644 --- a/doc/bashref.texi +++ b/doc/bashref.texi @@ -3227,8 +3227,8 @@ This is semantically equivalent to @subsection Here Documents This type of redirection instructs the shell to read input from the -current source until a line containing only @var{delimiter} -(with no trailing blanks) is seen. +current source until it reads a line containing only @var{delimiter} +(with no trailing blanks). All of the lines read up to that point are then used as the standard input (or file descriptor @var{n} if @var{n} is specified) for a command. diff --git a/doc/builtins.0 b/doc/builtins.0 index fcb2bdbe..ee7a0d80 100644 --- a/doc/builtins.0 +++ b/doc/builtins.0 @@ -15,55 +15,56 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS Unless otherwise noted, each builtin command documented in this section as accepting options preceded by -- accepts ---- to signify the end of the options. The ::, ttrruuee, ffaallssee, and tteesstt/[[ builtins do not accept options - and do not treat ---- specially. The eexxiitt, llooggoouutt, rreettuurrnn, bbrreeaakk, ccoonn-- + and do not treat ---- specially. The eexxiitt, llooggoouutt, rreettuurrnn, bbrreeaakk, ccoonn-- ttiinnuuee, lleett, and sshhiifftt builtins accept and process arguments beginning - with -- without requiring ----. Other builtins that accept arguments but + with -- without requiring ----. Other builtins that accept arguments but are not specified as accepting options interpret arguments beginning with -- as invalid options and require ---- to prevent this interpreta- tion. :: [_a_r_g_u_m_e_n_t_s] No effect; the command does nothing beyond expanding _a_r_g_u_m_e_n_t_s - and performing any specified redirections. The return status is + and performing any specified redirections. The return status is zero. .. _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] ssoouurrccee _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] Read and execute commands from _f_i_l_e_n_a_m_e in the current shell en- vironment and return the exit status of the last command exe- - cuted from _f_i_l_e_n_a_m_e. If _f_i_l_e_n_a_m_e does not contain a slash, file- - names in PPAATTHH are used to find the directory containing _f_i_l_e_- - _n_a_m_e, but _f_i_l_e_n_a_m_e does not need to be executable. The file - searched for in PPAATTHH need not be executable. When bbaasshh is not in - _p_o_s_i_x _m_o_d_e, it searches the current directory if no file is - found in PPAATTHH. If the ssoouurrcceeppaatthh option to the sshhoopptt builtin - command is turned off, the PPAATTHH is not searched. If any _a_r_g_u_- + cuted from _f_i_l_e_n_a_m_e. If _f_i_l_e_n_a_m_e does not contain a slash, + filenames in PPAATTHH are used to find the directory containing + _f_i_l_e_n_a_m_e, but _f_i_l_e_n_a_m_e does not need to be executable. The file + searched for in PPAATTHH need not be executable. When bbaasshh is not + in _p_o_s_i_x _m_o_d_e, it searches the current directory if no file is + found in PPAATTHH. If the ssoouurrcceeppaatthh option to the sshhoopptt builtin + command is turned off, the PPAATTHH is not searched. If any _a_r_g_u_- _m_e_n_t_s are supplied, they become the positional parameters when _f_i_l_e_n_a_m_e is executed. Otherwise the positional parameters are - unchanged. If the --TT option is enabled, .. inherits any trap on + unchanged. If the --TT option is enabled, .. inherits any trap on DDEEBBUUGG; if it is not, any DDEEBBUUGG trap string is saved and restored around the call to .., and .. unsets the DDEEBBUUGG trap while it exe- cutes. If --TT is not set, and the sourced file changes the DDEEBBUUGG - trap, the new value is retained when .. completes. The return + trap, the new value is retained when .. completes. The return status is the status of the last command exited within the script (0 if no commands are executed), and false if _f_i_l_e_n_a_m_e is not found or cannot be read. aalliiaass [--pp] [_n_a_m_e[=_v_a_l_u_e] ...] AAlliiaass with no arguments or with the --pp option prints the list of - aliases in the form aalliiaass _n_a_m_e=_v_a_l_u_e on standard output. When + aliases in the form aalliiaass _n_a_m_e=_v_a_l_u_e on standard output. When arguments are supplied, an alias is defined for each _n_a_m_e whose - _v_a_l_u_e is given. A trailing space in _v_a_l_u_e causes the next word + _v_a_l_u_e is given. A trailing space in _v_a_l_u_e causes the next word to be checked for alias substitution when the alias is expanded. For each _n_a_m_e in the argument list for which no _v_a_l_u_e is sup- - plied, the name and value of the alias is printed. AAlliiaass returns - true unless a _n_a_m_e is given for which no alias has been defined. + plied, the name and value of the alias is printed. AAlliiaass re- + turns true unless a _n_a_m_e is given for which no alias has been + defined. bbgg [_j_o_b_s_p_e_c ...] - Resume each suspended job _j_o_b_s_p_e_c in the background, as if it - had been started with &&. If _j_o_b_s_p_e_c is not present, the shell's - notion of the _c_u_r_r_e_n_t _j_o_b is used. bbgg _j_o_b_s_p_e_c returns 0 unless - run when job control is disabled or, when run with job control - enabled, any specified _j_o_b_s_p_e_c was not found or was started + Resume each suspended job _j_o_b_s_p_e_c in the background, as if it + had been started with &&. If _j_o_b_s_p_e_c is not present, the shell's + notion of the _c_u_r_r_e_n_t _j_o_b is used. bbgg _j_o_b_s_p_e_c returns 0 unless + run when job control is disabled or, when run with job control + enabled, any specified _j_o_b_s_p_e_c was not found or was started without job control. bbiinndd [--mm _k_e_y_m_a_p] [--llppssvvPPSSVVXX] @@ -73,19 +74,20 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS bbiinndd [--mm _k_e_y_m_a_p] _k_e_y_s_e_q:_f_u_n_c_t_i_o_n_-_n_a_m_e bbiinndd [--mm _k_e_y_m_a_p] _k_e_y_s_e_q:_r_e_a_d_l_i_n_e_-_c_o_m_m_a_n_d bbiinndd _r_e_a_d_l_i_n_e_-_c_o_m_m_a_n_d_-_l_i_n_e - Display current rreeaaddlliinnee key and function bindings, bind a key - sequence to a rreeaaddlliinnee function or macro, or set a rreeaaddlliinnee + Display current rreeaaddlliinnee key and function bindings, bind a key + sequence to a rreeaaddlliinnee function or macro, or set a rreeaaddlliinnee variable. Each non-option argument is a command as it would ap- - pear in a rreeaaddlliinnee initialization file such as _._i_n_p_u_t_r_c, but - each binding or command must be passed as a separate argument; - e.g., '"\C-x\C-r": re-read-init-file'. Options, if supplied, + pear in a rreeaaddlliinnee initialization file such as _._i_n_p_u_t_r_c, but + each binding or command must be passed as a separate argument; + e.g., '"\C-x\C-r": re-read-init-file'. Options, if supplied, have the following meanings: --mm _k_e_y_m_a_p Use _k_e_y_m_a_p as the keymap to be affected by the subsequent - bindings. Acceptable _k_e_y_m_a_p names are _e_m_a_c_s_, _e_m_a_c_s_-_s_t_a_n_- - _d_a_r_d_, _e_m_a_c_s_-_m_e_t_a_, _e_m_a_c_s_-_c_t_l_x_, _v_i_, _v_i_-_m_o_v_e_, _v_i_-_c_o_m_m_a_n_d, - and _v_i_-_i_n_s_e_r_t. _v_i is equivalent to _v_i_-_c_o_m_m_a_n_d (_v_i_-_m_o_v_e is - also a synonym); _e_m_a_c_s is equivalent to _e_m_a_c_s_-_s_t_a_n_d_a_r_d. + bindings. Acceptable _k_e_y_m_a_p names are _e_m_a_c_s_, _e_m_a_c_s_-_s_t_a_n_- + _d_a_r_d_, _e_m_a_c_s_-_m_e_t_a_, _e_m_a_c_s_-_c_t_l_x_, _v_i_, _v_i_-_m_o_v_e_, _v_i_-_c_o_m_m_a_n_d, + and _v_i_-_i_n_s_e_r_t. _v_i is equivalent to _v_i_-_c_o_m_m_a_n_d (_v_i_-_m_o_v_e + is also a synonym); _e_m_a_c_s is equivalent to _e_m_a_c_s_-_s_t_a_n_- + _d_a_r_d. --ll List the names of all rreeaaddlliinnee functions. --pp Display rreeaaddlliinnee function names and bindings in such a way that they can be re-read. @@ -110,24 +112,24 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS Cause _s_h_e_l_l_-_c_o_m_m_a_n_d to be executed whenever _k_e_y_s_e_q is en- tered. The separator between _k_e_y_s_e_q and _s_h_e_l_l_-_c_o_m_m_a_n_d is either whitespace or a colon optionally followed by - whitespace. If the separator is whitespace, _s_h_e_l_l_-_c_o_m_m_a_n_d - must be enclosed in double quotes and rreeaaddlliinnee expands - any of its special backslash-escapes in _s_h_e_l_l_-_c_o_m_m_a_n_d be- - fore saving it. If the separator is a colon, any enclos- - ing double quotes are optional, and rreeaaddlliinnee does not ex- - pand the command string before saving it. Since the en- - tire key binding expression must be a single argument, it - should be enclosed in quotes. When _s_h_e_l_l_-_c_o_m_m_a_n_d is exe- - cuted, the shell sets the RREEAADDLLIINNEE__LLIINNEE variable to the - contents of the rreeaaddlliinnee line buffer and the RREEAADD-- - LLIINNEE__PPOOIINNTT and RREEAADDLLIINNEE__MMAARRKK variables to the current lo- - cation of the insertion point and the saved insertion - point (the mark), respectively. The shell assigns any nu- - meric argument the user supplied to the RREEAADDLLIINNEE__AARRGGUUMMEENNTT - variable. If there was no argument, that variable is not - set. If the executed command changes the value of any of - RREEAADDLLIINNEE__LLIINNEE, RREEAADDLLIINNEE__PPOOIINNTT, or RREEAADDLLIINNEE__MMAARRKK, those - new values will be reflected in the editing state. + whitespace. If the separator is whitespace, _s_h_e_l_l_-_c_o_m_- + _m_a_n_d must be enclosed in double quotes and rreeaaddlliinnee ex- + pands any of its special backslash-escapes in _s_h_e_l_l_-_c_o_m_- + _m_a_n_d before saving it. If the separator is a colon, any + enclosing double quotes are optional, and rreeaaddlliinnee does + not expand the command string before saving it. Since + the entire key binding expression must be a single argu- + ment, it should be enclosed in quotes. When _s_h_e_l_l_-_c_o_m_- + _m_a_n_d is executed, the shell sets the RREEAADDLLIINNEE__LLIINNEE vari- + able to the contents of the rreeaaddlliinnee line buffer and the + RREEAADDLLIINNEE__PPOOIINNTT and RREEAADDLLIINNEE__MMAARRKK variables to the current + location of the insertion point and the saved insertion + point (the mark), respectively. The shell assigns any + numeric argument the user supplied to the RREEAADDLLIINNEE__AARRGGUU-- + MMEENNTT variable. If there was no argument, that variable + is not set. If the executed command changes the value of + any of RREEAADDLLIINNEE__LLIINNEE, RREEAADDLLIINNEE__PPOOIINNTT, or RREEAADDLLIINNEE__MMAARRKK, + those new values will be reflected in the editing state. --XX List all key sequences bound to shell commands and the associated commands in a format that can be reused as in- put. @@ -136,401 +138,402 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS an error occurred. bbrreeaakk [_n] - Exit from within a ffoorr, wwhhiillee, uunnttiill, or sseelleecctt loop. If _n is - specified, break _n levels. _n must be >= 1. If _n is greater than - the number of enclosing loops, all enclosing loops are exited. - The return value is 0 unless _n is not greater than or equal to - 1. + Exit from within a ffoorr, wwhhiillee, uunnttiill, or sseelleecctt loop. If _n is + specified, break _n levels. _n must be >= 1. If _n is greater + than the number of enclosing loops, all enclosing loops are ex- + ited. The return value is 0 unless _n is not greater than or + equal to 1. bbuuiillttiinn _s_h_e_l_l_-_b_u_i_l_t_i_n [_a_r_g_u_m_e_n_t_s] Execute the specified shell builtin, passing it _a_r_g_u_m_e_n_t_s, and - return its exit status. This is useful when defining a function + return its exit status. This is useful when defining a function whose name is the same as a shell builtin, retaining the func- - tionality of the builtin within the function. The ccdd builtin is - commonly redefined this way. The return status is false if + tionality of the builtin within the function. The ccdd builtin is + commonly redefined this way. The return status is false if _s_h_e_l_l_-_b_u_i_l_t_i_n is not a shell builtin command. ccaalllleerr [_e_x_p_r] Returns the context of any active subroutine call (a shell func- - tion or a script executed with the .. or ssoouurrccee builtins). With- + tion or a script executed with the .. or ssoouurrccee builtins). With- out _e_x_p_r, ccaalllleerr displays the line number and source filename of - the current subroutine call. If a non-negative integer is sup- + the current subroutine call. If a non-negative integer is sup- plied as _e_x_p_r, ccaalllleerr displays the line number, subroutine name, and source file corresponding to that position in the current - execution call stack. This extra information may be used, for - example, to print a stack trace. The current frame is frame 0. + execution call stack. This extra information may be used, for + example, to print a stack trace. The current frame is frame 0. The return value is 0 unless the shell is not executing a sub- routine call or _e_x_p_r does not correspond to a valid position in the call stack. ccdd [--LL|[--PP [--ee]]] [-@] [_d_i_r] - Change the current directory to _d_i_r. if _d_i_r is not supplied, the - value of the HHOOMMEE shell variable is the default. The variable - CCDDPPAATTHH defines the search path for the directory containing _d_i_r: - each directory name in CCDDPPAATTHH is searched for _d_i_r. Alternative - directory names in CCDDPPAATTHH are separated by a colon (:). A null - directory name in CCDDPPAATTHH is the same as the current directory, - i.e., ``..''. If _d_i_r begins with a slash (/), then CCDDPPAATTHH is not - used. The --PP option causes ccdd to use the physical directory - structure by resolving symbolic links while traversing _d_i_r and - before processing instances of _._. in _d_i_r (see also the --PP option - to the sseett builtin command); the --LL option forces symbolic links - to be followed by resolving the link after processing instances - of _._. in _d_i_r. If _._. appears in _d_i_r, it is processed by removing - the immediately previous pathname component from _d_i_r, back to a - slash or the beginning of _d_i_r. If the --ee option is supplied with - --PP, and the current working directory cannot be successfully de- - termined after a successful directory change, ccdd will return an - unsuccessful status. On systems that support it, the --@@ option - presents the extended attributes associated with a file as a di- - rectory. An argument of -- is converted to $$OOLLDDPPWWDD before the di- - rectory change is attempted. If a non-empty directory name from - CCDDPPAATTHH is used, or if -- is the first argument, and the directory - change is successful, the absolute pathname of the new working - directory is written to the standard output. If the directory - change is successful, ccdd sets the value of the PPWWDD environment - variable to the new directory name, and sets the OOLLDDPPWWDD environ- - ment variable to the value of the current working directory be- - fore the change. The return value is true if the directory was - successfully changed; false otherwise. + Change the current directory to _d_i_r. if _d_i_r is not supplied, + the value of the HHOOMMEE shell variable is the default. The vari- + able CCDDPPAATTHH defines the search path for the directory containing + _d_i_r: each directory name in CCDDPPAATTHH is searched for _d_i_r. Alter- + native directory names in CCDDPPAATTHH are separated by a colon (:). + A null directory name in CCDDPPAATTHH is the same as the current di- + rectory, i.e., ``..''. If _d_i_r begins with a slash (/), then CCDD-- + PPAATTHH is not used. The --PP option causes ccdd to use the physical + directory structure by resolving symbolic links while traversing + _d_i_r and before processing instances of _._. in _d_i_r (see also the + --PP option to the sseett builtin command); the --LL option forces sym- + bolic links to be followed by resolving the link after process- + ing instances of _._. in _d_i_r. If _._. appears in _d_i_r, it is pro- + cessed by removing the immediately previous pathname component + from _d_i_r, back to a slash or the beginning of _d_i_r. If the --ee + option is supplied with --PP, and the current working directory + cannot be successfully determined after a successful directory + change, ccdd will return an unsuccessful status. On systems that + support it, the --@@ option presents the extended attributes asso- + ciated with a file as a directory. An argument of -- is con- + verted to $$OOLLDDPPWWDD before the directory change is attempted. If + a non-empty directory name from CCDDPPAATTHH is used, or if -- is the + first argument, and the directory change is successful, the ab- + solute pathname of the new working directory is written to the + standard output. If the directory change is successful, ccdd sets + the value of the PPWWDD environment variable to the new directory + name, and sets the OOLLDDPPWWDD environment variable to the value of + the current working directory before the change. The return + value is true if the directory was successfully changed; false + otherwise. ccoommmmaanndd [--ppVVvv] _c_o_m_m_a_n_d [_a_r_g ...] - Run _c_o_m_m_a_n_d with _a_r_g_s suppressing the normal shell function + Run _c_o_m_m_a_n_d with _a_r_g_s suppressing the normal shell function lookup. Only builtin commands or commands found in the PPAATTHH are - executed. If the --pp option is given, the search for _c_o_m_m_a_n_d is - performed using a default value for PPAATTHH that is guaranteed to - find all of the standard utilities. If either the --VV or --vv op- - tion is supplied, a description of _c_o_m_m_a_n_d is printed. The --vv - option causes a single word indicating the command or filename + executed. If the --pp option is given, the search for _c_o_m_m_a_n_d is + performed using a default value for PPAATTHH that is guaranteed to + find all of the standard utilities. If either the --VV or --vv op- + tion is supplied, a description of _c_o_m_m_a_n_d is printed. The --vv + option causes a single word indicating the command or filename used to invoke _c_o_m_m_a_n_d to be displayed; the --VV option produces a - more verbose description. If the --VV or --vv option is supplied, - the exit status is 0 if _c_o_m_m_a_n_d was found, and 1 if not. If nei- - ther option is supplied and an error occurred or _c_o_m_m_a_n_d cannot - be found, the exit status is 127. Otherwise, the exit status of - the ccoommmmaanndd builtin is the exit status of _c_o_m_m_a_n_d. + more verbose description. If the --VV or --vv option is supplied, + the exit status is 0 if _c_o_m_m_a_n_d was found, and 1 if not. If + neither option is supplied and an error occurred or _c_o_m_m_a_n_d can- + not be found, the exit status is 127. Otherwise, the exit sta- + tus of the ccoommmmaanndd builtin is the exit status of _c_o_m_m_a_n_d. ccoommppggeenn [--VV _v_a_r_n_a_m_e] [_o_p_t_i_o_n] [_w_o_r_d] - Generate possible completion matches for _w_o_r_d according to the - _o_p_t_i_o_ns, which may be any option accepted by the ccoommpplleettee + Generate possible completion matches for _w_o_r_d according to the + _o_p_t_i_o_ns, which may be any option accepted by the ccoommpplleettee builtin with the exceptions of --pp, --rr, --DD, --EE, and --II, and write - the matches to the standard output. If the --VV option is sup- + the matches to the standard output. If the --VV option is sup- plied, ccoommppggeenn stores the generated completions into the indexed - array variable _v_a_r_n_a_m_e instead of writing them to the standard - output. When using the --FF or --CC options, the various shell vari- - ables set by the programmable completion facilities, while + array variable _v_a_r_n_a_m_e instead of writing them to the standard + output. When using the --FF or --CC options, the various shell + variables set by the programmable completion facilities, while available, will not have useful values. The matches will be generated in the same way as if the program- mable completion code had generated them directly from a comple- - tion specification with the same flags. If _w_o_r_d is specified, + tion specification with the same flags. If _w_o_r_d is specified, only those completions matching _w_o_r_d will be displayed. - The return value is true unless an invalid option is supplied, + The return value is true unless an invalid option is supplied, or no matches were generated. ccoommpplleettee [--aabbccddeeffggjjkkssuuvv] [--oo _c_o_m_p_-_o_p_t_i_o_n] [--DDEEII] [--AA _a_c_t_i_o_n] [--GG _g_l_o_b_p_a_t] [--WW _w_o_r_d_l_i_s_t] [--FF _f_u_n_c_t_i_o_n] [--CC _c_o_m_m_a_n_d] [--XX _f_i_l_t_e_r_p_a_t] [--PP _p_r_e_f_i_x] [--SS _s_u_f_f_i_x] _n_a_m_e [_n_a_m_e _._._.] ccoommpplleettee --pprr [--DDEEII] [_n_a_m_e ...] - Specify how arguments to each _n_a_m_e should be completed. If the - --pp option is supplied, or if no options are supplied, existing - completion specifications are printed in a way that allows them - to be reused as input. The --rr option removes a completion speci- - fication for each _n_a_m_e, or, if no _n_a_m_es are supplied, all com- - pletion specifications. The --DD option indicates that other sup- - plied options and actions should apply to the ``default'' com- - mand completion; that is, completion attempted on a command for - which no completion has previously been defined. The --EE option - indicates that other supplied options and actions should apply - to ``empty'' command completion; that is, completion attempted - on a blank line. The --II option indicates that other supplied op- - tions and actions should apply to completion on the initial non- - assignment word on the line, or after a command delimiter such - as ;; or ||, which is usually command name completion. If multiple - options are supplied, the --DD option takes precedence over --EE, - and both take precedence over --II. If any of --DD, --EE, or --II are - supplied, any other _n_a_m_e arguments are ignored; these comple- - tions only apply to the case specified by the option. + Specify how arguments to each _n_a_m_e should be completed. If the + --pp option is supplied, or if no options are supplied, existing + completion specifications are printed in a way that allows them + to be reused as input. The --rr option removes a completion spec- + ification for each _n_a_m_e, or, if no _n_a_m_es are supplied, all com- + pletion specifications. The --DD option indicates that other sup- + plied options and actions should apply to the ``default'' com- + mand completion; that is, completion attempted on a command for + which no completion has previously been defined. The --EE option + indicates that other supplied options and actions should apply + to ``empty'' command completion; that is, completion attempted + on a blank line. The --II option indicates that other supplied + options and actions should apply to completion on the initial + non-assignment word on the line, or after a command delimiter + such as ;; or ||, which is usually command name completion. If + multiple options are supplied, the --DD option takes precedence + over --EE, and both take precedence over --II. If any of --DD, --EE, or + --II are supplied, any other _n_a_m_e arguments are ignored; these + completions only apply to the case specified by the option. - The process of applying these completion specifications when + The process of applying these completion specifications when word completion is attempted is described in _b_a_s_h_(_1_). - Other options, if specified, have the following meanings. The - arguments to the --GG, --WW, and --XX options (and, if necessary, the - --PP and --SS options) should be quoted to protect them from expan- + Other options, if specified, have the following meanings. The + arguments to the --GG, --WW, and --XX options (and, if necessary, the + --PP and --SS options) should be quoted to protect them from expan- sion before the ccoommpplleettee builtin is invoked. --oo _c_o_m_p_-_o_p_t_i_o_n - The _c_o_m_p_-_o_p_t_i_o_n controls several aspects of the comp- - spec's behavior beyond the simple generation of comple- - tions. _c_o_m_p_-_o_p_t_i_o_n may be one of: + The _c_o_m_p_-_o_p_t_i_o_n controls several aspects of the comp- + spec's behavior beyond the simple generation of comple- + tions. _c_o_m_p_-_o_p_t_i_o_n may be one of: bbaasshhddeeffaauulltt Perform the rest of the default bbaasshh completions if the compspec generates no matches. - ddeeffaauulltt Use readline's default filename completion if + ddeeffaauulltt Use readline's default filename completion if the compspec generates no matches. ddiirrnnaammeess - Perform directory name completion if the comp- + Perform directory name completion if the comp- spec generates no matches. ffiilleennaammeess - Tell readline that the compspec generates file- - names, so it can perform any filename-specific - processing (like adding a slash to directory - names, quoting special characters, or suppress- - ing trailing spaces). Intended to be used with + Tell readline that the compspec generates file- + names, so it can perform any filename-specific + processing (like adding a slash to directory + names, quoting special characters, or suppress- + ing trailing spaces). Intended to be used with shell functions. ffuullllqquuoottee - Tell readline to quote all the completed words + Tell readline to quote all the completed words even if they are not filenames. - nnooqquuoottee Tell readline not to quote the completed words - if they are filenames (quoting filenames is the + nnooqquuoottee Tell readline not to quote the completed words + if they are filenames (quoting filenames is the default). - nnoossoorrtt Tell readline not to sort the list of possible + nnoossoorrtt Tell readline not to sort the list of possible completions alphabetically. - nnoossppaaccee Tell readline not to append a space (the de- - fault) to words completed at the end of the + nnoossppaaccee Tell readline not to append a space (the de- + fault) to words completed at the end of the line. pplluussddiirrss - After any matches defined by the compspec are + After any matches defined by the compspec are generated, directory name completion is at- tempted and any matches are added to the results of the other actions. --AA _a_c_t_i_o_n - The _a_c_t_i_o_n may be one of the following to generate a + The _a_c_t_i_o_n may be one of the following to generate a list of possible completions: - aalliiaass Alias names. May also be specified as --aa. + aalliiaass Alias names. May also be specified as --aa. aarrrraayyvvaarr Array variable names. bbiinnddiinngg RReeaaddlliinnee key binding names. - bbuuiillttiinn Names of shell builtin commands. May also be + bbuuiillttiinn Names of shell builtin commands. May also be specified as --bb. - ccoommmmaanndd Command names. May also be specified as --cc. + ccoommmmaanndd Command names. May also be specified as --cc. ddiirreeccttoorryy - Directory names. May also be specified as --dd. + Directory names. May also be specified as --dd. ddiissaabblleedd Names of disabled shell builtins. eennaabblleedd Names of enabled shell builtins. - eexxppoorrtt Names of exported shell variables. May also be + eexxppoorrtt Names of exported shell variables. May also be specified as --ee. - ffiillee File names. May also be specified as --ff. + ffiillee File names. May also be specified as --ff. ffuunnccttiioonn Names of shell functions. - ggrroouupp Group names. May also be specified as --gg. + ggrroouupp Group names. May also be specified as --gg. hheellppttooppiicc Help topics as accepted by the hheellpp builtin. hhoossttnnaammee - Hostnames, as taken from the file specified by + Hostnames, as taken from the file specified by the HHOOSSTTFFIILLEE shell variable. - jjoobb Job names, if job control is active. May also be - specified as --jj. - kkeeyywwoorrdd Shell reserved words. May also be specified as + jjoobb Job names, if job control is active. May also + be specified as --jj. + kkeeyywwoorrdd Shell reserved words. May also be specified as --kk. rruunnnniinngg Names of running jobs, if job control is active. - sseerrvviiccee Service names. May also be specified as --ss. - sseettoopptt Valid arguments for the --oo option to the sseett + sseerrvviiccee Service names. May also be specified as --ss. + sseettoopptt Valid arguments for the --oo option to the sseett builtin. - sshhoopptt Shell option names as accepted by the sshhoopptt + sshhoopptt Shell option names as accepted by the sshhoopptt builtin. ssiiggnnaall Signal names. ssttooppppeedd Names of stopped jobs, if job control is active. - uusseerr User names. May also be specified as --uu. + uusseerr User names. May also be specified as --uu. vvaarriiaabbllee - Names of all shell variables. May also be speci- - fied as --vv. + Names of all shell variables. May also be spec- + ified as --vv. --CC _c_o_m_m_a_n_d - _c_o_m_m_a_n_d is executed in a subshell environment, and its - output is used as the possible completions. Arguments + _c_o_m_m_a_n_d is executed in a subshell environment, and its + output is used as the possible completions. Arguments are passed as with the --FF option. --FF _f_u_n_c_t_i_o_n - The shell function _f_u_n_c_t_i_o_n is executed in the current - shell environment. When the function is executed, the + The shell function _f_u_n_c_t_i_o_n is executed in the current + shell environment. When the function is executed, the first argument ($$11) is the name of the command whose ar- guments are being completed, the second argument ($$22) is the word being completed, and the third argument ($$33) is - the word preceding the word being completed on the cur- - rent command line. When it finishes, the possible com- - pletions are retrieved from the value of the CCOOMMPPRREEPPLLYY + the word preceding the word being completed on the cur- + rent command line. When it finishes, the possible com- + pletions are retrieved from the value of the CCOOMMPPRREEPPLLYY array variable. --GG _g_l_o_b_p_a_t - The pathname expansion pattern _g_l_o_b_p_a_t is expanded to + The pathname expansion pattern _g_l_o_b_p_a_t is expanded to generate the possible completions. --PP _p_r_e_f_i_x - _p_r_e_f_i_x is added at the beginning of each possible com- + _p_r_e_f_i_x is added at the beginning of each possible com- pletion after all other options have been applied. --SS _s_u_f_f_i_x _s_u_f_f_i_x is appended to each possible completion after all other options have been applied. --WW _w_o_r_d_l_i_s_t - The _w_o_r_d_l_i_s_t is split using the characters in the IIFFSS - special variable as delimiters, and each resultant word - is expanded. Shell quoting is honored within _w_o_r_d_l_i_s_t, + The _w_o_r_d_l_i_s_t is split using the characters in the IIFFSS + special variable as delimiters, and each resultant word + is expanded. Shell quoting is honored within _w_o_r_d_l_i_s_t, in order to provide a mechanism for the words to contain - shell metacharacters or characters in the value of IIFFSS. - The possible completions are the members of the resul- + shell metacharacters or characters in the value of IIFFSS. + The possible completions are the members of the resul- tant list which match the word being completed. --XX _f_i_l_t_e_r_p_a_t - _f_i_l_t_e_r_p_a_t is a pattern as used for pathname expansion. + _f_i_l_t_e_r_p_a_t is a pattern as used for pathname expansion. It is applied to the list of possible completions gener- - ated by the preceding options and arguments, and each - completion matching _f_i_l_t_e_r_p_a_t is removed from the list. - A leading !! in _f_i_l_t_e_r_p_a_t negates the pattern; in this + ated by the preceding options and arguments, and each + completion matching _f_i_l_t_e_r_p_a_t is removed from the list. + A leading !! in _f_i_l_t_e_r_p_a_t negates the pattern; in this case, any completion not matching _f_i_l_t_e_r_p_a_t is removed. - The return value is true unless an invalid option is supplied, + The return value is true unless an invalid option is supplied, an option other than --pp, --rr, --DD, --EE, or --II is supplied without a - _n_a_m_e argument, an attempt is made to remove a completion speci- + _n_a_m_e argument, an attempt is made to remove a completion speci- fication for a _n_a_m_e for which no specification exists, or an er- ror occurs adding a completion specification. ccoommppoopptt [--oo _o_p_t_i_o_n] [--DDEEII] [++oo _o_p_t_i_o_n] [_n_a_m_e] - Modify completion options for each _n_a_m_e according to the _o_p_- + Modify completion options for each _n_a_m_e according to the _o_p_- _t_i_o_ns, or for the currently-executing completion if no _n_a_m_es are - supplied. If no _o_p_t_i_o_ns are given, display the completion op- - tions for each _n_a_m_e or the current completion. The possible val- - ues of _o_p_t_i_o_n are those valid for the ccoommpplleettee builtin described - above. The --DD option indicates that other supplied options - should apply to the ``default'' command completion; that is, - completion attempted on a command for which no completion has - previously been defined. The --EE option indicates that other sup- - plied options should apply to ``empty'' command completion; that - is, completion attempted on a blank line. The --II option indi- - cates that other supplied options should apply to completion on - the initial non-assignment word on the line, or after a command - delimiter such as ;; or ||, which is usually command name comple- - tion. + supplied. If no _o_p_t_i_o_ns are given, display the completion op- + tions for each _n_a_m_e or the current completion. The possible + values of _o_p_t_i_o_n are those valid for the ccoommpplleettee builtin de- + scribed above. The --DD option indicates that other supplied op- + tions should apply to the ``default'' command completion; that + is, completion attempted on a command for which no completion + has previously been defined. The --EE option indicates that other + supplied options should apply to ``empty'' command completion; + that is, completion attempted on a blank line. The --II option + indicates that other supplied options should apply to completion + on the initial non-assignment word on the line, or after a com- + mand delimiter such as ;; or ||, which is usually command name + completion. - The return value is true unless an invalid option is supplied, + The return value is true unless an invalid option is supplied, an attempt is made to modify the options for a _n_a_m_e for which no completion specification exists, or an output error occurs. ccoonnttiinnuuee [_n] Resume the next iteration of the enclosing ffoorr, wwhhiillee, uunnttiill, or - sseelleecctt loop. If _n is specified, resume at the _nth enclosing - loop. _n must be >= 1. If _n is greater than the number of enclos- - ing loops, the last enclosing loop (the ``top-level'' loop) is - resumed. The return value is 0 unless _n is not greater than or - equal to 1. + sseelleecctt loop. If _n is specified, resume at the _nth enclosing + loop. _n must be >= 1. If _n is greater than the number of en- + closing loops, the last enclosing loop (the ``top-level'' loop) + is resumed. The return value is 0 unless _n is not greater than + or equal to 1. ddeeccllaarree [--aaAAffFFggiiIIllnnrrttuuxx] [--pp] [_n_a_m_e[=_v_a_l_u_e] ...] ttyyppeesseett [--aaAAffFFggiiIIllnnrrttuuxx] [--pp] [_n_a_m_e[=_v_a_l_u_e] ...] - Declare variables and/or give them attributes. If no _n_a_m_es are - given then display the values of variables. The --pp option will - display the attributes and values of each _n_a_m_e. When --pp is used - with _n_a_m_e arguments, additional options, other than --ff and --FF, - are ignored. When --pp is supplied without _n_a_m_e arguments, it will - display the attributes and values of all variables having the - attributes specified by the additional options. If no other op- - tions are supplied with --pp, ddeeccllaarree will display the attributes - and values of all shell variables. The --ff option will restrict - the display to shell functions. The --FF option inhibits the dis- - play of function definitions; only the function name and at- - tributes are printed. If the eexxttddeebbuugg shell option is enabled - using sshhoopptt, the source file name and line number where each - _n_a_m_e is defined are displayed as well. The --FF option implies --ff. - The --gg option forces variables to be created or modified at the - global scope, even when ddeeccllaarree is executed in a shell function. - It is ignored in all other cases. The --II option causes local - variables to inherit the attributes (except the _n_a_m_e_r_e_f attri- - bute) and value of any existing variable with the same _n_a_m_e at a - surrounding scope. If there is no existing variable, the local - variable is initially unset. The following options can be used - to restrict output to variables with the specified attribute or - to give variables attributes: - --aa Each _n_a_m_e is an indexed array variable (see AArrrraayyss in + Declare variables and/or give them attributes. If no _n_a_m_es are + given then display the values of variables. The --pp option will + display the attributes and values of each _n_a_m_e. When --pp is used + with _n_a_m_e arguments, additional options, other than --ff and --FF, + are ignored. When --pp is supplied without _n_a_m_e arguments, it + will display the attributes and values of all variables having + the attributes specified by the additional options. If no other + options are supplied with --pp, ddeeccllaarree will display the at- + tributes and values of all shell variables. The --ff option will + restrict the display to shell functions. The --FF option inhibits + the display of function definitions; only the function name and + attributes are printed. If the eexxttddeebbuugg shell option is enabled + using sshhoopptt, the source file name and line number where each + _n_a_m_e is defined are displayed as well. The --FF option implies + --ff. The --gg option forces variables to be created or modified at + the global scope, even when ddeeccllaarree is executed in a shell func- + tion. It is ignored in all other cases. The --II option causes + local variables to inherit the attributes (except the _n_a_m_e_r_e_f + attribute) and value of any existing variable with the same _n_a_m_e + at a surrounding scope. If there is no existing variable, the + local variable is initially unset. The following options can be + used to restrict output to variables with the specified attri- + bute or to give variables attributes: + --aa Each _n_a_m_e is an indexed array variable (see AArrrraayyss in _b_a_s_h_(_1_)). --AA Each _n_a_m_e is an associative array variable (see AArrrraayyss in _b_a_s_h_(_1_)). --ff Use function names only. --ii The variable is treated as an integer; arithmetic evalua- - tion (see AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN in _b_a_s_h_(_1_)) is performed + tion (see AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN in _b_a_s_h_(_1_)) is performed when the variable is assigned a value. - --ll When the variable is assigned a value, all upper-case - characters are converted to lower-case. The upper-case + --ll When the variable is assigned a value, all upper-case + characters are converted to lower-case. The upper-case attribute is disabled. - --nn Give each _n_a_m_e the _n_a_m_e_r_e_f attribute, making it a name - reference to another variable. That other variable is de- - fined by the value of _n_a_m_e. All references, assignments, - and attribute modifications to _n_a_m_e, except those using - or changing the --nn attribute itself, are performed on the - variable referenced by _n_a_m_e's value. The nameref attri- - bute cannot be applied to array variables. - --rr Make _n_a_m_es readonly. These names cannot then be assigned + --nn Give each _n_a_m_e the _n_a_m_e_r_e_f attribute, making it a name + reference to another variable. That other variable is + defined by the value of _n_a_m_e. All references, assign- + ments, and attribute modifications to _n_a_m_e, except those + using or changing the --nn attribute itself, are performed + on the variable referenced by _n_a_m_e's value. The nameref + attribute cannot be applied to array variables. + --rr Make _n_a_m_es readonly. These names cannot then be assigned values by subsequent assignment statements or unset. - --tt Give each _n_a_m_e the _t_r_a_c_e attribute. Traced functions in- - herit the DDEEBBUUGG and RREETTUURRNN traps from the calling shell. + --tt Give each _n_a_m_e the _t_r_a_c_e attribute. Traced functions in- + herit the DDEEBBUUGG and RREETTUURRNN traps from the calling shell. The trace attribute has no special meaning for variables. - --uu When the variable is assigned a value, all lower-case - characters are converted to upper-case. The lower-case + --uu When the variable is assigned a value, all lower-case + characters are converted to upper-case. The lower-case attribute is disabled. - --xx Mark _n_a_m_es for export to subsequent commands via the en- + --xx Mark _n_a_m_es for export to subsequent commands via the en- vironment. - Using `+' instead of `-' turns off the attribute instead, with - the exceptions that ++aa and ++AA may not be used to destroy array - variables and ++rr will not remove the readonly attribute. When + Using `+' instead of `-' turns off the attribute instead, with + the exceptions that ++aa and ++AA may not be used to destroy array + variables and ++rr will not remove the readonly attribute. When used in a function, ddeeccllaarree and ttyyppeesseett make each _n_a_m_e local, as - with the llooccaall command, unless the --gg option is supplied. If a - variable name is followed by =_v_a_l_u_e, the value of the variable - is set to _v_a_l_u_e. When using --aa or --AA and the compound assignment - syntax to create array variables, additional attributes do not - take effect until subsequent assignments. 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 + with the llooccaall command, unless the --gg option is supplied. If a + variable name is followed by =_v_a_l_u_e, the value of the variable + is set to _v_a_l_u_e. When using --aa or --AA and the compound assign- + ment syntax to create array variables, additional attributes do + not take effect until subsequent assignments. 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 as- sign a value to an array variable without using the compound as- signment syntax (see AArrrraayyss in _b_a_s_h_(_1_)), one of the _n_a_m_e_s 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 + 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 --ff. ddiirrss [[--ccllppvv]] [[++_n]] [[--_n]] - Without options, displays the list of currently remembered di- - rectories. The default display is on a single line with direc- - tory names separated by spaces. Directories are added to the - list with the ppuusshhdd command; the ppooppdd command removes entries - from the list. The current directory is always the first direc- + Without options, displays the list of currently remembered di- + rectories. The default display is on a single line with direc- + tory names separated by spaces. Directories are added to the + list with the ppuusshhdd command; the ppooppdd command removes entries + from the list. The current directory is always the first direc- tory in the stack. - --cc Clears the directory stack by deleting all of the en- + --cc Clears the directory stack by deleting all of the en- tries. - --ll Produces a listing using full pathnames; the default + --ll Produces a listing using full pathnames; the default listing format uses a tilde to denote the home directory. --pp Print the directory stack with one entry per line. - --vv Print the directory stack with one entry per line, pre- + --vv Print the directory stack with one entry per line, pre- fixing each entry with its index in the stack. ++_n Displays the _nth entry counting from the left of the list shown by ddiirrss when invoked without options, starting with zero. - --_n Displays the _nth entry counting from the right of the + --_n Displays the _nth entry counting from the right of the list shown by ddiirrss when invoked without options, starting with zero. - The return value is 0 unless an invalid option is supplied or _n + The return value is 0 unless an invalid option is supplied or _n indexes beyond the end of the directory stack. ddiissoowwnn [--aarr] [--hh] [_j_o_b_s_p_e_c ... | _p_i_d ... ] - Without options, remove each _j_o_b_s_p_e_c from the table of active - jobs. If _j_o_b_s_p_e_c is not present, and neither the --aa nor the --rr - option is supplied, the _c_u_r_r_e_n_t _j_o_b is used. If the --hh option is - given, each _j_o_b_s_p_e_c is not removed from the table, but is marked - so that SSIIGGHHUUPP is not sent to the job if the shell receives a - SSIIGGHHUUPP. If no _j_o_b_s_p_e_c is supplied, the --aa option means to remove - or mark all jobs; the --rr option without a _j_o_b_s_p_e_c argument re- - stricts operation to running jobs. The return value is 0 unless - a _j_o_b_s_p_e_c does not specify a valid job. + Without options, remove each _j_o_b_s_p_e_c from the table of active + jobs. If _j_o_b_s_p_e_c is not present, and neither the --aa nor the --rr + option is supplied, the _c_u_r_r_e_n_t _j_o_b is used. If the --hh option + is given, each _j_o_b_s_p_e_c is not removed from the table, but is + marked so that SSIIGGHHUUPP is not sent to the job if the shell re- + ceives a SSIIGGHHUUPP. If no _j_o_b_s_p_e_c is supplied, the --aa option means + to remove or mark all jobs; the --rr option without a _j_o_b_s_p_e_c ar- + gument restricts operation to running jobs. The return value is + 0 unless a _j_o_b_s_p_e_c does not specify a valid job. eecchhoo [--nneeEE] [_a_r_g ...] - Output the _a_r_gs, separated by spaces, followed by a newline. The - return status is 0 unless a write error occurs. If --nn is speci- - fied, the trailing newline is suppressed. If the --ee option is - given, interpretation of the following backslash-escaped charac- - ters is enabled. The --EE option disables the interpretation of - these escape characters, even on systems where they are inter- - preted by default. The xxppgg__eecchhoo shell option may be used to dy- - namically determine whether or not eecchhoo interprets any options - and expands these escape characters by default. eecchhoo does not - interpret ---- to mean the end of options. eecchhoo interprets the - following escape sequences: + Output the _a_r_gs, separated by spaces, followed by a newline. + The return status is 0 unless a write error occurs. If --nn is + specified, the trailing newline is suppressed. If the --ee option + is given, interpretation of the following backslash-escaped + characters is enabled. The --EE option disables the interpreta- + tion of these escape characters, even on systems where they are + interpreted by default. The xxppgg__eecchhoo shell option may be used + to dynamically determine whether or not eecchhoo interprets any op- + tions and expands these escape characters by default. eecchhoo does + not interpret ---- to mean the end of options. eecchhoo interprets + the following escape sequences: \\aa alert (bell) \\bb backspace \\cc suppress further output @@ -542,206 +545,206 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS \\tt horizontal tab \\vv vertical tab \\\\ backslash - \\00_n_n_n the eight-bit character whose value is the octal value + \\00_n_n_n the eight-bit character whose value is the octal value _n_n_n (zero to three octal digits) - \\xx_H_H the eight-bit character whose value is the hexadecimal + \\xx_H_H the eight-bit character whose value is the hexadecimal value _H_H (one or two hex digits) - \\uu_H_H_H_H the Unicode (ISO/IEC 10646) character whose value is the + \\uu_H_H_H_H the Unicode (ISO/IEC 10646) character whose value is the hexadecimal value _H_H_H_H (one to four hex digits) \\UU_H_H_H_H_H_H_H_H - the Unicode (ISO/IEC 10646) character whose value is the + the Unicode (ISO/IEC 10646) character whose value is the hexadecimal value _H_H_H_H_H_H_H_H (one to eight hex digits) eennaabbllee [--aa] [--ddnnppss] [--ff _f_i_l_e_n_a_m_e] [_n_a_m_e ...] - Enable and disable builtin shell commands. Disabling a 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 without specifying a full pathname, even though - the shell normally searches for builtins before disk commands. - If --nn is used, each _n_a_m_e is disabled; otherwise, _n_a_m_e_s are en- - abled. For example, to use the tteesstt binary found via the PPAATTHH - instead of the shell builtin version, run ``enable -n test''. - The --ff option means to load the new builtin command _n_a_m_e from + to be executed without specifying a full pathname, even though + the shell normally searches for builtins before disk commands. + If --nn is used, each _n_a_m_e is disabled; otherwise, _n_a_m_e_s are en- + abled. For example, to use the tteesstt binary found via the PPAATTHH + instead of the shell builtin version, run ``enable -n test''. + The --ff option means to load the new builtin command _n_a_m_e from shared object _f_i_l_e_n_a_m_e, on systems that support dynamic loading. BBaasshh will use the value of the BBAASSHH__LLOOAADDAABBLLEESS__PPAATTHH variable as a colon-separated list of directories in which to search for _f_i_l_e_- - _n_a_m_e. The default is system-dependent. The --dd option will delete - a builtin previously loaded with --ff. If no _n_a_m_e arguments are - given, or if the --pp option is supplied, a list of shell builtins - is printed. With no other option arguments, the list consists of - all enabled shell builtins. If --nn is supplied, only disabled - builtins are printed. If --aa is supplied, the list printed in- - cludes all builtins, with an indication of whether or not each - is enabled. If --ss is supplied, the output is restricted to the - POSIX _s_p_e_c_i_a_l builtins. If no options are supplied and a _n_a_m_e is - not a shell builtin, eennaabbllee will attempt to load _n_a_m_e from a - shared object named _n_a_m_e, as if the command were ``enable -f - _n_a_m_e _n_a_m_e . The return value is 0 unless a _n_a_m_e is not a shell - builtin or there is an error loading a new builtin from a shared - object. + _n_a_m_e. The default is system-dependent. The --dd option will + delete a builtin previously loaded with --ff. If no _n_a_m_e argu- + ments are given, or if the --pp option is supplied, a list of + shell builtins is printed. With no other option arguments, the + list consists of all enabled shell builtins. If --nn is supplied, + only disabled builtins are printed. If --aa is supplied, the list + printed includes all builtins, with an indication of whether or + not each is enabled. If --ss is supplied, the output is re- + stricted to the POSIX _s_p_e_c_i_a_l builtins. If no options are sup- + plied and a _n_a_m_e is not a shell builtin, eennaabbllee will attempt to + load _n_a_m_e from a shared object named _n_a_m_e, as if the command + were ``enable -f _n_a_m_e _n_a_m_e . The return value is 0 unless a + _n_a_m_e is not a shell builtin or there is an error loading a new + builtin from a shared object. eevvaall [_a_r_g ...] - The _a_r_gs are read and concatenated together into a single com- - mand. This command is then read and executed by the shell, and - its exit status is returned as the value of eevvaall. If there are + The _a_r_gs are read and concatenated together into a single com- + mand. This command is then read and executed by the shell, and + its exit status is returned as the value of eevvaall. If there are no _a_r_g_s, or only null arguments, eevvaall returns 0. eexxeecc [--ccll] [--aa _n_a_m_e] [_c_o_m_m_a_n_d [_a_r_g_u_m_e_n_t_s]] - If _c_o_m_m_a_n_d is specified, it replaces the shell. No new process - is created. The _a_r_g_u_m_e_n_t_s become the arguments to _c_o_m_m_a_n_d. If + If _c_o_m_m_a_n_d is specified, it replaces the shell. No new process + is created. The _a_r_g_u_m_e_n_t_s become the arguments to _c_o_m_m_a_n_d. If the --ll option is supplied, the shell places a dash at the begin- - ning of the zeroth argument passed to _c_o_m_m_a_n_d. This is what _l_o_- - _g_i_n(1) does. The --cc option causes _c_o_m_m_a_n_d to be executed with an - empty environment. If --aa is supplied, the shell passes _n_a_m_e as - the zeroth argument to the executed command. If _c_o_m_m_a_n_d cannot - be executed for some reason, a non-interactive shell exits, un- - less the eexxeeccffaaiill shell option is enabled. In that case, it re- - turns failure. An interactive shell returns failure if the file - cannot be executed. A subshell exits unconditionally if eexxeecc - fails. If _c_o_m_m_a_n_d is not specified, any redirections take effect - in the current shell, and the return status is 0. If there is a - redirection error, the return status is 1. + ning of the zeroth argument passed to _c_o_m_m_a_n_d. This is what _l_o_- + _g_i_n(1) does. The --cc option causes _c_o_m_m_a_n_d to be executed with + an empty environment. If --aa is supplied, the shell passes _n_a_m_e + as the zeroth argument to the executed command. If _c_o_m_m_a_n_d can- + not be executed for some reason, a non-interactive shell exits, + unless the eexxeeccffaaiill shell option is enabled. In that case, it + returns failure. An interactive shell returns failure if the + file cannot be executed. A subshell exits unconditionally if + eexxeecc fails. If _c_o_m_m_a_n_d is not specified, any redirections take + effect in the current shell, and the return status is 0. If + there is a redirection error, the return status is 1. eexxiitt [_n] - Cause the shell to exit with a status of _n. If _n is omitted, the - exit status is that of the last command executed. A trap on EEXXIITT - is executed before the shell terminates. + Cause the shell to exit with a status of _n. If _n is omitted, + the exit status is that of the last command executed. A trap on + EEXXIITT is executed before the shell terminates. eexxppoorrtt [--ffnn] [_n_a_m_e[=_w_o_r_d]] ... eexxppoorrtt --pp - The supplied _n_a_m_e_s are marked for automatic export to the envi- - ronment of subsequently executed commands. If the --ff option is - given, the _n_a_m_e_s refer to functions. If no _n_a_m_e_s are given, or - if the --pp option is supplied, a list of names of all exported - variables is printed. The --nn option causes the export property - to be removed from each _n_a_m_e. If a variable name is followed by - =_w_o_r_d, the value of the variable is set to _w_o_r_d. eexxppoorrtt returns + The supplied _n_a_m_e_s are marked for automatic export to the envi- + ronment of subsequently executed commands. If the --ff option is + given, the _n_a_m_e_s refer to functions. If no _n_a_m_e_s are given, or + if the --pp option is supplied, a list of names of all exported + variables is printed. The --nn option causes the export property + to be removed from each _n_a_m_e. If a variable name is followed by + =_w_o_r_d, the value of the variable is set to _w_o_r_d. eexxppoorrtt returns an exit status of 0 unless an invalid option is encountered, one - of the _n_a_m_e_s is not a valid shell variable name, or --ff is sup- + of the _n_a_m_e_s is not a valid shell variable name, or --ff is sup- plied with a _n_a_m_e that is not a function. ffaallssee Does nothing, returns a non-zero status. ffcc [--ee _e_n_a_m_e] [--llnnrr] [_f_i_r_s_t] [_l_a_s_t] ffcc --ss [_p_a_t=_r_e_p] [_c_m_d] - The first form selects a range of commands from _f_i_r_s_t to _l_a_s_t - from the history list and displays or edits and re-executes - them. _F_i_r_s_t and _l_a_s_t may be specified as a string (to locate the - last command beginning with that string) or as a number (an in- - dex into the history list, where a negative number is used as an - offset from the current command number). When listing, a _f_i_r_s_t - or _l_a_s_t of 0 is equivalent to -1 and -0 is equivalent to the - current command (usually the ffcc command); otherwise 0 is equiva- - lent to -1 and -0 is invalid. If _l_a_s_t is not specified, it is - set to the current command for listing (so that ``fc -l -10'' - prints the last 10 commands) and to _f_i_r_s_t otherwise. If _f_i_r_s_t is - not specified, it is set to the previous command for editing and - -16 for listing. + The first form selects a range of commands from _f_i_r_s_t to _l_a_s_t + from the history list and displays or edits and re-executes + them. _F_i_r_s_t and _l_a_s_t may be specified as a string (to locate + the last 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). When listing, a + _f_i_r_s_t or _l_a_s_t of 0 is equivalent to -1 and -0 is equivalent to + the current command (usually the ffcc command); otherwise 0 is + equivalent to -1 and -0 is invalid. If _l_a_s_t is not specified, + it is set to the current command for listing (so that ``fc -l + -10'' prints the last 10 commands) and to _f_i_r_s_t otherwise. If + _f_i_r_s_t is not specified, it is set to the previous command for + editing and -16 for listing. - The --nn option suppresses the command numbers when listing. The - --rr option reverses the order of the commands. If the --ll option - is given, the commands are listed on standard output. Otherwise, - the editor given by _e_n_a_m_e is invoked on a file containing those - commands. If _e_n_a_m_e is not given, the value of the FFCCEEDDIITT vari- - able is used, and the value of EEDDIITTOORR if FFCCEEDDIITT is not set. If - neither variable is set, _v_i is used. When editing is complete, - the edited commands are echoed and executed. + The --nn option suppresses the command numbers when listing. The + --rr option reverses the order of the commands. If the --ll option + is given, the commands are listed on standard output. Other- + wise, the editor given by _e_n_a_m_e is invoked on a file containing + those commands. If _e_n_a_m_e is not given, the value of the FFCCEEDDIITT + variable is used, and the value of EEDDIITTOORR if FFCCEEDDIITT is not set. + If neither variable is set, _v_i is used. When editing is com- + plete, the edited commands are echoed and executed. - In the second form, _c_o_m_m_a_n_d is re-executed after each instance - of _p_a_t is replaced by _r_e_p. _C_o_m_m_a_n_d is interpreted the same as - _f_i_r_s_t above. A useful alias to use with this is ``r="fc -s"'', - so that typing ``r cc'' runs the last command beginning with + In the second form, _c_o_m_m_a_n_d is re-executed after each instance + of _p_a_t is replaced by _r_e_p. _C_o_m_m_a_n_d is interpreted the same as + _f_i_r_s_t above. A useful alias to use with this is ``r="fc -s"'', + so that typing ``r cc'' runs the last command beginning with ``cc'' and typing ``r'' re-executes the last command. - If the first form is used, the return value is 0 unless an in- - valid option is encountered or _f_i_r_s_t or _l_a_s_t specify history - lines out of range. If the --ee option is supplied, the return + If the first form is used, the return value is 0 unless an in- + valid option is encountered or _f_i_r_s_t or _l_a_s_t specify history + lines out of range. If the --ee option is supplied, the return value is the value of the last command executed or failure if an - error occurs with the temporary file of commands. If the second - form is used, the return status is that of the command re-exe- - cuted, unless _c_m_d does not specify a valid history line, in + error occurs with the temporary file of commands. If the second + form is used, the return status is that of the command re-exe- + cuted, unless _c_m_d does not specify a valid history line, in which case ffcc returns failure. ffgg [_j_o_b_s_p_e_c] - Resume _j_o_b_s_p_e_c in the foreground, and make it the current job. + Resume _j_o_b_s_p_e_c in the foreground, and make it the current job. If _j_o_b_s_p_e_c is not present, the shell's notion of the _c_u_r_r_e_n_t _j_o_b - is used. The return value is that of the command placed into the - foreground, or failure if run when job control is disabled or, - when run with job control enabled, if _j_o_b_s_p_e_c does not specify a - valid job or _j_o_b_s_p_e_c specifies a job that was started without - job control. + is used. The return value is that of the command placed into + the foreground, or failure if run when job control is disabled + or, when run with job control enabled, if _j_o_b_s_p_e_c does not spec- + ify a valid job or _j_o_b_s_p_e_c specifies a job that was started + without job control. ggeettooppttss _o_p_t_s_t_r_i_n_g _n_a_m_e [_a_r_g _._._.] - ggeettooppttss is used by shell procedures to parse positional parame- - ters. _o_p_t_s_t_r_i_n_g contains the option characters to be recognized; - if a character is followed by a colon, the option is expected to - have an argument, which should be separated from it by white - space. The colon and question mark characters may not be used as - option characters. Each time it is invoked, ggeettooppttss places the - next option in the shell variable _n_a_m_e, initializing _n_a_m_e if it - does not exist, and the index of the next argument to be pro- - cessed into the variable OOPPTTIINNDD. OOPPTTIINNDD is initialized to 1 each - time the shell or a shell script is invoked. When an option re- - quires an argument, ggeettooppttss places that argument into the vari- - able OOPPTTAARRGG. The shell does not reset OOPPTTIINNDD automatically; it - must be manually reset between multiple calls to ggeettooppttss within - the same shell invocation if a new set of parameters is to be - used. + ggeettooppttss is used by shell procedures to parse positional parame- + ters. _o_p_t_s_t_r_i_n_g contains the option characters to be recog- + nized; if a character is followed by a colon, the option is ex- + pected to have an argument, which should be separated from it by + white space. The colon and question mark characters may not be + used as option characters. Each time it is invoked, ggeettooppttss + places the next option in the shell variable _n_a_m_e, initializing + _n_a_m_e if it does not exist, and the index of the next argument to + be processed into the variable OOPPTTIINNDD. OOPPTTIINNDD is initialized to + 1 each time the shell or a shell script is invoked. When an op- + tion requires an argument, ggeettooppttss places that argument into the + variable OOPPTTAARRGG. The shell does not reset OOPPTTIINNDD automatically; + it must be manually reset between multiple calls to ggeettooppttss + within the same shell invocation if a new set of parameters is + to be used. When the end of options is encountered, ggeettooppttss exits with a re- - turn value greater than zero. OOPPTTIINNDD is set to the index of the + turn value greater than zero. OOPPTTIINNDD is set to the index of the first non-option argument, and _n_a_m_e is set to ?. - ggeettooppttss normally parses the positional parameters, but if more - arguments are supplied as _a_r_g values, ggeettooppttss parses those in- + ggeettooppttss normally parses the positional parameters, but if more + arguments are supplied as _a_r_g values, ggeettooppttss parses those in- stead. - ggeettooppttss can report errors in two ways. If the first character of - _o_p_t_s_t_r_i_n_g is a colon, _s_i_l_e_n_t error reporting is used. In normal - operation, diagnostic messages are printed when invalid options - or missing option arguments are encountered. If the variable - OOPPTTEERRRR is set to 0, no error messages will be displayed, even if - the first character of _o_p_t_s_t_r_i_n_g is not a colon. + ggeettooppttss can report errors in two ways. If the first character + of _o_p_t_s_t_r_i_n_g is a colon, _s_i_l_e_n_t error reporting is used. In + normal operation, diagnostic messages are printed when invalid + options or missing option arguments are encountered. If the + variable OOPPTTEERRRR is set to 0, no error messages will be dis- + played, even if the first character of _o_p_t_s_t_r_i_n_g is not a colon. If an invalid option is seen, ggeettooppttss places ? into _n_a_m_e and, if - not silent, prints an error message and unsets OOPPTTAARRGG. If - ggeettooppttss is silent, the option character found is placed in OOPP-- + not silent, prints an error message and unsets OOPPTTAARRGG. If + ggeettooppttss is silent, the option character found is placed in OOPP-- TTAARRGG and no diagnostic message is printed. - If a required argument is not found, and ggeettooppttss is not silent, - a question mark (??) is placed in _n_a_m_e, OOPPTTAARRGG is unset, and a - diagnostic message is printed. If ggeettooppttss is silent, then a - colon (::) is placed in _n_a_m_e and OOPPTTAARRGG is set to the option + If a required argument is not found, and ggeettooppttss is not silent, + a question mark (??) is placed in _n_a_m_e, OOPPTTAARRGG is unset, and a + diagnostic message is printed. If ggeettooppttss is silent, then a + colon (::) is placed in _n_a_m_e and OOPPTTAARRGG is set to the option character found. - ggeettooppttss returns true if an option, specified or unspecified, is + ggeettooppttss returns true if an option, specified or unspecified, is found. It returns false if the end of options is encountered or an error occurs. hhaasshh [--llrr] [--pp _f_i_l_e_n_a_m_e] [--ddtt] [_n_a_m_e] Each time hhaasshh is invoked, the full pathname of the command _n_a_m_e - is determined by searching the directories in $$PPAATTHH and remem- - bered. Any previously-remembered pathname is discarded. If the - --pp option is supplied, hhaasshh uses _f_i_l_e_n_a_m_e as the full filename - of the command. The --rr option causes the shell to forget all re- - membered locations. Assigning to the PPAATTHH variable also clears - all hashed filenames. The --dd option causes the shell to forget - the remembered location of each _n_a_m_e. If the --tt option is sup- - plied, the full pathname to which each _n_a_m_e corresponds is - printed. If multiple _n_a_m_e arguments are supplied with --tt, the - _n_a_m_e is printed before the hashed full pathname. The --ll option - causes output to be displayed in a format that may be reused as - input. If no arguments are given, or if only --ll is supplied, in- - formation about remembered commands is printed. The --tt, --dd, and - --pp options (the options that act on the _n_a_m_e arguments) are mu- - tually exclusive. Only one will be active. If more than one is - supplied, --tt has higher priority than --pp, and both are higher - priority than --dd. The return status is true unless a _n_a_m_e is not - found or an invalid option is supplied. + is determined by searching the directories in $$PPAATTHH and remem- + bered. Any previously-remembered pathname is discarded. If the + --pp option is supplied, hhaasshh uses _f_i_l_e_n_a_m_e as the full filename + of the command. The --rr option causes the shell to forget all + remembered locations. Assigning to the PPAATTHH variable also + clears all hashed filenames. The --dd option causes the shell to + forget the remembered location of each _n_a_m_e. If the --tt option + is supplied, the full pathname to which each _n_a_m_e corresponds is + printed. If multiple _n_a_m_e arguments are supplied with --tt, the + _n_a_m_e is printed before the hashed full pathname. The --ll option + causes output to be displayed in a format that may be reused as + input. If no arguments are given, or if only --ll is supplied, + information about remembered commands is printed. The --tt, --dd, + and --pp options (the options that act on the _n_a_m_e arguments) are + mutually exclusive. Only one will be active. If more than one + is supplied, --tt has higher priority than --pp, and both are higher + priority than --dd. The return status is true unless a _n_a_m_e is + not found or an invalid option is supplied. hheellpp [--ddmmss] [_p_a_t_t_e_r_n] - Display helpful information about builtin commands. If _p_a_t_t_e_r_n - is specified, hheellpp gives detailed help on all commands matching - _p_a_t_t_e_r_n; otherwise help for all the builtins and shell control + Display helpful information about builtin commands. If _p_a_t_t_e_r_n + is specified, hheellpp gives detailed help on all commands matching + _p_a_t_t_e_r_n; otherwise help for all the builtins and shell control structures is printed. --dd Display a short description of each _p_a_t_t_e_r_n --mm Display the description of each _p_a_t_t_e_r_n in a manpage-like @@ -758,73 +761,73 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS hhiissttoorryy --pp _a_r_g [_a_r_g _._._.] hhiissttoorryy --ss _a_r_g [_a_r_g _._._.] With no options, display the command history list with line num- - bers. Lines listed with a ** have been modified. An argument of _n - lists only the last _n lines. If the shell variable HHIISSTTTTIIMMEEFFOORR-- - MMAATT is set and not null, it is used as a format string for _s_t_r_f_- - _t_i_m_e(3) to display the time stamp associated with each displayed - history entry. No intervening blank is printed between the for- - matted time stamp and the history line. If _f_i_l_e_n_a_m_e is supplied, - it is used as the name of the history file; if not, the value of - HHIISSTTFFIILLEE is used. If _f_i_l_e_n_a_m_e is not supplied and HHIISSTTFFIILLEE is - unset or null, the --aa,, --nn,, --rr,, and --ww options have no effect. - Options, if supplied, have the following meanings: + bers. Lines listed with a ** have been modified. An argument of + _n lists only the last _n lines. If the shell variable HHIISSTTTTIIMMEE-- + FFOORRMMAATT is set and not null, it is used as a format string for + _s_t_r_f_t_i_m_e(3) to display the time stamp associated with each dis- + played history entry. No intervening blank is printed between + the formatted time stamp and the history line. If _f_i_l_e_n_a_m_e is + supplied, it is used as the name of the history file; if not, + the value of HHIISSTTFFIILLEE is used. If _f_i_l_e_n_a_m_e is not supplied and + HHIISSTTFFIILLEE is unset or null, the --aa,, --nn,, --rr,, and --ww options have + no effect. Options, if supplied, have the following meanings: --cc Clear the history list by deleting all the entries. --dd _o_f_f_s_e_t - Delete the history entry at position _o_f_f_s_e_t. If _o_f_f_s_e_t is - negative, it is interpreted as relative to one greater + Delete the history entry at position _o_f_f_s_e_t. If _o_f_f_s_e_t + is negative, it is interpreted as relative to one greater than the last history position, so negative indices count - back from the end of the history, and an index of -1 + back from the end of the history, and an index of -1 refers to the current hhiissttoorryy --dd command. --dd _s_t_a_r_t-_e_n_d - Delete the range of history entries between positions - _s_t_a_r_t and _e_n_d, inclusive. Positive and negative values + Delete the range of history entries between positions + _s_t_a_r_t and _e_n_d, inclusive. Positive and negative values for _s_t_a_r_t and _e_n_d are interpreted as described above. - --aa Append the ``new'' history lines to the history file. - These are history lines entered since the beginning of + --aa Append the ``new'' history lines to the history file. + These are history lines entered since the beginning of the current bbaasshh session, but not already appended to the history file. - --nn Read the history lines not already read from the history - file into the current history list. These are lines ap- - pended to the history file since the beginning of the + --nn Read the history lines not already read from the history + file into the current history list. These are lines ap- + pended to the history file since the beginning of the current bbaasshh session. - --rr Read the contents of the history file and append them to + --rr Read the contents of the history file and append them to the current history list. --ww Write the current history list to the history file, over- writing the history file's contents. - --pp Perform history substitution on the following _a_r_g_s and - display the result on the standard output. Does not store - the results in the history list. Each _a_r_g must be quoted - to disable normal history expansion. - --ss Store the _a_r_g_s in the history list as a single entry. The - last command in the history list is removed before the - _a_r_g_s are added. + --pp Perform history substitution on the following _a_r_g_s and + display the result on the standard output. Does not + store the results in the history list. Each _a_r_g must be + quoted to disable normal history expansion. + --ss Store the _a_r_g_s in the history list as a single entry. + The last command in the history list is removed before + the _a_r_g_s are added. - If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, the time stamp informa- - tion associated with each history entry is written to the his- - tory file, marked with the history comment character. When the - history file is read, lines beginning with the history comment - character followed immediately by a digit are interpreted as - timestamps for the following history entry. The return value is + If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, the time stamp informa- + tion associated with each history entry is written to the his- + tory file, marked with the history comment character. When the + history file is read, lines beginning with the history comment + character followed immediately by a digit are interpreted as + timestamps for the following history entry. The return value is 0 unless an invalid option is encountered, an error occurs while - reading or writing the history file, an invalid _o_f_f_s_e_t or range - is supplied as an argument to --dd, or the history expansion sup- + reading or writing the history file, an invalid _o_f_f_s_e_t or range + is supplied as an argument to --dd, or the history expansion sup- plied as an argument to --pp fails. jjoobbss [--llnnpprrss] [ _j_o_b_s_p_e_c ... ] jjoobbss --xx _c_o_m_m_a_n_d [ _a_r_g_s ... ] - The first form lists the active jobs. The options have the fol- + The first form lists the active jobs. The options have the fol- lowing meanings: --ll List process IDs in addition to the normal information. - --nn Display information only about jobs that have changed + --nn Display information only about jobs that have changed status since the user was last notified of their status. - --pp List only the process ID of the job's process group + --pp List only the process ID of the job's process group leader. --rr Display only running jobs. --ss Display only stopped jobs. - If _j_o_b_s_p_e_c is given, output is restricted to information about - that job. The return status is 0 unless an invalid option is en- - countered or an invalid _j_o_b_s_p_e_c is supplied. + If _j_o_b_s_p_e_c is given, output is restricted to information about + that job. The return status is 0 unless an invalid option is + encountered or an invalid _j_o_b_s_p_e_c is supplied. If the --xx option is supplied, jjoobbss replaces any _j_o_b_s_p_e_c found in _c_o_m_m_a_n_d or _a_r_g_s with the corresponding process group ID, and ex- @@ -832,148 +835,149 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS kkiillll [--ss _s_i_g_s_p_e_c | --nn _s_i_g_n_u_m | --_s_i_g_s_p_e_c] [_p_i_d | _j_o_b_s_p_e_c] ... kkiillll --ll|--LL [_s_i_g_s_p_e_c | _e_x_i_t___s_t_a_t_u_s] - Send the signal named by _s_i_g_s_p_e_c or _s_i_g_n_u_m to the processes - named by _p_i_d or _j_o_b_s_p_e_c. _s_i_g_s_p_e_c is either a case-insensitive - signal name such as SSIIGGKKIILLLL (with or without the SSIIGG prefix) or - a signal number; _s_i_g_n_u_m is a signal number. If _s_i_g_s_p_e_c is not - present, then SSIIGGTTEERRMM is assumed. An argument of --ll lists the - signal names. If any arguments are supplied when --ll is given, - the names of the signals corresponding to the arguments are - listed, and the return status is 0. The _e_x_i_t___s_t_a_t_u_s argument to - --ll is a number specifying either a signal number or the exit - status of a process terminated by a signal. The --LL option is - equivalent to --ll. kkiillll returns true if at least one signal was + Send the signal named by _s_i_g_s_p_e_c or _s_i_g_n_u_m to the processes + named by _p_i_d or _j_o_b_s_p_e_c. _s_i_g_s_p_e_c is either a case-insensitive + signal name such as SSIIGGKKIILLLL (with or without the SSIIGG prefix) or + a signal number; _s_i_g_n_u_m is a signal number. If _s_i_g_s_p_e_c is not + present, then SSIIGGTTEERRMM is assumed. An argument of --ll lists the + signal names. If any arguments are supplied when --ll is given, + the names of the signals corresponding to the arguments are + listed, and the return status is 0. The _e_x_i_t___s_t_a_t_u_s argument to + --ll is a number specifying either a signal number or the exit + status of a process terminated by a signal. The --LL option is + equivalent to --ll. kkiillll returns true if at least one signal was successfully sent, or false if an error occurs or an invalid op- tion is encountered. lleett _a_r_g [_a_r_g ...] Each _a_r_g is an arithmetic expression to be evaluated (see AARRIITTHH-- - MMEETTIICC EEVVAALLUUAATTIIOONN in _b_a_s_h_(_1_)). If the last _a_r_g evaluates to 0, + MMEETTIICC EEVVAALLUUAATTIIOONN in _b_a_s_h_(_1_)). If the last _a_r_g evaluates to 0, lleett returns 1; 0 is returned otherwise. llooccaall [_o_p_t_i_o_n] [_n_a_m_e[=_v_a_l_u_e] ... | - ] - For each argument, a local variable named _n_a_m_e is created, and - assigned _v_a_l_u_e. The _o_p_t_i_o_n can be any of the options accepted by - ddeeccllaarree. When llooccaall is used within a function, it causes the - variable _n_a_m_e to have a visible scope restricted to that func- - tion and its children. If _n_a_m_e is -, the set of shell options is - made local to the function in which llooccaall is invoked: shell op- - tions changed using the sseett builtin inside the function after + For each argument, a local variable named _n_a_m_e is created, and + assigned _v_a_l_u_e. The _o_p_t_i_o_n can be any of the options accepted + by ddeeccllaarree. When llooccaall is used within a function, it causes the + variable _n_a_m_e to have a visible scope restricted to that func- + tion and its children. If _n_a_m_e is -, the set of shell options + is made local to the function in which llooccaall is invoked: shell + options changed using the sseett builtin inside the function after the call to llooccaall are restored to their original values when the - function returns. The restore is effected as if a series of sseett - commands were executed to restore the values that were in place - before the function. With no operands, llooccaall writes a list of - local variables to the standard output. It is an error to use - llooccaall when not within a function. The return status is 0 unless - llooccaall is used outside a function, an invalid _n_a_m_e is supplied, + function returns. The restore is effected as if a series of sseett + commands were executed to restore the values that were in place + before the function. With no operands, llooccaall writes a list of + local variables to the standard output. It is an error to use + llooccaall when not within a function. The return status is 0 unless + llooccaall is used outside a function, an invalid _n_a_m_e is supplied, or _n_a_m_e is a readonly variable. llooggoouutt Exit a login shell. - mmaappffiillee [--dd _d_e_l_i_m] [--nn _c_o_u_n_t] [--OO _o_r_i_g_i_n] [--ss _c_o_u_n_t] [--tt] [--uu _f_d] [--CC + mmaappffiillee [--dd _d_e_l_i_m] [--nn _c_o_u_n_t] [--OO _o_r_i_g_i_n] [--ss _c_o_u_n_t] [--tt] [--uu _f_d] [--CC _c_a_l_l_b_a_c_k] [--cc _q_u_a_n_t_u_m] [_a_r_r_a_y] rreeaaddaarrrraayy [--dd _d_e_l_i_m] [--nn _c_o_u_n_t] [--OO _o_r_i_g_i_n] [--ss _c_o_u_n_t] [--tt] [--uu _f_d] [--CC _c_a_l_l_b_a_c_k] [--cc _q_u_a_n_t_u_m] [_a_r_r_a_y] - Read lines from the standard input into the indexed array vari- - able _a_r_r_a_y, or from file descriptor _f_d if the --uu option is sup- - plied. The variable MMAAPPFFIILLEE is the default _a_r_r_a_y. Options, if + Read lines from the standard input into the indexed array vari- + able _a_r_r_a_y, or from file descriptor _f_d if the --uu option is sup- + plied. The variable MMAAPPFFIILLEE is the default _a_r_r_a_y. Options, if supplied, have the following meanings: - --dd The first character of _d_e_l_i_m is used to terminate each - input line, rather than newline. If _d_e_l_i_m is the empty + --dd The first character of _d_e_l_i_m is used to terminate each + input line, rather than newline. If _d_e_l_i_m is the empty string, mmaappffiillee will terminate a line when it reads a NUL character. - --nn Copy at most _c_o_u_n_t lines. If _c_o_u_n_t is 0, all lines are + --nn Copy at most _c_o_u_n_t lines. If _c_o_u_n_t is 0, all lines are copied. - --OO Begin assigning to _a_r_r_a_y at index _o_r_i_g_i_n. The default in- - dex is 0. + --OO Begin assigning to _a_r_r_a_y at index _o_r_i_g_i_n. The default + index is 0. --ss Discard the first _c_o_u_n_t lines read. - --tt Remove a trailing _d_e_l_i_m (default newline) from each line + --tt Remove a trailing _d_e_l_i_m (default newline) from each line read. - --uu Read lines from file descriptor _f_d instead of the stan- + --uu Read lines from file descriptor _f_d instead of the stan- dard input. - --CC Evaluate _c_a_l_l_b_a_c_k each time _q_u_a_n_t_u_m lines are read. The + --CC Evaluate _c_a_l_l_b_a_c_k each time _q_u_a_n_t_u_m lines are read. The --cc option specifies _q_u_a_n_t_u_m. - --cc Specify the number of lines read between each call to + --cc Specify the number of lines read between each call to _c_a_l_l_b_a_c_k. - If --CC is specified without --cc, the default quantum is 5000. When - _c_a_l_l_b_a_c_k is evaluated, it is supplied the index of the next ar- - ray element to be assigned and the line to be assigned to that - element as additional arguments. _c_a_l_l_b_a_c_k is evaluated after the - line is read but before the array element is assigned. + If --CC is specified without --cc, the default quantum is 5000. + When _c_a_l_l_b_a_c_k is evaluated, it is supplied the index of the next + array element to be assigned and the line to be assigned to that + element as additional arguments. _c_a_l_l_b_a_c_k is evaluated after + the line is read but before the array element is assigned. - If not supplied with an explicit origin, mmaappffiillee will clear _a_r_- + If not supplied with an explicit origin, mmaappffiillee will clear _a_r_- _r_a_y before assigning to it. - mmaappffiillee returns successfully unless an invalid option or option - argument is supplied, _a_r_r_a_y is invalid or unassignable, or if + mmaappffiillee returns successfully unless an invalid option or option + argument is supplied, _a_r_r_a_y is invalid or unassignable, or if _a_r_r_a_y is not an indexed array. ppooppdd [-nn] [+_n] [-_n] - Removes entries from the directory stack. The elements are num- - bered from 0 starting at the first directory listed by ddiirrss. - With no arguments, ppooppdd removes the top directory from the - stack, and changes to the new top directory. Arguments, if sup- + Removes entries from the directory stack. The elements are num- + bered from 0 starting at the first directory listed by ddiirrss. + With no arguments, ppooppdd removes the top directory from the + stack, and changes to the new top directory. Arguments, if sup- plied, have the following meanings: - --nn Suppresses the normal change of directory when removing + --nn Suppresses the normal change of directory when removing directories from the stack, so that only the stack is ma- nipulated. - ++_n Removes the _nth entry counting from the left of the list - shown by ddiirrss, starting with zero, from the stack. For - example: ``popd +0'' removes the first directory, ``popd + ++_n Removes the _nth entry counting from the left of the list + shown by ddiirrss, starting with zero, from the stack. For + example: ``popd +0'' removes the first directory, ``popd +1'' the second. --_n Removes the _nth entry counting from the right of the list - shown by ddiirrss, starting with zero. For example: ``popd - -0'' removes the last directory, ``popd -1'' the next to + shown by ddiirrss, starting with zero. For example: ``popd + -0'' removes the last directory, ``popd -1'' the next to last. - If the top element of the directory stack is modified, and the - _-_n option was not supplied, ppooppdd uses the ccdd builtin to change - to the directory at the top of the stack. If the ccdd fails, ppooppdd + If the top element of the directory stack is modified, and the + _-_n option was not supplied, ppooppdd uses the ccdd builtin to change + to the directory at the top of the stack. If the ccdd fails, ppooppdd returns a non-zero value. - Otherwise, ppooppdd returns false if an invalid option is encoun- + Otherwise, ppooppdd returns false if an invalid option is encoun- tered, the directory stack is empty, or a non-existent directory stack entry is specified. - If the ppooppdd command is successful, bash runs ddiirrss to show the - final contents of the directory stack, and the return status is + If the ppooppdd command is successful, bash runs ddiirrss to show the + final contents of the directory stack, and the return status is 0. pprriinnttff [--vv _v_a_r] _f_o_r_m_a_t [_a_r_g_u_m_e_n_t_s] - Write the formatted _a_r_g_u_m_e_n_t_s to the standard output under the - control of the _f_o_r_m_a_t. The --vv option causes the output to be as- - signed to the variable _v_a_r rather than being printed to the + Write the formatted _a_r_g_u_m_e_n_t_s to the standard output under the + control of the _f_o_r_m_a_t. The --vv option causes the output to be + assigned to the variable _v_a_r rather than being printed to the standard output. - The _f_o_r_m_a_t 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 _a_r_g_u_m_e_n_t. In ad- - dition to the standard _p_r_i_n_t_f(3) format characters ccssnnddiioouuxxXXeeEEff-- - FFggGGaaAA, pprriinnttff interprets the following additional format speci- - fiers: + The _f_o_r_m_a_t 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 _a_r_g_u_m_e_n_t. In + addition to the standard _p_r_i_n_t_f(3) format characters ccssnnddiioouuxxXXee-- + EEffFFggGGaaAA, pprriinnttff interprets the following additional format spec- + ifiers: %%bb causes pprriinnttff to expand backslash escape sequences in the corresponding _a_r_g_u_m_e_n_t in the same way as eecchhoo --ee. - %%qq causes pprriinnttff to output the corresponding _a_r_g_u_m_e_n_t in a - format that can be reused as shell input. %%qq and %%QQ use - the $$'''' quoting style if any characters in the argument - string require it, and backslash quoting otherwise. If - the format string uses the _p_r_i_n_t_f alternate form, these + %%qq causes pprriinnttff to output the corresponding _a_r_g_u_m_e_n_t in a + format that can be reused as shell input. %%qq and %%QQ use + the $$'''' quoting style if any characters in the argument + string require it, and backslash quoting otherwise. If + the format string uses the _p_r_i_n_t_f alternate form, these two formats quote the argument string using single quotes. - %%QQ like %%qq, but applies any supplied precision to the _a_r_g_u_- + %%QQ like %%qq, but applies any supplied precision to the _a_r_g_u_- _m_e_n_t before quoting it. %%((_d_a_t_e_f_m_t))TT - causes pprriinnttff to output the date-time string resulting - from using _d_a_t_e_f_m_t as a format string for _s_t_r_f_t_i_m_e(3). + causes pprriinnttff to output the date-time string resulting + from using _d_a_t_e_f_m_t as a format string for _s_t_r_f_t_i_m_e(3). The corresponding _a_r_g_u_m_e_n_t is an integer representing the - number of seconds since the epoch. Two special argument - values may be used: -1 represents the current time, and - -2 represents the time the shell was invoked. If no argu- - ment is specified, conversion behaves as if -1 had been - given. This is an exception to the usual pprriinnttff behavior. + number of seconds since the epoch. Two special argument + values may be used: -1 represents the current time, and + -2 represents the time the shell was invoked. If no ar- + gument is specified, conversion behaves as if -1 had been + given. This is an exception to the usual pprriinnttff behav- + ior. The %b, %q, and %T format specifiers all use the field width and precision arguments from the format specification and write that @@ -995,18 +999,18 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS is the ASCII value of the following character. The _f_o_r_m_a_t is reused as necessary to consume all of the _a_r_g_u_- - _m_e_n_t_s. If the _f_o_r_m_a_t requires more _a_r_g_u_m_e_n_t_s than are supplied, + _m_e_n_t_s. If the _f_o_r_m_a_t requires more _a_r_g_u_m_e_n_t_s than are supplied, the extra format specifications behave as if a zero value or - null string, as appropriate, had been supplied. The return value - is zero on success, non-zero if an invalid option is supplied or - a write or assignment error occurs. + null string, as appropriate, had been supplied. The return + value is zero on success, non-zero if an invalid option is sup- + plied or a write or assignment error occurs. ppuusshhdd [--nn] [+_n] [-_n] ppuusshhdd [--nn] [_d_i_r] Adds a directory to the top of the directory stack, or rotates the stack, making the new top of the stack the current working - directory. With no arguments, ppuusshhdd exchanges the top two ele- - ments of the directory stack. Arguments, if supplied, have the + directory. With no arguments, ppuusshhdd exchanges the top two ele- + ments of the directory stack. Arguments, if supplied, have the following meanings: --nn Suppresses the normal change of directory when rotating or adding directories to the stack, so that only the @@ -1021,13 +1025,13 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS After the stack has been modified, if the --nn option was not sup- plied, ppuusshhdd uses the ccdd builtin to change to the directory at - the top of the stack. If the ccdd fails, ppuusshhdd returns a non-zero + the top of the stack. If the ccdd fails, ppuusshhdd returns a non-zero value. Otherwise, if no arguments are supplied, ppuusshhdd returns 0 unless - the directory stack is empty. When rotating the directory stack, - ppuusshhdd returns 0 unless the directory stack is empty or a non-ex- - istent directory stack element is specified. + the directory stack is empty. When rotating the directory + stack, ppuusshhdd returns 0 unless the directory stack is empty or a + non-existent directory stack element is specified. If the ppuusshhdd command is successful, bash runs ddiirrss to show the final contents of the directory stack. @@ -1036,8 +1040,8 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS Print the absolute pathname of the current working directory. The pathname printed contains no symbolic links if the --PP option is supplied or the --oo pphhyyssiiccaall option to the sseett builtin command - is enabled. If the --LL option is used, the pathname printed may - contain symbolic links. The return status is 0 unless an error + is enabled. If the --LL option is used, the pathname printed may + contain symbolic links. The return status is 0 unless an error occurs while reading the name of the current directory or an in- valid option is supplied. @@ -1047,19 +1051,19 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS scriptor _f_d supplied as an argument to the --uu option, split into words as described in _b_a_s_h_(_1_) under WWoorrdd SSpplliittttiinngg, and the first word is assigned to the first _n_a_m_e, the second word to the - second _n_a_m_e, and so on. If there are more words than names, the + second _n_a_m_e, and so on. If there are more words than names, the remaining words and their intervening delimiters are assigned to - the last _n_a_m_e. If there are fewer words read from the input + the last _n_a_m_e. If there are fewer words read from the input stream than names, the remaining names are assigned empty val- - ues. The characters in IIFFSS are used to split the line into words - using the same rules the shell uses for expansion (described in - _b_a_s_h_(_1_) under WWoorrdd SSpplliittttiinngg). The backslash character (\\) may - be used to remove any special meaning for the next character - read and for line continuation. Options, if supplied, have the - following meanings: + ues. The characters in IIFFSS are used to split the line into + words using the same rules the shell uses for expansion (de- + scribed in _b_a_s_h_(_1_) under WWoorrdd SSpplliittttiinngg). The backslash charac- + ter (\\) may be used to remove any special meaning for the next + character read and for line continuation. Options, if supplied, + have the following meanings: --aa _a_n_a_m_e The words are assigned to sequential indices of the array - variable _a_n_a_m_e, starting at 0. _a_n_a_m_e is unset before any + variable _a_n_a_m_e, starting at 0. _a_n_a_m_e is unset before any new values are assigned. Other _n_a_m_e arguments are ig- nored. --dd _d_e_l_i_m @@ -1069,12 +1073,12 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS character. --ee If the standard input is coming from a terminal, rreeaadd uses rreeaaddlliinnee (see RREEAADDLLIINNEE in _b_a_s_h_(_1_)) to obtain the - line. Readline uses the current (or default, if line + line. Readline uses the current (or default, if line editing was not previously active) editing settings, but uses readline's default filename completion. --EE If the standard input is coming from a terminal, rreeaadd uses rreeaaddlliinnee (see RREEAADDLLIINNEE in _b_a_s_h_(_1_)) to obtain the - line. Readline uses the current (or default, if line + line. Readline uses the current (or default, if line editing was not previously active) editing settings, but uses bash's default completion, including programmable completion. @@ -1092,40 +1096,40 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS EOF is encountered or rreeaadd times out. Delimiter charac- ters encountered in the input are not treated specially and do not cause rreeaadd to return until _n_c_h_a_r_s characters - are read. The result is not split on the characters in + are read. The result is not split on the characters in IIFFSS; the intent is that the variable is assigned exactly the characters read (with the exception of backslash; see the --rr option below). --pp _p_r_o_m_p_t Display _p_r_o_m_p_t on standard error, without a trailing new- - line, before attempting to read any input. The prompt is + line, before attempting to read any input. The prompt is displayed only if input is coming from a terminal. - --rr Backslash does not act as an escape character. The back- - slash is considered to be part of the line. In particu- + --rr Backslash does not act as an escape character. The back- + slash is considered to be part of the line. In particu- lar, a backslash-newline pair may not then be used as a line continuation. - --ss Silent mode. If input is coming from a terminal, charac- + --ss Silent mode. If input is coming from a terminal, charac- ters are not echoed. --tt _t_i_m_e_o_u_t Cause rreeaadd to time out and return failure if a complete line of input (or a specified number of characters) is - not read within _t_i_m_e_o_u_t seconds. _t_i_m_e_o_u_t may be a decimal - number with a fractional portion following the decimal - point. This option is only effective if rreeaadd is reading - input from a terminal, pipe, or other special file; it - has no effect when reading from regular files. If rreeaadd - times out, rreeaadd saves any partial input read into the - specified variable _n_a_m_e. If _t_i_m_e_o_u_t is 0, rreeaadd returns - immediately, without trying to read any data. The exit - status is 0 if input is available on the specified file - descriptor, or the read will return EOF, non-zero other- - wise. The exit status is greater than 128 if the timeout - is exceeded. + not read within _t_i_m_e_o_u_t seconds. _t_i_m_e_o_u_t may be a deci- + mal number with a fractional portion following the deci- + mal point. This option is only effective if rreeaadd is + reading input from a terminal, pipe, or other special + file; it has no effect when reading from regular files. + If rreeaadd times out, rreeaadd saves any partial input read into + the specified variable _n_a_m_e. If _t_i_m_e_o_u_t is 0, rreeaadd re- + turns immediately, without trying to read any data. The + exit status is 0 if input is available on the specified + file descriptor, or the read will return EOF, non-zero + otherwise. The exit status is greater than 128 if the + timeout is exceeded. --uu _f_d Read input from file descriptor _f_d. If no _n_a_m_e_s are supplied, the line read, without the ending de- limiter but otherwise unmodified, is assigned to the variable - RREEPPLLYY. The exit status is zero, unless end-of-file is encoun- + RREEPPLLYY. The exit status is zero, unless end-of-file is encoun- tered, rreeaadd times out (in which case the status is greater than 128), a variable assignment error (such as assigning to a read- only variable) occurs, or an invalid file descriptor is supplied @@ -1133,101 +1137,102 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS rreeaaddoonnllyy [--aaAAff] [--pp] [_n_a_m_e[=_w_o_r_d] ...] The given _n_a_m_e_s are marked readonly; the values of these _n_a_m_e_s - may not be changed by subsequent assignment. If the --ff option is - supplied, the functions corresponding to the _n_a_m_e_s are so - marked. The --aa option restricts the variables to indexed arrays; - the --AA option restricts the variables to associative arrays. If - both options are supplied, --AA takes precedence. If no _n_a_m_e argu- - ments are given, or if the --pp option is supplied, a list of all - readonly names is printed. The other options may be used to re- - strict the output to a subset of the set of readonly names. The - --pp option causes output to be displayed in a format that may be - reused as input. If a variable name is followed by =_w_o_r_d, the - value of the variable is set to _w_o_r_d. The return status is 0 un- - less an invalid option is encountered, one of the _n_a_m_e_s is not a - valid shell variable name, or --ff is supplied with a _n_a_m_e that is - not a function. + may not be changed by subsequent assignment. If the --ff option + is supplied, the functions corresponding to the _n_a_m_e_s are so + marked. The --aa option restricts the variables to indexed ar- + rays; the --AA option restricts the variables to associative ar- + rays. If both options are supplied, --AA takes precedence. If no + _n_a_m_e arguments are given, or if the --pp option is supplied, a + list of all readonly names is printed. The other options may be + used to restrict the output to a subset of the set of readonly + names. The --pp option causes output to be displayed in a format + that may be reused as input. If a variable name is followed by + =_w_o_r_d, the value of the variable is set to _w_o_r_d. The return + status is 0 unless an invalid option is encountered, one of the + _n_a_m_e_s is not a valid shell variable name, or --ff is supplied with + a _n_a_m_e that is not a function. rreettuurrnn [_n] Causes a function to stop executing and return the value speci- - fied by _n to its caller. If _n is omitted, the return status is - that of the last command executed in the function body. If rree-- + fied by _n to its caller. If _n is omitted, the return status is + that of the last command executed in the function body. If rree-- ttuurrnn is executed by a trap handler, the last command used to de- termine the status is the last command executed before the trap - handler. If rreettuurrnn is executed during a DDEEBBUUGG trap, the last + handler. If rreettuurrnn is executed during a DDEEBBUUGG trap, the last command used to determine the status is the last command exe- cuted by the trap handler before rreettuurrnn was invoked. If rreettuurrnn is used outside a function, but during execution of a script by - the .. (ssoouurrccee) command, it causes the shell to stop executing + the .. (ssoouurrccee) command, it causes the shell to stop executing that script and return either _n or the exit status of the last command executed within the script as the exit status of the - script. If _n is supplied, the return value is its least signifi- - cant 8 bits. The return status is non-zero if rreettuurrnn is supplied - a non-numeric argument, or is used outside a function and not - during execution of a script by .. or ssoouurrccee. Any command associ- - ated with the RREETTUURRNN trap is executed before execution resumes - after the function or script. + script. If _n is supplied, the return value is its least signif- + icant 8 bits. The return status is non-zero if rreettuurrnn is sup- + plied a non-numeric argument, or is used outside a function and + not during execution of a script by .. or ssoouurrccee. Any command + associated with the RREETTUURRNN trap is executed before execution re- + sumes after the function or script. sseett [--aabbeeffhhkkmmnnppttuuvvxxBBCCEEHHPPTT] [--oo _o_p_t_i_o_n_-_n_a_m_e] [----] [--] [_a_r_g ...] sseett [++aabbeeffhhkkmmnnppttuuvvxxBBCCEEHHPPTT] [++oo _o_p_t_i_o_n_-_n_a_m_e] [----] [--] [_a_r_g ...] sseett --oo sseett ++oo Without options, display the name and value of each shell vari- able in a format that can be reused as input for setting or re- - setting the currently-set variables. Read-only variables cannot - be reset. In _p_o_s_i_x _m_o_d_e, only shell variables are listed. The + setting the currently-set variables. Read-only variables cannot + be reset. In _p_o_s_i_x _m_o_d_e, only shell variables are listed. The output is sorted according to the current locale. When options - are specified, they set or unset shell attributes. Any arguments - remaining after option processing are treated as values for the - positional parameters and are assigned, in order, to $$11, $$22, ...... - $$_n. Options, if specified, have the following meanings: + are specified, they set or unset shell attributes. Any argu- + ments remaining after option processing are treated as values + for the positional parameters and are assigned, in order, to $$11, + $$22, ...... $$_n. Options, if specified, have the following mean- + ings: --aa Each variable or function that is created or modified is - given the export attribute and marked for export to the + given the export attribute and marked for export to the environment of subsequent commands. - --bb Report the status of terminated background jobs immedi- - ately, rather than before the next primary prompt. This + --bb Report the status of terminated background jobs immedi- + ately, rather than before the next primary prompt. This is effective only when job control is enabled. - --ee Exit immediately if a _p_i_p_e_l_i_n_e (which may consist of a - single _s_i_m_p_l_e _c_o_m_m_a_n_d), a _l_i_s_t, or a _c_o_m_p_o_u_n_d _c_o_m_m_a_n_d - (see SSHHEELLLL GGRRAAMMMMAARR in _b_a_s_h_(_1_)), exits with a non-zero - status. The shell does not exit if the command that - fails is part of the command list immediately following + --ee Exit immediately if a _p_i_p_e_l_i_n_e (which may consist of a + single _s_i_m_p_l_e _c_o_m_m_a_n_d), a _l_i_s_t, or a _c_o_m_p_o_u_n_d _c_o_m_m_a_n_d + (see SSHHEELLLL GGRRAAMMMMAARR in _b_a_s_h_(_1_)), exits with a non-zero + status. The shell does not exit if the command that + fails is part of the command list immediately following a wwhhiillee or uunnttiill keyword, part of the test following the - iiff or eelliiff reserved words, part of any command executed - in a &&&& or |||| list except the command following the fi- + iiff or eelliiff reserved words, part of any command executed + in a &&&& or |||| list except the command following the fi- nal &&&& or ||||, any command in a pipeline but the last, or - if the command's return value is being inverted with !!. - If a compound command other than a subshell returns a - non-zero status because a command failed while --ee was - being ignored, the shell does not exit. A trap on EERRRR, - if set, is executed before the shell exits. This option + if the command's return value is being inverted with !!. + If a compound command other than a subshell returns a + non-zero status because a command failed while --ee was + being ignored, the shell does not exit. A trap on EERRRR, + if set, is executed before the shell exits. This option applies to the shell environment and each subshell envi- ronment separately (see CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONNMMEENNTT in _b_a_s_h_(_1_)), and may cause subshells to exit before execut- ing all the commands in the subshell. - If a compound command or shell function executes in a - context where --ee is being ignored, none of the commands - executed within the compound command or function body - will be affected by the --ee setting, even if --ee is set - and a command returns a failure status. If a compound - command or shell function sets --ee while executing in a - context where --ee is ignored, that setting will not have - any effect until the compound command or the command + If a compound command or shell function executes in a + context where --ee is being ignored, none of the commands + executed within the compound command or function body + will be affected by the --ee setting, even if --ee is set + and a command returns a failure status. If a compound + command or shell function sets --ee while executing in a + context where --ee is ignored, that setting will not have + any effect until the compound command or the command containing the function call completes. --ff Disable pathname expansion. - --hh Remember the location of commands as they are looked up - for execution. This is enabled by default. - --kk All arguments in the form of assignment statements are - placed in the environment for a command, not just those + --hh Remember the location of commands as they are looked up + for execution. This is enabled by default. + --kk All arguments in the form of assignment statements are + placed in the environment for a command, not just those that precede the command name. - --mm Monitor mode. Job control is enabled. This option is on - by default for interactive shells on systems that sup- - port it (see JJOOBB CCOONNTTRROOLL in _b_a_s_h_(_1_)). All processes run - in a separate process group. When a background job com- - pletes, the shell prints a line containing its exit sta- - tus. - --nn Read commands but do not execute them. This may be used - to check a shell script for syntax errors. This is ig- + --mm Monitor mode. Job control is enabled. This option is + on by default for interactive shells on systems that + support it (see JJOOBB CCOONNTTRROOLL in _b_a_s_h_(_1_)). All processes + run in a separate process group. When a background job + completes, the shell prints a line containing its exit + status. + --nn Read commands but do not execute them. This may be used + to check a shell script for syntax errors. This is ig- nored by interactive shells. --oo _o_p_t_i_o_n_-_n_a_m_e The _o_p_t_i_o_n_-_n_a_m_e can be one of the following: @@ -1235,10 +1240,10 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS Same as --aa. bbrraacceeeexxppaanndd Same as --BB. - eemmaaccss Use an emacs-style command line editing inter- - face. This is enabled by default when the shell + eemmaaccss Use an emacs-style command line editing inter- + face. This is enabled by default when the shell is interactive, unless the shell is started with - the ----nnooeeddiittiinngg option. This also affects the + the ----nnooeeddiittiinngg option. This also affects the editing interface used for rreeaadd --ee. eerrrreexxiitt Same as --ee. eerrrrttrraaccee @@ -1248,12 +1253,12 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS hhaasshhaallll Same as --hh. hhiisstteexxppaanndd Same as --HH. - hhiissttoorryy Enable command history, as described in _b_a_s_h_(_1_) - under HHIISSTTOORRYY. This option is on by default in + hhiissttoorryy Enable command history, as described in _b_a_s_h_(_1_) + under HHIISSTTOORRYY. This option is on by default in interactive shells. iiggnnoorreeeeooff - The effect is as if the shell command ``IG- - NOREEOF=10'' had been executed (see SShheellll VVaarrii-- + The effect is as if the shell command ``IG- + NOREEOF=10'' had been executed (see SShheellll VVaarrii-- aabblleess in _b_a_s_h_(_1_)). kkeeyywwoorrdd Same as --kk. mmoonniittoorr Same as --mm. @@ -1268,116 +1273,117 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS pphhyyssiiccaall Same as --PP. ppiippeeffaaiill - If set, the return value of a pipeline is the - value of the last (rightmost) command to exit - with a non-zero status, or zero if all commands - in the pipeline exit successfully. This option + If set, the return value of a pipeline is the + value of the last (rightmost) command to exit + with a non-zero status, or zero if all commands + in the pipeline exit successfully. This option is disabled by default. - ppoossiixx Change the behavior of bbaasshh where the default - operation differs from the POSIX standard to - match the standard (_p_o_s_i_x _m_o_d_e). See SSEEEE AALLSSOO in - _b_a_s_h_(_1_) for a reference to a document that de- - tails how posix mode affects bash's behavior. + ppoossiixx Change the behavior of bbaasshh where the default + operation differs from the POSIX standard to + match the standard (_p_o_s_i_x _m_o_d_e). See SSEEEE AALLSSOO + in _b_a_s_h_(_1_) for a reference to a document that + details how posix mode affects bash's behavior. pprriivviilleeggeedd Same as --pp. vveerrbboossee Same as --vv. - vvii Use a vi-style command line editing interface. + vvii Use a vi-style command line editing interface. This also affects the editing interface used for rreeaadd --ee. xxttrraaccee Same as --xx. - If --oo is supplied with no _o_p_t_i_o_n_-_n_a_m_e, sseett prints the - current shell option settings. If ++oo is supplied with no - _o_p_t_i_o_n_-_n_a_m_e, sseett prints a series of sseett commands to - recreate the current option settings on the standard + If --oo is supplied with no _o_p_t_i_o_n_-_n_a_m_e, sseett prints the + current shell option settings. If ++oo is supplied with + no _o_p_t_i_o_n_-_n_a_m_e, sseett prints a series of sseett commands to + recreate the current option settings on the standard output. - --pp Turn on _p_r_i_v_i_l_e_g_e_d mode. In this mode, the $$EENNVV and - $$BBAASSHH__EENNVV files are not processed, shell functions are - not inherited from the environment, and the SSHHEELLLLOOPPTTSS, - BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if they ap- - pear in the environment, are ignored. If the shell is - started with the effective user (group) id not equal to - the real user (group) id, and the --pp option is not sup- + --pp Turn on _p_r_i_v_i_l_e_g_e_d mode. In this mode, the $$EENNVV and + $$BBAASSHH__EENNVV files are not processed, shell functions are + not inherited from the environment, and the SSHHEELLLLOOPPTTSS, + BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if they ap- + pear in the environment, are ignored. If the shell is + started with the effective user (group) id not equal to + the real user (group) id, and the --pp option is not sup- plied, these actions are taken and the effective user id - is set to the real user id. If the --pp option is supplied - at startup, the effective user id is not reset. Turning - this option off causes the effective user and group ids - to be set to the real user and group ids. - --rr Enable restricted shell mode. This option cannot be un- + is set to the real user id. If the --pp option is sup- + plied at startup, the effective user id is not reset. + Turning this option off causes the effective user and + group ids to be set to the real user and group ids. + --rr Enable restricted shell mode. This option cannot be un- set once it has been set. --tt Exit after reading and executing one command. --uu Treat unset variables and parameters other than the spe- - cial parameters "@" and "*", or array variables sub- - scripted with "@" or "*", as an error when performing - parameter expansion. If expansion is attempted on an un- - set variable or parameter, the shell prints an error - message, and, if not interactive, exits with a non-zero + cial parameters "@" and "*", or array variables sub- + scripted with "@" or "*", as an error when performing + parameter expansion. If expansion is attempted on an + unset variable or parameter, the shell prints an error + message, and, if not interactive, exits with a non-zero status. --vv Print shell input lines as they are read. - --xx After expanding each _s_i_m_p_l_e _c_o_m_m_a_n_d, ffoorr command, ccaassee + --xx After expanding each _s_i_m_p_l_e _c_o_m_m_a_n_d, ffoorr command, ccaassee command, sseelleecctt command, or arithmetic ffoorr command, dis- - play the expanded value of PPSS44, followed by the command - and its expanded arguments or associated word list, to + play the expanded value of PPSS44, followed by the command + and its expanded arguments or associated word list, to standard error. - --BB The shell performs brace expansion (see BBrraaccee EExxppaannssiioonn - in _b_a_s_h_(_1_)). This is on by default. - --CC If set, bbaasshh does not overwrite an existing file with - the >>, >>&&, and <<>> redirection operators. This may be + --BB The shell performs brace expansion (see BBrraaccee EExxppaannssiioonn + in _b_a_s_h_(_1_)). This is on by default. + --CC If set, bbaasshh does not overwrite an existing file with + the >>, >>&&, and <<>> redirection operators. This may be overridden when creating output files by using the redi- rection operator >>|| instead of >>. --EE If set, any trap on EERRRR is inherited by shell functions, - command substitutions, and commands executed in a sub- - shell environment. The EERRRR trap is normally not inher- + command substitutions, and commands executed in a sub- + shell environment. The EERRRR trap is normally not inher- ited in such cases. - --HH Enable !! style history substitution. This option is on + --HH Enable !! style history substitution. This option is on by default when the shell is interactive. - --PP If set, the shell does not resolve symbolic links when - executing commands such as ccdd that change the current - working directory. It uses the physical directory struc- - ture instead. By default, bbaasshh follows the logical chain - of directories when performing commands which change the - current directory. - --TT If set, any traps on DDEEBBUUGG and RREETTUURRNN are inherited by + --PP If set, the shell does not resolve symbolic links when + executing commands such as ccdd that change the current + working directory. It uses the physical directory + structure instead. By default, bbaasshh follows the logical + chain of directories when performing commands which + change the current directory. + --TT If set, any traps on DDEEBBUUGG and RREETTUURRNN are inherited by shell functions, command substitutions, and commands ex- - ecuted in a subshell environment. The DDEEBBUUGG and RREETTUURRNN + ecuted in a subshell environment. The DDEEBBUUGG and RREETTUURRNN traps are normally not inherited in such cases. - ---- If no arguments follow this option, then the positional - parameters are unset. Otherwise, the positional parame- - ters are set to the _a_r_gs, even if some of them begin + ---- If no arguments follow this option, then the positional + parameters are unset. Otherwise, the positional parame- + ters are set to the _a_r_gs, even if some of them begin with a --. - -- Signal the end of options, cause all remaining _a_r_gs to - be assigned to the positional parameters. The --xx and --vv - options are turned off. If there are no _a_r_gs, the posi- + -- Signal the end of options, cause all remaining _a_r_gs to + be assigned to the positional parameters. The --xx and --vv + options are turned off. If there are no _a_r_gs, the posi- tional parameters remain unchanged. - 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 $$--. The return - status is always true unless an invalid option is encountered. + The options are off by default unless otherwise noted. Using + + rather than - causes these options to be turned off. The op- + tions can also be specified as arguments to an invocation of the + shell. The current set of options may be found in $$--. The re- + turn status is always true unless an invalid option is encoun- + tered. sshhiifftt [_n] The positional parameters from _n+1 ... are renamed to $$11 ........ Parameters represented by the numbers $$## down to $$##-_n+1 are un- - set. _n must be a non-negative number less than or equal to $$##. - If _n is 0, no parameters are changed. If _n is not given, it is - assumed to be 1. If _n is greater than $$##, the positional parame- - ters are not changed. The return status is greater than zero if - _n is greater than $$## or less than zero; otherwise 0. + set. _n must be a non-negative number less than or equal to $$##. + If _n is 0, no parameters are changed. If _n is not given, it is + assumed to be 1. If _n is greater than $$##, the positional param- + eters are not changed. The return status is greater than zero + if _n is greater than $$## or less than zero; otherwise 0. sshhoopptt [--ppqqssuu] [--oo] [_o_p_t_n_a_m_e ...] Toggle the values of settings controlling optional shell behav- - ior. The settings can be either those listed below, or, if the + ior. The settings can be either those listed below, or, if the --oo option is used, those available with the --oo option to the sseett - builtin command. With no options, or with the --pp option, a list + builtin command. With no options, or with the --pp option, a list of all settable options is displayed, with an indication of whether or not each is set; if _o_p_t_n_a_m_e_s are supplied, the output - is restricted to those options. The --pp option causes output to - be displayed in a form that may be reused as input. Other op- + is restricted to those options. The --pp option causes output to + be displayed in a form that may be reused as input. Other op- tions have the following meanings: --ss Enable (set) each _o_p_t_n_a_m_e. --uu Disable (unset) each _o_p_t_n_a_m_e. --qq Suppresses normal output (quiet mode); the return status - indicates whether the _o_p_t_n_a_m_e is set or unset. If multi- + indicates whether the _o_p_t_n_a_m_e is set or unset. If multi- ple _o_p_t_n_a_m_e arguments are given with --qq, the return sta- tus is zero if all _o_p_t_n_a_m_e_s are enabled; non-zero other- wise. @@ -1390,7 +1396,7 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS by default. The return status when listing options is zero if all _o_p_t_n_a_m_e_s - are enabled, non-zero otherwise. When setting or unsetting op- + are enabled, non-zero otherwise. When setting or unsetting op- tions, the return status is zero unless an _o_p_t_n_a_m_e is not a valid shell option. @@ -1406,40 +1412,41 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS Deprecated; a synonym for aarrrraayy__eexxppaanndd__oonnccee. aauuttooccdd If set, a command name that is the name of a directory is executed as if it were the argument to the ccdd com- - mand. This option is only used by interactive shells. + mand. This option is only used by interactive shells. ccddaabbllee__vvaarrss If set, an argument to the ccdd builtin command that is not a directory is assumed to be the name of a variable whose value is the directory to change to. ccddssppeellll If set, minor errors in the spelling of a directory com- - ponent in a ccdd command will be corrected. The errors + ponent in a ccdd command will be corrected. The errors checked for are transposed characters, a missing charac- - ter, and one character too many. If a correction is + ter, and one character too many. If a correction is found, the corrected filename is printed, and the com- mand proceeds. This option is only used by interactive shells. cchheecckkhhaasshh If set, bbaasshh checks that a command found in the hash ta- - ble exists before trying to execute it. If a hashed com- - mand no longer exists, a normal path search is per- + ble exists before trying to execute it. If a hashed + command no longer exists, a normal path search is per- formed. cchheecckkjjoobbss If set, bbaasshh lists the status of any stopped and running jobs before exiting an interactive shell. If any jobs are running, this causes the exit to be deferred until a second exit is attempted without an intervening command - (see JJOOBB CCOONNTTRROOLL in _b_a_s_h_(_1_)). The shell always postpones - exiting if any jobs are stopped. + (see JJOOBB CCOONNTTRROOLL in _b_a_s_h_(_1_)). The shell always post- + pones exiting if any jobs are stopped. cchheecckkwwiinnssiizzee If set, bbaasshh checks the window size after each external (non-builtin) command and, if necessary, updates the - values of LLIINNEESS and CCOOLLUUMMNNSS. This option is enabled by + values of LLIINNEESS and CCOOLLUUMMNNSS. This option is enabled by default. ccmmddhhiisstt If set, bbaasshh attempts to save all lines of a multiple- - line command in the same history entry. This allows easy - re-editing of multi-line commands. This option is en- - abled by default, but only has an effect if command his- - tory is enabled, as described in _b_a_s_h_(_1_) under HHIISSTTOORRYY. + line command in the same history entry. This allows + easy re-editing of multi-line commands. This option is + enabled by default, but only has an effect if command + history is enabled, as described in _b_a_s_h_(_1_) under HHIISS-- + TTOORRYY. ccoommppaatt3311 ccoommppaatt3322 ccoommppaatt4400 @@ -1448,122 +1455,122 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS ccoommppaatt4433 ccoommppaatt4444 ccoommppaatt5500 - These control aspects of the shell's compatibility mode + These control aspects of the shell's compatibility mode (see SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE in _b_a_s_h_(_1_)). ccoommpplleettee__ffuullllqquuoottee - If set, bbaasshh quotes all shell metacharacters in file- - names and directory names when performing completion. If - not set, bbaasshh removes metacharacters such as the dollar - sign from the set of characters that will be quoted in - completed filenames when these metacharacters appear in - shell variable references in words to be completed. This - means that dollar signs in variable names that expand to - directories will not be quoted; however, any dollar - signs appearing in filenames will not be quoted, either. - This is active only when bash is using backslashes to - quote completed filenames. This variable is set by de- - fault, which is the default bash behavior in versions - through 4.2. + If set, bbaasshh quotes all shell metacharacters in file- + names and directory names when performing completion. + If not set, bbaasshh removes metacharacters such as the dol- + lar sign from the set of characters that will be quoted + in completed filenames when these metacharacters appear + in shell variable references in words to be completed. + This means that dollar signs in variable names that ex- + pand to directories will not be quoted; however, any + dollar signs appearing in filenames will not be quoted, + either. This is active only when bash is using back- + slashes to quote completed filenames. This variable is + set by default, which is the default bash behavior in + versions through 4.2. ddiirreexxppaanndd - If set, bbaasshh replaces directory names with the results - of word expansion when performing filename completion. - This changes the contents of the readline editing buf- - fer. If not set, bbaasshh attempts to preserve what the user - typed. + If set, bbaasshh replaces directory names with the results + of word expansion when performing filename completion. + This changes the contents of the readline editing buf- + fer. If not set, bbaasshh attempts to preserve what the + user typed. ddiirrssppeellll - If set, bbaasshh attempts spelling correction on directory - names during word completion if the directory name ini- + If set, bbaasshh attempts spelling correction on directory + names during word completion if the directory name ini- tially supplied does not exist. - ddoottgglloobb If set, bbaasshh includes filenames beginning with a `.' in - the results of pathname expansion. The filenames ````..'''' - and ````....'''' must always be matched explicitly, even if + ddoottgglloobb If set, bbaasshh includes filenames beginning with a `.' in + the results of pathname expansion. The filenames ````..'''' + and ````....'''' must always be matched explicitly, even if ddoottgglloobb is set. eexxeeccffaaiill If set, a non-interactive shell will not exit if it can- - not execute the file specified as an argument to the - eexxeecc builtin command. An interactive shell does not exit - if eexxeecc fails. + not execute the file specified as an argument to the + eexxeecc builtin command. An interactive shell does not + exit if eexxeecc fails. eexxppaanndd__aalliiaasseess If set, aliases are expanded as described in _b_a_s_h_(_1_) un- - der AALLIIAASSEESS. This option is enabled by default for in- + der AALLIIAASSEESS. This option is enabled by default for in- teractive shells. eexxttddeebbuugg - If set at shell invocation, or in a shell startup file, + If set at shell invocation, or in a shell startup file, arrange to execute the debugger profile before the shell - starts, identical to the ----ddeebbuuggggeerr option. If set after - invocation, behavior intended for use by debuggers is - enabled: + starts, identical to the ----ddeebbuuggggeerr option. If set af- + ter invocation, behavior intended for use by debuggers + is enabled: 11.. The --FF option to the ddeeccllaarree builtin displays the source file name and line number corresponding to each function name supplied as an argument. - 22.. If the command run by the DDEEBBUUGG trap returns a - non-zero value, the next command is skipped and + 22.. If the command run by the DDEEBBUUGG trap returns a + non-zero value, the next command is skipped and not executed. - 33.. If the command run by the DDEEBBUUGG trap returns a - value of 2, and the shell is executing in a sub- - routine (a shell function or a shell script exe- - cuted by the .. or ssoouurrccee builtins), the shell + 33.. If the command run by the DDEEBBUUGG trap returns a + value of 2, and the shell is executing in a sub- + routine (a shell function or a shell script exe- + cuted by the .. or ssoouurrccee builtins), the shell simulates a call to rreettuurrnn. - 44.. BBAASSHH__AARRGGCC and BBAASSHH__AARRGGVV are updated as described + 44.. BBAASSHH__AARRGGCC and BBAASSHH__AARRGGVV are updated as described in their descriptions in _b_a_s_h_(_1_)). - 55.. Function tracing is enabled: command substitu- + 55.. Function tracing is enabled: command substitu- tion, shell functions, and subshells invoked with (( _c_o_m_m_a_n_d )) inherit the DDEEBBUUGG and RREETTUURRNN traps. - 66.. Error tracing is enabled: command substitution, - shell functions, and subshells invoked with (( + 66.. Error tracing is enabled: command substitution, + shell functions, and subshells invoked with (( _c_o_m_m_a_n_d )) inherit the EERRRR trap. eexxttgglloobb If set, the extended pattern matching features described in _b_a_s_h_(_1_) under PPaatthhnnaammee EExxppaannssiioonn are enabled. eexxttqquuoottee - If set, $$'_s_t_r_i_n_g' and $$"_s_t_r_i_n_g" quoting is performed - within $${{_p_a_r_a_m_e_t_e_r}} expansions enclosed in double - quotes. This option is enabled by default. + If set, $$'_s_t_r_i_n_g' and $$"_s_t_r_i_n_g" quoting is performed + within $${{_p_a_r_a_m_e_t_e_r}} expansions enclosed in double + quotes. This option is enabled by default. ffaaiillgglloobb - If set, patterns which fail to match filenames during + If set, patterns which fail to match filenames during pathname expansion result in an expansion error. ffoorrccee__ffiiggnnoorree - If set, the suffixes specified by the FFIIGGNNOORREE shell - variable cause words to be ignored when performing word + If set, the suffixes specified by the FFIIGGNNOORREE shell + variable cause words to be ignored when performing word completion even if the ignored words are the only possi- - ble completions. See SSHHEELLLL VVAARRIIAABBLLEESS in _b_a_s_h_(_1_) for a - description of FFIIGGNNOORREE. This option is enabled by de- + ble completions. See SSHHEELLLL VVAARRIIAABBLLEESS in _b_a_s_h_(_1_) for a + description of FFIIGGNNOORREE. This option is enabled by de- fault. gglloobbaasscciiiirraannggeess - If set, range expressions used in pattern matching - bracket expressions (see PPaatttteerrnn MMaattcchhiinngg in _b_a_s_h_(_1_)) + If set, range expressions used in pattern matching + bracket expressions (see PPaatttteerrnn MMaattcchhiinngg in _b_a_s_h_(_1_)) behave as if in the traditional C locale when performing - comparisons. That is, the current locale's collating se- - quence is not taken into account, so bb will not collate - between AA and BB, and upper-case and lower-case ASCII - characters will collate together. + comparisons. That is, the current locale's collating + sequence is not taken into account, so bb will not col- + late between AA and BB, and upper-case and lower-case + ASCII characters will collate together. gglloobbsskkiippddoottss - If set, pathname expansion will never match the file- - names ````..'''' and ````....'''', even if the pattern begins with - a ````..''''. This option is enabled by default. + If set, pathname expansion will never match the file- + names ````..'''' and ````....'''', even if the pattern begins with + a ````..''''. This option is enabled by default. gglloobbssttaarr If set, the pattern **** used in a pathname expansion con- - text will match all files and zero or more directories - and subdirectories. If the pattern is followed by a //, + text will match all files and zero or more directories + and subdirectories. If the pattern is followed by a //, only directories and subdirectories match. ggnnuu__eerrrrffmmtt @@ -1571,179 +1578,179 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS GNU error message format. hhiissttaappppeenndd - If set, the history list is appended to the file named + If set, the history list is appended to the file named by the value of the HHIISSTTFFIILLEE variable when the shell ex- its, rather than overwriting the file. hhiissttrreeeeddiitt - If set, and rreeaaddlliinnee is being used, a user is given the + If set, and rreeaaddlliinnee is being used, a user is given the opportunity to re-edit a failed history substitution. hhiissttvveerriiffyy - If set, and rreeaaddlliinnee is being used, the results of his- - tory substitution are not immediately passed to the - shell parser. Instead, the resulting line is loaded into - the rreeaaddlliinnee editing buffer, allowing further modifica- - tion. + If set, and rreeaaddlliinnee is being used, the results of his- + tory substitution are not immediately passed to the + shell parser. Instead, the resulting line is loaded + into the rreeaaddlliinnee editing buffer, allowing further modi- + fication. hhoossttccoommpplleettee If set, and rreeaaddlliinnee is being used, bbaasshh will attempt to - perform hostname completion when a word containing a @@ - is being completed (see CCoommpplleettiinngg under RREEAADDLLIINNEE in - _b_a_s_h_(_1_)). This is enabled by default. + perform hostname completion when a word containing a @@ + is being completed (see CCoommpplleettiinngg under RREEAADDLLIINNEE in + _b_a_s_h_(_1_)). This is enabled by default. hhuuppoonneexxiitt If set, bbaasshh will send SSIIGGHHUUPP to all jobs when an inter- active login shell exits. iinnhheerriitt__eerrrreexxiitt - If set, command substitution inherits the value of the - eerrrreexxiitt option, instead of unsetting it in the subshell - environment. This option is enabled when _p_o_s_i_x _m_o_d_e is + If set, command substitution inherits the value of the + eerrrreexxiitt option, instead of unsetting it in the subshell + environment. This option is enabled when _p_o_s_i_x _m_o_d_e is enabled. iinntteerraaccttiivvee__ccoommmmeennttss If set, allow a word beginning with ## to cause that word - and all remaining characters on that line to be ignored + and all remaining characters on that line to be ignored in an interactive shell (see CCOOMMMMEENNTTSS in _b_a_s_h_(_1_)). This option is enabled by default. llaassttppiippee - If set, and job control is not active, the shell runs + If set, and job control is not active, the shell runs the last command of a pipeline not executed in the back- ground in the current shell environment. - lliitthhiisstt If set, and the ccmmddhhiisstt option is enabled, multi-line + lliitthhiisstt If set, and the ccmmddhhiisstt option is enabled, multi-line commands are saved to the history with embedded newlines rather than using semicolon separators where possible. llooccaallvvaarr__iinnhheerriitt If set, local variables inherit the value and attributes of a variable of the same name that exists at a previous - scope before any new value is assigned. The nameref at- + scope before any new value is assigned. The nameref at- tribute is not inherited. llooccaallvvaarr__uunnsseett - If set, calling uunnsseett on local variables in previous - function scopes marks them so subsequent lookups find - them unset until that function returns. This is identi- - cal to the behavior of unsetting local variables at the + If set, calling uunnsseett on local variables in previous + function scopes marks them so subsequent lookups find + them unset until that function returns. This is identi- + cal to the behavior of unsetting local variables at the current function scope. llooggiinn__sshheellll - The shell sets this option if it is started as a login - shell (see IINNVVOOCCAATTIIOONN in _b_a_s_h_(_1_)). The value may not be + The shell sets this option if it is started as a login + shell (see IINNVVOOCCAATTIIOONN in _b_a_s_h_(_1_)). The value may not be changed. mmaaiillwwaarrnn - If set, and a file that bbaasshh is checking for mail has - been accessed since the last time it was checked, the - message ``The mail in _m_a_i_l_f_i_l_e has been read'' is dis- + If set, and a file that bbaasshh is checking for mail has + been accessed since the last time it was checked, the + message ``The mail in _m_a_i_l_f_i_l_e has been read'' is dis- played. nnoo__eemmppttyy__ccmmdd__ccoommpplleettiioonn - If set, and rreeaaddlliinnee is being used, bbaasshh will not at- - tempt to search the PPAATTHH for possible completions when + If set, and rreeaaddlliinnee is being used, bbaasshh will not at- + tempt to search the PPAATTHH for possible completions when completion is attempted on an empty line. nnooccaasseegglloobb - If set, bbaasshh matches filenames in a case-insensitive + If set, bbaasshh matches filenames in a case-insensitive fashion when performing pathname expansion (see PPaatthhnnaammee EExxppaannssiioonn in _b_a_s_h_(_1_)). nnooccaasseemmaattcchh - If set, bbaasshh matches patterns in a case-insensitive + If set, bbaasshh matches patterns in a case-insensitive fashion when performing matching while executing ccaassee or [[[[ conditional commands, when performing pattern substi- - tution word expansions, or when filtering possible com- + tution word expansions, or when filtering possible com- pletions as part of programmable completion. nnooeexxppaanndd__ttrraannssllaattiioonn - If set, bbaasshh encloses the translated results of $"..." - quoting in single quotes instead of double quotes. If + If set, bbaasshh encloses the translated results of $"..." + quoting in single quotes instead of double quotes. If the string is not translated, this has no effect. nnuullllgglloobb - If set, bbaasshh allows patterns which match no files (see - PPaatthhnnaammee EExxppaannssiioonn in _b_a_s_h_(_1_)) to expand to a null + If set, bbaasshh allows patterns which match no files (see + PPaatthhnnaammee EExxppaannssiioonn in _b_a_s_h_(_1_)) to expand to a null string, rather than themselves. ppaattssuubb__rreeppllaacceemmeenntt If set, bbaasshh expands occurrences of && in the replacement - string of pattern substitution to the text matched by - the pattern, as described under PPaarraammeetteerr EExxppaannssiioonn in - _b_a_s_h_(_1_). This option is enabled by default. + string of pattern substitution to the text matched by + the pattern, as described under PPaarraammeetteerr EExxppaannssiioonn in + _b_a_s_h_(_1_). This option is enabled by default. pprrooggccoommpp If set, the programmable completion facilities (see PPrroo-- - ggrraammmmaabbllee CCoommpplleettiioonn in _b_a_s_h_(_1_)) are enabled. This op- + ggrraammmmaabbllee CCoommpplleettiioonn in _b_a_s_h_(_1_)) are enabled. This op- tion is enabled by default. pprrooggccoommpp__aalliiaass - If set, and programmable completion is enabled, bbaasshh - treats a command name that doesn't have any completions - as a possible alias and attempts alias expansion. If it - has an alias, bbaasshh attempts programmable completion us- + If set, and programmable completion is enabled, bbaasshh + treats a command name that doesn't have any completions + as a possible alias and attempts alias expansion. If it + has an alias, bbaasshh attempts programmable completion us- ing the command word resulting from the expanded alias. pprroommppttvvaarrss If set, prompt strings undergo parameter expansion, com- - mand substitution, arithmetic expansion, and quote re- - moval after being expanded as described in PPRROOMMPPTTIINNGG in - _b_a_s_h_(_1_). This option is enabled by default. + mand substitution, arithmetic expansion, and quote re- + moval after being expanded as described in PPRROOMMPPTTIINNGG in + _b_a_s_h_(_1_). This option is enabled by default. rreessttrriicctteedd__sshheellll - The shell sets this option if it is started in re- - stricted mode (see RREESSTTRRIICCTTEEDD SSHHEELLLL in _b_a_s_h_(_1_)). The - value may not be changed. This is not reset when the - startup files are executed, allowing the startup files + The shell sets this option if it is started in re- + stricted mode (see RREESSTTRRIICCTTEEDD SSHHEELLLL in _b_a_s_h_(_1_)). The + value may not be changed. This is not reset when the + startup files are executed, allowing the startup files to discover whether or not a shell is restricted. sshhiifftt__vveerrbboossee - If set, the sshhiifftt builtin prints an error message when + If set, the sshhiifftt builtin prints an error message when the shift count exceeds the number of positional parame- ters. ssoouurrcceeppaatthh If set, the .. (ssoouurrccee) builtin uses the value of PPAATTHH to - find the directory containing the file supplied as an - argument. This option is enabled by default. + find the directory containing the file supplied as an + argument. This option is enabled by default. vvaarrrreeddiirr__cclloossee - If set, the shell automatically closes file descriptors + If set, the shell automatically closes file descriptors assigned using the _{_v_a_r_n_a_m_e_} redirection syntax (see RREE-- - DDIIRREECCTTIIOONN in _b_a_s_h_(_1_)) instead of leaving them open when + DDIIRREECCTTIIOONN in _b_a_s_h_(_1_)) instead of leaving them open when the command completes. xxppgg__eecchhoo - If set, the eecchhoo builtin expands backslash-escape se- - quences by default. If the ppoossiixx shell option is also + If set, the eecchhoo builtin expands backslash-escape se- + quences by default. If the ppoossiixx shell option is also enabled, eecchhoo does not interpret any options. ssuussppeenndd [--ff] - Suspend the execution of this shell until it receives a SSIIGGCCOONNTT - signal. A login shell, or a shell without job control enabled, - cannot be suspended; the --ff option can be used to override this - and force the suspension. The return status is 0 unless the - shell is a login shell or job control is not enabled and --ff is + Suspend the execution of this shell until it receives a SSIIGGCCOONNTT + signal. A login shell, or a shell without job control enabled, + cannot be suspended; the --ff option can be used to override this + and force the suspension. The return status is 0 unless the + shell is a login shell or job control is not enabled and --ff is not supplied. tteesstt _e_x_p_r [[ _e_x_p_r ]] Return a status of 0 (true) or 1 (false) depending on the evalu- - ation of the conditional expression _e_x_p_r. Each operator and op- - erand must be a separate argument. Expressions are composed of - the primaries described in _b_a_s_h_(_1_) under CCOONNDDIITTIIOONNAALL EEXXPPRREESS-- + ation of the conditional expression _e_x_p_r. Each operator and op- + erand must be a separate argument. Expressions are composed of + the primaries described in _b_a_s_h_(_1_) under CCOONNDDIITTIIOONNAALL EEXXPPRREESS-- SSIIOONNSS. tteesstt does not accept any options, nor does it accept and ignore an argument of ---- as signifying the end of options. - Expressions may be combined using the following operators, - listed in decreasing order of precedence. The evaluation depends - on the number of arguments; see below. Operator precedence is - used when there are five or more arguments. + Expressions may be combined using the following operators, + listed in decreasing order of precedence. The evaluation de- + pends on the number of arguments; see below. Operator prece- + dence is used when there are five or more arguments. !! _e_x_p_r True if _e_x_p_r is false. (( _e_x_p_r )) - Returns the value of _e_x_p_r. This may be used to override + Returns the value of _e_x_p_r. This may be used to override the normal precedence of operators. _e_x_p_r_1 -aa _e_x_p_r_2 True if both _e_x_p_r_1 and _e_x_p_r_2 are true. @@ -1760,83 +1767,84 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS null. 2 arguments If the first argument is !!, the expression is true if and - only if the second argument is null. If the first argu- - ment is one of the unary conditional operators listed in - _b_a_s_h_(_1_) under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS, the expression is - true if the unary test is true. If the first argument is + only if the second argument is null. If the first argu- + ment is one of the unary conditional operators listed in + _b_a_s_h_(_1_) under CCOONNDDIITTIIOONNAALL EEXXPPRREESSSSIIOONNSS, 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. 3 arguments The following conditions are applied in the order listed. - If the second argument is one of the binary conditional - operators listed in _b_a_s_h_(_1_) under CCOONNDDIITTIIOONNAALL EEXXPPRREESS-- - SSIIOONNSS, the result of the expression is the result of the - binary test using the first and third arguments as oper- - ands. The --aa and --oo operators are considered binary oper- - ators when there are three arguments. If the first argu- - ment 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 ar- - gument. Otherwise, the expression is false. + If the second argument is one of the binary conditional + operators listed in _b_a_s_h_(_1_) under CCOONNDDIITTIIOONNAALL EEXXPPRREESS-- + SSIIOONNSS, the result of the expression is the result of the + binary test using the first and third arguments as oper- + ands. The --aa and --oo operators are considered binary op- + erators when there are three arguments. If the first ar- + gument is !!, the value is the negation of the two-argu- + ment test using the second and third arguments. If the + first argument is exactly (( and the third argument is ex- + actly )), the result is the one-argument test of the sec- + ond argument. Otherwise, the expression is false. 4 arguments The following conditions are applied in the order listed. If the first argument is !!, the result is the negation of - the three-argument expression composed of the remaining - arguments. the two-argument test using the second and - third arguments. If the first argument is exactly (( and - the fourth argument is exactly )), the result is the two- - argument test of the second and third arguments. Other- + the three-argument expression composed of the remaining + arguments. the two-argument test using the second and + third arguments. If the first argument is exactly (( and + the fourth argument is exactly )), the result is the two- + argument test of the second and third arguments. Other- wise, 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 + The expression is parsed and evaluated according to precedence using the rules listed above. If the shell is not in _p_o_s_i_x _m_o_d_e, when used with tteesstt or [[, the - << and >> operators sort lexicographically using ASCII ordering. - When the shell is in _p_o_s_i_x _m_o_d_e, these operators sort using the + << and >> operators sort lexicographically using ASCII ordering. + When the shell is in _p_o_s_i_x _m_o_d_e, these operators sort using the current locale. - ttiimmeess Print the accumulated user and system times for the shell and - for processes run from the shell. The return status is 0. + ttiimmeess Print the accumulated user and system times for the shell and + for processes run from the shell. The return status is 0. ttrraapp [--llpp] [[_a_c_t_i_o_n] _s_i_g_s_p_e_c ...] The _a_c_t_i_o_n is a command that is read and executed when the shell - receives signal(s) _s_i_g_s_p_e_c. If _a_c_t_i_o_n is absent (and there is a - single _s_i_g_s_p_e_c) or --, each specified signal is reset to its - original disposition (the value it had upon entrance to the - shell). If _a_c_t_i_o_n is the null string the signal specified by - each _s_i_g_s_p_e_c is ignored by the shell and by the commands it in- + receives signal(s) _s_i_g_s_p_e_c. If _a_c_t_i_o_n is absent (and there is a + single _s_i_g_s_p_e_c) or --, each specified signal is reset to its + original disposition (the value it had upon entrance to the + shell). If _a_c_t_i_o_n is the null string the signal specified by + each _s_i_g_s_p_e_c is ignored by the shell and by the commands it in- vokes. - If no arguments are supplied, ttrraapp displays the actions associ- + If no arguments are supplied, ttrraapp displays the actions associ- ated with each trapped signal as a set of ttrraapp commands that can - be reused as shell input to restore the current signal disposi- - tions. If --pp is given, and _a_c_t_i_o_n is not present, then ttrraapp dis- - plays the actions associated with each _s_i_g_s_p_e_c or, if none are - supplied, for all trapped signals, as a set of ttrraapp commands - that can be reused as shell input to restore the current signal - dispositions. The --PP option behaves similarly, but displays only - the actions associated with each _s_i_g_s_p_e_c argument. --PP requires - at least one _s_i_g_s_p_e_c argument. The --PP or --pp options to ttrraapp may - be used in a subshell environment (e.g., command substitution) - and, as long as they are used before ttrraapp is used to change a - signal's handling, will display the state of its parent's traps. + be reused as shell input to restore the current signal disposi- + tions. If --pp is given, and _a_c_t_i_o_n is not present, then ttrraapp + displays the actions associated with each _s_i_g_s_p_e_c or, if none + are supplied, for all trapped signals, as a set of ttrraapp commands + that can be reused as shell input to restore the current signal + dispositions. The --PP option behaves similarly, but displays + only the actions associated with each _s_i_g_s_p_e_c argument. --PP re- + quires at least one _s_i_g_s_p_e_c argument. The --PP or --pp options to + ttrraapp may be used in a subshell environment (e.g., command sub- + stitution) and, as long as they are used before ttrraapp is used to + change a signal's handling, will display the state of its par- + ent's traps. The --ll option causes ttrraapp to print a list of signal names and - their corresponding numbers. Each _s_i_g_s_p_e_c is either a signal - name defined in <_s_i_g_n_a_l_._h>, or a signal number. Signal names are - case insensitive and the SSIIGG prefix is optional. + their corresponding numbers. Each _s_i_g_s_p_e_c is either a signal + name defined in <_s_i_g_n_a_l_._h>, or a signal number. Signal names + are case insensitive and the SSIIGG prefix is optional. If a _s_i_g_s_p_e_c is EEXXIITT (0) the command _a_c_t_i_o_n is executed on exit - from the shell. If a _s_i_g_s_p_e_c is DDEEBBUUGG, the command _a_c_t_i_o_n is ex- - ecuted before every _s_i_m_p_l_e _c_o_m_m_a_n_d, _f_o_r command, _c_a_s_e command, + from the shell. If a _s_i_g_s_p_e_c is DDEEBBUUGG, the command _a_c_t_i_o_n is + executed before every _s_i_m_p_l_e _c_o_m_m_a_n_d, _f_o_r command, _c_a_s_e command, _s_e_l_e_c_t command, (( arithmetic command, [[ conditional command, arithmetic _f_o_r command, and before the first command executes in a shell function (see SSHHEELLLL GGRRAAMMMMAARR in _b_a_s_h_(_1_)). Refer to the description of the eexxttddeebbuugg option to the sshhoopptt builtin for de- - tails of its effect on the DDEEBBUUGG trap. If a _s_i_g_s_p_e_c is RREETTUURRNN, + tails of its effect on the DDEEBBUUGG trap. If a _s_i_g_s_p_e_c is RREETTUURRNN, the command _a_c_t_i_o_n is executed each time a shell function or a script executed with the .. or ssoouurrccee builtins finishes execut- ing. @@ -1844,46 +1852,46 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS If a _s_i_g_s_p_e_c is EERRRR, the command _a_c_t_i_o_n is executed whenever a pipeline (which may consist of a single simple command), a list, or a compound command returns a non-zero exit status, subject to - the following conditions. The EERRRR trap is not executed if the + the following conditions. The EERRRR trap is not executed if the failed command is part of the command list immediately following a wwhhiillee or uunnttiill keyword, part of the test in an _i_f statement, part of a command executed in a &&&& or |||| list except the command following the final &&&& or ||||, any command in a pipeline but the last, or if the command's return value is being inverted using - !!. These are the same conditions obeyed by the eerrrreexxiitt (--ee) op- + !!. These are the same conditions obeyed by the eerrrreexxiitt (--ee) op- tion. When the shell is not interactive, signals ignored upon entry to - the shell cannot be trapped or reset. Interactive shells permit - trapping signals ignored on entry. Trapped signals that are not + the shell cannot be trapped or reset. Interactive shells permit + trapping signals ignored on entry. Trapped signals that are not being ignored are reset to their original values in a subshell - or subshell environment when one is created. The return status + or subshell environment when one is created. The return status is false if any _s_i_g_s_p_e_c is invalid; otherwise ttrraapp returns true. ttrruuee Does nothing, returns a 0 status. ttyyppee [--aaffttppPP] _n_a_m_e [_n_a_m_e ...] With no options, indicate how each _n_a_m_e would be interpreted if - used as a command name. If the --tt option is used, ttyyppee prints a + used as a command name. If the --tt option is used, ttyyppee prints a string which is one of _a_l_i_a_s, _k_e_y_w_o_r_d, _f_u_n_c_t_i_o_n, _b_u_i_l_t_i_n, or _f_i_l_e if _n_a_m_e is an alias, shell reserved word, function, - builtin, or executable disk file, respectively. If the _n_a_m_e is + builtin, or executable disk file, respectively. If the _n_a_m_e is not found, then nothing is printed, and ttyyppee returns a non-zero - exit status. If the --pp option is used, ttyyppee either returns the + exit status. If the --pp option is used, ttyyppee either returns the name of the executable file that would be found by searching $$PPAATTHH if _n_a_m_e were specified as a command name, or nothing if - ``type -t name'' would not return _f_i_l_e. The --PP option forces a + ``type -t name'' would not return _f_i_l_e. The --PP option forces a PPAATTHH search for each _n_a_m_e, even if ``type -t name'' would not - return _f_i_l_e. If a command is hashed, --pp and --PP print the hashed + return _f_i_l_e. If a command is hashed, --pp and --PP print the hashed value, which is not necessarily the file that appears first in - PPAATTHH. If the --aa option is used, ttyyppee prints all of the places - that contain a command named _n_a_m_e. This includes aliases, re- + PPAATTHH. If the --aa option is used, ttyyppee prints all of the places + that contain a command named _n_a_m_e. This includes aliases, re- served words, functions, and builtins, but the path search op- tions (--pp and --PP) can be supplied to restrict the output to exe- - cutable files. ttyyppee does not consult the table of hashed com- + cutable files. ttyyppee does not consult the table of hashed com- mands when using --aa with --pp, and only performs a PPAATTHH search for - _n_a_m_e. The --ff option suppresses shell function lookup, as with - the ccoommmmaanndd builtin. ttyyppee returns true if all of the arguments + _n_a_m_e. The --ff option suppresses shell function lookup, as with + the ccoommmmaanndd builtin. ttyyppee returns true if all of the arguments are found, false if any are not found. uulliimmiitt [--HHSS] --aa @@ -1891,17 +1899,17 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS Provides control over the resources available to the shell and to processes started by it, on systems that allow such control. The --HH and --SS options specify that the hard or soft limit is set - for the given resource. A hard limit cannot be increased by a + for the given resource. A hard limit cannot be increased by a non-root user once it is set; a soft limit may be increased up - to the value of the hard limit. If neither --HH nor --SS is speci- - fied, both the soft and hard limits are set. The value of _l_i_m_i_t + to the value of the hard limit. If neither --HH nor --SS is speci- + fied, both the soft and hard limits are set. The value of _l_i_m_i_t can be a number in the unit specified for the resource or one of the special values hhaarrdd, ssoofftt, or uunnlliimmiitteedd, which stand for the current hard limit, the current soft limit, and no limit, re- - spectively. If _l_i_m_i_t is omitted, the current value of the soft + spectively. If _l_i_m_i_t is omitted, the current value of the soft limit of the resource is printed, unless the --HH option is given. When more than one resource is specified, the limit name and - unit, if appropriate, are printed before the value. Other op- + unit, if appropriate, are printed before the value. Other op- tions are interpreted as follows: --aa All current limits are reported; no limits are set --bb The maximum socket buffer size @@ -1933,86 +1941,86 @@ BBAASSHH BBUUIILLTTIINN CCOOMMMMAANNDDSS --TT The maximum number of threads If _l_i_m_i_t is given, and the --aa option is not used, _l_i_m_i_t is the - new value of the specified resource. If no option is given, then - --ff is assumed. Values are in 1024-byte increments, except for - --tt, which is in seconds; --RR, which is in microseconds; --pp, which - is in units of 512-byte blocks; --PP, --TT, --bb, --kk, --nn, and --uu, - which are unscaled values; and, when in posix mode, --cc and --ff, - which are in 512-byte increments. The return status is 0 unless - an invalid option or argument is supplied, or an error occurs - while setting a new limit. + new value of the specified resource. If no option is given, + then --ff is assumed. Values are in 1024-byte increments, except + for --tt, which is in seconds; --RR, which is in microseconds; --pp, + which is in units of 512-byte blocks; --PP, --TT, --bb, --kk, --nn, and + --uu, which are unscaled values; and, when in posix mode, --cc and + --ff, which are in 512-byte increments. The return status is 0 + unless an invalid option or argument is supplied, or an error + occurs while setting a new limit. uummaasskk [--pp] [--SS] [_m_o_d_e] - The user file-creation mask is set to _m_o_d_e. If _m_o_d_e begins with + The user file-creation mask is set to _m_o_d_e. If _m_o_d_e begins with a digit, it is interpreted as an octal number; otherwise it is interpreted as a symbolic mode mask similar to that accepted by - _c_h_m_o_d(1). If _m_o_d_e is omitted, the current value of the mask is - printed. The --SS option causes the mask to be printed in symbolic - form; the default output is an octal number. If the --pp option is - supplied, and _m_o_d_e is omitted, the output is in a form that may - be reused as input. The return status is 0 if the mode was suc- - cessfully changed or if no _m_o_d_e argument was supplied, and false - otherwise. + _c_h_m_o_d(1). If _m_o_d_e is omitted, the current value of the mask is + printed. The --SS option causes the mask to be printed in sym- + bolic form; the default output is an octal number. If the --pp + option is supplied, and _m_o_d_e 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 _m_o_d_e argument was supplied, + and false otherwise. uunnaalliiaass [-aa] [_n_a_m_e ...] - Remove each _n_a_m_e from the list of defined aliases. If --aa is sup- - plied, all alias definitions are removed. The return value is - true unless a supplied _n_a_m_e is not a defined alias. + Remove each _n_a_m_e from the list of defined aliases. If --aa is + supplied, all alias definitions are removed. The return value + is true unless a supplied _n_a_m_e is not a defined alias. uunnsseett [-ffvv] [-nn] [_n_a_m_e ...] - For each _n_a_m_e, remove the corresponding variable or function. If - the --vv option is given, each _n_a_m_e refers to a shell variable, - and that variable is removed. Read-only variables may not be un- - set. If --ff is specified, each _n_a_m_e refers to a shell function, - and the function definition is removed. If the --nn option is sup- - plied, and _n_a_m_e is a variable with the _n_a_m_e_r_e_f attribute, _n_a_m_e - will be unset rather than the variable it references. --nn has no - effect if the --ff option is supplied. If no options are supplied, - each _n_a_m_e refers to a variable; if there is no variable by that - name, a function with that name, if any, is unset. Each unset - variable or function is removed from the environment passed to - subsequent commands. If any of BBAASSHH__AALLIIAASSEESS, BBAASSHH__AARRGGVV00, - BBAASSHH__CCMMDDSS, BBAASSHH__CCOOMMMMAANNDD, BBAASSHH__SSUUBBSSHHEELLLL, BBAASSHHPPIIDD, CCOOMMPP__WWOORRDD-- - BBRREEAAKKSS, DDIIRRSSTTAACCKK, EEPPOOCCHHRREEAALLTTIIMMEE, EEPPOOCCHHSSEECCOONNDDSS, FFUUNNCCNNAAMMEE, GGRROOUUPPSS, - HHIISSTTCCMMDD, LLIINNEENNOO, RRAANNDDOOMM, SSEECCOONNDDSS, or SSRRAANNDDOOMM are unset, they - lose their special properties, even if they are subsequently re- - set. The exit status is true unless a _n_a_m_e is readonly or may - not be unset. + For each _n_a_m_e, remove the corresponding variable or function. + If the --vv option is given, each _n_a_m_e refers to a shell variable, + and that variable is removed. Read-only variables may not be + unset. If --ff is specified, each _n_a_m_e refers to a shell func- + tion, and the function definition is removed. If the --nn option + is supplied, and _n_a_m_e is a variable with the _n_a_m_e_r_e_f attribute, + _n_a_m_e will be unset rather than the variable it references. --nn + has no effect if the --ff option is supplied. If no options are + supplied, each _n_a_m_e refers to a variable; if there is no vari- + able by that name, a function with that name, if any, is unset. + Each unset variable or function is removed from the environment + passed to subsequent commands. If any of BBAASSHH__AALLIIAASSEESS, + BBAASSHH__AARRGGVV00, BBAASSHH__CCMMDDSS, BBAASSHH__CCOOMMMMAANNDD, BBAASSHH__SSUUBBSSHHEELLLL, BBAASSHHPPIIDD, + CCOOMMPP__WWOORRDDBBRREEAAKKSS, DDIIRRSSTTAACCKK, EEPPOOCCHHRREEAALLTTIIMMEE, EEPPOOCCHHSSEECCOONNDDSS, FFUUNNCC-- + NNAAMMEE, GGRROOUUPPSS, HHIISSTTCCMMDD, LLIINNEENNOO, RRAANNDDOOMM, SSEECCOONNDDSS, or SSRRAANNDDOOMM are + unset, they lose their special properties, even if they are sub- + sequently reset. The exit status is true unless a _n_a_m_e is read- + only or may not be unset. wwaaiitt [--ffnn] [--pp _v_a_r_n_a_m_e] [_i_d _._._.] Wait for each specified child process and return its termination - status. Each _i_d may be a process ID or a job specification; if a - job spec is given, all processes in that job's pipeline are - waited for. If _i_d is not given, wwaaiitt waits for all running back- - ground jobs and the last-executed process substitution, if its - process id is the same as $$!!, and the return status is zero. If - the --nn option is supplied, wwaaiitt waits for a single job from the - list of _i_ds or, if no _i_ds are supplied, any job, to complete and - returns its exit status. If none of the supplied arguments is a - child of the shell, or if no arguments are supplied and the - shell has no unwaited-for children, the exit status is 127. If + status. Each _i_d may be a process ID or a job specification; if + a job spec is given, all processes in that job's pipeline are + waited for. If _i_d is not given, wwaaiitt waits for all running + background jobs and the last-executed process substitution, if + its process id is the same as $$!!, and the return status is zero. + If the --nn option is supplied, wwaaiitt waits for a single job from + the list of _i_ds or, if no _i_ds are supplied, any job, to complete + and returns its exit status. If none of the supplied arguments + is a child of the shell, or if no arguments are supplied and the + shell has no unwaited-for children, the exit status is 127. If the --pp option is supplied, the process or job identifier of the job for which the exit status is returned is assigned to the - variable _v_a_r_n_a_m_e named by the option argument. The variable will - be unset initially, before any assignment. This is useful only - when the --nn option is supplied. Supplying the --ff option, when - job control is enabled, forces wwaaiitt to wait for _i_d to terminate - before returning its status, instead of returning when it + variable _v_a_r_n_a_m_e named by the option argument. The variable + will be unset initially, before any assignment. This is useful + only when the --nn option is supplied. Supplying the --ff option, + when job control is enabled, forces wwaaiitt to wait for _i_d to ter- + minate before returning its status, instead of returning when it changes status. If _i_d specifies a non-existent process or job, - the return status is 127. If wwaaiitt is interrupted by a signal, + the return status is 127. If wwaaiitt is interrupted by a signal, the return status will be greater than 128, as described under - SSIIGGNNAALLSS in _b_a_s_h_(_1_). Otherwise, the return status is the exit + SSIIGGNNAALLSS in _b_a_s_h_(_1_). Otherwise, the return status is the exit status of the last process or job waited for. SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE Bash-4.0 introduced the concept of a _s_h_e_l_l _c_o_m_p_a_t_i_b_i_l_i_t_y _l_e_v_e_l, speci- fied as a set of options to the shopt builtin ( ccoommppaatt3311, ccoommppaatt3322, - ccoommppaatt4400, ccoommppaatt4411, and so on). There is only one current compatibility - level - each option is mutually exclusive. The compatibility level is - intended to allow users to select behavior from previous versions that - is incompatible with newer versions while they migrate scripts to use - current features and behavior. It's intended to be a temporary solu- - tion. + ccoommppaatt4400, ccoommppaatt4411, and so on). There is only one current compatibil- + ity level -- each option is mutually exclusive. The compatibility + level is intended to allow users to select behavior from previous ver- + sions that is incompatible with newer versions while they migrate + scripts to use current features and behavior. It's intended to be a + temporary solution. This section does not mention behavior that is standard for a particu- lar version (e.g., setting ccoommppaatt3322 means that quoting the rhs of the @@ -2021,23 +2029,23 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE If a user enables, say, ccoommppaatt3322, it may affect the behavior of other compatibility levels up to and including the current compatibility - level. The idea is that each compatibility level controls behavior that - changed in that version of bbaasshh, but that behavior may have been - present in earlier versions. For instance, the change to use locale- + level. The idea is that each compatibility level controls behavior + that changed in that version of bbaasshh, but that behavior may have been + present in earlier versions. For instance, the change to use locale- based comparisons with the [[[[ command came in bash-4.1, and earlier versions used ASCII-based comparisons, so enabling ccoommppaatt3322 will enable - ASCII-based comparisons as well. That granularity may not be sufficient - for all uses, and as a result users should employ compatibility levels - carefully. Read the documentation for a particular feature to find out - the current behavior. + ASCII-based comparisons as well. That granularity may not be suffi- + cient for all uses, and as a result users should employ compatibility + levels carefully. Read the documentation for a particular feature to + find out the current behavior. - Bash-4.3 introduced a new shell variable: BBAASSHH__CCOOMMPPAATT. The value as- + Bash-4.3 introduced a new shell variable: BBAASSHH__CCOOMMPPAATT. The value as- signed to this variable (a decimal version number like 4.2, or an inte- ger corresponding to the ccoommppaatt_N_N option, like 42) determines the com- patibility level. Starting with bash-4.4, bbaasshh has begun deprecating older compatibility - levels. Eventually, the options will be removed in favor of BBAASSHH__CCOOMM-- + levels. Eventually, the options will be removed in favor of BBAASSHH__CCOOMM-- PPAATT. Bash-5.0 is the final version for which there will be an individual @@ -2045,10 +2053,10 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE bash-5.0 and later versions. The following table describes the behavior changes controlled by each - compatibility level setting. The ccoommppaatt_N_N tag is used as shorthand for + compatibility level setting. The ccoommppaatt_N_N tag is used as shorthand for setting the compatibility level to _N_N using one of the following mecha- - nisms. For versions prior to bash-5.0, the compatibility level may be - set using the corresponding ccoommppaatt_N_N shopt option. For bash-4.3 and + nisms. For versions prior to bash-5.0, the compatibility level may be + set using the corresponding ccoommppaatt_N_N shopt option. For bash-4.3 and later versions, the BBAASSHH__CCOOMMPPAATT variable is preferred, and it is re- quired for bash-5.1 and later versions. @@ -2147,7 +2155,7 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE can be expanded more than once +o tteesstt --vv, when given an argument of AA[[@@]], where AAPP iiss aann eexxiissttiinngg aassssoocciiaattiivvee aarrrraayy,, wwiillll rreettuurrnn ttrruuee iiff tthhee aarrrraayy - hhaass aannyy sseett eelleemmeennttss.. BBaasshh--55..22 wwiillll llooookk ffoorr aanndd rreeppoorrtt + hhaass aannyy sseett eelleemmeennttss.. BBaasshh--55..22 wwiillll llooookk ffoorr aanndd rreeppoorrtt oonn aa kkeeyy nnaammeedd @@.. ++oo the ${_p_a_r_a_m_e_t_e_r[[::]]==_v_a_l_u_e} word expansion will return _v_a_l_u_e, before any variable-specific transformations have @@ -2157,11 +2165,11 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE globbing (see the description of the sshhoopptt builtin above) is enabled, so that parsing a command substitution con- taining an extglob pattern (say, as part of a shell func- - tion) will not fail. This assumes the intent is to enable - extglob before the command is executed and word expan- - sions are performed. It will fail at word expansion time - if extglob hasn't been enabled by the time the command is - executed. + tion) will not fail. This assumes the intent is to en- + able extglob before the command is executed and word ex- + pansions are performed. It will fail at word expansion + time if extglob hasn't been enabled by the time the com- + mand is executed. SSEEEE AALLSSOO bash(1), sh(1) diff --git a/pathexp.c b/pathexp.c index a849ec76..a050ca2c 100644 --- a/pathexp.c +++ b/pathexp.c @@ -67,11 +67,11 @@ unquoted_glob_pattern_p (char *string) { register int c; char *send; - int open, bsquote; + int open; DECLARE_MBSTATE; - open = bsquote = 0; + open = 0; send = string + strlen (string); while (c = *string++) @@ -94,33 +94,23 @@ unquoted_glob_pattern_p (char *string) case '/': if (open) open = 0; + continue; case '+': case '@': case '!': - if (*string == '(') /*)*/ + if (extended_glob && *string == '(') /*)*/ return (1); continue; - /* A pattern can't end with a backslash, but a backslash in the pattern - can be special to the matching engine, so we note it in case we - need it later. */ case '\\': - if (*string != '\0' && *string != '/') - { - bsquote = 1; - string++; - continue; - } - else if (open && *string == '/') - { - string++; /* quoted slashes in bracket expressions are ok */ - continue; - } - else if (*string == 0) - return (0); - - case CTLESC: + /* Even after an unquoted backslash, CTLESC either quotes the next + char or escapes a CTLESC or CTLNUL. Either way, the character + after it is not an unquoted globbing char. */ + if (*string == CTLESC) + string++; + /*FALLTHROUGH*/ + case CTLESC: if (*string++ == '\0') return (0); } @@ -136,11 +126,7 @@ unquoted_glob_pattern_p (char *string) #endif } -#if 0 - return (bsquote ? 2 : 0); -#else return (0); -#endif } /* Return 1 if C is a character that is `special' in a POSIX ERE and needs to @@ -175,6 +161,14 @@ glob_char_p (const char *s) { switch (*s) { +#if defined (EXTENDED_GLOB) + case '+': + case '@': + return (s[1] == '('); /*)*/ + case '(': + case '|': + case ')': +#endif case '!': case '^': case '-': @@ -187,11 +181,6 @@ glob_char_p (const char *s) case '?': case '\\': return 1; - case '+': - case '@': - if (s[1] == '(') /*(*/ - return 1; - break; } return 0; } diff --git a/tests/builtins.right b/tests/builtins.right index 1f788774..24b654dc 100644 --- a/tests/builtins.right +++ b/tests/builtins.right @@ -467,7 +467,7 @@ unlimited ./builtins11.sub: line 27: ulimit: +1999: invalid number 0 0 -./builtins11.sub: line 37: ulimit: -q: invalid option +./builtins11.sub: line 37: ulimit: -g: invalid option ulimit: usage: ulimit [-SHabcdefiklmnpqrstuvxPRT] [limit] ./builtins11.sub: line 39: ulimit: max user processes: cannot modify limit: Operation not permitted /tmp /bin @@ -490,3 +490,4 @@ popd: usage: popd [-n] [+N | -N] /tmp / / ./builtins.tests: line 322: exit: status: numeric argument required +after non-numeric arg to exit: 2 diff --git a/tests/builtins.tests b/tests/builtins.tests index f3a8fc2b..60ec6bbc 100644 --- a/tests/builtins.tests +++ b/tests/builtins.tests @@ -318,7 +318,6 @@ shift 0 # succeeds silently options=$(set -o -B 2>&1 | wc -l) [[ $options -gt 3 ]] || echo 'set: bad -o option name parsing' -# this must be last -- it is a fatal error +# this no longer must be last -- it is no longer a fatal error exit status - -echo after bad exit +echo after non-numeric arg to exit: $? diff --git a/tests/builtins11.sub b/tests/builtins11.sub index ec841cbe..2f41df4f 100644 --- a/tests/builtins11.sub +++ b/tests/builtins11.sub @@ -34,7 +34,7 @@ ulimit -c ulimit -a >/dev/null # just make sure we have no errors # these are errors -ulimit -q +ulimit -g # have to see about this one ulimit -u $(( 2**31 - 1 )) diff --git a/tests/errors.right b/tests/errors.right index 394ba933..83057a98 100644 --- a/tests/errors.right +++ b/tests/errors.right @@ -269,6 +269,45 @@ DEBUG ./errors9.sub: line 8: ((: -- : arithmetic syntax error: operand expected (error token is "- ") DEBUG ./errors9.sub: line 10: ((: -- : arithmetic syntax error: operand expected (error token is "- ") +invalid numeric argument +bash: line 1: exit: abcde: numeric argument required +after exit: 2 +bash: line 1: break: abcde: numeric argument required +bash: line 1: continue: abcde: numeric argument required +bash: line 1: shift: abcde: numeric argument required +after shift: 2 +bash: line 1: return: abcde: numeric argument required +after return: 2 +bash: line 1: exit: abcde: numeric argument required +bash: line 1: break: abcde: numeric argument required +bash: line 1: continue: abcde: numeric argument required +bash: line 1: shift: abcde: numeric argument required +bash: line 1: return: abcde: numeric argument required +./errors10.sub: line 38: history: abcde: numeric argument required +after history: 2 +./errors10.sub: line 40: history: too many arguments +after history: 2 +too many arguments +errors: line 3: exit: too many arguments +after exit: 2 +errors: line 3: return: too many arguments +after return: 2 +errors: line 3: shift: too many arguments +after shift: 2 +errors: line 3: break: too many arguments +after break: 2 +errors: line 3: continue: too many arguments +after continue: 2 +errors: line 3: exit: too many arguments +after exit: 2 +errors: line 3: return: too many arguments +after return: 2 +errors: line 3: shift: too many arguments +after shift: 2 +errors: line 3: break: too many arguments +after break: 2 +errors: line 3: continue: too many arguments +after continue: 2 bash: line 1: return: can only `return' from a function or sourced script after return bash: line 1: return: can only `return' from a function or sourced script @@ -277,4 +316,4 @@ sh: line 1: unset: `a-b': not a valid identifier sh: line 1: /nosuchfile: No such file or directory sh: line 1: trap: SIGNOSIG: invalid signal specification after trap -./errors.tests: line 395: `!!': not a valid identifier +./errors.tests: line 398: `!!': not a valid identifier diff --git a/tests/errors.tests b/tests/errors.tests index 2ed935e5..576746d1 100644 --- a/tests/errors.tests +++ b/tests/errors.tests @@ -373,6 +373,9 @@ ${THIS_SH} -o posix ./errors7.sub ${THIS_SH} ./errors8.sub ${THIS_SH} ./errors9.sub +# invalid numeric arguments and too many arguments +${THIS_SH} ./errors10.sub + ${THIS_SH} -c 'return ; echo after return' bash ${THIS_SH} -o posix -c 'return ; echo after return' bash diff --git a/tests/errors10.sub b/tests/errors10.sub new file mode 100644 index 00000000..4ee21076 --- /dev/null +++ b/tests/errors10.sub @@ -0,0 +1,70 @@ +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +: ${THIS_SH:=$PWD/bash} ${TMPDIR:=/tmp} +POSIX_SH="${THIS_SH} -o posix" + +# these are the posix special builtins that take a numeric argument + +echo invalid numeric argument +# default mode +for b in exit break continue shift; do + BUILTIN=$b ${THIS_SH} -c 'set -- a b c; (exit 45); for f in _; do $BUILTIN abcde; done; echo after $BUILTIN: $?' bash +done +${THIS_SH} -c 'func() { return abcde; echo in func: $?; }; func; echo after return: $?' bash + +# posix mode +for b in exit break continue shift; do + BUILTIN=$b ${POSIX_SH} -c 'set -- a b c; (exit 45); for f in _; do $BUILTIN abcde; done; echo after $BUILTIN: $?' bash +done +${POSIX_SH} -c 'func() { return abcde; echo in func: $?; }; func; echo after return: $?' bash + +# non-special builtins, no difference +set -o history +HISTFILE=/dev/null +echo a >/dev/null +echo b >/dev/null +echo c >/dev/null +history abcde +echo after history: $? +history 10 42 +echo after history: $? +set +o history + +# too many arguments + +echo too many arguments + +TDIR=$TMPDIR/errors-$$ +TFILE=errors +mkdir $TDIR || exit 1 +cd $TDIR + +cat <<\EOF >$TFILE +set -- a b c +(exit 45) +for f in _; do $BUILTIN 42 abcde; done +echo after $BUILTIN: $? +EOF + +# default mode +for b in exit return shift break continue; do + BUILTIN=$b ${THIS_SH} $TFILE # TFILE for consistent error messages +done +# posix mode +for b in exit return shift break continue; do + BUILTIN=$b ${POSIX_SH} $TFILE # TFILE for consistent error messages +done + +cd $OLDPWD +rm -rf $TDIR diff --git a/tests/invocation.right b/tests/invocation.right index 6f2a3d7f..304fc91d 100644 --- a/tests/invocation.right +++ b/tests/invocation.right @@ -96,6 +96,7 @@ do echo $(( 2**$i )); done +this is bash_logout a a bad-interp diff --git a/tests/invocation.tests b/tests/invocation.tests index 4f9cab37..c629c297 100644 --- a/tests/invocation.tests +++ b/tests/invocation.tests @@ -41,13 +41,15 @@ ${THIS_SH} ./invocation2.sub # rudimentary pretty-print tests ${THIS_SH} ./invocation3.sub -${THIS_SH} --login -c 'logout' - : ${TMPDIR:=/tmp} TDIR=$TMPDIR/invocation-$$ mkdir $TDIR || exit 1 SAVEPWD=$PWD +echo 'echo this is bash_logout' > $TDIR/.bash_logout +HOME=$TDIR ${THIS_SH} --login -c 'logout' +rm -f $TDIR/.bash_logout + # script that ends with a comment and no newline printf 'echo a # comment' > $TDIR/x23.in ${THIS_SH} $TDIR/x23.in