Bash - (Builtin|Intern|System|Reserved|Shell) variable name

> Procedural Languages > Bash Shell and (Unix|Linux) Utilities (XCU)

1 - About

Reserved variable name are named that have a special meaning for the bash shell.

Advertising

3 - Examples of built-in shell variables

  • PS1 defines the shell's command-line prompt.
  • HOME defines the home directory for a user.
  • PATH defines a list of directories to search through when looking for a command to execute.

4 - List

4.1 - BASH

Bash: Expands to the full file name used to invoke this instance of bash.

4.2 - BASH_ARGC

An array variable whose values are the number of parameters in each frame of the current bash execution call stack.

The number of parameters to the current subroutine (shell function or script executed with . or source) is at the top of the stack.

When a subroutine is executed, the number of parameters passed is pushed onto BASH_ARGC.

The shell sets BASH_ARGC only when in extended debugging mode (see the description of the extdebug option to the shopt builtin)

4.3 - BASH_ARGV

An array variable containing all of the parameters in the current bash execution call stack.

  • The final parameter of the last subroutine call is at the top of the stack;
  • the first parameter of the initial call is at the bottom.

When a subroutine is executed, the parameters supplied are pushed onto BASH_ARGV.

The shell sets BASH_ARGV only when in extended debugging mode (see the description of the extdebug option to the shopt builtin)

Advertising

4.4 - BASH_COMMAND

The command currently being executed or about to be executed, unless the shell is executing a command as the result of a trap, in which case it is the command executing at the time of the trap.

4.5 - BASH_EXECUTION_STRING

The command argument to the -c invocation option. See Bash - Bash cli

4.6 - BASH_LINENO

An array variable whose members are the line numbers in source files corresponding to each member of FUNCNAME. ${BASH_LINENO[$i]} is the line number in the source file where ${FUNCNAME[$i]} was called. The corresponding source file name is ${BASH_SOURCE[$i]}. Use LINENO to obtain the current line number.

4.7 - BASH_REMATCH

