2 Linux - Advanced Bash Shell Scripting Gude
2 Linux - Advanced Bash Shell Scripting Gude
Brindle-Phlogiston Associates
16 June 2002
Revision History
Revision 0.1 14 June 2000 Revised by: mc
Initial release.
Revision 0.2 30 October 2000 Revised by: mc
Bugs fixed, plus much additional material and more example scripts.
Revision 0.3 12 February 2001 Revised by: mc
Another major update.
Revision 0.4 08 July 2001 Revised by: mc
More bugfixes, much more material, more scripts - a complete revision and expansion of
the book.
Revision 0.5 03 September 2001 Revised by: mc
Major update. Bugfixes, material added, chapters and sections reorganized.
Revision 1.0 14 October 2001 Revised by: mc
Bugfixes, reorganization, material added. Stable release.
Revision 1.1 06 January 2002 Revised by: mc
Bugfixes, material and scripts added.
Revision 1.2 31 March 2002 Revised by: mc
Bugfixes, material and scripts added.
Revision 1.3 02 June 2002 Revised by: mc
'TANGERINE' release: A few bugfixes, much more material and scripts added.
Revision 1.4 16 June 2002 Revised by: mc
'MANGO' release: Quite a number of typos fixed, more material and scripts added.
The latest update of this document, as an archived, bzip2-ed "tarball" including both the
SGML source and rendered HTML, may be downloaded from the author's home site. See
the change log for a revision history.
Dedication
For Anita, the source of all the magic
Table of Contents
Part 1. Introduction
1. Why Shell Programming?
2. Starting Off With a Sha-Bang
Part 2. Basics
3. Exit and Exit Status
4. Special Characters
5. Introduction to Variables and Parameters
6. Quoting
7. Tests
8. Operations and Related Topics
Part 3. Beyond the Basics
9. Variables Revisited
10. Loops and Branches
11. Internal Commands and Builtins
List of Tables
11-1. Job Identifiers
31-1. bash options
B-1. Basic sed operators
B-2. Examples
C-1. "Reserved" Exit Codes
H-1. Batch file keywords / variables / operators, and their shell equivalents
H-2. DOS Commands and Their UNIX Equivalents
List of Examples
2-1. cleanup: A script to clean up the log files in /var/log
2-2. cleanup: An enhanced and generalized version of above script.
3-1. exit / exit status
3-2. Negating a condition using !
4-1. Code blocks and I/O redirection
4-2. Saving the results of a code block to a file
4-3. Running a loop in the background
4-4. Backup of all files changed in last day
5-1. Variable assignment and substitution
5-2. Plain Variable Assignment
5-3. Variable Assignment, plain and fancy
5-4. Integer or string?
5-5. Positional Parameters
5-6. wh, whois domain name lookup
5-7. Using shift
6-1. Echoing Weird Variables
Next
Introduction
tar
The standard UNIX archiving utility. Originally a Tape ARchiving program, it has developed into a general purpose package that
can handle all manner of archiving with all types of destination devices, ranging from tape drives to regular files to even
stdout (see Example 4-4). GNU tar has been patched to accept various compression filters, such as tar czvf
archive_name.tar.gz *, which recursively archives and gzips all files in a directory tree except dotfiles in the current working
directory ($PWD). [1]
It may be difficult to recover data from a corrupted gzipped tar archive. When archiving important files,
make multiple backups.
shar
Shell archiving utility. The files in a shell archive are concatenated without compression, and the resultant archive is essentially
a shell script, complete with #!/bin/sh header, and containing all the necessary unarchiving commands. Shar archives still show
up in Internet newsgroups, but otherwise shar has been pretty well replaced by tar/gzip. The unshar command unpacks shar
archives.
ar
Creation and manipulation utility for archives, mainly used for binary object file libraries.
cpio
This specialized archiving copy command (copy input and output) is rarely seen any more, having been supplanted by tar/gzip.
It still has its uses, such as moving a directory tree.
#!/bin/bash
ARGS=2
E_BADARGS=65
if [ $# -ne "$ARGS" ]
then
echo "Usage: `basename $0` source destination"
exit $E_BADARGS
fi
source=$1
destination=$2
exit 0
#!/bin/bash
# de-rpm.sh: Unpack an 'rpm' archive
E_NO_ARGS=65
TEMPFILE=$$.cpio # Tempfile with "unique" name.
# $$ is process ID of script.
if [ -z "$1" ]
then
echo "Usage: `basename $0` filename"
exit $E_NO_ARGS
fi
rpm2cpio < $1 > $TEMPFILE # Converts rpm archive into cpio archive.
cpio --make-directories -F $TEMPFILE -i # Unpacks cpio archive.
rm -f $TEMPFILE # Deletes cpio archive.
exit 0
Compression
gzip
The standard GNU/UNIX compression utility, replacing the inferior and proprietary compress. The corresponding
decompression command is gunzip, which is the equivalent of gzip -d.
The zcat filter decompresses a gzipped file to stdout, as possible input to a pipe or redirection. This is, in effect, a cat
command that works on compressed files (including files processed with the older compress utility). The zcat command is
equivalent to gzip -dc.
On some commercial UNIX systems, zcat is a synonym for uncompress -c, and will not work on gzipped files.
bzip2
An alternate compression utility, usually more efficient (but slower) than gzip, especially on large files. The corresponding
decompression command is bunzip2.
This is an older, proprietary compression utility found in commercial UNIX distributions. The more efficient gzip has largely
replaced it. Linux distributions generally include a compress workalike for compatibility, although gunzip can unarchive files
treated with compress.
Yet another compression utility, a filter that works only on sorted ASCII word lists. It uses the standard invocation syntax for a
filter, sq < input-file > output-file. Fast, but not nearly as efficient as gzip. The corresponding uncompression filter is unsq,
invoked like sq.
Cross-platform file archiving and compression utility compatible with DOS pkzip.exe. "Zipped" archives seem to be a more
acceptable medium of exchange on the Internet than "tarballs".
unarc, unarj, unrar
These Linux utilities permit unpacking archives compressed with the DOS arc.exe, arj.exe, and rar.exe programs.
File Information
file
A utility for identifying file types. The command file file-name will return a file specification for file-name, such as
ascii text or data. It references the magic numbers found in /usr/share/magic, /etc/magic, or
/usr/lib/magic, depending on the Linux/UNIX distribution.
The -f option causes file to run in batch mode, to read from a designated file a list of filenames to analyze. The -z option,
when used on a compressed target file, forces an attempt to analyze the uncompressed file type.
#!/bin/bash
# strip-comment.sh: Strips out the comments (/* COMMENT */) in a C program.
E_NOARGS=65
E_ARGERROR=66
E_WRONG_FILE_TYPE=67
if [ $# -eq "$E_NOARGS" ]
then
echo "Usage: `basename $0` C-program-file" >&2 # Error message to stderr.
exit $E_ARGERROR
fi
if [ "$type" != "$correct_type" ]
then
echo
echo "This script works on C program files only."
echo
exit $E_WRONG_FILE_TYPE
fi
# Need to add one more line to the sed script to deal with
#+ case where line of code has a comment following it on same line.
# This is left as a non-trivial exercise.
exit 0
# ----------------------------------------------------------------
# Code below this line will not execute because of 'exit 0' above.
usage() {
echo "Usage: `basename $0` C-program-file" >&2
exit 1
}
exit 0
which
which command-xxx gives the full path to "command-xxx". This is useful for finding out whether a particular command or
utility is installed on the system.
$bash which rm
/usr/bin/rm
whereis
Similar to which, above, whereis command-xxx gives the full path to "command-xxx", but also to its manpage.
$bash whereis rm
whatis
whatis filexxx looks up "filexxx" in the whatis database. This is useful for identifying system commands and important
configuration files. Consider it a simplified man command.
#!/bin/bash
DIRECTORY="/usr/X11R6/bin"
# Try also "/bin", "/usr/bin", "/usr/local/bin", etc.
exit 0
# You may wish to redirect output of this script, like so:
# ./what.sh >>whatis.db
# or view it a page at a time on stdout,
# ./what.sh | less
bash$ vdir
total 10
-rw-r--r-- 1 bozo bozo 4034 Jul 18 22:04 data1.xrolo
-rw-r--r-- 1 bozo bozo 4602 May 25 13:58 data1.xrolo.bak
-rw-r--r-- 1 bozo bozo 877 Dec 17 2000 employment.xrolo
bash ls -l
total 10
-rw-r--r-- 1 bozo bozo 4034 Jul 18 22:04 data1.xrolo
-rw-r--r-- 1 bozo bozo 4602 May 25 13:58 data1.xrolo.bak
-rw-r--r-- 1 bozo bozo 877 Dec 17 2000 employment.xrolo
shred
Securely erase a file by overwriting it multiple times with random bit patterns before deleting it. This command has the same
effect as Example 12-41, but does it in a more thorough and elegant manner.
Using shred on a file may not prevent recovery of some or all of its contents using advanced forensic technology.
locate, slocate
The locate command searches for files using a database stored for just that purpose. The slocate command is the secure version
of locate (which may be aliased to slocate).
/usr/lib/xephem/catalogs/hickson.edb
strings
Use the strings command to find printable strings in a binary or data file. It will list sequences of printable characters found in
the target file. This might be handy for a quick 'n dirty examination of a core dump or for looking at an unknown graphic image
file (strings image-file | more might show something like JFIF, which would identify the file as a jpeg graphic). In
a script, you would probably parse the output of strings with grep or sed. See Example 10-7 and Example 10-9.
#!/bin/bash
# wstrings.sh: "word-strings" (enhanced "strings" command)
#
# This script filters the output of "strings" by checking it
#+ against a standard word list file.
# This effectively eliminates all the gibberish and noise,
#+ and outputs only recognized words.
# =================================================================
# Standard Check for Script Argument(s)
ARGS=1
E_BADARGS=65
E_NOFILE=66
if [ $# -ne $ARGS ]
then
echo "Usage: `basename $0` filename"
exit $E_BADARGS
fi
done
exit 0
Comparison
diff, patch
diff: flexible file comparison utility. It compares the target files line-by-line sequentially. In some applications, such as
comparing word dictionaries, it may be helpful to filter the files through sort and uniq before piping them to diff. diff file-
1 file-2 outputs the lines in the files that differ, with carets showing which file each particular line belongs to.
The --side-by-side option to diff outputs each compared file, line by line, in separate columns, with non-matching lines
marked.
There are available various fancy frontends for diff, such as spiff, wdiff, xdiff, and mgdiff.
The diff command returns an exit status of 0 if the compared files are identical, and 1 if they differ. This permits
use of diff in a test construct within a shell script (see below).
A common use for diff is generating difference files to be used with patch The -e option outputs files suitable for ed or ex scripts.
patch: flexible versioning utility. Given a difference file generated by diff, patch can upgrade a previous version of a package to a
newer version. It is much more convenient to distribute a relatively small "diff" file than the entire body of a newly revised package.
Kernel "patches" have become the preferred method of distributing the frequent releases of the Linux kernel.
cd /usr/src
gzip -cd patchXX.gz | patch -p0
# Upgrading kernel source using 'patch'.
# From the Linux kernel docs "README",
# by anonymous author (Alan Cox?).
The diff command can also recursively compare directories (for the filenames present).
An extended version of diff that compares three files at a time. This command returns an exit value of 0 upon successful
execution, but unfortunately this gives no information about the results of the comparison.
sdiff
Compare and/or edit two files in order to merge them into an output file. Because of its interactive nature, this command would
find little use in a script.
cmp
The cmp command is a simpler version of diff, above. Whereas diff reports the differences between two files, cmp merely
shows at what point they differ.
Like diff, cmp returns an exit status of 0 if the compared files are identical, and 1 if they differ. This permits use
in a test construct within a shell script.
#!/bin/bash
if [ $# -ne "$ARGS" ]
then
echo "Usage: `basename $0` file1 file2"
exit $E_BADARGS
fi
if [[ ! -r "$1" || ! -r "$2" ]]
then
echo "Both files to be compared must exist and be readable."
exit $E_UNREADABLE
fi
cmp $1 $2 &> /dev/null # /dev/null buries the output of the "cmp" command.
# Also works with 'diff', i.e., diff $1 $2 &> /dev/null
exit 0
Versatile file comparison utility. The files must be sorted for this to be useful.
❍ -1 suppresses column 1
❍ -2 suppresses column 2
❍ -3 suppresses column 3
Utilities
basename
Strips the path information from a file name, printing only the file name. The construction basename $0 lets the script know
its name, that is, the name it was invoked by. This can be used for "usage" messages if, for example a script is called with
missing arguments:
dirname
Strips the basename from a filename, printing only the path information.
basename and dirname can operate on any arbitrary string. The argument does not need to refer to an existing
file, or even be a filename for that matter (see Example A-8).
#!/bin/bash
a=/home/bozo/daily-journal.txt
exit 0
split
Utility for splitting a file into smaller chunks. Usually used for splitting up large files in order to back them up on floppies or
preparatory to e-mailing or uploading them.
These are utilities for generating checksums. A checksum is a number mathematically calculated from the contents of a file, for
the purpose of checking its integrity. A script might refer to a list of checksums for security purposes, such as ensuring that the
contents of key system files have not been altered or corrupted. For security applications, use the 128-bit md5sum (message
digest checksum) command.
Note that cksum also shows the size, in bytes, of the target file.
#!/bin/bash
# file-integrity.sh: Checking whether files in a given directory
# have been tampered with.
E_DIR_NOMATCH=70
E_BAD_DBFILE=71
dbfile=File_record.md5
# Filename for storing records.
set_up_database ()
{
echo ""$directory"" > "$dbfile"
# Write directory name to first line of file.
md5sum "$directory"/* >> "$dbfile"
# Append md5 checksums and filenames.
}
check_database ()
{
local n=0
local filename
local checksum
# ------------------------------------------- #
# This file check should be unnecessary,
#+ but better safe than sorry.
if [ ! -r "$dbfile" ]
then
echo "Unable to read checksum database file!"
exit $E_BAD_DBFILE
fi
# ------------------------------------------- #
directory_checked="${record[0]}"
if [ "$directory_checked" != "$directory" ]
then
echo "Directories do not match up!"
# Tried to use file for a different directory.
exit $E_DIR_NOMATCH
fi
if [ "${record[n]}" = "${checksum[n]}" ]
then
echo "${filename[n]} unchanged."
else
fi
let "n+=1"
done <"$dbfile" # Read from checksum database file.
# =================================================== #
# main ()
if [ -z "$1" ]
then
directory="$PWD" # If not specified,
else #+ use current working directory.
directory="$1"
fi
# ------------------------------------------------------------------ #
if [ ! -r "$dbfile" ] # Need to create database file?
then
echo "Setting up database file, \""$directory"/"$dbfile"\"."; echo
set_up_database
fi
# ------------------------------------------------------------------ #
echo
exit 0
uuencode
This utility encodes binary files into ASCII characters, making them suitable for transmission in the body of an e-mail message
or in a newsgroup posting.
uudecode
This reverses the encoding, decoding uuencoded files back into the original binaries.
#!/bin/bash
for File in * # Test all the files in the current working directory...
do
search1=`head -$lines $File | grep begin | wc -w`
search2=`tail -$lines $File | grep end | wc -w`
# Uuencoded files have a "begin" near the beginning,
#+ and an "end" near the end.
if [ "$search1" -gt 0 ]
then
if [ "$search2" -gt 0 ]
then
echo "uudecoding - $File -"
uudecode $File
fi
fi
done
# Exercise:
# Modify this script to check for a newsgroup header.
exit 0
The fold -s command may be useful (possibly in a pipe) to process long uudecoded text messages downloaded
from Usenet newsgroups.
mimencode, mmencode
The mimencode and mmencode commands process multimedia-encoded e-mail attachments. Although mail user agents (such
as pine or kmail) normally handle this automatically, these particular utilities permit manipulating such attachments manually
from the command line or in a batch by means of a shell script.
crypt
At one time, this was the standard UNIX file encryption utility. [2] Politically motivated government regulations prohibiting the
export of encryption software resulted in the disappearance of crypt from much of the UNIX world, and it is still missing from
most Linux distributions. Fortunately, programmers have come up with a number of decent alternatives to it, among them the
author's very own cruft (see Example A-5).
Miscellaneous
make
Utility for building and compiling binary packages. This can also be used for any set of operations that is triggered by
incremental changes in source files.
The make command checks a Makefile, a list of file dependencies and operations to be carried out.
install
Special purpose file copying command, similar to cp, but capable of setting permissions and attributes of the copied files. This
command seems tailormade for installing software packages, and as such it shows up frequently in Makefiles (in the make
The ptx [targetfile] command outputs a permuted index (cross-reference list) of the targetfile. This may be further filtered and
formatted in a pipe, if necessary.
more, less
Pagers that display a text file or stream to stdout, one screenful at a time. These may be used to filter the output of a script.
Notes
[1] A tar czvf archive_name.tar.gz * will include dotfiles in directories below the current working directory. This is an
undocumented GNU tar "feature".
[2] This is a symmetric block cipher, used to encrypt files on a single system or local network, as opposed to the "public key"
cipher class, of which pgp is a well-known example.
sort
File sorter, often used as a filter in a pipe. This command sorts a text stream or file forwards or backwards, or according to
various keys or character positions. Using the -m option, it merges presorted input files. The info page lists its many
capabilities and options. See Example 10-9, Example 10-10, and Example A-9.
tsort
Topological sort, reading in pairs of whitespace-separated strings and sorting according to input patterns.
uniq
This filter removes duplicate lines from a sorted file. It is often seen in a pipe coupled with sort.
The useful -c option prefixes each line of the input file with its number of occurrences.
The sort INPUTFILE | uniq -c | sort -nr command string produces a frequency of occurrence listing on the
INPUTFILE file (the -nr options to sort cause a reverse numerical sort). This template finds use in analysis of log files
and dictionary lists, and wherever the lexical structure of a document needs to be examined.
#!/bin/bash
# wf.sh: Crude word frequency analysis on a text file.
########################################################
# main ()
sed -e 's/\.//g' -e 's/ /\
/g' "$1" | tr 'A-Z' 'a-z' | sort | uniq -c | sort -nr
# =========================
# Frequency of occurrence
# Exercises:
# ---------
# 1) Add 'sed' commands to filter out other punctuation, such as commas.
# 2) Modify to also filter out multiple spaces and other whitespace.
# 3) Add a secondary sort key, so that instances of equal occurrence
#+ are sorted alphabetically.
exit 0
expand, unexpand
The unexpand filter converts spaces to tabs. This reverses the effect of expand.
cut
A tool for extracting fields from files. It is similar to the print $N command set in awk, but more limited. It may be
simpler to use cut in a script than awk. Particularly important are the -d (delimiter) and -f (field specifier) options.
FILENAME=/etc/passwd
cut -d ' ' -f2,3 filename is equivalent to awk -F'[ ]' '{ print $2, $3 }' filename
Tool for merging together different files into a single, multi-column file. In combination with cut, useful for creating
system log files.
join
Consider this a special-purpose cousin of paste. This powerful utility allows merging two files in a meaningful fashion,
which essentially creates a simple version of a relational database.
The join command operates on exactly two files, but pastes together only those lines with a common tagged field (usually a
numerical label), and writes the result to stdout. The files to be joined should be sorted according to the tagged field for
the matchups to work properly.
File: 1.data
100 Shoes
200 Laces
300 Socks
File: 2.data
100 $40.00
200 $1.00
300 $2.00
lists the beginning of a file to stdout (the default is 10 lines, but this can be changed). It has a number of interesting
options.
#!/bin/bash
# script-detector.sh: Detects scripts within a directory.
exit 0
#!/bin/bash
# rnd.sh: Outputs a 10-digit random number
# =================================================================== #
# Analysis
# --------
# head:
# -c4 option takes first 4 bytes.
# od:
# -N4 option limits output to 4 bytes.
# -tu4 option selects unsigned decimal format for output.
# sed:
# -n option, in combination with "p" flag to the "s" command,
# outputs only matched lines.
# range action
# 1 s/.* //p
# sed is now ready to continue reading its input. (Note that before
# continuing, if -n option had not been passed, sed would have printed
# the line once again).
# Now, sed reads the remainder of the characters, and finds the end of the file.
# It is now ready to process its 2nd line (which is also numbered '$' as
# it's the last one).
# It sees it is not matched by any <range>, so its job is done.
# range action
# nothing (matches line) s/.* //
# nothing (matches line) q (quit)
# =================================================================== #
exit 0
tail
lists the end of a file to stdout (the default is 10 lines). Commonly used to keep track of changes to a system logfile,
#!/bin/bash
filename=sys.log
exit 0
grep
A multi-purpose file search tool that uses regular expressions. It was originally a command/filter in the venerable ed line
editor, g/re/p, that is, global - regular expression - print.
Search the target file(s) for occurrences of pattern, where pattern may be literal text or a regular expression.
The -l option lists only the files in which matches were found, but not the matching lines.
The -r (recursive) option searches files in the current working directory and all subdirectories below it.
The -n option lists the matching lines, together with line numbers.
The -c (--count) option gives a numerical count of matches, rather than actually listing the matches.
# grep -cz .
# ^ dot
# means count (-c) zero-separated (-z) items matching "."
# that is, non-empty ones (containing at least 1 character).
#
printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep -cz . # 4
printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep -cz '$' # 5
printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep -cz '^' # 5
#
printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep -c '$' # 9
# By default, newline chars (\n) separate items to match.
# Thanks, S.C.
When invoked with more than one target file given, grep specifies which file contains matches.
To force grep to show the filename when searching only one target file, simply give /dev/null as the second
file.
If there is a successful match, grep returns an exit status of 0, which makes it useful in a condition test in a script,
especially in combination with the -q option to suppress output.
grep -q "$word" "$filename" # The "-q" option causes nothing to echo to stdout.
if [ $? -eq $SUCCESS ]
then
echo "$word found in $filename"
else
echo "$word not found in $filename"
fi
Example 30-6 demonstrates how to use grep to search for a word pattern in a system logfile.
#!/bin/bash
# grp.sh: Very crude reimplementation of 'grep'.
E_BADARGS=65
echo
echo
done
echo
exit 0
# Exercises:
# ---------
# 1) Add newlines to output, if more than one match in any given file.
# 2) Add features.
egrep is the same as grep -E. This uses a somewhat different, extended set of regular expressions, which can
make the search somewhat more flexible.
fgrep is the same as grep -F. It does a literal string search (no regular expressions), which allegedly speeds
things up a bit.
agrep extends the capabilities of grep to approximate matching. The search string may differ by a specified
number of characters from the resulting matches. This utility is not part of the core Linux distribution.
To search compressed files, use zgrep, zegrep, or zfgrep. These also work on non-compressed files, though
slower than plain grep, egrep, fgrep. They are handy for searching through a mixed set of files, some
compressed, some not.
The command look works like grep, but does a lookup on a "dictionary", a sorted word list. By default, look searches for a
match in /usr/dict/words, but a different dictionary file may be specified.
#!/bin/bash
# lookup: Does a dictionary lookup on each word in a data file.
echo
if [ "$lookup" -eq 0 ]
then
echo "\"$word\" is valid."
else
echo "\"$word\" is invalid."
fi
echo
exit 0
# ----------------------------------------------------------------
# Code below line will not execute because of "exit" command above.
exit 0
sed, awk
Scripting languages especially suited for parsing text files and command output. May be embedded singly or in
combination in pipes and shell scripts.
sed
Non-interactive "stream editor", permits using many ex commands in batch mode. It finds many uses in shell scripts.
awk
Programmable file extractor and formatter, good for manipulating and/or extracting fields (columns) in structured text files.
Its syntax is similar to C.
wc
bash $ wc /usr/doc/sed-3.02/README
20 127 838 /usr/doc/sed-3.02/README
[20 lines 127 words 838 characters]
Using wc to count how many .txt files are in current working directory:
$ ls *.txt | wc -l
# Will work as long as none of the "*.txt" files have a linefeed in their name.
# Thanks, S.C.
Using wc to total up the size of all the files whose names begin with letters in the range d - h
Using wc to count the instances of the word "Linux" in the main source file for this book.
# Thanks, S.C.
tr
Must use quoting and/or brackets, as appropriate. Quotes prevent the shell from reinterpreting the special
characters in tr command sequences. Brackets should be quoted to prevent expansion by the shell.
Either tr "A-Z" "*" <filename or tr A-Z \* <filename changes all the uppercase letters in filename to
asterisks (writes to stdout). On some systems this may not work, but tr A-Z '[**]' will.
tr -d 0-9 <filename
# Deletes all digits from the file "filename".
The --squeeze-repeats (or -s) option deletes all but the first instance of a string of consecutive characters. This option is
useful for removing excess whitespace.
The -c "complement" option inverts the character set to match. With this option, tr acts only upon those characters not matching
the specified set.
#!/bin/bash
# Changes a file to all uppercase.
E_BADARGS=65
exit 0
#! /bin/bash
#
# Changes every filename in working directory to all lowercase.
#
# Inspired by a script of John Dubois,
# which was translated into into Bash by Chet Ramey,
# and considerably simplified by Mendel Cooper, author of this document.
exit 0
# The above script will not work on filenames containing blanks or newlines.
exit 0
#!/bin/bash
# du.sh: DOS to UNIX text file converter.
E_WRONGARGS=65
if [ -z "$1" ]
then
echo "Usage: `basename $0` filename-to-convert"
exit $E_WRONGARGS
fi
NEWFILENAME=$1.unx
exit 0
#!/bin/bash
# rot13.sh: Classic rot13 algorithm, encryption that might fool a 3-year old.
cat "$@" | tr 'a-zA-Z' 'n-za-mN-ZA-M' # "a" goes to "n", "b" to "o", etc.
# The 'cat "$@"' construction
# permits getting input either from stdin or from files.
exit 0
#!/bin/bash
# crypto-quote.sh: Encrypt quotes
key=ETAOINSHRDLUBCFGJMQPVWZYXK
# The "key" is nothing more than a scrambled alphabet.
# Changing the "key" changes the encryption.
# The 'cat "$@"' construction gets input either from stdin or from files.
# If using stdin, terminate input with a Control-D.
exit 0
tr variants
The tr utility has two historic variants. The BSD version does not use brackets (tr a-z A-Z), but the SysV one does (tr
'[a-z]' '[A-Z]'). The GNU version of tr resembles the BSD one, so quoting letter ranges within brackets is mandatory.
fold
A filter that wraps lines of input to a specified width. This is especially useful with the -s option, which breaks lines at
word spaces (see Example 12-19 and Example A-2).
fmt
Simple-minded file formatter, used as a filter in a pipe to "wrap" long lines of text output.
#!/bin/bash
exit 0
This deceptively named filter removes reverse line feeds from an input stream. It also attempts to replace whitespace with
equivalent tabs. The chief use of col is in filtering the output from certain text processing utilities, such as groff and tbl.
column
Column formatter. This filter transforms list-type text output into a "pretty-printed" table by inserting tabs at appropriate
places.
#!/bin/bash
# This is a slight modification of the example file in the "column" man page.
(printf "PERMISSIONS LINKS OWNER GROUP SIZE MONTH DAY HH:MM PROG-NAME\n" \
; ls -l | sed 1d) | column -t
# The "sed 1d" in the pipe deletes the first line of output,
#+ which would be "total N",
#+ where "N" is the total number of files found by "ls -l".
exit 0
colrm
Column removal filter. This removes columns (characters) from a file and writes the file, lacking the range of specified
columns, back to stdout. colrm 2 4 <filename removes the second through fourth characters from each line of
the text file filename.
If the file contains tabs or nonprintable characters, this may cause unpredictable behavior. In such cases,
consider using expand and unexpand in a pipe preceding colrm.
nl
Line numbering filter. nl filename lists filename to stdout, but inserts consecutive numbers at the beginning of
each non-blank line. If filename omitted, operates on stdin.
The output of nl is very similar to cat -n, however, by default nl does not list blank lines.
#!/bin/bash
# This script echoes itself twice to stdout with its lines numbered.
# 'nl' sees this as line 3 since it does not number blank lines.
# 'cat -n' sees the above line as number 5.
nl `basename $0`
exit 0
pr
Print formatting filter. This will paginate files (or stdout) into sections suitable for hard copy printing or viewing on
screen. Various options permit row and column manipulation, joining lines, setting margins, numbering lines, adding page
headers, and merging files, among other things. The pr command combines much of the functionality of nl, paste, fold,
column, and expand.
pr -o 5 --width=65 fileZZZ | more gives a nice paginated listing to screen of fileZZZ with margins set at 5
and 65.
A particularly useful option is -d, forcing double-spacing (same effect as sed -G).
gettext
A GNU utility for localization and translating the text output of programs into foreign languages. While primarily intended
for C programs, gettext also finds use in shell scripts. See the info page.
iconv
A utility for converting file(s) to a different encoding (character set). Its chief use is for localization.
recode
Consider this a fancier version of iconv, above. This very versatile utility for converting a file to a different encoding is not
part of the standard Linux installation.
TeX, gs
TeX and Postscript are text markup languages used for preparing copy for printing or formatted video display.
TeX is Donald Knuth's elaborate typsetting system. It is often convenient to write a shell script encapsulating all the
options and arguments passed to one of these markup languages.
Yet another text markup and display formatting language is groff. This is the enhanced GNU version of the venerable
UNIX roff/troff display and typesetting package. Manpages use groff (see Example A-1).
The tbl table processing utility is considered part of groff, as its function is to convert table markup into groff commands.
The eqn equation processing utility is likewise part of groff, and its function is to convert equation markup into groff
commands.
lex, yacc
The lex lexical analyzer produces programs for pattern matching. This has been replaced by the nonproprietary flex on
Linux systems.
The yacc utility creates a parser based on a set of specifications. This has been replaced by the nonproprietary bison on
Linux systems.
Notes
[1] This is only true of the GNU version of tr, not the generic version often found on commercial UNIX systems.
date
Simply invoked, date prints the date and time to stdout. Where this command gets interesting is in its
formatting and parsing options.
#!/bin/bash
# Exercising the 'date' command
echo "The number of days since the year's beginning is `date +%j`."
# Needs a leading '+' to invoke formatting.
# %j gives day of year.
prefix=temp
suffix=`eval date +%s` # The "+%s" option to 'date' is GNU-specific.
filename=$prefix.$suffix
echo $filename
# It's great for creating "unique" temp filenames,
#+ even better than using $$.
exit 0
bash$ date
Fri Mar 29 21:07:39 MST 2002
bash$ date -u
Sat Mar 30 04:07:42 UTC 2002
zdump
time
See also the very similar times command in the previous section.
As of version 2.0 of Bash, time became a shell reserved word, with slightly altered behavior in a
pipeline.
touch
Utility for updating access/modification times of a file to current system time or other specified time, but also
useful for creating a new file. The command touch zzz will create a new file of zero length, named zzz,
assuming that zzz did not previously exist. Time-stamping empty files in this way is useful for storing date
information, for example in keeping track of modification times on a project.
The touch command is equivalent to : >> newfile or >> newfile (for ordinary files).
at
The at job control command executes a given set of commands at a specified time. Superficially, it resembles
crond, however, at is chiefly useful for one-time execution of a command set.
at 2pm January 15 prompts for a set of commands to execute at that time. These commands should be shell-
script compatible, since, for all practical purposes, the user is typing in an executable shell script a line at a time.
Input terminates with a Ctl-D.
Using either the -f option or input redirection (<), at reads a command list from a file. This file is an executable
shell script, though it should, of course, be noninteractive. Particularly clever is including the run-parts command
in the file to execute a different set of scripts.
batch
The batch job control command is similar to at, but it runs a command list when the system load drops below
.8. Like at, it can read commands from a file with the -f option.
cal
Prints a neatly formatted monthly calendar to stdout. Will do current year or a large range of past and future
years.
sleep
This is the shell equivalent of a wait loop. It pauses for a specified number of seconds, doing nothing. This can be
useful for timing or in processes running in the background, checking for a specific event every so often (see
Example 30-6).
sleep 3
# Pauses 3 seconds.
The sleep command defaults to seconds, but minute, hours, or days may also be specified.
sleep 3 h
# Pauses 3 hours!
usleep
Microsleep (the "u" may be read as the Greek "mu", or micro prefix). This is the same as sleep, above, but
"sleeps" in microsecond intervals. This can be used for fine-grain timing, or for polling an ongoing process at
very frequent intervals.
usleep 30
# Pauses 30 microseconds.
The usleep command does not provide particularly accurate timing, and is therefore unsuitable
for critical timing loops.
hwclock, clock
The hwclock command accesses or adjusts the machine's hardware clock. Some options require root privileges.
The /etc/rc.d/rc.sysinit startup file uses hwclock to set the system time from the hardware clock at
bootup.
find
-exec COMMAND \;
Carries out COMMAND on each file that find scores a hit on. COMMAND terminates with \; (the ; is escaped to make certain the
shell passes it to find literally, which concludes the command sequence). If COMMAND contains {}, then find substitutes the
full path name of the selected file.
# Perhaps by:
# Thanks, S.C.
The -exec option to find should not be confused with the exec shell builtin.
Example 12-2. Badname, eliminate file names in current directory containing bad characters and whitespace.
#!/bin/bash
for filename in *
do
badname=`echo "$filename" | sed -n /[\+\{\;\"\\\=\?~\(\)\<\>\&\*\|\$]/p`
# Files containing those nasties: + { ; " \ = ? ~ ( ) < > & * | $
rm $badname 2>/dev/null # So error messages deep-sixed.
done
exit 0
#---------------------------------------------------------------------
# Commands below this line will not execute because of "exit" command.
#!/bin/bash
# idelete.sh: Deleting a file by its inode number.
if [ $# -ne "$ARGCOUNT" ]
then
echo "Usage: `basename $0` filename"
exit $E_WRONGARGS
fi
if [ ! -e "$1" ]
then
echo "File \""$1"\" does not exist."
exit $E_FILE_NOT_EXIST
fi
echo; echo -n "Are you absolutely sure you want to delete \"$1\" (y/n)? "
read answer
case "$answer" in
[nN]) echo "Changed your mind, huh?"
exit $E_CHANGED_MIND
;;
*) echo "Deleting file \"$1\".";;
esac
exit 0
See Example 12-22, Example 4-4, and Example 10-9 for scripts using find. Its manpage provides more detail on this complex and
powerful command.
xargs
A filter for feeding arguments to a command, and also a tool for assembling the commands themselves. It breaks a data
stream into small enough chunks for filters and commands to process. Consider it as a powerful replacement for backquotes.
In situations where backquotes fail with a too many arguments error, substituting xargs often works. Normally, xargs reads
from stdin or from a pipe, but it can also be given the output of a file.
The default command for xargs is echo. This means that input piped to xargs may have linefeeds and other whitespace
characters stripped out.
bash$ ls -l
total 0
-rw-rw-r-- 1 bozo bozo 0 Jan 29 23:58 file1
-rw-rw-r-- 1 bozo bozo 0 Jan 29 23:58 file2
bash$ ls -l | xargs
total 0 -rw-rw-r-- 1 bozo bozo 0 Jan 29 23:58 file1 -rw-rw-r-- 1 bozo bozo 0 Jan 29
23:58 file2
ls | xargs -p -l gzip gzips every file in current directory, one at a time, prompting before each operation.
An interesting xargs option is -n NN, which limits to NN the number of arguments passed.
Another useful option is -0, in combination with find -print0 or grep -lZ. This allows handling arguments
containing whitespace or quotes.
Either of the above will remove any file containing "GUI". (Thanks, S.C.)
#!/bin/bash
LINES=5
exit 0
Example 12-5. copydir, copying files in current directory to another, using xargs
#!/bin/bash
ls . | xargs -i -t cp ./{} $1
# This is the exact equivalent of
# cp * $1
# unless any of the filenames has "whitespace" characters.
exit 0
expr
All-purpose expression evaluator: Concatenates and evaluates the arguments according to the operation given (arguments
must be separated by spaces). Operations may be arithmetic, comparison, string, or logical.
expr 3 + 5
returns 8
expr 5 % 3
returns 2
expr 5 \* 3
returns 15
The multiplication operator must be escaped when used in an arithmetic expression with expr.
y=`expr $y + 1`
Increment a variable, with the same effect as let y=y+1 and y=$(($y+1)). This is an example of arithmetic expansion.
z=`expr substr $string $position $length`
#!/bin/bash
echo
# Arithmetic Operators
# ---------- ---------
a=`expr $a + 1`
echo
echo "a + 1 = $a"
echo "(incrementing a variable)"
a=`expr 5 % 3`
# modulo
echo
echo "5 mod 3 = $a"
echo
echo
# Logical Operators
# ------- ---------
x=24
y=25
b=`expr $x = $y` # Test equality.
echo "b = $b" # 0 ( $x -ne $y )
echo
a=3
b=`expr $a \> 10`
echo 'b=`expr $a \> 10`, therefore...'
echo "If a > 10, b = 0 (false)"
echo "b = $b" # 0 ( 3 ! -gt 10 )
echo
b=`expr $a \<= 3`
echo "If a <= 3, b = 1 (true)"
echo "b = $b" # 1 ( 3 -le 3 )
# There is also a "\>=" operator (greater than or equal to).
echo
echo
# Comparison Operators
# ---------- ---------
echo
echo
# String Operators
# ------ ---------
a=1234zipper43231
echo "The string being operated upon is \"$a\"."
echo
exit 0
The : operator can substitute for match. For example, b=`expr $a : [0-9]*` is the exact equivalent of
b=`expr match $a [0-9]*` in the above listing.
#!/bin/bash
echo
echo "String operations using \"expr \$string : \" construct"
echo "==================================================="
echo
a=1234zipper5FLIPPER43231
# ***************************
#+ Escaped parentheses
#+ match a substring
# ***************************
# If no escaped parentheses...
#+ then 'expr' converts the string operand to an integer.
# ------------------------------------------------------------------------- #
echo
echo "The digits at the beginning of \"$a\" are `expr "$a" : '\([0-9]*\)'`."
# == ==
echo "The first 7 characters of \"$a\" are `expr "$a" : '\(.......\)'`."
# ===== == ==
# Again, escaped parentheses force a substring match.
#
echo "The last 7 characters of \"$a\" are `expr "$a" : '.*\(.......\)'`."
# ==== end of string operator ^^
# (actually means skip over one or more of any characters until specified
#+ substring)
echo
exit 0
The above example illustrates how expr uses the escaped parentheses -- \( ... \) -- grouping operator in tandem with regular
expression parsing to match a substring.
Perl and sed have far superior string parsing facilities. A short Perl or sed "subroutine" within a script (see Section 34.2) is an
attractive alternative to using expr.
ls
The basic file "list" command. It is all too easy to underestimate the power of this humble command. For example, using the -
R, recursive option, ls provides a tree-like listing of a directory structure. Other interesting options are -S, sort listing by file
size, -t, sort by file modification time, and -i, show file inodes (see Example 12-3).
Example 12-1. Using ls to create a table of contents for burning a CDR disk
#!/bin/bash
if [ -z "$1" ]
then
IMAGE_DIRECTORY=$DEFAULTDIR
# Default directory, if not specified on command line.
else
IMAGE_DIRECTORY=$1
fi
exit 0
cat, tac
cat, an acronym for concatenate, lists a file to stdout. When combined with redirection (> or >>), it is commonly used to
concatenate files.
The -n option to cat inserts consecutive numbers before all lines of the target file(s). The -b option numbers only the non-
blank lines. The -v option echoes nonprintable characters, using ^ notation. The -s option squeezes multiple consecutive
blank lines into a single blank line.
tac, is the inverse of cat, listing a file backwards from its end.
rev
reverses each line of a file, and outputs to stdout. This is not the same effect as tac, as it preserves the order of the lines,
but flips each one around.
cp
This is the file copy command. cp file1 file2 copies file1 to file2, overwriting file2 if it already exists (see
Example 12-5).
Particularly useful are the -a archive flag (for copying an entire directory tree) and the -r and -R recursive
flags.
mv
This is the file move command. It is equivalent to a combination of cp and rm. It may be used to move multiple files to a
directory, or even to rename a directory. For some examples of using mv in a script, see Example 9-15 and Example A-3.
When used in a non-interactive script, mv takes the -f (force) option to bypass user input.
When a directory is moved to a preexisting directory, it becomes a subdirectory of the destination directory.
rm
Delete (remove) a file or files. The -f option forces removal of even readonly files, and is useful for bypassing user input in
a script.
When used with the recursive flag -r, this command removes files all the way down the directory tree.
rmdir
Remove directory. The directory must be empty of all files, including invisible "dotfiles", [1] for this command to succeed.
mkdir
Make directory, creates a new directory. mkdir -p project/programs/December creates the named directory. The
-p option automatically creates any necessary parent directories.
chmod
chmod +x filename
# Makes "filename" executable for all users.
chattr
Change file attributes. This has the same effect as chmod above, but with a different invocation syntax, and it works only on
an ext2 filesystem.
ln
Creates links to pre-existings files. Most often used with the -s, symbolic or "soft" link flag. This permits referencing the
linked file by more than one name and is a superior alternative to aliasing (see Example 5-6).
ln -s oldfile newfile links the previously existing oldfile to the newly created link, newfile.
Notes
[1] These are files whose names begin with a dot, such as ~/.Xdefaults. Such filenames do not show up in a normal ls
listing, and they cannot be deleted by an accidental rm -rf *. Dotfiles are generally used as setup and configuration files in a
user's home directory.
Standard UNIX commands make shell scripts more versatile. The power of scripts comes
from coupling system commands and shell directives with simple programming constructs.
jobs
Lists the jobs running in the background, giving the job number. Not as useful as ps.
It is all too easy to confuse jobs and processes. Certain builtins, such as kill, disown,
and wait accept either a job number or a process number as an argument. The fg, bg
and jobs commands accept only a job number.
bash $ jobs
[1]+ Running sleep 100 &
"1" is the job number (jobs are maintained by the current shell), and "1384" is the
process number (processes are maintained by the system). To kill this job/process,
either a kill %1 or a kill 1384 works.
Thanks, S.C.
disown
The fg command switches a job running in the background into the foreground. The bg command
restarts a suspended job, and runs it in the background. If no job number is specified, then the fg
or bg command acts upon the currently running job.
wait
Stop script execution until all jobs running in background have terminated, or until the job number
or process id specified as an option terminates. Returns the exit status of waited-for command.
You may use the wait command to prevent a script from exiting before a background job finishes
executing (this would create a dreaded orphan process).
#!/bin/bash
if [ -z "$1" ]
then
echo "Usage: `basename $0` find-string"
exit $E_NOPARAMS
fi
wait
# Don't run the rest of the script until 'updatedb' finished.
# You want the the database updated before looking up the file name.
locate $1
exit 0
Optionally, wait can take a job identifier as an argument, for example, wait%1 or wait $PPID. See the
job id table.
Within a script, running a command in the background with an ampersand (&) may cause the
script to hang until ENTER is hit. This seems to occur with commands that write to stdout. It
can be a major annoyance.
#!/bin/bash
# test.sh
ls -l &
echo "Done."
bash$ ./test.sh
Done.
[bozo@localhost test-scripts]$ total 1
-rwxr-xr-x 1 bozo bozo 34 Oct 11 15:09 test.sh
_
#!/bin/bash
# test.sh
ls -l &
echo "Done."
wait
bash$ ./test.sh
Done.
[bozo@localhost test-scripts]$ total 1
-rwxr-xr-x 1 bozo bozo 34 Oct 11 15:09 test.sh
Redirecting the output of the command to a file or even to /dev/null also takes care of this
problem.
suspend
This has a similar effect to Control-Z, but it suspends the shell (the shell's parent process should
resume it at an appropriate time).
logout
times
Gives statistics on the system time used in executing commands, in the following form:
0m0.020s 0m0.020s
This capability is of very limited value, since it is uncommon to profile and benchmark shell
scripts.
kill
Forcibly terminate a process by sending it an appropriate terminate signal (see Example 13-4).
#!/bin/bash
# self-destruct.sh
exit 0
kill -l lists all the signals. A kill -9 is a "sure kill", which will usually
terminate a process that stubbornly refuses to die with a plain kill. Sometimes, a kill
-15 works. A "zombie process", that is, a process whose parent has terminated, cannot
be killed (you can't kill something that is already dead), but init will usually clean it up
sooner or later.
command
The command COMMAND directive disables aliases and functions for the command
"COMMAND".
This is one of three shell directives that effect script command processing. The others
are builtin and enable.
builtin
name.
enable
This either enables or disables a shell builtin command. As an example, enable -n kill disables the
shell builtin kill, so that when Bash subsequently encounters kill, it invokes /bin/kill.
The -a option to enable lists all the shell builtins, indicating whether or not they are enabled. The
-f filename option lets enable load a builtin as a shared library (DLL) module from a
properly compiled object file. [1].
autoload
This is a port to Bash of the ksh autoloader. With autoload in place, a function with an "autoload"
declaration will load from an external file at its first invocation. [2] This saves system resources.
Note that autoload is not a part of the core Bash installation. It needs to be loaded in with enable -
f (see above).
Notation Meaning
%N Job number [N]
%S Invocation (command line) of job begins with string S
%?S Invocation (command line) of job contains within it string S
%% "current" job (last job stopped in foreground or started in background)
%+ "current" job (last job stopped in foreground or started in background)
%- Last job
$! Last background process
Notes
[1] The C source for a number of loadable builtins is typically found in the
/usr/share/doc/bash-?.??/functions directory.
When a command or the shell itself initiates (or spawns) a new subprocess to carry out a task, this is called forking. This
new process is the "child", and the process that forked it off is the "parent". While the child process is doing its work, the
parent process is still executing.
Generally, a Bash builtin does not fork a subprocess when it executes within a script. An external system command or filter
in a script usually will fork a subprocess.
A builtin may be a synonym to a system command of the same name, but Bash reimplements it internally. For example, the
Bash echo command is not the same as /bin/echo, although their behavior is almost identical.
#!/bin/bash
A keyword is a reserved word, token or operator. Keywords have a special meaning to the shell, and indeed are the building
blocks of the shell's syntax. As examples, "for", "while", "do", and "!" are keywords. Similar to a builtin, a keyword is hard-
coded into Bash, but unlike a builtin, a keyword is not by itself a command, but part of a larger command structure. [1]
I/O
echo
echo Hello
echo $a
An echo requires the -e option to print escaped characters. See Example 6-2.
Normally, each echo command prints a terminal newline, but the -n option suppresses this.
See also Example 12-15, Example 12-2, Example 12-32, and Example 12-33.
Be aware that echo `command` deletes any linefeeds that the output of command generates.
The $IFS (internal field separator) variable normally contains \n (linefeed) as one of its set of whitespace characters. Bash
therefore splits the output of command at linefeeds into arguments to echo. Then echo outputs these arguments, separated by
spaces.
bash$ ls -l /usr/share/apps/kjezz/sounds
-rw-r--r-- 1 root root 1407 Nov 7 2000 reflect.au
-rw-r--r-- 1 root root 362 Nov 7 2000 seconds.au
This command is a shell builtin, and not the same as /bin/echo, although its behavior is similar.
printf
The printf, formatted print, command is an enhanced echo. It is a limited variant of the C language printf() library
function, and its syntax is somewhat different.
This is the Bash builtin version of the /bin/printf or /usr/bin/printf command. See the printf manpage (of
the system command) for in-depth coverage.
#!/bin/bash
# printf demo
PI=3.14159265358979
DecimalConstant=31373
Message1="Greetings,"
Message2="Earthling."
echo
echo
# ==========================================#
# Simulation of C function, 'sprintf'.
# Loading a variable with a formatted string.
echo
exit 0
E_BADDIR=65
var=nonexistent_directory
error()
{
printf "$@" >&2
# Formats positional params passed, and sents them to stderr.
echo
exit $E_BADDIR
}
# Thanks, S.C.
read
"Reads" the value of a variable from stdin, that is, interactively fetches input from the keyboard. The -a option lets
read get array variables (see Example 26-2).
#!/bin/bash
read var1
# Note no '$' in front of var1, since it is being set.
echo
exit 0
A read without an associated variable assigns its input to the dedicated variable $REPLY.
#!/bin/bash
echo
# -------------------------- #
# First code block.
echo -n "Enter a value: "
read var
echo "\"var\" = "$var""
# Everything as expected here.
# -------------------------- #
echo
echo
exit 0
Normally, inputting a \ suppresses a newline during input to a read. The -r option causes an inputted \ to be interpreted
literally.
#!/bin/bash
echo
echo; echo
echo
exit 0
The read command has some interesting options that permit echoing a prompt and even reading keystrokes without hitting
ENTER.
# Using these options is tricky, since they need to be in the correct order.
The read command may also "read" its variable value from a file redirected to stdin. If the file contains more than one line,
only the first line is assigned to the variable. If read has more than one parameter, then each of these variables gets assigned a
successive whitespace-delineated string. Caution!
#!/bin/bash
echo "------------------------------------------------"
echo "------------------------------------------------"
exit 0
Filesystem
cd
The familiar cd change directory command finds use in scripts where execution of a command requires being in a
specified directory.
Print Working Directory. This gives the user's (or script's) current directory (see Example 11-6). The effect is identical
to reading the value of the builtin variable $PWD.
pushd, popd, dirs
This command set is a mechanism for bookmarking working directories, a means of moving back and forth through
directories in an orderly manner. A pushdown stack is used to keep track of directory names. Options allow various
pushd dir-name pushes the path dir-name onto the directory stack and simultaneously changes the current
working directory to dir-name
popd removes (pops) the top directory path name off the directory stack and simultaneously changes the current
working directory to that directory popped from the stack.
dirs lists the contents of the directory stack (compare this with the $DIRSTACK variable). A successful pushd or popd
will automatically invoke dirs.
Scripts that require various changes to the current working directory without hard-coding the directory name changes
can make good use of these commands. Note that the implicit $DIRSTACK array variable, accessible from within a
script, holds the contents of the directory stack.
#!/bin/bash
dir1=/usr/local
dir2=/var/spool
pushd $dir1
# Will do an automatic 'dirs' (list directory stack to stdout).
echo "Now in directory `pwd`." # Uses back-quoted 'pwd'.
exit 0
Variables
let
The let command carries out arithmetic operations on variables. In many cases, it functions as a less complex version of
expr.
#!/bin/bash
echo
echo
exit 0
eval
Translates into commands the arguments in a list (useful for code generation within a script).
#!/bin/bash
echo; echo
exit 0
#!/bin/bash
kill -9 $y # Killing it
exit 0
#!/bin/bash
# A version of "rot13" using 'eval'.
# Compare to "rot13.sh" example.
exit 0
The eval command can be risky, and normally should be avoided when there exists a reasonable
alternative. An eval $COMMANDS executes the contents of COMMANDS, which may contain such
unpleasant surprises as rm -rf *. Running an eval on unfamiliar code written by persons unknown is living
dangerously.
set
The set command changes the value of internal script variables. One use for this is to toggle option flags which help
determine the behavior of the script. Another application for it is to reset the positional parameters that a script sees as
the result of a command (set `command`). The script can then parse the fields of the command output.
#!/bin/bash
# script "set-test"
echo
echo "Positional parameters before set \`uname -a\` :"
echo "Command-line argument #1 = $1"
echo "Command-line argument #2 = $2"
echo "Command-line argument #3 = $3"
echo
exit 0
Invoking set without any options or arguments simply lists all the environmental and other variables that have been initialized.
bash$ set
AUTHORCOPY=/home/bozo/posts
BASH=/bin/bash
BASH_VERSION=$'2.05.8(1)-release'
...
XAUTHORITY=/home/bozo/.Xauthority
_=/etc/bashrc
variable22=abc
variable23=xzy
Using set with the -- option explicitly assigns the contents of a variable to the positional parameters. When no variable
follows the --, it unsets the positional parameters.
#!/bin/bash
set -- $variable
# Sets positional parameters to the contents of "$variable".
first_param=$1
second_param=$2
shift; shift # Shift past first two positional params.
remaining_params="$*"
echo
echo "first parameter = $first_param" # one
echo "second parameter = $second_param" # two
echo "remaining parameters = $remaining_params" # three four five
echo; echo
# Again.
set -- $variable
first_param=$1
second_param=$2
echo "first parameter = $first_param" # one
echo "second parameter = $second_param" # two
# ======================================================
set --
# Unsets positional parameters if no variable specified.
first_param=$1
second_param=$2
echo "first parameter = $first_param" # (null value)
echo "second parameter = $second_param" # (null value)
exit 0
unset
The unset command deletes a shell variable, effectively setting it to null. Note that this command does not affect
positional parameters.
bash$
#!/bin/bash
# unset.sh: Unsetting a variable.
variable=hello # Initialized.
echo "variable = $variable"
exit 0
export
The export command makes available variables to all child processes of the running script or shell. Unfortunately, there
is no way to export variables back to the parent process, to the process that called or invoked the script or shell. One
important use of export command is in startup files, to initialize and make accessible environmental variables to
subsequent user processes.
#!/bin/bash
ARGS=2
E_WRONGARGS=65
filename=$1
column_number=$2
export column_number
# Export column number to environment, so it's available for retrieval.
exit 0
It is possible to initialize and export variables in the same operation, as in export var1=xxx.
declare, typeset
The declare and typeset commands specify and/or restrict properties of variables.
readonly
Same as declare -r, sets a variable as read-only, or, in effect, as a constant. Attempts to change the variable fail with an
error message. This is the shell analog of the C language const type qualifier.
getopts
This powerful tool parses command-line arguments passed to the script. This is the Bash analog of the getopt external
command and the getopt library function familiar to C programmers. It permits passing and concatenating multiple
options [2] and associated arguments to a script (for example scriptname -abc -e /usr/local).
The getopts construct uses two implicit variables. $OPTIND is the argument pointer (OPTion INDex) and $OPTARG
(OPTion ARGument) the (optional) argument attached to an option. A colon following the option name in the
declaration tags that option as having an associated argument.
A getopts construct usually comes packaged in a while loop, which processes the options and arguments one at a time,
then decrements the implicit $OPTIND variable to step to the next.
1. The arguments passed from the command line to the script must be preceded by a minus (-) or a
plus (+). It is the prefixed - or + that lets getopts recognize command-line arguments as options. In
fact, getopts will not process arguments without the prefixed - or +, and will terminate option
processing at the first argument encountered lacking them.
2. The getopts template differs slightly from the standard while loop, in that it lacks condition
brackets.
3. The getopts construct replaces the obsolete and less powerful getopt external command.
#!/bin/bash
NO_ARGS=0
E_OPTERROR=65
exit 0
Script Behavior
This command, when invoked from the command line, executes a script. Within a script, a source file-name
loads the file file-name. This is the shell scripting equivalent of a C/C++ #include directive. It is useful in
situations when multiple scripts use a common data file or function library.
#!/bin/bash
exit 0
File data-file for Example 11-16, above. Must be present in same directory.
variable1=22
variable2=474
variable3=5
variable4=97
print_message ()
{
# Echoes any message passed to it.
if [ -z "$1" ]
then
return 1
# Error, if argument missing.
fi
echo
until [ -z "$1" ]
do
# Step through arguments passed to function.
echo -n "$1"
# Echo args one at a time, suppressing line feeds.
echo -n " "
# Insert spaces between words.
shift
# Next one.
done
echo
return 0
}
exit
Unconditionally terminates a script. The exit command may optionally take an integer argument, which is returned to
the shell as the exit status of the script. It is a good practice to end all but the simplest scripts with an exit 0,
indicating a successful run.
If a script terminates with an exit lacking an argument, the exit status of the script is the exit status of the
last command executed in the script, not counting the exit.
exec
This shell builtin replaces the current process with a specified command. Normally, when the shell encounters a
command, it forks off a child process to actually execute the command. Using the exec builtin, the shell does not fork,
and the command exec'ed replaces the shell. When used in a script, therefore, it forces an exit from the script when the
exec'ed command terminates. For this reason, if an exec appears in a script, it would probably be the final command.
#!/bin/bash
# ----------------------------------
# The following lines never execute.
#!/bin/bash
# self-exec.sh
echo
echo "This line appears ONCE in the script, yet it keeps echoing."
echo "The PID of this instance of the script is still $$."
# Demonstrates that a subshell is not forked off.
sleep 1
exit 0
An exec also serves to reassign file descriptors. exec <zzz-file replaces stdin with the file zzz-file (see Example
16-1).
The -exec option to find is not the same as the exec shell builtin.
shopt
This command permits changing shell options on the fly (see Example 24-1 and Example 24-2). It often appears in the
Bash startup files, but also has its uses in scripts. Needs version 2 or later of Bash.
shopt -s cdspell
# Allows minor misspelling directory names with 'cd'
command.
Commands
true
A command that returns a successful (zero) exit status, but does nothing else.
# Endless loop
while true # alias for ":"
do
operation-1
operation-2
...
operation-n
# Need a way to break out of loop.
done
false
A command that returns an unsuccessful exit status, but does nothing else.
# Null loop
while false
do
# The following code will not execute.
operation-1
operation-2
...
operation-n
# Nothing happens!
done
type [cmd]
Similar to the which external command, type cmd gives the full pathname to "cmd". Unlike which, type is a Bash
builtin. The useful -a option to type identifies keywords and builtins, and also locates system commands with
identical names.
hash [cmds]
Record the path name of specified commands (in the shell hash table), so the shell or script will not need to search the
$PATH on subsequent calls to those commands. When hash is called with no arguments, it simply lists the commands
that have been hashed. The -r option resets the hash table.
help
help COMMAND looks up a short usage summary of the shell builtin COMMAND. This is the counterpart to whatis,
but for builtins.
Notes
[1] An exception to this is the time command, listed in the official Bash documentation as a keyword.
[2] A option is an argument that acts as a flag, switching script behaviors on or off. The argument associated with a
particular option indicates the behavior that the option (flag) switches on or off.
The case construct is the shell equivalent of switch in C/C++. It permits branching to one of a number of code
blocks, depending on condition tests. It serves as a kind of shorthand for multiple if/then/else statements and is
an appropriate tool for creating menus.
case "$variable" in
"$condition1" )
command...
;;
"$condition2" )
command...
;;
esac
❍ Quoting the variables is not mandatory, since word splitting does not take place.
❍ Each test line ends with a right paren ).
❍ Each condition block ends with a double semicolon ;;.
❍ The entire case block terminates with an esac (case spelled backwards).
#!/bin/bash
case "$Keypress" in
[a-z] ) echo "Lowercase letter";;
[A-Z] ) echo "Uppercase letter";;
[0-9] ) echo "Digit";;
* ) echo "Punctuation, whitespace, or other";;
esac # Allows ranges of characters in [square brackets].
# Exercise:
# --------
# As the script stands, # it accepts a single keystroke, then terminates.
# Change the script so it accepts continuous input,
# reports on each keystroke, and terminates only when "X" is hit.
# Hint: enclose everything in a "while" loop.
exit 0
#!/bin/bash
read person
case "$person" in
# Note variable is quoted.
"E" | "e" )
# Accept upper or lowercase input.
echo
echo "Roland Evans"
echo "4321 Floppy Dr."
echo "Hardscrabble, CO 80753"
echo "(303) 734-9874"
echo "(303) 734-9892 fax"
echo "[email protected]"
echo "Business partner & old friend"
;;
# Note double semicolon to terminate
# each option.
"J" | "j" )
echo
echo "Mildred Jones"
echo "249 E. 7th St., Apt. 19"
echo "New York, NY 10009"
* )
# Default option.
# Empty input (hitting RETURN) fits here, too.
echo
echo "Not yet in database."
;;
esac
echo
# Exercise:
# --------
# Change the script so it accepts continuous input,
#+ instead of terminating after displaying just one address.
exit 0
#! /bin/bash
case "$1" in
"") echo "Usage: ${0##*/} <filename>"; exit 65;; # No command-line parameters,
# or first parameter empty.
# Note that ${0##*/} is ${var##pattern} param substitution. Net result is $0.
#!/bin/bash
# Using command substitution to generate a "case" variable.
exit 0
#!/bin/bash
# match-string.sh: simple string matching
match_string ()
{
MATCH=0
NOMATCH=90
PARAMS=2 # Function requires 2 arguments.
BAD_PARAMS=91
case "$1" in
"$2") return $MATCH;;
* ) return $NOMATCH;;
esac
a=one
b=two
c=three
d=two
match_string $a $b # no match
echo $? # 90
match_string $b $d # match
echo $? # 0
exit 0
#!/bin/bash
# Using "case" structure to filter a string.
SUCCESS=0
FAILURE=-1
case "$1" in
[a-zA-Z]*) return $SUCCESS;; # Begins with a letter?
* ) return $FAILURE;;
esac
} # Compare this with "isalpha ()" function in C.
case $1 in
*[!a-zA-Z]*|"") return $FAILURE;;
*) return $SUCCESS;;
esac
}
a=23skidoo
b=H3llo
c=-What?
d=`echo $b` # Command substitution.
check_var $a
check_var $b
check_var $c
check_var $d
check_var # No argument passed, so what happens?
exit 0
select
The select construct, adopted from the Korn Shell, is yet another tool for building menus.
This prompts the user to enter one of the choices presented in the variable list. Note that select uses the PS3
prompt (#? ) by default, but that this may be changed.
#!/bin/bash
echo
exit 0
If in list is omitted, then select uses the list of command line arguments ($@) passed to the script or to the function
in which the select construct is embedded.
#!/bin/bash
echo
choice_of()
{
select vegetable
# [in list] omitted, so 'select' uses arguments passed to function.
do
echo
echo "Your favorite veggie is $vegetable."
echo "Yuck!"
echo
break
done
}
exit 0
break, continue
The break and continue loop control commands [1] correspond exactly to their counterparts in other
programming languages. The break command terminates the loop (breaks out of it), while continue
causes a jump to the next iteration of the loop, skipping all the remaining commands in that particular
loop cycle.
#!/bin/bash
echo
echo "Printing Numbers 1 through 20 (but not 3 and 11)."
a=0
# Exercise:
# Why does loop print up to 20?
echo; echo
##################################################################
a=0
if [ "$a" -gt 2 ]
then
break # Skip entire rest of loop.
fi
exit 0
The break command may optionally take a parameter. A plain break terminates only the innermost loop in
which it is embedded, but a break N breaks out of N levels of loop.
#!/bin/bash
# break-levels.sh: Breaking out of loops.
for outerloop in 1 2 3 4 5
do
echo -n "Group $outerloop: "
for innerloop in 1 2 3 4 5
do
echo -n "$innerloop "
if [ "$innerloop" -eq 3 ]
then
break # Try break 2 to see what happens.
# ("Breaks" out of both inner and outer loops.)
fi
done
echo
done
echo
exit 0
The continue command, similar to break, optionally takes a parameter. A plain continue cuts short the
current iteration within its loop and begins the next. A continue N terminates all remaining iterations at its
loop level and continues with the next iteration at the loop N levels above.
#!/bin/bash
# The "continue N" command, continuing at the Nth level loop.
if [ "$inner" -eq 7 ]
then
continue 2 # Continue at loop on 2nd level, that is "outer loop".
# Replace above line with a simple "continue"
# to see normal loop behavior.
fi
done
echo; echo
# Exercise:
# Come up with a meaningful use for "continue N" in a script.
exit 0
The continue N construct is difficult to understand and tricky to use in any meaningful
context. It is probably best avoided.
Notes
[1] These are shell builtins, whereas other loop commands, such as while and case, are keywords.
#!/bin/bash
# Nested "for" loops.
exit 0
See Example 26-4 for an illustration of nested "while" loops, and Example 26-5 to see a "while"
loop nested inside an "until" loop.
10.1. Loops
A loop is a block of code that iterates (repeats) a list of commands as long as the loop control condition is true.
for loops
for (in)
This is the basic looping construct. It differs significantly from its C counterpart.
During each pass through the loop, arg takes on the value of each variable in the list.
#!/bin/bash
# List the planets.
for planet in Mercury Venus Earth Mars Jupiter Saturn Uranus Neptune Pluto
do
echo $planet
done
echo
exit 0
Each [list] element may contain multiple parameters. This is useful when processing parameters
in groups. In such cases, use the set command (see Example 11-11) to force parsing of each [list]
element and assignment of each component to the positional parameters.
Example 10-2. for loop with two parameters in each [list] element
#!/bin/bash
# Planets revisited.
# Associate the name of each planet with its distance from the sun.
for planet in "Mercury 36" "Venus 67" "Earth 93" "Mars 142" "Jupiter 483"
do
set -- $planet # Parses variable "planet" and sets positional parameters.
# the "--" prevents nasty surprises if $planet is null or begins with a dash.
# May need to save original positional parameters, since they get overwritten.
# One way of doing this is to use an array,
# original_params=("$@")
exit 0
#!/bin/bash
# fileinfo.sh
FILES="/usr/sbin/privatepw
/usr/sbin/pwck
/usr/sbin/go500gw
/usr/bin/fakefile
/sbin/mkreiserfs
/sbin/ypbind" # List of files you are curious about.
# Threw in a dummy file, /usr/bin/fakefile.
echo
ls -l $file | awk '{ print $9 " file size: " $5 }' # Print 2 fields.
whatis `basename $file` # File info.
echo
done
exit 0
The [list] in a for loop may contain filename globbing, that is, using wildcards for filename expansion.
#!/bin/bash
# list-glob.sh: Generating [list] in a for-loop using "globbing".
echo
for file in *
do
ls -l "$file" # Lists all files in $PWD (current directory).
# Recall that the wild card character "*" matches everything,
# however, in "globbing", it doesn't match dot-files.
echo; echo
echo
exit 0
Omitting the in [list] part of a for loop causes the loop to operate on $@, the list of arguments given on the
command line to the script. A particularly clever illustration of this is Example A-16.
#!/bin/bash
# Invoke both with and without arguments, and see what happens.
for a
do
echo -n "$a "
done
echo
exit 0
It is possible to use command substitution to generate the [list] in a for loop. See also Example 12-38, Example 10-10
and Example 12-33.
Example 10-6. Generating the [list] in a for loop with command substitution
#!/bin/bash
# A for-loop with [list] generated by command substitution.
NUMBERS="9 7 3 8 37.53"
echo
exit 0
This is a somewhat more complex example of using command substitution to create the [list].
#!/bin/bash
# bin-grep.sh: Locates matching strings in a binary file.
E_BADARGS=65
E_NOFILE=66
if [ $# -ne 2 ]
then
echo "Usage: `basename $0` string filename"
exit $E_BADARGS
fi
if [ ! -f "$2" ]
then
echo "File \"$2\" does not exist."
exit $E_NOFILE
fi
# As S.C. points out, the above for-loop could be replaced with the simpler
# strings "$2" | grep "$1" | tr -s "$IFS" '[\n*]'
exit 0
#!/bin/bash
# userlist.sh
PASSWORD_FILE=/etc/passwd
n=1 # User number
# USER #1 = root
# USER #2 = bin
# USER #3 = daemon
# ...
# USER #30 = bozo
exit 0
#!/bin/bash
# findstring.sh:
# Find a particular string in binaries in a specified directory.
directory=/usr/bin/
fstring="Free Software Foundation" # See which files come from the FSF.
exit 0
# Exercise (easy):
# ---------------
# Convert this script to taking command-line parameters
#+ for $directory and $fstring.
#!/bin/bash
# symlinks.sh: Lists symbolic links in a directory.
for file in "$( find $directory -type l )" # -type l = symbolic links
do
echo "$file"
done | sort # Otherwise file list is unsorted.
exit 0
The stdout of a loop may be redirected to a file, as this slight modification to the previous example shows.
#!/bin/bash
# symlinks.sh: Lists symbolic links in a directory.
for file in "$( find $directory -type l )" # -type l = symbolic links
do
echo "$file"
done | sort > "$OUTFILE" # stdout of loop
exit 0
There is an alternative syntax to a for loop that will look very familiar to C programmers. This requires double
parentheses.
#!/bin/bash
# Two ways to count up to 10.
echo
# Standard syntax.
for a in 1 2 3 4 5 6 7 8 9 10
do
echo -n "$a "
done
echo; echo
# +==========================================+
LIMIT=10
for ((a=1; a <= LIMIT ; a++)) # Double parentheses, and "LIMIT" with no "$".
do
echo -n "$a "
done # A construct borrowed from 'ksh93'.
echo; echo
# +=========================================================================+
for ((a=1, b=1; a <= LIMIT ; a++, b++)) # The comma chains together operations.
do
echo -n "$a-$b "
done
echo; echo
exit 0
---
#!/bin/bash
EXPECTED_ARGS=2
E_BADARGS=65
if [ $# -ne $EXPECTED_ARGS ]
# Check for proper no. of command line args.
then
echo "Usage: `basename $0` phone# text-file"
exit $E_BADARGS
fi
if [ ! -f "$2" ]
then
echo "File $2 is not a text file"
exit $E_BADARGS
fi
exit 0
while
This construct tests for a condition at the top of a loop, and keeps looping as long as that condition is true (returns
a 0 exit status). In contrast to a for loop, a while loop finds use in situations where the number of loop repetitions is
not known beforehand.
while [condition]
do
command...
done
As is the case with for/in loops, placing the do on the same line as the condition test requires a semicolon.
while [condition] ; do
Note that certain specialized while loops, as, for example, a getopts construct, deviate somewhat from the standard
template given here.
#!/bin/bash
var0=0
LIMIT=10
echo
exit 0
#!/bin/bash
echo
exit 0
A while loop may have multiple conditions. Only the final condition determines when the loop terminates. This
necessitates a slightly different loop syntax, however.
#!/bin/bash
var1=unset
previous=$var1
exit 0
As with a for loop, a while loop may employ C-like syntax by using the double parentheses construct (see also Example
9-25).
#!/bin/bash
# wh-loopc.sh: Count to 10 in a "while" loop.
LIMIT=10
a=1
echo; echo
# +=================================================================+
# Yes, indeed.
# Double parentheses permit incrementing a variable with C-like syntax.
done
echo
exit 0
A while loop may have its stdin redirected to a file by a < at its end.
until
This construct tests for a condition at the top of a loop, and keeps looping as long as that condition is false
(opposite of while loop).
until [condition-is-true]
do
command...
done
Note that an until loop tests for the terminating condition at the top of the loop, differing from a similar construct
in some programming languages.
As is the case with for/in loops, placing the do on the same line as the condition test requires a semicolon.
until [condition-is-true] ; do
#!/bin/bash
exit 0
Operations on code blocks are the key to structured, organized shell scripts. Looping and
branching constructs provide the tools for accomplishing this.
Let us carefully distinguish between the name of a variable and its value. If variable1 is the name of a
variable, then $variable1 is a reference to its value, the data item it contains. The only time a variable
appears "naked", without the $ prefix, is when declared or assigned, when unset, when exported, or in the
special case of a variable representing a signal (see Example 30-5). Assignment may be with an = (as in
var1=27), in a read statement, and at the head of a loop (for var2 in 1 2 3).
Enclosing a referenced value in double quotes (" ") does not interfere with variable substitution. This is
called partial quoting, sometimes referred to as "weak quoting". Using single quotes (' ') causes the variable
name to be used literally, and no substitution will take place. This is full quoting, sometimes referred to as
"strong quoting". See Chapter 6 for a detailed discussion.
Note that $variable is actually a simplified alternate form of ${variable}. In contexts where the
$variable syntax causes an error, the longer form may work (see Section 9.3, below).
#!/bin/bash
a=375
hello=$a
#-------------------------------------------------------------------------
# No space permitted on either side of = sign when initializing variables.
# If "VARIABLE =value",
#+ script tries to run "VARIABLE" command with one argument, "=value".
# If "VARIABLE= value",
#+ script tries to run "value" command with
#+ the environmental variable "VARIABLE" set to "".
#-------------------------------------------------------------------------
echo $hello
echo ${hello} # Identical to above.
echo "$hello"
echo "${hello}"
echo
hello="A B C D"
echo $hello # A B C D
echo "$hello" # A B C D
# As you see, echo $hello and echo "$hello" give different results.
# Quoting a variable preserves whitespace.
echo
# --------------------------------------------------------------
# --------------------------------------------------------------
echo; echo
echo
exit 0
An uninitialized variable has a "null" value - no assigned value at all (not zero!). Using a
variable before assigning a value to it will inevitably cause problems.
Chapter 6. Quoting
Quoting means just that, bracketing a string in quotes. This has the effect of protecting special characters in the string from
reinterpretation or expansion by the shell or shell script. (A character is "special" if it has an interpretation other than its literal
meaning, such as the wild card character, *.)
bash$ ls -l [Vv]*
-rw-rw-r-- 1 bozo bozo 324 Apr 2 15:05 VIEWDATA.BAT
-rw-rw-r-- 1 bozo bozo 507 May 4 14:25 vartrace.sh
-rw-rw-r-- 1 bozo bozo 539 Apr 14 17:11 viewdata.sh
bash$ ls -l '[Vv]*'
ls: [Vv]*: No such file or directory
Certain programs and utilities can still reinterpret or expand special characters in a quoted string. This is an important
use of quoting, protecting a command-line parameter from the shell, but still letting the calling program expand it.
When referencing a variable, it is generally advisable in enclose it in double quotes (" "). This preserves all special characters
within the variable name, except $, ` (backquote), and \ (escape). Keeping $ as a special character permits referencing a quoted
variable ("$variable"), that is, replacing the variable with its value (see Example 5-1, above).
Use double quotes to prevent word splitting. [1] An argument enclosed in double quotes presents itself as a single word, even if
it contains whitespace separators.
variable2="" # Empty.
# Thanks, S.C.
Enclosing the arguments to an echo statement in double quotes is necessary only when word splitting is an issue.
#!/bin/bash
# weirdvars.sh: Echoing weird variables.
var="'(]\\{}\$\""
echo $var # '(]\{}$"
echo "$var" # '(]\{}$" Doesn't make a difference.
echo
IFS='\'
echo $var # '(] {}$" \ converted to space.
echo "$var" # '(]\{}$"
exit 0
Single quotes (' ') operate similarly to double quotes, but do not permit referencing variables, since the special meaning of $ is
turned off. Within single quotes, every special character except ' gets interpreted literally. Consider single quotes ("full
quoting") to be a stricter method of quoting than double quotes ("partial quoting").
Since even the escape character (\) gets a literal interpretation within single quotes, trying to enclose a single quote
within single quotes will not yield the expected result.
echo
Escaping is a method of quoting single characters. The escape (\) preceding a character tells the shell to interpret that character
literally.
With certain commands and utilities, such as echo and sed, escaping a character may have the opposite effect - it can
toggle on a special meaning for that character.
\n
means newline
\r
means return
\t
means tab
\v
means backspace
\a
#!/bin/bash
# escaped.sh: escaped characters
echo; echo
echo
echo; echo
echo; echo
exit 0
See Example 35-1 for another example of the $' ' string expansion construct.
\"
\$
gives the dollar sign its literal meaning (variable name following \$ will not be referenced)
\\
The behavior of \ depends on whether it is itself escaped, quoted, or appearing within command substitution or a here
document.
# Command substitution
echo `echo \z` # z
echo `echo \\z` # z
echo `echo \\\z` # \z
echo `echo \\\\z` # \z
echo `echo \\\\\\z` # \z
echo `echo \\\\\\\z` # \\z
echo `echo "\z"` # \z
echo `echo "\\z"` # \z
# Here document
cat <<EOF
\z
EOF # \z
cat <<EOF
\\z
EOF # \z
Elements of a string assigned to a variable may be escaped, but the escape character alone may not be assigned to a
variable.
variable=\
echo "$variable"
# Will not work - gives an error message:
# test.sh: : command not found
# A "naked" escape cannot safely be assigned to a variable.
#
# What actually happens here is that the "\" escapes the newline and
#+ the effect is variable=echo "$variable"
#+ invalid variable assignment
variable=\
23skidoo
echo "$variable" # 23skidoo
# This works, since the second line
#+ is a valid variable assignment.
variable=\
# \^ escape followed by space
echo "$variable" # space
variable=\\
echo "$variable" # \
variable=\\\
echo "$variable"
# Will not work - gives an error message:
# test.sh: \: command not found
#
# First escape escapes second one, but the third one is left "naked",
#+ with same result as first instance, above.
variable=\\\\
echo "$variable" # \\
# Second and fourth escapes escaped.
# This is o.k.
echo "-------------------------------------------------------------------------"
The escape also provides a means of writing a multi-line command. Normally, each separate line constitutes a different
command, but an escape at the end of a line escapes the newline character, and the command sequence continues on to the next
line.
# As an alternative:
tar cf - -C /source/directory . |
tar xpvf - -C /dest/directory
# See note below.
# (Thanks, Stephane Chazelas.)
If a script line ends with a |, a pipe character, then a \, an escape, is not strictly necessary. It is, however, good
programming practice to always escape the end of a line of code that continues to the following line.
echo "foo
bar"
#foo
#bar
echo
echo 'foo
bar' # No difference yet.
#foo
#bar
echo
echo foo\
bar # Newline escaped.
#foobar
echo
echo "foo\
bar" # Same here, as \ still interpreted as escape within weak quotes.
#foobar
echo
echo 'foo\
bar' # Escape character \ taken literally because of strong quoting.
#foor\
#bar
Notes
[1] "Word splitting", in this context, means dividing a character string into a number of separate and discrete arguments.
The classic form of command substitution uses backquotes (`...`). Commands within backquotes (backticks) generate command
line text.
script_name=`basename $0`
echo "The name of this script is $script_name."
The output of commands can be used as arguments to another command, to set a variable, and even for generating the
argument list in a for loop.
textfile_listing=`ls *.txt`
# Variable contains names of all *.txt files in current working directory.
echo $textfile_listing
# Thanks, S.C.
Even when there is no word splitting, command substitution can remove trailing newlines.
Thanks, S.C.
Using echo to output an unquoted variable set with command substitution removes trailing newlines characters from the
output of the reassigned command(s). This can cause unpleasant surprises.
dir_listing=`ls -l`
echo $dir_listing # unquoted
Command substitution even permits setting a variable to the contents of a file, using either redirection or the cat command.
if [ -f /fsckoptions ]; then
fsckoptions=`cat /fsckoptions`
...
fi
#
#
if [ -e "/proc/ide/${disk[$device]}/media" ] ; then
hdmedia=`cat /proc/ide/${disk[$device]}/media`
...
fi
#
#
if [ ! -n "`uname -r | grep -- "-"`" ]; then
ktag="`cat /proc/version`"
...
fi
#
#
if [ $usb = "1" ]; then
sleep 5
mouseoutput=`cat /proc/bus/usb/devices 2>/dev/null|grep -E "^I.*Cls=03.*Prot=02"`
kbdoutput=`cat /proc/bus/usb/devices 2>/dev/null|grep -E "^I.*Cls=03.*Prot=01"`
...
fi
Do not set a variable to the contents of a long text file unless you have a very good reason for doing so. Do not set a
variable to the contents of a binary file, even as a joke.
#!/bin/bash
# stupid-script-tricks.sh: Don't try this at home, folks.
# echo "$dangerous_variable"
# Don't try this! It would hang the script.
exit 0
Notice that a buffer overrun does not occur. This is one instance where an interpreted language, such as Bash, provides
more protection from programmer mistakes than a compiled language.
Command substitution permits setting a variable to the output of a loop. The key to this is grabbing the output of an echo
command within the loop.
#!/bin/bash
# csubloop.sh: Setting a variable to the output of a loop.
variable1=`for i in 1 2 3 4 5
do
echo -n "$i" # The 'echo' command is critical
done` #+ to command substitution.
i=0
variable2=`while [ "$i" -lt 10 ]
do
exit 0
Command substitution makes it possible to extend the toolset available to Bash. It is simply a matter of writing a program or
script that outputs to stdout (like a well-behaved UNIX tool should) and assigning that output to a variable.
#include <stdio.h>
int main()
{
printf( "Hello, world." );
return (0);
}
#!/bin/bash
# hello.sh
greeting=`./hello`
echo $greeting
bash$ sh hello.sh
Hello, world.
1. Example 10-7
2. Example 10-25
3. Example 9-23
4. Example 12-2
5. Example 12-15
6. Example 12-12
7. Example 12-38
8. Example 10-13
9. Example 10-10
10. Example 12-24
11. Example 16-7
12. Example A-17
13. Example 28-1
14. Example 12-32
15. Example 12-33
16. Example 12-34
Notes
[1] For purposes of command substitution, a command may be an external system command, an internal scripting builtin,
or even a script function.
factor
bc, dc
Of the two, bc seems more useful in scripting. It is a fairly well-behaved UNIX utility, and may therefore be used in a
pipe.
Bash can't handle floating point calculations, and it lacks operators for certain important mathematical functions.
Fortunately, bc comes to the rescue.
Here is a simple template for using bc to calculate a script variable. This uses command substitution.
#!/bin/bash
# monthlypmt.sh: Calculates monthly payment on a mortgage.
echo
echo "Given the principal, interest rate, and term of a mortgage,"
echo "calculate the monthly payment."
bottom=1.0
echo
echo -n "Enter principal (no commas) "
read principal
echo -n "Enter interest rate (percent) " # If 12%, enter "12", not ".12".
read interest_r
echo -n "Enter term (months) "
read term
# bottom=`{
# echo "scale=9; bottom=$bottom; interest_rate=$interest_rate"
# ====================================================================
echo
echo "monthly payment = \$$payment" # Echo a dollar sign in front of amount.
echo
exit 0
# Exercises:
# 1) Filter input to permit commas in principal amount.
# 2) Filter input to permit interest to be entered as percent or decimal.
# 3) If you are really ambitious,
# expand this script to print complete amortization tables.
:
##########################################################################
# Shellscript: base.sh - print number to different bases (Bourne Shell)
# Author : Heiner Steven ([email protected])
# Date : 07-03-95
# Category : Desktop
# $Id: base.sh,v 1.2 2000/02/06 19:55:35 heiner Exp $
##########################################################################
# Description
#
# Changes
# 21-03-95 stv fixed error occuring with 0xb as input (0.2)
##########################################################################
NOARGS=65
PN=`basename "$0"` # Program name
VER=`echo '$Revision: 1.2 $' | cut -d' ' -f2` # ==> VER=1.2
Usage () {
echo "$PN - print number to different bases, $VER (stv '95)
usage: $PN [number ...]
A number may be
binary (base 2) starting with 0b (i.e. 0b1100)
octal (base 8) starting with 0 (i.e. 014)
hexadecimal (base 16) starting with 0x (i.e. 0xc)
decimal otherwise (i.e. 12)" >&2
exit $NOARGS
} # ==> Function to print usage message.
Msg () {
for i # ==> in [list] missing.
do echo "$PN: $i" >&2
done
}
PrintBases () {
# Determine base of the number
for i # ==> in [list] missing...
do # ==> so operates on command line arg(s).
case "$i" in
0b*) ibase=2;; # binary
0x*|[a-f]*|[A-F]*) ibase=16;; # hexadecimal
0*) ibase=8;; # octal
[1-9]*) ibase=10;; # decimal
*)
Msg "illegal number $i - ignored"
continue;;
esac
done
}
while [ $# -gt 0 ]
do
case "$1" in
--) shift; break;;
-h) Usage;; # ==> Help message.
-*) Usage;;
*) break;; # first number
esac # ==> More error checking for illegal input would be useful.
shift
done
if [ $# -gt 0 ]
then
PrintBases "$@"
else # read from stdin
while read line
do
PrintBases $line
done
fi
An alternate method of invoking bc involves using a here document embedded within a command substitution block. This is
especially appropriate when a script needs to pass a list of options and commands to bc.
...or...
#!/bin/bash
# Invoking 'bc' using command substitution
# in combination with a 'here document'.
exit 0
Most persons avoid dc, since it requires non-intuitive RPN input. Yet it has its uses.
#!/bin/bash
# hexconvert.sh: Convert a decimal number to hexadecimal.
BASE=16 # Hexadecimal.
if [ -z "$1" ]
then
echo "Usage: $0 number"
exit $E_NOARGS
# Need a command line argument.
fi
# Exercise: add argument validity checking.
hexcvt ()
{
if [ -z "$1" ]
then
echo 0
return # "Return" 0 if no arg passed to function.
fi
hexcvt "$1"
exit 0
Studying the info page for dc gives some insight into its intricacies. However, there seems to be a small, select group of dc
wizards who delight in showing off their mastery of this powerful, but arcane utility.
#!/bin/bash
# factr.sh: Factor a number
if [ -z $1 ]
then
echo "Usage: $0 number"
exit $E_NOARGS
fi
exit 0
awk
Yet another way of doing floating point math in a script is using awk's built-in math functions in a shell wrapper.
#!/bin/bash
# hypotenuse.sh: Returns the "hypotenuse" of a right triangle.
# ( square root of sum of squares of the "legs")
exit 0
$BASH_ENV
an environmental variable pointing to a Bash startup file to be read when a script is invoked
$BASH_VERSINFO[n]
a 6-element array containing version information about the installed release of Bash. This is similar to $BASH_VERSION,
below, but a bit more detailed.
for n in 0 1 2 3 4 5
do
echo "BASH_VERSINFO[$n] = ${BASH_VERSINFO[$n]}"
done
$BASH_VERSION
Checking $BASH_VERSION is a good method of determining which shell is running. $SHELL does not necessarily give
the correct answer.
$DIRSTACK
the top value in the directory stack (affected by pushd and popd)
This builtin variable corresponds to the dirs command, however dirs shows the entire contents of the directory stack.
$EDITOR
Identification number of whatever identity the current user has assumed, perhaps by means of su.
xyz23 ()
{
echo "$FUNCNAME now executing." # xyz23 now executing.
}
xyz23
$GLOBIGNORE
This is a listing (array) of the group id numbers for current user, as recorded in /etc/passwd.
$HOME
The hostname command assigns the system name at bootup in an init script. However, the gethostname() function sets
the Bash internal variable $HOSTNAME. See also Example 9-12.
$HOSTTYPE
host type
$IFS
This defaults to whitespace (space, tab, and newline), but may be changed, for example, to parse a comma-separated data
file. Note that $* uses the first character held in $IFS. See Example 6-1.
$IFS does not handle whitespace the same as it does other characters.
#!/bin/bash
# $IFS treats whitespace differently than other characters.
output_args_one_per_line()
{
for arg
do echo "[$arg]"
done
}
IFS=" "
var=" a b c "
output_args_one_per_line $var # output_args_one_per_line `echo " a b c "`
#
# [a]
# [b]
# [c]
IFS=:
var=":a::b:c:::" # Same as above, but substitute ":" for " ".
output_args_one_per_line $var
#
# []
# [a]
# []
# [b]
# [c]
# []
# []
# []
# The same thing happens with the "FS" field separator in awk.
echo
exit 0
ignore EOF: how many end-of-files (control-D) the shell will ignore before logging out.
$LC_COLLATE
Often set in the .bashrc or /etc/profile files, this variable controls collation order in filename expansion and
pattern matching. If mishandled, LC_COLLATE can cause unexpected results in filename globbing.
As of version 2.05 of Bash, filename globbing no longer distinguishes between lowercase and uppercase
letters in a character range between brackets. For example, ls [A-M]* would match both File1.txt and
file1.txt. To revert to the customary behavior of bracket matching, set LC_COLLATE to C by an
export LC_COLLATE=C in /etc/profile and/or ~/.bashrc.
$LC_CTYPE
This internal variable controls character interpretation in globbing and pattern matching.
$LINENO
This variable is the line number of the shell script in which this variable appears. It has significance only within the script in
which it appears, and is chiefly useful for debugging purposes.
$MACHTYPE
machine type
$OLDPWD
$PATH
When given a command, the shell automatically does a hash table search on the directories listed in the path for the
executable. The path is stored in the environmental variable, $PATH, a list of directories, separated by colons. Normally,
the system stores the $PATH definition in /etc/profile and/or ~/.bashrc (see Chapter 27).
PATH=${PATH}:/opt/bin appends the /opt/bin directory to the current path. In a script, it may be expedient to
temporarily add a directory to the path in this way. When the script exits, this restores the original $PATH (a child process,
such as a script, may not change the environment of the parent process, the shell).
The current "working directory", ./, is usually omitted from the $PATH as a security measure.
$PIPESTATUS
Exit status of last executed pipe. Interestingly enough, this does not give the same result as the exit status of the last
executed command.
$PPID
The $PPID of a process is the process id (pid) of its parent process. [1]
The secondary prompt, seen when additional input is expected. It displays as ">".
$PS3
The quartenary prompt, shown at the beginning of each line of output when invoking a script with the -x option. It displays
as "+".
$PWD
#!/bin/bash
E_WRONG_DIRECTORY=73
TargetDirectory=/home/bozo/projects/GreatAmericanNovel
cd $TargetDirectory
echo "Deleting stale files in $TargetDirectory."
if [ "$PWD" != "$TargetDirectory" ]
then # Keep from wiping out wrong directory by accident.
echo "Wrong directory!"
echo "In $PWD, rather than $TargetDirectory!"
echo "Bailing out!"
exit $E_WRONG_DIRECTORY
fi
rm -rf *
rm .[A-Za-z0-9]* # Delete dotfiles.
# rm -f .[^.]* ..?* to remove filenames beginning with multiple dots.
# (shopt -s dotglob; rm -f *) will also work.
# Thanks, S.C. for pointing this out.
# Filenames may contain all characters in the 0 - 255 range, except "/".
# Deleting files beginning with weird characters is left as an exercise.
echo
echo "Done."
echo "Old files deleted in $TargetDirectory."
echo
exit 0
$REPLY
The default value when a variable is not supplied to read. Also applicable to select menus, but only supplies the item
number of the variable chosen, not the value of the variable itself.
#!/bin/bash
echo
echo -n "What is your favorite vegetable? "
read
echo
echo -n "What is your favorite fruit? "
read fruit
echo
exit 0
$SECONDS
#!/bin/bash
ENDLESS_LOOP=1
INTERVAL=1
echo
echo "Hit Control-C to exit this script."
echo
while [ $ENDLESS_LOOP ]
do
if [ "$SECONDS" -eq 1 ]
then
units=second
else
units=seconds
fi
exit 0
$SHELLOPTS
$SHLVL
Shell level, how deeply Bash is nested. If, at the command line, $SHLVL is 1, then in a script it will increment to 2.
$TMOUT
If the $TMOUT environmental variable is set to a non-zero value time, then the shell prompt will time out after time seconds.
This will cause a logout.
Unfortunately, this works only while waiting for input at the shell prompt console or in an xterm. While it
would be nice to speculate on the uses of this internal variable for timed input, for example in combination
with read, $TMOUT does not work in that context and is virtually useless for shell scripting. (Reportedly the
ksh version of a timed read does work.)
Implementing timed input in a script is certainly possible, but may require complex machinations. One method is to set up a timing
loop to signal the script when it times out. This also requires a signal handling routine to trap (see Example 30-5) the interrupt
generated by the timing loop (whew!).
#!/bin/bash
# timed-input.sh
PrintAnswer()
{
if [ "$answer" = TIMEOUT ]
then
echo $answer
else # Don't want to mix up the two instances.
echo "Your favorite veggie is $answer"
kill $! # Kills no longer needed TimerOn function running in background.
# $! is PID of last job running in background.
fi
TimerOn()
{
sleep $TIMELIMIT && kill -s 14 $$ &
# Waits 3 seconds, then sends sigalarm to script.
}
Int14Vector()
{
answer="TIMEOUT"
PrintAnswer
exit 14
}
exit 0
#!/bin/bash
# timeout.sh
timedout_read() {
timeout=$1
varname=$2
old_tty_settings=`stty -g`
stty -icanon min 0 time ${timeout}0
eval read $varname # or just read $varname
stty "$old_tty_settings"
# See man page for "stty".
}
echo
echo
exit 0
#!/bin/bash
# t-out.sh (per a suggestion by "syngin seven)
TIMELIMIT=4 # 4 seconds
echo
if [ -z "$variable" ]
then
echo "Timed out, variable still unset."
else
echo "variable = $variable"
fi
exit 0
$UID
user id number
This is the current user's real id, even if she has temporarily assumed another identity through su. $UID is a readonly
variable, not subject to change from the command line or within a script, and is the counterpart to the id builtin.
#!/bin/bash
# am-i-root.sh: Am I root or not?
if [ "$UID" -eq "$ROOT_UID" ] # Will the real "root" please stand up?
then
echo "You are root."
else
echo "You are just an ordinary user (but mom loves you just the same)."
fi
exit 0
# ============================================================= #
# Code below will not execute, because the script already exited.
ROOTUSER_NAME=root
then
echo "Rooty, toot, toot. You are root."
else
echo "You are just a regular fella."
fi
The variables $ENV, $LOGNAME, $MAIL, $TERM, $USER, and $USERNAME are not Bash builtins. These
are, however, often set as environmental variables in one of the Bash startup files. $SHELL, the name of the
user's login shell, may be set from /etc/passwd or in an "init" script, and it is likewise not a Bash builtin.
Positional Parameters
positional parameters, passed from command line to script, passed to a function, or set to a variable (see Example 5-5 and
Example 11-11)
$#
number of command line arguments [2] or positional parameters (see Example 34-2)
$*
Same as $*, but each parameter is a quoted string, that is, the parameters are passed on intact, without interpretation or
expansion. This means, among other things, that each parameter in the argument list is seen as a separate word.
#!/bin/bash
# Invoke this script with several arguments, such as "one two three".
E_BADARGS=65
if [ ! -n "$1" ]
then
echo "Usage: `basename $0` argument1 argument2 etc."
exit $E_BADARGS
fi
echo
index=1
echo
index=1
echo
exit 0
Following a shift, the $@ holds the remaining command-line parameters, lacking the previous $1, which was lost.
#!/bin/bash
# Invoke with ./scriptname 1 2 3 4 5
echo "$@" # 1 2 3 4 5
shift
echo "$@" # 2 3 4 5
shift
echo "$@" # 3 4 5
The $@ special parameter finds use as a tool for filtering input into shell scripts. The cat "$@" construction accepts input to a
script either from stdin or from files given as parameters to the script. See Example 12-17 and Example 12-18.
The $* and $@ parameters sometimes display inconsistent and puzzling behavior, depending on the setting of
$IFS.
#!/bin/bash
echo
IFS=:
echo 'IFS=":", using "$*"'
c=0
for i in "$*"
do echo "$((c+=1)): [$i]"
done
echo ---
var=$*
echo 'IFS=":", using "$var" (var=$*)'
c=0
for i in "$var"
do echo "$((c+=1)): [$i]"
done
echo ---
var="$*"
echo 'IFS=":", using $var (var="$*")'
c=0
for i in $var
do echo "$((c+=1)): [$i]"
done
echo ---
var=$@
echo 'IFS=":", using $var (var=$@)'
c=0
for i in $var
do echo "$((c+=1)): [$i]"
done
echo ---
var="$@"
echo 'IFS=":", using "$var" (var="$@")'
c=0
for i in "$var"
do echo "$((c+=1)): [$i]"
done
echo ---
echo
exit 0
#!/bin/bash
mecho $@ # a,b,c
mecho "$@" # a,b,c
# Thanks, S.C.
exit 0
$-
This was originally a ksh construct adopted into Bash, and unfortunately it does not seem to work reliably in
Bash scripts. One possible use for it is to have a script self-test whether it is interactive.
$!
#!/bin/bash
echo $_ # /bin/bash
# Just called /bin/bash to run the script.
:
echo $_ # :
$?
exit status of a command, function, or the script itself (see Example 23-3)
$$
process id of the script itself, often used in scripts to construct "unique" temp file names (see Example A-13, Example 30-6,
Example 12-23, and Example 11-20)
Notes
Comments. Lines beginning with a # (with the exception of #!) are comments.
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, an escaped # in an echo statement does not begin a comment. Likewise, a # appears in certain
parameter substitution constructs and in numerical constant expressions.
# Thanks, S.C.
The standard quoting and escape characters (" ' \) escape the #.
Command separator. [Semicolon] Permits putting two or more commands on the same line.
;;
case "$variable" in
abc) echo "$variable = abc" ;;
xyz) echo "$variable = xyz" ;;
esac
"dot" command. [period] Equivalent to source (see Example 11-16). This is a bash builtin.
"dot", as a component of a filename. When working with filenames, a dot is the prefix of a "hidden" file, a file that an ls will
not normally show.
bash$ ls -al
total 14
drwxrwxr-x 2 bozo bozo 1024 Aug 29 20:54 ./
drwx------ 52 bozo bozo 3072 Aug 29 20:51 ../
-rw-r--r-- 1 bozo bozo 4034 Jul 18 22:04 data1.addressbook
-rw-r--r-- 1 bozo bozo 4602 May 25 13:58 data1.addressbook.bak
-rw-r--r-- 1 bozo bozo 877 Dec 17 2000 employment.addressbook
-rw-rw-r-- 1 bozo bozo 0 Aug 29 20:54 .hidden-file
When considering directory names, a single dot represents the current working directory, and two dots denote the parent
directory.
bash$ pwd
/home/bozo/projects
bash$ cd .
bash$ pwd
/home/bozo/projects
bash$ cd ..
bash$ pwd
/home/bozo/
The dot often appears as the destination (directory) of a file movement command.
bash$ cp /home/bozo/current_work/junk/* .
"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
also Chapter 6.
'
full quoting. [single quote] 'STRING' preserves all special characters within STRING. This is a stronger form of quoting than
using ". See also Chapter 6.
comma operator. The comma operator links together a series of arithmetic operations. All are evaluated, but only the last one
is returned.
escape. [backslash] \X "escapes" the character X. This has the effect of "quoting" X, equivalent to 'X'. The \ may be used to
quote " and ', so they are expressed literally.
Filename path separator. [forward slash] Separates the components of a filename (as in
/home/bozo/projects/Makefile).
command substitution. [backticks] `command` makes available the output of command for setting a variable. This is also
known as backticks or backquotes.
null command. [colon] This is the shell equivalent of a "NOP" (no op, a do-nothing operation). It may be considered a
synonym for the shell builtin true. The ":" command is a itself a Bash builtin, and its exit status is "true" (0).
:
echo $? # 0
Endless loop:
while :
do
operation-1
operation-2
...
operation-n
done
# Same as:
# while true
# do
# ...
# done
if condition
then : # Do nothing and branch ahead
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`} without the leading : gives an error
# unless "username" is a command or builtin...
Provide a placeholder where a command is expected in a here document. See Example 17-9.
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.
In combination with the >> redirection operator, updates a file access/modification time (: >> new_file). If the file did not
previously exist, creates it. This is equivalent to touch.
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 be appear in a comment. However, this is not the case with :.
The ":" also serves as a field separator, in /etc/passwd, and in the $PATH variable.
reverse (or negate) the sense of a test or exit status. The ! operator inverts the exit status of the command to which it is
applied (see Example 3-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 yet another context, from the command line, the ! invokes the Bash history mechanism (see Appendix F). 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, as well as representing any
number (or zero) characters in a regular expression.
test operator. Within certain expressions, the ? indicates a test for a condition.
In a double parentheses construct, the ? serves as a C-style trinary operator. See Example 9-25.
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.
var1=5
var2=23skidoo
echo $var1 # 5
echo $var2 # 23skidoo
${}
Parameter substitution.
$*, $@
positional parameters.
$?
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 of the script in which it appears.
()
command group.
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.
a=123
( a=321; )
array initialization.
{xxx,yyy,zzz,...}
Brace expansion.
A command may act upon a comma-separated list of file specs within braces. [1] Filename expansion (globbing) applies to
the file specs between the braces.
No spaces allowed within the braces unless the spaces are quoted or escaped.
Block of code. [curly brackets] Also referred to as an "inline group", this construct, in effect, creates an anonymous function.
However, unlike a function, the variables in 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.
#!/bin/bash
# Reading lines in /etc/fstab.
File=/etc/fstab
{
read line1
read line2
} < $File
exit 0
#!/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
{
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
} > "$1.test" # Redirects output of everything in block to file.
exit 0
Unlike a command group within (parentheses), as above, a code block enclosed by {braces} will not
normally launch a subshell. [2]
{} \;
The ";" ends the -exec option of a find command sequence. It needs to be escaped to protect it from
interpretation by the shell.
[]
test.
Test expression between [ ]. Note that [ is part of the shell builtin test (and a synonym for it), not a link to the external
command /usr/bin/test.
[[ ]]
test.
[]
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.
(( ))
integer expansion.
redirection.
scriptname >filename redirects the output of scriptname to file filename. Overwrite filename if it already
exists.
command &>filename redirects both the stdout and the stderr of command to filename.
scriptname >>filename appends the output of scriptname to file filename. If filename does not already exist,
it will be created.
process substitution.
(command)>
<(command)
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 12-6.
<<
<, >
ASCII comparison.
veg1=carrots
veg2=tomatoes
\<, \>
pipe. Passes the output of previous command to the input of the next one, or to the shell. This is a method of chaining
commands together.
echo ls -l | sh
# Passes the output of "echo ls -l" to the shell,
#+ with the same result as a simple "ls -l".
A pipe, as a classic method of interprocess communication, sends the stdout of one process to the stdin of another. In a
typical case, a command, such as cat or echo, pipes a stream of data to a "filter" (a command that transforms its input) for
processing.
#!/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 stdout of each process in a pipe must be read as the stdin of the next. If this is not the case, the
data stream will block, and the pipe will not behave as expected.
A pipe runs as a child process, and therefore cannot alter script variables.
variable="initial_value"
echo "new_value" | read variable
echo "variable = $variable" # variable = initial_value
If one of the commands in the pipe aborts, this prematurely terminates execution of the pipe. Called a
broken pipe, this condition sends a SIGPIPE signal.
>|
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.
#!/bin/bash
# background-loop.sh
# ======================================================
# 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?)
exit 0
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.
COMMAND -[Option1][Option2][...]
ls -al
set -- $variable
Note that in this context the "-" is not itself a Bash operator, but rather an option recognized by certain UNIX utilities that write
to stdout, such as tar, cat, etc.
Where a filename is expected, - redirects output to stdout (sometimes seen with tar cf), or accepts input from stdin,
rather than from a file. This is a method of using a file-oriented utility as a filter in a pipe.
bash$ file
Usage: file [-bciknvzL] [-f namefile] [-m magicfiles] file...
Add a "-" for a more useful result. This causes the shell to await user input.
bash$ file -
abc
standard input: ASCII text
bash$ file -
#!/bin/bash
standard input: Bourne-Again shell script text executable
The "-" can be used to pipe stdout to other commands. This permits such stunts as prepending lines to a file.
#!/bin/bash
NOARGS=0
E_BADARGS=65
if [ $# = $NOARGS ]
then
echo "Usage: `basename $0` filename"
exit $E_BADARGS
fi
# Stephane Chazelas points out that the above code will fail
#+ if there are too many files found
#+ or if any filenames contain blank characters.
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 ./-FILENAME,
$PWD/-FILENAME, or $PATHNAME/-FILENAME.
If the value of a variable begins with a -, this may likewise create problems.
var="-n"
echo $var
# Has the effect of "echo -n", and outputs nothing.
previous working directory. [dash] cd - 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.
a=28
echo $a # 28
Certain commands and builtins use the + to enable certain options and the - to disable them.
home directory. [tilde] This corresponds to the $HOME internal variable. ~bozo is bozo's home directory, and ls ~bozo lists
the contents of it. ~/ is the current user's home directory, and ls ~/ lists the contents of it.
bash$ echo ~
/home/bozo
bash$ echo ~/
/home/bozo/
bash$ echo ~:
/home/bozo:
~+
~-
Control Characters
change the behavior of the terminal or text display. A control character is a CONTROL + key combination.
❍ Ctl-C
Ctl-D
"BEL" (beep).
❍ Ctl-H
Backspace.
#!/bin/bash
# Embedding Ctl-H in a string.
❍ Ctl-J
Carriage return.
❍ Ctl-L
Formfeed (clear the terminal screen). This has the same effect as the clear command.
❍ Ctl-M
Newline.
❍ Ctl-U
functions as a separator, separating commands or variables. Whitespace consists of either spaces, tabs, blank lines, or any
combination thereof. 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.
Notes
[1] The shell does the brace expansion. The command itself acts upon the result of the expansion.
[2] Exception: a code block in braces as part of a pipe may be run as a subshell.
# Thanks, S.C.
#!/bin/bash
area[11]=23
area[13]=37
area[51]=UFOs
echo
# -----------------------------------------------------------------
# Another array, "area2".
# Another way of assigning array variables...
# array_name=( XXX YYY ZZZ ... )
# -----------------------------------------------
# Yet another array, "area3".
# Yet another way of assigning array variables...
# array_name=([xx]=XXX [yy]=YYY ...)
area3=([17]=seventeen [24]=twenty-four)
exit 0
Array variables have a syntax all their own, and even standard Bash commands and operators have special options adapted
for array use.
echo ${#array} # 4
# Length of first element of array.
In an array context, some Bash builtins have a slightly altered meaning. For example, unset deletes array elements, or even
an entire array.
#!/bin/bash
declare -a colors
# Permits declaring an array without specifying its size.
echo "Enter your favorite colors (separated from each other by a space)."
echo
element_count=${#colors[@]}
# Special syntax to extract number of elements in array.
# element_count=${#colors[*]} works also.
#
# The "@" variable allows word splitting within quotes
#+ (extracts variables separated by whitespace).
index=0
echo
# Again, list all the elements in the array, but using a more elegant method.
echo ${colors[@]} # echo ${colors[*]} also works.
echo
exit 0
As seen in the previous example, either ${array_name[@]} or ${array_name[*]} refers to all the elements of the array.
Similarly, to get a count of the number of elements in an array, use either ${#array_name[@]} or ${#array_name[*]}.
${#array_name} is the length (number of characters) of ${array_name[0]}, the first element of the array.
#!/bin/bash
# empty-array.sh
echo
echo
The relationship of ${array_name[@]} and ${array_name[*]} is analogous to that between $@ and $*. This powerful
array notation has a number of uses.
# Copying an array.
array2=( "${array1[@]}" )
# or
array2="${array1[@]}"
# Thanks, S.C.
The array=( element1 element2 ... elementN ) initialization operation, with the help of command substitution,
makes it possible to load the contents of a text file into an array.
#!/bin/bash
filename=sample_file
# cat sample_file
#
# 1 a b c
# 2 d e fg
declare -a array1
element_count=${#array1[*]}
echo $element_count # 8
Arrays permit deploying old familiar algorithms as shell scripts. Whether this is necessarily a good idea is left to the reader
to decide.
#!/bin/bash
# bubble.sh: Bubble sort, of sorts.
exchange()
{
# Swaps two members of the array.
return
}
number_of_elements=${#Countries[@]}
let "comparisons = $number_of_elements - 1"
echo
echo "$count: ${Countries[@]}" # Print resultant array at end of each pass.
echo
let "count += 1" # Increment pass count.
exit 0
--
Arrays enable implementing a shell script version of the Sieve of Eratosthenes. Of course, a resource-intensive application
of this nature should really be written in a compiled language, such as C. It runs excruciatingly slowly as a script.
#!/bin/bash
# sieve.sh
# Sieve of Eratosthenes
# Ancient algorithm for finding prime numbers.
PRIME=1
NON_PRIME=0
let SPLIT=UPPER_LIMIT/2
# Optimization:
# Need to test numbers only halfway to upper limit.
declare -a Primes
# Primes[] is an array.
initialize ()
{
# Initialize the array.
i=$LOWER_LIMIT
until [ "$i" -gt "$UPPER_LIMIT" ]
do
Primes[i]=$PRIME
let "i += 1"
done
# Assume all array members guilty (prime)
print_primes ()
{
# Print out the members of the Primes[] array tagged as prime.
i=$LOWER_LIMIT
done
let i=$LOWER_LIMIT+1
# We know 1 is prime, so let's start with 2.
t=$i
fi
initialize
sift
print_primes
# This is what they call structured programming.
echo
exit 0
# ----------------------------------------------- #
# Code below line will not execute.
i=1
until (( ( i += 1 ) > SPLIT )) # Need check only halfway.
do
if [[ -n $Primes[i] ]]
then
t=$i
until (( ( t += i ) > UPPER_LIMIT ))
do
Primes[t]=
done
fi
done
echo ${Primes[*]}
exit 0
Compare this array-based prime number generator with an alternative that does not use arrays, Example A-16.
--
Arrays lend themselves, to some extent, to emulating data structures for which Bash has no native support.
#!/bin/bash
# stack.sh: push-down stack simulation
declare -a stack
return
}
Data=${stack[$SP]}
let "SP += 1" # Bump stack pointer.
return
}
# =======================================================
# Now, for some fun.
echo
echo
push garbage
pop
status_report # Garbage in, garbage out.
pop # FINAL
status_report
pop # skidoo
status_report
pop # 23
status_report # Last-in, first-out!
echo
# =======================================================
# Exercises:
# ---------
exit 0
--
Fancy manipulation of array "subscripts" may require intermediate variables. For projects involving this, again consider
using a more powerful programming language, such as Perl or C.
#!/bin/bash
# Q(1) = Q(2) = 1
# Q(n) = Q(n - Q(n-1)) + Q(n - Q(n-2)), for n>2
echo
echo "Q-series [$LIMIT terms]:"
echo -n "${Q[1]} " # Output first two terms.
echo -n "${Q[2]} "
done
echo
exit 0
--
Bash supports only one-dimensional arrays, however a little trickery permits simulating multi-dimensional ones.
#!/bin/bash
# Simulating a two-dimensional array.
Rows=5
Columns=5
load_alpha ()
{
local rc=0
local index
for i in 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
do
local row=`expr $rc / $Columns`
local column=`expr $rc % $Rows`
let "index = $row * $Rows + $column"
alpha[$index]=$i # alpha[$row][$column]
let "rc += 1"
done
# Simpler would be
# declare -a alpha=( 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 )
# but this somehow lacks the "flavor" of a two-dimensional array.
}
print_alpha ()
{
local row=0
local index
echo
done
echo
}
if [[ "$1" -ge 0 && "$1" -lt "$Rows" && "$2" -ge 0 && "$2" -lt "$Columns" ]]
then
let "index = $1 * $Rows + $2"
# Now, print it rotated.
echo -n " ${alpha[index]}" # alpha[$row][$column]
fi
for (( row = Rows; row > -Rows; row-- )) # Step through the array backwards.
do
if [ "$row" -ge 0 ]
then
let "t1 = $column - $row"
let "t2 = $column"
else
let "t1 = $column"
let "t2 = $column + $row"
fi
done
echo; echo
done
#-----------------------------------------------------#
load_alpha # Load the array.
print_alpha # Print it out.
rotate # Rotate it 45 degrees counterclockwise.
#-----------------------------------------------------#
exit 0
A two-dimensional array is essentially equivalent to a one-dimensional one, but with additional addressing modes for
referencing and manipulating the individual elements by "row" and "column" position.
For an even more elaborate example of simulating a two-dimensional array, see Example A-10.
There are always three default "files" open, stdin (the keyboard), stdout (the screen), and stderr (error messages output
to the screen). These, and any other open files, can be redirected. Redirection simply means capturing output from a file,
command, program, script, or even code block within a script (see Example 4-1 and Example 4-2) and sending it as input to
another file, command, program, or script.
Each open file gets assigned a file descriptor. [1] The file descriptors for stdin, stdout, and stderr are 0, 1, and 2,
respectively. For opening additional files, there remain descriptors 3 to 9. It is sometimes useful to assign one of these
additional file descriptors to stdin, stdout, or stderr as a temporary duplicate link. [2] This simplifies restoration to
normal after complex redirection and reshuffling (see Example 16-1).
COMMAND_OUTPUT >
# Redirect stdout to a file.
# Creates the file if not present, otherwise overwrites it.
: > filename
# The > truncates file "filename" to zero length.
# If file not present, creates zero-length file (same effect as 'touch').
# The : serves as a dummy placeholder, producing no output.
> filename
# The > truncates file "filename" to zero length.
# If file not present, creates zero-length file (same effect as 'touch').
# (Same result as ": >", above, but this does not work with some shells.)
COMMAND_OUTPUT >>
# Redirect stdout to a file.
# Creates the file if not present, otherwise appends to it.
# Single-line redirection commands (affect only the line they are on):
# --------------------------------------------------------------------
1>filename
# Redirect stdout to file "filename".
1>>filename
# Redirect and append stdout to file "filename".
2>filename
# Redirect stderr to file "filename".
2>>filename
# Redirect and append stderr to file "filename".
&>filename
# Redirect both stdout and stderr to file "filename".
#==============================================================================
# Redirecting stdout, one line at a time.
LOGFILE=script.log
2>&1
# Redirects stderr to stdout.
# Error messages get sent to same place as standard output.
i>&j
# Redirects file descriptor i to j.
# All output of file pointed to by i gets sent to file pointed to by j.
>&j
# Redirects, by default, file descriptor 1 (stdout) to j.
# All stdout gets sent to file pointed to by j.
0< FILENAME
< FILENAME
# Accept input from a file.
# Companion command to ">", and often used in combination with it.
#
# grep search-word <filename
[j]<>filename
# Open file "filename" for reading and writing, and assign file descriptor "j"
to it.
# If "filename" does not exist, create it.
# If file descriptor "j" is not specified, default to fd 0, stdin.
#
# An application of this is writing at a specified place in a file.
echo 1234567890 > File # Write string to "File".
exec 3<> File # Open "File" and assign fd 3 to it.
read -n 4 <&3 # Read only 4 characters.
|
# Pipe.
# General purpose process and command chaining tool.
# Similar to ">", but more general in effect.
# Useful for chaining commands, scripts, files, and programs together.
cat *.txt | sort | uniq > result-file
# Sorts the output of all the .txt files and deletes duplicate lines,
# finally saves results to "result-file".
Multiple instances of input and output redirection and/or pipes can be combined in a single command line.
n<&-
Close stdin.
n>&-
Close stdout.
Child processes inherit open file descriptors. This is why pipes work. To prevent an fd from being inherited, close it.
# Thanks, S.C.
Notes
[1] A file descriptor is simply a number that the operating system assigns to an open file to keep track of it. Consider it a
simplified version of a file pointer. It is analogous to a file handle in C.
[2] Using file descriptor 5 might cause problems. When Bash creates a child process, as with exec, the child
inherits fd 5 (see Chet Ramey's archived e-mail, SUBJECT: RE: File descriptor 5 is held open). Best leave this
particular fd alone.
Puccini
var-1=23
# Use 'var_1' instead.
Using the same name for a variable and a function. This can make a script difficult to understand.
do_something ()
{
echo "This function does something with \"$1\"."
}
do_something=do_something
do_something do_something
Using whitespace inappropriately (in contrast to other programming languages, Bash can be quite finicky about
whitespace).
Assuming uninitialized variables (variables before a value is assigned to them) are "zeroed out". An uninitialized
variable has a value of "null", not zero.
Mixing up = and -eq in a test. Remember, = is for comparing literal variables and -eq for integers.
if [ "$a" = 273 ]
then
echo "Comparison works."
else
echo "Comparison does not work."
fi # Comparison does not work.
#!/bin/bash
# bad-op.sh
number=1
Sometimes variables within "test" brackets ([ ]) need to be quoted (double quotes). Failure to do so may cause
unexpected behavior. See Example 7-5, Example 16-4, and Example 9-6.
Commands issued from a script may fail to execute because the script owner lacks execute permission for them. If a
user cannot invoke a command from the command line, then putting it into a script will likewise fail. Try changing
the attributes of the command in question, perhaps even setting the suid bit (as root, of course).
Attempting to use - as a redirection operator (which it is not) will usually result in an unpleasant surprise.
Thanks, S.C.
Using Bash version 2+ functionality may cause a bailout with error messages. Older Linux machines may have
version 1.XX of Bash as the default installation.
#!/bin/bash
minimum_version=2
# Since Chet Ramey is constantly adding features to Bash,
# you may set $minimum_version to 2.XX, or whatever is appropriate.
E_BAD_VERSION=80
...
Using Bash-specific functionality in a Bourne shell script (#!/bin/sh) on a non-Linux machine may cause
unexpected behavior. A Linux system usually aliases sh to bash, but this does not necessarily hold true for a generic
UNIX machine.
A script with DOS-type newlines (\r\n) will fail to execute, since #!/bin/bash\r\n is not recognized, not the
same as the expected #!/bin/bash\n. The fix is to convert the script to UNIX-style newlines.
A shell script headed by #!/bin/sh may not run in full Bash-compatibility mode. Some Bash-specific functions
might be disabled. Scripts that need complete access to all the Bash-specific extensions should start with
#!/bin/bash.
A script may not export variables back to its parent process, the shell, or to the environment. Just as we learned in
biology, a child process can inherit from a parent, but not vice versa.
WHATEVER=/home/bozo
export WHATEVER
exit 0
bash$
Setting and manipulating variables in a subshell, then attempting to use those same variables outside the scope of the
subshell will result an unpleasant surprise.
#!/bin/bash
# Pitfalls of variables in a subshell.
outer_variable=outer
echo
echo "outer_variable = $outer_variable"
echo
(
# Begin subshell
# End subshell
)
echo
echo "inner_variable outside subshell = $inner_variable" # Unset.
echo "outer_variable outside subshell = $outer_variable" # Unchanged.
echo
exit 0
Piping echooutput to a read may produce unexpected results. In this scenario, the read acts as if it were running in a
subshell. Instead, use the set command (as in Example 11-12).
#!/bin/bash
# badread.sh:
# Attempting to use 'echo and 'read'
#+ to assign variables non-interactively.
a=aaa
b=bbb
c=ccc
# ------------------------------
echo "-------"
echo "a = $a" # a = one
echo "b = $b" # b = two
echo "c = $c" # c = three
# Reassignment succeeded.
exit 0
Using "suid" commands within scripts is risky, as it may compromise system security. [1]
Using shell scripts for CGI programming may be problematic. Shell script variables are not "typesafe", and this can
cause undesirable behavior as far as CGI is concerned. Moreover, it is difficult to "cracker-proof" shell scripts.
Bash scripts written for Linux or BSD systems may need fixups to run on a commercial UNIX machine. Such scripts
often employ GNU commands and filters which have greater functionality than their generic UNIX counterparts.
This is particularly true of such text processing utilites as tr.
So beware --
Beware.
Notes
[1] Setting the suid permission on the script itself has no effect.
The set command enables options within a script. At the point in the script where you want
the options to take effect, use set -o option-name or, in short form, set -option-abbrev.
These two forms are equivalent.
#!/bin/bash
set -o verbose
# Echoes all commands before executing.
#!/bin/bash
set -v
# Exact same effect as above.
#!/bin/bash
set -o verbose
# Command echoing on.
command
...
command
set +o verbose
# Command echoing off.
command
# Not echoed.
set -v
# Command echoing on.
command
...
command
set +v
# Command echoing off.
command
exit 0
#!/bin/bash -x
#
# Body of script follows.
It is also possible to enable script options from the command line. Some options that will not
work with set are available this way. Among these are -i, force script to run interactive.
bash -v script-name
The following is a listing of some useful options. They may be specified in either
abbreviated form or by complete name.
variables visible only within a code block or function (see also local variables in functions)
environmental variables
variables that affect the behavior of the shell and user interface
In a more general context, each process has an "environment", that is, a group of variables that hold
information that the process may reference. In this sense, the shell behaves like any other process.
Every time a shell starts, it creates shell variables that correspond to its own environmental
variables. Updating or adding new shell variables causes the shell to update its environment, and all
the shell's child processes (the commands it executes) inherit this environment.
The space allotted to the environment is limited. Creating too many environmental variables or ones
that use up excessive space may cause problems.
bash$ du
bash: /usr/bin/du: Argument list too long
(Thank you, S. C. for the clarification, and for providing the above example.)
If a script sets environmental variables, they need to be "exported", that is, reported to the environment local to the
script. This is the function of the export command.
A script can export variables only to child processes, that is, only to commands or processes which
that particular script initiates. A script invoked from the command line cannot export variables
back to the command line environment. Child processes cannot export variables back to the parent
processes that spawned them.
---
positional parameters
arguments passed to the script from the command line - $0, $1, $2, $3... $0 is the name of the script itself, $1 is
the first argument, $2 the second, $3 the third, and so forth. [1] After $9, the arguments must be enclosed in
brackets, for example, ${10}, ${11}, ${12}.
#!/bin/bash
echo
echo
if [ -n "$2" ]
then
echo "Parameter #2 is $2"
fi
if [ -n "$3" ]
then
echo "Parameter #3 is $3"
fi
# ...
echo
exit 0
Some scripts can perform different operations, depending on which name they are invoked with. For this to work, the
script needs to check $0, the name it was invoked by. There must also exist symbolic links to all the alternate names of
the script.
If a script expects a command line parameter but is invoked without one, this may cause a null
variable assignment, generally an undesirable result. One way to prevent this is to append an extra
character to both sides of the assignment statement using the expected positional parameter.
variable1_=$1_
# This will prevent an error, even if positional parameter is absent.
critical_argument01=$variable1_
# The extra character can be stripped off later, if desired, like so.
variable1=${variable1_/_/} # Side effects only if $variable1_ begins with "_".
# This uses one of the parameter substitution templates discussed in Chapter 9.
# Leaving out the replacement pattern results in a deletion.
---
#!/bin/bash
if [ -z "$1" ]
then
echo "Usage: `basename $0` [domain-name]"
exit 65
fi
exit 0
---
The shift command reassigns the positional parameters, in effect shifting them to the left one notch.
The old $1 disappears, but $0 (the script name) does not change. If you use a large number of positional parameters to
a script, shift lets you access those past 10, although {bracket} notation also permits this.
#!/bin/bash
# Using 'shift' to step through all the positional parameters.
exit 0
The shift command also works on parameters passed to a function. See Example 34-6.
Notes
[1] The process calling the script sets the $0 parameter. By convention, this parameter is the name of the script. See
the manpage for execv.
jot, seq
The normal separator character between each integer is a newline, but this can be changed with the -s option.
bash$ seq 5
1
2
3
4
5
bash$ seq -s : 5
1:2:3:4:5
#!/bin/bash
echo; echo
echo
exit 0
getopt
The getopt command parses command-line options preceded by a dash. This external command corresponds to the getopts
Bash builtin, but it is not nearly as flexible.
#!/bin/bash
E_OPTERR=65
if [ "$#" -eq 0 ]
then # Script needs at least one command-line argument.
echo "Usage $0 -[options a,b,c]"
exit $E_OPTERR
fi
while [ ! -z "$1" ]
do
case "$1" in
-a) echo "Option \"a\"";;
-b) echo "Option \"b\"";;
-c) echo "Option \"c\"";;
-d) echo "Option \"d\" $2";;
*) break;;
esac
shift
done
exit 0
run-parts
The run-parts command [1] executes all the scripts in a target directory, sequentially in ASCII-sorted filename order. Of
course, the scripts need to have execute permission.
The crond daemon invokes run-parts to run the scripts in the /etc/cron.* directories.
yes
In its default behavior the yes command feeds a continuous string of the character y followed by a line feed to stdout. A
control-c terminates the run. A different output string may be specified, as in yes different string, which would
continually output different string to stdout. One might well ask the purpose of this. From the command line or
in a script, the output of yes can be redirected or piped into a program expecting user input. In effect, this becomes a sort of
poor man's version of expect.
Be very cautious when piping yes to a potentially dangerous system command, such as fsck or fdisk.
banner
Prints arguments as a large vertical banner to stdout, using an ASCII character (default '#'). This may be redirected to a
printer for hardcopy.
printenv
lp
The lp and lpr commands send file(s) to the print queue, to be printed as hard copy. [2] These commands trace the origin of
their names to the line printers of another era.
Formatting packages, such as groff and Ghostscript may send their output directly to lp.
Related commands are lpq, for viewing the print queue, and lprm, for removing jobs from the print queue.
tee
This is a redirection operator, but with a difference. Like the plumber's tee, it permits "siponing off" the output of a
command or commands within a pipe, but without affecting the result. This is useful for printing an ongoing process to a
file or paper, perhaps to keep track of it for debugging purposes.
tee
|------> to file
|
===============|===============
command--->----|-operator-->---> result of command(s)
===============================
(The file check.file contains the concatenated sorted "listfiles", before the duplicate lines are removed by uniq.)
mkfifo
This obscure command creates a named pipe, a temporary first-in-first-out buffer for transferring data between processes.
[3] Typically, one process writes to the FIFO, and the other reads from it. See Example A-15.
pathchk
This command checks the validity of a filename. If the filename exceeds the maximum allowable length (255 characters) or
one or more of the directories in its path is not searchable, then an error message results. Unfortunately, pathchk does not
return a recognizable error code, and it is therefore pretty much useless in a script.
dd
This is the somewhat obscure and much feared "data duplicator" command. Originally a utility for exchanging data on
magnetic tapes between UNIX minicomputers and IBM mainframes, this command still has its uses. The dd command
simply copies a file (or stdin/stdout), but with conversions. Possible conversions are ASCII/EBCDIC, [4]
upper/lower case, swapping of byte pairs between input and output, and skipping and/or truncating the head or tail of the
input file. A dd --help lists the conversion and other options that this powerful utility takes.
# Exercising 'dd'.
n=3
p=5
input_file=project.txt
output_file=log.txt
# Thanks, S.C.
#!/bin/bash
# Capture keystrokes without needing to press ENTER.
# Thanks, S.C.
The dd command can copy raw data and disk images to and from devices, such as floppies and tape drives (Example A-6). A
common use is creating boot floppies.
dd if=kernel-image of=/dev/fd0H1440
Similarly, dd can copy the entire contents of a floppy, even one formatted with a "foreign" OS, to the hard drive as an image file.
dd if=/dev/fd0 of=/home/bozo/projects/floppy.img
Other applications of dd include initializing temporary swap files (Example 29-2) and ramdisks (Example 29-3). It can even do a
low-level copy of an entire hard drive partition, although this is not necessarily recommended.
People (with presumably nothing better to do with their time) are constantly thinking of interesting applications of dd.
#!/bin/bash
# blotout.sh: Erase all traces of a file.
file=$1
if [ ! -e "$file" ]
then
echo "File \"$file\" not found."
exit $E_NOT_FOUND
fi
echo; echo -n "Are you absolutely sure you want to blot out \"$file\" (y/n)? "
read answer
case "$answer" in
[nN]) echo "Changed your mind, huh?"
exit $E_CHANGED_MIND
;;
*) echo "Blotting out file \"$file\".";;
esac
pass_count=1
echo
# Tom Vier's "wipe" file-deletion package does a much more thorough job
#+ of file shredding than this simple script.
# http://www.ibiblio.org/pub/Linux/utils/file/wipe-2.0.0.tar.bz2
exit 0
od
The od, or octal dump filter converts input (or files) to octal (base-8) or other bases. This is useful for viewing or
processing binary data files or otherwise unreadable system device files, such as /dev/urandom, and as a filter for
binary data. See Example 9-23 and Example 12-10.
hexdump
Performs a hexadecimal, octal, decimal, or ASCII dump of a binary file. This command is the rough equivalent of od,
above, but not nearly as useful.
mcookie
This command generates a "magic cookie", a 128-bit (32-character) pseudorandom hexadecimal number, normally used as
an authorization "signature" by the X server. This also available for use in a script as a "quick 'n dirty" random number.
m4
A hidden treasure, m4 is a powerful macro processing filter, [5] virtually a complete language. Although originally written
as a pre-processor for RatFor, m4 turned out to be useful as a stand-alone utility. In fact, m4 combines some of the
functionality of eval, tr, and awk, in addition to its extensive macro expansion facilities.
The April, 2002 issue of Linux Journal has a very nice article on m4 and its uses.
#!/bin/bash
# m4.sh: Using the m4 macro processor
# Strings
string=abcdA01
echo "len($string)" | m4 # 7
echo "substr($string,4)" | m4 # A01
echo "regexp($string,[0-1][0-1],\&Z)" | m4 # 01Z
# Arithmetic
echo "incr(22)" | m4 # 23
echo "eval(99 / 3)" | m4 # 33
exit 0
Notes
[1] This is actually a script adapted from the Debian Linux distribution.
[2] The print queue is the group of jobs "waiting in line" to be printed.
[3] For an excellent overview of this topic, see Andy Vaught's article, Introduction to Named Pipes, in the September, 1997
issue of Linux Journal.
[4] EBCDIC (pronounced "ebb-sid-ic") is an acronym for Extended Binary Coded Decimal Interchange Code. This is an IBM
data format no longer in much use. A bizarre application of the conv=ebcdic option of dd is as a quick 'n easy, but not
very secure text file encoder.
[5] A macro is a symbolic constant that expands into a command string or a set of operations on parameters.
These files contain the aliases and environmental variables made available to Bash
running as a user shell and to all Bash scripts invoked after system initialization.
/etc/profile
systemwide defaults, mostly setting the environment (all Bourne-type shells, not just
Bash [1])
/etc/bashrc
user-specific Bash init file, found in each user's home directory (the local counterpart
to /etc/bashrc). Only interactive shells and user scripts read this file. See
Appendix G for a sample .bashrc file.
logout file
$HOME/.bash_logout
user-specific instruction file, found in each user's home directory. Upon exit from a
login (Bash) shell, the commands in this file execute.
Notes
[1] This does not apply to csh, tcsh, and other shells not related to or descended from the
classic Bourne shell (sh).
B.2. Awk
Awk is a full-featured text processing language with a syntax reminiscent of C. While it
possesses an extensive set of operators and capabilities, we will cover only a couple of these
here - the ones most useful for shell scripting.
Awk breaks each line of input passed to it into fields. By default, a field is a string of
consecutive characters separated by whitespace, though there are options for changing the
delimiter. Awk parses and operates on each separate field. This makes awk ideal for
handling structured text files, especially tables, data organized into consistent chunks, such
as rows and columns.
Strong quoting (single quotes) and curly brackets enclose segments of awk code within a
shell script.
We have just seen the awk print command in action. The only other feature of awk we need
to deal with here is variables. Awk handles variables similarly to shell scripts, though a bit
more flexibly.
{ total += ${column_number} }
This adds the value of column_number to the running total of "total". Finally, to print
"total", there is an END command block, executed after the script has processed all its input.
END { print total }
Corresponding to the END, there is a BEGIN, for a code block to be performed before awk
starts processing its input.
1. Example 11-9
2. Example 16-7
3. Example 12-24
4. Example 34-3
5. Example 9-20
6. Example 11-14
7. Example 28-1
8. Example 28-2
9. Example 10-3
10. Example 12-41
11. Example 9-23
12. Example 12-3
13. Example 9-11
14. Example 34-7
15. Example 10-8
That's all the awk we'll cover here, folks, but there's lots more to learn. See the appropriate
references in the Bibliography.
declare/typeset options
-r readonly
declare -r var1
This is the rough equivalent of the C const type qualifier. An attempt to change the value of a readonly variable fails with an
error message.
-i integer
declare -i number
# The script will treat subsequent occurrences of "number" as an integer.
number=3
echo "number = $number" # number = 3
number=three
echo "number = $number" # number = 0
# Tries to evaluate "three" as an integer.
Note that certain arithmetic operations are permitted for declared integer variables without the need for expr or let.
-a array
declare -a indices
declare -f
A declare -f line with no arguments in a script causes a listing of all the functions previously defined in that script.
declare -f function_name
declare -x var3
This declares a variable as available for exporting outside the environment of the script itself.
var=$value
declare -x var3=373
The declare command permits assigning a value to a variable in the same statement as setting its properties.
#!/bin/bash
func1 ()
{
echo This is a function.
}
echo
echo
Chet Ramey
The exit command may be used to terminate a script, just as in a C program. It can also return a value, which is
available to the script's parent process.
Every command returns an exit status (sometimes referred to as a return status ). A successful command returns a 0,
while an unsuccessful one returns a non-zero value that usually may be interpreted as an error code. Well-behaved
UNIX commands, programs, and utilities return a 0 exit code upon successful completion, though there are some
exceptions.
Likewise, functions within a script and the script itself return an exit status. The last command executed in the
function or script determines the exit status. Within a script, an exit nnn command may be used to deliver an
nnn exit status to the shell (nnn must be a decimal number in the 0 - 255 range).
When a script ends with an exit that has no parameter, the exit status of the script is the exit status of the last
command executed in the script (not counting the exit).
$? reads the exit status of the last command executed. After a function returns, $? gives the exit status of the last
command executed in the function. This is Bash's way of giving functions a "return value". After a script terminates,
a $? from the command line gives the exit status of the script, that is, the last command executed in the script,
which is, by convention, 0 on success or an integer in the range 1 - 255 on error.
#!/bin/bash
echo hello
echo $? # Exit status 0 returned because command executed successfully.
echo
$? is especially useful for testing the result of a command in a script (see Example 12-27 and Example 12-13).
The !, the logical "not" qualifier, reverses the outcome of a test or command, and this affects its exit status.
! true
echo "exit status of \"! true\" = $?" # 1
# Note that the "!" needs a space.
# !true leads to a "command not found" error
# Thanks, S.C.
Certain exit status codes have reserved meanings and should not be user-specified in a script.
#!/bin/bash
# Redirecting stdin using 'exec'.
echo
echo "Following lines read from file."
echo "-------------------------------"
echo $a1
echo $a2
echo
exit 0
Similarly, an exec >filename command redirects stdout to a designated file. This sends all command
output that would normally go to stdout to that file.
#!/bin/bash
# reassign-stdout.sh
LOGFILE=logfile.txt
# ----------------------------------------------------------- #
# All output from commands in this block sent to file $LOGFILE.
# ----------------------------------------------------------- #
exec 1>&6 6>&- # Restore stdout and close file descriptor #6.
echo
echo "== stdout now restored to default == "
echo
ls -al
echo
exit 0
Example 16-3. Redirecting both stdin and stdout in the same script with exec
#!/bin/bash
# upperconv.sh
# Converts a specified input file to uppercase.
E_FILE_ACCESS=70
E_WRONG_ARGS=71
if [ -z "$2" ]
then
echo "Need to specify output file."
echo "Usage: $0 input-file output-file"
exit $E_WRONG_ARGS
fi
exec 4<&0
exec < $1 # Will read from input file.
exec 7>&1
exec > $2 # Will write to output file.
# Assumes output file writable (add check?).
# -----------------------------------------------
cat - | tr a-z A-Z # Uppercase conversion.
# ^^^^^ # Reads from stdin.
# ^^^^^^^^^^ # Writes to stdout.
# However, both stdin and stdout were redirected.
# -----------------------------------------------
exit 0
In a script, aliases have very limited usefulness. It would be quite nice if aliases could assume some of the functionality of the C
preprocessor, such as macro expansion, but unfortunately Bash does not expand arguments within the alias body. [1] Moreover,
a script fails to expand an alias itself within "compound constructs", such as if/then statements, loops, and functions. An added
limitation is that an alias will not expand recursively. Almost invariably, whatever we would like an alias to do could be
accomplished much more effectively with a function.
#!/bin/bash
# Invoke with command line parameter to exercise last section of this script.
shopt -s expand_aliases
# Must set this option, else script will not expand aliases.
echo
directory=/usr/X11R6/bin/
prefix=mk* # See if wild-card causes problems.
echo "Variables \"directory\" + \"prefix\" = $directory$prefix"
echo
TRUE=1
echo
if [ TRUE ]
then
alias rr="ls -l"
echo "Trying aliased \"rr\" within if/then statement:"
rr /usr/X11R6/bin/mk* #* Error message results!
# Aliases not expanded within compound statements.
echo "However, previously expanded alias still recognized:"
ll /usr/X11R6/bin/mk*
fi
echo
count=0
while [ $count -lt 3 ]
do
alias rrr="ls -l"
echo "Trying aliased \"rrr\" within \"while\" loop:"
rrr /usr/X11R6/bin/mk* #* Alias will not expand here either.
let count+=1
done
echo; echo
exit 0
#!/bin/bash
echo
exit 0
bash$ ./unalias.sh
total 6
drwxrwxr-x 2 bozo bozo 3072 Feb 6 14:04 .
drwxr-xr-x 40 bozo bozo 2048 Feb 6 14:04 ..
-rwxr-xr-x 1 bozo bozo 199 Feb 6 14:04 unalias.sh
Notes
This update of the classic Bash scripting language added array variables, [1] string and parameter expansion, and a better
method of indirect variable references, among other features.
#!/bin/bash
# String expansion.
# Introduced with version 2 of Bash.
exit 0
#!/bin/bash
a=letter_of_alphabet
letter_of_alphabet=z
echo
t=table_cell_3
table_cell_3=24
exit 0
#!/bin/bash
# resistor-inventory.sh
# Simple database application using indirect variable referencing.
# ============================================================== #
# Data
B1723_value=470 # ohms
B1723_powerdissip=.25 # watts
B1723_colorcode="yellow-violet-brown" # color bands
B1723_loc=173 # where they are
B1723_inventory=78 # how many
B1724_value=1000
B1724_powerdissip=.25
B1724_colorcode="brown-black-red"
B1724_loc=24N
B1724_inventory=243
B1725_value=10000
B1725_powerdissip=.25
B1725_colorcode="brown-black-orange"
B1725_loc=24N
B1725_inventory=89
# ============================================================== #
echo
echo
echo
echo "Catalog number $catalog_number:"
echo "There are ${!Inv} of [${!Val} ohm / ${!Pdissip} watt] resistors in stock."
echo "These are located in bin # ${!Loc}."
echo "Their color code is \"${!Ccode}\"."
break
done
echo; echo
# Exercise:
# --------
# Rewrite this script using arrays, rather than indirect variable referencing.
# Which method is more straightforward and intuitive?
# Notes:
# -----
# Shell scripts are inappropriate for anything except the most simple
#+ database applications, and even then it involves workarounds and kludges.
# Much better is to use a language with native support for data structures,
#+ such as C++ or Java (or even Perl).
exit 0
Example 35-4. Using arrays and other miscellaneous trickery to deal four random hands from a deck of cards
#!/bin/bash
# May need to be invoked with #!/bin/bash2 on older machines.
# Cards:
# deals four random hands from a deck of cards.
UNPICKED=0
PICKED=1
DUPE_CARD=99
LOWER_LIMIT=0
UPPER_LIMIT=51
CARDS_IN_SUIT=13
CARDS=52
declare -a Deck
declare -a Suits
declare -a Cards
# It would have been easier and more intuitive
# with a single, 3-dimensional array.
# Perhaps a future version of Bash will support multidimensional arrays.
initialize_Deck ()
{
i=$LOWER_LIMIT
until [ "$i" -gt $UPPER_LIMIT ]
do
Deck[i]=$UNPICKED # Set each card of "Deck" as unpicked.
let "i += 1"
done
echo
}
initialize_Suits ()
{
Suits[0]=C #Clubs
Suits[1]=D #Diamonds
Suits[2]=H #Hearts
Suits[3]=S #Spades
}
initialize_Cards ()
{
Cards=(2 3 4 5 6 7 8 9 10 J Q K A)
# Alternate method of initializing an array.
}
pick_a_card ()
{
card_number=$RANDOM
let "card_number %= $CARDS"
if [ "${Deck[card_number]}" -eq $UNPICKED ]
then
Deck[card_number]=$PICKED
return $card_number
else
return $DUPE_CARD
fi
}
parse_card ()
{
number=$1
let "suit_number = number / CARDS_IN_SUIT"
suit=${Suits[suit_number]}
echo -n "$suit-"
let "card_no = number % CARDS_IN_SUIT"
Card=${Cards[card_no]}
printf %-4s $Card
# Print cards in neat columns.
}
deal_cards ()
{
echo
cards_picked=0
while [ "$cards_picked" -le $UPPER_LIMIT ]
do
pick_a_card
t=$?
u=$cards_picked+1
# Change back to 1-based indexing (temporarily).
let "u %= $CARDS_IN_SUIT"
if [ "$u" -eq 0 ] # Nested if/then condition test.
then
echo
echo
fi
# Separate hands.
echo
return 0
}
# Structured programming:
# entire program logic modularized in functions.
#================
seed_random
initialize_Deck
initialize_Suits
initialize_Cards
deal_cards
exit 0
#================
# Exercise 1:
# Add comments to thoroughly document this script.
# Exercise 2:
# Revise the script to print out each hand sorted in suits.
# You may add other bells and whistles if you like.
# Exercise 3:
# Simplify and streamline the logic of the script.
Notes
[1] Chet Ramey promises associative arrays (a Perl feature) in a future Bash release.
19.2. Globbing
Bash itself cannot recognize Regular Expressions. In scripts, commands and utilities, such as sed and awk, interpret RE's.
Bash does carry out filename expansion, a process known as "globbing", but this does not use the standard RE set. Instead,
globbing recognizes and expands wildcards. Globbing interprets the standard wildcard characters, * and ?, character lists in square
brackets, and certain other special characters (such as ^ for negating the sense of a match). There are some important limitations on
wildcard characters in globbing, however. Strings containing * will not match filenames that start with a dot, as, for example,
.bashrc. [1] Likewise, the ? has a different meaning in globbing than as part of an RE.
bash$ ls -l
total 2
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 a.1
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 b.1
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 c.1
-rw-rw-r-- 1 bozo bozo 466 Aug 6 17:48 t2.sh
-rw-rw-r-- 1 bozo bozo 758 Jul 30 09:02 test1.txt
bash$ ls -l t?.sh
-rw-rw-r-- 1 bozo bozo 466 Aug 6 17:48 t2.sh
bash$ ls -l [ab]*
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 a.1
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 b.1
bash$ ls -l [a-c]*
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 a.1
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 b.1
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 c.1
bash$ ls -l [^ab]*
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 c.1
-rw-rw-r-- 1 bozo bozo 466 Aug 6 17:48 t2.sh
-rw-rw-r-- 1 bozo bozo 758 Jul 30 09:02 test1.txt
bash$ ls -l {b*,c*,*est*}
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 b.1
-rw-rw-r-- 1 bozo bozo 0 Aug 6 18:42 c.1
-rw-rw-r-- 1 bozo bozo 758 Jul 30 09:02 test1.txt
bash$ echo *
a.1 b.1 c.1 t2.sh test1.txt
bash$ echo t*
t2.sh test1.txt
Notes
[1] Filename expansion can match dotfiles, but only if the pattern explicitly includes the dot.
# Thanks, S.C.
The main uses for Regular Expressions (REs) are text searches and string manipulation. An RE matches a
single character or a set of characters (a substring or an entire string).
● The asterisk -- * -- matches any number of repeats of the character string or RE preceding it,
including zero.
"[^b-d]" matches all characters except those in the range b to d. This is an instance of ^ negating
or inverting the meaning of the following RE (taking on a role similar to ! in a different context).
A "\$" reverts back to its literal meaning of "$", rather than its RE meaning of end-of-line.
Likewise a "\\" has the literal meaning of "\".
●
The angle brackets must be escaped, since otherwise they have only their literal character meaning.
"\<the\>" matches the word "the", but not the words "them", "there", "other", etc.
The question mark -- ? -- matches zero or one of the previous RE. It is generally used for matching
single characters.
●
The plus -- + -- matches one or more of the previous RE. It serves a role similar to the *, but does
not match zero occurrences.
# Thanks, S.C.
It is necessary to escape the curly brackets since they have only their literal character meaning
otherwise. This usage is technically not part of the basic RE set.
● Parentheses -- ( ) -- enclose groups of REs. They are useful with the following "|" operator and in
substring extraction using expr.
● The -- | -- "or" RE operator matches any of a set of alternate characters.
POSIX character classes generally require quoting or double brackets ([[ ]]).
These character classes may even be used with globbing, to a limited extent.
bash$ ls -l ?[[:digit:]][[:digit:]]?
-rw-rw-r-- 1 bozo bozo 0 Aug 21 14:47 a33b
To see POSIX character classes used in scripts, refer to Example 12-14 and
Example 12-15.
Sed, awk, and Perl, used as filters in scripts, take REs as arguments when "sifting" or transforming files or
I/O streams. See Example A-12 and Example A-17 for illustrations of this.
"Sed & Awk", by Dougherty and Robbins gives a very complete and lucid treatment of REs (see the
Bibliography).
Notes
[1] The simplest type of Regular Expression is a character string that retains its literal meaning, not
containing any metacharacters.
[2] Since sed, awk, and grep process single lines, there will usually not be a newline to match. In those
cases where there is a newline in a multiple line expression, the dot will match the newline.
#!/bin/bash
echo
# Thanks, S.C.
exit 0
A shell script can also launch subprocesses. These subshells let the script do parallel processing, in effect executing
multiple subtasks simultaneously.
Variables in a subshell are not visible outside the block of code in the subshell. They are not accessible to the
parent process, to the shell that launched the subshell. These are, in effect, local variables.
#!/bin/bash
# subshell.sh
echo
outer_variable=Outer
(
inner_variable=Inner
echo "From subshell, \"inner_variable\" = $inner_variable"
echo "From subshell, \"outer\" = $outer_variable"
)
echo
if [ -z "$inner_variable" ]
then
echo "inner_variable undefined in main body of shell"
else
echo "inner_variable defined in main body of shell"
fi
echo
exit 0
Directory changes made in a subshell do not carry over to the parent shell.
#!/bin/bash
# allprofs.sh: print all user profiles
# This script written by Heiner Steven, and modified by the document author.
exit 0
COMMAND1
COMMAND2
COMMAND3
(
IFS=:
PATH=/bin
unset TERMINFO
set -C
shift 5
COMMAND4
COMMAND5
exit 3 # Only exits the subshell.
)
# The parent shell has not been affected, and the environment is preserved.
COMMAND6
COMMAND7
# Thanks, S.C.
Processes may execute in parallel within different subshells. This permits breaking a complex task into subcomponents
processed concurrently.
Redirecting I/O to a subshell uses the "|" pipe operator, as in ls -al | (command).
This is a very brief introduction to the sed and awk text processing utilities. We will deal
with only a few basic commands here, but that will suffice for understanding simple sed and
awk constructs within shell scripts.
For all their differences, the two utilities share a similar invocation syntax, both use regular
expressions , both read input by default from stdin, and both output to stdout. These
are well-behaved UNIX tools, and they work together well. The output from one can be
piped into the other, and their combined capabilities give shell scripts some of the power of
Perl.
One important difference between the utilities is that while shell scripts can easily
pass arguments to sed, it is more complicated for awk (see Example 34-3 and
Example 9-20).
To fully utilize the power of shell scripting, you need to master Regular Expressions.
Certain commands and utilities commonly used in scripts, such as expr, sed and awk
interpret and use REs.
Part 1. Introduction
The shell is a command interpreter. More than just the insulating layer between the
operating system kernel and the user, it's also a fairly powerful programming language. A
shell program, called a script, is an easy-to-use tool for building applications by "gluing"
together system calls, tools, utilities, and compiled binaries. Virtually the entire repertoire of
UNIX commands, utilities, and tools is available for invocation by a shell script. If that were
not enough, internal shell commands, such as testing and loop constructs, give additional
power and flexibility to scripts. Shell scripts lend themselves exceptionally well to
administrative system tasks and other routine repetitive jobs not requiring the bells and
whistles of a full-blown tightly structured programming language.
Table of Contents
1. Why Shell Programming?
2. Starting Off With a Sha-Bang
2.1. Invoking the script
2.2. Preliminary Exercises
Writing shell scripts is not hard to learn, since the scripts can be built in bite-sized sections
and there is only a fairly small set of shell-specific operators and options [1] to learn. The
syntax is simple and straightforward, similar to that of invoking and chaining together
utilities at the command line, and there are only a few "rules" to learn. Most short scripts
work right the first time, and debugging even the longer ones is straightforward.
A shell script is a "quick and dirty" method of prototyping a complex application. Getting
even a limited subset of the functionality to work in a shell script, even if slowly, is often a
useful first stage in project development. This way, the structure of the application can be
tested and played with, and the major pitfalls found before proceeding to the final coding in
C, C++, Java, or Perl.
Shell scripting hearkens back to the classical UNIX philosophy of breaking complex
projects into simpler subtasks, of chaining together components and utilities. Many consider
this a better, or at least more esthetically pleasing approach to problem solving than using
one of the new generation of high powered all-in-one languages, such as Perl, which attempt
to be all things to all people, but at the cost of forcing you to alter your thinking processes to
fit the tool.
If any of the above applies, consider a more powerful scripting language, perhaps Perl, Tcl,
Python, or possibly a high-level compiled language such as C, C++, or Java. Even then,
prototyping the application as a shell script might still be a useful development step.
We will be using Bash, an acronym for "Bourne-Again Shell" and a pun on Stephen
Bourne's now classic Bourne Shell. Bash has become a de facto standard for shell scripting
on all flavors of UNIX. Most of the principles dealt with in this book apply equally well to
scripting with other shells, such as the Korn Shell, from which Bash derives some of its
features, [2] and the C Shell and its variants. (Note that C Shell programming is not
recommended due to certain inherent problems, as pointed out in a news group posting by
Tom Christiansen in October of 1993).
Unless otherwise noted, the book author wrote the example scripts that follow.
Notes
In the simplest case, a script is nothing more than a list of system commands stored in a file. At the very least, this saves the effort
of retyping that particular sequence of commands each time it is invoked.
# cleanup
# Run as root, of course.
cd /var/log
cat /dev/null > messages
cat /dev/null > wtmp
echo "Logs cleaned up."
There is nothing unusual here, just a set of commands that could just as easily be invoked one by one from the command line on
the console or in an xterm. The advantages of placing the commands in a script go beyond not having to retype them time and
again. The script can easily be modified, customized, or generalized for a particular application.
#!/bin/bash
# cleanup, version 2
# Run as root, of course.
LOG_DIR=/var/log
ROOT_UID=0 # Only users with $UID 0 have root privileges.
LINES=50 # Default number of lines saved.
E_XCD=66 # Can't change directory?
E_NOTROOT=67 # Non-root exit error.
if [ -n "$1" ]
# Test if command line argument present (non-empty).
then
lines=$1
else
lines=$LINES # Default, if not specified on command line.
fi
cd $LOG_DIR
tail -$lines messages > mesg.temp # Saves last section of message log file.
mv mesg.temp messages # Becomes new log directory.
cat /dev/null > wtmp # ': > wtmp' and '> wtmp' have the same effect.
echo "Logs cleaned up."
exit 0
# A zero return value from the script upon exit
#+ indicates success to the shell.
Since you may not wish to wipe out the entire system log, this variant of the first script keeps the last section of the message log
intact. You will constantly discover ways of refining previously written scripts for increased effectiveness.
The sha-bang ( #!) at the head of a script tells your system that this file is a set of commands to be fed to the command interpreter
indicated. The #! is actually a two-byte [1] "magic number", a special marker that designates a file type, or in this case an
executable shell script (see man magic for more details on this fascinating topic). Immediately following the sha-bang is a path
name. This is the path to the program that interprets the commands in the script, whether it be a shell, a programming language, or
a utility. This command interpreter then executes the commands in the script, starting at the top (line 1 of the script), ignoring
comments. [2]
#!/bin/sh
#!/bin/bash
#!/usr/bin/perl
#!/usr/bin/tcl
#!/bin/sed -f
#!/usr/awk -f
Each of the above script header lines calls a different command interpreter, be it /bin/sh, the default shell (bash in a Linux
system) or otherwise. [3] Using #!/bin/sh, the default Bourne Shell in most commercial variants of UNIX, makes the script
portable to non-Linux machines, though you may have to sacrifice a few Bash-specific features (the script will conform to the
POSIX [4] sh standard).
Note that the path given at the "sha-bang" must be correct, otherwise an error message, usually "Command not found" will be the
only result of running the script.
#! can be omitted if the script consists only of a set of generic system commands, using no internal shell directives. Example 2,
above, requires the initial #!, since the variable assignment line, lines=50, uses a shell-specific construct. Note that
#!/bin/sh invokes the default shell interpreter, which defaults to /bin/bash on a Linux machine.
This tutorial encourages a modular approach to constructing a script. Make note of and collect "boilerplate" code snippets
that might be useful in future scripts. Eventually you can build a quite extensive library of nifty routines. As an example,
the following script prolog tests whether the script has been invoked with the correct number of parameters.
Notes
[1] Some flavors of UNIX (those based on 4.2BSD) take a four-byte magic number, requiring a blank after the !, #! /bin/sh.
[2] The #! line in a shell script will be the first thing the command interpreter (sh or bash) sees. Since this line begins with a #, it
will be correctly interpreted as a comment when the command interpreter finally executes the script. The line has already
served its purpose - calling the command interpreter.
[3] This allows some cute tricks.
#!/bin/rm
# Self-deleting script.
# Nothing much seems to happen when you run this... except that the file disappears.
WHATEVER=65
exit $WHATEVER # Doesn't matter. The script will not exit here.
Also, try starting a README file with a #!/bin/more, and making it executable. The result is a self-listing documentation
file.
[4] Portable Operating System Interface, an attempt to standardize UNIX-like OSes.
Part 2. Basics
Table of Contents
3. Exit and Exit Status
4. Special Characters
5. Introduction to Variables and Parameters
5.1. Variable Substitution
5.2. Variable Assignment
5.3. Bash Variables Are Untyped
5.4. Special Variable Types
6. Quoting
7. Tests
7.1. Test Constructs
7.2. File test operators
7.3. Comparison operators (binary)
7.4. Nested if/then Condition Tests
7.5. Testing Your Knowledge of Tests
8. Operations and Related Topics
8.1. Operators
8.2. Numerical Constants
Variables are at the heart of every programming and scripting language. They appear in
arithmetic operations and manipulation of quantities, string parsing, and are indispensable
for working in the abstract with symbols - tokens that represent something else. A variable
is nothing more than a location or set of locations in computer memory holding an item of
data.
Chapter 7. Tests
Table of Contents
7.1. Test Constructs
7.2. File test operators
7.3. Comparison operators (binary)
7.4. Nested if/then Condition Tests
7.5. Testing Your Knowledge of Tests
Every reasonably complete programming language can test for a condition, then act
according to the result of the test. Bash has the test command, various bracket and
parenthesis operators, and the if/then construct.
Used properly, variables can add power and flexibility to scripts. This requires learning their
subtleties and nuances.
chown, chgrp
The chown command changes the ownership of a file or files. This command is a useful method that root can use to shift file
ownership from one user to another. An ordinary user may not change the ownership of files, not even her own files. [1]
The chgrp command changes the group ownership of a file or files. You must be owner of the file(s) as well as a member of
the destination group (or root) to use this operation.
useradd, userdel
The useradd administrative command adds a user account to the system and creates a home directory for that particular user, if
so specified. The corresponding userdel command removes a user account from the system [2] and deletes associated files.
The adduser command is a synonym for useradd and is usually a symbolic link to it.
id
The id command lists the real and effective user IDs and the group IDs of the current user. This is the counterpart to the $UID,
$EUID, and $GROUPS internal Bash variables.
bash$ id
uid=501(bozo) gid=501(bozo) groups=501(bozo),22(cdrom),80(cdwriter),81(audio)
bash$ who
bozo tty1 Apr 27 17:45
bozo pts/0 Apr 27 17:46
bozo pts/1 Apr 27 17:47
bozo pts/2 Apr 27 17:49
The -m gives detailed information about only the current user. Passing any two arguments to who is the equivalent of who -m,
as in who am i or who The Man.
bash$ who -m
localhost.localdomain!bozo pts/2 Apr 27 17:49
whoami is similar to who -m, but only lists the user name.
bash$ whoami
bozo
Show all logged on users and the processes belonging to them. This is an extended version of who. The output of w may be
piped to grep to find a specific user and/or process.
logname
Show current user's login name (as found in /var/run/utmp). This is a near-equivalent to whoami, above.
bash$ logname
bozo
bash$ whoami
bozo
However...
bash$ su
Password: ......
bash# whoami
root
bash# logname
bozo
su
Runs a program or script as a substitute user. su rjones starts a shell as user rjones. A naked su defaults to root. See Example
A-15.
sudo
Runs a command as root (or another user). This may be used in a script, thus permitting a regular user to run the script.
#!/bin/bash
# Some commands.
sudo cp /root/secretfile /home/bozo/secret
# Some more commands.
The file /etc/sudoers holds the names of users permitted to invoke sudo.
users
Show all logged on users. This is the approximate equivalent of who -q.
ac
Show users' logged in time, as read from /var/log/wtmp. This is one of the GNU accounting utilities.
bash$ ac
total 68.08
last
List last logged in users, as read from /var/log/wtmp. This command can also show remote logins.
groups
Lists the current user and the groups she belongs to. This corresponds to the $GROUPS internal variable, but gives the group
names, rather than the numbers.
bash$ groups
bozita cdrom cdwriter audio xgrp
newgrp
Change user's group ID without logging out. This permits access to the new group's files. Since users may be members of
multiple groups simultaneously, this command finds little use.
Terminals
tty
Echoes the name of the current user's terminal. Note that each separate xterm window counts as a different terminal.
bash$ tty
/dev/pts/1
stty
Shows and/or changes terminal settings. This complex command, used in a script, can control terminal behavior and the way
output displays. See the info page, and study it carefully.
#!/bin/bash
# erase.sh: Using "stty" to set an erase character when reading input.
exit 0
#!/bin/bash
echo
echo -n "Enter password "
read passwd
echo "password is $passwd"
echo -n "If someone had been looking over your shoulder, "
echo "your password would have been compromised."
exit 0
#!/bin/bash
# keypress.sh: Detect a user keypress ("hot keyboard").
echo
echo
echo "Key pressed was \""$Keypress"\"."
echo
exit 0
Normally, a terminal works in the canonical mode. When a user hits a key, the resulting character does not immediately go to the
program actually running in this terminal. A buffer local to the terminal stores keystrokes. When the user hits the ENTER key, this
sends all the stored keystrokes to the program running. There is even a basic line editor inside the terminal.
bash$ stty -a
speed 9600 baud; rows 36; columns 96; line = 0;
intr = ^C; quit = ^\; erase = ^H; kill = ^U; eof = ^D; eol = <undef>; eol2 =
<undef>;
start = ^Q; stop = ^S; susp = ^Z; rprnt = ^R; werase = ^W; lnext = ^V; flush = ^O;
...
isig icanon iexten echo echoe echok -echonl -noflsh -xcase -tostop -echoprt
Using canonical mode, it is possible to redefine the special keys for the local terminal line editor.
The process controlling the terminal receives only 13 characters (12 alphabetic ones, plus a newline), although the user hit 26 keys.
In non-canonical ("raw") mode, every key hit (including special editing keys such as ctl-H) sends a character immediately to the
controlling process.
The Bash prompt disables both icanon and echo, since it replaces the basic terminal line editor with its own more elaborate one.
For example, when you hit ctl-A at the Bash prompt, there's no ^A echoed by the terminal, but Bash gets a \1 character, interprets
it, and moves the cursor to the begining of the line.
Stephane Chazelas
tset
bash$ tset -r
Terminal type is xterm-xfree86.
Kill is control-U (^U).
Interrupt is control-C (^C).
setserial
Set or display serial port parameters. This command must be run by root user and is usually found in a system setup script.
getty, agetty
The initialization process for a terminal uses getty or agetty to set it up for login by a user. These commands are not used
within user shell scripts. Their scripting counterpart is stty.
mesg
Enables or disables write access to the current user's terminal. Disabling access would prevent another user on the network to
write to the terminal.
It can be very annoying to have a message about ordering pizza suddenly appear in the middle of the text file you
are editing. On a multi-user network, you might therefore wish to disable write access to your terminal when you
need to avoid interruptions.
wall
This is an acronym for "write all", i.e., sending a message to all users at every terminal logged into the network. It is primarily
a system administrator's tool, useful, for example, when warning everyone that the system will shortly go down due to a
problem (see Example 17-2).
If write access to a particular terminal has been disabled with mesg, then wall cannot send a message to it.
dmesg
Lists all system bootup messages to stdout. Handy for debugging and ascertaining which device drivers were installed and
which system interrupts in use. The output of dmesg may, of course, be parsed with grep, sed, or awk from within a script.
uname
Output system specifications (OS, kernel version, etc.) to stdout. Invoked with the -a option, gives verbose system info (see
Example 12-4). The -s option shows only the OS type.
bash$ uname -a
Linux localhost.localdomain 2.2.15-2.5.0 #1 Sat Feb 5 00:13:43 EST 2000 i686 unknown
bash$ uname -s
Linux
arch
bash$ arch
i686
bash$ uname -m
i686
lastcomm
Gives information about previous commands, as stored in the /var/account/pacct file. Command name and user name
can be specified by options. This is one of the GNU accounting utilities.
lastlog
List the last login time of all system users. This references the /var/log/lastlog file.
bash$ lastlog
root tty1 Fri Dec 7 18:43:21 -0700 2001
bin **Never logged in**
daemon **Never logged in**
...
bozo tty1 Sat Dec 8 21:14:29 -0700 2001
This command will fail if the user invoking it does not have read permission for the
/var/log/lastlog file.
lsof
List open files. This command outputs a detailed table of all currently open files and gives information about their owner, size,
the processes associated with them, and more. Of course, lsof may be piped to grep and/or awk to parse and analyze its results.
bash$ lsof
COMMAND PID USER FD TYPE DEVICE SIZE NODE NAME
init 1 root mem REG 3,5 30748 30303 /sbin/init
init 1 root mem REG 3,5 73120 8069 /lib/ld-2.1.3.so
init 1 root mem REG 3,5 931668 8075 /lib/libc-2.1.3.so
cardmgr 213 root mem REG 3,5 36956 30357 /sbin/cardmgr
...
strace
Diagnostic and debugging tool for tracing system calls and signals. The simplest way of invoking it is strace COMMAND.
bash$ strace df
execve("/bin/df", ["df"], [/* 45 vars */]) = 0
uname({sys="Linux", node="bozo.localdomain", ...}) = 0
brk(0) = 0x804f5e4
...
Shows memory and cache usage in tabular form. The output of this command lends itself to parsing, using grep, awk or Perl.
The procinfo command shows all the information that free does, and much more.
bash$ free
total used free shared buffers cached
Mem: 30504 28624 1880 15820 1608 16376
-/+ buffers/cache: 10640 19864
Swap: 68540 3128 65412
procinfo
Extract and list information and statistics from the /proc pseudo-filesystem. This gives a very extensive and detailed listing.
lsdev
bash$ lsdev
Device DMA IRQ I/O Ports
------------------------------------------------
cascade 4 2
dma 0080-008f
dma1 0000-001f
dma2 00c0-00df
fpu 00f0-00ff
ide0 14 01f0-01f7 03f6-03f6
...
du
Show (disk) file usage, recursively. Defaults to current working directory, unless otherwise specified.
bash$ du -ach
1.0k ./wi.sh
1.0k ./tst.sh
1.0k ./random.file
6.0k .
6.0k total
df
bash$ df
Filesystem 1k-blocks Used Available Use% Mounted on
/dev/hda5 273262 92607 166547 36% /
/dev/hda8 222525 123951 87085 59% /home
/dev/hda7 1408796 1075744 261488 80% /usr
stat
Gives detailed and verbose statistics on a given file (even a directory or device file) or set of files.
If the target file does not exist, stat returns an error message.
vmstat
bash$ vmstat
procs memory swap io system cpu
r b w swpd free buff cache si so bi bo in cs us sy id
0 0 0 0 11040 2636 38952 0 0 33 7 271 88 8 3 89
netstat
Show current network statistics and information, such as routing tables and active connections. This utility accesses
information in /proc/net (Chapter 28). See Example 28-2.
Shows how long the system has been running, along with associated statistics.
bash$ uptime
10:28pm up 1:57, 3 users, load average: 0.17, 0.34, 0.27
hostname
Lists the system's host name. This command sets the host name in an /etc/rc.d setup script (/etc/rc.d/rc.sysinit
or similar). It is equivalent to uname -n, and a counterpart to the $HOSTNAME internal variable.
bash$ hostname
localhost.localdomain
hostid
bash$ hostid
7f0100
This command allegedly fetches a "unique" serial number for a particular system. Certain product
registration procedures use this number to brand a particular user license. Unfortunately, hostid only
returns the machine network address in hexadecimal, with pairs of bytes transposed.
As it happens, transposing the bytes of 127.0.0.1, we get 0.127.1.0, which translates in hex to
007f0100, the exact equivalent of what hostid returns, above. There exist only a few million other
Linux machines with this identical hostid.
sar
Invoking sar (system activity report) gives a very detailed rundown on system statistics. This command is found on some
commercial UNIX systems, but is not part of the base Linux distribution. It is contained in the sysstat utilities package, written
by Sebastien Godard.
bash$ sar
Linux 2.4.7-10 (localhost.localdomain) 12/31/2001
System Logs
logger
Appends a user-generated message to the system log (/var/log/messages). You do not have to be root to invoke logger.
# tail /var/log/message
# ...
# Jul 7 20:48:58 localhost ./test.sh[1712]: Logging at line 3.
logrotate
This utility manages the system log files, rotating, compressing, deleting, and/or mailing them, as appropriate. Usually crond
runs logrotate on a daily basis.
Adding an appropriate entry to /etc/logrotate.conf makes it possible to manage personal log files, as well as system-
wide ones.
Job Control
ps
Process Statistics: lists currently executing processes by owner and PID (process id). This is usually invoked with ax options,
and may be piped to grep or sed to search for a specific process (see Example 11-9 and Example 28-1).
pstree
Lists currently executing processes in "tree" format. The -p option shows the PIDs, as well as the process names.
top
Continuously updated display of most cpu-intensive processes. The -b option displays in text mode, so that the output may be
parsed or accessed from a script.
bash$ top -b
8:30pm up 3 min, 3 users, load average: 0.49, 0.32, 0.13
45 processes: 44 sleeping, 1 running, 0 zombie, 0 stopped
CPU states: 13.6% user, 7.3% system, 0.0% nice, 78.9% idle
Mem: 78396K av, 65468K used, 12928K free, 0K shrd, 2352K buff
Swap: 157208K av, 0K used, 157208K free 37244K cached
PID USER PRI NI SIZE RSS SHARE STAT %CPU %MEM TIME COMMAND
848 bozo 17 0 996 996 800 R 5.6 1.2 0:00 top
1 root 8 0 512 512 444 S 0.0 0.6 0:04 init
2 root 9 0 0 0 0 SW 0.0 0.0 0:00 keventd
...
nice
Run a background job with an altered priority. Priorities run from 19 (lowest) to -20 (highest). Only root may set the negative
(higher) priorities. Related commands are renice, snice, and skill.
nohup
Keeps a command running even after user logs off. The command will run as a foreground process unless followed by &. If
you use nohup within a script, consider coupling it with a wait to avoid creating an orphan or zombie process.
pidof
Identifies process id (pid) of a running job. Since job control commands, such as kill and renice act on the pid of a process (not
its name), it is sometimes necessary to identify that pid. The pidof command is the approximate counterpart to the $PPID
internal variable.
#!/bin/bash
# kill-process.sh
NOPROCESS=2
exit 0
fuser
Identifies the processes (by pid) that are accessing a given file, set of files, or directory. May also be invoked with the -k
option, which kills those processes. This has interesting implications for system security, especially in scripts preventing
unauthorized users from accessing system services.
crond
Administrative program scheduler, performing such duties as cleaning up and deleting system log files and updating the slocate
database. This is the superuser version of at (although each user may have their own crontab file which can be changed with
the crontab command). It runs as a daemon and executes scheduled entries from /etc/crontab.
init
The init command is the parent of all processes. Called in the final step of a bootup, init determines the runlevel of the system
from /etc/inittab. Invoked by its alias telinit, and by root only.
telinit
Symlinked to init, this is a means of changing the system runlevel, usually done for system maintenance or emergency
filesystem repairs. Invoked only by root. This command can be dangerous - be certain you understand it well before using!
runlevel
Shows the current and last runlevel, that is, whether the system is halted (runlevel 0), in single-user mode (1), in multi-user
mode (2 or 3), in X Windows (5), or rebooting (6). This command accesses the /var/run/utmp file.
halt, shutdown, reboot
Command set to shut the system down, usually just prior to a power down.
Network
ifconfig
Network interface configuration and tuning utility. It is most often used at bootup to set up the interfaces, or to shut them down
when rebooting.
# ...
[ -x /sbin/ifconfig ] || exit 0
# ...
for i in $interfaces ; do
if ifconfig $i 2>/dev/null | grep -q "UP" >/dev/null 2>&1 ; then
action "Shutting down interface $i: " ./ifdown $i boot
fi
# The GNU-specific "-q" option to "grep" means "quiet", i.e., producing no output.
# Redirecting output to /dev/null is therefore not strictly necessary.
# ...
route
bash$ route
Destination Gateway Genmask Flags MSS Window irtt Iface
pm3-67.bozosisp * 255.255.255.255 UH 40 0 0 ppp0
127.0.0.0 * 255.0.0.0 U 40 0 0 lo
default pm3-67.bozosisp 0.0.0.0 UG 40 0 0 ppp0
chkconfig
Check network configuration. This command lists and manages the network services started at bootup in the /etc/rc?.d
directory.
Originally a port from IRIX to Red Hat Linux, chkconfig may not be part of the core installation of some Linux flavors.
tcpdump
Network packet "sniffer". This is a tool for analyzing and troubleshooting traffic on a network by dumping packet headers that
match specified criteria.
Of course, the output of tcpdump can be parsed, using certain of the previously discussed text processing utilities.
Filesystem
mount
Mount a filesystem, usually on an external device, such as a floppy or CDROM. The file /etc/fstab provides a handy
listing of available filesystems, partitions, and devices, including options, that may be automatically or manually mounted. The
file /etc/mtab shows the currently mounted filesystems and partitions (including the virtual ones, such as /proc).
mount -a mounts all filesystems and partitions listed in /etc/fstab, except those with a noauto option. At bootup, a
startup script in /etc/rc.d (rc.sysinit or something similar) invokes this to get everything mounted.
This versatile command can even mount an ordinary file on a block device, and the file will act as if it were a filesystem.
Mount accomplishes that by associating the file with a loopback device. One application of this is to mount and examine an
ISO9660 image before burning it onto a CDR. [3]
# As root...
umount
Unmount a currently mounted filesystem. Before physically removing a previously mounted floppy or CDROM disk, the
device must be umounted, else filesystem corruption may result.
umount /mnt/cdrom
# You may now press the eject button and safely remove the disk.
The automount utility, if properly installed, can mount and unmount floppies or CDROM disks as they
are accessed or removed. On laptops with swappable floppy and CDROM drives, this can cause problems,
though.
sync
Forces an immediate write of all updated data from buffers to hard drive (synchronize drive with buffers). While not strictly
necessary, a sync assures the sys admin or user that the data just changed will survive a sudden power failure. In the olden
days, a sync; sync (twice, just to make absolutely sure) was a useful precautionary measure before a system reboot.
At times, you may wish to force an immediate buffer flush, as when securely deleting a file (see Example 12-41) or when the
lights begin to flicker.
losetup
SIZE=1000000 # 1 meg
head -c $SIZE < /dev/zero > file # Set up file of designated size.
losetup /dev/loop0 file # Set it up as loopback device.
mke2fs /dev/loop0 # Create filesystem.
mount -o loop /dev/loop0 /mnt # Mount it.
# Thanks, S.C.
mkswap
Creates a swap partition or file. The swap area must subsequently be enabled with swapon.
swapon, swapoff
Enable / disable swap partitition or file. These commands usually take effect at bootup and shutdown.
mke2fs
#!/bin/bash
fdisk $NEWDISK
mke2fs -cv $NEWDISK1 # Check for bad blocks & verbose output.
# Note: /dev/hdb1, *not* /dev/hdb!
mkdir $MOUNTPOINT
chmod 777 $MOUNTPOINT # Makes new drive accessible to all users.
# Now, test...
# mount -t ext2 /dev/hdb1 /mnt/newdisk
# Try creating a directory.
# If it works, umount it, and proceed.
# Final step:
# Add the following line to /etc/fstab.
# /dev/hdb1 /mnt/newdisk ext2 defaults 1 1
exit 0
tune2fs
Tune ext2 filesystem. May be used to change filesystem parameters, such as maximum mount count. This must be invoked as
root.
This is an extremely dangerous command. Use it at your own risk, as you may inadvertently destroy your
filesystem.
dumpe2fs
Dump (list to stdout) very verbose filesystem info. This must be invoked as root.
hdparm
List or change hard disk parameters. This command must be invoked as root, and it may be dangerous if misused.
fdisk
Create or change a partition table on a storage device, usually a hard drive. This command must be invoked as root.
Use this command with extreme caution. If something goes wrong, you may destroy an existing filesystem.
fsck, e2fsck, debugfs
fsck: a front end for checking a UNIX filesystem (may invoke other utilities). The actual filesystem type generally defaults to
ext2.
debugfs: ext2 filesystem debugger. One of the uses of this versatile, but dangerous command is to (attempt to) recover deleted
files. For advanced users only!
All of these should be invoked as root, and they can damage or destroy a filesystem if misused.
badblocks
Checks for bad blocks (physical media flaws) on a storage device. This command finds use when formatting a newly installed
hard drive or testing the integrity of backup media. [4] As an example, badblocks /dev/fd0 tests a floppy disk.
The badblocks command may be invoked destructively (overwrite all data) or in non-destructive read-only mode. If root user
owns the device to be tested, as is generally the case, then root must invoke this command.
mkbootdisk
Creates a boot floppy which can be used to bring up the system if, for example, the MBR (master boot record) becomes
corrupted. The mkbootdisk command is actually a Bash script, written by Erik Troan, in the /sbin directory.
chroot
CHange ROOT directory. Normally commands are fetched from $PATH, relative to /, the default root directory. This changes
the root directory to a different one (and also changes the working directory to there). This is useful for security purposes, for
instance when the system administrator wishes to restrict certain users, such as those telnetting in, to a secured portion of the
filesystem (this is sometimes referred to as confining a guest user to a "chroot jail"). Note that after a chroot, the execution
path for system binaries is no longer valid.
A chroot /opt would cause references to /usr/bin to be translated to /opt/usr/bin. Likewise, chroot
/aaa/bbb /bin/ls would redirect future instances of ls to /aaa/bbb as the base directory, rather than / as is normally
the case. An alias XX 'chroot /aaa/bbb ls' in a user's ~/.bashrc effectively restricts which portion of the filesystem she
may run command "XX" on.
The chroot command is also handy when running from an emergency boot floppy (chroot to /dev/fd0), or as an option to
lilo when recovering from a system crash. Other uses include installation from a different filesystem (an rpm option) or
running a readonly filesystem from a CD ROM. Invoke only as root, and use with care.
It might be necessary to copy certain system files to a chrooted directory, since the normal $PATH can no longer
be relied upon.
lockfile
This utility is part of the procmail package (www.procmail.org). It creates a lock file, a semaphore file that controls access to a
file, device, or resource. The lock file serves as a flag that this particular file, device, or resource is in use by a particular
process ("busy"), and this permits only restricted access (or no access) to other processes.
Lock files are used in such applications as protecting system mail folders from simultaneously being changed by multiple
users, indicating that a modem port is being accessed, and showing that an instance of Netscape is using its cache. Scripts may
check for the existence of a lock file created by a certain process to check if that process is running. Note that if a script
attempts create a lock file that already exists, the script will likely hang.
Normally, applications create and check for lock files in the /var/lock directory. A script can test for the presence of a lock
file by something like the following.
appname=xyzip
# Application "xyzip" created lock file "/var/lock/xyzip.lock".
if [ -e "/var/lock/$appname.lock ]
then
...
mknod
Creates block or character device files (may be necessary when installing new hardware on the system).
tmpwatch
Automatically deletes files which have not been accessed within a specified period of time. Usually invoked by crond to
remove stale log files.
MAKEDEV
Utility for creating device files. It must be run as root, and in the /dev directory.
root# ./MAKEDEV
Backup
dump, restore
The dump command is an elaborate filesystem backup utility, generally used on larger installations and networks. [5] It reads
raw disk partitions and writes a backup file in a binary format. Files to be backed up may be saved to a variety of storage
media, including disks and tape drives. The restore command restores backups made with dump.
fdformat
System Resources
ulimit
Sets an upper limit on system resources. Usually invoked with the -f option, which sets a limit on file size (ulimit -f 1000
limits files to 1 meg maximum). The -t option limits the coredump size (ulimit -c 0 eliminates coredumps). Normally, the
value of ulimit would be set in /etc/profile and/or ~/.bash_profile (see Chapter 27).
umask
User file creation MASK. Limit the default file attributes for a particular user. All files created by that user take on the
attributes specified by umask. The (octal) value passed to umask defines the file permissions disabled. For example, umask
022 ensures that new files will have at most 755 permissions (777 NAND 022). [6] Of course, the user may later change the
attributes of particular files with chmod. The usual practice is to set the value of umask in /etc/profile and/or
~/.bash_profile (see Chapter 27).
rdev
Get info about or make changes to root device, swap space, or video mode. The functionality of rdev has generally been taken
over by lilo, but rdev remains useful for setting up a ram disk. This is another dangerous command, if misused.
Modules
lsmod
bash$ lsmod
Module Size Used by
autofs 9456 2 (autoclean)
opl3 11376 0
serial_cs 5456 0 (unused)
sb 34752 0
uart401 6384 0 [sb]
sound 58368 0 [opl3 sb uart401]
soundlow 464 0 [sound]
soundcore 2800 6 [sb sound]
ds 6448 2 [serial_cs]
i82365 22928 2
pcmcia_core 45984 0 [serial_cs ds i82365]
insmod
Miscellaneous
env
Runs a program or script with certain environmental variables set or changed (without changing the overall system
environment). The [varname=xxx] permits changing the environmental variable varname for the duration of the script.
With no options specified, this command lists all the environmental variable settings.
In Bash and other Bourne shell derivatives, it is possible to set variables in a single command's environment.
The first line of a script (the "sha-bang" line) may use env when the path to the shell or interpreter is unknown.
#! /usr/bin/env perl
ldd
strip
Remove the debugging symbolic references from an executable binary. This decreases its size, but makes debugging of it
impossible.
Remote distribution client: synchronizes, clones, or backs up a file system on a remote server.
Using our knowledge of administrative commands, let us examine a system script. One of the shortest and simplest to understand
scripts is killall, used to suspend running processes at system shutdown.
#!/bin/sh
# --> Comments added by the author of this document marked by "# -->".
# Bring down all unneeded services that are still running (there shouldn't
# be any, so this is just a sanity check)
for i in /var/lock/subsys/*; do
# --> Standard for/in loop, but since "do" is on same line,
# --> it is necessary to add ";".
# Check if the script is there.
[ ! -f $i ] && continue
# --> This is a clever use of an "and list", equivalent to:
# --> if [ ! -f "$i" ]; then continue
# --> It gets it from the lock file name, and since if there
# --> is a lock file, that's proof the process has been running.
# --> See the "lockfile" entry, above.
That wasn't so bad. Aside from a little fancy footwork with variable matching, there is no new material there.
Exercise 1. In /etc/rc.d/init.d, analyze the halt script. It is a bit longer than killall, but similar in concept. Make a copy of
this script somewhere in your home directory and experiment with it (do not run it as root). Do a simulated run with the -vn flags (sh
-vn scriptname). Add extensive comments. Change the "action" commands to "echos".
Exercise 2. Look at some of the more complex scripts in /etc/rc.d/init.d. See if you can understand parts of them. Follow the
above procedure to analyze them. For some additional insight, you might also examine the file sysvinitfiles in
/usr/share/doc/initscripts-?.??, which is part of the "initscripts" documentation.
Notes
[1] This is the case on a Linux machine or a UNIX system with disk quotas.
[2] The userdel command will fail if the particular user being deleted is still logged on.
[3] For more detail on burning CDRs, see Alex Withers' article, Creating CDs, in the October, 1999 issue of Linux Journal.
[4] The -c option to mke2fs also invokes a check for bad blocks.
[5] Operators of single-user Linux systems generally prefer something simpler for backups, such as tar.
[6] NAND is the logical "not-and" operator. Its effect is somewhat similar to subtraction.
Variations
The use of backticks in arithmetic expansion has been superseded by double parentheses $((...)) or
the very convenient let construction.
z=$(($z+3))
# $((EXPRESSION)) is arithmetic expansion. # Not to be confused with
# command substitution.
let z=z+3
let "z += 3" #If quotes, then spaces and special operators allowed.
# 'let' is actually arithmetic evaluation, rather than expansion.
All the above are equivalent. You may use whichever one "rings your chimes".
1. Example 12-6
2. Example 10-14
3. Example 26-1
4. Example 26-4
5. Example A-17
command #1
command #2
...
#!/bin/bash
interactive-program <<LimitString
command #1
command #2
...
LimitString
Choose a limit string sufficiently unusual that it will not occur anywhere in the command list and confuse matters.
Note that here documents may sometimes be used to good effect with non-interactive utilities and commands.
#!/bin/bash
E_BADARGS=65
if [ -z "$1" ]
then
echo "Usage: `basename $0` filename"
exit $E_BADARGS
fi
TARGETFILE=$1
# Bram Moolenaar points out that this may not work with 'vim',
#+ because of possible problems with terminal interaction.
exit 0
The above script could just as effectively have been implemented with ex, rather than vi. Here documents containing a list of
ex commands are common enough to form their own category, known as ex scripts.
#!/bin/bash
wall <<zzz23EndOfMessagezzz23
E-mail your noontime orders for pizza to the system administrator.
(Add an extra dollar for anchovy or mushroom topping.)
# Additional message text goes here.
# Note: Comment lines printed by 'wall'.
zzz23EndOfMessagezzz23
exit 0
#!/bin/bash
cat <<End-of-message
-------------------------------------
This is line 1 of the message.
This is line 2 of the message.
This is line 3 of the message.
This is line 4 of the message.
This is the last line of the message.
-------------------------------------
End-of-message
exit 0
#--------------------------------------------
# Code below disabled, due to "exit 0" above.
The - option to mark a here document limit string (<<-LimitString) suppresses tabs (but not spaces) in the output. This
may be useful in making a script more readable.
#!/bin/bash
# Same as previous example, but...
cat <<-ENDOFMESSAGE
This is line 1 of the message.
This is line 2 of the message.
This is line 3 of the message.
This is line 4 of the message.
This is the last line of the message.
ENDOFMESSAGE
# The output of the script will be flush left.
# Leading tab in each line will not show.
exit 0
A here document supports parameter and command substitution. It is therefore possible to pass different parameters to the
body of the here document, changing its output accordingly.
#!/bin/bash
# Another 'cat' here document, using parameter substitution.
if [ $# -ge $CMDLINEPARAM ]
then
NAME=$1 # If more than one command line param,
# then just take the first.
else
NAME="John Doe" # Default, if no command line parameter.
fi
cat <<Endofmessage
Endofmessage
exit 0
Quoting or escaping the "limit string" at the head of a here document disables parameter substitution within its body. This has
very limited usefulness.
#!/bin/bash
# A 'cat' here document, but with parameter substitution disabled.
NAME="John Doe"
RESPONDENT="the author of this fine script"
cat <<'Endofmessage'
Endofmessage
effect.
# cat <<"Endofmessage"
# cat <<\Endofmessage
exit 0
#!/bin/bash
# upload.sh
E_ARGERROR=65
if [ -z "$1" ]
then
echo "Usage: `basename $0` filename"
exit $E_ARGERROR
fi
Server="metalab.unc.edu"
Directory="/incoming/Linux"
# These need not be hard-coded into script,
# but may instead be changed to command line argument.
exit 0
#!/bin/bash
# here-function.sh
GetPersonalData ()
{
read firstname
read lastname
read address
read city
read state
read zipcode
} # This certainly looks like an interactive function, but...
echo
echo "$firstname $lastname"
echo "$address"
echo "$city, $state $zipcode"
echo
exit 0
It is possible to use : as a dummy command accepting output from a here document. This, in effect, creates an "anonymous"
here document.
#!/bin/bash
: <<TESTVARIABLES
${HOSTNAME?}${USER?}${MAIL?} # Print error message if one of the variables not set.
TESTVARIABLES
exit 0
#!/bin/bash
# commentblock.sh
: << COMMENTBLOCK
echo "This line will not echo."
This is a comment line missing the "#" prefix.
This is another comment line missing the "#" prefix.
&*@!!++=
The above line will cause no error message,
because the Bash interpreter will ignore it.
COMMENTBLOCK
: << DEBUGXXX
for file in *
do
cat "$file"
done
DEBUGXXX
exit 0
Yet another twist of this nifty trick makes "self-documenting" scripts possible.
#!/bin/bash
# self-document.sh: self-documenting script
# Modification of "colm.sh".
DOC_REQUEST=70
: << DOCUMENTATIONXX
List the statistics of a specified directory in tabular format.
---------------------------------------------------------------
The command line parameter gives the directory to be listed.
If no directory specified or directory specified cannot be read,
then list the current working directory.
DOCUMENTATIONXX
if [ -z "$1" -o ! -r "$1" ]
then
directory=.
else
directory="$1"
fi
exit 0
Here documents create temporary files, but these files are deleted after opening and are not accessible to any other
process.
For those tasks too complex for a "here document", consider using the expect scripting language, which is specifically tailored
for feeding input into interactive programs.
Don't break the chain! Send out your ten copies today!
Courtesy 'NIX "fortune cookies", with some alterations and many apologies
Running a script or portion of a script in restricted mode disables certain commands that would
otherwise be available. This is a security measure intended to limit the privileges of the script
user and to minimize possible damage from running the script.
Output redirection.
Various other commands that would enable monkeying with or attempting to subvert the
script for an unintended purpose.
#!/bin/bash
# Starting the script with "#!/bin/bash -r"
# runs entire script in restricted mode.
echo
set -r
# set --restricted has same effect.
echo "==> Now in restricted mode. <=="
echo
echo
echo
echo
echo
echo
echo
exit 0
>(command)
<(command)
These initiate process substitution. This uses /dev/fd/<n> files to send the results of the process within
parentheses to another process. [1]
There is no space between the the "<" or ">" and the parentheses. Space there would give an
error message.
Bash creates a pipe with two file descriptors, --fIn and fOut--. The stdin of true connects to fOut
(dup2(fOut, 0)), then Bash passes a /dev/fd/fIn argument to echo. On systems lacking /dev/fd/<n> files,
Bash may use temporary files. (Thanks, S.C.)
# Thanks, S.C.
A reader of this document sent in the following interesting example of process substitution.
# Output:
# Kernel IP routing table
# Destination Gateway Genmask Flags Metric Ref Use Iface
# 127.0.0.0 0.0.0.0 255.0.0.0 U 0 0 0 lo
route -n |
while read des what mask iface; do # Variables set from output of pipe.
echo $des $what $mask $iface
done # Same output as above.
Notes
[1] This has the same effect as a named pipe (temp file), and, in fact, named pipes were at one time used in
process substitution.
Like "real" programming languages, Bash has functions, though in a somewhat limited implementation. A function is a
subroutine, a code block that implements a set of operations, a "black box" that performs a specified task. Wherever there is
repetitive code, when a task repeats with only slight variations, then consider using a function.
function function_name {
command...
}
or
function_name () {
command...
}
This second form will cheer the hearts of C programmers (and is more portable).
As in C, the function's opening bracket may optionally appear on the second line.
function_name ()
{
command...
}
#!/bin/bash
funky ()
{
echo "This is a funky function."
echo "Now exiting funky function."
} # Function declaration must precede call.
funky
exit 0
The function definition must precede the first call to it. There is no method of "declaring" the function, as, for example, in C.
# f1
# Will give an error message, since function "f1" not yet defined.
# However...
f1 ()
{
echo "Calling function \"f2\" from within function \"f1\"."
f2
}
f2 ()
{
echo "Function \"f2\"."
}
# Thanks, S.C.
It is even possible to nest a function within another function, although this is not very useful.
f1 ()
{
f2 () # nested
{
echo "Function \"f2\", inside \"f1\"."
}
# f2
# Gives an error message.
f1 # Does nothing, since calling "f1" does not automatically call "f2".
f2 # Now, it's all right to call "f2",
# since its definition has been made visible by calling "f1".
# Thanks, S.C.
Function declarations can appear in unlikely places, even where a command would otherwise go.
if [ "$USER" = bozo ]
then
bozo_greet () # Function definition embedded in an if/then construct.
{
echo "Hello, Bozo."
}
fi
bozo_greet # Works only for Bozo, and other users get an error.
# Thanks, S.C.
and list
Each command executes in turn provided that the previous command has given a return value of true (zero). At the first false
(non-zero) return, the command chain terminates (the first command returning false is the last one to execute).
#!/bin/bash
# "and list"
if [ ! -z "$1" ] && echo "Argument #1 = $1" && [ ! -z "$2" ] && echo "Argument #2 =
$2"
then
echo "At least 2 arguments passed to script."
# All the chained commands return true.
else
echo "Less than 2 arguments passed to script."
# At least one of the chained commands returns false.
fi
# Note that "if [ ! -z $1 ]" works, but its supposed equivalent,
# if [ -n $1 ] does not. However, quoting fixes this.
# if [ -n "$1" ] works. Careful!
# It is best to always quote tested variables.
exit 0
#!/bin/bash
test $# -ne $ARGS && echo "Usage: `basename $0` $ARGS argument(s)" && exit $E_BADARGS
# If condition-1 true (wrong number of args passed to script),
# then the rest of the line executes, and script terminates.
exit 0
or list
Each command executes in turn for as long as the previous command returns false. At the first true return, the command
chain terminates (the first command returning true is the last one to execute). This is obviously the inverse of the "and list".
#!/bin/bash
E_BADARGS=65
if [ -z "$1" ]
then
echo "Usage: `basename $0` filename"
exit $E_BADARGS # No arg? Bail out.
else
file=$1 # Set filename.
fi
exit 0
The exit status of an and list or an or list is the exit status of the last command executed.
Clever combinations of "and" and "or" lists are possible, but the logic may easily become convoluted and require extensive
debugging.
# Same result as
( false && true ) || echo false # false
# But *not*
false && ( true || echo false ) # (nothing echoed)
# It's best to avoid such complexities, unless you know what you're doing.
# Thanks, S.C.
See Example A-8 for an illustration of using an and / or list to test variables.
A Linux or UNIX machine typically has two special-purpose directories, /dev and /proc.
Uses of /dev/null
Think of /dev/null as a "black hole". It is the nearest equivalent to a write-only file. Everything written to it
disappears forever. Attempts to read or output from it result in nothing. Nevertheless, /dev/null can be quite
useful from both the command line and in scripts.
Suppressing stdout.
rm $badname 2>/dev/null
# So error messages [stderr] deep-sixed.
Deleting contents of a file, but preserving the file itself, with all attendant permissions (from Example 2-1 and
Example 2-2):
Automatically emptying the contents of a logfile (especially good for dealing with those nasty "cookies" sent by Web
commercial sites):
ln -s /dev/null ~/.netscape/cookies
# All cookies now get sent to a black hole, rather than saved to disk.
Uses of /dev/zero
Like /dev/null, /dev/zero is a pseudo file, but it actually contains nulls (numerical zeros, not the ASCII kind).
Output written to it disappears, and it is fairly difficult to actually read the nulls in /dev/zero, though it can be
done with od or a hex editor. The chief use for /dev/zero is in creating an initialized dummy file of specified
length intended as a temporary swap file.
#!/bin/bash
# Creating a swapfile.
# This script must be run as root.
FILE=/swap
BLOCKSIZE=1024
MINBLOCKS=40
SUCCESS=0
if [ -n "$1" ]
then
blocks=$1
else
blocks=$MINBLOCKS # Set to default of 40 blocks
fi # if nothing specified on command line.
exit $SUCCESS
Another application of /dev/zero is to "zero out" a file of a designated size for a special purpose, such as mounting a
filesystem on a loopback device (see Example 13-6) or securely deleting a file (see Example 12-41).
#!/bin/bash
# ramdisk.sh
MOUNTPT=/mnt/ramdisk
SIZE=2000 # 2K blocks (change as appropriate)
BLOCKSIZE=1024 # 1K (1024 byte) block size
DEVICE=/dev/ram0 # First ram device
username=`id -nu`
if [ "$username" != "$ROOTUSER_NAME" ]
then
echo "Must be root to run \"`basename $0`\"."
exit $E_NON_ROOT_USER
fi
exit 0
#!/bin/bash
# ex74.sh
a=37
if [$a -gt 27 ]
then
echo $a
fi
exit 0
What's wrong with the above script (hint: after the if)?
#!/bin/bash
# missing-keyword.sh: What error message will this generate?
for a in 1 2 3
do
echo "$a"
# done # Required keyword 'done' commented out in line 7.
exit 0
Note that the error message does not necessarily reference the line in which the error occurs, but the line where the
Bash interpreter finally becomes aware of the error.
What if the script executes, but does not work as expected? This is the all too familiar logic error.
#!/bin/bash
# echo "$badname"
rm "$badname"
exit 0
Try to find out what's wrong with Example 30-3 by uncommenting the echo "$badname" line. Echo statements
are useful for seeing whether what you expect is actually what you get.
In this particular case, rm "$badname" will not give the desired results because $badname should not be quoted.
Placing it in quotes ensures that rm has only one argument (it will match only one filename). A partial fix is to remove
to quotes from $badname and to reset $IFS to contain only a newline, IFS=$'\n'. However, there are simpler
ways of going about it.
1. echo statements at critical points in the script to trace the variables, and otherwise give a snapshot of what is
going on.
2. using the tee filter to check processes or data flows at critical points.
3. setting option flags -n -v -x
sh -n scriptname checks for syntax errors without actually running the script. This is the equivalent of
inserting set -n or set -o noexec into the script. Note that certain types of syntax errors can slip past
this check.
sh -v scriptname echoes each command before executing it. This is the equivalent of inserting set -v
or set -o verbose in the script.
The -n and -v flags work well together. sh -nv scriptname gives a verbose syntax check.
sh -x scriptname echoes the result each command, but in an abbreviated manner. This is the equivalent
of inserting set -x or set -o xtrace in the script.
Inserting set -u or set -o nounset in the script runs it, but gives an unbound variable error message at
each attempt to use an undeclared variable.
4. Using an "assert" function to test a variable or condition at critical points in a script. (This is an idea borrowed
from C.)
#!/bin/bash
# assert.sh
lineno=$2
if [ ! $1 ]
then
echo "Assertion failed: \"$1\""
echo "File \"$0\", line $lineno"
exit $E_ASSERT_FAILED
# else
# return
# and continue executing script.
fi
}
a=5
b=4
condition="$a -lt $b" # Error message and exit from script.
# Try setting "condition" to something else,
#+ and see what happens.
# Some commands.
# ...
echo "You will never see this statement echo."
# ...
# Some more commands.
exit 0
5. trapping at exit.
The exit command in a script triggers a signal 0, terminating the process, that is, the script itself. [1] It is often
useful to trap the exit, forcing a "printout" of variables, for example. The trap must be the first command in the
script.
Trapping signals
trap
A signal is simply a message sent to a process, either by the kernel or another process,
telling it to take some specified action (usually to terminate). For example, hitting a Control-
C, sends a user interrupt, an INT signal, to a running program.
trap '' 2
# Ignore interrupt 2 (Control-C), with no action specified.
#!/bin/bash
a=39
b=36
exit 0
# Note that commenting out the 'exit' command makes no difference,
# since the script exits in any case after running out of commands.
#!/bin/bash
# logon.sh: A quick 'n dirty script to check whether you are on-line yet.
TRUE=1
LOGFILE=/var/log/messages
# Note that $LOGFILE must be readable (chmod 644 /var/log/messages).
TEMPFILE=temp.$$
# Create a "unique" temp file name, using process id of the script.
KEYWORD=address
# At logon, the line "remote IP address xxx.xxx.xxx.xxx"
# appended to /var/log/messages.
ONLINE=22
USER_INTERRUPT=13
CHECK_LINES=100
# How many lines in log file to check.
echo
else
echo -n "." # -n option to echo suppresses newline,
# so you get continuous rows of dots.
fi
sleep 1
done
exit 0
while true
do ifconfig ppp0 | grep UP 1> /dev/null && echo "connected" && exit 0
echo -n "." # Prints dots (.....) until connected.
sleep 2
done
CHECK_INTERVAL=1
The DEBUG argument to trap causes a specified action to execute after every command in a script. This
permits tracing variables, for example.
#!/bin/bash
variable=29
exit 0
trap '' SIGNAL (two adjacent apostrophes) disables SIGNAL for the remainder of the script. trap
SIGNAL restores the functioning of SIGNAL once more. This is useful to protect a critical portion of a script
from an undesirable interrupt.
Notes
Herewith are a few stylistic guidelines. This is not intended as an Official Shell Scripting
Stylesheet.
Tom Duff
Table of Contents
34.1. Interactive and non-interactive shells and scripts
34.2. Shell Wrappers
34.3. Tests and Comparisons: Alternatives
34.4. Optimizations
34.5. Assorted Tips
34.6. Oddities
34.7. Security Issues
34.8. Portability Issues
34.9. Shell Scripting Under Windows
This reminds me of the apocryphal story about the mad professor. Crazy as a loon, the
fellow was. At the sight of a book, any book -- at the library, at a bookstore, anywhere -- he
would become totally obsessed with the idea that he could have written it, should have
written it, and done a better job of it to boot. He would thereupon rush home and proceed to
do just that, write a book with the very same title. When he died some years later, he
allegedly had several thousand books to his credit, probably putting even Asimov to shame.
The books might not have been any good, who knows, but does that really matter? Here's a
fellow who lived his dream, even if he was obsessed by it, driven by it, and I can't help
admiring the old coot...
Notes
The author claims no credentials or special qualifications, other than a compulsion to write.
[1] This book is somewhat of a departure from his other major work, HOW-2 Meet Women:
The Shy Man's Guide to Relationships. He has also written the Software-Building HOWTO.
A Linux user since 1995 (Slackware 2.2, kernel 1.2.1), the author has emitted a few
software truffles, including the cruft one-time pad encryption utility, the mcalc mortgage
calculator, the judge Scrabble® adjudicator, and the yawl word gaming list package. He got
his start in programming using FORTRAN IV on a CDC 3800, but is not the least bit
nostalgic for those days.
Living in a secluded desert community with wife and dog, he cherishes human frailty.
Notes
[1] Those who can, do. Those who can't... get an MCSE.
36.4. Credits
Community participation made this project possible. The author gratefully acknowledges
that writing this book would have been an impossible task without help and feedback from
all you people out there.
Philippe Martin translated this document into DocBook/SGML. While not on the job at a
small French company as a software developer, he enjoys working on GNU/Linux
documentation and software, reading literature, playing music, and for his peace of mind
making merry with friends. You may run across him somewhere in France or in the Basque
Country, or email him at [email protected].
Philippe Martin also pointed out that positional parameters past $9 are possible using
{bracket} notation, see Example 5-5.
Stephane Chazelas sent a long list of corrections, additions, and example scripts. More than
a contributor, he has, in effect, taken on the role of editor for this document. Merci
beaucoup!
I would like to especially thank Patrick Callahan, Mike Novak, and Pal Domokos for
catching bugs, pointing out ambiguities, and for suggesting clarifications and changes. Their
lively discussion of shell scripting and general documentation issues inspired me to try to
make this document more readable.
I'm grateful to Jim Van Zandt for pointing out errors and omissions in version 0.2 of this
document. He also contributed an instructive example script.
Many thanks to Jordi Sanfeliu for giving permission to use his fine tree script (Example A-
17).
Likewise, thanks to Michel Charpentier for permission to use his dc factoring script
(Example 12-36).
Kudos to Noah Friedman for permission to use his string function script (Example A-18).
Emmanuel Rouat suggested corrections and additions on command substitution and aliases.
He also contributed a very nice sample .bashrc file (Appendix G).
Heiner Steven kindly gave permission to use his base conversion script, Example 12-33. He
also made a number of corrections and many helpful suggestions. Special thanks.
Rick Boivie contributed the delightfully recursive pb.sh script (Example 34-10) and
suggested performance improvements for the monthlypmt.sh script (Example 12-32).
Florian Wisser enlightened me on some of the fine points of testing strings (see Example 7-
5), and on other matters.
Hyun Jin Cha found several typos in the document in the process of doing a Korean
translation. Thanks for pointing these out.
Andreas Abraham sent in a long list of typographical errors and other corrections. Special
thanks!
Others making helpful suggestions and pointing out errors were Gabor Kiss, Leopold
Toetsch, Peter Tillier, Marcus Berglof, Tony Richardson, Nick Drage (script ideas!), Rich
Bartell, Jess Thrysoee, Adam Lazur, Bram Moolenaar, Baris Cicek, and David Lawyer
(himself an author of 4 HOWTOs).
My gratitude to Chet Ramey and Brian Fox for writing Bash, an elegant and powerful
scripting tool.
Very special thanks to the hard-working volunteers at the Linux Documentation Project. The
LDP hosts a repository of Linux knowledge and lore, and has, to a large extent, enabled the
publication of this book.
Thanks most of all to my wife, Anita, for her encouragement and emotional support.
Bibliography
Edited by Peter Denning, Computers Under Attack: Intruders, Worms, and Viruses, ACM
Press, 1990, 0-201-53067-8.
Dale Dougherty and Arnold Robbins, Sed and Awk, 2nd edition, O'Reilly and Associates,
1997, 1-156592-225-5.
To unfold the full power of shell scripting, you need at least a passing familiarity with sed
and awk. This is the standard tutorial. It includes an excellent introduction to "regular
expressions". Read this book.
Aeleen Frisch, Essential System Administration, 2nd edition, O'Reilly and Associates, 1995,
1-56592-127-5.
This excellent sys admin manual has a decent introduction to shell scripting for sys
administrators and does a nice job of explaining the startup and initialization scripts. The
book is long overdue for a third edition (are you listening, Tim O'Reilly?).
Stephen Kochan and Patrick Woods, Unix Shell Programming, Hayden, 1990, 067248448X.
Neil Matthew and Richard Stones, Beginning Linux Programming, Wrox Press, 1996,
1874416680.
Good in-depth coverage of various programming languages available for Linux, including a
fairly strong chapter on shell scripting.
Herbert Mayer, Advanced C Programming on the IBM PC, Windcrest Books, 1989,
0830693637.
Good info on shell scripting, with examples, and a short intro to Tcl and Perl.
Cameron Newham and Bill Rosenblatt, Learning the Bash Shell, 2nd edition, O'Reilly and
Associates, 1998, 1-56592-347-2.
This is a valiant effort at a decent shell primer, but somewhat deficient in coverage on
programming topics and lacking sufficient examples.
Anatole Olczak, Bourne Shell Quick Reference Guide, ASP, Inc., 1991, 093573922X.
Jerry Peek, Tim O'Reilly, and Mike Loukides, Unix Power Tools, 2nd edition, O'Reilly and
Associates, Random House, 1997, 1-56592-260-3.
but falls short of being a tutorial. It reproduces much of the regular expressions tutorial from
the Dougherty and Robbins book, above.
Clifford Pickover, Computers, Pattern, Chaos, and Beauty, St. Martin's Press, 1990, 0-312-
04123-3.
George Polya, How To Solve It, Princeton University Press, 1973, 0-691-02356-5.
Excellent Bash pocket reference (don't leave home without it). A bargain at $4.95, but also
available for free download on-line in pdf format.
Arnold Robbins, Effective Awk Programming, Free Software Foundation / O'Reilly and
Associates, 2000, 1-882114-26-4.
The absolute best awk tutorial and reference. The free electronic version of this book is part
of the awk documentation, and printed copies of the latest version are available from
O'Reilly and Associates.
This book has served as an inspiration for the author of this document.
Bill Rosenblatt, Learning the Korn Shell, O'Reilly and Associates, 1993, 1-56592-054-6.
Paul Sheer, LINUX: Rute User's Tutorial and Exposition, 1st edition, , 2002, 0-13-033351-
4.
Ellen Siever and the staff of O'Reilly and Associates, Linux in a Nutshell, 2nd edition,
O'Reilly and Associates, 1999, 1-56592-585-8.
The all-around best Linux command reference, even has a Bash section.
The UNIX CD Bookshelf, 2nd edition, O'Reilly and Associates, 2000, 1-56592-815-6.
An array of six UNIX books on CD ROM, including UNIX Power Tools, Sed and Awk, and
Learning the Korn Shell. A complete set of all the UNIX references and tutorials you would
ever need at about $70. Buy this one, even if it means going into debt and not paying the
rent.
---
Ben Okopnik's well-written introductory Bash scripting articles in issues 53, 54, 55, 57, and
59 of the Linux Gazette , and his explanation of "The Deep, Dark Secrets of Bash" in issue
56.
Chet Ramey's bash - The GNU Shell, a two-part series published in issues 3 and 4 of the
Linux Journal, July-August 1994.
Very nice sed, awk, and regular expression tutorials at The UNIX Grymoire.
The GNU gawk reference manual (gawk is the extended GNU version of awk available on
Linux and BSD systems).
There is some nice material on I/O redirection in chapter 10 of the textutils documentation at
the University of Alberta site.
Rick Hohensee has written the osimpa i386 assembler entirely as Bash scripts.
---
The excellent "Bash Reference Manual", by Chet Ramey and Brian Fox, distributed as part
of the "bash-2-doc" package (available as an rpm). See especially the instructive example
scripts in this package.
The manpages for bash and bash2, date, expect, expr, find, grep, gzip, ln, patch, tar, tr,
bc, xargs. The texinfo documentation on bash, dd, m4, gawk, and sed.
#!/bin/bash
# manview.sh: Formats the source of a man page for viewing.
# This is useful when writing man page source and you want to
# look at the intermediate results on the fly while working on it.
E_WRONGARGS=65
if [ -z "$1" ]
then
echo "Usage: `basename $0` [filename]"
exit $E_WRONGARGS
fi
exit 0
#!/bin/bash
# mail-format.sh: Format e-mail messages.
# =================================================================
# Standard Check for Script Argument(s)
ARGS=1
E_BADARGS=65
E_NOFILE=66
then
echo "Usage: `basename $0` filename"
exit $E_BADARGS
fi
exit 0
#! /bin/bash
#
# Very simpleminded filename "rename" utility (based on "lowercase.sh").
#
# The "ren" utility, by Vladimir Lanin ([email protected]),
#+ does a much better job of this.
ARGS=2
E_BADARGS=65
ONE=1 # For getting singular/plural right (see below).
if [ $# -ne "$ARGS" ]
then
echo "Usage: `basename $0` old-pattern new-pattern"
# As in "rn gif jpg", which renames all gif files in working directory to jpg.
exit $E_BADARGS
fi
exit 0
# Exercises:
# ---------
# What type of files will this not work on?
# How can this be fixed?
#
# Rewrite this script to process all the files in a directory
#+ containing spaces in their names, and to rename them,
#+ substituting an underscore for each space.
#! /bin/bash
# blank-rename.sh
#
# Substitutes underscores for blanks in all the filenames in a directory.
exit 0
Example A-5. encryptedpw: Uploading to an ftp site, using a locally encrypted password
#!/bin/bash
E_BADARGS=65
if [ -z "$1" ]
then
echo "Usage: `basename $0` filename"
exit $E_BADARGS
fi
Server="XXX"
Directory="YYY" # Change above to actual server name & directory.
bell
cd $Directory
put $Filename
bye
End-Of-Session
# -n option to "ftp" disables auto-logon.
# "bell" rings 'bell' after each file transfer.
exit 0
#!/bin/bash
# copy-cd.sh: copying a data CD
echo "Do you want to erase the image file (y/n)? " # Probably a huge file.
read answer
case "$answer" in
[yY]) rm -f $OF
echo "$OF erased."
;;
*) echo "$OF not erased.";;
esac
echo
# Exercise:
# Change the above "case" statement to also accept "yes" and "Yes" as input.
exit 0
#!/bin/bash
# collatz.sh
ARGS=1
E_BADARGS=65
MAX_ITERATIONS=200
# For large seed numbers (>32000), increase MAX_ITERATIONS.
h=$1 # Seed
echo
echo "C($1) --- $MAX_ITERATIONS Iterations"
echo
done
echo
exit 0
#!/bin/bash
# days-between.sh: Number of days between two dates.
# Usage: ./days-between.sh [M]M/[D]D/YYYY [M]M/[D]D/YYYY
{
echo "Usage: `basename $0` [M]M/[D]D/YYYY [M]M/[D]D/YYYY"
echo " (date must be after 1/3/1600)"
exit $E_PARAM_ERR
}
day=$1
month=$2
year=$3
return $dindex
Parse_Date $1
check_date $day $month $year # See if valid date.
Parse_Date $2
check_date $day $month $year
strip_leading_zero $day
day=$?
strip_leading_zero $month
month=$?
echo $diff
exit 0
# Compare this script with the implementation of Gauss' Formula in C at
# http://buschencrew.hypermart.net/software/datedif
#!/bin/bash
# makedict.sh [make dictionary]
E_BADARGS=65
exit 0
#!/bin/bash
# life.sh: "Life in the Slow Lane"
# ##################################################################### #
# This is the Bash script version of John Conway's "Game of Life". #
# "Life" is a simple implementation of cellular automata. #
# --------------------------------------------------------------------- #
# On a rectangular grid, let each "cell" be either "living" or "dead". #
# Designate a living cell with a dot, and a dead one with a blank space.#
# Begin with an arbitrarily drawn dot-and-blank grid, #
#+ and let this be the starting generation, "generation 0". #
# Determine each successive generation by the following rules: #
# 1) Each cell has 8 neighbors, the adjoining cells #
#+ left, right, top, bottom, and the 4 diagonals. #
# 123 #
# 4*5 #
# 678 #
# #
# 2) A living cell with either 2 or 3 living neighbors remains alive. #
# 3) A dead cell with 3 living neighbors becomes alive (a "birth"). #
SURVIVE=2 #
BIRTH=3 #
# 4) All other cases result in dead cells. #
# ##################################################################### #
ALIVE1=.
DEAD1=_
# Represent living and "dead" cells in the start-up file.
# =================================================================
display ()
{
declare -a arr
arr=( `echo "$1"` ) # Convert passed arg to array.
element_count=${#arr[*]}
local i
local rowcheck
cell=${arr[i]}
if [ "$cell" = . ]
then
let "alive += 1"
fi
return
local row
local lower_limit=0 # Disallow negative coordinate.
local upper_limit
local left
local right
row=$2
let "left = $row * $ROWS" # Left limit.
let "right = $left + $COLS - 1" # Right limit.
return $ALIVE
fi
then
let "count += 1"
fi
fi
done
if [ ${array[$cell_number]} = "$ALIVE1" ]
then
let "count -= 1" # Make sure value of tested cell itself
fi #+ is not counted.
return $count
local array
local i=0
if [ "$alive" -eq 0 ]
then
echo
echo "Premature exit: no more cells alive!"
exit $NONE_ALIVE # No point in continuing
fi #+ if no live cells.
# =========================================================
# main ()
echo # Title
echo "======================="
echo " $GENERATIONS generations"
echo " of"
echo "\"Life in the Slow Lane\""
echo "======================="
echo
exit 0
# --------------------------------------------------------------
# The grid in this script has a "boundary problem".
# The the top, bottom, and sides border on a void of dead cells.
# Exercise: Change the script to have the grid wrap around,
# + so that the left and right sides will "touch",
# + as will the top and bottom.
+++
The following two scripts are by Mark Moraes of the University of Toronto. See the enclosed file "Moraes-COPYRIGHT" for
permissions and restrictions.
#! /bin/sh
# Strips off the header from a mail/News message i.e. till the first
# empty line
# Mark Moraes, University of Toronto
if [ $# -eq 0 ]; then
# ==> If no command line args present, then works on file redirected to stdin.
sed -e '1,/^$/d' -e '/^[ ]*$/d'
# --> Delete empty lines and all lines until
# --> first one beginning with white space.
else
#! /bin/sh
# $Id: ftpget,v 1.2 91/05/07 21:15:43 moraes Exp $
# Script to perform batch anonymous ftp. Essentially converts a list of
# of command line arguments into input to ftp.
# Simple, and quick - written as a companion to ftplist
# -h specifies the remote host (default prep.ai.mit.edu)
# -d specifies the remote directory to cd to - you can provide a sequence
# of -d options - they will be cd'ed to in turn. If the paths are relative,
# make sure you get the sequence right. Be careful with relative paths -
# there are far too many symlinks nowadays.
# (default is the ftp login directory)
# -v turns on the verbose option of ftp, and shows all responses from the
# ftp server.
# -f remotefile[:localfile] gets the remote file into localfile
# -m pattern does an mget with the specified pattern. Remember to quote
# shell characters.
# -c does a local cd to the specified directory
# For example,
# ftpget -h expo.lcs.mit.edu -d contrib -f xplaces.shar:xplaces.sh \
# -d ../pub/R3/fixes -c ~/fixes -m 'fix*'
# will get xplaces.shar from ~ftp/contrib on expo.lcs.mit.edu, and put it in
# xplaces.sh in the current working directory, and get all fixes from
# ~ftp/pub/R3/fixes and put them in the ~/fixes directory.
# Obviously, the sequence of the options is important, since the equivalent
# commands are executed by ftp in corresponding order
#
# Mark Moraes ([email protected]), Feb 1, 1989
# ==> Angle brackets changed to parens, so Docbook won't get indigestion.
#
# PATH=/local/bin:/usr/ucb:/usr/bin:/bin
# export PATH
# ==> Above 2 lines from original script probably superfluous.
TMPFILE=/tmp/ftp.$$
# ==> Creates temp file, using process id of script ($$)
# ==> to construct filename.
SITE=`domainname`.toronto.edu
# ==> 'domainname' similar to 'hostname'
# ==> May rewrite this to parameterize this for general use.
rm -f ${TMPFILE}
# ==> Exercises:
# ==> ---------
# ==> 1) Add error checking.
# ==> 2) Add bells & whistles.
Antek Sawicki contributed the following script, which makes very clever use of the parameter substitution operators discussed
in Section 9.3.
#!/bin/bash
# May need to be invoked with #!/bin/bash2 on older machines.
#
# Random password generator for bash 2.x by Antek Sawicki <[email protected]>,
# who generously gave permission to the document author to use it here.
#
# ==> Comments added by document author ==>
MATRIX="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
LENGTH="8"
# ==> May change 'LENGTH' for longer password, of course.
# ==> ${MATRIX:$(($RANDOM%${#MATRIX})):1}
# ==> returns expansion of MATRIX at random position, by length 1.
# ==> See {var:pos:len} parameter substitution in Section 3.3.1
# ==> and following examples.
# ==> PASS=... simply pastes this result onto previous PASS (concatenation).
let n+=1
exit 0
James R. Van Zandt contributed this script, which uses named pipes and, in his words, "really exercises quoting and
escaping".
#!/bin/bash
# ==> Script by James R. Van Zandt, and used here with his permission.
# ==> The end result is this backs up the main directories, from / on down.
exit 0
Stephane Chazelas contributed the following script to demonstrate that generating prime numbers does not require arrays.
#!/bin/bash
# primes.sh: Generate prime numbers, without using arrays.
# Script contributed by Stephane Chazelas.
Primes()
{
(( n = $1 + 1 )) # Bump to next integer.
shift # Next parameter in list.
# echo "_n=$n i=$i_"
if (( n == LIMIT ))
then echo $*
return
fi
Primes 1
exit 0
#!/bin/sh
# @(#) tree 1.1 30/11/95 by Jordi Sanfeliu
# email: [email protected]
#
# Initial version: 1.0 30/11/95
# Next version : 1.1 24/02/97 Now, with symbolic links
# Patch by : Ian Kjos, to support unsearchable dirs
# email: [email protected]
#
# Tree is a tool for view the directory tree (obvious :-) )
#
# ==> 'Tree' script used here with the permission of its author, Jordi Sanfeliu.
# ==> Comments added by the author of this document.
# ==> Argument quoting added.
search () {
for dir in `echo *`
# ==> `echo *` lists all the files in current working directory, without line
breaks.
# ==> Similar effect to for dir in *
# ==> but "dir in `echo *`" will not handle filenames with blanks.
do
if [ -d "$dir" ] ; then # ==> If it is a directory (-d)...
zz=0 # ==> Temp variable, keeping track of directory level.
while [ $zz != $deep ] # Keep track of inner nested loop.
do
echo -n "| " # ==> Display vertical connector symbol,
# ==> with 2 spaces & no line feed in order to indent.
zz=`expr $zz + 1` # ==> Increment zz.
done
if [ -L "$dir" ] ; then # ==> If directory is a symbolic link...
echo "+---$dir" `ls -l $dir | sed 's/^.*'$dir' //'`
# ==> Display horiz. connector and list directory name, but...
# ==> delete date/time part of long listing.
else
echo "+---$dir" # ==> Display horizontal connector symbol...
# ==> and print directory name.
if cd "$dir" ; then # ==> If can move to subdirectory...
deep=`expr $deep + 1` # ==> Increment depth.
search # with recursivity ;-)
# ==> Function calls itself.
numdirs=`expr $numdirs + 1` # ==> Increment directory count.
fi
fi
fi
done
cd .. # ==> Up one directory level.
if [ "$deep" ] ; then # ==> If depth = 0 (returns TRUE)...
swfi=1 # ==> set flag showing that search is done.
fi
deep=`expr $deep - 1` # ==> Decrement depth.
}
# - Main -
if [ $# = 0 ] ; then
cd `pwd` # ==> No args to script, then use current working directory.
else
cd $1 # ==> Otherwise, move to indicated directory.
fi
echo "Initial directory = `pwd`"
swfi=0 # ==> Search finished flag.
deep=0 # ==> Depth of listing.
numdirs=0
zz=0
exit 0
# ==> Challenge: try to figure out exactly how this script works.
Noah Friedman gave permission to use his string function script, which essentially reproduces some of the C-library string
manipulation functions.
#!/bin/bash
# Commentary:
# Code:
#:docstring strcat:
# Usage: strcat s1 s2
#
# Strcat appends the value of variable s2 to variable s1.
#
# Example:
# a="foo"
# b="bar"
# strcat a b
# echo $a
# => foobar
#
#:end docstring:
#:docstring strncat:
# Usage: strncat s1 s2 $n
#
# Line strcat, but strncat appends a maximum of n characters from the value
# of variable s2. It copies fewer if the value of variabl s2 is shorter
# than n characters. Echoes result on stdout.
#
# Example:
# a=foo
# b=barbaz
# strncat a b 3
# echo $a
# => foobar
#
#:end docstring:
###;;;autoload
function strncat ()
{
local s1="$1"
local s2="$2"
local -i n="$3"
local s1_val s2_val
eval "$s1"=\'"${s1_val}${s2_val}"\'
# ==> eval $1='${s1_val}${s2_val}' avoids problems,
# ==> if one of the variables contains a single quote.
}
#:docstring strcmp:
# Usage: strcmp $s1 $s2
#
# Strcmp compares its arguments and returns an integer less than, equal to,
# or greater than zero, depending on whether string s1 is lexicographically
# less than, equal to, or greater than string s2.
#:end docstring:
###;;;autoload
function strcmp ()
{
[ "$1" = "$2" ] && return 0
return 1
}
#:docstring strncmp:
# Usage: strncmp $s1 $s2 $n
#
# Like strcmp, but makes the comparison by examining a maximum of n
# characters (n less than or equal to zero yields equality).
#:end docstring:
###;;;autoload
function strncmp ()
{
if [ -z "${3}" -o "${3}" -le "0" ]; then
return 0
fi
#:docstring strlen:
# Usage: strlen s
#
# Strlen returns the number of characters in string literal s.
#:end docstring:
###;;;autoload
function strlen ()
{
eval echo "\${#${1}}"
# ==> Returns the length of the value of the variable
# ==> whose name is passed as an argument.
}
#:docstring strspn:
# Usage: strspn $s1 $s2
#
# Strspn returns the length of the maximum initial segment of string s1,
# which consists entirely of characters from string s2.
#:end docstring:
###;;;autoload
function strspn ()
{
# Unsetting IFS allows whitespace to be handled as normal chars.
local IFS=
local result="${1%%[!${2}]*}"
echo ${#result}
}
#:docstring strcspn:
# Usage: strcspn $s1 $s2
#
# Strcspn returns the length of the maximum initial segment of string s1,
# which consists entirely of characters not from string s2.
#:end docstring:
###;;;autoload
function strcspn ()
{
# Unsetting IFS allows whitspace to be handled as normal chars.
local IFS=
local result="${1%%[${2}]*}"
echo ${#result}
}
#:docstring strstr:
# Usage: strstr s1 s2
#
# Strstr echoes a substring starting at the first occurrence of string s2 in
# string s1, or nothing if s2 does not occur in the string. If s2 points to
# a string of zero length, strstr echoes s1.
#:end docstring:
###;;;autoload
function strstr ()
{
# if s2 points to a string of zero length, strstr echoes s1
[ ${#2} -eq 0 ] && { echo "$1" ; return 0; }
# use the pattern matching code to strip off the match and everything
# following it
first=${1/$2*/}
#:docstring strtok:
# Usage: strtok s1 s2
#
# Strtok considers the string s1 to consist of a sequence of zero or more
# text tokens separated by spans of one or more characters from the
# separator string s2. The first call (with a non-empty string s1
# specified) echoes a string consisting of the first token on stdout. The
# function keeps track of its position in the string s1 between separate
# calls, so that subsequent calls made with the first argument an empty
# string will work through the string immediately following that token. In
# this way subsequent calls will work through the string s1 until no tokens
# remain. The separator string s2 may be different from call to call.
# When no token remains in s1, an empty value is echoed on stdout.
#:end docstring:
###;;;autoload
function strtok ()
{
:
}
#:docstring strtrunc:
# Usage: strtrunc $n $s1 {$s2} {$...}
#
# Used by many functions like strncmp to truncate arguments for comparison.
# Echoes the first n characters of each string s1 s2 ... on stdout.
#:end docstring:
###;;;autoload
function strtrunc ()
{
n=$1 ; shift
for z; do
echo "${z:0:$n}"
done
}
# provide string
# ========================================================================== #
# ==> Everything below here added by the document author.
# strcat
string0=one
string1=two
echo
echo "Testing \"strcat\" function:"
echo "Original \"string0\" = $string0"
echo "\"string1\" = $string1"
strcat string0 string1
echo "New \"string0\" = $string0"
echo
# strlen
echo
echo "Testing \"strlen\" function:"
str=123456789
echo "\"str\" = $str"
echo -n "Length of \"str\" = "
strlen str
echo
# Exercise:
# --------
# Add code to test all the other string functions above.
exit 0
#!/bin/bash
# obj-oriented.sh: Object-oriented programming in a shell script.
# Script by Stephane Chazelas.
eval "$obj_name.set_name() {
eval \"$obj_name.get_name() {
echo \$1
}\"
}"
eval "$obj_name.set_firstname() {
eval \"$obj_name.get_firstname() {
echo \$1
}\"
}"
eval "$obj_name.set_birthdate() {
eval \"$obj_name.get_birthdate() {
echo \$1
}\"
eval \"$obj_name.show_birthdate() {
echo \$(date -d \"1/1/1970 0:0:\$1 GMT\")
}\"
eval \"$obj_name.get_age() {
echo \$(( (\$(date +%s) - \$1) / 3600 / 24 / 365 ))
}\"
}"
$obj_name.set_name $name
$obj_name.set_firstname $firstname
$obj_name.set_birthdate $birthdate
}
echo
self.get_firstname # Bozo
self.get_name # Bozeman
self.get_age # 28
self.get_birthdate # 101272413
self.show_birthdate # Sat Mar 17 20:13:33 MST 1973
echo
# typeset -f
# to see the created functions (careful, it scrolls off the page).
exit 0
B.1. Sed
Sed is a non-interactive line editor. It receives text input, whether from stdin or from a file, performs certain operations on
specified lines of the input, one line at a time, then outputs the result to stdout or to a file. Within a shell script, sed is
usually one of several tool components in a pipe.
Sed determines which lines of its input that it will operate on from the address range passed to it. [1] Specify this address
range either by line number or by a pattern to match. For example, 3d signals sed to delete line 3 of the input, and
/windows/d tells sed that you want every line of the input containing a match to "windows" deleted.
Of all the operations in the sed toolkit, we will focus primarily on the three most commonly used ones. These are printing (to
stdout), deletion, and substitution.
Unless the g (global) operator is appended to a substitute command, the substitution operates only on the first instance
of a pattern match within each line.
From the command line and in a shell script, a sed operation may require quoting and certain options.
Sed uses the -e option to specify that the following string is an instruction or set of instructions. If there is only a
single instruction contained in the string, then this option may be omitted.
Notation Effect
8d Delete 8th line of input.
/^$/d Delete all blank lines.
1,/^$/d Delete from beginning of input up to, and including first blank line.
/Jones/p Print only lines containing "Jones" (with -n option).
s/Windows/Linux/ Substitute "Linux" for first instance of "Windows" found in each input line.
s/BSOD/stability/g Substitute "stability" for every instance of "BSOD" found in each input line.
s/ *$// Delete all spaces at the end of every line.
s/00*/0/g Compress all consecutive sequences of zeroes into a single zero.
/GUI/d Delete all lines containing "GUI".
s/GUI//g Delete all instances of "GUI", leaving the remainder of each line intact.
Substituting a zero-length string for another is equivalent to deleting that string within a line of input. This leaves the
remainder of the line intact. Applying s/GUI// to the line
The most important parts of any application are its GUI and sound effects
results in
The most important parts of any application are its and sound effects
The backslash represents a newline as a substitution character. In this special case, the replacement expression continues on
the next line.
s/^ */\
/g
This substitution replaces line-beginning spaces with a newline. The net result is to replace paragraph indents with a blank line
between paragraphs.
An address range followed by one or more operations may require open and closed curly brackets, with appropriate newlines.
/[0-9A-Za-z]/,/^$/{
/^$/d
}
This deletes only the first of each set of consecutive blank lines. That might be useful for single-spacing a text file, but
retaining the blank line(s) between paragraphs.
1. Example 34-1
2. Example 34-2
3. Example 12-2
4. Example A-3
5. Example 12-12
6. Example 12-20
7. Example A-12
8. Example A-17
9. Example 12-24
10. Example 10-9
11. Example 12-33
12. Example A-2
13. Example 12-10
14. Example 12-8
15. Example A-10
16. Example 17-11
For a more extensive treatment of sed, check the appropriate references in the Bibliography.
Notes
According to the table, exit codes 1 - 2, 126 - 165, and 255 [1] have special meanings, and
should therefore be avoided as user-specified exit parameters. Ending a script with exit 127
would certainly cause confusion when troubleshooting (is the error a "command not found"
or a user-defined one?). However, many scripts use an exit 1 as a general bailout upon error.
Since exit code 1 signifies so many possible errors, this might not add any additional
ambiguity, but, on the other hand, it probably would not be very informative either.
All user-defined exit codes in the accompanying examples to this document now conform to
this standard, except where overriding circumstances exist, as in Example 9-2.
Issuing a $? from the command line after a shell script exits gives results consistent
with the table above only from the Bash or sh prompt. Running the C-shell or tcsh
may give different values in some cases.
Notes
[1] Out of range exit values can result in unpredictable exit codes. For example, exit 3809
gives an exit code of 225.
A command expects the first three file descriptors to be available. The first, fd 0 (standard input, stdin), is for reading. The
other two (fd 1, stdout and fd 2, stderr) are for writing.
There is a stdin, stdout, and a stderr associated with each command. ls 2>&1 means temporarily connecting the
stderr of the ls command to the same "resource" as the shell's stdout.
By convention, a command reads its input from fd 0 (stdin), prints normal output to fd 1 (stdout), and error ouput to fd 2
(stderr). If one of those three fd's is not open, you may encounter problems:
For example, when xterm runs, it first initializes itself. Before running the user's shell, xterm opens the terminal device
(/dev/pts/<n> or something similar) three times.
At this point, Bash inherits these three file descriptors, and each command (child process) run by Bash inherits them in turn,
except when you redirect the command. Redirection means reassigning one of the file descriptors to another file (or a pipe, or
anything permissible). File descriptors may be reassigned locally (for a command, a command group, a subshell, a while or if or
case or for loop...), or globally, for the remainder of the shell (using exec).
#! /usr/bin/env bash
exec 3>&1
(
(
(
while read a; do echo "FIFO2: $a"; done < /tmp/fifo2 | tee /dev/stderr | tee
/dev/fd/4 | tee /dev/fd/5 | tee /dev/fd/6 >&7 &
exec 3> /tmp/fifo2
) 4>&1 >&3 3>&- | while read a; do echo "FD4: $a"; done 1>&3 5>&- 6>&-
) 5>&1 >&3 | while read a; do echo "FD5: $a"; done 1>&3 6>&-
) 6>&1 >&3 | while read a; do echo "FD6: $a"; done 3>&-
rm -f /tmp/fifo1 /tmp/fifo2
# For each command and subshell, figure out which fd points to what.
exit 0
Appendix E. Localization
Localization is an undocumented Bash feature.
A localized shell script echoes its text output in the language defined as the system's locale.
A Linux user in Berlin, Germany, would get script output in German, whereas his cousin in
Berlin, Maryland, would get output from the same script in English.
To create a localized script, use the following template to write all messages to the user
(error messages, prompts, etc.).
#!/bin/bash
# localized.sh
E_CDERROR=65
error()
{
printf "$@" >&2
exit $E_CDERROR
}
This lists all the localized text. (The -D option lists double-quoted strings prefixed by a $,
without executing the script.)
The --dump-po-strings option to Bash resembles the -D option, but uses gettext "po"
format.
Now, build a language.po file for each language that the script will be translated into,
specifying the msgstr. As an example:
fr.po:
#: a:6
msgid "Can't cd to %s."
msgstr "Impossible de se positionner dans le répertoire %s."
#: a:7
msgid "Enter the value: "
msgstr "Entrez la valeur : "
TEXTDOMAINDIR=/usr/local/share/locale
TEXTDOMAIN=localized.sh
If a user on a French system runs the script, she will get French messages.
With older versions of Bash or other shells, localization requires gettext, using the -
s option. In this case, the script becomes:
#!/bin/bash
# localized.sh
E_CDERROR=65
error() {
local format=$1
shift
printf "$(gettext -s "$format")" "$@" >&2
exit $E_CDERROR
}
cd $var || error "Can't cd to %s." "$var"
read -p "$(gettext -s "Enter the value: ")" var
# ...
---
1. history
2. fc
bash$ history
1 mount /mnt/cdrom
2 cd /mnt/cdrom
3 ls
...
1. $HISTCMD
2. $HISTCONTROL
3. $HISTIGNORE
4. $HISTFILE
5. $HISTFILESIZE
6. $HISTSIZE
7. !!
8. !$
9. !#
10. !N
11. !-N
12. !STRING
13. !?STRING?
14. ^STRING^string^
#!/bin/bash
# history.sh
# Attempt to use 'history' command in a script.
history
bash$ ./history.sh
(no output)
Emmanuel Rouat contributed the following very elaborate .bashrc file, written for a Linux system. He welcomes reader
feedback on it.
Study the file carefully, and feel free to reuse code snippets and functions from it in your own .bashrc file or even in your
scripts.
#===============================================================
#
# PERSONAL $HOME/.bashrc FILE for bash-2.05 (or later)
#
# This file is read (normally) by interactive shells only.
# Here is the place to define your aliases, functions and
# other interactive features like your prompt.
#
# This file was designed (originally) for Solaris.
# --> Modified for Linux.
# This bashrc file is a bit overcrowded - remember it is just
# just an example. Tailor it to your needs
#
#===============================================================
#-----------------------------------
# Source global definitions (if any)
#-----------------------------------
if [ -f /etc/bashrc ]; then
. /etc/bashrc # --> Read /etc/bashrc, if present.
fi
#-------------------------------------------------------------
# Automatic setting of $DISPLAY (if not set already)
# This works for linux and solaris - your mileage may vary....
#-------------------------------------------------------------
if [ -z ${DISPLAY:=""} ]; then
DISPLAY=$(who am i)
DISPLAY=${DISPLAY%%\!*}
if [ -n "$DISPLAY" ]; then
export DISPLAY=$DISPLAY:0.0
else
export DISPLAY=":0.0" # fallback
fi
fi
#---------------
# Some settings
#---------------
set -o notify
set -o noclobber
set -o ignoreeof
set -o nounset
#set -o xtrace # useful for debuging
shopt -s cdspell
shopt -s cdable_vars
shopt -s checkhash
shopt -s checkwinsize
shopt -s mailwarn
shopt -s sourcepath
shopt -s no_empty_cmd_completion
shopt -s histappend histreedit
shopt -s extglob # useful for programmable completion
#-----------------------
# Greeting, motd etc...
#-----------------------
#---------------
# Shell prompt
#---------------
function fastprompt()
{
unset PROMPT_COMMAND
case $TERM in
*term | rxvt )
PS1="[\h] \W > \[\033]0;[\u@\h] \w\007\]" ;;
*)
PS1="[\h] \W > " ;;
esac
}
function powerprompt()
{
_powerprompt()
{
LOAD=$(uptime|sed -e "s/.*: \([^,]*\).*/\1/" -e "s/ //g")
TIME=$(date +%H:%M)
}
PROMPT_COMMAND=_powerprompt
case $TERM in
*term | rxvt )
PS1="${cyan}[\$TIME \$LOAD]$NC\n[\h \#] \W > \[\033]0;[\u@\h] \w\007\]"
;;
linux )
PS1="${cyan}[\$TIME - \$LOAD]$NC\n[\h \#] \w > " ;;
* )
PS1="[\$TIME - \$LOAD]\n[\h \#] \w > " ;;
esac
}
#===============================================================
#
# ALIASES AND FUNCTIONS
#
# Arguably, some functions defined here are quite big
# (ie 'lowercase') but my workstation has 512Meg of RAM, so .....
# If you want to make this file smaller, these functions can
# be converted into scripts.
#
# Many functions were taken (almost) straight from the bash-2.04
# examples.
#
#===============================================================
#-------------------
# Personnal Aliases
#-------------------
alias h='history'
# The 'ls' family (this assumes you use the GNU ls)
alias ls='ls -hF --color' # add colors for filetype recognition
alias lx='ls -lXB' # sort by extension
alias lk='ls -lSr' # sort by size
alias la='ls -Al' # show hidden files
alias lr='ls -lR' # recursice ls
alias lt='ls -ltr' # sort by date
alias lm='ls -al |more' # pipe through 'more'
alias tree='tree -Cs' # nice alternative to 'ls'
# tailoring 'less'
alias more='less'
export PAGER=less
export LESSCHARSET='latin1'
export LESSOPEN='|/usr/bin/lesspipe.sh %s 2>&-' # Use this if lesspipe.sh exists
export LESS='-i -N -w -z-4 -g -e -M -X -F -R -P%t?f%f \
:stdin .?pb%pb\%:?lbLine %lb:?bbByte %bb:-...'
#----------------
# a few fun ones
#----------------
function xtitle ()
{
case $TERM in
*term | rxvt)
echo -n -e "\033]0;$*\007" ;;
*) ;;
esac
}
# aliases...
alias top='xtitle Processes on $HOST && top'
alias make='xtitle Making $(basename $PWD) ; make'
alias ncftp="xtitle ncFTP ; ncftp"
# .. and functions
function man ()
{
xtitle The $(basename $1|tr -d .[:digit:]) manual
man -a "$*"
}
function ll(){ ls -l "$@"| egrep "^d" ; ls -lXB "$@" 2>&-| egrep -v "^d|total "; }
function xemacs() { { command xemacs -private $* 2>&- & } && disown ;}
function te() # wrapper around xemacs/gnuserv
{
if [ "$(gnuclient -batch -eval t 2>&-)" == "t" ]; then
gnuclient -q "$@";
else
( xemacs "$@" & );
fi
}
#-----------------------------------
# File & strings related functions:
#-----------------------------------
#-----------------------------------
# Process/system related functions:
#-----------------------------------
# Misc utilities:
function ask()
{
echo -n "$@" '[y/n] ' ; read ans
case "$ans" in
y*|Y*) return 0 ;;
*) return 1 ;;
esac
}
#=========================================================================
#
# PROGRAMMABLE COMPLETION - ONLY SINCE BASH-2.04
# (Most are taken from the bash 2.05 documentation)
# You will in fact need bash-2.05 for some features
#
#=========================================================================
case "$1" in
\~*) eval cmd=$1 ;;
*) cmd="$1" ;;
esac
COMPREPLY=( $("$cmd" --help | sed -e '/--/!d' -e 's/.*--\([^ ]*\).*/--\1/'| \
grep ^"$2" |sort -u) )
}
complete -o default -F _universal_func ldd wget bash id info
_make_targets ()
{
local mdef makef gcmd cur prev i
COMPREPLY=()
cur=${COMP_WORDS[COMP_CWORD]}
prev=${COMP_WORDS[COMP_CWORD-1]}
# if we don't want to use *.mk, we can take out the cat and use
# test -f $makef and input redirection
COMPREPLY=( $(cat $makef 2>/dev/null | awk 'BEGIN {FS=":"} /^[^.# ][^=]*:/
{print $1}' | tr -s ' ' '\012' | sort -u | eval $gcmd ) )
}
_configure_func ()
{
case "$2" in
-*) ;;
*) return ;;
esac
case "$1" in
\~*) eval cmd=$1 ;;
*) cmd="$1" ;;
esac
COMPREPLY=( $("$cmd" --help | awk '{if ($1 ~ /--.*/) print $1}' | grep ^"$2" |
sort -u) )
}
# cvs(1) completion
_cvs ()
{
local cur prev
COMPREPLY=()
cur=${COMP_WORDS[COMP_CWORD]}
prev=${COMP_WORDS[COMP_CWORD-1]}
_killall ()
{
local cur prev
COMPREPLY=()
cur=${COMP_WORDS[COMP_CWORD]}
return 0
}
# Local Variables:
# mode:shell-script
# sh-shell:bash
# End:
Table H-1. Batch file keywords / variables / operators, and their shell equivalents
Batch files usually contain DOS commands. These must be translated into their UNIX
equivalents in order to convert a batch file into a shell script.
Virtually all UNIX and shell operators and commands have many more options and
enhancements than their DOS and batch file equivalents. Many DOS batch files rely
on auxiliary utilities, such as ask.com, a crippled counterpart to read.
Converting a DOS batch file into a shell script is generally straightforward, and the result
ofttimes reads better than the original.
REM VIEWDATA
@ECHO OFF
:VIEWDATA
TYPE C:\BOZO\BOOKLIST.TXT | MORE
REM SHOW ENTIRE FILE, 1 PAGE AT A TIME.
:EXIT0
#!/bin/bash
# Conversion of VIEWDATA.BAT to shell script.
DATAFILE=/home/bozo/datafiles/book-collection.data
ARGNO=1
exit 0 # :EXIT0
Ted Davis' Shell Scripts on the PC site has a set of comprehensive tutorials on the old-
fashioned art of batch file programming. Certain of his ingenious techniques could
conceivably have relevance for shell scripts.
Appendix I. Exercises
Table of Contents
I.1. Analyzing Scripts
I.2. Writing Scripts
#!/bin/bash
MAX=10000
break # What heppens when you comment out this line? Why?
done
exit 0
---
---
Analyze Example A-10, and reorganize it in a simplified and more logical style. See how
many of its variables can be eliminated and try to optimize the script to speed up its
execution time.
Alter the script so that it accepts any ordinary ASCII text file as input for its initial
"generation". The script will read the first $ROW*$COL characters, and set the occurrences
of vowels as "living" cells. Hint: be sure to translate the spaces in the input file to
underscore characters.
Easy
Perform a recursive directory listing on the user's home directory and save the information to a file. Compress the
file, have the script prompt the user to insert a floppy, then press ENTER. Finally, save the file to the floppy.
Converting for loops to while and until loops
Convert the for loops in Example 10-1 to while loops. Hint: store the data in an array and step through the array
elements.
Having already done the "heavy lifting", now convert the loops in the example to until loops.
Changing the line spacing of a text file
Write a script that reads each line of a target file, then writes the line back to stdout, but with an extra blank line
following. This has the effect of double-spacing the file.
Include all necessary code to check whether the script gets the necessary command line argument (a filename), and
whether the specified file exists.
When the script runs correctly, modify it to triple-space the target file.
Finally, write a script to remove all blank lines from the target file, single-spacing it.
Backwards Listing
Given a list of filenames as input, this script queries each target file (parsing the output of the file command) for the
type of compression used on it. Then the script automatically invokes the appropriate decompression command
(gunzip, bunzip2, unzip, uncompress, or whatever). If a target file is not compressed, the script emits a warning
message, but takes no other action on that particular file.
Unique System ID
Generate a "unique" 6-digit hexadecimal identifier for your computer. Do not use the flawed hostid command. Hint:
md5sum /etc/passwd, then select the first 6 digits of output.
Backup
Archive as a "tarball" (*.tar.gz file) all the files in your home directory tree (/home/your-name) that have
been modified in the last 24 hours. Hint: use find.
Primes
Print (to stdout) all prime numbers between 60000 and 63000. The output should be nicely formatted in columns
(hint: use printf).
Lottery Numbers
One type of lottery involves picking five different numbers, in the range of 1 - 50. Write a script that generates five
pseudorandom numbers in this range, with no duplicates. The script will give the option of echoing the numbers to
stdout or saving them to a file, along with the date and time the particular number set was generated.
Intermediate
List, one at a time, all files larger than 100K in the /home/username directory tree. Give the user the option to
delete or compress the file, then proceed to show the next one. Write to a logfile the names of all deleted files and the
deletion times.
Safe Delete
Write, as a script, a "safe" delete command, srm.sh. Filenames passed as command-line arguments to this script are
not deleted, but instead gzipped if not already compressed (use file to check), then moved to a
/home/username/trash directory. At invocation, the script checks the "trash" directory for files older than 48
hours and deletes them.
Making Change
What is the most efficient way to make change for $1.68, using only coins in common circulations (up to 25c)? It's 6
quarters, 1 dime, a nickel, and three cents.
Given any arbitrary command line input in dollars and cents ($*.??), calculate the change, using the minimum
number of coins. If your home country is not the United States, you may use your local currency units instead. The
script will need to parse the command line input, then change it to multiples of the smallest monetary unit (cents or
whatever). Hint: look at Example 23-4.
Quadratic Equations
Solve a "quadratic" equation of the form Ax^2 + Bx + C = 0. Have a script take as arguments the coefficients, A, B,
and C, and return the solutions to four decimal places.
Hint: pipe the coefficients to bc, using the well-known formula, x = ( -B +/- sqrt( B^2 - 4AC ) ) / 2A.
Sum of Matching Numbers
Find the sum of all five-digit numbers (in the range 10000 - 99999) containing exactly two out of the following set of
digits: { 4, 5, 6 }. These may repeat within the same number, and if so, they count once for each occurrence.
A "lucky number" is one whose individual digits add up to 7, in successive additions. For example, 62431 is a "lucky
number" (6 + 2 + 4 + 3 + 1 = 16, 1 + 6 = 7). Find all the "lucky numbers" between 1000 and 10000.
Alphabetizing a String
Alphabetize (in ASCII order) an arbitrary string read from the command line.
Parsing
Parse /etc/passwd, and output its contents in nice, easy-to-read tabular form.
Certain database and spreadsheet packages use save-files with comma-separated values (CSVs). Other applications
often need to parse these files.
Reformat the data and print it out to stdout in labeled, evenly-spaced columns.
Passwords
Generate pseudorandom 8-character passwords, using characters in the ranges [0-9], [A-Z], [a-z]. Each password
must contain at least two digits.
Difficult
Log all accesses to the files in /etc during the course of a single day. This information should include the filename,
user name, and access time. If any alterations to the files take place, that should be flagged. Write this data as neatly
formatted records in a logfile.
Strip Comments
Strip all comments from a shell script whose name is specified on the command line. Note that the "#! line" must not
be stripped out.
HTML Conversion
Convert a given text file to HTML. This non-interactive script automatically inserts all appropriate HTML tags into a
file specified as an argument.
Strip HTML Tags
Strip all HTML tags from a specified HTML file, then reformat it into lines between 60 and 75 characters in length.
Reset paragraph and block spacing, as appropriate, and convert HTML tables to their approximate text equivalent.
XML Conversion
Convert a text file to Morse code. Each character of the text file will be represented as a corresponding Morse code
group of dots and dashes (underscores), separated by whitespace from the next. For example, "script" ===> "... _._.
._. .. .__. _".
Hex Dump
Do a hex(adecimal) dump on a binary file specified as an argument. The output should be in neat tabular fields, with
the first field showing the address, each of the next 8 fields a 4-byte hex number, and the final field the ASCII
equivalent of the previous 8 fields.
Emulating a Shift Register
Using Example 26-6 as an inspiration, write a script that emulates a 64-bit shift register as an array. Implement
functions to load the register, shift left, and shift right. Finally, write a function that interprets the register contents as
eight 8-bit ASCII characters.
Determinant
Solve a 4 x 4 determinant.
Hidden Words
Write a "word-find" puzzle generator, a script that hides 10 input words in a 10 x 10 matrix of random letters. The
words may be hidden across, down, or diagonally.
Anagramming
Anagram 4-letter input. For example, the anagrams of word are: do or rod row word. You may use
/usr/share/dict/linux.words as the reference list.
Fog Index
The "fog index" of a passage of text estimates its reading difficulty, as a number corresponding roughly to a school
grade level. For example, a passage with a fog index of 12 should be comprehensible to anyone with 12 years of
schooling.
The Gunning version of the fog index uses the following algorithm.
Step 4 is by far the most difficult portion of the exercise. There exist various algorithms for estimating the syllable
count of a word. A rule-of-thumb formula might consider the number of letters in a word and the vowel-consonant
mix.
A strict interpretation of the Gunning Fog index does not count compound words and proper nouns as "difficult"
words, but this would enormously complicate the script.
Playfair Cipher
The Playfair Cipher encrypts text by substitution of each 2-letter "digram" (grouping). Traditionally, one would use a
5 x 5 letter scrambled alphabet code key square for the encryption and decryption.
C O D E S
A B F G H
I K L M N
P Q R T U
V W X Y Z
Each letter of the alphabet appears once, except "I" also represents
"J". The arbitrarily chosen key word, "CODES" comes first, then all the
rest of the alphabet, skipping letters already used.
TH IS IS AT OP SE CR ET ME SA GE
or
or
3) Both letters will form the corners of a rectangle within the key
square. For each letter, substitute the one on the other corner the
rectangle which lies on the same row.
T --> U
H --> G
=========================================================================
--
Please do not send the author your solutions to these exercises. There are better ways to impress him with your cleverness,
such as submitting bugfixes and suggestions for improving this book.
Appendix J. Copyright
The "Advanced Bash-Scripting Guide" is copyright, (c) 2000, by Mendel Cooper. This document may only be
distributed subject to the terms and conditions set forth in the Open Publication License (version 1.0 or later),
http://www.opencontent.org/openpub/. The following license options also apply.
Essentially, you may freely distribute this book in unaltered electronic form. You must obtain the author's
permission to distribute a substantially modified version or derivative work. The purpose of this restriction is to
preserve the artistic integrity of this document and to prevent "forking".
These are very liberal terms, and they should not hinder any legitimate distribution or use of this book. The author
especially encourages the use of this book for instructional purposes.
The commercial print rights to this book are available. Please contact the author if interested.
The author produced this book in a manner consistent with the spirit of the LDP Manifesto.
---
Hyun Jin Cha has done a Korean translation of version 1.0.11 of this book. Spanish, Portuguese, French, German,
and Chinese translations are underway. If you wish to translate this document into another language, please feel
free to do so, subject to the terms stated above. The author wishes to be notified of such efforts.
Prev Home
Writing Scripts
Do not confuse this with = and -eq, which test, rather than assign!
#!/bin/bash
echo
# Assignment
a=879
echo "The value of \"a\" is $a"
echo
echo
echo
echo
exit 0
#!/bin/bash
exit 0
Variable assignment using the $(...) mechanism (a newer method than backquotes)
# From /etc/rc.d/rc.local
R=$(cat /etc/redhat-release)
arch=$(uname -m)
#!/bin/bash
# int-or-string.sh
# Integer or string?
a=2334 # Integer.
let "a += 1"
echo "a = $a " # Integer, still.
echo
c=BB34
echo "c = $c" # BB34
d=${c/BB/23} # Transform into an integer.
echo "d = $d" # 2334
let "d += 1" # 2334 + 1 =
echo "d = $d" # 2335
exit 0
Untyped variables are both a blessing and a curse. They permit more flexibility in scripting
(enough rope to hang yourself) and make it easier to grind out lines of code. However, they
permit errors to creep in and encourage sloppy programming habits.
The burden is on the programmer to keep track of what type the script variables are. Bash will
not do it for you.
host
Searches for information about an Internet host by name or IP address, using DNS.
vrfy
Do an Internet "name server lookup" on a host by IP address. This may be run either interactively or noninteractively, i.e.,
from within a script.
dig
Similar to nslookup, do an Internet "name server lookup" on a host. May be run either interactively or noninteractively, i.e.,
from within a script.
traceroute
Trace the route taken by packets sent to a remote host. This command works within a LAN, WAN, or over the Internet. The
remote host may be specified by an IP address. The output of this command may be filtered by grep or sed in a pipe.
ping
Broadcast an "ICMP ECHO_REQUEST" packet to other machines, either on a local or remote network. This is a diagnostic
tool for testing network connections, and it should be used with caution.
A successful ping returns an exit status of 0. This can be tested for in a script.
whois
Perform a DNS (Domain Name System) lookup. The -h option permits specifying which whois server to query. See
Example 5-6.
finger
Retrieve information about a particular user on a network. Optionally, this command can display the user's ~/.plan,
~/.project, and ~/.forward files, if present.
Out of security considerations, many networks disable finger and its associated daemon. [1]
sx, rx
The sx and rx command set serves to transfer files to and from a remote host using the xmodem protocol. These are
generally part of a communications package, such as minicom.
sz, rz
The sz and rz command set serves to transfer files to and from a remote host using the zmodem protocol. Zmodem has
certain advantages over xmodem, such as greater transmission rate and resumption of interrupted file transfers. Like sx and
rx, these are generally part of a communications package.
ftp
Utility and protocol for uploading / downloading files to / from a remote host. An ftp session can be automated in a script
(see Example 17-7, Example A-5, and Example A-13).
cu
Call Up a remote system and connect as a simple terminal. This is a sort of dumbed-down version of telnet.
uucp
UNIX to UNIX copy. This is a communications package for transferring files between UNIX servers. A shell script is an
effective way to handle a uucp command sequence.
Since the advent of the Internet and e-mail, uucp seems to have faded into obscurity, but it still exists and remains perfectly
workable in situations where an Internet connection is not available or appropriate.
telnet
The telnet protocol contains security holes and should therefore probably be avoided.
rlogin
Remote login, initates a session on a remote host. This command has security issues, so use ssh instead.
rsh
Remote shell, executes command(s) on a remote host. This has security issues, so use ssh instead.
rcp
Remote copy, copies files between two different networked machines. Using rcp and similar utilities with security
implications in a shell script may not be advisable. Consider, instead, using ssh or an expect script.
ssh
Secure shell, logs onto a remote host and executes commands there. This secure replacement for telnet, rlogin, rcp,
and rsh uses identity authentication and encryption. See its manpage for details.
Local Network
write
This is a utility for terminal-to-terminal communication. It allows sending lines from your terminal (console or xterm) to
that of another user. The mesg command may, of course, be used to disable write access to a terminal
This stripped-down command-line mail client works fine as a command embedded in a script.
#!/bin/sh
# self-mailer.sh: Self-mailing script
# ========================================================================
cat $0 | mail -s "Script \"`basename $0`\" has mailed itself to you." "$1"
# ========================================================================
# --------------------------------------------
# Greetings from the self-mailing script.
# A mischievous person has run this script,
#+ which has caused it to mail itself to you.
# Apparently, some people have nothing better
#+ to do with their time.
# --------------------------------------------
exit 0
vacation
This utility automatically replies to e-mails that the intended recipient is on vacation and temporarily unavailable. This runs
on a network, in conjunction with sendmail, and is not applicable to a dial-up POPmail account.
Notes
[1] A daemon is a background process not attached to a terminal session. Daemons perform designated services either at
specified times or explicitly triggered by certain events.
The word "daemon" means ghost in Greek, and there is certainly something mysterious, almost supernatural, about the way
UNIX daemons silently wander about behind the scenes, carrying out their appointed tasks.
7.1.
Test Constructs
● An if/then construct tests whether the exit status of a list of commands is 0 (since 0 means "success" by
UNIX convention), and if so, executes one or more commands.
● There exists a dedicated command called [ (left bracket special character). It is a synonym for test, and a
builtin for efficiency reasons. This command considers its arguments as comparison expressions or file
tests and returns an exit status corresponding to the result of the comparison (0 for true, 1 for false).
● With version 2.02, Bash introduced the [[ ... ]] extended test command, which performs comparisons in a
manner more familiar to programmers from other languages. Note that [[ is a keyword, not a command.
The (( ... )) and let ... constructs also return an exit status of 0 if the arithmetic expressions they evaluate
expand to a non-zero value. These arithmetic expansion constructs may therefore be used to perform
arithmetic comparisons.
● An if can test any command, not just conditions enclosed within brackets.
if COMMAND_WHOSE_EXIT_STATUS_IS_0_UNLESS_ERROR_OCCURRED
then echo "Command succeeded."
else echo "Command failed."
fi
if echo "Next *if* is part of the comparison for the first *if*."
if [[ $comparison = "integer" ]]
then (( a < b ))
else
[[ $a < $b ]]
fi
then
echo '$a is less than $b'
fi
#!/bin/bash
echo
echo
echo
echo
echo
echo
echo
echo
echo
echo
echo
exit 0
if [ condition-true ]
then
command 1
command 2
...
else
# Optional (may be left out if not needed).
# Adds default code block executing if original condition tests false.
command 3
command 4
...
fi
When if and then are on same line in a condition test, a semicolon must terminate the if statement. Both if
and then are keywords. Keywords (or commands) begin statements, and before a new statement on the
same line begins, the old one must terminate.
if [ -x "$filename" ]; then
elif
elif is a contraction for else if. The effect is to nest an inner if/then construct within an outer one.
if [ condition1 ]
then
command1
command2
command3
elif [ condition2 ]
# Same as else if
then
command4
command5
else
default-command
fi
The test command is a Bash builtin which tests file types and compares strings. Therefore, in a Bash
script, test does not call the external /usr/bin/test binary, which is part of the sh-utils package.
Likewise, [ does not call /usr/bin/[, which is linked to /usr/bin/test.
#!/bin/bash
echo
if test -z "$1"
then
echo "No command-line arguments."
else
echo "First command-line argument is $1."
fi
echo
echo
echo
echo
exit 0
The [[ ]] construct is the shell equivalent of [ ]. This is the extended test command, adopted from ksh88.
No filename expansion or word splitting takes place between [[ and ]], but there is parameter expansion
and command substitution.
file=/etc/passwd
if [[ -e $file ]]
then
echo "Password file exists."
fi
Using the [[ ... ]] test construct, rather than [ ... ] can prevent many logic errors in scripts. For example, the
&&, ||, <, and > operators work within a [[ ]] test, despite giving an error within a [ ] construct.
Following an if, neither the test command nor the test brackets ( [ ] or [[ ]] ) are strictly necessary.
dir=/home/bozo
Similarly, a condition within test brackets may stand alone without an if, when used in combination with a
list construct.
var1=20
var2=22
[ "$var1" -ne "$var2" ] && echo "$var1 is not equal to $var2"
home=/home/bozo
[ -d "$home" ] || echo "$home directory does not exist."
The (( )) construct expands and evaluates an arithmetic expression. If the expression evaluates as zero, it returns an
exit status of 1, or "false". A non-zero expression returns an exit status of 0, or "true". This is in marked contrast to
using the test and [ ] constructs previously discussed.
#!/bin/bash
# Arithmetic tests.
(( 0 ))
echo "Exit status of \"(( 0 ))\" is $?." # 1
(( 1 ))
echo "Exit status of \"(( 1 ))\" is $?." # 0
(( 5 > 4 )) # true
echo $? # 0
(( 5 > 9 )) # false
echo $? # 1
exit 0
-eq
is equal to
is not equal to
is greater than
is less than
string comparison
is equal to
if [ "$a" = "$b" ]
==
is equal to
if [ "$a" == "$b" ]
# Thanks, S.C.
!=
is not equal to
if [ "$a" != "$b" ]
<
The -n test absolutely requires that the string be quoted within the test brackets. Using an
unquoted string with ! -z, or even just the unquoted string alone within test brackets (see
Example 7-5) normally works, however, this is an unsafe practice. Always quote a tested
string. [1]
#!/bin/bash
a=4
b=5
echo
if [ "$a" != "$b" ]
then
echo "$a is not equal to $b."
echo "(string comparison)"
fi
echo
exit 0
#!/bin/bash
# str-test.sh: Testing null strings and unquoted strings,
# but not strings and sealing wax, not to mention cabbages and kings...
# Using if [ ... ]
else
echo "String \"string1\" is null."
fi
# Wrong result.
# Shows $string1 as not null, although it was not initialized.
echo
echo
echo
string1=initialized
string1="a = b"
exit 0
# Also, thank you, Florian Wisser, for the "heads-up".
#!/bin/bash
NOARGS=65
NOTFOUND=66
NOTGZIP=67
filename=$1
if [ ${filename##*.} != "gz" ]
# Using bracket in variable substitution.
then
zcat $1 | most
compound comparison
-a
logical and
exp1 -a exp2 returns true if both exp1 and exp2 are true.
-o
logical or
These are similar to the Bash comparison operators && and ||, used within double brackets.
The -o and -a operators work with the test command or occur within single test brackets.
if [ "$exp1" -a "$exp2" ]
Refer to Example 8-3 and Example 26-8 to see compound comparison operators in action.
Notes
[1] As S.C. points out, in a compound test, even quoting the string variable might not suffice. [ -n
"$string" -o "$a" = "$b" ] may cause an error with some versions of Bash if $string is
empty. The safe way is to append an extra character to possibly empty variables, [ "x$string"
!= x -o "x$a" = "x$b" ] (the "x's" cancel out).
8.1. Operators
assignment
variable assignment
All-purpose assignment operator, which works for both arithmetic and string assignments.
var=27
category=minerals # No spaces allowed after the "=".
Do not confuse the "=" assignment operator with the = test operator.
# = as a test operator
if [ "$string1" = "$string2" ]
# if [ "X$string1" = "X$string2" ] is safer,
# to prevent an error message should one of the variables be empty.
# (The prepended "X" characters cancel out.)
then
command
fi
arithmetic operators
plus
-
minus
*
multiplication
/
division
**
exponentiation
let "z=5**3"
echo "z = $z" # z = 125
This operator finds use in, among other things, generating numbers within a specific range (see Example 9-21 and Example 9-
22) and formatting program output (see Example 26-7 and Example A-7). It can even be used to generate prime numbers,
(see Example A-16). Modulo turns up surprisingly often in various numerical recipes.
#!/bin/bash
# gcd.sh: greatest common divisor
# Uses Euclid's algorithm
# ------------------------------------------------------
# Argument check
ARGS=2
E_BADARGS=65
if [ $# -ne "$ARGS" ]
then
echo "Usage: `basename $0` first-number second-number"
exit $E_BADARGS
fi
# ------------------------------------------------------
gcd ()
{
# Arbitrary assignment.
gcd $1 $2
# Exercise :
# --------
# Check command-line arguments to make sure they are integers,
#+ and exit the script with an appropriate error message if not.
exit 0
+=
-=
*=
/=
%=
#!/bin/bash
# Counting to 6 in 5 different ways.
: $((n = $n + 1))
# ":" necessary because otherwise Bash attempts
#+ to interpret "$((n = $n + 1))" as a command.
echo -n "$n "
n=$(($n + 1))
echo -n "$n "
: $[ n = $n + 1 ]
# ":" necessary because otherwise Bash attempts
#+ to interpret "$[ n = $n + 1 ]" as a command.
# Works even if "n" was initialized as a string.
echo -n "$n "
n=$[ $n + 1 ]
# Works even if "n" was initialized as a string.
#* Avoid this type of construct, since it is obsolete and nonportable.
echo -n "$n "; echo
exit 0
Integer variables in Bash are actually signed long (32-bit) integers, in the range of -2147483648 to 2147483647. An
operation that takes a variable outside these limits will give an erroneous result.
a=2147483646
echo "a = $a" # a = 2147483646
let "a+=1" # Increment "a".
echo "a = $a" # a = 2147483647
let "a+=1" # increment "a" again, past the limit.
echo "a = $a" # a = -2147483648
# ERROR (out of range)
Bash does not understand floating point arithmetic. It treats numbers containing a decimal point as strings.
a=1.5
Use bc in scripts that that need floating point calculations or math library functions.
bitwise operators. The bitwise operators seldom make an appearance in shell scripts. Their chief use seems to be manipulating and
testing values read from ports or sockets. "Bit flipping" is more relevant to compiled languages, such as C and C++, which run fast
enough to permit its use on the fly.
bitwise operators
<<
"left-shift-equal"
bitwise and
&=
"bitwise and-equal"
|
bitwise OR
|=
"bitwise OR-equal"
~
bitwise negate
!
bitwise NOT
^
bitwise XOR
^=
"bitwise XOR-equal"
logical operators
&&
and (logical)
&& may also, depending on context, be used in an and list to concatenate commands.
||
or (logical)
if [ $condition1 ] || [ $condition2 ]
# Same as: if [ $condition1 -o $condition2 ]
# Returns true if either condition1 or condition2 holds true...
Bash tests the exit status of each statement linked with a logical operator.
#!/bin/bash
a=24
b=47
a=rhino
b=crocodile
if [ "$a" = rhino ] && [ "$b" = crocodile ]
then
echo "Test #5 succeeds."
else
echo "Test #5 fails."
fi
exit 0
bash$ echo $(( 1 && 2 )) $((3 && 0)) $((4 || 0)) $((0 || 0))
1 0 1 0
miscellaneous operators
comma operator
The comma operator chains together two or more arithmetic operations. All the operations are evaluated (with possible side
effects), but only the last operation is returned.
The comma operator finds use mainly in for loops. See Example 10-12.
#!/bin/bash
# numbers.sh: Representation of numbers.
# Decimal
let "dec = 32"
echo "decimal number = $dec" # 32
# Nothing out of the ordinary here.
echo
# Important note:
# Using a digit out of range of the specified base notation
#+ will give an error message.
exit 0
# Thanks, Rich Bartell and Stephane Chazelas, for clarification.
String Length
${#string}
stringZ=abcABC123ABCabc
echo ${#stringZ} # 15
echo `expr length $stringZ` # 15
echo `expr "$stringZ" : '.*'` # 15
stringZ=abcABC123ABCabc
# |------|
Index
stringZ=abcABC123ABCabc
echo `expr index "$stringZ" C12` # 6
# C position.
Substring Extraction
${string:position}
If the $string parameter is "*" or "@", then this extracts the positional parameters, [1] starting at $position.
${string:position:length}
stringZ=abcABC123ABCabc
# 0123456789.....
# 0-based indexing.
If the $string parameter is "*" or "@", then this extracts a maximum of $length positional parameters, starting at
$position.
stringZ=abcABC123ABCabc
# 123456789......
# 1-based indexing.
stringZ=abcABC123ABCabc
# =======
stringZ=abcABC123ABCabc
# ======
Substring Removal
${string#substring}
stringZ=abcABC123ABCabc
# |----|
# |----------|
${string%substring}
stringZ=abcABC123ABCabc
# ||
# |------------|
echo ${stringZ%%b*c} # a
# Strip out longest match between 'b' and 'c', from back of $stringZ.
#!/bin/bash
# cvt.sh:
# Converts all the MacPaint image files in a directory to "pbm" format.
OPERATION=macptopbm
SUFFIX=pbm # New filename suffix.
if [ -n "$1" ]
then
directory=$1 # If directory name given as a script argument...
else
directory=$PWD # Otherwise use current working directory.
fi
# Assumes all files in the target directory are MacPaint image files,
# + with a ".mac" suffix.
exit 0
Substring Replacement
${string/substring/replacement}
${string//substring/replacement}
stringZ=abcABC123ABCabc
${string/#substring/replacement}
${string/%substring/replacement}
stringZ=abcABC123ABCabc
#!/bin/bash
# substring-extraction.sh
String=23skidoo1
# 012345678 Bash
# 123456789 awk
# Note different string indexing system:
# Bash numbers first character of string as '0'.
# Awk numbers first character of string as '1'.
exit 0
1. Example 12-6
2. Example 9-13
3. Example 9-14
4. Example 9-15
5. Example 9-17
Notes
[1] This applies to either command line arguments or parameters passed to a function.
${parameter}
Same as $parameter, i.e., value of the variable parameter. In certain contexts, only the less ambiguous
${parameter} form works.
your_id=${USER}-on-${HOSTNAME}
echo "$your_id"
#
echo "Old \$PATH = $PATH"
PATH=${PATH}:/opt/bin #Add /opt/bin to $PATH for duration of script.
echo "New \$PATH = $PATH"
${parameter-default}
echo ${username-`whoami`}
# Echoes the result of `whoami`, if variable $username is still unset.
#!/bin/bash
username0=
# username0 has been declared, but is set to null.
echo "username0 = ${username0-`whoami`}"
# Will not echo.
username2=
# username2 has been declared, but is set to null.
echo "username2 = ${username2:-`whoami`}"
# Will echo because of :- rather than just - in condition test.
exit 0
${parameter=default}, ${parameter:=default}
Both forms nearly equivalent. The : makes a difference only when $parameter has been declared and is null, [1] as
above.
echo ${username=`whoami`}
# Variable "username" is now set to `whoami`.
${parameter+alt_value}, ${parameter:+alt_value}
Both forms nearly equivalent. The : makes a difference only when parameter has been declared and is null, see
below.
a=${param1+xyz}
echo "a = $a" # a =
param2=
a=${param2+xyz}
echo "a = $a" # a = xyz
param3=123
a=${param3+xyz}
echo "a = $a" # a = xyz
echo
echo "###### \${parameter:+alt_value} ########"
echo
a=${param4:+xyz}
echo "a = $a" # a =
param5=
a=${param5:+xyz}
echo "a = $a" # a =
# Different result from a=${param5+xyz}
param6=123
a=${param6+xyz}
echo "a = $a" # a = xyz
${parameter?err_msg}, ${parameter:?err_msg}
Both forms nearly equivalent. The : makes a difference only when parameter has been declared and is null, as above.
#!/bin/bash
# ------------------------------------------------------
ThisVariable=Value-of-ThisVariable
# Note, by the way, that string variables may be set
#+ to characters disallowed in their names.
: ${ThisVariable?}
echo "Value of ThisVariable is $ThisVariable".
echo
echo
echo "You will not see this message, because script terminated above."
HERE=0
exit $HERE # Will *not* exit here.
Parameter substitution and/or expansion. The following expressions are the complement to the match in expr string
operations (see Example 12-6). These particular ones are used mostly in parsing file path names.
${#var}
String length (number of characters in $var). For an array, ${#array} is the length of the first element in the
array.
Exceptions:
#!/bin/bash
# length.sh
E_NO_ARGS=65
var01=abcdEFGH28ij
exit 0
${var#Pattern}, ${var##Pattern}
Remove from $var the shortest/longest part of $Pattern that matches the front end of $var.
${var%Pattern}, ${var%%Pattern}
Remove from $var the shortest/longest part of $Pattern that matches the back end of $var.
#!/bin/bash
# Pattern matching using the # ## % %% parameter substitution operators.
var1=abcd12345abc6789
pattern1=a*c # * (wild card) matches everything between a - c.
echo
echo "var1 = $var1" # abcd12345abc6789
echo "var1 = ${var1}" # abcd12345abc6789 (alternate form)
echo "Number of characters in ${var1} = ${#var1}"
echo "pattern1 = $pattern1" # a*c (everything between 'a' and 'c')
echo
echo; echo
echo
exit 0
#!/bin/bash
# rfe
# ---
ARGS=2
E_BADARGS=65
if [ $# -ne "$ARGS" ]
then
echo "Usage: `basename $0` old_file_suffix new_file_suffix"
exit $E_BADARGS
fi
exit 0
Expansion to a max of len characters of variable var, from offset pos. See Example A-14 for an example of the
creative use of this operator.
${var/Pattern/Replacement}
If Replacement is omitted, then the first match of Pattern is replaced by nothing, that is, deleted.
${var//Pattern/Replacement}
Global replacement. All matches of Pattern, within var replaced with Replacement.
As above, if Replacement is omitted, then all occurrences of Pattern are replaced by nothing, that is, deleted.
#!/bin/bash
var1=abcd-1234-defg
echo "var1 = $var1"
t=${var1#*-*}
echo "var1 (with everything, up to and including first - stripped out) = $t"
# t=${var1#*-} works just the same,
#+ since # matches the shortest string,
#+ and * matches everything preceding, including an empty string.
# (Thanks, S. C. for pointing this out.)
t=${var1##*-*}
echo "If var1 contains a \"-\", returns empty string... var1 = $t"
t=${var1%*-*}
echo "var1 (with everything from the last - on stripped out) = $t"
echo
# -------------------------------------------
path_name=/home/bozo/ideas/thoughts.for.today
# -------------------------------------------
echo "path_name = $path_name"
t=${path_name##/*/}
echo "path_name, stripped of prefixes = $t"
t=${path_name%/*.*}
# Same effect as t=`dirname $path_name`
echo "path_name, stripped of suffixes = $t"
# These will fail in some cases, such as "../", "/foo////", # "foo/", "/".
# Removing suffixes, especially when the basename has no suffix,
#+ but the dirname does, also complicates matters.
# (Thanks, S.C.)
echo
t=${path_name:11}
echo "$path_name, with first 11 chars stripped off = $t"
t=${path_name:11:5}
echo "$path_name, with first 11 chars stripped off, length 5 = $t"
echo
t=${path_name/bozo/clown}
echo "$path_name with \"bozo\" replaced by \"clown\" = $t"
t=${path_name/today/}
echo "$path_name with \"today\" deleted = $t"
t=${path_name//o/O}
echo "$path_name with all o's capitalized = $t"
t=${path_name//o/}
echo "$path_name with all o's deleted = $t"
exit 0
${var/#Pattern/Replacement}
${var/%Pattern/Replacement}
#!/bin/bash
# Pattern replacement at prefix / suffix of string.
echo
# ----------------------------------------------------
# Must match at beginning / end of string,
#+ otherwise no replacement results.
# ----------------------------------------------------
v3=${v0/#123/000} # Matches, but not at beginning.
echo "v3 = $v3" # abc1234zip1234abc
# NO REPLACEMENT.
v4=${v0/%123/000} # Matches, but not at end.
echo "v4 = $v4" # abc1234zip1234abc
# NO REPLACEMENT.
exit 0
${!varprefix*}, ${!varprefix@}
xyz23=whatever
xyz24=
Notes
[1] If $parameter is null in a non-interactive script, it will terminate with a 127 exit status (the Bash error code code for
"command not found").
#!/bin/bash
# Indirect variable referencing.
a=letter_of_alphabet
letter_of_alphabet=z
echo
# Direct reference.
echo "a = $a"
# Indirect reference.
eval a=\$$a
echo "Now a = $a"
echo
t=table_cell_3
table_cell_3=24
echo "\"table_cell_3\" = $table_cell_3"
echo -n "dereferenced \"t\" = "; eval echo \$$t
# In this simple case,
# eval t=\$$t; echo "\"t\" = $t"
# also works (why?).
echo
t=table_cell_3
NEW_VAL=387
table_cell_3=$NEW_VAL
echo "Changing value of \"table_cell_3\" to $NEW_VAL."
echo "\"table_cell_3\" now $table_cell_3"
echo -n "dereferenced \"t\" now "; eval echo \$$t
# "eval" takes the two arguments "echo" and "\$$t" (set equal to $table_cell_3)
echo
# Another method is the ${!t} notation, discussed in "Bash, version 2" section.
# See also example "ex78.sh".
exit 0
#!/bin/bash
ARGS=2
E_WRONGARGS=65
filename=$1
column_number=$2
" "$filename"
# ------------------------------------------------
# End awk script.
exit 0
This method of indirect referencing is a bit tricky. If the second order variable changes its value, then the first
order variable must be properly dereferenced (as in the above example). Fortunately, the ${!variable}
notation introduced with version 2 of Bash (see Example 35-2) makes indirect referencing more intuitive.
#!/bin/bash
MAXCOUNT=10
count=1
echo
echo "$MAXCOUNT random numbers:"
echo "-----------------"
while [ "$count" -le $MAXCOUNT ] # Generate 10 ($MAXCOUNT) random integers.
do
number=$RANDOM
echo $number
let "count += 1" # Increment count.
done
echo "-----------------"
# If you need a random int within a certain range, use the 'modulo' operator.
# This returns the remainder of a division operation.
RANGE=500
echo
number=$RANDOM
let "number %= $RANGE"
echo "Random number less than $RANGE --- $number"
echo
FLOOR=200
number=0 #initialize
while [ "$number" -le $FLOOR ]
do
number=$RANDOM
done
# May combine above two techniques to retrieve random number between two limits.
number=0 #initialize
while [ "$number" -le $FLOOR ]
do
number=$RANDOM
let "number %= $RANGE" # Scales $number down within $RANGE.
done
echo "Random number between $FLOOR and $RANGE --- $number"
echo
echo
exit 0
Just how random is RANDOM? The best way to test this is to write a script that tracks the distribution of "random"
numbers generated by RANDOM. Let's roll a RANDOM die a few times...
#!/bin/bash
# How random is RANDOM?
RANDOM=$$ # Reseed the random number generator using script process ID.
print_result ()
{
echo
echo "ones = $ones"
echo "twos = $twos"
echo "threes = $threes"
echo "fours = $fours"
echo "fives = $fives"
echo "sixes = $sixes"
echo
}
update_count()
{
case "$1" in
0) let "ones += 1";; # Since die has no "zero", this corresponds to 1.
1) let "twos += 1";; # And this to 2, etc.
2) let "threes += 1";;
3) let "fours += 1";;
4) let "fives += 1";;
5) let "sixes += 1";;
esac
}
echo
do
let "die1 = RANDOM % $PIPS"
update_count $die1
let "throw += 1"
done
print_result
# The scores should distribute fairly evenly, assuming RANDOM is fairly random.
# With $MAXTHROWS at 600, all should cluster around 100, plus-or-minus 20 or so.
#
# Keep in mind that RANDOM is a pseudorandom generator,
# and not a spectacularly good one at that.
# Exercise (easy):
# ---------------
# Rewrite this script to flip a coin 1000 times.
# Choices are "HEADS" or "TAILS".
exit 0
As we have seen in the last example, it is best to "reseed" the RANDOM generator each time it is invoked. Using the same
seed for RANDOM repeats the same series of numbers. (This mirrors the behavior of the random() function in C.)
#!/bin/bash
# seeding-random.sh: Seeding the RANDOM variable.
random_numbers ()
{
count=0
while [ "$count" -lt "$MAXCOUNT" ]
do
number=$RANDOM
echo -n "$number "
let "count += 1"
done
}
echo; echo
echo; echo
echo; echo
echo; echo
# Getting fancy...
SEED=$(head -1 /dev/urandom | od -N 1 | awk '{ print $2 }')
# Pseudo-random output fetched
#+ from /dev/urandom (system pseudo-random device-file),
#+ then converted to line of printable (octal) numbers by "od",
#+ finally "awk" retrieves just one number for SEED.
RANDOM=$SEED
random_numbers
echo; echo
exit 0
The /dev/urandom device-file provides a means of generating much more "random" pseudorandom numbers
than the $RANDOM variable. dd if=/dev/urandom of=targetfile bs=1 count=XX creates a file of
well-scattered pseudorandom numbers. However, assigning these numbers to a variable in a script requires a
workaround, such as filtering through od (as in above example) or using dd (see Example 12-41).
There are also other means of generating pseudorandom numbers in a script. Awk provides a convenient means of
doing this.
#!/bin/bash
# random2.sh: Returns a pseudorandom number in the range 0 - 1.
# Uses the awk rand() function.
exit 0
# Exercises:
# ---------
# in each pass through the loop. What happens if you fail to do this?)
# 3) Same as exercise #2, above, but generate random integers this time.
#!/bin/bash
# Manipulating a variable, C-style, using the ((...)) construct.
echo
echo
echo
# -----------------
# Easter Egg alert!
# -----------------
# Chet Ramey apparently snuck a bunch of undocumented C-style constructs
#+ into Bash (actually adapted from ksh, pretty much).
# In the Bash docs, Ramey calls ((...)) shell arithmetic,
#+ but it goes far beyond that.
# Sorry, Chet, the secret is now out.
# See also "for" and "while" loops using the ((...)) construct.
exit 0
#!/bin/bash
if [ -z "$1" ]
then
Filename=names.data # Default, if no filename specified.
else
Filename=$1
fi
#+ Filename=${1:-names.data}
# can replace the above test (parameter substitution).
count=0
echo
exit 0
#!/bin/bash
if [ -z "$1" ]
then
Filename=names.data # Default, if no filename specified.
else
Filename=$1
fi
count=0
echo
exit 0
#!/bin/bash
# Same as previous example, but with "until" loop.
if [ -z "$1" ]
then
Filename=names.data # Default, if no filename specified.
else
Filename=$1
fi
exit 0
#!/bin/bash
if [ -z "$1" ]
then
Filename=names.data # Default, if no filename specified.
else
Filename=$1
fi
for name in `seq $line_count` # Recall that "seq" prints sequence of numbers.
# while [ "$name" != Smith ] -- more complicated than a "while" loop --
do
read name # Reads from $Filename, rather than stdin.
echo $name
if [ "$name" = Smith ] # Need all this extra baggage here.
then
break
fi
exit 0
We can modify the previous example to also redirect the output of the loop.
Example 16-8. Redirected for loop (both stdin and stdout redirected)
#!/bin/bash
if [ -z "$1" ]
then
Filename=names.data # Default, if no filename specified.
else
Filename=$1
fi
line_count=`wc $Filename | awk '{ print $1 }'` # Number of lines in target file.
exit 0
#!/bin/bash
if [ -z "$1" ]
then
Filename=names.data # Default, if no filename specified.
else
Filename=$1
fi
TRUE=1
exit 0
Aristotle
Belisarius
Capablanca
Euler
Goethe
Hamurabi
Jonah
Laplace
Maroczy
Purcell
Schmidt
Semmelweiss
Smith
Turing
Venn
Wilson
Znosko-Borowski
Redirecting the stdout of a code block has the effect of saving its output to a file. See Example 4-2.
16.3. Applications
Clever use of I/O redirection permits parsing and stitching together snippets of command output (see Example 11-
5). This permits generating report and log files.
#!/bin/bash
# logevents.sh, by Stephane Chazelas.
FD_DEBUG1=3
FD_DEBUG2=4
FD_DEBUG3=5
case $LOG_LEVEL in
1) exec 3>&2 4> /dev/null 5> /dev/null;;
2) exec 3>&2 4>&2 5> /dev/null;;
3) exec 3>&2 4>&2 5>&2;;
FD_LOGVARS=6
if [[ $LOG_VARS ]]
then exec 6>> /var/log/vars.log
else exec 6> /dev/null # Bury output.
fi
FD_LOGEVENTS=7
if [[ $LOG_EVENTS ]]
then
# then exec 7 >(exec gawk '{print strftime(), $0}' >> /var/log/event.log)
# Above line will not work in Bash, version 2.04.
exec 7>> /var/log/event.log # Append to "event.log".
log # Write time and date.
else exec 7> /dev/null # Bury output.
fi
exit 0
28.1. /dev
The /dev directory contains entries for the physical devices that may or may not be present in
the hardware. [1] The hard drive partitions containing the mounted filesystem(s) have entries
in /dev, as a simple df shows.
bash$ df
Filesystem 1k-blocks Used Available Use%
Mounted on
/dev/hda6 495876 222748 247527 48% /
/dev/hda1 50755 3887 44248 9% /boot
/dev/hda8 367013 13262 334803 4% /home
/dev/hda5 1714416 1123624 503704 70% /usr
Among other things, the /dev directory also contains loopback devices, such as
/dev/loop0. A loopback device is a gimmick that allows an ordinary file to be accessed as
if it were a block device. [2] This enables mounting an entire filesystem within a single large
file. See Example 13-6 and Example 13-5.
A few of the pseudo-devices in /dev have other specialized uses, such as /dev/null,
/dev/zero and /dev/urandom.
Notes
[1] The entries in /dev provide mount points for physical and virtual devices. These
entries use very little drive space.
[2] A block device reads and/or writes data in chunks, or blocks, in contrast to a character
device, which acesses data in character units. Examples of block devices are a hard
drive and CD ROM drive. An example of a character device is a keyboard.
A shell running a script is always a non-interactive shell. All the same, the script can still access its
tty. It is even possible to emulate an interactive shell in a script.
#!/bin/bash
MY_PROMPT='$ '
while :
do
echo -n "$MY_PROMPT"
read line
eval "$line"
done
exit 0
Let us consider an interactive script to be one that requires input from the user, usually with read
statements (see Example 11-2). "Real life" is actually a bit messier than that. For now, assume an
interactive script is bound to a tty, a script that a user has invoked from the console or an xterm.
Init and startup scripts are necessarily non-interactive, since they must run without human
intervention. Many administrative and system maintenance scripts are likewise non-interactive.
Unvarying repetitive tasks cry out for automation by non-interactive scripts.
Non-interactive scripts can run in the background, but interactive ones hang, waiting for input that
never comes. Handle that difficulty by having an expect script or embedded here document feed input
to an interactive script running as a background job. In the simplest case, redirect a file to supply input
to a read statement (read variable <file). These particular workarounds make possible general
If a script needs to test whether it is running in an interactive shell, it is simply a matter of finding
whether the prompt variable, $PS1 is set. (If the user is being prompted for input, then the script needs
to display a prompt.)
if [ -z $PS1 ] # no prompt?
then
# non-interactive
...
else
# interactive
...
fi
Alternatively, the script can test for the presence of option "i" in the $- flag.
case $- in
*i*) # interactive shell
;;
*) # non-interactive shell
;;
# (Courtesy of "UNIX F.A.Q.," 1993)
Scripts may be forced to run in interactive mode with the -i option or with a #!/bin/bash -
i header. Be aware that this can cause erratic script behavior or show error messages even
when no error is present.
-e
file exists
-f
file is a directory
-b
file is a pipe
-h
file is a socket
-t
This test option may be used to check whether the stdin ([ -t 0 ]) or stdout ([ -t 1 ]) in a given
script is a terminal.
-r
file has read permission (for the user running the test)
-w
file has write permission (for the user running the test)
-x
file has execute permission (for the user running the test)
-g
If a directory has the sgid flag set, then a file created within that directory belongs to the group that owns the
directory, not necessarily to the group of the user who created the file. This may be useful for a directory shared
by a workgroup.
-u
A binary owned by root with set-user-id flag set runs with root privileges, even when an ordinary user
invokes it. [1] This is useful for executables (such as pppd and cdrecord) that need to access system hardware.
Lacking the suid flag, these binaries could not be invoked by a non-root user.
-k
Commonly known as the "sticky bit", the save-text-mode flag is a special type of file permission. If a file has this
flag set, that file will be kept in cache memory, for quicker access. [2] If set on a directory, it restricts write
permission. Setting the sticky bit adds a t to the permissions on the file or directory listing.
If a user does not own a directory that has the sticky bit set, but has write permission in that directory, he can only
delete files in it that he owns. This keeps users from inadvertently overwriting or deleting each other's files in a
publicly accessible directory, such as /tmp.
-O
"not" -- reverses the sense of the tests above (returns true if condition absent).
Example 29-1, Example 10-7, Example 10-3, Example 29-3, and Example A-2 illustrate uses of the file test operators.
Notes
[1] Be aware that suid binaries may open security holes and that the suid flag has no effect on shell scripts.
[2] On modern UNIX systems, the sticky bit is no longer used for files, only on directories.
if [ condition1 ]
then
if [ condition2 ]
then
do-something # But only if both "condition1" and "condition2" valid.
fi
fi
if [ -f $HOME/.Xclients ]; then
exec $HOME/.Xclients
elif [ -f /etc/X11/xinit/Xclients ]; then
exec /etc/X11/xinit/Xclients
else
# failsafe settings. Although we should never get here
# (we provide fallbacks in Xclients as well) it can't hurt.
xclock -geometry 100x100-5+5 &
xterm -geometry 80x50-50+150 &
if [ -f /usr/bin/netscape -a -f /usr/share/doc/HTML/index.html ]; then
netscape /usr/share/doc/HTML/index.html &
fi
fi
Explain the "test" constructs in the above excerpt, then examine the entire file, /etc/X11/xinit/xinitrc,
and analyze the if/then test constructs there. You may need to refer ahead to the discussions of grep, sed, and
regular expressions.
2. Write a script that upon invocation shows the time and date, lists all logged-in users,
and gives the system uptime. The script then saves this information to a logfile.
a=8
city="New York"
# Again, all of the comparisons below are equivalent.
test "$city" \< Paris && echo "Yes, Paris is greater than $city" # Greater ASCII
order.
/bin/test "$city" \< Paris && echo "Yes, Paris is greater than $city"
[ "$city" \< Paris ] && echo "Yes, Paris is greater than $city"
[[ $city < Paris ]] && echo "Yes, Paris is greater than $city" # Need not quote
$city.
Either:
Having made the script executable, you may now test it by ./scriptname. [3] If it
begins with a "sha-bang" line, invoking the script calls the correct command interpreter to
run it.
As a final step, after testing and debugging, you would likely want to move it to
/usr/local/bin (as root, of course), to make the script available to yourself and all
other users as a system-wide executable. The script could then be invoked by simply typing
scriptname [ENTER] from the command line.
Notes
[3] Why not simply invoke the script with scriptname? If the directory you are in
($PWD) is where scriptname is located, why doesn't this work? This fails because, for
security reasons, the current directory, "." is not included in a user's $PATH. It is
therefore necessary to explicitly invoke the script in the current directory with a
./scriptname.
As it happens, many of the various shells and scripting languages seem to be converging
toward the POSIX 1003.2 standard. Invoking Bash with the --posix option or inserting a
set -o posix at the head of a script causes Bash to conform very closely to this standard.
Even lacking this measure, most Bash scripts will run as-is under ksh, and vice-versa, since
Chet Ramey has been busily porting ksh features to the latest versions of Bash.
34.4. Optimizations
Most shell scripts are quick 'n dirty solutions to non-complex problems. As such, optimizing
them for speed is not much of an issue. Consider the case, though, where a script carries out
an important task, does it well, but runs too slowly. Rewriting it in a compiled language may
not be a palatable option. The simplest fix would be to rewrite the parts of the script that
slow it down. Is it possible to apply principles of code optimization even to a lowly shell
script?
Check the loops in the script. Time consumed by repetitive operations adds up quickly. If at
all possible, remove time-consuming operations from within loops.
Use builtin commands in preference to system commands. Builtins execute faster and
usually do not launch a subshell when invoked.
Use the time and times tools to profile computation-intensive commands. Consider rewriting
time-critical code sections in C, or even in assembler.
Try to minimize file I/O. Bash is not particularly efficient at handling files, so consider
using more appropriate tools for this within the script, such as awk or Perl.
Write your scripts in a structured, coherent form, so they can be reorganized and tightened
up as necessary. Some of the optimization techniques applicable to high-level languages
may work for scripts, but others, such as loop unrolling, are mostly irrelevant. Above all,
use common sense.
For an excellent demonstration of how optimization can drastically reduce the execution
time of a script, see Example 12-32.
PASS="$PASS${MATRIX:$(($RANDOM%${#MATRIX})):1}"
# It made perfect sense when you wrote it last year, but now it's a complete mystery.
# (From Antek Sawicki's "pw.sh" script.)
#!/bin/bash
#************************************************#
# xyz.sh
# written by Bozo Bozeman
# July 05, 2001
#-------------------------------------------------------#
# cleanup_pfiles ()
# Removes all files in designated directory.
# Parameter: $target_directory
# Returns: 0 on success, $BADDIR if something went wrong.
#-------------------------------------------------------#
cleanup_pfiles ()
{
if [ ! -d "$1" ] # Test if target directory exists.
then
echo "$1 is not a directory."
return $BADDIR
fi
rm -f "$1"/*
return 0 # Success.
}
cleanup_pfiles $projectdir
exit 0
Be sure to put the #!/bin/bash at the beginning of the first line of the script, preceding any comment headers.
● Avoid using "magic numbers", [1] that is, "hard-wired" literal constants. Use meaningful variable names instead. This makes
the script easier to understand and permits making changes and updates without breaking the application.
if [ -f /var/log/messages ]
then
...
fi
# A year later, you decide to change the script to check /var/log/syslog.
# It is now necessary to manually change the script, instance by instance,
# and hope nothing breaks.
# A better way:
LOGFILE=/var/log/messages # Only line that needs to be changed.
if [ -f "$LOGFILE" ]
then
...
fi
E_WRONG_ARGS=65
...
...
exit $E_WRONG_ARGS
● Break complex scripts into simpler modules. Use functions where appropriate. See Example 35-4.
● Don't use a complex construct where a simpler one will do.
COMMAND
if [ $? -eq 0 ]
...
# Redundant and non-intuitive.
if COMMAND
...
# More concise (if perhaps not quite as legible).
Notes
[1] In this context, " magic numbers" have an entirely different meaning than the magic numbers used to designate file types.
Various researchers at Bell Labs and other sites, including M. Douglas McIlroy, Tom Duff,
and Fred Cohen have investigated the implications of shell script viruses. They conclude
that it is all to easy for even a novice, a "script kiddie", to write one. [1]
Here is yet another reason to learn scripting. Being able to look at and understand scripts
may protect your system from being hacked or damaged.
Notes
[1] See Marius van Oers' article, Unix Shell Scripting Malware, and also the Denning
reference in the bibliography.