Concise Bash Reference Sheet

• Work in progress

Builtins

Dummies

• true (or :): These commands do nothing at all. They are NOPs that always return successfully.

• false: The same as above, except that the command always "fails". It returns an exit code of 1 indicating failure.

Declarative

• alias: Sets up a Bash alias, or print the bash alias with the given name.

  • Aliasses replace a word in the beginning of a command by something else. They only work in interactive shells (not scripts).

• declare (or typeset): Assign a value to a variable. Each argument is a new variable assignment. Each argument's part before the equal sign is the name of the variable, and after comes the data of the variable. Options to declare can be used to toggle special variable flags (like read-only/export/integer/array).

• export: Export the given variable to the environment so that child processes inherit it. This is the same as declare -x.

  • Remember that for the child process, the variable is not the same as the one you exported. It just holds the same data. Which means, you can't change the variable data and expect it to change in the parent process, too.

• local: Declare a variable to have a scope limited to the current function. As soon as the function exits, the variable disappears. Assigning to it in a function also doesn't change a global variable with the same name, should one exist. The same options as taken by declare can be passed to local.

• type: Show the type of the command name specified as argument. The type can be either: alias, keyword, function, builtin, or file.

Input

• read: Read a line (unless the -d option is used to change the delimiter from newline to something else) and put it in the variables denoted by the arguments given to read. If more than one variable name is given, split the line up using the characters in IFS as delimitors. If less variable names are given than there are split chunks in the line, the last variable gets all data left unsplit.

Output

• echo: Output each argument given to echo on one line, separated by a single space. The first arguments can be options that toggle special behaviour (like no newline at end/evaluate escape sequences).

• printf: Use the first argument as a format specifier of how to output the other arguments. See help printf.

• pwd: Output the absolute pathname of the current working directory. You can use the -P option to make pwd resolve any symlinks in the pathname.

Execution

• cd: Changes the current directory to the given path. If the path doesn't start with a slash, it is relative to the current directory.

• command: Run the first argument as an application, don't try to look for an alias, function, builtin or keyword by that name.

• . or source: Makes Bash read the filename given as first argument and execute its contents in the current shell (kind of like include in other languages). If more arguments are given than just a filename to source, those arguments are set as the positional parameters during the execution of the sourced code.

  • If the filename to source has no slash in it, PATH is searched for it.

• exec: Run the command given as first argument and replace the current shell with it. Other arguments are passed to the command as its arguments. If no arguments are given to exec but you do specify Redirections on the exec command, the redirections will be applied to the current shell.

• exit: End the execution of the current script. If an argument is given, it is the exit status of the current script (an integer between 0 and 255).

• logout: End the execution of a login shell.

• return: End the execution of the current function. An exit status may be specified just like with the exit builtin.

• ulimit: Modify resource limitations of the current shell's process. These limits are inherited by child processes.

Jobs/Processes

• jobs: List the current shell's active jobs.

• bg: Send the previous job (or job denoted by the given argument) to run in the background. (The shell continues to run while the job is running. The shell's input is handled by itself, not the job.)

• fg: Send the previous job (or job denoted by the given argument) to run in the foreground. (The shell waits for the job to end and the job can receive the input from the shell.)

• kill: Send a signal(3) to a process or job. As argument, give the process ID of the process or the jobspec of the job you want to send the signal to.

• trap: Handle a signal(3) sent to the current shell. The code that is in the first argument is executed whenever a signal is received denoted by any of the other arguments to trap.

• suspend: Stops the execution of the current shell until it receives a SIGCONT signal. This is much like what happens when the shell receives a SIGSTOP signal.

• wait: Stops the execution of the current shell until active jobs have finished. In arguments, you can specify which jobs (by jobspec) or processes (by PID) to wait for.

Conditionals And Loops

• break: Break out of the current loop. When more than one loop is active, break out the last one declared. When a number is given as argument to break, break out of number loops, starting with the last one declared.

• continue: Skip the code that is left in the current loop and start a new iteration of that loop. Just like with break, a number may be given to skip out more loops.

Arguments

• getops: Puts an option specified in the arguments in a variable. getopts Uses the first argument as a specification for which options to look for in the arguments. It then takes the first option in the arguments that is mentioned in this option specification (or next option, if getopts has been ran before), and puts this option in the variable denoted by the name in the second argument to getopts.

  • This command is pretty much always used in a loop: while getopts abc opt; do case $opt in a) ...;; b) ...;; c) ...;; esac; done. This way all options in the arguments are parsed and when they are either -a, -b or -c, the respective code in the case statement is executed. Following short style is also valid for specifying multiple options in the arguments that getopts parses: -ac.

• set: The set command normally sets various Shell options, but can also set Positional parameters.

  • Shell options are options that can be passed to the shell, such as bash -x or bash -e.

    • set toggles shell options like this: set -x, set +x, set -e, ...

    Positional parameters are parameters that hold arguments that were passed to the script or shell, such as bash myscript -foo /bar.

    • set assigns positional parameters like this: set -- -foo /bar.

• shift: Moves all positional parameters' values one parameter back. This way, values that were in $1 are discarted, values from $2 go into $1, values from $3 go into $2, and so on. You can specify an argument to shift which is an integer that specifies how many times to repeat this shift.