From: Chet Ramey Date: Sat, 26 Oct 2024 16:39:17 +0000 (-0400) Subject: do not require leading . for rl color prefix etension; fix for isearch in single... X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ee3b91dfd9aaaa2acd60ece9302e7ce6f09e3e73;p=thirdparty%2Fbash.git do not require leading . for rl color prefix etension; fix for isearch in single-byte locales; next set of doc updates (SIGNALS); add warning for invalid job id; allow function names to be non-identifiers in posix mode --- diff --git a/CWRU/CWRU.chlog b/CWRU/CWRU.chlog index 2c460293..cfb94b58 100644 --- a/CWRU/CWRU.chlog +++ b/CWRU/CWRU.chlog @@ -10398,3 +10398,70 @@ doc/bash.1,doc/bashref.texi - update word splitting section to add what IFS whitespace means and how word splitting uses it. Based on a bug-bash discussion + 10/21 + ----- +lib/readline/colors.c +doc/bash.1,lib/readline/doc/readline.3,lib/readline/doc/rluser.texi + - RL_COLOR_PREFIX_EXTENSION: remove the leading `.' again; this was + the result of a misunderstanding about how `dircolors' works + Report from Daniël Gerbrand Haasbroek + +lib/readline/isearch.c + - _rl_isearch_dispatch: when adding the character to the search + string, insert it as a single byte in the C locale (or if we're + not doing multibyte characters) + Report and patch from Grisha Levit + + 10/23 + ----- +doc/bash.1,doc/bashref.texi + - SIGNALS: update section to make it clear how job control affects + SIGINT receipt and the behavior of the shell when it's waiting + for a command that receives one. + From a suggestion by Simone Robinson + +builtins/common.c + - get_job_spec: warn about deprecated notation if the job spec doesn't + have a leading `%'; code to return BAD_JOBSPEC tagged for bash-5.4 + - sh_invalidjob: new convenience function to print error for invalid + job specifications + +builtins/jobs.def, builtins/ kill.def, builtins/ wait.def, builtins/fg_bg.def + - handle BAD_JOBSPEC return from get_job_spec; call sh_invalidjob. + Nothing returns that yet. + +builtins/kill.def + - kill_builtin: change to use common error message via sh_badpid() if + we get an argument where the first character is not a digit or `%' + +builtins/jobs.def + - jobs_builtin: check for INVALID_JOB return from get_job_spec to + avoid call to get_job_by_jid + + 10/24 + ----- +error.c, error.h + - err_invalidid: common error function for invalid identifiers; + changed callers in execute_cmd.c, general.c + +general.c + - valid_function_word: separated posix check against special builtin + names (flags&4) and posix check for valid identifiers (flags&1); + callers need to differentiate. This means that posix mode does not + require function names to be valid identifiers + +execute_cmd.c + - execute_intern_function: don't call valid_function_word with + (flags&1) in posix mode unless POSIX_RESTRICT_FUNCNAME is defined; + call with flags&4 to keep the check against special builtin names + +print_cmd.c + - print_function_def,named_function_string: don't print functions + with names that are invalid identifiers with a leading `function' + +config-top.h + - POSIX_RESTRICT_FUNCNAME: placeholder, not defined by default + +doc/bashref.texi + - Posix mode: remove item about function names being valid shell + identifiers diff --git a/POSIX b/POSIX index adb84c14..b313af82 100644 --- a/POSIX +++ b/POSIX @@ -94,113 +94,111 @@ The following list is what's changed when 'POSIX mode' is in effect: 10. Redirection operators do not perform word splitting on the word in a redirection. - 11. Function names must be valid shell ‘name’s. That is, they may not - contain characters other than letters, digits, and underscores, and - may not start with a digit. Declaring a function with an invalid - name in a non-interactive shell is a fatal syntax error. - - 12. Function names may not be the same as one of the POSIX special + 11. Function names may not be the same as one of the POSIX special builtins. - 13. Tilde expansion is only performed on assignments preceding a + 12. Tilde expansion is only performed on assignments preceding a command name, rather than on all assignment statements on the line. - 14. While variable indirection is available, it may not be applied to + 13. While variable indirection is available, it may not be applied to the ‘#’ and ‘?’ special parameters. - 15. Expanding the ‘*’ special parameter in a pattern context where the + 14. Expanding the ‘*’ special parameter in a pattern context where the expansion is double-quoted does not treat the ‘$*’ as if it were double-quoted. - 16. A double quote character (‘"’) is treated specially when it + 15. A double quote character (‘"’) is treated specially when it appears in a backquoted command substitution in the body of a here-document that undergoes expansion. That means, for example, that a backslash preceding a double quote character will escape it and the backslash will be removed. - 17. Command substitutions don't set the ‘?’ special parameter. The + 16. Command substitutions don't set the ‘?’ special parameter. The exit status of a simple command without a command word is still the exit status of the last command substitution that occurred while evaluating the variable assignments and redirections in that command, but that does not happen until after all of the assignments and redirections. - 18. Literal tildes that appear as the first character in elements of + 17. Literal tildes that appear as the first character in elements of the ‘PATH’ variable are not expanded as described above under *note Tilde Expansion::. - 19. Command lookup finds POSIX special builtins before shell + 18. Command lookup finds POSIX special builtins before shell functions, including output printed by the ‘type’ and ‘command’ builtins. - 20. Even if a shell function whose name contains a slash was defined + 19. Even if a shell function whose name contains a slash was defined before entering POSIX mode, the shell will not execute a function whose name contains one or more slashes. - 21. When a command in the hash table no longer exists, Bash will + 20. When a command in the hash table no longer exists, Bash will re-search ‘$PATH’ to find the new location. This is also available with ‘shopt -s checkhash’. - 22. Bash will not insert a command without the execute bit set into + 21. Bash will not insert a command without the execute bit set into the command hash table, even if it returns it as a (last-ditch) result from a ‘$PATH’ search. - 23. The message printed by the job control code and builtins when a + 22. The message printed by the job control code and builtins when a job exits with a non-zero status is 'Done(status)'. - 24. The message printed by the job control code and builtins when a + 23. The message printed by the job control code and builtins when a job is stopped is 'Stopped(SIGNAME)', where SIGNAME is, for example, ‘SIGTSTP’. - 25. If the shell is interactive, Bash does not perform job + 24. If the shell is interactive, Bash does not perform job notifications between executing commands in lists separated by ‘;’ or newline. Non-interactive shells print status messages after a foreground job in a list completes. - 26. If the shell is interactive, Bash waits until the next prompt + 25. If the shell is interactive, Bash waits until the next prompt before printing the status of a background job that changes status or a foreground job that terminates due to a signal. Non-interactive shells print status messages after a foreground job completes. - 27. Bash permanently removes jobs from the jobs table after notifying + 26. Bash permanently removes jobs from the jobs table after notifying the user of their termination via the ‘wait’ or ‘jobs’ builtins. + It removes the job from the jobs list after notifying the user of + its termination, but the status is still available via ‘wait’, as + long as ‘wait’ is supplied a PID argument. - 28. The ‘vi’ editing mode will invoke the ‘vi’ editor directly when + 27. The ‘vi’ editing mode will invoke the ‘vi’ editor directly when the ‘v’ command is run, instead of checking ‘$VISUAL’ and ‘$EDITOR’. - 29. Prompt expansion enables the POSIX ‘PS1’ and ‘PS2’ expansions of + 28. Prompt expansion enables the POSIX ‘PS1’ and ‘PS2’ expansions of ‘!’ to the history number and ‘!!’ to ‘!’, and Bash performs parameter expansion on the values of ‘PS1’ and ‘PS2’ regardless of the setting of the ‘promptvars’ option. - 30. The default history file is ‘~/.sh_history’ (this is the default + 29. The default history file is ‘~/.sh_history’ (this is the default value the shell assigns to ‘$HISTFILE’). - 31. The ‘!’ character does not introduce history expansion within a + 30. The ‘!’ character does not introduce history expansion within a double-quoted string, even if the ‘histexpand’ option is enabled. - 32. When printing shell function definitions (e.g., by ‘type’), Bash - does not print the ‘function’ keyword. + 31. When printing shell function definitions (e.g., by ‘type’), Bash + does not print the ‘function’ keyword unless necessary. - 33. Non-interactive shells exit if a syntax error in an arithmetic + 32. Non-interactive shells exit if a syntax error in an arithmetic expansion results in an invalid expression. - 34. Non-interactive shells exit if a parameter expansion error occurs. + 33. Non-interactive shells exit if a parameter expansion error occurs. - 35. If a POSIX special builtin returns an error status, a + 34. If a POSIX special builtin returns an error status, a non-interactive shell exits. The fatal errors are those listed in the POSIX standard, and include things like passing incorrect options, redirection errors, variable assignment errors for assignments preceding the command name, and so on. - 36. A non-interactive shell exits with an error status if a variable + 35. A non-interactive shell exits with an error status if a variable assignment error occurs when no command name follows the assignment statements. A variable assignment error occurs, for example, when trying to assign a value to a readonly variable. - 37. A non-interactive shell exits with an error status if a variable + 36. A non-interactive shell exits with an error status if a variable assignment error occurs in an assignment statement preceding a special builtin, but not with any other simple command. For any other simple command, the shell aborts execution of that command, @@ -208,156 +206,156 @@ The following list is what's changed when 'POSIX mode' is in effect: perform any further processing of the command in which the error occurred"). - 38. A non-interactive shell exits with an error status if the + 37. A non-interactive shell exits with an error status if the iteration variable in a ‘for’ statement or the selection variable in a ‘select’ statement is a readonly variable or has an invalid name. - 39. Non-interactive shells exit if FILENAME in ‘.’ FILENAME is not + 38. Non-interactive shells exit if FILENAME in ‘.’ FILENAME is not found. - 40. Non-interactive shells exit if there is a syntax error in a script + 39. Non-interactive shells exit if there is a syntax error in a script read with the ‘.’ or ‘source’ builtins, or in a string processed by the ‘eval’ builtin. - 41. Non-interactive shells exit if the ‘export’, ‘readonly’ or ‘unset’ + 40. Non-interactive shells exit if the ‘export’, ‘readonly’ or ‘unset’ builtin commands get an argument that is not a valid identifier, and they are not operating on shell functions. These errors force an exit because these are special builtins. - 42. Assignment statements preceding POSIX special builtins persist in + 41. Assignment statements preceding POSIX special builtins persist in the shell environment after the builtin completes. - 43. The ‘command’ builtin does not prevent builtins that take + 42. The ‘command’ builtin does not prevent builtins that take assignment statements as arguments from expanding them as assignment statements; when not in POSIX mode, declaration commands lose their assignment statement expansion properties when preceded by ‘command’. - 44. Enabling POSIX mode has the effect of setting the + 43. Enabling POSIX mode has the effect of setting the ‘inherit_errexit’ option, so subshells spawned to execute command substitutions inherit the value of the ‘-e’ option from the parent shell. When the ‘inherit_errexit’ option is not enabled, Bash clears the ‘-e’ option in such subshells. - 45. Enabling POSIX mode has the effect of setting the ‘shift_verbose’ + 44. Enabling POSIX mode has the effect of setting the ‘shift_verbose’ option, so numeric arguments to ‘shift’ that exceed the number of positional parameters will result in an error message. - 46. Enabling POSIX mode has the effect of setting the + 45. Enabling POSIX mode has the effect of setting the ‘interactive_comments’ option (*note Comments::). - 47. The ‘.’ and ‘source’ builtins do not search the current directory + 46. The ‘.’ and ‘source’ builtins do not search the current directory for the filename argument if it is not found by searching ‘PATH’. - 48. When the ‘alias’ builtin displays alias definitions, it does not + 47. When the ‘alias’ builtin displays alias definitions, it does not display them with a leading ‘alias ’ unless the ‘-p’ option is supplied. - 49. The ‘bg’ builtin uses the required format to describe each job + 48. The ‘bg’ builtin uses the required format to describe each job placed in the background, which does not include an indication of whether the job is the current or previous job. - 50. When the ‘cd’ builtin is invoked in logical mode, and the pathname + 49. When the ‘cd’ builtin is invoked in logical mode, and the pathname constructed from ‘$PWD’ and the directory name supplied as an argument does not refer to an existing directory, ‘cd’ will fail instead of falling back to physical mode. - 51. When the ‘cd’ builtin cannot change a directory because the length + 50. When the ‘cd’ builtin cannot change a directory because the length of the pathname constructed from ‘$PWD’ and the directory name supplied as an argument exceeds ‘PATH_MAX’ when canonicalized, ‘cd’ will attempt to use the supplied directory name. - 52. When the ‘xpg_echo’ option is enabled, Bash does not attempt to + 51. When the ‘xpg_echo’ option is enabled, Bash does not attempt to interpret any arguments to ‘echo’ as options. ‘echo’ displays each argument after converting escape sequences. - 53. The ‘export’ and ‘readonly’ builtin commands display their output + 52. The ‘export’ and ‘readonly’ builtin commands display their output in the format required by POSIX. - 54. When listing the history, the ‘fc’ builtin does not include an + 53. When listing the history, the ‘fc’ builtin does not include an indication of whether or not a history entry has been modified. - 55. The default editor used by ‘fc’ is ‘ed’. + 54. The default editor used by ‘fc’ is ‘ed’. - 56. ‘fc’ treats extra arguments as an error instead of ignoring them. + 55. ‘fc’ treats extra arguments as an error instead of ignoring them. - 57. If there are too many arguments supplied to ‘fc -s’, ‘fc’ prints + 56. If there are too many arguments supplied to ‘fc -s’, ‘fc’ prints an error message and returns failure. - 58. The output of ‘kill -l’ prints all the signal names on a single + 57. The output of ‘kill -l’ prints all the signal names on a single line, separated by spaces, without the ‘SIG’ prefix. - 59. The ‘kill’ builtin does not accept signal names with a ‘SIG’ + 58. The ‘kill’ builtin does not accept signal names with a ‘SIG’ prefix. - 60. The ‘printf’ builtin uses ‘double’ (via ‘strtod’) to convert + 59. The ‘printf’ builtin uses ‘double’ (via ‘strtod’) to convert arguments corresponding to floating point conversion specifiers, instead of ‘long double’ if it's available. The ‘L’ length modifier forces ‘printf’ to use ‘long double’ if it's available. - 61. The ‘pwd’ builtin verifies that the value it prints is the same as + 60. The ‘pwd’ builtin verifies that the value it prints is the same as the current directory, even if it is not asked to check the file system with the ‘-P’ option. - 62. The ‘read’ builtin may be interrupted by a signal for which a trap + 61. The ‘read’ builtin may be interrupted by a signal for which a trap has been set. If Bash receives a trapped signal while executing ‘read’, the trap handler executes and ‘read’ returns an exit status greater than 128. - 63. When the ‘set’ builtin is invoked without options, it does not + 62. When the ‘set’ builtin is invoked without options, it does not display shell function names and definitions. - 64. When the ‘set’ builtin is invoked without options, it displays + 63. When the ‘set’ builtin is invoked without options, it displays variable values without quotes, unless they contain shell metacharacters, even if the result contains nonprinting characters. - 65. The ‘test’ builtin compares strings using the current locale when + 64. The ‘test’ builtin compares strings using the current locale when evaluating the ‘<’ and ‘>’ binary operators. - 66. The ‘test’ builtin's ‘-t’ unary primary requires an argument. + 65. The ‘test’ builtin's ‘-t’ unary primary requires an argument. Historical versions of ‘test’ made the argument optional in certain cases, and Bash attempts to accommodate those for backwards compatibility. - 67. The ‘trap’ builtin displays signal names without the leading + 66. The ‘trap’ builtin displays signal names without the leading ‘SIG’. - 68. The ‘trap’ builtin doesn't check the first argument for a possible + 67. The ‘trap’ builtin doesn't check the first argument for a possible signal specification and revert the signal handling to the original disposition if it is, unless that argument consists solely of digits and is a valid signal number. If users want to reset the handler for a given signal to the original disposition, they should use ‘-’ as the first argument. - 69. ‘trap -p’ without arguments displays signals whose dispositions + 68. ‘trap -p’ without arguments displays signals whose dispositions are set to SIG_DFL and those that were ignored when the shell started, not just trapped signals. - 70. The ‘type’ and ‘command’ builtins will not report a non-executable + 69. The ‘type’ and ‘command’ builtins will not report a non-executable file as having been found, though the shell will attempt to execute such a file if it is the only so-named file found in ‘$PATH’. - 71. The ‘ulimit’ builtin uses a block size of 512 bytes for the ‘-c’ + 70. The ‘ulimit’ builtin uses a block size of 512 bytes for the ‘-c’ and ‘-f’ options. - 72. The ‘unset’ builtin with the ‘-v’ option specified returns a fatal + 71. The ‘unset’ builtin with the ‘-v’ option specified returns a fatal error if it attempts to unset a ‘readonly’ or ‘non-unsettable’ variable, which causes a non-interactive shell to exit. - 73. When asked to unset a variable that appears in an assignment + 72. When asked to unset a variable that appears in an assignment statement preceding the command, the ‘unset’ builtin attempts to unset a variable of the same name in the current or previous scope as well. This implements the required "if an assigned variable is further modified by the utility, the modifications made by the utility shall persist" behavior. - 74. The arrival of ‘SIGCHLD’ when a trap is set on ‘SIGCHLD’ does not + 73. The arrival of ‘SIGCHLD’ when a trap is set on ‘SIGCHLD’ does not interrupt the ‘wait’ builtin and cause it to return immediately. The trap command is run once for each child that exits. - 75. Bash removes an exited background process's status from the list - of such statuses after the ‘wait’ builtin is used to obtain it. + 74. Bash removes an exited background process's status from the list + of such statuses after the ‘wait’ builtin returns it. There is other POSIX behavior that Bash does not implement by default even when in POSIX mode. Specifically: diff --git a/builtins/common.c b/builtins/common.c index 3e84ff9a..13a6b7b3 100644 --- a/builtins/common.c +++ b/builtins/common.c @@ -272,6 +272,13 @@ sh_nojobs (const char *s) else builtin_error (_("no job control")); } + +void +sh_invalidjob (const char *s) +{ + builtin_error (_("%s: invalid job specification"), s); +} + #endif #if defined (RESTRICTED_SHELL) @@ -693,6 +700,14 @@ get_job_spec (WORD_LIST *list) if (*word == '%') word++; + else +#if 1 + /* This could be builtin_error or sh_invalidjob() */ + builtin_warning (_("%s: job specification requires leading `%%'"), word); +#else + /* TAG:bash-5.4 10/23/2024 */ + return (BAD_JOBSPEC); +#endif if (DIGIT (*word) && all_digits (word)) { diff --git a/builtins/common.h b/builtins/common.h index 99684920..a169f494 100644 --- a/builtins/common.h +++ b/builtins/common.h @@ -103,6 +103,7 @@ extern void sh_erange (const char *, const char *); extern void sh_badpid (const char *); extern void sh_badjob (const char *); extern void sh_nojobs (const char *); +extern void sh_invalidjob (const char *); extern void sh_restricted (const char *); extern void sh_notbuiltin (const char *); extern void sh_wrerror (void); diff --git a/builtins/fg_bg.def b/builtins/fg_bg.def index bfff5f9b..84ac36ca 100644 --- a/builtins/fg_bg.def +++ b/builtins/fg_bg.def @@ -1,7 +1,7 @@ This file is fg_bg.def, from which is created fg_bg.c. It implements the builtins "bg" and "fg" in Bash. -Copyright (C) 1987-2022 Free Software Foundation, Inc. +Copyright (C) 1987-2024 Free Software Foundation, Inc. This file is part of GNU Bash, the Bourne Again SHell. @@ -144,7 +144,9 @@ fg_bg (WORD_LIST *list, int foreground) if (INVALID_JOB (job)) { - if (job != DUP_JOB) + if (job == BAD_JOBSPEC) + sh_invalidjob (list->word->word); + else if (job != DUP_JOB) sh_badjob (list ? list->word->word : _("current")); goto failure; diff --git a/builtins/jobs.def b/builtins/jobs.def index 1a237fdb..643f43f1 100644 --- a/builtins/jobs.def +++ b/builtins/jobs.def @@ -155,7 +155,7 @@ jobs_builtin (WORD_LIST *list) BLOCK_CHILD (set, oset); job = get_job_spec (list); - if ((job == NO_JOB) || jobs == 0 || get_job_by_jid (job) == 0) + if ((job == NO_JOB) || jobs == 0 || INVALID_JOB (job) || get_job_by_jid (job) == 0) { sh_badjob (list->word->word); any_failed++; @@ -287,7 +287,10 @@ disown_builtin (WORD_LIST *list) if (job == NO_JOB || jobs == 0 || INVALID_JOB (job)) { - sh_badjob (list ? list->word->word : _("current")); + if (job == BAD_JOBSPEC) + sh_invalidjob (list->word->word); + else + sh_badjob (list ? list->word->word : _("current")); retval = EXECUTION_FAILURE; } else if (nohup_only) diff --git a/builtins/kill.def b/builtins/kill.def index c1ea14b8..f09c932a 100644 --- a/builtins/kill.def +++ b/builtins/kill.def @@ -207,7 +207,11 @@ use_sigspec: #if defined (JOB_CONTROL) else if (*list->word->word && *list->word->word != '%') { +#if 1 + sh_badpid (list->word->word); +#else builtin_error (_("%s: arguments must be process or job IDs"), list->word->word); +#endif CONTINUE_OR_FAIL; } else if (*word) diff --git a/builtins/wait.def b/builtins/wait.def index 98160bea..c8c735aa 100644 --- a/builtins/wait.def +++ b/builtins/wait.def @@ -380,6 +380,8 @@ set_waitlist (WORD_LIST *list) } else if (l->word->word[0] == '%') sh_badjob (l->word->word); + else if (job == BAD_JOBSPEC) + sh_invalidjob (l->word->word); else sh_badpid (l->word->word); continue; diff --git a/config-top.h b/config-top.h index b6e73c4b..c47ab01b 100644 --- a/config-top.h +++ b/config-top.h @@ -139,7 +139,6 @@ /* Define as 1 if you want to enable code that implements multiple coprocs executing simultaneously */ -/* TAG: bash-5.3 */ #ifndef MULTIPLE_COPROCS # define MULTIPLE_COPROCS 1 #endif @@ -206,3 +205,7 @@ #ifndef PATSUB_REPLACE_DEFAULT #define PATSUB_REPLACE_DEFAULT 1 #endif + +/* Define to 1 if you want posix mode to restrict shell function names to + shell NAMEs. */ +/* #define POSIX_RESTRICT_FUNCNAME 0 */ diff --git a/doc/bash.0 b/doc/bash.0 index 4d1cf0ad..b2ae81c3 100644 --- a/doc/bash.0 +++ b/doc/bash.0 @@ -3252,177 +3252,195 @@ SSIIGGNNAALLSS SSIIGGHHUUPP to all jobs when an interactive login shell exits. 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- + which a trap has been set, it will not execute the trap until the com- mand completes. If bbaasshh is waiting for an asynchronous command via the - wwaaiitt builtin, and it receives a signal for which a trap has been set, - the wwaaiitt builtin will return immediately with an exit status greater + wwaaiitt builtin, and it receives a signal for which a trap has been set, + the wwaaiitt builtin will return immediately with an exit status greater than 128, immediately after which the shell executes the trap. - 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 + 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 - processes in that process group. See JJOOBB CCOONNTTRROOLL below for more infor- - mation about process groups. - - 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: + the same process group as the terminal, and ^^CC sends SSIIGGIINNTT to all + processes in that process group. Since bbaasshh does not enable job con- + trol by default when the shell is not interactive, this scenario is + most common in non-interactive shells. + + When job control is enabled, and bbaasshh is waiting for a foreground com- + mand to complete, the shell does not receive keyboard-generated sig- + nals, because it is not in the same process group as the terminal. + This scenario is most common in interactive shells, where bbaasshh attempts + to enable job control by default. See JJOOBB CCOONNTTRROOLL below for more in- + formation about process groups. + + When job control is not enabled, and bbaasshh receives SSIIGGIINNTT while waiting + for a foreground command, it waits until that foreground command termi- + nates 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 - (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 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 + the user meant to send the SSIIGGIINNTT to the shell as well, and acts + on the SSIIGGIINNTT (e.g., by running a SSIIGGIINNTT trap, exiting a non-in- + teractive shell, or returning to the top level to read a new + command). + + 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- + 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. + When job control is enabled, bbaasshh does not receive keyboard-generated + signals such as SSIIGGIINNTT while it is waiting for a foreground command. + An interactive shell does not pay attention to the SSIIGGIINNTT, even if the + foreground command terminates as a result, other than noting its exit + status. If the shell is not interactive, and the foreground command + terminates due to the SSIIGGIINNTT, bbaasshh pretends it received the SSIIGGIINNTT it- + self (scenario 1 above), 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 in- + 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 dri- ver and bbaasshh. - The shell associates a _j_o_b with each pipeline. It keeps a table of - currently executing jobs, which the jjoobbss command will display. Each - job has a _j_o_b _n_u_m_b_e_r, which jjoobbss displays between brackets. Job num- - bers start at 1. When bbaasshh starts a job asynchronously (in the _b_a_c_k_- + The shell associates a _j_o_b with each pipeline. It keeps a table of + currently executing jobs, which the jjoobbss command will display. Each + job has a _j_o_b _n_u_m_b_e_r, which jjoobbss displays between brackets. Job num- + bers start at 1. 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 + 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, each process has a _p_r_o_c_e_s_s _g_r_o_u_p _I_D, and 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. Processes that have - the same process group ID are said to be part of the same _p_r_o_c_e_s_s - _g_r_o_u_p. Members of the _f_o_r_e_g_r_o_u_n_d process group (processes whose + the same process group ID are said to be part of the same _p_r_o_c_e_s_s + _g_r_o_u_p. Members of the _f_o_r_e_g_r_o_u_n_d process group (processes whose process group ID is equal to the current terminal process group ID) re- - ceive keyboard-generated signals such as SSIIGGIINNTT. Processes in the - foreground process group are said to be _f_o_r_e_g_r_o_u_n_d processes. _B_a_c_k_- + ceive keyboard-generated signals such as SSIIGGIINNTT. Processes in the + foreground process group are said to be _f_o_r_e_g_r_o_u_n_d processes. _B_a_c_k_- _g_r_o_u_n_d processes are those whose process group ID differs from the ter- minal's; such processes are immune to keyboard-generated signals. Only foreground processes are allowed to read from or, if the user so speci- - fies with "stty tostop", write to the terminal. Background processes - which attempt to read from (write to when "tostop" is in effect) the - terminal are sent a SSIIGGTTTTIINN ((SSIIGGTTTTOOUU)) signal by the kernel's terminal + fies with "stty tostop", write to the terminal. Background processes + which attempt to read from (write to when "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, + 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 (typ- ically ^^ZZ, Control-Z) while a process is running stops that process and - returns control to bbaasshh. Typing the _d_e_l_a_y_e_d _s_u_s_p_e_n_d character (typi- - cally ^^YY, Control-Y) causes the process stop when it attempts to read - input from the terminal, and returns control to bbaasshh. The user then - manipulates 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. The suspend character takes effect imme- - diately, and has the additional side effect of discarding any pending + returns control to bbaasshh. Typing the _d_e_l_a_y_e_d _s_u_s_p_e_n_d character (typi- + cally ^^YY, Control-Y) causes the process stop when it attempts to read + input from the terminal, and returns control to bbaasshh. The user then + manipulates 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. The suspend character takes effect imme- + diately, and has the additional side effect of discarding any pending output and typeahead. To force a background process to stop, or stop a - process that's not associated with the current terminal session, send + process that's not associated with the current terminal session, send it the SSIIGGSSTTOOPP signal using kkiillll. There are a number of ways to refer to a job in the shell. The %% char- acter introduces a job specification (jobspec). - 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 job whose - command name begins with ccee. Using %%??ccee, on the other hand, refers to + 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 job whose + command name begins with ccee. Using %%??ccee, on the other hand, refers to any job containing the string ccee in its command line. If the prefix or 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. - A single % (with no accompanying job specification) also refers to the - current job. %%-- refers to the _p_r_e_v_i_o_u_s _j_o_b. When a job starts in the + The symbols %%%% and %%++ refer to the shell's notion of the _c_u_r_r_e_n_t _j_o_b. + A single % (with no accompanying job specification) also refers to the + current job. %%-- refers to the _p_r_e_v_i_o_u_s _j_o_b. When a job starts in the background, a job stops while in the foreground, or a job is resumed in - the background, it becomes the current job. The job that was the cur- - rent job becomes the previous job. When the current job terminates, - the previous job becomes the current job. If there is only a single - job, %%++ and %%-- can both be used to refer to that job. In output per- + the background, it becomes the current job. The job that was the cur- + rent job becomes the previous job. When the current job terminates, + the previous job becomes the current job. If there is only a single + job, %%++ and %%-- can both be used to refer to that job. In output per- taining to jobs (e.g., the output of the jjoobbss command), the current job is always marked with a ++, and the previous job with a --. - Simply naming a job can be used to bring it into the foreground: %%11 is - a synonym for "fg %1", bringing job 1 from the background into the + Simply naming a job can be used to bring it into the foreground: %%11 is + a synonym for "fg %1", bringing job 1 from the background into the foreground. Similarly, "%1 &" resumes job 1 in the background, equiva- lent to "bg %1". - The shell learns immediately whenever a job changes state. Normally, - bbaasshh waits until it is about to print a prompt before notifying the - user about changes in a job's status so as to not interrupt any other - output, though it will notify of changes in a job's status after a - foreground command in a list completes, before executing the next com- - mand in the list. If the --bb option to the sseett builtin command is en- + The shell learns immediately whenever a job changes state. Normally, + bbaasshh waits until it is about to print a prompt before notifying the + user about changes in a job's status so as to not interrupt any other + output, though it will notify of changes in a job's status after a + foreground command in a list completes, before executing the next com- + mand in the list. If the --bb option to the sseett builtin command is en- abled, bbaasshh reports status changes immediately. BBaasshh executes any trap on SSIIGGCCHHLLDD for each child that terminates. When a job terminates and bbaasshh notifies the user about it, bbaasshh removes - the job from the table. It will not appear in jjoobbss output, but wwaaiitt - will report its exit status, as long as it's supplied the process ID - associated with the job as an argument. When the table is empty, job + the job from the table. It will not appear in jjoobbss output, but wwaaiitt + will report its exit status, as long as it's supplied the process ID + associated with the job as an argument. When the table is empty, job numbers start over at 1. - If a user attempts to exit bbaasshh while jobs are stopped (or, if the - cchheecckkjjoobbss shell option has been enabled using the sshhoopptt builtin, run- + If a user attempts to exit bbaasshh 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 + is enabled, lists the jobs and their statuses. The jjoobbss command may then be used to inspect their status. If the user immediately attempts - to exit again, without an intervening command, bbaasshh does not print an- + to exit again, without an intervening command, bbaasshh does not print an- other warning, and terminates any stopped jobs. - 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 + 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 + it is ready to read a command, and the secondary prompt PPSS22 when it needs more input to complete a command. - BBaasshh examines the value of the array variable PPRROOMMPPTT__CCOOMMMMAANNDD just be- - fore printing each primary prompt. If any elements in PPRROOMMPPTT__CCOOMMMMAANNDD - are set and non-null, Bash executes each value, in numeric order, just - as if it had been typed on the command line. BBaasshh displays PPSS00 after + BBaasshh examines the value of the array variable PPRROOMMPPTT__CCOOMMMMAANNDD just be- + fore printing each primary prompt. If any elements in PPRROOMMPPTT__CCOOMMMMAANNDD + are set and non-null, Bash executes each value, in numeric order, just + as if it had been typed on the command line. BBaasshh displays PPSS00 after it reads a command but before executing it. - BBaasshh displays PPSS44 as described above before tracing each command when + BBaasshh displays PPSS44 as described above before tracing each command when the --xx option is enabled. BBaasshh allows the prompt strings PPSS00, PPSS11, PPSS22, and PPSS44, to be customized - by inserting a number of backslash-escaped special characters that are + 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 + \\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 + 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. \\jj The number of jobs currently managed by the shell. - \\ll The basename of the shell's terminal device name (e.g., + \\ll The basename of the shell's terminal device name (e.g., "ttys0"). \\nn A newline. \\rr A carriage return. - \\ss The name of the shell: the basename of $$00 (the portion + \\ss The name of the shell: the basename of $$00 (the portion following the final slash). \\tt The current time in 24-hour HH:MM:SS format. \\TT The current time in 12-hour HH:MM:SS format. @@ -3431,104 +3449,104 @@ PPRROOMMPPTTIINNGG \\uu The username of the current user. \\vv The bbaasshh version (e.g., 2.00). \\VV The bbaasshh release, version + patch level (e.g., 2.00.0) - \\ww The value of the PPWWDD shell variable ($$PPWWDD), with $$HHOOMMEE - abbreviated with a tilde (uses the value of the + \\ww The value of the PPWWDD shell variable ($$PPWWDD), with $$HHOOMMEE + abbreviated with a tilde (uses the value of the PPRROOMMPPTT__DDIIRRTTRRIIMM variable). - \\WW The basename of $$PPWWDD, with $$HHOOMMEE abbreviated with a + \\WW The basename of $$PPWWDD, with $$HHOOMMEE abbreviated with a tilde. \\!! The history number of this command. \\## The command number of this command. \\$$ If the effective UID is 0, a ##, otherwise a $$. \\_n_n_n The character corresponding to the octal number _n_n_n. \\\\ A backslash. - \\[[ Begin a sequence of non-printing characters, which could - be used to embed a terminal control sequence into the + \\[[ Begin a sequence of non-printing characters, which could + be used to embed a terminal control sequence into the prompt. \\]] End a sequence of non-printing characters. - The command number and the history number are usually different: the - 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 - decoded, it is expanded via parameter expansion, command substitution, - arithmetic expansion, and quote removal, subject to the value of the + The command number and the history number are usually different: the + 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 + 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 - escaped portions of the string appear within command substitution or + 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. RREEAADDLLIINNEE - This is the library that handles reading input when using an interac- - tive shell, unless the ----nnooeeddiittiinngg option is supplied at shell invoca- - tion. Line editing is also used when using the --ee option to the rreeaadd + This is the library that handles reading input when using an interac- + tive shell, unless the ----nnooeeddiittiinngg option is supplied at shell invoca- + tion. 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 edit- - ing 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 after the shell is running, use the ++oo eemmaaccss or ++oo vvii options + ing 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 after the shell is running, use the ++oo eemmaaccss or ++oo vvii options to the sseett builtin. RReeaaddlliinnee NNoottaattiioonn - This section uses Emacs-style editing concepts and uses its notation - for keystrokes. Control keys are denoted by C-_k_e_y, e.g., C-n means - Control-N. Similarly, _m_e_t_a keys are denoted by M-_k_e_y, so M-x means + This section uses Emacs-style editing concepts and uses its notation + for keystrokes. Control keys are denoted by C-_k_e_y, e.g., C-n means + Control-N. Similarly, _m_e_t_a keys are denoted by M-_k_e_y, so M-x means Meta-X. The Meta key is often labeled "Alt" or "Option". - On keyboards without a _M_e_t_a key, M-_x means ESC _x, i.e., press and re- - lease the Escape key, then press and release the _x key, in sequence. - This makes ESC the _m_e_t_a _p_r_e_f_i_x. The combination M-C-_x means ESC-Con- - trol-_x: press and release the Escape key, then press and hold the Con- + On keyboards without a _M_e_t_a key, M-_x means ESC _x, i.e., press and re- + lease the Escape key, then press and release the _x key, in sequence. + This makes ESC the _m_e_t_a _p_r_e_f_i_x. The combination M-C-_x means ESC-Con- + trol-_x: press and release the Escape key, then press and hold the Con- trol key while pressing the _x key, then release both. - On some keyboards, the Meta key modifier produces characters with the - eighth bit (0200) set. You can use the eennaabbllee--mmeettaa--kkeeyy variable to - control whether or not it does this, if the keyboard allows it. On - many others, the terminal or terminal emulator converts the metafied - key to a key sequence beginning with ESC as described in the preceding + On some keyboards, the Meta key modifier produces characters with the + eighth bit (0200) set. You can use the eennaabbllee--mmeettaa--kkeeyy variable to + control whether or not it does this, if the keyboard allows it. On + many others, the terminal or terminal emulator converts the metafied + key to a key sequence beginning with ESC as described in the preceding paragraph. - If your _M_e_t_a key produces a key sequence with the ESC meta prefix, you - can make M-_k_e_y key bindings you specify (see RReeaaddlliinnee KKeeyy BBiinnddiinnggss be- + If your _M_e_t_a key produces a key sequence with the ESC meta prefix, you + can make M-_k_e_y key bindings you specify (see RReeaaddlliinnee KKeeyy BBiinnddiinnggss be- low) do the same thing by setting the ffoorrccee--mmeettaa--pprreeffiixx variable. RReeaaddlliinnee 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) makes that command act - in a backward direction. Commands whose behavior with arguments devi- + 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) makes that command act + in a backward direction. Commands whose behavior with arguments devi- ates from this are noted below. - The _p_o_i_n_t is the current cursor position, and _m_a_r_k refers to a saved + 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 referred to as the _r_e_g_i_o_n. RReeaaddlliinnee has the concept of an _a_c_t_i_v_e _r_e_g_i_o_n: when the re- - gion is active, rreeaaddlliinnee redisplay highlights the region using the + gion is active, rreeaaddlliinnee redisplay highlights the region using the value of the aaccttiivvee--rreeggiioonn--ssttaarrtt--ccoolloorr variable. The eennaabbllee--aaccttiivvee--rree-- - ggiioonn variable turns this on and off. Several commands set the region + ggiioonn variable turns this on and off. Several commands set the region to active; those are noted below. - When a command is described as _k_i_l_l_i_n_g text, the text deleted is saved + 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 accumulate the deleted text into one + _k_i_l_l _r_i_n_g. Consecutive kills accumulate the deleted text 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 - RReeaaddlliinnee 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 shell 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, rreeaaddlliinnee + RReeaaddlliinnee 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 shell 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, rreeaaddlliinnee looks for _/_e_t_c_/_i_n_p_u_t_r_c. When a program which uses the rreeaaddlliinnee library - starts up, rreeaaddlliinnee reads the initialization file and sets the key + starts up, rreeaaddlliinnee reads the initialization file and sets the key bindings and variables found there, before reading any user input. - There are only a few basic constructs allowed in the inputrc file. + There are only a few basic constructs allowed in the inputrc 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 in this section may be changed using key bind- - ing commands in the _i_n_p_u_t_r_c file. Programs that use the rreeaaddlliinnee li- + ing commands in the _i_n_p_u_t_r_c file. Programs that use the rreeaaddlliinnee li- brary, including bbaasshh, may add their own commands and bindings. For example, placing @@ -3537,26 +3555,26 @@ RREEAADDLLIINNEE or C-Meta-u: universal-argument - into the _i_n_p_u_t_r_c would make M-C-u execute the rreeaaddlliinnee command _u_n_i_v_e_r_- + into the _i_n_p_u_t_r_c would make M-C-u execute the rreeaaddlliinnee command _u_n_i_v_e_r_- _s_a_l_-_a_r_g_u_m_e_n_t. - Key bindings may contain the following symbolic character names: _D_E_L, - _E_S_C, _E_S_C_A_P_E, _L_F_D, _N_E_W_L_I_N_E, _R_E_T, _R_E_T_U_R_N, _R_U_B_O_U_T(a_d_e_s_t_r_u_c_t_i_v_ebackspace), + Key bindings may contain the following symbolic character names: _D_E_L, + _E_S_C, _E_S_C_A_P_E, _L_F_D, _N_E_W_L_I_N_E, _R_E_T, _R_E_T_U_R_N, _R_U_B_O_U_T(a_d_e_s_t_r_u_c_t_i_v_ebackspace), _S_P_A_C_E, _S_P_C, and _T_A_B. - In addition to command names, rreeaaddlliinnee allows keys to be bound to a + In addition to command names, rreeaaddlliinnee allows keys to be bound to a string that is inserted when the key is pressed (a _m_a_c_r_o). The differ- - ence between a macro and a command is that a macro is enclosed in sin- + ence between a macro and a command is that a macro is enclosed in sin- gle or double quotes. 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 key sequence may - be specified 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 composed of one or - more characters enclosed in double quotes. The key sequence and name - are separated by a colon. There can be no whitespace between the name + 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 key sequence may + be specified 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 composed of one or + more characters enclosed in double quotes. The key sequence and name + are separated by a colon. There can be no whitespace between the name and the colon. 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 @@ -3566,15 +3584,15 @@ RREEAADDLLIINNEE 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 none of the symbolic character names are recognized. "\C-u": universal-argument @@ -3582,21 +3600,21 @@ 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 available when speci- + The full set of GNU Emacs style escape sequences available when speci- fying key sequences is \\CC-- A control prefix. - \\MM-- Adding the meta prefix or converting the following char- - acter to a meta character, as described below under + \\MM-- Adding the meta prefix or converting the following char- + acter to a meta character, as described below under ffoorrccee--mmeettaa--pprreeffiixx. \\ee An escape character. \\\\ Backslash. \\"" Literal ", a double quote. \\'' Literal ', a single quote. - 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 @@ -3606,20 +3624,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. Tthe backslash escapes described above are expanded in the - macro body. Backslash will quote any other character in the macro + tion name. Tthe backslash escapes described above are expanded in the + macro body. Backslash will quote any other character in the macro text, including " and '. - BBaasshh will display or modify the current rreeaaddlliinnee key bindings with the + BBaasshh will display or modify the current rreeaaddlliinnee key bindings with the bbiinndd builtin command. The --oo eemmaaccss or --oo vvii options to the sseett builtin - (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) will change the editing mode during + (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) will change the editing mode during interactive use. RReeaaddlliinnee VVaarriiaabblleess @@ -3630,356 +3648,356 @@ 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, rreeaaddlliinnee variables can take the values OOnn or OOffff - (without regard to case). Unrecognized variable names are ignored. + Except where noted, rreeaaddlliinnee variables can take the values OOnn or OOffff + (without regard to case). Unrecognized variable names are ignored. When rreeaaddlliinnee reads a variable value, empty or null values, "on" (case- - insensitive), and "1" are equivalent to OOnn. All other values are + insensitive), and "1" are equivalent to OOnn. All other values are equivalent to OOffff. - The bbiinndd --VV command lists the current rreeaaddlliinnee variable names and val- + The bbiinndd --VV command lists the current rreeaaddlliinnee variable names and val- ues (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). 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 - terminal in standout mode, as obtained from the terminal's ter- + 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 - 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- + 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 rreeaaddlliinnee wants to ring the terminal + Controls what happens when rreeaaddlliinnee wants to ring the terminal bell. If set to nnoonnee, rreeaaddlliinnee never rings the bell. If set to - vviissiibbllee, rreeaaddlliinnee uses a visible bell if one is available. If + vviissiibbllee, rreeaaddlliinnee uses a visible bell if one is available. If set to aauuddiibbllee, rreeaaddlliinnee attempts to ring the terminal's bell. bbiinndd--ttttyy--ssppeecciiaall--cchhaarrss ((OOnn)) - If set to OOnn, rreeaaddlliinnee attempts to bind the control characters - that are treated specially by the kernel's terminal driver to + If set to OOnn, rreeaaddlliinnee attempts to bind the control characters + that are treated specially by the kernel's terminal driver to their rreeaaddlliinnee equivalents. These override the default rreeaaddlliinnee bindings described here. Type "stty -a" at a bbaasshh prompt to see - your current terminal settings, including the special control + your current terminal settings, including the special control characters (usually cccchhaarrss). bblliinnkk--mmaattcchhiinngg--ppaarreenn ((OOffff)) If set to OOnn, rreeaaddlliinnee 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, rreeaaddlliinnee displays the + If set to OOnn, when listing completions, rreeaaddlliinnee displays the common prefix of the set of possible completions using a differ- - ent color. The color definitions are taken from the value of + 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", rreeaaddlliinnee uses this color for the common prefix + pletion-prefix", rreeaaddlliinnee uses this color for the common prefix instead of its default. ccoolloorreedd--ssttaattss ((OOffff)) - If set to OOnn, rreeaaddlliinnee 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 + If set to OOnn, rreeaaddlliinnee 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 the rreeaaddlliinnee iinnsseerrtt--ccoommmmeenntt command inserts. - This command is bound to MM--## in emacs mode and to ## in vi com- + The string that the rreeaaddlliinnee iinnsseerrtt--ccoommmmeenntt command inserts. + This command is bound to MM--## in emacs mode and to ## in vi com- mand 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 + 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 value is -1. ccoommpplleettiioonn--iiggnnoorree--ccaassee ((OOffff)) If set to OOnn, rreeaaddlliinnee performs filename matching and completion in a case-insensitive fashion. ccoommpplleettiioonn--mmaapp--ccaassee ((OOffff)) - If set to OOnn, and ccoommpplleettiioonn--iiggnnoorree--ccaassee is enabled, rreeaaddlliinnee - treats hyphens (_-) and underscores (__) as equivalent when per- + If set to OOnn, and ccoommpplleettiioonn--iiggnnoorree--ccaassee is enabled, rreeaaddlliinnee + treats hyphens (_-) and underscores (__) as equivalent when per- forming case-insensitive filename matching and completion. ccoommpplleettiioonn--pprreeffiixx--ddiissppllaayy--lleennggtthh ((00)) - The maximum length in characters of the common prefix of a list - of possible completions that is displayed without modification. - When set to a value greater than zero, rreeaaddlliinnee replaces common + The maximum length in characters of the common prefix of a list + of possible completions that is displayed without modification. + When set to a value greater than zero, rreeaaddlliinnee replaces common prefixes longer than this value with an ellipsis when displaying possible completions. ccoommpplleettiioonn--qquueerryy--iitteemmss ((110000)) - 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 - greater than or equal to the value of this variable, rreeaaddlliinnee - will ask whether or not the user wishes to view them; otherwise - rreeaaddlliinnee simply lists them on the terminal. A zero value means + 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 + greater than or equal to the value of this variable, rreeaaddlliinnee + will ask whether or not the user wishes to view them; otherwise + rreeaaddlliinnee simply lists them on the terminal. A zero value means rreeaaddlliinnee should never ask; negative values are treated as zero. ccoonnvveerrtt--mmeettaa ((OOnn)) - If set to OOnn, rreeaaddlliinnee will convert characters it reads that + If set to OOnn, rreeaaddlliinnee will convert characters it reads that have the eighth bit set to an ASCII key sequence by clearing the eighth bit and prefixing it with an escape character (converting - the character to have the meta prefix). The default is _O_n, but - rreeaaddlliinnee will set it to _O_f_f if the locale contains characters + the character to have the meta prefix). The default is _O_n, but + rreeaaddlliinnee will set it to _O_f_f if the locale contains characters whose encodings may include bytes with the eighth bit set. This - variable is dependent on the LLCC__CCTTYYPPEE locale category, and may - change if the locale changes. This variable also affects key + variable is dependent on the LLCC__CCTTYYPPEE locale category, and may + change if the locale changes. This variable also affects key bindings; see the description of ffoorrccee--mmeettaa--pprreeffiixx below. ddiissaabbllee--ccoommpplleettiioonn ((OOffff)) If set to OOnn, rreeaaddlliinnee will inhibit word completion. Completion - characters will be inserted into the line as if they had been + characters will be inserted into the line as if they had been mapped to sseellff--iinnsseerrtt. eecchhoo--ccoonnttrrooll--cchhaarraacctteerrss ((OOnn)) - When set to OOnn, on operating systems that indicate they support + When set to OOnn, on operating systems that indicate they support it, rreeaaddlliinnee echoes a character corresponding to a signal gener- ated from the keyboard. eeddiittiinngg--mmooddee ((eemmaaccss)) - Controls whether rreeaaddlliinnee uses a set of key bindings similar to + Controls whether rreeaaddlliinnee uses a set of key bindings similar 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 + 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 - key binding, so the standard set of meta- and control- prefixes - and backslash escape sequences is available. The \1 and \2 es- - capes begin and end sequences of non-printing characters, which - can be used to embed a terminal control sequence into the mode + key binding, so the standard set of meta- and control- prefixes + and backslash escape sequences is available. The \1 and \2 es- + capes 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)) - When this variable is set to _O_n, rreeaaddlliinnee allows certain com- + When this variable is set to _O_n, rreeaaddlliinnee allows certain com- mands to designate the region as _a_c_t_i_v_e. When the region is ac- tive, rreeaaddlliinnee 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 standout mode. The active region + of the aaccttiivvee--rreeggiioonn--ssttaarrtt--ccoolloorr, which defaults to the string + that enables the terminal's standout mode. The active region shows the text inserted by bracketed-paste and any matching text found by incremental and non-incremental history searches. eennaabbllee--bbrraacckkeetteedd--ppaassttee ((OOnn)) - When set to OOnn, rreeaaddlliinnee 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 is called _b_r_a_c_k_e_t_e_d_-_p_a_s_t_e _m_o_d_e; it prevents - rreeaaddlliinnee from executing any editing commands bound to key se- + When set to OOnn, rreeaaddlliinnee 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 is called _b_r_a_c_k_e_t_e_d_-_p_a_s_t_e _m_o_d_e; it prevents + rreeaaddlliinnee from executing any editing commands bound to key se- quences appearing in the pasted text. eennaabbllee--kkeeyyppaadd ((OOffff)) When set to OOnn, rreeaaddlliinnee will try to enable the application key- pad when it is called. Some systems need this to enable the ar- row keys. eennaabbllee--mmeettaa--kkeeyy ((OOnn)) - When set to OOnn, rreeaaddlliinnee will try to enable any meta modifier + When set to OOnn, rreeaaddlliinnee will try to enable any meta modifier key the terminal claims to support. On many terminals, the Meta - key is used to send eight-bit characters; this variable checks - for the terminal capability that indicates the terminal can en- - able and disable a mode that sets the eighth bit of a character - (0200) if the Meta key is held down when the character is typed + key is used to send eight-bit characters; this variable checks + for the terminal capability that indicates the terminal can en- + able and disable a mode that sets the eighth bit of a character + (0200) if the Meta key is held down when the character is typed (a meta character). eexxppaanndd--ttiillddee ((OOffff)) If set to OOnn, rreeaaddlliinnee performs tilde expansion when it attempts word completion. ffoorrccee--mmeettaa--pprreeffiixx ((OOffff)) - If set to OOnn, rreeaaddlliinnee modifies its behavior when binding key - sequences containing \M- or Meta- (see KKeeyy BBiinnddiinnggss above) by + If set to OOnn, rreeaaddlliinnee modifies its behavior when binding key + sequences containing \M- or Meta- (see KKeeyy BBiinnddiinnggss above) by converting a key sequence of the form \M-_C or Meta-_C to the two- - character sequence EESSCC _C (adding the meta prefix). If + character sequence EESSCC _C (adding the meta prefix). If ffoorrccee--mmeettaa--pprreeffiixx is set to OOffff (the default), rreeaaddlliinnee uses the - value of the ccoonnvveerrtt--mmeettaa variable to determine whether to per- - form this conversion: if ccoonnvveerrtt--mmeettaa is OOnn, rreeaaddlliinnee performs - the conversion described above; if it is OOffff, rreeaaddlliinnee converts + value of the ccoonnvveerrtt--mmeettaa variable to determine whether to per- + form this conversion: if ccoonnvveerrtt--mmeettaa is OOnn, rreeaaddlliinnee performs + the conversion described above; if it is OOffff, rreeaaddlliinnee converts _C to a meta character by setting the eighth bit (0200). hhiissttoorryy--pprreesseerrvvee--ppooiinntt ((OOffff)) - If set to OOnn, the history code attempts to place point at the - same location on each history line retrieved with pprreevviioouuss--hhiiss-- + If set to OOnn, the history code attempts to place point at the + same location on each history line retrieved with pprreevviioouuss--hhiiss-- 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 + 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, - the number of history entries is not limited. By default, bbaasshh - sets the the maximum number of history entries to the value of - the HHIISSTTSSIIZZEE shell variable. Setting _h_i_s_t_o_r_y_-_s_i_z_e to a non-nu- - meric value will set the maximum number of history entries to + the number of history entries is not limited. By default, bbaasshh + sets the the maximum number of history entries to the value of + the HHIISSTTSSIIZZEE shell variable. Setting _h_i_s_t_o_r_y_-_s_i_z_e to a non-nu- + meric value will set the maximum number of history entries to 500. hhoorriizzoonnttaall--ssccrroollll--mmooddee ((OOffff)) Setting this variable to OOnn makes rreeaaddlliinnee 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 + 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. iinnppuutt--mmeettaa ((OOffff)) - If set to OOnn, rreeaaddlliinnee will enable eight-bit input (that is, it - will not clear the eighth bit in the characters it reads), re- - gardless of what the terminal claims it can support. The de- - fault is _O_f_f, but rreeaaddlliinnee will set it to _O_n if the locale con- - tains characters whose encodings may include bytes with the - eighth bit set. This variable is dependent on the LLCC__CCTTYYPPEE lo- - cale category, and its value may change if the locale changes. + If set to OOnn, rreeaaddlliinnee will enable eight-bit input (that is, it + will not clear the eighth bit in the characters it reads), re- + gardless of what the terminal claims it can support. The de- + fault is _O_f_f, but rreeaaddlliinnee will set it to _O_n if the locale con- + tains characters whose encodings may include bytes with the + eighth bit set. This variable is dependent on the LLCC__CCTTYYPPEE lo- + cale category, and its value may change if the locale changes. The name mmeettaa--ffllaagg is a synonym for iinnppuutt--mmeettaa. 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- + 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- ters _E_S_C and _C_-_J will terminate an incremental search. kkeeyymmaapp ((eemmaaccss)) - Set the current rreeaaddlliinnee 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 + Set the current rreeaaddlliinnee 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 value of eeddiittiinngg--mmooddee also affects the default keymap. kkeeyysseeqq--ttiimmeeoouutt ((550000)) - Specifies the duration rreeaaddlliinnee will wait for a character when - reading an ambiguous key sequence (one that can form a complete + Specifies the duration rreeaaddlliinnee 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 rreeaaddlliinnee does not - receive any input within the timeout, it will use the shorter - but complete key sequence. The value is specified in millisec- - onds, so a value of 1000 means that rreeaaddlliinnee will wait one sec- - ond for additional input. If this variable is set to a value - less than or equal to zero, or to a non-numeric value, rreeaaddlliinnee - will wait until another key is pressed to decide which key se- + input to complete a longer key sequence). If rreeaaddlliinnee does not + receive any input within the timeout, it will use the shorter + but complete key sequence. The value is specified in millisec- + onds, so a value of 1000 means that rreeaaddlliinnee will wait one sec- + ond for additional input. If this variable is set to a value + less than or equal to zero, or to a non-numeric value, rreeaaddlliinnee + will wait until another key is pressed to decide which key se- quence to complete. mmaarrkk--ddiirreeccttoorriieess ((OOnn)) If set to OOnn, completed directory names have a slash appended. mmaarrkk--mmooddiiffiieedd--lliinneess ((OOffff)) - If set to OOnn, rreeaaddlliinnee displays history lines that have been + If set to OOnn, rreeaaddlliinnee displays history lines that have been modified with a preceding asterisk (**). mmaarrkk--ssyymmlliinnkkeedd--ddiirreeccttoorriieess ((OOffff)) If set to OOnn, completed names which are symbolic links to direc- - tories have a slash appended, subject to the value of mmaarrkk--ddii-- + tories have a slash appended, subject to the value of mmaarrkk--ddii-- rreeccttoorriieess. mmaattcchh--hhiiddddeenn--ffiilleess ((OOnn)) - This variable, when set to OOnn, forces rreeaaddlliinnee to match files - whose names begin with a "." (hidden files) when performing - filename completion. If set to OOffff, the user must include the + This variable, when set to OOnn, forces rreeaaddlliinnee to match files + whose names begin with a "." (hidden files) when performing + filename completion. If set to OOffff, the user must include the leading "." in the filename to be completed. mmeennuu--ccoommpplleettee--ddiissppllaayy--pprreeffiixx ((OOffff)) - If set to OOnn, menu completion displays the common prefix of the + If set to OOnn, menu completion displays the common prefix of the list of possible completions (which may be empty) before cycling through the list. oouuttppuutt--mmeettaa ((OOffff)) - If set to OOnn, rreeaaddlliinnee will display characters with the eighth + If set to OOnn, rreeaaddlliinnee will display characters with the eighth bit set directly rather than as a meta-prefixed escape sequence. The default is _O_f_f, but rreeaaddlliinnee will set it to _O_n if the locale - contains characters whose encodings may include bytes with the - eighth bit set. This variable is dependent on the LLCC__CCTTYYPPEE lo- + contains characters whose encodings may include bytes with the + eighth bit set. This variable is dependent on the LLCC__CCTTYYPPEE lo- cale category, and its value may change if the locale changes. ppaaggee--ccoommpplleettiioonnss ((OOnn)) - If set to OOnn, rreeaaddlliinnee uses an internal _m_o_r_e-like pager to dis- + If set to OOnn, rreeaaddlliinnee uses an internal _m_o_r_e-like pager to dis- play a screenful of possible completions at a time. pprreeffeerr--vviissiibbllee--bbeellll See bbeellll--ssttyyllee. pprriinntt--ccoommpplleettiioonnss--hhoorriizzoonnttaallllyy ((OOffff)) - If set to OOnn, rreeaaddlliinnee will display completions with matches - sorted horizontally in alphabetical order, rather than down the + If set to OOnn, rreeaaddlliinnee will display completions with matches + sorted horizontally in alphabetical order, rather than down the screen. rreevveerrtt--aallll--aatt--nneewwlliinnee ((OOffff)) - If set to OOnn, rreeaaddlliinnee will undo all changes to history lines - before returning when executing aacccceepptt--lliinnee. By default, his- - tory lines may be modified and retain individual undo lists + If set to OOnn, rreeaaddlliinnee will undo all changes to history lines + before returning when executing aacccceepptt--lliinnee. 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, rreeaaddlliinnee performs incremental and non-incremental + If set to OOnn, rreeaaddlliinnee 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. + 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 + 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 + This alters the default behavior of the completion functions in 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- + 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. + 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). 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, - rreeaaddlliinnee does not insert characters from the completion that - match characters after point in the word being completed, so + 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, + rreeaaddlliinnee 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 + 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 + 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. - The \1 and \2 escapes begin and end sequences of non-printing - characters, which can be used to embed a terminal control se- + control- prefixes and backslash escape sequences is available. + The \1 and \2 escapes begin and end sequences of non-printing + characters, which can be used to embed a terminal control se- quence into the mode string. 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 + 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 is expanded like a key binding, so the standard set of meta- and - control- prefixes and backslash escape sequences is available. - The \1 and \2 escapes begin and end sequences of non-printing - characters, which can be used to embed a terminal control se- + control- prefixes and backslash escape sequences is available. + The \1 and \2 escapes begin and end sequences of non-printing + characters, which can be used to embed a terminal control se- quence into the mode string. vviissiibbllee--ssttaattss ((OOffff)) - If set to OOnn, a character denoting a file's type as reported by - _s_t_a_t(2) is appended to the filename when listing possible com- + If set to OOnn, a character denoting a file's type as reported by + _s_t_a_t(2) is appended to the filename when listing possible com- pletions. RReeaaddlliinnee CCoonnddiittiioonnaall CCoonnssttrruuccttss - RReeaaddlliinnee 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 + RReeaaddlliinnee 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 available. - $$iiff The $$iiff construct allows bindings to be made based on the edit- - ing mode, the terminal being used, or the application using - rreeaaddlliinnee. The text of the test, after any comparison operator, + $$iiff The $$iiff construct allows bindings to be made based on the edit- + ing mode, the terminal being used, or the application using + rreeaaddlliinnee. 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 rreeaaddlliinnee 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 rreeaaddlliinnee is starting out in + mmooddee The mmooddee== form of the $$iiff directive is used to test + whether rreeaaddlliinnee 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 rreeaaddlliinnee 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 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 _x_t_e_r_m to match both _x_t_e_r_m and + minal and the portion of the terminal name before the + first --. This allows _x_t_e_r_m to match both _x_t_e_r_m and _x_t_e_r_m_-_2_5_6_c_o_l_o_r, for instance. vveerrssiioonn - The vveerrssiioonn test may be used to perform comparisons - against specific rreeaaddlliinnee versions. The vveerrssiioonn expands - to the current rreeaaddlliinnee 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 + The vveerrssiioonn test may be used to perform comparisons + against specific rreeaaddlliinnee versions. The vveerrssiioonn expands + to the current rreeaaddlliinnee 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 defaults to 00. The - operator may be separated from the string vveerrssiioonn and + If the minor version is omitted, it defaults to 00. The + operator may be separated from the string vveerrssiioonn and from the version number argument by whitespace. _a_p_p_l_i_c_a_t_i_o_n The _a_p_p_l_i_c_a_t_i_o_n construct is used to include application- - specific settings. Each program using the rreeaaddlliinnee li- - brary sets the _a_p_p_l_i_c_a_t_i_o_n _n_a_m_e, and an initialization + specific settings. Each program using the rreeaaddlliinnee 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 + 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 @@ -3989,12 +4007,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 - rreeaaddlliinnee variables and values. The permitted comparison - operators are _=, _=_=, and _!_=. The variable name must be + rreeaaddlliinnee 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. String and boolean variables - may be tested. Boolean variables must be tested against + operator may be separated from the value on the right + hand side by whitespace. String and boolean variables + may be tested. Boolean variables must be tested against the values _o_n and _o_f_f. $$eellssee Commands in this branch of the $$iiff directive are executed if the @@ -4004,67 +4022,67 @@ RREEAADDLLIINNEE command. $$iinncclluuddee - This directive takes a single filename as an argument and reads + This directive takes a single filename as an argument and reads commands and key bindings from that file. For example, the fol- lowing 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 - RReeaaddlliinnee provides commands for searching through the command history + RReeaaddlliinnee 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, rreeaadd-- + Incremental searches begin before the user has finished typing the + search string. As each character of the search string is typed, rreeaadd-- lliinnee 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. When using emacs editing - mode, type CC--rr to search backward in the history for a particular - string. Typing CC--ss searches forward through the history. The charac- - ters present in the value of the iisseeaarrcchh--tteerrmmiinnaattoorrss variable are used - to terminate an incremental search. If that variable has not been as- - signed a value, _E_S_C and _C_-_J will terminate an incremental search. _C_-_g - will abort an incremental search and restore the original line. When - the search is terminated, the history entry containing the search + so far. An incremental search requires only as many characters as + needed to find the desired history entry. When using emacs editing + mode, type CC--rr to search backward in the history for a particular + string. Typing CC--ss searches forward through the history. The charac- + ters present in the value of the iisseeaarrcchh--tteerrmmiinnaattoorrss variable are used + to terminate an incremental search. If that variable has not been as- + signed a value, _E_S_C and _C_-_J will terminate an incremental search. _C_-_g + will abort an incremental search and restore the original line. When + the search is terminated, the history entry containing the search string becomes the current line. - To find other matching entries in the history list, type CC--rr or CC--ss 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 + To find other matching entries in the history list, type CC--rr or CC--ss 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 rreeaaddlliinnee command will terminate the search and exe- - cute that command. For instance, a newline will terminate the search - and accept the line, thereby executing the command from the history + cute that command. For instance, a newline will terminate the search + and accept the line, thereby executing the command from the history list. A movement command will terminate the search, make the last line found the current line, and begin editing. RReeaaddlliinnee remembers the last incremental search string. If two CC--rrs are - typed without any intervening characters defining a new search string, + typed without any intervening characters defining a new search string, rreeaaddlliinnee uses any remembered search string. - Non-incremental searches read the entire search string before starting + Non-incremental searches read the entire search string before starting to search for matching history entries. 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 + 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 descriptions, _p_o_i_n_t refers to the current cursor posi- - tion, and _m_a_r_k refers to a cursor position saved by the sseett--mmaarrkk com- - mand. The text between the point and mark is referred to as the _r_e_- + tion, and _m_a_r_k refers to a cursor position saved by the sseett--mmaarrkk com- + mand. The text between the point and mark is referred to as the _r_e_- _g_i_o_n. RReeaaddlliinnee has the concept of an _a_c_t_i_v_e _r_e_g_i_o_n: when the region is - active, rreeaaddlliinnee redisplay uses the value of the aaccttiivvee--rree-- - ggiioonn--ssttaarrtt--ccoolloorr vvaarriiaabbllee ttoo ddeennoottee tthhee rreeggiioonn.. SSeevveerraall ccoommmmaannddss sseett + active, rreeaaddlliinnee redisplay uses the value of the aaccttiivvee--rree-- + ggiioonn--ssttaarrtt--ccoolloorr vvaarriiaabbllee ttoo ddeennoottee tthhee rreeggiioonn.. SSeevveerraall ccoommmmaannddss sseett tthhee rreeggiioonn ttoo aaccttiivvee;; tthhoossee aarree nnootteedd bbeellooww.. CCoommmmaannddss ffoorr MMoovviinngg bbeeggiinnnniinngg--ooff--lliinnee ((CC--aa)) - Move to the start of the current line. This may also be bound + Move to the start of the current line. This may also be bound to the Home key on some keyboards. eenndd--ooff--lliinnee ((CC--ee)) - Move to the end of the line. This may also be bound to the End + Move to the end of the line. This may also be bound to the End key on some keyboards. ffoorrwwaarrdd--cchhaarr ((CC--ff)) Move forward a character. @@ -4074,33 +4092,33 @@ RREEAADDLLIINNEE 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 + 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 rreeaaddlliinnee 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 rreeaaddlliinnee 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 - next physical screen line. This will not have the desired ef- + Attempt to move point to the same physical screen column on the + next physical screen line. This will not have the desired ef- fect if the current rreeaaddlliinnee line does not take up more than one - physical line or if the length of the current rreeaaddlliinnee line is + physical line or if the length of the current rreeaaddlliinnee 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. @@ -4108,46 +4126,46 @@ RREEAADDLLIINNEE 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 and HHIISSTTIIGGNNOORREE variables. If the line is a - modified history line, restore the history line to its original + is non-empty, add it to the history list according to the state + of the HHIISSTTCCOONNTTRROOLL and HHIISSTTIIGGNNOORREE variables. If the line is a + modified history line, 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 as if a newline had been - entered, and fetch the next line relative to the current line - from the history for editing. A numeric argument, if supplied, + Accept the current line for execution as if a newline had been + entered, 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 + 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. This command sets the region to the matched text and - activates the region. - ffoorrwwaarrdd--sseeaarrcchh--hhiissttoorryy ((CC--ss)) - Search forward starting at the current line and moving "down" + Search backward starting at the current line and moving "up" through the history as necessary. This is an incremental search. This command sets the region to the matched text and activates the region. + 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. This command sets the region to the matched text and + activates the region. 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. The search string may match anywhere in a history line. 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. The search string may match anywhere in a history line. hhiissttoorryy--sseeaarrcchh--bbaacckkwwaarrdd @@ -4157,72 +4175,72 @@ RREEAADDLLIINNEE non-incremental search. This may be bound to the Page Up key on some keyboards. hhiissttoorryy--sseeaarrcchh--ffoorrwwaarrdd - Search forward through the history for the string of characters + Search forward through the history for the string of characters between the start of the current line and the point. The search string must match at the beginning of a history line. This is a - non-incremental search. This may be bound to the Page Down key + non-incremental search. This may be bound to the Page Down key on some keyboards. hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--bbaacckkwwaarrdd Search backward 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- + string may match anywhere in a history line. This is a non-in- cremental search. hhiissttoorryy--ssuubbssttrriinngg--sseeaarrcchh--ffoorrwwaarrdd - Search forward through the history for the string of characters + 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- + 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 + 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, this uses the history expansion fa- - cilities to extract the _nth word, as if the "!_n" history expan- + 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, this uses the history expansion fa- + cilities to extract the _nth word, as if the "!_n" history expan- sion had been specified. yyaannkk--llaasstt--aarrgg ((MM--..,, MM--__)) - Insert the last argument to the previous command (the last word + 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 + 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). This uses the history expansion facilities - to extract the last word, as if the "!$" history expansion had + calls determines the direction to move through the history. A + negative argument switches the direction through the history + (back or forward). This uses the history expansion facilities + 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, command and process substitution, word split- - ting, and quote removal. An explicit argument suppresses com- - mand and process substitution. See HHIISSTTOORRYY EEXXPPAANNSSIIOONN below for + ing, tilde expansion, parameter and variable expansion, arith- + metic expansion, command and process substitution, word split- + ting, and quote removal. An explicit argument suppresses com- + mand and process substitution. 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 + 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 + The character indicating end-of-file as set, for example, by _s_t_t_y(1). If this character is read when there are no characters on the line, and point is at the beginning of the line, rreeaaddlliinnee interprets it as the end of input and returns EEOOFF. @@ -4232,173 +4250,173 @@ RREEAADDLLIINNEE above for the effects. This may also be bound to the Delete key on some keyboards. bbaacckkwwaarrdd--ddeelleettee--cchhaarr ((RRuubboouutt)) - Delete the character behind the cursor. When given a numeric + 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. bbrraacckkeetteedd--ppaassttee--bbeeggiinn - This function is intended to be bound to the "bracketed paste" - escape sequence sent by some terminals, and such a binding is - assigned by default. It allows rreeaaddlliinnee to insert the pasted - text as a single unit without treating each character as if it - had been read from the keyboard. The pasted characters are in- - serted as if each one was bound to sseellff--iinnsseerrtt instead of exe- + This function is intended to be bound to the "bracketed paste" + escape sequence sent by some terminals, and such a binding is + assigned by default. It allows rreeaaddlliinnee to insert the pasted + text as a single unit without treating each character as if it + had been read from the keyboard. The pasted characters are in- + serted as if each one was bound to sseellff--iinnsseerrtt instead of exe- cuting any editing commands. - Bracketed paste sets the region to the inserted text and acti- + Bracketed paste sets the region to the inserted text and acti- vates the region. 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. sshheellll--ttrraannssppoossee--wwoorrddss ((MM--CC--tt)) - Drag the word before point past the word after point, moving - point past that word as well. If the insertion point is at the + Drag the word before point past the word after point, moving + point past that word as well. If the insertion point is at the end of the line, this transposes the last two words on the line. - Word boundaries are the same as sshheellll--ffoorrwwaarrdd--wwoorrdd and + Word boundaries are the same as sshheellll--ffoorrwwaarrdd--wwoorrdd and sshheellll--bbaacckkwwaarrdd--wwoorrdd. uuppccaassee--wwoorrdd ((MM--uu)) - Uppercase the current (or following) word. With a negative ar- + 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 ar- + 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- gument, capitalize the previous word, but do not move point. oovveerrwwrriittee--mmooddee - Toggle overwrite mode. With an explicit positive numeric argu- + 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 + 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, characters bound to sseellff--iinnsseerrtt replace the - text at point rather than pushing the text to the right. Char- - acters bound to bbaacckkwwaarrdd--ddeelleettee--cchhaarr replace the character be- - fore point with a space. By default, this command is unbound, + In overwrite mode, characters bound to sseellff--iinnsseerrtt replace the + text at point rather than pushing the text to the right. Char- + acters bound to bbaacckkwwaarrdd--ddeelleettee--cchhaarr replace the character be- + fore point with a space. By default, this command is unbound, but may be bound to the Insert key on some keyboards. KKiilllliinngg aanndd YYaannkkiinngg kkiillll--lliinnee ((CC--kk)) Kill the text from point to the end of the current line. With a - negative numeric argument, kill backward from the cursor to the + negative numeric argument, kill backward from the cursor to the beginning of the line. bbaacckkwwaarrdd--kkiillll--lliinnee ((CC--xx RRuubboouutt)) Kill backward to the beginning of the current line. With a neg- - ative numeric argument, kill forward from the cursor to the end + ative numeric argument, kill forward from the cursor to the end of the line. uunniixx--lliinnee--ddiissccaarrdd ((CC--uu)) - Kill backward from point to the beginning of the line, saving + Kill backward from point to the beginning of the line, saving the killed text 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 + 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 ((MM--CC--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 + 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- + Kill the word behind point, using white space as a word bound- ary, saving the killed text on the kill-ring. uunniixx--ffiilleennaammee--rruubboouutt - Kill the word behind point, using white space and the slash - character as the word boundaries, saving the killed text on the + Kill the word behind point, using white space and the slash + character as the word boundaries, saving the killed text on the kill-ring. ddeelleettee--hhoorriizzoonnttaall--ssppaaccee ((MM--\\)) Delete all spaces and tabs around point. kkiillll--rreeggiioonn Kill the text in the current region. ccooppyy--rreeggiioonn--aass--kkiillll - Copy the text in the region to the kill buffer, so it can be + Copy the text in the region to the kill buffer, so it can be yanked immediately. 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 follow- + 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 + 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 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 - attempts completion by first checking for any programmable com- - pletions for the command word (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn be- + Attempt to perform completion on the text before point. BBaasshh + attempts completion by first checking for any programmable com- + pletions for the command word (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn be- low), otherwise treating the text as a variable (if the text be- gins with $$), username (if the text begins with ~~), hostname (if - the text begins with @@), or command (including aliases, func- - tions, and builtins) in turn. If none of these produces a + the text begins with @@), or command (including aliases, func- + tions, and builtins) in turn. If none of these produces a match, it falls back to filename completion. ppoossssiibbllee--ccoommpplleettiioonnss ((MM--??)) - List the possible completions of the text before point. When + List the possible completions of the text before point. When displaying completions, rreeaaddlliinnee sets the number of columns used - for display to the value of ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh, the value - of the shell variable CCOOLLUUMMNNSS, or the screen width, in that or- + for display to the value of ccoommpplleettiioonn--ddiissppllaayy--wwiiddtthh, the value + of the shell variable CCOOLLUUMMNNSS, or the screen width, in that or- der. 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, separated by a space. mmeennuu--ccoommpplleettee - Similar to ccoommpplleettee, but replaces the word to be completed with - a single match from the list of possible completions. Repeat- - edly executing mmeennuu--ccoommpplleettee steps through the list of possible - completions, inserting each match in turn. At the end of the - list of completions, mmeennuu--ccoommpplleettee rings the bell (subject to - the setting of bbeellll--ssttyyllee) and restores the original text. An - argument of _n moves _n positions forward in the list of matches; - a negative argument moves backward through the list. This com- + Similar to ccoommpplleettee, but replaces the word to be completed with + a single match from the list of possible completions. Repeat- + edly executing mmeennuu--ccoommpplleettee steps through the list of possible + completions, inserting each match in turn. At the end of the + list of completions, mmeennuu--ccoommpplleettee rings the bell (subject to + the setting of bbeellll--ssttyyllee) and restores the original text. An + argument of _n moves _n positions forward in the list of matches; + a negative argument moves 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 + 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). At the end of the line, + Deletes the character under the cursor if not at the beginning + or end of the line (like ddeelleettee--cchhaarr). At the end of the line, it behaves identically to ppoossssiibbllee--ccoommpplleettiioonnss. This command is unbound by default. ccoommpplleettee--ffiilleennaammee ((MM--//)) @@ -4407,66 +4425,66 @@ 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 + Attempt completion on the text before point, comparing the text against history list entries 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)) @@ -4474,210 +4492,210 @@ RREEAADDLLIINNEE 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, set the mark to that position. eexxcchhaannggee--ppooiinntt--aanndd--mmaarrkk ((CC--xx CC--xx)) - Swap the point with the mark. Set the current cursor position + Swap the point with the mark. Set the current cursor position to the saved position, then set the mark to the old cursor posi- tion. cchhaarraacctteerr--sseeaarrcchh ((CC--]])) - Read a character and move point to the next occurrence of that - character. A negative argument searches for previous occur- + Read a character and move point to the next occurrence of that + character. A negative argument searches for previous occur- rences. cchhaarraacctteerr--sseeaarrcchh--bbaacckkwwaarrdd ((MM--CC--]])) - Read a character and move point to the previous occurrence of + Read a character and move point to the previous occurrence of that character. A negative argument searches for subsequent oc- currences. sskkiipp--ccssii--sseeqquueennccee - Read enough characters to consume a multi-key sequence such as - those defined for keys like Home and End. CSI sequences begin + Read enough characters to consume a multi-key sequence such as + those defined for keys like Home and End. CSI sequences begin with a Control Sequence Indicator (CSI), usually ESC-[. If this - sequence is bound to "\e[", keys producing CSI sequences will - have no effect unless explicitly bound to a rreeaaddlliinnee command, - instead of inserting stray characters into the editing buffer. + sequence is bound to "\e[", keys producing CSI sequences will + have no effect unless explicitly bound to a rreeaaddlliinnee 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, insert the value of the rreeaaddlliinnee + Without a numeric argument, insert the value of the rreeaaddlliinnee ccoommmmeenntt--bbeeggiinn variable 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, insert the value; otherwise delete the - characters in ccoommmmeenntt--bbeeggiinn from the beginning 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 + 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, insert the value; otherwise delete the + characters in ccoommmmeenntt--bbeeggiinn from the beginning 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 ex- ecuted 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 + 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)) Treat the word before point as a pattern for pathname expansion, - with an asterisk implicitly appended, then use the pattern to + with an asterisk implicitly appended, then use the pattern to generate a list of matching file names for possible completions. gglloobb--eexxppaanndd--wwoorrdd ((CC--xx **)) Treat the word before point as a pattern for pathname expansion, - and insert the list of matching file names, replacing the word. - If a numeric argument is supplied, append a ** before pathname + and insert the list of matching file names, replacing the word. + If a numeric argument is supplied, append a ** before pathname expansion. gglloobb--lliisstt--eexxppaannssiioonnss ((CC--xx gg)) Display the list of expansions that would have been generated by - gglloobb--eexxppaanndd--wwoorrdd and redisplay the line. If a numeric argument + gglloobb--eexxppaanndd--wwoorrdd and redisplay the line. If a numeric argument is supplied, append a ** before pathname expansion. dduummpp--ffuunnccttiioonnss - Print all of the functions and their key bindings to the rreeaadd-- + Print all of the functions and their key bindings to the rreeaadd-- lliinnee 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 + 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 rreeaaddlliinnee variables and their values to - the rreeaaddlliinnee output stream. If a numeric argument is supplied, - the output is formatted in such a way that it can be made part + the rreeaaddlliinnee 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 rreeaaddlliinnee key sequences bound to macros and the + Print all of the rreeaaddlliinnee key sequences bound to macros and the strings they output to the rreeaaddlliinnee 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. eexxeeccuuttee--nnaammeedd--ccoommmmaanndd ((MM--xx)) Read a bindable rreeaaddlliinnee command name from the input and execute - the function to which it's bound, as if the key sequence to - which it was bound appeared in the input. If this function is + the function to which it's bound, as if the key sequence to + which it was bound appeared in the input. If this function is supplied with a numeric argument, it passes that argument to the function it executes. ddiissppllaayy--sshheellll--vveerrssiioonn ((CC--xx CC--vv)) Display version information about the current instance of bbaasshh. PPrrooggrraammmmaabbllee CCoommpplleettiioonn - When a user attempts word completion 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), rreeaaddlliinnee in- + When a user attempts word completion 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), rreeaaddlliinnee in- vokes the programmable completion facilities. - First, bbaasshh identifies the command name. If a compspec has been de- - fined for that command, the compspec is used to generate the list of - possible completions for the word. If the command word is the empty - string (completion attempted at the beginning of an empty line), bbaasshh - uses any compspec defined with the --EE option to ccoommpplleettee. If the com- + First, bbaasshh identifies the command name. If a compspec has been de- + fined for that command, the compspec is used to generate the list of + possible completions for the word. If the command word is the empty + string (completion attempted at the beginning of an empty line), bbaasshh + uses any compspec defined with the --EE option to ccoommpplleettee. If the com- mand word is a full pathname, bbaasshh searches for a compspec for the full - pathname first. If there is no compspec for the full pathname, bbaasshh - attempts 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 + pathname first. If there is no compspec for the full pathname, bbaasshh + attempts 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. If a compspec is not found, bbaasshh performs its default completion as de- - scribed above under CCoommpplleettiinngg. Otherwise, once a compspec has been + scribed above under CCoommpplleettiinngg. Otherwise, once a compspec has been found, bbaasshh uses it to generate the list of matching words. - First, bbaasshh performs the _a_c_t_i_o_n_s specified by the compspec. Only - matches which are prefixed by the word being completed are returned. + First, bbaasshh performs the _a_c_t_i_o_n_s specified by the compspec. 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 comple- tion, bbaasshh uses the shell variable FFIIGGNNOORREE 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 + tion are generated next. The words generated by the pattern need not match the word being completed. BBaasshh uses the FFIIGGNNOORREE variable to fil- ter the matches, but does not use the GGLLOOBBIIGGNNOORREE shell variable. - Next, completion considers the string specified as the argument to the - --WW option. The string is first split using the characters in the IIFFSS - special 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 + Next, completion considers the string specified as the argument to the + --WW option. The string is first split using the characters in the IIFFSS + special 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 possible completions. - After these matches have been generated, bbaasshh executes any shell func- + After these matches have been generated, bbaasshh executes any shell func- tion or command specified with the --FF and --CC options. 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 + 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 in- - voked, the first argument ($$11) is the name of the command whose argu- - ments 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 current command line. There is no filtering of - the generated completions against the word being completed; the func- + voked, the first argument ($$11) is the name of the command whose argu- + ments 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 current command line. There is no filtering of + the generated completions against the word being completed; the func- tion or command has complete freedom in generating the matches. - Any function specified with --FF is invoked first. The function may use + Any function specified with --FF is invoked first. The function may use any of the shell facilities, including the ccoommppggeenn and ccoommppoopptt builtins - described below, to generate the matches. It must put the possible + 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 - used to escape a newline, if necessary. These are added to the set of + 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. These are added to the set of possible completions. - 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. + 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- + 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 rreeaaddlliinnee 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, bbaasshh attempts directory name completion. - If the --oo pplluussddiirrss option was supplied to ccoommpplleettee when the compspec - was defined, bbaasshh attempts directory name completion and adds any + If the --oo pplluussddiirrss option was supplied to ccoommpplleettee when the compspec + was defined, bbaasshh attempts directory name completion and adds any matches to the set of possible completions. - 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 and the rreeaaddlliinnee default of filename comple- - tion are disabled. If the --oo bbaasshhddeeffaauulltt option was supplied to ccoomm-- - pplleettee when the compspec was defined, if the compspec generates no - matches, bbaasshh attempts its default completions. If the --oo ddeeffaauulltt op- + 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 and the rreeaaddlliinnee default of filename comple- + tion are disabled. If the --oo bbaasshhddeeffaauulltt option was supplied to ccoomm-- + pplleettee when the compspec was defined, if the compspec generates no + matches, bbaasshh attempts its default completions. If the --oo ddeeffaauulltt op- tion was supplied to ccoommpplleettee when the compspec was defined, programma- - ble completion will perform rreeaaddlliinnee's default completion if the comp- - spec (and, if attempted, the default bbaasshh completions) generate no + ble completion will perform rreeaaddlliinnee's default completion if the comp- + spec (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 rreeaaddlliinnee to append a slash - to completed names which are symbolic links to directories, subject to - the value of the mmaarrkk--ddiirreeccttoorriieess rreeaaddlliinnee variable, regardless of the + When a compspec indicates that directory name completion is desired, + the programmable completion functions force rreeaaddlliinnee to append a slash + to completed names which are symbolic links to directories, subject to + the value of the mmaarrkk--ddiirreeccttoorriieess rreeaaddlliinnee variable, regardless of the setting of the mmaarrkk--ssyymmlliinnkkeedd--ddiirreeccttoorriieess rreeaaddlliinnee 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 functions 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 functions 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() { @@ -4688,162 +4706,162 @@ RREEAADDLLIINNEE -o bashdefault -o default 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 - commands to save in a history list: the shell saves the text of the + typed. The value of the HHIISSTTSSIIZZEE variable is used as the number of + commands to save in a history list: the shell saves the text of the last HHIISSTTSSIIZZEE commands (default 500). The shell stores each command in - the history list prior to parameter and variable expansion (see EEXXPPAANN-- - SSIIOONN above) but after history expansion is performed, subject to the + the history list prior to parameter and variable expansion (see EEXXPPAANN-- + SSIIOONN above) but after history expansion is performed, subject to the values of the shell variables HHIISSTTIIGGNNOORREE and HHIISSTTCCOONNTTRROOLL. - On startup, bbaasshh initializes the history list by reading history en- - tries from the the file named by the HHIISSTTFFIILLEE variable (default - _~_/_._b_a_s_h___h_i_s_t_o_r_y). That file is referred to as the _h_i_s_t_o_r_y _f_i_l_e. The - history file is truncated, if necessary, to contain no more than the - number of history entries specified by the value of the HHIISSTTFFIILLEESSIIZZEE - variable. If HHIISSTTFFIILLEESSIIZZEE is unset, or set to null, a non-numeric + On startup, bbaasshh initializes the history list by reading history en- + tries from the the file named by the HHIISSTTFFIILLEE variable (default + _~_/_._b_a_s_h___h_i_s_t_o_r_y). That file is referred to as the _h_i_s_t_o_r_y _f_i_l_e. The + history file is truncated, if necessary, to contain no more than the + number of history entries specified by the value of the HHIISSTTFFIILLEESSIIZZEE + variable. If HHIISSTTFFIILLEESSIIZZEE is unset, or set to null, a non-numeric value, or a numeric value less than zero, the history file is not trun- cated. 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 dis- - played depending on the value of the HHIISSTTTTIIMMEEFFOORRMMAATT variable. When - present, history timestamps delimit history entries, making multi-line + for the following history line. These timestamps are optionally dis- + played depending on the value of the HHIISSTTTTIIMMEEFFOORRMMAATT variable. When + present, history timestamps delimit history entries, making multi-line entries possible. When a shell with history enabled exits, bbaasshh copies the last $$HHIISSTTSSIIZZEE - entries from the history list to $$HHIISSTTFFIILLEE. If the hhiissttaappppeenndd shell - option is enabled (see the description of sshhoopptt under SSHHEELLLL BBUUIILLTTIINN - CCOOMMMMAANNDDSS below), bbaasshh appends the entries to the history file, other- - wise it overwrites the history file. If HHIISSTTFFIILLEE is unset or null, or - if the history file is unwritable, the history is not saved. After - saving the history, bbaasshh truncates the history file to contain no more + entries from the history list to $$HHIISSTTFFIILLEE. If the hhiissttaappppeenndd shell + option is enabled (see the description of sshhoopptt under SSHHEELLLL BBUUIILLTTIINN + CCOOMMMMAANNDDSS below), bbaasshh appends the entries to the history file, other- + wise it overwrites the history file. If HHIISSTTFFIILLEE is unset or null, or + if the history file is unwritable, the history is not saved. After + saving the history, bbaasshh truncates the history file to contain no more than HHIISSTTFFIILLEESSIIZZEE lines as described above. - If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, the shell writes the timestamp - information associated with each history entry to the history file, - marked with the history comment character, so timestamps are preserved + If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, the shell writes the timestamp + information associated with each history entry to the history file, + marked with the history comment character, so timestamps are preserved across shell sessions. This uses the history comment character to dis- - tinguish timestamps from other history lines. As above, when using + tinguish timestamps from other history lines. As above, when using HHIISSTTTTIIMMEEFFOORRMMAATT, the timestamps delimit multi-line history entries. - The ffcc builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) will list or + The ffcc builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below) will list or edit and re-execute a portion of the history list. The hhiissttoorryy builtin can display or modify the history list and manipulate the history file. - When using command-line editing, search commands are available in each + 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 + The shell allows control over which commands are saved on the history list. The HHIISSTTCCOONNTTRROOLL and HHIISSTTIIGGNNOORREE variables are used to save only a - subset of the commands entered. If the ccmmddhhiisstt shell option is en- - abled, the shell attempts 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 modifies ccmmddhhiisstt by - saving the command with embedded newlines instead of semicolons. See + subset of the commands entered. If the ccmmddhhiisstt shell option is en- + abled, the shell attempts 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 modifies ccmmddhhiisstt by + saving 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 options. HHIISSTTOORRYY EEXXPPAANNSSIIOONN - The shell supports a history expansion feature that is similar to the - history expansion in ccsshh. This section describes what syntax features + The shell supports a history expansion feature that is similar to the + history expansion in ccsshh. This section describes what syntax features are available. History expansion is enabled by default for interactive shells, and can - be disabled using the ++HH option to the sseett builtin command (see SSHHEELLLL + be disabled using the ++HH option to the sseett builtin command (see SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS below). Non-interactive shells do not perform history expansion by default, but it can be enabled with "set -H". 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. The shell attempts to inform the history expansion + 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. The shell attempts to inform the history expansion functions about quoting still in effect from previous lines. - It takes place in two parts. The first is to determine which history - list entry to use during substitution. The second is to select por- + It takes place in two parts. The first is to determine which history + list entry to use during substitution. The second is to select por- tions of that entry to include into the current one. - The entry selected from the history is the _e_v_e_n_t, and the portions of + The entry selected from the history is the _e_v_e_n_t, and the portions of that entry that are acted upon are _w_o_r_d_s. Various _m_o_d_i_f_i_e_r_s are avail- - able to manipulate the selected words. The entry is split 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. The entry is split 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 ap- + 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. There is a special abbreviation for substitution, active when the _q_u_i_c_k - _s_u_b_s_t_i_t_u_t_i_o_n character (described above under hhiissttcchhaarrss) is the first + _s_u_b_s_t_i_t_u_t_i_o_n character (described above under hhiissttcchhaarrss) is the first character on the line. It selects the previous history list entry, us- - ing an event designator equivalent to !!!!, and substitutes one string - for another in that entry. It is described below under EEvveenntt DDeessiiggnnaa-- - ttoorrss. This is the only history expansion that does not begin with the + ing an event designator equivalent to !!!!, and substitutes one string + for another in that entry. It is described below under EEvveenntt DDeessiiggnnaa-- + ttoorrss. This is the only history expansion that does not begin with the history expansion character. - Several shell options settable with the sshhoopptt builtin will modify his- - tory expansion behavior (see the description of the sshhoopptt builtin be- + Several shell options settable with the sshhoopptt builtin will modify his- + tory expansion behavior (see the description of the sshhoopptt builtin be- low).and If the hhiissttvveerriiffyy shell option is enabled, and rreeaaddlliinnee is be- ing used, history substitutions are not immediately passed to the shell parser. Instead, the expanded line is reloaded into the rreeaaddlliinnee edit- - ing buffer for further modification. If rreeaaddlliinnee is being used, and - the hhiissttrreeeeddiitt shell option is enabled, a failed history substitution + ing buffer for further modification. If rreeaaddlliinnee is being used, and + the hhiissttrreeeeddiitt shell option is enabled, a failed history substitution is reloaded into the rreeaaddlliinnee editing buffer for correction. - The --pp option to the hhiissttoorryy builtin command shows what a history ex- - pansion will do before using it. The --ss option to the hhiissttoorryy builtin - will add commands to the end of the history list without actually exe- + The --pp option to the hhiissttoorryy builtin command shows what a history ex- + pansion will do before using it. The --ss option to the hhiissttoorryy builtin + will add commands to the end of the history list without actually exe- cuting 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 an entry in the history list. + An event designator is a reference to an entry in the history 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, + 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 history list entry _n. !!--_n Refer to the current entry minus _n. !!!! Refer to the previous entry. 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, this uses the string from the most recent + 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, this uses the string from the most recent search; 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. @@ -4851,37 +4869,37 @@ HHIISSTTOORRYY EEXXPPAANNSSIIOONN Word designators are used to select desired words from the event. They are optional; if the word designator isn't supplied, the history expan- sion uses the entire 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 in- + 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 in- serted into the current line separated by single spaces. 00 ((zzeerroo)) The zeroth word. For the shell, this is the command word. _n The _nth word. ^^ The first argument: word 1. - $$ The last word. This is usually the last argument, but will ex- + $$ 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 - word. By default, searches begin at the end of each line and - proceed to the beginning, so the first word matched is the one + the search string begins with a character that is part of a + word. By default, searches begin at the end of each line and + proceed to the beginning, so the first word matched is the one closest to the end of the line. _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 + ** 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; it expands to the empty string in that case. xx** Abbreviates _x_-_$. 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, equivalent to !!!!. MMooddiiffiieerrss - After the optional word designator, the expansion may include a se- - quence of one or more of the following modifiers, each preceded by a - ":". These modify, or edit, the word or words selected from the his- + After the optional word designator, the expansion may include a se- + quence of one or more of the following modifiers, each preceded by a + ":". These modify, or edit, the word or words selected from the his- tory event. hh Remove a trailing pathname component, leaving only the head. @@ -4890,24 +4908,24 @@ 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; expansion uses the last one supplied. 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. A single backslash will quote the delimiter in - _o_l_d and _n_e_w. If & appears in _n_e_w, it is replaced with _o_l_d. A + The final delimiter is optional if it is the last character of + the event line. A single backslash will quote the delimiter in + _o_l_d and _n_e_w. If & appears in _n_e_w, it is replaced with _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 substitu- - tions took place, the last _s_t_r_i_n_g in a !!??_s_t_r_i_n_g[[??]] search. If + the last _o_l_d substituted, or, if no previous history substitu- + tions 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 + 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. @@ -4916,64 +4934,64 @@ 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 + 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. .. [--pp _p_a_t_h] _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] ssoouurrccee [--pp _p_a_t_h] _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] - The .. command (ssoouurrccee) reads and execute commands from _f_i_l_e_n_a_m_e - in the current shell environment and returns the exit status of + The .. command (ssoouurrccee) reads and execute commands from _f_i_l_e_n_a_m_e + in the current shell environment and returns the exit status of the last command executed from _f_i_l_e_n_a_m_e. If _f_i_l_e_n_a_m_e does not contain a slash, .. searches for it. If the - --pp option is supplied, .. treats _p_a_t_h as a colon-separated list - of directories in which to find _f_i_l_e_n_a_m_e; otherwise, .. uses the - entries in PPAATTHH to find the directory containing _f_i_l_e_n_a_m_e. - _f_i_l_e_n_a_m_e does not need to be executable. When bbaasshh is not in + --pp option is supplied, .. treats _p_a_t_h as a colon-separated list + of directories in which to find _f_i_l_e_n_a_m_e; otherwise, .. uses the + entries in PPAATTHH to find the directory containing _f_i_l_e_n_a_m_e. + _f_i_l_e_n_a_m_e does not need to be executable. When bbaasshh is not in posix mode, it searches the current directory if _f_i_l_e_n_a_m_e is not - found in PPAATTHH, but does not search the current directory if --pp + found in PPAATTHH, but does not search the current directory if --pp is supplied. If the ssoouurrcceeppaatthh option to the sshhoopptt builtin com- mand is turned off, .. does not search PPAATTHH. - If any _a_r_g_u_m_e_n_t_s are supplied, they become the positional para- - meters when _f_i_l_e_n_a_m_e is executed. Otherwise the positional pa- + If any _a_r_g_u_m_e_n_t_s are supplied, they become the positional para- + meters when _f_i_l_e_n_a_m_e is executed. Otherwise the positional pa- rameters 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 + is not, any DDEEBBUUGG trap string is saved and restored around the call to .., and .. unsets the DDEEBBUUGG trap while it executes. If --TT is not set, and the sourced file changes the DDEEBBUUGG trap, the new value persists after .. completes. The return status is the sta- tus of the last command executed from _f_i_l_e_n_a_m_e (0 if no commands - are executed), and non-zero if _f_i_l_e_n_a_m_e is not found or cannot + are executed), and non-zero 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] ...] - With no arguments or with the --pp option, aalliiaass prints the list - of aliases in the form aalliiaass _n_a_m_e=_v_a_l_u_e on standard output. + With no arguments or with the --pp option, aalliiaass 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, define an alias 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 - during command parsing. For each _n_a_m_e in the argument list for - which no _v_a_l_u_e is supplied, print the name and value of the - alias _n_a_m_e. aalliiaass returns true unless a _n_a_m_e is given (without + _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 + during command parsing. For each _n_a_m_e in the argument list for + which no _v_a_l_u_e is supplied, print the name and value of the + alias _n_a_m_e. aalliiaass returns true unless a _n_a_m_e is given (without a corresponding =_v_a_l_u_e) 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 + 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 uses its notion of the _c_u_r_r_e_n_t _j_o_b. 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 + 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] [--llssvvSSVVXX] @@ -4984,191 +5002,191 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS bbiinndd [--mm _k_e_y_m_a_p] --pp|--PP [_r_e_a_d_l_i_n_e_-_c_o_m_m_a_n_d] 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 to a shell command, - or set a rreeaaddlliinnee variable. Each non-option argument is a key - binding or command as it would appear in a rreeaaddlliinnee initializa- - tion 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'. In the following descriptions, output - available to be re-read is formatted as commands that would ap- + Display current rreeaaddlliinnee key and function bindings, bind a key + sequence to a rreeaaddlliinnee function or macro or to a shell command, + or set a rreeaaddlliinnee variable. Each non-option argument is a key + binding or command as it would appear in a rreeaaddlliinnee initializa- + tion 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'. In the following descriptions, output + available to be re-read is formatted as commands that would ap- pear in a rreeaaddlliinnee initialization file or that would be supplied - as individual arguments to a bbiinndd command. Options, if sup- + as individual arguments to a bbiinndd command. Options, if sup- plied, 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_, _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 used as an argument to a subsequent - bbiinndd command or in a rreeaaddlliinnee initialization file. If - arguments remain after option processing, bbiinndd treats - them as rreeaaddlliinnee command names and restricts output to - those names. - --PP List current rreeaaddlliinnee function names and bindings. If + --pp Display rreeaaddlliinnee function names and bindings in such a + way that they can be used as an argument to a subsequent + bbiinndd command or in a rreeaaddlliinnee initialization file. If arguments remain after option processing, bbiinndd treats them as rreeaaddlliinnee command names and restricts output to those names. - --ss Display rreeaaddlliinnee key sequences bound to macros and the - strings they output in such a way that they can be used + --PP List current rreeaaddlliinnee function names and bindings. If + arguments remain after option processing, bbiinndd treats + them as rreeaaddlliinnee command names and restricts output to + those names. + --ss Display rreeaaddlliinnee key sequences bound to macros and the + strings they output in such a way that they can be used as an argument to a subsequent bbiinndd command or in a rreeaadd-- lliinnee initialization file. - --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 used as an argument to a subsequent bbiinndd command or in a rreeaaddlliinnee initialization file. --VV List current rreeaaddlliinnee variable names and values. --ff _f_i_l_e_n_a_m_e Read key bindings from _f_i_l_e_n_a_m_e. --qq _f_u_n_c_t_i_o_n - Display key sequences that invoke the named rreeaaddlliinnee + Display key sequences that invoke the named rreeaaddlliinnee _f_u_n_c_t_i_o_n. --uu _f_u_n_c_t_i_o_n - Unbind all key sequences bound to the named rreeaaddlliinnee + Unbind all key sequences bound to the named rreeaaddlliinnee _f_u_n_c_t_i_o_n. --rr _k_e_y_s_e_q Remove any current binding for _k_e_y_s_e_q. --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 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 single quotes. When - _s_h_e_l_l_-_c_o_m_m_a_n_d is executed, the shell sets the RREEAADD-- - LLIINNEE__LLIINNEE variable to the contents of the rreeaaddlliinnee line + 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 single quotes. When + _s_h_e_l_l_-_c_o_m_m_a_n_d is executed, the shell sets the RREEAADD-- + LLIINNEE__LLIINNEE variable 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__AARRGGUUMMEENNTT variable. If there was no argu- - ment, that variable is not set. If the executed command - changes the value of any of RREEAADDLLIINNEE__LLIINNEE, RREEAADD-- - LLIINNEE__PPOOIINNTT, or RREEAADDLLIINNEE__MMAARRKK, those new values will be + 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__AARRGGUUMMEENNTT variable. If there was no argu- + ment, that variable is not set. If the executed command + changes the value of any of RREEAADDLLIINNEE__LLIINNEE, RREEAADD-- + LLIINNEE__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 an + --XX List all key sequences bound to shell commands and the + associated commands in a format that can be reused as an argument to a subsequent bbiinndd command. - The return value is 0 unless an unrecognized option is supplied + The return value is 0 unless an unrecognized option is supplied or an error occurred. bbrreeaakk [_n] - Exit from within a ffoorr, wwhhiillee, uunnttiill, or sseelleecctt loop. If _n is + Exit from within a ffoorr, wwhhiillee, uunnttiill, or sseelleecctt loop. If _n is specified, bbrreeaakk exits _n enclosing loops. _n must be >= 1. If _n - is greater than the number of enclosing loops, all enclosing + 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. 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 _s_h_e_l_l_-_b_u_i_l_t_i_n, 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 functionality of the builtin within the function. - The ccdd builtin is commonly redefined this way. The return sta- + Execute the specified shell builtin _s_h_e_l_l_-_b_u_i_l_t_i_n, 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 functionality of the builtin within the function. + The ccdd builtin is commonly redefined this way. The return sta- tus 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). - Without _e_x_p_r, ccaalllleerr displays the line number and source file- - name of the current subroutine call. If a non-negative integer + Without _e_x_p_r, ccaalllleerr displays the line number and source file- + name of the current subroutine call. If a non-negative integer is supplied as _e_x_p_r, ccaalllleerr displays the line number, subroutine name, and source file corresponding to that position in the cur- - rent execution call stack. This extra information may be used, + rent 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 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] [-@] [_d_i_r] ccdd --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 used as _d_i_r. The vari- - able CCDDPPAATTHH exists, and _d_i_r does not begin with a slash (/), ccdd + Change the current directory to _d_i_r. if _d_i_r is not supplied, + the value of the HHOOMMEE shell variable is used as _d_i_r. The vari- + able CCDDPPAATTHH exists, and _d_i_r does not begin with a slash (/), ccdd uses it as a search path: the shell searches each directory name - in CCDDPPAATTHH for _d_i_r. Alternative directory names in CCDDPPAATTHH are - separated by a colon (:). A null directory name in CCDDPPAATTHH is + in CCDDPPAATTHH 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., ".". - The --PP option causes ccdd to use the physical directory structure + The --PP option causes ccdd to use the physical directory structure by resolving symbolic links while traversing _d_i_r and before pro- - cessing instances of _._. in _d_i_r (see also the --PP option to the + cessing instances of _._. in _d_i_r (see also the --PP option to the sseett builtin command). - The --LL option forces ccdd to follow symbolic links by resolving + The --LL option forces ccdd to follow symbolic links by resolving the link after processing instances of _._. in _d_i_r. If _._. appears - in _d_i_r, ccdd processes it by removing the immediately previous + in _d_i_r, ccdd processes it by removing the immediately previous pathname component from _d_i_r, back to a slash or the beginning of - _d_i_r, and verifying that the portion of _d_i_r it has processed to - that point is still a valid directory name after removing the + _d_i_r, and verifying that the portion of _d_i_r it has processed to + that point is still a valid directory name after removing the pathname component. If it is not a valid directory name, ccdd re- - turns a non-zero status. If neither --LL nor --PP is supplied, ccdd + turns a non-zero status. If neither --LL nor --PP is supplied, ccdd behaves as if --LL had been supplied. If the --ee option is supplied with --PP, and ccdd cannot successfully - determine the current working directory after a successful di- + determine the current working directory after a successful di- rectory change, it will return a non-zero status. - On systems that support it, the --@@ option presents the extended + On systems that support it, the --@@ option presents the extended attributes associated with a file as a directory. - An argument of -- is converted to $$OOLLDDPPWWDD before attempting the + An argument of -- is converted to $$OOLLDDPPWWDD before attempting the directory change. - If ccdd uses a non-empty directory name from CCDDPPAATTHH,, or if -- is - the first argument, and the directory change is successful, ccdd + If ccdd uses a non-empty directory name from CCDDPPAATTHH,, or if -- is + the first argument, and the directory change is successful, ccdd writes the absolute pathname of the new working directory to the standard output. - If the directory change is successful, ccdd sets the value of the + 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 + OOLLDDPPWWDD environment variable to the value of the current working directory before the change. - The return value is true if the directory was successfully + 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 ...] - The ccoommmmaanndd builtin runs _c_o_m_m_a_n_d with _a_r_g_s suppressing the nor- + The ccoommmmaanndd builtin runs _c_o_m_m_a_n_d with _a_r_g_s suppressing the nor- mal shell function lookup for _c_o_m_m_a_n_d. Only builtin commands or - commands found in the PPAATTHH named _c_o_m_m_a_n_d are executed. If the + commands found in the PPAATTHH named _c_o_m_m_a_n_d are executed. If the --pp option is supplied, 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 + a default value for PPAATTHH that is guaranteed to find all of the standard utilities. - If either the --VV or --vv option is supplied, ccoommmmaanndd prints a de- - scription of _c_o_m_m_a_n_d. The --vv option displays a single word in- - dicating the command or filename used to invoke _c_o_m_m_a_n_d; the --VV + If either the --VV or --vv option is supplied, ccoommmmaanndd prints a de- + scription of _c_o_m_m_a_n_d. The --vv option displays a single word in- + dicating the command or filename used to invoke _c_o_m_m_a_n_d; the --VV option produces a more verbose description. - If the --VV or --vv option is supplied, the exit status is zero if - _c_o_m_m_a_n_d was found, and non-zero if not. If neither 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 + If the --VV or --vv option is supplied, the exit status is zero if + _c_o_m_m_a_n_d was found, and non-zero if not. If neither 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. 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 supplied, ccoommppggeenn stores the generated com- - pletions into the indexed array variable _v_a_r_n_a_m_e instead of + If the --VV option is supplied, ccoommppggeenn stores the generated com- + pletions 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 variables set @@ -5177,11 +5195,11 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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, - only those completions matching _w_o_r_d will be displayed or + tion specification with the same flags. If _w_o_r_d is specified, + only those completions matching _w_o_r_d will be displayed or stored. - 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] @@ -5191,78 +5209,78 @@ 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 or _n_a_m_es are sup- - plied, print existing completion specifications in a way that + plied, print existing completion specifications in a way that allows them to be reused as input. The --rr option removes a com- - pletion specification for each _n_a_m_e, or, if no _n_a_m_es are sup- + pletion specification for each _n_a_m_e, or, if no _n_a_m_es are sup- plied, all completion specifications. - The --DD option indicates that other supplied options and actions - should apply to the "default" command completion; that is, com- - pletion attempted on a command for which no completion has pre- - viously been defined. The --EE option indicates that other sup- - plied options and actions should apply to "empty" command com- - pletion; 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 + The --DD option indicates that other supplied options and actions + should apply to the "default" command completion; that is, com- + pletion attempted on a command for which no completion has pre- + viously been defined. The --EE option indicates that other sup- + plied options and actions should apply to "empty" command com- + pletion; 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 usu- ally 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 + 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 at- - tempting word completion is described above under PPrrooggrraammmmaabbllee + tempting word completion is described above under PPrrooggrraammmmaabbllee CCoommpplleettiioonn. - 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- + 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 rreeaaddlliinnee's default filename completion if + ddeeffaauulltt Use rreeaaddlliinnee'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 rreeaaddlliinnee that the compspec generates file- - names, so it can perform any filename-specific - processing (such as adding a slash to directory - names, quoting special characters, or suppress- - ing trailing spaces). This is intended to be + Tell rreeaaddlliinnee that the compspec generates file- + names, so it can perform any filename-specific + processing (such as adding a slash to directory + names, quoting special characters, or suppress- + ing trailing spaces). This is intended to be used with shell functions. ffuullllqquuoottee - Tell rreeaaddlliinnee to quote all the completed words + Tell rreeaaddlliinnee to quote all the completed words even if they are not filenames. - nnooqquuoottee Tell rreeaaddlliinnee not to quote the completed words - if they are filenames (quoting filenames is the + nnooqquuoottee Tell rreeaaddlliinnee not to quote the completed words + if they are filenames (quoting filenames is the default). - nnoossoorrtt Tell rreeaaddlliinnee not to sort the list of possible + nnoossoorrtt Tell rreeaaddlliinnee not to sort the list of possible completions alphabetically. - nnoossppaaccee Tell rreeaaddlliinnee not to append a space (the de- - fault) to words completed at the end of the + nnoossppaaccee Tell rreeaaddlliinnee not to append a space (the de- + fault) to words completed at the end of the line. pplluussddiirrss - After generating any matches defined by the - compspec, attempt directory name completion and - add any matches to the results of the other ac- + After generating any matches defined by the + compspec, attempt directory name completion and + add any matches to the results of the other ac- tions. --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. 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. ddiirreeccttoorryy @@ -5270,7 +5288,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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. ffuunnccttiioonn @@ -5279,17 +5297,17 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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 + jjoobb Job names, if job control is active. May also be specified as --jj. - kkeeyywwoorrdd Shell reserved words. May also be specified as + 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 + 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. @@ -5298,219 +5316,219 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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- + the word preceding the word being completed on the cur- rent command line. When _f_u_n_c_t_i_o_n finishes, programmable - completion retrieves the possible completions from the + completion retrieves the possible completions from the value of the CCOOMMPPRREEPPLLYY array variable. --GG _g_l_o_b_p_a_t - Expand the pathname expansion pattern _g_l_o_b_p_a_t to gener- + Expand the pathname expansion pattern _g_l_o_b_p_a_t to gener- ate the possible completions. --PP _p_r_e_f_i_x - Add _p_r_e_f_i_x to the beginning of each possible completion + Add _p_r_e_f_i_x to the beginning of each possible completion after all other options have been applied. --SS _s_u_f_f_i_x - Append _s_u_f_f_i_x to each possible completion after all + Append _s_u_f_f_i_x to each possible completion after all other options have been applied. --WW _w_o_r_d_l_i_s_t - Split the _w_o_r_d_l_i_s_t using the characters in the IIFFSS spe- - cial variable as delimiters, and expand each resulting - word. Shell quoting is honored within _w_o_r_d_l_i_s_t, in or- - der 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- - tant list which match a prefix of the word being com- + Split the _w_o_r_d_l_i_s_t using the characters in the IIFFSS spe- + cial variable as delimiters, and expand each resulting + word. Shell quoting is honored within _w_o_r_d_l_i_s_t, in or- + der 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- + tant list which match a prefix of the word being com- pleted. --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 supplied, display the completion - options 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- + supplied. If no _o_p_t_i_o_ns are supplied, display the completion + options 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 options should apply - to the "default" command completion; the --EE option indicates + to the "default" command completion; the --EE option indicates that other supplied options should apply to "empty" command com- pletion; and the --II option indicates that other supplied options - should apply to completion on the initial word on the line. + should apply to completion on the initial word on the line. These are determined in the same way as the ccoommpplleettee builtin. If multiple options are supplied, the --DD option takes precedence over --EE, and both take precedence over --II. - 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] ccoonnttiinnuuee resumes the next iteration of the enclosing ffoorr, wwhhiillee, - uunnttiill, or sseelleecctt loop. If _n is specified, bbaasshh resumes the _nth - enclosing loop. _n must be >= 1. If _n is greater than the num- - ber of enclosing loops, the shell resumes the last enclosing - loop (the "top-level" loop). The return value is 0 unless _n is + uunnttiill, or sseelleecctt loop. If _n is specified, bbaasshh resumes the _nth + enclosing loop. _n must be >= 1. If _n is greater than the num- + ber of enclosing loops, the shell resumes the last enclosing + loop (the "top-level" loop). 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 + Declare variables and/or give them attributes. If no _n_a_m_es are given then display the values of variables or functions. 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 + 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, ddeeccllaarree will display the attributes and values of all variables having the attributes - specified by the additional options. If no other options are + specified by the additional options. If no other options are supplied with --pp, ddeeccllaarree will display the attributes and values - of all shell variables. The --ff option restricts the display to + of all shell variables. The --ff option restricts 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 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 + 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 when ddeeccllaarree is not executed in a shell function. - 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 vari- - able with the same _n_a_m_e at a surrounding scope. If there is no + 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 vari- + able 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 vari- - ables with the specified attribute or to give variables attrib- + The following options can be used to restrict output to vari- + ables with the specified attribute or to give variables attrib- utes: - --aa Each _n_a_m_e is an indexed array variable (see AArrrraayyss + --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 + --AA Each _n_a_m_e is an associative array variable (see AArrrraayyss above). --ff Each _n_a_m_e refers to a shell function. --ii The variable is treated as an integer; arithmetic evalua- - tion (see AARRIITTHHMMEETTIICC EEVVAALLUUAATTIIOONN above) is performed when + 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 + --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 - 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 + --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. + 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 each _n_a_m_e for export to subsequent commands via the + --xx Mark each _n_a_m_e for export to subsequent commands via the environment. - Using "+" instead of "-" turns off the specified attribute in- + Using "+" instead of "-" turns off the specified attribute in- stead, with the exceptions that ++aa and ++AA may not be used to de- - stroy array variables and ++rr will not remove the readonly at- + stroy array variables and ++rr will not remove the readonly at- tribute. - When used in a function, ddeeccllaarree and ttyyppeesseett make each _n_a_m_e lo- - cal, as with the llooccaall command, unless the --gg option is sup- - plied. 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 com- - pound assignment syntax to create array variables, additional + When used in a function, ddeeccllaarree and ttyyppeesseett make each _n_a_m_e lo- + cal, as with the llooccaall command, unless the --gg option is sup- + plied. 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 com- + pound 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 + 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 at- tempt is made to assign a value to an array variable without us- - ing the compound assignment syntax (see AArrrraayyss above), one of + ing the compound assignment syntax (see AArrrraayyss above), 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 + 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, display the list of currently remembered direc- - tories. The default display is on a single line with directory - 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 directory + tories. The default display is on a single line with directory + 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 directory in the stack. Options, if supplied, have the following meanings: - --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] [_i_d ...] - Without options, remove each _i_d from the table of active jobs. - Each _i_d may be a job specification _j_o_b_s_p_e_c or a process ID _p_i_d; + Without options, remove each _i_d from the table of active jobs. + Each _i_d may be a job specification _j_o_b_s_p_e_c or a process ID _p_i_d; if _i_d is a _p_i_d, ddiissoowwnn uses the job containing _p_i_d as _j_o_b_s_p_e_c. - If the --hh option is supplied, ddiissoowwnn does not remove the jobs - corresponding to each _i_d from the jobs table, but rather marks - them so the shell does not send SSIIGGHHUUPP to the job if the shell + If the --hh option is supplied, ddiissoowwnn does not remove the jobs + corresponding to each _i_d from the jobs table, but rather marks + them so the shell does not send SSIIGGHHUUPP to the job if the shell receives a SSIIGGHHUUPP. - If no _i_d is supplied, the --aa option means to remove or mark all + If no _i_d is supplied, the --aa option means to remove or mark all jobs; the --rr option without an _i_d argument removes or marks run- - ning jobs. If no _i_d is supplied, and neither the --aa nor the --rr + ning jobs. If no _i_d is supplied, and neither the --aa nor the --rr option is supplied, ddiissoowwnn removes or marks the current job. The return value is 0 unless an _i_d 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 + 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 not printed. - If the --ee option is given, eecchhoo interprets the following back- + If the --ee option is given, eecchhoo interprets the following back- slash-escaped characters. The --EE option disables interpretation - of these escape characters, even on systems where they are in- - terpreted by default. The xxppgg__eecchhoo shell option determines + of these escape characters, even on systems where they are in- + terpreted by default. The xxppgg__eecchhoo shell option determines whether or not eecchhoo interprets any options and expands these es- - cape characters. eecchhoo does not interpret ---- to mean the end of + cape characters. eecchhoo does not interpret ---- to mean the end of options. eecchhoo interprets the following escape sequences: @@ -5525,101 +5543,101 @@ SSHHEELLLL 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). - eecchhoo writes any unrecognized backslash-escaped characters un- + eecchhoo writes any unrecognized backslash-escaped characters un- changed. 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 - allows an executable file which has the same name as a shell - builtin to be executed without specifying a full pathname, even + Enable and disable builtin shell commands. Disabling a builtin + allows an executable file 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 files. - If --nn is supplied, each _n_a_m_e is disabled; otherwise, _n_a_m_es are - enabled. For example, to use the tteesstt binary found usin g PPAATTHH + If --nn is supplied, each _n_a_m_e is disabled; otherwise, _n_a_m_es are + enabled. For example, to use the tteesstt binary found usin g PPAATTHH instead of the shell builtin version, run "enable -n test". - If no _n_a_m_e arguments are supplied, or if the --pp option is sup- + If no _n_a_m_e arguments are supplied, or if the --pp option is sup- plied, print a list of shell builtins. With no other option ar- guments, the list consists of all enabled shell builtins. If --nn - is supplied, print only disabled builtins. If --aa is supplied, - the list printed includes all builtins, with an indication of + is supplied, print only disabled builtins. If --aa is supplied, + the list printed includes all builtins, with an indication of whether or not each is enabled. The --ss option means to restrict the output to the POSIX _s_p_e_c_i_a_l builtins. - The --ff option means to load the new builtin command _n_a_m_e from + 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. If _f_i_l_e_n_a_m_e does not contain a slash, 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 for - BBAASSHH__LLOOAADDAABBLLEESS__PPAATTHH is system-dependent, and may include "." to - force a search of the current directory. The --dd option will - delete a builtin previously loaded with --ff. If _-_s is used with + 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 for + BBAASSHH__LLOOAADDAABBLLEESS__PPAATTHH is system-dependent, and may include "." to + force a search of the current directory. The --dd option will + delete a builtin previously loaded with --ff. If _-_s is used with _-_f, the new builtin becomes a POSIX special builtin. - 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 + 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 + 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 ...] - Concatenate the _a_r_gs together into a single command, separating + Concatenate the _a_r_gs together into a single command, separating them with spaces. BBaasshh then reads and execute this command, and - returns its exit status as the return status of eevvaall. If there + returns its exit status as the return status 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 without creating - a new process. _c_o_m_m_a_n_d cannot be a shell builtin or function. + If _c_o_m_m_a_n_d is specified, it replaces the shell without creating + a new process. _c_o_m_m_a_n_d cannot be a shell builtin or function. 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 beginning of the ze- - roth 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 envi- + roth 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 envi- ronment. 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, unless the eexxeeccffaaiill shell option is enabled. In - that case, it returns a non-zero status. An interactive shell - returns a non-zero status if the file cannot be executed. A + shell exits, unless the eexxeeccffaaiill shell option is enabled. In + that case, it returns a non-zero status. An interactive shell + returns a non-zero status 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 redi- + current shell, and the return status is 0. If there is a redi- rection 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. Any trap + Cause the shell to exit with a status of _n. If _n is omitted, + the exit status is that of the last command executed. Any trap on EEXXIITT is executed before the shell terminates. eexxppoorrtt [--ffnn] [_n_a_m_e[=_v_a_l_u_e]] ... 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 + 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. - The --nn option unexports, or removes the export attribute, from - each _n_a_m_e. If no _n_a_m_e_s are given, or if the --pp option is sup- - plied, eexxppoorrtt prints a list of names of all exported variables + The --nn option unexports, or removes the export attribute, from + each _n_a_m_e. If no _n_a_m_e_s are given, or if the --pp option is sup- + plied, eexxppoorrtt prints a list of names of all exported variables on the standard output. - eexxppoorrtt allows the value of a variable to be set when it is ex- + eexxppoorrtt allows the value of a variable to be set when it is ex- ported or unexported by following the variable name with =_v_a_l_u_e. This sets the value of the variable to _v_a_l_u_e while modifying the - export attribute. 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 + export attribute. 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 supplied with a _n_a_m_e that is not a function. @@ -5627,140 +5645,140 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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 - index into the history list, where a negative number is used as + 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); oth- - erwise 0 is equivalent to -1 and -0 is invalid. If _l_a_s_t is not + erwise 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. - If the --ll option is supplied, the commands are listed on the - standard output. The --nn option suppresses the command numbers + If the --ll option is supplied, the commands are listed on the + standard output. The --nn option suppresses the command numbers when listing. The --rr option reverses the order of the commands. - Otherwise, ffcc invokes the editor named by _e_n_a_m_e on a file con- - taining those commands. If _e_n_a_m_e is not supplied, ffcc uses the - value of the FFCCEEDDIITT variable, and the value of EEDDIITTOORR if FFCCEEDDIITT - is not set. If neither variable is set, ffcc uses _v_i_. When edit- - ing is complete, ffcc reads the file containing the edited com- + Otherwise, ffcc invokes the editor named by _e_n_a_m_e on a file con- + taining those commands. If _e_n_a_m_e is not supplied, ffcc uses the + value of the FFCCEEDDIITT variable, and the value of EEDDIITTOORR if FFCCEEDDIITT + is not set. If neither variable is set, ffcc uses _v_i_. When edit- + ing is complete, ffcc reads the file containing the edited com- mands and echoes and executes them. - In the second form, ffcc re-executes _c_o_m_m_a_n_d after replacing each - instance of _p_a_t with _r_e_p. _C_o_m_m_a_n_d is interpreted the same as + In the second form, ffcc re-executes _c_o_m_m_a_n_d after replacing each + instance of _p_a_t with _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 ffcc is "r="fc -s"", so that typing "r + A useful alias to use with ffcc 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 zero unless an - invalid option is encountered or _f_i_r_s_t or _l_a_s_t specify history - lines out of range. When editing and re-executing a file of + If the first form is used, the return value is zero unless an + invalid option is encountered or _f_i_r_s_t or _l_a_s_t specify history + lines out of range. When editing and re-executing a file of commands, the return value is the value of the last command exe- cuted or failure if an error occurs with the temporary file. If the second form is used, the return status is that of the re-ex- - ecuted command, unless _c_m_d does not specify a valid history en- + ecuted command, unless _c_m_d does not specify a valid history en- try, in which case ffcc returns a non-zero status. 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, ffgg uses the shell's notion of the - _c_u_r_r_e_n_t _j_o_b. The return value is that of the command placed - into the foreground, or failure if run when job control is dis- + 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, ffgg uses the shell's notion of the + _c_u_r_r_e_n_t _j_o_b. The return value is that of the command placed + into the foreground, or failure if run when job control is dis- abled 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 + specify 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 scripts and functions to parse posi- - tional parameters and obtain options and their arguments. _o_p_t_- - _s_t_r_i_n_g contains the option characters to be recognized; if a + ggeettooppttss is used by shell scripts and functions to parse posi- + tional parameters and obtain options and their arguments. _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. + 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 + 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 option requires an argument, + OOPPTTIINNDD. OOPPTTIINNDD is initialized to 1 each time the shell or a + shell script is invoked. When an option requires an argument, ggeettooppttss places that argument into the variable OOPPTTAARRGG. - The shell does not reset OOPPTTIINNDD automatically; it must be manu- - ally reset between multiple calls to ggeettooppttss within the same + The shell does not reset OOPPTTIINNDD automatically; it must be manu- + ally reset between multiple calls to ggeettooppttss within the same shell invocation to use a new set of parameters. - When it reaches the end of options, ggeettooppttss exits with a return - value greater than zero. OOPPTTIINNDD is set to the index of the + When it reaches the end of options, ggeettooppttss exits with a return + 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, ggeettooppttss uses _s_i_l_e_n_t error reporting. - In normal operation, ggeettooppttss prints diagnostic messages when it - encounters invalid options or missing option arguments. If the - variable OOPPTTEERRRR is set to 0, no error messages will be dis- + ggeettooppttss can report errors in two ways. If the first character + of _o_p_t_s_t_r_i_n_g is a colon, ggeettooppttss uses _s_i_l_e_n_t error reporting. + In normal operation, ggeettooppttss prints diagnostic messages when it + encounters invalid options or missing option arguments. 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 ggeettooppttss detects an invalid option, it places ? into _n_a_m_e and, - if not silent, prints an error message and unsets OOPPTTAARRGG. If - ggeettooppttss is silent, it assigns the option character found to OOPP-- + if not silent, prints an error message and unsets OOPPTTAARRGG. If + ggeettooppttss is silent, it assigns the option character found to OOPP-- TTAARRGG and does not print a diagnostic message. - If a required argument is not found, and ggeettooppttss is not silent, + If a required argument is not found, and ggeettooppttss is not silent, it sets the value of _n_a_m_e to a question mark (??), unsets OOPPTTAARRGG, - and prints a diagnostic message. If ggeettooppttss is silent, it sets - the value of _n_a_m_e to a colon (::) and sets OOPPTTAARRGG to the option + and prints a diagnostic message. If ggeettooppttss is silent, it sets + the value of _n_a_m_e to a colon (::) and sets OOPPTTAARRGG 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, it remembers the full pathname of the - command _n_a_m_e as determined by searching the directories in - $$PPAATTHH. Any previously-remembered pathname associated with _n_a_m_e - is discarded. If the --pp option is supplied, hhaasshh uses _f_i_l_e_n_a_m_e + command _n_a_m_e as determined by searching the directories in + $$PPAATTHH. Any previously-remembered pathname associated with _n_a_m_e + is discarded. If the --pp option is supplied, hhaasshh uses _f_i_l_e_n_a_m_e as the full pathname of the command. - The --rr option causes the shell to forget all remembered loca- - tions. Assigning to the PPAATTHH variable also clears all hashed - filenames. The --dd option causes the shell to forget the remem- + The --rr option causes the shell to forget all remembered loca- + tions. Assigning to the PPAATTHH variable also clears all hashed + filenames. The --dd option causes the shell to forget the remem- bered location of each _n_a_m_e. If the --tt option is supplied, hhaasshh prints the full pathname cor- - responding to each _n_a_m_e. If multiple _n_a_m_e arguments are sup- - plied with --tt, hhaasshh prints the _n_a_m_e before the corresponding + responding to each _n_a_m_e. If multiple _n_a_m_e arguments are sup- + plied with --tt, hhaasshh prints the _n_a_m_e before the corresponding hashed full pathname. The --ll option displays output in a format that may be reused as input. - If no arguments are given, or if only --ll is supplied, hhaasshh - prints information about remembered commands. The --tt, --dd, and - --pp options (the options that act on the _n_a_m_e arguments) are mu- + If no arguments are given, or if only --ll is supplied, hhaasshh + prints information about remembered commands. 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 have higher + supplied, --tt has higher priority than --pp, and both have higher priority than --dd. - The return status is zero unless a _n_a_m_e is not found or an in- + The return status is zero unless a _n_a_m_e is not found or an in- valid 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 it displays a list of all the builtins and + 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 it displays a list of all the builtins and shell compound commands. --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 @@ -5776,18 +5794,18 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS hhiissttoorryy --aannrrww [_f_i_l_e_n_a_m_e] 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 numbers. - Entries prefixed with a ** have been modified. An argument of _n - lists only the last _n entries. 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. If hhiissttoorryy uses HHIISSTTTTIIMMEEFFOORRMMAATT, it does - not print an intervening space between the formatted time stamp + With no options, display the command history list with numbers. + Entries prefixed with a ** have been modified. An argument of _n + lists only the last _n entries. 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. If hhiissttoorryy uses HHIISSTTTTIIMMEEFFOORRMMAATT, it does + not print an intervening space between the formatted time stamp and the history entry. If _f_i_l_e_n_a_m_e is supplied, hhiissttoorryy uses it as the name of the his- - tory file; if not, it uses the value of HHIISSTTFFIILLEE. If _f_i_l_e_n_a_m_e - is not supplied and HHIISSTTFFIILLEE is unset or null, the --aa,, --nn,, --rr,, + tory file; if not, it uses the value of HHIISSTTFFIILLEE. 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: @@ -5795,20 +5813,20 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS can be used with the other options to replace the history list. --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 + 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 + --nn Read the history lines not already read from the history file and add them to the current history list. These are lines appended to the history file since the beginning of the current bbaasshh session. @@ -5816,24 +5834,24 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS rent history list. --ww Write the current history list to the history file, over- writing the history file. - --pp Perform history substitution on the following _a_r_g_s and - display the result on the standard output, without stor- - ing the results in the history list. Each _a_r_g must be + --pp Perform history substitution on the following _a_r_g_s and + display the result on the standard output, without stor- + ing 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 + --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 adding the _a_r_g_s. - If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, hhiissttoorryy writes the time + If the HHIISSTTTTIIMMEEFFOORRMMAATT variable is set, hhiissttoorryy writes the time stamp information associated with each history entry to the his- - tory file, marked with the history comment character as de- - scribed above. 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 + tory file, marked with the history comment character as de- + scribed above. 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 + 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 supplied as an argument to --pp fails. @@ -5842,14 +5860,14 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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 supplied, jjoobbss restricts output to information + If _j_o_b_s_p_e_c is supplied, jjoobbss restricts output 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. @@ -5859,433 +5877,433 @@ 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] _i_d [ ... ] kkiillll --ll|--LL [_s_i_g_s_p_e_c | _e_x_i_t___s_t_a_t_u_s] - Send the signal specified by _s_i_g_s_p_e_c or _s_i_g_n_u_m to the processes + Send the signal specified by _s_i_g_s_p_e_c or _s_i_g_n_u_m to the processes named by each _i_d. Each _i_d may be a job specification _j_o_b_s_p_e_c or - a process ID _p_i_d. _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 sig- - nal number; _s_i_g_n_u_m is a signal number. If _s_i_g_s_p_e_c is not sup- + a process ID _p_i_d. _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 sig- + nal number; _s_i_g_n_u_m is a signal number. If _s_i_g_s_p_e_c is not sup- plied, then kkiillll sends SSIIGGTTEERRMM. The --ll option lists the signal names. If any arguments are sup- plied when --ll is given, kkiillll lists the names of the signals cor- - responding to the arguments, 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 sig- - nal number or the exit status of a process terminated by a sig- - nal; if it is supplied, kkiillll prints the name of the signal that + responding to the arguments, 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 sig- + nal number or the exit status of a process terminated by a sig- + nal; if it is supplied, kkiillll prints the name of the signal that caused the process to terminate. kkiillll assumes that process exit statuses are greater than 128; anything less than that is a sig- nal number. The --LL option is equivalent to --ll. - kkiillll returns true if at least one signal was successfully sent, + kkiillll returns true if at least one signal was successfully sent, or false if an error occurs or an invalid option is encountered. lleett _a_r_g [_a_r_g ...] - Each _a_r_g is evaluated as an arithmetic expression (see AARRIITTHH-- - MMEETTIICC EEVVAALLUUAATTIIOONN above). If the last _a_r_g evaluates to 0, lleett + Each _a_r_g is evaluated as an arithmetic expression (see AARRIITTHH-- + MMEETTIICC EEVVAALLUUAATTIIOONN above). If the last _a_r_g evaluates to 0, lleett returns 1; otherwise lleett returns 0. llooccaall [_o_p_t_i_o_n] [_n_a_m_e[=_v_a_l_u_e] ... | - ] For each argument, create a local variable named _n_a_m_e and assign - it _v_a_l_u_e. The _o_p_t_i_o_n can be any of the options accepted by ddee-- - ccllaarree. 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. It is an error to use llooccaall when not + it _v_a_l_u_e. The _o_p_t_i_o_n can be any of the options accepted by ddee-- + ccllaarree. 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. It is an error to use llooccaall when not within a function. - If _n_a_m_e is -, it makes the set of shell options local to the - function in which llooccaall is invoked: any shell options changed - using the sseett builtin inside the function after the call to lloo-- - ccaall are restored to their original values when the function re- - turns. The restore is performed as if a series of sseett commands - were executed to restore the values that were in place before + If _n_a_m_e is -, it makes the set of shell options local to the + function in which llooccaall is invoked: any shell options changed + using the sseett builtin inside the function after the call to lloo-- + ccaall are restored to their original values when the function re- + turns. The restore is performed 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 + With no operands, llooccaall writes a list of local variables to the standard output. - The return status is 0 unless llooccaall is used outside 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 [[_n]] - Exit a login shell, returning a status of _n to the shell's par- + Exit a login shell, returning a status of _n to the shell's par- ent. 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, or from file descriptor _f_d - if the --uu option is supplied, into the indexed array variable - _a_r_r_a_y. The variable MMAAPPFFIILLEE is the default _a_r_r_a_y. Options, if + Read lines from the standard input, or from file descriptor _f_d + if the --uu option is supplied, into the indexed array variable + _a_r_r_a_y. The variable MMAAPPFFIILLEE is the default _a_r_r_a_y. Options, if supplied, have the following meanings: - --dd Use the first character of _d_e_l_i_m to terminate each input + --dd Use the first character of _d_e_l_i_m 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 charac- ter. --nn Copy at most _c_o_u_n_t lines. If _c_o_u_n_t is 0, copy all lines. - --OO Begin assigning to _a_r_r_a_y at index _o_r_i_g_i_n. The default + --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. + 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 + 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 zero 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 + 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] - Remove entries from the directory stack. The elements are num- - bered from 0 starting at the first directory listed by ddiirrss, so - ppooppdd is equivalent to "popd +0." With no arguments, ppooppdd re- - moves the top directory from the stack, and changes to the new + Remove entries from the directory stack. The elements are num- + bered from 0 starting at the first directory listed by ddiirrss, so + ppooppdd is equivalent to "popd +0." With no arguments, ppooppdd re- + moves the top directory from the stack, and changes to the new top directory. Arguments, if supplied, have the following mean- ings: --nn Suppress the normal change of directory when removing di- rectories from the stack, only manipulate the stack. - ++_n Remove the _nth entry counting from the left of the list - shown by ddiirrss, starting with zero, from the stack. For + ++_n Remove 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 Remove 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 + --_n Remove 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 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 + 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 supplied, - the directory stack is empty, or _n specifies a non-existent di- + Otherwise, ppooppdd returns false if an invalid option is supplied, + the directory stack is empty, or _n specifies a non-existent di- rectory stack entry. - If the ppooppdd command is successful, bbaasshh runs ddiirrss to show the - final contents of the directory stack, and the return status is + If the ppooppdd command is successful, bbaasshh 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 assigns the output 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 assigns the output to the variable _v_a_r rather than printing it 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 - addition to the standard _p_r_i_n_t_f(3) format characters ccCCssSS-- + 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 ccCCssSS-- nnddiioouuxxXXeeEEffFFggGGaaAA, pprriinnttff interprets the following additional for- mat specifiers: %%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. This format specifier recognizes two special argument values: -1 represents the - current time, and -2 represents the time the shell was + current time, and -2 represents the time the shell was invoked. If no argument is specified, conversion behaves - as if -1 had been supplied. This is an exception to the + as if -1 had been supplied. This is an exception to the usual pprriinnttff behavior. 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. The %S and %C format specifiers are equivalent to %ls and %lc, respectively. - 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 - is the numeric value of the following character, using the cur- + if the leading character is a single or double quote, the value + is the numeric value of the following character, using the cur- rent locale. - 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 sup- + 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] Add a directory to the top of the directory stack, or rotate the - stack, making the new top of the stack the current working di- - rectory. With no arguments, ppuusshhdd exchanges the top two ele- - ments of the directory stack. Arguments, if supplied, have the + stack, making the new top of the stack the current working di- + rectory. With no arguments, ppuusshhdd exchanges the top two ele- + ments of the directory stack. Arguments, if supplied, have the following meanings: - --nn Suppress the normal change of directory when rotating or - adding directories to the stack, only manipulate the + --nn Suppress the normal change of directory when rotating or + adding directories to the stack, only manipulate the stack. ++_n Rotate the stack so that the _nth directory (counting from - the left of the list shown by ddiirrss, starting with zero) + 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 + 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 zero un- - less the directory stack is empty. When rotating the directory + Otherwise, if no arguments are supplied, ppuusshhdd returns zero un- + less the directory stack is empty. When rotating the directory stack, ppuusshhdd returns zero unless the directory stack is empty or _n specifies a non-existent directory stack element. - If the ppuusshhdd command is successful, bbaasshh runs ddiirrss to show the + If the ppuusshhdd command is successful, bbaasshh 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] [--pp _p_r_o_m_p_t] [--tt _t_i_m_e_o_u_t] [--uu _f_d] [_n_a_m_e ...] Read one line from the standard input, or from the file descrip- - tor _f_d supplied as an argument to the --uu option, split it into - words as described above under WWoorrdd SSpplliittttiinngg, and assign the - first word 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 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 the value of the IIFFSS variable are used + tor _f_d supplied as an argument to the --uu option, split it into + words as described above under WWoorrdd SSpplliittttiinngg, and assign the + first word 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 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 the value of the IIFFSS variable are used to split the line into words using the same rules the shell uses for expansion (described above under WWoorrdd SSpplliittttiinngg). The back- - slash character (\\) removes any special meaning for the next + slash character (\\) removes any special meaning for the next character read and is used 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- + 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 terminates the input line, - rather than newline. If _d_e_l_i_m is the empty string, rreeaadd + The first character of _d_e_l_i_m terminates the input 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. - RReeaaddlliinnee 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. + RReeaaddlliinnee uses the current (or default, if line editing + was not previously active) editing settings, but uses rreeaaddlliinnee's default filename completion. - --EE If the standard input is coming from a terminal, rreeaadd - uses rreeaaddlliinnee (see RREEAADDLLIINNEE above) to obtain the line. - RReeaaddlliinnee 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. + RReeaaddlliinnee 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, rreeaadd places + If rreeaaddlliinnee is being used to read the line, rreeaadd places _t_e_x_t 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 - waiting for a complete line of input, unless it encoun- - ters EOF or rreeaadd times out, but honors a delimiter if it + rreeaadd returns after reading _n_c_h_a_r_s characters rather than + waiting for a complete line of input, unless it encoun- + ters EOF or rreeaadd times out, but honors a delimiter if it reads fewer than _n_c_h_a_r_s characters 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 + rreeaadd returns after reading exactly _n_c_h_a_r_s characters + rather than waiting for a complete line of input, unless it encounters EOF or rreeaadd times out. Any delimiter char- - acters in the input are not treated specially and do not + acters in the input are not treated specially and do not cause rreeaadd to return until it has read _n_c_h_a_r_s characters. The result is not split on the characters in IIFFSS; the in- tent is that the variable is assigned exactly the charac- - ters read (with the exception of backslash; see the --rr + ters 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, but only if + line, before attempting to read any input, but 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 + 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- ters are not echoed. --tt _t_i_m_e_o_u_t - Cause rreeaadd to time out and return failure if it does not - read a complete line of input (or a specified number of - characters) 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, it saves any partial input read into - the specified variable _n_a_m_e, and the exit status is - greater than 128. If _t_i_m_e_o_u_t is 0, rreeaadd returns immedi- - ately, without trying to read any data. In this case, - the exit status is 0 if input is available on the speci- - fied file descriptor, or the read will return EOF, non- + Cause rreeaadd to time out and return failure if it does not + read a complete line of input (or a specified number of + characters) 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, it saves any partial input read into + the specified variable _n_a_m_e, and the exit status is + greater than 128. If _t_i_m_e_o_u_t is 0, rreeaadd returns immedi- + ately, without trying to read any data. In this case, + the exit status is 0 if input is available on the speci- + fied file descriptor, or the read will return EOF, non- zero otherwise. - --uu _f_d Read input from file descriptor _f_d instead of the stan- + --uu _f_d Read input from file descriptor _f_d instead of the stan- dard input. - Other than the case where _d_e_l_i_m is the empty string, rreeaadd ig- + Other than the case where _d_e_l_i_m is the empty string, rreeaadd ig- nores any NUL characters in the input. - If no _n_a_m_e_s are supplied, rreeaadd assigns the line read, without - the ending delimiter but otherwise unmodified, to the variable + If no _n_a_m_e_s are supplied, rreeaadd assigns the line read, without + the ending delimiter but otherwise unmodified, to the variable RREEPPLLYY. The exit status is zero, unless end-of-file is encountered, rreeaadd - times out (in which case the status is greater than 128), a + times out (in which case the status is greater than 128), a variable assignment error (such as assigning to a readonly vari- - able) occurs, or an invalid file descriptor is supplied as the + able) 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 + 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 or unset. If the --ff - option is supplied, each _n_a_m_e refers to a shell function. The - --aa option restricts the variables to indexed arrays; the --AA op- + option is supplied, each _n_a_m_e refers to a shell function. The + --aa option restricts the variables to indexed arrays; the --AA op- tion restricts the variables to associative arrays. If both op- - tions are supplied, --AA takes precedence. If no _n_a_m_e arguments - are supplied, or if the --pp option is supplied, print a list of - all readonly names. The other options may be used to restrict + tions are supplied, --AA takes precedence. If no _n_a_m_e arguments + are supplied, or if the --pp option is supplied, print a list of + all readonly names. The other options may be used to restrict the output to a subset of the set of readonly names. The --pp op- tion displays output in a format that may be reused as input. - rreeaaddoonnllyy allows the value of a variable to be set at the same + rreeaaddoonnllyy allows the value of a variable to be set at the same time the readonly attribute is changed by following the variable - name with =_v_a_l_u_e. This sets the value of the variable is to + name with =_v_a_l_u_e. This sets the value of the variable is to _v_a_l_u_e while modifying the readonly attribute. - 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 + 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] - Stop executing a shell function or sourced file and return the + Stop executing a shell function or sourced file and return the value specified by _n to its caller. If _n is omitted, the return - status is that of the last command executed. If rreettuurrnn is exe- - cuted by a trap handler, the last command used to determine the + status is that of the last command executed. If rreettuurrnn is exe- + cuted by a trap handler, the last command used to determine 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 executed by the trap + determine the status is the last command executed by the trap handler before rreettuurrnn was invoked. When rreettuurrnn is used to terminate execution of a script being ex- - ecuted 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 + ecuted 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 significant 8 bits. - Any command associated with the RREETTUURRNN trap is executed before + Any command associated with the RREETTUURRNN trap is executed before execution resumes after the function or script. - The return status is non-zero if rreettuurrnn is supplied a non-nu- + The return status is non-zero if rreettuurrnn is supplied a non-nu- meric argument, or is used outside a function and not during ex- ecution of a script by .. or ssoouurrccee. 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- + 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 posix mode, 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 + be reset. In posix mode, 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- + $$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- + --bb Report the status of terminated background jobs immedi- ately, rather than before the next primary prompt or af- - ter a foreground command terminates. This is effective + ter a foreground command terminates. 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 + --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 above), 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 final &&&& - or ||||, any command in a pipeline but the last (subject - to the state of the ppiippeeffaaiill shell option), 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 + 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 final &&&& + or ||||, any command in a pipeline but the last (subject + to the state of the ppiippeeffaaiill shell option), 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 applies to the shell environment and each subshell envi- - ronment separately (see CCOOMMMMAANNDD EEXXEECCUUTTIIOONN EENNVVIIRROONNMMEENNTT + 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 - 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 + --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 + --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 - support it (see JJOOBB CCOONNTTRROOLL above). All processes run + --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- + 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: @@ -6293,10 +6311,10 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS Same as --aa. bbrraacceeeexxppaanndd Same as --BB. - eemmaaccss Use an emacs-style command line editing inter- + 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 @@ -6310,7 +6328,7 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS HHIISSTTOORRYY. This option is on by default in inter- active shells. iiggnnoorreeeeooff - The effect is as if the shell command + The effect is as if the shell command "IGNOREEOF=10" had been executed (see SShheellll VVaarriiaabblleess above). kkeeyywwoorrdd Same as --kk. @@ -6326,184 +6344,184 @@ 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 shell does - not read the $$EENNVV and $$BBAASSHH__EENNVV files, shell functions - are not inherited from the environment, and the SSHHEELL-- - LLOOPPTTSS, BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if - they appear 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 supplied, these actions are taken and the effective + --pp Turn on _p_r_i_v_i_l_e_g_e_d mode. In this mode, the shell does + not read the $$EENNVV and $$BBAASSHH__EENNVV files, shell functions + are not inherited from the environment, and the SSHHEELL-- + LLOOPPTTSS, BBAASSHHOOPPTTSS, CCDDPPAATTHH, and GGLLOOBBIIGGNNOORREE variables, if + they appear 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 supplied, 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 + 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 - unset 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 the standard error. - --BB The shell performs brace expansion (see BBrraaccee EExxppaannssiioonn + --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. Using the - redirection operator >>|| instead of >> will override this + --CC If set, bbaasshh does not overwrite an existing file with + the >>, >>&&, and <<>> redirection operators. Using the + redirection operator >>|| instead of >> will override this and force the creation of an output file. --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 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 + --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 + chain of directories when performing commands which change the current directory. - --TT If set, any traps on DDEEBBUUGG and RREETTUURRNN are inherited by + --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, unset the positional parameters. Otherwise, set the positional parameters to the _a_r_gs, even if some of them begin with a --. -- Signal the end of options, and assign all remaining _a_r_gs to the positional parameters. The --xx and --vv options are - turned off. If there are no _a_r_gs, the positional para- + turned off. If there are no _a_r_gs, the positional para- meters remain unchanged. - The options are off by default unless otherwise noted. Using + - rather than - causes these options to be turned off. The op- + 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 zero unless an invalid option is encoun- + shell. The current set of options may be found in $$--. The re- + turn status is always zero unless an invalid option is encoun- tered. sshhiifftt [_n] Rename positional parameters from _n+1 ... to $$11 ........ Parameters - represented by the numbers $$## down to $$##-_n+1 are unset. _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 parameters are - not changed. The return status is greater than zero if _n is + represented by the numbers $$## down to $$##-_n+1 are unset. _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 parameters 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 + Toggle the values of settings controlling optional shell behav- + 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, display a list of all - settable options, with an indication of whether or not each is - set; if any _o_p_t_n_a_m_e_s are supplied, the output is restricted to + With no options, or with the --pp option, display a list of all + settable options, with an indication of whether or not each is + set; if any _o_p_t_n_a_m_e_s are supplied, the output is restricted to those options. The --pp option displays output in a form that may be reused as input. Other options 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 + --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- - ple _o_p_t_n_a_m_e arguments are supplied with --qq, the return + ple _o_p_t_n_a_m_e arguments are supplied with --qq, the return status is zero if all _o_p_t_n_a_m_e_s are enabled; non-zero oth- erwise. - --oo Restricts the values of _o_p_t_n_a_m_e to be those defined for + --oo Restricts the values of _o_p_t_n_a_m_e to be those defined for the --oo option to the sseett builtin. - If either --ss or --uu is used with no _o_p_t_n_a_m_e arguments, sshhoopptt - shows only those options which are set or unset, respectively. - Unless otherwise noted, the sshhoopptt options are disabled (unset) + If either --ss or --uu is used with no _o_p_t_n_a_m_e arguments, sshhoopptt + shows only those options which are set or unset, respectively. + Unless otherwise noted, the sshhoopptt options are disabled (unset) 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- - tions, the return status is zero unless an _o_p_t_n_a_m_e is not a + 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- + tions, the return status is zero unless an _o_p_t_n_a_m_e is not a valid shell option. The list of sshhoopptt options is: aarrrraayy__eexxppaanndd__oonnccee - If set, the shell suppresses multiple evaluation of as- + If set, the shell suppresses multiple evaluation of as- sociative and indexed array subscripts during arithmetic expression evaluation, while executing builtins that can - perform variable assignments, and while executing + perform variable assignments, and while executing builtins that perform array dereferencing. aassssoocc__eexxppaanndd__oonnccee 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- + 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. bbaasshh__ssoouurrccee__ffuullllppaatthh - If set, filenames added to the BBAASSHH__SSOOUURRCCEE array vari- - able are converted to full pathnames (see SShheellll VVaarrii-- + If set, filenames added to the BBAASSHH__SSOOUURRCCEE array vari- + able are converted to full pathnames (see SShheellll VVaarrii-- aabblleess above). 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 + 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, the ccdd command attempts to correct minor errors - in the spelling of a directory component. Minor errors - include transposed characters, a missing character, and + ccddssppeellll If set, the ccdd command attempts to correct minor errors + in the spelling of a directory component. Minor errors + include transposed characters, a missing character, and one extra character. If ccdd corrects the directory name, - it prints the corrected filename, and the command pro- + it prints the corrected filename, and the command pro- ceeds. 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 - command no longer exists, bbaasshh performs a normal path + ble exists before trying to execute it. If a hashed + command no longer exists, bbaasshh performs a normal path search. cchheecckkjjoobbss If set, bbaasshh lists the status of any stopped and running - jobs before exiting an interactive shell. If any jobs + jobs before exiting an interactive shell. If any jobs are running, bbaasshh defers the exit until a second exit is - attempted without an intervening command (see JJOOBB CCOONN-- - TTRROOLL above). The shell always postpones exiting if any + attempted without an intervening command (see JJOOBB CCOONN-- + TTRROOLL above). The shell always postpones 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, using the file descriptor - associated with the standard error if it is a terminal. + If set, bbaasshh checks the window size after each external + (non-builtin) command and, if necessary, updates the + values of LLIINNEESS and CCOOLLUUMMNNSS, using the file descriptor + associated with the standard error if it is a terminal. 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 - enabled by default, but only has an effect if command + 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 + enabled by default, but only has an effect if command history is enabled, as described above under HHIISSTTOORRYY. ccoommppaatt3311 ccoommppaatt3322 @@ -6513,143 +6531,143 @@ SSHHEELLLL 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 below). ccoommpplleettee__ffuullllqquuoottee - If set, bbaasshh quotes all shell metacharacters in file- - names and directory names when performing completion. + 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 + 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. + If set, bbaasshh replaces directory names with the results + of word expansion when performing filename completion. This changes the contents of the rreeaaddlliinnee editing - buffer. If not set, bbaasshh attempts to preserve what the + buffer. 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 + 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. An interactive shell does not exit if + not execute the file specified as an argument to the + eexxeecc builtin. An interactive shell does not exit if eexxeecc fails. eexxppaanndd__aalliiaasseess - If set, aliases are expanded as described above under + If set, aliases are expanded as described above under AALLIIAASSEESS. This option is enabled by default for interac- tive 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 af- - ter invocation, behavior intended for use by debuggers + 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 above). - 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, enable the extended pattern matching features + eexxttgglloobb If set, enable the extended pattern matching features described above under PPaatthhnnaammee EExxppaannssiioonn. 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 + 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 above for a de- - scription of FFIIGGNNOORREE. This option is enabled by de- + 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, pattern matching does not take the - current locale's collating sequence into account, so bb - will not collate between AA and BB, and upper-case and + 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, pattern matching does not take the + current locale's collating sequence 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 ".". + 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 If set, shell error messages are written in the standard 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, the user is given - the opportunity to re-edit a failed history substitu- + If set, and rreeaaddlliinnee is being used, the user is given + the opportunity to re-edit a failed history substitu- tion. 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 + 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 + 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 posix mode 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 posix mode is enabled. iinntteerraaccttiivvee__ccoommmmeennttss - In an interactive shell, a word beginning with ## causes - that word and all remaining characters on that line to - be ignored, as in a non-interactive shell (see CCOOMMMMEENNTTSS + In an interactive shell, a word beginning with ## causes + that word and all remaining characters on that line to + be ignored, as in a non-interactive shell (see CCOOMMMMEENNTTSS above). 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 @@ -6658,37 +6676,37 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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 + 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 + 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, bbaasshh - displays the message "The mail in _m_a_i_l_f_i_l_e has been + If set, and a file that bbaasshh is checking for mail has + been accessed since the last time it was checked, bbaasshh + displays the message "The mail in _m_a_i_l_f_i_l_e has been read". nnoo__eemmppttyy__ccmmdd__ccoommpplleettiioonn If set, and rreeaaddlliinnee is being used, bbaasshh does not search - PPAATTHH for possible completions when completion is at- + PPAATTHH for possible completions when completion is at- tempted 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, pathname expansion patterns which match no files @@ -6696,73 +6714,73 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS removed, rather than expanding to 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 + 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, enable the programmable completion facilities + If set, enable the programmable completion facilities (see PPrrooggrraammmmaabbllee CCoommpplleettiioonn above). This option is en- abled by default. pprrooggccoommpp__aalliiaass - If set, and programmable completion is enabled, bbaasshh - treats a command name that doesn't have any completions + 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- + 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 + 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 when the --pp option is not supplied. This op- + find the directory containing the file supplied as an + argument when the --pp option is not supplied. This op- tion is enabled by default. vvaarrrreeddiirr__cclloossee - If set, the shell automatically closes file descriptors - assigned using the _{_v_a_r_n_a_m_e_} redirection syntax (see + If set, the shell automatically closes file descriptors + assigned using the _{_v_a_r_n_a_m_e_} redirection syntax (see RREEDDIIRREECCTTIIOONN 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 will 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 sup- + 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 will 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 sup- plied. 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 - operand 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 + operand 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 de- + 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. tteesstt uses operator precedence 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 normal operator precedence. _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. @@ -6779,110 +6797,110 @@ 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 + 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 + 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. If the first argument is exactly (( and the + the three-argument expression composed of the remaining + arguments. If the first argument is exactly (( and the fourth argument is exactly )), the result is the two-argu- - ment test of the second and third arguments. Otherwise, - the expression is parsed and evaluated according to + ment test of the second and third arguments. Otherwise, + the expression is parsed and evaluated according to precedence using the rules listed above. 5 or more arguments - The expression is parsed and evaluated according to + The expression is parsed and evaluated according to precedence using the rules listed above. When the shell is in posix mode, or if the expression is part of the [[[[ command, the << and >> operators sort using the current lo- - cale. If the shell is not in posix mode, the tteesstt and [[ com- + cale. If the shell is not in posix mode, the tteesstt and [[ com- mands sort lexicographically using ASCII ordering. - The historical operator-precedence parsing with 4 or more argu- - ments can lead to ambiguities when it encounters strings that - look like primaries. The POSIX standard has deprecated the --aa - and --oo primaries and enclosing expressions within parentheses. - Scripts should no longer use them. It's much more reliable to - restrict test invocations to a single primary, and to replace + The historical operator-precedence parsing with 4 or more argu- + ments can lead to ambiguities when it encounters strings that + look like primaries. The POSIX standard has deprecated the --aa + and --oo primaries and enclosing expressions within parentheses. + Scripts should no longer use them. It's much more reliable to + restrict test invocations to a single primary, and to replace uses of --aa and --oo with the shell's &&&& and |||| list operators. - ttiimmeess Print the accumulated user and system times for the shell and + ttiimmeess Print the accumulated user and system times for the shell and for processes run from the shell. The return status is 0. ttrraapp [--llppPP] [[_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 any of the signals _s_i_g_s_p_e_c. If _a_c_t_i_o_n is absent (and + receives any of the signals _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 _s_i_g_s_p_e_c is reset - to the value it had when the shell was started. 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 + to the value it had when the shell was started. 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 invokes. - 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 - displays the actions associated with each _s_i_g_s_p_e_c or, if none + 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 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 + 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 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. - The --ll option prints a list of signal names and their corre- - sponding numbers. Each _s_i_g_s_p_e_c is either a signal name defined + The --ll option prints a list of signal names and their corre- + sponding 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 insen- - sitive and the SSIIGG prefix is optional. If --ll is supplied with + sitive and the SSIIGG prefix is optional. If --ll is supplied with no _s_i_g_s_p_e_c arguments, it prints a list of valid signal names. - If a _s_i_g_s_p_e_c is EEXXIITT (0), _a_c_t_i_o_n is executed on exit from the - shell. If a _s_i_g_s_p_e_c is DDEEBBUUGG, _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 com- - mand, and before the first command executes in a shell function - (see SSHHEELLLL GGRRAAMMMMAARR above). Refer to the description of the - eexxttddeebbuugg shell option (see sshhoopptt above) for details of its ef- - fect on the DDEEBBUUGG trap. If a _s_i_g_s_p_e_c is RREETTUURRNN, _a_c_t_i_o_n is exe- + If a _s_i_g_s_p_e_c is EEXXIITT (0), _a_c_t_i_o_n is executed on exit from the + shell. If a _s_i_g_s_p_e_c is DDEEBBUUGG, _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 com- + mand, and before the first command executes in a shell function + (see SSHHEELLLL GGRRAAMMMMAARR above). Refer to the description of the + eexxttddeebbuugg shell option (see sshhoopptt above) for details of its ef- + fect on the DDEEBBUUGG trap. If a _s_i_g_s_p_e_c is RREETTUURRNN, _a_c_t_i_o_n is exe- cuted each time a shell function or a script executed with the .. or ssoouurrccee builtins finishes executing. - If a _s_i_g_s_p_e_c is EERRRR, _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 + If a _s_i_g_s_p_e_c is EERRRR, _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 failed command is part of the command list immediately following - a wwhhiillee or uunnttiill keyword, part of the test in an _i_f statement, + 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 (subject to the state of the ppiippeeffaaiill shell option), or if + following the final &&&& or ||||, any command in a pipeline but the + last (subject to the state of the ppiippeeffaaiill shell option), or if the command's return value is being inverted using !!. These are the same conditions obeyed by the eerrrreexxiitt (--ee) option. 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 - being ignored are reset to their original values in a subshell - or subshell environment when one is created. The return status + being ignored are reset to their original values in a subshell + 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. @@ -6891,61 +6909,61 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS 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 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 file, re- - spectively. If the _n_a_m_e is not found, ttyyppee prints nothing and + 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 file, re- + spectively. If the _n_a_m_e is not found, ttyyppee prints nothing and returns a non-zero exit status. - If the --pp option is used, ttyyppee either returns the pathname of - the executable file that would be found by searching $$PPAATTHH for + If the --pp option is used, ttyyppee either returns the pathname of + the executable file that would be found by searching $$PPAATTHH for _n_a_m_e or nothing if "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 + option forces a PPAATTHH search for each _n_a_m_e, even if "type -t name" would not return _f_i_l_e. If _n_a_m_e is present in the table of - hashed commands, --pp and --PP print the hashed value, which is not + hashed commands, --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, reserved - words, functions, and builtins, but the path search options (--pp - and --PP) can be supplied to restrict the output to executable - files. ttyyppee does not consult the table of hashed commands when + If the --aa option is used, ttyyppee prints all of the places that + contain a command named _n_a_m_e. This includes aliases, reserved + words, functions, and builtins, but the path search options (--pp + and --PP) can be supplied to restrict the output to executable + files. ttyyppee does not consult the table of hashed commands 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 ccoomm-- - mmaanndd builtin. ttyyppee returns true if all of the arguments are + mmaanndd builtin. ttyyppee returns true if all of the arguments are found, false if any are not found. uulliimmiitt [--HHSS] --aa uulliimmiitt [--HHSS] [--bbccddeeffiikkllmmnnppqqrrssttuuvvxxPPRRTT [_l_i_m_i_t]] - Provides control over the resources available to the shell and + Provides control over the resources available to the shell and to processes it starts, on systems that allow such control. - The --HH and --SS options specify whether the hard or soft limit is + The --HH and --SS options specify whether the hard or soft limit is set 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- + to the value of the hard limit. If neither --HH nor --SS is speci- fied, uulliimmiitt sets both the soft and hard limits. 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, respectively. If _l_i_m_i_t is omitted, uulliimmiitt prints - the current value of the soft limit of the resource, unless the - --HH option is given. When more than one resource is specified, - the limit name and unit, if appropriate, are printed before 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, respectively. If _l_i_m_i_t is omitted, uulliimmiitt prints + the current value of the soft limit of the resource, 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 options are interpreted as follows: --aa Report all current limits; no limits are set. --bb The maximum socket buffer size. --cc The maximum size of core files created. --dd The maximum size of a process's data segment. --ee The maximum scheduling priority ("nice"). - --ff The maximum size of files written by the shell and its + --ff The maximum size of files written by the shell and its children. --ii The maximum number of pending signals. --kk The maximum number of kqueues that may be allocated. --ll The maximum size that may be locked into memory. - --mm The maximum resident set size (many systems do not honor + --mm The maximum resident set size (many systems do not honor this limit). --nn The maximum number of open file descriptors (most systems do not allow this value to be set). @@ -6954,146 +6972,146 @@ SSHHEELLLL BBUUIILLTTIINN CCOOMMMMAANNDDSS --rr The maximum real-time scheduling priority. --ss The maximum stack size. --tt The maximum amount of cpu time in seconds. - --uu The maximum number of processes available to a single + --uu The maximum number of processes available to a single user. - --vv The maximum amount of virtual memory available to the + --vv The maximum amount of virtual memory available to the shell and, on some systems, to its children. --xx The maximum number of file locks. --PP The maximum number of pseudoterminals. - --RR The maximum time a real-time process can run before + --RR The maximum time a real-time process can run before blocking, in microseconds. --TT The maximum number of threads. - If _l_i_m_i_t is supplied, and the --aa option is not used, _l_i_m_i_t is - the new value of the specified resource. If no option is sup- + If _l_i_m_i_t is supplied, and the --aa option is not used, _l_i_m_i_t is + the new value of the specified resource. If no option is sup- plied, 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 + 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] - Set the user file-creation mask to _m_o_d_e. If _m_o_d_e begins with a + Set the user file-creation mask to _m_o_d_e. If _m_o_d_e begins with a digit, it is interpreted as an octal number; otherwise it is in- - terpreted as a symbolic mode mask similar to that accepted by + terpreted as a symbolic mode mask similar to that accepted by _c_h_m_o_d(1). If _m_o_d_e is omitted, uummaasskk prints the current value of the mask. The --SS option without a _m_o_d_e argument prints the mask in a symbolic format; 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 zero - if the mode was successfully changed or if no _m_o_d_e argument was + a form that may be reused as input. The return status is zero + if the mode was successfully changed or if no _m_o_d_e argument was supplied, and non-zero otherwise. uunnaalliiaass [-aa] [_n_a_m_e ...] - Remove each _n_a_m_e from the list of defined aliases. If --aa is - supplied, remove all alias definitions. The return value is + Remove each _n_a_m_e from the list of defined aliases. If --aa is + supplied, remove all alias definitions. 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. + 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. If --ff is specified, each _n_a_m_e - refers to a shell function, and the function definition is re- - moved. 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. Read-only variables and functions may not be unset. - When variables or functions are removed, they are also removed - from the environment passed to subsequent commands. If no op- - tions 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. Some shell variables may not be unset. If any of + and that variable is removed. If --ff is specified, each _n_a_m_e + refers to a shell function, and the function definition is re- + moved. 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. Read-only variables and functions may not be unset. + When variables or functions are removed, they are also removed + from the environment passed to subsequent commands. If no op- + tions 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. Some shell variables may not be unset. If any of BBAASSHH__AALLIIAASSEESS, BBAASSHH__AARRGGVV00, BBAASSHH__CCMMDDSS, BBAASSHH__CCOOMMMMAANNDD, BBAASSHH__SSUUBB-- - SSHHEELLLL, BBAASSHHPPIIDD, CCOOMMPP__WWOORRDDBBRREEAAKKSS, DDIIRRSSTTAACCKK, EEPPOOCCHHRREEAALLTTIIMMEE, - EEPPOOCCHHSSEECCOONNDDSS, FFUUNNCCNNAAMMEE, GGRROOUUPPSS, HHIISSTTCCMMDD, LLIINNEENNOO, RRAANNDDOOMM, SSEECC-- - OONNDDSS, or SSRRAANNDDOOMM are unset, they lose their special properties, - even if they are subsequently reset. The exit status is true + SSHHEELLLL, BBAASSHHPPIIDD, CCOOMMPP__WWOORRDDBBRREEAAKKSS, DDIIRRSSTTAACCKK, EEPPOOCCHHRREEAALLTTIIMMEE, + EEPPOOCCHHSSEECCOONNDDSS, FFUUNNCCNNAAMMEE, GGRROOUUPPSS, HHIISSTTCCMMDD, LLIINNEENNOO, RRAANNDDOOMM, SSEECC-- + OONNDDSS, or SSRRAANNDDOOMM are unset, they lose their special properties, + even if they are subsequently reset. The exit status is true unless a _n_a_m_e is readonly or may not be unset. wwaaiitt [--ffnn] [--pp _v_a_r_n_a_m_e] [_i_d ...] Wait for each specified child process _i_d and return the termina- - tion status of the last _i_d. Each _i_d may be a process ID _p_i_d or - a job specification _j_o_b_s_p_e_c; if a jobspec is supplied, wwaaiitt + tion status of the last _i_d. Each _i_d may be a process ID _p_i_d or + a job specification _j_o_b_s_p_e_c; if a jobspec is supplied, wwaaiitt waits for all processes in the job. - If no options or _i_ds are supplied, wwaaiitt waits for all running - background jobs and the last-executed process substitution, if + If no options or _i_ds are supplied, 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 any one of the + If the --nn option is supplied, wwaaiitt waits for any one of the given _i_ds or, if no _i_ds are supplied, any job or process substi- tution, to complete and returns its exit status. If none of the - supplied _i_ds is a child of the shell, or if no _i_ds are supplied - and the shell has no unwaited-for children, the exit status is + supplied _i_ds is a child of the shell, or if no _i_ds are supplied + and the shell has no unwaited-for children, the exit status is 127. - If the --pp option is supplied, wwaaiitt assigns the process or job - identifier of the job for which the exit status is returned to - the variable _v_a_r_n_a_m_e named by the option argument. The vari- - able, which cannot be readonly, will be unset initially, before - any assignment. This is useful only when used with the --nn op- + If the --pp option is supplied, wwaaiitt assigns the process or job + identifier of the job for which the exit status is returned to + the variable _v_a_r_n_a_m_e named by the option argument. The vari- + able, which cannot be readonly, will be unset initially, before + any assignment. This is useful only when used with the --nn op- tion. - Supplying the --ff option, when job control is enabled, forces - wwaaiitt to wait for each _i_d to terminate before returning its sta- + Supplying the --ff option, when job control is enabled, forces + wwaaiitt to wait for each _i_d to terminate before returning its sta- tus, instead of returning when it changes status. - If none of the _i_ds specify one of the shell's active child - processes, the return status is 127. If wwaaiitt is interrupted by - a signal, any _v_a_r_n_a_m_e will remain unset, and the return status - will be greater than 128, as described under SSIIGGNNAALLSS above. + If none of the _i_ds specify one of the shell's active child + processes, the return status is 127. If wwaaiitt is interrupted by + a signal, any _v_a_r_n_a_m_e will remain unset, and the return status + will be greater than 128, as described under SSIIGGNNAALLSS above. Otherwise, the return status is the exit status of the last _i_d. 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- + 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, ccoomm-- - ppaatt4400, ccoommppaatt4411, and so on). There is only one current compatibility + ppaatt4400, 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- + 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. - This section does not mention behavior that is standard for a particu- - lar version (e.g., setting ccoommppaatt3322 means that quoting the right hand - side of the regexp matching operator quotes special regexp characters - in the word, which is default behavior in bash-3.2 and subsequent ver- + This section does not mention behavior that is standard for a particu- + lar version (e.g., setting ccoommppaatt3322 means that quoting the right hand + side of the regexp matching operator quotes special regexp characters + in the word, which is default behavior in bash-3.2 and subsequent ver- sions). - 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- - based comparisons with the [[[[ command came in bash-4.1, and earlier + 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- + 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 suffi- - cient for all uses, and as a result users should employ compatibility - levels carefully. Read the documentation for a particular feature to + 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- + ger corresponding to the ccoommppaatt_N_N option, like 42) determines the com- patibility level. Starting with bash-4.4, bbaasshh began deprecating older compatibility lev- els. Eventually, the options will be removed in favor of BBAASSHH__CCOOMMPPAATT. - Bash-5.0 was the final version for which there was an individual shopt - option for the previous version. BBAASSHH__CCOOMMPPAATT is the only mechanism to + Bash-5.0 was the final version for which there was an individual shopt + option for the previous version. BBAASSHH__CCOOMMPPAATT is the only mechanism to control the compatibility level in versions newer than bash-5.0. - The following table describes the behavior changes controlled by each + The following table describes the behavior changes controlled by each 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 - later versions, the BBAASSHH__CCOOMMPPAATT variable is preferred, and it is re- + 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. ccoommppaatt3311 @@ -7101,173 +7119,173 @@ SSHHEELLLL CCOOMMPPAATTIIBBIILLIITTYY MMOODDEE ator (=~) has no special effect. ccoommppaatt3322 - +o The << and >> operators to the [[[[ command do not consider + +o The << and >> operators to the [[[[ command do not consider the current locale when comparing strings; they use ASCII ordering. ccoommppaatt4400 - +o The << and >> operators to the [[[[ command do not consider + +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- - lation and _s_t_r_c_m_p(3); bash-4.1 and later use the current + 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). ccoommppaatt4411 - +o In _p_o_s_i_x mode, ttiimmee may be followed by options and still + +o In _p_o_s_i_x mode, ttiimmee may be followed by options and still be recognized as a reserved word (this is POSIX interpre- tation 267). +o In _p_o_s_i_x mode, the parser requires that an even number of - single quotes occur in the _w_o_r_d portion of a double- - quoted parameter expansion and treats them specially, so - that characters within the single quotes are considered + single quotes occur in the _w_o_r_d portion of a double- + quoted parameter expansion and treats them specially, so + that characters within the single quotes are considered quoted (this is POSIX interpretation 221). ccoommppaatt4422 +o The replacement string in double-quoted pattern substitu- - tion does not undergo quote removal, as it does in ver- + tion does not undergo quote removal, as it does in ver- sions after bash-4.2. - +o In posix mode, single quotes are considered special when - expanding the _w_o_r_d portion of a double-quoted parameter - expansion and can be used to quote a closing brace or - other special character (this is part of POSIX interpre- - tation 221); in later versions, single quotes are not + +o In posix mode, single quotes are considered special when + expanding the _w_o_r_d portion of a double-quoted parameter + expansion and can be used to quote a closing brace or + other special character (this is part of POSIX interpre- + tation 221); in later versions, single quotes are not special within double-quoted word expansions. ccoommppaatt4433 - +o Word expansion errors are considered non-fatal errors - that cause the current command to fail, even in posix - mode (the default behavior is to make them fatal errors + +o Word expansion errors are considered non-fatal errors + that cause the current command to fail, even in posix + 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 + +o When executing a shell function, the loop state (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. ccoommppaatt4444 - +o The shell sets up the values used by BBAASSHH__AARRGGVV and - BBAASSHH__AARRGGCC so they can expand to the shell's positional - parameters even if extended debugging mode is not en- + +o The shell sets up the values used by BBAASSHH__AARRGGVV and + BBAASSHH__AARRGGCC so they can expand to the shell's positional + parameters even if extended debugging mode is not en- abled. - +o A subshell inherits loops from its parent context, so - bbrreeaakk or ccoonnttiinnuuee will cause the subshell to exit. - Bash-5.0 and later reset the loop state to prevent the + +o A subshell inherits loops from its parent context, so + bbrreeaakk or ccoonnttiinnuuee will cause the subshell to exit. + Bash-5.0 and later reset the loop state to prevent the exit - +o Variable assignments preceding builtins like eexxppoorrtt and + +o Variable assignments preceding builtins like eexxppoorrtt and rreeaaddoonnllyy that set attributes continue to affect variables with the same name in the calling environment even if the shell is not in posix mode. ccoommppaatt5500 - +o Bash-5.1 changed the way $$RRAANNDDOOMM is generated to intro- - duce slightly more randomness. If the shell compatibil- + +o Bash-5.1 changed the way $$RRAANNDDOOMM is generated to intro- + duce slightly more randomness. If the shell compatibil- ity level is set to 50 or lower, it reverts to the method - from bash-5.0 and previous versions, so seeding the ran- - dom number generator by assigning a value to RRAANNDDOOMM will + from bash-5.0 and previous versions, so seeding the ran- + dom number generator by assigning a value to RRAANNDDOOMM will produce the same sequence as in bash-5.0. - +o If the command hash table is empty, bash versions prior - to bash-5.1 printed an informational message to that ef- - fect, even when producing output that can be reused as - input. Bash-5.1 suppresses that message when the --ll op- + +o If the command hash table is empty, bash versions prior + to bash-5.1 printed an informational message to that ef- + fect, even when producing output that can be reused as + input. Bash-5.1 suppresses that message when the --ll op- tion is supplied. ccoommppaatt5511 - +o The uunnsseett builtin treats attempts to unset array sub- - scripts @@ and ** differently depending on whether the ar- - ray is indexed or associative, and differently than in + +o The uunnsseett builtin treats attempts to unset array sub- + scripts @@ and ** differently depending on whether the ar- + ray is indexed or associative, and differently than in previous versions. +o Arithmetic commands ( ((((...)))) ) and the expressions in an arithmetic for statement can be expanded more than once. - +o Expressions used as arguments to arithmetic operators in - the [[[[ conditional command can be expanded more than + +o Expressions used as arguments to arithmetic operators in + the [[[[ conditional command can be expanded more than once. - +o The expressions in substring parameter brace expansion + +o The expressions in substring parameter brace expansion can be expanded more than once. +o The expressions in the $$((((...)))) word expansion can be ex- panded more than once. - +o Arithmetic expressions used as indexed array subscripts + +o Arithmetic expressions used as indexed array subscripts can be expanded more than once. - +o tteesstt --vv, when given an argument of AA[[@@]], where AA is an + +o tteesstt --vv, when given an argument of AA[[@@]], where AA is an existing associative array, will return true if the array - has any set elements. Bash-5.2 will look for and report + has any set elements. Bash-5.2 will look for and report on a key named @@. +o 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 + _v_a_l_u_e, before any variable-specific transformations have 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 + +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- + 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 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- + 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. ccoommppaatt5522 - +o The tteesstt builtin uses its historical algorithm to parse - parenthesized subexpressions when given five or more ar- + +o The tteesstt builtin uses its historical algorithm to parse + parenthesized subexpressions when given five or more ar- guments. - +o If the --pp or --PP option is supplied to the bbiinndd builtin, + +o If the --pp or --PP option is supplied to the bbiinndd builtin, bbiinndd treats any arguments remaining after option process- - ing as bindable command names, and displays any key se- - quences bound to those commands, instead of treating the + ing as bindable command names, and displays any key se- + quences bound to those commands, instead of treating the arguments as key sequences to bind. RREESSTTRRIICCTTEEDD SSHHEELLLL If bbaasshh is started with the name rrbbaasshh, or the --rr option is supplied at - invocation, the shell becomes _r_e_s_t_r_i_c_t_e_d. 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 + invocation, the shell becomes _r_e_s_t_r_i_c_t_e_d. 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. - +o Setting or unsetting the values of SSHHEELLLL, PPAATTHH, HHIISSTTFFIILLEE, EENNVV, + +o Setting or unsetting the values of SSHHEELLLL, PPAATTHH, HHIISSTTFFIILLEE, EENNVV, or BBAASSHH__EENNVV. +o Specifying command names containing //. - +o Specifying a filename containing a // as an argument to the .. + +o Specifying a filename containing a // as an argument to the .. builtin command. - +o Using the --pp option to the .. builtin command to specify a + +o Using the --pp option to the .. builtin command to specify a search path. - +o Specifying a filename containing a slash as an argument to the + +o Specifying a filename containing a slash as an argument to the hhiissttoorryy builtin command. - +o Specifying a filename containing a slash as an argument to the + +o Specifying a filename containing a slash as an argument to the --pp option to the hhaasshh builtin command. - +o Importing function definitions from the shell environment at + +o Importing function definitions from the shell environment at startup. - +o Parsing the value of SSHHEELLLLOOPPTTSS from the shell environment at + +o Parsing the value of SSHHEELLLLOOPPTTSS from the shell environment at startup. - +o Redirecting output using the >, >|, <>, >&, &>, and >> redirec- + +o Redirecting output using the >, >|, <>, >&, &>, and >> redirec- tion operators. +o Using the eexxeecc builtin command to replace the shell with another command. - +o Adding or deleting builtin commands with the --ff and --dd options + +o Adding or deleting builtin commands with the --ff and --dd options to the eennaabbllee builtin command. - +o Using the eennaabbllee builtin command to enable disabled shell + +o Using the eennaabbllee builtin command to enable disabled shell builtins. +o Specifying the --pp option to the ccoommmmaanndd builtin command. - +o Turning off restricted mode with sseett ++rr or sshhoopptt --uu rree-- + +o Turning off restricted mode with sseett ++rr or sshhoopptt --uu rree-- ssttrriicctteedd__sshheellll. These restrictions are enforced after any startup files are read. When a command that is found to be a shell script is executed (see CCOOMM-- - MMAANNDD EEXXEECCUUTTIIOONN above), rrbbaasshh turns off any restrictions in the shell + MMAANNDD EEXXEECCUUTTIIOONN above), rrbbaasshh turns off any restrictions in the shell spawned to execute the script. SSEEEE AALLSSOO @@ -7292,10 +7310,10 @@ FFIILLEESS _~_/_._b_a_s_h_r_c The individual per-interactive-shell startup file _~_/_._b_a_s_h___l_o_g_o_u_t - The individual login shell cleanup file, executed when a login + The individual login shell cleanup file, executed when a login shell exits _~_/_._b_a_s_h___h_i_s_t_o_r_y - The default value of HHIISSTTFFIILLEE, the file in which bash saves the + The default value of HHIISSTTFFIILLEE, the file in which bash saves the command history _~_/_._i_n_p_u_t_r_c Individual _r_e_a_d_l_i_n_e initialization file @@ -7309,15 +7327,15 @@ AAUUTTHHOORRSS BBUUGG RREEPPOORRTTSS 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 + 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 _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 + 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! You may send suggestions and "philosophical" bug - reports to _b_u_g_-_b_a_s_h_@_g_n_u_._o_r_g or post them to the Usenet newsgroup + reports to _b_u_g_-_b_a_s_h_@_g_n_u_._o_r_g or post them to the Usenet newsgroup ggnnuu..bbaasshh..bbuugg. ALL bug reports should include: @@ -7328,7 +7346,7 @@ BBUUGG RREEPPOORRTTSS A description of the bug behaviour A short script or "recipe" which exercises the bug - _b_a_s_h_b_u_g inserts the first three items automatically into the template + _b_a_s_h_b_u_g inserts the first three items automatically into the template it provides for filing a bug report. Comments and bug reports concerning this manual page should be directed @@ -7345,13 +7363,13 @@ 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 sequence. It suffices to place the sequence of commands between - parentheses to force it into a subshell, which may be stopped as a - unit, or to start the command in the background and immediately bring + 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, or to start the command in the background and immediately bring it into the foreground. Array variables may not (yet) be exported. -GNU Bash 5.3 2024 October 20 _B_A_S_H(1) +GNU Bash 5.3 2024 October 23 _B_A_S_H(1) diff --git a/doc/bash.1 b/doc/bash.1 index fe44b678..c84836e6 100644 --- a/doc/bash.1 +++ b/doc/bash.1 @@ -5,14 +5,14 @@ .\" Case Western Reserve University .\" chet.ramey@case.edu .\" -.\" Last Change: Sun Oct 20 12:31:15 EDT 2024 +.\" Last Change: Wed Oct 23 11:32:05 EDT 2024 .\" .\" bash_builtins, strip all but Built-Ins section .\" avoid a warning about an undefined register .\" .if !rzY .nr zY 0 .if \n(zZ=1 .ig zZ .if \n(zY=1 .ig zY -.TH BASH 1 "2024 October 20" "GNU Bash 5.3" +.TH BASH 1 "2024 October 23" "GNU Bash 5.3" .\" .ie \n(.g \{\ .ds ' \(aq @@ -5791,8 +5791,8 @@ sends a to all jobs when an interactive login shell exits. .PP If \fBbash\fP 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 command completes. +for which a trap has been set, +it will not execute the trap until the command completes. If \fBbash\fP is waiting for an asynchronous command via the \fBwait\fP builtin, and it receives a signal for which a trap has been set, @@ -5811,12 +5811,21 @@ same process group as the terminal, and \fB\*^C\fP sends .SM .B SIGINT to all processes in that process group. +Since \fBbash\fP does not enable job control by default when the +shell is not interactive, +this scenario is most common in non-interactive shells. +.PP +When job control is enabled, and \fBbash\fP is waiting for a foreground +command to complete, the shell does not receive keyboard-generated +signals, because it is not in the same process group as the terminal. +This scenario is most common in interactive shells, where \fBbash\fP +attempts to enable job control by default. See .SM .B "JOB CONTROL" below for more information about process groups. .PP -When \fBbash\fP is running without job control enabled and receives +When job control is not enabled, and \fBbash\fP receives .SM .B SIGINT while waiting for a foreground command, it waits until that foreground @@ -5828,13 +5837,18 @@ If the command terminates due to the .SM .BR SIGINT , \fBbash\fP concludes -that the user meant to end the entire script, and acts on the +that the user meant to send the +.SM +.B SIGINT +to the shell as well, and acts on the .SM .B SIGINT (e.g., by running a .SM .B SIGINT -trap or exiting itself); +trap, +exiting a non-interactive shell, +or returning to the top level to read a new command). .IP 2. If the command does not terminate due to .SM @@ -5859,6 +5873,25 @@ trap set on as it does with any other trapped signal it receives while it is waiting for the foreground command to complete, for compatibility. +.PP +When job control is enabled, \fBbash\fP does not receive keyboard-generated +signals such as +.SM +.B SIGINT +while it is waiting for a foreground command. +An interactive shell does not pay attention to the +.SM +.BR SIGINT , +even if the foreground command terminates as a result, other than noting +its exit status. +If the shell is not interactive, and +the foreground command terminates due to the +.SM +.BR SIGINT , +\fBbash\fP pretends it received the +.SM +.B SIGINT +itself (scenario 1 above), for compatibility. .SH "JOB CONTROL" .I Job control refers to the ability to selectively stop (\fIsuspend\fP) diff --git a/doc/bash.info b/doc/bash.info index 78e82a9a..743a2007 100644 --- a/doc/bash.info +++ b/doc/bash.info @@ -1,9 +1,9 @@ This is bash.info, produced by makeinfo version 7.1 from bashref.texi. This text is a brief description of the features that are present in the -Bash shell (version 5.3, 20 October 2024). +Bash shell (version 5.3, 23 October 2024). - This is Edition 5.3, last updated 20 October 2024, of ‘The GNU Bash + This is Edition 5.3, last updated 23 October 2024, of ‘The GNU Bash Reference Manual’, for ‘Bash’, Version 5.3. Copyright © 1988-2024 Free Software Foundation, Inc. @@ -26,10 +26,10 @@ Bash Features ************* This text is a brief description of the features that are present in the -Bash shell (version 5.3, 20 October 2024). The Bash home page is +Bash shell (version 5.3, 23 October 2024). The Bash home page is . - This is Edition 5.3, last updated 20 October 2024, of ‘The GNU Bash + This is Edition 5.3, last updated 23 October 2024, of ‘The GNU Bash Reference Manual’, for ‘Bash’, Version 5.3. Bash contains features that appear in other popular shells, and some @@ -3222,7 +3222,7 @@ Shopt Builtin::), Bash sends a ‘SIGHUP’ to all jobs when an interactive login shell exits. If Bash 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 +for which a trap has been set, it will not execute the trap until the command completes. If Bash is waiting for an asynchronous command via the ‘wait’ builtin, and it receives a signal for which a trap has been set, the ‘wait’ builtin will return immediately with an exit status @@ -3233,19 +3233,28 @@ command to complete, the shell receives keyboard-generated signals such as ‘SIGINT’ (usually generated by ‘^C’) 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 ‘^C’ sends ‘SIGINT’ -to all processes in that process group. See *note Job Control::, for a -more in-depth discussion of process groups. +to all processes in that process group. Since Bash does not enable job +control by default when the shell is not interactive, this scenario is +most common in non-interactive shells. - When Bash is running without job control enabled and receives -‘SIGINT’ while waiting for a foreground command, it waits until that -foreground command terminates and then decides what to do about the -‘SIGINT’: + When job control is enabled, and Bash is waiting for a foreground +command to complete, the shell does not receive keyboard-generated +signals, because it is not in the same process group as the terminal. +This scenario is most common in interactive shells, where Bash attempts +to enable job control by default. See *note Job Control::, for a more +in-depth discussion of process groups. + + When job control is not enabled, and Bash receives ‘SIGINT’ while +waiting for a foreground command, it waits until that foreground command +terminates and then decides what to do about the ‘SIGINT’: 1. If the command terminates due to the ‘SIGINT’, Bash concludes that - the user meant to end the entire script, and acts on the ‘SIGINT’ - (e.g., by running a ‘SIGINT’ trap or exiting itself); + the user meant to send the ‘SIGINT’ to the shell as well, and acts + on the ‘SIGINT’ (e.g., by running a ‘SIGINT’ trap, exiting a + non-interactive shell, or returning to the top level to read a new + command). - 2. If the pipeline does not terminate due to ‘SIGINT’, the program + 2. If the command does not terminate due to ‘SIGINT’, the program handled the ‘SIGINT’ itself and did not treat it as a fatal signal. In that case, Bash does not treat ‘SIGINT’ as a fatal signal, either, instead assuming that the ‘SIGINT’ was used as part of the @@ -3255,6 +3264,14 @@ foreground command terminates and then decides what to do about the receives while it is waiting for the foreground command to complete, for compatibility. + When job control is enabled, Bash does not receive keyboard-generated +signals such as ‘SIGINT’ while it is waiting for a foreground command. +An interactive shell does not pay attention to the ‘SIGINT’, even if the +foreground command terminates as a result, other than noting its exit +status. If the shell is not interactive, and the foreground command +terminates due to the ‘SIGINT’, Bash pretends it received the ‘SIGINT’ +itself (scenario 1 above), for compatibility. +  File: bash.info, Node: Shell Scripts, Prev: Executing Commands, Up: Basic Shell Features @@ -7610,116 +7627,111 @@ startup files. 10. Redirection operators do not perform word splitting on the word in a redirection. - 11. Function names must be valid shell ‘name’s. That is, they may not - contain characters other than letters, digits, and underscores, and - may not start with a digit. Declaring a function with an invalid - name in a non-interactive shell is a fatal syntax error. - - 12. Function names may not be the same as one of the POSIX special + 11. Function names may not be the same as one of the POSIX special builtins. - 13. Tilde expansion is only performed on assignments preceding a + 12. Tilde expansion is only performed on assignments preceding a command name, rather than on all assignment statements on the line. - 14. While variable indirection is available, it may not be applied to + 13. While variable indirection is available, it may not be applied to the ‘#’ and ‘?’ special parameters. - 15. Expanding the ‘*’ special parameter in a pattern context where the + 14. Expanding the ‘*’ special parameter in a pattern context where the expansion is double-quoted does not treat the ‘$*’ as if it were double-quoted. - 16. A double quote character (‘"’) is treated specially when it + 15. A double quote character (‘"’) is treated specially when it appears in a backquoted command substitution in the body of a here-document that undergoes expansion. That means, for example, that a backslash preceding a double quote character will escape it and the backslash will be removed. - 17. Command substitutions don't set the ‘?’ special parameter. The + 16. Command substitutions don't set the ‘?’ special parameter. The exit status of a simple command without a command word is still the exit status of the last command substitution that occurred while evaluating the variable assignments and redirections in that command, but that does not happen until after all of the assignments and redirections. - 18. Literal tildes that appear as the first character in elements of + 17. Literal tildes that appear as the first character in elements of the ‘PATH’ variable are not expanded as described above under *note Tilde Expansion::. - 19. Command lookup finds POSIX special builtins before shell + 18. Command lookup finds POSIX special builtins before shell functions, including output printed by the ‘type’ and ‘command’ builtins. - 20. Even if a shell function whose name contains a slash was defined + 19. Even if a shell function whose name contains a slash was defined before entering POSIX mode, the shell will not execute a function whose name contains one or more slashes. - 21. When a command in the hash table no longer exists, Bash will + 20. When a command in the hash table no longer exists, Bash will re-search ‘$PATH’ to find the new location. This is also available with ‘shopt -s checkhash’. - 22. Bash will not insert a command without the execute bit set into + 21. Bash will not insert a command without the execute bit set into the command hash table, even if it returns it as a (last-ditch) result from a ‘$PATH’ search. - 23. The message printed by the job control code and builtins when a + 22. The message printed by the job control code and builtins when a job exits with a non-zero status is 'Done(status)'. - 24. The message printed by the job control code and builtins when a + 23. The message printed by the job control code and builtins when a job is stopped is 'Stopped(SIGNAME)', where SIGNAME is, for example, ‘SIGTSTP’. - 25. If the shell is interactive, Bash does not perform job + 24. If the shell is interactive, Bash does not perform job notifications between executing commands in lists separated by ‘;’ or newline. Non-interactive shells print status messages after a foreground job in a list completes. - 26. If the shell is interactive, Bash waits until the next prompt + 25. If the shell is interactive, Bash waits until the next prompt before printing the status of a background job that changes status or a foreground job that terminates due to a signal. Non-interactive shells print status messages after a foreground job completes. - 27. Bash permanently removes jobs from the jobs table after notifying + 26. Bash permanently removes jobs from the jobs table after notifying the user of their termination via the ‘wait’ or ‘jobs’ builtins. It removes the job from the jobs list after notifying the user of its termination, but the status is still available via ‘wait’, as long as ‘wait’ is supplied a PID argument. - 28. The ‘vi’ editing mode will invoke the ‘vi’ editor directly when + 27. The ‘vi’ editing mode will invoke the ‘vi’ editor directly when the ‘v’ command is run, instead of checking ‘$VISUAL’ and ‘$EDITOR’. - 29. Prompt expansion enables the POSIX ‘PS1’ and ‘PS2’ expansions of + 28. Prompt expansion enables the POSIX ‘PS1’ and ‘PS2’ expansions of ‘!’ to the history number and ‘!!’ to ‘!’, and Bash performs parameter expansion on the values of ‘PS1’ and ‘PS2’ regardless of the setting of the ‘promptvars’ option. - 30. The default history file is ‘~/.sh_history’ (this is the default + 29. The default history file is ‘~/.sh_history’ (this is the default value the shell assigns to ‘$HISTFILE’). - 31. The ‘!’ character does not introduce history expansion within a + 30. The ‘!’ character does not introduce history expansion within a double-quoted string, even if the ‘histexpand’ option is enabled. - 32. When printing shell function definitions (e.g., by ‘type’), Bash - does not print the ‘function’ keyword. + 31. When printing shell function definitions (e.g., by ‘type’), Bash + does not print the ‘function’ keyword unless necessary. - 33. Non-interactive shells exit if a syntax error in an arithmetic + 32. Non-interactive shells exit if a syntax error in an arithmetic expansion results in an invalid expression. - 34. Non-interactive shells exit if a parameter expansion error occurs. + 33. Non-interactive shells exit if a parameter expansion error occurs. - 35. If a POSIX special builtin returns an error status, a + 34. If a POSIX special builtin returns an error status, a non-interactive shell exits. The fatal errors are those listed in the POSIX standard, and include things like passing incorrect options, redirection errors, variable assignment errors for assignments preceding the command name, and so on. - 36. A non-interactive shell exits with an error status if a variable + 35. A non-interactive shell exits with an error status if a variable assignment error occurs when no command name follows the assignment statements. A variable assignment error occurs, for example, when trying to assign a value to a readonly variable. - 37. A non-interactive shell exits with an error status if a variable + 36. A non-interactive shell exits with an error status if a variable assignment error occurs in an assignment statement preceding a special builtin, but not with any other simple command. For any other simple command, the shell aborts execution of that command, @@ -7727,155 +7739,155 @@ startup files. perform any further processing of the command in which the error occurred"). - 38. A non-interactive shell exits with an error status if the + 37. A non-interactive shell exits with an error status if the iteration variable in a ‘for’ statement or the selection variable in a ‘select’ statement is a readonly variable or has an invalid name. - 39. Non-interactive shells exit if FILENAME in ‘.’ FILENAME is not + 38. Non-interactive shells exit if FILENAME in ‘.’ FILENAME is not found. - 40. Non-interactive shells exit if there is a syntax error in a script + 39. Non-interactive shells exit if there is a syntax error in a script read with the ‘.’ or ‘source’ builtins, or in a string processed by the ‘eval’ builtin. - 41. Non-interactive shells exit if the ‘export’, ‘readonly’ or ‘unset’ + 40. Non-interactive shells exit if the ‘export’, ‘readonly’ or ‘unset’ builtin commands get an argument that is not a valid identifier, and they are not operating on shell functions. These errors force an exit because these are special builtins. - 42. Assignment statements preceding POSIX special builtins persist in + 41. Assignment statements preceding POSIX special builtins persist in the shell environment after the builtin completes. - 43. The ‘command’ builtin does not prevent builtins that take + 42. The ‘command’ builtin does not prevent builtins that take assignment statements as arguments from expanding them as assignment statements; when not in POSIX mode, declaration commands lose their assignment statement expansion properties when preceded by ‘command’. - 44. Enabling POSIX mode has the effect of setting the + 43. Enabling POSIX mode has the effect of setting the ‘inherit_errexit’ option, so subshells spawned to execute command substitutions inherit the value of the ‘-e’ option from the parent shell. When the ‘inherit_errexit’ option is not enabled, Bash clears the ‘-e’ option in such subshells. - 45. Enabling POSIX mode has the effect of setting the ‘shift_verbose’ + 44. Enabling POSIX mode has the effect of setting the ‘shift_verbose’ option, so numeric arguments to ‘shift’ that exceed the number of positional parameters will result in an error message. - 46. Enabling POSIX mode has the effect of setting the + 45. Enabling POSIX mode has the effect of setting the ‘interactive_comments’ option (*note Comments::). - 47. The ‘.’ and ‘source’ builtins do not search the current directory + 46. The ‘.’ and ‘source’ builtins do not search the current directory for the filename argument if it is not found by searching ‘PATH’. - 48. When the ‘alias’ builtin displays alias definitions, it does not + 47. When the ‘alias’ builtin displays alias definitions, it does not display them with a leading ‘alias ’ unless the ‘-p’ option is supplied. - 49. The ‘bg’ builtin uses the required format to describe each job + 48. The ‘bg’ builtin uses the required format to describe each job placed in the background, which does not include an indication of whether the job is the current or previous job. - 50. When the ‘cd’ builtin is invoked in logical mode, and the pathname + 49. When the ‘cd’ builtin is invoked in logical mode, and the pathname constructed from ‘$PWD’ and the directory name supplied as an argument does not refer to an existing directory, ‘cd’ will fail instead of falling back to physical mode. - 51. When the ‘cd’ builtin cannot change a directory because the length + 50. When the ‘cd’ builtin cannot change a directory because the length of the pathname constructed from ‘$PWD’ and the directory name supplied as an argument exceeds ‘PATH_MAX’ when canonicalized, ‘cd’ will attempt to use the supplied directory name. - 52. When the ‘xpg_echo’ option is enabled, Bash does not attempt to + 51. When the ‘xpg_echo’ option is enabled, Bash does not attempt to interpret any arguments to ‘echo’ as options. ‘echo’ displays each argument after converting escape sequences. - 53. The ‘export’ and ‘readonly’ builtin commands display their output + 52. The ‘export’ and ‘readonly’ builtin commands display their output in the format required by POSIX. - 54. When listing the history, the ‘fc’ builtin does not include an + 53. When listing the history, the ‘fc’ builtin does not include an indication of whether or not a history entry has been modified. - 55. The default editor used by ‘fc’ is ‘ed’. + 54. The default editor used by ‘fc’ is ‘ed’. - 56. ‘fc’ treats extra arguments as an error instead of ignoring them. + 55. ‘fc’ treats extra arguments as an error instead of ignoring them. - 57. If there are too many arguments supplied to ‘fc -s’, ‘fc’ prints + 56. If there are too many arguments supplied to ‘fc -s’, ‘fc’ prints an error message and returns failure. - 58. The output of ‘kill -l’ prints all the signal names on a single + 57. The output of ‘kill -l’ prints all the signal names on a single line, separated by spaces, without the ‘SIG’ prefix. - 59. The ‘kill’ builtin does not accept signal names with a ‘SIG’ + 58. The ‘kill’ builtin does not accept signal names with a ‘SIG’ prefix. - 60. The ‘printf’ builtin uses ‘double’ (via ‘strtod’) to convert + 59. The ‘printf’ builtin uses ‘double’ (via ‘strtod’) to convert arguments corresponding to floating point conversion specifiers, instead of ‘long double’ if it's available. The ‘L’ length modifier forces ‘printf’ to use ‘long double’ if it's available. - 61. The ‘pwd’ builtin verifies that the value it prints is the same as + 60. The ‘pwd’ builtin verifies that the value it prints is the same as the current directory, even if it is not asked to check the file system with the ‘-P’ option. - 62. The ‘read’ builtin may be interrupted by a signal for which a trap + 61. The ‘read’ builtin may be interrupted by a signal for which a trap has been set. If Bash receives a trapped signal while executing ‘read’, the trap handler executes and ‘read’ returns an exit status greater than 128. - 63. When the ‘set’ builtin is invoked without options, it does not + 62. When the ‘set’ builtin is invoked without options, it does not display shell function names and definitions. - 64. When the ‘set’ builtin is invoked without options, it displays + 63. When the ‘set’ builtin is invoked without options, it displays variable values without quotes, unless they contain shell metacharacters, even if the result contains nonprinting characters. - 65. The ‘test’ builtin compares strings using the current locale when + 64. The ‘test’ builtin compares strings using the current locale when evaluating the ‘<’ and ‘>’ binary operators. - 66. The ‘test’ builtin's ‘-t’ unary primary requires an argument. + 65. The ‘test’ builtin's ‘-t’ unary primary requires an argument. Historical versions of ‘test’ made the argument optional in certain cases, and Bash attempts to accommodate those for backwards compatibility. - 67. The ‘trap’ builtin displays signal names without the leading + 66. The ‘trap’ builtin displays signal names without the leading ‘SIG’. - 68. The ‘trap’ builtin doesn't check the first argument for a possible + 67. The ‘trap’ builtin doesn't check the first argument for a possible signal specification and revert the signal handling to the original disposition if it is, unless that argument consists solely of digits and is a valid signal number. If users want to reset the handler for a given signal to the original disposition, they should use ‘-’ as the first argument. - 69. ‘trap -p’ without arguments displays signals whose dispositions + 68. ‘trap -p’ without arguments displays signals whose dispositions are set to SIG_DFL and those that were ignored when the shell started, not just trapped signals. - 70. The ‘type’ and ‘command’ builtins will not report a non-executable + 69. The ‘type’ and ‘command’ builtins will not report a non-executable file as having been found, though the shell will attempt to execute such a file if it is the only so-named file found in ‘$PATH’. - 71. The ‘ulimit’ builtin uses a block size of 512 bytes for the ‘-c’ + 70. The ‘ulimit’ builtin uses a block size of 512 bytes for the ‘-c’ and ‘-f’ options. - 72. The ‘unset’ builtin with the ‘-v’ option specified returns a fatal + 71. The ‘unset’ builtin with the ‘-v’ option specified returns a fatal error if it attempts to unset a ‘readonly’ or ‘non-unsettable’ variable, which causes a non-interactive shell to exit. - 73. When asked to unset a variable that appears in an assignment + 72. When asked to unset a variable that appears in an assignment statement preceding the command, the ‘unset’ builtin attempts to unset a variable of the same name in the current or previous scope as well. This implements the required "if an assigned variable is further modified by the utility, the modifications made by the utility shall persist" behavior. - 74. The arrival of ‘SIGCHLD’ when a trap is set on ‘SIGCHLD’ does not + 73. The arrival of ‘SIGCHLD’ when a trap is set on ‘SIGCHLD’ does not interrupt the ‘wait’ builtin and cause it to return immediately. The trap command is run once for each child that exits. - 75. Bash removes an exited background process's status from the list + 74. Bash removes an exited background process's status from the list of such statuses after the ‘wait’ builtin returns it. There is other POSIX behavior that Bash does not implement by default @@ -8768,9 +8780,9 @@ Variable Settings different color. The color definitions are taken from the value of the ‘LS_COLORS’ environment variable. If there is a color definition in ‘LS_COLORS’ for the custom suffix - ‘.readline-colored-completion-prefix’, Readline uses this - color for the common prefix instead of its default. The - default is ‘off’. + ‘readline-colored-completion-prefix’, Readline uses this color + for the common prefix instead of its default. The default is + ‘off’. ‘colored-stats’ If set to ‘on’, Readline displays possible completions using @@ -13489,88 +13501,88 @@ Node: Command Execution Environment133995 Node: Environment137443 Node: Exit Status139346 Node: Signals141404 -Node: Shell Scripts145302 -Node: Shell Builtin Commands148600 -Node: Bourne Shell Builtins150711 -Node: Bash Builtins177261 -Node: Modifying Shell Behavior213709 -Node: The Set Builtin214051 -Node: The Shopt Builtin225987 -Node: Special Builtins243039 -Node: Shell Variables244028 -Node: Bourne Shell Variables244462 -Node: Bash Variables246970 -Node: Bash Features285279 -Node: Invoking Bash286293 -Node: Bash Startup Files292719 -Node: Interactive Shells298011 -Node: What is an Interactive Shell?298419 -Node: Is this Shell Interactive?299081 -Node: Interactive Shell Behavior299905 -Node: Bash Conditional Expressions303666 -Node: Shell Arithmetic308885 -Node: Aliases312214 -Node: Arrays315349 -Node: The Directory Stack322412 -Node: Directory Stack Builtins323209 -Node: Controlling the Prompt327654 -Node: The Restricted Shell330538 -Node: Bash POSIX Mode333420 -Node: Shell Compatibility Mode351749 -Node: Job Control360756 -Node: Job Control Basics361213 -Node: Job Control Builtins367491 -Node: Job Control Variables374173 -Node: Command Line Editing375404 -Node: Introduction and Notation377107 -Node: Readline Interaction379459 -Node: Readline Bare Essentials380647 -Node: Readline Movement Commands382455 -Node: Readline Killing Commands383451 -Node: Readline Arguments385474 -Node: Searching386531 -Node: Readline Init File388792 -Node: Readline Init File Syntax390096 -Node: Conditional Init Constructs416844 -Node: Sample Init File421229 -Node: Bindable Readline Commands424350 -Node: Commands For Moving425888 -Node: Commands For History428115 -Node: Commands For Text433368 -Node: Commands For Killing437493 -Node: Numeric Arguments440281 -Node: Commands For Completion441433 -Node: Keyboard Macros445933 -Node: Miscellaneous Commands446634 -Node: Readline vi Mode453187 -Node: Programmable Completion454164 -Node: Programmable Completion Builtins462210 -Node: A Programmable Completion Example473875 -Node: Using History Interactively479220 -Node: Bash History Facilities479901 -Node: Bash History Builtins483636 -Node: History Interaction490107 -Node: Event Designators495061 -Node: Word Designators496639 -Node: Modifiers498947 -Node: Installing Bash500888 -Node: Basic Installation502004 -Node: Compilers and Options505880 -Node: Compiling For Multiple Architectures506630 -Node: Installation Names508383 -Node: Specifying the System Type510617 -Node: Sharing Defaults511363 -Node: Operation Controls512077 -Node: Optional Features513096 -Node: Reporting Bugs525476 -Node: Major Differences From The Bourne Shell526834 -Node: GNU Free Documentation License548254 -Node: Indexes573431 -Node: Builtin Index573882 -Node: Reserved Word Index580980 -Node: Variable Index583425 -Node: Function Index600838 -Node: Concept Index614694 +Node: Shell Scripts146333 +Node: Shell Builtin Commands149631 +Node: Bourne Shell Builtins151742 +Node: Bash Builtins178292 +Node: Modifying Shell Behavior214740 +Node: The Set Builtin215082 +Node: The Shopt Builtin227018 +Node: Special Builtins244070 +Node: Shell Variables245059 +Node: Bourne Shell Variables245493 +Node: Bash Variables248001 +Node: Bash Features286310 +Node: Invoking Bash287324 +Node: Bash Startup Files293750 +Node: Interactive Shells299042 +Node: What is an Interactive Shell?299450 +Node: Is this Shell Interactive?300112 +Node: Interactive Shell Behavior300936 +Node: Bash Conditional Expressions304697 +Node: Shell Arithmetic309916 +Node: Aliases313245 +Node: Arrays316380 +Node: The Directory Stack323443 +Node: Directory Stack Builtins324240 +Node: Controlling the Prompt328685 +Node: The Restricted Shell331569 +Node: Bash POSIX Mode334451 +Node: Shell Compatibility Mode352513 +Node: Job Control361520 +Node: Job Control Basics361977 +Node: Job Control Builtins368255 +Node: Job Control Variables374937 +Node: Command Line Editing376168 +Node: Introduction and Notation377871 +Node: Readline Interaction380223 +Node: Readline Bare Essentials381411 +Node: Readline Movement Commands383219 +Node: Readline Killing Commands384215 +Node: Readline Arguments386238 +Node: Searching387295 +Node: Readline Init File389556 +Node: Readline Init File Syntax390860 +Node: Conditional Init Constructs417607 +Node: Sample Init File421992 +Node: Bindable Readline Commands425113 +Node: Commands For Moving426651 +Node: Commands For History428878 +Node: Commands For Text434131 +Node: Commands For Killing438256 +Node: Numeric Arguments441044 +Node: Commands For Completion442196 +Node: Keyboard Macros446696 +Node: Miscellaneous Commands447397 +Node: Readline vi Mode453950 +Node: Programmable Completion454927 +Node: Programmable Completion Builtins462973 +Node: A Programmable Completion Example474638 +Node: Using History Interactively479983 +Node: Bash History Facilities480664 +Node: Bash History Builtins484399 +Node: History Interaction490870 +Node: Event Designators495824 +Node: Word Designators497402 +Node: Modifiers499710 +Node: Installing Bash501651 +Node: Basic Installation502767 +Node: Compilers and Options506643 +Node: Compiling For Multiple Architectures507393 +Node: Installation Names509146 +Node: Specifying the System Type511380 +Node: Sharing Defaults512126 +Node: Operation Controls512840 +Node: Optional Features513859 +Node: Reporting Bugs526239 +Node: Major Differences From The Bourne Shell527597 +Node: GNU Free Documentation License549017 +Node: Indexes574194 +Node: Builtin Index574645 +Node: Reserved Word Index581743 +Node: Variable Index584188 +Node: Function Index601601 +Node: Concept Index615457  End Tag Table diff --git a/doc/bash.pdf b/doc/bash.pdf index 60aebab2..55354480 100644 Binary files a/doc/bash.pdf and b/doc/bash.pdf differ diff --git a/doc/bashref.info b/doc/bashref.info index 5c29644d..641c262f 100644 --- a/doc/bashref.info +++ b/doc/bashref.info @@ -2,9 +2,9 @@ This is bashref.info, produced by makeinfo version 7.1 from bashref.texi. This text is a brief description of the features that are present in the -Bash shell (version 5.3, 20 October 2024). +Bash shell (version 5.3, 23 October 2024). - This is Edition 5.3, last updated 20 October 2024, of ‘The GNU Bash + This is Edition 5.3, last updated 23 October 2024, of ‘The GNU Bash Reference Manual’, for ‘Bash’, Version 5.3. Copyright © 1988-2024 Free Software Foundation, Inc. @@ -27,10 +27,10 @@ Bash Features ************* This text is a brief description of the features that are present in the -Bash shell (version 5.3, 20 October 2024). The Bash home page is +Bash shell (version 5.3, 23 October 2024). The Bash home page is . - This is Edition 5.3, last updated 20 October 2024, of ‘The GNU Bash + This is Edition 5.3, last updated 23 October 2024, of ‘The GNU Bash Reference Manual’, for ‘Bash’, Version 5.3. Bash contains features that appear in other popular shells, and some @@ -3223,7 +3223,7 @@ Shopt Builtin::), Bash sends a ‘SIGHUP’ to all jobs when an interactive login shell exits. If Bash 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 +for which a trap has been set, it will not execute the trap until the command completes. If Bash is waiting for an asynchronous command via the ‘wait’ builtin, and it receives a signal for which a trap has been set, the ‘wait’ builtin will return immediately with an exit status @@ -3234,19 +3234,28 @@ command to complete, the shell receives keyboard-generated signals such as ‘SIGINT’ (usually generated by ‘^C’) 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 ‘^C’ sends ‘SIGINT’ -to all processes in that process group. See *note Job Control::, for a -more in-depth discussion of process groups. +to all processes in that process group. Since Bash does not enable job +control by default when the shell is not interactive, this scenario is +most common in non-interactive shells. - When Bash is running without job control enabled and receives -‘SIGINT’ while waiting for a foreground command, it waits until that -foreground command terminates and then decides what to do about the -‘SIGINT’: + When job control is enabled, and Bash is waiting for a foreground +command to complete, the shell does not receive keyboard-generated +signals, because it is not in the same process group as the terminal. +This scenario is most common in interactive shells, where Bash attempts +to enable job control by default. See *note Job Control::, for a more +in-depth discussion of process groups. + + When job control is not enabled, and Bash receives ‘SIGINT’ while +waiting for a foreground command, it waits until that foreground command +terminates and then decides what to do about the ‘SIGINT’: 1. If the command terminates due to the ‘SIGINT’, Bash concludes that - the user meant to end the entire script, and acts on the ‘SIGINT’ - (e.g., by running a ‘SIGINT’ trap or exiting itself); + the user meant to send the ‘SIGINT’ to the shell as well, and acts + on the ‘SIGINT’ (e.g., by running a ‘SIGINT’ trap, exiting a + non-interactive shell, or returning to the top level to read a new + command). - 2. If the pipeline does not terminate due to ‘SIGINT’, the program + 2. If the command does not terminate due to ‘SIGINT’, the program handled the ‘SIGINT’ itself and did not treat it as a fatal signal. In that case, Bash does not treat ‘SIGINT’ as a fatal signal, either, instead assuming that the ‘SIGINT’ was used as part of the @@ -3256,6 +3265,14 @@ foreground command terminates and then decides what to do about the receives while it is waiting for the foreground command to complete, for compatibility. + When job control is enabled, Bash does not receive keyboard-generated +signals such as ‘SIGINT’ while it is waiting for a foreground command. +An interactive shell does not pay attention to the ‘SIGINT’, even if the +foreground command terminates as a result, other than noting its exit +status. If the shell is not interactive, and the foreground command +terminates due to the ‘SIGINT’, Bash pretends it received the ‘SIGINT’ +itself (scenario 1 above), for compatibility. +  File: bashref.info, Node: Shell Scripts, Prev: Executing Commands, Up: Basic Shell Features @@ -7611,116 +7628,111 @@ startup files. 10. Redirection operators do not perform word splitting on the word in a redirection. - 11. Function names must be valid shell ‘name’s. That is, they may not - contain characters other than letters, digits, and underscores, and - may not start with a digit. Declaring a function with an invalid - name in a non-interactive shell is a fatal syntax error. - - 12. Function names may not be the same as one of the POSIX special + 11. Function names may not be the same as one of the POSIX special builtins. - 13. Tilde expansion is only performed on assignments preceding a + 12. Tilde expansion is only performed on assignments preceding a command name, rather than on all assignment statements on the line. - 14. While variable indirection is available, it may not be applied to + 13. While variable indirection is available, it may not be applied to the ‘#’ and ‘?’ special parameters. - 15. Expanding the ‘*’ special parameter in a pattern context where the + 14. Expanding the ‘*’ special parameter in a pattern context where the expansion is double-quoted does not treat the ‘$*’ as if it were double-quoted. - 16. A double quote character (‘"’) is treated specially when it + 15. A double quote character (‘"’) is treated specially when it appears in a backquoted command substitution in the body of a here-document that undergoes expansion. That means, for example, that a backslash preceding a double quote character will escape it and the backslash will be removed. - 17. Command substitutions don't set the ‘?’ special parameter. The + 16. Command substitutions don't set the ‘?’ special parameter. The exit status of a simple command without a command word is still the exit status of the last command substitution that occurred while evaluating the variable assignments and redirections in that command, but that does not happen until after all of the assignments and redirections. - 18. Literal tildes that appear as the first character in elements of + 17. Literal tildes that appear as the first character in elements of the ‘PATH’ variable are not expanded as described above under *note Tilde Expansion::. - 19. Command lookup finds POSIX special builtins before shell + 18. Command lookup finds POSIX special builtins before shell functions, including output printed by the ‘type’ and ‘command’ builtins. - 20. Even if a shell function whose name contains a slash was defined + 19. Even if a shell function whose name contains a slash was defined before entering POSIX mode, the shell will not execute a function whose name contains one or more slashes. - 21. When a command in the hash table no longer exists, Bash will + 20. When a command in the hash table no longer exists, Bash will re-search ‘$PATH’ to find the new location. This is also available with ‘shopt -s checkhash’. - 22. Bash will not insert a command without the execute bit set into + 21. Bash will not insert a command without the execute bit set into the command hash table, even if it returns it as a (last-ditch) result from a ‘$PATH’ search. - 23. The message printed by the job control code and builtins when a + 22. The message printed by the job control code and builtins when a job exits with a non-zero status is 'Done(status)'. - 24. The message printed by the job control code and builtins when a + 23. The message printed by the job control code and builtins when a job is stopped is 'Stopped(SIGNAME)', where SIGNAME is, for example, ‘SIGTSTP’. - 25. If the shell is interactive, Bash does not perform job + 24. If the shell is interactive, Bash does not perform job notifications between executing commands in lists separated by ‘;’ or newline. Non-interactive shells print status messages after a foreground job in a list completes. - 26. If the shell is interactive, Bash waits until the next prompt + 25. If the shell is interactive, Bash waits until the next prompt before printing the status of a background job that changes status or a foreground job that terminates due to a signal. Non-interactive shells print status messages after a foreground job completes. - 27. Bash permanently removes jobs from the jobs table after notifying + 26. Bash permanently removes jobs from the jobs table after notifying the user of their termination via the ‘wait’ or ‘jobs’ builtins. It removes the job from the jobs list after notifying the user of its termination, but the status is still available via ‘wait’, as long as ‘wait’ is supplied a PID argument. - 28. The ‘vi’ editing mode will invoke the ‘vi’ editor directly when + 27. The ‘vi’ editing mode will invoke the ‘vi’ editor directly when the ‘v’ command is run, instead of checking ‘$VISUAL’ and ‘$EDITOR’. - 29. Prompt expansion enables the POSIX ‘PS1’ and ‘PS2’ expansions of + 28. Prompt expansion enables the POSIX ‘PS1’ and ‘PS2’ expansions of ‘!’ to the history number and ‘!!’ to ‘!’, and Bash performs parameter expansion on the values of ‘PS1’ and ‘PS2’ regardless of the setting of the ‘promptvars’ option. - 30. The default history file is ‘~/.sh_history’ (this is the default + 29. The default history file is ‘~/.sh_history’ (this is the default value the shell assigns to ‘$HISTFILE’). - 31. The ‘!’ character does not introduce history expansion within a + 30. The ‘!’ character does not introduce history expansion within a double-quoted string, even if the ‘histexpand’ option is enabled. - 32. When printing shell function definitions (e.g., by ‘type’), Bash - does not print the ‘function’ keyword. + 31. When printing shell function definitions (e.g., by ‘type’), Bash + does not print the ‘function’ keyword unless necessary. - 33. Non-interactive shells exit if a syntax error in an arithmetic + 32. Non-interactive shells exit if a syntax error in an arithmetic expansion results in an invalid expression. - 34. Non-interactive shells exit if a parameter expansion error occurs. + 33. Non-interactive shells exit if a parameter expansion error occurs. - 35. If a POSIX special builtin returns an error status, a + 34. If a POSIX special builtin returns an error status, a non-interactive shell exits. The fatal errors are those listed in the POSIX standard, and include things like passing incorrect options, redirection errors, variable assignment errors for assignments preceding the command name, and so on. - 36. A non-interactive shell exits with an error status if a variable + 35. A non-interactive shell exits with an error status if a variable assignment error occurs when no command name follows the assignment statements. A variable assignment error occurs, for example, when trying to assign a value to a readonly variable. - 37. A non-interactive shell exits with an error status if a variable + 36. A non-interactive shell exits with an error status if a variable assignment error occurs in an assignment statement preceding a special builtin, but not with any other simple command. For any other simple command, the shell aborts execution of that command, @@ -7728,155 +7740,155 @@ startup files. perform any further processing of the command in which the error occurred"). - 38. A non-interactive shell exits with an error status if the + 37. A non-interactive shell exits with an error status if the iteration variable in a ‘for’ statement or the selection variable in a ‘select’ statement is a readonly variable or has an invalid name. - 39. Non-interactive shells exit if FILENAME in ‘.’ FILENAME is not + 38. Non-interactive shells exit if FILENAME in ‘.’ FILENAME is not found. - 40. Non-interactive shells exit if there is a syntax error in a script + 39. Non-interactive shells exit if there is a syntax error in a script read with the ‘.’ or ‘source’ builtins, or in a string processed by the ‘eval’ builtin. - 41. Non-interactive shells exit if the ‘export’, ‘readonly’ or ‘unset’ + 40. Non-interactive shells exit if the ‘export’, ‘readonly’ or ‘unset’ builtin commands get an argument that is not a valid identifier, and they are not operating on shell functions. These errors force an exit because these are special builtins. - 42. Assignment statements preceding POSIX special builtins persist in + 41. Assignment statements preceding POSIX special builtins persist in the shell environment after the builtin completes. - 43. The ‘command’ builtin does not prevent builtins that take + 42. The ‘command’ builtin does not prevent builtins that take assignment statements as arguments from expanding them as assignment statements; when not in POSIX mode, declaration commands lose their assignment statement expansion properties when preceded by ‘command’. - 44. Enabling POSIX mode has the effect of setting the + 43. Enabling POSIX mode has the effect of setting the ‘inherit_errexit’ option, so subshells spawned to execute command substitutions inherit the value of the ‘-e’ option from the parent shell. When the ‘inherit_errexit’ option is not enabled, Bash clears the ‘-e’ option in such subshells. - 45. Enabling POSIX mode has the effect of setting the ‘shift_verbose’ + 44. Enabling POSIX mode has the effect of setting the ‘shift_verbose’ option, so numeric arguments to ‘shift’ that exceed the number of positional parameters will result in an error message. - 46. Enabling POSIX mode has the effect of setting the + 45. Enabling POSIX mode has the effect of setting the ‘interactive_comments’ option (*note Comments::). - 47. The ‘.’ and ‘source’ builtins do not search the current directory + 46. The ‘.’ and ‘source’ builtins do not search the current directory for the filename argument if it is not found by searching ‘PATH’. - 48. When the ‘alias’ builtin displays alias definitions, it does not + 47. When the ‘alias’ builtin displays alias definitions, it does not display them with a leading ‘alias ’ unless the ‘-p’ option is supplied. - 49. The ‘bg’ builtin uses the required format to describe each job + 48. The ‘bg’ builtin uses the required format to describe each job placed in the background, which does not include an indication of whether the job is the current or previous job. - 50. When the ‘cd’ builtin is invoked in logical mode, and the pathname + 49. When the ‘cd’ builtin is invoked in logical mode, and the pathname constructed from ‘$PWD’ and the directory name supplied as an argument does not refer to an existing directory, ‘cd’ will fail instead of falling back to physical mode. - 51. When the ‘cd’ builtin cannot change a directory because the length + 50. When the ‘cd’ builtin cannot change a directory because the length of the pathname constructed from ‘$PWD’ and the directory name supplied as an argument exceeds ‘PATH_MAX’ when canonicalized, ‘cd’ will attempt to use the supplied directory name. - 52. When the ‘xpg_echo’ option is enabled, Bash does not attempt to + 51. When the ‘xpg_echo’ option is enabled, Bash does not attempt to interpret any arguments to ‘echo’ as options. ‘echo’ displays each argument after converting escape sequences. - 53. The ‘export’ and ‘readonly’ builtin commands display their output + 52. The ‘export’ and ‘readonly’ builtin commands display their output in the format required by POSIX. - 54. When listing the history, the ‘fc’ builtin does not include an + 53. When listing the history, the ‘fc’ builtin does not include an indication of whether or not a history entry has been modified. - 55. The default editor used by ‘fc’ is ‘ed’. + 54. The default editor used by ‘fc’ is ‘ed’. - 56. ‘fc’ treats extra arguments as an error instead of ignoring them. + 55. ‘fc’ treats extra arguments as an error instead of ignoring them. - 57. If there are too many arguments supplied to ‘fc -s’, ‘fc’ prints + 56. If there are too many arguments supplied to ‘fc -s’, ‘fc’ prints an error message and returns failure. - 58. The output of ‘kill -l’ prints all the signal names on a single + 57. The output of ‘kill -l’ prints all the signal names on a single line, separated by spaces, without the ‘SIG’ prefix. - 59. The ‘kill’ builtin does not accept signal names with a ‘SIG’ + 58. The ‘kill’ builtin does not accept signal names with a ‘SIG’ prefix. - 60. The ‘printf’ builtin uses ‘double’ (via ‘strtod’) to convert + 59. The ‘printf’ builtin uses ‘double’ (via ‘strtod’) to convert arguments corresponding to floating point conversion specifiers, instead of ‘long double’ if it's available. The ‘L’ length modifier forces ‘printf’ to use ‘long double’ if it's available. - 61. The ‘pwd’ builtin verifies that the value it prints is the same as + 60. The ‘pwd’ builtin verifies that the value it prints is the same as the current directory, even if it is not asked to check the file system with the ‘-P’ option. - 62. The ‘read’ builtin may be interrupted by a signal for which a trap + 61. The ‘read’ builtin may be interrupted by a signal for which a trap has been set. If Bash receives a trapped signal while executing ‘read’, the trap handler executes and ‘read’ returns an exit status greater than 128. - 63. When the ‘set’ builtin is invoked without options, it does not + 62. When the ‘set’ builtin is invoked without options, it does not display shell function names and definitions. - 64. When the ‘set’ builtin is invoked without options, it displays + 63. When the ‘set’ builtin is invoked without options, it displays variable values without quotes, unless they contain shell metacharacters, even if the result contains nonprinting characters. - 65. The ‘test’ builtin compares strings using the current locale when + 64. The ‘test’ builtin compares strings using the current locale when evaluating the ‘<’ and ‘>’ binary operators. - 66. The ‘test’ builtin's ‘-t’ unary primary requires an argument. + 65. The ‘test’ builtin's ‘-t’ unary primary requires an argument. Historical versions of ‘test’ made the argument optional in certain cases, and Bash attempts to accommodate those for backwards compatibility. - 67. The ‘trap’ builtin displays signal names without the leading + 66. The ‘trap’ builtin displays signal names without the leading ‘SIG’. - 68. The ‘trap’ builtin doesn't check the first argument for a possible + 67. The ‘trap’ builtin doesn't check the first argument for a possible signal specification and revert the signal handling to the original disposition if it is, unless that argument consists solely of digits and is a valid signal number. If users want to reset the handler for a given signal to the original disposition, they should use ‘-’ as the first argument. - 69. ‘trap -p’ without arguments displays signals whose dispositions + 68. ‘trap -p’ without arguments displays signals whose dispositions are set to SIG_DFL and those that were ignored when the shell started, not just trapped signals. - 70. The ‘type’ and ‘command’ builtins will not report a non-executable + 69. The ‘type’ and ‘command’ builtins will not report a non-executable file as having been found, though the shell will attempt to execute such a file if it is the only so-named file found in ‘$PATH’. - 71. The ‘ulimit’ builtin uses a block size of 512 bytes for the ‘-c’ + 70. The ‘ulimit’ builtin uses a block size of 512 bytes for the ‘-c’ and ‘-f’ options. - 72. The ‘unset’ builtin with the ‘-v’ option specified returns a fatal + 71. The ‘unset’ builtin with the ‘-v’ option specified returns a fatal error if it attempts to unset a ‘readonly’ or ‘non-unsettable’ variable, which causes a non-interactive shell to exit. - 73. When asked to unset a variable that appears in an assignment + 72. When asked to unset a variable that appears in an assignment statement preceding the command, the ‘unset’ builtin attempts to unset a variable of the same name in the current or previous scope as well. This implements the required "if an assigned variable is further modified by the utility, the modifications made by the utility shall persist" behavior. - 74. The arrival of ‘SIGCHLD’ when a trap is set on ‘SIGCHLD’ does not + 73. The arrival of ‘SIGCHLD’ when a trap is set on ‘SIGCHLD’ does not interrupt the ‘wait’ builtin and cause it to return immediately. The trap command is run once for each child that exits. - 75. Bash removes an exited background process's status from the list + 74. Bash removes an exited background process's status from the list of such statuses after the ‘wait’ builtin returns it. There is other POSIX behavior that Bash does not implement by default @@ -8769,9 +8781,9 @@ Variable Settings different color. The color definitions are taken from the value of the ‘LS_COLORS’ environment variable. If there is a color definition in ‘LS_COLORS’ for the custom suffix - ‘.readline-colored-completion-prefix’, Readline uses this - color for the common prefix instead of its default. The - default is ‘off’. + ‘readline-colored-completion-prefix’, Readline uses this color + for the common prefix instead of its default. The default is + ‘off’. ‘colored-stats’ If set to ‘on’, Readline displays possible completions using @@ -13490,88 +13502,88 @@ Node: Command Execution Environment134136 Node: Environment137587 Node: Exit Status139493 Node: Signals141554 -Node: Shell Scripts145455 -Node: Shell Builtin Commands148756 -Node: Bourne Shell Builtins150870 -Node: Bash Builtins177423 -Node: Modifying Shell Behavior213874 -Node: The Set Builtin214219 -Node: The Shopt Builtin226158 -Node: Special Builtins243213 -Node: Shell Variables244205 -Node: Bourne Shell Variables244642 -Node: Bash Variables247153 -Node: Bash Features285465 -Node: Invoking Bash286482 -Node: Bash Startup Files292911 -Node: Interactive Shells298206 -Node: What is an Interactive Shell?298617 -Node: Is this Shell Interactive?299282 -Node: Interactive Shell Behavior300109 -Node: Bash Conditional Expressions303873 -Node: Shell Arithmetic309095 -Node: Aliases312427 -Node: Arrays315565 -Node: The Directory Stack322631 -Node: Directory Stack Builtins323431 -Node: Controlling the Prompt327879 -Node: The Restricted Shell330766 -Node: Bash POSIX Mode333651 -Node: Shell Compatibility Mode351983 -Node: Job Control360993 -Node: Job Control Basics361453 -Node: Job Control Builtins367734 -Node: Job Control Variables374419 -Node: Command Line Editing375653 -Node: Introduction and Notation377359 -Node: Readline Interaction379714 -Node: Readline Bare Essentials380905 -Node: Readline Movement Commands382716 -Node: Readline Killing Commands383715 -Node: Readline Arguments385741 -Node: Searching386801 -Node: Readline Init File389065 -Node: Readline Init File Syntax390372 -Node: Conditional Init Constructs417123 -Node: Sample Init File421511 -Node: Bindable Readline Commands424635 -Node: Commands For Moving426176 -Node: Commands For History428406 -Node: Commands For Text433662 -Node: Commands For Killing437790 -Node: Numeric Arguments440581 -Node: Commands For Completion441736 -Node: Keyboard Macros446239 -Node: Miscellaneous Commands446943 -Node: Readline vi Mode453499 -Node: Programmable Completion454479 -Node: Programmable Completion Builtins462528 -Node: A Programmable Completion Example474196 -Node: Using History Interactively479544 -Node: Bash History Facilities480228 -Node: Bash History Builtins483966 -Node: History Interaction490440 -Node: Event Designators495397 -Node: Word Designators496978 -Node: Modifiers499289 -Node: Installing Bash501233 -Node: Basic Installation502352 -Node: Compilers and Options506231 -Node: Compiling For Multiple Architectures506984 -Node: Installation Names508740 -Node: Specifying the System Type510977 -Node: Sharing Defaults511726 -Node: Operation Controls512443 -Node: Optional Features513465 -Node: Reporting Bugs525848 -Node: Major Differences From The Bourne Shell527209 -Node: GNU Free Documentation License548632 -Node: Indexes573812 -Node: Builtin Index574266 -Node: Reserved Word Index581367 -Node: Variable Index583815 -Node: Function Index601231 -Node: Concept Index615090 +Node: Shell Scripts146486 +Node: Shell Builtin Commands149787 +Node: Bourne Shell Builtins151901 +Node: Bash Builtins178454 +Node: Modifying Shell Behavior214905 +Node: The Set Builtin215250 +Node: The Shopt Builtin227189 +Node: Special Builtins244244 +Node: Shell Variables245236 +Node: Bourne Shell Variables245673 +Node: Bash Variables248184 +Node: Bash Features286496 +Node: Invoking Bash287513 +Node: Bash Startup Files293942 +Node: Interactive Shells299237 +Node: What is an Interactive Shell?299648 +Node: Is this Shell Interactive?300313 +Node: Interactive Shell Behavior301140 +Node: Bash Conditional Expressions304904 +Node: Shell Arithmetic310126 +Node: Aliases313458 +Node: Arrays316596 +Node: The Directory Stack323662 +Node: Directory Stack Builtins324462 +Node: Controlling the Prompt328910 +Node: The Restricted Shell331797 +Node: Bash POSIX Mode334682 +Node: Shell Compatibility Mode352747 +Node: Job Control361757 +Node: Job Control Basics362217 +Node: Job Control Builtins368498 +Node: Job Control Variables375183 +Node: Command Line Editing376417 +Node: Introduction and Notation378123 +Node: Readline Interaction380478 +Node: Readline Bare Essentials381669 +Node: Readline Movement Commands383480 +Node: Readline Killing Commands384479 +Node: Readline Arguments386505 +Node: Searching387565 +Node: Readline Init File389829 +Node: Readline Init File Syntax391136 +Node: Conditional Init Constructs417886 +Node: Sample Init File422274 +Node: Bindable Readline Commands425398 +Node: Commands For Moving426939 +Node: Commands For History429169 +Node: Commands For Text434425 +Node: Commands For Killing438553 +Node: Numeric Arguments441344 +Node: Commands For Completion442499 +Node: Keyboard Macros447002 +Node: Miscellaneous Commands447706 +Node: Readline vi Mode454262 +Node: Programmable Completion455242 +Node: Programmable Completion Builtins463291 +Node: A Programmable Completion Example474959 +Node: Using History Interactively480307 +Node: Bash History Facilities480991 +Node: Bash History Builtins484729 +Node: History Interaction491203 +Node: Event Designators496160 +Node: Word Designators497741 +Node: Modifiers500052 +Node: Installing Bash501996 +Node: Basic Installation503115 +Node: Compilers and Options506994 +Node: Compiling For Multiple Architectures507747 +Node: Installation Names509503 +Node: Specifying the System Type511740 +Node: Sharing Defaults512489 +Node: Operation Controls513206 +Node: Optional Features514228 +Node: Reporting Bugs526611 +Node: Major Differences From The Bourne Shell527972 +Node: GNU Free Documentation License549395 +Node: Indexes574575 +Node: Builtin Index575029 +Node: Reserved Word Index582130 +Node: Variable Index584578 +Node: Function Index601994 +Node: Concept Index615853  End Tag Table diff --git a/doc/bashref.pdf b/doc/bashref.pdf index d7c7090b..63523684 100644 Binary files a/doc/bashref.pdf and b/doc/bashref.pdf differ diff --git a/doc/bashref.texi b/doc/bashref.texi index 1a10a62d..e97d52e1 100644 --- a/doc/bashref.texi +++ b/doc/bashref.texi @@ -3853,8 +3853,8 @@ If the @code{huponexit} shell option has been set using @code{shopt} an interactive login shell exits. If Bash 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 command completes. +for which a trap has been set, +it will not execute the trap until the command completes. If Bash is waiting for an asynchronous command via the @code{wait} builtin, and it receives a signal for which a trap has been set, the @code{wait} builtin will return immediately with an exit status @@ -3867,20 +3867,33 @@ 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 @samp{^C} sends @code{SIGINT} to all processes in that process group. +Since Bash does not enable job control by default when the +shell is not interactive, +this scenario is most common in non-interactive shells. + +When job control is enabled, and Bash is waiting for a foreground +command to complete, the shell does not receive keyboard-generated +signals, because it is not in the same process group as the terminal. +This scenario is most common in interactive shells, where Bash +attempts to enable job control by default. See @ref{Job Control}, for a more in-depth discussion of process groups. -When Bash is running without job control enabled and receives @code{SIGINT} +When job control is not enabled, and Bash receives @code{SIGINT} while waiting for a foreground command, it waits until that foreground command terminates and then decides what to do about the @code{SIGINT}: @enumerate @item If the command terminates due to the @code{SIGINT}, Bash concludes -that the user meant to end the entire script, and acts on the -@code{SIGINT} (e.g., by running a @code{SIGINT} trap or exiting itself); +that the user meant to send the @code{SIGINT} to the shell as well, +and acts on the +@code{SIGINT} +(e.g., by running a @code{SIGINT} trap, +exiting a non-interactive shell, +or returning to the top level to read a new command). @item -If the pipeline does not terminate due to @code{SIGINT}, the program +If the command does not terminate due to @code{SIGINT}, the program handled the @code{SIGINT} itself and did not treat it as a fatal signal. In that case, Bash does not treat @code{SIGINT} as a fatal signal, either, instead assuming that the @code{SIGINT} was used as part of the @@ -3892,6 +3905,17 @@ receives while it is waiting for the foreground command to complete, for compatibility. @end enumerate +When job control is enabled, Bash does not receive keyboard-generated +signals such as @code{SIGINT} +while it is waiting for a foreground command. +An interactive shell does not pay attention to the @code{SIGINT}, +even if the foreground command terminates as a result, other than noting +its exit status. +If the shell is not interactive, and +the foreground command terminates due to the @code{SIGINT}, +Bash pretends it received the @code{SIGINT} +itself (scenario 1 above), for compatibility. + @node Shell Scripts @section Shell Scripts @cindex shell script @@ -8953,14 +8977,6 @@ in a redirection unless the shell is interactive. Redirection operators do not perform word splitting on the word in a redirection. -@item -Function names must be valid shell @code{name}s. -That is, they may not -contain characters other than letters, digits, and underscores, and -may not start with a digit. -Declaring a function with an invalid name in a non-interactive shell -is a fatal syntax error. - @item Function names may not be the same as one of the @sc{posix} special builtins. @@ -9068,7 +9084,7 @@ double-quoted string, even if the @code{histexpand} option is enabled. @item When printing shell function definitions (e.g., by @code{type}), Bash does -not print the @code{function} keyword. +not print the @code{function} keyword unless necessary. @item Non-interactive shells exit if a syntax error in an arithmetic expansion diff --git a/doc/version.texi b/doc/version.texi index dff85a95..f68242d8 100644 --- a/doc/version.texi +++ b/doc/version.texi @@ -2,10 +2,10 @@ Copyright (C) 1988-2024 Free Software Foundation, Inc. @end ignore -@set LASTCHANGE Sun Oct 20 12:30:58 EDT 2024 +@set LASTCHANGE Wed Oct 23 11:32:20 EDT 2024 @set EDITION 5.3 @set VERSION 5.3 -@set UPDATED 20 October 2024 +@set UPDATED 23 October 2024 @set UPDATED-MONTH October 2024 diff --git a/error.c b/error.c index 366d012f..10af0709 100644 --- a/error.c +++ b/error.c @@ -454,3 +454,9 @@ err_readonly (const char *s) { report_error (_("%s: readonly variable"), s); } + +void +err_invalidid (const char *s) +{ + internal_error (_("`%s': not a valid identifier"), s); +} diff --git a/error.h b/error.h index 9a312772..db0972bc 100644 --- a/error.h +++ b/error.h @@ -73,6 +73,8 @@ extern void err_badarraysub (const char *); extern void err_unboundvar (const char *); extern void err_readonly (const char *); +extern void err_invalidid (const char *); + #ifdef DEBUG # define INTERNAL_DEBUG(x) internal_debug x #else diff --git a/execute_cmd.c b/execute_cmd.c index 758fbf5e..4dea87eb 100644 --- a/execute_cmd.c +++ b/execute_cmd.c @@ -1967,7 +1967,7 @@ cpl_reap (void) if (p->coproc->c_flags & COPROC_DEAD) { coproc_list.ncoproc--; /* keep running count, fix up pointers later */ -#ifdef DEBUG +#if 0 INTERNAL_DEBUG (("cpl_reap: deleting %d", p->coproc->c_pid)); #endif coproc_dispose (p->coproc); @@ -2496,7 +2496,7 @@ execute_coproc (COMMAND *command, int pipe_in, int pipe_out, struct fd_bitmap *f /* Optional check -- could be relaxed */ if (valid_identifier (name) == 0) { - internal_error (_("`%s': not a valid identifier"), name); + err_invalidid (name); free (name); return (invert ? EXECUTION_SUCCESS : EXECUTION_FAILURE); } @@ -6256,8 +6256,21 @@ execute_intern_function (WORD_DESC *name, FUNCTION_DEF *funcdef) { SHELL_VAR *var; char *t; + int pflags; + + /* This is where we enforce any restrictions on the function name via the + call to valid_function_word(). */ + pflags = 0; +#if POSIX_RESTRICT_FUNCNAME + if (posixly_correct) + pflags |= 1; /* enforce posix function name restrictions */ +#endif + if (posixly_correct) + pflags |= 4; /* no special builtins */ - if (valid_function_word (name, posixly_correct) == 0) + /* We still allow functions with the same name as reserved words, so they + can be called if quoted. */ + if (valid_function_word (name, pflags) == 0) { if (posixly_correct) { diff --git a/general.c b/general.c index 723607eb..13746f3c 100644 --- a/general.c +++ b/general.c @@ -357,12 +357,12 @@ check_identifier (WORD_DESC *word, int check_word) { if (word->flags & (W_HASDOLLAR|W_QUOTED)) /* XXX - HASDOLLAR? */ { - internal_error (_("`%s': not a valid identifier"), word->word); + err_invalidid (word->word); return (0); } else if (check_word && (all_digits (word->word) || valid_identifier (word->word) == 0)) { - internal_error (_("`%s': not a valid identifier"), word->word); + err_invalidid (word->word); return (0); } else @@ -431,10 +431,15 @@ valid_function_name (const char *name, int flags) /* Return 1 if this is an identifier that can be used as a function name when declaring a function. We don't allow `$' for historical reasons. We allow quotes (for now), slashes, and pretty much everything else. - If FLAGS is non-zero (it's usually posixly_correct), we check the name - for additional posix restrictions using valid_function_name(). We pass - flags|2 to valid_function_name to suppress the check for an assignment - word, since we want to allow those here. */ + If (FLAGS&4) is non-zero, we check that the name is not one of the POSIX + special builtins (this is the shell enforcing a POSIX application + requirement). We allow reserved words, even though it's unlikely anyone + would use them. + If (FLAGS&1) is non-zero (it's usually set by the caller from + posixly_correct), we check the name for additional posix restrictions + using valid_function_name(). + We pass flags|2 to valid_function_name to suppress the check for an + assignment word, since we want to allow those here. */ int valid_function_word (WORD_DESC *word, int flags) { @@ -443,18 +448,20 @@ valid_function_word (WORD_DESC *word, int flags) name = word->word; if ((word->flags & W_HASDOLLAR)) /* allow quotes for now */ { - internal_error (_("`%s': not a valid identifier"), name); + err_invalidid (name); return (0); } - /* POSIX interpretation 383 */ - if (flags && find_special_builtin (name)) + /* POSIX interpretation 383 -- this is an application requirement, but the + shell should enforce it rather than allow a script to define a function + that will never be called. */ + if ((flags & 4) && find_special_builtin (name)) { internal_error (_("`%s': is a special builtin"), name); return (0); } - if (flags && valid_function_name (name, flags|2) == 0) + if ((flags & 1) && valid_function_name (name, flags|2) == 0) { - internal_error (_("`%s': not a valid identifier"), name); + err_invalidid (name); return (0); } return 1; diff --git a/lib/readline/colors.c b/lib/readline/colors.c index 28ed7bcd..329acce5 100644 --- a/lib/readline/colors.c +++ b/lib/readline/colors.c @@ -73,7 +73,7 @@ static bool is_colored (enum indicator_no type); static void restore_default_color (void); -#define RL_COLOR_PREFIX_EXTENSION ".readline-colored-completion-prefix" +#define RL_COLOR_PREFIX_EXTENSION "readline-colored-completion-prefix" COLOR_EXT_TYPE *_rl_color_ext_list = 0; diff --git a/lib/readline/doc/readline.3 b/lib/readline/doc/readline.3 index e8133882..d0708e33 100644 --- a/lib/readline/doc/readline.3 +++ b/lib/readline/doc/readline.3 @@ -478,7 +478,7 @@ common prefix of the set of possible completions using a different color. The color definitions are taken from the value of the \fBLS_COLORS\fP environment variable. If there is a color definition in \fB$LS_COLORS\fP for the custom suffix -.Q .readline-colored-completion-prefix , +.Q readline-colored-completion-prefix , \fBreadline\fP uses this color for the common prefix instead of its default. .TP diff --git a/lib/readline/doc/rluser.texi b/lib/readline/doc/rluser.texi index 9b3cf791..d4918f8d 100644 --- a/lib/readline/doc/rluser.texi +++ b/lib/readline/doc/rluser.texi @@ -508,7 +508,7 @@ common prefix of the set of possible completions using a different color. The color definitions are taken from the value of the @env{LS_COLORS} environment variable. If there is a color definition in @env{LS_COLORS} for the custom suffix -@samp{.readline-colored-completion-prefix}, Readline uses this color for +@samp{readline-colored-completion-prefix}, Readline uses this color for the common prefix instead of its default. The default is @samp{off}. diff --git a/lib/readline/isearch.c b/lib/readline/isearch.c index 9ddf9ce3..7c1a717b 100644 --- a/lib/readline/isearch.c +++ b/lib/readline/isearch.c @@ -742,10 +742,11 @@ opcode_dispatch: /* Add character to search string and continue search. */ default: #if defined (HANDLE_MULTIBYTE) - wlen = (cxt->mb[0] == 0 || cxt->mb[1] == 0) ? 1 : RL_STRLEN (cxt->mb); -#else - wlen = 1; + if (MB_CUR_MAX > 1 && rl_byte_oriented == 0) + wlen = (cxt->mb[0] == 0 || cxt->mb[1] == 0) ? 1 : RL_STRLEN (cxt->mb); + else #endif + wlen = 1; if (cxt->search_string_index + wlen + 1 >= cxt->search_string_size) { cxt->search_string_size += 128; /* 128 much greater than MB_CUR_MAX */ diff --git a/parse.y b/parse.y index 6ed8b5f0..a0535294 100644 --- a/parse.y +++ b/parse.y @@ -343,8 +343,8 @@ static int two_tokens_ago; /* Someday compoundcmd_lineno will be an array of these structs. */ struct tokeninfo { - int tok; int lineno; + int tok; }; /* The line number in a script where a compound command begins. The @@ -6790,6 +6790,9 @@ report_syntax_error (const char *message) free (msg); msg = p; } +if (shell_eof_token && current_token != shell_eof_token) + parser_error (line_number, _("syntax error near unexpected token `%s' while looking for matching `%c'"), msg, shell_eof_token); +else parser_error (line_number, _("syntax error near unexpected token `%s'"), msg); free (msg); diff --git a/print_cmd.c b/print_cmd.c index 36268e19..e7021338 100644 --- a/print_cmd.c +++ b/print_cmd.c @@ -1325,16 +1325,27 @@ print_function_def (FUNCTION_DEF *func) COMMAND *cmdcopy; REDIRECT *func_redirects; WORD_DESC *w; + int pflags; + + pflags = 0; + if (posixly_correct) + { + pflags |= 4; /* no reserved words */ +#if POSIX_RESTRICT_FUNCNAME + pflags |= 1; /* function names must be valid identifiers */ +#endif + } w = pretty_print_mode ? dequote_word (func->name) : func->name; /* we're just pretty-printing, so this can be destructive */ func_redirects = NULL; /* When in posix mode, print functions as posix specifies them, but prefix - `function' to words that are not valid POSIX identifiers. */ + `function' to names that are not valid posix function names, as + determined by valid_function_name(). */ if (posixly_correct == 0) cprintf ("function %s () \n", w->word); - else if (valid_function_name (w->word, posixly_correct) == 0) + else if (valid_function_name (w->word, pflags) == 0) cprintf ("function %s () \n", w->word); else cprintf ("%s () \n", w->word); @@ -1392,6 +1403,16 @@ named_function_string (char *name, COMMAND *command, int flags) int old_indent, old_amount; COMMAND *cmdcopy; REDIRECT *func_redirects; + int pflags; + + pflags = 0; + if (posixly_correct) + { + pflags |= 4; /* no reserved words */ +#if POSIX_RESTRICT_FUNCNAME + pflags |= 1; /* function names must be valid identifiers */ +#endif + } old_indent = indentation; old_amount = indentation_amount; @@ -1401,7 +1422,7 @@ named_function_string (char *name, COMMAND *command, int flags) if (name && *name) { - if (valid_function_name (name, posixly_correct) == 0) + if (valid_function_name (name, pflags) == 0) cprintf ("function "); cprintf ("%s ", name); } diff --git a/tests/comsub-posix.right b/tests/comsub-posix.right index 037f0ed2..ce606f8f 100644 --- a/tests/comsub-posix.right +++ b/tests/comsub-posix.right @@ -76,22 +76,22 @@ swap32_posix () )); done } -bash: -c: line 1: syntax error near unexpected token `done' +bash: -c: line 1: syntax error near unexpected token `done' while looking for matching `)' bash: -c: line 1: `: $(case x in x) ;; x) done esac)' -bash: -c: line 1: syntax error near unexpected token `done' +bash: -c: line 1: syntax error near unexpected token `done' while looking for matching `)' bash: -c: line 1: `: $(case x in x) ;; x) done ;; esac)' -bash: -c: line 1: syntax error near unexpected token `esac' +bash: -c: line 1: syntax error near unexpected token `esac' while looking for matching `)' bash: -c: line 1: `: $(case x in x) (esac) esac)' -bash: -c: line 1: syntax error near unexpected token `in' +bash: -c: line 1: syntax error near unexpected token `in' while looking for matching `)' bash: -c: line 1: `: $(case x in esac|in) foo;; esac)' -bash: -c: line 1: syntax error near unexpected token `done' +bash: -c: line 1: syntax error near unexpected token `done' while looking for matching `)' bash: -c: line 1: `: $(case x in x) ;; x) done)' -case: -c: line 3: syntax error near unexpected token `esac' +case: -c: line 3: syntax error near unexpected token `esac' while looking for matching `)' case: -c: line 3: `$( esac ; bar=foo ; echo "$bar")) echo bad 2;;' ok 2 inside outside ok 3 -syntax-error: -c: line 2: syntax error near unexpected token `done' +syntax-error: -c: line 2: syntax error near unexpected token `done' while looking for matching `)' syntax-error: -c: line 2: `: $(case x in x) ;; x) done ;; esac)' yes diff --git a/tests/errors.right b/tests/errors.right index d9ddde73..1f118e77 100644 --- a/tests/errors.right +++ b/tests/errors.right @@ -68,7 +68,7 @@ umask: usage: umask [-p] [-S] [mode] ./errors.tests: line 214: VAR: readonly variable comsub: -c: line 1: syntax error near unexpected token `)' comsub: -c: line 1: `: $( for z in 1 2 3; do )' -comsub: -c: line 1: syntax error near unexpected token `done' +comsub: -c: line 1: syntax error near unexpected token `done' while looking for matching `)' comsub: -c: line 1: `: $( for z in 1 2 3; done )' ./errors.tests: line 221: cd: HOME not set ./errors.tests: line 222: cd: /tmp/xyz.bash: No such file or directory @@ -130,7 +130,7 @@ kill: usage: kill [-s sigspec | -n signum | -sigspec] pid | jobspec ... or kill kill: usage: kill [-s sigspec | -n signum | -sigspec] pid | jobspec ... or kill -l [sigspec] ./errors.tests: line 332: kill: SIGBAD: invalid signal specification ./errors.tests: line 334: kill: BAD: invalid signal specification -./errors.tests: line 336: kill: @12: arguments must be process or job IDs +./errors.tests: line 336: kill: `@12': not a pid or valid job spec ./errors.tests: line 339: unset: BASH_LINENO: cannot unset ./errors.tests: line 339: unset: BASH_SOURCE: cannot unset ./errors.tests: line 342: set: trackall: invalid option name @@ -343,4 +343,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 396: `!!': not a valid identifier +end diff --git a/tests/errors.tests b/tests/errors.tests index f0799c33..d10935dc 100644 --- a/tests/errors.tests +++ b/tests/errors.tests @@ -388,10 +388,8 @@ ${THIS_SH} -o posix -c '. /nosuchfile ; echo after source' sh # but trap specifying a bad signal nunber is non-fatal ${THIS_SH} -o posix -c 'trap "echo bad" SIGNOSIG; echo after trap' sh -# this must be last! -# in posix mode, a function name must be a valid identifier -# this can't go in posix2.tests, since it causes the shell to exit -# immediately +# in posix mode, this is no longer a fatal error +# a function name does not have to be a valid identifier set -o posix function !! () { fc -s "$@" ; } set +o posix diff --git a/tests/func.right b/tests/func.right index 2c83a0fb..dfe6c20d 100644 --- a/tests/func.right +++ b/tests/func.right @@ -175,7 +175,7 @@ function a=2 () { printf "FUNCNAME: %s\n" $FUNCNAME } -function 11111 () +11111 () { printf "FUNCNAME: %s\n" $FUNCNAME } @@ -242,14 +242,13 @@ break () execution inside function break ./func5.sub: line 86: `break': is a special builtin -./func5.sub: line 92: `!!': not a valid identifier !! is a function !! () { fc -s "$@" } !! is a function -function !! () +!! () { fc -s "$@" } diff --git a/tests/func5.sub b/tests/func5.sub index bacb82db..357e4cc1 100644 --- a/tests/func5.sub +++ b/tests/func5.sub @@ -85,15 +85,15 @@ break() echo after ) -# in posix mode, functions whose names are invalid identifiers are fatal errors +# in posix mode, functions whose names are invalid identifiers are +# no longer fatal errors ( set -o posix !! () { fc -s "$@" ; } type \!\! ) -# but you can create such functions and print them in posix mode -!! () { fc -s "$@" ; } -type '!!' +# you can create such functions and print them in posix mode set -o posix +!! () { fc -s "$@" ; } type '!!' set +o posix diff --git a/tests/jobs.right b/tests/jobs.right index f8037bc8..442b8260 100644 --- a/tests/jobs.right +++ b/tests/jobs.right @@ -79,6 +79,7 @@ bg: usage: bg [job_spec ...] disown: usage: disown [-h] [-ar] [jobspec ... | pid ...] ./jobs.tests: line 141: disown: %1: no such job ./jobs.tests: line 144: disown: %2: no such job +./jobs.tests: line 147: disown: warning: @12: job specification requires leading `%' ./jobs.tests: line 147: disown: @12: no such job wait-for-non-child ./jobs.tests: line 150: wait: pid 1 is not a child of this shell