An array variable whose members are assigned by the =~ binary operator to the [[ conditional command. The element with index 0 is the portion of the string matching the entire regular expression. The element with index n is the portion of the string matching the nth parenthesized subexpression. This variable is read-only.

4.8 - BASH_SOURCE

An array variable whose members are the source filenames corresponding to the elements in the FUNCNAME array variable.

4.9 - BASH_SUBSHELL

Incremented by one each time a subshell or subshell environment is spawned. The initial value is 0.

4.10 - Bash Version

  • BASH_VERSINFO
  • BASH_VERSION
Advertising

4.11 - Completion

The below variable are available only in shell functions and external commands invoked by the programmable completion facilities. See Bash - Complete (Builtin command) - Completion

4.11.1 - COMP_CWORD

An index into ${COMP_WORDS} of the word containing the current cursor position.

4.11.2 - COMP_LINE

The current command line.

4.11.3 - COMP_POINT

The index of the current cursor position relative to the beginning of the current command. If the current cursor position is at the end of the current command, the value of this variable is equal to ${#COMP_LINE}.

4.11.4 - COMP_WORDBREAKS

The set of characters that the Readline library treats as word separators when performing word completion. If COMP_WORDBREAKS is unset, it loses its special properties, even if it is subsequently reset.

4.11.5 - COMP_WORDS

An array variable consisting of the individual words in the current command line. The words are split on shell metacharacters as the shell parser would separate them.

4.12 - DIRSTACK

An array variable containing the current contents of the directory stack. Directories appear in the stack in the order they are displayed by the dirs builtin.

Assigning to members of this array variable may be used to modify directories already in the stack, but the pushd and popd builtins must be used to add and remove directories.

Assignment to this variable will not change the current directory. If DIRSTACK is unset, it loses its special properties, even if it is subsequently reset.

4.13 - EUID

Expands to the effective User ID of the current user, initialized at shell startup. This variable is readonly.

4.14 - FUNCNAME

An array variable containing the names of all shell functions currently in the execution call stack.

  • The element with index 0 is the name of any currently-executing shell function.
  • The bottom-most element is main.

This variable exists only when a shell function is executing.

Assignments to FUNCNAME have no effect and return an error status. If FUNCNAME is unset, it loses its special properties, even if it is subsequently reset.

4.15 - GROUPS

An array variable containing the list of groups of which the current user is a member.

Assignments to GROUPS have no effect and return an error status.

If GROUPS is unset, it loses its special properties, even if it is subsequently reset.

4.16 - HISTCMD

The history number, or index in the history list, of the current command. If HISTCMD is unset, it loses its special properties, even if it is subsequently reset.

4.17 - HOSTNAME

Automatically set to the name of the current host.

4.18 - HOSTTYPE

Automatically set to a string that uniquely describes the type of machine on which bash is executing. The default is systemdependent.

4.19 - LINENO

Each time this parameter is referenced, the shell substitutes a decimal number representing the current sequential line number (starting with 1) within a script or function. When not in a script or function, the value substituted is not guaranteed to be meaningful. If LINENO is unset, it loses its special properties, even if it is subsequently reset.

4.20 - MACHTYPE

Automatically set to a string that fully describes the system type on which bash is executing, in the standard GNU cpu-company-system format. The default is system-dependent.

4.21 - OLDPWD

The previous working directory as set by the cd command.

4.22 - Getopts

Variable for the getopts builtin command.

4.22.1 - OPTARG

The value of the last option argument processed

4.22.2 - OPTIND

The index of the next argument to be processed

4.23 - OSTYPE

Automatically set to a string that describes the operating system on which bash is executing. The default is system-dependent.

4.24 - PIPESTATUS

An array variable containing a list of exit status values from the processes in the most-recently-executed foreground pipeline (which may contain only a single command).

4.25 - PPID

The process ID of the shell's parent. This variable is readonly.

4.26 - PWD

The current working directory as set by the cd command.

4.27 - RANDOM

Each time this parameter is referenced, a random integer between 0 and 32767 is generated. The sequence of random numbers may be initialized by assigning a value to RANDOM. If RANDOM is unset, it loses its special properties, even if it is subsequently reset.

4.28 - REPLY

Set to the line of input read by the read builtin command when no arguments are supplied.

4.29 - SECONDS

Each time this parameter is referenced, the number of seconds since shell invocation is returned. If a value is assigned to SECONDS, the value returned upon subsequent references is the number of seconds since the assignment plus the value assigned. If SECONDS is unset, it loses its special properties, even if it is subsequently reset.

4.30 - SHELLOPTS

A colon-separated list of enabled shell options. Each word in the list is a valid argument for the -o option to the set builtin command (see SHELL BUILTIN COMMANDS below). The options appearing in SHELLOPTS are those reported as on by set -o. If this variable is in the environment when bash starts up, each shell option in the list will be enabled before reading any startup files. This variable is read-only.

SHLVL Incremented by one each time an instance of bash is started.

UID Expands to the user ID of the current user, initialized at shell startup. This variable is readonly.

The following variables are used by the shell. In some cases, bash assigns a default value to a variable; these cases are noted below.

4.31 - BASH_ENV

If this parameter is set when bash is executing a shell script, its value is interpreted as a filename containing commands to initialize the shell, as in ~/.bashrc. The value of BASH_ENV is subjected to parameter expansion, command substitution, and arithmetic expansion before being interpreted as a file name. PATH is not used to search for the resultant file name. CDPATH The search path for the cd command. This is a colon-separated list of directories in which the shell looks for destination directories specified by the cd command. A sample value is “.:~:/usr”.

4.32 - COLUMNS

Used by the select builtin command to determine the terminal width when printing selection lists. Automatically set upon receipt of a SIGWINCH.

4.33 - COMPREPLY

An array variable from which bash reads the possible completions generated by a shell function invoked by the programmable completion facility (see Programmable Completion below). EMACS If bash finds this variable in the environment when the shell starts with value “t”, it assumes that the shell is running in an emacs shell buffer and disables line editing. FCEDIT The default editor for the fc builtin command.

4.34 - FIGNORE

A colon-separated list of suffixes to ignore when performing filename completion (see READLINE below). A filename whose suffix matches one of the entries in FIGNORE is excluded from the list of matched filenames. A sample value is “.o:~”.

4.35 - GLOBIGNORE

A colon-separated list of patterns defining the set of filenames to be ignored by pathname expansion. If a filename matched by a pathname expansion pattern also matches one of the patterns in GLOBIGNORE, it is removed from the list of matches.

4.36 - HISTCONTROL

A colon-separated list of values controlling how commands are saved on the history list. If the list of values includes ignorespace, lines which begin with a space character are not saved in the history list. A value of ignoredups causes lines matching the previous history entry to not be saved. A value of ignoreboth is shorthand for ignorespace and ignoredups. A value of erasedups causes all previous lines matching the current line to be removed from the history list before that line is saved. Any value not in the above list is ignored. If HISTCONTROL is unset, or does not include a valid value, all lines read by the shell parser are saved on the history list, subject to the value of HISTIGNORE. The second and subsequent lines of a multi-line compound command are not tested, and are added to the history regardless of the value of HISTCONTROL.

4.37 - HISTFILE

The name of the file in which command history is saved. The default value is ~/.bash_history. If unset, the command history is not saved when an interactive shell exits.

4.38 - HISTFILESIZE

The maximum number of lines contained in the history file. When this variable is assigned a value, the history file is truncated, if necessary, by removing the oldest entries, to contain no more than that number of lines. The default value is 500. The history file is also truncated to this size after writing it when an interactive shell exits.

4.39 - HISTIGNORE

A colon-separated list of patterns used to decide which command lines should be saved on the history list. Each pattern is anchored at the beginning of the line and must match the complete line (no implicit * is appended). Each pattern is tested against the line after the checks specified by HISTCONTROL are applied. In addition to the normal shell pattern matching characters, & matches the previous history line. & may be escaped using a backslash; the backslash is removed before attempting a match. The second and subsequent lines of a multi-line compound command are not tested, and are added to the history regardless of the value of HISTIGNORE.

4.40 - HISTSIZE

The number of commands to remember in the command history. The default value is 500.

4.41 - HISTTIMEFORMAT

If this variable is set and not null, its value is used as a format string for strftime(3) to print the time stamp associated with each history entry displayed by the history builtin. If this variable is set, time stamps are written to the history file so they may be preserved across shell sessions.

4.42 - HOME

The home directory of the current user; the default argument for the cd builtin command. The value of this variable is also used when performing tilde expansion.

4.43 - HOSTFILE

Contains the name of a file in the same format as /etc/hosts that should be read when the shell needs to complete a hostname. The list of possible hostname completions may be changed while the shell is running; the next time hostname completion is attempted after the value is changed, bash adds the contents of the new file to the existing list. If HOSTFILE is set, but has no value, bash attempts to read /etc/hosts to obtain the list of possible hostname completions. When HOSTFILE is unset, the hostname list is cleared. IFS The Internal Field Separator that is used for word splitting after expansion and to split lines into words with the read builtin command. The default value is <space><tab><newline>.

4.44 - IGNOREEOF

Controls the action of an interactive shell on receipt of an EOF character as the sole input. If set, the value is the number of consecutive EOF characters which must be typed as the first characters on an input line before bash exits. If the variable exists but does not have a numeric value, or has no value, the default value is 10. If it does not exist, EOF signifies the end of input to the shell.

4.45 - INPUTRC

The filename for the readline startup file, overriding the default of ~/.inputrc (see READLINE below). LANG Used to determine the locale category for any category not specifically selected with a variable starting with LC_. LC_ALL This variable overrides the value of LANG and any other LC_ variable specifying a locale category.

4.46 - LC_COLLATE

This variable determines the collation order used when sorting the results of pathname expansion, and determines the behavior of range expressions, equivalence classes, and collating sequences within pathname expansion and pattern matching.

4.47 - LC_CTYPE

This variable determines the interpretation of characters and the behavior of character classes within pathname expansion and pattern matching.

4.48 - LC_MESSAGES

This variable determines the locale used to translate doublequoted strings preceded by a $.

4.49 - LC_NUMERIC

This variable determines the locale category used for number formatting.

4.50 - LINES

Used by the select builtin command to determine the column length for printing selection lists. Automatically set upon receipt of a SIGWINCH.

4.51 - MAIL

If this parameter is set to a file name and the MAILPATH variable is not set, bash informs the user of the arrival of mail in the specified file.

4.52 - MAILCHECK

Specifies how often (in seconds) bash checks for mail. The default is 60 seconds. When it is time to check for mail, the shell does so before displaying the primary prompt. If this variable is unset, or set to a value that is not a number greater than or equal to zero, the shell disables mail checking.

4.53 - MAILPATH

A colon-separated list of file names to be checked for mail. The message to be printed when mail arrives in a particular file may be specified by separating the file name from the message with a ?. When used in the text of the message, $_ expands to the name of the current mailfile. Example: MAILPATH='/var/mail/bfox?“You have mail”:~/shell-mail?“$_ has mail!”' Bash supplies a default value for this variable, but the location of the user mail files that it uses is system dependent (e.g., /var/mail/$USER).

4.54 - OPTERR

If set to the value 1, bash displays error messages generated by the getopts builtin command (see SHELL BUILTIN COMMANDS below). OPTERR is initialized to 1 each time the shell is invoked or a shell script is executed.

4.55 - PATH

The search path for commands. It is a colon-separated list of directories in which the shell looks for commands. A zero-length (null) directory name in the value of PATH indicates the current directory. A null directory name may appear as two adjacent colons, or as an initial or trailing colon. The default path is system-dependent, and is set by the administrator who installs bash. A common value is /usr/gnu/bin:/usr/local/bin:/usr/ucb:/bin:/usr/bin.

4.56 - POSIXLY_CORRECT

If this variable is in the environment when bash starts, the shell enters posix mode before reading the startup files, as if the –posix invocation option had been supplied. If it is set while the shell is running, bash enables posix mode, as if the command set -o posix had been executed.

4.57 - PROMPT_COMMAND

If set, the value is executed as a command prior to issuing each primary prompt.

  • PS1 The value of this parameter is expanded and used as the primary prompt string. The default value is \s-\v\$ .
  • PS2 The value of this parameter is expanded as with PS1 and used as the secondary prompt string. The default is > .
  • PS3 The value of this parameter is used as the prompt for the select command.
  • PS4 The value of this parameter is expanded as with PS1 and the value is printed before each command bash displays during an execution trace. The first character of PS4 is replicated multiple times, as necessary, to indicate multiple levels of indirection. The default is + .
  • SHELL The full pathname to the shell is kept in this environment variable. If it is not set when the shell starts, bash assigns to it the full pathname of the current user's login shell.

4.58 - TIMEFORMAT

The value of this parameter is used as a format string specifying how the timing information for pipelines prefixed with the time reserved word should be displayed.

4.59 - TMOUT

If set to a value greater than zero, TMOUT is treated as the default timeout for the read builtin. The select command terminates if input does not arrive after TMOUT seconds when input is coming from a terminal. In an interactive shell, the value is interpreted as the number of seconds to wait for input after issuing the primary prompt. Bash terminates after waiting for that number of seconds if input does not arrive.

4.60 - TMPDIR

If set, Bash uses its value as the name of a directory in which Bash creates temporary files for the shell's use.

4.61 - auto_resume

This variable controls how the shell interacts with the user and job control.

If this variable is set, single word simple commands without redirections are treated as candidates for resumption of an existing stopped job. There is no ambiguity allowed; if there is more than one job beginning with the string typed, the job most recently accessed is selected. The name of a stopped job, in this context, is the command line used to start it.

If set to the value exact, the string supplied must match the name of a stopped job exactly; if set to substring, the string supplied needs to match a substring of the name of a stopped job.

The substring value provides functionality analogous to the %? job identifier. If set to any other value, the supplied string must be a prefix of a stopped job's name; this provides functionality analogous to the %string job identifier.

4.62 - histchars

The two or three characters which control history expansion and tokenization.

  • The first character is the history expansion character, the character which signals the start of a history expansion, normally !.
  • The second character is the quick substitution character, which is used as shorthand for re-running the previous command entered, substituting one string for another in the command. The default is ^.
  • The optional third is the history comment character (The remainder of the line is a comment), normally #. The history comment character causes history substitution to be skipped for the remaining words on the line. It does not necessarily cause the shell parser to treat the rest of the line as a comment.

5 - Documentation / Reference

lang/bash/shell_variable.txt · Last modified: 2019/05/19 11:39 by 172.69.68.91