What makes a character special? If it has a meaning beyond its literal meaning, a meta-meaning, then we refer to it as a special character.
Special Characters Found In Scripts and Elsewhere
Comments. Lines beginning with a # (with the exception of #!) are comments and will not be executed.
# This line is a comment. |
Comments may also occur following the end of a command.
echo "A comment will follow." # Comment here. # ^ Note whitespace before # |
Comments may also follow whitespace at the beginning of a line.
# A tab precedes this comment. |
![]() | A command may not follow a comment on the same line. There is no method of terminating the comment, in order for "live code" to begin on the same line. Use a new line for the next command. |
![]() | Of course, a quoted or an escaped # in an echo statement does not begin a comment. Likewise, a # appears in certain parameter-substitution constructs and in numerical constant expressions.
|
Certain pattern matching operations also use the #.
Command separator [semicolon]. Permits putting two or more commands on the same line.
echo hello; echo there
if [ -x "$filename" ]; then # Note that "if" and "then" need whitespace
#+ separation. Why?
echo "File $filename exists."; cp $filename $filename.bak
else
echo "File $filename not found."; touch $filename
fi; echo "File test complete." |
Note that the ";" sometimes needs to be escaped.
Terminator in a case option [double semicolon].
case "$variable" in abc) echo "\$variable = abc" ;; xyz) echo "\$variable = xyz" ;; esac |
"dot" command [period]. Equivalent to source (see Example 14-22). This is a bash builtin.
"dot", as a component of a filename. When working with filenames, a leading dot is the prefix of a "hidden" file, a file that an ls will not normally show.
|
When considering directory names, a single dot represents the current working directory, and two dots denote the parent directory.
|
The dot often appears as the destination (directory) of a file movement command, in this context meaning current directory.
|
"dot" character match. When matching characters, as part of a regular expression, a "dot" matches a single character.
partial quoting [double quote]. "STRING" preserves (from interpretation) most of the special characters within STRING. See Chapter 5.
full quoting [single quote]. 'STRING' preserves all special characters within STRING. This is a stronger form of quoting than "STRING". See Chapter 5.
comma operator. The comma operator [1] links together a series of arithmetic operations. All are evaluated, but only the last one is returned.
let "t2 = ((a = 9, 15 / 3))" # Set "a = 9" and "t2 = 15 / 3" |
escape [backslash]. A quoting mechanism for single characters.
See Chapter 5 for an in-depth explanation of escaped characters.
Filename path separator [forward slash]. Separates the components of a filename (as in
This is also the division arithmetic operator.
command substitution. The `command` construct makes available the output of command for assignment to a variable. This is also known as backquotes or backticks.
null command [colon]. This is the shell equivalent of a
"NOP" (
: echo $? # 0 |
Endless loop:
while : do operation-1 operation-2 ... operation-n done # Same as: # while true # do # ... # done |
Placeholder in if/then test:
if condition then : # Do nothing and branch ahead else # Or else ... take-some-action fi |
Provide a placeholder where a binary operation is expected, see Example 8-2 and default parameters.
: ${username=`whoami`}
# ${username=`whoami`} Gives an error without the leading :
# unless "username" is a command or builtin... |
Provide a placeholder where a command is expected in a here document. See Example 18-10.
Evaluate string of variables using parameter substitution (as in Example 9-16).
: ${HOSTNAME?} ${USER?} ${MAIL?}
# Prints error message
#+ if one or more of essential environmental variables not set. |
Variable expansion / substring replacement.
In combination with the > redirection operator, truncates a file to zero length, without changing its permissions. If the file did not previously exist, creates it.
: > data.xxx # File "data.xxx" now empty. # Same effect as cat /dev/null >data.xxx # However, this does not fork a new process, since ":" is a builtin. |
In combination with the >>
redirection operator, has no effect on a pre-existing
target file (
![]() | This applies to regular files, not pipes, symlinks, and certain special files. |
May be used to begin a comment line, although this is not recommended. Using # for a comment turns off error checking for the remainder of that line, so almost anything may appear in a comment. However, this is not the case with :.
: This is a comment that generates an error, ( if [ $x -eq 3] ). |
The ":" also serves as a field
separator, in
|
reverse (or negate) the sense of a test or exit status [bang]. The ! operator inverts the exit status of the command to which it is applied (see Example 6-2). It also inverts the meaning of a test operator. This can, for example, change the sense of equal ( = ) to not-equal ( != ). The ! operator is a Bash keyword.
In a different context, the ! also appears in indirect variable references.
In yet another context, from the command line, the ! invokes the Bash history mechanism (see Appendix J). Note that within a script, the history mechanism is disabled.
wild card [asterisk]. The * character serves as a "wild card" for filename expansion in globbing. By itself, it matches every filename in a given directory.
|
The * also represents any number (or zero) characters in a regular expression.
arithmetic operator. In the context of arithmetic operations, the * denotes multiplication.
A double asterisk, **, is the exponentiation operator.
test operator. Within certain expressions, the ? indicates a test for a condition.
In a double-parentheses
construct, the ?
can serve as an element of a C-style
trinary operator,
(( var0 = var1<98?9:21 )) # ^ ^ # if [ "$var1" -lt 98 ] # then # var0=9 # else # var0=21 # fi |
In a parameter substitution expression, the ? tests whether a variable has been set.
wild card. The ? character serves as a single-character "wild card" for filename expansion in globbing, as well as representing one character in an extended regular expression.
Variable substitution (contents of a variable).
var1=5 var2=23skidoo echo $var1 # 5 echo $var2 # 23skidoo |
A $ prefixing a variable name indicates the value the variable holds.
end-of-line. In a regular expression, a "$" addresses the end of a line of text.
exit status variable. The $? variable holds the exit status of a command, a function, or of the script itself.
process ID variable. The $$ variable holds the process ID [2] of the script in which it appears.
command group.
(a=hello; echo $a) |
![]() | A listing of commands within
Variables inside parentheses, within the subshell, are not visible to the rest of the script. The parent process, the script, cannot read variables created in the child process, the subshell.
|
cat {file1,file2,file3} > combined_file
# Concatenates the files file1, file2, and file3 into combined_file.
cp file22.{txt,backup}
# Copies "file22.txt" to "file22.backup" |
A command may act upon a comma-separated list of file specs within
![]() | No spaces allowed within the braces unless the spaces are quoted or escaped. |
Extended Brace expansion.
echo {a..z} # a b c d e f g h i j k l m n o p q r s t u v w x y z
# Echoes characters between a and z.
echo {0..3} # 0 1 2 3
# Echoes characters between 0 and 3. |
The {a..z} extended brace expansion construction is a feature introduced in version 3 of Bash.
Block of code [curly brackets]. Also referred to as an inline group, this construct, in effect, creates an anonymous function (a function without a name). However, unlike in a "standard" function, the variables inside a code block remain visible to the remainder of the script.
|
a=123
{ a=321; }
echo "a = $a" # a = 321 (value inside code block)
# Thanks, S.C. |
The code block enclosed in braces may have I/O redirected to and from it.
Example 3-1. Code blocks and I/O redirection
#!/bin/bash
# Reading lines in /etc/fstab.
File=/etc/fstab
{
read line1
read line2
} < $File
echo "First line in $File is:"
echo "$line1"
echo
echo "Second line in $File is:"
echo "$line2"
exit 0
# Now, how do you parse the separate fields of each line?
# Hint: use awk, or . . .
# . . . Hans-Joerg Diers suggests using the "set" Bash builtin. |
Example 3-2. Saving the output of a code block to a file
#!/bin/bash
# rpm-check.sh
# Queries an rpm file for description, listing,
#+ and whether it can be installed.
# Saves output to a file.
#
# This script illustrates using a code block.
SUCCESS=0
E_NOARGS=65
if [ -z "$1" ]
then
echo "Usage: `basename $0` rpm-file"
exit $E_NOARGS
fi
{ # Begin code block.
echo
echo "Archive Description:"
rpm -qpi $1 # Query description.
echo
echo "Archive Listing:"
rpm -qpl $1 # Query listing.
echo
rpm -i --test $1 # Query whether rpm file can be installed.
if [ "$?" -eq $SUCCESS ]
then
echo "$1 can be installed."
else
echo "$1 cannot be installed."
fi
echo # End code block.
} > "$1.test" # Redirects output of everything in block to file.
echo "Results of rpm test in file $1.test"
# See rpm man page for explanation of options.
exit 0 |
placeholder for text. Used after xargs
ls . | xargs -i -t cp ./{} $1
# ^^ ^^
# From "ex42.sh" (copydir.sh) example. |
anchor id="semicolonesc">
![]() | The ";" ends
the |
Test expression between
[ ]. Note that [
is part of the shell builtin test (and a synonym for it),
not a link to the external command
test.
Test expression between [[ ]]. More flexible than the single-bracket [ ] test, this is a shell keyword.
See the discussion on the [[ ... ]] construct.
array element.
In the context of an array, brackets set off the numbering of each element of that array.
Array[1]=slot_1
echo ${Array[1]} |
range of characters.
As part of a regular expression, brackets delineate a range of characters to match.
integer expansion.
Expand and evaluate integer expression between (( )).
See the discussion on the (( ... )) construct.
In a different context, the "<" and ">" characters act as string comparison operators.
In yet another context, the "<" and ">" characters act as integer comparison operators. See also Example 15-9.
redirection used in a here document.
redirection used in a here string.
veg1=carrots veg2=tomatoes if [[ "$veg1" < "$veg2" ]] then echo "Although $veg1 precede $veg2 in the dictionary," echo -n "this does not necessarily imply anything " echo "about my culinary preferences." else echo "What kind of dictionary are you using, anyhow?" fi |
pipe. Passes the output (
echo ls -l | sh # Passes the output of "echo ls -l" to the shell, #+ with the same result as a simple "ls -l". cat *.lst | sort | uniq # Merges and sorts all ".lst" files, then deletes duplicate lines. |
A pipe, as a classic method of interprocess
communication, sends the
For an interesting note on the complexity of using UNIX pipes, see the UNIX FAQ, Part 3. |
The output of a command or commands may be piped to a script.
#!/bin/bash # uppercase.sh : Changes input to uppercase. tr 'a-z' 'A-Z' # Letter ranges must be quoted #+ to prevent filename generation from single-letter filenames. exit 0 |
|
![]() | The
A pipe runs as a child process, and therefore cannot alter script variables.
If one of the commands in the pipe
aborts, this prematurely terminates execution of the
pipe. Called a broken pipe, this
condition sends a |
force redirection (even if the noclobber option is set). This will forcibly overwrite an existing file.
OR logical operator. In a test construct, the || operator causes a return of 0 (success) if either of the linked test conditions is true.
Run job in background. A command followed by an & will run in the background.
|
Within a script, commands and even loops may run in the background.
Example 3-3. Running a loop in the background
#!/bin/bash
# background-loop.sh
for i in 1 2 3 4 5 6 7 8 9 10 # First loop.
do
echo -n "$i "
done & # Run this loop in background.
# Will sometimes execute after second loop.
echo # This 'echo' sometimes will not display.
for i in 11 12 13 14 15 16 17 18 19 20 # Second loop.
do
echo -n "$i "
done
echo # This 'echo' sometimes will not display.
# ======================================================
# The expected output from the script:
# 1 2 3 4 5 6 7 8 9 10
# 11 12 13 14 15 16 17 18 19 20
# Sometimes, though, you get:
# 11 12 13 14 15 16 17 18 19 20
# 1 2 3 4 5 6 7 8 9 10 bozo $
# (The second 'echo' doesn't execute. Why?)
# Occasionally also:
# 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
# (The first 'echo' doesn't execute. Why?)
# Very rarely something like:
# 11 12 13 1 2 3 4 5 6 7 8 9 10 14 15 16 17 18 19 20
# The foreground loop preempts the background one.
exit 0
# Nasimuddin Ansari suggests adding sleep 1
#+ after the echo -n "$i" in lines 6 and 14,
#+ for some real fun. |
![]() | A command run in the background within a script may cause the script to hang, waiting for a keystroke. Fortunately, there is a remedy for this. |
AND logical operator. In a test construct, the && operator causes a return of 0 (success) only if both the linked test conditions are true.
option, prefix. Option flag for a command or filter. Prefix for an operator. Prefix for a default parameter in parameter substitution.
if [ $file1 -ot $file2 ]
then # ^
echo "File $file1 is older than $file2."
fi
if [ "$a" -eq "$b" ]
then ^
echo "$a is equal to $b."
fi
if [ "$c" -eq 24 -a "$d" -eq 47 ]
then ^ ^
echo "$c equals 24 and $d equals 47."
fi
param2=${param1:-$DEFAULTVAL}
# ^ |
--
The double-dash
Used with a Bash builtin, it means the end of options to that particular command.
![]() | This provides a handy means of removing files whose names begin with a dash.
|
The double-dash is also used in conjunction with set.
|
As expected,
(cd /source/directory && tar cf - . ) | (cd /dest/directory && tar xpvf -)
# Move entire file tree from one directory to another
# [courtesy Alan Cox <a.cox@swansea.ac.uk>, with a minor change]
# 1) cd /source/directory
# Source directory, where the files to be moved are.
# 2) &&
# "And-list": if the 'cd' operation successful,
# then execute the next command.
# 3) tar cf - .
# The 'c' option 'tar' archiving command creates a new archive,
# the 'f' (file) option, followed by '-' designates the target file
# as stdout, and do it in current directory tree ('.').
# 4) |
# Piped to ...
# 5) ( ... )
# a subshell
# 6) cd /dest/directory
# Change to the destination directory.
# 7) &&
# "And-list", as above
# 8) tar xpvf -
# Unarchive ('x'), preserve ownership and file permissions ('p'),
# and send verbose messages to stdout ('v'),
# reading data from stdin ('f' followed by '-').
#
# Note that 'x' is a command, and 'p', 'v', 'f' are options.
#
# Whew!
# More elegant than, but equivalent to:
# cd source/directory
# tar cf - . | (cd ../dest/directory; tar xpvf -)
#
# Also having same effect:
# cp -a /source/directory/* /dest/directory
# Or:
# cp -a /source/directory/* /source/directory/.[^.]* /dest/directory
# If there are hidden files in /source/directory. |
bunzip2 -c linux-2.6.16.tar.bz2 | tar xvf - # --uncompress tar file-- | --then pass it to "tar"-- # If "tar" has not been patched to handle "bunzip2", #+ this needs to be done in two discrete steps, using a pipe. # The purpose of the exercise is to unarchive "bzipped" kernel source. |
Note that in this context the "-" is not
itself a Bash operator, but rather an option recognized by
certain UNIX utilities that write to
|
Where a filename is expected,
|
Add a "-" for a more useful result. This causes the shell to await user input.
|
The "-" can be used to pipe
Using diff to compare a file with a section of another:
Finally, a real-world example using
Example 3-4. Backup of all files changed in last day
#!/bin/bash
# Backs up all files in current directory modified within last 24 hours
#+ in a "tarball" (tarred and gzipped file).
BACKUPFILE=backup-$(date +%m-%d-%Y)
# Embeds date in backup filename.
# Thanks, Joshua Tschida, for the idea.
archive=${1:-$BACKUPFILE}
# If no backup-archive filename specified on command line,
#+ it will default to "backup-MM-DD-YYYY.tar.gz."
tar cvf - `find . -mtime -1 -type f -print` > $archive.tar
gzip $archive.tar
echo "Directory $PWD backed up in archive file \"$archive.tar.gz\"."
# Stephane Chazelas points out that the above code will fail
#+ if there are too many files found
#+ or if any filenames contain blank characters.
# He suggests the following alternatives:
# -------------------------------------------------------------------
# find . -mtime -1 -type f -print0 | xargs -0 tar rvf "$archive.tar"
# using the GNU version of "find".
# find . -mtime -1 -type f -exec tar rvf "$archive.tar" '{}' \;
# portable to other UNIX flavors, but much slower.
# -------------------------------------------------------------------
exit 0 |
![]() | Filenames beginning with
"-" may cause problems when coupled with the
"-" redirection operator. A script should
check for this and add an appropriate prefix to such
filenames, for example If the value of a variable begins with a
|
previous working directory. A cd - command changes to the previous working directory. This uses the $OLDPWD environmental variable.
![]() | Do not confuse the "-" used in this sense with the "-" redirection operator just discussed. The interpretation of the "-" depends on the context in which it appears. |
Minus. Minus sign in an arithmetic operation.
Equals. Assignment operator
a=28 echo $a # 28 |
In a different context, the "=" is a string comparison operator.
Plus. Addition arithmetic operator.
In a different context, the + is a Regular Expression operator.
Option. Option flag for a command or filter.
Certain commands and builtins use the
modulo. Modulo (remainder of a division) arithmetic operation.
let "z = 5 % 3" echo $z # 2 |
In a different context, the % is a pattern matching operator.
home directory [tilde]. This corresponds to the $HOME internal variable.
|
current working directory. This corresponds to the $PWD internal variable.
previous working directory. This corresponds to the $OLDPWD internal variable.
regular expression match. This operator was introduced with version 3 of Bash.
beginning-of-line. In a regular expression, a "^" addresses the beginning of a line of text.
change the behavior of the terminal or text display. A control character is a CONTROL + key combination (pressed simultaneously). A control character may also be written in octal or hexadecimal notation, following an escape.
Control characters are not normally useful inside a script.
Moves cursor to beginning of line of text (on the command-line).
Log out from a shell (similar to exit).
When typing text on the console or in an
xterm window,
Moves cursor to end of line of text (on the command-line).
Moves cursor forward one character position (on the command-line).
#!/bin/bash
# Embedding Ctl-H in a string.
a="^H^H" # Two Ctl-H's -- backspaces
# ctl-V ctl-H, using vi/vim
echo "abcdef" # abcdef
echo
echo -n "abcdef$a " # abcd f
# Space at end ^ ^ Backspaces twice.
echo
echo -n "abcdef$a" # abcdef
# No space at end ^ Doesn't backspace (why?).
# Results may not be quite as expected.
echo; echo
# Constantin Hagemeier suggests trying:
# a=$'\010\010'
# a=$'\b\b'
# a=$'\x08\x08'
# But, this does not change the results. |
When typing text on the console or in an
xterm window,
#!/bin/bash
# Thank you, Lee Maschmeyer, for this example.
read -n 1 -s -p \
$'Control-M leaves cursor at beginning of this line. Press Enter. \x0d'
# Of course, '0d' is the hex equivalent of Control-M.
echo >&2 # The '-s' makes anything typed silent,
#+ so it is necessary to go to new line explicitly.
read -n 1 -s -p $'Control-J leaves cursor on next line. \x0a'
# '0a' is the hex equivalent of Control-J, linefeed.
echo >&2
###
read -n 1 -s -p $'And Control-K\x0bgoes straight down.'
echo >&2 # Control-K is vertical tab.
# A better example of the effect of a vertical tab is:
var=$'\x0aThis is the bottom line\x0bThis is the top line\x0a'
echo "$var"
# This works the same way as the above example. However:
echo "$var" | col
# This causes the right end of the line to be higher than the left end.
# It also explains why we started and ended with a line feed --
#+ to avoid a garbled screen.
# As Lee Maschmeyer explains:
# --------------------------
# In the [first vertical tab example] . . . the vertical tab
#+ makes the printing go straight down without a carriage return.
# This is true only on devices, such as the Linux console,
#+ that can't go "backward."
# The real purpose of VT is to go straight UP, not down.
# It can be used to print superscripts on a printer.
# The col utility can be used to emulate the proper behavior of VT.
exit 0 |
Erases a line of text recalled from history buffer [6] (on the command-line).
Issues a newline (on the command-line).
Recalls last command from history buffer (on the command-line).
Resume (
This resumes
Backwards search for text in history buffer (on the command-line).
Suspend (
This freezes
Reverses the position of the character the cursor is on with the previous character (on the command-line).
Erase a line of input, from the cursor backward to
beginning of line. In some settings,
When inputting text,
echo -e '\x0a' echo <Ctl-V><Ctl-J> |
When typing text on the console or in an xterm window,
In certain word processing programs, Cuts highlighted text and copies to clipboard.
Pastes back text previously
erased (with
Pauses a foreground job.
Substitute operation in certain word processing applications.
functions as a separator, separating commands or variables. Whitespace consists of either spaces, tabs, blank lines, or any combination thereof. [7] In some contexts, such as variable assignment, whitespace is not permitted, and results in a syntax error.
Blank lines have no effect on the action of a script, and are therefore useful for visually separating functional sections.
$IFS, the special variable separating fields of input to certain commands, defaults to whitespace.
To preserve whitespace within a string or in a variable, use quoting.
UNIX filters can target and operate on whitespace using the POSIX character class [:space:].
| [1] | An operator is an agent that carries out an operation. Some examples are the common arithmetic operators, + - * /. In Bash, there is some overlap between the concepts of operator and keyword. | |
| [2] | A PID, or process ID, is a number assigned to a running process. The PIDs of running processes may be viewed with a ps command. Definition: A process is an executing program, sometimes referred to as a job. | |
| [3] | The shell does the brace expansion. The command itself acts upon the result of the expansion. | |
| [4] | Exception: a code block in braces as part of a pipe may run as a subshell.
| |
| [5] | Even as in olden times a philtre denoted a potion alleged to have magical transformative powers, so does a UNIX filter transform its target in (rougly) analogous fashion. (The coder who comes up with a "love philtre" that runs on a Linux machine will likely win accolades and honors.) | |
| [6] | Bash stores a list of commands previously issued from the command-line in a buffer, or memory space, for recall with the builtin history commands. | |
| [7] | A linefeed (newline) is also a whitespace character. This explains why a blank line, consisting only of a linefeed, is considered whitespace. |