Advanced BashScripting Guide

An indepth exploration of the art of shell scripting

Mendel Cooper

<[email protected]> 4.2.01 15 December 2006 Revision History Revision 4.0 18 Jun 2006 'WINTERBERRY' release: Major Update. Revision 4.1 08 Oct 2006 'WAXBERRY' release: Minor Update. Revision 4.2 10 Dec 2006 'SPARKLEBERRY' release: Important Update.

Revised by: mc Revised by: mc Revised by: mc

This tutorial assumes no previous knowledge of scripting or programming, but progresses rapidly toward an intermediate/advanced level of instruction . . . all the while sneaking in little snippets of UNIX wisdom and lore. It serves as a textbook, a manual for selfstudy, and a reference and source of knowledge on shell scripting techniques. The exercises and heavilycommented examples invite active reader participation, under the premise that the only way to really learn scripting is to write scripts. This book is suitable for classroom use as a general introduction to programming concepts.

The latest update of this document, as an archived, bzip2ed "tarball" including both the SGML source and rendered HTML, may be downloaded from the author's home site. A pdf version is also available. See the change log for a revision history.

Dedication
For Anita, the source of all the magic

Advanced BashScripting Guide

Table of Contents
Chapter 1. Why Shell Programming?...............................................................................................................1 Chapter 2. Starting Off With a ShaBang.......................................................................................................3 2.1. Invoking the script............................................................................................................................6 2.2. Preliminary Exercises.......................................................................................................................6 Part 2. Basics.......................................................................................................................................................7 Chapter 3. Special Characters...........................................................................................................................8 Chapter 4. Introduction to Variables and Parameters ..................................................................................26 4.1. Variable Substitution......................................................................................................................26 4.2. Variable Assignment......................................................................................................................28 . 4.3. Bash Variables Are Untyped..........................................................................................................30 4.4. Special Variable Types...................................................................................................................31 Chapter 5. Quoting...........................................................................................................................................36 5.1. Quoting Variables...........................................................................................................................36 5.2. Escaping..........................................................................................................................................38 Chapter 6. Exit and Exit Status.......................................................................................................................43 Chapter 7. Tests................................................................................................................................................45 7.1. Test Constructs...............................................................................................................................45 7.2. File test operators............................................................................................................................51 7.3. Other Comparison Operators..........................................................................................................54 7.4. Nested if/then Condition Tests.......................................................................................................59 7.5. Testing Your Knowledge of Tests..................................................................................................59 Chapter 8. Operations and Related Topics....................................................................................................61 8.1. Operators.........................................................................................................................................61 8.2. Numerical Constants.......................................................................................................................67 Part 3. Beyond the Basics.................................................................................................................................69 Chapter 9. Variables Revisited........................................................................................................................70 9.1. Internal Variables............................................................................................................................70 9.2. Manipulating Strings .......................................................................................................................87 9.2.1. Manipulating strings using awk............................................................................................93 9.2.2. Further Discussion .................................................................................................................94 9.3. Parameter Substitution....................................................................................................................94 9.4. Typing variables: declare or typeset.............................................................................................103 9.5. Indirect References to Variables...................................................................................................105 9.6. $RANDOM: generate random integer..........................................................................................108 9.7. The Double Parentheses Construct...............................................................................................117

Advanced BashScripting Guide

Table of Contents
Chapter 10. Loops and Branches..................................................................................................................119 10.1. Loops..........................................................................................................................................119 10.2. Nested Loops..............................................................................................................................130 10.3. Loop Control...............................................................................................................................131 10.4. Testing and Branching................................................................................................................134 Chapter 11. Command Substitution.............................................................................................................142 Chapter 12. Arithmetic Expansion................................................................................................................148 Chapter 13. Recess Time................................................................................................................................149 Part 4. Commands..........................................................................................................................................150 Chapter 14. Internal Commands and Builtins.............................................................................................158 14.1. Job Control Commands..............................................................................................................184 Chapter 15. External Filters, Programs and Commands...........................................................................189 15.1. Basic Commands........................................................................................................................189 15.2. Complex Commands ...................................................................................................................194 15.3. Time / Date Commands..............................................................................................................204 15.4. Text Processing Commands ........................................................................................................207 15.5. File and Archiving Commands...................................................................................................227 15.6. Communications Commands......................................................................................................243 15.7. Terminal Control Commands.....................................................................................................257 15.8. Math Commands.........................................................................................................................258 15.9. Miscellaneous Commands..........................................................................................................267 Chapter 16. System and Administrative Commands..................................................................................280 16.1. Analyzing a System Script..........................................................................................................308 Part 5. Advanced Topics .................................................................................................................................310 Chapter 17. Regular Expressions..................................................................................................................312 17.1. A Brief Introduction to Regular Expressions ..............................................................................312 17.2. Globbing.....................................................................................................................................315 Chapter 18. Here Documents.........................................................................................................................317 18.1. Here Strings................................................................................................................................326 Chapter 19. I/O Redirection ...........................................................................................................................329 19.1. Using exec ...................................................................................................................................332 19.2. Redirecting Code Blocks............................................................................................................335 19.3. Applications................................................................................................................................340 Chapter 20. Subshells.....................................................................................................................................342

ii

Advanced BashScripting Guide

Table of Contents
Chapter 21. Restricted Shells.........................................................................................................................347 Chapter 22. Process Substitution ...................................................................................................................349 Chapter 23. Functions....................................................................................................................................352 23.1. Complex Functions and Function Complexities.........................................................................354 23.2. Local Variables...........................................................................................................................364 23.2.1. Local variables help make recursion possible...................................................................366 23.3. Recursion Without Local Variables............................................................................................367 Chapter 24. Aliases.........................................................................................................................................369 Chapter 25. List Constructs...........................................................................................................................372 Chapter 26. Arrays.........................................................................................................................................375 Chapter 27. /dev and /proc.............................................................................................................................401 27.1. /dev ..............................................................................................................................................401 27.2. /proc............................................................................................................................................403 Chapter 28. Of Zeros and Nulls.....................................................................................................................408 Chapter 29. Debugging...................................................................................................................................412 Chapter 30. Options........................................................................................................................................422 Chapter 31. Gotchas.......................................................................................................................................424 Chapter 32. Scripting With Style..................................................................................................................432 32.1. Unofficial Shell Scripting Stylesheet..........................................................................................432 Chapter 33. Miscellany...................................................................................................................................435 33.1. Interactive and noninteractive shells and scripts......................................................................435 33.2. Shell Wrappers............................................................................................................................436 33.3. Tests and Comparisons: Alternatives ..........................................................................................440 33.4. Recursion....................................................................................................................................441 33.5. "Colorizing" Scripts....................................................................................................................443 33.6. Optimizations..............................................................................................................................456 33.7. Assorted Tips..............................................................................................................................457 33.8. Security Issues............................................................................................................................467 33.8.1. Infected Shell Scripts .........................................................................................................467 33.8.2. Hiding Shell Script Source................................................................................................467 33.9. Portability Issues.........................................................................................................................467 33.10. Shell Scripting Under Windows...............................................................................................468 Chapter 34. Bash, versions 2 and 3...............................................................................................................469 34.1. Bash, version 2............................................................................................................................469 34.2. Bash, version 3............................................................................................................................473 iii

Advanced BashScripting Guide

Table of Contents
Chapter 34. Bash, versions 2 and 3 34.2.1. Bash, version 3.1...............................................................................................................475 Chapter 35. Endnotes.....................................................................................................................................477 35.1. Author's Note..............................................................................................................................477 35.2. About the Author........................................................................................................................477 35.3. Where to Go For Help .................................................................................................................477 35.4. Tools Used to Produce This Book..............................................................................................478 35.4.1. Hardware...........................................................................................................................478 35.4.2. Software and Printware.....................................................................................................478 35.5. Credits.........................................................................................................................................478 Bibliography....................................................................................................................................................481 Appendix A. Contributed Scripts..................................................................................................................488 Appendix B. Reference Cards........................................................................................................................625 Appendix C. A Sed and Awk MicroPrimer ................................................................................................630 C.1. Sed................................................................................................................................................630 C.2. Awk..............................................................................................................................................633 Appendix D. Exit Codes With Special Meanings.........................................................................................636 Appendix E. A Detailed Introduction to I/O and I/O Redirection.............................................................637 Appendix F. CommandLine Options..........................................................................................................639 F.1. Standard CommandLine Options...............................................................................................639 F.2. Bash CommandLine Options.....................................................................................................640 Appendix G. Important Files.........................................................................................................................642 Appendix H. Important System Directories.................................................................................................643 Appendix I. Localization................................................................................................................................645 Appendix J. History Commands...................................................................................................................649 Appendix K. A Sample .bashrc File..............................................................................................................650 Appendix L. Converting DOS Batch Files to Shell Scripts.........................................................................662 Appendix M. Exercises...................................................................................................................................666 M.1. Analyzing Scripts........................................................................................................................666 M.2. Writing Scripts............................................................................................................................667

iv

Advanced BashScripting Guide

Table of Contents
Appendix N. Revision History.......................................................................................................................676 Appendix O. Mirror Sites ...............................................................................................................................678 Appendix P. To Do List..................................................................................................................................679 Appendix Q. Copyright..................................................................................................................................681 Notes....................................................................................................................................................682

Chapter 1. Why Shell Programming?

No programming language is perfect. There is not even a single best language; there are only languages well suited or perhaps poorly suited for particular purposes. Herbert Mayer A working knowledge of shell scripting is essential to anyone wishing to become reasonably proficient at system administration, even if they do not anticipate ever having to actually write a script. Consider that as a Linux machine boots up, it executes the shell scripts in /etc/rc.d to restore the system configuration and set up services. A detailed understanding of these startup scripts is important for analyzing the behavior of a system, and possibly modifying it. Writing shell scripts is not hard to learn, since the scripts can be built in bitesized sections and there is only a fairly small set of shellspecific 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 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 classic 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 allinone 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. According to Herbert Mayer, "a useful language needs arrays, pointers, and a generic mechanism for building data structures." By these criteria, shell scripting falls somewhat short of being "useful." Or, perhaps not. When not to use shell scripts Resourceintensive tasks, especially where speed is a factor (sorting, hashing, etc.) Procedures involving heavyduty math operations, especially floating point arithmetic, arbitrary precision calculations, or complex numbers (use C++ or FORTRAN instead) Crossplatform portability required (use C or Java instead) Complex applications, where structured programming is a necessity (need typechecking of variables, function prototypes, etc.) Missioncritical applications upon which you are betting the ranch, or the future of the company Situations where security is important, where you need to guarantee the integrity of your system and protect against intrusion, cracking, and vandalism Project consists of subcomponents with interlocking dependencies Extensive file operations required (Bash is limited to serial file access, and that only in a particularly clumsy and inefficient linebyline fashion) Need native support for multidimensional arrays Need data structures, such as linked lists or trees Need to generate or manipulate graphics or GUIs Need direct access to system hardware Chapter 1. Why Shell Programming? 1

Advanced BashScripting Guide Need port or socket I/O Need to use libraries or interface with legacy code Proprietary, closedsource applications (shell scripts put the source code right out in the open for all the world to see) If any of the above applies, consider a more powerful scripting language perhaps Perl, Tcl, Python, Ruby or possibly a highlevel 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 "BourneAgain 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 this book covers 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 an October, 1993 Usenet post by Tom Christiansen.) What follows is a tutorial on shell scripting. It relies heavily on examples to illustrate various features of the shell. The example scripts work they've been tested, insofar as was possible and some of them are even useful in real life. The reader can play with the actual working code of the examples in the source archive (scriptname.sh or scriptname.bash), [3] give them execute permission (chmod u+rx scriptname), then run them to see what happens. Should the source archive not be available, then cutandpaste from the HTML, pdf, or text rendered versions. Be aware that some of the scripts presented here introduce features before they are explained, and this may require the reader to temporarily skip ahead for enlightenment. Unless otherwise noted, the author of this book wrote the example scripts that follow.

Chapter 1. Why Shell Programming?

Chapter 2. Starting Off With a ShaBang

Shell programming is a 1950s juke box . . . Larry Wall 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.

Example 21. cleanup: A script to clean up the log files in /var/log

# 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, only 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 becomes a tool, and can easily be modified or customized for a particular application.

Example 22. cleanup: An improved cleanup script

#!/bin/bash # Proper header for a Bash script. # Cleanup, version 2 # Run as root, of course. # Insert code here to print error message and exit if not root. LOG_DIR=/var/log # Variables are better than hardcoded values. cd $LOG_DIR cat /dev/null > messages cat /dev/null > wtmp

echo "Logs cleaned up." exit # The right and proper method of "exiting" from a script.

Now that's beginning to look like a real script. But we can go even farther . . .

Example 23. cleanup: An enhanced and generalized version of above scripts.

#!/bin/bash # Cleanup, version 3 # # # Warning: This script uses quite a number of features that will be explained

Chapter 2. Starting Off With a ShaBang

Advanced BashScripting Guide

#+ later on. # By the time you've finished the first half of the book, #+ there should be nothing mysterious about it.

LOG_DIR=/var/log ROOT_UID=0 # LINES=50 # E_XCD=66 # E_NOTROOT=67 #

Only users with $UID 0 have root privileges. Default number of lines saved. Can't change directory? Nonroot exit error.

# Run as root, of course. if [ "$UID" ne "$ROOT_UID" ] then echo "Must be root to run this script." exit $E_NOTROOT fi if [ n "$1" ] # Test if command line argument present (nonempty). then lines=$1 else lines=$LINES # Default, if not specified on command line. fi

# #+ #+ # # # # # # # # # #*

Stephane Chazelas suggests the following, as a better way of checking command line arguments, but this is still a bit advanced for this stage of the tutorial. E_WRONGARGS=65 case "$1" "" ) *[!09]*) * ) esac # Nonnumerical argument (bad arg format)

in lines=50;; echo "Usage: `basename $0` filetocleanup"; exit $E_WRONGARGS;; lines=$1;;

Skip ahead to "Loops" chapter to decipher all this.

cd $LOG_DIR if [ `pwd` != "$LOG_DIR" ] # or if [ "$PWD" != "$LOG_DIR" ] # Not in /var/log?

then echo "Can't change to $LOG_DIR." exit $E_XCD fi # Doublecheck if in right directory, before messing with log file. # far more efficient is: # # cd /var/log || { # echo "Cannot change to necessary directory." >&2 # exit $E_XCD; # }

Chapter 2. Starting Off With a ShaBang

Advanced BashScripting Guide

tail n $lines messages > mesg.temp # Saves last section of message log file. mv mesg.temp messages # Becomes new log directory.

# cat /dev/null > messages #* No longer needed, as the above method is safer. cat /dev/null > wtmp # echo "Logs cleaned up." ': > wtmp' and '> wtmp' have the same effect.

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 version of the script keeps the last section of the message log intact. You will constantly discover ways of refining previously written scripts for increased effectiveness. The shabang ( #!) 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 twobyte [4] magic number, a special marker that designates a file type, or in this case an executable shell script (type man magic for more details on this fascinating topic). Immediately following the shabang 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 following the shabang line), ignoring comments. [5]
#!/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. [6] Using #!/bin/sh, the default Bourne shell in most commercial variants of UNIX, makes the script portable to nonLinux machines, though you sacrifice Bashspecific features. The script will, however, conform to the POSIX [7] sh standard. Note that the path given at the "shabang" 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. The second example, above, requires the initial #!, since the variable assignment line, lines=50, uses a shellspecific construct. [8] Note again 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 quite an 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.
E_WRONG_ARGS=65 script_parameters="a h m z" # a = all, h = help, etc. if [ $# ne $Number_of_expected_args ]

Chapter 2. Starting Off With a ShaBang

Advanced BashScripting Guide

then echo "Usage: `basename $0` $script_parameters" # `basename $0` is the script's filename. exit $E_WRONG_ARGS fi

Many times, you will write a script that carries out one particular task. The first script in this chapter is an example of this. Later, it might occur to you to generalize the script to do other, similar tasks. Replacing the literal ("hardwired") constants by variables is a step in that direction, as is replacing repetitive code blocks by functions.

2.1. Invoking the script

Having written the script, you can invoke it by sh scriptname, [9] or alternatively bash scriptname. (Not recommended is using sh <scriptname, since this effectively disables reading from stdin within the script.) Much more convenient is to make the script itself directly executable with a chmod. Either: chmod 555 scriptname (gives everyone read/execute permission) [10] or chmod +rx scriptname (gives everyone read/execute permission) chmod u+rx scriptname (gives only the script owner read/execute permission) Having made the script executable, you may now test it by ./scriptname. [11] If it begins with a "shabang" 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 systemwide executable. The script could then be invoked by simply typing scriptname [ENTER] from the command line.

2.2. Preliminary Exercises

1. System administrators often write scripts to automate common tasks. Give several instances where such scripts would be useful. 2. Write a script that upon invocation shows the time and date, lists all loggedin users, and gives the system uptime. The script then saves this information to a logfile.

Chapter 2. Starting Off With a ShaBang

Part 2. Basics
Table of Contents 3. Special Characters 4. Introduction to Variables and Parameters 4.1. Variable Substitution 4.2. Variable Assignment 4.3. Bash Variables Are Untyped 4.4. Special Variable Types 5. Quoting 5.1. Quoting Variables 5.2. Escaping 6. Exit and Exit Status 7. Tests 7.1. Test Constructs 7.2. File test operators 7.3. Other Comparison Operators 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

Part 2. Basics

Chapter 3. Special Characters

Special Characters Found In Scripts and Elsewhere # Comments. Lines beginning with a # (with the exception of #!) are comments.
# This line is a comment.

Comments may also occur following the end of a command.

echo "A comment will follow." # Comment here. # ^ Note whitespace before #

Comments may also follow whitespace at the beginning of a line.

# A tab precedes this comment.

A command may not follow a comment on the same line. There is no method of terminating the comment, in order for "live code" to begin on the same line. Use a new line for the next command. Of course, an escaped # in an echo statement does not begin a comment. Likewise, a # appears in certain parameter substitution constructs and in numerical constant expressions.
echo echo echo echo "The # here does not begin a comment." 'The # here does not begin a comment.' The \# here does not begin a comment. The # here begins a comment. # Parameter substitution, not a comment. # Base conversion, not a comment.

echo ${PATH#*:} echo $(( 2#101011 )) # Thanks, S.C.

The standard quoting and escape characters (" ' \) escape the #. Certain pattern matching operations also use the #. ; Command separator [semicolon]. Permits putting two or more commands on the same line.
echo hello; echo there

if [ x "$filename" ]; then

# Note that "if" and "then" need separation. # Why? echo "File $filename exists."; cp $filename $filename.bak else echo "File $filename not found."; touch $filename fi; echo "File test complete."

Note that the ";" sometimes needs to be escaped. ;; Terminator in a case option [double semicolon].
case "$variable" in abc) echo "\$variable = abc" ;;

Chapter 3. Special Characters

Advanced BashScripting Guide

xyz) esac echo "\$variable = xyz" ;;

. "dot" command [period]. Equivalent to source (see Example 1422). 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$ touch .hiddenfile bash$ ls l total 10 rwrr 1 bozo rwrr 1 bozo rwrr 1 bozo

4034 Jul 18 22:04 data1.addressbook 4602 May 25 13:58 data1.addressbook.bak 877 Dec 17 2000 employment.addressbook

bash$ ls al total 14 drwxrwxrx drwx rwrr rwrr rwrr rwrwr

2 52 1 1 1 1

bozo bozo bozo bozo bozo bozo

bozo bozo bozo bozo bozo bozo

1024 3072 4034 4602 877 0

Aug Aug Jul May Dec Aug

29 29 18 25 17 29

20:54 20:51 22:04 13:58 2000 20:54

./ ../ data1.addressbook data1.addressbook.bak employment.addressbook .hiddenfile

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 5. ' full quoting [single quote]. 'STRING' preserves all special characters within STRING. This is a stronger form of quoting than using ". See also Chapter 5. , comma operator. The comma operator links together a series of arithmetic operations. All are evaluated, but only the last one is returned. Chapter 3. Special Characters 9

Advanced BashScripting Guide

let "t2 = ((a = 9, 15 / 3))" # Set "a = 9" and "t2 = 15 / 3"

\ escape [backslash]. A quoting mechanism for single characters. \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. See Chapter 5 for an indepth explanation of escaped characters. / Filename path separator [forward slash]. Separates the components of a filename (as in /home/bozo/projects/Makefile). This is also the division arithmetic operator. ` command substitution. The `command` construct makes available the output of command for assignment to a variable. This is also known as backquotes or backticks. : null command [colon]. This is the shell equivalent of a "NOP" (no op, a donothing operation). It may be considered a synonym for the shell builtin true. The ":" command is itself a Bash builtin, and its exit status is "true" (0).
: echo $?

# 0

Endless loop:
while : do operation1 operation2 ... operationn done # Same as: # while true # do # ... # done

Placeholder in if/then test:

if condition then : # Do nothing and branch ahead else takesomeaction fi

Provide a placeholder where a binary operation is expected, see Example 82 and default parameters.
: ${username=`whoami`} # ${username=`whoami`} #

Gives an error without the leading : unless "username" is a command or builtin...

Provide a placeholder where a command is expected in a here document. See Example 1810. Evaluate string of variables using parameter substitution (as in Example 915). Chapter 3. Special Characters 10

Advanced BashScripting Guide

: ${HOSTNAME?} ${USER?} ${MAIL?} # Prints error message #+ if one or more of essential environmental variables not set.

Variable expansion / substring replacement. In combination with the > redirection operator, truncates a file to zero length, without changing its permissions. If the file did not previously exist, creates it.
: > data.xxx # File "data.xxx" now empty.

# Same effect as cat /dev/null >data.xxx # However, this does not fork a new process, since ":" is a builtin.

See also Example 1514. In combination with the >> redirection operator, has no effect on a preexisting target file (: >> target_file). If the file did not previously exist, creates it. This applies to regular files, not pipes, symlinks, and certain special files. May be used to begin a comment line, although this is not recommended. Using # for a comment turns off error checking for the remainder of that line, so almost anything may appear in a comment. However, this is not the case with :.
: This is a comment that generates an error, ( if [ $x eq 3] ).

The ":" also serves as a field separator, in /etc/passwd, and in the $PATH variable.
bash$ echo $PATH /usr/local/bin:/bin:/usr/bin:/usr/X11R6/bin:/sbin:/usr/sbin:/usr/games

! reverse (or negate) the sense of a test or exit status [bang]. The ! operator inverts the exit status of the command to which it is applied (see Example 62). It also inverts the meaning of a test operator. This can, for example, change the sense of "equal" ( = ) to "notequal" ( != ). The ! operator is a Bash keyword. In a different context, the ! also appears in indirect variable references. In yet another context, from the command line, the ! invokes the Bash history mechanism (see Appendix J). Note that within a script, the history mechanism is disabled. * wild card [asterisk]. The * character serves as a "wild card" for filename expansion in globbing. By itself, it matches every filename in a given directory.
bash$ echo * absbook.sgml adddrive.sh agram.sh alias.sh

The * also represents any number (or zero) characters in a regular expression. * arithmetic operator. In the context of arithmetic operations, the * denotes multiplication. A double asterisk, **, is the exponentiation operator. ? Chapter 3. Special Characters 11

Advanced BashScripting Guide test operator. Within certain expressions, the ? indicates a test for a condition. In a double parentheses construct, the ? serves as a Cstyle trinary operator. See Example 931. In a parameter substitution expression, the ? tests whether a variable has been set. ? wild card. The ? character serves as a singlecharacter "wild card" for filename expansion in globbing, as well as representing one character in an extended regular expression. $ Variable substitution (contents of a variable).
var1=5 var2=23skidoo echo $var1 echo $var2 # 5 # 23skidoo

A $ prefixing a variable name indicates the value the variable holds. $ endofline. In a regular expression, a "$" addresses the end of a line of text. ${} 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 [12] of the script in which it appears. () command group.
(a=hello; echo $a)

A listing of commands within parentheses starts a subshell. 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; ) echo "a = $a" # a = 123 # "a" within parentheses acts like a local variable.

array initialization.
Array=(element1 element2 element3)

{xxx,yyy,zzz,...} Brace expansion.

cat {file1,file2,file3} > combined_file # Concatenates the files file1, file2, and file3 into combined_file.

Chapter 3. Special Characters

12

Advanced BashScripting Guide

cp file22.{txt,backup} # Copies "file22.txt" to "file22.backup"

A command may act upon a commaseparated list of file specs within braces. [13] Filename expansion (globbing) applies to the file specs between the braces. No spaces allowed within the braces unless the spaces are quoted or escaped. echo {file1,file2}\ :{\ A," B",' C'} file1 : A file1 : B file1 : C file2 : A file2 : B file2 : C {a..z} Extended Brace expansion.
echo {a..z} # a b c d e f g h i j k l m n o p q r s t u v w x y z # Echoes characters between a and z. echo {0..3} # 0 1 2 3 # Echoes characters between 0 and 3.

The {a..z} extended brace expansion construction is a feature introduced in version 3 of Bash. {} Block of code [curly brackets]. Also referred to as an inline group, this construct, in effect, creates an anonymous function (a function without a name). However, unlike in a "standard" function, the variables inside a code block remain visible to the remainder of the script.
bash$ { local a; a=123; } bash: local: can only be used in a function

a=123 { a=321; } echo "a = $a" # Thanks, S.C.

# a = 321

(value inside code block)

The code block enclosed in braces may have I/O redirected to and from it.

Example 31. Code blocks and I/O redirection

#!/bin/bash # Reading lines in /etc/fstab. File=/etc/fstab { read line1 read line2 } < $File echo "First line in $File is:" echo "$line1"

Chapter 3. Special Characters

13

Advanced BashScripting Guide

echo echo "Second line in $File is:" echo "$line2" exit 0 # Now, how do you parse the separate fields of each line? # Hint: use awk.

Example 32. Saving the results of a code block to a file

#!/bin/bash # rpmcheck.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` rpmfile" exit $E_NOARGS fi { # Begin code block. echo echo "Archive Description:" rpm qpi $1 # Query description. echo echo "Archive Listing:" rpm qpl $1 # Query listing. echo rpm i test $1 # Query whether rpm file can be installed. if [ "$?" eq $SUCCESS ] then echo "$1 can be installed." else echo "$1 cannot be installed." fi echo # End code block. } > "$1.test" # Redirects output of everything in block to file. echo "Results of rpm test in file $1.test" # See rpm man page for explanation of options. exit 0

Unlike a command group within (parentheses), as above, a code block enclosed by {braces} will not normally launch a subshell. [14] {} placeholder for text. Used after xargs i (replace strings option). The {} double curly brackets are a placeholder for output text.

Chapter 3. Special Characters

14

Advanced BashScripting Guide

ls . | xargs i t cp ./{} $1 # ^^ ^^ # From "ex42.sh" (copydir.sh) example.

{} \; pathname. Mostly used in find constructs. This is not a shell builtin. 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. Test expression between [[ ]]. This is a shell keyword. See the discussion on the [[ ... ]] construct. [] array element. In the context of an array, brackets set off the numbering of each element of that array.
Array[1]=slot_1 echo ${Array[1]}

[] range of characters. As part of a regular expression, brackets delineate a range of characters to match. (( )) integer expansion. Expand and evaluate integer expression between (( )). See the discussion on the (( ... )) construct. > &> >& >> < <> 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. command >&2 redirects stdout of command to stderr. scriptname >>filename appends the output of scriptname to file filename. If filename does not already exist, it is created.

Chapter 3. Special Characters

15

Advanced BashScripting Guide [i]<>filename opens file filename for reading and writing, and assigns file descriptor i to it. If filename does not exist, it is 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 159. << redirection used in a here document. <<< redirection used in a here string. <, > ASCII comparison.
veg1=carrots veg2=tomatoes if [[ "$veg1" < "$veg2" ]] then echo "Although $veg1 precede $veg2 in the dictionary," echo "this implies nothing about my culinary preferences." else echo "What kind of dictionary are you using, anyhow?" fi

\<, \> word boundary in a regular expression. bash$ grep '\<the\>' textfile | 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".

cat *.lst | sort | uniq # Merges and sorts all ".lst" files, then deletes duplicate lines.

A pipe, as a classic method of interprocess communication, sends the 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. cat $filename1 $filename2 | grep $search_word The output of a command or commands may be piped to a script. Chapter 3. Special Characters 16

Advanced BashScripting Guide

#!/bin/bash # uppercase.sh : Changes input to uppercase. tr 'az' 'AZ' # Letter ranges must be quoted #+ to prevent filename generation from singleletter filenames. exit 0

Now, let us pipe the output of ls l to this script.

bash$ ls l | ./uppercase.sh RWRWR 1 BOZO BOZO RWRWR 1 BOZO BOZO RWRR 1 BOZO BOZO 109 APR 7 19:49 1.TXT 109 APR 14 16:48 2.TXT 725 APR 20 20:56 DATAFILE

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.
cat file1 file2 | ls l | sort # The output from "cat file1 file2" disappears.

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.
bash$ sleep 10 & [1] 850 [1]+ Done

sleep 10

Within a script, commands and even loops may run in the background.

Example 33. Running a loop in the background

#!/bin/bash # backgroundloop.sh for i in 1 2 3 4 5 6 7 8 9 10 # First loop. do echo n "$i " done & # Run this loop in background. # Will sometimes execute after second loop. echo # This 'echo' sometimes will not display. # Second loop.

for i in 11 12 13 14 15 16 17 18 19 20

Chapter 3. Special Characters

17

Advanced BashScripting Guide

do echo n "$i " done echo # This 'echo' sometimes will not display.

# ====================================================== # The expected output from the script: # 1 2 3 4 5 6 7 8 9 10 # 11 12 13 14 15 16 17 18 19 20 # # # # Sometimes, though, you get: 11 12 13 14 15 16 17 18 19 20 1 2 3 4 5 6 7 8 9 10 bozo $ (The second 'echo' doesn't execute. Why?)

# Occasionally also: # 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 # (The first 'echo' doesn't execute. Why?) # Very rarely something like: # 11 12 13 1 2 3 4 5 6 7 8 9 10 14 15 16 17 18 19 20 # The foreground loop preempts the background one. exit 0 # Nasimuddin Ansari suggests adding sleep 1 #+ after the echo n "$i" in lines 6 and 14, #+ for some real fun.

A command run in the background within a script may cause the script to hang, waiting for a keystroke. Fortunately, there is a remedy for this. && AND logical operator. In a test construct, the && operator causes a return of 0 (success) only if both the linked test conditions are true. option, prefix. Option flag for a command or filter. Prefix for an operator. COMMAND [Option1][Option2][...] ls al sort dfu $filename set $variable
if [ $file1 ot $file2 ] then echo "File $file1 is older than $file2." fi if [ "$a" eq "$b" ] then echo "$a is equal to $b." fi if [ "$c" eq 24 a "$d" eq 47 ]

Chapter 3. Special Characters

18

Advanced BashScripting Guide

then echo "$c equals 24 and $d equals 47." fi

redirection from/to stdin or stdout [dash].

(cd /source/directory && tar cf . ) | (cd /dest/directory && tar xpvf ) # Move entire file tree from one directory to another # [courtesy Alan Cox <[email protected]>, with a minor change] # # # # # # # # # # # # # # # # # # # # # # # # # 1) cd /source/directory Source directory, where the files to be moved are. 2) && "Andlist": if the 'cd' operation successful, then execute the next command. 3) tar cf . The 'c' option 'tar' archiving command creates a new archive, the 'f' (file) option, followed by '' designates the target file as stdout, and do it in current directory tree ('.'). 4) | Piped to ... 5) ( ... ) a subshell 6) cd /dest/directory Change to the destination directory. 7) && "Andlist", as above 8) tar xpvf Unarchive ('x'), preserve ownership and file permissions ('p'), and send verbose messages to stdout ('v'), reading data from stdin ('f' followed by ''). Note that 'x' is a command, and 'p', 'v', 'f' are options. Whew!

# More elegant than, but equivalent to: # cd source/directory # tar cf . | (cd ../dest/directory; tar xpvf ) # # Also having same effect: # cp a /source/directory/* /dest/directory # Or: # cp a /source/directory/* /source/directory/.[^.]* /dest/directory # If there are hidden files in /source/directory. bunzip2 c linux2.6.16.tar.bz2 | tar xvf # uncompress tar file | then pass it to "tar" # If "tar" has not been patched to handle "bunzip2", #+ this needs to be done in two discrete steps, using a pipe. # The purpose of the exercise is to unarchive "bzipped" kernel source.

Note that in this context the "" is not itself a Bash operator, but rather an option recognized by certain UNIX utilities that write to stdout, such as tar, cat, etc.
bash$ echo "whatever" | cat whatever

Chapter 3. Special Characters

19

Advanced BashScripting Guide 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 fileoriented utility as a filter in a pipe.
bash$ file Usage: file [bciknvzL] [f namefile] [m magicfiles] file...

By itself on the command line, file fails with an error message. 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:

BourneAgain shell script text executable

Now the command accepts input from stdin and analyzes it. The "" can be used to pipe stdout to other commands. This permits such stunts as prepending lines to a file. Using diff to compare a file with a section of another: grep Linux file1 | diff file2 Finally, a realworld example using with tar.

Example 34. Backup of all files changed in last day

#!/bin/bash # Backs up all files in current directory modified within last 24 hours #+ in a "tarball" (tarred and gzipped file). BACKUPFILE=backup$(date +%m%d%Y) # Embeds date in backup filename. # Thanks, Joshua Tschida, for the idea. archive=${1:$BACKUPFILE} # If no backuparchive filename specified on command line, #+ it will default to "backupMMDDYYYY.tar.gz." tar cvf `find . mtime 1 type f print` > $archive.tar gzip $archive.tar echo "Directory $PWD backed up in archive file \"$archive.tar.gz\"."

# Stephane Chazelas points out that the above code will fail #+ if there are too many files found #+ or if any filenames contain blank characters. # He suggests the following alternatives:

Chapter 3. Special Characters

20

Advanced BashScripting Guide

# # find . mtime 1 type f print0 | xargs 0 tar rvf "$archive.tar" # using the GNU version of "find".

# find . mtime 1 type f exec tar rvf "$archive.tar" '{}' \; # portable to other UNIX flavors, but much slower. #

exit 0

Filenames beginning with "" may cause problems when coupled with the "" redirection operator. A script should check for this and add an appropriate prefix to such filenames, for example ./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. A cd command changes to the previous working directory. This uses the $OLDPWD environmental variable. Do not confuse the "" used in this sense with the "" redirection operator just discussed. The interpretation of the "" depends on the context in which it appears. Minus. Minus sign in an arithmetic operation. = Equals. Assignment operator
a=28 echo $a

# 28

In a different context, the "=" is a string comparison operator. + Plus. Addition arithmetic operator. In a different context, the + is a Regular Expression operator. + Option. Option flag for a command or filter. Certain commands and builtins use the + to enable certain options and the to disable them. % modulo. Modulo (remainder of a division) arithmetic operation. In a different context, the % is a pattern matching operator. ~ 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. Chapter 3. Special Characters 21

Advanced BashScripting Guide

bash$ echo ~bozo /home/bozo bash$ echo ~ /home/bozo bash$ echo ~/ /home/bozo/ bash$ echo ~: /home/bozo: bash$ echo ~nonexistentuser ~nonexistentuser

~+ current working directory. This corresponds to the $PWD internal variable. ~ previous working directory. This corresponds to the $OLDPWD internal variable. =~ regular expression match. This operator was introduced with version 3 of Bash. ^ beginningofline. In a regular expression, a "^" addresses the beginning of a line of text. Control Characters change the behavior of the terminal or text display. A control character is a CONTROL + key combination (pressed simultaneously). A control character may also be written in octal or hexadecimal notation, following an escape. Control characters are not normally useful inside a script. CtlB Backspace (nondestructive). CtlC Break. Terminate a foreground job. CtlD Log out from a shell (similar to exit). "EOF" (end of file). This also terminates input from stdin. When typing text on the console or in an xterm window, CtlD erases the character under the cursor. When there are no characters present, CtlD logs out of the session, as expected. In an xterm window, this has the effect of closing the window. CtlG "BEL" (beep). On some oldtime teletype terminals, this would actually ring a bell. CtlH "Rubout" (destructive backspace). Erases characters the cursor backs over while backspacing. Chapter 3. Special Characters 22

Advanced BashScripting Guide

#!/bin/bash # Embedding CtlH in a string. a="^H^H" echo "abcdef" echo n "abcdef$a " # Space at end ^ echo n "abcdef$a" # No space at end echo; echo # Two CtlH's (backspaces). # abcdef # abcd f ^ Backspaces twice. # abcdef Doesn't backspace (why?). # Results may not be quite as expected.

CtlI Horizontal tab. CtlJ Newline (line feed). In a script, may also be expressed in octal notation '\012' or in hexadecimal '\x0a'. CtlK Vertical tab. When typing text on the console or in an xterm window, CtlK erases from the character under the cursor to end of line. Within a script, CtlK may behave differently, as in Lee Lee Maschmeyer's example, below. CtlL Formfeed (clear the terminal screen). In a terminal, this has the same effect as the clear command. When sent to a printer, a CtlL causes an advance to end of the paper sheet. CtlM Carriage return.
#!/bin/bash # Thank you, Lee Maschmeyer, for this example. read n 1 s p \ $'ControlM leaves cursor at beginning of this line. Press Enter. \x0d' # Of course, '0d' is the hex equivalent of ControlM. echo >&2 # The 's' makes anything typed silent, #+ so it is necessary to go to new line explicitly. read n 1 s p $'ControlJ leaves cursor on next line. \x0a' # '0a' is the hex equivalent of ControlJ, linefeed. echo >&2 ### read n 1 s p $'And ControlK\x0bgoes straight down.' echo >&2 # ControlK is vertical tab. # A better example of the effect of a vertical tab is: var=$'\x0aThis is the bottom line\x0bThis is the top line\x0a' echo "$var" # This works the same way as the above example. However: echo "$var" | col

Chapter 3. Special Characters

23

Advanced BashScripting Guide

# This causes the right end of the line to be higher than the left end. # It also explains why we started and ended with a line feed #+ to avoid a garbled screen. # As Lee Maschmeyer explains: # # In the [first vertical tab example] . . . the vertical tab #+ makes the printing go straight down without a carriage return. # This is true only on devices, such as the Linux console, #+ that can't go "backward." # The real purpose of VT is to go straight UP, not down. # It can be used to print superscripts on a printer. # The col utility can be used to emulate the proper behavior of VT. exit 0

CtlQ Resume (XON). This resumes stdin in a terminal. CtlS Suspend (XOFF). This freezes stdin in a terminal. (Use CtlQ to restore input.) CtlU Erase a line of input, from the cursor backward to beginning of line. In some settings, CtlU erases the entire line of input, regardless of cursor position. CtlV When inputting text, CtlV permits inserting control characters. For example, the following two are equivalent:
echo e '\x0a' echo <CtlV><CtlJ>

CtlV is primarily useful from within a text editor. CtlW When typing text on the console or in an xterm window, CtlW erases from the character under the cursor backwards to the first instance of whitespace. In some settings, CtlW erases backwards to first nonalphanumeric character. CtlZ Pause a foreground job. Whitespace functions as a separator, separating commands or variables. Whitespace consists of either spaces, tabs, blank lines, or any combination thereof. [15] 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. Chapter 3. Special Characters 24

Advanced BashScripting Guide $IFS, the special variable separating fields of input to certain commands, defaults to whitespace. To preserve whitespace within a string or in a variable, use quoting.

Chapter 3. Special Characters

25

Chapter 4. Introduction to Variables and Parameters

Variables are how programming and scripting languages represent data. A variable is nothing more than a label, a name assigned to a location or set of locations in computer memory holding an item of data. Variables appear in arithmetic operations and manipulation of quantities, and in string parsing.

4.1. Variable Substitution

The name of a variable is a placeholder for its value, the data it holds. Referencing its value is called variable substitution. $ 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.
bash$ variable=23

bash$ echo variable variable bash$ echo $variable 23

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 295). 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 5 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).

Example 41. Variable assignment and substitution

#!/bin/bash # ex9.sh # Variables: assignment and substitution a=375 hello=$a # # No space permitted on either side of = sign when initializing variables. # What happens if there is a space?

Chapter 4. Introduction to Variables and Parameters

26

Advanced BashScripting Guide

# "VARIABLE =value" # ^ #% Script tries to run "VARIABLE" command with one argument, "=value". # "VARIABLE= value" # ^ #% Script tries to run "value" command with #+ the environmental variable "VARIABLE" set to "". #

echo hello # hello # Not a variable reference, just the string "hello" . . . echo $hello # 375 # ^ This *is* a variable reference. echo ${hello} # 375 # Also a variable reference, as above. # Quoting . . . 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" # Why? # ======================================= # Quoting a variable preserves whitespace. # ======================================= echo echo '$hello' # $hello # ^ ^ # Variable referencing disabled (escaped) by single quotes, #+ which causes the "$" to be interpreted literally. # Notice the effect of different types of quoting.

# 375 # 375

give different results.

hello= # Setting it to a null value. echo "\$hello (null value) = $hello" # Note that setting a variable to a null value is not the same as #+ unsetting it, although the end result is the same (see below). # # It is permissible to set multiple variables on the same line, #+ if separated by white space. # Caution, this may reduce legibility, and may not be portable. var1=21 var2=22 echo echo "var1=$var1 var3=$V3 var2=$var2 var3=$var3"

# May cause problems with older versions of "sh" . . .

Chapter 4. Introduction to Variables and Parameters

27

Advanced BashScripting Guide

# echo; echo numbers="one two three" # ^ ^ other_numbers="1 2 3" # ^ ^ # If there is whitespace embedded within a variable, #+ then quotes are necessary. # other_numbers=1 2 3 # Gives an error message. echo "numbers = $numbers" echo "other_numbers = $other_numbers" # other_numbers = 1 2 3 # Escaping the whitespace also works. mixed_bag=2\ \ Whatever # ^ ^ Space after escape (\). echo "$mixed_bag" echo; echo echo "uninitialized_variable = $uninitialized_variable" # Uninitialized variable has null value (no value at all!). uninitialized_variable= # Declaring, but not initializing it #+ same as setting it to a null value, as above. echo "uninitialized_variable = $uninitialized_variable" # It still has a null value. uninitialized_variable=23 # Set it. unset uninitialized_variable # Unset it. echo "uninitialized_variable = $uninitialized_variable" # It still has a null value. echo exit 0 # 2 Whatever

An uninitialized variable has a "null" value no assigned value at all (not zero!). Using a variable before assigning a value to it will usually cause problems. It is nevertheless possible to perform arithmetic operations on an uninitialized variable.
echo "$uninitialized" let "uninitialized += 5" echo "$uninitialized" # # #+ # # (blank line) # Add 5 to it. # 5

Conclusion: An uninitialized variable has no value, however it acts as if it were 0 in an arithmetic operation. This is undocumented (and probably nonportable) behavior.

See also Example 1423.

4.2. Variable Assignment

= the assignment operator (no space before and after)

Chapter 4. Introduction to Variables and Parameters

28

Advanced BashScripting Guide Do not confuse this with = and eq, which test, rather than assign! Note that = can be either an assignment or a test operator, depending on context. Example 42. Plain Variable Assignment
#!/bin/bash # Naked variables echo # When is a variable "naked", i.e., lacking the '$' in front? # When it is being assigned, rather than referenced. # Assignment a=879 echo "The value of \"a\" is $a." # Assignment using 'let' let a=16+5 echo "The value of \"a\" is now $a." echo # In a 'for' loop (really, a type of disguised assignment): echo n "Values of \"a\" in the loop are: " for a in 7 8 9 11 do echo n "$a " done echo echo # In echo read echo echo exit 0 a 'read' statement (also a type of assignment): n "Enter \"a\" " a "The value of \"a\" is now $a."

Example 43. Variable Assignment, plain and fancy

#!/bin/bash a=23 echo $a b=$a echo $b # Simple case

# Now, getting a little bit fancier (command substitution). a=`echo Hello!` # Assigns result of 'echo' command to 'a' echo $a # Note that including an exclamation mark (!) within a #+ command substitution construct #+ will not work from the command line, #+ since this triggers the Bash "history mechanism."

Chapter 4. Introduction to Variables and Parameters

29

Advanced BashScripting Guide

# Inside a script, however, the history functions are disabled. # Assigns result of 'ls l' command to 'a' # Unquoted, however, removes tabs and newlines. # The quoted variable preserves whitespace. # (See the chapter on "Quoting.")

a=`ls l` echo $a echo echo "$a"

exit 0

Variable assignment using the $(...) mechanism (a newer method than backquotes). This is actually a form of command substitution.
# From /etc/rc.d/rc.local R=$(cat /etc/redhatrelease) arch=$(uname m)

4.3. Bash Variables Are Untyped

Unlike many other programming languages, Bash does not segregate its variables by "type". Essentially, Bash variables are character strings, but, depending on context, Bash permits integer operations and comparisons on variables. The determining factor is whether the value of a variable contains only digits.

Example 44. Integer or string?

#!/bin/bash # intorstring.sh: Integer or string? a=2334 let "a += 1" echo "a = $a " echo # Integer. # a = 2335 # Integer, still.

b=${a/23/BB} echo "b = $b" declare i b echo "b = $b" let "b += 1" echo "b = $b" echo c=BB34 echo "c = $c" d=${c/BB/23} echo "d = $d" let "d += 1" echo "d = $d" echo

# # # # #

Substitute "BB" for "23". This transforms $b into a string. b = BB35 Declaring it an integer doesn't help. b = BB35

# BB35 + 1 = # b = 1

# # # # # #

c = BB34 Substitute "23" for "BB". This makes $d an integer. d = 2334 2334 + 1 = d = 2335

# What about null variables? e="" echo "e = $e" # e = let "e += 1" # Arithmetic operations allowed on a null variable?

Chapter 4. Introduction to Variables and Parameters

30

Advanced BashScripting Guide

echo "e = $e" echo # e = 1 # Null variable transformed into an integer.

# What about undeclared variables? echo "f = $f" # f = let "f += 1" # Arithmetic operations allowed? echo "f = $f" # f = 1 echo # Undeclared variable transformed into an integer.

# Variables in Bash are essentially untyped. 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.

4.4. Special Variable Types

local variables 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 environmental 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$ eval "`seq 10000 | sed e 's/.*/export var&=ZZZZZZZZZZZZZZ/'`" bash$ du bash: /usr/bin/du: Argument list too long

(Thank you, Stphane Chazelas 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 Chapter 4. Introduction to Variables and Parameters 31

Advanced BashScripting Guide 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. Definition: A child process is a subprocess launched by another process, its parent. 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. [16] After $9, the arguments must be enclosed in brackets, for example, ${10}, ${11}, ${12}. The special variables $* and $@ denote all the positional parameters.

Example 45. Positional Parameters

#!/bin/bash # Call this script with at least 10 parameters, for example # ./scriptname 1 2 3 4 5 6 7 8 9 10 MINPARAMS=10 echo echo "The name of this script is \"$0\"." # Adds ./ for current directory echo "The name of this script is \"`basename $0`\"." # Strips out path name info (see 'basename') echo if [ n "$1" ] then echo "Parameter #1 is $1" fi if [ n "$2" ] then echo "Parameter #2 is $2" fi if [ n "$3" ] then echo "Parameter #3 is $3" fi # ... # Tested variable is quoted. # Need quotes to escape #

if [ n "${10}" ] # Parameters > $9 must be enclosed in {brackets}. then echo "Parameter #10 is ${10}" fi echo "" echo "All the commandline parameters are: "$*""

Chapter 4. Introduction to Variables and Parameters

32

Advanced BashScripting Guide

if [ $# lt "$MINPARAMS" ] then echo echo "This script needs at least $MINPARAMS commandline arguments!" fi echo exit 0

Bracket notation for positional parameters leads to a fairly simple way of referencing the last argument passed to a script on the command line. This also requires indirect referencing.
args=$# # Number of args passed. lastarg=${!args} # Or: lastarg=${!#} # (Thanks, Chris Monson.) # Note that lastarg=${!$#} doesn't work.

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. See Example 152. 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_ # Rather than variable1=$1 # This will prevent an error, even if positional parameter is absent. critical_argument01=$variable1_ # The extra character can be stripped off later, like so. variable1=${variable1_/_/} # Side effects only if $variable1_ begins with an underscore. # This uses one of the parameter substitution templates discussed later. # (Leaving out the replacement pattern results in a deletion.) # A more straightforward way of dealing with this is #+ to simply test whether expected positional parameters have been passed. if [ z $1 ] then exit $E_MISSING_POS_PARAM fi

# #+ # # # #+

However, as Fabian Kreutz points out, the above method may have unexpected sideeffects. A better method is parameter substitution: ${1:$DefaultVal} See the "Parameter Substition" section in the "Variables Revisited" chapter.

Example 46. wh, whois domain name lookup

#!/bin/bash # ex18.sh

Chapter 4. Introduction to Variables and Parameters

33

Advanced BashScripting Guide

# Does a 'whois domainname' lookup on any of 3 alternate servers: # ripe.net, cw.net, radb.net # Place this script renamed 'wh' in /usr/local/bin # # # # Requires symbolic links: ln s /usr/local/bin/wh /usr/local/bin/whripe ln s /usr/local/bin/wh /usr/local/bin/whcw ln s /usr/local/bin/wh /usr/local/bin/whradb

E_NOARGS=65

if [ z "$1" ] then echo "Usage: `basename $0` [domainname]" exit $E_NOARGS fi # Check script case `basename "wh" ) "whripe") "whradb") "whcw" ) * ) esac exit $? name and call proper server. $0` in # Or: case ${0##*/} in whois [email protected];; whois [email protected];; whois [email protected];; whois [email protected];; echo "Usage: `basename $0` [domainname]";;

The shift command reassigns the positional parameters, in effect shifting them to the left one notch. $1 < $2, $2 < $3, $3 < $4, etc. 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.

Example 47. Using shift

#!/bin/bash # shft.sh: Using 'shift' to step through all the positional parameters # Name this script something like shft.sh, #+ and invoke it with some parameters. #+ For example: # sh shft.sh a b c def 23 skidoo until [ z "$1" ] do echo n "$1 " shift done echo # Until all parameters used up . . .

# Extra line feed.

Chapter 4. Introduction to Variables and Parameters

34

Advanced BashScripting Guide

exit 0 # See also the echoparams.sh script for a "shiftless" #+ alternative method of stepping through the positional params.

The shift command can take a numerical parameter indicating how many positions to shift.
#!/bin/bash # shiftpast.sh shift 3 # Shift 3 positions. # n=3; shift $n # Has the same effect. echo "$1" exit 0

$ sh shiftpast.sh 1 2 3 4 5 4

The shift command works in a similar fashion on parameters passed to a function. See Example 3315.

Chapter 4. Introduction to Variables and Parameters

35

Chapter 5. 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]* rwrwr 1 bozo bozo rwrwr 1 bozo bozo rwrwr 1 bozo bozo

324 Apr 2 15:05 VIEWDATA.BAT 507 May 4 14:25 vartrace.sh 539 Apr 14 17:11 viewdata.sh

bash$ ls l '[Vv]*' ls: [Vv]*: No such file or directory

In everyday speech or writing, when we "quote" a phrase, we set it apart and give it special meaning. In a Bash script, when we quote a string, we set it apart and protect its literal meaning. Certain programs and utilities reinterpret or expand special characters in a quoted string. An important use of quoting is protecting a commandline parameter from the shell, but still letting the calling program expand it.
bash$ grep '[Ff]irst' *.txt file1.txt:This is the first line of file1.txt. file2.txt:This is the First line of file2.txt.

Note that the unquoted grep [Ff]irst *.txt works under the Bash shell. [17] Quoting can also suppress echo's "appetite" for newlines.
bash$ echo $(ls l) total 8 rwrwr 1 bo bo 13 Aug 21 12:57 t.sh rwrwr 1 bo bo 78 Aug 21 12:57 u.sh

bash$ echo "$(ls l)" total 8 rwrwr 1 bo bo 13 Aug 21 12:57 t.sh rwrwr 1 bo bo 78 Aug 21 12:57 u.sh

5.1. Quoting Variables

When referencing a variable, it is generally advisable to enclose its name in double quotes. This prevents reinterpretation of all special characters within the quoted string the variable name [18] except $, ` (backquote), and \ (escape). [19] Keeping $ as a special character within double quotes permits referencing a quoted variable ("$variable"), that is, replacing the variable with its value (see Example 41, above). Use double quotes to prevent word splitting. [20] An argument enclosed in double quotes presents itself as a single word, even if it contains whitespace separators.
variable1="a variable containing five words" COMMAND This is $variable1 # Executes COMMAND with 7 arguments: # "This" "is" "a" "variable" "containing" "five" "words" COMMAND "This is $variable1" # Executes COMMAND with 1 argument: # "This is a variable containing five words"

Chapter 5. Quoting

36

Advanced BashScripting Guide

variable2=""

# Empty.

COMMAND $variable2 $variable2 $variable2 # Executes COMMAND with no arguments. COMMAND "$variable2" "$variable2" "$variable2" # Executes COMMAND with 3 empty arguments. COMMAND "$variable2 $variable2 $variable2" # Executes COMMAND with 1 argument (2 spaces). # Thanks, Stphane Chazelas.

Enclosing the arguments to an echo statement in double quotes is necessary only when word splitting or preservation of whitespace is an issue. Example 51. Echoing Weird Variables
#!/bin/bash # weirdvars.sh: Echoing weird variables. var="'(]\\{}\$\"" echo $var # '(]\{}$" echo "$var" # '(]\{}$" echo IFS='\' echo $var echo "$var"

Doesn't make a difference.

# '(] {}$" # '(]\{}$"

\ converted to space. Why?

# Examples above supplied by Stephane Chazelas. 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 "Why can't I write 's between single quotes" echo # The roundabout method. echo 'Why can'\''t I write '"'"'s between single quotes' # || || || # Three singlequoted strings, with escaped and quoted single quotes between. # This example courtesy of Stphane Chazelas.

Chapter 5. Quoting

37

Advanced BashScripting Guide

5.2. Escaping
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. Special meanings of certain escaped characters used with echo and sed \n means newline \r means return \t means tab \v means vertical tab \b means backspace \a means "alert" (beep or flash) \0xx translates to the octal ASCII equivalent of 0xx

Example 52. Escaped Characters

#!/bin/bash # escaped.sh: escaped characters echo; echo # Escaping a newline. # echo "" echo "This will print as two lines." # This will print # as two lines. echo "This will print \ as one line." # This will print as one line. echo; echo echo "============="

echo "\v\v\v\v" # Prints \v\v\v\v literally. # Use the e option with 'echo' to print escaped characters.

Chapter 5. Quoting

38

Advanced BashScripting Guide

echo echo echo echo "=============" "VERTICAL TABS" e "\v\v\v\v" # Prints 4 vertical tabs. "=============="

echo "QUOTATION MARK" echo e "\042" # Prints " (quote, octal ASCII character 42). echo "==============" # The $'\X' construct makes the e option unnecessary. echo; echo "NEWLINE AND BEEP" echo $'\n' # Newline. echo $'\a' # Alert (beep). echo "===============" echo "QUOTATION MARKS" # Version 2 and later of Bash permits using the $'\nnn' construct. # Note that in this case, '\nnn' is an octal value. echo $'\t \042 \t' # Quote (") framed by tabs. # It also works with hexadecimal values, in an $'\xhhh' construct. echo $'\t \x22 \t' # Quote (") framed by tabs. # Thank you, Greg Keraunen, for pointing this out. # Earlier Bash versions allowed '\x022'. echo "===============" echo

# Assigning ASCII characters to a variable. # quote=$'\042' # " assigned to a variable. echo "$quote This is a quoted string, $quote and this lies outside the quotes." echo # Concatenating ASCII chars in a variable. triple_underline=$'\137\137\137' # 137 is octal ASCII code for '_'. echo "$triple_underline UNDERLINE $triple_underline" echo ABC=$'\101\102\103\010' echo $ABC echo; echo escape=$'\033' # 033 is octal for escape. echo "\"escape\" echoes as $escape" # no visible output. echo; echo exit 0 # 101, 102, 103 are octal A, B, C.

See Example 341 for another example of the $' ' string expansion construct. \" gives the quote its literal meaning

Chapter 5. Quoting

39

Advanced BashScripting Guide

echo "Hello" echo "\"Hello\", he said." # Hello # "Hello", he said.

\$ gives the dollar sign its literal meaning (variable name following \$ will not be referenced)
echo "\$variable01" # results in $variable01

\\ gives the backslash its literal meaning

echo "\\" # Results in \

# Whereas . . . echo "\" # Invokes secondary prompt from the command line. # In a script, gives an error message.

The behavior of \ depends on whether it is itself escaped, quoted, or appearing within command substitution or a here document.
# # # # # # # # # # # # # # # # Simple escaping and quoting z \z \z \\z \z \z Command substitution z z \z \z \z \\z \z \z

echo echo echo echo echo echo

\z \\z '\z' '\\z' "\z" "\\z"

echo echo echo echo echo echo echo echo

`echo `echo `echo `echo `echo `echo `echo `echo

\z` \\z` \\\z` \\\\z` \\\\\\z` \\\\\\\z` "\z"` "\\z"`

# Here document cat <<EOF \z EOF cat <<EOF \\z EOF

# \z

# \z

# These examples supplied by Stphane Chazelas.

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"

Chapter 5. Quoting

40

Advanced BashScripting Guide

#+ variable=\ 23skidoo echo "$variable" invalid variable assignment

# 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.

Escaping a space can prevent word splitting in a command's argument list.

file_list="/bin/cat /bin/gzip /bin/more /usr/bin/less /usr/bin/emacs20.7" # List of files as argument(s) to a command. # Add two files to the list, and list all. ls l /usr/X11R6/bin/xsetroot /sbin/dump $file_list echo "" # What happens if we escape a couple of spaces? ls l /usr/X11R6/bin/xsetroot\ /sbin/dump\ $file_list # Error: the first three files concatenated into a single argument to 'ls l' # because the two escaped spaces prevent argument (word) splitting.

The escape also provides a means of writing a multiline 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.
(cd /source/directory && tar cf . ) | \ (cd /dest/directory && tar xpvf ) # Repeating Alan Cox's directory tree copy command, # but split into two lines for increased legibility. # As an alternative: tar cf C /source/directory . | tar xpvf C /dest/directory # See note below. # (Thanks, Stphane 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. Chapter 5. Quoting 41

Advanced BashScripting Guide

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. #foo\ #bar # Examples suggested by Stphane Chazelas.

Chapter 5. Quoting

42

Chapter 6. Exit and Exit Status

...there are dark corners in the Bourne shell, and people use all of them. 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 nonzero value that usually may be interpreted as an error code. Wellbehaved 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 (previous to the exit).
#!/bin/bash COMMAND_1 . . . # Will exit with status of last command. COMMAND_LAST exit

The equivalent of a bare exit is exit $? or even just omitting the exit.
#!/bin/bash COMMAND_1 . . . # Will exit with status of last command. COMMAND_LAST exit $? #!/bin/bash COMMAND1 . . . # Will exit with status of last command. COMMAND_LAST

$? 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 Chapter 6. Exit and Exit Status 43

Advanced BashScripting Guide 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.

Example 61. exit / exit status

#!/bin/bash echo hello echo $? # Exit status 0 returned because command executed successfully. lskdf echo $? echo exit 113 # Will return 113 to shell. # To verify this, type "echo $?" after script terminates. # Unrecognized command. # Nonzero exit status returned because command failed to execute.

# By convention, an 'exit 0' indicates success, #+ while a nonzero exit value means an error or anomalous condition.

$? is especially useful for testing the result of a command in a script (see Example 1532 and Example 1517). The !, the logical "not" qualifier, reverses the outcome of a test or command, and this affects its exit status. Example 62. Negating a condition using !
true # the "true" builtin. echo "exit status of \"true\" = $?"

# 0

! true echo "exit status of \"! true\" = $?" # 1 # Note that the "!" needs a space. # !true leads to a "command not found" error # # The '!' operator prefixing a command invokes the Bash history mechanism. true !true # No error this time, but no negation either. # It just repeats the previous command (true). # Thanks, Stphane Chazelas and Kristopher Newsome.

Certain exit status codes have reserved meanings and should not be userspecified in a script.

Chapter 6. Exit and Exit Status

44

Chapter 7. 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.

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. Bash sees [[ $a lt $b ]] as a single element, which returns an exit status. The (( ... )) and let ... constructs also return an exit status of 0 if the arithmetic expressions they evaluate expand to a nonzero value. These arithmetic expansion constructs may therefore be used to perform arithmetic comparisons.
let "1<2" returns 0 (as "1<2" expands to "1") (( 0 && 1 )) returns 1 (as "0 && 1" expands to "0")

An if can test any command, not just conditions enclosed within brackets.
if cmp a b &> /dev/null # Suppress output. then echo "Files a and b are identical." else echo "Files a and b differ." fi # The very useful "ifgrep" construct: # if grep q Bash file then echo "File contains at least one occurrence of Bash." fi word=Linux letter_sequence=inu if echo "$word" | grep q "$letter_sequence" # The "q" option to grep suppresses output. then echo "$letter_sequence found in $word" else echo "$letter_sequence not found in $word" fi

if COMMAND_WHOSE_EXIT_STATUS_IS_0_UNLESS_ERROR_OCCURRED then echo "Command succeeded."

Chapter 7. Tests

45

Advanced BashScripting Guide

else echo "Command failed." fi

An if/then construct can contain nested comparisons and tests.

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

This detailed "iftest" explanation courtesy of Stphane Chazelas.

Example 71. What is truth?

#!/bin/bash # Tip: # If you're unsure of how a certain condition would evaluate, #+ test it in an iftest. echo echo "Testing \"0\"" if [ 0 ] # zero then echo "0 is true." else echo "0 is false." fi # 0 is true. echo echo "Testing \"1\"" if [ 1 ] # one then echo "1 is true." else echo "1 is false." fi # 1 is true. echo echo "Testing if [ 1 ] then echo "1 is else echo "1 is fi echo echo "Testing \"NULL\"" if [ ] # NULL (empty condition) then \"1\"" # minus one true." false." # 1 is true.

Chapter 7. Tests

46

Advanced BashScripting Guide

echo "NULL is true." else echo "NULL is false." fi # NULL is false. echo echo "Testing \"xyz\"" if [ xyz ] # string then echo "Random string is true." else echo "Random string is false." fi # Random string is true. echo echo "Testing \"\$xyz\"" if [ $xyz ] # Tests if $xyz is null, but... # it's only an uninitialized variable. then echo "Uninitialized variable is true." else echo "Uninitialized variable is false." fi # Uninitialized variable is false. echo echo "Testing \"n \$xyz\"" if [ n "$xyz" ] # More pedantically correct. then echo "Uninitialized variable is true." else echo "Uninitialized variable is false." fi # Uninitialized variable is false. echo

xyz=

# Initialized, but set to null value.

echo "Testing \"n \$xyz\"" if [ n "$xyz" ] then echo "Null variable is true." else echo "Null variable is false." fi # Null variable is false.

echo

# When is "false" true? echo "Testing \"false\"" if [ "false" ] # It seems that "false" is just a string. then echo "\"false\" is true." #+ and it tests true. else echo "\"false\" is false." fi # "false" is true.

Chapter 7. Tests

47

Advanced BashScripting Guide

echo echo "Testing \"\$false\"" # Again, uninitialized variable. if [ "$false" ] then echo "\"\$false\" is true." else echo "\"\$false\" is false." fi # "$false" is false. # Now, we get the expected result. # What would happen if we tested the uninitialized variable "$true"?

echo exit 0

Exercise. Explain the behavior of Example 71, above.

if [ conditiontrue ] 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

Else if and elif 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 defaultcommand fi

Chapter 7. Tests

48

Advanced BashScripting Guide The if test conditiontrue construct is the exact equivalent of if [ conditiontrue ]. As it happens, the left bracket, [ , is a token which invokes the test command. The closing right bracket, ] , in an if/test should not therefore be strictly necessary, however newer versions of Bash require it.

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 shutils package. Likewise, [ does not call /usr/bin/[, which is linked to /usr/bin/test.
bash$ type test test is a shell builtin bash$ type '[' [ is a shell builtin bash$ type '[[' [[ is a shell keyword bash$ type ']]' ]] is a shell keyword bash$ type ']' bash: type: ]: not found

If, for some reason, you wish to use /usr/bin/test in a Bash script, then specify it by full pathname. Example 72. Equivalence of test, /usr/bin/test, [ ], and /usr/bin/[
#!/bin/bash echo if test z "$1" then echo "No commandline arguments." else echo "First commandline argument is $1." fi echo if /usr/bin/test z "$1" # Equivalent to "test" builtin. # ^^^^^^^^^^^^^ # Specifying full pathname. then echo "No commandline arguments." else echo "First commandline argument is $1." fi echo if [ z "$1" ] # Functionally identical to above code blocks. # if [ z "$1" should work, but... #+ Bash responds to a missing closebracket with an error message. then echo "No commandline arguments." else echo "First commandline argument is $1." fi

Chapter 7. Tests

49

Advanced BashScripting Guide

echo

if /usr/bin/[ z "$1" ] # Again, functionally identical to above. # if /usr/bin/[ z "$1" # Works, but gives an error message. # # Note: # This has been fixed in Bash, version 3.x. then echo "No commandline arguments." else echo "First commandline argument is $1." fi echo exit 0

The [[ ]] construct is the more versatile Bash version 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 if cd "$dir" 2>/dev/null; then echo "Now in $dir." else echo "Can't change to $dir." fi # "2>/dev/null" hides error message.

The "if COMMAND" construct returns the exit status of COMMAND. 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 nonzero expression returns an exit status of 0, or "true". This is in marked contrast to using the test and [ ] constructs previously discussed. Chapter 7. Tests 50

Advanced BashScripting Guide Example 73. Arithmetic Tests using (( ))

#!/bin/bash # Arithmetic tests. # The (( ... )) construct evaluates and tests numerical expressions. # Exit status opposite from [ ... ] construct! (( 0 )) echo "Exit status of \"(( 0 ))\" is $?." (( 1 )) echo "Exit status of \"(( 1 ))\" is $?." (( 5 > 4 )) echo "Exit status of \"(( 5 > 4 ))\" is $?." (( 5 > 9 )) echo "Exit status of \"(( 5 > 9 ))\" is $?." (( 5 5 )) echo "Exit status of \"(( 5 5 ))\" is $?." (( 5 / 4 )) echo "Exit status of \"(( 5 / 4 ))\" is $?." (( 1 / 2 )) echo "Exit status of \"(( 1 / 2 ))\" is $?."

# 1

# 0 # true # 0 # false # 1 # 0 # 1 # Division o.k. # 0 # Division result < 1. # Rounded off to 0. # 1 # Illegal division by 0. # 1

(( 1 / 0 )) 2>/dev/null # ^^^^^^^^^^^ echo "Exit status of \"(( 1 / 0 ))\" is $?." # What effect does the "2>/dev/null" have? # What would happen if it were removed? # Try removing it, then rerunning the script. exit 0

7.2. File test operators

Returns true if... e file exists a file exists This is identical in effect to e. It has been "deprecated," [21] and its use is discouraged. f file is a regular file (not a directory or device file) s file is not zero size d file is a directory b Chapter 7. Tests 51

Advanced BashScripting Guide file is a block device (floppy, cdrom, etc.) c file is a character device (keyboard, modem, sound card, etc.) p file is a pipe h file is a symbolic link L file is a symbolic link S file is a socket t file (descriptor) is associated with a terminal device 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 setgroupid (sgid) flag set on file or directory 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 setuserid (suid) flag set on file A binary owned by root with setuserid flag set runs with root privileges, even when an ordinary user invokes it. [22] 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 nonroot user.
rwsrxrt 1 root 178236 Oct 2 2000 /usr/sbin/pppd

A file with the suid flag set shows an s in its permissions. k sticky bit set Commonly known as the sticky bit, the savetextmode 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. [23] 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.
drwxrwxrwt 7 root 1024 May 19 21:26 tmp/

Chapter 7. Tests

52

Advanced BashScripting Guide If a user does not own a directory that has the sticky bit set, but has write permission in that directory, she can only delete those files that she owns in it. This keeps users from inadvertently overwriting or deleting each other's files in a publicly accessible directory, such as /tmp. (The owner of the directory or root can, of course, delete or rename files there.) O you are owner of file G groupid of file same as yours N file modified since it was last read f1 nt f2 file f1 is newer than f2 f1 ot f2 file f1 is older than f2 f1 ef f2 files f1 and f2 are hard links to the same file ! "not" reverses the sense of the tests above (returns true if condition absent).

Example 74. Testing for broken links

#!/bin/bash # brokenlink.sh # Written by Lee bigelow <[email protected]> # Used in ABS Guide with permission. # A pure shell script to find dead symlinks and output them quoted #+ so they can be fed to xargs and dealt with :) #+ eg. sh brokenlink.sh /somedir /someotherdir|xargs rm # # This, however, is a better method: # # find "somedir" type l print0|\ # xargs r0 file|\ # grep "broken symbolic"| # sed e 's/^\|: *broken symbolic.*$/"/g' # #+ but that wouldn't be pure Bash, now would it. # Caution: beware the /proc file system and any circular links! ################################################################

# If no args are passed to the script set directoriestosearch #+ to current directory. Otherwise set the directoriestosearch #+ to the args passed. ###################### [ $# eq 0 ] && directorys=`pwd` || directorys=$@

# Setup the #+ for files # If one of #+ send that ##########

function linkchk to check the directory it is passed that are links and don't exist, then print them quoted. the elements in the directory is a subdirectory then subdirectory to the linkcheck function.

Chapter 7. Tests

53

Advanced BashScripting Guide

linkchk () { for element in $1/*; do [ h "$element" a ! e "$element" ] && echo \"$element\" [ d "$element" ] && linkchk $element # Of course, 'h' tests for symbolic link, 'd' for directory. done } # Send each arg that was passed to the script to the linkchk() function #+ if it is a valid directoy. If not, then print the error message #+ and usage info. ################## for directory in $directorys; do if [ d $directory ] then linkchk $directory else echo "$directory is not a directory" echo "Usage: $0 dir1 dir2 ..." fi done exit $?

Example 281, Example 107, Example 103, Example 283, and Example A1 also illustrate uses of the file test operators.

7.3. Other Comparison Operators

A binary comparison operator compares two variables or quantities. Note that integer and string comparison use a different set of operators. integer comparison eq is equal to if [ "$a" eq "$b" ] ne is not equal to if [ "$a" ne "$b" ] gt is greater than if [ "$a" gt "$b" ] ge is greater than or equal to if [ "$a" ge "$b" ] lt is less than if [ "$a" lt "$b" ] le Chapter 7. Tests 54

Advanced BashScripting Guide is less than or equal to if [ "$a" le "$b" ] < is less than (within double parentheses) (("$a" < "$b")) <= is less than or equal to (within double parentheses) (("$a" <= "$b")) > is greater than (within double parentheses) (("$a" > "$b")) >= is greater than or equal to (within double parentheses) (("$a" >= "$b")) string comparison = is equal to if [ "$a" = "$b" ] == is equal to if [ "$a" == "$b" ] This is a synonym for =. The == comparison operator behaves differently within a doublebrackets test than within single brackets.
[[ $a == z* ]] [[ $a == "z*" ]] [ $a == z* ] [ "$a" == "z*" ] # True if $a starts with an "z" (pattern matching). # True if $a is equal to z* (literal matching). # File globbing and word splitting take place. # True if $a is equal to z* (literal matching).

# Thanks, Stphane Chazelas

!= is not equal to if [ "$a" != "$b" ] This operator uses pattern matching within a [[ ... ]] construct. < is less than, in ASCII alphabetical order Chapter 7. Tests 55

Advanced BashScripting Guide if [[ "$a" < "$b" ]] if [ "$a" \< "$b" ] Note that the "<" needs to be escaped within a [ ] construct. > is greater than, in ASCII alphabetical order if [[ "$a" > "$b" ]] if [ "$a" \> "$b" ] Note that the ">" needs to be escaped within a [ ] construct. See Example 2611 for an application of this comparison operator. z string is "null," that is, has zero length n string is not "null." 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 76) normally works, however, this is an unsafe practice. Always quote a tested string. [24]

Example 75. Arithmetic and string comparisons

#!/bin/bash a=4 b=5 # Here "a" and "b" can be treated either as integers or strings. # There is some blurring between the arithmetic and string comparisons, #+ since Bash variables are not strongly typed. # Bash permits integer operations and comparisons on variables #+ whose value consists of allinteger characters. # Caution advised, however. echo if [ "$a" ne "$b" ] then echo "$a is not equal to $b" echo "(arithmetic comparison)" fi echo if [ "$a" != "$b" ] then echo "$a is not equal to $b." echo "(string comparison)" # "4" != "5"

Chapter 7. Tests

56

Advanced BashScripting Guide

# ASCII 52 != ASCII 53 fi # In this particular instance, both "ne" and "!=" work. echo exit 0

Example 76. Testing whether a string is null

#!/bin/bash # strtest.sh: Testing null strings and unquoted strings, #+ but not strings and sealing wax, not to mention cabbages and kings . . . # Using if [ ... ]

# If a string has not been initialized, it has no defined value. # This state is called "null" (not the same as zero). if [ n $string1 ] # $string1 has not been declared or initialized. then echo "String \"string1\" is not null." else echo "String \"string1\" is null." fi # Wrong result. # Shows $string1 as not null, although it was not initialized.

echo

# Lets try it again. if [ n "$string1" ] # This time, $string1 is quoted. then echo "String \"string1\" is not null." else echo "String \"string1\" is null." fi # Quote strings within test brackets!

echo

if [ $string1 ] # This time, $string1 stands naked. then echo "String \"string1\" is not null." else echo "String \"string1\" is null." fi # This works fine. # The [ ] test operator alone detects whether the string is null. # However it is good practice to quote it ("$string1"). # # As Stephane Chazelas points out, # if [ $string1 ] has one argument, "]" # if [ "$string1" ] has two arguments, the empty "$string1" and "]"

Chapter 7. Tests

57

Advanced BashScripting Guide

echo

string1=initialized if [ $string1 ] # Again, $string1 stands naked. then echo "String \"string1\" is not null." else echo "String \"string1\" is null." fi # Again, gives correct result. # Still, it is better to quote it ("$string1"), because . . .

string1="a = b" if [ $string1 ] # Again, $string1 stands naked. then echo "String \"string1\" is not null." else echo "String \"string1\" is null." fi # Not quoting "$string1" now gives wrong result! exit 0 # Thank you, also, Florian Wisser, for the "headsup".

Example 77. zmore

#!/bin/bash # zmore #View gzipped files with 'more' NOARGS=65 NOTFOUND=66 NOTGZIP=67 if [ $# eq 0 ] # same effect as: if [ z "$1" ] # $1 can exist, but be empty: zmore "" arg2 arg3 then echo "Usage: `basename $0` filename" >&2 # Error message to stderr. exit $NOARGS # Returns 65 as exit status of script (error code). fi filename=$1 if [ ! f "$filename" ] # Quoting $filename allows for possible spaces. then echo "File $filename not found!" >&2 # Error message to stderr. exit $NOTFOUND fi if [ ${filename##*.} != "gz" ]

Chapter 7. Tests

58

Advanced BashScripting Guide

# Using bracket in variable substitution. then echo "File $1 is not a gzipped file!" exit $NOTGZIP fi zcat $1 | more # Uses the filter 'more.' # May substitute 'less', if desired.

exit $? # Script returns exit status of pipe. # Actually "exit $?" is unnecessary, as the script will, in any case, # return the exit status of the last command executed.

compound comparison a logical and exp1 a exp2 returns true if both exp1 and exp2 are true. o logical or exp1 o exp2 returns true if either exp1 or exp2 are true. These are similar to the Bash comparison operators && and ||, used within double brackets.
[[ condition1 && condition2 ]]

The o and a operators work with the test command or occur within single test brackets.
if [ "$exp1" a "$exp2" ]

Refer to Example 83, Example 2616, and Example A29 to see compound comparison operators in action.

7.4. Nested if/then Condition Tests

Condition tests using the if/then construct may be nested. The net result is equivalent to using the && compound comparison operator above.
if [ condition1 ] then if [ condition2 ] then dosomething # But only if both "condition1" and "condition2" valid. fi fi

See Example 344 for an example of nested if/then condition tests.

7.5. Testing Your Knowledge of Tests

The systemwide xinitrc file can be used to launch the X server. This file contains quite a number of if/then tests. The following is excerpted from an "ancient" version of xinitrc (Red Hat 7.1, or thereabouts).

Chapter 7. Tests

59

Advanced BashScripting Guide

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 100x1005+5 & xterm geometry 80x5050+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 snippet, then examine an updated version of the 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.

Chapter 7. Tests

60

Chapter 8. Operations and Related Topics

8.1. Operators
assignment variable assignment Initializing or changing the value of a variable = Allpurpose 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" ] then command fi # 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.)

arithmetic operators + plus minus * multiplication / division ** exponentiation

# Bash, version 2.02, introduced the "**" exponentiation operator. let "z=5**3" echo "z = $z"

# z = 125

% modulo, or mod (returns the remainder of an integer division operation)

bash$ expr 5 % 3 2

5/3 = 1 with remainder 2

Chapter 8. Operations and Related Topics

61

Advanced BashScripting Guide This operator finds use in, among other things, generating numbers within a specific range (see Example 925 and Example 928) and formatting program output (see Example 2615 and Example A6). It can even be used to generate prime numbers, (see Example A16). Modulo turns up surprisingly often in various numerical recipes.

Example 81. Greatest common divisor

#!/bin/bash # gcd.sh: greatest common divisor # Uses Euclid's algorithm # The "greatest common divisor" (gcd) of two integers #+ is the largest integer that will divide both, leaving no remainder. # # #+ #+ #+ #+ # # #+ Euclid's algorithm uses successive division. In each pass, dividend < divisor divisor < remainder until remainder = 0. The gcd = dividend, on the final pass. For an excellent discussion of Euclid's algorithm, see Jim Loy's site, http://www.jimloy.com/number/euclids.htm.

# # Argument check ARGS=2 E_BADARGS=65 if [ $# ne "$ARGS" ] then echo "Usage: `basename $0` firstnumber secondnumber" exit $E_BADARGS fi #

gcd () { dividend=$1 divisor=$2 # Arbitrary assignment. #! It doesn't matter which of the two is larger. # Why not? # If uninitialized variable used in loop, #+ it results in an error message #+ on the first pass through loop.

remainder=1

until [ "$remainder" eq 0 ] do let "remainder = $dividend % $divisor" dividend=$divisor # Now repeat with 2 smallest numbers. divisor=$remainder done # Euclid's algorithm } # Last $dividend is the gcd.

Chapter 8. Operations and Related Topics

62

Advanced BashScripting Guide

gcd $1 $2 echo; echo "GCD of $1 and $2 = $dividend"; echo

# Exercise : # # Check commandline arguments to make sure they are integers, #+ and exit the script with an appropriate error message if not. exit 0

+= "plusequal" (increment variable by a constant) let "var += 5" results in var being incremented by 5. = "minusequal" (decrement variable by a constant) *= "timesequal" (multiply variable by a constant) let "var *= 4" results in var being multiplied by 4. /= "slashequal" (divide variable by a constant) %= "modequal" (remainder of dividing variable by a constant) Arithmetic operators often occur in an expr or let expression.

Example 82. Using Arithmetic Operations

#!/bin/bash # Counting to 11 in 10 different ways. n=1; echo n "$n " let "n = $n + 1" echo n "$n " # let "n = n + 1" also works.

: $((n = $n + 1)) # ":" necessary because otherwise Bash attempts #+ to interpret "$((n = $n + 1))" as a command. echo n "$n " (( n = n + 1 )) # A simpler alternative to the method above. # Thanks, David Lombard, for pointing this out. 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.

Chapter 8. Operations and Related Topics

63

Advanced BashScripting Guide

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. # Thanks, Stephane Chazelas. echo n "$n " # Now for Cstyle increment operators. # Thanks, Frank Wang, for pointing this out. let "n++" echo n "$n " (( n++ )) echo n "$n " : $(( n++ )) echo n "$n " : $[ n++ ] echo n "$n " echo exit 0 # let "++n" also works.

# (( ++n )

also works.

# : $(( ++n )) also works.

# : $[ ++n ]] also works

Integer variables in Bash are actually signed long (32bit) 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" let "a+=1" echo "a = $a" let "a+=1" echo "a = $a"

# # # # # #

a = 2147483646 Increment "a". a = 2147483647 increment "a" again, past the limit. a = 2147483648 ERROR (out of range)

As of version 2.05b, Bash supports 64bit integers.

Bash does not understand floating point arithmetic. It treats numbers containing a decimal point as strings.
a=1.5 let "b = $a + 1.3" # Error. # t2.sh: let: b = 1.5 + 1.3: syntax error in expression # (error token is ".5 + 1.3") echo "b = $b" # b=1

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

Chapter 8. Operations and Related Topics

64

Advanced BashScripting Guide << bitwise left shift (multiplies by 2 for each shift position) <<= "leftshiftequal" let "var <<= 2" results in var leftshifted 2 bits (multiplied by 4) >> bitwise right shift (divides by 2 for each shift position) >>= "rightshiftequal" (inverse of <<=) & bitwise and &= "bitwise andequal" | bitwise OR |= "bitwise ORequal" ~ bitwise negate ! bitwise NOT ^ bitwise XOR ^= "bitwise XORequal" logical operators && and (logical)
if [ $condition1 ] && [ $condition2 ] # Same as: if [ $condition1 a $condition2 ] # Returns true if both condition1 and condition2 hold true... if [[ $condition1 && $condition2 ]] # Also works. # Note that && operator not permitted within [ ... ] construct.

&& 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... if [[ $condition1 || $condition2 ]] # Also works. # Note that || operator not permitted within [ ... ] construct.

Bash tests the exit status of each statement linked with a logical operator.

Chapter 8. Operations and Related Topics

65

Advanced BashScripting Guide Example 83. Compound Condition Tests Using && and ||
#!/bin/bash a=24 b=47 if [ "$a" eq 24 ] && [ "$b" eq 47 ] then echo "Test #1 succeeds." else echo "Test #1 fails." fi # ERROR: if [ "$a" eq 24 && "$b" eq 47 ] #+ attempts to execute ' [ "$a" eq 24 ' #+ and fails to finding matching ']'. # # Note: if [[ $a eq 24 && $b eq 24 ]] works. # The doublebracket iftest is more flexible #+ than the singlebracket version. # (The "&&" has a different meaning in line 17 than in line 6.) # Thanks, Stephane Chazelas, for pointing this out.

if [ "$a" eq 98 ] || [ "$b" eq 47 ] then echo "Test #2 succeeds." else echo "Test #2 fails." fi

# The a and o options provide #+ an alternative compound condition test. # Thanks to Patrick Callahan for pointing this out.

if [ "$a" eq 24 a "$b" eq 47 ] then echo "Test #3 succeeds." else echo "Test #3 fails." fi

if [ "$a" eq 98 o "$b" eq 47 ] then echo "Test #4 succeeds." else echo "Test #4 fails." fi

a=rhino b=crocodile if [ "$a" = rhino ] && [ "$b" = crocodile ] then echo "Test #5 succeeds." else echo "Test #5 fails." fi

Chapter 8. Operations and Related Topics

66

Advanced BashScripting Guide

exit 0

The && and || operators also find use in an arithmetic context.

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.
let "t1 = ((5 + 3, 7 1, 15 4))" echo "t1 = $t1" # t1 = 11 let "t2 = ((a = 9, 15 / 3))" echo "t2 = $t2 a = $a" # Set "a" and calculate "t2". # t2 = 5 a = 9

The comma operator finds use mainly in for loops. See Example 1012.

8.2. Numerical Constants

A shell script interprets a number as decimal (base 10), unless that number has a special prefix or notation. A number preceded by a 0 is octal (base 8). A number preceded by 0x is hexadecimal (base 16). A number with an embedded # evaluates as BASE#NUMBER (with range and notational restrictions).

Example 84. Representation of numerical constants

#!/bin/bash # numbers.sh: Representation of numbers in different bases. # Decimal: the default let "dec = 32" echo "decimal number = $dec" # Nothing out of the ordinary here.

# 32

# Octal: numbers preceded by '0' (zero) let "oct = 032" echo "octal number = $oct" # Expresses result in decimal. #

# 26

# Hexadecimal: numbers preceded by '0x' or '0X' let "hex = 0x32" echo "hexadecimal number = $hex" # 50 echo $((0x9abc)) # 39612 # ^^ ^^ doubleparentheses arithmetic expansion/evaluation # Expresses result in decimal.

Chapter 8. Operations and Related Topics

67

Advanced BashScripting Guide

# Other bases: BASE#NUMBER # BASE between 2 and 64. # NUMBER must use symbols within the BASE range, see below.

let "bin = 2#111100111001101" echo "binary number = $bin" let "b32 = 32#77" echo "base32 number = $b32"

# 31181

# 231

let "b64 = 64#@_" echo "base64 number = $b64" # 4031 # This notation only works for a limited range (2 64) of ASCII characters. # 10 digits + 26 lowercase characters + 26 uppercase characters + @ + _

echo echo $((36#zz)) $((2#10101010)) $((16#AF16)) $((53#1aA)) # 1295 170 44822 3375

# # # #+

Important note: Using a digit out of range of the specified base notation gives an error message.

let "bad_oct = 081" # (Partial) error message output: # bad_oct = 081: value too great for base (error token is "081") # Octal numbers use only digits in the range 0 7. exit 0 # Thanks, Rich Bartell and Stephane Chazelas, for clarification.

Chapter 8. Operations and Related Topics

68

Part 3. Beyond the Basics

Table of Contents 9. Variables Revisited 9.1. Internal Variables 9.2. Manipulating Strings 9.3. Parameter Substitution 9.4. Typing variables: declare or typeset 9.5. Indirect References to Variables 9.6. $RANDOM: generate random integer 9.7. The Double Parentheses Construct 10. Loops and Branches 10.1. Loops 10.2. Nested Loops 10.3. Loop Control 10.4. Testing and Branching 11. Command Substitution 12. Arithmetic Expansion 13. Recess Time

Part 3. Beyond the Basics

69

Chapter 9. Variables Revisited

Used properly, variables can add power and flexibility to scripts. This requires learning their subtleties and nuances.

9.1. Internal Variables

Builtin variables variables affecting bash script behavior $BASH the path to the Bash binary itself
bash$ echo $BASH /bin/bash

$BASH_ENV an environmental variable pointing to a Bash startup file to be read when a script is invoked $BASH_SUBSHELL a variable indicating the subshell level. This is a new addition to Bash, version 3. See Example 201 for usage. $BASH_VERSINFO[n] a 6element array containing version information about the installed release of Bash. This is similar to $BASH_VERSION, below, but a bit more detailed.
# Bash version info: for n in 0 1 2 3 4 5 do echo "BASH_VERSINFO[$n] = ${BASH_VERSINFO[$n]}" done # # # # # # BASH_VERSINFO[0] BASH_VERSINFO[1] BASH_VERSINFO[2] BASH_VERSINFO[3] BASH_VERSINFO[4] BASH_VERSINFO[5] = = = = = = 3 00 14 1 release i386redhatlinuxgnu # # # # # # # Major version no. Minor version no. Patch level. Build version. Release status. Architecture (same as $MACHTYPE).

$BASH_VERSION the version of Bash installed on the system

bash$ echo $BASH_VERSION 3.00.14(1)release

tcsh% echo $BASH_VERSION BASH_VERSION: Undefined variable.

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) Chapter 9. Variables Revisited 70

Advanced BashScripting Guide This builtin variable corresponds to the dirs command, however dirs shows the entire contents of the directory stack. $EDITOR the default editor invoked by a script, usually vi or emacs. $EUID "effective" user ID number Identification number of whatever identity the current user has assumed, perhaps by means of su. The $EUID is not necessarily the same as the $UID. $FUNCNAME name of the current function
xyz23 () { echo "$FUNCNAME now executing." } xyz23 echo "FUNCNAME = $FUNCNAME" # FUNCNAME = # Null value outside a function.

# xyz23 now executing.

$GLOBIGNORE A list of filename patterns to be excluded from matching in globbing. $GROUPS groups current user belongs to This is a listing (array) of the group id numbers for current user, as recorded in /etc/passwd.
root# echo $GROUPS 0

root# echo ${GROUPS[1]} 1

root# echo ${GROUPS[5]} 6

$HOME home directory of the user, usually /home/username (see Example 915) $HOSTNAME 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 915. $HOSTTYPE host type Like $MACHTYPE, identifies the system hardware.
bash$ echo $HOSTTYPE i686

$IFS internal field separator Chapter 9. Variables Revisited 71

Advanced BashScripting Guide This variable determines how Bash recognizes fields, or word boundaries when it interprets character strings. $IFS defaults to whitespace (space, tab, and newline), but may be changed, for example, to parse a commaseparated data file. Note that $* uses the first character held in $IFS. See Example 51.
bash$ echo $IFS | cat vte $ (Show tabs and display "$" at endofline.)

bash$ bash c 'set w x y z; IFS=":;"; echo "$*"' w:x:y:z (Read commands from string and assign any arguments to pos params.)

$IFS does not handle whitespace the same as it does other characters. Example 91. $IFS and whitespace
#!/bin/bash # $IFS treats whitespace differently than other characters. output_args_one_per_line() { for arg do echo "[$arg]" done } echo; echo "IFS=\" \"" echo "" IFS=" " var=" a b c " output_args_one_per_line $var # # [a] # [b] # [c]

# output_args_one_per_line `echo " a

b c

"`

echo; echo "IFS=:" echo "" IFS=: var=":a::b:c:::" output_args_one_per_line $var # # [] # [a] # [] # [b] # [c] # [] # [] # []

# Same as above, but substitute ":" for " ".

Chapter 9. Variables Revisited

72

Advanced BashScripting Guide

# The same thing happens with the "FS" field separator in awk. # Thank you, Stephane Chazelas. echo exit 0

(Thanks, S. C., for clarification and examples.) See also Example 1537, Example 107, and Example 1814 for instructive examples of using $IFS. $IGNOREEOF ignore EOF: how many endoffiles (controlD) 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 [AM]* 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.
# *** BEGIN DEBUG BLOCK *** last_cmd_arg=$_ # Save it. echo "At line number $LINENO, variable \"v1\" = $v1" echo "Last command argument processed = $last_cmd_arg" # *** END DEBUG BLOCK ***

$MACHTYPE machine type Identifies the system hardware.

bash$ echo $MACHTYPE i686

$OLDPWD old working directory ("OLDprintworkingdirectory", previous directory you were in) $OSTYPE operating system type
bash$ echo $OSTYPE linux

$PATH path to binaries, usually /usr/bin/, /usr/X11R6/bin/, /usr/local/bin, etc.

Chapter 9. Variables Revisited

73

Advanced BashScripting Guide 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 Appendix G).
bash$ echo $PATH /bin:/usr/bin:/usr/local/bin:/usr/X11R6/bin:/sbin:/usr/sbin

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 Array variable holding exit status(es) of last executed foreground pipe. Interestingly enough, this does not necessarily give the same result as the exit status of the last executed command.
bash$ echo $PIPESTATUS 0 bash$ ls al | bogus_command bash: bogus_command: command not found bash$ echo $PIPESTATUS 141 bash$ ls al | bogus_command bash: bogus_command: command not found bash$ echo $? 127

The members of the $PIPESTATUS array hold the exit status of each respective command executed in a pipe. $PIPESTATUS[0] holds the exit status of the first command in the pipe, $PIPESTATUS[1] the exit status of the second command, and so on. The $PIPESTATUS variable may contain an erroneous 0 value in a login shell (in releases prior to 3.0 of Bash).
tcsh% bash bash$ who | grep nobody | sort bash$ echo ${PIPESTATUS[*]} 0

The above lines contained in a script would produce the expected 0 1 0 output. Thank you, Wayne Pollock for pointing this out and supplying the above example. The $PIPESTATUS variable gives unexpected results in some contexts.
bash$ echo $BASH_VERSION 3.00.14(1)release bash$ $ ls | bogus_command | wc

Chapter 9. Variables Revisited

74

Advanced BashScripting Guide

bash: bogus_command: command not found 0 0 0 bash$ echo ${PIPESTATUS[@]} 141 127 0

Chet Ramey attributes the above output to the behavior of ls. If ls writes to a pipe whose output is not read, then SIGPIPE kills it, and its exit status is 141. Otherwise its exit status is 0, as expected. This likewise is the case for tr. $PIPESTATUS is a "volatile" variable. It needs to be captured immediately after the pipe in question, before any other command intervenes.
bash$ $ ls | bogus_command | wc bash: bogus_command: command not found 0 0 0 bash$ echo ${PIPESTATUS[@]} 0 127 0 bash$ echo ${PIPESTATUS[@]} 0

The pipefail option may be useful in cases where $PIPESTATUS does not give the desired information. $PPID The $PPID of a process is the process ID (pid) of its parent process. [25] Compare this with the pidof command. $PROMPT_COMMAND A variable holding a command to be executed just before the primary prompt, $PS1 is to be displayed. $PS1 This is the main prompt, seen at the command line. $PS2 The secondary prompt, seen when additional input is expected. It displays as ">". $PS3 The tertiary prompt, displayed in a select loop (see Example 1029). $PS4 The quartenary prompt, shown at the beginning of each line of output when invoking a script with the x option. It displays as "+". $PWD working directory (directory you are in at the time) This is the analog to the pwd builtin command.
#!/bin/bash E_WRONG_DIRECTORY=73

Chapter 9. Variables Revisited

75

Advanced BashScripting Guide

clear # Clear screen. 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 .[AZaz09]* # 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. # Various other operations here, as necessary. 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 # reply.sh # REPLY is the default value for a 'read' command. echo echo n "What is your favorite vegetable? " read echo "Your favorite vegetable is $REPLY." # REPLY holds the value of last "read" if and only if #+ no variable supplied. echo echo n "What is your favorite fruit? " read fruit echo "Your favorite fruit is $fruit." echo "but..." echo "Value of \$REPLY is still $REPLY." # $REPLY is still set to its previous value because #+ the variable $fruit absorbed the new "read" value. echo

Chapter 9. Variables Revisited

76

Advanced BashScripting Guide

exit 0

$SECONDS The number of seconds the script has been running.

#!/bin/bash TIME_LIMIT=10 INTERVAL=1 echo echo "Hit ControlC to exit before $TIME_LIMIT seconds." echo while [ "$SECONDS" le "$TIME_LIMIT" ] do if [ "$SECONDS" eq 1 ] then units=second else units=seconds fi echo "This script has been running $SECONDS $units." # On a slow or overburdened machine, the script may skip a count #+ every once in a while. sleep $INTERVAL done echo e "\a" exit 0 # Beep!

$SHELLOPTS the list of enabled shell options, a readonly variable

bash$ echo $SHELLOPTS braceexpand:hashall:histexpand:monitor:history:interactivecomments:emacs

$SHLVL Shell level, how deeply Bash is nested. [26] If, at the command line, $SHLVL is 1, then in a script it will increment to 2. This variable is not affected by subshells. Use $BASH_SUBSHELL when you need an indication of subshell nesting. $TMOUT If the $TMOUT environmental variable is set to a nonzero value time, then the shell prompt will time out after $time seconds. This will cause a logout. As of version 2.05b of Bash, it is now possible to use $TMOUT in a script in combination with read.
# Works in scripts for Bash, versions 2.05b and later. TMOUT=3 # Prompt times out at three seconds.

echo "What is your favorite song?" echo "Quickly now, you only have $TMOUT seconds to answer!" read song

Chapter 9. Variables Revisited

77

Advanced BashScripting Guide

if [ z "$song" ] then song="(no answer)" # Default response. fi echo "Your favorite song is $song."

There are other, more complex, ways of implementing timed input in a script. One alternative 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 295) the interrupt generated by the timing loop (whew!).

Example 92. Timed Input

#!/bin/bash # timedinput.sh # TMOUT=3 Also works, as of newer versions of Bash.

TIMELIMIT=3

# Three seconds in this instance. May be set to different value.

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 } trap Int14Vector 14 # Timer interrupt (14) subverted for our purposes.

echo "What is your favorite vegetable " TimerOn read answer PrintAnswer

# Admittedly, this is a kludgy implementation of timed input, #+ however the "t" option to "read" simplifies this task.

Chapter 9. Variables Revisited

78

Advanced BashScripting Guide

# See "tout.sh", below.

# If you need something really elegant... #+ consider writing the application in C or C++, #+ using appropriate library functions, such as 'alarm' and 'setitimer'. exit 0

An alternative is using stty.

Example 93. Once more, timed input

#!/bin/bash # timeout.sh # Written by Stephane Chazelas, #+ and modified by the document author. INTERVAL=5 # timeout interval

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 n "What's your name? Quick! " timedout_read $INTERVAL your_name # This may not work on every terminal type. # The maximum timeout depends on the terminal. #+ (it is often 25.5 seconds). echo if [ ! z "$your_name" ] # If name input before timeout... then echo "Your name is $your_name." else echo "Timed out." fi echo # The behavior of this script differs somewhat from "timedinput.sh". # At each keystroke, the counter resets. exit 0

Perhaps the simplest method is using the t option to read.

Example 94. Timed read

#!/bin/bash # tout.sh

Chapter 9. Variables Revisited

79

Advanced BashScripting Guide

# Inspired by a suggestion from "syngin seven" (thanks).

TIMELIMIT=4

# 4 seconds

read t $TIMELIMIT variable <&1 # ^^^ # In this instance, "<&1" is needed for Bash 1.x and 2.x, # but unnecessary for Bash 3.x. echo if [ z "$variable" ] # Is null? then echo "Timed out, variable still unset." else echo "variable = $variable" fi exit 0

$UID user ID number current user's user identification number, as recorded in /etc/passwd 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.

Example 95. Am I root?

#!/bin/bash # amiroot.sh: ROOT_UID=0

Am I root or not?

# Root has $UID 0.

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. # An alternate method of getting to the root of matters: ROOTUSER_NAME=root username=`id nu` # Or... username=`whoami` if [ "$username" = "$ROOTUSER_NAME" ] then echo "Rooty, toot, toot. You are root." else

Chapter 9. Variables Revisited

80

Advanced BashScripting Guide

echo "You are just a regular fella." fi

See also Example 23. 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.
tcsh% echo $LOGNAME bozo tcsh% echo $SHELL /bin/tcsh tcsh% echo $TERM rxvt bash$ echo $LOGNAME bozo bash$ echo $SHELL /bin/tcsh bash$ echo $TERM rxvt

Positional Parameters $0, $1, $2, etc. positional parameters, passed from command line to script, passed to a function, or set to a variable (see Example 45 and Example 1416) $# number of command line arguments [27] or positional parameters (see Example 332) $* All of the positional parameters, seen as a single word "$*" must be quoted. $@ 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. Of course, "$@" should be quoted. Example 96. arglist: Listing arguments with $* and $@
#!/bin/bash # arglist.sh # 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

Chapter 9. Variables Revisited

81

Advanced BashScripting Guide

fi echo index=1 # Initialize count.

echo "Listing args with \"\$*\":" for arg in "$*" # Doesn't work properly if "$*" isn't quoted. do echo "Arg #$index = $arg" let "index+=1" done # $* sees all arguments as single word. echo "Entire arg list seen as single word." echo index=1 # Reset count. # What happens if you forget to do this?

echo "Listing args with \"\$@\":" for arg in "$@" do echo "Arg #$index = $arg" let "index+=1" done # $@ sees arguments as separate words. echo "Arg list seen as separate words." echo index=1 # Reset count.

echo "Listing args with \$* (unquoted):" for arg in $* do echo "Arg #$index = $arg" let "index+=1" done # Unquoted $* sees arguments as separate words. echo "Arg list seen as separate words." exit 0

Following a shift, the $@ holds the remaining commandline parameters, lacking the previous $1, which was lost.
#!/bin/bash # Invoke with ./scriptname 1 2 3 4 5 echo "$@" shift echo "$@" shift echo "$@" # 1 2 3 4 5 # 2 3 4 5 # 3 4 5

# Each "shift" loses parameter $1. # "$@" then contains the remaining parameters.

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 1521 and Example 1522. The $* and $@ parameters sometimes display inconsistent and puzzling behavior, Chapter 9. Variables Revisited 82

Advanced BashScripting Guide depending on the setting of $IFS. Example 97. Inconsistent $* and $@ behavior
#!/bin/bash # Erratic behavior of the "$*" and "$@" internal Bash variables, #+ depending on whether they are quoted or not. # Inconsistent handling of word splitting and linefeeds.

set "First one" "second" "third:one" "" "Fifth: :one" # Setting the script arguments, $1, $2, etc. echo echo 'IFS unchanged, using "$*"' c=0 for i in "$*" # quoted do echo "$((c+=1)): [$i]" # This line remains the same in every instance. # Echo args. done echo echo 'IFS unchanged, using $*' c=0 for i in $* # unquoted do echo "$((c+=1)): [$i]" done echo echo 'IFS unchanged, using "$@"' c=0 for i in "$@" do echo "$((c+=1)): [$i]" done echo echo 'IFS unchanged, using $@' c=0 for i in $@ do echo "$((c+=1)): [$i]" done echo IFS=: echo 'IFS=":", using "$*"' c=0 for i in "$*" do echo "$((c+=1)): [$i]" done echo echo 'IFS=":", using $*' c=0 for i in $* do echo "$((c+=1)): [$i]" done echo var=$*

Chapter 9. Variables Revisited

83

Advanced BashScripting Guide

echo 'IFS=":", using "$var" (var=$*)' c=0 for i in "$var" do echo "$((c+=1)): [$i]" done echo 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 'IFS=":", using "$var" (var="$*")' c=0 for i in "$var" do echo "$((c+=1)): [$i]" done echo echo 'IFS=":", using "$@"' c=0 for i in "$@" do echo "$((c+=1)): [$i]" done echo 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 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"

Chapter 9. Variables Revisited

84

Advanced BashScripting Guide

do echo "$((c+=1)): [$i]" done echo echo 'IFS=":", using $var (var="$@")' c=0 for i in $var do echo "$((c+=1)): [$i]" done echo # Try this script with ksh or zsh y. exit 0 # This example script by Stephane Chazelas, # and slightly modified by the document author.

The $@ and $* parameters differ only when between double quotes. Example 98. $* and $@ when $IFS is empty
#!/bin/bash # If $IFS set, but empty, #+ then "$*" and "$@" do not echo positional params as expected. mecho () # Echo positional parameters. { echo "$1,$2,$3"; }

IFS="" set a b c mecho "$*" mecho $* mecho $@ mecho "$@"

# Set, but empty. # Positional parameters. # abc,, # a,b,c # a,b,c # a,b,c

# The behavior of $* and $@ when $IFS is empty depends #+ on whatever Bash or sh version being run. # It is therefore inadvisable to depend on this "feature" in a script.

# Thanks, Stephane Chazelas. exit 0

Other Special Parameters $ Flags passed to script (using set). See Example 1416.

Chapter 9. Variables Revisited

85

Advanced BashScripting Guide 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 selftest whether it is interactive. $! PID (process ID) of last job run in background
LOG=$0.log COMMAND1="sleep 100" echo "Logging PIDs background commands for script: $0" >> "$LOG" # So they can be monitored, and killed as necessary. echo >> "$LOG" # Logging commands. echo n "PID of \"$COMMAND1\": ${COMMAND1} & echo $! >> "$LOG" # PID of "sleep 100": 1506 " >> "$LOG"

# Thank you, Jacques Lederer, for suggesting this.

Using $! for job control:

possibly_hanging_job & { sleep ${TIMEOUT}; eval 'kill 9 $!' &> /dev/null; } # Forces completion of an illbehaved program. # Useful, for example, in init scripts. # Thank you, Sylvain Fourmanoit, for this creative use of the "!" variable.

Or, alternately:
# This example by Matthew Sage. # Used with permission. TIMEOUT=30 count=0 # Timeout value in seconds

possibly_hanging_job & { while ((count < TIMEOUT )); do eval '[ ! d "/proc/$!" ] && ((count = TIMEOUT))' # /proc is where information about running processes is found. # "d" tests whether it exists (whether directory exists). # So, we're waiting for the job in question to show up. ((count++)) sleep 1 done eval '[ d "/proc/$!" ] && kill 15 $!' # If the hanging job is running, kill it. }

$_ Special variable set to last argument of previous command executed.

Example 99. Underscore variable

#!/bin/bash

Chapter 9. Variables Revisited

86

Advanced BashScripting Guide

echo $_ # /bin/bash # Just called /bin/bash to run the script. # So no output from command. # du # So no output from command. # al (last argument)

du >/dev/null echo $_ ls al >/dev/null echo $_ : echo $_

# :

$? Exit status of a command, function, or the script itself (see Example 237) $$ Process ID of the script itself. The $$ variable often finds use in scripts to construct "unique" temp file names (see Example A13, Example 296, Example 1528, and Example 1427). This is usually simpler than invoking mktemp.

9.2. Manipulating Strings

Bash supports a surprising number of string manipulation operations. Unfortunately, these tools lack a unified focus. Some are a subset of parameter substitution, and others fall under the functionality of the UNIX expr command. This results in inconsistent command syntax and overlap of functionality, not to mention confusion. String Length ${#string} expr length $string expr "$string" : '.*'
stringZ=abcABC123ABCabc echo ${#stringZ} echo `expr length $stringZ` echo `expr "$stringZ" : '.*'` # 15 # 15 # 15

Example 910. Inserting a blank line between paragraphs in a text file

#!/bin/bash # paragraphspace.sh # Inserts a blank line between paragraphs of a singlespaced text file. # Usage: $0 <FILENAME MINLEN=45 # May need to change this value. # Assume lines shorter than $MINLEN characters #+ terminate a paragraph. while read line do echo "$line" # For as many lines as the input file has... # Output the line itself.

Chapter 9. Variables Revisited

87

Advanced BashScripting Guide

len=${#line} if [ "$len" lt "$MINLEN" ] then echo # Add a blank line after short line. fi done exit 0

Length of Matching Substring at Beginning of String expr match "$string" '$substring' $substring is a regular expression. expr "$string" : '$substring' $substring is a regular expression.
stringZ=abcABC123ABCabc # || echo `expr match "$stringZ" 'abc[AZ]*.2'` echo `expr "$stringZ" : 'abc[AZ]*.2'` # 8 # 8

Index expr index $string $substring Numerical position in $string of first character in $substring that matches.
stringZ=abcABC123ABCabc echo `expr index "$stringZ" C12`

# 6 # C position. # 3

echo `expr index "$stringZ" 1c` # 'c' (in #3 position) matches before '1'.

This is the near equivalent of strchr() in C. Substring Extraction ${string:position} Extracts substring from $string at $position. If the $string parameter is "*" or "@", then this extracts the positional parameters, [28] starting at $position. ${string:position:length} Extracts $length characters of substring from $string at $position.
stringZ=abcABC123ABCabc # 0123456789..... # 0based indexing. echo ${stringZ:0} echo ${stringZ:1} echo ${stringZ:7} echo ${stringZ:7:3} # abcABC123ABCabc # bcABC123ABCabc # 23ABCabc # 23A # Three characters of substring.

Chapter 9. Variables Revisited

88

Advanced BashScripting Guide

# Is it possible to index from the right end of the string? echo ${stringZ:4} # abcABC123ABCabc # Defaults to full string, as in ${parameter:default}. # However . . . echo ${stringZ:(4)} # Cabc echo ${stringZ: 4} # Cabc # Now, it works. # Parentheses or added space "escape" the position parameter. # Thank you, Dan Jacobson, for pointing this out.

If the $string parameter is "*" or "@", then this extracts a maximum of $length positional parameters, starting at $position.
echo ${*:2} echo ${@:2} echo ${*:2:3} # Echoes second and following positional parameters. # Same as above. # Echoes three positional parameters, starting at second.

expr substr $string $position $length Extracts $length characters from $string starting at $position.
stringZ=abcABC123ABCabc # 123456789...... # 1based indexing. echo `expr substr $stringZ 1 2` echo `expr substr $stringZ 4 3` # ab # ABC

expr match "$string" '\($substring\)' Extracts $substring at beginning of $string, where $substring is a regular expression. expr "$string" : '\($substring\)' Extracts $substring at beginning of $string, where $substring is a regular expression.
stringZ=abcABC123ABCabc # ======= echo `expr match "$stringZ" '\(.[bc]*[AZ]..[09]\)'` echo `expr "$stringZ" : '\(.[bc]*[AZ]..[09]\)'` echo `expr "$stringZ" : '\(.......\)'` # All of the above forms give an identical result. # abcABC1 # abcABC1 # abcABC1

expr match "$string" '.*\($substring\)' Extracts $substring at end of $string, where $substring is a regular expression. expr "$string" : '.*\($substring\)' Extracts $substring at end of $string, where $substring is a regular expression.
stringZ=abcABC123ABCabc # ====== echo `expr match "$stringZ" '.*\([AC][AC][AC][ac]*\)'` echo `expr "$stringZ" : '.*\(......\)'` # ABCabc # ABCabc

Substring Removal ${string#substring} Chapter 9. Variables Revisited 89

Advanced BashScripting Guide Strips shortest match of $substring from front of $string. ${string##substring} Strips longest match of $substring from front of $string.
stringZ=abcABC123ABCabc # || # || echo ${stringZ#a*C} # 123ABCabc # Strip out shortest match between 'a' and 'C'. echo ${stringZ##a*C} # abc # Strip out longest match between 'a' and 'C'.

${string%substring} Strips shortest match of $substring from back of $string. For example:
# Rename all filenames in $PWD with "TXT" suffix to a "txt" suffix. # For example, "file1.TXT" becomes "file1.txt" . . . SUFF=TXT suff=txt for i in $(ls *.$SUFF) do mv f $i ${i%.$SUFF}.$suff # Leave unchanged everything *except* the shortest pattern match #+ starting from the righthandside of the variable $i . . . done ### This could be condensed into a "oneliner" if desired. # Thank you, Rory Winston.

${string%%substring} Strips longest match of $substring from back of $string.

stringZ=abcABC123ABCabc # || # || echo ${stringZ%b*c} # abcABC123ABCa # Strip out shortest match between 'b' and 'c', from back of $stringZ. echo ${stringZ%%b*c} # a # Strip out longest match between 'b' and 'c', from back of $stringZ.

This operator is useful for generating filenames.

Example 911. Converting graphic file formats, with filename change

#!/bin/bash # cvt.sh: # Converts all the MacPaint image files in a directory to "pbm" format. # Uses the "macptopbm" binary from the "netpbm" package, #+ which is maintained by Brian Henderson ([email protected]). # Netpbm is a standard part of most Linux distros.

Chapter 9. Variables Revisited

90

Advanced BashScripting Guide

OPERATION=macptopbm SUFFIX=pbm # New filename suffix. if [ n "$1" ] then directory=$1 else directory=$PWD fi

# If directory name given as a script argument... # Otherwise use current working directory.

# Assumes all files in the target directory are MacPaint image files, #+ with a ".mac" filename suffix. for file in $directory/* do filename=${file%.*c} # Filename globbing.

# Strip ".mac" suffix off filename #+ ('.*c' matches everything #+ between '.' and 'c', inclusive). $OPERATION $file > "$filename.$SUFFIX" # Redirect conversion to new filename. rm f $file # Delete original files after converting. echo "$filename.$SUFFIX" # Log what is happening to stdout. done exit 0 # Exercise: # # As it stands, this script converts *all* the files in the current #+ working directory. # Modify it to work *only* on files with a ".mac" suffix.

Example 912. Converting streaming audio files to ogg

#!/bin/bash # ra2ogg.sh: Convert streaming audio files (*.ra) to ogg. # Uses the "mplayer" media player program: # http://www.mplayerhq.hu/homepage # Appropriate codecs may need to be installed for this script to work. # Uses the "ogg" library and "oggenc": # http://www.xiph.org/

OFILEPREF=${1%%ra} # Strip off the "ra" suffix. OFILESUFF=wav # Suffix for wav file. OUTFILE="$OFILEPREF""$OFILESUFF" E_NOARGS=65 if [ z "$1" ] # Must specify a filename to convert. then echo "Usage: `basename $0` [filename]" exit $E_NOARGS fi

########################################################################## mplayer "$1" ao pcm:file=$OUTFILE oggenc "$OUTFILE" # Correct file extension automatically added by oggenc. ##########################################################################

Chapter 9. Variables Revisited

91

Advanced BashScripting Guide

rm "$OUTFILE" # Delete intermediate *.wav file. # If you want to keep it, comment out above line.

exit $? # # # #+ # #+ Note: On a Website, simply clicking on a *.ram streaming audio file usually only downloads the URL of the actual audio file, the *.ra file. You can then use "wget" or something similar to download the *.ra file itself.

# # # # # # #+ # #+

Exercises: As is, this script converts only *.ra filenames. Add flexibility by permitting use of *.ram and other filenames. If you're really ambitious, expand the script to do automatic downloads and conversions of streaming audio files. Given a URL, batch download streaming audio files (using "wget") and convert them.

A simple emulation of getopt using substring extraction constructs.

Example 913. Emulating getopt

#!/bin/bash # getoptsimple.sh # Author: Chris Morgan # Used in the ABS Guide with permission.

getopt_simple() { echo "getopt_simple()" echo "Parameters are '$*'" until [ z "$1" ] do echo "Processing parameter of: '$1'" if [ ${1:0:1} = '/' ] then tmp=${1:1} # Strip off leading '/' . . . parameter=${tmp%%=*} # Extract name. value=${tmp##*=} # Extract value. echo "Parameter: '$parameter', value: '$value'" eval $parameter=$value fi shift done } # Pass all options to getopt_simple(). getopt_simple $* echo "test is '$test'" echo "test2 is '$test2'" exit 0

Chapter 9. Variables Revisited

92

Advanced BashScripting Guide

sh getopt_example.sh /test=value1 /test2=value2 Parameters are '/test=value1 /test2=value2' Processing parameter of: '/test=value1' Parameter: 'test', value: 'value1' Processing parameter of: '/test2=value2' Parameter: 'test2', value: 'value2' test is 'value1' test2 is 'value2'

Substring Replacement ${string/substring/replacement} Replace first match of $substring with $replacement. ${string//substring/replacement} Replace all matches of $substring with $replacement.
stringZ=abcABC123ABCabc echo ${stringZ/abc/xyz} # xyzABC123ABCabc # Replaces first match of 'abc' with 'xyz'. # xyzABC123ABCxyz # Replaces all matches of 'abc' with # 'xyz'.

echo ${stringZ//abc/xyz}

${string/#substring/replacement} If $substring matches front end of $string, substitute $replacement for $substring. ${string/%substring/replacement} If $substring matches back end of $string, substitute $replacement for $substring.
stringZ=abcABC123ABCabc echo ${stringZ/#abc/XYZ} # XYZABC123ABCabc # Replaces frontend match of 'abc' with 'XYZ'. # abcABC123ABCXYZ # Replaces backend match of 'abc' with 'XYZ'.

echo ${stringZ/%abc/XYZ}

9.2.1. Manipulating strings using awk

A Bash script may invoke the string manipulation facilities of awk as an alternative to using its builtin operations.

Example 914. Alternate ways of extracting substrings

#!/bin/bash # substringextraction.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'.

Chapter 9. Variables Revisited

93

Advanced BashScripting Guide

echo ${String:2:4} # position 3 (012), 4 characters long # skid # The awk equivalent of ${string:pos:length} is substr(string,pos,length). echo | awk ' { print substr("'"${String}"'",3,4) # skid } ' # Piping an empty "echo" to awk gives it dummy input, #+ and thus makes it unnecessary to supply a filename. exit 0

9.2.2. Further Discussion

For more on string manipulation in scripts, refer to Section 9.3 and the relevant section of the expr command listing. For script examples, see: 1. Example 159 2. Example 917 3. Example 918 4. Example 919 5. Example 921

9.3. Parameter Substitution

Manipulating and/or expanding variables ${parameter} Same as $parameter, i.e., value of the variable parameter. In certain contexts, only the less ambiguous ${parameter} form works. May be used for concatenating variables with strings.
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"

${parameterdefault}, ${parameter:default} If parameter not set, use default.

echo ${username`whoami`} # Echoes the result of `whoami`, if variable $username is still unset.

${parameterdefault} and ${parameter:default} are almost equivalent. The extra : makes a difference only when parameter has been declared, but is null.
#!/bin/bash # paramsub.sh

Chapter 9. Variables Revisited

94

Advanced BashScripting Guide

# Whether a variable has been declared #+ affects triggering of the default option #+ even if the variable is null. username0= echo "username0 has been declared, but is set to null." echo "username0 = ${username0`whoami`}" # Will not echo. echo echo username1 has not been declared. echo "username1 = ${username1`whoami`}" # Will echo. username2= echo "username2 has been declared, but is set to null." echo "username2 = ${username2:`whoami`}" # ^ # Will echo because of : rather than just in condition test. # Compare to first instance, above.

# # Once again: variable= # variable has been declared, but is set to null. echo "${variable0}" echo "${variable:1}" # ^ unset variable echo "${variable2}" echo "${variable:3}" exit 0 # 2 # 3 # (no output) # 1

The default parameter construct finds use in providing "missing" commandline arguments in scripts.
DEFAULT_FILENAME=generic.data filename=${1:$DEFAULT_FILENAME} # If not otherwise specified, the following command block operates #+ on the file "generic.data". # # Commands follow.

See also Example 34, Example 282, and Example A6. Compare this method with using an and list to supply a default commandline argument. ${parameter=default}, ${parameter:=default} If parameter not set, set it to default. Both forms nearly equivalent. The : makes a difference only when $parameter has been declared and is null, [29] as above.

Chapter 9. Variables Revisited

95

Advanced BashScripting Guide

echo ${username=`whoami`} # Variable "username" is now set to `whoami`.

${parameter+alt_value}, ${parameter:+alt_value} If parameter set, use alt_value, else use null string. Both forms nearly equivalent. The : makes a difference only when parameter has been declared and is null, see below.
echo "###### \${parameter+alt_value} ########" echo a=${param1+xyz} echo "a = $a" param2= a=${param2+xyz} echo "a = $a" param3=123 a=${param3+xyz} echo "a = $a"

# a =

# a = xyz

# 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 param6=123 a=${param6:+xyz} echo "a = $a"

a=${param5+xyz}

# a = xyz

${parameter?err_msg}, ${parameter:?err_msg} If parameter set, use it, else print err_msg. Both forms nearly equivalent. The : makes a difference only when parameter has been declared and is null, as above.

Example 915. Using parameter substitution and error messages

#!/bin/bash # # # #+ Check some of the system's environmental variables. This is good preventative maintenance. If, for example, $USER, the name of the person at the console, is not set, the machine will not recognize you.

: ${HOSTNAME?} ${USER?} ${HOME?} ${MAIL?} echo echo "Name of the machine is $HOSTNAME." echo "You are $USER." echo "Your home directory is $HOME."

Chapter 9. Variables Revisited

96

Advanced BashScripting Guide

echo "Your mail INBOX is located in $MAIL." echo echo "If you are reading this message," echo "critical environmental variables have been set." echo echo # # The ${variablename?} construction can also check #+ for variables set within the script. ThisVariable=ValueofThisVariable # 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

: ${ZZXy23AB?"ZZXy23AB has not been set."} # If ZZXy23AB has not been set, #+ then the script terminates with an error message. # You can specify the error message. # : ${variablename?"ERROR MESSAGE"}

# Same result with: # # #

dummy_variable=${ZZXy23AB?} dummy_variable=${ZZXy23AB?"ZXy23AB has not been set."} echo ${ZZXy23AB?} >/dev/null

# Compare these methods of checking whether a variable has been set #+ with "set u" . . .

echo "You will not see this message, because script already terminated." HERE=0 exit $HERE

# Will NOT exit here.

# In fact, this script will return an exit status (echo $?) of 1.

Example 916. Parameter substitution and "usage" messages

#!/bin/bash # usagemessage.sh : ${1?"Usage: $0 ARGUMENT"} # Script exits here if commandline parameter absent, #+ with following error message. # usagemessage.sh: 1: Usage: usagemessage.sh ARGUMENT echo "These two lines echo only if commandline parameter given." echo "command line parameter = \"$1\"" exit 0 # Will exit here only if commandline parameter present.

Chapter 9. Variables Revisited

97

Advanced BashScripting Guide

# Check the exit status, both with and without commandline parameter. # If commandline parameter present, then "$?" is 0. # If not, then "$?" is 1.

Parameter substitution and/or expansion. The following expressions are the complement to the match in expr string operations (see Example 159). These particular ones are used mostly in parsing file path names. Variable length / Substring removal ${#var} String length (number of characters in $var). For an array, ${#array} is the length of the first element in the array. Exceptions: ${#*} and ${#@} give the number of positional parameters. For an array, ${#array[*]} and ${#array[@]} give the number of elements in the array. Example 917. Length of a variable
#!/bin/bash # length.sh E_NO_ARGS=65 if [ $# eq 0 ] # Must have commandline args to demo script. then echo "Please invoke this script with one or more commandline arguments." exit $E_NO_ARGS fi var01=abcdEFGH28ij echo "var01 = ${var01}" echo "Length of var01 = ${#var01}" # Now, let's try embedding a space. var02="abcd EFGH28ij" echo "var02 = ${var02}" echo "Length of var02 = ${#var02}" echo "Number of commandline arguments passed to script = ${#@}" echo "Number of commandline arguments passed to script = ${#*}" exit 0

${var#Pattern}, ${var##Pattern} Remove from $var the shortest/longest part of $Pattern that matches the front end of $var. A usage illustration from Example A7:
# Function from "daysbetween.sh" example. # Strips leading zero(s) from argument passed. strip_leading_zero () # Strip possible leading zero(s) { #+ from argument passed. return=${1#0} # The "1" refers to "$1" passed arg. } # The "0" is what to remove from "$1" strips zeros.

Manfred Schwarb's more elaborate variation of the above: Chapter 9. Variables Revisited 98

Advanced BashScripting Guide

strip_leading_zero2 () # Strip possible leading zero(s), since otherwise { # Bash will interpret such numbers as octal values. shopt s extglob # Turn on extended globbing. local val=${1##+(0)} # Use local variable, longest matching series of 0's. shopt u extglob # Turn off extended globbing. _strip_leading_zero2=${val:0} # If input was 0, return 0 instead of "". }

Another usage illustration:

echo `basename $PWD` echo "${PWD##*/}" echo echo `basename $0` echo $0 echo "${0##*/}" echo filename=test.data echo "${filename##*.}" # Basename of current working directory. # Basename of current working directory. # Name of script. # Name of script. # Name of script.

# data # Extension of filename.

${var%Pattern}, ${var%%Pattern} Remove from $var the shortest/longest part of $Pattern that matches the back end of $var. Version 2 of Bash added additional options.

Example 918. Pattern matching in parameter substitution

#!/bin/bash # pattmatching.sh # Pattern matching using the # ## % %% parameter substitution operators.

var1=abcd12345abc6789 pattern1=a*c # * (wild card) matches everything between a c. echo echo "var1 = $var1" echo "var1 = ${var1}"

# abcd12345abc6789 # abcd12345abc6789 # (alternate form) echo "Number of characters in ${var1} = ${#var1}" echo echo "pattern1 = $pattern1" # a*c (everything between 'a' and 'c') echo "" echo '${var1#$pattern1} =' "${var1#$pattern1}" # d12345abc6789 # Shortest possible match, strips out first 3 characters abcd12345abc6789 # ^^^^^ || echo '${var1##$pattern1} =' "${var1##$pattern1}" # 6789 # Longest possible match, strips out first 12 characters abcd12345abc6789 # ^^^^^ || echo; echo; echo pattern2=b*9 # everything between 'b' and '9' echo "var1 = $var1" # Still abcd12345abc6789 echo echo "pattern2 = $pattern2" echo ""

Chapter 9. Variables Revisited

99

Advanced BashScripting Guide

echo '${var1%pattern2} =' "${var1%$pattern2}" # # Shortest possible match, strips out last 6 characters # ^^^^ echo '${var1%%pattern2} =' "${var1%%$pattern2}" # # Longest possible match, strips out last 12 characters # ^^^^ abcd12345a abcd12345abc6789 || a abcd12345abc6789 ||

# Remember, # and ## work from the left end (beginning) of string, # % and %% work from the right end. echo exit 0

Example 919. Renaming file extensions:

#!/bin/bash # rfe.sh: Renaming file extensions. # # rfe old_extension new_extension # # Example: # To rename all *.gif files in working directory to *.jpg, # rfe gif jpg

E_BADARGS=65 case $# in 0|1) # The vertical bar means "or" in this context. echo "Usage: `basename $0` old_file_suffix new_file_suffix" exit $E_BADARGS # If 0 or 1 arg, then bail out. ;; esac

for filename in *.$1 # Traverse list of files ending with 1st argument. do mv $filename ${filename%$1}$2 # Strip off part of filename matching 1st argument, #+ then append 2nd argument. done exit 0

Variable expansion / Substring replacement These constructs have been adopted from ksh. ${var:pos} Variable var expanded, starting from offset pos. ${var:pos:len} Expansion to a max of len characters of variable var, from offset pos. See Example A14 for an example of the creative use of this operator. ${var/Pattern/Replacement} First match of Pattern, within var replaced with Replacement. If Replacement is omitted, then the first match of Pattern is replaced by nothing, that is, deleted. Chapter 9. Variables Revisited 100

Advanced BashScripting Guide ${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.

Example 920. Using pattern matching to parse arbitrary strings

#!/bin/bash var1=abcd1234defg 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, Stephane Chazelas, 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" # Same effect as t=`basename $path_name` in this particular case. # t=${path_name%/}; t=${t##*/} is a more general solution, #+ but still fails sometimes. # If $path_name ends with a newline, then `basename $path_name` will not work, #+ but the above expression will. # (Thanks, S.C.) 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

Chapter 9. Variables Revisited

101

Advanced BashScripting Guide

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} If prefix of var matches Pattern, then substitute Replacement for Pattern. ${var/%Pattern/Replacement} If suffix of var matches Pattern, then substitute Replacement for Pattern.

Example 921. Matching patterns at prefix or suffix of string

#!/bin/bash # varmatch.sh: # Demo of pattern replacement at prefix / suffix of string. v0=abc1234zip1234abc echo "v0 = $v0" echo # Original variable. # abc1234zip1234abc

# Match at prefix (beginning) of string. v1=${v0/#abc/ABCDEF} # abc1234zip1234abc # || echo "v1 = $v1" # ABCDEF1234zip1234abc # || # Match at suffix (end) of string. v2=${v0/%abc/ABCDEF} # abc1234zip123abc # || echo "v2 = $v2" # abc1234zip1234ABCDEF # || 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@} Matches all previously declared variables beginning with varprefix.
xyz23=whatever xyz24= a=${!xyz*} # Expands to names of declared variables beginning with "xyz".

Chapter 9. Variables Revisited

102

Advanced BashScripting Guide

echo "a = $a" a=${!xyz@} echo "a = $a" # a = xyz23 xyz24 # Same as above. # a = xyz23 xyz24

# Bash, version 2.04, adds this feature.

9.4. Typing variables: declare or typeset

The declare or typeset builtins (they are exact synonyms) permit restricting the properties of variables. This is a very weak form of the typing available in certain programming languages. The declare command is specific to version 2 or later of Bash. The typeset command also works in ksh scripts. declare/typeset options r readonly
declare r var1

(declare r var1 works the same as readonly 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 the string "three" as an integer.

Certain arithmetic operations are permitted for declared integer variables without the need for expr or let.
n=6/3 echo "n = $n" declare i n n=6/3 echo "n = $n"

# n = 6/3

# n = 2

a array
declare a indices

The variable indices will be treated as an array. f function(s)

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

Chapter 9. Variables Revisited

103

Advanced BashScripting Guide A declare f function_name in a script lists just the function named. x export
declare x var3

This declares a variable as available for exporting outside the environment of the script itself. x var=$value
declare x var3=373

The declare command permits assigning a value to a variable in the same statement as setting its properties.

Example 922. Using declare to type variables

#!/bin/bash func1 () { echo This is a function. } declare f echo declare i var1 # var1 is an integer. var1=2367 echo "var1 declared as $var1" var1=var1+1 # Integer declaration eliminates the need for 'let'. echo "var1 incremented by 1 is $var1." # Attempt to change variable declared as integer. echo "Attempting to change var1 to floating point value, 2367.1." var1=2367.1 # Results in error message, with no change to variable. echo "var1 is still $var1" echo declare r var2=13.36 # 'declare' permits setting a variable property #+ and simultaneously assigning it a value. echo "var2 declared as $var2" # Attempt to change readonly variable. var2=13.37 # Generates error message, and exit from script. echo "var2 is still $var2" exit 0 # This line will not execute. # Script will not exit here. # Lists the function above.

Using the declare builtin restricts the scope of a variable.

foo () { FOO="bar" } bar () { foo echo $FOO }

Chapter 9. Variables Revisited

104

Advanced BashScripting Guide

bar # Prints bar.

However . . .
foo (){ declare FOO="bar" } bar () { foo echo $FOO } bar # Prints nothing.

# Thank you, Michael Iatrou, for pointing this out.

9.5. Indirect References to Variables

Assume that the value of a variable is the name of a second variable. Is it somehow possible to retrieve the value of this second variable from the first one? For example, if a=letter_of_alphabet and letter_of_alphabet=z, can a reference to a return z? This can indeed be done, and it is called an indirect reference. It uses the unusual eval var1=\$$var2 notation.

Example 923. Indirect References

#!/bin/bash # indref.sh: Indirect variable referencing. # Accessing the contents of the contents of a variable. a=letter_of_alphabet letter_of_alphabet=z echo # Direct reference. echo "a = $a" # Indirect reference. eval a=\$$a echo "Now a = $a" echo # Variable "a" holds the name of another variable.

# a = letter_of_alphabet

# Now a = z

# Now, let's try changing the secondorder reference. t=table_cell_3 table_cell_3=24 echo "\"table_cell_3\" = $table_cell_3" # "table_cell_3" = 24 echo n "dereferenced \"t\" = "; eval echo \$$t # dereferenced "t" = 24 # In this simple case, the following also works (why?). # eval t=\$$t; echo "\"t\" = $t"

Chapter 9. Variables Revisited

105

Advanced BashScripting Guide

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 # (Thanks, Stephane Chazelas, for clearing up the above behavior.)

# Another method is the ${!t} notation, discussed in "Bash, version 2" section. # See also ex78.sh. exit 0

Of what practical use is indirect referencing of variables? It gives Bash a little of the functionality of pointers in C, for instance, in table lookup. And, it also has some other very interesting applications. . . . Nils Radtke shows how to build "dynamic" variable names and evaluate their contents. This can be useful when sourcing configuration files.
#!/bin/bash

# # This could be "sourced" from a separate file. isdnMyProviderRemoteNet=172.16.0.100 isdnYourProviderRemoteNet=10.0.0.10 isdnOnlineService="MyProvider" #

remoteNet=$(eval remoteNet=$(eval remoteNet=$(eval remoteNet=$(eval echo "$remoteNet"

"echo "echo "echo "echo

\$$(echo isdn${isdnOnlineService}RemoteNet)") \$$(echo isdnMyProviderRemoteNet)") \$isdnMyProviderRemoteNet") $isdnMyProviderRemoteNet")

# 172.16.0.100

# ================================================================ # And, it gets even better.

# Consider the following snippet given a variable named getSparc, #+ but no such variable getIa64: chkMirrorArchs () { arch="$1"; if [ "$(eval "echo \${$(echo get$(echo ne $arch | sed 's/^\(.\).*/\1/g' | tr 'az' 'AZ'; echo $arch | sed 's/^.\(.*\)/\1/g')):false}")" = true ] then return 0; else return 1;

Chapter 9. Variables Revisited

106

Advanced BashScripting Guide

fi; } getSparc="true" unset getIa64 chkMirrorArchs sparc echo $? # 0 # True chkMirrorArchs Ia64 echo $? # 1 # False # # # # # Notes: Even the tobesubstituted variable name part is built explicitly. The parameters to the chkMirrorArchs calls are all lower case. The variable name is composed of two parts: "get" and "Sparc" . . .

Example 924. Passing an indirect reference to awk

#!/bin/bash # Another version of the "column totaler" script #+ that adds up a specified column (of numbers) in the target file. # This one uses indirect references. ARGS=2 E_WRONGARGS=65 if [ $# ne "$ARGS" ] # Check for proper no. of command line args. then echo "Usage: `basename $0` filename columnnumber" exit $E_WRONGARGS fi filename=$1 column_number=$2 #===== Same as original script, up to this point =====#

# A multiline awk script is invoked by

awk ' ..... '

# Begin awk script. # awk " { total += \$${column_number} # indirect reference } END { print total } " "$filename" # # End awk script. # Indirect variable reference avoids the hassles #+ of referencing a shell variable within the embedded awk script.

Chapter 9. Variables Revisited

107

Advanced BashScripting Guide

# Thanks, Stephane Chazelas.

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 342 and Example A23) makes indirect referencing more intuitive. Bash does not support pointer arithmetic, and this severely limits the usefulness of indirect referencing. In fact, indirect referencing in a scripting language is an ugly kludge.

9.6. $RANDOM: generate random integer

$RANDOM is an internal Bash function (not a constant) that returns a pseudorandom [30] integer in the range 0 32767. It should not be used to generate an encryption key.

Example 925. Generating random numbers

#!/bin/bash # $RANDOM returns a different random integer at each invocation. # Nominal range: 0 32767 (signed 16bit integer). 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 echo

$number"

Chapter 9. Variables Revisited

108

Advanced BashScripting Guide

# If you need a random integer greater than a lower bound, #+ then set up a test to discard all numbers below that. FLOOR=200 number=0 #initialize while [ "$number" le $FLOOR ] do number=$RANDOM done echo "Random number greater than $FLOOR echo

$number"

# Let's examine a simple alternative to the above loop, namely # let "number = $RANDOM + $FLOOR" # That would eliminate the whileloop and run faster. # But, there might be a problem with that. What is it?

# 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

# Generate binary choice, that is, "true" or "false" value. BINARY=2 T=1 number=$RANDOM let "number %= $BINARY" # Note that let "number >>= 14" gives a better random distribution #+ (right shifts out everything except last binary digit). if [ "$number" eq $T ] then echo "TRUE" else echo "FALSE" fi echo

# Generate a toss of the dice. SPOTS=6 # Modulo 6 gives range 0 5. # Incrementing by 1 gives desired range of 1 6. # Thanks, Paulo Marcel Coelho Aragao, for the simplification. die1=0 die2=0 # Would it be better to just set SPOTS=7 and not add 1? Why or why not? # Tosses each die separately, and so gives correct odds. let "die1 = $RANDOM % $SPOTS +1" # Roll first one. let "die2 = $RANDOM % $SPOTS +1" # Roll second one.

Chapter 9. Variables Revisited

109

Advanced BashScripting Guide

# Which arithmetic operation, above, has greater precedence #+ modulo (%) or addition (+)?

let "throw = $die1 + $die2" echo "Throw of the dice = $throw" echo

exit 0

Example 926. Picking a random card from a deck

#!/bin/bash # pickcard.sh # This is an example of choosing random elements of an array.

# Pick a card, any card. Suites="Clubs Diamonds Hearts Spades" Denominations="2 3 4 5 6 7 8 9 10 Jack Queen King Ace" # Note variables spread over multiple lines.

suite=($Suites) denomination=($Denominations)

# Read into array variable.

num_suites=${#suite[*]} # Count how many elements. num_denominations=${#denomination[*]} echo n "${denomination[$((RANDOM%num_denominations))]} of " echo ${suite[$((RANDOM%num_suites))]}

# $bozo sh pickcards.sh # Jack of Clubs

# Thank you, "jipe," for pointing out this use of $RANDOM. exit 0

Jipe points out a set of techniques for generating random numbers within a range. Chapter 9. Variables Revisited 110

Advanced BashScripting Guide

# Generate random number between 6 and 30. rnumber=$((RANDOM%25+6))

# Generate random number in the same 6 30 range, #+ but the number must be evenly divisible by 3. rnumber=$(((RANDOM%30/3+1)*3)) # # # Note that this will not work all the time. It fails if $RANDOM%30 returns 0. Frank Wang suggests the following alternative: rnumber=$(( RANDOM%27/3*3+6 ))

Bill Gradwohl came up with an improved formula that works for positive numbers.
rnumber=$(((RANDOM%(maxmin+divisibleBy))/divisibleBy*divisibleBy+min))

Here Bill presents a versatile function that returns a random number between two specified values.

Example 927. Random between values

#!/bin/bash # randombetween.sh # Random number between two specified values. # Script by Bill Gradwohl, with minor modifications by the document author. # Used with permission.

randomBetween() { # Generates a positive or negative random number #+ between $min and $max #+ and divisible by $divisibleBy. # Gives a "reasonably random" distribution of return values. # # Bill Gradwohl Oct 1, 2003 syntax() { # Function echo echo echo echo n echo echo echo echo n echo echo echo echo echo n echo echo echo n echo echo n echo }

embedded within function. "Syntax: randomBetween [min] [max] [multiple]" "Expects up to 3 passed parameters, " "but all are completely optional." "min is the minimum value" "max is the maximum value" "multiple specifies that the answer must be " "a multiple of this value." " i.e. answer must be evenly divisible by this number." "If any value is missing, defaults area supplied as: 0 32767 1" "Successful completion returns 0, " "unsuccessful completion returns" "function syntax and 1." "The answer is returned in the global variable " "randomBetweenAnswer" "Negative values for any passed parameter are " "handled correctly."

local min=${1:0} local max=${2:32767}

Chapter 9. Variables Revisited

111

Advanced BashScripting Guide

local divisibleBy=${3:1} # Default values assigned, in case parameters not passed to function. local x local spread # Let's make sure the divisibleBy value is positive. [ ${divisibleBy} lt 0 ] && divisibleBy=$((0divisibleBy)) # Sanity check. if [ $# gt 3 o ${divisibleBy} eq 0 o syntax return 1 fi # See if the min and max are reversed. if [ ${min} gt ${max} ]; then # Swap them. x=${min} min=${max} max=${x} fi # If min is itself not evenly divisible by $divisibleBy, #+ then fix the min to be within range. if [ $((min/divisibleBy*divisibleBy)) ne ${min} ]; then if [ ${min} lt 0 ]; then min=$((min/divisibleBy*divisibleBy)) else min=$((((min/divisibleBy)+1)*divisibleBy)) fi fi # If max is itself not evenly divisible by $divisibleBy, #+ then fix the max to be within range. if [ $((max/divisibleBy*divisibleBy)) ne ${max} ]; then if [ ${max} lt 0 ]; then max=$((((max/divisibleBy)1)*divisibleBy)) else max=$((max/divisibleBy*divisibleBy)) fi fi # # Now, to do the real work.

${min} eq ${max} ]; then

# Note that to get a proper distribution for the end points, #+ the range of random values has to be allowed to go between #+ 0 and abs(maxmin)+divisibleBy, not just abs(maxmin)+1. # The slight increase will produce the proper distribution for the #+ end points. # #+ #+ #+ # Changing the formula to use abs(maxmin)+1 will still produce correct answers, but the randomness of those answers is faulty in that the number of times the end points ($min and $max) are returned is considerably lower than when the correct formula is used.

spread=$((maxmin)) # Omair Eshkenazi points out that this test is unnecessary, #+ since max and min have already been switched around.

Chapter 9. Variables Revisited

112

Advanced BashScripting Guide

[ ${spread} lt 0 ] && spread=$((0spread)) let spread+=divisibleBy randomBetweenAnswer=$(((RANDOM%spread)/divisibleBy*divisibleBy+min)) return 0 # #+ #+ # # # } # Let's test the function. min=14 max=20 divisibleBy=3 However, Paulo Marcel Coelho Aragao points out that when $max and $min are not divisible by $divisibleBy, the formula fails. He suggests instead the following formula: rnumber = $(((RANDOM%(maxmin+1)+min)/divisibleBy*divisibleBy))

# Generate an array of expected answers and check to make sure we get #+ at least one of each answer if we loop long enough. declare a answer minimum=${min} maximum=${max} if [ $((minimum/divisibleBy*divisibleBy)) ne ${minimum} ]; then if [ ${minimum} lt 0 ]; then minimum=$((minimum/divisibleBy*divisibleBy)) else minimum=$((((minimum/divisibleBy)+1)*divisibleBy)) fi fi

# If max is itself not evenly divisible by $divisibleBy, #+ then fix the max to be within range. if [ $((maximum/divisibleBy*divisibleBy)) ne ${maximum} ]; then if [ ${maximum} lt 0 ]; then maximum=$((((maximum/divisibleBy)1)*divisibleBy)) else maximum=$((maximum/divisibleBy*divisibleBy)) fi fi

# We need to generate only positive array subscripts, #+ so we need a displacement that that will guarantee #+ positive results. disp=$((0minimum)) for ((i=${minimum}; i<=${maximum}; i+=divisibleBy)); do answer[i+disp]=0 done

# Now loop a large number of times to see what we get. loopIt=1000 # The script author suggests 100000, #+ but that takes a good long while.

Chapter 9. Variables Revisited

113

Advanced BashScripting Guide

for ((i=0; i<${loopIt}; ++i)); do # Note that we are specifying min and max in reversed order here to #+ make the function correct for this case. randomBetween ${max} ${min} ${divisibleBy} # Report an error if an answer is unexpected. [ ${randomBetweenAnswer} lt ${min} o ${randomBetweenAnswer} gt ${max} ] \ && echo MIN or MAX error ${randomBetweenAnswer}! [ $((randomBetweenAnswer%${divisibleBy})) ne 0 ] \ && echo DIVISIBLE BY error ${randomBetweenAnswer}! # Store the answer away statistically. answer[randomBetweenAnswer+disp]=$((answer[randomBetweenAnswer+disp]+1)) done

# Let's check the results for ((i=${minimum}; i<=${maximum}; i+=divisibleBy)); do [ ${answer[i+displacement]} eq 0 ] \ && echo "We never got an answer of $i." \ || echo "${i} occurred ${answer[i+displacement]} times." done

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 . . .

Example 928. Rolling a single die with RANDOM

#!/bin/bash # How random is RANDOM? RANDOM=$$ PIPS=6 MAXTHROWS=600 throw=0 ones=0 twos=0 threes=0 fours=0 fives=0 sixes=0 # Reseed the random number generator using script process ID. # A die has 6 pips. # Increase this if you have nothing better to do with your time. # Throw count. # Must initialize counts to zero, #+ since an uninitialized variable is null, not zero.

print_result () { echo echo "ones = $ones" echo "twos = $twos" echo "threes = $threes" echo "fours = $fours" echo "fives = $fives" echo "sixes = $sixes"

Chapter 9. Variables Revisited

114

Advanced BashScripting Guide

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

while [ "$throw" lt "$MAXTHROWS" ] do let "die1 = RANDOM % $PIPS" update_count $die1 let "throw += 1" done print_result exit 0 # # # # #+ The scores should distribute fairly evenly, assuming RANDOM is fairly random. With $MAXTHROWS at 600, all should cluster around 100, plusorminus 20 or so. Keep in mind that RANDOM is a pseudorandom generator, and not a spectacularly good one at that.

# Randomness is a deep and complex subject. # Sufficiently long "random" sequences may exhibit #+ chaotic and other "nonrandom" behavior. # # # # Exercise (easy): Rewrite this script to flip a coin 1000 times. Choices are "HEADS" and "TAILS".

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. [31] (This mirrors the behavior of the random() function in C.)

Example 929. Reseeding RANDOM

#!/bin/bash # seedingrandom.sh: Seeding the RANDOM variable. MAXCOUNT=25 # How many numbers to generate.

random_numbers () { count=0 while [ "$count" lt "$MAXCOUNT" ] do

Chapter 9. Variables Revisited

115

Advanced BashScripting Guide

number=$RANDOM echo n "$number " let "count += 1" done } echo; echo RANDOM=1 random_numbers echo; echo RANDOM=1 random_numbers # Same seed for RANDOM... # ...reproduces the exact same number series. # # When is it useful to duplicate a "random" number series? # Setting RANDOM seeds the random number generator.

echo; echo RANDOM=2 random_numbers echo; echo # RANDOM=$$ seeds RANDOM from process id of script. # It is also possible to seed RANDOM from 'time' or 'date' commands. # Getting fancy... SEED=$(head 1 /dev/urandom | od N 1 | awk '{ print $2 }') # Pseudorandom output fetched #+ from /dev/urandom (system pseudorandom devicefile), #+ 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 # Trying again, but with a different seed... # gives a different number series.

The /dev/urandom devicefile provides a method 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 wellscattered pseudorandom numbers. However, assigning these numbers to a variable in a script requires a workaround, such as filtering through od (as in above example and Example 1513), or using dd (see Example 1555), or even piping to md5sum (see Example 3314).

There are also other ways to generate pseudorandom numbers in a script. Awk provides a convenient means of doing this.

Example 930. Pseudorandom numbers, using awk

#!/bin/bash # random2.sh: Returns a pseudorandom number in the range 0 1. # Uses the awk rand() function.

Chapter 9. Variables Revisited

116

Advanced BashScripting Guide

AWKSCRIPT=' { srand(); print rand() } ' # Command(s) / parameters passed to awk # Note that srand() reseeds awk's random number generator.

echo n "Random number between 0 and 1 = " echo | awk "$AWKSCRIPT" # What happens if you leave out the 'echo'? exit 0

# Exercises: # # 1) Using a loop construct, print out 10 different random numbers. # (Hint: you must reseed the "srand()" function with a different seed #+ in each pass through the loop. What happens if you fail to do this?) # 2) Using an integer multiplier as a scaling factor, generate random numbers #+ in the range between 10 and 100. # 3) Same as exercise #2, above, but generate random integers this time.

The date command also lends itself to generating pseudorandom integer sequences.

9.7. The Double Parentheses Construct

Similar to the let command, the ((...)) construct permits arithmetic expansion and evaluation. In its simplest form, a=$(( 5 + 3 )) would set "a" to "5 + 3", or 8. However, this double parentheses construct is also a mechanism for allowing Ctype manipulation of variables in Bash.

Example 931. Ctype manipulation of variables

#!/bin/bash # Manipulating a variable, Cstyle, using the ((...)) construct.

echo (( a = 23 )) # Setting a value, Cstyle, with spaces on both sides of the "=". echo "a (initial value) = $a" (( a++ )) # Postincrement 'a', Cstyle. echo "a (after a++) = $a" (( a )) # Postdecrement 'a', Cstyle. echo "a (after a) = $a"

(( ++a )) # Preincrement 'a', Cstyle. echo "a (after ++a) = $a" (( a )) # Predecrement 'a', Cstyle. echo "a (after a) = $a" echo

Chapter 9. Variables Revisited

117

Advanced BashScripting Guide

######################################################## # Note that, as in C, pre and postdecrement operators #+ have slightly different sideeffects. n=1; let n && echo "True" || echo "False" n=1; let n && echo "True" || echo "False" # False # True

# Thanks, Jeroen Domburg. ######################################################## echo (( t = a<45?7:11 )) # Cstyle trinary operator. echo "If a < 45, then t = 7, else t = 11." echo "t = $t " # Yes! echo

# # Easter Egg alert! # # Chet Ramey apparently snuck a bunch of undocumented Cstyle 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. # These work only with Bash, version 2.04 or later. exit 0

See also Example 1012 and Example 84.

Chapter 9. Variables Revisited

118

Chapter 10. Loops and Branches

Operations on code blocks are the key to structured and organized shell scripts. Looping and branching constructs provide the tools for accomplishing this.

10.1. Loops
A loop is a block of code that iterates [32] a list of commands as long as the loop control condition is true. for loops for arg in [list] This is the basic looping construct. It differs significantly from its C counterpart. for arg in [list] do command(s)... done During each pass through the loop, arg takes on the value of each successive variable in the list.
for arg in "$var1" # In pass 1 of the # In pass 2 of the # In pass 3 of the # ... # In pass N of the "$var2" "$var3" ... "$varN" loop, arg = $var1 loop, arg = $var2 loop, arg = $var3 loop, arg = $varN

# Arguments in [list] quoted to prevent possible word splitting.

The argument list may contain wild cards.

If do is on same line as for, there needs to be a semicolon after list. for arg in [list] ; do

Example 101. Simple for loops

#!/bin/bash # Listing the planets. for planet in Mercury Venus Earth Mars Jupiter Saturn Uranus Neptune Pluto do echo $planet # Each planet on a separate line. done echo for planet in "Mercury Venus Earth Mars Jupiter Saturn Uranus Neptune Pluto" # All planets on same line. # Entire 'list' enclosed in quotes creates a single variable.

Chapter 10. Loops and Branches

119

Advanced BashScripting Guide

# Why? Whitespace incorporated into the variable. do echo $planet done 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 1416) to force parsing of each [list] element and assignment of each component to the positional parameters. Example 102. 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=("$@") echo "$1 #two done $2,000,000 miles from the sun" tabsconcatenate zeroes onto parameter $2

# (Thanks, S.C., for additional clarification.) exit 0

A variable may supply the [list] in a for loop.

Example 103. Fileinfo: operating on a file list contained in a variable

#!/bin/bash # fileinfo.sh FILES="/usr/sbin/accept /usr/sbin/pwck /usr/sbin/chroot /usr/bin/fakefile /sbin/badblocks /sbin/ypbind" # List of files you are curious about. # Threw in a dummy file, /usr/bin/fakefile. echo for file in $FILES do

Chapter 10. Loops and Branches

120

Advanced BashScripting Guide

if [ ! e "$file" ] # Check if file exists. then echo "$file does not exist."; echo continue # On to next. fi ls l $file | awk '{ print $9 " file size: " $5 }' # Print 2 fields. whatis `basename $file` # File info. # Note that the whatis database needs to have been set up for this to work. # To do this, as root run /usr/bin/makewhatis. echo done exit 0

If the [list] in a for loop contains wildcards (* and ?) used in filename expansion, then globbing takes place.

Example 104. Operating on files with a for loop

#!/bin/bash # listglob.sh: Generating [list] in a forloop, using "globbing" echo for file in * # ^ Bash performs filename expansion #+ on expressions that globbing recognizes. do ls l "$file" # Lists all files in $PWD (current directory). # Recall that the wild card character "*" matches every filename, #+ however, in "globbing," it doesn't match dotfiles. # If the pattern matches no file, it is expanded to itself. # To prevent this, set the nullglob option #+ (shopt s nullglob). # Thanks, S.C. done echo; echo for file in [jx]* do rm f $file # Removes only files beginning with "j" or "x" in $PWD. echo "Removed file \"$file\"". done echo exit 0

Omitting the in [list] part of a for loop causes the loop to operate on $@ the positional parameters. A particularly clever illustration of this is Example A16. See also Example 1417.

Example 105. Missing in [list] in a for loop

#!/bin/bash

Chapter 10. Loops and Branches

121

Advanced BashScripting Guide

# Invoke this script both with and without arguments, #+ and see what happens. for a do echo n "$a " done # The 'in list' missing, therefore the loop operates on '$@' #+ (commandline argument list, including whitespace). echo exit 0

It is possible to use command substitution to generate the [list] in a for loop. See also Example 1549, Example 1010 and Example 1543.

Example 106. Generating the [list] in a for loop with command substitution
#!/bin/bash # forloopcmd.sh: forloop with [list] #+ generated by command substitution. NUMBERS="9 7 3 8 37.53" for number in `echo $NUMBERS` do echo n "$number " done echo exit 0 # for number in 9 7 3 8 37.53

Here is a somewhat more complex example of using command substitution to create the [list].

Example 107. A grep replacement for binary files

#!/bin/bash # bingrep.sh: Locates matching strings in a binary file. # A "grep" replacement for binary files. # Similar effect to "grep a" E_BADARGS=65 E_NOFILE=66 if [ $# ne 2 ] then echo "Usage: `basename $0` search_string filename" exit $E_BADARGS fi if [ ! f "$2" ] then echo "File \"$2\" does not exist." exit $E_NOFILE fi

Chapter 10. Loops and Branches

122

Advanced BashScripting Guide

IFS=$'\012' # Per suggestion of Anton Filippov. # was: IFS="\n" for word in $( strings "$2" | grep "$1" ) # The "strings" command lists strings in binary files. # Output then piped to "grep", which tests for desired string. do echo $word done # As S.C. points out, lines 23 30 could be replaced with the simpler # strings "$2" | grep "$1" | tr s "$IFS" '[\n*]'

# Try something like "./bingrep.sh mem /bin/ls" #+ to exercise this script. exit 0

More of the same.

Example 108. Listing all users on the system

#!/bin/bash # userlist.sh PASSWORD_FILE=/etc/passwd n=1 # User number for name in $(awk 'BEGIN{FS=":"}{print $1}' < "$PASSWORD_FILE" ) # Field separator = : ^^^^^^ # Print first field ^^^^^^^^ # Get input from password file ^^^^^^^^^^^^^^^^^ do echo "USER #$n = $name" let "n += 1" done

# # # # #

USER USER USER ... USER

#1 = root #2 = bin #3 = daemon #30 = bozo

exit 0 # # # #+ # Exercise: How is it that an ordinary user (or a script run by same) can read /etc/passwd? Isn't this a security hole? Why or why not?

A final example of the [list] resulting from command substitution.

Example 109. Checking all the binaries in a directory for authorship

#!/bin/bash # findstring.sh:

Chapter 10. Loops and Branches

123

Advanced BashScripting Guide

# Find a particular string in the binaries in a specified directory. directory=/usr/bin/ fstring="Free Software Foundation"

# See which files come from the FSF.

for file in $( find $directory type f name '*' | sort ) do strings f $file | grep "$fstring" | sed e "s%$directory%%" # In the "sed" expression, #+ it is necessary to substitute for the normal "/" delimiter #+ because "/" happens to be one of the characters filtered out. # Failure to do so gives an error message (try it). done exit 0 # # # #+ Exercise (easy): Convert this script to take commandline parameters for $directory and $fstring.

The output of a for loop may be piped to a command or commands.

Example 1010. Listing the symbolic links in a directory

#!/bin/bash # symlinks.sh: Lists symbolic links in a directory.

directory=${1`pwd`} # Defaults to current working directory, #+ if not otherwise specified. # Equivalent to code block below. # # ARGS=1 # Expect one commandline argument. # # if [ $# ne "$ARGS" ] # If not 1 arg... # then # directory=`pwd` # current working directory # else # directory=$1 # fi # echo "symbolic links in directory \"$directory\"" for file in "$( find $directory type l )" # type l = symbolic links do echo "$file" done | sort # Otherwise file list is unsorted. # Strictly speaking, a loop isn't really necessary here, #+ since the output of the "find" command is expanded into a single word. # However, it's easy to understand and illustrative this way. # #+ #+ # As Dominik 'Aeneas' Schnitzer points out, failing to quote $( find $directory type l ) will choke on filenames with embedded whitespace. Even this will only pick up the first field of each argument.

exit 0

Chapter 10. Loops and Branches

124

Advanced BashScripting Guide

# Jean Helou proposes the following alternative: echo "symbolic links in directory \"$directory\"" # Backup of the current IFS. One can never be too cautious. OLDIFS=$IFS IFS=: for file in $(find $directory type l printf "%p$IFS") do # ^^^^^^^^^^^^^^^^ echo "$file" done|sort

The stdout of a loop may be redirected to a file, as this slight modification to the previous example shows.

Example 1011. Symbolic links in a directory, saved to a file

#!/bin/bash # symlinks.sh: Lists symbolic links in a directory. OUTFILE=symlinks.list directory=${1`pwd`} # Defaults to current working directory, #+ if not otherwise specified. # save file

echo "symbolic links in directory \"$directory\"" > "$OUTFILE" echo "" >> "$OUTFILE" for file in "$( find $directory type l )" do echo "$file" done | sort >> "$OUTFILE" # ^^^^^^^^^^^^^ exit 0 # type l = symbolic links

# stdout of loop redirected to save file.

There is an alternative syntax to a for loop that will look very familiar to C programmers. This requires double parentheses.

Example 1012. A Clike for loop

#!/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 # +==========================================+

Chapter 10. Loops and Branches

125

Advanced BashScripting Guide

# Now, let's do the same, using Clike syntax. LIMIT=10 for ((a=1; a <= LIMIT ; a++)) do echo n "$a " done echo; echo # +=========================================================================+ # Let's use the C "comma operator" to increment two variables simultaneously. for ((a=1, b=1; a <= LIMIT ; a++, b++)) do echo n "$a$b " done echo; echo exit 0 # The comma chains together operations. # Double parentheses, and "LIMIT" with no "$".

# A construct borrowed from 'ksh93'.

See also Example 2615, Example 2616, and Example A6. Now, a for loop used in a "reallife" context.

Example 1013. Using efax in batch mode

#!/bin/bash # Faxing (must have 'efax' package installed). EXPECTED_ARGS=2 E_BADARGS=65 MODEM_PORT="/dev/ttyS3" if [ $# # Check then echo exit fi

# May be different on your machine.

ne $EXPECTED_ARGS ] for proper no. of command line args. "Usage: `basename $0` phone# textfile" $E_BADARGS

if [ ! f "$2" ] then echo "File $2 is not a text file." # File is not a regular file, or does not exist. exit $E_BADARGS fi

fax make $2 for file in $(ls $2.0*)

Create fax formatted files from text files.

# Concatenate the converted files. # Uses wild card (filename "globbing") #+ in variable list.

Chapter 10. Loops and Branches

126

Advanced BashScripting Guide

do fil="$fil $file" done efax d "$MODEM_PORT" o1 t "T$1" $fil # Finally, do the work.

# As S.C. points out, the forloop can be eliminated with # efax d /dev/ttyS3 o1 t "T$1" $2.0* #+ but it's not quite as instructive [grin]. 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(s)... done The bracket construct in a while loop is nothing more than our old friend, the test brackets used in an if/then test. In fact, a while loop can legally use the more versatile double brackets construct (while [[ condition ]]). As is the case with for 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.

Example 1014. Simple while loop

#!/bin/bash var0=0 LIMIT=10 while [ "$var0" lt "$LIMIT" ] # ^ ^ # Spaces, because these are "testbrackets" . . . do echo n "$var0 " # n suppresses newline. # ^ Space, to separate printed out numbers. var0=`expr $var0 + 1` # # # # var0=$(($var0+1)) also works. var0=$((var0 + 1)) also works. let "var0 += 1" also works. Various other methods also work.

done echo

Chapter 10. Loops and Branches

127

Advanced BashScripting Guide

exit 0

Example 1015. Another while loop

#!/bin/bash echo # Equivalent to: while [ "$var1" != "end" ] # while test "$var1" != "end" do echo "Input variable #1 (end to exit) " read var1 # Not 'read $var1' (why?). echo "variable #1 = $var1" # Need quotes because of "#" . . . # If input is 'end', echoes it here. # Does not test for termination condition until top of loop. echo done 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.

Example 1016. while loop with multiple conditions

#!/bin/bash var1=unset previous=$var1 while echo "previousvariable = $previous" echo previous=$var1 [ "$var1" != end ] # Keeps track of what $var1 was previously. # Four conditions on "while", but only last one controls loop. # The *last* exit status is the one that counts. do echo "Input variable #1 (end to exit) " read var1 echo "variable #1 = $var1" done # Try to figure out how this all works. # It's a wee bit tricky. exit 0

As with a for loop, a while loop may employ Clike syntax by using the double parentheses construct (see also Example 931).

Example 1017. Clike syntax in a while loop

#!/bin/bash # whloopc.sh: Count to 10 in a "while" loop. LIMIT=10 a=1

Chapter 10. Loops and Branches

128

Advanced BashScripting Guide

while [ "$a" le $LIMIT ] do echo n "$a " let "a+=1" done # No surprises, so far. echo; echo # +=================================================================+ # Now, repeat with Clike syntax. ((a = 1)) # a=1 # Double parentheses permit space when setting a variable, as in C. while (( a <= LIMIT )) # Double parentheses, and no "$" preceding variables. do echo n "$a " ((a += 1)) # let "a+=1" # Yes, indeed. # Double parentheses permit incrementing a variable with Clike syntax. done echo # C programmers can feel right at home in Bash. exit 0

Inside its test brackets, a while loop can call a function.

t=0 condition () { ((t++)) if [ $t lt 5 ] then return 0 # true else return 1 # false fi } while condition # ^^^^^^^^^ # Function call four loop iterations. do echo "Still going: t = $t" done # # # # Still Still Still Still going: going: going: going: t t t t = = = = 1 2 3 4

By coupling the power of the read command with a while loop, we get the handy while read construct, useful for reading and parsing files. A while loop may have its stdin redirected to a file by a < at its end.

Chapter 10. Loops and Branches

129

Advanced BashScripting Guide A while loop may have its stdin supplied by a pipe. 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 [ conditionistrue ] do command(s)... 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 loops, placing the do on the same line as the condition test requires a semicolon. until [ conditionistrue ] ; do

Example 1018. until loop

#!/bin/bash END_CONDITION=end until [ "$var1" = "$END_CONDITION" ] # Tests condition here, at top of loop. do echo "Input variable #1 " echo "($END_CONDITION to exit)" read var1 echo "variable #1 = $var1" echo done exit 0

10.2. Nested Loops

A nested loop is a loop within a loop, an inner loop within the body of an outer one. How this works is that the first pass of the outer loop triggers the inner loop, which executes to completion. Then the second pass of the outer loop triggers the inner loop again. This repeats until the outer loop finishes. Of course, a break within either the inner or outer loop would interrupt this process.

Example 1019. Nested Loop

#!/bin/bash # nestedloop.sh: Nested "for" loops. outer=1 # Set outer loop counter.

# Beginning of outer loop. for a in 1 2 3 4 5

Chapter 10. Loops and Branches

130

Advanced BashScripting Guide

do echo "Pass $outer in outer loop." echo "" inner=1 # Reset inner loop counter. # =============================================== # Beginning of inner loop. for b in 1 2 3 4 5 do echo "Pass $inner in inner loop." let "inner+=1" # Increment inner loop counter. done # End of inner loop. # =============================================== let "outer+=1" # Increment outer loop counter. echo # Space between output blocks in pass of outer loop. done # End of outer loop. exit 0

See Example 2611 for an illustration of nested while loops, and Example 2613 to see a while loop nested inside an until loop.

10.3. Loop Control

Commands Affecting Loop Behavior break, continue The break and continue loop control commands [33] 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 (repetition) of the loop, skipping all the remaining commands in that particular loop cycle.

Example 1020. Effects of break and continue in a loop

#!/bin/bash LIMIT=19 # Upper limit

echo echo "Printing Numbers 1 through 20 (but not 3 and 11)." a=0 while [ $a le "$LIMIT" ] do a=$(($a+1)) if [ "$a" eq 3 ] || [ "$a" eq 11 ] # Excludes 3 and 11. then continue # Skip rest of this particular loop iteration. fi echo n "$a " done # This will not execute for 3 and 11.

Chapter 10. Loops and Branches

131

Advanced BashScripting Guide

# Exercise: # Why does loop print up to 20? echo; echo echo Printing Numbers 1 through 20, but something happens after 2. ################################################################## # Same loop, but substituting 'break' for 'continue'. a=0 while [ "$a" le "$LIMIT" ] do a=$(($a+1)) if [ "$a" gt 2 ] then break # Skip entire rest of loop. fi echo n "$a " done echo; echo; echo 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.

Example 1021. Breaking out of multiple loop levels

#!/bin/bash # breaklevels.sh: Breaking out of loops. # "break N" breaks out of N level 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

Chapter 10. Loops and Branches

132

Advanced BashScripting Guide

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.

Example 1022. Continuing at a higher loop level

#!/bin/bash # The "continue N" command, continuing at the Nth level loop. for outer in I II III IV V do echo; echo n "Group $outer: " # outer loop

# for inner in 1 2 3 4 5 6 7 8 9 10 # inner loop do 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 echo n "$inner " # 7 8 9 10 will never echo. done # done echo; echo # Exercise: # Come up with a meaningful use for "continue N" in a script. exit 0

Example 1023. Using continue N in an actual task

# Albert Reiner gives an example of how to use "continue N": # # #+ #+ #+ #+ Suppose I have a large number of jobs that need to be run, with any data that is to be treated in files of a given name pattern in a directory. There are several machines that access this directory, and I want to distribute the work over these different boxen. Then I usually nohup something like the following on every box:

while true do for n in .iso.* do [ "$n" = ".iso.opts" ] && continue beta=${n#.iso.} [ r .Iso.$beta ] && continue

Chapter 10. Loops and Branches

133

Advanced BashScripting Guide

[ r .lock.$beta ] && sleep 10 && continue lockfile r0 .lock.$beta || continue echo n "$beta: " `date` runisotherm $beta date ls alF .Iso.$beta [ r .Iso.$beta ] && rm f .lock.$beta continue 2 done break done # The details, in particular the sleep N, are particular to my #+ application, but the general pattern is: while true do for job in {pattern} do {job already done or running} && continue {mark job as running, do job, mark job as done} continue 2 done break # Or something like `sleep 600' to avoid termination. done # #+ #+ #+ #+ #+ #+ #+ #+ #+ #+ This way the script will stop only when there are no more jobs to do (including jobs that were added during runtime). Through the use of appropriate lockfiles it can be run on several machines concurrently without duplication of calculations [which run a couple of hours in my case, so I really want to avoid this]. Also, as search always starts again from the beginning, one can encode priorities in the file names. Of course, one could also do this without `continue 2', but then one would have to actually check whether or not some job was done (so that we should immediately look for the next job) or not (in which case we terminate or sleep for a long time before checking for a new job).

The continue N construct is difficult to understand and tricky to use in any meaningful context. It is probably best avoided.

10.4. Testing and Branching

The case and select constructs are technically not loops, since they do not iterate the execution of a code block. Like loops, however, they direct program flow according to conditions at the top or bottom of the block. Controlling program flow in a code block case (in) / esac The case construct is the shell scripting analog to 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

Chapter 10. Loops and Branches

134

Advanced BashScripting Guide "$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). Example 1024. Using case
#!/bin/bash # Testing ranges of characters. echo; echo "Hit a key, then hit return." read Keypress case "$Keypress" in [[:lower:]] ) echo "Lowercase letter";; [[:upper:]] ) echo "Uppercase letter";; [09] ) echo "Digit";; * ) echo "Punctuation, whitespace, or other";; esac # Allows ranges of characters in [square brackets], #+ or POSIX ranges in [[double square brackets. # #+ #+ # # # # # # # #+ # In the first version of this example, the tests for lowercase and uppercase characters were [az] and [AZ]. This no longer works in certain locales and/or Linux distros. POSIX is more portable. Thanks to Frank Wang for pointing this out. Exercise: As the script stands, it accepts a single keystroke, then terminates. Change the script so it accepts repeated input, reports on each keystroke, and terminates only when "X" is hit. Hint: enclose everything in a "while" loop.

exit 0

Example 1025. Creating menus using case

#!/bin/bash # Crude address database clear # Clear the screen.

Chapter 10. Loops and Branches

135

Advanced BashScripting Guide

echo echo echo echo echo echo echo echo echo " Contact List" " " "Choose one of the following persons:" "[E]vans, Roland" "[J]ones, Mildred" "[S]mith, Julie" "[Z]ane, Morris"

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) 7349874" echo "(303) 7349892 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" echo "(212) 5332814" echo "(212) 5339972 fax" echo "[email protected]" echo "Exgirlfriend" echo "Birthday: Feb. 11" ;; # Add info for Smith & Zane later. * ) # Default option. # Empty input (hitting RETURN) fits here, too. echo echo "Not yet in database." ;; esac echo # # # #+ Exercise: Change the script so it accepts multiple inputs, instead of terminating after displaying just one address.

exit 0

An exceptionally clever use of case involves testing for commandline parameters.

Chapter 10. Loops and Branches

136

Advanced BashScripting Guide

#! /bin/bash case "$1" in "") echo "Usage: ${0##*/} <filename>"; exit $E_PARAM;; # No commandline parameters, # or first parameter empty. # Note that ${0##*/} is ${var##pattern} param substitution. # Net result is $0. *) FILENAME=./$1;; # #+ #+ #+ #+ If filename passed as argument ($1) starts with a dash, replace it with ./$1 so further commands don't interpret it as an option.

* ) FILENAME=$1;; esac

# Otherwise, $1.

Here is an more straightforward example of commandline parameter handling:

#! /bin/bash

while [ $# gt 0 ]; do # Until you run out of parameters . . . case "$1" in d|debug) # "d" or "debug" parameter? DEBUG=1 ;; c|conf) CONFFILE="$2" shift if [ ! f $CONFFILE ]; then echo "Error: Supplied file doesn't exist!" exit $E_CONFFILE # File not found error. fi ;; esac shift # Check next set of parameters. done # From Stefano Falsetto's "Log2Rot" script, #+ part of his "rottlog" package. # Used with permission.

Example 1026. Using command substitution to generate the case variable

#!/bin/bash # casecmd.sh: Using command substitution to generate a "case" variable. case $( arch ) in i386 i486 i586 i686 * esac ) ) ) ) ) echo echo echo echo echo # "arch" returns machine architecture. # Equivalent to 'uname m' ... "80386based machine";; "80486based machine";; "Pentiumbased machine";; "Pentium2+based machine";; "Other type of machine";;

exit 0

A case construct can filter strings for globbing patterns. Chapter 10. Loops and Branches 137

Advanced BashScripting Guide Example 1027. Simple string matching

#!/bin/bash # matchstring.sh: simple string matching match_string () { MATCH=0 NOMATCH=90 PARAMS=2 # Function requires 2 arguments. BAD_PARAMS=91 [ $# eq $PARAMS ] || return $BAD_PARAMS case "$1" in "$2") return $MATCH;; * ) return $NOMATCH;; esac }

a=one b=two c=three d=two

match_string $a echo $? match_string $a $b echo $? match_string $b $d echo $?

# wrong number of parameters # 91 # no match # 90 # match # 0

exit 0

Example 1028. Checking for alphabetic input

#!/bin/bash # isalpha.sh: Using a "case" structure to filter a string. SUCCESS=0 FAILURE=1 isalpha () # Tests whether *first character* of input string is alphabetic. { if [ z "$1" ] # No argument passed? then return $FAILURE fi case "$1" in [azAZ]*) return $SUCCESS;; # Begins with a letter? * ) return $FAILURE;; esac } # Compare this with "isalpha ()" function in C.

Chapter 10. Loops and Branches

138

Advanced BashScripting Guide

isalpha2 () # Tests whether *entire string* is alphabetic. { [ $# eq 1 ] || return $FAILURE case $1 in *[!azAZ]*|"") return $FAILURE;; *) return $SUCCESS;; esac } isdigit () # Tests whether *entire string* is numerical. { # In other words, tests for integer variable. [ $# eq 1 ] || return $FAILURE case $1 in *[!09]*|"") return $FAILURE;; *) return $SUCCESS;; esac }

check_var () # Frontend to isalpha (). { if isalpha "$@" then echo "\"$*\" begins with an alpha character." if isalpha2 "$@" then # No point in testing if first char is nonalpha. echo "\"$*\" contains only alpha characters." else echo "\"$*\" contains at least one nonalpha character." fi else echo "\"$*\" begins with a nonalpha character." # Also "nonalpha" if no argument passed. fi echo } digit_check () # Frontend to isdigit (). { if isdigit "$@" then echo "\"$*\" contains only digits [0 9]." else echo "\"$*\" has at least one nondigit character." fi echo } a=23skidoo b=H3llo c=What? d=What? e=`echo $b` f=AbcDef

# Command substitution.

Chapter 10. Loops and Branches

139

Advanced BashScripting Guide

g=27234 h=27a34 i=27.34 check_var $a check_var $b check_var $c check_var $d check_var $e check_var $f check_var # No argument passed, so what happens? # digit_check $g digit_check $h digit_check $i

exit 0

# Script improved by S.C.

# Exercise: # # Write an 'isfloat ()' function that tests for floating point numbers. # Hint: The function duplicates 'isdigit ()', #+ but adds a test for a mandatory decimal point.

select The select construct, adopted from the Korn Shell, is yet another tool for building menus. select variable [in list] do command... break done 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.

Example 1029. Creating menus using select

#!/bin/bash PS3='Choose your favorite vegetable: ' # Sets the prompt string. echo select vegetable in "beans" "carrots" "potatoes" "onions" "rutabagas" do echo echo "Your favorite veggie is $vegetable." echo "Yuck!" echo break # What happens if there is no 'break' here? done 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.

Chapter 10. Loops and Branches

140

Advanced BashScripting Guide Compare this to the behavior of a for variable [in list] construct with the in list omitted. Example 1030. Creating menus using select in a function
#!/bin/bash PS3='Choose your favorite vegetable: ' 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 } choice_of beans rice carrots radishes tomatoes spinach # $1 $2 $3 $4 $5 $6 # passed to choice_of() function exit 0

See also Example 343.

Chapter 10. Loops and Branches

141

Chapter 11. Command Substitution

Command substitution reassigns the output of a command [34] or even multiple commands; it literally plugs the command output into another context. [35] 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.
rm `cat filename` # "filename" contains a list of files to delete. # # S. C. points out that "arg list too long" error might result. # Better is xargs rm < filename # ( covers those cases where "filename" begins with a "" ) textfile_listing=`ls *.txt` # Variable contains names of all *.txt files in current working directory. echo $textfile_listing textfile_listing2=$(ls *.txt) echo $textfile_listing2 # Same result. # # # # # # # # # The alternative form of command substitution.

A possible problem with putting a list of files into a single string is that a newline may creep in. A safer way to assign a list of files to a parameter is with an array. shopt s nullglob # If no match, filename expands to nothing. textfile_listing=( *.txt ) Thanks, S.C.

Command substitution invokes a subshell. Command substitution may result in word splitting.
COMMAND `echo a b` COMMAND "`echo a b`" COMMAND `echo` COMMAND "`echo`" # 2 args: a and b # 1 arg: "a b" # no arg # one empty arg

# Thanks, S.C.

Even when there is no word splitting, command substitution can remove trailing newlines.
# cd "`pwd`" # However... # This should always work.

Chapter 11. Command Substitution

142

Advanced BashScripting Guide

mkdir 'dir with trailing newline ' cd 'dir with trailing newline ' cd "`pwd`" # Error message: # bash: cd: /tmp/file with trailing newline: No such file or directory cd "$PWD" # Works fine.

old_tty_setting=$(stty g) echo "Hit a key " stty icanon echo

# Save old terminal setting.

# Disable "canonical" mode for terminal. # Also, disable *local* echo. key=$(dd bs=1 count=1 2> /dev/null) # Using 'dd' to get a keypress. stty "$old_tty_setting" # Restore old setting. echo "You hit ${#key} key." # ${#variable} = number of characters in $variable # # Hit any key except RETURN, and the output is "You hit 1 key." # Hit RETURN, and it's "You hit 0 key." # The newline gets eaten in the command substitution. 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

# Expecting a nicely ordered directory listing. # However, what you get is: # total 3 rwrwr 1 bozo bozo 30 May 13 17:15 1.txt rwrwr 1 bozo # bozo 51 May 15 20:57 t2.sh rwxrxrx 1 bozo bozo 217 Mar 5 21:13 wi.sh # The newlines disappeared.

echo "$dir_listing" # quoted # rwrwr 1 bozo 30 May 13 17:15 1.txt # rwrwr 1 bozo 51 May 15 20:57 t2.sh # rwxrxrx 1 bozo 217 Mar 5 21:13 wi.sh

Command substitution even permits setting a variable to the contents of a file, using either redirection or the cat command.
variable1=`<file1` variable2=`cat file2` # # # #+ Set "variable1" to contents of "file1". Set "variable2" to contents of "file2". This, however, forks a new process, so the line of code executes slower than the above version.

# #

Note: The variables may contain embedded whitespace,

Chapter 11. Command Substitution

143

Advanced BashScripting Guide

#+ or even (horrors), control characters. # Excerpts from system file, /etc/rc.d/rc.sysinit #+ (on a Red Hat Linux installation)

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.

Example 111. Stupid script tricks

#!/bin/bash # stupidscripttricks.sh: Don't try this at home, folks. # From "Stupid Script Tricks," Volume I.

dangerous_variable=`cat /boot/vmlinuz`

# The compressed Linux kernel itself.

echo "stringlength of \$dangerous_variable = ${#dangerous_variable}" # stringlength of $dangerous_variable = 794151 # (Does not give same count as 'wc c /boot/vmlinuz'.) # echo "$dangerous_variable" # Don't try this! It would hang the script.

# The document author is aware of no useful applications for #+ setting a variable to the contents of a binary file. 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.

Chapter 11. Command Substitution

144

Advanced BashScripting Guide 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.

Example 112. Generating a variable from a 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" done` echo "variable1 = $variable1"

# The 'echo' command is critical #+ to command substitution here. # variable1 = 12345

i=0 variable2=`while [ "$i" lt 10 ] do echo n "$i" # Again, the necessary 'echo'. let "i += 1" # Increment. done` echo "variable2 = $variable2" # variable2 = 0123456789

# Demonstrates that it's possible to embed a loop #+ within a variable declaration. 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 wellbehaved UNIX tool should) and assigning that output to a variable.
#include <stdio.h> /* "Hello, world." C program */

int main() { printf( "Hello, world." ); return (0); } bash$ gcc o hello hello.c

#!/bin/bash # hello.sh greeting=`./hello` echo $greeting bash$ sh hello.sh Hello, world.

Chapter 11. Command Substitution

145

Advanced BashScripting Guide The $(COMMAND) form has superseded backticks for command substitution.
output=$(sed n /"$1"/p $file) # From "grp.sh" example.

# Setting a variable to the contents of a text file. File_contents1=$(cat $file1) File_contents2=$(<$file2) # Bash permits this also.

The $(...) form of command substitution treats a double backslash in a different way than `...`.
bash$ echo `echo \\`

bash$ echo $(echo \\) \

The $(...) form of command substitution permits nesting. [36]

word_count=$( wc w $(ls l | awk '{print $9}') )

Or, for something a bit more elaborate . . .

Example 113. Finding anagrams

#!/bin/bash # agram2.sh # Example of nested command substitution. # #+ # # Uses "anagram" utility that is part of the author's "yawl" word list package. http://ibiblio.org/pub/Linux/libs/yawl0.3.2.tar.gz http://personal.riverusers.com/~thegrendel/yawl0.3.2.tar.gz

E_NOARGS=66 E_BADARG=67 MINLEN=7 if [ z "$1" ] then echo "Usage $0 LETTERSET" exit $E_NOARGS # Script needs a commandline argument. elif [ ${#1} lt $MINLEN ] then echo "Argument must have at least $MINLEN letters." exit $E_BADARG fi

FILTER='.......' # Must have at least 7 letters. # 1234567 Anagrams=( $(echo $(anagram $1 | grep $FILTER) ) ) # $( $( nested command sub. ) ) # ( array assignment ) echo echo "${#Anagrams[*]} echo echo ${Anagrams[0]}

7+ letter anagrams found" # First anagram.

Chapter 11. Command Substitution

146

Advanced BashScripting Guide

echo ${Anagrams[1]} # Second anagram. # Etc. # To list all the anagrams in a single line . . .

# echo "${Anagrams[*]}"

# Look ahead to the "Arrays" chapter for enlightenment on #+ what's going on here. # See also the agram.sh script for an example of anagram finding. exit $?

Examples of command substitution in shell scripts: 1. Example 107 2. Example 1026 3. Example 929 4. Example 153 5. Example 1519 6. Example 1515 7. Example 1549 8. Example 1013 9. Example 1010 10. Example 1529 11. Example 198 12. Example A17 13. Example 272 14. Example 1542 15. Example 1543 16. Example 1544

Chapter 11. Command Substitution

147

Chapter 12. Arithmetic Expansion

Arithmetic expansion provides a powerful tool for performing (integer) arithmetic operations in scripts. Translating a string into a numerical expression is relatively straightforward using backticks, double parentheses, or let. Variations Arithmetic expansion with backticks (often used in conjunction with expr)
z=`expr $z + 3` # The 'expr' command performs the expansion.

Arithmetic expansion with double parentheses, and using let The use of backticks (backquotes) in arithmetic expansion has been superseded by double parentheses ((...)) and $((...)) and also by the very convenient let construction.
z=$(($z+3)) z=$((z+3))

# # #+ #+

Also correct. Within double parentheses, parameter dereferencing is optional.

# $((EXPRESSION)) is arithmetic expansion.

# Not to be confused with #+ command substitution.

# You may also use operations within double parentheses without assignment. n=0 echo "n = $n" (( n += 1 )) # (( $n += 1 )) is incorrect! echo "n = $n"

# n = 0 # Increment. # n = 1

let z=z+3 let "z += 3"

# Quotes permit the use of spaces in variable assignment. # The 'let' operator actually performs arithmetic evaluation, #+ rather than expansion.

Examples of arithmetic expansion in scripts: 1. Example 159 2. Example 1014 3. Example 261 4. Example 2611 5. Example A17

Chapter 12. Arithmetic Expansion

148

Chapter 13. Recess Time

This bizarre little intermission gives the reader a chance to relax and maybe laugh a bit.

Fellow Linux user, greetings! You are reading something which will bring you luck and good fortune. Just email a copy of this document to 10 of your friends. Before making the copies, send a 100line Bash script to the first person on the list at the bottom of this letter. Then delete their name and add yours to the bottom of the list. Don't break the chain! Make the copies within 48 hours. Wilfred P. of Brooklyn failed to send out his ten copies and woke the next morning to find his job description changed to "COBOL programmer." Howard L. of Newport News sent out his ten copies and within a month had enough hardware to build a 100node Beowulf cluster dedicated to playing Tuxracer. Amelia V. of Chicago laughed at this letter and broke the chain. Shortly thereafter, a fire broke out in her terminal and she now spends her days writing documentation for MS Windows. Don't break the chain! Send out your ten copies today!

Courtesy 'NIX "fortune cookies", with some alterations and many apologies

Chapter 13. Recess Time

149

Part 4. Commands
Mastering the commands on your Linux machine is an indispensable prelude to writing effective shell scripts. This section covers the following commands: . (See also source) ac adduser agetty agrep ar arch at autoload awk (See also Using awk for math operations) badblocks banner basename batch bc bg bind bison builtin bzgrep bzip2 cal caller cat cd chattr chfn chgrp chkconfig chmod chown chroot cksum clear clock cmp col colrm column comm command compress cp Part 4. Commands 150

Advanced BashScripting Guide cpio cron crypt csplit cu cut date dc dd debugfs declare depmod df dialog diff diff3 diffstat dig dirname dirs disown dmesg doexec dos2unix du dump dumpe2fs e2fsck echo egrep enable enscript env eqn eval exec exit (Related topic: exit status) expand export expr factor false fdformat fdisk fg fgrep file find finger flex flock Part 4. Commands 151

Advanced BashScripting Guide fmt fold free fsck ftp fuser getopt getopts gettext getty gnomemount grep groff groupmod groups (Related topic: the $GROUPS variable) gs gzip halt hash hdparm head help hexdump host hostid hostname (Related topic: the $HOSTNAME variable) hwclock iconv id (Related topic: the $UID variable) ifconfig info infocmp init insmod install ip ipcalc iwconfig jobs join jot kill killall last lastcomm lastlog ldd less let lex ln Part 4. Commands 152

Advanced BashScripting Guide locate lockfile logger logname logout logrotate look losetup lp ls lsdev lsmod lsof lspci lsusb ltrace lynx m4 mail mailto make MAKEDEV man mcookie md5sum mesg mimencode mkbootdisk mkdir mke2fs mkfifo mknod mkswap mktemp mmencode modinfo modprobe more mount msgfmt mv nc netconfig netstat newgrp nice nl nm nmap nohup nslookup Part 4. Commands 153

Advanced BashScripting Guide objdump od passwd paste patch (Related topic: diff) pathchk pgrep pidof ping pkill popd pr printenv printf procinfo ps pstree ptx pushd pwd (Related topic: the $PWD variable) quota rcp rdev rdist read readelf readlink readonly reboot recode renice reset restore rev rlogin rm rmdir rmmod route rpm rpm2cpio rsh rsync runlevel runparts rx rz sar scp script sdiff Part 4. Commands 154

Advanced BashScripting Guide sed seq service set setquota setserial setterm sha1sum shar shopt shred shutdown size skill sleep slocate snice sort source sox split sq ssh stat strace strings strip stty su sudo sum suspend swapoff swapon sx sync sz tac tail tar tbl tcpdump tee telinit telnet Tex texexec time times tmpwatch top Part 4. Commands 155

Advanced BashScripting Guide touch tput tr traceroute true tset tsort tty tune2fs type typeset ulimit umask umount uname unarc unarj uncompress unexpand uniq units unrar unset unsq unzip uptime usbmodules useradd userdel usermod users usleep uucp uudecode uuencode uux vacation vdir vmstat vrfy w wait wall watch wc wget whatis whereis which who whoami Part 4. Commands 156

Advanced BashScripting Guide whois write xargs yacc yes zcat zdiff zdump zegrep zfgrep zgrep zip Table of Contents 14. Internal Commands and Builtins 14.1. Job Control Commands 15. External Filters, Programs and Commands 15.1. Basic Commands 15.2. Complex Commands 15.3. Time / Date Commands 15.4. Text Processing Commands 15.5. File and Archiving Commands 15.6. Communications Commands 15.7. Terminal Control Commands 15.8. Math Commands 15.9. Miscellaneous Commands 16. System and Administrative Commands 16.1. Analyzing a System Script

Part 4. Commands

157

Chapter 14. Internal Commands and Builtins

A builtin is a command contained within the Bash tool set, literally built in. This is either for performance reasons builtins execute faster than external commands, which usually require forking off a separate process or because a particular builtin needs direct access to the shell internals.

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. Note that while a parent process gets the process ID of the child process, and can thus pass arguments to it, the reverse is not true. This can create problems that are subtle and hard to track down.

Example 141. A script that forks off multiple instances of itself

#!/bin/bash # spawn.sh

PIDS=$(pidof sh $0) # Process IDs of the various instances of this script. P_array=( $PIDS ) # Put them in an array (why?). echo $PIDS # Show process IDs of parent and child processes. let "instances = ${#P_array[*]} 1" # Count elements, less 1. # Why subtract 1? echo "$instances instance(s) of this script running." echo "[Hit CtlC to exit.]"; echo

sleep 1 sh $0 exit 0

# Wait. # Play it again, Sam. # Not necessary; script will never get to here. # Why not?

# After exiting with a CtlC, #+ do all the spawned instances of the script die? # If so, why? # # # # Note: Be careful not to run this script too long. It will eventually eat up too many system resources.

# Is having a script spawn multiple instances of itself #+ an advisable scripting technique. # Why or why not?

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.

Chapter 14. Internal Commands and Builtins

158

Advanced BashScripting Guide

#!/bin/bash echo "This line uses the \"echo\" builtin." /bin/echo "This line uses the /bin/echo system command."

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 hardcoded into Bash, but unlike a builtin, a keyword is not in itself a command, but a subunit of a larger command structure. [37] I/O echo prints (to stdout) an expression or variable (see Example 41).
echo Hello echo $a

An echo requires the e option to print escaped characters. See Example 52. Normally, each echo command prints a terminal newline, but the n option suppresses this.

An echo can be used to feed a sequence of commands down a pipe.

if echo "$VAR" | grep q txt # if [[ $VAR = *txt* ]] then echo "$VAR contains the substring sequence \"txt\"" fi

An echo, in combination with command substitution can set a variable. a=`echo "HELLO" | tr AZ az` See also Example 1519, Example 153, Example 1542, and Example 1543. 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 rwrr 1 root root 1407 Nov 7 2000 reflect.au rwrr 1 root root 362 Nov 7 2000 seconds.au

bash$ echo `ls l /usr/share/apps/kjezz/sounds` total 40 rwrr 1 root root 716 Nov 7 2000 reflect.au rwrr 1 root root ...

So, how can we embed a linefeed within an echoed character string?

# Embedding a linefeed? echo "Why doesn't this string \n split on two lines?" # Doesn't split.

Chapter 14. Internal Commands and Builtins

159

Advanced BashScripting Guide

# Let's try something else. echo echo $"A line of text containing a linefeed." # Prints as two distinct lines (embedded linefeed). # But, is the "$" variable prefix really necessary? echo echo "This string splits on two lines." # No, the "$" is not needed. echo echo "" echo echo n $"Another line of text containing a linefeed." # Prints as two distinct lines (embedded linefeed). # Even the n option fails to suppress the linefeed here. echo echo echo "" echo echo # However, the following doesn't work as expected. # Why not? Hint: Assignment to a variable. string1=$"Yet another line of text containing a linefeed (maybe)." echo $string1 # Yet another line of text containing a linefeed (maybe). # ^ # Linefeed becomes a space. # Thanks, Steve Parker, for pointing this out.

This command is a shell builtin, and not the same as /bin/echo, although its behavior is similar.
bash$ type a echo echo is a shell builtin echo is /bin/echo

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. printf formatstring... parameter... This is the Bash builtin version of the /bin/printf or /usr/bin/printf command. See the printf manpage (of the system command) for indepth coverage. Chapter 14. Internal Commands and Builtins 160

Advanced BashScripting Guide Older versions of Bash may not support printf. Example 142. printf in action
#!/bin/bash # printf demo PI=3.14159265358979 DecimalConstant=31373 Message1="Greetings," Message2="Earthling." echo printf "Pi to 2 decimal places = %1.2f" $PI echo printf "Pi to 9 decimal places = %1.9f" $PI printf "\n"

# It even rounds off correctly. # Prints a line feed, # Equivalent to 'echo' . . . # Inserts tab (\t).

printf "Constant = \t%d\n" $DecimalConstant printf "%s %s \n" $Message1 $Message2 echo # ==========================================# # Simulation of C function, sprintf(). # Loading a variable with a formatted string. echo Pi12=$(printf "%1.12f" $PI) echo "Pi to 12 decimal places = $Pi12" Msg=`printf "%s %s \n" $Message1 $Message2` echo $Msg; echo $Msg

# As it happens, the 'sprintf' function can now be accessed #+ as a loadable module to Bash, #+ but this is not portable. exit 0

Formatting error messages is a useful application of printf

E_BADDIR=65 var=nonexistent_directory error() { printf "$@" >&2 # Formats positional params passed, and sends them to stderr. echo exit $E_BADDIR } cd $var || error $"Can't cd to %s." "$var"

Chapter 14. Internal Commands and Builtins

161

Advanced BashScripting Guide

# 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 266).

Example 143. Variable assignment, using read

#!/bin/bash # "Reading" variables. echo n "Enter the value of variable 'var1': " # The n option to echo suppresses newline. read var1 # Note no '$' in front of var1, since it is being set. echo "var1 = $var1"

echo # A single 'read' statement can set multiple variables. echo n "Enter the values of variables 'var2' and 'var3' " echo =n "(separated by a space or tab): " read var2 var3 echo "var2 = $var2 var3 = $var3" # If you input only one value, #+ the other variable(s) will remain unset (null). exit 0

A read without an associated variable assigns its input to the dedicated variable $REPLY.

Example 144. What happens when read has no variable

#!/bin/bash # readnovar.sh echo # # echo n "Enter a value: " read var echo "\"var\" = "$var"" # Everything as expected here. # # echo # # echo n "Enter another value: " read # No variable supplied for 'read', therefore... #+ Input to 'read' assigned to default variable, $REPLY. var="$REPLY" echo "\"var\" = "$var"" # This is equivalent to the first code block. # #

Chapter 14. Internal Commands and Builtins

162

Advanced BashScripting Guide

echo exit 0 # This example is similar to the "reply.sh" script. # However, this one shows that $REPLY is available #+ even after a 'read' to a variable in the conventional way.

Normally, inputting a \ suppresses a newline during input to a read. The r option causes an inputted \ to be interpreted literally.

Example 145. Multiline input to read

#!/bin/bash echo echo "Enter a string terminated by a \\, then press <ENTER>." echo "Then, enter a second string, and again press <ENTER>." read var1 # The "\" suppresses the newline, when reading $var1. # first line \ # second line echo "var1 = $var1" # var1 = first line second line # For each line terminated by a "\" #+ you get a prompt on the next line to continue feeding characters into var1. echo; echo echo "Enter another string terminated by a \\ , then press <ENTER>." read r var2 # The r option causes the "\" to be read literally. # first line \ echo "var2 = $var2" # var2 = first line \ # Data entry terminates with the first <ENTER>. echo exit 0

The read command has some interesting options that permit echoing a prompt and even reading keystrokes without hitting ENTER.
# Read a keypress without hitting ENTER. read s n1 p "Hit a key " keypress echo; echo "Keypress was "\"$keypress\""." # s option means do not echo input. # n N option means accept only N characters of input. # p option means echo the following prompt before reading input. # Using these options is tricky, since they need to be in the correct order.

The n option to read also allows detection of the arrow keys and certain of the other unusual keys.

Chapter 14. Internal Commands and Builtins

163

Advanced BashScripting Guide Example 146. Detecting the arrow keys

#!/bin/bash # arrowdetect.sh: Detects the arrow keys, and a few more. # Thank you, Sandro Magi, for showing me how. # # Character codes generated by the keypresses. arrowup='\[A' arrowdown='\[B' arrowrt='\[C' arrowleft='\[D' insert='\[2' delete='\[3' # SUCCESS=0 OTHER=65 echo n "Press a key... " # May need to also press ENTER if a key not listed above pressed. read n3 key # Read 3 characters. echo n "$key" | grep "$arrowup" if [ "$?" eq $SUCCESS ] then echo "Uparrow key pressed." exit $SUCCESS fi echo n "$key" | grep "$arrowdown" if [ "$?" eq $SUCCESS ] then echo "Downarrow key pressed." exit $SUCCESS fi echo n "$key" | grep "$arrowrt" if [ "$?" eq $SUCCESS ] then echo "Rightarrow key pressed." exit $SUCCESS fi echo n "$key" | grep "$arrowleft" if [ "$?" eq $SUCCESS ] then echo "Leftarrow key pressed." exit $SUCCESS fi echo n "$key" | grep "$insert" if [ "$?" eq $SUCCESS ] then echo "\"Insert\" key pressed." exit $SUCCESS fi echo n "$key" | grep "$delete" if [ "$?" eq $SUCCESS ] then echo "\"Delete\" key pressed." #Check if character code detected.

Chapter 14. Internal Commands and Builtins

164

Advanced BashScripting Guide

exit $SUCCESS fi

echo " Some other key pressed." exit $OTHER # ========================================= # # Mark Alexander came up with a simplified #+ version of the above script (Thank you!). # It eliminates the need for grep. #!/bin/bash uparrow=$'\x1b[A' downarrow=$'\x1b[B' leftarrow=$'\x1b[D' rightarrow=$'\x1b[C' read s n3 p "Hit an arrow key: " x case "$x" in $uparrow) echo "You ;; $downarrow) echo "You ;; $leftarrow) echo "You ;; $rightarrow) echo "You ;; esac

pressed uparrow"

pressed downarrow"

pressed leftarrow"

pressed rightarrow"

# ========================================= # # # # Exercise: 1) Add detection of the "Home," "End," "PgUp," and "PgDn" keys.

The n option to read will not detect the ENTER (newline) key. The t option to read permits timed input (see Example 94). 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 whitespacedelineated string. Caution!

Example 147. Using read with file redirection

#!/bin/bash read var1 <datafile

Chapter 14. Internal Commands and Builtins

165

Advanced BashScripting Guide

echo "var1 = $var1" # var1 set to the entire first line of the input file "datafile" read var2 var3 <datafile echo "var2 = $var2 var3 = $var3" # Note nonintuitive behavior of "read" here. # 1) Rewinds back to the beginning of input file. # 2) Each variable is now set to a corresponding string, # separated by whitespace, rather than to an entire line of text. # 3) The final variable gets the remainder of the line. # 4) If there are more variables to be set than whitespaceterminated strings # on the first line of the file, then the excess variables remain empty. echo "" # How to resolve the above problem with a loop: while read line do echo "$line" done <datafile # Thanks, Heiner Steven for pointing this out. echo "" # Use $IFS (Internal Field Separator variable) to split a line of input to # "read", if you do not want the default to be whitespace. echo "List of all users:" OIFS=$IFS; IFS=: # /etc/passwd uses ":" for field separator. while read name passwd uid gid fullname ignore do echo "$name ($fullname)" done </etc/passwd # I/O redirection. IFS=$OIFS # Restore original $IFS. # This code snippet also by Heiner Steven.

# Setting the $IFS variable within the loop itself #+ eliminates the need for storing the original $IFS #+ in a temporary variable. # Thanks, Dim Segebart, for pointing this out. echo "" echo "List of all users:" while IFS=: read name passwd uid gid fullname ignore do echo "$name ($fullname)" done </etc/passwd # I/O redirection. echo echo "\$IFS still $IFS" exit 0

Piping output to a read, using echo to set variables will fail. Yet, piping the output of cat seems to work.

Chapter 14. Internal Commands and Builtins

166

Advanced BashScripting Guide

cat file1 file2 | while read line do echo $line done

However, as Bjn Eriksson shows:

Example 148. Problems reading from a pipe

#!/bin/sh # readpipe.sh # This example contributed by Bjon Eriksson. last="(null)" cat $0 | while read line do echo "{$line}" last=$line done printf "\nAll done, last:$last\n" exit 0 # End of code. # (Partial) output of script follows. # The 'echo' supplies extra brackets.

############################################# ./readpipe.sh {#!/bin/sh} {last="(null)"} {cat $0 |} {while read line} {do} {echo "{$line}"} {last=$line} {done} {printf "nAll done, last:$lastn"}

All done, last:(null) The variable (last) is set within the subshell but unset outside.

The gendiff script, usually found in /usr/bin on many Linux distros, pipes the output of find to a while read construct.
find $1 \( name "*$2" o name ".*$2" \) print | while read f; do . . .

Filesystem cd The familiar cd change directory command finds use in scripts where execution of a command requires being in a specified directory.

Chapter 14. Internal Commands and Builtins

167

Advanced BashScripting Guide

(cd /source/directory && tar cf . ) | (cd /dest/directory && tar xpvf )

[from the previously cited example by Alan Cox] The P (physical) option to cd causes it to ignore symbolic links. cd changes to $OLDPWD, the previous working directory.

The cd command does not function as expected when presented with two forward slashes.
bash$ cd // bash$ pwd //

The output should, of course, be /. This is a problem both from the command line and in a script. pwd Print Working Directory. This gives the user's (or script's) current directory (see Example 149). 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 manipulations of the directory stack. pushd dirname pushes the path dirname onto the directory stack and simultaneously changes the current working directory to dirname 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 hardcoding 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.

Example 149. Changing the current working directory

#!/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 backquoted 'pwd'. # Now, do some stuff in directory 'dir1'. pushd $dir2 echo "Now in directory `pwd`."

Chapter 14. Internal Commands and Builtins

168

Advanced BashScripting Guide

# Now, do some stuff in directory 'dir2'. echo "The top entry in the DIRSTACK array is $DIRSTACK." popd echo "Now back in directory `pwd`." # Now, do some more stuff in directory 'dir1'. popd echo "Now back in original working directory `pwd`." exit 0 # What happens if you don't 'popd' then exit the script? # Which directory do you end up in? Why?

Variables let The let command carries out arithmetic operations on variables. In many cases, it functions as a less complex version of expr.

Example 1410. Letting let do arithmetic.

#!/bin/bash echo let a=11 let a=a+5 echo "11 + 5 = $a" # # # # Same as 'a=11' Equivalent to let "a = a + 5" (Double quotes and spaces make it more readable.) 16

let "a <<= 3" # Equivalent to let "a = a << 3" echo "\"\$a\" (=16) leftshifted 3 places = $a" # 128 let "a /= 4" # Equivalent to echo "128 / 4 = $a" # 32 let "a = 5" echo "32 5 = $a" # Equivalent to # 27 let "a = a / 4"

let "a = a 5"

let "a *= 10" # Equivalent to echo "27 * 10 = $a" # 270

let "a = a * 10"

let "a %= 8" # Equivalent to let "a = a % 8" echo "270 modulo 8 = $a (270 / 8 = 33, remainder $a)" # 6 echo exit 0

eval eval arg1 [arg2] ... [argN] Combines the arguments in an expression or list of expressions and evaluates them. Any variables contained within the expression are expanded. The result translates into a command. This can be Chapter 14. Internal Commands and Builtins 169

Advanced BashScripting Guide useful for code generation from the command line or within a script.
bash$ process=xterm bash$ show_process="eval ps ax | grep $process" bash$ $show_process 1867 tty1 S 0:02 xterm 2779 tty1 S 0:00 xterm 2886 pts/1 S 0:00 grep xterm

Example 1411. Showing the effect of eval

#!/bin/bash y=`eval ls l` echo $y echo echo "$y" echo; echo y=`eval df` echo $y # Similar to y=`df` #+ but linefeeds removed. # Similar to y=`ls l` #+ but linefeeds removed because "echoed" variable is unquoted. # Linefeeds preserved when variable is quoted.

# When LF's not preserved, it may make it easier to parse output, #+ using utilities such as "awk". echo echo "===========================================================" echo # Now, showing how to "expand" a variable using "eval" . . . for i in 1 2 3 4 5; do eval value=$i # value=$i has same effect. The "eval" is not necessary here. # A variable lacking a metameaning evaluates to itself #+ it can't expand to anything other than its literal self. echo $value done echo echo "" echo for i in ls df; do value=eval $i # value=$i has an entirely different effect here. # The "eval" evaluates the commands "ls" and "df" . . . # The terms "ls" and "df" have a metameaning, #+ since they are interpreted as commands, #+ rather than just character strings. echo $value done

exit 0

Example 1412. Echoing the commandline parameters

Chapter 14. Internal Commands and Builtins

170

Advanced BashScripting Guide

#!/bin/bash # echoparams.sh # Call this script with a few command line parameters. # For example: # sh echoparams.sh first second third fourth fifth params=$# param=1 # Number of commandline parameters. # Start at first commandline param.

while [ "$param" le "$params" ] do echo n "Command line parameter " echo n \$$param # Gives only the *name* of variable. # ^^^ # $1, $2, $3, etc. # Why? # \$ escapes the first "$" #+ so it echoes literally, #+ and $param dereferences "$param" . . . #+ . . . as expected. echo n " = " eval echo \$$param # Gives the *value* of variable. # ^^^^ ^^^ # The "eval" forces the *evaluation* #+ of \$$ #+ as an indirect variable reference. (( param ++ )) done exit $? # ================================================= $ sh echoparams.sh first Command line parameter $1 Command line parameter $2 Command line parameter $3 Command line parameter $4 Command line parameter $5 second third fourth fifth = first = second = third = fourth = fifth # On to the next.

Example 1413. Forcing a logoff

#!/bin/bash # Killing ppp to force a logoff. # Script should be run as root user. killppp="eval kill 9 `ps ax | awk '/ppp/ { print $1 }'`" # process ID of ppp $killppp # This variable is now a command.

# The following operations must be done as root user. chmod 666 /dev/ttyS3 # Restore read+write permissions, or else what? # Since doing a SIGKILL on ppp changed the permissions on the serial port, #+ we restore permissions to previous state. rm /var/lock/LCK..ttyS3 # Remove the serial port lock file. Why?

Chapter 14. Internal Commands and Builtins

171

Advanced BashScripting Guide

# # #+ #+ Note: Depending on the hardware and even the kernel version, the modem port on your machine may be different /dev/ttyS1 or /dev/ttyS2.

exit 0 # Exercises: # # 1) Have script check whether root user is invoking it. # 2) Do a check on whether the process to be killed #+ is actually running before attempting to kill it. # 3) Write an alternate version of this script based on 'fuser': #+ if [ fuser s /dev/modem ]; then . . .

Example 1414. A version of rot13

#!/bin/bash # A version of "rot13" using 'eval'. # Compare to "rot13.sh" example. setvar_rot_13() # "rot13" scrambling { local varname=$1 varvalue=$2 eval $varname='$(echo "$varvalue" | tr az nzam)' }

setvar_rot_13 var "foobar" echo $var setvar_rot_13 var "$var" echo $var

# Run "foobar" through rot13. # sbbone # Run "sbbone" through rot13. # Back to original variable. # foobar

# This example by Stephane Chazelas. # Modified by document author. exit 0

Rory Winston contributed the following instance of how useful eval can be.

Example 1415. Using eval to force variable substitution in a Perl script

In the Perl script "test.pl": ... my $WEBROOT = <WEBROOT_PATH>; ... To force variable substitution try: $export WEBROOT_PATH=/usr/local/webroot $sed 's/<WEBROOT_PATH>/$WEBROOT_PATH/' < test.pl > out But this just gives: my $WEBROOT = $WEBROOT_PATH; However: $export WEBROOT_PATH=/usr/local/webroot $eval sed 's%\<WEBROOT_PATH\>%$WEBROOT_PATH%' < test.pl > out # ====

Chapter 14. Internal Commands and Builtins

172

Advanced BashScripting Guide

That works fine, and gives the expected substitution: my $WEBROOT = /usr/local/webroot;

### Correction applied to original example by Paulo Marcel Coelho Aragao.

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.

Example 1416. Using set with positional parameters

#!/bin/bash # script "settest" # Invoke this script with three command line parameters, # for example, "./settest one two three". echo echo echo echo echo

"Positional parameters "Commandline argument "Commandline argument "Commandline argument

before set \`uname a\` :" #1 = $1" #2 = $2" #3 = $3"

set `uname a` # Sets the positional parameters to the output # of the command `uname a` echo $_ # unknown # Flags set in script. echo "Positional parameters after set \`uname a\` :" # $1, $2, $3, etc. reinitialized to result of `uname a` echo "Field #1 of 'uname a' = $1" echo "Field #2 of 'uname a' = $2" echo "Field #3 of 'uname a' = $3" echo echo $_ # echo exit 0

More fun with positional parameters.

Example 1417. Reversing the positional parameters

#!/bin/bash # revposparams.sh: Reverse positional parameters.

Chapter 14. Internal Commands and Builtins

173

Advanced BashScripting Guide

# Script by Dan Jacobson, with stylistic revisions by document author.

set a\ b c d\ e; # ^ ^ # ^ ^ OIFS=$IFS; IFS=:; # ^ echo

Spaces escaped Spaces not escaped Saving old IFS and setting new one.

until [ $# eq 0 ] do # Step through positional parameters. echo "### k0 = "$k"" # Before k=$1:$k; # Append each pos param to loop variable. # ^ echo "### k = "$k"" # After echo shift; done set $k # echo echo $# # echo echo for i do echo $i done IFS=$OIFS # # #+ # # #+ # # Display new positional parameters. Set new positional parameters. Count of positional parameters.

# Omitting the "in list" sets the variable i #+ to the positional parameters.

# Restore IFS.

Question: Is it necessary to set an new IFS, internal field separator, in order for this script to work properly? What happens if you don't? Try it. And, why use the new IFS a colon in line 17, to append to the loop variable? What is the purpose of this?

exit 0 $ ./revposparams.sh ### k0 = ### k = a b ### k0 = a b ### k = c a b ### k0 = c a b ### k = d e c a b 3 d e c

Chapter 14. Internal Commands and Builtins

174

Advanced BashScripting Guide

a b

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. If no variable follows the it unsets the positional parameters.

Example 1418. Reassigning the positional parameters

#!/bin/bash variable="one two three four five" set $variable # Sets positional parameters to the contents of "$variable". first_param=$1 second_param=$2 shift; shift # Shift past first two positional params. # shift 2 also works. remaining_params="$*" echo echo "first parameter = $first_param" echo "second parameter = $second_param" echo "remaining parameters = $remaining_params" echo; echo # Again. set $variable first_param=$1 second_param=$2 echo "first parameter = $first_param" echo "second parameter = $second_param"

# one # two # three four five

# one # two

# ====================================================== set # Unsets positional parameters if no variable specified. first_param=$1 second_param=$2 echo "first parameter = $first_param" echo "second parameter = $second_param" exit 0

# (null value) # (null value)

See also Example 102 and Example 1551. Chapter 14. Internal Commands and Builtins 175

Advanced BashScripting Guide unset The unset command deletes a shell variable, effectively setting it to null. Note that this command does not affect positional parameters.
bash$ unset PATH bash$ echo $PATH bash$

Example 1419. "Unsetting" a variable

#!/bin/bash # unset.sh: Unsetting a variable. variable=hello echo "variable = $variable" unset variable echo "(unset) variable = $variable" # Initialized.

# Unset. # Same effect as: variable= # $variable is null.

if [ z "$variable" ] # Try a stringlength test. then echo "\$variable has zero length." fi exit 0

export The export command makes available variables to all child processes of the running script or shell. One important use of the export command is in startup files, to initialize and make accessible environmental variables to subsequent user processes. Unfortunately, there is no way to export variables back to the parent process, to the process that called or invoked the script or shell. Example 1420. Using export to pass a variable to an embedded awk script
#!/bin/bash # #+ # #+ Yet another version of the "column totaler" script (coltotaler.sh) that adds up a specified column (of numbers) in the target file. This uses the environment to pass a script variable to 'awk' . . . and places the awk script in a variable.

ARGS=2 E_WRONGARGS=65 if [ $# ne "$ARGS" ] # Check for proper no. of command line args. then echo "Usage: `basename $0` filename columnnumber" exit $E_WRONGARGS fi filename=$1 column_number=$2

Chapter 14. Internal Commands and Builtins

176

Advanced BashScripting Guide

#===== Same as original script, up to this point =====# export column_number # Export column number to environment, so it's available for retrieval.

# awkscript='{ total += $ENVIRON["column_number"] } END { print total }' # Yes, a variable can hold an awk script. # # Now, run the awk script. awk "$awkscript" "$filename" # Thanks, Stephane Chazelas. exit 0

It is possible to initialize and export variables in the same operation, as in export var1=xxx. However, as Greg Keraunen points out, in certain situations this may have a different effect than setting a variable, then exporting it.
bash$ export var=(a b); echo ${var[0]} (a b)

bash$ var=(a b); export var; echo ${var[0]} a

declare, typeset The declare and typeset commands specify and/or restrict properties of variables. readonly Same as declare r, sets a variable as readonly, 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 commandline 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 [38] 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 increments 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 (). It is the prefixed that lets getopts recognize commandline Chapter 14. Internal Commands and Builtins 177

Advanced BashScripting Guide arguments as options. In fact, getopts will not process arguments without the prefixed , 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 deprecated getopt external command.
while getopts ":abcde:fg" Option # Initial declaration. # a, b, c, d, e, f, and g are the options (flags) expected. # The : after option 'e' shows it will have an argument passed with it. do case $Option in a ) # Do something with variable 'a'. b ) # Do something with variable 'b'. ... e) # Do something with 'e', and also with $OPTARG, # which is the associated argument passed with option 'e'. ... g ) # Do something with variable 'g'. esac done shift $(($OPTIND 1)) # Move argument pointer to next. # All this is not nearly as complicated as it looks <grin>.

Example 1421. Using getopts to read the options/arguments passed to a script

#!/bin/bash # Exercising getopts and OPTIND # Script modified 10/09/03 at the suggestion of Bill Gradwohl.

# Here we observe how 'getopts' processes command line arguments to script. # The arguments are parsed as "options" (flags) and associated arguments. # Try invoking this script with # 'scriptname mn' # 'scriptname oq qOption' (qOption can be some arbitrary string.) # 'scriptname qXXX r' # # 'scriptname qr' Unexpected result, takes "r" as the argument to option "q" # 'scriptname q r' Unexpected result, same as above # 'scriptname mnop mnop' Unexpected result # (OPTIND is unreliable at stating where an option came from). # # If an option expects an argument ("flag:"), then it will grab #+ whatever is next on the command line. NO_ARGS=0 E_OPTERROR=65 if [ $# eq "$NO_ARGS" ] # Script invoked with no commandline args? then echo "Usage: `basename $0` options (mnopqrs)" exit $E_OPTERROR # Exit and explain usage, if no argument(s) given. fi # Usage: scriptname options

Chapter 14. Internal Commands and Builtins

178

Advanced BashScripting Guide

# Note: dash () necessary

while getopts ":mnopq:rs" Option do case $Option in m ) echo "Scenario #1: option m [OPTIND=${OPTIND}]";; n | o ) echo "Scenario #2: option $Option [OPTIND=${OPTIND}]";; p ) echo "Scenario #3: option p [OPTIND=${OPTIND}]";; q ) echo "Scenario #4: option q\ with argument \"$OPTARG\" [OPTIND=${OPTIND}]";; # Note that option 'q' must have an associated argument, #+ otherwise it falls through to the default. r | s ) echo "Scenario #5: option $Option";; * ) echo "Unimplemented option chosen.";; # DEFAULT esac done shift $(($OPTIND 1)) # Decrements the argument pointer so it points to next argument. # $1 now references the first non option item supplied on the command line #+ if one exists. exit 0 # As Bill Gradwohl states, # "The getopts mechanism allows one to specify: scriptname mnop mnop #+ but there is no reliable way to differentiate what came from where #+ by using OPTIND."

Script Behavior source, . (dot command) This command, when invoked from the command line, executes a script. Within a script, a source filename loads the file filename. Sourcing a file (dotcommand) imports code into the script, appending to the script (same effect as the #include directive in a C program). The net result is the same as if the "sourced" lines of code were physically present in the body of the script. This is useful in situations when multiple scripts use a common data file or function library.

Example 1422. "Including" a data file

#!/bin/bash . datafile # Load a data file. # Same effect as "source datafile", but more portable. # The file "datafile" must be present in current working directory, #+ since it is referred to by its 'basename'. # Now, reference some data from that file. echo "variable1 (from datafile) = $variable1" echo "variable3 (from datafile) = $variable3" let "sum = $variable2 + $variable4" echo "Sum of variable2 + variable4 (from datafile) = $sum" echo "message1 (from datafile) is \"$message1\"" # Note: escaped quotes

Chapter 14. Internal Commands and Builtins

179

Advanced BashScripting Guide

print_message This is the messageprint function in the datafile.

exit 0

File datafile for Example 1422, above. Must be present in same directory.
# This is a data file loaded by a script. # Files of this type may contain variables, functions, etc. # It may be loaded with a 'source' or '.' command by a shell script. # Let's initialize some variables. variable1=22 variable2=474 variable3=5 variable4=97 message1="Hello, how are you?" message2="Enough for now. Goodbye." 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 }

If the sourced file is itself an executable script, then it will run, then return control to the script that called it. A sourced executable script may use a return for this purpose. Arguments may be (optionally) passed to the sourced file as positional parameters.
source $filename $arg1 arg2

It is even possible for a script to source itself, though this does not seem to have any practical applications.

Example 1423. A (useless) script that sources itself Chapter 14. Internal Commands and Builtins 180

Advanced BashScripting Guide

#!/bin/bash # selfsource.sh: a script sourcing itself "recursively." # From "Stupid Script Tricks," Volume II. MAXPASSCNT=100 # Maximum number of execution passes.

echo n "$pass_count " # At first execution pass, this just echoes two blank spaces, #+ since $pass_count still uninitialized. let "pass_count += 1" # Assumes the uninitialized variable $pass_count #+ can be incremented the first time around. # This works with Bash and pdksh, but #+ it relies on nonportable (and possibly dangerous) behavior. # Better would be to initialize $pass_count to 0 before incrementing. while [ "$pass_count" le $MAXPASSCNT ] do . $0 # Script "sources" itself, rather than calling itself. # ./$0 (which would be true recursion) doesn't work here. Why? done # #+ #+ #+ # # # #+ What occurs here is not actually recursion, since the script effectively "expands" itself, i.e., generates a new section of code with each pass through the 'while' loop', with each 'source' in line 20. Of course, the script interprets each newly 'sourced' "#!" line as a comment, and not as the start of a new script.

echo exit 0 # The net effect is counting from 1 to 100. # Very impressive.

# Exercise: # # Write a script that uses this trick to actually do something useful.

exit Unconditionally terminates a script. [39] The exit command may optionally take an integer argument, which is returned to the shell as the exit status of the script. It is 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. This is equivalent to an exit $?. An exit command may also be used to terminate a subshell. 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. [40]

Chapter 14. Internal Commands and Builtins

181

Advanced BashScripting Guide Example 1424. Effects of exec

#!/bin/bash exec echo "Exiting \"$0\"." # Exit from script here.

# # The following lines never execute. echo "This echo will never echo." exit 99 # # #+ # This script will not exit here. Check exit value after script terminates with an 'echo $?'. It will *not* be 99.

Example 1425. A script that exec's itself

#!/bin/bash # selfexec.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. echo "==================== Hit CtlC to exit ====================" sleep 1 exec $0 # Spawns another instance of this same script #+ that replaces the previous one. # Why not? # Will not exit here! # Exit code will not be 99!

echo "This line will never echo!" exit 99

An exec also serves to reassign file descriptors. For example, exec <zzzfile replaces stdin with the file zzzfile. 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 241 and Example 242). 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 of directory names with 'cd' cd /hpme pwd # Oops! Mistyped '/home'. # /home # The shell corrected the misspelling.

caller Putting a caller command inside a function echoes to stdout information about the caller of that function.

Chapter 14. Internal Commands and Builtins

182

Advanced BashScripting Guide

#!/bin/bash function1 () { # Inside function1 (). caller 0 # Tell me about it. } function1 # Line 9 of script.

# 9 main test.sh # ^ # ^^^^ # ^^^^^^^ caller 0

Line number that the function was called from. Invoked from "main" part of script. Name of calling script.

# Has no effect because it's not inside a function.

A caller command can also return caller information from a script sourced within another script. Analogous to a function, this is a "subroutine call." You may find this command useful in debugging. Commands true A command that returns a successful (zero) exit status, but does nothing else.
bash$ true bash$ echo $? 0

# Endless loop while true # alias for ":" do operation1 operation2 ... operationn # Need a way to break out of loop or script will hang. done

false A command that returns an unsuccessful exit status, but does nothing else.
bash$ false bash$ echo $? 1

# Testing "false" if false then echo "false evaluates \"true\"" else echo "false evaluates \"false\"" fi # false evaluates "false"

Chapter 14. Internal Commands and Builtins

183

Advanced BashScripting Guide

# Looping while "false" (null loop) while false do # The following code will not execute. operation1 operation2 ... operationn # Nothing happens! done

type [cmd] Similar to the which external command, type cmd identifies "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.
bash$ type '[' [ is a shell builtin bash$ type a '[' [ is a shell builtin [ is /usr/bin/[

bash$ type type type is a shell builtin

hash [cmds] Record the path name of specified commands in the shell hash table [41] 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. bind The bind builtin displays or modifies readline [42] key bindings. help Gets a short usage summary of a shell builtin. This is the counterpart to whatis, but for builtins.
bash$ help exit exit: exit [n] Exit the shell with a status of N. If N is omitted, the exit status is that of the last command executed.

14.1. Job Control Commands

Certain of the following job control commands take a "job identifier" as an argument. See the table at end of the chapter. 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.

Chapter 14. Internal Commands and Builtins

184

Advanced BashScripting Guide

bash$ sleep 100 & [1] 1384 bash $ jobs [1]+ Running

sleep 100 &

"1" is the job number (jobs are maintained by the current shell). "1384" is the PID or process ID 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 Remove job(s) from the shell's table of active jobs. fg, bg 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 waitedfor 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).

Example 1426. Waiting for a process to finish before proceeding

#!/bin/bash ROOT_UID=0 # Only users with $UID 0 have root privileges. E_NOTROOT=65 E_NOPARAMS=66 if [ "$UID" ne "$ROOT_UID" ] then echo "Must be root to run this script." # "Run along kid, it's past your bedtime." exit $E_NOTROOT fi if [ z "$1" ] then echo "Usage: `basename $0` findstring" exit $E_NOPARAMS fi

echo "Updating 'locate' database..." echo "This may take a while." updatedb /usr & # Must be run as root. 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 # Without the 'wait' command, in the worse case scenario,

Chapter 14. Internal Commands and Builtins

185

Advanced BashScripting Guide

#+ the script would exit while 'updatedb' was still running, #+ leaving it as an orphan process. 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 testscripts]$ total 1 rwxrxrx 1 bozo bozo _

34 Oct 11 15:09 test.sh

Placing a wait after the background command seems to remedy this.

#!/bin/bash # test.sh ls l & echo "Done." wait bash$ ./test.sh Done. [bozo@localhost testscripts]$ total 1 rwxrxrx 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 ControlZ, but it suspends the shell (the shell's parent process should resume it at an appropriate time). logout Exit a login shell, optionally specifying an exit status. 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 166).

Example 1427. A script that kills itself

Chapter 14. Internal Commands and Builtins

186

Advanced BashScripting Guide

#!/bin/bash # selfdestruct.sh kill $$ # Script kills its own process here. # Recall that "$$" is the script's PID.

echo "This line will not echo." # Instead, the shell sends a "Terminated" message to stdout. exit 0 # Normal exit? No!

# After this script terminates prematurely, #+ what exit status does it return? # # sh selfdestruct.sh # echo $? # 143 # # 143 = 128 + 15 # TERM signal

kill l lists all the signals (as does the file /usr/include/asm/signal.h). 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 child process that has terminated, but that the parent process has not (yet) killed, cannot be killed by a loggedon user you can't kill something that is already dead but init will generally clean it up sooner or later. killall The killall command kills a running process by name, rather than by process ID. If there are multiple instances of a particular command running, then doing a killall on that command will terminate them all. This refers to the killall command in /usr/bin, not the killall script in /etc/rc.d/init.d. command The command directive disables aliases and functions for the command immediately following it.
bash$ command ls

This is one of three shell directives that effect script command processing. The others are builtin and enable. builtin Invoking builtin BUILTIN_COMMAND runs the command "BUILTIN_COMMAND" as a shell builtin, temporarily disabling both functions and external system commands with the same 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 the external command /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. [43]. autoload Chapter 14. Internal Commands and Builtins 187

Advanced BashScripting Guide 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. [44] 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).

Table 141. Job identifiers Notation %N %S %?S %% %+ % $! Meaning Job number [N] Invocation (command line) of job begins with string 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

Chapter 14. Internal Commands and Builtins

188

Chapter 15. External Filters, Programs and Commands

Standard UNIX commands make shell scripts more versatile. The power of scripts comes from coupling system commands and shell directives with simple programming constructs.

15.1. Basic Commands

The first commands a novice learns 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 treelike listing of a directory structure. Other useful options are S, sort listing by file size, t, sort by file modification time, b, show escape characters, and i, show file inodes (see Example 154). The ls command returns a nonzero exit status when attempting to list a nonexistent file.
bash$ ls abc ls: abc: No such file or directory

bash$ echo $? 2

Example 151. Using ls to create a table of contents for burning a CDR disk
#!/bin/bash # ex40.sh (burncd.sh) # Script to automate burning a CDR.

SPEED=2 # May use higher speed if your hardware supports it. IMAGEFILE=cdimage.iso CONTENTSFILE=contents DEVICE=cdrom # DEVICE="0,0" For older versions of cdrecord DEFAULTDIR=/opt # This is the directory containing the data to be burned. # Make sure it exists. # Exercise: Add a test for this. # Uses Joerg Schilling's "cdrecord" package: # http://www.fokus.fhg.de/usr/schilling/cdrecord.html # If this script invoked as an ordinary user, may need to suid cdrecord #+ chmod u+s /usr/bin/cdrecord, as root. # Of course, this creates a security hole, though a relatively minor one. if [ z "$1" ] then IMAGE_DIRECTORY=$DEFAULTDIR # Default directory, if not specified on command line.

Chapter 15. External Filters, Programs and Commands

189

Advanced BashScripting Guide

else IMAGE_DIRECTORY=$1 fi # Create a "table of contents" file. ls lRF $IMAGE_DIRECTORY > $IMAGE_DIRECTORY/$CONTENTSFILE # The "l" option gives a "long" file listing. # The "R" option makes the listing recursive. # The "F" option marks the file types (directories get a trailing /). echo "Creating table of contents." # Create an image file preparatory to burning it onto the CDR. mkisofs r o $IMAGEFILE $IMAGE_DIRECTORY echo "Creating ISO9660 file system image ($IMAGEFILE)." # Burn the CDR. echo "Burning the disk." echo "Please be patient, this will take a while." cdrecord v isosize speed=$SPEED dev=$DEVICE $IMAGEFILE exit $?

cat, tac cat, an acronym for concatenate, lists a file to stdout. When combined with redirection (> or >>), it is commonly used to concatenate files.
# Uses of 'cat' cat filename cat file.1 file.2 file.3 > file.123

# Lists the file. # Combines three files into one.

The n option to cat inserts consecutive numbers before all lines of the target file(s). The b option numbers only the nonblank lines. The v option echoes nonprintable characters, using ^ notation. The s option squeezes multiple consecutive blank lines into a single blank line. See also Example 1525 and Example 1521. In a pipe, it may be more efficient to redirect the stdin to a file, rather than to cat the file.
cat filename | tr az AZ tr az AZ < filename # Same effect, but starts one less process, #+ and also dispenses with the pipe.

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 does not have the same effect as tac, as it preserves the order of the lines, but flips each one around (mirror image).
bash$ cat file1.txt This is line 1. This is line 2.

bash$ tac file1.txt This is line 2. This is line 1.

Chapter 15. External Filters, Programs and Commands

190

Advanced BashScripting Guide

bash$ rev file1.txt .1 enil si sihT .2 enil si sihT

cp This is the file copy command. cp file1 file2 copies file1 to file2, overwriting file2 if it already exists (see Example 156). Particularly useful are the a archive flag (for copying an entire directory tree), the u update flag (which prevents overwriting identicallynamed newer files), and the r and R recursive flags.
cp u source_dir/* dest_dir # "Synchronize" dest_dir to source_dir #+ by copying over all newer and not previously existing files.

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 919 and Example A2. When used in a noninteractive 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.
bash$ mv source_directory target_directory bash$ ls lF target_directory total 1 drwxrwxrx 2 bozo bozo

1024 May 28 19:20 source_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. The rm command will, by itself, fail to remove filenames beginning with a dash.
bash$ rm badname rm: invalid option b Try `rm help' for more information.

One way to accomplish this is to preface the filename to be removed with a dotslash .
bash$ rm ./badname

Another method is to precede the filename with a " ".

bash$ rm badname

When used with the recursive flag r, this command removes files all the way down the directory tree from the current directory. A careless rm rf * can wipe out a big chunk of a directory structure. rmdir Chapter 15. External Filters, Programs and Commands 191

Advanced BashScripting Guide Remove directory. The directory must be empty of all files including "invisible" dotfiles [45] for this command to succeed. mkdir Make directory, creates a new directory. For example, mkdir p project/programs/December creates the named directory. The p option automatically creates any necessary parent directories. chmod Changes the attributes of an existing file or directory (see Example 1413).
chmod +x filename # Makes "filename" executable for all users. chmod u+s filename # Sets "suid" bit on "filename" permissions. # An ordinary user may execute "filename" with same privileges as the file's owner. # (This does not apply to shell scripts.) chmod 644 filename # Makes "filename" readable/writable to owner, readable to others # (octal mode). chmod 444 filename # Makes "filename" readonly for all. # Modifying the file (for example, with a text editor) #+ not allowed for a user who does not own the file (except for root), #+ and even the file owner must force a filesave #+ if she modifies the file. # Same restrictions apply for deleting the file. chmod 1777 directoryname # Gives everyone read, write, and execute permission in directory, #+ however also sets the "sticky bit". # This means that only the owner of the directory, #+ owner of the file, and, of course, root #+ can delete any particular file in that directory. chmod 111 directoryname # Gives everyone executeonly permission in a directory. # This means that you can execute and READ the files in that directory #+ (execute permission necessarily includes read permission #+ because you can't execute a file without being able to read it). # But you can't list the files or search for them with the "find" command. # These restrictions do not apply to root. chmod 000 directoryname # No permissions at all for that directory. # Can't read, write, or execute files in it. # Can't even list files in it or "cd" to it. # But, you can rename (mv) the directory #+ or delete it (rmdir) if it is empty. # You can even symlink to files in the directory, #+ but you can't read, write, or execute the symlinks. # These restrictions do not apply to root.

chattr Change file attributes. This is analogous to chmod above, but with different options and a different invocation syntax, and it works only on an ext2 filesystem.

Chapter 15. External Filters, Programs and Commands

192

Advanced BashScripting Guide One particularly interesting chattr option is i. A chattr +i filename marks the file as immutable. The file cannot be modified, linked to, or deleted, not even by root. This file attribute can be set or removed only by root. In a similar fashion, the a option marks the file as append only.
root# chattr +i file1.txt

root# rm file1.txt rm: remove writeprotected regular file `file1.txt'? y rm: cannot remove `file1.txt': Operation not permitted

If a file has the s (secure) attribute set, then when it is deleted its block is zeroed out on the disk. If a file has the u (undelete) attribute set, then when it is deleted, its contents can still be retrieved (undeleted). If a file has the c (compress) attribute set, then it will automatically be compressed on writes to disk, and uncompressed on reads. The file attributes set with chattr do not show in a file listing (ls l). ln Creates links to preexistings files. A "link" is a reference to a file, an alternate name for it. The ln command permits referencing the linked file by more than one name and is a superior alternative to aliasing (see Example 46). The ln creates only a reference, a pointer to the file only a few bytes in size.

The ln command is most often used with the s, symbolic or "soft" link flag. Advantages of using the s flag are that it permits linking across file systems or to directories. The syntax of the command is a bit tricky. For example: ln s oldfile newfile links the previously existing oldfile to the newly created link, newfile. If a file named newfile has previously existed, an error message will result. Which type of link to use? As John Macdonald explains it: Both of these [types of links] provide a certain measure of dual reference if you edit the contents of the file using any name, your changes will affect both the original name and either a hard or soft new name. The differences between them occurs when you work at a higher level. The advantage of a hard link is that the new name is totally independent of the old name if you remove or rename the old name, that does not affect the hard link, which continues to point to the data while it would leave a soft link hanging pointing to the old name which is no longer there. The advantage of a soft link is that it can refer to a different file system (since it is just a reference to a file name, not to actual data). And, unlike a hard link, a symbolic link can refer to a directory.

Chapter 15. External Filters, Programs and Commands

193

Advanced BashScripting Guide Links give the ability to invoke a script (or any other type of executable) with multiple names, and having that script behave according to how it was invoked.

Example 152. Hello or Goodbye

#!/bin/bash # hello.sh: Saying "hello" or "goodbye" #+ depending on how script is invoked. # # # # # Make a link in current working directory ($PWD) to this script: ln s hello.sh goodbye Now, try invoking this script both ways: ./hello.sh ./goodbye

HELLO_CALL=65 GOODBYE_CALL=66 if [ $0 = "./goodbye" ] then echo "Goodbye!" # Some other goodbyetype commands, as appropriate. exit $GOODBYE_CALL fi echo "Hello!" # Some other hellotype commands, as appropriate. exit $HELLO_CALL

man, info These commands access the manual and information pages on system commands and installed utilities. When available, the info pages usually contain more detailed descriptions than do the man pages.

15.2. Complex Commands

Commands for more advanced users find exec COMMAND \; Carries out COMMAND on each file that find matches. The command sequence terminates with ; (the ";" is escaped to make certain the shell passes it to find literally, without interpreting it as a special character).
bash$ find ~/ name '*.txt' /home/bozo/.kde/share/apps/karm/karmdata.txt /home/bozo/misc/irmeyc.txt /home/bozo/testscripts/1.txt

If COMMAND contains {}, then find substitutes the full path name of the selected file for "{}".
find ~/ name 'core*' exec rm {} \;

Chapter 15. External Filters, Programs and Commands

194

Advanced BashScripting Guide

# Removes all core dump files from user's home directory. find /home/bozo/projects mtime 1 # Lists all files in /home/bozo/projects directory tree #+ that were modified within the last day. # # mtime = last modification time of the target file # ctime = last status change time (via 'chmod' or otherwise) # atime = last access time DIR=/home/bozo/junk_files find "$DIR" type f atime +5 exec rm {} \; # ^^ # Curly brackets are placeholder for the path name output by "find." # # Deletes all files in "/home/bozo/junk_files" #+ that have not been accessed in at least 5 days. # # "type filetype", where # f = regular file # d = directory, etc. # (The 'find' manpage has a complete listing.) find /etc exec grep '[09][09]*[.][09][09]*[.][09][09]*[.][09][09]*' {} \; # Finds all IP addresses (xxx.xxx.xxx.xxx) in /etc directory files. # There a few extraneous hits. How can they be filtered out? # Perhaps by: find /etc type f exec cat '{}' \; | tr c '.[:digit:]' '\n' \ | grep '^[^.][^.]*\.[^.][^.]*\.[^.][^.]*\.[^.][^.]*$' # # [:digit:] is one of the character classes #+ introduced with the POSIX 1003.2 standard. # Thanks, Stphane Chazelas.

The exec option to find should not be confused with the exec shell builtin. Example 153. Badname, eliminate file names in current directory containing bad characters and whitespace.
#!/bin/bash # badname.sh # Delete filenames in current directory containing bad characters. for filename in * do badname=`echo "$filename" | sed n /[\+\{\;\"\\\=\?~\(\)\<\>\&\*\|\$]/p` # badname=`echo "$filename" | sed n '/[+{;"\=?~()<>&*|$]/p'` also works. # Deletes files containing these nasties: + { ; " \ = ? ~ ( ) < > & * | $ # rm $badname 2>/dev/null # ^^^^^^^^^^^ Error messages deepsixed. done # Now, take care of files containing all manner of whitespace. find . name "* *" exec rm f {} \;

Chapter 15. External Filters, Programs and Commands

195

Advanced BashScripting Guide

# The path name of the file that "find" finds replaces the "{}". # The '\' ensures that the ';' is interpreted literally, as end of command. exit 0 # # Commands below this line will not execute because of "exit" command. # An alternative to the above script: find . name '*[+{;"\\=?~()<>&*|$ ]*' exec rm f '{}' \; # (Thanks, S.C.)

Example 154. Deleting a file by its inode number

#!/bin/bash # idelete.sh: Deleting a file by its inode number. # This is useful when a filename starts with an illegal character, #+ such as ? or . ARGCOUNT=1 E_WRONGARGS=70 E_FILE_NOT_EXIST=71 E_CHANGED_MIND=72 # Filename arg must be passed to script.

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 inum=`ls i | grep "$1" | awk '{print $1}'` # inum = inode (index node) number of file # # Every file has an inode, a record that holds its physical address info. # echo; echo n "Are you absolutely sure you want to delete \"$1\" (y/n)? " # The 'v' option to 'rm' also asks this. read answer case "$answer" in [nN]) echo "Changed your mind, huh?" exit $E_CHANGED_MIND ;; *) echo "Deleting file \"$1\".";; esac find . inum $inum exec rm {} \; # ^^ # Curly brackets are placeholder #+ for text output by "find." echo "File "\"$1"\" deleted!" exit 0

The find command also works without the exec option. Chapter 15. External Filters, Programs and Commands 196

Advanced BashScripting Guide

#!/bin/bash # Find suid root files. # A strange suid file might indicate a security hole, #+ or even a system intrusion. directory="/usr/sbin" # Might also try /sbin, /usr/bin, /usr/local/bin, etc. permissions="+4000" # suid root (dangerous!)

for file in $( find "$directory" perm "$permissions" ) do ls ltF author "$file" done

See Example 1527, Example 34, and Example 109 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 command substitution fails with a too many arguments error, substituting xargs often works. [46] 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 rwrwr rwrwr

1 bozo 1 bozo

bozo bozo

0 Jan 29 23:58 file1 0 Jan 29 23:58 file2

bash$ ls l | xargs total 0 rwrwr 1 bozo bozo 0 Jan 29 23:58 file1 rwrwr 1 bozo bozo 0 Jan...

bash$ find ~/mail type f | xargs grep "Linux" ./misc:UserAgent: slrn/0.9.8.1 (Linux) ./sentmailjul2005: hosted by the Linux Documentation Project. ./sentmailjul2005: (Linux Documentation Project Site, rtf version) ./sentmailjul2005: Subject: Criticism of Bozo's Windows/Linux article ./sentmailjul2005: while mentioning that the Linux ext2/ext3 filesystem . . .

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. ls | xargs n 8 echo lists the files in the current directory in 8 columns. Another useful option is 0, in combination with find print0 or grep lZ. This allows handling arguments containing whitespace or quotes. Chapter 15. External Filters, Programs and Commands 197

Advanced BashScripting Guide find / type f print0 | xargs 0 grep liwZ GUI | xargs 0 rm f grep rliwZ GUI / | xargs 0 rm f Either of the above will remove any file containing "GUI". (Thanks, S.C.) Example 155. Logfile: Using xargs to monitor system log
#!/bin/bash # Generates a log file in current directory # from the tail end of /var/log/messages. # Note: /var/log/messages must be world readable # if this script invoked by an ordinary user. # #root chmod 644 /var/log/messages LINES=5 ( date; uname a ) >>logfile # Time and machine name echo >>logfile tail n $LINES /var/log/messages | xargs | fmt s >>logfile echo >>logfile echo >>logfile exit 0 # # # #+ #+ # # # Note: As Frank Wang points out, unmatched quotes (either single or double quotes) in the source file may give xargs indigestion. He suggests the following substitution for line 15: tail n $LINES /var/log/messages | tr d "\"'" | xargs | fmt s >>logfile

# # # #+ #

Exercise: Modify this script to track changes in /var/log/messages at intervals of 20 minutes. Hint: Use the "watch" command.

As in find, a curly bracket pair serves as a placeholder for replacement text.

Example 156. Copying files in current directory to another

#!/bin/bash # copydir.sh # Copy (verbose) all files in current directory ($PWD) #+ to directory specified on command line. E_NOARGS=65

Chapter 15. External Filters, Programs and Commands

198

Advanced BashScripting Guide

if [ z "$1" ] # Exit if no argument given. then echo "Usage: `basename $0` directorytocopyto" exit $E_NOARGS fi ls # # # # # # # #+ #+ # # #+ #+ . | xargs i t cp ./{} $1 ^^ ^^ ^^ t is "verbose" (output command line to stderr) option. i is "replace strings" option. {} is a placeholder for output text. This is similar to the use of a curly bracket pair in "find." List the files in current directory (ls .), pass the output of "ls" as arguments to "xargs" (i t options), then copy (cp) these arguments ({}) to new directory ($1). The net result is the exact equivalent of cp * $1 unless any of the filenames has embedded "whitespace" characters.

exit 0

Example 157. Killing processes by name

#!/bin/bash # killbyname.sh: Killing processes by name. # Compare this script with killprocess.sh. # For instance, #+ try "./killbyname.sh xterm" #+ and watch all the xterms on your desktop disappear. # # # # #+ Warning: This is a fairly dangerous script. Running it carelessly (especially as root) can cause data loss and other undesirable effects.

E_BADARGS=66 if test z "$1" # No command line arg supplied? then echo "Usage: `basename $0` Process(es)_to_kill" exit $E_BADARGS fi

PROCESS_NAME="$1" ps ax | grep "$PROCESS_NAME" | awk '{print $1}' | xargs i kill {} 2&>/dev/null # ^^ ^^ # # # # # # Notes: i is the "replace strings" option to xargs. The curly brackets are the placeholder for the replacement. 2&>/dev/null suppresses unwanted error messages.

exit $?

Chapter 15. External Filters, Programs and Commands

199

Advanced BashScripting Guide

# The "killall" command has the same effect as this script, #+ but using it is not quite as educational.

Example 158. Word frequency analysis using xargs

#!/bin/bash # wf2.sh: Crude word frequency analysis on a text file. # Uses 'xargs' to decompose lines of text into single words. # Compare this example to the "wf.sh" script later on.

# Check for input file on command line. ARGS=1 E_BADARGS=65 E_NOFILE=66 if [ $# ne "$ARGS" ] # Correct number of arguments passed to script? then echo "Usage: `basename $0` filename" exit $E_BADARGS fi if [ ! f "$1" ] # Check if file exists. then echo "File \"$1\" does not exist." exit $E_NOFILE fi

######################################################## cat "$1" | xargs n1 | \ # List the file, one word per line. tr AZ az | \ # Shift characters to lowercase. sed e 's/\.//g' e 's/\,//g' e 's/ /\ /g' | \ # Filter out periods and commas, and #+ change space between words to linefeed, sort | uniq c | sort nr # Finally prefix occurrence count and sort numerically. ######################################################## # This does the same job as the "wf.sh" example, #+ but a bit more ponderously, and it runs more slowly (why?). exit 0

expr Allpurpose 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 Chapter 15. External Filters, Programs and Commands 200

Advanced BashScripting Guide expr 1 / 0 returns the error message, expr: division by zero Illegal arithmetic operations not allowed. 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` Extract substring of $length characters, starting at $position. Example 159. Using expr
#!/bin/bash # Demonstrating some of the uses of 'expr' # ======================================= echo # Arithmetic Operators # echo "Arithmetic Operators" echo a=`expr 5 + 3` echo "5 + 3 = $a" 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 # # Returns 1 if true, 0 if false, #+ opposite of normal Bash convention. echo "Logical Operators" echo x=24 y=25 b=`expr $x = $y` echo "b = $b"

# Test equality. # 0 ( $x ne $y )

Chapter 15. External Filters, Programs and Commands

201

Advanced BashScripting Guide

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 \< 10` echo "If a < 10, b = 1 (true)" echo "b = $b" # 1 ( 3 lt 10 ) echo # Note escaping of operators. 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

# String Operators # echo "String Operators" echo a=1234zipper43231 echo "The string being operated upon is \"$a\"." # length: length of string b=`expr length $a` echo "Length of \"$a\" is $b." # index: position of first character in substring # that matches a character in string b=`expr index $a 23` echo "Numerical position of first \"2\" in \"$a\" is \"$b\"." # substr: extract substring, starting position & length specified b=`expr substr $a 2 6` echo "Substring of \"$a\", starting at position 2,\ and 6 chars long is \"$b\"."

# The default behavior of the 'match' operations is to #+ search for the specified match at the ***beginning*** of the string. # # uses Regular Expressions b=`expr match "$a" '[09]*'` # Numerical count. echo Number of digits at the beginning of \"$a\" is $b. b=`expr match "$a" '\([09]*\)'` # Note that escaped parentheses # == == + trigger substring match. echo "The digits at the beginning of \"$a\" are \"$b\"." echo

Chapter 15. External Filters, Programs and Commands

202

Advanced BashScripting Guide

exit 0

The : operator can substitute for match. For example, b=`expr $a : [09]*` is the exact equivalent of b=`expr match $a [09]*` in the above listing.
#!/bin/bash echo echo "String operations using \"expr \$string : \" construct" echo "===================================================" echo a=1234zipper5FLIPPER43231 echo "The string being operated upon is \"`expr "$a" : '\(.*\)'`\"." # Escaped parentheses grouping operator. == == # #+ #+ # *************************** Escaped parentheses match a substring ***************************

# If no escaped parentheses... #+ then 'expr' converts the string operand to an integer. echo "Length of \"$a\" is `expr "$a" : '.*'`." # Length of string

echo "Number of digits at the beginning of \"$a\" is `expr "$a" : '[09]*'`." # # echo echo "The digits at the beginning of \"$a\" are `expr "$a" : '\([09]*\)'`." # == == 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 script illustrates how expr uses the escaped parentheses \( ... \) grouping operator in tandem with regular expression parsing to match a substring. Here is a another example, this time from "real life."
# Strip the whitespace from the beginning and end. LRFDATE=`expr "$LRFDATE" : '[[:space:]]*\(.*\)[[:space:]]*$'` # From Peter Knowles' "booklistgen.sh" script #+ for converting files to Sony Librie format. # (http://booklistgensh.peterknowles.com)

Chapter 15. External Filters, Programs and Commands

203

Advanced BashScripting Guide Perl, sed, and awk have far superior string parsing facilities. A short sed or awk "subroutine" within a script (see Section 33.2) is an attractive alternative to expr. See Section 9.2 for more on using expr in string operations.

15.3. Time / Date Commands

Time/date and timing date Simply invoked, date prints the date and time to stdout. Where this command gets interesting is in its formatting and parsing options.

Example 1510. Using date

#!/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. echo "The number of seconds elapsed since 01/01/1970 is `date +%s`." # %s yields number of seconds since "UNIX epoch" began, #+ but how is this useful? prefix=temp suffix=$(date +%s) # The "+%s" option to 'date' is GNUspecific. filename=$prefix.$suffix echo $filename # It's great for creating "unique" temp filenames, #+ even better than using $$. # Read the 'date' man page for more formatting options. exit 0

The u option gives the UTC (Universal Coordinated Time).

bash$ date Fri Mar 29 21:07:39 MST 2002

bash$ date u Sat Mar 30 04:07:42 UTC 2002

The date command has quite a number of output options. For example %N gives the nanosecond portion of the current time. One interesting use for this is to generate sixdigit random integers.
date +%N | sed e 's/000$//' e 's/^0//' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # Strip off leading and trailing zeroes, if present.

There are many more options (try man date). Chapter 15. External Filters, Programs and Commands 204

Advanced BashScripting Guide

date +%j # Echoes day of the year (days elapsed since January 1). date +%k%M # Echoes hour and minute in 24hour format, as a single digit string.

# The 'TZ' parameter permits overriding the default time zone. date # Mon Mar 28 21:42:16 MST 2005 TZ=EST date # Mon Mar 28 23:42:16 EST 2005 # Thanks, Frank Kannemann and Pete Sjoberg, for the tip.

SixDaysAgo=$(date date='6 days ago') OneMonthAgo=$(date date='1 month ago') OneYearAgo=$(date date='1 year ago')

# Four weeks back (not a month).

See also Example 34. zdump Time zone dump: echoes the time in a specified time zone.
bash$ zdump EST EST Tue Sep 18 22:09:22 2001 EST

time Outputs very verbose timing statistics for executing a command. time ls l / gives something like this:
0.00user 0.01system 0:00.05elapsed 16%CPU (0avgtext+0avgdata 0maxresident)k 0inputs+0outputs (149major+27minor)pagefaults 0swaps

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. Timestamping 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). Before doing a cp u (copy/update), use touch to update the time stamp of files you don't wish overwritten. As an example, if the directory /home/bozo/tax_audit contains the files spreadsheet051606.data, spreadsheet051706.data, and spreadsheet051806.data, then doing a touch spreadsheet*.data will protect these files from being overwritten by files with the same names during a cp u /home/bozo/financial_info/spreadsheet*data /home/bozo/tax_audit. Chapter 15. External Filters, Programs and Commands 205

Advanced BashScripting Guide at The at job control command executes a given set of commands at a specified time. Superficially, it resembles cron, however, at is chiefly useful for onetime execution of a command set. at 2pm January 15 prompts for a set of commands to execute at that time. These commands should be shellscript compatible, since, for all practical purposes, the user is typing in an executable shell script a line at a time. Input terminates with a CtlD. 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 runparts command in the file to execute a different set of scripts.
bash$ at 2:30 am Friday < atjobs.list job 2 at 20001027 02:30

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.

The concept of batch processing dates back to the era of mainframe computers. It means running a set of commands without user intervention. 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. It can be useful for timing or in processes running in the background, checking for a specific event every so often (polling), as in Example 296.
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!

The watch command may be a better choice than sleep for running commands at timed intervals. 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. It can be used for finegrained timing, or for polling an ongoing process at very frequent intervals.
usleep 30 # Pauses 30 microseconds.

This command is part of the Red Hat initscripts / rcscripts package.

Chapter 15. External Filters, Programs and Commands

206

Advanced BashScripting Guide 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. The clock command is a synonym for hwclock.

15.4. Text Processing Commands

Commands affecting text and text files sort File sort utility, 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 109, Example 1010, and Example A8. tsort Topological sort, reading in pairs of whitespaceseparated strings and sorting according to input patterns. The original purpose of tsort was to sort a list of dependencies for an obsolete version of the ld linker in an "ancient" version of UNIX. The results of a tsort will usually differ markedly from those of the standard sort command, above. uniq This filter removes duplicate lines from a sorted file. It is often seen in a pipe coupled with sort.
cat list1 list2 list3 | sort | uniq > final.list # Concatenates the list files, # sorts them, # removes duplicate lines, # and finally writes the result to an output file.

The useful c option prefixes each line of the input file with its number of occurrences.
bash$ cat testfile This line occurs only once. This line occurs twice. This line occurs twice. This line occurs three times. This line occurs three times. This line occurs three times.

bash$ uniq c testfile 1 This line occurs only once. 2 This line occurs twice. 3 This line occurs three times.

bash$ sort testfile | uniq c | sort nr 3 This line occurs three times. 2 This line occurs twice. 1 This line occurs only once.

Chapter 15. External Filters, Programs and Commands

207

Advanced BashScripting Guide 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.

Example 1511. Word Frequency Analysis

#!/bin/bash # wf.sh: Crude word frequency analysis on a text file. # This is a more efficient version of the "wf2.sh" script.

# Check for input file on command line. ARGS=1 E_BADARGS=65 E_NOFILE=66 if [ $# ne "$ARGS" ] # Correct number of arguments passed to script? then echo "Usage: `basename $0` filename" exit $E_BADARGS fi if [ ! f "$1" ] # Check if file exists. then echo "File \"$1\" does not exist." exit $E_NOFILE fi

######################################################## # main () sed e 's/\.//g' e 's/\,//g' e 's/ /\ /g' "$1" | tr 'AZ' 'az' | sort | uniq c | sort nr # ========================= # Frequency of occurrence # #+ #+ #+ Filter out periods and commas, and change space between words to linefeed, then shift characters to lowercase, and finally prefix occurrence count and sort numerically.

# Arun Giridhar suggests modifying the above to: # . . . | sort | uniq c | sort +1 [f] | sort +0 nr # This adds a secondary sort key, so instances of #+ equal occurrence are sorted alphabetically. # As he explains it: # "This is effectively a radix sort, first on the #+ least significant column #+ (word or string, optionally caseinsensitive) #+ and last on the most significant column (frequency)." # # As Frank Wang explains, the above is equivalent to #+ . . . | sort | uniq c | sort +0 nr #+ and the following also works: #+ . . . | sort | uniq c | sort k1nr k ########################################################

Chapter 15. External Filters, Programs and Commands

208

Advanced BashScripting Guide

exit 0 # Exercises: # # 1) Add 'sed' commands to filter out other punctuation, #+ such as semicolons. # 2) Modify the script to also filter out multiple spaces and #+ other whitespace. bash$ cat testfile This line occurs only once. This line occurs twice. This line occurs twice. This line occurs three times. This line occurs three times. This line occurs three times.

bash$ ./wf.sh testfile 6 this 6 occurs 6 line 3 times 3 three 2 twice 1 only 1 once

expand, unexpand The expand filter converts tabs to spaces. It is often used in a pipe. 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. Using cut to obtain a listing of the mounted filesystems:
cut d ' ' f1,2 /etc/mtab

Using cut to list the OS and kernel version:

uname a | cut d" " f1,3,11,12

Using cut to extract message headers from an email folder:

bash$ grep '^Subject:' readmessages | cut c1080 Re: Linux suitable for missioncritical apps? MAKE MILLIONS WORKING AT HOME!!! Spam complaint Re: Spam complaint

Using cut to parse a file:

# List all the users in /etc/passwd. FILENAME=/etc/passwd for user in $(cut d: f1 $FILENAME)

Chapter 15. External Filters, Programs and Commands

209

Advanced BashScripting Guide

do echo $user done # Thanks, Oleg Philon for suggesting this.

cut d ' ' f2,3 filename is equivalent to awk F'[ ]' '{ print $2, $3 }' filename It is even possible to specify a linefeed as a delimiter. The trick is to actually embed a linefeed (RETURN) in the command sequence.
bash$ cut d' ' f3,7,19 testfile This is line 3 of testfile. This is line 7 of testfile. This is line 19 of testfile.

Thank you, Jaka Kranjc, for pointing this out. See also Example 1543. paste Tool for merging together different files into a single, multicolumn file. In combination with cut, useful for creating system log files. join Consider this a specialpurpose 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 bash$ join 1.data 2.data File: 1.data 2.data 100 Shoes $40.00 200 Laces $1.00 300 Socks $2.00

The tagged field appears only once in the output. head lists the beginning of a file the default is 10 lines, but this can be changed to stdout. The command has a number of interesting options. Chapter 15. External Filters, Programs and Commands 210

Advanced BashScripting Guide Example 1512. Which files are scripts?

#!/bin/bash # scriptdetector.sh: Detects scripts within a directory. TESTCHARS=2 SHABANG='#!' # Test first 2 characters. # Scripts begin with a "shabang."

for file in * # Traverse all the files in current directory. do if [[ `head c$TESTCHARS "$file"` = "$SHABANG" ]] # head c2 #! # The 'c' option to "head" outputs a specified #+ number of characters, rather than lines (the default). then echo "File \"$file\" is a script." else echo "File \"$file\" is *not* a script." fi done exit 0 # # # #+ #+ # # #+ # Exercises: 1) Modify this script to take as an optional argument the directory to scan for scripts (rather than just the current working directory). 2) As it stands, this script gives "false positives" for Perl, awk, and other scripting language scripts. Correct this.

Example 1513. Generating 10digit random numbers

#!/bin/bash # rnd.sh: Outputs a 10digit random number # Script by Stephane Chazelas. head c4 /dev/urandom | od N4 tu4 | sed ne '1s/.* //p'

# =================================================================== # # 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.

Chapter 15. External Filters, Programs and Commands

211

Advanced BashScripting Guide

# The author of this script explains the action of 'sed', as follows. # head c4 /dev/urandom | od N4 tu4 | sed ne '1s/.* //p' # > | # Assume output up to "sed" > | # is 0000000 1198195154\n # # #+ # # # # #+ # # #+ sed begins reading characters: 0000000 1198195154\n. Here it finds a newline character, so it is ready to process the first line (0000000 1198195154). It looks at its <range><action>s. The first and only one is range 1 action s/.* //p

The line number is in the range, so it executes the action: tries to substitute the longest string ending with a space in the line ("0000000 ") with nothing (//), and if it succeeds, prints the result ("p" is a flag to the "s" command here, this is different from the "p" command).

# 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.

# In few word this sed commmand means: # "On the first line only, remove any character up to the rightmost space, #+ then print it." # A better way to do this would have been: # sed e 's/.* //;q' # Here, two <range><action>s (could have been written # sed e 's/.* //' e q): # # # range nothing (matches line) nothing (matches line) action s/.* // q (quit)

# Here, sed only reads its first line of input. # It performs both actions, and prints the line (substituted) before #+ quitting (because of the "q" action) since the "n" option is not passed. # =================================================================== # # An even simpler altenative to the above oneline script would be: # head c4 /dev/urandom| od An tu4 exit 0

See also Example 1535. tail lists the end of a file the default is 10 lines to stdout. Commonly used to keep track of changes to a system logfile, using the f option, which outputs lines appended to the file.

Chapter 15. External Filters, Programs and Commands

212

Advanced BashScripting Guide Example 1514. Using tail to monitor the system log
#!/bin/bash filename=sys.log cat /dev/null > $filename; echo "Creating / cleaning out file." # Creates file if it does not already exist, #+ and truncates it to zero length if it does. # : > filename and > filename also work. tail /var/log/messages > $filename # /var/log/messages must have world read permission for this to work. echo "$filename contains tail end of system log." exit 0

To list a specific line of a text file, pipe the output of head to tail n 1. For example head n 8 database.txt | tail n 1 lists the 8th line of the file database.txt. To set a variable to a given block of a text file:
var=$(head n $m $filename | tail n $n) # filename = name of file # m = from beginning of file, number of lines to end of block # n = number of lines to set variable to (trim from end of block)

Newer implementations of tail deprecate the older tail $LINES filename usage. The standard tail n $LINES filename is correct. See also Example 155, Example 1535 and Example 296. grep A multipurpose file search tool that uses Regular Expressions. It was originally a command/filter in the venerable ed line editor: g/re/p global regular expression print. grep pattern [file...] Search the target file(s) for occurrences of pattern, where pattern may be literal text or a Regular Expression.
bash$ grep '[rst]ystem.$' osinfo.txt The GPL governs the distribution of the Linux operating system.

If no target file(s) specified, grep works as a filter on stdout, as in a pipe.

bash$ ps ax | grep clock 765 tty1 S 0:00 xclock 901 pts/1 S 0:00 grep clock

The i option causes a caseinsensitive search. The w option matches only whole words. Chapter 15. External Filters, Programs and Commands 213

Advanced BashScripting Guide 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.
bash$ grep n Linux osinfo.txt 2:This is a file containing information about Linux. 6:The GPL governs the distribution of the Linux operating system.

The v (or invertmatch) option filters out matches.

grep pattern1 *.txt | grep v pattern2 # Matches all lines in "*.txt" files containing "pattern1", # but ***not*** "pattern2".

The c (count) option gives a numerical count of matches, rather than actually listing the matches.
grep c txt *.sgml # (number of occurrences of "txt" in "*.sgml" files)

# grep cz . # ^ dot # means count (c) zeroseparated (z) items matching "." # that is, nonempty ones (containing at least 1 character). # printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep cz . printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep cz '$' printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep cz '^' # printf 'a b\nc d\n\n\n\n\n\000\n\000e\000\000\nf' | grep c '$' # By default, newline chars (\n) separate items to match. # Note that the z option is GNU "grep" specific.

# 3 # 5 # 5 # 9

# Thanks, S.C.

When invoked with more than one target file given, grep specifies which file contains matches.
bash$ grep Linux osinfo.txt misc.txt osinfo.txt:This is a file containing information about Linux. osinfo.txt:The GPL governs the distribution of the Linux operating system. misc.txt:The Linux operating system is steadily gaining in popularity.

To force grep to show the filename when searching only one target file, simply give /dev/null as the second file.
bash$ grep Linux osinfo.txt /dev/null osinfo.txt:This is a file containing information about Linux. osinfo.txt:The GPL governs the distribution of the Linux operating system.

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. Chapter 15. External Filters, Programs and Commands 214

Advanced BashScripting Guide

SUCCESS=0 word=Linux filename=data.file grep q "$word" "$filename" # if grep lookup succeeds

# The "q" option causes nothing to echo to stdout.

if [ $? eq $SUCCESS ] # if grep q "$word" "$filename" can replace lines 5 7. then echo "$word found in $filename" else echo "$word not found in $filename" fi

Example 296 demonstrates how to use grep to search for a word pattern in a system logfile.

Example 1515. Emulating grep in a script

#!/bin/bash # grp.sh: Very crude reimplementation of 'grep'. E_BADARGS=65 if [ z "$1" ] # Check for argument to script. then echo "Usage: `basename $0` pattern" exit $E_BADARGS fi echo for file in * # Traverse all files in $PWD. do output=$(sed n /"$1"/p $file) # Command substitution. if [ ! z "$output" ] # What happens if "$output" is not quoted? then echo n "$file: " echo $output fi # sed ne "/$1/s|^|${file}: |p" is equivalent to above. echo done echo exit 0 # # # # Exercises: 1) Add newlines to output, if more than one match in any given file. 2) Add features.

How can grep search for two (or more) separate patterns? What if you want grep to display all lines in a file or files that contain both "pattern1" and "pattern2"? One method is to pipe the result of grep pattern1 to grep pattern2. For example, given the following file:

Chapter 15. External Filters, Programs and Commands

215

Advanced BashScripting Guide

# Filename: tstfile This This This This Here is a sample file. is an ordinary text file. file does not contain any unusual text. file is not unusual. is some text.

Now, let's search this file for lines containing both "file" and "text" . . .
bash$ grep file tstfile # Filename: tstfile This is a sample file. This is an ordinary text file. This file does not contain any unusual text. This file is not unusual. bash$ grep file tstfile | grep text This is an ordinary text file. This file does not contain any unusual text.

egrep extended grep is the same as grep E. This uses a somewhat different, extended set of Regular Expressions, which can make the search a bit more flexible. It also allows the boolean | (or) operator.
bash $ egrep 'matches|Matches' file.txt Line 1 matches. Line 3 Matches. Line 4 contains matches, but also Matches

fgrep fast grep is the same as grep F. It does a literal string search (no Regular Expressions), which usually speeds things up a bit. On some Linux distros, egrep and fgrep are symbolic links to, or aliases for grep, but invoked with the E and F options, respectively. Example 1516. Looking up definitions in Webster's 1913 Dictionary
#!/bin/bash # dictlookup.sh # # #+ #+ # # #+ # # This script looks up definitions in the 1913 Webster's Dictionary. This Public Domain dictionary is available for download from various sites, including Project Gutenberg (http://www.gutenberg.org/etext/247). Convert it from DOS to UNIX format (only LF at end of line) before using it with this script. Store the file in plain, uncompressed ASCII. Set DEFAULT_DICTFILE variable below to path/filename.

E_BADARGS=65 MAXCONTEXTLINES=50 # Maximum number of lines to show. DEFAULT_DICTFILE="/usr/share/dict/webster1913dict.txt" # Default dictionary file pathname. # Change this as necessary.

Chapter 15. External Filters, Programs and Commands

216

Advanced BashScripting Guide

# # # #+ #+ # #+ Note: This particular edition of the 1913 Webster's begins each entry with an uppercase letter (lowercase for the remaining characters). Only the *very first line* of an entry begins this way, and that's why the search algorithm below works.

if [[ z $(echo "$1" | sed n '/^[AZ]/p') ]] # Must at least specify word to look up, and #+ it must start with an uppercase letter. then echo "Usage: `basename $0` Wordtodefine [dictionaryfile]" echo echo "Note: Word to look up must start with capital letter," echo "with the rest of the word in lowercase." echo "" echo "Examples: Abandon, Dictionary, Marking, etc." exit $E_BADARGS fi

if [ z "$2" ] then dictfile=$DEFAULT_DICTFILE else dictfile="$2" fi

# May specify different dictionary #+ as an argument to this script.

# Definition=$(fgrep A $MAXCONTEXTLINES "$1 \\" "$dictfile") # Definitions in form "Word \..." # # And, yes, "fgrep" is fast enough #+ to search even a very large text file.

# Now, snip out just the definition block. echo "$Definition" | sed n '1,/^[AZ]/p' | # Print from first line of output #+ to the first line of the next entry. sed '$d' | sed '$d' # Delete last two lines of output #+ (blank line and first line of next entry). # exit 0 # # # # # # # # # Exercises: 1) Modify the script to accept any type of alphabetic input + (uppercase, lowercase, mixed case), and convert it + to an acceptable format for processing. 2) Convert the script to a GUI application, + using something like "gdialog" . . . The script will then no longer take its argument(s)

Chapter 15. External Filters, Programs and Commands

217

Advanced BashScripting Guide

# + from the command line. # # 3) Modify the script to parse one of the other available # + Public Domain Dictionaries, such as the U.S. Census Bureau Gazetteer.

agrep (approximate grep) 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 noncompressed files, though slower than plain grep, egrep, fgrep. They are handy for searching through a mixed set of files, some compressed, some not.

To search bzipped files, use bzgrep. look 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.

Example 1517. Checking words in a list for validity

#!/bin/bash # lookup: Does a dictionary lookup on each word in a data file. file=words.data echo while [ "$word" != end ] # Last word in data file. do # ^^^ read word # From data file, because of redirection at end of loop. look $word > /dev/null # Don't want to display lines in dictionary file. lookup=$? # Exit status of 'look' command. if [ "$lookup" eq 0 ] then echo "\"$word\" is valid." else echo "\"$word\" is invalid." fi done <"$file" echo exit 0 # # Code below line will not execute because of "exit" command above. # Redirects stdin to $file, so "reads" come from there. # Data file from which to read words to test.

# Stephane Chazelas proposes the following, more concise alternative: while read word && [[ $word != end ]]

Chapter 15. External Filters, Programs and Commands

218

Advanced BashScripting Guide

do if look "$word" > /dev/null then echo "\"$word\" is valid." else echo "\"$word\" is invalid." fi done <"$file" 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 Noninteractive "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 wc gives a "word count" on a file or I/O stream:
bash $ wc /usr/share/doc/sed4.1.2/README 13 70 447 README [13 lines 70 words 447 characters]

wc w gives only the word count. wc l gives only the line count. wc c gives only the byte count. wc m gives only the character count. wc L gives only the length of the longest line. 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. # Alternative ways of doing this are: # find . maxdepth 1 name \*.txt print0 | grep cz . # (shopt s nullglob; set *.txt; echo $#) # Thanks, S.C.

Using wc to total up the size of all the files whose names begin with letters in the range d h
bash$ wc [dh]* | grep total | awk '{print $3}' 71832

Using wc to count the instances of the word "Linux" in the main source file for this book.
bash$ grep Linux absbook.sgml | wc l 50

See also Example 1535 and Example 198.

Chapter 15. External Filters, Programs and Commands

219

Advanced BashScripting Guide Certain commands include some of the functionality of wc as options.
... | grep foo | wc l # This frequently used construct can be more concisely rendered. ... | grep c foo # Just use the "c" (or "count") option of grep. # Thanks, S.C.

tr character translation filter. 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 "AZ" "*" <filename or tr AZ \* <filename changes all the uppercase letters in filename to asterisks (writes to stdout). On some systems this may not work, but tr AZ '[**]' will. The d option deletes a range of characters.
echo "abcdef" echo "abcdef" | tr d bd # abcdef # aef

tr d 09 <filename # Deletes all digits from the file "filename".

The squeezerepeats (or s) option deletes all but the first instance of a string of consecutive characters. This option is useful for removing excess whitespace.
bash$ echo "XXXXX" | tr squeezerepeats 'X' X

The c "complement" option inverts the character set to match. With this option, tr acts only upon those characters not matching the specified set.
bash$ echo "acfdeb123" | tr c bd + +c+d+b++++

Note that tr recognizes POSIX character classes. [47]

bash$ echo "abcd2ef1" | tr '[:alpha:]' 21

Example 1518. toupper: Transforms a file to all uppercase.

#!/bin/bash # Changes a file to all uppercase. E_BADARGS=65 if [ z "$1" ] # Standard check for command line arg. then echo "Usage: `basename $0` filename" exit $E_BADARGS fi

Chapter 15. External Filters, Programs and Commands

220

Advanced BashScripting Guide

tr az AZ <"$1" # Same effect as above, but using POSIX character set notation: # tr '[:lower:]' '[:upper:]' <"$1" # Thanks, S.C. exit 0 # Exercise: # Rewrite this script to give the option of changing a file #+ to *either* upper or lowercase.

Example 1519. lowercase: Changes all filenames in working directory to lowercase.

#!/bin/bash # # Changes every filename in working directory to all lowercase. # # Inspired by a script of John Dubois, #+ which was translated into Bash by Chet Ramey, #+ and considerably simplified by the author of the ABS Guide.

for filename in * do fname=`basename $filename` n=`echo $fname | tr AZ az` if [ "$fname" != "$n" ] then mv $fname $n fi done exit $?

# Traverse all files in directory.

# Change name to lowercase. # Rename only files not already lowercase.

# Code below this line will not execute because of "exit". ## # To run it, delete script above line. # The above script will not work on filenames containing blanks or newlines. # Stephane Chazelas therefore suggests the following alternative:

for filename in *

# Not necessary to use basename, # since "*" won't return any file containing "/". do n=`echo "$filename/" | tr '[:upper:]' '[:lower:]'` # POSIX char set notation. # Slash added so that trailing newlines are not # removed by command substitution. # Variable substitution: n=${n%/} # Removes trailing slash, added above, from filename. [[ $filename == $n ]] || mv "$filename" "$n" # Checks if filename already lowercase. done exit $?

Example 1520. du: DOS to UNIX text file conversion. Chapter 15. External Filters, Programs and Commands 221

Advanced BashScripting Guide

#!/bin/bash # Du.sh: DOS to UNIX text file converter. E_WRONGARGS=65 if [ z "$1" ] then echo "Usage: `basename $0` filenametoconvert" exit $E_WRONGARGS fi NEWFILENAME=$1.unx CR='\015' # # # # Carriage return. 015 is octal ASCII code for CR. Lines in a DOS text file end in CRLF. Lines in a UNIX text file end in LF only.

tr d $CR < $1 > $NEWFILENAME # Delete CR's and write to new file. echo "Original DOS text file is \"$1\"." echo "Converted UNIX text file is \"$NEWFILENAME\"." exit 0 # Exercise: # # Change the above script to convert from UNIX to DOS.

Example 1521. rot13: ultraweak encryption.

#!/bin/bash # rot13.sh: Classic rot13 algorithm, # encryption that might fool a 3year old. # Usage: ./rot13.sh filename # or ./rot13.sh <filename # or ./rot13.sh and supply keyboard input (stdin) cat "$@" | tr 'azAZ' 'nzamNZAM' # "a" goes to "n", "b" to "o", etc. # The 'cat "$@"' construction #+ permits getting input either from stdin or from files. exit 0

Example 1522. Generating "CryptoQuote" Puzzles

#!/bin/bash # cryptoquote.sh: Encrypt quotes # Will encrypt famous quotes in a simple monoalphabetic substitution. # The result is similar to the "Crypto Quote" puzzles #+ seen in the Op Ed pages of the Sunday paper.

key=ETAOINSHRDLUBCFGJMQPVWZYXK # The "key" is nothing more than a scrambled alphabet. # Changing the "key" changes the encryption.

Chapter 15. External Filters, Programs and Commands

222

Advanced BashScripting Guide

# The 'cat "$@"' construction gets input either from stdin or from files. # If using stdin, terminate input with a ControlD. # Otherwise, specify filename as commandline parameter. cat "$@" | tr "az" "AZ" | tr "AZ" "$key" # | to uppercase | encrypt # Will work on lowercase, uppercase, or mixedcase quotes. # Passes nonalphabetic characters through unchanged.

# # # # # # #

Try this script with something like: "Nothing so needs reforming as other people's habits." Mark Twain Output is: "CFPHRCS QF CIIOQ MINFMBRCS EQ FPHIM GIFGUI'Q HETRPQ." BEML PZERC

# To reverse the encryption: # cat "$@" | tr "$key" "AZ"

# This simpleminded cipher can be broken by an average 12year old #+ using only pencil and paper. exit 0 # # # #+ Exercise: Modify the script so that it will either encrypt or decrypt, depending on commandline argument(s).

tr variants The tr utility has two historic variants. The BSD version does not use brackets (tr az AZ), but the SysV one does (tr '[az]' '[AZ]'). The GNU version of tr resembles the BSD one. 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 1523 and Example A1). fmt Simpleminded file formatter, used as a filter in a pipe to "wrap" long lines of text output.

Example 1523. Formatted file listing.

#!/bin/bash WIDTH=40 b=`ls /usr/local/bin` echo $b | fmt w $WIDTH # Could also have been done by # echo $b | fold s w $WIDTH exit 0 # 40 columns wide. # Get a file listing...

Chapter 15. External Filters, Programs and Commands

223

Advanced BashScripting Guide See also Example 155. A powerful alternative to fmt is Kamil Toman's par utility, available from http://www.cs.berkeley.edu/~amc/Par/. col 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 listtype text output into a "prettyprinted" table by inserting tabs at appropriate places.

Example 1524. Using column to format a directory listing

#!/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 PROGNAME\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". # The t option to "column" prettyprints a table. 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 nonblank line. If filename omitted, operates on stdin. The output of nl is very similar to cat b, since, by default nl does not list blank lines.

Example 1525. nl: A selfnumbering script.

#!/bin/bash # linenumber.sh # This script echoes itself twice to stdout with its lines numbered. # 'nl' sees this as line 4 since it does not number blank lines. # 'cat n' sees the above line as number 6.

Chapter 15. External Filters, Programs and Commands

224

Advanced BashScripting Guide

nl `basename $0` echo; echo # Now, let's try it with 'cat n'

cat n `basename $0` # The difference is that 'cat n' numbers the blank lines. # Note that 'nl ba' will also do so. 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 doublespacing (same effect as sed G). gettext The GNU gettext package is a set of utilities for localizing and translating the text output of programs into foreign languages. While originally intended for C programs, it now supports quite a number of programming and scripting languages. The gettext program works on shell scripts. See the info page. msgfmt A program for generating binary message catalogs. It is used for localization. iconv A utility for converting file(s) to a different encoding (character set). Its chief use is for localization.
# Convert a string from UTF8 to UTF16 and print to the BookList function write_utf8_string { STRING=$1 BOOKLIST=$2 echo n "$STRING" | iconv f UTF8 t UTF16 | \ cut b 3 | tr d \\n >> "$BOOKLIST" } # From Peter Knowles' "booklistgen.sh" script #+ for converting files to Sony Librie format. # (http://booklistgensh.peterknowles.com)

recode Consider this a fancier version of iconv, above. This very versatile utility for converting a file to a different encoding scheme. Note that recode> 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. Ghostscript (gs) is a GPLed Postscript interpreter. texexec Chapter 15. External Filters, Programs and Commands 225

Advanced BashScripting Guide Utility for processing TeX and pdf files. Found in /usr/bin on many Linux distros, it is actually a shell wrapper that calls Perl to invoke Tex.
texexec pdfarrange result=Concatenated.pdf *pdf # #+ # # Concatenates all the pdf files in the current working directory into the merged file, Concatenated.pdf . . . (The pdfarrange option repaginates a pdf file. See also pdfcombine.) The above command line could be parameterized and put into a shell script.

enscript Utility for converting plain text file to PostScript For example, enscript filename.txt p filename.ps produces the PostScript output file filename.ps. groff, tbl, eqn 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. 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.

Example 1526. manview: Viewing formatted manpages

#!/bin/bash # manview.sh: Formats the source of a man page for viewing. # This script is useful when writing man page source. # It lets you 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 # groff Tascii man $1 | less # From the man page for groff. # # If the man page includes tables and/or equations, #+ then the above code will barf. # The following line can handle such cases. # # gtbl < "$1" | geqn Tlatin1 | groff Tlatin1 mttychar man # # Thanks, S.C. exit 0

lex, yacc Chapter 15. External Filters, Programs and Commands 226

Advanced BashScripting Guide 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.

15.5. File and Archiving Commands

Archiving tar The standard UNIX archiving utility. [48] 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 34). GNU tar has been patched to accept various compression filters, for example: 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). [49] Some useful tar options: 1. c create (a new archive) 2. x extract (files from existing archive) 3. delete delete (files from existing archive) This option will not work on magnetic tape devices. 4. r append (files to existing archive) 5. A append (tar files to existing archive) 6. t list (contents of existing archive) 7. u update archive 8. d compare archive with specified filesystem 9. z gzip the archive (compress or uncompress, depending on whether combined with the c or x) option 10. j bzip2 the archive 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 Usenet 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. rpm The Red Hat Package Manager, or rpm utility provides a wrapper for source or binary archives. It includes commands for installing and checking the integrity of packages, among other things.

Chapter 15. External Filters, Programs and Commands

227

Advanced BashScripting Guide A simple rpm i package_name.rpm usually suffices to install a package, though there are many more options available. rpm qf identifies which package a file originates from.
bash$ rpm qf /bin/ls coreutils5.2.131

rpm qa gives a complete list of all installed rpm packages on a given system. An rpm qa package_name lists only the package(s) corresponding to package_name.
bash$ rpm qa redhatlogos1.1.31 glibc2.2.413 cracklib2.712 dosfstools2.71 gdbm1.8.010 ksymoops2.4.11 mktemp1.511 perl5.6.017 reiserfsutils3.x.0j2 ...

bash$ rpm qa docbookutils docbookutils0.6.92

bash$ rpm qa docbook | grep docbook docbookdtd31sgml1.010 docbookstyledsssl1.643 docbookdtd30sgml1.010 docbookdtd40sgml1.011 docbookutilspdf0.6.92 docbookdtd41sgml1.010 docbookutils0.6.92

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. With an appropriate block size (for copying) specified, it can be appreciably faster than tar.

Example 1527. Using cpio to move a directory tree

#!/bin/bash # Copying a directory tree using cpio. # Advantages of using 'cpio': # Speed of copying. It's faster than 'tar' with pipes. # Well suited for copying special files (named pipes, etc.) #+ that 'cp' may choke on. ARGS=2

Chapter 15. External Filters, Programs and Commands

228

Advanced BashScripting Guide

E_BADARGS=65 if [ $# ne "$ARGS" ] then echo "Usage: `basename $0` source destination" exit $E_BADARGS fi source=$1 destination=$2

find "$source" depth | cpio admvp "$destination" # ^^^^^ ^^^^^ # Read the 'find' and 'cpio' man pages to decipher these options.

# Exercise: # # Add code to check the exit status ($?) of the 'find | cpio' pipe #+ and output appropriate error messages if anything went wrong. exit 0

rpm2cpio This command extracts a cpio archive from an rpm one.

Example 1528. Unpacking an rpm archive

#!/bin/bash # derpm.sh: Unpack an 'rpm' archive : ${1?"Usage: `basename $0` targetfile"} # Must specify 'rpm' archive name as an argument.

TEMPFILE=$$.cpio

# # # #+ # #

Tempfile with "unique" name. $$ is process ID of script. Converts rpm archive into cpio archive. Unpacks cpio archive. Deletes cpio archive.

rpm2cpio < $1 > $TEMPFILE cpio makedirectories F $TEMPFILE i rm f $TEMPFILE exit 0

# Exercise: # Add check for whether 1) "targetfile" exists and #+ 2) it is an rpm archive. # Hint: Parse output of 'file' command.

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.

Chapter 15. External Filters, Programs and Commands

229

Advanced BashScripting Guide The c option sends the output of gzip to stdout. This is useful when piping to other commands. 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. See also Example 77. bzip2 An alternate compression utility, usually more efficient (but slower) than gzip, especially on large files. The corresponding decompression command is bunzip2. Newer versions of tar have been patched with bzip2 support. compress, uncompress 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. The znew command transforms compressed files into gzipped ones. sq Yet another compression (squeeze) utility, a filter that works only on sorted ASCII word lists. It uses the standard invocation syntax for a filter, sq < inputfile > outputfile. Fast, but not nearly as efficient as gzip. The corresponding uncompression filter is unsq, invoked like sq. The output of sq may be piped to gzip for further compression. zip, unzip Crossplatform file archiving and compression utility compatible with DOS pkzip.exe. "Zipped" archives seem to be a more common medium of file 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 filename will return a file specification for filename, 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.
bash$ file test.tar.gz test.tar.gz: gzip compressed data, deflated, last modified: Sun Sep 16 13:34:51 2001, os: Unix

Chapter 15. External Filters, Programs and Commands

230

Advanced BashScripting Guide

bash file z test.tar.gz test.tar.gz: GNU tar archive (gzip compressed data, deflated, last modified: Sun Sep 16 13:34:51 2001, os: Unix)

# Find sh and Bash scripts in a given directory: DIRECTORY=/usr/local/bin KEYWORD=Bourne # Bourne and BourneAgain shell scripts file $DIRECTORY/* | fgrep $KEYWORD # Output: # # # # # /usr/local/bin/burncd: /usr/local/bin/burnit: /usr/local/bin/cassette.sh: /usr/local/bin/copycd: . . . BourneAgain BourneAgain Bourne shell BourneAgain shell script text executable shell script text executable script text executable shell script text executable

Example 1529. Stripping comments from C program files

#!/bin/bash # stripcomment.sh: Strips out the comments (/* COMMENT */) in a C program. E_NOARGS=0 E_ARGERROR=66 E_WRONG_FILE_TYPE=67 if [ $# eq "$E_NOARGS" ] then echo "Usage: `basename $0` Cprogramfile" >&2 # Error message to stderr. exit $E_ARGERROR fi # Test for correct file type. type=`file $1 | awk '{ print $2, $3, $4, $5 }'` # "file $1" echoes file type . . . # Then awk removes the first field, the filename . . . # Then the result is fed into the variable "type." correct_type="ASCII C program text" if [ "$type" != "$correct_type" ] then echo echo "This script works on C program files only." echo exit $E_WRONG_FILE_TYPE fi

# Rather cryptic sed script: # sed ' /^\/\*/d /.*\*\//d ' $1 # # Easy to understand if you take several hours to learn sed fundamentals.

Chapter 15. External Filters, Programs and Commands

231

Advanced BashScripting Guide

# 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 nontrivial exercise. # Also, the above code deletes noncomment lines with a "*/" . . . #+ not a desirable result. exit 0

# # Code below this line will not execute because of 'exit 0' above. # Stephane Chazelas suggests the following alternative: usage() { echo "Usage: `basename $0` Cprogramfile" >&2 exit 1 } WEIRD=`echo n e '\377'` # or WEIRD=$'\377' [[ $# eq 1 ]] || usage case `file "$1"` in *"C program text"*) sed e "s%/\*%${WEIRD}%g;s%\*/%${WEIRD}%g" "$1" \ | tr '\377\n' '\n\377' \ | sed ne 'p;n' \ | tr d '\n' | tr '\377' '\n';; *) usage;; esac # # # # # # #+ #+ This is still fooled by things like: printf("/*"); or /* /* buggy embedded comment */ To handle all special cases (comments in strings, comments in string where there is a \", \\" ...), the only way is to write a C parser (using lex or yacc perhaps?).

exit 0

which which command gives the full path to "command." This is useful for finding out whether a particular command or utility is installed on the system. $bash which rm
/usr/bin/rm

For an interesting use of this command, see Example 3314. whereis Similar to which, above, whereis command gives the full path to "command," but also to its manpage. $bash whereis rm
rm: /bin/rm /usr/share/man/man1/rm.1.bz2

whatis Chapter 15. External Filters, Programs and Commands 232

Advanced BashScripting Guide whatis command looks up "command" in the whatis database. This is useful for identifying system commands and important configuration files. Consider it a simplified man command. $bash whatis whatis
whatis (1) search the whatis database for complete words

Example 1530. Exploring /usr/X11R6/bin

#!/bin/bash # What are all those mysterious binaries in /usr/X11R6/bin? DIRECTORY="/usr/X11R6/bin" # Try also "/bin", "/usr/bin", "/usr/local/bin", etc. for file in $DIRECTORY/* do whatis `basename $file` done 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

# Echoes info about the binary.

See also Example 103. vdir Show a detailed directory listing. The effect is similar to ls lb. This is one of the GNU fileutils.
bash$ vdir total 10 rwrr rwrr rwrr bash ls l total 10 rwrr rwrr rwrr

1 bozo 1 bozo 1 bozo

bozo bozo bozo

4034 Jul 18 22:04 data1.xrolo 4602 May 25 13:58 data1.xrolo.bak 877 Dec 17 2000 employment.xrolo

1 bozo 1 bozo 1 bozo

bozo bozo bozo

4034 Jul 18 22:04 data1.xrolo 4602 May 25 13:58 data1.xrolo.bak 877 Dec 17 2000 employment.xrolo

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). $bash locate hickson
/usr/lib/xephem/catalogs/hickson.edb

readlink Disclose the file that a symbolic link points to.

Chapter 15. External Filters, Programs and Commands

233

Advanced BashScripting Guide

bash$ readlink /usr/bin/awk ../../bin/gawk

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 imagefile | 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 107 and Example 109.

Example 1531. An "improved" strings command

#!/bin/bash # wstrings.sh: "wordstrings" (enhanced "strings" command) # # This script filters the output of "strings" by checking it #+ against a standard word list file. # This effectively eliminates 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 if [ ! f "$1" ] # Check if file exists. then echo "File \"$1\" does not exist." exit $E_NOFILE fi # ===========================================================

MINSTRLEN=3 WORDFILE=/usr/share/dict/linux.words

# # # #+ #+

Minimum string length. Dictionary file. May specify a different word list file of onewordperline format.

wlist=`strings "$1" | tr AZ az | tr '[:space:]' Z | \ tr cs '[:alpha:]' Z | tr s '\173\377' Z | tr Z ' '` # Translate output of 'strings' command with multiple passes of 'tr'. # "tr AZ az" converts to lowercase. # "tr '[:space:]'" converts whitespace characters to Z's. # "tr cs '[:alpha:]' Z" converts nonalphabetic characters to Z's, #+ and squeezes multiple consecutive Z's. # "tr s '\173\377' Z" converts all characters past 'z' to Z's #+ and squeezes multiple consecutive Z's, #+ which gets rid of all the weird characters that the previous #+ translation failed to deal with.

Chapter 15. External Filters, Programs and Commands

234

Advanced BashScripting Guide

# Finally, "tr Z ' '" converts all those Z's to whitespace, #+ which will be seen as word separators in the loop below. # # #+ # **************************************************************** Note the technique of feeding the output of 'tr' back to itself, but with different arguments and/or options on each pass. ****************************************************************

for word in $wlist

# # # #

Important: $wlist must not be quoted here. "$wlist" does not work. Why not?

do strlen=${#word} if [ "$strlen" lt "$MINSTRLEN" ] then continue fi grep Fw $word "$WORDFILE" ^^^ # String length. # Skip over short strings.

# Match whole words only. # "Fixed strings" and #+ "whole words" options.

done

exit $?

Comparison diff, patch diff: flexible file comparison utility. It compares the target files linebyline 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 file1 file2 outputs the lines in the files that differ, with carets showing which file each particular line belongs to. The sidebyside option to diff outputs each compared file, line by line, in separate columns, with nonmatching lines marked. The c and u options likewise make the output of the command easier to interpret. There are available various fancy frontends for diff, such as sdiff, 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.

Chapter 15. External Filters, Programs and Commands

235

Advanced BashScripting Guide

patch p1 <patchfile # Takes all the changes listed in 'patchfile' # and applies them to the files referenced therein. # This upgrades to a newer version of the package.

Patching the 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).
bash$ diff r ~/notes1 ~/notes2 Only in /home/bozo/notes1: file02 Only in /home/bozo/notes1: file03 Only in /home/bozo/notes2: file04

Use zdiff to compare gzipped files.

Use diffstat to create a histogram (pointdistribution graph) of output from diff. diff3 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.
bash$ diff3 file1 file2 file3 ==== 1:1c This is line 1 of "file1". 2:1c This is line 1 of "file2". 3:1c This is line 1 of "file3"

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. Example 1532. Using cmp to compare two files within a script.
#!/bin/bash

Chapter 15. External Filters, Programs and Commands

236

Advanced BashScripting Guide

ARGS=2 # Two args to script expected. E_BADARGS=65 E_UNREADABLE=66 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. # cmp s $1 $2 has same result ("s" silent flag to "cmp") # Thank you Anders Gustavsson for pointing this out. # # Also works with 'diff', i.e., diff $1 $2 &> /dev/null if [ $? eq 0 ] # Test exit status of "cmp" command. then echo "File \"$1\" is identical to file \"$2\"." else echo "File \"$1\" differs from file \"$2\"." fi exit 0

Use zcmp on gzipped files. comm Versatile file comparison utility. The files must be sorted for this to be useful. comm options firstfile secondfile comm file1 file2 outputs three columns: column 1 = lines unique to file1 column 2 = lines unique to file2 column 3 = lines common to both. The options allow suppressing output of one or more columns. 1 suppresses column 1 2 suppresses column 2 3 suppresses column 3 12 suppresses both columns 1 and 2, etc. This command is useful for comparing "dictionaries" or word lists sorted text files with one word per line. Utilities basename

Chapter 15. External Filters, Programs and Commands

237

Advanced BashScripting Guide 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:
echo "Usage: `basename $0` arg1 arg2 ... argn"

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 A7). Example 1533. basename and dirname
#!/bin/bash a=/home/bozo/dailyjournal.txt echo echo echo echo echo "Basename of /home/bozo/dailyjournal.txt = `basename $a`" "Dirname of /home/bozo/dailyjournal.txt = `dirname $a`" "My own home is `basename ~/`." "The home of my home is `dirname ~/`." # `basename ~` also works. # `dirname ~` also works.

exit 0

split, csplit These are utilities for splitting a file into smaller chunks. They are usually used for splitting up large files in order to back them up on floppies or preparatory to emailing or uploading them. The csplit command splits a file according to context, the split occuring where patterns are matched. Encoding and Encryption sum, cksum, md5sum, sha1sum 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 md5sum (message digest 5 checksum) command, or better yet, the newer sha1sum (Secure Hash Algorithm).
bash$ cksum /boot/vmlinuz 1670054224 804083 /boot/vmlinuz bash$ echo n "Top Secret" | cksum 3391003827 10

bash$ md5sum /boot/vmlinuz 0f43eccea8f09e0a0b2b5cf1dcf333ba

/boot/vmlinuz

bash$ echo n "Top Secret" | md5sum 8babc97a6f62a4649716f4df8d61728f

Chapter 15. External Filters, Programs and Commands

238

Advanced BashScripting Guide The cksum command shows the size, in bytes, of its target, whether file or stdout. The md5sum and sha1sum commands display a dash when they receive their input from stdout. Example 1534. Checking file integrity
#!/bin/bash # fileintegrity.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 (database file).

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 # # while read record[n] do 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 [ "$n" gt 0 ] # Not directory name. then filename[n]=$( echo ${record[$n]} | awk '{ print $2 }' ) # md5sum writes records backwards, #+ checksum first, then filename. checksum[n]=$( md5sum "${filename[n]}" )

Chapter 15. External Filters, Programs and Commands

239

Advanced BashScripting Guide

if [ "${record[n]}" = "${checksum[n]}" ] then echo "${filename[n]} unchanged." elif [ "`basename ${filename[n]}`" != "$dbfile" ] # Skip over checksum database file, #+ as it will change with each invocation of script. # # This unfortunately means that when running #+ this script on $PWD, tampering with the #+ checksum database file will not be detected. # Exercise: Fix this. then echo "${filename[n]} : CHECKSUM ERROR!" # File has been changed since last checked. fi fi

let "n+=1" done <"$dbfile" }

# Read from checksum database file.

# =================================================== # # main () if [ z "$1" ] then directory="$PWD" else directory="$1" fi

# If not specified, #+ use current working directory.

clear # Clear screen. echo " Running file integrity check on $directory" echo # # if [ ! r "$dbfile" ] # Need to create database file? then echo "Setting up database file, \""$directory"/"$dbfile"\"."; echo set_up_database fi # # check_database echo # You may wish to redirect the stdout of this script to a file, #+ especially if the directory checked has many files in it. exit 0 # For a much more thorough file integrity check, #+ consider the "Tripwire" package, #+ http://sourceforge.net/projects/tripwire/. # Do the actual work.

Chapter 15. External Filters, Programs and Commands

240

Advanced BashScripting Guide Also see Example A19 and Example 3314 for creative uses of the md5sum command. There have been reports that the 128bit md5sum can be cracked, so the more secure 160bit sha1sum is a welcome new addition to the checksum toolkit. Some security consultants think that even sha1sum can be compromised. So, what's next a 512bit checksum utility?
bash$ md5sum testfile e181e2c8720c60522c4c4c981108e367

testfile

bash$ sha1sum testfile 5d7425a9c08a66c3177f1e31286fa40986ffc996

testfile

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 1555, but does it in a more thorough and elegant manner. This is one of the GNU fileutils. Advanced forensic technology may still be able to recover the contents of a file, even after application of shred. uuencode This utility encodes binary files (images, sound files, compressed files, etc.) into ASCII characters, making them suitable for transmission in the body of an email message or in a newsgroup posting. This is especially useful where MIME (multimedia) encoding is not available. uudecode This reverses the encoding, decoding uuencoded files back into the original binaries.

Example 1535. Uudecoding encoded files

#!/bin/bash # Uudecodes all uuencoded files in current working directory. lines=35 # Allow 35 lines for the header (very generous).

for File in * # Test all the files in $PWD. do search1=`head n $lines $File | grep begin | wc w` search2=`tail n $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 # Note that running this script upon itself fools it

Chapter 15. External Filters, Programs and Commands

241

Advanced BashScripting Guide

#+ into thinking it is a uuencoded file, #+ because it contains both "begin" and "end". # # # #+ Exercise: Modify this script to check each file for a newsgroup header, and skip to next if not found.

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 multimediaencoded email 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 batch processing mode by means of a shell script. crypt At one time, this was the standard UNIX file encryption utility. [50] 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 A4). Miscellaneous mktemp Create a temporary file [51] with a "unique" filename. When invoked from the command line without additional arguments, it creates a zerolength file in the /tmp directory.
bash$ mktemp /tmp/tmp.zzsvql3154

PREFIX=filename tempfile=`mktemp $PREFIX.XXXXXX` # ^^^^^^ Need at least 6 placeholders #+ in the filename template. # If no filename template supplied, #+ "tmp.XXXXXXXXXX" is the default. echo "tempfile name = $tempfile" # tempfile name = filename.QA2ZpY # or something similar... # #+ # # Creates a file of that name in the current working directory with 600 file permissions. A "umask 177" is therefore unnecessary, but it's good programming practice anyhow.

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. Chapter 15. External Filters, Programs and Commands 242

Advanced BashScripting Guide 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 install : section). It could likewise find use in installation scripts. dos2unix This utility, written by Benjamin Lin and collaborators, converts DOSformatted text files (lines terminated by CRLF) to UNIX format (lines terminated by LF only), and viceversa. ptx The ptx [targetfile] command outputs a permuted index (crossreference 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 stdout . . . or of a script. An interesting application of more is to "test drive" a command sequence, to forestall potentially unpleasant consequences.
ls /home/bozo | awk '{print "rm rf " $1}' | more # ^^^^ # Testing the effect of the following (disastrous) command line: # ls /home/bozo | awk '{print "rm rf " $1}' | sh # Hand off to the shell to execute . . . ^^

15.6. Communications Commands

Certain of the following commands find use in chasing spammers, as well as in network data transfer and analysis. Information and Statistics host Searches for information about an Internet host by name or IP address, using DNS.
bash$ host surfacemail.com surfacemail.com. has address 202.92.42.236

ipcalc Displays IP information for a host. With the h option, ipcalc does a reverse DNS lookup, finding the name of the host (server) from the IP address.
bash$ ipcalc h 202.92.42.236 HOSTNAME=surfacemail.com

nslookup Do an Internet "name server lookup" on a host by IP address. This is essentially equivalent to ipcalc h or dig x . The command may be run either interactively or noninteractively, i.e., from within a script. The nslookup command has allegedly been "deprecated," but it is still useful.

Chapter 15. External Filters, Programs and Commands

243

Advanced BashScripting Guide

bash$ nslookup sil 66.97.104.180 nslookup kuhleersparnis.ch Server: 135.116.137.2 Address: 135.116.137.2#53 Nonauthoritative answer: Name: kuhleersparnis.ch

dig Domain Information Groper. Similar to nslookup, dig does an Internet "name server lookup" on a host. May be run either interactively or noninteractively, i.e., from within a script. Some interesting options to dig are +time=N for setting a query timeout to N seconds, +nofail for continuing to query servers until a reply is received, and x for doing a reverse address lookup. Compare the output of dig x with ipcalc h and nslookup.
bash$ dig x 81.9.6.2 ;; Got answer: ;; >>HEADER<< opcode: QUERY, status: NXDOMAIN, id: 11649 ;; flags: qr rd ra; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 0 ;; QUESTION SECTION: ;2.6.9.81.inaddr.arpa. ;; AUTHORITY SECTION: 6.9.81.inaddr.arpa. 3600 2002031705 900 600 86400 3600 ;; ;; ;; ;;

IN

PTR

IN

SOA

ns.eltel.net. noc.eltel.net.

Query time: 537 msec SERVER: 135.116.137.2#53(135.116.137.2) WHEN: Wed Jun 26 08:35:24 2002 MSG SIZE rcvd: 91

Example 1536. Finding out where to report a spammer

#!/bin/bash # spamlookup.sh: Look up abuse contact to report a spammer. # Thanks, Michael Zick. # Check for commandline arg. ARGCOUNT=1 E_WRONGARGS=65 if [ $# ne "$ARGCOUNT" ] then echo "Usage: `basename $0` domainname" exit $E_WRONGARGS fi

dig +short $1.contacts.abuse.net c in t txt # Also try: # dig +nssearch $1 # Tries to find "authoritative name servers" and display SOA records. # The following also works: # whois h whois.abuse.net $1 # ^^ ^^^^^^^^^^^^^^^ Specify host.

Chapter 15. External Filters, Programs and Commands

244

Advanced BashScripting Guide

# # Can even lookup multiple spammers with this, i.e." whois h whois.abuse.net $spamdomain1 $spamdomain2 . . .

# # # #+ #+ #

Exercise: Expand the functionality of this script so that it automatically emails a notification to the responsible ISP's contact address(es). Hint: use the "mail" command.

exit $? # spamlookup.sh chinatietong.com # A known spam domain. # "[email protected]" # "[email protected]" # "[email protected]"

# For a more elaborate version of this script, #+ see the SpamViz home page, http://www.spamviz.net/index.html.

Example 1537. Analyzing a spam domain

#! /bin/bash # isspammer.sh: Identifying spam domains # $Id: isspammer, v 1.4 2004/09/01 19:37:52 mszick Exp $ # Above line is RCS ID info. # # This is a simplified version of the "is_spammer.bash #+ script in the Contributed Scripts appendix. # isspammer <domain.name> # Uses an external program: 'dig' # Tested with version: 9.2.4rc5 # Uses functions. # Uses IFS to parse strings by assignment into arrays. # And even does something useful: checks email blacklists. # Use the domain.name(s) from the text body: # http://www.good_stuff.spammer.biz/just_ignore_everything_else # ^^^^^^^^^^^ # Or the domain.name(s) from any email address: # [email protected] # # as the only argument to this script. #(PS: have your Inet connection running) # # So, to invoke this script in the above two instances: # isspammer.sh spammer.biz

# Whitespace == :Space:Tab:Line Feed:Carriage Return: WSP_IFS=$'\x20'$'\x09'$'\x0A'$'\x0D' # No Whitespace == Line Feed:Carriage Return

Chapter 15. External Filters, Programs and Commands

245

Advanced BashScripting Guide

No_WSP=$'\x0A'$'\x0D' # Field separator for dotted decimal ip addresses ADR_IFS=${No_WSP}'.' # Get the dns text resource record. # get_txt <error_code> <list_query> get_txt() { # Parse $1 by assignment at the dots. local a dns IFS=$ADR_IFS dns=( $1 ) IFS=$WSP_IFS if [ "${dns[0]}" == '127' ] then # See if there is a reason. echo $(dig +short $2 t txt) fi } # Get the # chk_adr chk_adr() local local local dns address resource record. <rev_dns> <list_server> { reply server reason

server=${1}${2} reply=$( dig +short ${server} ) # If reply might be an error code . . . if [ ${#reply} gt 6 ] then reason=$(get_txt ${reply} ${server} ) reason=${reason:${reply}} fi echo ${reason:' not blacklisted.'} } # Need to get the IP address from the name. echo 'Get address of: '$1 ip_adr=$(dig +short $1) dns_reply=${ip_adr:' no answer '} echo ' Found address: '${dns_reply} # A valid reply is at least 4 digits plus 3 dots. if [ ${#ip_adr} gt 6 ] then echo declare query # Parse by assignment at the dots. declare a dns IFS=$ADR_IFS dns=( ${ip_adr} ) IFS=$WSP_IFS # Reorder octets into dns query order. rev_dns="${dns[3]}"'.'"${dns[2]}"'.'"${dns[1]}"'.'"${dns[0]}"'.' # See: http://www.spamhaus.org (Conservative, well maintained)

Chapter 15. External Filters, Programs and Commands

246

Advanced BashScripting Guide

echo n 'spamhaus.org says: ' echo $(chk_adr ${rev_dns} 'sblxbl.spamhaus.org') # See: http://ordb.org (Open mail relays) echo n ' ordb.org says: ' echo $(chk_adr ${rev_dns} 'relays.ordb.org') # See: http://www.spamcop.net/ (You can report spammers here) echo n ' spamcop.net says: ' echo $(chk_adr ${rev_dns} 'bl.spamcop.net') # # # other blacklist operations # # # # See: http://cbl.abuseat.org. echo n ' abuseat.org says: ' echo $(chk_adr ${rev_dns} 'cbl.abuseat.org') # See: http://dsbl.org/usage (Various mail relays) echo echo 'Distributed Server Listings' echo n ' list.dsbl.org says: ' echo $(chk_adr ${rev_dns} 'list.dsbl.org') echo n ' multihop.dsbl.org says: ' echo $(chk_adr ${rev_dns} 'multihop.dsbl.org') echo n 'unconfirmed.dsbl.org says: ' echo $(chk_adr ${rev_dns} 'unconfirmed.dsbl.org') else echo echo 'Could not use that address.' fi exit 0 # Exercises: # # 1) Check arguments to script, # and exit with appropriate error message if necessary. # 2) Check if online at invocation of script, # and exit with appropriate error message if necessary. # 3) Substitute generic variables for "hardcoded" BHL domains. # 4) Set a timeout for the script using the "+time=" option to the 'dig' command.

For a much more elaborate version of the above script, see Example A28. 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.
bash$ traceroute 81.9.6.2 traceroute to 81.9.6.2 (81.9.6.2), 30 hops max, 38 byte packets 1 tc43.xjbnnbrb.com (136.30.178.8) 191.303 ms 179.400 ms 179.767 ms 2 or0.xjbnnbrb.com (136.30.178.1) 179.536 ms 179.534 ms 169.685 ms 3 192.168.11.101 (192.168.11.101) 189.471 ms 189.556 ms *

Chapter 15. External Filters, Programs and Commands

247

Advanced BashScripting Guide

...

ping Broadcast an "ICMP ECHO_REQUEST" packet to another machine, either on a local or remote network. This is a diagnostic tool for testing network connections, and it should be used with caution.
bash$ ping localhost PING localhost.localdomain (127.0.0.1) from 127.0.0.1 : 56(84) bytes of data. 64 bytes from localhost.localdomain (127.0.0.1): icmp_seq=0 ttl=255 time=709 usec 64 bytes from localhost.localdomain (127.0.0.1): icmp_seq=1 ttl=255 time=286 usec localhost.localdomain ping statistics 2 packets transmitted, 2 packets received, 0% packet loss roundtrip min/avg/max/mdev = 0.286/0.497/0.709/0.212 ms

A successful ping returns an exit status of 0. This can be tested for in a script.
HNAME=nastyspammer.com # HNAME=$HOST # Debug: test for localhost. count=2 # Send only two pings. if [[ `ping c $count "$HNAME"` ]] then echo ""$HNAME" still up and broadcasting spam your way." else echo ""$HNAME" seems to be down. Pity." fi

whois Perform a DNS (Domain Name System) lookup. The h option permits specifying which particular whois server to query. See Example 46 and Example 1536. finger Retrieve information about users on a network. Optionally, this command can display a user's ~/.plan, ~/.project, and ~/.forward files, if present.
bash$ finger Login Name bozo Bozo Bozeman bozo Bozo Bozeman bozo Bozo Bozeman

Tty tty1 ttyp0 ttyp1

Idle 8

Login Time Office Jun 25 16:59 Jun 25 16:59 Jun 25 17:07

Office Phone

bash$ finger bozo Login: bozo Directory: /home/bozo Office: 2355 Clown St., 5431234 On since Fri Aug 31 20:13 (MST) on On since Fri Aug 31 20:13 (MST) on On since Fri Aug 31 20:13 (MST) on On since Fri Aug 31 20:31 (MST) on No mail. No Plan.

Name: Bozo Bozeman Shell: /bin/bash tty1 pts/0 pts/1 pts/2 1 hour 38 minutes idle 12 seconds idle 1 hour 16 minutes idle

Out of security considerations, many networks disable finger and its associated daemon. [52] chfn Change information disclosed by the finger command. vrfy Chapter 15. External Filters, Programs and Commands 248

Advanced BashScripting Guide Verify an Internet email address. This command seems to be missing from newer Linux distros. Remote Host Access 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 faster 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 or from a remote host. An ftp session can be automated in a script (see Example 186, Example A4, and Example A13). uucp, uux, cu 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 email, 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. The advantage of uucp is that it is faulttolerant, so even if there is a service interruption the copy operation will resume where it left off when the connection is restored. uux: UNIX to UNIX execute. Execute a command on a remote system. This command is part of the uucp package. cu: Call Up a remote system and connect as a simple terminal. It is a sort of dumbeddown version of telnet. This command is part of the uucp package. telnet Utility and protocol for connecting to a remote host. The telnet protocol contains security holes and should therefore probably be avoided. wget The wget utility noninteractively retrieves or downloads files from a Web or ftp site. It works well in a script.
wget p http://www.xyz23.com/file01.html # The p or pagerequisite option causes wget to fetch all files #+ required to display the specified page. wget r ftp://ftp.xyz24.net/~bozo/project_files/ O $SAVEFILE # The r option recursively follows and retrieves all links #+ on the specified site.

Chapter 15. External Filters, Programs and Commands

249

Advanced BashScripting Guide Example 1538. Getting a stock quote

#!/bin/bash # quotefetch.sh: Download a stock quote.

E_NOPARAMS=66 if [ z "$1" ] # Must specify a stock (symbol) to fetch. then echo "Usage: `basename $0` stocksymbol" exit $E_NOPARAMS fi stock_symbol=$1 file_suffix=.html # Fetches an HTML file, so name it appropriately. URL='http://finance.yahoo.com/q?s=' # Yahoo finance board, with stock query suffix. # wget O ${stock_symbol}${file_suffix} "${URL}${stock_symbol}" #

# # # # # #

To look up stuff on http://search.yahoo.com: URL="http://search.yahoo.com/search?fr=ushnews&p=${query}" wget O "$savefilename" "${URL}" Saves a list of relevant URLs.

exit $? # Exercises: # # # 1) Add a test to ensure the user running the script is online. # (Hint: parse the output of 'ps ax' for "ppp" or "connect." # # 2) Modify this script to fetch the local weather report, #+ taking the user's zip code as an argument.

See also Example A30 and Example A31. lynx The lynx Web and file browser can be used inside a script (with the dump option) to retrieve a file from a Web or ftp site noninteractively.
lynx dump http://www.xyz23.com/file01.html >$SAVEFILE

With the traversal option, lynx starts at the HTTP URL specified as an argument, then "crawls" through all links located on that particular server. Used together with the crawl option, outputs page text to a log file. 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 Chapter 15. External Filters, Programs and Commands 250

Advanced BashScripting Guide Remote copy, copies files between two different networked machines. rsync Remote synchronize, updates (synchronizes) files between two different networked machines.
bash$ rsync a ~/sourcedir/*txt /node1/subdirectory/

Example 1539. Updating FC4

#!/bin/bash # fc4upd.sh # Script author: Frank Wang. # Slight stylistic modifications by ABS Guide author. # Used in ABS Guide with permission.

# # # #+

Download Fedora Core 4 update from mirror site using rsync. Should also work for newer Fedora Cores 5, 6, . . . Only download latest package if multiple versions exist, to save space.

URL=rsync://distro.ibiblio.org/fedoralinuxcore/updates/ # URL=rsync://ftp.kddilabs.jp/fedora/core/updates/ # URL=rsync://rsync.planetmirror.com/fedoralinuxcore/updates/ DEST=${1:/var/www/html/fedora/updates/} LOG=/tmp/repoupdate$(/bin/date +%Y%m%d).txt PID_FILE=/var/run/${0##*/}.pid E_RETURN=65 # Something unexpected happened.

# # # #

General rsync options r: recursive download t: reserve time v: verbose

OPTS="rtv deleteexcluded deleteafter partial" # rsync include pattern # Leading slash causes absolute path name match. INCLUDE=( "/4/i386/kdei18nChinese*" # ^ ^ # Quoting is necessary to prevent globbing. )

# rsync exclude pattern # Temporarily comment out unwanted pkgs using "#" . . . EXCLUDE=( /1 /2 /3 /testing /4/SRPMS /4/ppc /4/x86_64 /4/i386/debug

Chapter 15. External Filters, Programs and Commands

251

Advanced BashScripting Guide

"/4/i386/kdei18n*" "/4/i386/openoffice.orglangpack*" "/4/i386/*i586.rpm" "/4/i386/GFS*" "/4/i386/cman*" "/4/i386/dlm*" "/4/i386/gnbd*" "/4/i386/kernelsmp*" "/4/i386/kernelxen*" "/4/i386/xen*"

# # )

init () { # Let pipe command return possible rsync error, e.g., stalled network. set o pipefail # Newly introduced in Bash, version 3. TMP=${TMPDIR:/tmp}/${0##*/}.$$ trap "{ rm f $TMP 2>/dev/null }" EXIT } # Store refined download list.

# Clear temporary file on exit.

check_pid () { # Check if process exists. if [ s "$PID_FILE" ]; then echo "PID file exists. Checking ..." PID=$(/bin/egrep o "^[[:digit:]]+" $PID_FILE) if /bin/ps pid $PID &>/dev/null; then echo "Process $PID found. ${0##*/} seems to be running!" /usr/bin/logger t ${0##*/} \ "Process $PID found. ${0##*/} seems to be running!" exit $E_RETURN fi echo "Process $PID not found. Start new process . . ." fi }

# Set overall file update range starting from root or $URL, #+ according to above patterns. set_range () { include= exclude= for p in "${INCLUDE[@]}"; do include="$include include \"$p\"" done for p in "${EXCLUDE[@]}"; do exclude="$exclude exclude \"$p\"" done }

# Retrieve and refine rsync update list. get_list () { echo $$ > $PID_FILE || { echo "Can't write to pid file $PID_FILE" exit $E_RETURN }

Chapter 15. External Filters, Programs and Commands

252

Advanced BashScripting Guide

echo n "Retrieving and refining update list . . ." # Retrieve list 'eval' is needed to run rsync as a single command. # $3 and $4 is the date and time of file creation. # $5 is the full package name. previous= pre_file= pre_date=0 eval /bin/nice /usr/bin/rsync \ r $include $exclude $URL | \ egrep '^dr.x|^r' | \ awk '{print $3, $4, $5}' | \ sort k3 | \ { while read line; do # Get seconds since epoch, to filter out obsolete pkgs. cur_date=$(date d "$(echo $line | awk '{print $1, $2}')" +%s) # echo $cur_date # Get file name. cur_file=$(echo $line | awk '{print $3}') # echo $cur_file # Get rpm pkg name from file name, if possible. if [[ $cur_file == *rpm ]]; then pkg_name=$(echo $cur_file | sed r e \ 's/(^([^_]+[_])+)[[:digit:]]+\..*[_].*$/\1/') else pkg_name= fi # echo $pkg_name if [ z "$pkg_name" ]; then # If not a rpm file, echo $cur_file >> $TMP #+ then append to download list. elif [ "$pkg_name" != "$previous" ]; then # A new pkg found. echo $pre_file >> $TMP # Output latest file. previous=$pkg_name # Save current. pre_date=$cur_date pre_file=$cur_file elif [ "$cur_date" gt "$pre_date" ]; then # If same pkg, but newer, pre_date=$cur_date #+ then update latest pointer. pre_file=$cur_file fi done echo $pre_file >> $TMP # TMP contains ALL #+ of refined list now. # echo "subshell=$BASH_SUBSHELL" } # Bracket required here to let final "echo $pre_file >> $TMP" # Remained in the same subshell ( 1 ) with the entire loop. # Get return code of the pipe command.

RET=$?

[ "$RET" ne 0 ] && { echo "List retrieving failed with code $RET" exit $E_RETURN } echo "done"; echo } # Real rsync download part.

Chapter 15. External Filters, Programs and Commands

253

Advanced BashScripting Guide

get_file () { echo "Downloading..." /bin/nice /usr/bin/rsync \ $OPTS \ filter "merge,+/ $TMP" \ exclude '*' \ $URL $DEST \ | /usr/bin/tee $LOG RET=$? # # # #+ filter merge,+/ is crucial for the intention. + modifier means include and / means absolute path. Then sorted list in $TMP will contain ascending dir name and prevent the following exclude '*' from "shortcutting the circuit."

echo "Done" rm f $PID_FILE 2>/dev/null return $RET } # # Main init check_pid set_range get_list get_file RET=$? # if [ "$RET" eq 0 ]; then /usr/bin/logger t ${0##*/} "Fedora update mirrored successfully." else /usr/bin/logger t ${0##*/} \ "Fedora update mirrored with failure code: $RET" fi exit $RET

See also Example A32. Using rcp, rsync, and similar utilities with security implications in a shell script may not be advisable. Consider, instead, using ssh, scp, 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.

Example 1540. Using ssh

#!/bin/bash # remote.bash: Using ssh. # This example by Michael Zick. # Used with permission.

Chapter 15. External Filters, Programs and Commands

254

Advanced BashScripting Guide

# # # # # # # #+ # # # # # # # # Presumptions: fd2 isn't being captured ( '2>/dev/null' ). ssh/sshd presumes stderr ('2') will display to user. sshd is running on your machine. For any 'standard' distribution, it probably is, and without any funky sshkeygen having been done. Try ssh to your machine from the command line: $ ssh $HOSTNAME Without extra setup you'll be asked for your password. enter password when done, $ exit Did that work? If so, you're ready for more fun.

# Try ssh to your machine as 'root': # # $ ssh l root $HOSTNAME # When asked for password, enter root's, not yours. # Last login: Tue Aug 10 20:25:49 2004 from localhost.localdomain # Enter 'exit' when done. # # #+ # #+ The above gives you an interactive shell. It is possible for sshd to be set up in a 'single command' mode, but that is beyond the scope of this example. The only thing to note is that the following will work in 'single command' mode.

# A basic, write stdout (local) command. ls l # Now the same basic command on a remote machine. # Pass a different 'USERNAME' 'HOSTNAME' if desired: USER=${USERNAME:$(whoami)} HOST=${HOSTNAME:$(hostname)} # Now excute the above command line on the remote host, #+ with all transmissions encrypted. ssh l ${USER} ${HOST} " ls l " # #+ # #+ The expected result is a listing of your username's home directory on the remote machine. To see any difference, run this script from somewhere other than your home directory.

# In other words, the Bash command is passed as a quoted line #+ to the remote shell, which executes it on the remote machine. # In this case, sshd does ' bash c "ls l" ' on your behalf. # For information on topics such as not having to enter a #+ password/passphrase for every command line, see #+ man ssh #+ man sshkeygen #+ man sshd_config.

Chapter 15. External Filters, Programs and Commands

255

Advanced BashScripting Guide

exit 0

Within a loop, ssh may cause unexpected behavior. According to a Usenet post in the comp.unix shell archives, ssh inherits the loop's stdin. To remedy this, pass ssh either the n or f option. Thanks, Jason Bechtel, for pointing this out. scp Secure copy, similar in function to rcp, copies files between two different networked machines, but does so using authentication, and with a security level similar to ssh. Local Network write This is a utility for terminaltoterminal 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 Since write is interactive, it would not normally find use in a script. netconfig A commandline utility for configuring a network adapter (using DHCP). This command is native to Red Hat centric Linux distros. Mail mail Send or read email messages. This strippeddown commandline mail client works fine as a command embedded in a script.

Example 1541. A script that mails itself

#!/bin/sh # selfmailer.sh: Selfmailing script adr=${1:`whoami`} # Default to current user, if not specified. # Typing 'selfmailer.sh [email protected]' #+ sends this script to that addressee. # Just 'selfmailer.sh' (no argument) sends the script #+ to the person invoking it, for example, [email protected]. # # For more on the ${parameter:default} construct, #+ see the "Parameter Substitution" section #+ of the "Variables Revisited" chapter. # ============================================================================ cat $0 | mail s "Script \"`basename $0`\" has mailed itself to you." "$adr" # ============================================================================ # # Greetings from the selfmailing script. # A mischievous person has run this script, #+ which has caused it to mail itself to you.

Chapter 15. External Filters, Programs and Commands

256

Advanced BashScripting Guide

# Apparently, some people have nothing better #+ to do with their time. # echo "At `date`, script \"`basename $0`\" mailed to "$adr"." exit 0

mailto Similar to the mail command, mailto sends email messages from the command line or in a script. However, mailto also permits sending MIME (multimedia) messages. vacation This utility automatically replies to emails that the intended recipient is on vacation and temporarily unavailable. It runs on a network, in conjunction with sendmail, and is not applicable to a dialup POPmail account.

15.7. Terminal Control Commands

Command affecting the console or terminal tput Initialize terminal and/or fetch information about it from terminfo data. Various options permit certain terminal operations. tput clear is the equivalent of clear, below. tput reset is the equivalent of reset, below. tput sgr0 also resets the terminal, but without clearing the screen.
bash$ tput longname xterm terminal emulator (XFree86 4.0 Window System)

Issuing a tput cup X Y moves the cursor to the (X,Y) coordinates in the current terminal. A clear to erase the terminal screen would normally precede this. Note that stty offers a more powerful command set for controlling a terminal. infocmp This command prints out extensive information about the current terminal. It references the terminfo database.
bash$ infocmp # Reconstructed via infocmp from file: /usr/share/terminfo/r/rxvt rxvt|rxvt terminal emulator (X Window System), am, bce, eo, km, mir, msgr, xenl, xon, colors#8, cols#80, it#8, lines#24, pairs#64, acsc=``aaffggjjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~, bel=^G, blink=\E[5m, bold=\E[1m, civis=\E[?25l, clear=\E[H\E[2J, cnorm=\E[?25h, cr=^M, ...

reset Reset terminal parameters and clear text screen. As with clear, the cursor and prompt reappear in the upper lefthand corner of the terminal. clear The clear command simply clears the text screen at the console or in an xterm. The prompt and cursor reappear at the upper lefthand corner of the screen or xterm window. This command may be used Chapter 15. External Filters, Programs and Commands 257

Advanced BashScripting Guide either at the command line or in a script. See Example 1025. script This utility records (saves to a file) all the user keystrokes at the command line in a console or an xterm window. This, in effect, creates a record of a session.

15.8. Math Commands

"Doing the numbers" factor Decompose an integer into prime factors.
bash$ factor 27417 27417: 3 13 19 37

bc Bash can't handle floating point calculations, and it lacks operators for certain important mathematical functions. Fortunately, bc comes to the rescue. Not just a versatile, arbitrary precision calculation utility, bc offers many of the facilities of a programming language. bc has a syntax vaguely resembling C. Since it is a fairly wellbehaved UNIX utility, and may therefore be used in a pipe, bc comes in handy in scripts. Here is a simple template for using bc to calculate a script variable. This uses command substitution.
variable=$(echo "OPTIONS; OPERATIONS" | bc)

Example 1542. Monthly Payment on a Mortgage

#!/bin/bash # monthlypmt.sh: Calculates monthly payment on a mortgage.

# #+ #+ #+ #+ #

This is a modification of code in the "mcalc" (mortgage calculator) package, by Jeff Schmidt and Mendel Cooper (yours truly, the author of the ABS Guide). http://www.ibiblio.org/pub/Linux/apps/financial/mcalc1.6.tar.gz

[15k]

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

Chapter 15. External Filters, Programs and Commands

258

Advanced BashScripting Guide

echo read echo read n "Enter interest rate (percent) " interest_r n "Enter term (months) " term # If 12%, enter "12", not ".12".

interest_r=$(echo "scale=9; $interest_r/100.0" | bc) # Convert to decimal. # ^^^^^^^^^^^^^^^^^ Divide by 100. # "scale" determines how many decimal places. interest_rate=$(echo "scale=9; $interest_r/12 + 1.0" | bc)

top=$(echo "scale=9; $principal*$interest_rate^$term" | bc) # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # Standard formula for figuring interest. echo; echo "Please be patient. This may take a while." let "months = $term 1" # ==================================================================== for ((x=$months; x > 0; x)) do bot=$(echo "scale=9; $interest_rate^$x" | bc) bottom=$(echo "scale=9; $bottom+$bot" | bc) # bottom = $(($bottom + $bot")) done # ==================================================================== # # Rick Boivie pointed out a more efficient implementation #+ of the above loop, which decreases computation time by 2/3. # for ((x=1; x <= $months; x++)) # do # bottom=$(echo "scale=9; $bottom * $interest_rate + 1" | bc) # done

# And then he came up with an even more efficient alternative, #+ one that cuts down the run time by about 95%! # bottom=`{ # echo "scale=9; bottom=$bottom; interest_rate=$interest_rate" # for ((x=1; x <= $months; x++)) # do # echo 'bottom = bottom * interest_rate + 1' # done # echo 'bottom' # } | bc` # Embeds a 'for loop' within command substitution. # # On the other hand, Frank Wang suggests: # bottom=$(echo "scale=9; ($interest_rate^$term1)/($interest_rate1)" | bc) # Because . . . # The algorithm behind the loop #+ is actually a sum of geometric proportion series. # The sum formula is e0(1q^n)/(1q), #+ where e0 is the first element and q=e(n+1)/e(n) #+ and n is the number of elements. #

Chapter 15. External Filters, Programs and Commands

259

Advanced BashScripting Guide

# let "payment = $top/$bottom" payment=$(echo "scale=2; $top/$bottom" | bc) # Use two decimal places for dollars and cents. echo echo "monthly payment = \$$payment" echo

# Echo a dollar sign in front of amount.

exit 0

# Exercises: # 1) Filter # 2) Filter # 3) If you #+ expand

input to permit commas in principal amount. input to permit interest to be entered as percent or decimal. are really ambitious, this script to print complete amortization tables.

Example 1543. Base Conversion

#!/bin/bash ########################################################################### # Shellscript: base.sh print number to different bases (Bourne Shell) # Author : Heiner Steven ([email protected]) # Date : 070395 # Category : Desktop # $Id: base.sh,v 1.2 2000/02/06 19:55:35 heiner Exp $ # ==> Above line is RCS ID info. ########################################################################### # Description # # Changes # 210395 stv fixed error occuring with 0xb as input (0.2) ########################################################################### # ==> Used in ABS Guide with the script author's permission. # ==> Comments added by ABS Guide author. NOARGS=65 PN=`basename "$0"` VER=`echo '$Revision: 1.2 $' | cut d' ' f2`

# Program name # ==> VER=1.2

Usage () { echo "$PN print number to different bases, $VER (stv '95) usage: $PN [number ...] If no number is given, the numbers are read from standard input. 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 }

Chapter 15. External Filters, Programs and Commands

260

Advanced BashScripting Guide

Fatal () { Msg "$@"; exit 66; } 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*|[af]*|[AF]*) ibase=16;; # hexadecimal 0*) ibase=8;; # octal [19]*) ibase=10;; # decimal *) Msg "illegal number $i ignored" continue;; esac # Remove prefix, convert hex digits to uppercase (bc needs this) number=`echo "$i" | sed e 's:^0[bBxX]::' | tr '[af]' '[AF]'` # ==> Uses ":" as sed separator, rather than "/". # Convert number to decimal dec=`echo "ibase=$ibase; $number" | bc` case "$dec" in [09]*) ;; *) continue;; esac

# ==> 'bc' is calculator utility. # number ok # error: ignore

# Print all conversions in one line. # ==> 'here document' feeds command list to 'bc'. echo `bc <<! obase=16; "hex="; $dec obase=10; "dec="; $dec obase=8; "oct="; $dec obase=2; "bin="; $dec ! ` | sed e 's: : done } while [ $# gt 0 ] # ==> Is a "while loop" really necessary here, # ==>+ since all the cases either break out of the loop # ==>+ or terminate the script. # ==> (Above comment by Paulo Marcel Coelho Aragao.) do case "$1" in ) shift; break;; h) Usage;; # ==> Help message. *) Usage;; *) break;; # first number esac # ==> More error checking for illegal input might be useful. shift done if [ $# gt 0 ] then PrintBases "$@" else while read line do :g'

# read from stdin

Chapter 15. External Filters, Programs and Commands

261

Advanced BashScripting Guide

PrintBases $line done fi

exit 0

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.
variable=`bc << LIMIT_STRING options statements operations LIMIT_STRING ` ...or...

variable=$(bc << LIMIT_STRING options statements operations LIMIT_STRING )

Example 1544. Invoking bc using a here document

#!/bin/bash # Invoking 'bc' using command substitution # in combination with a 'here document'.

var1=`bc << EOF 18.33 * 19.78 EOF ` echo $var1

# 362.56

# $( ... ) notation also works. v1=23.53 v2=17.881 v3=83.501 v4=171.63 var2=$(bc << EOF scale = 4 a = ( $v1 + $v2 ) b = ( $v3 * $v4 ) a * b + 15.35 EOF ) echo $var2 # 593487.8452

var3=$(bc l << EOF scale = 9 s ( 1.7 )

Chapter 15. External Filters, Programs and Commands

262

Advanced BashScripting Guide

EOF ) # Returns the sine of 1.7 radians. # The "l" option calls the 'bc' math library. echo $var3 # .991664810

# Now, try it in a function... hypotenuse () # Calculate hypotenuse of a right triangle. { # c = sqrt( a^2 + b^2 ) hyp=$(bc l << EOF scale = 9 sqrt ( $1 * $1 + $2 * $2 ) EOF ) # Can't directly return floating point values from a Bash function. # But, can echoandcapture: echo "$hyp" } hyp=$(hypotenuse 3.68 7.31) echo "hypotenuse = $hyp" # 8.184039344

exit 0

Example 1545. Calculating PI

#!/bin/bash # cannon.sh: Approximating PI by firing cannonballs. # This is a very simple instance of a "Monte Carlo" simulation: #+ a mathematical model of a reallife event, #+ using pseudorandom numbers to emulate random chance. # # #+ # # # # #+ # #+ # #+ # #+ # # #+ #+ # # #+ #+ # # # # Consider a perfectly square plot of land, 10000 units on a side. This land has a perfectly circular lake in its center, with a diameter of 10000 units. The plot is actually mostly water, except for land in the four corners. (Think of it as a square with an inscribed circle.) We will fire iron cannonballs from an oldstyle cannon at the square. All the shots impact somewhere on the square, either in the lake or on the dry corners. Since the lake takes up most of the area, most of the shots will SPLASH! into the water. Just a few shots will THUD! into solid ground in the four corners of the square. If we take enough random, unaimed shots at the square, Then the ratio of SPLASHES to total shots will approximate the value of PI/4. The reason for this is that the cannon is actually shooting only at the upper righthand quadrant of the square, i.e., Quadrant I of the Cartesian coordinate plane. (The previous explanation was a simplification.) Theoretically, the more shots taken, the better the fit. However, a shell script, as opposed to a compiled language

Chapter 15. External Filters, Programs and Commands

263

Advanced BashScripting Guide

#+ with floatingpoint math built in, requires a few compromises. # This tends to lower the accuracy of the simulation, of course.

DIMENSION=10000

# Length of each side of the plot. # Also sets ceiling for random integers generated. # Fire this many shots. # 10000 or more would be better, but would take too long. # Scaling factor to approximate PI.

MAXSHOTS=1000 PMULTIPLIER=4.0

get_random () { SEED=$(head n 1 /dev/urandom | od N 1 | awk '{ RANDOM=$SEED # #+ let "rnum = $RANDOM % $DIMENSION" # echo $rnum }

print $2 }') From "seedingrandom.sh" example script. Range less than 10000.

distance= # Declare global variable. hypotenuse () # Calculate hypotenuse of a right triangle. { # From "altbc.sh" example. distance=$(bc l << EOF scale = 0 sqrt ( $1 * $1 + $2 * $2 ) EOF ) # Setting "scale" to zero rounds down result to integer value, #+ a necessary compromise in this script. # This diminshes the accuracy of the simulation, unfortunately. }

# main() { # Initialize variables. shots=0 splashes=0 thuds=0 Pi=0 while [ "$shots" lt do "$MAXSHOTS" ] # Main loop.

xCoord=$(get_random) yCoord=$(get_random) hypotenuse $xCoord $yCoord ((shots++)) printf printf printf printf "#%4d " $shots "Xc = %4d " $xCoord "Yc = %4d " $yCoord "Distance = %5d " $distance

# Get random X and Y coords. # Hypotenuse of righttriangle = #+ distance.

# #+ # #+

Distance from center of lake the "origin" coordinate (0,0).

if [ "$distance" le "$DIMENSION" ] then echo n "SPLASH! "

Chapter 15. External Filters, Programs and Commands

264

Advanced BashScripting Guide

((splashes++)) else echo n "THUD! ((thuds++)) fi

"

Pi=$(echo "scale=9; $PMULTIPLIER*$splashes/$shots" | bc) # Multiply ratio by 4.0. echo n "PI ~ $Pi" echo done echo echo "After $shots shots, PI looks like approximately $Pi." # Tends to run a bit high . . . # Probably due to roundoff error and imperfect randomness of $RANDOM. echo # } exit 0 # #+ # # # # #+ One might well wonder whether a shell script is appropriate for an application as complex and computationintensive as a simulation. There 1) As 2) To it are at least two justifications. a proof of concept: to show it can be done. prototype and test the algorithms before rewriting in a compiled highlevel language.

dc The dc (desk calculator) utility is stackoriented and uses RPN ("Reverse Polish Notation"). Like bc, it has much of the power of a programming language. Most persons avoid dc, since it requires nonintuitive RPN input. Yet, it has its uses.

Example 1546. Converting a decimal number to hexadecimal

#!/bin/bash # hexconvert.sh: Convert a decimal number to hexadecimal. E_NOARGS=65 # Commandline arg missing. 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.

Chapter 15. External Filters, Programs and Commands

265

Advanced BashScripting Guide

fi echo ""$1" "$BASE" o p" | dc # "o" sets radix (numerical base) of output. # "p" prints the top of stack. # See 'man dc' for other options. return } hexcvt "$1" exit 0

Studying the info page for dc is a painful path to understanding its intricacies. There seems to be a small, select group of dc wizards who delight in showing off their mastery of this powerful, but arcane utility.
bash$ echo "16i[q]sa[ln0=aln100%Pln100/snlbx]sbA0D68736142snlbxq" | dc" Bash

Example 1547. Factoring

#!/bin/bash # factr.sh: Factor a number MIN=2 # Will not work for number smaller than this. E_NOARGS=65 E_TOOSMALL=66 if [ z $1 ] then echo "Usage: $0 number" exit $E_NOARGS fi if [ "$1" lt "$MIN" ] then echo "Number to factor must be $MIN or greater." exit $E_TOOSMALL fi # Exercise: Add type checking (to reject noninteger arg). echo "Factors of $1:" # echo "$1[p]s2[lip/dli%0=1dvsr]s12sid2%0=13sidvsr[dli%0=1lrli2+dsi!>.]ds.xd1<2"|dc # # Above line of code written by Michel Charpentier <[email protected]>. # Used in ABS Guide with permission (thanks!). exit 0

awk Yet another way of doing floating point math in a script is using awk's builtin math functions in a shell wrapper.

Example 1548. Calculating the hypotenuse of a triangle

Chapter 15. External Filters, Programs and Commands

266

Advanced BashScripting Guide

#!/bin/bash # hypotenuse.sh: Returns the "hypotenuse" of a right triangle. # (square root of sum of squares of the "legs") ARGS=2 E_BADARGS=65 # Script needs sides of triangle passed. # Wrong number of arguments.

if [ $# ne "$ARGS" ] # Test number of arguments to script. then echo "Usage: `basename $0` side_1 side_2" exit $E_BADARGS fi

AWKSCRIPT=' { printf( "%3.7f\n", sqrt($1*$1 + $2*$2) ) } ' # command(s) / parameters passed to awk

# Now, pipe the parameters to awk. echo n "Hypotenuse of $1 and $2 = " echo $1 $2 | awk "$AWKSCRIPT" # ^^^^^^^^^^^^ # An echoandpipe is an easy way of passing shell parameters to awk. exit 0 # Exercise: Rewrite this script using 'bc' rather than awk. # Which method is more intuitive?

15.9. Miscellaneous Commands

Command that fit in no special category jot, seq These utilities emit a sequence of integers, with a userselected increment. The default 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

Both jot and seq come in handy in a for loop.

Example 1549. Using seq to generate loop arguments

#!/bin/bash

Chapter 15. External Filters, Programs and Commands

267

Advanced BashScripting Guide

# Using "seq" echo for a in `seq 80` # or for a in $( seq 80 ) # Same as for a in 1 2 3 4 5 ... 80 (saves much typing!). # May also use 'jot' (if present on system). do echo n "$a " done # 1 2 3 4 5 ... 80 # Example of using the output of a command to generate # the [list] in a "for" loop. echo; echo

COUNT=80

# Yes, 'seq' also accepts a replaceable parameter. for a in $( seq $COUNT )

for a in `seq $COUNT` # or do echo n "$a " done # 1 2 3 4 5 ... 80 echo; echo BEGIN=75 END=80

for a in `seq $BEGIN $END` # Giving "seq" two arguments starts the count at the first one, #+ and continues until it reaches the second. do echo n "$a " done # 75 76 77 78 79 80 echo; echo BEGIN=45 INTERVAL=5 END=80 for a in `seq $BEGIN $INTERVAL $END` # Giving "seq" three arguments starts the count at the first one, #+ uses the second for a step interval, #+ and continues until it reaches the third. do echo n "$a " done # 45 50 55 60 65 70 75 80 echo; echo exit 0

A simpler example:
# Create a set of 10 files, #+ named file.1, file.2 . . . file.10. COUNT=10 PREFIX=file for filename in `seq $COUNT` do

Chapter 15. External Filters, Programs and Commands

268

Advanced BashScripting Guide

touch $PREFIX.$filename # Or, can do other operations, #+ such as rm, grep, etc. done

Example 1550. Letter Count"

#!/bin/bash # lettercount.sh: Counting letter occurrences in a text file. # Written by Stefano Palmeri. # Used in ABS Guide with permission. # Slightly modified by document author. MINARGS=2 E_BADARGS=65 FILE=$1 let LETTERS=$#1 # Script requires at least two arguments.

# How many letters specified (as commandline args). # (Subtract 1 from number of command line args.)

show_help(){ echo echo Usage: `basename $0` file letters echo Note: `basename $0` arguments are case sensitive. echo Example: `basename $0` foobar.txt G n U L i N U x. echo } # Checks number of arguments. if [ $# lt $MINARGS ]; then echo echo "Not enough arguments." echo show_help exit $E_BADARGS fi

# Checks if file exists. if [ ! f $FILE ]; then echo "File \"$FILE\" does not exist." exit $E_BADARGS fi

# Counts letter occurrences . for n in `seq $LETTERS`; do shift if [[ `echo n "$1" | wc c` eq 1 ]]; then # echo "$1" \> `cat $FILE | tr cd "$1" | wc c` # else echo "$1 is not a single char." fi done exit $?

Checks arg. Counting.

# This script has exactly the same functionality as lettercount2.sh, #+ but executes faster.

Chapter 15. External Filters, Programs and Commands

269

Advanced BashScripting Guide

# Why?

getopt The getopt command parses commandline options preceded by a dash. This external command corresponds to the getopts Bash builtin. Using getopt permits handling long options by means of the l flag, and this also allows parameter reshuffling.

Example 1551. Using getopt to parse commandline options

#!/bin/bash # Using getopt # Try the following when invoking this script: # sh ex33a.sh a # sh ex33a.sh abc # sh ex33a.sh a b c # sh ex33a.sh d # sh ex33a.sh dXYZ # sh ex33a.sh d XYZ # sh ex33a.sh abcd # sh ex33a.sh abcdZ # sh ex33a.sh z # sh ex33a.sh a # Explain the results of each of the above. E_OPTERR=65 if [ "$#" eq 0 ] then # Script needs at least one commandline argument. echo "Usage $0 [options a,b,c]" exit $E_OPTERR fi set `getopt "abcd:" "$@"` # Sets positional parameters to commandline arguments. # What happens if you use "$*" instead of "$@"? while [ ! z "$1" ] do case "$1" in a) echo "Option b) echo "Option c) echo "Option d) echo "Option *) break;; esac shift done # # It is usually better to use the 'getopts' builtin in a script. See "ex33.sh."

\"a\"";; \"b\"";; \"c\"";; \"d\" $2";;

exit 0

See Example 913 for a simplified emulation of getopt. runparts The runparts command [53] executes all the scripts in a target directory, sequentially in ASCIIsorted filename order. Of course, the scripts need to have execute permission.

Chapter 15. External Filters, Programs and Commands

270

Advanced BashScripting Guide The cron daemon invokes runparts 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 controlc 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. yes | fsck /dev/hda1 runs fsck noninteractively (careful!). yes | rm r dirname has same effect as rm rf dirname (careful!). Caution advised when piping yes to a potentially dangerous system command, such as fsck or fdisk. It may have unintended sideeffects. The yes command parses variables. For example:
bash$ yes $BASH_VERSION 3.00.16(1)release 3.00.16(1)release 3.00.16(1)release 3.00.16(1)release 3.00.16(1)release . . .

This "feature" may not be particularly useful. 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 Show all the environmental variables set for a particular user.
bash$ printenv | grep HOME HOME=/home/bozo

lp The lp and lpr commands send file(s) to the print queue, to be printed as hard copy. [54] These commands trace the origin of their names to the line printers of another era. bash$ lp file1.txt or bash lp <file1.txt It is often useful to pipe the formatted output from pr to lp. bash$ pr options file1.txt | lp Formatting packages, such as groff and Ghostscript may send their output directly to lp. bash$ groff Tascii file.tr | lp bash$ gs options | lp file.ps Chapter 15. External Filters, Programs and Commands 271

Advanced BashScripting Guide Related commands are lpq, for viewing the print queue, and lprm, for removing jobs from the print queue. tee [UNIX borrows an idea from the plumbing trade.] This is a redirection operator, but with a difference. Like the plumber's tee, it permits "siponing off" to a file 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.
(redirection) |> to file | ==========================|==================== command > command > |tee > command > > output of pipe ===============================================

cat listfile* | sort | tee check.file | uniq > result.file

(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 firstinfirstout buffer for transferring data between processes. [55] Typically, one process writes to the FIFO, and the other reads from it. See Example A15.
#!/bin/bash # This short script by Omair Eshkenazi. # Used in ABS Guide with permission (thanks!). mkfifo pipe1 mkfifo pipe2 (cut d' ' f1 | tr "az" "AZ") >pipe2 <pipe1 & ls l | tr s ' ' | cut d' ' f3,9 | tee pipe1 | cut d' ' f2 | paste pipe2 rm f pipe1 rm f pipe2 # No need to kill background processes when script terminates (why not?). exit $? Now, invoke the script and explain the output: sh mkfifoexample.sh 4830.tar.gz pipe1 BOZO pipe2 BOZO mkfifoexample.sh Mixed.msg BOZO BOZO

BOZO

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. Chapter 15. External Filters, Programs and Commands 272

Advanced BashScripting Guide Unfortunately, pathchk does not return a recognizable error code, and it is therefore pretty much useless in a script. Consider instead the file test operators. 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, [56] upper/lower case, swapping of byte pairs between input and output, and skipping and/or truncating the head or tail of the input file.
# Converting a file to all uppercase: dd if=$filename conv=ucase > $filename.uppercase # lcase # For lower case conversion

Some basic options to dd are: if=INFILE INFILE is the source file. of=OUTFILE OUTFILE is the target file, the file that will have the data written to it. bs=BLOCKSIZE This is the size of each block of data being read and written, usually a power of 2. skip=BLOCKS How many blocks of data to skip in INFILE before starting to copy. This is useful when the INFILE has "garbage" or garbled data in its header or when it is desirable to copy only a portion of the INFILE. seek=BLOCKS How many blocks of data to skip in OUTFILE before starting to copy, leaving blank data at beginning of OUTFILE. count=BLOCKS Copy only this many blocks of data, rather than the entire INFILE. conv=CONVERSION Type of conversion to be applied to INFILE data before copying operation. A dd help lists all the options this powerful utility takes.

Example 1552. A script that copies itself

#!/bin/bash # selfcopy.sh # This script copies itself. file_subscript=copy dd if=$0 of=$0.$file_subscript 2>/dev/null # Suppress messages from dd: ^^^^^^^^^^^

Chapter 15. External Filters, Programs and Commands

273

Advanced BashScripting Guide

exit $?

Example 1553. Exercising dd

#!/bin/bash # exercisingdd.sh # Script by Stephane Chazelas. # Somewhat modified by ABS Guide author. infile=$0 # This script. outfile=log.txt # This output file left behind. n=3 p=5 dd if=$infile of=$outfile bs=1 skip=$((n1)) count=$((pn+1)) 2> /dev/null # Extracts characters n to p (3 to 5) from this script. # echo n "hello world" | dd cbs=1 conv=unblock 2> /dev/null # Echoes "hello world" vertically. # Why? Newline after each character dd emits. exit 0

To demonstrate just how versatile dd is, let's use it to capture keystrokes.

Example 1554. Capturing Keystrokes

#!/bin/bash # ddkeypress.sh: Capture keystrokes without needing to press ENTER.

keypresses=4

# Number of keypresses to capture.

old_tty_setting=$(stty g) echo "Press $keypresses keys." stty icanon echo

# Save old terminal settings.

# Disable canonical mode. # Disable local echo. keys=$(dd bs=1 count=$keypresses 2> /dev/null) # 'dd' uses stdin, if "if" (input file) not specified. stty "$old_tty_setting" # Restore old terminal settings.

echo "You pressed the \"$keys\" keys." # Thanks, Stephane Chazelas, for showing the way. exit 0

The dd command can do random access on a data stream.

echo n . | dd bs=1 seek=4 of=file conv=notrunc # The "conv=notrunc" option means that the output file #+ will not be truncated. # Thanks, S.C.

Chapter 15. External Filters, Programs and Commands

274

Advanced BashScripting Guide The dd command can copy raw data and disk images to and from devices, such as floppies and tape drives (Example A5). A common use is creating boot floppies. dd if=kernelimage 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 282) and ramdisks (Example 283). It can even do a lowlevel 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.

Example 1555. Securely deleting a file

#!/bin/bash # blotout.sh: Erase "all" traces of a file. # #+ # #+ This script overwrites a target file alternately with random bytes, then zeros before finally deleting it. After that, even examining the raw disk sectors by conventional methods will not reveal the original file data. # # #+ # #+ # Number of fileshredding passes. Increasing this slows script execution, especially on large target files. I/O with /dev/urandom requires unit block size, otherwise you get weird results. Various error exit codes.

PASSES=7

BLOCKSIZE=1 E_BADARGS=70 E_NOT_FOUND=71 E_CHANGED_MIND=72

if [ z "$1" ] # No filename specified. then echo "Usage: `basename $0` filename" exit $E_BADARGS fi 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\".";;

Chapter 15. External Filters, Programs and Commands

275

Advanced BashScripting Guide

esac

flength=$(ls l "$file" | awk '{print $5}') pass_count=1 chmod u+w "$file" echo

# Field 5 is file length.

# Allow overwriting/deleting the file.

while [ "$pass_count" le "$PASSES" ] do echo "Pass #$pass_count" sync # Flush buffers. dd if=/dev/urandom of=$file bs=$BLOCKSIZE count=$flength # Fill with random bytes. sync # Flush buffers again. dd if=/dev/zero of=$file bs=$BLOCKSIZE count=$flength # Fill with zeros. sync # Flush buffers yet again. let "pass_count += 1" echo done

rm f $file sync

# Finally, delete scrambled and shredded file. # Flush buffers a final time.

echo "File \"$file\" blotted out and deleted."; echo

exit 0 # #+ # #+ # # #+ #+ # # This is a fairly secure, if inefficient and slow method of thoroughly "shredding" a file. The "shred" command, part of the GNU "fileutils" package, does the same thing, although more efficiently. The file cannot not be "undeleted" or retrieved by normal methods. However . . . this simple method would *not* likely withstand sophisticated forensic analysis. This script may not play well with a journaled file system. Exercise (difficult): Fix it so it does.

# Tom Vier's "wipe" filedeletion package does a much more thorough job #+ of file shredding than this simple script. # http://www.ibiblio.org/pub/Linux/utils/file/wipe2.0.0.tar.bz2 # For an indepth analysis on the topic of file deletion and security, #+ see Peter Gutmann's paper, #+ "Secure Deletion of Data From Magnetic and SolidState Memory". # http://www.cs.auckland.ac.nz/~pgut001/pubs/secure_del.html

See also the dd thread entry in the bibliography. od The od, or octal dump filter converts input (or files) to octal (base8) 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 929 and Example 1513. Chapter 15. External Filters, Programs and Commands 276

Advanced BashScripting Guide 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. May be used to view the contents of a binary file, in combination with dd and less.
dd if=/bin/ls | hexdump C | less # The C option nicely formats the output in tabular form.

objdump Displays information about an object file or binary executable in either hexadecimal form or as a disassembled listing (with the d option).
bash$ objdump d /bin/ls /bin/ls: file format elf32i386 Disassembly of section .init: 080490bc <.init>: 80490bc: 55 80490bd: 89 e5 . . .

push mov

%ebp %esp,%ebp

mcookie This command generates a "magic cookie," a 128bit (32character) 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.
random000=$(mcookie)

Of course, a script could use md5 for the same purpose.

# Generate md5 checksum on the script itself. random001=`md5sum $0 | awk '{print $1}'` # Uses 'awk' to strip off the filename.

The mcookie command gives yet another way to generate a "unique" filename.

Example 1556. Filename generator

#!/bin/bash # tempfilename.sh: BASE_STR=`mcookie` POS=11 LEN=5 prefix=temp

temp filename generator # 32character magic cookie. # Arbitrary position in magic cookie string. # Get $LEN consecutive characters. # # #+ #+ This is, after all, a "temp" file. For more "uniqueness," generate the filename prefix using the same method as the suffix, below.

suffix=${BASE_STR:POS:LEN} # Extract a 5character string, #+ starting at position 11. temp_filename=$prefix.$suffix # Construct the filename.

Chapter 15. External Filters, Programs and Commands

277

Advanced BashScripting Guide

echo "Temp filename = "$temp_filename"" # sh tempfilename.sh # Temp filename = temp.e19ea # Compare this method of generating "unique" filenames #+ with the 'date' method in ex51.sh. exit 0

units This utility converts between different units of measure. While normally invoked in interactive mode, units may find use in a script.

Example 1557. Converting meters to miles

#!/bin/bash # unitconversion.sh

convert_units () # Takes as arguments the units to convert. { cf=$(units "$1" "$2" | sed silent e '1p' | awk '{print $2}') # Strip off everything except the actual conversion factor. echo "$cf" } Unit1=miles Unit2=meters cfactor=`convert_units $Unit1 $Unit2` quantity=3.73 result=$(echo $quantity*$cfactor | bc) echo "There are $result $Unit2 in $quantity $Unit1." # What happens if you pass incompatible units, #+ such as "acres" and "miles" to the function? exit 0

m4 A hidden treasure, m4 is a powerful macro processing filter, [57] virtually a complete language. Although originally written as a preprocessor for RatFor, m4 turned out to be useful as a standalone 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.

Example 1558. Using m4

#!/bin/bash # m4.sh: Using the m4 macro processor # Strings string=abcdA01 echo "len($string)" | m4

Chapter 15. External Filters, Programs and Commands

278

Advanced BashScripting Guide

echo "substr($string,4)" | m4 echo "regexp($string,[01][01],\&Z)" | m4 # Arithmetic echo "incr(22)" | m4 echo "eval(99 / 3)" | m4 exit 0 # A01 # 01Z

# #

23 33

doexec The doexec command enables passing an arbitrary list of arguments to a binary executable. In particular, passing argv[0] (which corresponds to $0 in a script) lets the executable be invoked by various names, and it can then carry out different sets of actions, according to the name by which it was called. What this amounts to is roundabout way of passing options to an executable. For example, the /usr/local/bin directory might contain a binary called "aaa". Invoking doexec /usr/local/bin/aaa list would list all those files in the current working directory beginning with an "a", while invoking (the same executable with) doexec /usr/local/bin/aaa delete would delete those files. The various behaviors of the executable must be defined within the code of the executable itself, analogous to something like the following in a shell script:
case `basename $0` in "name1" ) do_something;; "name2" ) do_something_else;; "name3" ) do_yet_another_thing;; * ) bail_out;; esac

dialog The dialog family of tools provide a method of calling interactive "dialog" boxes from a script. The more elaborate variations of dialog gdialog, Xdialog, and kdialog actually invoke XWindows widgets. See Example 3319. sox The sox, or "sound exchange" command plays and performs transformations on sound files. In fact, the /usr/bin/play executable (now deprecated) is nothing but a shell wrapper for sox. For example, sox soundfile.wav soundfile.au changes a WAV sound file into a (Sun audio format) AU sound file. Shell scripts are ideally suited for batchprocessing sox operations on sound files. For examples, see the Linux Radio Timeshift HOWTO and the MP3do Project.

Chapter 15. External Filters, Programs and Commands

279

Chapter 16. System and Administrative Commands

The startup and shutdown scripts in /etc/rc.d illustrate the uses (and usefulness) of many of these comands. These are usually invoked by root and used for system maintenance or emergency filesystem repairs. Use with caution, as some of these commands may damage your system if misused. Users and Groups users Show all logged on users. This is the approximate equivalent of who q. 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 bash$ echo $GROUPS 501

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. [58]
root# chown bozo *.txt

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.
chgrp recursive dunderheads *.data # The "dunderheads" group will now own all the "*.data" files #+ all the way down the $PWD directory tree (that's what "recursive" means).

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 [59] and deletes associated files. The adduser command is a synonym for useradd and is usually a symbolic link to it. usermod Modify a user account. Changes may be made to the password, group membership, expiration date, and other attributes of a given user's account. With this command, a user's password may be locked, which has the effect of disabling the account. groupmod Modify a given group. The group name and/or ID number may be changed using this command. id The id command lists the real and effective user IDs and the group IDs of the user associated with the current process. 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)

Chapter 16. System and Administrative Commands

280

Advanced BashScripting Guide

bash$ echo $UID 501

The id command shows the effective IDs only when they differ from the real ones. Also see Example 95. who Show all users logged on to the system.
bash$ who bozo tty1 bozo pts/0 bozo pts/1 bozo pts/2

Apr 27 17:45 Apr 27 17:46 Apr 27 17:47 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

w 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.
bash$ w | grep startx bozo tty1

4:22pm

6:41

4.47s

0.45s

startx

logname Show current user's login name (as found in /var/run/utmp). This is a nearequivalent to whoami, above.
bash$ logname bozo bash$ whoami bozo

However . . .
bash$ su Password: ...... bash# whoami root bash# logname bozo

While logname prints the name of the logged in user, whoami gives the name of the user attached to the current process. As we have just seen, sometimes these are not the same. Chapter 16. System and Administrative Commands 281

Advanced BashScripting Guide 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 A15. 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. passwd Sets, changes, or manages a user's password. The passwd command can be used in a script, but probably should not be.

Example 161. Setting a new password

#!/bin/bash # setnewpassword.sh: For demonstration purposes only. # Not a good idea to actually run this script. # This script must be run as root. ROOT_UID=0 E_WRONG_USER=65 E_NOSUCHUSER=70 SUCCESS=0 # Root has $UID 0. # Not root?

if [ "$UID" ne "$ROOT_UID" ] then echo; echo "Only root can run this script."; echo exit $E_WRONG_USER else echo echo "You should know better than to run this script, root." echo "Even root users get the blues... " echo fi

username=bozo NEWPASSWORD=security_violation # Check if bozo lives here. grep q "$username" /etc/passwd if [ $? ne $SUCCESS ] then echo "User $username does not exist." echo "No password changed." exit $E_NOSUCHUSER fi echo "$NEWPASSWORD" | passwd stdin "$username"

Chapter 16. System and Administrative Commands

282

Advanced BashScripting Guide

# The 'stdin' option to 'passwd' permits #+ getting a new password from stdin (or a pipe). echo; echo "User $username's password changed!" # Using the 'passwd' command in a script is dangerous. exit 0

The passwd command's l, u, and d options permit locking, unlocking, and deleting a user's password. Only root may use these options. 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. For example, to show the last few times the system rebooted:
bash$ last reboot reboot system boot 2.6.91.667 reboot system boot 2.6.91.667 reboot system boot 2.6.91.667 reboot system boot 2.6.91.667 . . . wtmp begins Tue Feb 1 12:50:09 2005

Fri Feb 4 18:18 Fri Feb 4 15:20 Fri Feb 4 12:56 Thu Feb 3 21:08

(00:02) (01:27) (00:49) (02:17)

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.

Example 162. Setting an erase character

#!/bin/bash # erase.sh: Using "stty" to set an erase character when reading input. echo n "What is your name? " read name

Try to backspace

Chapter 16. System and Administrative Commands

283

Advanced BashScripting Guide

#+ to erase characters of input. # Problems? echo "Your name is $name." stty echo read echo erase '#' n "What is your name? " name "Your name is $name." # # Set "hashmark" (#) as erase character. Use # to erase last character typed.

exit 0 # Even after the script exits, the new key value remains set. # Exercise: How would you reset the erase character to the default value?

Example 163. secret password: Turning off terminal echoing

#!/bin/bash # secretpw.sh: secret password echo echo read echo echo echo

n "Enter password " passwd "password is $passwd" n "If someone had been looking over your shoulder, " "your password would have been compromised." # Two linefeeds in an "and list."

echo && echo

stty echo

# Turns off screen echo.

echo n "Enter password again " read passwd echo echo "password is $passwd" echo stty echo exit 0 # Do an 'info stty' for more on this usefulbuttricky command. # Restores screen echo.

A creative use of stty is detecting a user keypress (without hitting ENTER).

Example 164. Keypress detection

#!/bin/bash # keypress.sh: Detect a user keypress ("hot keys"). echo old_tty_settings=$(stty g) stty icanon Keypress=$(head c1) # Save old settings (why?). # or $(dd bs=1 count=1 2> /dev/null) # on nonGNU systems

echo echo "Key pressed was \""$Keypress"\"." echo

Chapter 16. System and Administrative Commands

284

Advanced BashScripting Guide

stty "$old_tty_settings" # Thanks, Stephane Chazelas. exit 0 # Restore old settings.

Also see Example 93.

terminals and modes 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.
bash$ cat > filexxx wha<ctlW>I<ctlH>foo bar<ctlU>hello world<ENTER> <ctlD> bash$ cat filexxx hello world bash$ wc c < filexxx 12

The process controlling the terminal receives only 12 characters (11 alphabetic ones, plus a newline), although the user hit 26 keys. In noncanonical ("raw") mode, every key hit (including special editing keys such as ctlH) 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 ctlA 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. Stphane Chazelas setterm Set certain terminal attributes. This command writes to its terminal's stdout a string that changes the behavior of that terminal.
bash$ setterm cursor off bash$

The setterm command can be used within a script to change the appearance of text written to stdout, although there are certainly better tools available for this purpose.

Chapter 16. System and Administrative Commands

285

Advanced BashScripting Guide

setterm bold on echo bold hello setterm bold off echo normal hello

tset Show or initialize terminal settings. This is a less capable version of stty.
bash$ tset r Terminal type is xtermxfree86. Kill is controlU (^U). Interrupt is controlC (^C).

setserial Set or display serial port parameters. This command must be run by root and is usually found in a system setup script.
# From /etc/pcmcia/serial script: IRQ=`setserial /dev/$DEVICE | sed e 's/.*IRQ: //'` setserial /dev/$DEVICE irq 0 ; setserial /dev/$DEVICE irq $IRQ

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 quite annoying to have a message about ordering pizza suddenly appear in the middle of the text file you are editing. On a multiuser 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 181).
bash$ wall System going down for maintenance in 5 minutes! Broadcast message from bozo (pts/1) Sun Jul 8 13:53:27 2001... System going down for maintenance in 5 minutes!

If write access to a particular terminal has been disabled with mesg, then wall cannot send a message to that terminal. Information and Statistics uname Output system specifications (OS, kernel version, etc.) to stdout. Invoked with the a option, gives verbose system info (see Example 155). The s option shows only the OS type.
bash$ uname

Chapter 16. System and Administrative Commands

286

Advanced BashScripting Guide

Linux bash$ uname s Linux

bash$ uname a Linux iron.bozo 2.6.151.2054_FC5 #1 Tue Mar 14 15:48:33 EST 2006 i686 i686 i386 GNU/Linux

arch Show system architecture. Equivalent to uname m. See Example 1026.

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 bin daemon ... bozo tty1

Fri Dec 7 18:43:21 0700 2001 **Never logged in** **Never logged in** Sat Dec 8 21:14:29 0700 2001

bash$ lastlog | grep root root tty1

Fri Dec

7 18:43:21 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 init 1 init 1 init 1 cardmgr 213 ...

USER root root root root

FD mem mem mem mem

TYPE REG REG REG REG

DEVICE 3,5 3,5 3,5 3,5

SIZE 30748 73120 931668 36956

NODE NAME 30303 /sbin/init 8069 /lib/ld2.1.3.so 8075 /lib/libc2.1.3.so 30357 /sbin/cardmgr

The lsof command is a useful, if complex administrative tool. If you are unable to dismount a filesystem and get an error message that it is still in use, then running lsof helps determine which files are still open on that filesystem. The i option lists open network socket files, and this can help trace intrusion or hack attempts. Chapter 16. System and Administrative Commands 287

Advanced BashScripting Guide

bash$ lsof an i tcp COMMAND PID USER FD TYPE DEVICE SIZE NODE NAME firefox 2330 bozo 32u IPv4 9956 TCP 66.0.118.137:57596>67.112.7.104:http ... firefox 2330 bozo 38u IPv4 10535 TCP 66.0.118.137:57708>216.79.48.24:http ...

strace System trace: diagnostic and debugging tool for tracing system calls and signals. This command and ltrace, following, are useful for diagnosing why a given program or package fails to run . . . perhaps due to missing libraries or related causes.
bash$ strace df execve("/bin/df", ["df"], [/* 45 vars */]) = 0 uname({sys="Linux", node="bozo.localdomain", ...}) = 0 brk(0) = 0x804f5e4 ...

This is the Linux equivalent of the Solaris truss command. ltrace Library trace: diagnostic and debugging tool that traces library calls invoked by a given command.
bash$ ltrace df __libc_start_main(0x804a910, 1, 0xbfb589a4, 0x804fb70, 0x804fb68 <unfinished ...>: setlocale(6, "") = "en_US.UTF8" bindtextdomain("coreutils", "/usr/share/locale") = "/usr/share/locale" textdomain("coreutils") = "coreutils" __cxa_atexit(0x804b650, 0, 0, 0x8052bf0, 0xbfb58908) = 0 getenv("DF_BLOCK_SIZE") = NULL ...

nmap Network mapper and port scanner. This command scans a server to locate open ports and the services associated with those ports. It can also report information about packet filters and firewalls. This is an important security tool for locking down a network against hacking attempts.
#!/bin/bash SERVER=$HOST PORT_NUMBER=25 # localhost.localdomain (127.0.0.1). # SMTP port.

nmap $SERVER | grep w "$PORT_NUMBER" # Is that particular port open? # grep w matches whole words only, #+ so this wouldn't match port 1025, for example. exit 0 # 25/tcp open smtp

nc The nc (netcat) utility is a complete toolkit for connecting to and listening to TCP and UDP ports. It is useful as a diagnostic and testing tool and as a component in simple scriptbased HTTP clients and servers.
bash$ nc localhost.localdomain 25 220 localhost.localdomain ESMTP Sendmail 8.13.1/8.13.1; Thu, 31 Mar 2005 15:41:35 0700

Chapter 16. System and Administrative Commands

288

Advanced BashScripting Guide Example 165. Checking a remote server for identd
#! /bin/sh ## Duplicate DaveG's identscan thingie using netcat. Oooh, he'll be p*ssed. ## Args: target port [port port port ...] ## Hose stdout _and_ stderr together. ## ## Advantages: runs slower than identscan, giving remote inetd less cause ##+ for alarm, and only hits the few known daemon ports you specify. ## Disadvantages: requires numericonly port args, the output sleazitude, ##+ and won't work for rservices when coming from high source ports. # Script author: Hobbit <[email protected]> # Used in ABS Guide with permission. # E_BADARGS=65 # Need at least two args. TWO_WINKS=2 # How long to sleep. THREE_WINKS=3 IDPORT=113 # Authentication "tap ident" port. RAND1=999 RAND2=31337 TIMEOUT0=9 TIMEOUT1=8 TIMEOUT2=4 # case "${2}" in "" ) echo "Need HOST and at least one PORT." ; exit $E_BADARGS ;; esac # Ping 'em once and see if they *are* running identd. nc z w $TIMEOUT0 "$1" $IDPORT || \ { echo "Oops, $1 isn't running identd." ; exit 0 ; } # z scans for listening daemons. # w $TIMEOUT = How long to try to connect. # Generate a randomish base port. RP=`expr $$ % $RAND1 + $RAND2` TRG="$1" shift while test "$1" ; do nc v w $TIMEOUT1 p ${RP} "$TRG" ${1} < /dev/null > /dev/null & PROC=$! sleep $THREE_WINKS echo "${1},${RP}" | nc w $TIMEOUT2 r "$TRG" $IDPORT 2>&1 sleep $TWO_WINKS # Does this look like a lamer script or what . . . ? # ABS Guide author comments: "Ain't really all that bad . . . #+ kinda clever, actually." kill HUP $PROC RP=`expr ${RP} + 1` shift done exit $? # # Notes:

Chapter 16. System and Administrative Commands

289

Advanced BashScripting Guide

# Try commenting out line 30 and running this script #+ with "localhost.localdomain 25" as arguments. # For more of Hobbit's 'nc' example scripts, #+ look in the documentation: #+ the /usr/share/doc/ncX.XX/scripts directory.

And, of course, there's Dr. Andrew Tridgell's notorious oneline script in the BitKeeper Affair:
echo clone | nc thunk.org 5000 > e2fsprogs.dat

free 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 Mem: 30504 /+ buffers/cache: Swap: 68540 used 28624 10640 3128 free 1880 19864 65412 shared 15820 buffers 1608 cached 16376

To show unused RAM memory:

bash$ free | grep Mem | awk '{ print $4 }' 1880

procinfo Extract and list information and statistics from the /proc pseudofilesystem. This gives a very extensive and detailed listing.
bash$ procinfo | grep Bootup Bootup: Wed Mar 21 15:15:50 2001

Load average: 0.04 0.21 0.34 3/47 6829

lsdev List devices, that is, show installed hardware.

bash$ lsdev Device DMA IRQ I/O Ports cascade 4 2 dma 0080008f dma1 0000001f dma2 00c000df fpu 00f000ff ide0 14 01f001f7 03f603f6 ...

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 Shows filesystem usage in tabular form. Chapter 16. System and Administrative Commands 290

Advanced BashScripting Guide

bash$ df Filesystem /dev/hda5 /dev/hda8 /dev/hda7 1kblocks 273262 222525 1408796 Used Available Use% Mounted on 92607 166547 36% / 123951 87085 59% /home 1075744 261488 80% /usr

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.
bash$ dmesg | grep hda Kernel command line: ro root=/dev/hda2 hda: IBMDLGA23080, ATA DISK drive hda: 6015744 sectors (3080 MB) w/96KiB Cache, CHS=746/128/63 hda: hda1 hda2 hda3 < hda5 hda6 hda7 > hda4

stat Gives detailed and verbose statistics on a given file (even a directory or device file) or set of files.
bash$ stat test.cru File: "test.cru" Size: 49970 Allocated Blocks: 100 Filetype: Regular File Mode: (0664/rwrwr) Uid: ( 501/ bozo) Gid: ( 501/ bozo) Device: 3,8 Inode: 18185 Links: 1 Access: Sat Jun 2 16:40:24 2001 Modify: Sat Jun 2 16:40:24 2001 Change: Sat Jun 2 16:40:24 2001

If the target file does not exist, stat returns an error message.
bash$ stat nonexistentfile nonexistentfile: No such file or directory

In a script, you can use stat to extract information about files (and filesystems) and set variables accordingly.
#!/bin/bash # fileinfo2.sh # Per suggestion of Jol Bourquard and . . . # http://www.linuxquestions.org/questions/showthread.php?t=410766

FILENAME=testfile.txt file_name=$(stat c%n "$FILENAME") # Same as "$FILENAME" of course. file_owner=$(stat c%U "$FILENAME") file_size=$(stat c%s "$FILENAME") # Certainly easier than using "ls l $FILENAME" #+ and then parsing with sed. file_inode=$(stat c%i "$FILENAME") file_type=$(stat c%F "$FILENAME") file_access_rights=$(stat c%A "$FILENAME") echo echo echo echo echo "File "File "File "File "File name: owner: size: inode: type: $file_name" $file_owner" $file_size" $file_inode" $file_type"

Chapter 16. System and Administrative Commands

291

Advanced BashScripting Guide

echo "File access rights: $file_access_rights" exit 0 sh fileinfo2.sh File File File File File File name: owner: size: inode: type: access rights: testfile.txt bozo 418 1730378 regular file rwrwr

vmstat Display virtual memory statistics.

bash$ vmstat procs r b w swpd 0 0 0 0

free 11040

buff 2636

memory cache 38952

si 0

swap so 0

bi 33

io system bo in 7 271

cs 88

us 8

cpu sy id 3 89

netstat Show current network statistics and information, such as routing tables and active connections. This utility accesses information in /proc/net (Chapter 27). See Example 273. netstat r is equivalent to route.
bash$ netstat Active Internet connections (w/o servers) Proto RecvQ SendQ Local Address Foreign Address State Active UNIX domain sockets (w/o servers) Proto RefCnt Flags Type State INode Path unix 11 [ ] DGRAM 906 /dev/log unix 3 [ ] STREAM CONNECTED 4514 /tmp/.X11unix/X0 unix 3 [ ] STREAM CONNECTED 4513 . . .

A netstat lptu shows sockets that are listening to ports, and the associated processes. This can be useful for determining whether a computer has been hacked or compromised. uptime 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

A load average of 1 or less indicates that the system handles processes immediately. A load average greater than 1 means that processes are being queued. When the load average gets above 3, then system performance is significantly degraded. 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

Chapter 16. System and Administrative Commands

292

Advanced BashScripting Guide

bash$ echo $HOSTNAME localhost.localdomain

Similar to the hostname command are the domainname, dnsdomainname, nisdomainname, and ypdomainname commands. Use these to display or set the system DNS or NIS/YP domain name. Various options to hostname also perform these functions. hostid Echo a 32bit hexadecimal numerical identifier for the host machine.
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. The network address of a typical nonnetworked Linux machine, is found in /etc/hosts.
bash$ cat /etc/hosts 127.0.0.1

localhost.localdomain localhost

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 Reporter) gives a very detailed rundown on system statistics. The Santa Cruz Operation ("Old" SCO) released sar as Open Source in June, 1999. This command is not part of the base Linux distribution, but may be obtained as part of the sysstat utilities package, written by Sebastien Godard.
bash$ sar Linux 2.4.9 (brooks.seringas.fr) 10:30:00 10:40:00 10:50:00 11:00:00 Average: 14:32:30 15:00:00 15:10:00 15:20:00 15:30:00 Average: CPU all all all all %user 2.21 3.36 1.12 2.23

09/26/03 %nice 10.90 0.00 0.00 3.63 %system 65.48 72.36 80.77 72.87 %iowait 0.00 0.00 0.00 0.00 %idle 21.41 24.28 18.11 21.27

LINUX RESTART CPU all all all all %user 8.59 4.07 0.79 6.33 %nice 2.40 1.00 2.94 1.70 %system 17.47 11.95 7.56 14.71 %iowait 0.00 0.00 0.00 0.00 %idle 71.54 82.98 88.71 77.26

readelf Show information and statistics about a designated elf binary. This is part of the binutils package.
bash$ readelf h /bin/bash ELF Header:

Chapter 16. System and Administrative Commands

293

Advanced BashScripting Guide

Magic: 7f 45 4c 46 01 01 01 00 00 00 00 00 00 00 00 00 Class: ELF32 Data: 2's complement, little endian Version: 1 (current) OS/ABI: UNIX System V ABI Version: 0 Type: EXEC (Executable file) . . .

size The size [/path/to/binary] command gives the segment sizes of a binary executable or archive file. This is mainly of use to programmers.
bash$ size /bin/bash text data bss 495971 22496 17392

dec 535859

hex filename 82d33 /bin/bash

System Logs logger Appends a usergenerated message to the system log (/var/log/messages). You do not have to be root to invoke logger.
logger Experiencing instability in network connection at 23:10, 05/21. # Now, do a 'tail /var/log/messages'.

By embedding a logger command in a script, it is possible to write debugging information to /var/log/messages.

logger t $0 i Logging at line "$LINENO". # The "t" option specifies the tag for the logger entry. # The "i" option records the process ID. # 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 emailing them, as appropriate. This keeps the /var/log from getting cluttered with old log files. Usually cron 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 systemwide ones. Stefano Falsetto has created rottlog, which he considers to be an improved version of logrotate. Job Control ps Process Statistics: lists currently executing processes by owner and PID (process ID). This is usually invoked with ax or aux options, and may be piped to grep or sed to search for a specific process (see Example 1413 and Example 272).

Chapter 16. System and Administrative Commands

294

Advanced BashScripting Guide

bash$ 295 ? ps ax | grep sendmail S 0:00 sendmail: accepting connections on port 25

To display system processes in graphical "tree" format: ps afjx or ps ax forest. pgrep, pkill Combining the ps command with grep or kill.
bash$ ps a | grep mingetty 2212 tty2 Ss+ 0:00 /sbin/mingetty tty2 2213 tty3 Ss+ 0:00 /sbin/mingetty tty3 2214 tty4 Ss+ 0:00 /sbin/mingetty tty4 2215 tty5 Ss+ 0:00 /sbin/mingetty tty5 2216 tty6 Ss+ 0:00 /sbin/mingetty tty6 4849 pts/2 S+ 0:00 grep mingetty

bash$ pgrep mingetty 2212 mingetty 2213 mingetty 2214 mingetty 2215 mingetty 2216 mingetty

Compare the action of pkill with killall. 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 cpuintensive 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, Swap: 157208K av, 0K used, 157208K free PID 848 1 2 ... USER bozo root root PRI 17 8 9 NI 0 0 0 SIZE 996 512 0 RSS SHARE STAT %CPU %MEM 996 800 R 5.6 1.2 512 444 S 0.0 0.6 0 0 SW 0.0 0.0 TIME 0:00 0:04 0:00

2352K buff 37244K cached

COMMAND top init 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 and snice, which change the priority of a running process or processes, and skill, which sends a kill signal to a process or processes. 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 Chapter 16. System and Administrative Commands 295

Advanced BashScripting Guide command is the approximate counterpart to the $PPID internal variable.
bash$ pidof xclock 880

Example 166. pidof helps kill a process

#!/bin/bash # killprocess.sh NOPROCESS=2 process=xxxyyyzzz # Use nonexistent process. # For demo purposes only... # ... don't want to actually kill any actual process with this script. # # If, for example, you wanted to use this script to logoff the Internet, # process=pppd t=`pidof $process` # Find pid (process id) of $process. # The pid is needed by 'kill' (can't 'kill' by program name). if [ z "$t" ] # If process not present, 'pidof' returns null. then echo "Process $process was not running." echo "Nothing killed." exit $NOPROCESS fi kill $t # May need 'kill 9' for stubborn process.

# Need a check here to see if process allowed itself to be killed. # Perhaps another " t=`pidof $process` " or ...

# This entire script could be replaced by # kill $(pidof x process_name) # or # killall process_name # but it would not be as instructive. 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.
bash$ fuser u /usr/bin/vim /usr/bin/vim: 3207e(bozo)

bash$ fuser u /dev/null /dev/null: 3009(bozo)

3010(bozo)

3197(bozo)

3199(bozo)

One important application for fuser is when physically inserting or removing storage media, such as CD ROM disks or USB flash drives. Sometimes trying a umount fails with a device is busy error Chapter 16. System and Administrative Commands 296

Advanced BashScripting Guide message. This means that some user(s) and/or process(es) are accessing the device. An fuser um /dev/device_name will clear up the mystery, so you can kill any relevant processes.
bash$ umount /mnt/usbdrive umount: /mnt/usbdrive: device is busy

bash$ fuser um /dev/usbdrive /mnt/usbdrive: 1772c(bozo) bash$ kill 9 1772 bash$ umount /mnt/usbdrive

The fuser command, invoked with the n option identifies the processes accessing a port. This is especially useful in combination with nmap.
root# nmap localhost.localdomain PORT STATE SERVICE 25/tcp open smtp

root# fuser un tcp 25 25/tcp: 2095(root) root# ps ax | grep 2095 | grep v grep 2095 ? Ss 0:00 sendmail: accepting connections

cron 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. Some flavors of Linux run crond, Matthew Dillon's version of cron. Process Control and Booting 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 singleuser mode (1), in multiuser 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. service Chapter 16. System and Administrative Commands 297

Advanced BashScripting Guide Starts or stops a system service. The startup scripts in /etc/init.d and /etc/rc.d use this command to start services at bootup.
root# /sbin/service iptables stop Flushing firewall rules: Setting chains to policy ACCEPT: filter Unloading iptables modules:

[ [ [

OK ] OK ] OK ]

Network ifconfig Network interface configuration and tuning utility.

bash$ ifconfig a lo Link encap:Local Loopback inet addr:127.0.0.1 Mask:255.0.0.0 UP LOOPBACK RUNNING MTU:16436 Metric:1 RX packets:10 errors:0 dropped:0 overruns:0 frame:0 TX packets:10 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:0 RX bytes:700 (700.0 b) TX bytes:700 (700.0 b)

The ifconfig command is most often used at bootup to set up the interfaces, or to shut them down when rebooting.
# Code snippets from /etc/rc.d/init.d/network # ... # Check that networking is up. [ ${NETWORKING} = "no" ] && exit 0 [ 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 GNUspecific "q" option to "grep" means "quiet", i.e., #+ producing no output. # Redirecting output to /dev/null is therefore not strictly necessary. # ... echo "Currently active devices:" echo `/sbin/ifconfig | grep ^[az] | awk '{print $1}'` # ^^^^^ should be quoted to prevent globbing. # The following also work. # echo $(/sbin/ifconfig | awk '/^[az]/ { print $1 })' # echo $(/sbin/ifconfig | sed e 's/ .*//') # Thanks, S.C., for additional comments.

See also Example 296. iwconfig This is the command set for configuring a wireless network. It is the wireless equivalent of ifconfig, above. ip Chapter 16. System and Administrative Commands 298

Advanced BashScripting Guide General purpose utility for setting up, changing, and analyzing IP (Internet Protocol) networks and attached devices. This command is part of the iproute2 package.
bash$ ip link show 1: lo: <LOOPBACK,UP> mtu 16436 qdisc noqueue link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 2: eth0: <BROADCAST,MULTICAST> mtu 1500 qdisc pfifo_fast qlen 1000 link/ether 00:d0:59:ce:af:da brd ff:ff:ff:ff:ff:ff 3: sit0: <NOARP> mtu 1480 qdisc noop link/sit 0.0.0.0 brd 0.0.0.0

bash$ ip route list 169.254.0.0/16 dev lo

scope link

Or, in a script:
#!/bin/bash # Script by Juan Nicolas Ruiz # Used with his kind permission. # Setting up (and stopping) a GRE tunnel.

# starttunnel.sh LOCAL_IP="192.168.1.17" REMOTE_IP="10.0.5.33" OTHER_IFACE="192.168.0.100" REMOTE_NET="192.168.3.0/24" /sbin/ip tunnel add netb mode gre remote $REMOTE_IP \ local $LOCAL_IP ttl 255 /sbin/ip addr add $OTHER_IFACE dev netb /sbin/ip link set netb up /sbin/ip route add $REMOTE_NET dev netb exit 0 #############################################

# stoptunnel.sh REMOTE_NET="192.168.3.0/24" /sbin/ip route del $REMOTE_NET dev netb /sbin/ip link set netb down /sbin/ip tunnel del netb exit 0

route Show info about or make changes to the kernel routing table.
bash$ route Destination Gateway Genmask Flags pm367.bozosisp * 255.255.255.255 UH 127.0.0.0 * 255.0.0.0 U default pm367.bozosisp 0.0.0.0 UG

MSS Window 40 0 40 0 40 0

irtt Iface 0 ppp0 0 lo 0 ppp0

chkconfig

Chapter 16. System and Administrative Commands

299

Advanced BashScripting Guide 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.
bash$ chkconfig list atd 0:off rwhod 0:off ...

1:off 1:off

2:off 2:off

3:on 3:off

4:on 4:off

5:on 5:off

6:off 6:off

tcpdump Network packet "sniffer." This is a tool for analyzing and troubleshooting traffic on a network by dumping packet headers that match specified criteria. Dump ip packet traffic between hosts bozoville and caduceus:
bash$ tcpdump ip host bozoville and caduceus

Of course, the output of tcpdump can be parsed with 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.
mount t iso9660 /dev/cdrom /mnt/cdrom # Mounts CDROM mount /mnt/cdrom # Shortcut, if /mnt/cdrom listed in /etc/fstab

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. [60]

Example 167. Checking a CD image

# As root... mkdir /mnt/cdtest # Prepare a mount point, if not already there.

mount r t iso9660 o loop cdimage.iso /mnt/cdtest # Mount the image. # "o loop" option equivalent to "losetup /dev/loop0" cd /mnt/cdtest # Now, check the image. ls alR # List the files in the directory tree there. # And so forth.

Chapter 16. System and Administrative Commands

300

Advanced BashScripting Guide 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 "multispindle" laptops with swappable floppy and optical drives, this can cause problems, however. gnomemount The newer Linux distros have deprecated mount and umount. The successor, for commandline mounting of removable storage devices, is gnomemount. It can take the d option to mount a device file by its listing in /dev. For example, to mount a USB flash drive:
bash$ gnomemount d /dev/sda1 gnomemount 0.4

bash$ df . . . /dev/sda1

63584

12034

51550

19% /media/disk

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 1555) or when the lights begin to flicker. losetup Sets up and configures loopback devices.

Example 168. Creating a filesystem in a file

SIZE=1000000 # 1 meg # # # # Set up file of designated size. Set it up as loopback device. Create filesystem. Mount it.

head c $SIZE < /dev/zero > file losetup /dev/loop0 file mke2fs /dev/loop0 mount o loop /dev/loop0 /mnt # 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 Create a Linux ext2 filesystem. This command must be invoked as root. Chapter 16. System and Administrative Commands 301

Advanced BashScripting Guide Example 169. Adding a new hard drive

#!/bin/bash # # # # Adding a second hard drive to system. Software configuration. Assumes hardware already mounted. From an article by the author of this document. In issue #38 of "Linux Gazette", http://www.linuxgazette.com. # This script must be run as root. # Nonroot exit error.

ROOT_UID=0 E_NOTROOT=67

if [ "$UID" ne "$ROOT_UID" ] then echo "Must be root to run this script." exit $E_NOTROOT fi # Use with extreme caution! # If something goes wrong, you may wipe out your current filesystem.

NEWDISK=/dev/hdb MOUNTPOINT=/mnt/newdisk

# Assumes /dev/hdb vacant. Check! # Or choose another mount point.

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 exit 0

1 1

See also Example 168 and Example 283. 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.
root# dumpe2fs /dev/hda7 | dumpe2fs 1.19, 13Jul2000 Mount count: Maximum mount count: grep 'ount count' for EXT2 FS 0.5b, 95/08/09 6 20

hdparm Chapter 16. System and Administrative Commands 302

Advanced BashScripting Guide 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 Filesystem check, repair, and debug command set. fsck: a front end for checking a UNIX filesystem (may invoke other utilities). The actual filesystem type generally defaults to ext2. e2fsck: ext2 filesystem checker. 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. [61] As an example, badblocks /dev/fd0 tests a floppy disk. The badblocks command may be invoked destructively (overwrite all data) or in nondestructive readonly mode. If root user owns the device to be tested, as is generally the case, then root must invoke this command. lsusb, usbmodules The lsusb command lists all USB (Universal Serial Bus) buses and the devices hooked up to them. The usbmodules command outputs information about the driver modules for connected USB devices.
bash$ lsusb Bus 001 Device 001: ID 0000:0000 Device Descriptor: bLength 18 bDescriptorType 1 bcdUSB 1.00 bDeviceClass 9 Hub bDeviceSubClass 0 bDeviceProtocol 0 bMaxPacketSize0 8 idVendor 0x0000 idProduct 0x0000 . . .

lspci Lists pci busses present.

bash$ lspci

Chapter 16. System and Administrative Commands

303

Advanced BashScripting Guide

00:00.0 Host (Brookdale) 00:01.0 PCI (Brookdale) 00:1d.0 USB 00:1d.1 USB 00:1d.2 USB 00:1e.0 PCI . . . bridge: Intel Corporation 82845 845 Chipset Host Bridge (rev 04) bridge: Intel Corporation 82845 845 Chipset AGP Bridge (rev 04) Controller: Intel Corporation 82801CA/CAM USB (Hub #1) Controller: Intel Corporation 82801CA/CAM USB (Hub #2) Controller: Intel Corporation 82801CA/CAM USB (Hub #3) bridge: Intel Corporation 82801 Mobile PCI Bridge (rev

(rev 02) (rev 02) (rev 02) 42)

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.
lockfile /home/bozo/lockfiles/$0.lock # Creates a writeprotected lockfile prefixed with the name of the script.

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 to 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. [62] A script can test for the presence of a lock file by something like the following.

Chapter 16. System and Administrative Commands

304

Advanced BashScripting Guide

appname=xyzip # Application "xyzip" created lock file "/var/lock/xyzip.lock". if [ e "/var/lock/$appname.lock" ] then #+ Prevent other programs & scripts # from accessing files/resources used by xyzip. ...

flock Much less useful than the lockfile command is flock. It sets an "advisory" lock on a file and then executes a command while the lock is on. This is to prevent any other process from setting a lock on that file until completion of the specified command.
flock $0 cat $0 > lockfile__$0 # Set a lock on the script the above line appears in, #+ while listing the script to stdout.

Unlike lockfile, flock does not automatically create a lock file. mknod Creates block or character device files (may be necessary when installing new hardware on the system). The MAKEDEV utility has virtually all of the functionality of mknod, and is easier to use. MAKEDEV Utility for creating device files. It must be run as root, and in the /dev directory. It is a sort of advanced version of mknod. tmpwatch Automatically deletes files which have not been accessed within a specified period of time. Usually invoked by cron to remove stale log files. Backup dump, restore The dump command is an elaborate filesystem backup utility, generally used on larger installations and networks. [63] 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 Perform a lowlevel format on a floppy disk (/dev/fd0*). System Resources ulimit Sets an upper limit on use of 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 Appendix G). Judicious use of ulimit can protect a system against the dreaded fork bomb.
#!/bin/bash # This script is for illustrative purposes only. # Run it at your own peril it WILL freeze your system. while true # Endless loop.

Chapter 16. System and Administrative Commands

305

Advanced BashScripting Guide

do $0 & # #+ #+ # # This script invokes itself . . . forks an infinite number of times . . . until the system freezes up because all resources exhausted. This is the notorious "sorcerer's appentice" scenario. Will not exit here, because this script will never terminate.

done exit 0

A ulimit Hu XX (where XX is the user process limit) in /etc/profile would abort this script when it exceeded the preset limit. quota Display user or group disk quotas. setquota Set user or group disk quotas from the command line. umask User file creation permissions 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). [64] 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 Appendix G).

Example 1610. Using umask to hide an output file from prying eyes
#!/bin/bash # rot13a.sh: Same as "rot13.sh" script, but writes output to "secure" file. # Usage: ./rot13a.sh filename # or ./rot13a.sh <filename # or ./rot13a.sh and supply keyboard input (stdin) umask 177 # File creation mask. # Files created by this script #+ will have 600 permissions. # Results output to file "decrypted.txt" #+ which can only be read/written # by invoker of script (or root).

OUTFILE=decrypted.txt

cat "$@" | tr 'azAZ' 'nzamNZAM' > $OUTFILE # ^^ Input from stdin or a file. ^^^^^^^^^^ Output redirected to file. exit 0

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 a dangerous command, if misused. Modules lsmod List installed kernel modules.
bash$ lsmod Module

Size

Used by

Chapter 16. System and Administrative Commands

306

Advanced BashScripting Guide

autofs opl3 serial_cs sb uart401 sound soundlow soundcore ds i82365 pcmcia_core 9456 11376 5456 34752 6384 58368 464 2800 6448 22928 45984 2 0 0 0 0 0 0 6 2 2 0 (autoclean) (unused) [sb] [opl3 sb uart401] [sound] [sb sound] [serial_cs] [serial_cs ds i82365]

Doing a cat /proc/modules gives the same information. insmod Force installation of a kernel module (use modprobe instead, when possible). Must be invoked as root. rmmod Force unloading of a kernel module. Must be invoked as root. modprobe Module loader that is normally invoked automatically in a startup script. Must be invoked as root. depmod Creates module dependency file. Usually invoked from a startup script. modinfo Output information about a loadable module.
bash$ modinfo hid filename: /lib/modules/2.4.206/kernel/drivers/usb/hid.o description: "USB HID support drivers" author: "Andreas Gal, Vojtech Pavlik <[email protected]>" license: "GPL"

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.
var1=value1 var2=value2 commandXXX # $var1 and $var2 set in the environment of 'commandXXX' only.

The first line of a script (the "shabang" line) may use env when the path to the shell or interpreter is unknown.
#! /usr/bin/env perl print "This Perl script will run,\n";

Chapter 16. System and Administrative Commands

307

Advanced BashScripting Guide

print "even when I don't know where to find Perl.\n"; # Good for portable crossplatform scripts, # where the Perl binaries may not be in the expected place. # Thanks, S.C.

ldd Show shared lib dependencies for an executable file.

bash$ ldd /bin/ls libc.so.6 => /lib/libc.so.6 (0x4000c000) /lib/ldlinux.so.2 => /lib/ldlinux.so.2 (0x80000000)

watch Run a command repeatedly, at specified time intervals. The default is twosecond intervals, but this may be changed with the n option.
watch n 5 tail /var/log/messages # Shows tail end of system log, /var/log/messages, every five seconds.

Unfortunately, piping the output of watch command to grep does not work. strip Remove the debugging symbolic references from an executable binary. This decreases its size, but makes debugging it impossible. This command often occurs in a Makefile, but rarely in a shell script. nm List symbols in an unstripped compiled binary. rdist Remote distribution client: synchronizes, clones, or backs up a file system on a remote server.

16.1. Analyzing a System Script

Using our knowledge of administrative commands, let us examine a system script. One of the shortest and simplest to understand scripts is "killall," [65] used to suspend running processes at system shutdown.

Example 1611. killall, from /etc/rc.d/init.d

#!/bin/sh # > Comments added by the author of this document marked by "# >". # > This is part of the 'rc' script package # > by Miquel van Smoorenburg, <[email protected]>. # > This particular script seems to be Red Hat / FC specific # > (may not be present in other distributions). # 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

Chapter 16. System and Administrative Commands

308

Advanced BashScripting Guide

# # # [ # # > 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

# Get the subsystem name. subsys=${i#/var/lock/subsys/} # > Match variable name, which, in this case, is the file name. # > This is the exact equivalent of subsys=`basename $i`. # # # # > >+ >+ > It gets it from the lock file name (if there is a lock file, that's proof the process has been running). See the "lockfile" entry, above.

# Bring the subsystem down. if [ f /etc/rc.d/init.d/$subsys.init ]; then /etc/rc.d/init.d/$subsys.init stop else /etc/rc.d/init.d/$subsys stop # > Suspend running jobs and daemons. # > Note that "stop" is a positional parameter, # >+ not a shell builtin. fi done

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.

Chapter 16. System and Administrative Commands

309

Part 5. Advanced Topics

At this point, we are ready to delve into certain of the difficult and unusual aspects of scripting. Along the way, we will attempt to "push the envelope" in various ways and examine boundary conditions (what happens when we move into uncharted territory?). Table of Contents 17. Regular Expressions 17.1. A Brief Introduction to Regular Expressions 17.2. Globbing 18. Here Documents 18.1. Here Strings 19. I/O Redirection 19.1. Using exec 19.2. Redirecting Code Blocks 19.3. Applications 20. Subshells 21. Restricted Shells 22. Process Substitution 23. Functions 23.1. Complex Functions and Function Complexities 23.2. Local Variables 23.3. Recursion Without Local Variables 24. Aliases 25. List Constructs 26. Arrays 27. /dev and /proc 27.1. /dev 27.2. /proc 28. Of Zeros and Nulls 29. Debugging 30. Options 31. Gotchas 32. Scripting With Style 32.1. Unofficial Shell Scripting Stylesheet 33. Miscellany 33.1. Interactive and noninteractive shells and scripts 33.2. Shell Wrappers 33.3. Tests and Comparisons: Alternatives 33.4. Recursion 33.5. "Colorizing" Scripts 33.6. Optimizations 33.7. Assorted Tips 33.8. Security Issues 33.9. Portability Issues 33.10. Shell Scripting Under Windows 34. Bash, versions 2 and 3 34.1. Bash, version 2 34.2. Bash, version 3 Part 5. Advanced Topics 310

Advanced BashScripting Guide

Part 5. Advanced Topics

311

Chapter 17. Regular Expressions

. . . the intellectual activity associated with software development is largely one of gaining insight. Stowe Boyd To fully utilize the power of shell scripting, you need to master Regular Expressions. Certain commands and utilities commonly used in scripts, such as grep, expr, sed and awk interpret and use REs.

17.1. A Brief Introduction to Regular Expressions

An expression is a string of characters. Those characters having an interpretation above and beyond their literal meaning are called metacharacters. A quote symbol, for example, may denote speech by a person, ditto, or a metameaning for the symbols that follow. Regular Expressions are sets of characters and/or metacharacters that match (or specify) patterns. A Regular Expression contains one or more of the following: A character set. These are the characters retaining their literal meaning. The simplest type of Regular Expression consists only of a character set, with no metacharacters. An anchor. These designate (anchor) the position in the line of text that the RE is to match. For example, ^, and $ are anchors. Modifiers. These expand or narrow (modify) the range of text the RE is to match. Modifiers include the asterisk, brackets, and the backslash. 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 string or a part of a string. The asterisk * matches any number of repeats of the character string or RE preceding it, including zero. "1133*" matches 11 + one or more 3's + possibly other characters: 113, 1133, 111312, and so forth. The dot . matches any one character, except a newline. [66] "13." matches 13 + at least one of any character (including a space): 1133, 11333, but not 13 (additional character missing). The caret ^ matches the beginning of a line, but sometimes, depending on context, negates the meaning of a set of characters in an RE. The dollar sign $ at the end of an RE matches the end of a line. "XXX$" matches XXX at the end of a line. "^$" matches blank lines. Brackets [...] enclose a set of characters to match in a single RE. "[xyz]" matches the characters x, y, or z. Chapter 17. Regular Expressions 312

Advanced BashScripting Guide "[cn]" matches any of the characters in the range c to n. "[BPky]" matches any of the characters in the ranges B to P and k to y. "[az09]" matches any lowercase letter or any digit. "[^bd]" 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). Combined sequences of bracketed characters match common word patterns. "[Yy][Ee][Ss]" matches yes, Yes, YES, yEs, and so forth. "[09][09][09][09][09][09][09][09][09]" matches any Social Security number. The backslash \ escapes a special character, which means that character gets interpreted literally. A "\$" reverts back to its literal meaning of "$", rather than its RE meaning of endofline. Likewise a "\\" has the literal meaning of "\". Escaped "angle brackets" \<...\> mark word boundaries. 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.
bash$ cat textfile This is line 1, of which there is only one instance. This is the only instance of line 2. This is line 3, another line. This is line 4.

bash$ grep 'the' textfile This is line 1, of which there is only one instance. This is the only instance of line 2. This is line 3, another line.

bash$ grep '\<the\>' textfile This is the only instance of line 2.

The only way to be certain that a particular RE works is to test it.

TEST FILE: tstfile Run grep "1133*" on this file. # # # # # # # # # # # No match. No match. Match. No match. No match. Match. No match. No match. Match. Match. No match.

This This This This This This

line line line line line line

contains contains contains contains contains contains

the the the the the the

number number number number number number

113. 13. 133. 1133. 113312. 1112.

Chapter 17. Regular Expressions

313

Advanced BashScripting Guide

This line contains the number 113312312. This line contains no numbers at all. bash$ Run This This This This grep grep line line line line "1133*" tstfile "1133*" on this file. contains the number 113. contains the number 1133. contains the number 113312. contains the number 113312312. # Match. # No match. # Match. # Match. # Match. # Match. # Match.

Extended REs. Additional metacharacters added to the basic set. Used in egrep, awk, and Perl. 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.
# GNU versions of sed and awk can use "+", # but it needs to be escaped. echo a111b | sed ne '/a1\+b/p' echo a111b | grep 'a1\+b' echo a111b | gawk '/a1+b/' # All of above are equivalent. # Thanks, S.C.

Escaped "curly brackets" \{ \} indicate the number of occurrences of a preceding RE to match. 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. "[09]\{5\}" matches exactly five digits (characters in the range of 0 to 9). Curly brackets are not available as an RE in the "classic" (nonPOSIX compliant) version of awk. However, gawk has the reinterval option that permits them (without being escaped).
bash$ echo 2222 | gawk reinterval '/2{3}/' 2222

Perl and some egrep versions do not require escaping the curly brackets. 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.
bash$ egrep 're(a|e)d' misc.txt People who read seem to be better informed than those who do not. The clarinet produces sound by the vibration of its reed.

Some versions of sed, ed, and ex support escaped versions of the extended Regular Expressions described above, as do the GNU utilities. Chapter 17. Regular Expressions 314

Advanced BashScripting Guide POSIX Character Classes. [:class:] This is an alternate method of specifying a range of characters to match. [:alnum:] matches alphabetic or numeric characters. This is equivalent to AZaz09. [:alpha:] matches alphabetic characters. This is equivalent to AZaz. [:blank:] matches a space or a tab. [:cntrl:] matches control characters. [:digit:] matches (decimal) digits. This is equivalent to 09. [:graph:] (graphic printable characters). Matches characters in the range of ASCII 33 126. This is the same as [:print:], below, but excluding the space character. [:lower:] matches lowercase alphabetic characters. This is equivalent to az. [:print:] (printable characters). Matches characters in the range of ASCII 32 126. This is the same as [:graph:], above, but adding the space character. [:space:] matches whitespace characters (space and horizontal tab). [:upper:] matches uppercase alphabetic characters. This is equivalent to AZ. [:xdigit:] matches hexadecimal digits. This is equivalent to 09AFaf. POSIX character classes generally require quoting or double brackets ([[ ]]).
bash$ grep [[:digit:]] test.file abc=723

These character classes may even be used with globbing, to a limited extent.
bash$ ls l ?[[:digit:]][[:digit:]]? rwrwr 1 bozo bozo 0 Aug 21 14:47 a33b

To see POSIX character classes used in scripts, refer to Example 1518 and Example 1519. Sed, awk, and Perl, used as filters in scripts, take REs as arguments when "sifting" or transforming files or I/O streams. See Example A12 and Example A17 for illustrations of this. The standard reference on this complex topic is Friedl's Mastering Regular Expressions. Sed & Awk, by Dougherty and Robbins also gives a very lucid treatment of REs. See the Bibliography for more information on these books.

17.2. Globbing
Bash itself cannot recognize Regular Expressions. Inside scripts, it is commands and utilities such as sed and awk that interpret RE's. Bash does carry out filename expansion [67] 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 important limitations on wildcard characters in globbing, however. Strings containing * will not match filenames that start with a dot, as, for example, .bashrc. [68] Likewise, the ? has a different meaning in globbing than as part of an RE.
bash$ ls l total 2

Chapter 17. Regular Expressions

315

Advanced BashScripting Guide

rwrwr rwrwr rwrwr rwrwr rwrwr 1 1 1 1 1 bozo bozo bozo bozo bozo bozo bozo bozo bozo bozo 0 0 0 466 758 Aug 6 Aug 6 Aug 6 Aug 6 Jul 30 18:42 18:42 18:42 17:48 09:02 a.1 b.1 c.1 t2.sh test1.txt

bash$ ls l t?.sh rwrwr 1 bozo

bozo

466 Aug

6 17:48 t2.sh

bash$ ls l [ab]* rwrwr 1 bozo bozo rwrwr 1 bozo bozo bash$ ls l [ac]* rwrwr 1 bozo bozo rwrwr 1 bozo bozo rwrwr 1 bozo bozo bash$ ls l [^ab]* rwrwr 1 bozo bozo rwrwr 1 bozo bozo rwrwr 1 bozo bozo bash$ ls l {b*,c*,*est*} rwrwr 1 bozo bozo rwrwr 1 bozo bozo rwrwr 1 bozo bozo

0 Aug 6 18:42 a.1 0 Aug 6 18:42 b.1

0 Aug 6 18:42 a.1 0 Aug 6 18:42 b.1 0 Aug 6 18:42 c.1

0 Aug 6 18:42 c.1 466 Aug 6 17:48 t2.sh 758 Jul 30 09:02 test1.txt

0 Aug 6 18:42 b.1 0 Aug 6 18:42 c.1 758 Jul 30 09:02 test1.txt

Bash performs filename expansion on unquoted commandline arguments. The echo command demonstrates this.
bash$ echo * a.1 b.1 c.1 t2.sh test1.txt bash$ echo t* t2.sh test1.txt

It is possible to modify the way Bash interprets special characters in globbing. A set f command disables globbing, and the nocaseglob and nullglob options to shopt change globbing behavior. See also Example 104.

Chapter 17. Regular Expressions

316

Chapter 18. Here Documents

Here and now, boys. Aldous Huxley, Island A here document is a specialpurpose code block. It uses a form of I/O redirection to feed a command list to an interactive program or a command, such as ftp, cat, or the ex text editor.
COMMAND <<InputComesFromHERE ... InputComesFromHERE

A limit string delineates (frames) the command list. The special symbol << designates the limit string. This has the effect of redirecting the output of a file into the stdin of the program or command. It is similar to interactiveprogram < commandfile, where commandfile contains
command #1 command #2 ...

The here document alternative looks like this:

#!/bin/bash interactiveprogram <<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 noninteractive utilities and commands, such as, for example, wall.

Example 181. broadcast: Sends message to everyone logged in

#!/bin/bash wall <<zzz23EndOfMessagezzz23 Email your noontime orders for pizza to the system administrator. (Add an extra dollar for anchovy or mushroom topping.) # Additional message text goes here. # Note: 'wall' prints comment lines. zzz23EndOfMessagezzz23 # Could have been done more efficiently by # wall <messagefile # However, embedding the message template in a script #+ is a quickanddirty oneoff solution. exit 0

Even such unlikely candidates as vi lend themselves to here documents.

Example 182. dummyfile: Creates a 2line dummy file Chapter 18. Here Documents 317

Advanced BashScripting Guide

#!/bin/bash # Noninteractive use of 'vi' to edit a file. # Emulates 'sed'. E_BADARGS=65 if [ z "$1" ] then echo "Usage: `basename $0` filename" exit $E_BADARGS fi TARGETFILE=$1 # Insert 2 lines in file, then save. #Begin here document# vi $TARGETFILE <<x23LimitStringx23 i This is line 1 of the example file. This is line 2 of the example file. ^[ ZZ x23LimitStringx23 #End here document# # Note that ^[ above is a literal escape #+ typed by ControlV <Esc>. # 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 # Replace all instances of "Smith" with "Jones" #+ in files with a ".txt" filename suffix. ORIGINAL=Smith REPLACEMENT=Jones for word in $(fgrep l $ORIGINAL *.txt) do # ex $word <<EOF :%s/$ORIGINAL/$REPLACEMENT/g :wq EOF # :%s is the "ex" substitution command. # :wq is writeandquit. # done

Analogous to "ex scripts" are cat scripts.

Example 183. Multiline message using cat

Chapter 18. Here Documents

318

Advanced BashScripting Guide

#!/bin/bash # 'echo' is fine for printing single line messages, #+ but somewhat problematic for for message blocks. # A 'cat' here document overcomes this limitation. 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 # Replacing line 7, above, with #+ cat > $Newfile <<Endofmessage #+ ^^^^^^^^^^ #+ writes the output to the file $Newfile, rather than to stdout. exit 0

# # Code below disabled, due to "exit 0" above. # S.C. points out that the following also works. echo " 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. " # However, text may not include double quotes unless they are escaped.

The option to mark a here document limit string (<<LimitString) suppresses leading tabs (but not spaces) in the output. This may be useful in making a script more readable.

Example 184. Multiline message, with tabs suppressed

#!/bin/bash # Same as previous example, but... # The option to a here document << #+ suppresses leading tabs in the body of the document, #+ but *not* spaces. 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. # Above 5 lines of "message" prefaced by a tab, not spaces.

Chapter 18. Here Documents

319

Advanced BashScripting Guide

# Spaces not affected by << .

# Note that this option has no effect on *embedded* tabs. 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.

Example 185. Here document with parameter substitution

#!/bin/bash # Another 'cat' here document, using parameter substitution. # Try it with no command line parameters, ./scriptname # Try it with one command line parameter, ./scriptname Mortimer # Try it with one twoword quoted command line parameter, # ./scriptname "Mortimer Jones" CMDLINEPARAM=1 # Expect at least command line parameter.

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 RESPONDENT="the author of this fine script"

cat <<Endofmessage Hello, there, $NAME. Greetings to you, $NAME, from $RESPONDENT. # This comment shows up in the output (why?). Endofmessage # Note that the blank lines show up in the output. # So does the "comment". exit 0

This is a useful script containing a here document with parameter substitution.

Example 186. Upload a file pair to Sunsite incoming directory

#!/bin/bash # upload.sh # #+ # # # Upload file pair (Filename.lsm, Filename.tar.gz) to incoming directory at Sunsite/UNC (ibiblio.org). Filename.tar.gz is the tarball itself. Filename.lsm is the descriptor file. Sunsite requires "lsm" file, otherwise will bounce contributions.

Chapter 18. Here Documents

320

Advanced BashScripting Guide

E_ARGERROR=65 if [ z "$1" ] then echo "Usage: `basename $0` Filenametoupload" exit $E_ARGERROR fi

Filename=`basename $1`

# Strips pathname out of file name.

Server="ibiblio.org" Directory="/incoming/Linux" # These need not be hardcoded into script, #+ but may instead be changed to command line argument. Password="your.email.address" ftp n $Server <<EndOfSession # n option disables autologon user anonymous "$Password" binary bell cd $Directory put "$Filename.lsm" put "$Filename.tar.gz" bye EndOfSession exit 0 # Change above to suit.

# Ring 'bell' after each file transfer.

Quoting or escaping the "limit string" at the head of a here document disables parameter substitution within its body.

Example 187. Parameter substitution turned off

#!/bin/bash # A 'cat' heredocument, but with parameter substitution disabled. NAME="John Doe" RESPONDENT="the author of this fine script" cat <<'Endofmessage' Hello, there, $NAME. Greetings to you, $NAME, from $RESPONDENT. Endofmessage # No parameter substitution when the "limit string" is quoted or escaped. # Either of the following at the head of the here document would have #+ the same effect. # cat <<"Endofmessage" # cat <<\Endofmessage exit 0

Disabling parameter substitution permits outputting literal text. Generating scripts or even program code is one use for this. Chapter 18. Here Documents 321

Advanced BashScripting Guide Example 188. A script that generates another script
#!/bin/bash # generatescript.sh # Based on an idea by Albert Reiner. OUTFILE=generated.sh # Name of the file to generate.

# # 'Here document containing the body of the generated script. ( cat <<'EOF' #!/bin/bash echo "This is a generated shell script." # Note that since we are inside a subshell, #+ we can't access variables in the "outside" script. echo "Generated file will be named: $OUTFILE" # Above line will not work as normally expected #+ because parameter expansion has been disabled. # Instead, the result is literal output. a=7 b=3 let "c = $a * $b" echo "c = $c" exit 0 EOF ) > $OUTFILE # # Quoting the 'limit string' prevents variable expansion #+ within the body of the above 'here document.' # This permits outputting literal strings in the output file. if [ f "$OUTFILE" ] then chmod 755 $OUTFILE # Make the generated file executable. else echo "Problem in creating file: \"$OUTFILE\"" fi # This method can also be used for generating #+ C programs, Perl programs, Python programs, Makefiles, #+ and the like. exit 0

It is possible to set a variable from the output of a here document.

variable=$(cat <<SETVAR This variable runs over multiple lines. SETVAR) echo "$variable"

Chapter 18. Here Documents

322

Advanced BashScripting Guide A here document can supply input to a function in the same script.

Example 189. Here documents and functions

#!/bin/bash # herefunction.sh GetPersonalData () { read firstname read lastname read address read city read state read zipcode } # This certainly looks like an interactive function, but...

# Supply input to the above function. GetPersonalData <<RECORD001 Bozo Bozeman 2726 Nondescript Dr. Baltimore MD 21226 RECORD001

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.

Example 1810. "Anonymous" Here Document

#!/bin/bash : <<TESTVARIABLES ${HOSTNAME?}${USER?}${MAIL?} TESTVARIABLES exit 0

# Print error message if one of the variables not set.

A variation of the above technique permits "commenting out" blocks of code. Example 1811. Commenting out a block of code
#!/bin/bash

Chapter 18. Here Documents

323

Advanced BashScripting Guide

# 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 echo "Exit value of above \"COMMENTBLOCK\" is $?." # No error shown. # 0

# #+ # #+

The above technique also comes in useful for commenting out a block of working code for debugging purposes. This saves having to put a "#" at the beginning of each line, then having to go back and delete each "#" later.

: <<DEBUGXXX for file in * do cat "$file" done DEBUGXXX exit 0

Yet another twist of this nifty trick makes "selfdocumenting" scripts possible. Example 1812. A selfdocumenting script
#!/bin/bash # selfdocument.sh: selfdocumenting script # Modification of "colm.sh". DOC_REQUEST=70 if [ "$1" = "h" o "$1" = "help" ] # Request help. then echo; echo "Usage: $0 [directoryname]"; echo sed silent e '/DOCUMENTATIONXX$/,/^DOCUMENTATIONXX$/p' "$0" | sed e '/DOCUMENTATIONXX$/d'; exit $DOC_REQUEST; fi

: <<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

Chapter 18. Here Documents

324

Advanced BashScripting Guide

directory="$1" fi echo "Listing of "$directory":"; echo (printf "PERMISSIONS LINKS OWNER GROUP SIZE MONTH DAY HH:MM PROGNAME\n" \ ; ls l "$directory" | sed 1d) | column t exit 0

Using a cat script is an alternate way of accomplishing this.

DOC_REQUEST=70 if [ "$1" = "h" o "$1" = "help" ] # Request help. then # Use a "cat script" . . . cat <<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 exit $DOC_REQUEST fi

See also Example A28 for one more excellent example of a selfdocumenting script. Here documents create temporary files, but these files are deleted after opening and are not accessible to any other process.
bash$ bash c 'lsof a p $$ d0' << EOF > EOF lsof 1213 bozo 0r REG 3,5 0 30386 /tmp/t12130sh (deleted)

Some utilities will not work inside a here document. The closing limit string, on the final line of a here document, must start in the first character position. There can be no leading whitespace. Trailing whitespace after the limit string likewise causes unexpected behavior. The whitespace prevents the limit string from being recognized.
#!/bin/bash echo "" cat <<LimitString echo "This is line 1 of the message inside the here document." echo "This is line 2 of the message inside the here document." echo "This is the final line of the message inside the here document." LimitString #^^^^Indented limit string. Error! This script will not behave as expected. echo "" # These comments are outside the 'here document', #+ and should not echo. echo "Outside the here document."

Chapter 18. Here Documents

325

Advanced BashScripting Guide

exit 0 echo "This line had better not echo." # Follows an 'exit' command.

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.

18.1. Here Strings

A here string can be considered as a strippeddown form of a here document. It consists of nothing more than COMMAND <<<$WORD, where $WORD is expanded and fed to the stdin of COMMAND. As a simple example, consider this alternative to the echogrep construction.
# Instead of: if echo "$VAR" | grep q txt # etc.

# if [[ $VAR = *txt* ]]

# Try: if grep q "txt" <<< "$VAR" then echo "$VAR contains the substring sequence \"txt\"" fi # Thank you, Sebastian Kaminski, for the suggestion.

Or, in combination with read:

String="This is a string of words." read r a Words <<< "$String" # The a option to "read" #+ assigns the resulting values to successive members of an array. echo echo echo echo echo echo echo "First word in String is: "Second word in String is: "Third word in String is: "Fourth word in String is: "Fifth word in String is: "Sixth word in String is: "Seventh word in String is: ${Words[0]}" ${Words[1]}" ${Words[2]}" ${Words[3]}" ${Words[4]}" ${Words[5]}" ${Words[6]}" # # # # # # # # This is a string of words. (null) Past end of $String.

# Thank you, Francisco Lobo, for the suggestion.

Example 1813. Prepending a line to a file

#!/bin/bash # prepend.sh: Add text at beginning of file. # # Example contributed by Kenny Stauffer, #+ and slightly modified by document author.

E_NOSUCHFILE=65 read p "File: " file if [ ! e "$file" ] # p arg to 'read' displays prompt.

Chapter 18. Here Documents

326

Advanced BashScripting Guide

then # Bail out if no such file. echo "File $file not found." exit $E_NOSUCHFILE fi read p "Title: " title cat $file <<<$title > $file.new echo "Modified file is $file.new" exit 0 # from 'man bash': # Here Strings # A variant of here documents, the format is: # # <<<word # # The word is expanded and supplied to the command on its standard input.

Example 1814. Parsing a mailbox

#!/bin/bash # Script by Francisco Lobo, #+ and slightly modified and commented by ABS Guide author. # Used in ABS Guide with permission. (Thank you!) # This script will not run under Bash versions < 3.0.

E_MISSING_ARG=67 if [ z "$1" ] then echo "Usage: $0 mailboxfile" exit $E_MISSING_ARG fi mbox_grep() # Parse mailbox file. { declare i body=0 match=0 declare a date sender declare mail header value

# #

while IFS= read r mail ^^^^ Reset $IFS. Otherwise "read" will strip leading & trailing space from its input. do if [[ $mail =~ "^From " ]] then (( body = 0 )) (( match = 0 )) unset date # Match "From" field in message. # "Zero out" variables.

elif (( body )) then (( match )) # echo "$mail" # Uncomment above line if you want entire body of message to display.

Chapter 18. Here Documents

327

Advanced BashScripting Guide

elif [[ $mail ]]; then IFS=: read r header value <<< "$mail" # ^^^ "here string" case "$header" in [Ff][Rr][Oo][Mm] ) [[ $value =~ "$2" ]] && (( match++ )) ;; # Match "From" line. [Dd][Aa][Tt][Ee] ) read r a date <<< "$value" ;; # ^^^ # Match "Date" line. [Rr][Ee][Cc][Ee][Ii][Vv][Ee][Dd] ) read r a sender <<< "$value" ;; # ^^^ # Match IP Address (may be spoofed). esac else (( body++ )) (( match )) && echo "MESSAGE ${date:+of: ${date[*]} }" # Entire $date array ^ echo "IP address of sender: ${sender[1]}" # Second field of "Received" line ^ fi

done < "$1" # Redirect stdout of file into loop. }

mbox_grep "$1" exit $?

# Send mailbox file to function.

# Exercises: # # 1) Break the single function, above, into multiple functions, #+ for the sake of readability. # 2) Add additional parsing to the script, checking for various keywords.

$ mailbox_grep.sh scam_mail > MESSAGE of Thu, 5 Jan 2006 08:00:56 0500 (EST) > IP address of sender: 196.3.62.4

Exercise: Find other uses for here strings.

Chapter 18. Here Documents

328

Chapter 19. I/O Redirection

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 31 and Example 32) and sending it as input to another file, command, program, or script. Each open file gets assigned a file descriptor. [69] 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. [70] This simplifies restoration to normal after complex redirection and reshuffling (see Example 191).

COMMAND_OUTPUT > # Redirect stdout to a file. # Creates the file if not present, otherwise overwrites it. ls lR > dirtree.list # Creates a file containing a listing of the directory tree. : > filename # The > truncates file "filename" to zero length. # If file not present, creates zerolength 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 zerolength 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.

# Singleline redirection commands (affect only the line they are on): # 1>filename # Redirect 1>>filename # Redirect 2>filename # Redirect 2>>filename # Redirect &>filename # Redirect

stdout to file "filename." and append stdout to file "filename." stderr to file "filename." and append stderr to file "filename." both stdout and stderr to file "filename."

M>N # "M" is a file descriptor, which defaults to 1, if not explicitly set. # "N" is a filename. # File descriptor "M" is redirect to file "N." M>&N # "M" is a file descriptor, which defaults to 1, if not set. # "N" is another file descriptor.

Chapter 19. I/O Redirection

329

Advanced BashScripting Guide

#============================================================================== # Redirecting stdout, one line at a time. LOGFILE=script.log echo "This statement is sent to the log file, \"$LOGFILE\"." 1>$LOGFILE echo "This statement is appended to \"$LOGFILE\"." 1>>$LOGFILE echo "This statement is also appended to \"$LOGFILE\"." 1>>$LOGFILE echo "This statement is echoed to stdout, and will not appear in \"$LOGFILE\"." # These redirection commands automatically "reset" after each line.

# Redirecting stderr, one line at a time. ERRORFILE=script.errors bad_command1 2>$ERRORFILE bad_command2 2>>$ERRORFILE bad_command3 # Error message sent to $ERRORFILE. # Error message appended to $ERRORFILE. # Error message echoed to stderr, #+ and does not appear in $ERRORFILE. # These redirection commands also automatically "reset" after each line. #==============================================================================

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 searchword <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. echo n . >&3 # Write a decimal point there. exec 3>& # Close fd 3. cat File # ==> 1234.67890 # Random access, by golly.

Chapter 19. I/O Redirection

330

Advanced BashScripting Guide

| # 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 > resultfile # Sorts the output of all the .txt files and deletes duplicate lines, # finally saves results to "resultfile".

Multiple instances of input and output redirection and/or pipes can be combined in a single command line.
command < inputfile > outputfile command1 | command2 | command3 > outputfile

See Example 1528 and Example A15. Multiple output streams may be redirected to one file.
ls # # #+ yz >> command.log 2>&1 Capture result of illegal options "yz" in file "command.log." Because stderr is redirected to the file, any error messages will also be there.

# Note, however, that the following does *not* give the same result. ls yz 2>&1 >> command.log # Outputs an error message and does not write to file. # If redirecting both stdout and stderr, #+ the order of the commands makes a difference.

Closing File Descriptors n<& Close input file descriptor n. 0<&, <& Close stdin. n>& Close output file descriptor n. 1>&, >& Close stdout. Child processes inherit open file descriptors. This is why pipes work. To prevent an fd from being inherited, close it.
# Redirecting only stderr to a pipe. exec 3>&1 ls l 2>&1 >&3 3>& | grep bad 3>& # ^^^^ ^^^^ exec 3>& # Thanks, S.C. # Save current "value" of stdout. # Close fd 3 for 'grep' (but not 'ls'). # Now close it for the remainder of the script.

For a more detailed introduction to I/O redirection see Appendix E.

Chapter 19. I/O Redirection

331

Advanced BashScripting Guide

19.1. Using exec

An exec <filename command redirects stdin to a file. From that point on, all stdin comes from that file, rather than its normal source (usually keyboard input). This provides a method of reading a file line by line and possibly parsing each line of input using sed and/or awk.

Example 191. Redirecting stdin using exec

#!/bin/bash # Redirecting stdin using 'exec'.

exec 6<&0

# Link file descriptor #6 with stdin. # Saves stdin. # stdin replaced by file "datafile" # Reads first line of file "datafile". # Reads second line of file "datafile."

exec < datafile read a1 read a2 echo echo echo echo echo

"Following lines read from file." "" $a1 $a2

echo; echo; echo exec 0<&6 6<& # Now restore stdin from fd #6, where it had been saved, #+ and close fd #6 ( 6<& ) to free it for other processes to use. # # <&6 6<& also works. echo read echo echo echo echo exit 0 n "Enter data " b1 # Now "read" functions as expected, reading from normal stdin. "Input read from stdin." "" "b1 = $b1"

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. exec N > filename affects the entire script or current shell. Redirection in the PID of the script or shell from that point on has changed. However . . . N > filename affects only the newlyforked process, not the entire script or shell. Thank you, Ahmed Darwish, for pointing this out. Example 192. Redirecting stdout using exec Chapter 19. I/O Redirection 332

Advanced BashScripting Guide

#!/bin/bash # reassignstdout.sh LOGFILE=logfile.txt exec 6>&1 # Link file descriptor #6 with stdout. # Saves stdout. # stdout replaced with file "logfile.txt".

exec > $LOGFILE

# # # All output from commands in this block sent to file $LOGFILE. echo n "Logfile: " date echo "" echo echo "Output of \"ls al\" command" echo ls al echo; echo echo "Output of \"df\" command" echo df # # 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 193. 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 [ ! then echo echo exit fi r "$1" ] # Is specified input file readable?

"Can't read from input file!" "Usage: $0 inputfile outputfile" $E_FILE_ACCESS # Will exit with same error #+ even if input file ($1) not specified (why?).

if [ z "$2" ] then echo "Need to specify output file." echo "Usage: $0 inputfile outputfile" exit $E_WRONG_ARGS fi

Chapter 19. I/O Redirection

333

Advanced BashScripting Guide

exec 4<&0 exec < $1 exec 7>&1 exec > $2

# Will read from input file.

# Will write to output file. # Assumes output file writable (add check?).

# cat | tr az AZ # Uppercase conversion. # ^^^^^ # Reads from stdin. # ^^^^^^^^^^ # Writes to stdout. # However, both stdin and stdout were redirected. # exec 1>&7 7>& exec 0<&4 4<& # Restore stout. # Restore stdin.

# After restoration, the following line prints to stdout as expected. echo "File \"$1\" written to \"$2\" as uppercase conversion." exit 0

I/O redirection is a clever way of avoiding the dreaded inaccessible variables within a subshell problem.

Example 194. Avoiding a subshell

#!/bin/bash # avoidsubshell.sh # Suggested by Matthew Walker. Lines=0 echo cat myfile.txt | while read line; do { echo $line (( Lines++ ));

# Incremented values of this variable #+ inaccessible outside loop. # Subshell problem.

} done echo "Number of lines read = $Lines" # 0 # Wrong!

echo ""

exec 3<> myfile.txt while read line <&3 do { echo "$line" (( Lines++ ));

# Incremented values of this variable #+ accessible outside loop. # No subshell, no problem.

} done exec 3>&

Chapter 19. I/O Redirection

334

Advanced BashScripting Guide

echo "Number of lines read = $Lines" echo exit 0 # Lines below not seen by script. $ cat myfile.txt Line Line Line Line Line Line Line Line 1. 2. 3. 4. 5. 6. 7. 8. # 8

19.2. Redirecting Code Blocks

Blocks of code, such as while, until, and for loops, even if/then test blocks can also incorporate redirection of stdin. Even a function may use this form of redirection (see Example 2311). The < operator at the end of the code block accomplishes this.

Example 195. Redirected while loop

#!/bin/bash # redir2.sh 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 while [ "$name" != Smith ] do read name echo $name let "count += 1" done <"$Filename" # ^^^^^^^^^^^^ # Why is variable $name in quotes? # Reads from $Filename, rather than stdin.

# Redirects stdin to file $Filename.

echo; echo "$count names read"; echo exit 0 # Note that in some older shell scripting languages, #+ the redirected loop would run as a subshell.

Chapter 19. I/O Redirection

335

Advanced BashScripting Guide

# # #+ # Therefore, $count would return 0, the initialized value outside the loop. Bash and ksh avoid starting a subshell *whenever possible*, so that this script, for example, runs correctly. (Thanks to Heiner Steven for pointing this out.)

# However . . . # Bash *can* sometimes start a subshell in a PIPED "whileread" loop, #+ as distinct from a REDIRECTED "while" loop. abc=hi echo e "1\n2\n3" | while read l do abc="$l" echo $abc done echo $abc # Thanks, Bruno de Oliveira Schneider, for demonstrating this #+ with the above snippet of code. # And, thanks, Brian Onn, for correcting an annotation error.

Example 196. Alternate form of redirected while loop

#!/bin/bash # This is an alternate form of the preceding script. # Suggested by Heiner Steven #+ as a workaround in those situations when a redirect loop #+ runs as a subshell, and therefore variables inside the loop # +do not keep their values upon loop termination.

if [ z "$1" ] then Filename=names.data else Filename=$1 fi

# Default, if no filename specified.

exec 3<&0 exec 0<"$Filename" count=0 echo

# Save stdin to file descriptor 3. # Redirect standard input.

while [ "$name" != Smith ] do read name # Reads from redirected stdin ($Filename). echo $name let "count += 1" done # Loop reads from file $Filename #+ because of line 20. # The original version of this script terminated the "while" loop with #+ done <"$Filename" # Exercise: # Why is this unnecessary?

Chapter 19. I/O Redirection

336

Advanced BashScripting Guide

exec 0<&3 exec 3<& # Restore old stdin. # Close temporary fd 3.

echo; echo "$count names read"; echo exit 0

Example 197. Redirected until loop

#!/bin/bash # Same as previous example, but with "until" loop. if [ z "$1" ] then Filename=names.data else Filename=$1 fi # while [ "$name" != Smith ] until [ "$name" = Smith ] do read name echo $name done <"$Filename" # ^^^^^^^^^^^^

# Default, if no filename specified.

# Change

!=

to =.

# Reads from $Filename, rather than stdin. # Redirects stdin to file $Filename.

# Same results as with "while" loop in previous example. exit 0

Example 198. Redirected for loop

#!/bin/bash if [ z "$1" ] then Filename=names.data else Filename=$1 fi

# Default, if no filename specified.

line_count=`wc $Filename | awk '{ print $1 }'` # Number of lines in target file. # # Very contrived and kludgy, nevertheless shows that #+ it's possible to redirect stdin within a "for" loop... #+ if you're clever enough. # # More concise is line_count=$(wc l < "$Filename")

for name in `seq $line_count` # while [ "$name" != Smith ] do read name echo $name if [ "$name" = Smith ] then break

# Recall that "seq" prints sequence of numbers. more complicated than a "while" loop # Reads from $Filename, rather than stdin. # Need all this extra baggage here.

Chapter 19. I/O Redirection

337

Advanced BashScripting Guide

fi done <"$Filename" # ^^^^^^^^^^^^ exit 0 # Redirects stdin to file $Filename.

We can modify the previous example to also redirect the output of the loop.

Example 199. Redirected for loop (both stdin and stdout redirected)
#!/bin/bash if [ z "$1" ] then Filename=names.data else Filename=$1 fi Savefile=$Filename.new FinalName=Jonah

# Default, if no filename specified.

# Filename to save results in. # Name to terminate "read" on. # Number of lines in target file.

line_count=`wc $Filename | awk '{ print $1 }'`

for name in `seq $line_count` do read name echo "$name" if [ "$name" = "$FinalName" ] then break fi done < "$Filename" > "$Savefile" # ^^^^^^^^^^^^^^^^^^^^^^^^^^^ exit 0

# Redirects stdin to file $Filename, and saves it to backup file.

Example 1910. Redirected if/then test

#!/bin/bash if [ z "$1" ] then Filename=names.data else Filename=$1 fi TRUE=1 if [ "$TRUE" ] then read name echo $name fi <"$Filename" # ^^^^^^^^^^^^ # if true and if : also work.

# Default, if no filename specified.

# Reads only first line of file. # An "if/then" test has no way of iterating unless embedded in a loop.

Chapter 19. I/O Redirection

338

Advanced BashScripting Guide

exit 0

Example 1911. Data file names.data for above examples

Aristotle Belisarius Capablanca Euler Goethe Hamurabi Jonah Laplace Maroczy Purcell Schmidt Semmelweiss Smith Turing Venn Wilson ZnoskoBorowski # This is a data file for #+ "redir2.sh", "redir3.sh", "redir4.sh", "redir4a.sh", "redir5.sh".

Redirecting the stdout of a code block has the effect of saving its output to a file. See Example 32. Here documents are a special case of redirected code blocks. That being the case, it should be possible to feed the output of a here document into the stdin for a while loop.
# This example by Albert Siersema # Used with permission (thanks!). function doesOutput() # Could be an external command too, of course. # Here we show you can use a function as well. { ls al *.jpg | awk '{print $5,$9}' }

nr=0 totalSize=0

# We want the while loop to be able to manipulate these and #+ to be able to see the changes after the while finished.

while read fileSize fileName ; do echo "$fileName is $fileSize bytes" let nr++ totalSize=$((totalSize+fileSize)) # Or: "let totalSize+=fileSize" done<<EOF $(doesOutput) EOF echo "$nr files totaling $totalSize bytes"

Chapter 19. I/O Redirection

339

Advanced BashScripting Guide

19.3. Applications
Clever use of I/O redirection permits parsing and stitching together snippets of command output (see Example 147). This permits generating report and log files.

Example 1912. Logging events

#!/bin/bash # logevents.sh # Author: Stephane Chazelas. # Used in ABS Guide with permission. # Event logging to a file. # Must be run as root (for write access in /var/log). ROOT_UID=0 E_NOTROOT=67 # Only users with $UID 0 have root privileges. # Nonroot exit error.

if [ "$UID" ne "$ROOT_UID" ] then echo "Must be root to run this script." exit $E_NOTROOT fi

FD_DEBUG1=3 FD_DEBUG2=4 FD_DEBUG3=5 # === Uncomment one of the two lines below to activate script. === # LOG_EVENTS=1 # LOG_VARS=1

log() # Writes time and date to log file. { echo "$(date) $*" >&7 # This *appends* the date to the file. # ^^^^^^^ command substitution # See below. }

case $LOG_LEVEL in 1) exec 3>&2 2) exec 3>&2 3) exec 3>&2 *) exec 3> /dev/null esac

4> /dev/null 4>&2 4>&2 4> /dev/null

5> /dev/null;; 5> /dev/null;; 5>&2;; 5> /dev/null;;

FD_LOGVARS=6 if [[ $LOG_VARS ]] then exec 6>> /var/log/vars.log else exec 6> /dev/null fi FD_LOGEVENTS=7 if [[ $LOG_EVENTS ]]

# Bury output.

Chapter 19. I/O Redirection

340

Advanced BashScripting Guide

then # exec 7 >(exec gawk '{print strftime(), $0}' >> /var/log/event.log) # Above line fails in versions of Bash more recent than 2.04. Why? exec 7>> /var/log/event.log # Append to "event.log". log # Write time and date. else exec 7> /dev/null # Bury output. fi echo "DEBUG3: beginning" >&${FD_DEBUG3} ls l >&5 2>&4 echo "Done" # command1 >&5 2>&4 # command2

echo "sending mail" >&${FD_LOGEVENTS} # Writes "sending mail" to file descriptor #7.

exit 0

Chapter 19. I/O Redirection

341

Chapter 20. Subshells

Running a shell script launches a new process, a subshell.

Definition: A subshell is a process launched by a shell (or shell script). A subshell is a separate instance of the command processor the shell that gives you the prompt at the console or in an xterm window. Just as your commands are interpreted at the command line prompt, similarly does a script batchprocess a list of commands. Each shell script running is, in effect, a subprocess (child process) of the parent shell. A shell script can itself launch subprocesses. These subshells let the script do parallel processing, in effect executing multiple subtasks simultaneously.
#!/bin/bash # subshelltest.sh ( # Inside parentheses, and therefore a subshell . . . while [ 1 ] # Endless loop. do echo "Subshell running . . ." done ) # Script will run forever, #+ or at least until terminated by a CtlC. exit $? # End of script (but will never get here).

Now, run the script: sh subshelltest.sh And, while the script is running, from a different xterm: ps ef | grep subshelltest.sh UID 500 500 PID 2698 2699 ^^^^ Analysis: PID 2698, the script, launched PID 2699, the subshell. Note: The "UID ..." line would be filtered out by the "grep" command, but is shown here for illustrative purposes. PPID C STIME TTY 2502 0 14:26 pts/4 2698 21 14:26 pts/4 TIME CMD 00:00:00 sh subshelltest.sh 00:00:24 sh subshelltest.sh

In general, an external command in a script forks off a subprocess, [71] whereas a Bash builtin does not. For this reason, builtins execute more quickly than their external command equivalents. Command List in Parentheses

Chapter 20. Subshells

342

Advanced BashScripting Guide ( command1; command2; command3; ... ) A command list embedded between parentheses runs as a subshell. 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.

Example 201. Variable scope in a subshell

#!/bin/bash # subshell.sh echo echo "We are outside the subshell." echo "Subshell level OUTSIDE subshell = $BASH_SUBSHELL" # Bash, version 3, adds the new $BASH_SUBSHELL variable. echo; echo outer_variable=Outer global_variable= # Define global variable for "storage" of #+ value of subshell variable. ( echo "We are inside the subshell." echo "Subshell level INSIDE subshell = $BASH_SUBSHELL" inner_variable=Inner echo "From inside subshell, \"inner_variable\" = $inner_variable" echo "From inside subshell, \"outer\" = $outer_variable" global_variable="$inner_variable" ) echo; echo echo "We are outside the subshell." echo "Subshell level OUTSIDE subshell = $BASH_SUBSHELL" 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 "From main body of shell, \"inner_variable\" = $inner_variable" # $inner_variable will show as blank (uninitialized) #+ because variables defined in a subshell are "local variables". # Is there a remedy for this? echo "global_variable = "$global_variable"" # Why doesn't this work? # Will this allow "exporting" #+ a subshell variable?

echo exit 0 # Question:

Chapter 20. Subshells

343

Advanced BashScripting Guide

# # #+ #+ Once having exited a subshell, is there any way to reenter that very same subshell to modify or access the subshell variables?

See also Example 312.

While the $BASH_SUBSHELL internal variable indicates the nesting level of a subshell, the $SHLVL variable shows no change within a subshell.
echo " \$BASH_SUBSHELL outside subshell = $BASH_SUBSHELL" # 0 ( echo " \$BASH_SUBSHELL inside subshell = $BASH_SUBSHELL" ) # 1 ( ( echo " \$BASH_SUBSHELL inside nested subshell = $BASH_SUBSHELL" ) ) # 2 # ^ ^ *** nested *** ^ ^ echo echo " \$SHLVL outside subshell = $SHLVL" ( echo " \$SHLVL inside subshell = $SHLVL" ) # 3 # 3 (No change!)

Directory changes made in a subshell do not carry over to the parent shell.

Example 202. List User Profiles

#!/bin/bash # allprofs.sh: print all user profiles # This script written by Heiner Steven, and modified by the document author. FILE=.bashrc # File containing user profile, #+ was ".profile" in original script.

for home in `awk F: '{print $6}' /etc/passwd` do [ d "$home" ] || continue # If no home directory, go to next. [ r "$home" ] || continue # If not readable, go to next. (cd $home; [ e $FILE ] && less $FILE) done # When script terminates, there is no need to 'cd' back to original directory, #+ because 'cd $home' takes place in a subshell. exit 0

A subshell may be used to set up a "dedicated environment" for a command group.

COMMAND1 COMMAND2 COMMAND3 ( IFS=: PATH=/bin unset TERMINFO set C shift 5 COMMAND4 COMMAND5 exit 3 # Only exits the subshell! )

Chapter 20. Subshells

344

Advanced BashScripting Guide

# The parent shell has not been affected, and the environment is preserved. COMMAND6 COMMAND7

As seen here, the exit command only terminates the subshell in which it is running, not the parent shell or script. One application of such a "dedicated environment" is testing whether a variable is defined.
if (set u; : $variable) 2> /dev/null then echo "Variable is set." fi # Variable has been set in current script, #+ or is an an internal Bash variable, #+ or is present in environment (has been exported). # # # # Could also be written [[ ${variablex} != x || ${variabley} != y ]] or [[ ${variablex} != x$variable ]] or [[ ${variable+x} = x ]] or [[ ${variablex} != x ]]

Another application is checking for a lock file:

if (set C; : > lock_file) 2> /dev/null then : # lock_file didn't exist: no user running the script else echo "Another user is already running that script." exit 65 fi # Code snippet by Stphane Chazelas, #+ with modifications by Paulo Marcel Coelho Aragao.

+ Processes may execute in parallel within different subshells. This permits breaking a complex task into subcomponents processed concurrently.

Example 203. Running parallel processes in subshells

(cat list1 list2 list3 | sort | uniq > list123) & (cat list4 list5 list6 | sort | uniq > list456) & # Merges and sorts both sets of lists simultaneously. # Running in background ensures parallel execution. # # Same effect as # cat list1 list2 list3 | sort | uniq > list123 & # cat list4 list5 list6 | sort | uniq > list456 & wait # Don't execute the next command until subshells finish.

diff list123 list456

Redirecting I/O to a subshell uses the "|" pipe operator, as in ls al | (command). A command block between curly braces does not launch a subshell. { command1; command2; command3; . . . commandN; } Chapter 20. Subshells 345

Advanced BashScripting Guide

Chapter 20. Subshells

346

Chapter 21. Restricted Shells

Disabled commands in restricted shells 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. Using cd to change the working directory. Changing the values of the $PATH, $SHELL, $BASH_ENV, or $ENV environmental variables. Reading or changing the $SHELLOPTS, shell environmental options. Output redirection. Invoking commands containing one or more /'s. Invoking exec to substitute a different process for the shell. Various other commands that would enable monkeying with or attempting to subvert the script for an unintended purpose. Getting out of restricted mode within the script.

Example 211. Running a script in restricted mode

#!/bin/bash # Starting the script with "#!/bin/bash r" #+ runs entire script in restricted mode. echo echo "Changing directory." cd /usr/local echo "Now in `pwd`" echo "Coming back home." cd echo "Now in `pwd`" echo # Everything up to here in normal, unrestricted mode. set r # set restricted has same effect. echo "==> Now in restricted mode. <==" echo echo echo "Attempting directory change in restricted mode." cd .. echo "Still in `pwd`" echo echo echo "\$SHELL = $SHELL" echo "Attempting to change shell in restricted mode." SHELL="/bin/ash" echo echo "\$SHELL= $SHELL"

Chapter 21. Restricted Shells

347

Advanced BashScripting Guide

echo echo echo "Attempting to redirect output in restricted mode." ls l /usr/bin > bin.files ls l bin.files # Try to list attempted file creation effort. echo exit 0

Chapter 21. Restricted Shells

348

Chapter 22. Process Substitution

Process substitution is the counterpart to command substitution. Command substitution sets a variable to the result of a command, as in dir_contents=`ls al` or xref=$( grep word datafile). Process substitution feeds the output of a process to another process (in other words, it sends the results of a command to another command). Command substitution template command within parentheses >(command) <(command) These initiate process substitution. This uses /dev/fd/<n> files to send the results of the process within parentheses to another process. [72] There is no space between the the "<" or ">" and the parentheses. Space there would give an error message.
bash$ echo >(true) /dev/fd/63 bash$ echo <(true) /dev/fd/63

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.) Process substitution can compare the output of two different commands, or even the output of different options to the same command.
bash$ comm <(ls l) <(ls al) total 12 rwrwr 1 bozo bozo 78 Mar 10 12:58 File0 rwrwr 1 bozo bozo 42 Mar 10 12:58 File2 rwrwr 1 bozo bozo 103 Mar 10 12:58 t2.sh total 20 drwxrwxrwx 2 bozo bozo 4096 Mar 10 18:10 . drwx 72 bozo bozo 4096 Mar 10 17:58 .. rwrwr 1 bozo bozo 78 Mar 10 12:58 File0 rwrwr 1 bozo bozo 42 Mar 10 12:58 File2 rwrwr 1 bozo bozo 103 Mar 10 12:58 t2.sh

Using process substitution to compare the contents of two directories (to see which filenames are in one, but not the other):
diff <(ls $first_directory) <(ls $second_directory)

Some other usages and uses of process substitution:

cat <(ls l) # Same as

ls l | cat

Chapter 22. Process Substitution

349

Advanced BashScripting Guide

sort k 9 <(ls l /bin) <(ls l /usr/bin) <(ls l /usr/X11R6/bin) # Lists all the files in the 3 main 'bin' directories, and sorts by filename. # Note that three (count 'em) distinct commands are fed to 'sort'.

diff <(command1) <(command2)

# Gives difference in command output.

tar cf >(bzip2 c > file.tar.bz2) $directory_name # Calls "tar cf /dev/fd/?? $directory_name", and "bzip2 c > file.tar.bz2". # # Because of the /dev/fd/<n> system feature, # the pipe between both commands does not need to be named. # # This can be emulated. # bzip2 c < pipe > file.tar.bz2& tar cf pipe $directory_name rm pipe # or exec 3>&1 tar cf /dev/fd/4 $directory_name 4>&1 >&3 3>& | bzip2 c > file.tar.bz2 3>& exec 3>&

# Thanks, Stphane Chazelas

A reader sent in the following interesting example of process substitution.

# Script fragment taken from SuSE distribution: while read des what mask iface; do # Some commands ... done < <(route n)

# To test it, let's make it do something. while read des what mask iface; do echo $des $what $mask $iface done < <(route n) # # # # 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

# As Stphane Chazelas points out, an easiertounderstand equivalent is: route n | while read des what mask iface; do # Variables set from output of pipe. echo $des $what $mask $iface done # This yields the same output as above. # However, as Ulrich Gayer points out . . . #+ this simplified equivalent uses a subshell for the while loop, #+ and therefore the variables disappear when the pipe terminates.

# However, Filip Moritz comments that there is a subtle difference #+ between the above two examples, as the following shows. (

Chapter 22. Process Substitution

350

Advanced BashScripting Guide

route n | while read x; do ((y++)); done echo $y # $y is still unset while read x; do ((y++)); done < <(route n) echo $y # $y has the number of lines of output of route n ) More generally spoken ( : | x=x # seems to start a subshell like : | ( x=x ) # while x=x < <(:) # does not ) # This is useful, when parsing csv and the like. # That is, in effect, what the original SuSE code fragment does.

Chapter 22. Process Substitution

351

Chapter 23. Functions

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... } A function may be "compacted" into a single line.
fun () { echo "This is a function"; echo; }

In this case, however, a semicolon must follow the final command in the function.
fun () { echo "This is a function"; echo } # Error!

Functions are called, triggered, simply by invoking their names.

Example 231. Simple functions

#!/bin/bash JUST_A_SECOND=1 funky () { # This is about as simple as functions get. echo "This is a funky function." echo "Now exiting funky function." } # Function declaration must precede call.

fun () { # A somewhat more complex function. i=0

Chapter 23. Functions

352

Advanced BashScripting Guide

REPEATS=30 echo echo "And now the fun really begins." echo sleep $JUST_A_SECOND # Hey, wait a second! while [ $i lt $REPEATS ] do echo "FUNCTIONS>" echo "<ARE" echo "<FUN>" echo let "i+=1" done } # Now, call the functions. funky fun 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. declare f f1 f1 # However... # This doesn't help either. # Still an error message.

f1 () { echo "Calling function \"f2\" from within function \"f1\"." f2 } f2 () { echo "Function \"f2\"." } f1 # Function "f2" is not actually called until this point, #+ although it is referenced before its definition. # This is permissible. # 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\"." }

Chapter 23. Functions

353

Advanced BashScripting Guide

} f2 # # Gives an error message. Even a preceding "declare f f2" wouldn't help.

echo f1 f2 # Does nothing, since calling "f1" does not automatically call "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.
ls l | foo() { echo "foo"; } # Permissible, but useless.

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.

# Something like this might be useful in some contexts. NO_EXIT=1 # Will enable function definition below. [[ $NO_EXIT eq 1 ]] && exit() { true; } # Function definition in an "andlist". # If $NO_EXIT is 1, declares "exit ()". # This disables the "exit" builtin by aliasing it to "true". exit # Invokes "exit ()" function, not "exit" builtin.

# Or, similarly: filename=file1 [ f "$filename" ] && foo () { rm f "$filename"; echo "File "$filename" deleted."; } || foo () { echo "File "$filename" not found."; touch bar; } foo # Thanks, S.C. and Christopher Head

23.1. Complex Functions and Function Complexities

Functions may process arguments passed to them and return an exit status to the script for further processing.
function_name $arg1 $arg2

Chapter 23. Functions

354

Advanced BashScripting Guide The function refers to the passed arguments by position (as if they were positional parameters), that is, $1, $2, and so forth.

Example 232. Function Taking Parameters

#!/bin/bash # Functions and parameters DEFAULT=default func2 () { if [ z "$1" ] then echo "Parameter #1 is zero length." else echo "Param #1 is \"$1\"." fi variable=${1$DEFAULT} echo "variable = $variable" # Default param value.

# Is parameter #1 zero length? # Or no parameter passed.

# #+ # # #+

What does parameter substitution show? It distinguishes between no param and a null param.

if [ "$2" ] then echo "Parameter #2 is \"$2\"." fi return 0 } echo echo "Nothing passed." func2 echo

# Called with no params

echo "Zerolength parameter passed." func2 "" # Called with zerolength param echo echo "Null parameter passed." func2 "$uninitialized_param" echo

# Called with uninitialized param

echo "One parameter passed." func2 first # Called with one param echo echo "Two parameters passed." func2 first second # Called with two params echo echo "\"\" \"second\" passed." func2 "" second # Called with zerolength first parameter echo # and ASCII string as a second one. exit 0

Chapter 23. Functions

355

Advanced BashScripting Guide The shift command works on arguments passed to functions (see Example 3315). But, what about commandline arguments passed to the script? Does a function see them? Well, let's clear up the confusion.

Example 233. Functions and commandline args passed to the script

#!/bin/bash # funccmdlinearg.sh # Call this script with a commandline argument, #+ something like $0 arg1.

func () { echo "$1" } echo "First call to function: no arg passed." echo "See if commandline arg is seen." func # No! Commandline arg not seen. echo "============================================================" echo echo "Second call to function: commandline arg passed explicitly." func $1 # Now it's seen! exit 0

In contrast to certain other programming languages, shell scripts normally pass only value parameters to functions. Variable names (which are actually pointers), if passed as parameters to functions, will be treated as string literals. Functions interpret their arguments literally. Indirect variable references (see Example 342) provide a clumsy sort of mechanism for passing variable pointers to functions.

Example 234. Passing an indirect reference to a function

#!/bin/bash # indfunc.sh: Passing an indirect reference to a function. echo_var () { echo "$1" } message=Hello Hello=Goodbye echo_var "$message" # Hello # Now, let's pass an indirect reference to the function. echo_var "${!message}" # Goodbye echo ""

Chapter 23. Functions

356

Advanced BashScripting Guide

# What happens if we change the contents of "hello" variable? Hello="Hello, again!" echo_var "$message" # Hello echo_var "${!message}" # Hello, again! exit 0

The next logical question is whether parameters can be dereferenced after being passed to a function.

Example 235. Dereferencing a parameter passed to a function

#!/bin/bash # dereference.sh # Dereferencing parameter passed to a function. # Script by Bruce W. Clare. dereference () { y=\$"$1" echo $y

# Name of variable. # $Junk

x=`eval "expr \"$y\" "` echo $1=$x eval "$1=\"Some Different Text \"" } Junk="Some Text" echo $Junk "before" dereference Junk echo $Junk "after" exit 0

# Assign new value.

# Some Text before

# Some Different Text after

Example 236. Again, dereferencing a parameter passed to a function

#!/bin/bash # refparams.sh: Dereferencing a parameter passed to a function. # (Complex Example) ITERATIONS=3 icount=1 # How many times to get input.

my_read () { # Called with my_read varname, #+ outputs the previous value between brackets as the default value, #+ then asks for a new value. local local_var echo n "Enter a value " eval 'echo n "[$'$1'] "' # eval echo n "[\$$1] "

# Previous value. # Easier to understand, #+ but loses trailing space in user prompt.

read local_var [ n "$local_var" ] && eval $1=\$local_var # "Andlist": if "local_var" then set "$1" to its value. }

Chapter 23. Functions

357

Advanced BashScripting Guide

echo while [ "$icount" le "$ITERATIONS" ] do my_read var echo "Entry #$icount = $var" let "icount += 1" echo done

# Thanks to Stephane Chazelas for providing this instructive example. exit 0

Exit and Return exit status Functions return a value, called an exit status. The exit status may be explicitly specified by a return statement, otherwise it is the exit status of the last command in the function (0 if successful, and a nonzero error code if not). This exit status may be used in the script by referencing it as $?. This mechanism effectively permits script functions to have a "return value" similar to C functions. return Terminates a function. A return command [73] optionally takes an integer argument, which is returned to the calling script as the "exit status" of the function, and this exit status is assigned to the variable $?.

Example 237. Maximum of two numbers

#!/bin/bash # max.sh: Maximum of two integers. E_PARAM_ERR=250 # If less than 2 params passed to function. EQUAL=251 # Return value if both params equal. # Error values out of range of any #+ params that might be fed to the function. max2 () # Returns larger of two numbers. { # Note: numbers compared must be less than 257. if [ z "$2" ] then return $E_PARAM_ERR fi if [ "$1" eq "$2" ] then return $EQUAL else if [ "$1" gt "$2" ] then return $1 else return $2 fi fi

Chapter 23. Functions

358

Advanced BashScripting Guide

} max2 33 34 return_val=$? if [ "$return_val" eq $E_PARAM_ERR ] then echo "Need to pass two parameters to the function." elif [ "$return_val" eq $EQUAL ] then echo "The two numbers are equal." else echo "The larger of the two numbers is $return_val." fi

exit 0 # # # #+ Exercise (easy): Convert this to an interactive script, that is, have the script ask for input (two numbers).

For a function to return a string or array, use a dedicated variable.

count_lines_in_etc_passwd() { [[ r /etc/passwd ]] && REPLY=$(echo $(wc l < /etc/passwd)) # If /etc/passwd is readable, set REPLY to line count. # Returns both a parameter value and status information. # The 'echo' seems unnecessary, but . . . #+ it removes excess whitespace from the output. } if count_lines_in_etc_passwd then echo "There are $REPLY lines in /etc/passwd." else echo "Cannot count lines in /etc/passwd." fi # Thanks, S.C.

Example 238. Converting numbers to Roman numerals

#!/bin/bash # Arabic number to Roman numeral conversion # Range: 0 200 # It's crude, but it works. # Extending the range and otherwise improving the script is left as an exercise. # Usage: roman numbertoconvert LIMIT=200 E_ARG_ERR=65 E_OUT_OF_RANGE=66 if [ z "$1" ]

Chapter 23. Functions

359

Advanced BashScripting Guide

then echo "Usage: `basename $0` numbertoconvert" exit $E_ARG_ERR fi num=$1 if [ "$num" gt $LIMIT ] then echo "Out of range!" exit $E_OUT_OF_RANGE fi to_roman () # Must declare function before first call to it. { number=$1 factor=$2 rchar=$3 let "remainder = number factor" while [ "$remainder" ge 0 ] do echo n $rchar let "number = factor" let "remainder = number factor" done return $number # Exercise: # # Explain how this function works. # Hint: division by successive subtraction. }

to_roman num=$? to_roman num=$? to_roman num=$? to_roman num=$? to_roman num=$? to_roman num=$? to_roman num=$? to_roman num=$? to_roman echo exit 0

$num 100 C $num 90 LXXXX $num 50 L $num 40 XL $num 10 X $num 9 IX $num 5 V $num 4 IV $num 1 I

See also Example 1028. The largest positive integer a function can return is 255. The return command is closely tied to the concept of exit status, which accounts for this particular limitation. Fortunately, there are various workarounds for those situations requiring a large integer return value from a function. Chapter 23. Functions 360

Advanced BashScripting Guide Example 239. Testing large return values in a function
#!/bin/bash # returntest.sh # The largest positive value a function can return is 255. return_test () { return $1 } return_test 27 echo $? return_test 255 echo $? return_test 257 echo $? # Returns whatever passed to it.

# o.k. # Returns 27. # Still o.k. # Returns 255. # Error! # Returns 1 (return code for miscellaneous error).

# ====================================================== return_test 151896 # Do large negative numbers work? echo $? # Will this return 151896? # No! It returns 168. # Version of Bash before 2.05b permitted #+ large negative integer return values. # Newer versions of Bash plug this loophole. # This may break older scripts. # Caution! # ====================================================== exit 0

A workaround for obtaining large integer "return values" is to simply assign the "return value" to a global variable.
Return_Val= # Global variable to hold oversize return value of function.

alt_return_test () { fvar=$1 Return_Val=$fvar return # Returns 0 (success). } alt_return_test 1 echo $? echo "return value = $Return_Val" alt_return_test 256 echo "return value = $Return_Val" alt_return_test 257 echo "return value = $Return_Val" alt_return_test 25701 echo "return value = $Return_Val"

# 0 # 1

# 256

# 257

#25701

A more elegant method is to have the function echo its "return value to stdout," and then capture it by command substitution. See the discussion of this in Section 33.7.

Chapter 23. Functions

361

Advanced BashScripting Guide Example 2310. Comparing two large integers

#!/bin/bash # max2.sh: Maximum of two LARGE integers. # This is the previous "max.sh" example, #+ modified to permit comparing large integers. EQUAL=0 E_PARAM_ERR=99999 # ^^^^^^ # Return value if both params equal. # Not enough params passed to function. Out of range of any params that might be passed.

max2 () # "Returns" larger of two numbers. { if [ z "$2" ] then echo $E_PARAM_ERR return fi if [ "$1" eq "$2" ] then echo $EQUAL return else if [ "$1" gt "$2" ] then retval=$1 else retval=$2 fi fi echo $retval } # Echoes (to stdout), rather than returning value. # Why?

return_val=$(max2 33001 33997) # ^^^^ Function name # ^^^^^ ^^^^^ Params passed # This is actually a form of command substitution: #+ treating a function as if it were a command, #+ and assigning the stdout of the function to the variable "return_val."

# ========================= OUTPUT ======================== if [ "$return_val" eq "$E_PARAM_ERR" ] then echo "Error in parameters passed to comparison function!" elif [ "$return_val" eq "$EQUAL" ] then echo "The two numbers are equal." else echo "The larger of the two numbers is $return_val." fi # ========================================================= exit 0 # Exercises:

Chapter 23. Functions

362

Advanced BashScripting Guide

# # #+ # # 1) Find a more elegant way of testing the parameters passed to the function. 2) Simplify the if/then structure at "OUTPUT." 3) Rewrite the script to take input from commandline parameters.

Here is another example of capturing a function "return value." Understanding it requires some knowledge of awk.
month_length () # Takes month number as an argument. { # Returns number of days in month. monthD="31 28 31 30 31 30 31 31 30 31 30 31" # Declare as local? echo "$monthD" | awk '{ print $'"${1}"' }' # Tricky. # ^^^^^^^^^ # Parameter passed to function ($1 month number), then to awk. # Awk sees this as "print $1 . . . print $12" (depending on month number) # Template for passing a parameter to embedded awk script: # $'"${script_parameter}"' # Needs error checking for correct parameter range (112) #+ and for February in leap year. } # # Usage example: month=4 # April, for example (4th month). days_in=$(month_length $month) echo $days_in # 30 #

See also Example A7. Exercise: Using what we have just learned, extend the previous Roman numerals example to accept arbitrarily large input. Redirection Redirecting the stdin of a function A function is essentially a code block, which means its stdin can be redirected (as in Example 31).

Example 2311. Real name from username

#!/bin/bash # realname.sh # # From username, gets "real name" from /etc/passwd.

ARGCOUNT=1 E_WRONGARGS=65 file=/etc/passwd pattern=$1

# Expect one arg.

if [ $# ne "$ARGCOUNT" ] then echo "Usage: `basename $0` USERNAME" exit $E_WRONGARGS fi

Chapter 23. Functions

363

Advanced BashScripting Guide

file_excerpt () # Scan file for pattern, then print relevant portion of line. { while read line # "while" does not necessarily need "[ condition ]" do echo "$line" | grep $1 | awk F":" '{ print $5 }' # Have awk use ":" delimiter. done } <$file # Redirect into function's stdin. file_excerpt $pattern # # # # # # # Yes, this entire script could be reduced to grep PATTERN /etc/passwd | awk F":" '{ print $5 }' or awk F: '/PATTERN/ {print $5}' or awk F: '($1 == "username") { print $5 }' # real name from username However, it might not be as instructive.

exit 0

There is an alternate, and perhaps less confusing method of redirecting a function's stdin. This involves redirecting the stdin to an embedded bracketed code block within the function.
# Instead of: Function () { ... } < file # Try this: Function () { { ... } < file } # Similarly, Function () # This works. { { echo $* } | tr a b } Function () { echo $* } | tr a b # This doesn't work.

# A nested code block is mandatory here.

# Thanks, S.C.

23.2. Local Variables

What makes a variable local? local variables Chapter 23. Functions 364

Advanced BashScripting Guide A variable declared as local is one that is visible only within the block of code in which it appears. It has local "scope". In a function, a local variable has meaning only within that function block.

Example 2312. Local variable visibility

#!/bin/bash # Global and local variables inside a function. func () { local loc_var=23 # Declared as local variable. echo # Uses the 'local' builtin. echo "\"loc_var\" in function = $loc_var" global_var=999 # Not declared as local. # Defaults to global. echo "\"global_var\" in function = $global_var" } func # Now, to see if local variable "loc_var" exists outside function. echo echo "\"loc_var\" outside function = $loc_var" # $loc_var outside function = # No, $loc_var not visible globally. echo "\"global_var\" outside function = $global_var" # $global_var outside function = 999 # $global_var is visible globally. echo exit 0 # In contrast to C, a Bash variable declared inside a function #+ is local *only* if declared as such.

Before a function is called, all variables declared within the function are invisible outside the body of the function, not just those explicitly declared as local.
#!/bin/bash func () { global_var=37 }

# Visible only within the function block #+ before the function has been called. # END OF FUNCTION # global_var = # Function "func" has not yet been called, #+ so $global_var is not visible here.

echo "global_var = $global_var"

func echo "global_var = $global_var"

# global_var = 37 # Has been set by function call.

Chapter 23. Functions

365

Advanced BashScripting Guide

23.2.1. Local variables help make recursion possible.

Local variables permit recursion, [74] but this practice generally involves much computational overhead and is definitely not recommended in a shell script. [75]

Example 2313. Recursion, using a local variable

#!/bin/bash # # factorial

# Does bash permit recursion? # Well, yes, but... # It's so slow that you gotta have rocks in your head to try it.

MAX_ARG=5 E_WRONG_ARGS=65 E_RANGE_ERR=66

if [ z "$1" ] then echo "Usage: `basename $0` number" exit $E_WRONG_ARGS fi if [ "$1" gt $MAX_ARG ] then echo "Out of range (5 is maximum)." # Let's get real now. # If you want greater range than this, #+ rewrite it in a Real Programming Language. exit $E_RANGE_ERR fi fact () { local number=$1 # Variable "number" must be declared as local, #+ otherwise this doesn't work. if [ "$number" eq 0 ] then factorial=1 # Factorial of 0 = 1. else let "decrnum = number 1" fact $decrnum # Recursive function call (the function calls itself). let "factorial = $number * $?" fi return $factorial } fact $1 echo "Factorial of $1 is $?." exit 0

Chapter 23. Functions

366

Advanced BashScripting Guide See also Example A16 for an example of recursion in a script. Be aware that recursion is resourceintensive and executes slowly, and is therefore generally not appropriate to use in a script.

23.3. Recursion Without Local Variables

A function may recursively call itself even without use of local variables.

Example 2314. The Towers of Hanoi

#! /bin/bash # # The Towers Of Hanoi # Bash script # Copyright (C) 2000 Amit Singh. All Rights Reserved. # http://hanoi.kernelthread.com # # Last tested under bash version 2.05b.0(13)release # # Used in "Advanced Bash Scripting Guide" #+ with permission of script author. # Slightly modified and commented by ABS author. #=================================================================# # The Tower of Hanoi is a mathematical puzzle attributed to #+ Edouard Lucas, a nineteenthcentury French mathematician. # # There are three vertical posts set in a base. # The first post has a set of annular rings stacked on it. # These rings are flat disks with a hole drilled out of the center, #+ so they can slip over the posts. # The rings have different diameters, and they stack in descending #+ order, according to size. # The smallest ring is on top, and the largest on the bottom. # # The task is to transfer the stack of rings #+ to one of the other posts. # You can move only one ring at a time to another post. # You are permitted to move rings back to the original post. # You may place a smaller ring atop a larger one, #+ but *not* vice versa. # Again, it is forbidden to place a larger ring atop a smaller one. # # For a small number of rings, only a few moves are required. #+ For each additional ring, #+ the required number of moves approximately doubles, #+ and the "strategy" becomes increasingly complicated. # # For more information, see http://hanoi.kernelthread.com. # # # ... ... ... # | | | | | | # _|_|_ | | | | # |_____| | | | | # |_______| | | | | # |_________| | | | | # |___________| | | | | # | | | | | |

Chapter 23. Functions

367

Advanced BashScripting Guide

# .. # |**************************************************************| # #1 #2 #3 # #=================================================================#

E_NOPARAM=66 # No parameter passed to script. E_BADPARAM=67 # Illegal number of disks passed to script. Moves= # Global variable holding number of moves. # Modifications to original script. dohanoi() { # Recursive function. case $1 in 0) ;; *) dohanoi "$(($11))" $2 $4 $3 echo move $2 ">" $3 let "Moves += 1" # Modification to original script. dohanoi "$(($11))" $4 $3 $2 ;; esac } case $# in 1) case $(($1>0)) in # Must have at least one disk. 1) dohanoi $1 1 3 2 echo "Total moves = $Moves" exit 0; ;; *) echo "$0: illegal value for number of disks"; exit $E_BADPARAM; ;; esac ;; *) echo "usage: $0 N" echo " Where \"N\" is the number of disks." exit $E_NOPARAM; ;; esac # # # # # # Exercises: 1) Would commands beyond this point ever be executed? Why not? (Easy) 2) Explain the workings of the workings of the "dohanoi" function. (Difficult)

Chapter 23. Functions

368

Chapter 24. Aliases

A Bash alias is essentially nothing more than a keyboard shortcut, an abbreviation, a means of avoiding typing a long command sequence. If, for example, we include alias lm="ls l | more" in the ~/.bashrc file, then each lm typed at the command line will automatically be replaced by a ls l | more. This can save a great deal of typing at the command line and avoid having to remember complex combinations of commands and options. Setting alias rm="rm i" (interactive mode delete) may save a good deal of grief, since it can prevent inadvertently losing important files. 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. [76] 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.

Example 241. Aliases within a script

#!/bin/bash # alias.sh shopt s expand_aliases # Must set this option, else script will not expand aliases.

# First, some fun. alias Jesse_James='echo "\"Alias Jesse James\" was a 1959 comedy starring Bob Hope."' Jesse_James echo; echo; echo; alias ll="ls l" # May use either single (') or double (") quotes to define an alias. echo "Trying aliased \"ll\":" ll /usr/X11R6/bin/mk* #* Alias works. echo directory=/usr/X11R6/bin/ prefix=mk* # See if wild card causes problems. echo "Variables \"directory\" + \"prefix\" = $directory$prefix" echo alias lll="ls l $directory$prefix" echo "Trying aliased \"lll\":" lll # Long listing of all files in /usr/X11R6/bin stating with mk. # An alias can handle concatenated variables including wild card o.k.

TRUE=1

Chapter 24. Aliases

369

Advanced BashScripting Guide

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. # alias.sh: line 57: rrr: command not found let count+=1 done echo; echo alias xyz='cat $0' # Script lists itself. # Note strong quotes.

xyz # This seems to work, #+ although the Bash documentation suggests that it shouldn't. # # However, as Steve Jacobson points out, #+ the "$0" parameter expands immediately upon declaration of the alias. exit 0

The unalias command removes a previously set alias.

Example 242. unalias: Setting and unsetting an alias

#!/bin/bash # unalias.sh shopt s expand_aliases alias llm='ls al | more' llm echo unalias llm # Unset alias. llm # Error message results, since 'llm' no longer recognized. exit 0 bash$ ./unalias.sh total 6 drwxrwxrx 2 bozo drwxrxrx 40 bozo # Enables alias expansion.

bozo bozo

3072 Feb 2048 Feb

6 14:04 . 6 14:04 ..

Chapter 24. Aliases

370

Advanced BashScripting Guide

rwxrxrx 1 bozo bozo 199 Feb 6 14:04 unalias.sh

./unalias.sh: llm: command not found

Chapter 24. Aliases

371

Chapter 25. List Constructs

The "and list" and "or list" constructs provide a means of processing a number of commands consecutively. These can effectively replace complex nested if/then or even case statements. Chaining together commands and list
command1 && command2 && command3 && ... commandn

Each command executes in turn provided that the previous command has given a return value of true (zero). At the first false (nonzero) return, the command chain terminates (the first command returning false is the last one to execute). Example 251. Using an and list to test for commandline arguments
#!/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 always best to QUOTE tested variables.

# This if [ ! then echo fi if [ ! then echo echo else echo fi # It's

accomplishes the same thing, using "pure" if/then statements. z "$1" ] "Argument #1 = $1" z "$2" ] "Argument #2 = $2" "At least 2 arguments passed to script." "Less than 2 arguments passed to script." longer and less elegant than using an "and list".

exit 0

Example 252. Another commandline arg test using an and list

Chapter 25. List Constructs

372

Advanced BashScripting Guide

#!/bin/bash ARGS=1 E_BADARGS=65 # Number of arguments expected. # Exit value if incorrect number of args passed.

test $# ne $ARGS && \ echo "Usage: `basename $0` $ARGS argument(s)" && exit $E_BADARGS # If condition 1 tests true (wrong number of args passed to script), #+ then the rest of the line executes, and script terminates. # Line below executes only if the above test fails. echo "Correct number of arguments passed to this script." exit 0 # To check exit value, do a "echo $?" after script termination.

Of course, an and list can also set variables to a default value.

arg1=$@ && [ z "$arg1" ] && arg1=DEFAULT # Set $arg1 to command line arguments, if any. # But . . . set to DEFAULT if not specified on command line.

or list
command1 || command2 || command3 || ... commandn

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". Example 253. Using or lists in combination with an and list
#!/bin/bash # # delete.sh, notsocunning file deletion utility. Usage: delete filename

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

[ ! f "$file" ] && echo "File \"$file\" not found. \ Cowardly refusing to delete a nonexistent file." # AND LIST, to give error message if file not present. # Note echo message continued on to a second line with an escape. [ ! f "$file" ] || (rm f $file; echo "File \"$file\" deleted.") # OR LIST, to delete file if present. # Note logic inversion above. # AND LIST executes on true, OR LIST on false.

Chapter 25. List Constructs

373

Advanced BashScripting Guide

exit 0

If the first command in an "or list" returns true, it will execute.

# ==> #+==> #+==> # ==> The following snippets from the /etc/rc.d/init.d/single script by Miquel van Smoorenburg illustrate use of "and" and "or" lists. "Arrowed" comments added by document author.

[ x /usr/bin/clear ] && /usr/bin/clear # ==> If /usr/bin/clear exists, then invoke it. # ==> Checking for the existence of a command before calling it #+==> avoids error messages and other awkward consequences. # ==> . . . # If they want to run something in single user mode, might as well run it... for i in /etc/rc1.d/S[09][09]* ; do # Check if the script is there. [ x "$i" ] || continue # ==> If corresponding file in $PWD *not* found, #+==> then "continue" by jumping to the top of the loop. # Reject backup files and files generated by rpm. case "$1" in *.rpmsave|*.rpmorig|*.rpmnew|*~|*.orig) continue;; esac [ "$i" = "/etc/rc1.d/S00single" ] && continue # ==> Set script name, but don't execute it yet. $i start done # ==> . . .

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.
false && true || echo false # Same result as ( false && true ) || echo false # But *not* false && ( true || echo false ) # false

# false # (nothing echoed)

# Note lefttoright grouping and evaluation of statements, #+ since the logic operators "&&" and "||" have equal precedence. # # It's best to avoid such complexities, unless you know what you're doing. Thanks, S.C.

See Example A7 and Example 74 for illustrations of using an and / or list to test variables.

Chapter 25. List Constructs

374

Chapter 26. Arrays

Newer versions of Bash support onedimensional arrays. Array elements may be initialized with the variable[xx] notation. Alternatively, a script may introduce the entire array by an explicit declare a variable statement. To dereference (find the contents of) an array element, use curly bracket notation, that is, ${variable[xx]}.

Example 261. Simple array usage

#!/bin/bash

area[11]=23 area[13]=37 area[51]=UFOs # # # # #+ Array members need not be consecutive or contiguous. Some members of the array can be left uninitialized. Gaps in the array are okay. In fact, arrays with sparse data ("sparse arrays") are useful in spreadsheetprocessing software.

echo n "area[11] = " echo ${area[11]} # echo n "area[13] = " echo ${area[13]}

{curly brackets} needed.

echo "Contents of area[51] are ${area[51]}." # Contents of uninitialized array variable print blank (null variable). echo n "area[43] = " echo ${area[43]} echo "(area[43] unassigned)" echo # Sum of two array variables assigned to third area[5]=`expr ${area[11]} + ${area[13]}` echo "area[5] = area[11] + area[13]" echo n "area[5] = " echo ${area[5]} area[6]=`expr ${area[11]} + ${area[51]}` echo "area[6] = area[11] + area[51]" echo n "area[6] = " echo ${area[6]} # This fails because adding an integer to a string is not permitted. echo; echo; echo # # # # Another array, "area2". Another way of assigning array variables... array_name=( XXX YYY ZZZ ... )

Chapter 26. Arrays

375

Advanced BashScripting Guide

area2=( zero one two three four ) echo n "area2[0] = " echo ${area2[0]} # Aha, zerobased indexing (first element of array is [0], not [1]). echo n "area2[1] = " echo ${area2[1]} # [1] is second element of array. # echo; echo; echo # # # # Yet another array, "area3". Yet another way of assigning array variables... array_name=([xx]=XXX [yy]=YYY ...)

area3=([17]=seventeen [24]=twentyfour) echo n "area3[17] = " echo ${area3[17]} echo n "area3[24] = " echo ${area3[24]} # exit 0

Bash permits array operations on variables, even if the variables are not explicitly declared as arrays.
string=abcABC123ABCabc echo ${string[@]} echo ${string[*]} echo ${string[0]} echo ${string[1]} echo ${#string[@]}

# # # # # # # #

abcABC123ABCabc abcABC123ABCabc abcABC123ABCabc No output! Why? 1 One element in the array. The string itself.

# Thank you, Michael Zick, for pointing this out.

Once again this demonstrates that Bash variables are untyped. Example 262. Formatting a poem
#!/bin/bash # poem.sh: Prettyprints one of the document author's favorite poems. # Lines of the poem (single stanza). Line[1]="I do not know which to prefer," Line[2]="The beauty of inflections" Line[3]="Or the beauty of innuendoes," Line[4]="The blackbird whistling" Line[5]="Or just after." # Attribution. Attrib[1]=" Wallace Stevens"

Chapter 26. Arrays

376

Advanced BashScripting Guide

Attrib[2]="\"Thirteen Ways of Looking at a Blackbird\"" # This poem is in the Public Domain (copyright expired). echo for index in 1 2 3 4 5 # Five lines. do printf " %s\n" "${Line[index]}" done for index in 1 2 do printf " done echo exit 0 # Exercise: # # Modify this script to prettyprint a poem from a text data file. # Two attribution lines. %s\n" "${Attrib[index]}"

Array variables have a syntax all their own, and even standard Bash commands and operators have special options adapted for array use.

Example 263. Various array operations

#!/bin/bash # arrayops.sh: More fun with arrays.

array=( zero one two three four five ) # Element 0 1 2 3 4 5 echo ${array[0]} echo ${array:0} # # # #+ # # #+ zero zero Parameter expansion of starting at position # ero Parameter expansion of starting at position #

first element, 0 (1st character). first element, 1 (2nd character).

echo ${array:1}

echo "" echo ${#array[0]} echo ${#array} # # # # # # # # # # # # 4 Length of first element of array. 4 Length of first element of array. (Alternate notation) 3 Length of second element of array. Arrays in Bash have zerobased indexing. 6 Number of elements in array. 6 Number of elements in array.

echo ${#array[1]}

echo ${#array[*]} echo ${#array[@]}

Chapter 26. Arrays

377

Advanced BashScripting Guide

echo "" array2=( [0]="first element" [1]="second element" [3]="fourth element" ) echo ${array2[0]} echo ${array2[1]} echo ${array2[2]} echo ${array2[3]} # # # # # first element second element Skipped in initialization, and therefore null. fourth element

exit 0

Many of the standard string operations work on arrays.

Example 264. String operations on arrays

#!/bin/bash # arraystrops.sh: String operations on arrays. # Script by Michael Zick. # Used with permission. # In general, any string operation in the ${name ... } notation #+ can be applied to all string elements in an array #+ with the ${name[@] ... } or ${name[*] ...} notation.

arrayZ=( one two three four five five ) echo # Trailing Substring Extraction echo ${arrayZ[@]:0} # one two three four five five # All elements. echo ${arrayZ[@]:1} # two three four five five # All elements following element[0]. # two three # Only the two elements after element[0].

echo ${arrayZ[@]:1:2}

echo "" # Substring Removal # Removes shortest match from front of string(s), #+ where the substring is a regular expression. echo ${arrayZ[@]#f*r} # one two three five five # Applied to all elements of the array. # Matches "four" and removes it.

# Longest match from front of string(s) echo ${arrayZ[@]##t*e} # one two four five five # Applied to all elements of the array. # Matches "three" and removes it. # Shortest match from back of string(s) echo ${arrayZ[@]%h*e} # one two t four five five # Applied to all elements of the array. # Matches "hree" and removes it.

Chapter 26. Arrays

378

Advanced BashScripting Guide

# Longest match from back echo ${arrayZ[@]%%t*e} # # # of string(s) one two four five five Applied to all elements of the array. Matches "three" and removes it.

echo "" # Substring Replacement # Replace first occurance of substring with replacement echo ${arrayZ[@]/fiv/XYZ} # one two three four XYZe XYZe # Applied to all elements of the array. # Replace all occurances of substring echo ${arrayZ[@]//iv/YY} # one two three four fYYe fYYe # Applied to all elements of the array. # Delete all occurances of substring # Not specifing a replacement means 'delete' echo ${arrayZ[@]//fi/} # one two three four ve ve # Applied to all elements of the array. # Replace frontend occurances of substring echo ${arrayZ[@]/#fi/XY} # one two three four XYve XYve # Applied to all elements of the array. # Replace backend occurances of substring echo ${arrayZ[@]/%ve/ZZ} # one two three four fiZZ fiZZ # Applied to all elements of the array. echo ${arrayZ[@]/%o/XX} # one twXX three four five five # Why?

echo ""

# Before reaching for awk (or anything else) # Recall: # $( ... ) is command substitution. # Functions run as a subprocess. # Functions write their output to stdout. # Assignment reads the function's stdout. # The name[@] notation specifies a "foreach" operation. newstr() { echo n "!!!" } echo ${arrayZ[@]/%e/$(newstr)} # on!!! two thre!!! four fiv!!! fiv!!! # Q.E.D: The replacement action is an 'assignment.' # Accessing the "ForEach" echo ${arrayZ[@]//*/$(newstr optional_arguments)} # Now, if Bash would just pass the matched string as $0 #+ to the function being called . . . echo exit 0

Command substitution can construct the individual elements of an array. Chapter 26. Arrays 379

Advanced BashScripting Guide Example 265. Loading the contents of a script into an array
#!/bin/bash # scriptarray.sh: Loads this script into an array. # Inspired by an email from Chris Martin (thanks!). script_contents=( $(cat "$0") ) # Stores contents of this script ($0) #+ in an array.

for element in $(seq 0 $((${#script_contents[@]} 1))) do # ${#script_contents[@]} #+ gives number of elements in the array. # # Question: # Why is seq 0 necessary? # Try changing it to seq 1. echo n "${script_contents[$element]}" # List each field of this script on a single line. echo n " " # Use " " as a field separator. done echo exit 0 # Exercise: # # Modify this script so it lists itself #+ in its original format, #+ complete with whitespace, line breaks, etc.

In an array context, some Bash builtins have a slightly altered meaning. For example, unset deletes array elements, or even an entire array.

Example 266. Some special properties of arrays

#!/bin/bash declare a colors # All subsequent commands in this script will treat #+ the variable "colors" as an array. echo "Enter your favorite colors (separated from each other by a space)." read a colors # Enter at least 3 colors to demonstrate features below. # Special option to 'read' command, #+ allowing assignment of elements in an array. 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). # # This corresponds to the behavior of "$@" and "$*" #+ in positional parameters.

Chapter 26. Arrays

380

Advanced BashScripting Guide

index=0 while [ "$index" lt "$element_count" ] do # List all the elements in the array. echo ${colors[$index]} let "index = $index + 1" # Or: # index+=1 # if running Bash, version 3.1 or later. done # Each array element listed on a separate line. # If this is not desired, use echo n "${colors[$index]} " # # Doing it with a "for" loop instead: # for i in "${colors[@]}" # do # echo "$i" # done # (Thanks, S.C.) echo # Again, list all the elements in the array, but using a more elegant method. echo ${colors[@]} # echo ${colors[*]} also works. echo # The "unset" command deletes elements of an array, or entire array. unset colors[1] # Remove 2nd element of array. # Same effect as colors[1]= echo ${colors[@]} # List array again, missing 2nd element. unset colors # Delete entire array. # unset colors[*] and #+ unset colors[@] also work.

echo; echo n "Colors gone." echo ${colors[@]} # List array again, now empty. 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.

Example 267. Of empty arrays and empty elements

#!/bin/bash # emptyarray.sh # Thanks to Stephane Chazelas for the original example, #+ and to Michael Zick and Omair Eshkenazi for extending it.

# An empty array is not the same as an array with empty elements. array0=( first second third ) array1=( '' ) # "array1" consists of one empty element. array2=( ) # No elements . . . "array2" is empty. array3=( ) # What about this array?

Chapter 26. Arrays

381

Advanced BashScripting Guide

echo ListArray() { echo echo "Elements in array0: ${array0[@]}" echo "Elements in array1: ${array1[@]}" echo "Elements in array2: ${array2[@]}" echo "Elements in array3: ${array3[@]}" echo echo "Length of first element in array0 = ${#array0}" echo "Length of first element in array1 = ${#array1}" echo "Length of first element in array2 = ${#array2}" echo "Length of first element in array3 = ${#array3}" echo echo "Number of elements in array0 = ${#array0[*]}" # echo "Number of elements in array1 = ${#array1[*]}" # echo "Number of elements in array2 = ${#array2[*]}" # echo "Number of elements in array3 = ${#array3[*]}" # }

3 1 0 0

(Surprise!)

# =================================================================== ListArray # Try extending those arrays. # Adding array0=( array1=( array2=( array3=( an element to an array. "${array0[@]}" "new1" ) "${array1[@]}" "new1" ) "${array2[@]}" "new1" ) "${array3[@]}" "new1" )

ListArray # or array0[${#array0[*]}]="new2" array1[${#array1[*]}]="new2" array2[${#array2[*]}]="new2" array3[${#array3[*]}]="new2" ListArray # When extended as above; arrays are 'stacks' # The above is the 'push' # The stack 'height' is: height=${#array2[@]} echo echo "Stack height for array2 = $height" # The 'pop' is: unset array2[${#array2[@]}1] # Arrays are zerobased, height=${#array2[@]} #+ which means first element has index 0. echo echo "POP" echo "New stack height for array2 = $height" ListArray # List only 2nd and 3rd elements of array0. from=1 # Zerobased numbering. to=2

Chapter 26. Arrays

382

Advanced BashScripting Guide

array3=( ${array0[@]:1:2} ) echo echo "Elements in array3: ${array3[@]}" # Works like a string (array of characters). # Try some other "string" forms. # Replacement: array4=( ${array0[@]/second/2nd} ) echo echo "Elements in array4: ${array4[@]}" # Replace all matching wildcarded string. array5=( ${array0[@]//new?/old} ) echo echo "Elements in array5: ${array5[@]}" # Just when you are getting the feel for this . . . array6=( ${array0[@]#*new} ) echo # This one might surprise you. echo "Elements in array6: ${array6[@]}" array7=( ${array0[@]#new1} ) echo # After array6 this should not be a surprise. echo "Elements in array7: ${array7[@]}" # Which looks a lot like . . . array8=( ${array0[@]/new1/} ) echo echo "Elements in array8: ${array8[@]}" # # #+ # #+ #+ # So what can one say about this? The string operations are performed on each of the elements in var[@] in succession. Therefore : Bash supports string vector operations if the result is a zero length string, that element disappears in the resulting assignment. Question, are those strings hard or soft quotes?

zap='new*' array9=( ${array0[@]/$zap/} ) echo echo "Elements in array9: ${array9[@]}" # Just when you thought you where still in Kansas . . . array10=( ${array0[@]#$zap} ) echo echo "Elements in array10: ${array10[@]}" # Compare array7 with array10. # Compare array8 with array9. # Answer: must be soft quotes. exit 0

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.

Chapter 26. Arrays

383

Advanced BashScripting Guide

array2=( "${array1[@]}" ) # or array2="${array1[@]}" # # However, this fails with "sparse" arrays, #+ arrays with holes (missing elements) in them, #+ as Jochen DeSmet points out. # array1[0]=0 # array1[1] not assigned array1[2]=2 array2=( "${array1[@]}" ) # Copy it? echo ${array2[0]} # 0 echo ${array2[2]} # (null), should be 2 #

# Adding an element to an array. array=( "${array[@]}" "new element" ) # or array[${#array[*]}]="new element" # 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 array1=( `cat "$filename"`) # Loads contents # List file to stdout #+ of $filename into array1. # # array1=( `cat "$filename" | tr '\n' ' '`) # change linefeeds in file to spaces. # Not necessary because Bash does word splitting, #+ changing linefeeds to spaces. echo ${array1[@]} # List the array. # 1 a b c 2 d e fg # # Each whitespaceseparated "word" in the file #+ has been assigned to an element of the array. element_count=${#array1[*]} echo $element_count

# 8

Clever scripting makes it possible to add array operations.

Chapter 26. Arrays

384

Advanced BashScripting Guide Example 268. Initializing arrays

#! /bin/bash # arrayassign.bash # Array operations are Bash specific, #+ hence the ".bash" in the script name. # # # # # Copyright (c) Michael S. Zick, 2003, All rights reserved. License: Unrestricted reuse in any form, for any purpose. Version: $ID$ Clarification and additional comments by William Park.

# Based on an example provided by Stephane Chazelas #+ which appeared in the book: Advanced Bash Scripting Guide. # Output format of the 'times' command: # User CPU <space> System CPU # User CPU of dead children <space> System CPU of dead children # #+ # #+ # #+ Bash has two versions of assigning all elements of an array to a new array variable. Both drop 'null reference' elements in Bash versions 2.04, 2.05a and 2.05b. An additional array assignment that maintains the relationship of [subscript]=value for arrays may be added to newer versions.

# Constructs a large array using an internal command, #+ but anything creating an array of several thousand elements #+ will do just fine. declare a bigOne=( /dev/* ) echo echo 'Conditions: Unquoted, default IFS, AllElementsOf' echo "Number of elements in array is ${#bigOne[@]}" # set vx

echo echo ' testing: =( ${array[@]} ) ' times declare a bigTwo=( ${bigOne[@]} ) # ^ ^ times echo echo ' testing: =${array[@]} ' times declare a bigThree=${bigOne[@]} # No parentheses this time. times # #+ # # #+ #+ # Comparing the numbers shows that the second form, pointed out by Stephane Chazelas, is from three to four times faster. William Park explains: The bigTwo array assigned as single string, whereas bigThree assigned element by element. So, in essence, you have:

Chapter 26. Arrays

385

Advanced BashScripting Guide

# # bigTwo=( [0]="... ... ..." ) bigThree=( [0]="..." [1]="..." [2]="..." ... )

# I will continue to use the first form in my example descriptions #+ because I think it is a better illustration of what is happening. # The reusable portions of my examples will actual contain #+ the second form where appropriate because of the speedup. # MSZ: Sorry about that earlier oversight folks.

# # # #+ #+ # #+ #

Note: The "declare a" statements in lines 31 are not strictly necessary, since it is in the Array=( ... ) assignment form. However, eliminating these declarations the execution of the following sections Try it, and see what happens.

and 43 implicit slows down of the script.

exit 0

Adding a superfluous declare a statement to an array declaration may speed up execution of subsequent operations on the array. Example 269. Copying and concatenating arrays
#! /bin/bash # CopyArray.sh # # This script written by Michael Zick. # Used here with permission. # HowTo "Pass by Name & Return by Name" #+ or "Building your own assignment statement".

CpArray_Mac() { # Assignment Command Statement Builder echo echo echo echo echo n n n n n 'eval ' "$2" '=( ${' "$1" '[@]} )'

# Destination name # Source name

# That could all be a single command. # Matter of style only. } declare f CopyArray CopyArray=CpArray_Mac Hype() { # Hype the array named $1. # Function "Pointer" # Statement Builder

Chapter 26. Arrays

386

Advanced BashScripting Guide

# (Splice it together with array containing "Really Rocks".) # Return in array named $2. local a TMP local a hype=( Really Rocks ) $($CopyArray $1 TMP) TMP=( ${TMP[@]} ${hype[@]} ) $($CopyArray TMP $2) } declare a before=( Advanced Bash Scripting ) declare a after echo "Array Before = ${before[@]}" Hype before after echo "Array After = ${after[@]}" # Too much hype? echo "What ${after[@]:3:2}?" declare a modest=( ${after[@]:2:1} ${after[@]:3:2} ) # substring extraction echo "Array Modest = ${modest[@]}" # What happened to 'before' ? echo "Array Before = ${before[@]}" exit 0

Example 2610. More on concatenating arrays

#! /bin/bash # arrayappend.bash # # # # # Copyright (c) Michael S. Zick, 2003, All rights reserved. License: Unrestricted reuse in any form, for any purpose. Version: $ID$ Slightly modified in formatting by M.C.

# Array operations are Bashspecific. # Legacy UNIX /bin/sh lacks equivalents.

# Pipe the output of this script to 'more' #+ so it doesn't scroll off the terminal.

# Subscript packed. declare a array1=( zero1 one1 two1 ) # Subscript sparse ([1] is not defined). declare a array2=( [0]=zero2 [2]=two2 [3]=three2 ) echo

Chapter 26. Arrays

387

Advanced BashScripting Guide

echo ' Confirm that the array is really subscript sparse. ' echo "Number of elements: 4" # Hardcoded for illustration. for (( i = 0 ; i < 4 ; i++ )) do echo "Element [$i]: ${array2[$i]}" done # See also the more general code example in basicsreviewed.bash.

declare a dest # Combine (append) two arrays into a third array. echo echo 'Conditions: Unquoted, default IFS, AllElementsOf operator' echo ' Undefined elements not present, subscripts not maintained. ' # # The undefined elements do not exist; they are not being dropped. dest=( ${array1[@]} ${array2[@]} ) # dest=${array1[@]}${array2[@]} # Now, list the result. echo echo ' Testing Array Append ' cnt=${#dest[@]} echo "Number of elements: $cnt" for (( i = 0 ; i < cnt ; i++ )) do echo "Element [$i]: ${dest[$i]}" done # Assign an array to a single array element (twice). dest[0]=${array1[@]} dest[1]=${array2[@]} # List the result. echo echo ' Testing modified array ' cnt=${#dest[@]} echo "Number of elements: $cnt" for (( i = 0 ; i < cnt ; i++ )) do echo "Element [$i]: ${dest[$i]}" done # Examine the modified second element. echo echo ' Reassign and list second element ' declare a subArray=${dest[1]} cnt=${#subArray[@]} echo "Number of elements: $cnt" for (( i = 0 ; i < cnt ; i++ )) do echo "Element [$i]: ${subArray[$i]}" done # The assignment of an entire array to a single element #+ of another array using the '=${ ... }' array assignment #+ has converted the array being assigned into a string,

# Strange results, possibly a bug.

Chapter 26. Arrays

388

Advanced BashScripting Guide

#+ with the elements separated by a space (the first character of IFS). # If the original elements didn't contain whitespace . . . # If the original array isn't subscript sparse . . . # Then we could get the original array structure back again. # Restore from the modified second element. echo echo ' Listing restored element ' declare a subArray=( ${dest[1]} ) cnt=${#subArray[@]} echo "Number of elements: $cnt" for (( i = 0 ; i < cnt ; i++ )) do echo "Element [$i]: ${subArray[$i]}" done echo ' Do not depend on this behavior. ' echo ' This behavior is subject to change ' echo ' in versions of Bash newer than version 2.05b ' # MSZ: Sorry about any earlier confusion folks. exit 0

Arrays permit deploying old familiar algorithms as shell scripts. Whether this is necessarily a good idea is left to the reader to decide.

Example 2611. An old friend: The Bubble Sort

#!/bin/bash # bubble.sh: Bubble sort, of sorts. # Recall the algorithm for a bubble sort. In this particular version... # #+ # # # # # With each successive pass through the array to be sorted, compare two adjacent elements, and swap them if out of order. At the end of the first pass, the "heaviest" element has sunk to bottom. At the end of the second pass, the next "heaviest" one has sunk next to bottom. And so forth. This means that each successive pass needs to traverse less of the array. You will therefore notice a speeding up in the printing of the later passes.

exchange() { # Swaps two members of the array. local temp=${Countries[$1]} # Temporary storage #+ for element getting swapped out. Countries[$1]=${Countries[$2]} Countries[$2]=$temp return } declare a Countries # Declare array, #+ optional here since it's initialized below.

Chapter 26. Arrays

389

Advanced BashScripting Guide

# Is it permissable to split an array variable over multiple lines #+ using an escape (\)? # Yes. Countries=(Netherlands Ukraine Zaire Turkey Russia Yemen Syria \ Brazil Argentina Nicaragua Japan Mexico Venezuela Greece England \ Israel Peru Canada Oman Denmark Wales France Kenya \ Xanadu Qatar Liechtenstein Hungary) # "Xanadu" is the mythical place where, according to Coleridge, #+ Kubla Khan did a pleasure dome decree.

clear echo "0: ${Countries[*]}"

# Clear the screen to start with. # List entire array at pass 0.

number_of_elements=${#Countries[@]} let "comparisons = $number_of_elements 1" count=1 # Pass number. while [ "$comparisons" gt 0 ] do index=0 # Beginning of outer loop

# Reset index to start of array after each pass.

while [ "$index" lt "$comparisons" ] # Beginning of inner loop do if [ ${Countries[$index]} \> ${Countries[`expr $index + 1`]} ] # If out of order... # Recalling that \> is ASCII comparison operator #+ within single brackets. # if [[ ${Countries[$index]} > ${Countries[`expr $index + 1`]} ]] #+ also works. then exchange $index `expr $index + 1` # Swap. fi let "index += 1" # Or, index+=1 on Bash, ver. 3.1 or newer. done # End of inner loop # # Paulo Marcel Coelho Aragao suggests forloops as a simpler altenative. # # for (( last = $number_of_elements 1 ; last > 0 ; last )) ## Fix by C.Y. Hunt ^ (Thanks!) # do # for (( i = 0 ; i < last ; i++ )) # do # [[ "${Countries[$i]}" > "${Countries[$((i+1))]}" ]] \ # && exchange $i $((i+1)) # done # done #

let "comparisons = 1" # Since "heaviest" element bubbles to bottom, #+ we need do one less comparison each pass. echo

Chapter 26. Arrays

390

Advanced BashScripting Guide

echo "$count: ${Countries[@]}" echo let "count += 1" done # Print resultant array at end of each pass. # Increment pass count. # End of outer loop # All done.

exit 0

Is it possible to nest arrays within arrays?

#!/bin/bash # "Nested" array. # Michael Zick provided this example, #+ with corrections and clarifications by William Park. AnArray=( $(ls inode ignorebackups almostall \ directory fulltime color=none time=status \ sort=time l ${PWD} ) ) # Commands and options. # Spaces are significant . . . and don't quote anything in the above. SubArray=( ${AnArray[@]:11:1} ${AnArray[@]:6:5} ) # This array has six elements: #+ SubArray=( [0]=${AnArray[11]} [1]=${AnArray[6]} [2]=${AnArray[7]} # [3]=${AnArray[8]} [4]=${AnArray[9]} [5]=${AnArray[10]} ) # # Arrays in Bash are (circularly) linked lists #+ of type string (char *). # So, this isn't actually a nested array, #+ but it's functionally similar. echo "Current directory and date of last status change:" echo "${SubArray[@]}" exit 0

Embedded arrays in combination with indirect references create some fascinating possibilities

Example 2612. Embedded arrays and indirect references

#!/bin/bash # embeddedarrays.sh # Embedded arrays and indirect references. # This script by Dennis Leeuw. # Used with permission. # Modified by document author.

ARRAY1=( VAR1_1=value11 VAR1_2=value12 VAR1_3=value13 )

Chapter 26. Arrays

391

Advanced BashScripting Guide

ARRAY2=( VARIABLE="test" STRING="VAR1=value1 VAR2=value2 VAR3=value3" ARRAY21=${ARRAY1[*]} ) # Embed ARRAY1 within this second array. function print () { OLD_IFS="$IFS" IFS=$'\n'

# To print each array element #+ on a separate line. TEST1="ARRAY2[*]" local ${!TEST1} # See what happens if you delete this line. # Indirect reference. # This makes the components of $TEST1 #+ accessible to this function.

# Let's see what we've got so far. echo echo "\$TEST1 = $TEST1" # Just the name of the variable. echo; echo echo "{\$TEST1} = ${!TEST1}" # Contents of the variable. # That's what an indirect #+ reference does. echo echo ""; echo echo

# Print variable echo "Variable VARIABLE: $VARIABLE" # Print a string element IFS="$OLD_IFS" TEST2="STRING[*]" local ${!TEST2} # Indirect reference (as above). echo "String element VAR2: $VAR2 from STRING" # Print an array element TEST2="ARRAY21[*]" local ${!TEST2} # Indirect reference (as above). echo "Array element VAR1_1: $VAR1_1 from ARRAY21" } print echo exit 0 # As the author of the script notes, #+ "you can easily expand it to create namedhashes in bash." # (Difficult) exercise for the reader: implement this.

Arrays enable implementing a shell script version of the Sieve of Eratosthenes. Of course, a resourceintensive application of this nature should really be written in a compiled language, such as C. It runs excruciatingly slowly as a script.

Chapter 26. Arrays

392

Advanced BashScripting Guide Example 2613. Complex array application: Sieve of Eratosthenes
#!/bin/bash # sieve.sh (ex68.sh) # Sieve of Eratosthenes # Ancient algorithm for finding prime numbers. # This runs a couple of orders of magnitude slower #+ than the equivalent program written in C. LOWER_LIMIT=1 # Starting with 1. UPPER_LIMIT=1000 # Up to 1000. # (You may set this higher . . . if you have time on your hands.) PRIME=1 NON_PRIME=0 let SPLIT=UPPER_LIMIT/2 # Optimization: # Need to test numbers only halfway to upper limit (why?).

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) #+ until proven innocent. } print_primes () { # Print out the members of the Primes[] array tagged as prime. i=$LOWER_LIMIT until [ "$i" gt "$UPPER_LIMIT" ] do if [ "${Primes[i]}" eq "$PRIME" ] then printf "%8d" $i # 8 spaces per number gives nice, even columns. fi let "i += 1" done }

Chapter 26. Arrays

393

Advanced BashScripting Guide

sift () # Sift out the nonprimes. { let i=$LOWER_LIMIT+1 # We know 1 is prime, so let's start with 2. until [ "$i" gt "$UPPER_LIMIT" ] do if [ "${Primes[i]}" eq "$PRIME" ] # Don't bother sieving numbers already sieved (tagged as nonprime). then t=$i while [ "$t" le "$UPPER_LIMIT" ] do let "t += $i " Primes[t]=$NON_PRIME # Tag as nonprime all multiples. done fi let "i += 1" done

# ============================================== # main () # Invoke the functions sequentially. initialize sift print_primes # This is what they call structured programming. # ============================================== echo exit 0

# # # Code below line will not execute, because of 'exit.' # This improved version of the Sieve, by Stephane Chazelas, #+ executes somewhat faster. # Must invoke with commandline argument (limit of primes). UPPER_LIMIT=$1 let SPLIT=UPPER_LIMIT/2 # From command line. # Halfway to max number.

Primes=( '' $(seq $UPPER_LIMIT) ) i=1 until (( ( i += 1 ) > SPLIT )) do

# Need check only halfway.

Chapter 26. Arrays

394

Advanced BashScripting Guide

if [[ n $Primes[i] ]] then t=$i until (( ( t += i ) > UPPER_LIMIT )) do Primes[t]= done fi done echo ${Primes[*]} exit 0

Compare this arraybased prime number generator with an alternative that does not use arrays, Example A16. Arrays lend themselves, to some extent, to emulating data structures for which Bash has no native support.

Example 2614. Emulating a pushdown stack

#!/bin/bash # stack.sh: pushdown stack simulation # Similar to the CPU stack, a pushdown stack stores data items #+ sequentially, but releases them in reverse order, lastin firstout. BP=100 # # # # Base Pointer of stack array. Begin at element 100. Stack Pointer. Initialize it to "base" (bottom) of stack.

SP=$BP

Data=

# Contents of stack location. # Must use global variable, #+ because of limitation on function return range.

declare a stack

push() { if [ z "$1" ] then return fi let "SP = 1" stack[$SP]=$1 return } pop() { Data=

# Push item on stack. # Nothing to push?

# Bump stack pointer.

# Pop item off stack. # Empty out data item. # Stack empty?

if [ "$SP" eq "$BP" ] then

Chapter 26. Arrays

395

Advanced BashScripting Guide

return fi # This also keeps SP from getting past 100, #+ i.e., prevents a runaway stack.

Data=${stack[$SP]} let "SP += 1" return }

# Bump stack pointer.

status_report() # Find out what's happening. { echo "" echo "REPORT" echo "Stack Pointer = $SP" echo "Just popped \""$Data"\" off the stack." echo "" echo }

# ======================================================= # Now, for some fun. echo # See if you can pop anything off empty stack. pop status_report echo push garbage pop status_report

# Garbage in, garbage out.

value1=23; push $value1 value2=skidoo; push $value2 value3=FINAL; push $value3 pop status_report pop status_report pop status_report # FINAL # skidoo # 23 # Lastin, firstout!

# Notice how the stack pointer decrements with each push, #+ and increments with each pop. echo exit 0 # =======================================================

# Exercises: # # 1) Modify the "push()" function to permit pushing # + multiple element on the stack with a single function call.

Chapter 26. Arrays

396

Advanced BashScripting Guide

# 2) Modify the "pop()" function to permit popping # + multiple element from the stack with a single function call. # 3) # # + # + Add error checking to the critical functions. That is, return an error code, depending on successful or unsuccessful completion of the operation, and take appropriate action.

# 4) Using this script as a starting point, # + write a stackbased 4function calculator.

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.

Example 2615. Complex array application: Exploring a weird mathematical series

#!/bin/bash # Douglas Hofstadter's notorious "Qseries": # Q(1) = Q(2) = 1 # Q(n) = Q(n Q(n1)) + Q(n Q(n2)), for n>2 # This is a "chaotic" integer series with strange and unpredictable behavior. # The first 20 terms of the series are: # 1 1 2 3 3 4 5 5 6 6 6 8 8 8 10 9 10 11 11 12 # See Hofstadter's book, _Goedel, Escher, Bach: An Eternal Golden Braid_, #+ p. 137, ff.

LIMIT=100 LINEWIDTH=20 Q[1]=1 Q[2]=1

# Number of terms to calculate. # Number of terms printed per line. # First two terms of series are 1.

echo echo "Qseries [$LIMIT terms]:" echo n "${Q[1]} " # Output first two terms. echo n "${Q[2]} " for ((n=3; n <= $LIMIT; n++)) # Clike loop conditions. do # Q[n] = Q[n Q[n1]] + Q[n Q[n2]] for n>2 # Need to break the expression into intermediate terms, #+ since Bash doesn't handle complex array arithmetic very well. let "n1 = $n 1" let "n2 = $n 2" t0=`expr $n ${Q[n1]}` t1=`expr $n ${Q[n2]}` T0=${Q[t0]} T1=${Q[t1]} Q[n]=`expr $T0 + $T1` echo n "${Q[n]} " # n1 # n2 # n Q[n1] # n Q[n2] # Q[n Q[n1]] # Q[n Q[n2]] # Q[n Q[n1]] + Q[n Q[n2]]

Chapter 26. Arrays

397

Advanced BashScripting Guide

if [ `expr $n % $LINEWIDTH` eq 0 ] # Format output. then # ^ Modula operator echo # Break lines into neat chunks. fi done echo exit 0 # This is an iterative implementation of the Qseries. # The more intuitive recursive implementation is left as an exercise. # Warning: calculating this series recursively takes a VERY long time.

Bash supports only onedimensional arrays, though a little trickery permits simulating multidimensional ones.

Example 2616. Simulating a twodimensional array, then tilting it

#!/bin/bash # twodim.sh: Simulating a twodimensional array. # A onedimensional array consists of a single row. # A twodimensional array stores rows sequentially. Rows=5 Columns=5 # 5 X 5 Array. declare a alpha # char alpha [Rows] [Columns]; # Unnecessary declaration. Why?

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 # Use different symbols if you like. 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 twodimensional array. } print_alpha () { local row=0 local index

Chapter 26. Arrays

398

Advanced BashScripting Guide

echo while [ "$row" lt "$Rows" ] do local column=0 echo n " " # Lines up "square" array with rotated one. # Print out in "row major" order: #+ columns vary, #+ while row (outer loop) remains the same.

while [ "$column" lt "$Columns" ] do let "index = $row * $Rows + $column" echo n "${alpha[index]} " # alpha[$row][$column] let "column += 1" done let "row += 1" echo done # The simpler equivalent is # echo ${alpha[*]} | xargs n $Columns echo } filter () { echo n " " # Filter out negative array indices.

# Provides the tilt. # Explain how.

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 }

rotate () # Rotate the array 45 degrees { #+ "balance" it on its lower lefthand corner. local row local column for (( row = Rows; row > Rows; row )) do # Step through the array backwards. Why? for (( column = 0; column < Columns; column++ )) do if [ "$row" ge 0 ] then let "t1 = $column $row" let "t2 = $column"

Chapter 26. Arrays

399

Advanced BashScripting Guide

else let "t1 = $column" let "t2 = $column + $row" fi filter $t1 $t2 done echo; echo done # #+ #+ # #+ } Array rotation inspired by examples (pp. 143146) in "Advanced C Programming on the IBM PC," by Herbert Mayer (see bibliography). This just goes to show that much of what can be done in C can also be done in shell scripting. # Filter out negative array indices. # What happens if you don't do this?

# Now, let the show begin. # load_alpha # Load the array. print_alpha # Print it out. rotate # Rotate it 45 degrees counterclockwise. ## exit 0 # This is a rather contrived, not to mention inelegant simulation. # # # # # # # # # # # Exercises: 1) Rewrite the array loading and printing functions in a more intuitive and less kludgy fashion. 2) Figure out how the array rotation functions work. Hint: think about the implications of backwardsindexing an array. Rewrite this script to handle a nonsquare array, such as a 6 X 4 one. Try to minimize "distortion" when the array is rotated.

3)

A twodimensional array is essentially equivalent to a onedimensional 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 twodimensional array, see Example A10. For more interesting scripts using arrays, see: Example 113 and Example A23

Chapter 26. Arrays

400

Chapter 27. /dev and /proc

A Linux or UNIX machine typically has the /dev and /proc specialpurpose directories.

27.1. /dev
The /dev directory contains entries for the physical devices that may or may not be present in the hardware. [77] The hard drive partitions containing the mounted filesystem(s) have entries in /dev, as a simple df shows.
bash$ df Filesystem Mounted on /dev/hda6 /dev/hda1 /dev/hda8 /dev/hda5

1kblocks 495876 50755 367013 1714416

Used Available Use% 222748 3887 13262 1123624 247527 44248 334803 503704 48% 9% 4% 70% / /boot /home /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. [78] This enables mounting an entire filesystem within a single large file. See Example 168 and Example 167. A few of the pseudodevices in /dev have other specialized uses, such as /dev/null, /dev/zero, /dev/urandom, /dev/sda1, /dev/udp, and /dev/tcp. For instance: To mount a USB flash drive, append the following line to /etc/fstab. [79]
/dev/sda1 /mnt/flashdrive auto noauto,user,noatime 0 0

(See also Example A24.) Checking whether a disk is in the CDburner (softlinked to /dev/hdc):
head 1 /dev/hdc

# #

head: cannot open '/dev/hdc' for reading: No medium found (No disc in the drive.)

# head: error reading '/dev/hdc': Input/output error # (There is a disk in the drive, but it can't be read; #+ possibly it's an unrecorded CDR blank.) # # #+ # #+ Stream of characters and assorted gibberish (There is a prerecorded disk in the drive, and this is raw output a stream of ASCII and binary data.) Here we see the wisdom of using 'head' to limit the output to manageable proportions, rather than 'cat' or something similar.

# Now, it's just a matter of checking/parsing the output and taking #+ appropriate action.

Chapter 27. /dev and /proc

401

Advanced BashScripting Guide When executing a command on a /dev/tcp/$host/$port pseudodevice file, Bash opens a TCP connection to the associated socket. [80] Getting the time from nist.gov:
bash$ cat </dev/tcp/time.nist.gov/13 53082 040318 04:26:54 68 0 0 502.3 UTC(NIST) *

[Mark contributed the above example.] Downloading a URL:

bash$ exec 5<>/dev/tcp/www.net.cn/80 bash$ echo e "GET / HTTP/1.0\n" >&5 bash$ cat <&5

[Thanks, Mark and Mihai Maties.]

Example 271. Using /dev/tcp for troubleshooting

#!/bin/bash # devtcp.sh: /dev/tcp redirection to check Internet connection. # Script by Troy Engel. # Used with permission. TCP_HOST=www.dnsdiy.com TCP_PORT=80 # A known spamfriendly ISP. # Port 80 is http.

# Try to connect. (Somewhat similar to a 'ping' . . .) echo "HEAD / HTTP/1.0" >/dev/tcp/${TCP_HOST}/${TCP_PORT} MYEXIT=$? : <<EXPLANATION If bash was compiled with enablenetredirections, it has the capability of using a special character device for both TCP and UDP redirections. These redirections are used identically as STDIN/STDOUT/STDERR. The device entries are 30,36 for /dev/tcp: mknod /dev/tcp c 30 36 >From the bash reference: /dev/tcp/host/port If host is a valid hostname or Internet address, and port is an integer port number or service name, Bash attempts to open a TCP connection to the corresponding socket. EXPLANATION

if [ "X$MYEXIT" = "X0" ]; then echo "Connection successful. Exit code: $MYEXIT" else echo "Connection unsuccessful. Exit code: $MYEXIT" fi exit $MYEXIT

Chapter 27. /dev and /proc

402

Advanced BashScripting Guide

27.2. /proc
The /proc directory is actually a pseudofilesystem. The files in /proc mirror currently running system and kernel processes and contain information and statistics about them.
bash$ cat /proc/devices Character devices: 1 mem 2 pty 3 ttyp 4 ttyS 5 cua 7 vcs 10 misc 14 sound 29 fb 36 netlink 128 ptm 136 pts 162 raw 254 pcmcia Block devices: 1 ramdisk 2 fd 3 ide0 9 md

bash$ cat /proc/interrupts CPU0 0: 84505 XTPIC 1: 3375 XTPIC 2: 0 XTPIC 5: 1 XTPIC 8: 1 XTPIC 12: 4231 XTPIC 14: 109373 XTPIC NMI: 0 ERR: 0

timer keyboard cascade soundblaster rtc PS/2 Mouse ide0

bash$ cat /proc/partitions major minor #blocks name 3 3 3 3 ... 0 1 2 4 3007872 52416 1 165280

rio rmerge rsect ruse wio wmerge wsect wuse running use aveq

hda 4472 22260 114520 94240 3551 18703 50384 549710 0 111550 644030 hda1 27 395 844 960 4 2 14 180 0 800 1140 hda2 0 0 0 0 0 0 0 0 0 0 0 hda4 10 0 20 210 0 0 0 0 0 210 210

bash$ cat /proc/loadavg 0.13 0.42 0.27 2/44 1119

bash$ cat /proc/apm

Chapter 27. /dev and /proc

403

Advanced BashScripting Guide

1.16 1.2 0x03 0x01 0xff 0x80 1% 1 ?

bash$ cat /proc/acpi/battery/BAT0/info present: yes design capacity: 43200 mWh last full capacity: 36640 mWh battery technology: rechargeable design voltage: 10800 mV design capacity warning: 1832 mWh design capacity low: 200 mWh capacity granularity 1: 1 mWh capacity granularity 2: 1 mWh model number: IBM02K6897 serial number: 1133 battery type: LION OEM info: Panasonic

bash$ fgrep Mem /proc/meminfo MemTotal: 515216 kB MemFree: 266248 kB

Shell scripts may extract data from certain of the files in /proc. [81]
FS=iso grep $FS /proc/filesystems # ISO filesystem support in kernel? # iso9660

kernel_version=$( awk '{ print $3 }' /proc/version ) CPU=$( awk '/model name/ {print $5}' < /proc/cpuinfo ) if [ "$CPU" = "Pentium(R)" ] then run_some_commands ... else run_different_commands ... fi

cpu_speed=$( fgrep "cpu MHz" /proc/cpuinfo | awk '{print $4}' ) # Current operating speed (in MHz) of the cpu on your machine. # On a laptop this may vary, depending on use of battery #+ or AC power.

+
devfile="/proc/bus/usb/devices" text="Spd" USB1="Spd=12" USB2="Spd=480"

bus_speed=$(fgrep m 1 "$text" $devfile | awk '{print $9}') # ^^^^ Stop after first match.

Chapter 27. /dev and /proc

404

Advanced BashScripting Guide

if [ "$bus_speed" = "$USB1" ] then echo "USB 1.1 port found." # Do something appropriate for USB 1.1. fi

It is even possible to control certain peripherals with commands sent to the /proc directory.
root# echo on > /proc/acpi/ibm/light

This turns on the Thinklight in certain models of IBM/Lenovo Thinkpads. Of course, caution is advised when writing to /proc. The /proc directory contains subdirectories with unusual numerical names. Every one of these names maps to the process ID of a currently running process. Within each of these subdirectories, there are a number of files that hold useful information about the corresponding process. The stat and status files keep running statistics on the process, the cmdline file holds the commandline arguments the process was invoked with, and the exe file is a symbolic link to the complete path name of the invoking process. There are a few more such files, but these seem to be the most interesting from a scripting standpoint.

Example 272. Finding the process associated with a PID

#!/bin/bash # pididentifier.sh: # Gives complete path name to process associated with pid. ARGNO=1 # Number of arguments the script expects. E_WRONGARGS=65 E_BADPID=66 E_NOSUCHPROCESS=67 E_NOPERMISSION=68 PROCFILE=exe if [ $# ne $ARGNO ] then echo "Usage: `basename $0` PIDnumber" >&2 exit $E_WRONGARGS fi

# Error message >stderr.

pidno=$( ps ax | grep $1 | awk '{ print $1 }' | grep $1 ) # Checks for pid in "ps" listing, field #1. # Then makes sure it is the actual process, not the process invoked by this script. # The last "grep $1" filters out this possibility. # # pidno=$( ps ax | awk '{ print $1 }' | grep $1 ) # also works, as Teemu Huovila, points out. if [ z "$pidno" ] # If, after all the filtering, the result is a zerolength string, then #+ no running process corresponds to the pid given. echo "No such process running." exit $E_NOSUCHPROCESS fi # Alternatively:

Chapter 27. /dev and /proc

405

Advanced BashScripting Guide

# # # # # if ! ps $1 > /dev/null 2>&1 then # no running process corresponds to the pid given. echo "No such process running." exit $E_NOSUCHPROCESS fi

# To simplify the entire process, use "pidof".

if [ ! then echo echo exit fi

r "/proc/$1/$PROCFILE" ]

# Check for read permission.

"Process $1 running, but..." "Can't get read permission on /proc/$1/$PROCFILE." $E_NOPERMISSION # Ordinary user can't access some files in /proc.

# The last two tests may be replaced by: # if ! kill 0 $1 > /dev/null 2>&1 # '0' is not a signal, but # this will test whether it is possible # to send a signal to the process. # then echo "PID doesn't exist or you're not its owner" >&2 # exit $E_BADPID # fi

exe_file=$( ls l /proc/$1 | # Or exe_file=$( ls l # # /proc/pidnumber/exe is a #+ to the complete path name

grep "exe" | awk '{ print $11 }' ) /proc/$1/exe | awk '{print $11}' ) symbolic link of the invoking process.

if [ e "$exe_file" ] # If /proc/pidnumber/exe exists, then #+ then the corresponding process exists. echo "Process #$1 invoked by $exe_file." else echo "No such process running." fi

# This elaborate script can *almost* be replaced by # ps ax | grep $1 | awk '{ print $5 }' # However, this will not work... #+ because the fifth field of 'ps' is argv[0] of the process, #+ not the executable file path. # # However, either of the following would work. # find /proc/$1/exe printf '%l\n' # lsof aFn p $1 d txt | sed ne 's/^n//p' # Additional commentary by Stephane Chazelas. exit 0

Example 273. Online connect status

#!/bin/bash PROCNAME=pppd PROCFILENAME=status NOTCONNECTED=65 # ppp daemon # Where to look.

Chapter 27. /dev and /proc

406

Advanced BashScripting Guide

INTERVAL=2 # Update every 2 seconds.

pidno=$( ps ax | grep v "ps ax" | grep v grep | grep $PROCNAME | awk '{ print $1 }' ) # Finding the process number of 'pppd', the 'ppp daemon'. # Have to filter out the process lines generated by the search itself. # # However, as Oleg Philon points out, #+ this could have been considerably simplified by using "pidof". # pidno=$( pidof $PROCNAME ) # # Moral of the story: #+ When a command sequence gets too complex, look for a shortcut.

if [ z "$pidno" ] # If no pid, then process is not running. then echo "Not connected." exit $NOTCONNECTED else echo "Connected."; echo fi while [ true ] do # Endless loop, script can be improved here.

if [ ! e "/proc/$pidno/$PROCFILENAME" ] # While process running, then "status" file exists. then echo "Disconnected." exit $NOTCONNECTED fi netstat s | grep "packets received" # Get some connect statistics. netstat s | grep "packets delivered"

sleep $INTERVAL echo; echo done exit 0 # As it stands, this script must be terminated with a ControlC. # # # # Exercises: Improve the script so it exits on a "q" keystroke. Make the script more userfriendly in other ways.

In general, it is dangerous to write to the files in /proc, as this can corrupt the filesystem or crash the machine.

Chapter 27. /dev and /proc

407

Chapter 28. Of Zeros and Nulls

/dev/zero and /dev/null Uses of /dev/null Think of /dev/null as a "black hole." It is the nearest equivalent to a writeonly 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.
cat $filename >/dev/null # Contents of the file will not list to stdout.

Suppressing stderr (from Example 153).

rm $badname 2>/dev/null # So error messages [stderr] deepsixed.

Suppressing output from both stdout and stderr.

cat $filename 2>/dev/null >/dev/null # If "$filename" does not exist, there will be no error message output. # If "$filename" does exist, the contents of the file will not list to stdout. # Therefore, no output at all will result from the above line of code. # # This can be useful in situations where the return code from a command #+ needs to be tested, but no output is desired. # # cat $filename &>/dev/null # also works, as Baris Cicek points out.

Deleting contents of a file, but preserving the file itself, with all attendant permissions (from Example 21 and Example 23):
cat /dev/null > /var/log/messages # : > /var/log/messages has same effect, but does not spawn a new process. cat /dev/null > /var/log/wtmp

Automatically emptying the contents of a logfile (especially good for dealing with those nasty "cookies" sent by commercial Web sites):

Example 281. Hiding the cookie jar

if [ f ~/.netscape/cookies ] then rm f ~/.netscape/cookies fi # Remove, if exists.

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 device file, but it actually produces a stream of nulls (binary zeros, not the ASCII kind). Output written to /dev/zero disappears, and it is fairly difficult Chapter 28. Of Zeros and Nulls 408

Advanced BashScripting Guide to actually read the nulls from there, 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 predetermined length intended as a temporary swap file.

Example 282. Setting up a swapfile using /dev/zero

#!/bin/bash # Creating a swapfile. ROOT_UID=0 E_WRONG_USER=65 FILE=/swap BLOCKSIZE=1024 MINBLOCKS=40 SUCCESS=0 # Root has $UID 0. # Not root?

# This script must be run as root. if [ "$UID" ne "$ROOT_UID" ] then echo; echo "You must be root to run this script."; echo exit $E_WRONG_USER fi

blocks=${1:$MINBLOCKS} # # # # # # # # #

# Set to default of 40 blocks, #+ if nothing specified on command line. This is the equivalent of the command block below. if [ n "$1" ] then blocks=$1 else blocks=$MINBLOCKS fi

if [ "$blocks" lt $MINBLOCKS ] then blocks=$MINBLOCKS fi

# Must be at least 40 blocks long.

###################################################################### echo "Creating swap file of size $blocks blocks (KB)." dd if=/dev/zero of=$FILE bs=$BLOCKSIZE count=$blocks # Zero out file. mkswap $FILE $blocks # Designate it a swap file. swapon $FILE # Activate swap file. # Note that if one or more of these commands fails, #+ then it could cause nasty problems. ###################################################################### # Exercise: # Rewrite the above block of code so that if it does not execute #+ successfully, then: # 1) an error message is echoed to stderr, # 2) all temporary files are cleaned up, and

Chapter 28. Of Zeros and Nulls

409

Advanced BashScripting Guide

# #+ 3) the script exits in an orderly fashion with an appropriate error code.

echo "Swap file created and activated." 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 168) or "securely" deleting a file (see Example 1555).

Example 283. Creating a ramdisk

#!/bin/bash # ramdisk.sh # #+ # # #+ # # # #+ A "ramdisk" is a segment of system RAM memory which acts as if it were a filesystem. Its advantage is very fast access (read/write time). Disadvantages: volatility, loss of data on reboot or powerdown. less RAM available to system. Of what use is a ramdisk? Keeping a large dataset, such as a table or dictionary on ramdisk, speeds up data lookup, since memory access is much faster than disk access.

E_NON_ROOT_USER=70 ROOTUSER_NAME=root MOUNTPT=/mnt/ramdisk SIZE=2000 BLOCKSIZE=1024 DEVICE=/dev/ram0

# Must run as root.

# 2K blocks (change as appropriate) # 1K (1024 byte) block size # 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 if [ ! d "$MOUNTPT" ] then mkdir $MOUNTPT fi # Test whether mount point already there, #+ so no error if this script is run #+ multiple times.

############################################################################## dd if=/dev/zero of=$DEVICE count=$SIZE bs=$BLOCKSIZE # Zero out RAM device. # Why is this necessary? mke2fs $DEVICE # Create an ext2 filesystem on it. mount $DEVICE $MOUNTPT # Mount it. chmod 777 $MOUNTPT # Enables ordinary user to access ramdisk. # However, must be root to unmount it. ############################################################################## # Need to test whether above commands succeed. Could cause problems otherwise. # Exercise: modify this script to make it safer. echo "\"$MOUNTPT\" now available for use." # The ramdisk is now accessible for storing files, even by an ordinary user.

Chapter 28. Of Zeros and Nulls

410

Advanced BashScripting Guide

# Caution, the ramdisk is volatile, and its contents will disappear #+ on reboot or power loss. # Copy anything you want saved to a regular directory. # After reboot, run this script to again set up ramdisk. # Remounting /mnt/ramdisk without the other steps will not work. # Suitably modified, this script can by invoked in /etc/rc.d/rc.local, #+ to set up ramdisk automatically at bootup. # That may be appropriate on, for example, a database server. exit 0

In addition to all the above, /dev/zero is needed by ELF binaries.

Chapter 28. Of Zeros and Nulls

411

Chapter 29. Debugging

Debugging is twice as hard as writing the code in the first place. Therefore, if you write the code as cleverly as possible, you are, by definition, not smart enough to debug it. Brian Kernighan The Bash shell contains no debugger, nor even any debuggingspecific commands or constructs. [82] Syntax errors or outright typos in the script generate cryptic error messages that are often of no help in debugging a nonfunctional script.

Example 291. A buggy script

#!/bin/bash # ex74.sh # This is a buggy script. # Where, oh where is the error? a=37 if [$a gt 27 ] then echo $a fi exit 0

Output from script:

./ex74.sh: [37: command not found

What's wrong with the above script (hint: after the if)? Example 292. Missing keyword
#!/bin/bash # missingkeyword.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

Output from script:

missingkeyword.sh: line 10: syntax error: unexpected end of file

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. Error messages may disregard comment lines in a script when reporting the line number of a syntax error. What if the script executes, but does not work as expected? This is the all too familiar logic error. Chapter 29. Debugging 412

Advanced BashScripting Guide Example 293. test24: another buggy script

#!/bin/bash # #+ # # This script is supposed to delete all filenames in current directory containing embedded spaces. It doesn't work. Why not?

badname=`ls | grep ' '` # Try this: # echo "$badname" rm "$badname" exit 0

Try to find out what's wrong with Example 293 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.
# Correct methods of deleting filenames containing spaces. rm *\ * rm *" "* rm *' '* # Thank you. S.C.

Summarizing the symptoms of a buggy script, 1. It bombs with a "syntax error" message, or 2. It runs, but does not work as expected (logic error). 3. It runs, works as expected, but has nasty side effects (logic bomb). Tools for debugging nonworking scripts include 1. echo statements at critical points in the script to trace the variables, and otherwise give a snapshot of what is going on. Even better is an echo that echoes only when debug is on.
### debecho (debugecho), by Stefano Falsetto ### ### Will echo passed parameters only if DEBUG is set to a value. ### debecho () { if [ ! z "$DEBUG" ]; then echo "$1" >&2 # ^^^ to stderr fi } DEBUG=on Whatever=whatnot debecho $Whatever

# whatnot

Chapter 29. Debugging

413

Advanced BashScripting Guide

DEBUG= Whatever=notwhat debecho $Whatever

# (Will not echo.)

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.) Example 294. Testing a condition with an assert
#!/bin/bash # assert.sh ####################################################################### assert () # If condition false, { #+ exit from script #+ with appropriate error message. E_PARAM_ERR=98 E_ASSERT_FAILED=99

if [ z "$2" ] then return $E_PARAM_ERR fi lineno=$2

# Not enough parameters passed #+ to assert() function. # No damage done.

if [ ! $1 ] then echo "Assertion failed: \"$1\"" echo "File \"$0\", line $lineno" # Give name of file and line number. exit $E_ASSERT_FAILED # else # return # and continue executing the script. fi } # Insert a similar assert() function into a script you need to debug. #######################################################################

Chapter 29. Debugging

414

Advanced BashScripting Guide

a=5 b=4 condition="$a lt $b"

# Error message and exit from script. # Try setting "condition" to something else #+ and see what happens.

assert "$condition" $LINENO # The remainder of the script executes only if the "assert" does not fail.

# Some commands. # Some more commands . . . echo "This statement echoes only if the \"assert\" does not fail." # . . . # More commands . . . exit $?

5. Using the $LINENO variable and the caller builtin. 6. trapping at exit. The exit command in a script triggers a signal 0, terminating the process, that is, the script itself. [83] 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 Specifies an action on receipt of a signal; also useful for debugging. 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 ControlC, sends a user interrupt, an INT signal, to a running program.
trap '' 2 # Ignore interrupt 2 (ControlC), with no action specified. trap 'echo "ControlC disabled."' 2 # Message when ControlC pressed.

Example 295. Trapping at exit

#!/bin/bash # Hunting variables with a trap. trap 'echo Variable Listing a = $a b = $b' EXIT # EXIT is the name of the signal generated upon exit from a script. # # The command specified by the "trap" doesn't execute until #+ the appropriate signal is sent. echo "This prints before the \"trap\" " echo "even though the script sees the \"trap\" first." echo a=39 b=36

Chapter 29. Debugging

415

Advanced BashScripting Guide

exit 0 # Note that commenting out the 'exit' command makes no difference, #+ since the script exits in any case after running out of commands.

Example 296. Cleaning up after ControlC

#!/bin/bash # logon.sh: A quick 'n dirty script to check whether you are online yet. umask 177 # Make sure temp files are not world readable.

TRUE=1 LOGFILE=/var/log/messages # Note that $LOGFILE must be readable #+ (as root, chmod 644 /var/log/messages). TEMPFILE=temp.$$ # Create a "unique" temp file name, using process id of the script. # Using 'mktemp' is an alternative. # For example: # TEMPFILE=`mktemp temp.XXXXXX` 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. trap 'rm f $TEMPFILE; exit $USER_INTERRUPT' TERM INT # Cleans up the temp file if script interrupted by controlc. echo while [ $TRUE ] #Endless loop. do tail n $CHECK_LINES $LOGFILE> $TEMPFILE # Saves last 100 lines of system log file as temp file. # Necessary, since newer kernels generate many log messages at log on. search=`grep $KEYWORD $TEMPFILE` # Checks for presence of the "IP address" phrase, #+ indicating a successful logon. if [ ! z "$search" ] # then echo "Online" rm f $TEMPFILE # exit $ONLINE else echo n "." # #+ fi sleep 1 done Quotes necessary because of possible spaces.

Clean up temp file.

The n option to echo suppresses newline, so you get continuous rows of dots.

# Note: if you change the KEYWORD variable to "Exit", #+ this script can be used while online #+ to check for an unexpected logoff.

Chapter 29. Debugging

416

Advanced BashScripting Guide

# Exercise: Change the script, per the above note, # and prettify it. exit 0

# Nick Drage suggests an alternate method: while true do ifconfig ppp0 | grep UP 1> /dev/null && echo "connected" && exit 0 echo n "." # Prints dots (.....) until connected. sleep 2 done # Problem: Hitting ControlC to terminate this process may be insufficient. #+ (Dots may keep on echoing.) # Exercise: Fix this.

# Stephane Chazelas has yet another alternative: CHECK_INTERVAL=1 while ! tail n 1 "$LOGFILE" | grep q "$KEYWORD" do echo n . sleep $CHECK_INTERVAL done echo "Online" # Exercise: Discuss the relative strengths and weaknesses # of each of these various approaches.

The DEBUG argument to trap causes a specified action to execute after every command in a script. This permits tracing variables, for example. Example 297. Tracing a variable
#!/bin/bash trap 'echo "VARIABLETRACE> \$variable = \"$variable\""' DEBUG # Echoes the value of $variable after every command. variable=29 echo "Just initialized \"\$variable\" to $variable." let "variable *= 3" echo "Just multiplied \"\$variable\" by 3." exit $? # #+ #+ #+ The "trap 'command1 . . . command2 . . .' DEBUG" construct is more appropriate in the context of a complex script, where placing multiple "echo $variable" statements might be clumsy and timeconsuming.

# Thanks, Stephane Chazelas for the pointer.

Chapter 29. Debugging

417

Advanced BashScripting Guide

Output of script: VARIABLETRACE> $variable = "" VARIABLETRACE> $variable = "29" Just initialized "$variable" to 29. VARIABLETRACE> $variable = "29" VARIABLETRACE> $variable = "87" Just multiplied "$variable" by 3. VARIABLETRACE> $variable = "87"

Of course, the trap command has other uses aside from debugging.

Example 298. Running multiple processes (on an SMP box)

#!/bin/bash # parent.sh # Running multiple processes on an SMP box. # Author: Tedman Eng # This is the first of two scripts, #+ both of which must be present in the current working directory.

LIMIT=$1 # Total number of process to start NUMPROC=4 # Number of concurrent threads (forks?) PROCID=1 # Starting Process ID echo "My PID is $$" function start_thread() { if [ $PROCID le $LIMIT ] ; then ./child.sh $PROCID& let "PROCID++" else echo "Limit reached." wait exit fi } while [ "$NUMPROC" gt 0 ]; do start_thread; let "NUMPROC" done

while true do trap "start_thread" SIGRTMIN done exit 0

# ======== Second script follows ========

Chapter 29. Debugging

418

Advanced BashScripting Guide

#!/bin/bash # child.sh # Running multiple processes on an SMP box. # This script is called by parent.sh. # Author: Tedman Eng temp=$RANDOM index=$1 shift let "temp %= 5" let "temp += 4" echo "Starting $index Time:$temp" "$@" sleep ${temp} echo "Ending $index" kill s SIGRTMIN $PPID exit 0

# ======================= SCRIPT AUTHOR'S NOTES ======================= # # It's not completely bug free. # I ran it with limit = 500 and after the first few hundred iterations, #+ one of the concurrent threads disappeared! # Not sure if this is collisions from trap signals or something else. # Once the trap is received, there's a brief moment while executing the #+ trap handler but before the next trap is set. During this time, it may #+ be possible to miss a trap signal, thus miss spawning a child process. # No doubt someone may spot the bug and will be writing #+ . . . in the future.

# ===================================================================== #

# #

################################################################# # The following is the original script written by Vernia Damiano. # Unfortunately, it doesn't work properly. ################################################################# #!/bin/bash # Must call script with at least one integer parameter #+ (number of concurrent processes). # All other parameters are passed through to the processes started.

INDICE=8 TEMPO=5 E_BADARGS=65

# Total number of process to start # Maximum sleep time per process # No arg(s) passed to script.

if [ $# eq 0 ] # Check for at least one argument passed to script. then echo "Usage: `basename $0` number_of_processes [passed params]"

Chapter 29. Debugging

419

Advanced BashScripting Guide

exit $E_BADARGS fi NUMPROC=$1 shift PARAMETRI=( "$@" ) # Number of concurrent process # Parameters of each process

function avvia() { local temp local index temp=$RANDOM index=$1 shift let "temp %= $TEMPO" let "temp += 1" echo "Starting $index Time:$temp" "$@" sleep ${temp} echo "Ending $index" kill s SIGRTMIN $$ } function parti() { if [ $INDICE gt 0 ] ; then avvia $INDICE "${PARAMETRI[@]}" & let "INDICE" else trap : SIGRTMIN fi } trap parti SIGRTMIN while [ "$NUMPROC" gt 0 ]; do parti; let "NUMPROC" done wait trap SIGRTMIN exit $? : <<SCRIPT_AUTHOR_COMMENTS I had the need to run a program, with specified options, on a number of different files, using a SMP machine. So I thought [I'd] keep running a specified number of processes and start a new one each time . . . one of these terminates. The "wait" instruction does not help, since it waits for a given process or *all* process started in background. So I wrote [this] bash script that can do the job, using the "trap" instruction. Vernia Damiano SCRIPT_AUTHOR_COMMENTS

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.
trap '' 2 command # Signal 2 is ControlC, now disabled.

Chapter 29. Debugging

420

Advanced BashScripting Guide

command command trap 2

# Reenables ControlC

Version 3 of Bash adds the following special variables for use by the debugger. 1. $BASH_ARGC 2. $BASH_ARGV 3. $BASH_COMMAND 4. $BASH_EXECUTION_STRING 5. $BASH_LINENO 6. $BASH_SOURCE 7. $BASH_SUBSHELL

Chapter 29. Debugging

421

Chapter 30. Options

Options are settings that change shell and/or script behavior. 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 optionname or, in short form, set optionabbrev. These two forms are equivalent.
#!/bin/bash set o verbose # Echoes all commands before executing.

#!/bin/bash set v # Exact same effect as above.

To disable an option within a script, use set +o optionname or set +optionabbrev.

#!/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

An alternate method of enabling options in a script is to specify them immediately following the #! script header.
#!/bin/bash x # # Body of script follows.

Chapter 30. Options

422

Advanced BashScripting Guide 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 scriptname bash o verbose scriptname The following is a listing of some useful options. They may be specified in either abbreviated form (preceded by a single dash) or by complete name (preceded by a double dash or by o).

Table 301. Bash options Abbreviation C D a b c ... e f i n o OptionName o posix o pipefail p r s t u v x Name Effect noclobber Prevent overwriting of files by redirection (may be overridden by >|) (none) List doublequoted strings prefixed by $, but do not execute commands in script allexport Export all defined variables notify Notify when jobs running in background terminate (not of much use in a script) (none) Read commands from ... errexit Abort script at first error, when a command exits with nonzero status (except in until or while loops, iftests, list constructs) noglob Filename expansion (globbing) disabled interactive Script runs in interactive mode noexec Read commands in script, but do not execute them (syntax check) (none) Invoke the OptionName option POSIX Change the behavior of Bash, or invoked script, to conform to POSIX standard. pipe Causes a pipeline to return the exit status of the last command in the pipe failure that returned a nonzero return value. privileged Script runs as "suid" (caution!) restricted Script runs in restricted mode (see Chapter 21). stdin Read commands from stdin (none) Exit after first command nounset Attempt to use undefined variable outputs error message, and forces an exit verbose Print each command to stdout before executing it xtrace Similar to v, but expands commands (none) End of options flag. All other arguments are positional parameters. (none) Unset positional parameters. If arguments given ( arg1 arg2), positional parameters set to arguments.

Chapter 30. Options

423

Chapter 31. Gotchas

Turandot: Gli enigmi sono tre, la morte una! Caleph: No, no! Gli enigmi sono tre, una la vita! Puccini Here are some (nonrecommended!) scripting practices that will bring excitement to an otherwise dull life. Assigning reserved words or characters to variable names.
case=value0 # Causes problems. 23skidoo=value1 # Also problems. # Variable names starting with a digit are reserved by the shell. # Try _23skidoo=value1. Starting variables with an underscore is o.k. # However . . . _=25 echo $_ using just the underscore will not work. # $_ is a special variable set to last arg of last command.

xyz((!*=value2 # Causes severe problems. # As of version 3 of Bash, periods are not allowed within variable names.

Using a hyphen or other reserved characters in a variable name (or function name).
var1=23 # Use 'var_1' instead. functionwhatever () # Error # Use 'function_whatever ()' instead.

# As of version 3 of Bash, periods are not allowed within function names. function.whatever () # Error # Use 'functionWhatever ()' 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 # All this is legal, but highly confusing.

Using whitespace inappropriately. In contrast to other programming languages, Bash can be quite finicky about whitespace.
var1 = 23 # 'var1=23' is correct. # On line above, Bash attempts to execute command "var1" # with the arguments "=" and "23". let c = $a $b if [ $a le 5] # 'let c=$a$b' or 'let "c = $a $b"' are correct. # if [ $a le 5 ] is correct.

Chapter 31. Gotchas

424

Advanced BashScripting Guide

# if [ "$a" le 5 ] is even better. # [[ $a le 5 ]] also works.

Not terminating with a semicolon the final command in a code block within curly brackets.
{ ls l; df; echo "Done." } # bash: syntax error: unexpected end of file { ls l; df; echo "Done."; } # ^

### Final command needs semicolon.

Assuming uninitialized variables (variables before a value is assigned to them) are "zeroed out". An uninitialized variable has a value of null, not zero.
#!/bin/bash echo "uninitialized_var = $uninitialized_var" # uninitialized_var =

Mixing up = and eq in a test. Remember, = is for comparing literal variables and eq for integers.
if [ "$a" = 273 ] if [ "$a" eq 273 ] # Is $a an integer or string? # If $a is an integer.

# Sometimes you can mix up eq and = without adverse consequences. # However . . .

a=273.0

# Not an integer.

if [ "$a" = 273 ] then echo "Comparison works." else echo "Comparison does not work." fi # Comparison does not work. # Same with a=" 273" and a="0273".

# Likewise, problems trying to use "eq" with noninteger values. if [ "$a" eq 273.0 ] then echo "a = $a" fi # Aborts with an error message. # test.sh: [: 273.0: integer expression expected

Misusing string comparison operators. Example 311. Numerical and string comparison are not equivalent
#!/bin/bash # badop.sh: Trying to use a string comparison on integers. echo number=1 # The following "while loop" has two errors: #+ one blatant, and the other subtle. while [ "$number" < 5 ] # Wrong! Should be: while [ "$number" lt 5 ]

Chapter 31. Gotchas

425

Advanced BashScripting Guide

do echo n "$number " let "number += 1" done # Attempt to run this bombs with the error message: #+ badop.sh: line 10: 5: No such file or directory # Within single brackets, "<" must be escaped, #+ and even then, it's still wrong for comparing integers.

echo ""

while [ "$number" \< 5 ] do echo n "$number " let "number += 1" done

# # # #+ #+

1 2 3 4 This *seems to work, but . . . it actually does an ASCII comparison, rather than a numerical one.

echo; echo "" # This can cause problems. For example: lesser=5 greater=105 if [ "$greater" \< "$lesser" ] then echo "$greater is less than $lesser" fi # 105 is less than 5 # In fact, "105" actually is less than "5" #+ in a string comparison (ASCII sort order). echo exit 0

Sometimes variables within "test" brackets ([ ]) need to be quoted (double quotes). Failure to do so may cause unexpected behavior. See Example 76, Example 195, and Example 96. 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.
command1 2> | command2 # Trying to redirect error output of command1 into a pipe . . . # . . . will not work. command1 2>& | command2 Thanks, S.C. # Also futile.

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,

Chapter 31. Gotchas

426

Advanced BashScripting Guide

# you may set $minimum_version to 2.XX, 3.XX, or whatever is appropriate. E_BAD_VERSION=80 if [ "$BASH_VERSION" \< "$minimum_version" ] then echo "This script works only with Bash, version $minimum or greater." echo "Upgrade strongly recommended." exit $E_BAD_VERSION fi ...

Using Bashspecific functionality in a Bourne shell script (#!/bin/sh) on a nonLinux 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. Using undocumented features in Bash turns out to be a dangerous practice. In previous releases of this book there were several scripts that depended on the "feature" that, although the maximum value of an exit or return value was 255, that limit did not apply to negative integers. Unfortunately, in version 2.05b and later, that loophole disappeared. See Example 239. A script with DOStype 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 UNIXstyle newlines.
#!/bin/bash echo "Here" unix2dos $0 chmod 755 $0 # Script changes itself to DOS format. # Change back to execute permission. # The 'unix2dos' command removes execute permission. # Script tries to run itself again. # But it won't work as a DOS file.

./$0

echo "There" exit 0

A shell script headed by #!/bin/sh will not run in full Bashcompatibility mode. Some Bashspecific functions might be disabled. Scripts that need complete access to all the Bashspecific extensions should start with #!/bin/bash. Putting whitespace in front of the terminating limit string of a here document will cause unexpected behavior in a script. 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$ echo $WHATEVER bash$

Sure enough, back at the command prompt, $WHATEVER remains unset. 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.

Chapter 31. Gotchas

427

Advanced BashScripting Guide Example 312. Subshell Pitfalls

#!/bin/bash # Pitfalls of variables in a subshell. outer_variable=outer echo echo "outer_variable = $outer_variable" echo ( # Begin subshell echo "outer_variable inside subshell = $outer_variable" inner_variable=inner # Set echo "inner_variable inside subshell = $inner_variable" outer_variable=inner # Will value change globally? echo "outer_variable inside subshell = $outer_variable" # Will 'exporting' make a difference? # export inner_variable # export outer_variable # Try it and see. # End subshell ) echo echo "inner_variable outside subshell = $inner_variable" echo "outer_variable outside subshell = $outer_variable" echo exit 0 # What happens if you uncomment lines 19 and 20? # Does it make a difference?

# Unset. # Unchanged.

Piping echo output 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 1418).

Example 313. Piping the output of echo to a read

#!/bin/bash # badread.sh: # Attempting to use 'echo and 'read' #+ to assign variables noninteractively. a=aaa b=bbb c=ccc echo "one two three" | read a b c # Try to reassign a, b, and c. echo echo "a = $a" echo "b = $b" echo "c = $c" # Reassignment

# a = aaa # b = bbb # c = ccc failed.

Chapter 31. Gotchas

428

Advanced BashScripting Guide

# # Try the following alternative. var=`echo "one two three"` set $var a=$1; b=$2; c=$3 echo "" echo "a = $a" echo "b = $b" echo "c = $c" # Reassignment

# a = one # b = two # c = three succeeded.

# # # Note also that an echo to a 'read' works within a subshell. However, the value of the variable changes *only* within the subshell. # Starting all over again.

a=aaa b=bbb c=ccc

echo; echo echo "one two three" | ( read a b c; echo "Inside subshell: "; echo "a = $a"; echo "b = $b"; echo "c = $c" ) # a = one # b = two # c = three echo "" echo "Outside subshell: " echo "a = $a" # a = aaa echo "b = $b" # b = bbb echo "c = $c" # c = ccc echo exit 0

In fact, as Anthony Richardson points out, piping to any loop can cause a similar problem.
# Loop piping troubles. # This example by Anthony Richardson, #+ with addendum by Wilbert Berendsen.

foundone=false find $HOME type f atime +30 size 100k | while true do read f echo "$f is over 100KB and has not been accessed in over 30 days" echo "Consider moving the file to archives." foundone=true # echo "Subshell level = $BASH_SUBSHELL" # Subshell level = 1 # Yes, we're inside a subshell. # done # foundone will always be false here since it is

Chapter 31. Gotchas

429

Advanced BashScripting Guide

#+ set to true inside a subshell if [ $foundone = false ] then echo "No files need archiving." fi # =====================Now, here is the correct way:================= foundone=false for f in $(find $HOME type f atime +30 size 100k) # No pipe here. do echo "$f is over 100KB and has not been accessed in over 30 days" echo "Consider moving the file to archives." foundone=true done if [ $foundone = false ] then echo "No files need archiving." fi # ==================And here is another alternative================== # Places the part of the script that reads the variables #+ within a code block, so they share the same subshell. # Thank you, W.B. find $HOME type f atime +30 size 100k | { foundone=false while read f do echo "$f is over 100KB and has not been accessed in over 30 days" echo "Consider moving the file to archives." foundone=true done if ! $foundone then echo "No files need archiving." fi }

A related problem occurs when trying to write the stdout of a tail f piped to grep.
tail f /var/log/messages | grep "$ERROR_MSG" >> error.log # The "error.log" file will not have anything written to it.

Using "suid" commands within scripts is risky, as it may compromise system security. [84] 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 "crackerproof" shell scripts. Bash does not handle the double slash (//) string correctly. Bash scripts written for Linux or BSD systems may need fixups to run on a commercial UNIX (or Apple OSX) machine. Such scripts often employ the GNU set of commands and filters, which have greater functionality than their generic UNIX counterparts. This is particularly true of such text processing utilites as tr. Danger is near thee Beware, beware, beware, beware. Chapter 31. Gotchas 430

Advanced BashScripting Guide Many brave hearts are asleep in the deep. So beware Beware. A.J. Lamb and H.W. Petrie

Chapter 31. Gotchas

431

Chapter 32. Scripting With Style

Get into the habit of writing shell scripts in a structured and systematic manner. Even "onthefly" and "written on the back of an envelope" scripts will benefit if you take a few minutes to plan and organize your thoughts before sitting down and coding. Herewith are a few stylistic guidelines. This is not intended as an Official Shell Scripting Stylesheet.

32.1. Unofficial Shell Scripting Stylesheet

Comment your code. This makes it easier for others to understand (and appreciate), and easier for you to maintain.
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.)

Add descriptive headers to your scripts and functions.

#!/bin/bash #************************************************# # xyz.sh # # written by Bozo Bozeman # # July 05, 2001 # # # # Clean up project files. # #************************************************# E_BADDIR=65 projectdir=/home/bozo/projects # No such directory. # Directory to clean up. # # # # # #

# # cleanup_pfiles () # Removes all files in designated directory. # Parameter: $target_directory # Returns: 0 on success, $E_BADDIR if something went wrong. # cleanup_pfiles () { if [ ! d "$1" ] # Test if target directory exists. then echo "$1 is not a directory." return $E_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," [85] that is, "hardwired" literal constants. Use meaningful variable names instead. This makes the script easier to understand and permits making changes and updates Chapter 32. Scripting With Style 432

Advanced BashScripting Guide 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 if [ f "$LOGFILE" ] then ... fi

# Only line that needs to be changed.

Choose descriptive names for variables and functions.

fl=`ls al $dirname` file_listing=`ls al $dirname` # Cryptic. # Better.

MAXVAL=10 # All caps used for a script constant. while [ "$index" le "$MAXVAL" ] ...

E_NOTFOUND=75 if [ ! e "$filename" ] then echo "File $filename not found." exit $E_NOTFOUND fi

# Uppercase for an errorcode, # +and name begins with "E_".

MAIL_DIRECTORY=/var/spool/mail/bozo export MAIL_DIRECTORY

# Uppercase for an environmental variable.

GetAnswer () { prompt=$1 echo n $prompt read answer return $answer }

# Mixed case works well for a function.

GetAnswer "What is your favorite number? " favorite_number=$? echo $favorite_number

_uservariable=23 # Permissible, but not recommended. # It's better for userdefined variables not to start with an underscore. # Leave that for system variables.

Use exit codes in a systematic and meaningful way.

E_WRONG_ARGS=65 ... ... exit $E_WRONG_ARGS

See also Appendix D. Chapter 32. Scripting With Style 433

Advanced BashScripting Guide Ender suggests using the exit codes in /usr/include/sysexits.h in shell scripts, though these are primarily intended for C and C++ programming. Use standardized parameter flags for script invocation. Ender proposes the following set of flags.
a b c d e h l m n r s u v V All: Return all information (including hidden file info). Brief: Short version, usually for other scripts. Copy, concatenate, etc. Daily: Use information from the whole day, and not merely information for a specific instance/user. Extended/Elaborate: (often does not include hidden file info). Help: Verbose usage w/descs, aux info, discussion, help. See also V. Log output of script. Manual: Launch manpage for base command. Numbers: Numerical data only. Recursive: All files in a directory (and/or all subdirs). Setup & File Maintenance: Config files for this script. Usage: List of invocation flags for the script. Verbose: Human readable output, more or less formatted. Version / License / Copy(right|left) / Contribs (email too).

See also Section F.1. Break complex scripts into simpler modules. Use functions where appropriate. See Example 344. Don't use a complex construct where a simpler one will do.
COMMAND if [ $? eq 0 ] ... # Redundant and nonintuitive. if COMMAND ... # More concise (if perhaps not quite as legible).

... reading the UNIX source code to the Bourne shell (/bin/sh). I was shocked at how much simple algorithms could be made cryptic, and therefore useless, by a poor choice of code style. I asked myself, "Could someone be proud of this code?" Landon Noll

Chapter 32. Scripting With Style

434

Chapter 33. Miscellany

Nobody really knows what the Bourne shell's grammar is. Even examination of the source code is little help. Tom Duff

33.1. Interactive and noninteractive shells and scripts

An interactive shell reads commands from user input on a tty. Among other things, such a shell reads startup files on activation, displays a prompt, and enables job control by default. The user can interact with the shell. A shell running a script is always a noninteractive 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 # This example script, and much of the above explanation supplied by # Stphane Chazelas (thanks again).

Let us consider an interactive script to be one that requires input from the user, usually with read statements (see Example 143). "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 noninteractive, since they must run without human intervention. Many administrative and system maintenance scripts are likewise noninteractive. Unvarying repetitive tasks cry out for automation by noninteractive scripts. Noninteractive 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 purpose scripts that run in either interactive or noninteractive modes. 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 # noninteractive ... else # interactive ... fi

Chapter 33. Miscellany

435

Advanced BashScripting Guide Alternatively, the script can test for the presence of option "i" in the $ flag.
case $ in *i*) # interactive shell ;; *) # noninteractive 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.

33.2. Shell Wrappers

A "wrapper" is a shell script that embeds a system command or utility, that saves a set of parameters passed to that command. [86] Wrapping a script around a complex command line simplifies invoking it. This is expecially useful with sed and awk. A sed or awk script would normally be invoked from the command line by a sed e 'commands' or awk 'commands'. Embedding such a script in a Bash script permits calling it more simply, and makes it "reusable". This also enables combining the functionality of sed and awk, for example piping the output of a set of sed commands to awk. As a saved executable file, you can then repeatedly invoke it in its original form or modified, without the inconvenience of retyping it on the command line.

Example 331. shell wrapper

#!/bin/bash # # # # # # # # # # # This is a simple script that removes blank lines from a file. No argument checking. You might wish to add something like: E_NOARGS=65 if [ z "$1" ] then echo "Usage: `basename $0` targetfile" exit $E_NOARGS fi

# Same as # sed e '/^$/d' filename # invoked from the command line. sed e /^$/d "$1" # The 'e' means an "editing" command follows (optional here). # '^' is the beginning of line, '$' is the end. # This match lines with nothing between the beginning and the end, #+ blank lines. # The 'd' is the delete command. # Quoting the commandline arg permits #+ whitespace and special characters in the filename.

Chapter 33. Miscellany

436

Advanced BashScripting Guide

# # Note that this script doesn't actually change the target file. If you need to do that, redirect its output.

exit 0

Example 332. A slightly more complex shell wrapper

#!/bin/bash # "subst", a script that substitutes one pattern for #+ another in a file, #+ i.e., "subst Smith Jones letter.txt". ARGS=3 E_BADARGS=65 # Script requires 3 arguments. # Wrong number of arguments passed to script.

if [ $# ne "$ARGS" ] # Test number of arguments to script (always a good idea). then echo "Usage: `basename $0` oldpattern newpattern filename" exit $E_BADARGS fi old_pattern=$1 new_pattern=$2 if [ f "$3" ] then file_name=$3 else echo "File \"$3\" does not exist." exit $E_BADARGS fi

Here is where the heavy work gets done.

# sed e "s/$old_pattern/$new_pattern/g" $file_name # # #+ # #+ # 's' is, of course, the substitute command in sed, and /pattern/ invokes address matching. The "g", or global flag causes substitution for *every* occurence of $old_pattern on each line, not just the first. Read the literature on 'sed' for an indepth explanation. # Successful invocation of the script returns 0.

exit 0

Example 333. A generic shell wrapper that writes to a logfile

#!/bin/bash # Generic shell wrapper that performs an operation #+ and logs it. # Must set the following two variables. OPERATION= # Can be a complex chain of commands, #+ for example an awk script or a pipe . . .

Chapter 33. Miscellany

437

Advanced BashScripting Guide

LOGFILE= # Commandline arguments, if any, for the operation.

OPTIONS="$@"

# Log it. echo "`date` + `whoami` + $OPERATION "$@"" >> $LOGFILE # Now, do it. exec $OPERATION "$@" # It's necessary to do the logging before the operation. # Why?

Example 334. A shell wrapper around an awk script

#!/bin/bash # prascii.sh: Prints a table of ASCII characters. START=33 END=125 # Range of printable ASCII characters (decimal).

echo " Decimal echo "

Hex

Character" "

# Header.

for ((i=START; i<=END; i++)) do echo $i | awk '{printf(" %3d %2x %c\n", $1, $1, $1)}' # The Bash printf builtin will not work in this context: # printf "%c" "$i" done exit 0

# # # # # # # # # # # # #

Decimal 33 34 35 36 . . . 122 123 124 125

Hex 21 22 23 24

Character ! " # $

7a 7b 7c 7d

z { | }

# Redirect the output of this script to a file #+ or pipe it to "more": sh prasc.sh | more

Example 335. A shell wrapper around another awk script

#!/bin/bash # Adds up a specified column (of numbers) in the target file.

Chapter 33. Miscellany

438

Advanced BashScripting Guide

ARGS=2 E_WRONGARGS=65 if [ $# ne "$ARGS" ] # Check for proper no. of command line args. then echo "Usage: `basename $0` filename columnnumber" exit $E_WRONGARGS fi filename=$1 column_number=$2 # # #+ # # # # Passing shell variables to the awk part of the script is a bit tricky. One method is to strongquote the Bashscript variable within the awk script. $'$BASH_SCRIPT_VAR' ^ ^ This is done in the embedded awk script below. See the awk documentation for more details. awk ' ..... '

# A multiline awk script is invoked by:

# Begin awk script. # awk ' { total += $'"${column_number}"' } END { print total } ' "$filename" # # End awk script.

# #+ # # # # # # # #

It may not be safe to pass shell variables to an embedded awk script, so Stephane Chazelas proposes the following alternative: awk v column_number="$column_number" ' { total += $column_number } END { print total }' "$filename"

exit 0

For those scripts needing a single doitall tool, a Swiss army knife, there is Perl. Perl combines the capabilities of sed and awk, and throws in a large subset of C, to boot. It is modular and contains support for everything ranging from objectoriented programming up to and including the kitchen sink. Short Perl scripts lend themselves to embedding in shell scripts, and there may even be some substance to the claim that Perl can totally replace shell scripting (though the author of this document remains skeptical).

Example 336. Perl embedded in a Bash script

Chapter 33. Miscellany

439

Advanced BashScripting Guide

#!/bin/bash # Shell commands may precede the Perl script. echo "This precedes the embedded Perl script within \"$0\"." echo "===============================================================" perl e 'print "This is an embedded Perl script.\n";' # Like sed, Perl also uses the "e" option. echo "===============================================================" echo "However, the script may also contain shell and system commands." exit 0

It is even possible to combine a Bash script and Perl script within the same file. Depending on how the script is invoked, either the Bash part or the Perl part will execute.

Example 337. Bash and Perl scripts combined

#!/bin/bash # bashandperl.sh echo "Greetings from the Bash part of the script." # More Bash commands may follow here. exit 0 # End of Bash part of the script. # ======================================================= #!/usr/bin/perl # This part of the script must be invoked with x option. print "Greetings from the Perl part of the script.\n"; # More Perl commands may follow here. # End of Perl part of the script. bash$ bash bashandperl.sh Greetings from the Bash part of the script.

bash$ perl x bashandperl.sh Greetings from the Perl part of the script.

33.3. Tests and Comparisons: Alternatives

For tests, the [[ ]] construct may be more appropriate than [ ]. Likewise, arithmetic comparisons might benefit from the (( )) construct.
a=8 # All of the comparisons below are equivalent. test "$a" lt 16 && echo "yes, $a < 16" /bin/test "$a" lt 16 && echo "yes, $a < 16" [ "$a" lt 16 ] && echo "yes, $a < 16"

# "and list"

Chapter 33. Miscellany

440

Advanced BashScripting Guide

[[ $a lt 16 ]] && echo "yes, $a < 16" (( a < 16 )) && echo "yes, $a < 16" # Quoting variables within # [[ ]] and (( )) not necessary.

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. # Thank you, S.C.

33.4. Recursion
Can a script recursively call itself? Indeed.

Example 338. A (useless) script that recursively calls itself

#!/bin/bash # recurse.sh # # # Can a script recursively call itself? Yes, but is this of any practical use? (See the following.)

RANGE=10 MAXVAL=9 i=$RANDOM let "i %= $RANGE"

# Generate a random number between 0 and $RANGE 1.

if [ "$i" lt "$MAXVAL" ] then echo "i = $i" ./$0 # Script recursively spawns a new instance of itself. fi # Each child script does the same, until #+ a generated $i equals $MAXVAL. # # Using a "while" loop instead of an "if/then" test causes problems. Explain why.

exit 0 # # # # # Note: This script must have execute permission for it to work properly. This is the case even if it is invoked by an "sh" command. Explain why.

Example 339. A (useful) script that recursively calls itself

#!/bin/bash # pb.sh: phone book # Written by Rick Boivie, and used with permission.

Chapter 33. Miscellany

441

Advanced BashScripting Guide

# Modifications by ABS Guide author. MINARGS=1 # Script needs at least one argument. DATAFILE=./phonebook # A data file in current working directory #+ named "phonebook" must exist. PROGNAME=$0 E_NOARGS=70 # No arguments error. if [ $# lt $MINARGS ]; then echo "Usage: "$PROGNAME" data" exit $E_NOARGS fi

if [ $# eq $MINARGS ]; then grep $1 "$DATAFILE" # 'grep' prints an error message if $DATAFILE not present. else ( shift; "$PROGNAME" $* ) | grep $1 # Script recursively calls itself. fi exit 0 # Script exits here. # Therefore, it's o.k. to put #+ nonhashmarked comments and data after this point.

# Sample "phonebook" datafile: John Doe 1555 Main St., Baltimore, MD 21228 (410) 2223333 Mary Moe 9899 Jones Blvd., Warren, NH 03787 (603) 8983232 Richard Roe 856 E. 7th St., New York, NY 10009 (212) 3334567 Sam Roe 956 E. 8th St., New York, NY 10009 (212) 4445678 Zoe Zenobia 4481 N. Baker St., San Francisco, SF 94338 (415) 5011631 # $bash pb.sh Roe Richard Roe 856 E. 7th St., New York, NY 10009 Sam Roe 956 E. 8th St., New York, NY 10009 $bash pb.sh Roe Sam Sam Roe 956 E. 8th St., New York, NY 10009

(212) 3334567 (212) 4445678

(212) 4445678

# When more than one argument is passed to this script, #+ it prints *only* the line(s) containing all the arguments.

Example 3310. Another (useful) script that recursively calls itself

#!/bin/bash # usrmnt.sh, written by Anthony Richardson # Used with permission. # usage: usrmnt.sh # description: mount device, invoking user must be listed in the # MNTUSERS group in the /etc/sudoers file. # # This is a usermount script that reruns itself using sudo. # A user with the proper permissions only has to type

Chapter 33. Miscellany

442

Advanced BashScripting Guide

# usermount /dev/fd0 /mnt/floppy

# instead of # sudo usermount /dev/fd0 /mnt/floppy

# I use this same technique for all of my #+ sudo scripts, because I find it convenient. # # If SUDO_COMMAND variable is not set we are not being run through #+ sudo, so rerun ourselves. Pass the user's real and group id . . . if [ z "$SUDO_COMMAND" ] then mntusr=$(id u) grpusr=$(id g) sudo $0 $* exit 0 fi # We will only get here if we are being run by sudo. /bin/mount $* o uid=$mntusr,gid=$grpusr exit 0 # Additional notes (from the author of this script): # # 1) Linux allows the "users" option in the /etc/fstab # file so that any user can mount removable media. # But, on a server, I like to allow only a few # individuals access to removable media. # I find using sudo gives me more control. # 2) I also find sudo to be more convenient than # accomplishing this task through groups. # 3) This method gives anyone with proper permissions # root access to the mount command, so be careful # about who you allow access. # You can get finer control over which access can be mounted # by using this same technique in separate mntfloppy, mntcdrom, # and mntsamba scripts.

Too many levels of recursion can exhaust the script's stack space, causing a segfault.

33.5. "Colorizing" Scripts

The ANSI [87] escape sequences set screen attributes, such as bold text, and color of foreground and background. DOS batch files commonly used ANSI escape codes for color output, and so can Bash scripts.

Example 3311. A "colorized" address database

#!/bin/bash # ex30a.sh: "Colorized" version of ex30.sh. # Crude address database

Chapter 33. Miscellany

443

Advanced BashScripting Guide

clear # Clear the screen.

echo n " " echo e '\E[37;44m'"\033[1mContact List\033[0m" # White on blue background echo; echo echo e "\033[1mChoose one of the following persons:\033[0m" # Bold tput sgr0 echo "(Enter only the first letter of name.)" echo echo en '\E[47;34m'"\033[1mE\033[0m" # Blue tput sgr0 # Reset colors to "normal." echo "vans, Roland" # "[E]vans, Roland" echo en '\E[47;35m'"\033[1mJ\033[0m" # Magenta tput sgr0 echo "ones, Mildred" echo en '\E[47;32m'"\033[1mS\033[0m" # Green tput sgr0 echo "mith, Julie" echo en '\E[47;31m'"\033[1mZ\033[0m" # Red tput sgr0 echo "ane, Morris" echo 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) 7349874" echo "(303) 7349892 fax" echo "[email protected]" echo "Business partner & old friend" ;; "J" | "j" ) echo echo "Mildred Jones" echo "249 E. 7th St., Apt. 19" echo "New York, NY 10009" echo "(212) 5332814" echo "(212) 5339972 fax" echo "[email protected]" echo "Girlfriend" echo "Birthday: Feb. 11" ;; # Add info for Smith & Zane later. * ) # Default option. # Empty input (hitting RETURN) fits here, too. echo echo "Not yet in database."

Chapter 33. Miscellany

444

Advanced BashScripting Guide

;; esac tput sgr0 echo exit 0 # Reset colors to "normal."

Example 3312. Drawing a box

#!/bin/bash # Drawbox.sh: Drawing a box using ASCII characters. # Script by Stefano Palmeri, with minor editing by document author. # Minor edits suggested by Jim Angstadt. # Used in the "ABS Guide" with permission.

###################################################################### ### draw_box function doc ### # The "draw_box" function lets the user #+ draw a box into a terminal. # # Usage: draw_box ROW COLUMN HEIGHT WIDTH [COLOR] # ROW and COLUMN represent the position #+ of the upper left angle of the box you're going to draw. # ROW and COLUMN must be greater than 0 #+ and less than current terminal dimension. # HEIGHT is the number of rows of the box, and must be > 0. # HEIGHT + ROW must be <= than current terminal height. # WIDTH is the number of columns of the box and must be > 0. # WIDTH + COLUMN must be <= than current terminal width. # # E.g.: If your terminal dimension is 20x80, # draw_box 2 3 10 45 is good # draw_box 2 3 19 45 has bad HEIGHT value (19+2 > 20) # draw_box 2 3 18 78 has bad WIDTH value (78+3 > 80) # # COLOR is the color of the box frame. # This is the 5th argument and is optional. # 0=black 1=red 2=green 3=tan 4=blue 5=purple 6=cyan 7=white. # If you pass the function bad arguments, #+ it will just exit with code 65, #+ and no messages will be printed on stderr. # # Clear the terminal before you start to draw a box. # The clear command is not contained within the function. # This allows the user to draw multiple boxes, even overlapping ones. ### end of draw_box function doc ### ###################################################################### draw_box(){ #=============# HORZ="" VERT="|" CORNER_CHAR="+"

Chapter 33. Miscellany

445

Advanced BashScripting Guide

MINARGS=4 E_BADARGS=65 #=============#

if [ $# lt "$MINARGS" ]; then exit $E_BADARGS fi

# If args are less than 4, exit.

# Looking for non digit chars in arguments. # Probably it could be done better (exercise for the reader?). if echo $@ | tr d [:blank:] | tr d [:digit:] | grep . &> /dev/null; then exit $E_BADARGS fi BOX_HEIGHT=`expr $3 1` BOX_WIDTH=`expr $4 1` T_ROWS=`tput lines` T_COLS=`tput cols` # #+ # #+ 1 correction needed because angle char "+" is a part of both box height and width. Define current terminal dimension in rows and columns.

if [ $1 lt 1 ] || [ $1 gt $T_ROWS ]; then # Start checking if arguments exit $E_BADARGS #+ are correct. fi if [ $2 lt 1 ] || [ $2 gt $T_COLS ]; then exit $E_BADARGS fi if [ `expr $1 + $BOX_HEIGHT + 1` gt $T_ROWS ]; then exit $E_BADARGS fi if [ `expr $2 + $BOX_WIDTH + 1` gt $T_COLS ]; then exit $E_BADARGS fi if [ $3 lt 1 ] || [ $4 lt 1 ]; then exit $E_BADARGS fi # End checking arguments. plot_char(){ echo e "\E[${1};${2}H"$3 } echo ne "\E[3${5}m" # start drawing the box count=1 for (( r=$1; count<=$BOX_HEIGHT; r++)); do plot_char $r $2 $VERT let count=count+1 done count=1 c=`expr $2 + $BOX_WIDTH` for (( r=$1; count<=$BOX_HEIGHT; r++)); do plot_char $r $c $VERT let count=count+1 done count=1 for (( c=$2; count<=$BOX_WIDTH; c++)); do plot_char $1 $c $HORZ let count=count+1 # Draw horizontal lines using #+ plot_char function. # Draw vertical lines using #+ plot_char function. # Function within a function.

# Set box frame color, if defined.

Chapter 33. Miscellany

446

Advanced BashScripting Guide

done count=1 r=`expr $1 + $BOX_HEIGHT` for (( c=$2; count<=$BOX_WIDTH; c++)); do plot_char $r $c $HORZ let count=count+1 done plot_char plot_char plot_char plot_char $1 $2 $CORNER_CHAR # Draw box angles. $1 `expr $2 + $BOX_WIDTH` $CORNER_CHAR `expr $1 + $BOX_HEIGHT` $2 $CORNER_CHAR `expr $1 + $BOX_HEIGHT` `expr $2 + $BOX_WIDTH` $CORNER_CHAR # # Restore old colors. Put the prompt at bottom of the terminal.

echo ne "\E[0m" P_ROWS=`expr $T_ROWS 1` echo e "\E[${P_ROWS};1H" }

# Now, let's try drawing a box. clear # Clear the terminal. R=2 # Row C=3 # Column H=10 # Height W=45 # Width col=1 # Color (red) draw_box $R $C $H $W $col # Draw the box. exit 0 # Exercise: # # Add the option of printing text within the drawn box.

The simplest, and perhaps most useful ANSI escape sequence is bold text, \033[1m ... \033[0m. The \033 represents an escape, the "[1" turns on the bold attribute, while the "[0" switches it off. The "m" terminates each term of the escape sequence.
bash$ echo e "\033[1mThis is bold text.\033[0m"

A similar escape sequence switches on the underline attribute (on an rxvt and an aterm).
bash$ echo e "\033[4mThis is underlined text.\033[0m"

With an echo, the e option enables the escape sequences. Other escape sequences change the text and/or background color.
bash$ echo e '\E[34;47mThis prints in blue.'; tput sgr0

bash$ echo e '\E[33;44m'"yellow text on blue background"; tput sgr0

bash$ echo e '\E[1;33;44m'"BOLD yellow text on blue background"; tput sgr0

Chapter 33. Miscellany

447

Advanced BashScripting Guide It's usually advisable to set the bold attribute for lightcolored foreground text. The tput sgr0 restores the terminal settings to normal. Omitting this lets all subsequent output from that particular terminal remain blue. Since tput sgr0 fails to restore terminal settings under certain circumstances, echo ne \E[0m may be a better choice. Use the following template for writing colored text on a colored background. echo e '\E[COLOR1;COLOR2mSome text goes here.' The "\E[" begins the escape sequence. The semicolonseparated numbers "COLOR1" and "COLOR2" specify a foreground and a background color, according to the table below. (The order of the numbers does not matter, since the foreground and background numbers fall in nonoverlapping ranges.) The "m" terminates the escape sequence, and the text begins immediately after that. Note also that single quotes enclose the remainder of the command sequence following the echo e. The numbers in the following table work for an rxvt terminal. Results may vary for other terminal emulators.

Table 331. Numbers representing colors in Escape Sequences Color black red green yellow blue magenta cyan white Foreground 30 31 32 33 34 35 36 37 Background 40 41 42 43 44 45 46 47

Example 3313. Echoing colored text

#!/bin/bash # colorecho.sh: Echoing text messages in color. # Modify this script for your own purposes. # It's easier than handcoding color. black='\E[30;47m' red='\E[31;47m' green='\E[32;47m' yellow='\E[33;47m' blue='\E[34;47m' magenta='\E[35;47m' cyan='\E[36;47m' white='\E[37;47m'

Chapter 33. Miscellany

448

Advanced BashScripting Guide

alias Reset="tput sgr0" # Reset text attributes to normal #+ without clearing screen.

cecho ()

# Colorecho. # Argument $1 = message # Argument $2 = color

{ local default_msg="No message passed." # Doesn't really need to be a local variable. message=${1:$default_msg} color=${2:$black} echo e "$color" echo "$message" Reset return } # Defaults to default message. # Defaults to black, if not specified.

# Reset to normal.

# Now, let's try it out. # cecho "Feeling blue..." $blue cecho "Magenta looks more like purple." $magenta cecho "Green with envy." $green cecho "Seeing red?" $red cecho "Cyan, more familiarly known as aqua." $cyan cecho "No color passed (defaults to black)." # Missing $color argument. cecho "\"Empty\" color passed (defaults to black)." "" # Empty $color argument. cecho # Missing $message and $color arguments. cecho "" "" # Empty $message and $color arguments. # echo exit 0 # # # # Exercises: 1) Add the "bold" attribute to the 'cecho ()' function. 2) Add options for colored backgrounds.

Example 3314. A "horserace" game

#!/bin/bash # horserace.sh: Very simple horserace simulation. # Author: Stefano Palmeri # Used with permission. ################################################################ # Goals of the script: # playing with escape sequences and terminal colors. # # Exercise: # Edit the script to make it run less randomly,

Chapter 33. Miscellany

449

Advanced BashScripting Guide

#+ set up a fake betting shop . . . # Um . . . um . . . it's starting to remind me of a movie . . . # # The script gives each horse a random handicap. # The odds are calculated upon horse handicap #+ and are expressed in European(?) style. # E.g., odds=3.75 means that if you bet $1 and win, #+ you receive $3.75. # # The script has been tested with a GNU/Linux OS, #+ using xterm and rxvt, and konsole. # On a machine with an AMD 900 MHz processor, #+ the average race time is 75 seconds. # On faster computers the race time would be lower. # So, if you want more suspense, reset the USLEEP_ARG variable. # # Script by Stefano Palmeri. ################################################################ E_RUNERR=65 # Check if md5sum and bc are installed. if ! which bc &> /dev/null; then echo bc is not installed. echo "Can\'t run . . . " exit $E_RUNERR fi if ! which md5sum &> /dev/null; then echo md5sum is not installed. echo "Can\'t run . . . " exit $E_RUNERR fi # Set the following variable to slow down script execution. # It will be passed as the argument for usleep (man usleep) #+ and is expressed in microseconds (500000 = half a second). USLEEP_ARG=0 # Clean up the temp directory, restore terminal cursor and #+ terminal colors if script interrupted by CtlC. trap 'echo en "\E[?25h"; echo en "\E[0m"; stty echo;\ tput cup 20 0; rm fr $HORSE_RACE_TMP_DIR' TERM EXIT # See the chapter on debugging for an explanation of 'trap.' # Set a unique (paranoid) name for the temp directory the script needs. HORSE_RACE_TMP_DIR=$HOME/.horserace`date +%s``head c10 /dev/urandom \ | md5sum | head c30` # Create the temp directory and move right in. mkdir $HORSE_RACE_TMP_DIR cd $HORSE_RACE_TMP_DIR

# This function moves the cursor to line $1 column $2 and then prints $3. # E.g.: "move_and_echo 5 10 linux" is equivalent to #+ "tput cup 4 9; echo linux", but with one command instead of two. # Note: "tput cup" defines 0 0 the upper left angle of the terminal, #+ echo defines 1 1 the upper left angle of the terminal. move_and_echo() { echo ne "\E[${1};${2}H""$3" }

Chapter 33. Miscellany

450

Advanced BashScripting Guide

# Function to generate a pseudorandom number between 1 and 9. random_1_9 () { head c10 /dev/urandom | md5sum | tr d [az] | tr d 0 | cut c1 } # Two functions that simulate "movement," when drawing the horses. draw_horse_one() { echo n " "//$MOVE_HORSE// } draw_horse_two(){ echo n " "\\\\$MOVE_HORSE\\\\ }

# Define current terminal dimension. N_COLS=`tput cols` N_LINES=`tput lines` # Need at least a 20LINES X 80COLUMNS terminal. Check it. if [ $N_COLS lt 80 ] || [ $N_LINES lt 20 ]; then echo "`basename $0` needs a 80cols X 20lines terminal." echo "Your terminal is ${N_COLS}cols X ${N_LINES}lines." exit $E_RUNERR fi

# Start drawing the race field. # Need a string of 80 chars. See below. BLANK80=`seq s "" 100 | head c80` clear # Set foreground and background colors to white. echo ne '\E[37;47m' # Move the cursor on the upper left angle of the terminal. tput cup 0 0 # Draw six white lines. for n in `seq 5`; do echo $BLANK80 # Use the 80 chars string to colorize the terminal. done # Sets foreground color to black. echo ne '\E[30m' move_and_echo move_and_echo move_and_echo move_and_echo move_and_echo move_and_echo move_and_echo move_and_echo move_and_echo move_and_echo 3 3 1 1 2 2 4 4 5 5 1 "START 1" 75 FINISH 5 "|" 80 "|" 5 "|" 80 "|" 5 "| 2" 80 "|" 5 "V 3" 80 "V"

# Set foreground color to red. echo ne '\E[31m'

Chapter 33. Miscellany

451

Advanced BashScripting Guide

# Some ASCII art. move_and_echo 1 8 "..@@@..@@@@@...@@@@@.@...@..@@@@..." move_and_echo 2 8 ".@...@...@.......@...@...@.@......." move_and_echo 3 8 ".@@@@@...@.......@...@@@@@.@@@@...." move_and_echo 4 8 ".@...@...@.......@...@...@.@......." move_and_echo 5 8 ".@...@...@.......@...@...@..@@@@..." move_and_echo 1 43 "@@@@...@@@...@@@@..@@@@..@@@@." move_and_echo 2 43 "@...@.@...@.@.....@.....@....." move_and_echo 3 43 "@@@@..@@@@@.@.....@@@@...@@@.." move_and_echo 4 43 "@..@..@...@.@.....@.........@." move_and_echo 5 43 "@...@.@...@..@@@@..@@@@.@@@@.."

# Set foreground and background colors to green. echo ne '\E[32;42m' # Draw eleven green lines. tput cup 5 0 for n in `seq 11`; do echo $BLANK80 done # Set foreground color to black. echo ne '\E[30m' tput cup 5 0 # Draw the fences. echo "++++++++++++++++++++++++++++++++++++++\ ++++++++++++++++++++++++++++++++++++++++++" tput cup 15 0 echo "++++++++++++++++++++++++++++++++++++++\ ++++++++++++++++++++++++++++++++++++++++++" # Set foreground and background colors to white. echo ne '\E[37;47m' # Draw three white lines. for n in `seq 3`; do echo $BLANK80 done # Set foreground color to black. echo ne '\E[30m' # Create 9 files to stores handicaps. for n in `seq 10 7 68`; do touch $n done # Set the first type of "horse" the script will draw. HORSE_TYPE=2 # Create positionfile and oddsfile for every "horse". #+ In these files, store the current position of the horse, #+ the type and the odds. for HN in `seq 9`; do touch horse_${HN}_position touch odds_${HN} echo \1 > horse_${HN}_position echo $HORSE_TYPE >> horse_${HN}_position # Define a random handicap for horse.

Chapter 33. Miscellany

452

Advanced BashScripting Guide

HANDICAP=`random_1_9` # Check if the random_1_9 function returned a good value. while ! echo $HANDICAP | grep [19] &> /dev/null; do HANDICAP=`random_1_9` done # Define last handicap position for horse. LHP=`expr $HANDICAP \* 7 + 3` for FILE in `seq 10 7 $LHP`; do echo $HN >> $FILE done # Calculate odds. case $HANDICAP in 1) ODDS=`echo $HANDICAP \* 0.25 + 1.25 | bc` echo $ODDS > odds_${HN} ;; 2 | 3) ODDS=`echo $HANDICAP \* 0.40 + 1.25 | bc` echo $ODDS > odds_${HN} ;; 4 | 5 | 6) ODDS=`echo $HANDICAP \* 0.55 + 1.25 | bc` echo $ODDS > odds_${HN} ;; 7 | 8) ODDS=`echo $HANDICAP \* 0.75 + 1.25 | bc` echo $ODDS > odds_${HN} ;; 9) ODDS=`echo $HANDICAP \* 0.90 + 1.25 | bc` echo $ODDS > odds_${HN} esac

done

# Print odds. print_odds() { tput cup 6 0 echo ne '\E[30;42m' for HN in `seq 9`; do echo "#$HN odds>" `cat odds_${HN}` done } # Draw the horses at starting line. draw_horses() { tput cup 6 0 echo ne '\E[30;42m' for HN in `seq 9`; do echo /\\$HN/\\" done } print_odds echo ne '\E[47m' # Wait for a enter key press to start the race. # The escape sequence '\E[?25l' disables the cursor. tput cup 17 0 echo e '\E[?25l'Press [enter] key to start the race... read s # # Disable normal echoing in the terminal. This avoids key presses that might "contaminate" the screen

"

Chapter 33. Miscellany

453

Advanced BashScripting Guide

#+ during the race. stty echo # # Start the race. draw_horses echo ne '\E[37;47m' move_and_echo 18 1 $BLANK80 echo ne '\E[30m' move_and_echo 18 1 Starting... sleep 1 # Set the column of the finish line. WINNING_POS=74 # Define the time the race started. START_TIME=`date +%s` # COL variable needed by following "while" construct. COL=0 while [ $COL lt $WINNING_POS ]; do MOVE_HORSE=0 # Check if the random_1_9 function has returned a good value. while ! echo $MOVE_HORSE | grep [19] &> /dev/null; do MOVE_HORSE=`random_1_9` done # Define old type and position of the "randomized horse". HORSE_TYPE=`cat horse_${MOVE_HORSE}_position | tail n 1` COL=$(expr `cat horse_${MOVE_HORSE}_position | head n 1`) ADD_POS=1 # Check if the current position is an handicap position. if seq 10 7 68 | grep w $COL &> /dev/null; then if grep w $MOVE_HORSE $COL &> /dev/null; then ADD_POS=0 grep v w $MOVE_HORSE $COL > ${COL}_new rm f $COL mv f ${COL}_new $COL else ADD_POS=1 fi else ADD_POS=1 fi COL=`expr $COL + $ADD_POS` echo $COL > horse_${MOVE_HORSE}_position # Store new position. # Choose the type of horse to draw. case $HORSE_TYPE in 1) HORSE_TYPE=2; DRAW_HORSE=draw_horse_two ;; 2) HORSE_TYPE=1; DRAW_HORSE=draw_horse_one esac echo $HORSE_TYPE >> horse_${MOVE_HORSE}_position # Store current type. # Set foreground color to black and background to green. echo ne '\E[30;42m'

Chapter 33. Miscellany

454

Advanced BashScripting Guide

# Move the cursor to new horse position. tput cup `expr $MOVE_HORSE + 5` \ `cat horse_${MOVE_HORSE}_position | head n 1` # Draw the horse. $DRAW_HORSE usleep $USLEEP_ARG # When all horses have gone beyond field line 15, reprint odds. touch fieldline15 if [ $COL = 15 ]; then echo $MOVE_HORSE >> fieldline15 fi if [ `wc l fieldline15 | cut f1 d " "` = 9 ]; then print_odds : > fieldline15 fi # Define the leading horse. HIGHEST_POS=`cat *position | sort n | tail 1` # Set background color to white. echo ne '\E[47m' tput cup 17 0 echo n Current leader: `grep w $HIGHEST_POS *position | cut c7`\ " " done # Define the time the race finished. FINISH_TIME=`date +%s` # Set background color to green and enable blinking text. echo ne '\E[30;42m' echo en '\E[5m' # Make the winning horse blink. tput cup `expr $MOVE_HORSE + 5` \ `cat horse_${MOVE_HORSE}_position | head n 1` $DRAW_HORSE # Disable blinking text. echo en '\E[25m' # Set foreground and background color to white. echo ne '\E[37;47m' move_and_echo 18 1 $BLANK80 # Set foreground color to black. echo ne '\E[30m' # Make winner blink. tput cup 17 0 echo e "\E[5mWINNER: $MOVE_HORSE\E[25m"" Odds: `cat odds_${MOVE_HORSE}`"\ " Race time: `expr $FINISH_TIME $START_TIME` secs" # Restore cursor and old colors. echo en "\E[?25h" echo en "\E[0m" # Restore echoing. stty echo

Chapter 33. Miscellany

455

Advanced BashScripting Guide

# Remove race temp directory. rm rf $HORSE_RACE_TMP_DIR tput cup 19 0 exit 0

See also Example A22. There is, however, a major problem with all this. ANSI escape sequences are emphatically nonportable. What works fine on some terminal emulators (or the console) may work differently, or not at all, on others. A "colorized" script that looks stunning on the script author's machine may produce unreadable output on someone else's. This greatly compromises the usefulness of "colorizing" scripts, and possibly relegates this technique to the status of a gimmick or even a "toy". Moshe Jacobson's color utility (http://runslinux.net/projects.html#color) considerably simplifies using ANSI escape sequences. It substitutes a clean and logical syntax for the clumsy constructs just discussed. Henry/teikedvl has likewise created a utility (http://scriptechocolor.sourceforge.net/) to simplify creation of colorized scripts.

33.6. Optimizations
Most shell scripts are quick 'n dirty solutions to noncomplex 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 timeconsuming operations from within loops. Use builtin commands in preference to system commands. Builtins execute faster and usually do not launch a subshell when invoked. Avoid unnecessary commands, particularly in a pipe.
cat "$file" | grep "$word" grep "$word" "$file" # The above command lines have an identical effect, #+ but the second runs faster since it launches one fewer subprocess.

The cat command seems especially prone to overuse in scripts. Use the time and times tools to profile computationintensive commands. Consider rewriting timecritical 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 highlevel languages may work for scripts, but others, such Chapter 33. Miscellany 456

Advanced BashScripting Guide 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 1542.

33.7. Assorted Tips

You have a problem that you want to solve by writing a Bash script. Unfortunately, you don't know quite where to start. One method is to plunge right in and code those parts of the script that come easily, and write the hard parts as pseudocode.
#!/bin/bash ARGCOUNT=1 E_WRONGARGS=65 # Need name as argument.

if [ numberofarguments isnotequalto "$ARGCOUNT" ] # ^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^ # Can't figure out how to code this . . . #+ . . . so write it in pseudocode. then echo "Usage: nameofscript name" # ^^^^^^^^^^^^^^ More pseudocode. exit $E_WRONGARGS fi . . . exit 0

# Later on, substitute working code for the pseudocode. # Line 6 becomes: if [ $# ne "$ARGCOUNT" ] # Line 12 becomes: echo "Usage: `basename $0` name"

For an example of using pseudocode, see the Square Root exercise. To keep a record of which user scripts have run during a particular session or over a number of sessions, add the following lines to each script you want to keep track of. This will keep a continuing file record of the script names and invocation times.
# Append (>>) following to end of each script tracked. whoami>> $SAVE_FILE echo $0>> $SAVE_FILE date>> $SAVE_FILE echo>> $SAVE_FILE # # # # User invoking the script. Script name. Date and time. Blank line as separator.

# Of course, SAVE_FILE defined and exported as environmental variable in ~/.bashrc #+ (something like ~/.scriptsrun)

Chapter 33. Miscellany

457

Advanced BashScripting Guide The >> operator appends lines to a file. What if you wish to prepend a line to an existing file, that is, to paste it in at the beginning?
file=data.txt title="***This is the title line of data text file***" echo $title | cat $file >$file.new # "cat " concatenates stdout to $file. # End result is #+ to write a new file with $title appended at *beginning*.

This is a simplified variant of the Example 1813 script given earlier. And, of course, sed can also do this. A shell script may act as an embedded command inside another shell script, a Tcl or wish script, or even a Makefile. It can be invoked as an external shell command in a C program using the system() call, i.e., system("script_name");. Setting a variable to the contents of an embedded sed or awk script increases the readability of the surrounding shell wrapper. See Example A1 and Example 1420. Put together files containing your favorite and most useful definitions and functions. As necessary, "include" one or more of these "library files" in scripts with either the dot (.) or source command.
# SCRIPT LIBRARY # # Note: # No "#!" here. # No "live code" either.

# Useful variable definitions ROOT_UID=0 E_NOTROOT=101 MAXRETVAL=255 SUCCESS=0 FAILURE=1 # Root has $UID 0. # Not root user error. # Maximum (positive) return value of a function.

# Functions Usage () { if [ z "$1" ] then msg=filename else msg=$@ fi # "Usage:" message. # No arg passed.

echo "Usage: `basename $0` "$msg"" }

Check_if_root () # Check if root running script. { # From "ex39.sh" example. if [ "$UID" ne "$ROOT_UID" ] then echo "Must be root to run this script." exit $E_NOTROOT

Chapter 33. Miscellany

458

Advanced BashScripting Guide

fi }

CreateTempfileName () # Creates a "unique" temp filename. { # From "ex51.sh" example. prefix=temp suffix=`eval date +%s` Tempfilename=$prefix.$suffix }

isalpha2 () # Tests whether *entire string* is alphabetic. { # From "isalpha.sh" example. [ $# eq 1 ] || return $FAILURE case $1 in *[!azAZ]*|"") return $FAILURE;; *) return $SUCCESS;; esac # Thanks, S.C. }

abs () { E_ARGERR=999999 if [ z "$1" ] then return $E_ARGERR fi if [ "$1" ge 0 ] then absval=$1 else let "absval = (( 0 $1 ))" fi return $absval }

# Absolute value. # Caution: Max return value = 255.

# Need arg passed. # Obvious error value returned.

# # # # #

If nonnegative, stays asis. Otherwise, change sign.

tolower () { if [ z "$1" ] then echo "(null)" return fi

# Converts string(s) passed as argument(s) #+ to lowercase. # #+ #+ #+ If no argument(s) passed, send error message (Cstyle voidpointer error message) and return from function.

echo "$@" | tr AZ az # Translate all passed arguments ($@). return # Use command substitution to set a variable to function output. # For example: # oldvar="A seT of miXedcaSe LEtTerS" # newvar=`tolower "$oldvar"` # echo "$newvar" # a set of mixedcase letters

Chapter 33. Miscellany

459

Advanced BashScripting Guide

# # Exercise: Rewrite this function to change lowercase passed argument(s) # to uppercase ... toupper() [easy]. }

Use specialpurpose comment headers to increase clarity and legibility in scripts.

## Caution. rm rf *.zzy

## The "rf" options to "rm" are very dangerous, ##+ especially with wildcards.

#+ # #+ #+

Line continuation. This is line 1 of a multiline comment, and this is the final line.

#* Note. #o List item. #> Another point of view. while [ "$var1" != "end" ]

#> while test "$var1" != "end"

A particularly clever use of iftest constructs is commenting out blocks of code.

#!/bin/bash COMMENT_BLOCK= # Try setting the above variable to some value #+ for an unpleasant surprise. if [ $COMMENT_BLOCK ]; then Comment block ================================= This is a comment line. This is another comment line. This is yet another comment line. ================================= echo "This will not echo." Comment blocks are errorfree! Whee! fi echo "No more comments, please." exit 0

Compare this with using here documents to comment out code blocks. Using the $? exit status variable, a script may test if a parameter contains only digits, so it can be treated as an integer.
#!/bin/bash SUCCESS=0 E_BADINPUT=65 test "$1" ne 0 o "$1" eq 0 2>/dev/null # An integer is either equal to 0 or not equal to 0. # 2>/dev/null suppresses error message.

Chapter 33. Miscellany

460

Advanced BashScripting Guide

if [ $? ne "$SUCCESS" ] then echo "Usage: `basename $0` integerinput" exit $E_BADINPUT fi let "sum = $1 + 25" echo "Sum = $sum" # Would give error if $1 not integer.

# Any variable, not just a command line parameter, can be tested this way. exit 0

The 0 255 range for function return values is a severe limitation. Global variables and other workarounds are often problematic. An alternative method for a function to communicate a value back to the main body of the script is to have the function write to stdout (usually with echo) the "return value," and assign this to a variable. This is actually a variant of command substitution. Example 3315. Return value trickery
#!/bin/bash # multiplication.sh multiply () { local product=1 until [ z "$1" ] do let "product *= $1" shift done echo $product } mult1=15383; mult2=25211 val1=`multiply $mult1 $mult2` echo "$mult1 X $mult2 = $val1" # 387820813 mult1=25; mult2=5; mult3=20 val2=`multiply $mult1 $mult2 $mult3` echo "$mult1 X $mult2 X $mult3 = $val2" # 2500 mult1=188; mult2=37; mult3=25; mult4=47 val3=`multiply $mult1 $mult2 $mult3 $mult4` echo "$mult1 X $mult2 X $mult3 X $mult4 = $val3" # 8173300 exit 0 # Until uses up arguments passed... # Multiplies params passed. # Will accept a variable number of args.

# Will not echo to stdout, #+ since this will be assigned to a variable.

The same technique also works for alphanumeric strings. This means that a function can "return" a nonnumeric value.
capitalize_ichar () { # Capitalizes initial character #+ of argument string(s) passed.

Chapter 33. Miscellany

461

Advanced BashScripting Guide

string0="$@" firstchar=${string0:0:1} string1=${string0:1} # Accepts multiple arguments. # First character. # Rest of string(s).

FirstChar=`echo "$firstchar" | tr az AZ` # Capitalize first character. echo "$FirstChar$string1" } newstring=`capitalize_ichar "every sentence should start with a capital letter."` echo "$newstring" # Every sentence should start with a capital letter. # Output to stdout.

It is even possible for a function to "return" multiple values with this method.

Example 3316. Even more return value trickery

#!/bin/bash # sumproduct.sh # A function may "return" more than one value. sum_and_product () # Calculates both sum and product of passed args. { echo $(( $1 + $2 )) $(( $1 * $2 )) # Echoes to stdout each calculated value, separated by space. } echo echo "Enter first number " read first echo echo "Enter second number " read second echo retval=`sum_and_product $first $second` sum=`echo "$retval" | awk '{print $1}'` product=`echo "$retval" | awk '{print $2}'` echo "$first + $second = $sum" echo "$first * $second = $product" echo exit 0 # Assigns output of function. # Assigns first field. # Assigns second field.

Next in our bag of trick are techniques for passing an array to a function, then "returning" an array back to the main body of the script. Passing an array involves loading the spaceseparated elements of the array into a variable with command substitution. Getting an array back as the "return value" from a function uses the previously mentioned strategem of echoing the array in the function, then invoking command substitution and the ( ... ) operator to assign it to an array.

Example 3317. Passing and returning arrays

Chapter 33. Miscellany

462

Advanced BashScripting Guide

#!/bin/bash # arrayfunction.sh: Passing an array to a function and... # "returning" an array from a function

Pass_Array () { local passed_array # Local variable. passed_array=( `echo "$1"` ) echo "${passed_array[@]}" # List all the elements of the new array #+ declared and set within the function. }

original_array=( element1 element2 element3 element4 element5 ) echo echo "original_array = ${original_array[@]}" # List all elements of original array.

# This is the trick that permits passing an array to a function. # ********************************** argument=`echo ${original_array[@]}` # ********************************** # Pack a variable #+ with all the spaceseparated elements of the original array. # # Note that attempting to just pass the array itself will not work.

# This is the trick that allows grabbing an array as a "return value". # ***************************************** returned_array=( `Pass_Array "$argument"` ) # ***************************************** # Assign 'echoed' output of function to array variable. echo "returned_array = ${returned_array[@]}" echo "=============================================================" # Now, try it again, #+ attempting to access (list) the array from outside the function. Pass_Array "$argument" # The function itself lists the array, but... #+ accessing the array from outside the function is forbidden. echo "Passed array (within function) = ${passed_array[@]}" # NULL VALUE since this is a variable local to the function. echo exit 0

For a more elaborate example of passing arrays to functions, see Example A10. Using the double parentheses construct, it is possible to use Clike syntax for setting and incrementing variables and in for and while loops. See Example 1012 and Example 1017. Setting the path and umask at the beginning of a script makes it more "portable" more likely to run on a "foreign" machine whose user may have bollixed up the $PATH and umask.
#!/bin/bash PATH=/bin:/usr/bin:/usr/local/bin ; export PATH

Chapter 33. Miscellany

463

Advanced BashScripting Guide

umask 022 # Files that the script creates will have 755 permission.

# Thanks to Ian D. Allen, for this tip.

A useful scripting technique is to repeatedly feed the output of a filter (by piping) back to the same filter, but with a different set of arguments and/or options. Especially suitable for this are tr and grep.
# From "wstrings.sh" example. wlist=`strings "$1" | tr AZ az | tr '[:space:]' Z | \ tr cs '[:alpha:]' Z | tr s '\173\377' Z | tr Z ' '`

Example 3318. Fun with anagrams

#!/bin/bash # agram.sh: Playing games with anagrams. # Find anagrams of... LETTERSET=etaoinshrdlu FILTER='.......' # How many letters minimum? # 1234567 anagram "$LETTERSET" | grep "$FILTER" | grep '^is' | grep v 's$' | grep v 'ed$' # Possible to add many # #+ # # # Find all anagrams of the letterset... # With at least 7 letters, # starting with 'is' # no plurals # no past tense verbs combinations of conditions and filters.

Uses "anagram" utility that is part of the author's "yawl" word list package. http://ibiblio.org/pub/Linux/libs/yawl0.3.2.tar.gz http://personal.riverusers.com/~thegrendel/yawl0.3.2.tar.gz # End of code.

exit 0

bash$ sh agram.sh islander isolate isolead isotheral

# # # # #+

Exercises: Modify this script to take the LETTERSET as a commandline parameter. Parameterize the filters in lines 11 13 (as with $FILTER), so that they can be specified by passing arguments to a function.

# For a slightly different approach to anagramming, #+ see the agram2.sh script.

See also Example 273, Example 1522, and Example A9. Use "anonymous here documents" to comment out blocks of code, to save having to individually comment out each line with a #. See Example 1811. Running a script on a machine that relies on a command that might not be installed is dangerous. Use whatis to avoid potential problems with this.

Chapter 33. Miscellany

464

Advanced BashScripting Guide

CMD=command1 PlanB=command2 # First choice. # Fallback option.

command_test=$(whatis "$CMD" | grep 'nothing appropriate') # If 'command1' not found on system , 'whatis' will return #+ "command1: nothing appropriate." # # A safer alternative is: # command_test=$(whereis "$CMD" | grep \/) # But then the sense of the following test would have to be reversed, #+ since the $command_test variable holds content only if #+ the $CMD exists on the system. # (Thanks, bojster.)

if [[ z "$command_test" ]] then $CMD option1 option2 else $PlanB fi

# Check whether command present. # Run command1 with options. # Otherwise, #+ run command2.

An ifgrep test may not return expected results in an error case, when text is output to stderr, rather that stdout.
if ls l nonexistent_filename | grep q 'No such file or directory' then echo "File \"nonexistent_filename\" does not exist." fi

Redirecting stderr to stdout fixes this.

if ls l nonexistent_filename 2>&1 | grep q 'No such file or directory' # ^^^^ then echo "File \"nonexistent_filename\" does not exist." fi # Thanks, Chris Martin, for pointing this out.

The runparts command is handy for running a set of command scripts in sequence, particularly in combination with cron or at. It would be nice to be able to invoke XWindows widgets from a shell script. There happen to exist several packages that purport to do so, namely Xscript, Xmenu, and widtools. The first two of these no longer seem to be maintained. Fortunately, it is still possible to obtain widtools here. The widtools (widget tools) package requires the XForms library to be installed. Additionally, the Makefile needs some judicious editing before the package will build on a typical Linux system. Finally, three of the six widgets offered do not work (and, in fact, segfault). The dialog family of tools offers a method of calling "dialog" widgets from a shell script. The original dialog utility works in a text console, but its successors, gdialog, Xdialog, and kdialog use XWindowsbased widget sets.

Example 3319. Widgets invoked from a shell script

#!/bin/bash # dialog.sh: Using 'gdialog' widgets. # Must have 'gdialog' installed on your system to run this script. # Version 1.1 (corrected 04/05/05)

Chapter 33. Miscellany

465

Advanced BashScripting Guide

# This script was inspired by the following article. # "Scripting for X Productivity," by Marco Fioretti, # LINUX JOURNAL, Issue 113, September 2003, pp. 869. # Thank you, all you good people at LJ.

# Input error in dialog box. E_INPUT=65 # Dimensions of display, input widgets. HEIGHT=50 WIDTH=60 # Output file name (constructed out of script name). OUTFILE=$0.output # Display this script in a text widget. gdialog title "Displaying: $0" textbox $0 $HEIGHT $WIDTH

# Now, we'll try saving input in a file. echo n "VARIABLE=" > $OUTFILE gdialog title "User Input" inputbox "Enter variable, please:" \ $HEIGHT $WIDTH 2>> $OUTFILE

if [ "$?" eq 0 ] # It's good practice to check exit status. then echo "Executed \"dialog box\" without errors." else echo "Error(s) in \"dialog box\" execution." # Or, clicked on "Cancel", instead of "OK" button. rm $OUTFILE exit $E_INPUT fi

# Now, we'll retrieve and display the saved variable. . $OUTFILE # 'Source' the saved file. echo "The variable input in the \"input box\" was: "$VARIABLE""

rm $OUTFILE

# Clean up by removing the temp file. # Some applications may need to retain this file.

exit $?

For other methods of scripting with widgets, try Tk or wish (Tcl derivatives), PerlTk (Perl with Tk extensions), tksh (ksh with Tk extensions), XForms4Perl (Perl with XForms extensions), GtkPerl (Perl with Gtk extensions), or PyQt (Python with Qt extensions). For doing multiple revisions on a complex script, use the rcs Revision Control System package. Among other benefits of this is automatically updated ID header tags. The co command in rcs does a parameter replacement of certain reserved key words, for example, replacing #$Id$ in a script with something like:
#$Id: helloworld.sh,v 1.1 2004/10/16 02:43:05 bozo Exp $

Chapter 33. Miscellany

466

Advanced BashScripting Guide

33.8. Security Issues

33.8.1. Infected Shell Scripts
A brief warning about script security is appropriate. A shell script may contain a worm, trojan, or even a virus. For that reason, never run as root a script (or permit it to be inserted into the system startup scripts in /etc/rc.d) unless you have obtained said script from a trusted source or you have carefully analyzed it to make certain it does nothing harmful. 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 too easy for even a novice, a "script kiddie", to write one. [88] 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.

33.8.2. Hiding Shell Script Source

For security purposes, it may be necessary to render a script unreadable. If only there were a utility to create a stripped binary executable from a script. Francisco Rosales' shc generic shell script compiler does exactly that. Unfortunately, according to an article in the October, 2005 Linux Journal, the binary can, in at least some cases, be decrypted to recover the original script source. Still, this could be a useful method of keeping scripts secure from all but the most skilled hackers.

33.9. Portability Issues

This book deals specifically with Bash scripting on a GNU/Linux system. All the same, users of sh and ksh will find much of value here. 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. Another alternative is to use a
#!/bin/sh

header in the script, rather than

#!/bin/bash

Note that /bin/sh is a link to /bin/bash in Linux and certain other flavors of UNIX, and a script invoked this way disables extended Bash functionality. Most Bash scripts will run asis under ksh, and viceversa, since Chet Ramey has been busily porting ksh features to the latest versions of Bash. On a commercial UNIX machine, scripts using GNUspecific features of standard commands may not work. This has become less of a problem in the last few years, as the GNU utilities have pretty much displaced their proprietary counterparts even on "bigiron" UNIX. Caldera's release of the source to many of the original UNIX utilities has accelerated the trend. Chapter 33. Miscellany 467

Advanced BashScripting Guide Bash has certain features that the traditional Bourne shell lacks. Among these are: Certain extended invocation options Command substitution using $( ) notation Certain string manipulation operations Process substitution Bashspecific builtins See the Bash F.A.Q. for a complete listing.

33.10. Shell Scripting Under Windows

Even users running that other OS can run UNIXlike shell scripts, and therefore benefit from many of the lessons of this book. The Cygwin package from Cygnus and the MKS utilities from Mortice Kern Associates add shell scripting capabilities to Windows. There have been intimations that a future release of Windows will contain Bashlike command line scripting capabilities, but that remains to be seen.

Chapter 33. Miscellany

468

Chapter 34. Bash, versions 2 and 3

34.1. Bash, version 2
The current version of Bash, the one you have running on your machine, is version 2.xx.y or 3.xx.y.
bash$ echo $BASH_VERSION 2.05.b.0(1)release

The version 2 update of the classic Bash scripting language added array variables, [89] string and parameter expansion, and a better method of indirect variable references, among other features. Example 341. String expansion
#!/bin/bash # String expansion. # Introduced with version 2 of Bash. # Strings of the form $'xxx' #+ have the standard escaped characters interpreted. echo $'Ringing bell 3 times \a \a \a' # May only ring once with certain terminals. echo $'Three form feeds \f \f \f' echo $'10 newlines \n\n\n\n\n\n\n\n\n\n' echo $'\102\141\163\150' # Bash # Octal equivalent of characters. exit 0

Example 342. Indirect variable references the new way

#!/bin/bash # Indirect variable referencing. # This has a few of the attributes of references in C++.

a=letter_of_alphabet letter_of_alphabet=z echo "a = $a" # Direct reference.

echo "Now a = ${!a}" # Indirect reference. # The ${!variable} notation is greatly superior to the old "eval var1=\$$var2" echo t=table_cell_3 table_cell_3=24 echo "t = ${!t}" table_cell_3=387 echo "Value of t changed to ${!t}"

# t = 24 # 387

Chapter 34. Bash, versions 2 and 3

469

Advanced BashScripting Guide

# #+ # #+ This is useful for referencing members of an array or table, or for simulating a multidimensional array. An indexing option (analogous to pointer arithmetic) would have been nice. Sigh.

exit 0

Example 343. Simple database application, using indirect variable referencing

#!/bin/bash # resistorinventory.sh # Simple database application using indirect variable referencing. # ============================================================== # # Data B1723_value=470 B1723_powerdissip=.25 B1723_colorcode="yellowvioletbrown" B1723_loc=173 B1723_inventory=78 B1724_value=1000 B1724_powerdissip=.25 B1724_colorcode="brownblackred" B1724_loc=24N B1724_inventory=243 B1725_value=10000 B1725_powerdissip=.25 B1725_colorcode="brownblackorange" B1725_loc=24N B1725_inventory=89 # ============================================================== # # # # # # Ohms Watts Color bands Where they are How many

echo PS3='Enter catalog number: ' echo select catalog_number in "B1723" "B1724" "B1725" do Inv=${catalog_number}_inventory Val=${catalog_number}_value Pdissip=${catalog_number}_powerdissip Loc=${catalog_number}_loc Ccode=${catalog_number}_colorcode echo echo echo echo echo break done

"Catalog number $catalog_number:" "There are ${!Inv} of [${!Val} ohm / ${!Pdissip} watt] resistors in stock." "These are located in bin # ${!Loc}." "Their color code is \"${!Ccode}\"."

Chapter 34. Bash, versions 2 and 3

470

Advanced BashScripting Guide

echo; echo # Exercises: # # 1) Rewrite this script to read its data from an external file. # 2) Rewrite this script to use 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 344. Using arrays and other miscellaneous trickery to deal four random hands from a deck of cards
#!/bin/bash # 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 to implement and more intuitive #+ with a single, 3dimensional 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

Chapter 34. Bash, versions 2 and 3

471

Advanced BashScripting Guide

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. } seed_random () # Seed random number generator. { # What happens if you don't do this? seed=`eval date +%s` let "seed %= 32766" RANDOM=$seed # What are some other methods #+ of seeding the random number generator? } deal_cards () { echo cards_picked=0 while [ "$cards_picked" le $UPPER_LIMIT ] do pick_a_card t=$? if [ "$t" ne $DUPE_CARD ] then parse_card $t u=$cards_picked+1 # Change back to 1based indexing (temporarily). Why? let "u %= $CARDS_IN_SUIT" if [ "$u" eq 0 ] # Nested if/then condition test. then

Chapter 34. Bash, versions 2 and 3

472

Advanced BashScripting Guide

echo echo fi # Separate hands. let "cards_picked += 1" fi done 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: # Add a routine (function) 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.

34.2. Bash, version 3

On July 27, 2004, Chet Ramey released version 3 of Bash. This update fixes quite a number of bug in Bash and adds some new features. Some of the added features are: A new, more generalized {a..z} brace expansion operator.
#!/bin/bash for i in {1..10} # Simpler and more straightforward than #+ for i in $(seq 10) do echo n "$i "

Chapter 34. Bash, versions 2 and 3

473

Advanced BashScripting Guide

done echo # 1 2 3 4 5 6 7 8 9 10

# Or just . . . echo {a..z} echo {z..a} echo {3..2} echo {X..d} # # # # # # #+ # # a b c d e f g h i j k l m n o p q r s t u v w x y z z y x w v u t s r q p o n m l k j i h g f e d c b a Works backwards, too. 3 2 1 0 1 2 X Y Z [ ] ^ _ ` a b c d Shows (some of) the the ASCII characters between Z and a, but don't rely on this type of behavior because . . . {]..a} Why?

echo {]..a}

The ${!array[@]} operator, which expands to all the indices of a given array.
#!/bin/bash Array=(elementzero elementone elementtwo elementthree) echo ${Array[0]} # elementzero # First element of array. # 0 1 2 3 # All the indices of Array.

echo ${!Array[@]}

for i in ${!Array[@]} do echo ${Array[i]} # elementzero # elementone # elementtwo # elementthree # # All the elements in Array. done

The =~ Regular Expression matching operator within a double brackets test expression. (Perl has a similar operator.)
#!/bin/bash variable="This is a fine mess." echo "$variable" if [[ "$variable" =~ "T*fin*es*" ]] # Regex matching with =~ operator within [[ double brackets ]]. then echo "match found" # match found fi

Or, more usefully:

#!/bin/bash

Chapter 34. Bash, versions 2 and 3

474

Advanced BashScripting Guide

input=$1

if [[ "$input" =~ "[19][09][09][09][09][09][09][09][09]" ]] # NNNNNNNNN # Where each N is a digit. # But, initial digit must not be 0. then echo "Social Security number." # Process SSN. else echo "Not a Social Security number!" # Or, ask for corrected input. fi

For additional examples of using the =~ operator, see Example A29 and Example 1814. The new set o pipefail option is useful for debugging pipes. If this option is set, then the exit status of a pipe is the exit status of the last command in the pipe to fail (return a nonzero value), rather than the actual final command in the pipe. See Example 1539. The update to version 3 of Bash breaks a few scripts that worked under earlier versions. Test critical legacy scripts to make sure they still work! As it happens, a couple of the scripts in the Advanced Bash Scripting Guide had to be fixed up (see Example A20 and Example 94, for instance).

34.2.1. Bash, version 3.1

The version 3.1 update of Bash introduces a number of bugfixes and a few minor changes. The += operator is now permitted in in places where previously only the = assignment operator was recognized.
a=1 echo $a a+=5 echo $a a+=Hello echo $a

# 1 # Won't work under versions of Bash earlier than 3.1. # 15

# 15Hello

Here, += functions as a string concatenation operator. Note that its behavior in this particular context is different than within a let construct.
a=1 echo $a let a+=5 echo $a let a+=Hello echo $a

# 1 # Integer arithmetic, rather than string concatenation. # 6 # Doesn't "add" anything to a. # 6

Chapter 34. Bash, versions 2 and 3

475

Advanced BashScripting Guide

Chapter 34. Bash, versions 2 and 3

476

Chapter 35. Endnotes

35.1. Author's Note
doce ut discas (Teach, that you yourself may learn.) How did I come to write a Bash scripting book? It's a strange tale. It seems that a few years back I needed to learn shell scripting and what better way to do that than to read a good book on the subject? I was looking to buy a tutorial and reference covering all aspects of the subject. I was looking for a book that would take difficult concepts, turn them inside out, and explain them in excruciating detail, with wellcommented examples. [90] In fact, I was looking for this very book, or something much like it. Unfortunately, it didn't exist, and if I wanted it, I'd have to write it. And so, here we are, folks. This reminds me of the apocryphal story about a 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 somehow I can't help admiring the old coot.

35.2. About the Author

Who is this guy anyhow? The author claims no credentials or special qualifications, [91] other than a compulsion to write. [92] This book is somewhat of a departure from his other major work, HOW2 Meet Women: The Shy Man's Guide to Relationships. He has also written the SoftwareBuilding HOWTO. Lately, he has been trying his hand at short fiction. A Linux user since 1995 (Slackware 2.2, kernel 1.2.1), the author has emitted a few software truffles, including the cruft onetime 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 orange cat, he cherishes human frailty, especially his own.

35.3. Where to Go For Help

The author will sometimes, if not too busy (and in a good mood), answer general scripting questions. [93] However, if you have a problem getting a specific script to work, you would be well advised to post to the comp.os.unix.shell Usenet newsgroup. If you need assistance with a schoolwork assignment, read the pertinent sections of this and other reference works. Do your best to solve the problem using your own wits and resources. Please do not waste the author's Chapter 35. Endnotes 477

Advanced BashScripting Guide time. You will get neither help nor sympathy.

35.4. Tools Used to Produce This Book

35.4.1. Hardware
A used IBM Thinkpad, model 760XL laptop (P166, 104 meg RAM) running Red Hat 7.1/7.3. Sure, it's slow and has a funky keyboard, but it beats the heck out of a No. 2 pencil and a Big Chief tablet. Update: upgraded to a 770Z Thinkpad (P2366, 192 meg RAM) running FC3. Anyone feel like donating a latermodel laptop to a starving writer <g>? Update: upgraded to a A31 Thinkpad (P41.6, 512 meg RAM) running FC5. No longer starving, and no longer soliciting donations <g>.

35.4.2. Software and Printware

i. Bram Moolenaar's powerful SGMLaware vim text editor. ii. OpenJade, a DSSSL rendering engine for converting SGML documents into other formats. iii. Norman Walsh's DSSSL stylesheets. iv. DocBook, The Definitive Guide, by Norman Walsh and Leonard Muellner (O'Reilly, ISBN 1565925807). This is still the standard reference for anyone attempting to write a document in Docbook SGML format.

35.5. 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 the first version (0.1) of 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 you can email him at [email protected]. Philippe Martin also pointed out that positional parameters past $9 are possible using {bracket} notation. (See Example 45). Stphane Chazelas sent a long list of corrections, additions, and example scripts. More than a contributor, he had, in effect, for a while taken on the role of editor for this document. Merci beaucoup! Paulo Marcel Coelho Aragao offered many corrections, both major and minor, and contributed quite a number of helpful suggestions. 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. Chapter 35. Endnotes 478

Advanced BashScripting Guide Many thanks to Jordi Sanfeliu for giving permission to use his fine tree script (Example A17), and to Rick Boivie for revising it. Likewise, thanks to Michel Charpentier for permission to use his dc factoring script (Example 1547). Kudos to Noah Friedman for permission to use his string function script (Example A18). Emmanuel Rouat suggested corrections and additions on command substitution and aliases. He also contributed a very nice sample .bashrc file (Appendix K). Heiner Steven kindly gave permission to use his base conversion script, Example 1543. He also made a number of corrections and many helpful suggestions. Special thanks. Rick Boivie contributed the delightfully recursive pb.sh script (Example 339), revised the tree.sh script (Example A17), and suggested performance improvements for the monthlypmt.sh script (Example 1542). Florian Wisser enlightened me on some of the fine points of testing strings (see Example 76), and on other matters. Oleg Philon sent suggestions concerning cut and pidof. Michael Zick extended the empty array example to demonstrate some surprising array properties. He also contributed the isspammer scripts (Example 1537 and Example A28). MarcJano Knopp sent corrections and clarifications on DOS batch files. 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 contributing scripts, 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, Greg Keraunen, Keith Matthews, Sandro Magi, Albert Reiner, Dim Segebart, Rory Winston, Lee Bigelow, Wayne Pollock, "jipe," "bojster," "nyal," "Hobbit," "Ender," "Little Monster" (Alexis), "Mark," Emilio Conti, Ian. D. Allen, Arun Giridhar, Dennis Leeuw, Dan Jacobson, Aurelio Marinho Jargas, Edward Scholtz, Jean Helou, Chris Martin, Lee Maschmeyer, Bruno Haible, Wilbert Berendsen, Sebastien Godard, Bjn Eriksson, John MacDonald, Joshua Tschida, Troy Engel, Manfred Schwarb, Amit Singh, Bill Gradwohl, David Lombard, Jason Parker, Steve Parker, Bruce W. Clare, William Park, Vernia Damiano, Mihai Maties, Mark Alexander, Jeremy Impson, Ken Fuchs, Frank Wang, Sylvain Fourmanoit, Matthew Sage, Matthew Walker, Kenny Stauffer, Filip Moritz, Andrzej Stefanski, Daniel Albers, Stefano Palmeri, Nils Radtke, Jeroen Domburg, Alfredo Pironti, Phil Braham, Bruno de Oliveira Schneider, Stefano Falsetto, Chris Morgan, Walter Dnes, Linc Fessenden, Michael Iatrou, Pharis Monalo, Jesse Gough, Fabian Kreutz, Mark Norman, Harald Koenig, Peter Knowles, Francisco Lobo, Mariusz Gniazdowski, Tedman Eng, Jochen DeSmet, Juan Nicolas Ruiz, Oliver Beckstein, Achmed Darwish, Richard Neill, Albert Siersema, Omair Eshkenazi, Geoff Lee, Andreas Khne, and David Lawyer (himself an author of four HOWTOs). My gratitude to Chet Ramey and Brian Fox for writing Bash, and building into it elegant and powerful scripting capabilities.

Chapter 35. Endnotes

479

Advanced BashScripting Guide Very special thanks to the hardworking 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 and appreciation to IBM, Red Hat, the Free Software Foundation, and all the good people fighting the good fight to keep Open Source software free and open. Thanks most of all to my wife, Anita, for her encouragement and emotional support.

Chapter 35. Endnotes

480

Bibliography
Those who do not understand UNIX are condemned to reinvent it, poorly. Henry Spencer Edited by Peter Denning, Computers Under Attack: Intruders, Worms, and Viruses, ACM Press, 1990, 0201530678. This compendium contains a couple of articles on shell script viruses. *

Ken Burtch, Linux Shell Scripting with Bash, 1st edition, Sams Publishing (Pearson), 2004, 0672326426. Covers much of the same material as this guide. Dead tree media does have its advantages, though. *

Dale Dougherty and Arnold Robbins, Sed and Awk, 2nd edition, O'Reilly and Associates, 1997, 11565922255. 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. *

Jeffrey Friedl, Mastering Regular Expressions, O'Reilly and Associates, 2002, 0596002890. The best, allaround reference on Regular Expressions. *

Aeleen Frisch, Essential System Administration, 3rd edition, O'Reilly and Associates, 2002, 0596003439. 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 long overdue third edition of this classic has finally been released. *

Stephen Kochan and Patrick Woods, Unix Shell Programming, Hayden, 1990, 067248448X. The standard reference, though a bit dated by now. Bibliography 481

Advanced BashScripting Guide *

Neil Matthew and Richard Stones, Beginning Linux Programming, Wrox Press, 1996, 1874416680. Good indepth 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. Excellent coverage of algorithms and general programming practices. *

David Medinets, Unix Shell Programming Tools, McGrawHill, 1999, 0070397333. 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, 1565923472. 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. A very handy pocket reference, despite lacking coverage of Bashspecific features. *

Jerry Peek, Tim O'Reilly, and Mike Loukides, Unix Power Tools, 2nd edition, O'Reilly and Associates, Random House, 1997, 1565922603. Contains a couple of sections of very informative indepth articles on shell programming, but falls short of being a tutorial. It reproduces much of the regular expressions tutorial from the Dougherty and Robbins book, above. *

Bibliography

482

Advanced BashScripting Guide Clifford Pickover, Computers, Pattern, Chaos, and Beauty, St. Martin's Press, 1990, 0312041233. A treasure trove of ideas and recipes for computerbased exploration of mathematical oddities. *

George Polya, How To Solve It, Princeton University Press, 1973, 0691023565. The classic tutorial on problem solving methods (i.e., algorithms). *

Chet Ramey and Brian Fox, The GNU Bash Reference Manual, Network Theory Ltd, 2003, 0954161777. This manual is the definitive reference for GNU Bash. The authors of this manual, Chet Ramey and Brian Fox, are the original developers of GNU Bash. For each copy sold the publisher donates $1 to the Free Software Foundation.

Arnold Robbins, Bash Reference Card, SSC, 1998, 1587310105. Excellent Bash pocket reference (don't leave home without it). A bargain at $4.95, but also available for free download online in pdf format. *

Arnold Robbins, Effective Awk Programming, Free Software Foundation / O'Reilly and Associates, 2000, 1882114264. 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, 1565920546. This wellwritten book contains some excellent pointers on shell scripting. *

Paul Sheer, LINUX: Rute User's Tutorial and Exposition, 1st edition, , 2002, 0130333514. Very detailed and readable introduction to Linux system administration.

Bibliography

483

Advanced BashScripting Guide The book is available in print, or online. *

Ellen Siever and the staff of O'Reilly and Associates, Linux in a Nutshell, 2nd edition, O'Reilly and Associates, 1999, 1565925858. The allaround best Linux command reference, even has a Bash section. *

Dave Taylor, Wicked Cool Shell Scripts: 101 Scripts for Linux, Mac OS X, and Unix Systems, 1st edition, No Starch Press, 2004, 1593270127. Just as the title says . . . *

The UNIX CD Bookshelf, 3rd edition, O'Reilly and Associates, 2003, 0596003927. An array of seven 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 $130. Buy this one, even if it means going into debt and not paying the rent. *

The O'Reilly books on Perl. (Actually, any O'Reilly books.)

Fioretti, Marco, "Scripting for X Productivity," Linux Journal, Issue 113, September, 2003, pp. 869.

Ben Okopnik's wellwritten 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 twopart series published in issues 3 and 4 of the Linux Journal, JulyAugust 1994.

Mike G's BashProgrammingIntro HOWTO.

Richard's Unix Scripting Universe.

Bibliography

484

Advanced BashScripting Guide Chet Ramey's Bash F.A.Q.

Ed Schaefer's Shell Corner in Unix Review.

Example shell scripts at Lucc's Shell Scripts .

Example shell scripts at SHELLdorado .

Example shell scripts at Noah Friedman's script site.

Example shell scripts at zazzybob.

Steve Parker's Shell Programming Stuff.

Example shell scripts at SourceForge Snippet Library shell scrips.

"Miniscripts" at Unix Oneliners.

Giles Orr's BashPrompt HOWTO.

The Pixelbeat commandline reference.

Very nice sed, awk, and regular expression tutorials at The UNIX Grymoire.

Eric Pement's sed resources page.

Many interesting sed scripts at the seder's grab bag.

The GNU gawk reference manual (gawk is the extended GNU version of awk available on Linux and BSD systems).

Tips and tricks at Linux Reviews.

Trent Fisher's groff tutorial.

Bibliography

485

Advanced BashScripting Guide Mark Komarinski's PrintingUsage HOWTO.

The Linux USB subsystem (helpful in writing scripts affecting USB peripherals).

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.

Aurelio Marinho Jargas has written a Regular expression wizard. He has also written an informative book on Regular Expressions, in Portuguese.

Ben Tomkins has created the Bash Navigator directory management tool.

William Park has been working on a project to incorporate certain Awk and Python features into Bash. Among these is a gdbm interface. He has released bashdiff on Freshmeat.net. He has an article in the November, 2004 issue of the Linux Gazette on adding string functions to Bash, with a followup article in the December issue, and yet another in the January, 2005 issue.

Peter Knowles has written an elaborate Bash script that generates a book list on the Sony Librie ebook reader. This useful tool permits loading nonDRM user content on the Librie.

Rocky Bernstein is in the process of developing a "fullfledged" debugger for Bash.

Of historical interest are Colin Needham's original International Movie Database (IMDB) reader polling scripts, which nicely illustrate the use of awk for string parsing. Unfortunately, the URL link no longer works.

The excellent Bash Reference Manual, by Chet Ramey and Brian Fox, distributed as part of the "bash2doc" package (available as an rpm). See especially the instructive example scripts in this package.

The comp.os.unix.shell newsgroup.

The dd thread on Linux Questions.

The comp.os.unix.shell FAQ and its mirror site. Bibliography 486

Advanced BashScripting Guide Assorted comp.os.unix FAQs.

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.

Bibliography

487

Appendix A. Contributed Scripts

These scripts, while not fitting into the text of this document, do illustrate some interesting shell programming techniques. They are useful, too. Have fun analyzing and running them.

Example A1. mailformat: Formatting an email message

#!/bin/bash # mailformat.sh (ver. 1.1): Format email messages. # Gets rid of carets, tabs, and also folds excessively long lines. # ================================================================= # Standard Check for Script Argument(s) ARGS=1 E_BADARGS=65 E_NOFILE=66 if [ $# ne $ARGS ] # Correct number of arguments passed to script? then echo "Usage: `basename $0` filename" exit $E_BADARGS fi if [ f "$1" ] # Check if file exists. then file_name=$1 else echo "File \"$1\" does not exist." exit $E_NOFILE fi # ================================================================= MAXWIDTH=70 # Width to fold excessively long lines to.

# # A variable can hold a sed script. sedscript='s/^>// s/^ *>// s/^ *// s/ *//' # # Delete carets and tabs at beginning of lines, #+ then fold lines to $MAXWIDTH characters. sed "$sedscript" $1 | fold s width=$MAXWIDTH # s option to "fold" #+ breaks lines at whitespace, if possible.

# #+ # # #+

This script was inspired by an article in a wellknown trade journal extolling a 164K MS Windows utility with similar functionality. An nice set of text processing utilities and an efficient scripting language provide an alternative to bloated executables.

exit 0

Appendix A. Contributed Scripts

488

Advanced BashScripting Guide Example A2. rn: A simpleminded file rename utility This script is a modification of Example 1519.
#! /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` oldpattern newpattern" # As in "rn gif jpg", which renames all gif files in working directory to jpg. exit $E_BADARGS fi number=0 # Keeps track of how many files actually renamed.

for filename in *$1* #Traverse all matching files in directory. do if [ f "$filename" ] # If finds match... then fname=`basename $filename` # Strip off path. n=`echo $fname | sed e "s/$1/$2/"` # Substitute new for old in filename. mv $fname $n # Rename. let "number += 1" fi done if [ "$number" eq "$ONE" ] then echo "$number file renamed." else echo "$number files renamed." fi exit 0 # For correct grammar.

# 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.

Example A3. blankrename: renames filenames containing blanks This is an even simplerminded version of previous script.

Appendix A. Contributed Scripts

489

Advanced BashScripting Guide

#! /bin/bash # blankrename.sh # # Substitutes underscores for blanks in all the filenames in a directory. ONE=1 number=0 FOUND=0 # For getting singular/plural right (see below). # Keeps track of how many files actually renamed. # Successful return value.

for filename in * #Traverse all files in directory. do echo "$filename" | grep q " " # Check whether filename if [ $? eq $FOUND ] #+ contains space(s). then fname=$filename # Yes, this filename needs work. n=`echo $fname | sed e "s/ /_/g"` # Substitute underscore for blank. mv "$fname" "$n" # Do the actual renaming. let "number += 1" fi done if [ "$number" eq "$ONE" ] then echo "$number file renamed." else echo "$number files renamed." fi exit 0 # For correct grammar.

Example A4. encryptedpw: Uploading to an ftp site, using a locally encrypted password
#!/bin/bash # Example "ex72.sh" modified to use encrypted password. # Note that this is still rather insecure, #+ since the decrypted password is sent in the clear. # Use something like "ssh" if this is a concern. E_BADARGS=65 if [ z "$1" ] then echo "Usage: `basename $0` filename" exit $E_BADARGS fi Username=bozo # Change to suit. pword=/home/bozo/secret/password_encrypted.file # File containing encrypted password. Filename=`basename $1` Server="XXX" Directory="YYY" # Strips pathname out of file name.

# Change above to actual server name & directory.

Password=`cruft <$pword` # Decrypt password. # Uses the author's own "cruft" file encryption package, #+ based on the classic "onetime pad" algorithm,

Appendix A. Contributed Scripts

490

Advanced BashScripting Guide

#+ and obtainable from: #+ Primarysite: ftp://ibiblio.org/pub/Linux/utils/file #+ cruft0.2.tar.gz [16k]

ftp n $Server <<EndOfSession user $Username $Password binary bell cd $Directory put $Filename bye EndOfSession # n option to "ftp" disables autologon. # Note that "bell" rings 'bell' after each file transfer. exit 0

Example A5. copycd: Copying a data CD

#!/bin/bash # copycd.sh: copying a data CD CDROM=/dev/cdrom # CD ROM device OF=/home/bozo/projects/cdimage.iso # output file # /xxxx/xxxxxxx/ Change to suit your system. BLOCKSIZE=2048 SPEED=2 # May use higher speed if supported. DEVICE=cdrom # DEVICE="0,0" on older versions of cdrecord. echo; echo "Insert source CD, but do *not* mount it." echo "Press ENTER when ready. " read ready # Wait for input, $ready not used. echo; echo "Copying the source CD to $OF." echo "This may take a while. Please be patient." dd if=$CDROM of=$OF bs=$BLOCKSIZE # Raw device copy.

echo; echo "Remove data CD." echo "Insert blank CDR." echo "Press ENTER when ready. " read ready echo "Copying $OF to CDR."

# Wait for input, $ready not used.

cdrecord v isosize speed=$SPEED dev=$DEVICE $OF # Uses Joerg Schilling's "cdrecord" package (see its docs). # http://www.fokus.gmd.de/nthp/employees/schilling/cdrecord.html

echo; echo "Done copying $OF to CDR on device $CDROM." echo "Do you want to erase the image file (y/n)? " read answer case "$answer" in [yY]) rm f $OF echo "$OF erased." # Probably a huge file.

Appendix A. Contributed Scripts

491

Advanced BashScripting Guide

*) esac echo # Exercise: # Change the above "case" statement to also accept "yes" and "Yes" as input. exit 0 ;; echo "$OF not erased.";;

Example A6. Collatz series

#!/bin/bash # collatz.sh # # # # # # # # # # # #+ #+ #+ # # #+ # The notorious "hailstone" or Collatz series. 1) Get the integer "seed" from the command line. 2) NUMBER < seed 3) Print NUMBER. 4) If NUMBER is even, divide by 2, or 5)+ if odd, multiply by 3 and add 1. 6) NUMBER < result 7) Loop back to step 3 (for specified number of iterations). The theory is that every sequence, no matter how large the initial value, eventually settles down to repeating "4,2,1..." cycles, even after fluctuating through a wide range of values. This is an instance of an "iterate," an operation that feeds its output back into the input. Sometimes the result is a "chaotic" series.

MAX_ITERATIONS=200 # For large seed numbers (>32000), increase MAX_ITERATIONS. h=${1:$$} # Seed # Use $PID as seed, #+ if not specified as commandline arg.

echo echo "C($h) $MAX_ITERATIONS Iterations" echo for ((i=1; i<=MAX_ITERATIONS; i++)) do echo n "$h " # ^^^^^ # tab let "remainder = h % 2" if [ "$remainder" eq 0 ] then let "h /= 2" else let "h = h*3 + 1" fi

# Even? # Divide by 2. # Multiply by 3 and add 1.

Appendix A. Contributed Scripts

492

Advanced BashScripting Guide

COLUMNS=10 # Output 10 values per line. let "line_break = i % $COLUMNS" if [ "$line_break" eq 0 ] then echo fi done echo # For more information on this mathematical function, #+ see _Computers, Pattern, Chaos, and Beauty_, by Pickover, p. 185 ff., #+ as listed in the bibliography. exit 0

Example A7. daysbetween: Calculate number of days between two dates

#!/bin/bash # daysbetween.sh: Number of days between two dates. # Usage: ./daysbetween.sh [M]M/[D]D/YYYY [M]M/[D]D/YYYY # # Note: Script modified to account for changes in Bash, v. 2.05b +, #+ that closed the loophole permitting large negative #+ integer return values. ARGS=2 E_PARAM_ERR=65 REFYR=1600 CENTURY=100 DIY=365 ADJ_DIY=367 MIY=12 DIM=31 LEAPCYCLE=4 MAXRETVAL=255 # Two command line parameters expected. # Param error. # Reference year.

# Adjusted for leap year + fraction.

# Largest permissible #+ positive return value from a function. # Declare global variable for date difference. # Declare global variable for absolute value. # Declare globals for day, month, year.

diff= value= day= month= year=

Param_Error () # Command line parameters wrong. { 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 }

Parse_Date () { month=${1%%/**}

# Parse date from command line params.

Appendix A. Contributed Scripts

493

Advanced BashScripting Guide

dm=${1%/**} day=${dm#*/} let "year = `basename $1`" } # Day and month. # Not a filename, but works just the same.

check_date () # Checks for invalid date(s) passed. { [ "$day" gt "$DIM" ] || [ "$month" gt "$MIY" ] || [ "$year" lt "$REFYR" ] && Param_Error # Exit script on bad value(s). # Uses orlist / andlist. # # Exercise: Implement more rigorous date checking. }

strip_leading_zero () # Better to strip { #+ from day and/or return ${1#0} #+ since otherwise } #+ as octal values

possible leading zero(s) month Bash will interpret them (POSIX.2, sect 2.9.2.1).

day_index () { day=$1 month=$2 year=$3

# Gauss' Formula: # Days from March 1, 1600 to date passed as param. # ^^^^^^^^^^^^^

let "month = $month 2" if [ "$month" le 0 ] then let "month += 12" let "year = 1" fi let "year = $REFYR" let "indexyr = $year / $CENTURY"

let "Days = $DIY*$year + $year/$LEAPCYCLE $indexyr \ + $indexyr/$LEAPCYCLE + $ADJ_DIY*$month/$MIY + $day $DIM" # For an indepth explanation of this algorithm, see #+ http://weblogs.asp.net/pgreborio/archive/2005/01/06/347968.aspx

echo $Days }

calculate_difference () { let "diff = $1 $2" }

# Difference between two day indices. # Global variable.

abs () { if [ "$1" lt 0 ] then

# # # #+

Absolute value Uses global "value" variable. If negative then

Appendix A. Contributed Scripts

494

Advanced BashScripting Guide

let "value = 0 $1" else let "value = $1" fi } #+ change sign, #+ else #+ leave it alone.

if [ $# ne "$ARGS" ] then Param_Error fi Parse_Date $1 check_date $day $month $year strip_leading_zero $day day=$? strip_leading_zero $month month=$?

# Require two command line params.

See if valid date.

# Remove any leading zeroes #+ on day and/or month.

let "date1 = `day_index $day $month $year`"

Parse_Date $2 check_date $day $month $year strip_leading_zero $day day=$? strip_leading_zero $month month=$? date2=$(day_index $day $month $year) # Command substitution.

calculate_difference $date1 $date2 abs $diff diff=$value echo $diff exit 0 # Compare this script with #+ the implementation of Gauss' Formula in a C program at: #+ http://buschencrew.hypermart.net/software/datedif # Make sure it's positive.

Example A8. Making a "dictionary"

#!/bin/bash # makedict.sh

[make dictionary]

# Modification of /usr/sbin/mkdict script. # Original script copyright 1993, by Alec Muffett. # # This modified script included in this document in a manner #+ consistent with the "LICENSE" document of the "Crack" package #+ that the original script is a part of. # This script processes text files to produce a sorted list

Appendix A. Contributed Scripts

495

Advanced BashScripting Guide

#+ of words found in the files. # This may be useful for compiling dictionaries #+ and for lexicographic research.

E_BADARGS=65 if [ ! r "$1" ] then echo "Usage: $0 filestoprocess" exit $E_BADARGS fi # Need at least one #+ valid file argument.

# SORT="sort"

# No longer necessary to define options #+ to sort. Changed from original script. # Contents of specified files to stdout. # Convert to lowercase. # New: change spaces to newlines. # Get rid of everything nonalphanumeric #+ (original script). # Rather than deleting #+ now change nonalpha to newlines. # $SORT options unnecessary now. # Remove duplicates. # Delete lines beginning with a hashmark. # Delete blank lines.

cat $* | tr AZ az | tr ' ' '\012' | # tr cd '\012[az][09]' | tr c '\012az' sort uniq grep grep exit 0 | | v '^#' | v '^$' '\012' |

Example A9. Soundex conversion

#!/bin/bash # soundex.sh: Calculate "soundex" code for names # ======================================================= # Soundex script # by # Mendel Cooper # [email protected] # 23 January, 2002 # # Placed in the Public Domain. # # A slightly different version of this script appeared in #+ Ed Schaefer's July, 2002 "Shell Corner" column #+ in "Unix Review" online, #+ http://www.unixreview.com/documents/uni1026336632258/ # =======================================================

ARGCOUNT=1 E_WRONGARGS=70

# Need name as argument.

if [ $# ne "$ARGCOUNT" ] then echo "Usage: `basename $0` name" exit $E_WRONGARGS fi

Appendix A. Contributed Scripts

496

Advanced BashScripting Guide

assign_value () { val1=bfpv val2=cgjkqsxz val3=dt val4=l val5=mn val6=r # Assigns numerical value #+ to letters of name. # 'b,f,p,v' = 1 # 'c,g,j,k,q,s,x,z' = 2 # etc.

# Exceptionally clever use of 'tr' follows. # Try to figure out what is going on here. value=$( echo "$1" \ | tr d wh \ | tr $val1 1 | tr $val2 2 | tr $val3 3 \ | tr $val4 4 | tr $val5 5 | tr $val6 6 \ | tr s 123456 \ | tr d aeiouy ) # # # # # # } Assign Remove Ignore Ignore letter values. duplicate numbers, except when separated by vowels. vowels, except as separators, so delete them last. 'w' and 'h', even as separators, so delete them first.

The above command substitution lays more pipe than a plumber <g>.

input_name="$1" echo echo "Name = $input_name"

# Change all characters of name input to lowercase. # name=$( echo $input_name | tr AZ az ) # # Just in case argument to script is mixed case.

# Prefix of soundex code: first letter of name. #

char_pos=0 # Initialize character position. prefix0=${name:$char_pos:1} prefix=`echo $prefix0 | tr az AZ` # Uppercase 1st letter of soundex. let "char_pos += 1" name1=${name:$char_pos} # Bump character position to 2nd letter of name.

# ++++++++++++++++++++++++++ Exception Patch +++++++++++++++++++++++++++++++++ # Now, we run both the input name and the name shifted one char to the right #+ through the valueassigning function. # If we get the same value out, that means that the first two characters #+ of the name have the same value assigned, and that one should cancel. # However, we also need to test whether the first letter of the name

Appendix A. Contributed Scripts

497

Advanced BashScripting Guide

#+ is a vowel or 'w' or 'h', because otherwise this would bollix things up. char1=`echo $prefix | tr AZ az` assign_value $name s1=$value assign_value $name1 s2=$value assign_value $char1 s3=$value s3=9$s3 # First letter of name, lowercased.

# #+ #+ #+ #+

If first letter of name is a vowel or 'w' or 'h', then its "value" will be null (unset). Therefore, set it to 9, an otherwise unused value, which can be tested for.

if [[ "$s1" ne "$s2" || "$s3" eq 9 ]] then suffix=$s2 else suffix=${s2:$char_pos} fi # ++++++++++++++++++++++ end Exception Patch +++++++++++++++++++++++++++++++++

padding=000

# Use at most 3 zeroes to pad.

soun=$prefix$suffix$padding MAXLEN=4 soundex=${soun:0:$MAXLEN} echo "Soundex = $soundex" echo # #+ # #+ # # # # # # # # # # # # # #+ #+

# Pad with zeroes. # Truncate to maximum of 4 chars.

The soundex code is a method of indexing and classifying names by grouping together the ones that sound alike. The soundex code for a given name is the first letter of the name, followed by a calculated threenumber code. Similar sounding names should have almost the same soundex codes. Examples: Smith and Smythe both have a "S530" soundex. Harrison = H625 Hargison = H622 Harriman = H655 This works out fairly well in practice, but there are numerous anomalies.

The U.S. Census and certain other governmental agencies use soundex, as do genealogical researchers. For more information, see the "National Archives and Records Administration home page", http://www.nara.gov/genealogy/soundex/soundex.html

Appendix A. Contributed Scripts

498

Advanced BashScripting Guide

# Exercise: # # Simplify the "Exception Patch" section of this script. exit 0

Example A10. "Game of Life"

#!/bin/bash # life.sh: "Life in the Slow Lane" # Version 2: Patched by Daniel Albers #+ to allow nonsquare grids as input. # ##################################################################### # # 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 dotandblank 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 a dead cell for the next generation. # # ##################################################################### #

startfile=gen0

if [ n "$1" ] then startfile="$1" fi

# Read the starting generation from the file "gen0". # Default, if no other file specified when invoking script. # # Specify another "generation 0" file.

############################################ # Abort script if "startfile" not specified #+ AND #+ "gen0" not present. E_NOSTARTFILE=68 if [ ! e "$startfile" ] then echo "Startfile \""$startfile"\" missing!" exit $E_NOSTARTFILE fi ############################################

ALIVE1=. DEAD1=_

Appendix A. Contributed Scripts

499

Advanced BashScripting Guide

# Represent living and "dead" cells in the startup file. # # # This script uses a 10 x 10 grid (may be increased, #+ but a large grid will will cause very slow execution). ROWS=10 COLS=10 # Change above two variables to match grid size, if necessary. # # GENERATIONS=10 # How many generations to cycle through. # Adjust this upwards, #+ if you have time on your hands. # Exit status on premature bailout, #+ if no cells left alive.

NONE_ALIVE=80 TRUE=0 FALSE=1 ALIVE=0 DEAD=1 avar= generation=0

# Global; holds current generation. # Initialize generation count.

# =================================================================

let "cells = $ROWS * $COLS" # How many cells. declare a initial declare a current display () { alive=0 # How many cells "alive" at any given time. # Initially zero. # Arrays containing "cells".

declare a arr arr=( `echo "$1"` )

# Convert passed arg to array.

element_count=${#arr[*]} local i local rowcheck for ((i=0; i<$element_count; i++)) do # Insert newline at end of each row. let "rowcheck = $i % COLS" if [ "$rowcheck" eq 0 ] then echo # Newline. echo n " " # Indent. fi cell=${arr[i]} if [ "$cell" = . ] then

Appendix A. Contributed Scripts

500

Advanced BashScripting Guide

let "alive += 1" fi echo n "$cell" | sed e 's/_/ /g' # Print out array and change underscores to spaces. done return } IsValid () { if [ z "$1" o z "$2" ] then return $FALSE fi local local local local local row lower_limit=0 upper_limit left right # Test whether cell coordinate valid.

# Mandatory arguments missing?

# Disallow negative coordinate.

let "upper_limit = $ROWS * $COLS 1" # Total number of cells.

if [ "$1" lt "$lower_limit" o "$1" gt "$upper_limit" ] then return $FALSE # Out of array bounds. fi row=$2 let "left = $row * $COLS" let "right = $left + $COLS 1"

# Left limit. # Right limit.

if [ "$1" lt "$left" o "$1" gt "$right" ] then return $FALSE # Beyond row boundary. fi return $TRUE } # Valid coordinate.

IsAlive () { GetCount "$1" $2 local nhbd=$?

# Test whether cell is alive. # Takes array, cell number, state of cell as arguments. # Get alive cell count in neighborhood.

if [ "$nhbd" eq "$BIRTH" ] then return $ALIVE fi

# Alive in any case.

if [ "$3" = "." a "$nhbd" eq "$SURVIVE" ] then # Alive only if previously alive. return $ALIVE

Appendix A. Contributed Scripts

501

Advanced BashScripting Guide

fi return $DEAD } # Default.

GetCount ()

# # # #

Count live cells in passed cell's neighborhood. Two arguments needed: $1) variable holding array $2) cell number

{ local local local local local local local local local local local local local cell_number=$2 array top center bottom r row i t_top t_cen t_bot count=0 ROW_NHBD=3

array=( `echo "$1"` ) let let let let "top = $cell_number $COLS 1" # Set up cell neighborhood. "center = $cell_number 1" "bottom = $cell_number + $COLS 1" "r = $cell_number / $COLS" # Traverse from left to right.

for ((i=0; i<$ROW_NHBD; i++)) do let "t_top = $top + $i" let "t_cen = $center + $i" let "t_bot = $bottom + $i"

let "row = $r" # Count center row of neighborhood. IsValid $t_cen $row # Valid cell position? if [ $? eq "$TRUE" ] then if [ ${array[$t_cen]} = "$ALIVE1" ] # Is it alive? then # Yes? let "count += 1" # Increment count. fi fi let "row = $r 1" # Count top row. IsValid $t_top $row if [ $? eq "$TRUE" ] then if [ ${array[$t_top]} = "$ALIVE1" ] then let "count += 1" fi fi let "row = $r + 1" IsValid $t_bot $row # Count bottom row.

Appendix A. Contributed Scripts

502

Advanced BashScripting Guide

if [ $? eq "$TRUE" ] then if [ ${array[$t_bot]} = "$ALIVE1" ] 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 } next_gen () { local array local i=0 array=( `echo "$1"` ) # Convert passed arg to array. # Update generation array.

while [ "$i" lt "$cells" ] do IsAlive "$1" $i ${array[$i]} if [ $? eq "$ALIVE" ] then array[$i]=. else array[$i]="_" fi let "i += 1" done

# Is cell alive? # If alive, then #+ represent the cell as a period. # Otherwise underscore #+ (which will later be converted to space).

# let "generation += 1" # Increment generation count. # Why was the above line commented out?

# Set variable to pass as parameter to "display" function. avar=`echo ${array[@]}` # Convert array back to string variable. display "$avar" # Display it. echo; echo echo "Generation $generation $alive alive" 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. }

Appendix A. Contributed Scripts

503

Advanced BashScripting Guide

# ========================================================= # main () # Load initial array with contents of startup file. initial=( `cat "$startfile" | sed e '/#/d' | tr d '\n' |\ sed e 's/\./\. /g' e 's/_/_ /g'` ) # Delete lines containing '#' comment character. # Remove linefeeds and insert space between elements. clear echo echo echo echo echo echo # Clear screen.

# Title "=======================" " $GENERATIONS generations" " of" "\"Life in the Slow Lane\"" "======================="

# Display first generation. Gen0=`echo ${initial[@]}` display "$Gen0" # Display only. echo; echo echo "Generation $generation $alive alive" #

let "generation += 1" echo

# Increment generation count.

# Display second generation. Cur=`echo ${initial[@]}` next_gen "$Cur" # Update & display. # let "generation += 1" # Increment generation count.

# Main loop for displaying subsequent generations while [ "$generation" le "$GENERATIONS" ] do Cur="$avar" next_gen "$Cur" let "generation += 1" done # ============================================================== echo exit 0 # END

# # # # # # # # #

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. Exercise: Create a new "gen0" file to seed this script. Use a 12 x 16 grid, instead of the original 10 x 10 one. Make the necessary changes to the script,

Appendix A. Contributed Scripts

504

Advanced BashScripting Guide

#+ # # Exercise: #+ #+ # #+ so it will run with the altered file. Modify this script so that it can determine the grid size from the "gen0" file, and set any variables necessary for the script to run. This would make unnecessary any changes to variables in the script for an altered grid size.

Example A11. Data file for "Game of Life"

# gen0 # # This is an example "generation 0" startup file for "life.sh". # # The "gen0" file is a 10 x 10 grid using a period (.) for live cells, #+ and an underscore (_) for dead ones. We cannot simply use spaces #+ for dead cells in this file because of a peculiarity in Bash arrays. # [Exercise for the reader: explain this.] # # Lines beginning with a '#' are comments, and the script ignores them. __.__..___ ___._.____ ____.___.. _._______. ____._____ ..__...___ ____._____ ___...____ __.._..___ _..___..__

+++ The following two scripts are by Mark Moraes of the University of Toronto. See the file MoraesCOPYRIGHT for permissions and restrictions. This file is included in the combined HTML/source tarball of the ABS Guide.

Example A12. behead: Removing mail and news message headers

#! /bin/sh # Strips off the header from a mail/News message i.e. till the first # empty line # Mark Moraes, University of Toronto # ==> These comments added by author of this document. 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 # ==> If command line args present, then work on files named. for i do sed e '1,/^$/d' e '/^[ ]*$/d' $i # > Ditto, as above. done fi

Appendix A. Contributed Scripts

505

Advanced BashScripting Guide

# # # # ==> Exercise: Add error checking and other options. ==> ==> Note that the small sed script repeats, except for the arg passed. ==> Does it make sense to embed it in a function? Why or why not?

Example A13. ftpget: Downloading files via ftp

#! /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. # ==> This script is nothing but a shell wrapper around "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 #

# ==> These comments added by author of this document. # PATH=/local/bin:/usr/ucb:/usr/bin:/bin # export PATH # ==> Above 2 lines from original script probably superfluous. E_BADARGS=65 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. usage="Usage: $0 [h remotehost] [d remotedirectory]... [f remfile:localfile]... \ [c localdirectory] [m filepattern] [v]" ftpflags="i n" verbflag= set f # So we can use globbing in m set x `getopt vh:d:c:m:f: $*` if [ $? != 0 ]; then

Appendix A. Contributed Scripts

506

Advanced BashScripting Guide

echo $usage exit $E_BADARGS fi shift trap 'rm f ${TMPFILE} ; exit' 0 1 2 3 15 # ==> Signals: HUP INT (CtlC) QUIT TERM # ==> Delete tempfile in case of abnormal exit from script. echo "user anonymous ${USERgnu}@${SITE} > ${TMPFILE}" # ==> Added quotes (recommended in complex echoes). echo binary >> ${TMPFILE} for i in $* # ==> Parse command line args. do case $i in v) verbflag=v; echo hash >> ${TMPFILE}; shift;; h) remhost=$2; shift 2;; d) echo cd $2 >> ${TMPFILE}; if [ x${verbflag} != x ]; then echo pwd >> ${TMPFILE}; fi; shift 2;; c) echo lcd $2 >> ${TMPFILE}; shift 2;; m) echo mget "$2" >> ${TMPFILE}; shift 2;; f) f1=`expr "$2" : "\([^:]*\).*"`; f2=`expr "$2" : "[^:]*:\(.*\)"`; echo get ${f1} ${f2} >> ${TMPFILE}; shift 2;; ) shift; break;; esac # ==> 'lcd' and 'mget' are ftp commands. See "man ftp" . . . done if [ $# ne 0 ]; then echo $usage exit $E_BADARGS # ==> Changed from "exit 2" to conform with style standard. fi if [ x${verbflag} != x ]; then ftpflags="${ftpflags} v" fi if [ x${remhost} = x ]; then remhost=prep.ai.mit.edu # ==> Change to match appropriate ftp site. fi echo quit >> ${TMPFILE} # ==> All commands saved in tempfile. ftp ${ftpflags} ${remhost} < ${TMPFILE} # ==> Now, tempfile batch processed by ftp. rm f ${TMPFILE} # ==> Finally, tempfile deleted (you may wish to copy it to a logfile).

# # # #

==> ==> ==> ==>

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.

Appendix A. Contributed Scripts

507

Advanced BashScripting Guide Example A14. password: Generating random 8character passwords
#!/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 usage permission to the ABS Guide author. # # ==> Comments added by document author ==>

MATRIX="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" # ==> Password will consist of alphanumeric characters. LENGTH="8" # ==> May change 'LENGTH' for longer password.

while [ "${n:=1}" le "$LENGTH" ] # ==> Recall that := is "default substitution" operator. # ==> So, if 'n' has not been initialized, set it to 1. do PASS="$PASS${MATRIX:$(($RANDOM%${#MATRIX})):1}" # ==> Very clever, but tricky. # ==> Starting from the innermost nesting... # ==> ${#MATRIX} returns length of array MATRIX. # ==> $RANDOM%${#MATRIX} returns random number between 1 # ==> and [length of MATRIX] 1. # # # # ==> ==> ==> ==> ${MATRIX:$(($RANDOM%${#MATRIX})):1} returns expansion of MATRIX at random position, by length 1. See {var:pos:len} parameter substitution in Chapter 9. and the associated examples.

# ==> PASS=... simply pastes this result onto previous PASS (concatenation). # ==> To visualize this more clearly, uncomment the following line # echo "$PASS" # ==> to see PASS being built up, # ==> one character at a time, each iteration of the loop. let n+=1 # ==> Increment 'n' for next pass. done echo "$PASS" exit 0 # ==> Or, redirect to a file, as desired.

+ James R. Van Zandt contributed this script, which uses named pipes and, in his words, "really exercises quoting and escaping".

Example A15. fifo: Making daily backups, using named pipes

#!/bin/bash # ==> Script by James R. Van Zandt, and used here with his permission.

Appendix A. Contributed Scripts

508

Advanced BashScripting Guide

# ==> Comments added by author of this document.

HERE=`uname n` # ==> hostname THERE=bilbo echo "starting remote backup to $THERE at `date +%r`" # ==> `date +%r` returns time in 12hour format, i.e. "08:08:34 PM". # make sure /pipe really is a pipe and not a plain file rm rf /pipe mkfifo /pipe # ==> Create a "named pipe", named "/pipe". # ==> 'su xyz' runs commands as user "xyz". # ==> 'ssh' invokes secure shell (remote login client). su xyz c "ssh $THERE \"cat > /home/xyz/backup/${HERE}daily.tar.gz\" < /pipe"& cd / tar czf bin boot dev etc home info lib man root sbin share usr var > /pipe # ==> Uses named pipe, /pipe, to communicate between processes: # ==> 'tar/gzip' writes to /pipe and 'ssh' reads from /pipe. # ==> The end result is this backs up the main directories, from / on down. # ==> What are the advantages of a "named pipe" in this situation, # ==>+ as opposed to an "anonymous pipe", with |? # ==> Will an anonymous pipe even work here? # ==> # ==> Is it necessary to delete the pipe before exiting the script? How could that be done?

exit 0

+ Stphane Chazelas contributed the following script to demonstrate that generating prime numbers does not require arrays.

Example A16. Generating prime numbers using the modulo operator

#!/bin/bash # primes.sh: Generate prime numbers, without using arrays. # Script contributed by Stephane Chazelas. # This does *not* use the classic "Sieve of Eratosthenes" algorithm, #+ but instead uses the more intuitive method of testing each candidate number #+ for factors (divisors), using the "%" modulo operator.

LIMIT=1000 Primes() { (( n = $1 + 1 )) shift # echo "_n=$n i=$i_" if (( n == LIMIT )) then echo $* return

# Primes 2 1000

# Bump to next integer. # Next parameter in list.

Appendix A. Contributed Scripts

509

Advanced BashScripting Guide

fi for i; do # echo "n=$n i=$i" (( i * i > n )) && break (( n % i )) && continue Primes $n $@ return done Primes $n $@ $n # "i" gets set to "@", previous values of $n. # Optimization. # Sift out nonprimes using modulo operator. # Recursion inside loop.

# Recursion outside loop. # Successively accumulate positional parameters. # "$@" is the accumulating list of primes.

} Primes 1 exit 0 # Uncomment lines 16 and 24 to help figure out what is going on.

# Compare the speed of this algorithm for generating primes #+ with the Sieve of Eratosthenes (ex68.sh). # Exercise: Rewrite this script without recursion, for faster execution.

+ This is Rick Boivie's revision of Jordi Sanfeliu's tree script.

Example A17. tree: Displaying a directory tree

#!/bin/bash # tree.sh # # # #+ # #+ Written by Rick Boivie. Used with permission. This is a revised and simplified version of a script by Jordi Sanfeliu (and patched by Ian Kjos). This script replaces the earlier version used in previous releases of the Advanced Bash Scripting Guide.

# ==> Comments added by the author of this document.

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 != $1 ] # 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

Appendix A. Contributed Scripts

510

Advanced BashScripting Guide

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. numdirs=`expr $numdirs + 1` # ==> Increment directory count. if cd "$dir" ; then # ==> If can move to subdirectory... search `expr $1 + 1` # with recursion ;) # ==> Function calls itself. cd .. fi fi fi done } if [ $# != 0 ] ; then cd $1 # move to indicated directory. #else # stay in current directory fi echo "Initial directory = `pwd`" numdirs=0 search 0 echo "Total directories = $numdirs" exit 0

Noah Friedman gave permission to use his string function script, which essentially reproduces some of the Clibrary string manipulation functions.

Example A18. string functions: Clike string functions

#!/bin/bash # # # # # # string.bash bash emulation of string(3) library routines Author: Noah Friedman <[email protected]> ==> Used with his kind permission in this document. Created: 19920701 Last modified: 19930929 Public domain

# Conversion to bash v2 syntax done by Chet Ramey # 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

Appendix A. Contributed Scripts

511

Advanced BashScripting Guide

# echo $a # => foobar # #:end docstring: ###;;;autoload ==> Autoloading of function commented out. function strcat () { local s1_val s2_val s1_val=${!1} # indirect variable expansion s2_val=${!2} eval "$1"=\'"${s1_val}${s2_val}"\' # ==> eval $1='${s1_val}${s2_val}' avoids problems, # ==> if one of the variables contains a single quote. } #: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 s1_val=${!s1} s2_val=${!s2} if [ ${#s2_val} gt ${n} ]; then s2_val=${s2_val:0:$n} fi # ==> indirect variable expansion

# ==> substring extraction

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

Appendix A. Contributed Scripts

512

Advanced BashScripting Guide

function strcmp () { [ "$1" = "$2" ] && return 0 [ "${1}" '<' "${2}" ] > /dev/null && return 1 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 if [ ${3} ge ${#1} a ${3} ge ${#2} ]; then strcmp "$1" "$2" return $? else s1=${1:0:$3} s2=${2:0:$3} strcmp $s1 $s2 return $? 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}]*}"

Appendix A. Contributed Scripts

513

Advanced BashScripting Guide

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; } # strstr echoes nothing if s2 does not occur in s1 case "$1" in *$2*) ;; *) return 1;; esac # use the pattern matching code to strip off the match and everything # following it first=${1/$2*/} # then strip off the first unmatched portion of the string echo "${1##$first}" } #: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 nonempty 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:

Appendix A. Contributed Scripts

514

Advanced BashScripting Guide

###;;;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 # string.bash ends here

# ========================================================================== # # ==> Everything below here added by the document author. # ==> Suggested use of this script is to delete everything below here, # ==> and "source" this file into your own scripts. # 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

Appendix A. Contributed Scripts

515

Advanced BashScripting Guide Michael Zick's complex array example uses the md5sum check sum command to encode directory information.

Example A19. Directory information

#! /bin/bash # directoryinfo.sh # Parses and lists directory information. # NOTE: Change lines 273 and 353 per "README" file. # Michael Zick is the author of this script. # Used here with his permission. # # # # # # # # Controls If overridden by command arguments, they must be in the order: Arg1: "Descriptor Directory" Arg2: "Exclude Paths" Arg3: "Exclude Directories" Environment Settings override Defaults. Command arguments override Environment Settings.

# Default location for content addressed file descriptors. MD5UCFS=${1:${MD5UCFS:'/tmpfs/ucfs'}} # Directory paths never to list or enter declare a \ EXCLUDE_PATHS=${2:${EXCLUDE_PATHS:'(/proc /dev /devfs /tmpfs)'}} # Directories never to list or enter declare a \ EXCLUDE_DIRS=${3:${EXCLUDE_DIRS:'(ucfs lost+found tmp wtmp)'}} # Files never to list or enter declare a \ EXCLUDE_FILES=${3:${EXCLUDE_FILES:'(core "Name with Spaces")'}}

# : # # # # # # #

Here document used as a comment block. <<LSfieldsDoc # # # # List Filesystem Directory Information # # # # # ListDirectory "FileGlob" "FieldArrayName" or ListDirectory of "FileGlob" "FieldArrayFilename" 'of' meaning 'output to filename' # # # #

String format description based on: ls (GNU fileutils) version 4.0.36 Produces a line (or more) formatted: inode permissions hardlinks owner group ... 32736 rw 1 mszick mszick size day month date hh:mm:ss year path 2756608 Sun Apr 20 08:53:06 2003 /home/mszick/core Unless it is formatted: inode permissions hardlinks owner group ...

Appendix A. Contributed Scripts

516

Advanced BashScripting Guide

266705 crwrw 1 root uucp

major minor day month date hh:mm:ss year path 4, 68 Sun Apr 20 09:27:33 2003 /dev/ttyS4 NOTE: that pesky comma after the major number NOTE: the 'path' may be multiple fields: /home/mszick/core /proc/982/fd/0 > /dev/null /proc/982/fd/1 > /home/mszick/.xsessionerrors /proc/982/fd/13 > /tmp/tmpfZVVOCs (deleted) /proc/982/fd/7 > /tmp/kdemszick/ksycoca /proc/982/fd/8 > socket:[11586] /proc/982/fd/9 > pipe:[11588] If that isn't enough to keep your parser guessing, either or both of the path components may be relative: ../BuiltShared > BuiltStatic ../linux2.4.20.tar.bz2 > ../../../SRCS/linux2.4.20.tar.bz2 The first character of the 11 (10?) character permissions field: 's' Socket 'd' Directory 'b' Block device 'c' Character device 'l' Symbolic link NOTE: Hard links not marked test for identical inode numbers on identical filesystems. All information about hard linked files are shared, except for the names and the name's location in the directory system. NOTE: A "Hard link" is known as a "File Alias" on some systems. '' An undistingushed file Followed by three groups of letters for: User, Group, Others Character 1: '' Not readable; 'r' Readable Character 2: '' Not writable; 'w' Writable Character 3, User and Group: Combined execute and special '' Not Executable, Not Special 'x' Executable, Not Special 's' Executable, Special 'S' Not Executable, Special Character 3, Others: Combined execute and sticky (tacky?) '' Not Executable, Not Tacky 'x' Executable, Not Tacky 't' Executable, Tacky 'T' Not Executable, Tacky Followed by an access indicator Haven't tested this one, it may be the eleventh character or it may generate another field ' ' No alternate access '+' Alternate access LSfieldsDoc

ListDirectory() { local a T local i of=0 # OLD_IFS=$IFS case "$#" in

# Default return in variable # Using BASH default ' \t\n'

Appendix A. Contributed Scripts

517

Advanced BashScripting Guide

3) case "$1" in of) of=1 ; shift ;; * ) return 1 ;; esac ;; : ;; # Poor man's "continue" return 1 ;;

2) *) esac

# NOTE: the (ls) command is NOT quoted (") T=( $(ls inode ignorebackups almostall directory \ fulltime color=none time=status sort=none \ format=long $1) ) case $of in # Assign T back to the array whose name was passed as $2 0) eval $2=\( \"\$\{T\[@\]\}\" \) ;; # Write T into filename passed as $2 1) echo "${T[@]}" > "$2" ;; esac return 0 } # # # # # Is that string a legal number? # # # # # # # IsNumber "Var" # # # # # There has to be a better way, sigh... IsNumber() { local i int if [ $# eq 0 ] then return 1 else (let int=$1) return $? fi }

2>/dev/null # Exit status of the let thread

# # # # # Index Filesystem Directory Information # # # # # # # IndexList "FieldArrayName" "IndexArrayName" # or # IndexList if FieldArrayFilename IndexArrayName # IndexList of FieldArrayName IndexArrayFilename # IndexList if of FieldArrayFilename IndexArrayFilename # # # # # : <<IndexListDoc Walk an array of directory fields produced by ListDirectory Having suppressed the line breaks in an otherwise line oriented report, build an index to the array element which starts each line. Each line gets two index entries, the first element of each line (inode) and the element that holds the pathname of the file. The first index entry pair (LineNumber==0) are informational: IndexArrayName[0] : Number of "Lines" indexed IndexArrayName[1] : "Current Line" pointer into IndexArrayName The following index pairs (if any) hold element indexes into

Appendix A. Contributed Scripts

518

Advanced BashScripting Guide

the FieldArrayName per: IndexArrayName[LineNumber * 2] : The "inode" field element. NOTE: This distance may be either +11 or +12 elements. IndexArrayName[(LineNumber * 2) + 1] : The "pathname" element. NOTE: This distance may be a variable number of elements. Next line index pair for LineNumber+1. IndexListDoc

IndexList() { local local local local

a a i i

LIST i INDEX=( 0 0 ) Lidx Lcnt if=0 of=0

# Local of listname passed # Local of index to return # Default to variable names

case "$#" in # Simplistic option testing 0) return 1 ;; 1) return 1 ;; 2) : ;; # Poor man's continue 3) case "$1" in if) if=1 ;; of) of=1 ;; * ) return 1 ;; esac ; shift ;; 4) if=1 ; of=1 ; shift ; shift ;; *) return 1 esac # Make local copy of list case "$if" in 0) eval LIST=\( \"\$\{$1\[@\]\}\" \) ;; 1) LIST=( $(cat $1) ) ;; esac # Grok (grope?) the array Lcnt=${#LIST[@]} Lidx=0 until (( Lidx >= Lcnt )) do if IsNumber ${LIST[$Lidx]} then local i inode name local ft inode=Lidx local m=${LIST[$Lidx+2]} # Hard Links field ft=${LIST[$Lidx+1]:0:1} # FastStat case $ft in b) ((Lidx+=12)) ;; # Block device c) ((Lidx+=12)) ;; # Character device *) ((Lidx+=11)) ;; # Anything else esac name=Lidx case $ft in ) ((Lidx+=1)) ;; # The easy one b) ((Lidx+=1)) ;; # Block device c) ((Lidx+=1)) ;; # Character device d) ((Lidx+=1)) ;; # The other easy one l) ((Lidx+=3)) ;; # At LEAST two more fields # A little more elegance here would handle pipes, #+ sockets, deleted files later.

Appendix A. Contributed Scripts

519

Advanced BashScripting Guide

*) until IsNumber ${LIST[$Lidx]} || ((Lidx >= Lcnt)) do ((Lidx+=1)) done ;; # Not required

esac INDEX[${#INDEX[*]}]=$inode INDEX[${#INDEX[*]}]=$name INDEX[0]=${INDEX[0]}+1 # One more "line" found # echo "Line: ${INDEX[0]} Type: $ft Links: $m Inode: \ # ${LIST[$inode]} Name: ${LIST[$name]}" else ((Lidx+=1)) fi done case "$of" in 0) eval $2=\( \"\$\{INDEX\[@\]\}\" \) ;; 1) echo "${INDEX[@]}" > "$2" ;; esac return 0 # What could go wrong? } # # # # # Content Identify File # # # # # # # DigestFile InputArrayName DigestArrayName # or # DigestFile if InputFileName DigestArrayName # # # # # # Here document used as a comment block. : <<DigestFilesDoc The key (no pun intended) to a Unified Content File System (UCFS) is to distinguish the files in the system based on their content. Distinguishing files by their name is just, so, 20th Century. The content is distinguished by computing a checksum of that content. This version uses the md5sum program to generate a 128 bit checksum representative of the file's contents. There is a chance that two files having different content might generate the same checksum using md5sum (or any checksum). Should that become a problem, then the use of md5sum can be replace by a cyrptographic signature. But until then... The md5sum program is documented as outputting three fields (and it does), but when read it appears as two fields (array elements). This is caused by the lack of whitespace between the second and third field. So this function gropes the md5sum output and returns: [0] 32 character checksum in hexidecimal (UCFS filename) [1] Single character: ' ' text file, '*' binary file [2] Filesystem (20th Century Style) name Note: That name may be the character '' indicating STDIN read. DigestFilesDoc

DigestFile() { local if=0 local a T1 T2

# Default, variable name

Appendix A. Contributed Scripts

520

Advanced BashScripting Guide

case "$#" in 3) case "$1" in if) if=1 ; shift ;; * ) return 1 ;; esac ;; 2) : ;; # Poor man's "continue" *) return 1 ;; esac case $if in 0) eval T1=\( \"\$\{$1\[@\]\}\" \) T2=( $(echo ${T1[@]} | md5sum ) ) ;; 1) T2=( $(md5sum $1) ) ;; esac case ${#T2[@]} in 0) return 1 ;; 1) return 1 ;; 2) case ${T2[1]:0:1} in # SanScrit2.0.5 \*) T2[${#T2[@]}]=${T2[1]:1} T2[1]=\* ;; *) T2[${#T2[@]}]=${T2[1]} T2[1]=" " ;; esac ;; 3) : ;; # Assume it worked *) return 1 ;; esac local i len=${#T2[0]} if [ $len ne 32 ] ; then return 1 ; fi eval $2=\( \"\$\{T2\[@\]\}\" \) } # # # # # Locate File # # # # # # # LocateFile [l] FileName LocationArrayName # or # LocateFile [l] of FileName LocationArrayFileName # # # # # # A file location is Filesystemid and inodenumber # Here document used as a comment block. : <<StatFieldsDoc Based on stat, version 2.2 stat t and stat lt fields [0] name [1] Total size File number of bytes Symbolic link string length of pathname [2] Number of (512 byte) blocks allocated [3] File type and Access rights (hex) [4] User ID of owner [5] Group ID of owner [6] Device number [7] Inode number

Appendix A. Contributed Scripts

521

Advanced BashScripting Guide

[8] [9] [10] [11] Number of hard links Device type (if inode device) Major Device type (if inode device) Minor Time of last access May be disabled in 'mount' with noatime atime of files changed by exec, read, pipe, utime, mknod (mmap?) atime of directories changed by addition/deletion of files Time of last modification mtime of files changed by write, truncate, utime, mknod mtime of directories changed by addtition/deletion of files Time of last change ctime reflects time of changed inode information (owner, group permissions, link count

[12]

[13]

** Per: Return code: 0 Size of array: 14 Contents of array Element 0: /home/mszick Element 1: 4096 Element 2: 8 Element 3: 41e8 Element 4: 500 Element 5: 500 Element 6: 303 Element 7: 32385 Element 8: 22 Element 9: 0 Element 10: 0 Element 11: 1051221030 Element 12: 1051214068 Element 13: 1051214068 For a link in the form of linkname > realname stat t linkname returns the linkname (link) information stat lt linkname returns the realname information stat tf and stat ltf fields [0] name [1] ID0? # Maybe someday, but Linux stat structure [2] ID0? # does not have either LABEL nor UUID # fields, currently information must come # from filesystem specific utilities These will be munged into: [1] UUID if possible [2] Volume Label if possible Note: 'mount l' does return the label and could return the UUID [3] [4] [5] [6] [7] [8] [9] [10] Maximum length of filenames Filesystem type Total blocks in the filesystem Free blocks Free blocks for nonroot user(s) Block size of the filesystem Total inodes Free inodes

** Per: Return code: 0 Size of array: 11 Contents of array Element 0: /home/mszick Element 1: 0

Appendix A. Contributed Scripts

522

Advanced BashScripting Guide

Element Element Element Element Element Element Element Element Element StatFieldsDoc 2: 0 3: 255 4: ef53 5: 2581445 6: 2277180 7: 2146050 8: 4096 9: 1311552 10: 1276425

# #

LocateFile [l] FileName LocationArrayName LocateFile [l] of FileName LocationArrayFileName

LocateFile() { local a LOC LOC1 LOC2 local lk="" of=0 case "$#" in 0) return 1 ;; 1) return 1 ;; 2) : ;; *) while (( "$#" > 2 )) do case "$1" in l) lk=1 ;; of) of=1 ;; *) return 1 ;; esac shift done ;; esac # More Sanscrit2.0.5 # LOC1=( $(stat t $lk $1) ) # LOC2=( $(stat tf $lk $1) ) # Uncomment above two lines if system has "stat" command installed. LOC=( ${LOC1[@]:0:1} ${LOC1[@]:3:11} ${LOC2[@]:1:2} ${LOC2[@]:4:1} ) case "$of" in 0) eval $2=\( \"\$\{LOC\[@\]\}\" \) ;; 1) echo "${LOC[@]}" > "$2" ;; esac return 0 # Which yields (if you are lucky, and have "stat" installed) # ** Location Discriptor ** # Return code: 0 # Size of array: 15 # Contents of array # Element 0: /home/mszick 20th Century name # Element 1: 41e8 Type and Permissions # Element 2: 500 User # Element 3: 500 Group # Element 4: 303 Device # Element 5: 32385 inode # Element 6: 22 Link count # Element 7: 0 Device Major # Element 8: 0 Device Minor

Appendix A. Contributed Scripts

523

Advanced BashScripting Guide

# # # # # # } Element Element Element Element Element Element 9: 1051224608 10: 1051214068 11: 1051214068 12: 0 13: 0 14: ef53 Last Access Last Modify Last Status UUID (to be) Volume Label (to be) Filesystem type

# And then there was some test code ListArray() # ListArray Name { local a Ta eval Ta=\( \"\$\{$1\[@\]\}\" \) echo echo "** List of Array **" echo "Size of array $1: ${#Ta[*]}" echo "Contents of array $1:" for (( i=0 ; i<${#Ta[*]} ; i++ )) do echo e "\tElement $i: ${Ta[$i]}" done return 0 } declare a CUR_DIR # For small arrays ListDirectory "${PWD}" CUR_DIR ListArray CUR_DIR declare a DIR_DIG DigestFile CUR_DIR DIR_DIG echo "The new \"name\" (checksum) for ${CUR_DIR[9]} is ${DIR_DIG[0]}" declare a DIR_ENT # BIG_DIR # For really big arrays use a temporary file in ramdisk # BIGDIR # ListDirectory of "${CUR_DIR[11]}/*" "/tmpfs/junk2" ListDirectory "${CUR_DIR[11]}/*" DIR_ENT declare a DIR_IDX # BIGDIR # IndexList if "/tmpfs/junk2" DIR_IDX IndexList DIR_ENT DIR_IDX declare a IDX_DIG # BIGDIR # DIR_ENT=( $(cat /tmpfs/junk2) ) # BIGDIR # DigestFile if /tmpfs/junk2 IDX_DIG DigestFile DIR_ENT IDX_DIG # Small (should) be able to parallize IndexList & DigestFile # Large (should) be able to parallize IndexList & DigestFile & the assignment echo "The \"name\" (checksum) for the contents of ${PWD} is ${IDX_DIG[0]}" declare a FILE_LOC LocateFile ${PWD} FILE_LOC ListArray FILE_LOC exit 0

Stphane Chazelas demonstrates objectoriented programming in a Bash script.

Appendix A. Contributed Scripts

524

Advanced BashScripting Guide Example A20. Objectoriented database

#!/bin/bash # objoriented.sh: Objectoriented programming in a shell script. # Script by Stephane Chazelas. # # # #+ #+ Important Note: If running this script under version 3 or later of Bash, replace all periods in function names with a "legal" character, for example, an underscore.

person.new() # Looks almost like a class declaration in C++. { local obj_name=$1 name=$2 firstname=$3 birthdate=$4 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 person.new self Bozeman Bozo 101272413 # Create an instance of "person.new" (actually passing args to the function). self.get_firstname self.get_name self.get_age self.get_birthdate self.show_birthdate echo # typeset f #+ to see the created functions (careful, it scrolls off the page). # # # # # Bozo Bozeman 28 101272413 Sat Mar 17 20:13:33 MST 1973

Appendix A. Contributed Scripts

525

Advanced BashScripting Guide

exit 0

Mariusz Gniazdowski contributes a hash library for use in scripts.

Example A21. Library of hash functions

# # # # Hash: Hash function library Author: Mariusz Gniazdowski <mgniazdatgmail.com> Date: 20050407

# Functions making emulating hashes in Bash a little less painful.

# # # # #+ # #+ # # # # # # #

Limitations: * Only global variables are supported. * Each hash instance generates one global variable per value. * Variable names collisions are possible if you define variable like __hash__hashname_key * Keys must use chars that can be part of a Bash variable name (no dashes, periods, etc.). * The hash is created as a variable: ... hashname_keyname So if somone will create hashes like: myhash_ + mykey = myhash__mykey myhash + _mykey = myhash__mykey Then there will be a collision. (This should not pose a major problem.)

Hash_config_varname_prefix=__hash__

# Emulates: hash[key]=value # # Params: # 1 hash # 2 key # 3 value function hash_set { eval "${Hash_config_varname_prefix}${1}_${2}=\"${3}\"" }

# Emulates: value=hash[key] # # Params: # 1 hash # 2 key # 3 value (name of global variable to set) function hash_get_into { eval "$3=\"\$${Hash_config_varname_prefix}${1}_${2}\"" }

# # # # # #

Emulates:

echo hash[key]

Params: 1 hash 2 key 3 echo params (like n, for example)

Appendix A. Contributed Scripts

526

Advanced BashScripting Guide

function hash_echo { eval "echo $3 \"\$${Hash_config_varname_prefix}${1}_${2}\"" }

# Emulates: hash1[key1]=hash2[key2] # # Params: # 1 hash1 # 2 key1 # 3 hash2 # 4 key2 function hash_copy { eval "${Hash_config_varname_prefix}${1}_${2}\ =\"\$${Hash_config_varname_prefix}${3}_${4}\"" }

# Emulates: hash[keyN1]=hash[key2]=...hash[key1] # # Copies first key to rest of keys. # # Params: # 1 hash1 # 2 key1 # 3 key2 # . . . # N keyN function hash_dup { local hashName="$1" keyName="$2" shift 2 until [ ${#} le 0 ]; do eval "${Hash_config_varname_prefix}${hashName}_${1}\ =\"\$${Hash_config_varname_prefix}${hashName}_${keyName}\"" shift; done; }

# Emulates: unset hash[key] # # Params: # 1 hash # 2 key function hash_unset { eval "unset ${Hash_config_varname_prefix}${1}_${2}" }

# Emulates something similar to: ref=&hash[key] # # The reference is name of the variable in which value is held. # # Params: # 1 hash # 2 key # 3 ref Name of global variable to set. function hash_get_ref_into { eval "$3=\"${Hash_config_varname_prefix}${1}_${2}\"" }

Appendix A. Contributed Scripts

527

Advanced BashScripting Guide

# Emulates something similar to: echo &hash[key] # # That reference is name of variable in which value is held. # # Params: # 1 hash # 2 key # 3 echo params (like n for example) function hash_echo_ref { eval "echo $3 \"${Hash_config_varname_prefix}${1}_${2}\"" }

# Emulates something similar to: $$hash[key](param1, param2, ...) # # Params: # 1 hash # 2 key # 3,4, ... Function parameters function hash_call { local hash key hash=$1 key=$2 shift 2 eval "eval \"\$${Hash_config_varname_prefix}${hash}_${key} \\\"\\\$@\\\"\"" }

# Emulates something similar to: isset(hash[key]) or hash[key]==NULL # # Params: # 1 hash # 2 key # Returns: # 0 there is such key # 1 there is no such key function hash_is_set { eval "if [[ \"\${${Hash_config_varname_prefix}${1}_${2}a}\" = \"a\" && \"\${${Hash_config_varname_prefix}${1}_${2}b}\" = \"b\" ]] then return 1; else return 0; fi" }

# Emulates something similar to: # foreach($hash as $key => $value) { fun($key,$value); } # # It is possible to write different variations of this function. # Here we use a function call to make it as "generic" as possible. # # Params: # 1 hash # 2 function name function hash_foreach { local keyname oldIFS="$IFS" IFS=' ' for i in $(eval "echo \${!${Hash_config_varname_prefix}${1}_*}"); do keyname=$(eval "echo \${i##${Hash_config_varname_prefix}${1}_}") eval "$2 $keyname \"\$$i\"" done IFS="$oldIFS" }

Appendix A. Contributed Scripts

528

Advanced BashScripting Guide

# # NOTE: In lines 103 and 116, ampersand changed. But, it doesn't matter, because these are comment lines anyhow.

Here is an example script using the foregoing hash library.

Example A22. Colorizing text using hash functions

#!/bin/bash # hashexample.sh: Colorizing text. # Author: Mariusz Gniazdowski <mgniazdatgmail.com> . Hash.lib hash_set hash_set hash_set hash_set hash_set hash_set hash_set hash_set hash_set hash_set hash_set hash_set colors colors colors colors colors colors colors colors colors colors colors colors # Load the library of functions. red blue light_blue light_red cyan light_green light_gray green yellow light_purple purple reset_color "\033[0;31m" "\033[0;34m" "\033[1;34m" "\033[1;31m" "\033[0;36m" "\033[1;32m" "\033[0;37m" "\033[0;32m" "\033[1;33m" "\033[1;35m" "\033[0;35m" "\033[0;00m"

# $1 keyname # $2 value try_colors() { echo en "$2" echo "This line is $1." } hash_foreach colors try_colors hash_echo colors reset_color en echo e '\nLet us overwrite some colors with yellow.\n' # It's hard to read yellow text on some terminals. hash_dup colors yellow red light_green blue green light_gray cyan hash_foreach colors try_colors hash_echo colors reset_color en echo e '\nLet us delete them and try colors once more . . .\n' for i in red light_green blue green light_gray cyan; do hash_unset colors $i done hash_foreach colors try_colors hash_echo colors reset_color en hash_set other txt "Other examples . . ." hash_echo other txt hash_get_into other txt text echo $text hash_set other my_fun try_colors hash_call other my_fun purple "`hash_echo colors purple`" hash_echo colors reset_color en echo; echo "Back to normal?"; echo

Appendix A. Contributed Scripts

529

Advanced BashScripting Guide

exit $? # # # On some terminals, the "light" colors print in bold, and end up looking darker than the normal ones. Why is this?

An example illustrating the mechanics of hashing, but from a different point of view.

Example A23. More on hash functions

#!/bin/bash # $Id: ha.sh,v 1.2 2005/04/21 23:24:26 oliver Exp $ # Copyright 2005 Oliver Beckstein # Released under the GNU Public License # Author of script granted permission for inclusion in ABS Guide. # (Thank you!) # # pseudo hash based on indirect parameter expansion # API: access through functions: # # create the hash: # # newhash Lovers # # add entries (note single quotes for spaces) # # addhash Lovers Tristan Isolde # addhash Lovers 'Romeo Montague' 'Juliet Capulet' # # access value by key # # gethash Lovers Tristan > Isolde # # show all keys # # keyshash Lovers > 'Tristan' 'Romeo Montague' # # # Convention: instead of perls' foo{bar} = boing' syntax, # use # '_foo_bar=boing' (two underscores, no spaces) # # 1) store key in _NAME_keys[] # 2) store value in _NAME_values[] using the same integer index # The integer index for the last entry is _NAME_ptr # # NOTE: No error or sanity checks, just bare bones.

function _inihash () { # private function # call at the beginning of each procedure # defines: _keys _values _ptr # # usage: _inihash NAME local name=$1 _keys=_${name}_keys _values=_${name}_values _ptr=_${name}_ptr

Appendix A. Contributed Scripts

530

Advanced BashScripting Guide

} function newhash () { # usage: newhash NAME # NAME should not contain spaces or '.' # Actually: it must be a legal name for a Bash variable. # We rely on Bash automatically recognising arrays. local name=$1 local _keys _values _ptr _inihash ${name} eval ${_ptr}=0 }

function addhash () { # usage: addhash NAME KEY 'VALUE with spaces' # arguments with spaces need to be quoted with single quotes '' local name=$1 k="$2" v="$3" local _keys _values _ptr _inihash ${name} #echo "DEBUG(addhash): ${_ptr}=${!_ptr}" eval let ${_ptr}=${_ptr}+1 eval "$_keys[${!_ptr}]=\"${k}\"" eval "$_values[${!_ptr}]=\"${v}\"" } function gethash () { # usage: gethash NAME KEY # returns boing # ERR=0 if entry found, 1 otherwise # That's not a proper hash #+ we simply linearly search through the keys. local name=$1 key="$2" local _keys _values _ptr local k v i found h _inihash ${name} # _ptr holds the highest index in the hash found=0 for i in $(seq 1 ${!_ptr}); do h="\${${_keys}[${i}]}" # safer to do it in two steps eval k=${h} # (especially when quoting for spaces) if [ "${k}" = "${key}" ]; then found=1; break; fi done; [ ${found} = 0 ] && return 1; # else: i is the index that matches the key h="\${${_values}[${i}]}" eval echo "${h}" return 0; } function keyshash () { # usage: keyshash NAME # returns list of all keys defined for hash name local name=$1 key="$2" local _keys _values _ptr local k i h _inihash ${name}

Appendix A. Contributed Scripts

531

Advanced BashScripting Guide

# _ptr holds the highest index in the hash for i in $(seq 1 ${!_ptr}); do h="\${${_keys}[${i}]}" # Safer to do it in two steps eval k=${h} # (especially when quoting for spaces) echo n "'${k}' " done; }

# # Now, let's test it. # (Per comments at the beginning of the script.) newhash Lovers addhash Lovers Tristan Isolde addhash Lovers 'Romeo Montague' 'Juliet Capulet' # Output results. echo gethash Lovers Tristan echo keyshash Lovers echo; echo

# Isolde # 'Tristan' 'Romeo Montague'

exit 0 # Exercise: # # Add error checks to the functions.

Now for a script that installs and mounts those cute USB keychain solidstate "hard drives."

Example A24. Mounting USB keychain storage devices

#!/bin/bash # ==> usb.sh # ==> Script for mounting and installing pen/keychain USB storage devices. # ==> Runs as root at system startup (see below). # ==> # ==> Newer Linux distros (2004 or later) autodetect # ==> and install USB pen drives, and therefore don't need this script. # ==> But, it's still instructive. # # # # #+ # # # # # #+ # #+ # # This code is free software covered by GNU GPL license version 2 or above. Please refer to http://www.gnu.org/ for the full license text. Some code lifted from usbmount by Michael Hamilton's usbmount (LGPL) see http://users.actrix.co.nz/michael/usbmount.html INSTALL Put this in /etc/hotplug/usb/diskonkey. Then look in /etc/hotplug/usb.distmap, and copy all usbstorage entries into /etc/hotplug/usb.usermap, substituting "usbstorage" for "diskonkey". Otherwise this code is only run during the kernel module invocation/removal (at least in my tests), which defeats the purpose. TODO

Appendix A. Contributed Scripts

532

Advanced BashScripting Guide

# # Handle more than one diskonkey device at one time (e.g. /dev/diskonkey1 #+ and /mnt/diskonkey1), etc. The biggest problem here is the handling in #+ devlabel, which I haven't yet tried. # # AUTHOR and SUPPORT # # Konstantin Riabitsev, <icon linux duke edu>. # Send any problem reports to my email address at the moment. # # ==> Comments added by ABS Guide author.

SYMLINKDEV=/dev/diskonkey MOUNTPOINT=/mnt/diskonkey DEVLABEL=/sbin/devlabel DEVLABELCONFIG=/etc/sysconfig/devlabel IAM=$0 ## # Functions lifted nearverbatim from usbmount code. # function allAttachedScsiUsb { find /proc/scsi/ path '/proc/scsi/usbstorage*' type f | xargs grep l 'Attached: Yes' } function scsiDevFromScsiUsb { echo $1 | awk F"[/]" '{ n=$(NF1); print "/dev/sd" substr("abcdefghijklmnopqrstuvwxyz", n+1, 1) }' } if [ "${ACTION}" = "add" ] && [ f "${DEVICE}" ]; then ## # lifted from usbcam code. # if [ f /var/run/console.lock ]; then CONSOLEOWNER=`cat /var/run/console.lock` elif [ f /var/lock/console.lock ]; then CONSOLEOWNER=`cat /var/lock/console.lock` else CONSOLEOWNER= fi for procEntry in $(allAttachedScsiUsb); do scsiDev=$(scsiDevFromScsiUsb $procEntry) # Some bug with usbstorage? # Partitions are not in /proc/partitions until they are accessed #+ somehow. /sbin/fdisk l $scsiDev >/dev/null ## # Most devices have partitioning info, so the data would be on #+ /dev/sd?1. However, some stupider ones don't have any partitioning #+ and use the entire device for data storage. This tries to #+ guess semiintelligently if we have a /dev/sd?1 and if not, then #+ it uses the entire device and hopes for the better. # if grep q `basename $scsiDev`1 /proc/partitions; then part="$scsiDev""1" else part=$scsiDev fi ##

Appendix A. Contributed Scripts

533

Advanced BashScripting Guide

# Change ownership of the partition to the console user so they can #+ mount it. # if [ ! z "$CONSOLEOWNER" ]; then chown $CONSOLEOWNER:disk $part fi ## # This checks if we already have this UUID defined with devlabel. # If not, it then adds the device to the list. # prodid=`$DEVLABEL printid d $part` if ! grep q $prodid $DEVLABELCONFIG; then # cross our fingers and hope it works $DEVLABEL add d $part s $SYMLINKDEV 2>/dev/null fi ## # Check if the mount point exists and create if it doesn't. # if [ ! e $MOUNTPOINT ]; then mkdir p $MOUNTPOINT fi ## # Take care of /etc/fstab so mounting is easy. # if ! grep q "^$SYMLINKDEV" /etc/fstab; then # Add an fstab entry echo e \ "$SYMLINKDEV\t\t$MOUNTPOINT\t\tauto\tnoauto,owner,kudzu 0 0" \ >> /etc/fstab fi done if [ ! z "$REMOVER" ]; then ## # Make sure this script is triggered on device removal. # mkdir p `dirname $REMOVER` ln s $IAM $REMOVER fi elif [ "${ACTION}" = "remove" ]; then ## # If the device is mounted, unmount it cleanly. # if grep q "$MOUNTPOINT" /etc/mtab; then # unmount cleanly umount l $MOUNTPOINT fi ## # Remove it from /etc/fstab if it's there. # if grep q "^$SYMLINKDEV" /etc/fstab; then grep v "^$SYMLINKDEV" /etc/fstab > /etc/.fstab.new mv f /etc/.fstab.new /etc/fstab fi fi exit 0

Here is something to warm the hearts of webmasters and mistresses everywhere: a script that saves weblogs.

Example A25. Preserving weblogs

Appendix A. Contributed Scripts

534

Advanced BashScripting Guide

#!/bin/bash # archiveweblogs.sh v1.0 # Troy Engel <[email protected]> # Slightly modified by document author. # Used with permission. # # This script will preserve the normally rotated and #+ thrown away weblogs from a default RedHat/Apache installation. # It will save the files with a date/time stamp in the filename, #+ bzipped, to a given directory. # # Run this from crontab nightly at an off hour, #+ as bzip2 can suck up some serious CPU on huge logs: # 0 2 * * * /opt/sbin/archiveweblogs.sh

PROBLEM=66 # Set this to your backup dir. BKP_DIR=/opt/backups/weblogs # Default Apache/RedHat stuff LOG_DAYS="4 3 2 1" LOG_DIR=/var/log/httpd LOG_FILES="access_log error_log" # Default RedHat program locations LS=/bin/ls MV=/bin/mv ID=/usr/bin/id CUT=/bin/cut COL=/usr/bin/column BZ2=/usr/bin/bzip2 # Are we root? USER=`$ID u` if [ "X$USER" != "X0" ]; then echo "PANIC: Only root can run this script!" exit $PROBLEM fi # Backup dir exists/writable? if [ ! x $BKP_DIR ]; then echo "PANIC: $BKP_DIR doesn't exist or isn't writable!" exit $PROBLEM fi # Move, rename and bzip2 the logs for logday in $LOG_DAYS; do for logfile in $LOG_FILES; do MYFILE="$LOG_DIR/$logfile.$logday" if [ w $MYFILE ]; then DTS=`$LS lgo timestyle=+%Y%m%d $MYFILE | $COL t | $CUT d ' ' f7` $MV $MYFILE $BKP_DIR/$logfile.$DTS $BZ2 $BKP_DIR/$logfile.$DTS else # Only spew an error if the file exits (ergo nonwritable). if [ f $MYFILE ]; then echo "ERROR: $MYFILE not writable. Skipping." fi fi

Appendix A. Contributed Scripts

535

Advanced BashScripting Guide

done done exit 0

How do you keep the shell from expanding and reinterpreting strings?

Example A26. Protecting literal strings

#! /bin/bash # protect_literal.sh # set vx :<<'_Protect_Literal_String_Doc' Copyright (c) Michael S. Zick, 2003; All Rights Reserved License: Unrestricted reuse in any form, for any purpose. Warranty: None Revision: $ID$ Documentation redirected to the Bash nooperation. Bash will '/dev/null' this block when the script is first read. (Uncomment the above set command to see this action.) Remove the first (ShaBang) line when sourcing this as a library procedure. Also comment out the example use code in the two places where shown.

Usage: _protect_literal_str 'Whatever string meets your ${fancy}' Just echos the argument to standard out, hard quotes restored. $(_protect_literal_str 'Whatever string meets your ${fancy}') as the righthandside of an assignment statement. Does: As the righthandside of an assignment, preserves the hard quotes protecting the contents of the literal during assignment. Notes: The strange names (_*) are used to avoid trampling on the user's chosen names when this is sourced as a library. _Protect_Literal_String_Doc # The 'for illustration' function form _protect_literal_str() { # Pick an unused, nonprinting character as local IFS. # Not required, but shows that we are ignoring it. local IFS=$'\x1B' # \ESC character # Enclose the AllElementsOf in hard quotes during assignment. local tmp=$'\x27'$@$'\x27' # local tmp=$'\''$@$'\'' # Even uglier.

Appendix A. Contributed Scripts

536

Advanced BashScripting Guide

local len=${#tmp} echo $tmp is $len long. } # This is the shortnamed version. _pls() { local IFS=$'x1B' echo $'\x27'$@$'\x27' } # Info only. # Output AND information.

# \ESC character (not required) # Hard quoted parameter glob

# :<<'_Protect_Literal_String_Test' # # # Remove the above "# " to disable this code. # # # # See how that looks echo echo " Test One _protect_literal_str _protect_literal_str echo # # # # # # #+ # when printed. " 'Hello $user' 'Hello "${username}"'

Which yields: Test One 'Hello $user' is 13 long. 'Hello "${username}"' is 21 long. Looks as expected, but why all of the trouble? The difference is hidden inside the Bash internal order of operations. Which shows when you use it on the RHS of an assignment.

# Declare an array for test values. declare a arrayZ # Assign elements with various types of quotes and escapes. arrayZ=( zero "$(_pls 'Hello ${Me}')" 'Hello ${You}' "\'Pass: ${pw}\'" ) # Now list that array and see what is there. echo " Test Two " for (( i=0 ; i<${#arrayZ[*]} ; i++ )) do echo Element $i: ${arrayZ[$i]} is: ${#arrayZ[$i]} long. done echo # # # # # # Which yields: Test Two Element 0: zero is: 4 long. Element 1: 'Hello ${Me}' is: 13 long. Element 2: Hello ${You} is: 12 long. Element 3: \'Pass: \' is: 10 long.

# # # #

Our marker element Our "$(_pls '...' )" Quotes are missing ${pw} expanded to nothing

# Now make an assignment with that result. declare a array2=( ${arrayZ[@]} ) # And print what happened. echo " Test Three " for (( i=0 ; i<${#array2[*]} ; i++ )) do echo Element $i: ${array2[$i]} is: ${#array2[$i]} long. done echo

Appendix A. Contributed Scripts

537

Advanced BashScripting Guide

# # # # # # # # # # #+ # # # # # # #+ # # #+ # Which yields: Test Three Element 0: zero is: 4 long. Element 1: Hello ${Me} is: 11 long. Element 2: Hello is: 5 long. Element 3: 'Pass: is: 6 long. Element 4: ' is: 1 long.

# # # # #

Our marker element. Intended result. ${You} expanded to nothing. Split on the whitespace. The end quote is here now.

Our Element 1 has had its leading and trailing hard quotes stripped. Although not shown, leading and trailing whitespace is also stripped. Now that the string contents are set, Bash will always, internally, hard quote the contents as required during its operations. Why? Considering our "$(_pls 'Hello ${Me}')" construction: " ... " > Expansion required, strip the quotes. $( ... ) > Replace with the result of..., strip this. _pls ' ... ' > called with literal arguments, strip the quotes. The result returned includes hard quotes; BUT the above processing has already been done, so they become part of the value assigned. Similarly, during further usage of the string variable, the ${Me} is part of the contents (result) and survives any operations (Until explicitly told to evaluate the string).

# Hint: See what happens when the hard quotes ($'\x27') are replaced #+ with soft quotes ($'\x22') in the above procedures. # Interesting also is to remove the addition of any quoting. # _Protect_Literal_String_Test # # # Remove the above "# " to disable this code. # # # exit 0

What if you want the shell to expand and reinterpret strings?

Example A27. Unprotecting literal strings

#! /bin/bash # unprotect_literal.sh # set vx :<<'_UnProtect_Literal_String_Doc' Copyright (c) Michael S. Zick, 2003; All Rights Reserved License: Unrestricted reuse in any form, for any purpose. Warranty: None Revision: $ID$ Documentation redirected to the Bash nooperation. Bash will '/dev/null' this block when the script is first read. (Uncomment the above set command to see this action.) Remove the first (ShaBang) line when sourcing this as a library procedure. Also comment out the example use code in the two places where shown.

Usage:

Appendix A. Contributed Scripts

538

Advanced BashScripting Guide

Complement of the "$(_pls 'Literal String')" function. (See the protect_literal.sh example.) StringVar=$(_upls ProtectedSringVariable) Does: When used on the righthandside of an assignment statement; makes the substitions embedded in the protected string. Notes: The strange names (_*) are used to avoid trampling on the user's chosen names when this is sourced as a library.

_UnProtect_Literal_String_Doc _upls() { local IFS=$'x1B' eval echo $@ }

# \ESC character (not required) # Substitution on the glob.

# :<<'_UnProtect_Literal_String_Test' # # # Remove the above "# " to disable this code. # # #

_pls() { local IFS=$'x1B' echo $'\x27'$@$'\x27' } # Declare an array for test values. declare a arrayZ

# \ESC character (not required) # Hard quoted parameter glob

# Assign elements with various types of quotes and escapes. arrayZ=( zero "$(_pls 'Hello ${Me}')" 'Hello ${You}' "\'Pass: ${pw}\'" ) # Now make an assignment with that result. declare a array2=( ${arrayZ[@]} ) # # # # # # # Which yielded: Test Three Element 0: zero is: 4 long Element 1: Hello ${Me} is: 11 long Element 2: Hello is: 5 long Element 3: 'Pass: is: 6 long Element 4: ' is: 1 long

# # # # #

Our marker element. Intended result. ${You} expanded to nothing. Split on the whitespace. The end quote is here now.

# set vx # # #+ # Initialize 'Me' to something for the embedded ${Me} substitution. This needs to be done ONLY just prior to evaluating the protected string. (This is why it was protected to begin with.)

Me="to the array guy." # Set a string variable destination to the result. newVar=$(_upls ${array2[1]}) # Show what the contents are. echo $newVar

Appendix A. Contributed Scripts

539

Advanced BashScripting Guide

# Do we really need a function to do this? newerVar=$(eval echo ${array2[1]}) echo $newerVar # #+ # #+ I guess not, but the _upls function gives us a place to hang the documentation on. This helps when we forget what a # construction like: $(eval echo ... ) means.

# What if Me isn't set when the protected string is evaluated? unset Me newestVar=$(_upls ${array2[1]}) echo $newestVar # Just gone, no hints, no runs, no errors. # # #+ #+ # # #+ Why in the world? Setting the contents of a string variable containing character sequences that have a meaning in Bash is a general problem in script programming. This problem is now solved in eight lines of code (and four pages of description).

# Where is all this going? # Dynamic content Web pages as an array of Bash strings. # Content set per request by a Bash 'eval' command #+ on the stored page template. # Not intended to replace PHP, just an interesting thing to do. ### # Don't have a webserver application? # No problem, check the example directory of the Bash source; #+ there is a Bash script for that also. # _UnProtect_Literal_String_Test # # # Remove the above "# " to disable this code. # # # exit 0

This powerful script helps hunt down spammers.

Example A28. Spammer Identification

#!/bin/bash # $Id: is_spammer.bash,v 1.12.2.11 2004/10/01 21:42:33 mszick Exp $ # Above line is RCS info. # # # # # The latest version of this script is available from http://www.morethan.org. Spammeridentification by Michael S. Zick Used in the ABS Guide with permission.

####################################################### # Documentation # See also "Quickstart" at end of script. #######################################################

Appendix A. Contributed Scripts

540

Advanced BashScripting Guide

:<<'__is_spammer_Doc_' Copyright (c) Michael S. Zick, 2004 License: Unrestricted reuse in any form, for any purpose. Warranty: None {Its a script; the user is on their own.} Impatient? Application code: goto "# # # Hunt the Spammer' program code # # #" Example output: ":<<'_is_spammer_outputs_'" How to use: Enter script name without arguments. Or goto "Quickstart" at end of script. Provides Given a domain name or IP(v4) address as input: Does an exhaustive set of queries to find the associated network resources (short of recursing into TLDs). Checks the IP(v4) addresses found against Blacklist nameservers. If found to be a blacklisted IP(v4) address, reports the blacklist text records. (Usually hyperlinks to the specific report.) Requires A working Internet connection. (Exercise: Add check and/or abort if not online when running script.) Bash with arrays (2.05b+). The external program 'dig' a utility program provided with the 'bind' set of programs. Specifically, the version which is part of Bind series 9.x See: http://www.isc.org All usages of 'dig' are limited to wrapper functions, which may be rewritten as required. See: dig_wrappers.bash for details. ("Additional documentation" below) Usage Script requires a single argument, which may be: 1) A domain name; 2) An IP(v4) address; 3) A filename, with one name or address per line. Script accepts an optional second argument, which may be: 1) A Blacklist server name; 2) A filename, with one Blacklist server name per line. If the second argument is not provided, the script uses a builtin set of (free) Blacklist servers. See also, the Quickstart at the end of this script (after 'exit'). Return Codes 0 All OK 1 Script failure 2 Something is Blacklisted Optional environment variables

Appendix A. Contributed Scripts

541

Advanced BashScripting Guide

SPAMMER_TRACE If set to a writable file, script will log an execution flow trace. SPAMMER_DATA If set to a writable file, script will dump its discovered data in the form of GraphViz file. See: http://www.research.att.com/sw/tools/graphviz SPAMMER_LIMIT Limits the depth of resource tracing. Default is 2 levels. A setting of 0 (zero) means 'unlimited' . . . Caution: script might recurse the whole Internet! A limit of 1 or 2 is most useful when processing a file of domain names and addresses. A higher limit can be useful when hunting spam gangs.

Additional documentation Download the archived set of scripts explaining and illustrating the function contained within this script. http://personal.riverusers.com/mszick_clf.tar.bz2

Study notes This script uses a large number of functions. Nearly all general functions have their own example script. Each of the example scripts have tutorial level comments. Scripting project Add support for IP(v6) addresses. IP(v6) addresses are recognized but not processed. Advanced project Add the reverse lookup detail to the discovered information. Report the delegation chain and abuse contacts. Modify the GraphViz file output to include the newly discovered information. __is_spammer_Doc_ #######################################################

#### Special IFS settings used for string parsing. #### # Whitespace == :Space:Tab:Line Feed:Carriage Return: WSP_IFS=$'\x20'$'\x09'$'\x0A'$'\x0D' # No Whitespace == Line Feed:Carriage Return NO_WSP=$'\x0A'$'\x0D' # Field separator for dotted decimal IP addresses ADR_IFS=${NO_WSP}'.'

Appendix A. Contributed Scripts

542

Advanced BashScripting Guide

# Array to dotted string conversions DOT_IFS='.'${WSP_IFS} # # # # # # Pending operations stack machine # # # This set of functions described in func_stack.bash. (See "Additional documentation" above.) # #

# Global stack of pending operations. declare f a _pending_ # Global sentinel for stack runners declare i _p_ctrl_ # Global holder for currently executing function declare f _pend_current_ # # # Debug version only remove for regular use # # # # # The function stored in _pend_hook_ is called # immediately before each pending function is # evaluated. Stack clean, _pend_current_ set. # # This thingy demonstrated in pend_hook.bash. declare f _pend_hook_ # # # # The do nothing function pend_dummy() { : ; } # Clear and initialize the function stack. pend_init() { unset _pending_[@] pend_func pend_stop_mark _pend_hook_='pend_dummy' # Debug only. } # Discard the top function on the stack. pend_pop() { if [ ${#_pending_[@]} gt 0 ] then local i _top_ _top_=${#_pending_[@]}1 unset _pending_[$_top_] fi } # pend_func function_name [$(printf '%q\n' arguments)] pend_func() { local IFS=${NO_WSP} set f _pending_[${#_pending_[@]}]=$@ set +f } # The function which stops the release: pend_stop_mark() { _p_ctrl_=0 } pend_mark() { pend_func pend_stop_mark }

Appendix A. Contributed Scripts

543

Advanced BashScripting Guide

# Execute functions until 'pend_stop_mark' . . . pend_release() { local i _top_ # Declare _top_ as integer. _p_ctrl_=${#_pending_[@]} while [ ${_p_ctrl_} gt 0 ] do _top_=${#_pending_[@]}1 _pend_current_=${_pending_[$_top_]} unset _pending_[$_top_] $_pend_hook_ # Debug only. eval $_pend_current_ done } # Drop functions until 'pend_stop_mark' . . . pend_drop() { local i _top_ local _pd_ctrl_=${#_pending_[@]} while [ ${_pd_ctrl_} gt 0 ] do _top_=$_pd_ctrl_1 if [ "${_pending_[$_top_]}" == 'pend_stop_mark' ] then unset _pending_[$_top_] break else unset _pending_[$_top_] _pd_ctrl_=$_top_ fi done if [ ${#_pending_[@]} eq 0 ] then pend_func pend_stop_mark fi } #### Array editors #### # This function described in edit_exact.bash. # (See "Additional documentation," above.) # edit_exact <excludes_array_name> <target_array_name> edit_exact() { [ $# eq 2 ] || [ $# eq 3 ] || return 1 local a _ee_Excludes local a _ee_Target local _ee_x local _ee_t local IFS=${NO_WSP} set f eval _ee_Excludes=\( \$\{$1\[@\]\} \) eval _ee_Target=\( \$\{$2\[@\]\} \) local _ee_len=${#_ee_Target[@]} # Original length. local _ee_cnt=${#_ee_Excludes[@]} # Exclude list length. [ ${_ee_len} ne 0 ] || return 0 # Can't edit zero length. [ ${_ee_cnt} ne 0 ] || return 0 # Can't edit zero length. for (( x = 0; x < ${_ee_cnt} ; x++ )) do _ee_x=${_ee_Excludes[$x]} for (( n = 0 ; n < ${_ee_len} ; n++ )) do

Appendix A. Contributed Scripts

544

Advanced BashScripting Guide

_ee_t=${_ee_Target[$n]} if [ x"${_ee_t}" == x"${_ee_x}" ] then unset _ee_Target[$n] # Discard match. [ $# eq 2 ] && break # If 2 arguments, then done. fi done done eval $2=\( \$\{_ee_Target\[@\]\} \) set +f return 0 } # This function described in edit_by_glob.bash. # edit_by_glob <excludes_array_name> <target_array_name> edit_by_glob() { [ $# eq 2 ] || [ $# eq 3 ] || return 1 local a _ebg_Excludes local a _ebg_Target local _ebg_x local _ebg_t local IFS=${NO_WSP} set f eval _ebg_Excludes=\( \$\{$1\[@\]\} \) eval _ebg_Target=\( \$\{$2\[@\]\} \) local _ebg_len=${#_ebg_Target[@]} local _ebg_cnt=${#_ebg_Excludes[@]} [ ${_ebg_len} ne 0 ] || return 0 [ ${_ebg_cnt} ne 0 ] || return 0 for (( x = 0; x < ${_ebg_cnt} ; x++ )) do _ebg_x=${_ebg_Excludes[$x]} for (( n = 0 ; n < ${_ebg_len} ; n++ )) do [ $# eq 3 ] && _ebg_x=${_ebg_x}'*' # Do prefix edit if [ ${_ebg_Target[$n]:=} ] #+ if defined & set. then _ebg_t=${_ebg_Target[$n]/#${_ebg_x}/} [ ${#_ebg_t} eq 0 ] && unset _ebg_Target[$n] fi done done eval $2=\( \$\{_ebg_Target\[@\]\} \) set +f return 0 } # This function described in unique_lines.bash. # unique_lines <in_name> <out_name> unique_lines() { [ $# eq 2 ] || return 1 local a _ul_in local a _ul_out local i _ul_cnt local i _ul_pos local _ul_tmp local IFS=${NO_WSP} set f eval _ul_in=\( \$\{$1\[@\]\} \) _ul_cnt=${#_ul_in[@]} for (( _ul_pos = 0 ; _ul_pos < ${_ul_cnt} ; _ul_pos++ ))

Appendix A. Contributed Scripts

545

Advanced BashScripting Guide

do if [ ${_ul_in[${_ul_pos}]:=} ] # If defined & not empty then _ul_tmp=${_ul_in[${_ul_pos}]} _ul_out[${#_ul_out[@]}]=${_ul_tmp} for (( zap = _ul_pos ; zap < ${_ul_cnt} ; zap++ )) do [ ${_ul_in[${zap}]:=} ] && [ 'x'${_ul_in[${zap}]} == 'x'${_ul_tmp} ] && unset _ul_in[${zap}] done fi done eval $2=\( \$\{_ul_out\[@\]\} \) set +f return 0 } # This function described in char_convert.bash. # to_lower <string> to_lower() { [ $# eq 1 ] || return 1 local _tl_out _tl_out=${1//A/a} _tl_out=${_tl_out//B/b} _tl_out=${_tl_out//C/c} _tl_out=${_tl_out//D/d} _tl_out=${_tl_out//E/e} _tl_out=${_tl_out//F/f} _tl_out=${_tl_out//G/g} _tl_out=${_tl_out//H/h} _tl_out=${_tl_out//I/i} _tl_out=${_tl_out//J/j} _tl_out=${_tl_out//K/k} _tl_out=${_tl_out//L/l} _tl_out=${_tl_out//M/m} _tl_out=${_tl_out//N/n} _tl_out=${_tl_out//O/o} _tl_out=${_tl_out//P/p} _tl_out=${_tl_out//Q/q} _tl_out=${_tl_out//R/r} _tl_out=${_tl_out//S/s} _tl_out=${_tl_out//T/t} _tl_out=${_tl_out//U/u} _tl_out=${_tl_out//V/v} _tl_out=${_tl_out//W/w} _tl_out=${_tl_out//X/x} _tl_out=${_tl_out//Y/y} _tl_out=${_tl_out//Z/z} echo ${_tl_out} return 0 } #### Application helper functions #### # Not everybody uses dots as separators (APNIC, for example). # This function described in to_dot.bash # to_dot <string> to_dot() { [ $# eq 1 ] || return 1 echo ${1//[#|@|%]/.} return 0

Appendix A. Contributed Scripts

546

Advanced BashScripting Guide

} # This function described in is_number.bash. # is_number <input> is_number() { [ "$#" eq 1 ] || return 1 # is blank? [ x"$1" == 'x0' ] && return 0 # is zero? local i tst let tst=$1 2>/dev/null # else is numeric! return $? } # This function described in is_address.bash. # is_address <input> is_address() { [ $# eq 1 ] || return 1 # Blank ==> false local a _ia_input local IFS=${ADR_IFS} _ia_input=( $1 ) if [ ${#_ia_input[@]} eq 4 ] && is_number ${_ia_input[0]} && is_number ${_ia_input[1]} && is_number ${_ia_input[2]} && is_number ${_ia_input[3]} && [ ${_ia_input[0]} lt 256 ] && [ ${_ia_input[1]} lt 256 ] && [ ${_ia_input[2]} lt 256 ] && [ ${_ia_input[3]} lt 256 ] then return 0 else return 1 fi } # This function described in split_ip.bash. # split_ip <IP_address> #+ <array_name_norm> [<array_name_rev>] split_ip() { [ $# eq 3 ] || # Either three [ $# eq 2 ] || return 1 #+ or two arguments local a _si_input local IFS=${ADR_IFS} _si_input=( $1 ) IFS=${WSP_IFS} eval $2=\(\ \$\{_si_input\[@\]\}\ \) if [ $# eq 3 ] then # Build query order array. local a _dns_ip _dns_ip[0]=${_si_input[3]} _dns_ip[1]=${_si_input[2]} _dns_ip[2]=${_si_input[1]} _dns_ip[3]=${_si_input[0]} eval $3=\(\ \$\{_dns_ip\[@\]\}\ \) fi return 0 } # This function described in dot_array.bash. # dot_array <array_name> dot_array() {

Appendix A. Contributed Scripts

547

Advanced BashScripting Guide

[ $# eq 1 ] || return 1 # Single argument required. local a _da_input eval _da_input=\(\ \$\{$1\[@\]\}\ \) local IFS=${DOT_IFS} local _da_output=${_da_input[@]} IFS=${WSP_IFS} echo ${_da_output} return 0 } # This function described in file_to_array.bash # file_to_array <file_name> <line_array_name> file_to_array() { [ $# eq 2 ] || return 1 # Two arguments required. local IFS=${NO_WSP} local a _fta_tmp_ _fta_tmp_=( $(cat $1) ) eval $2=\( \$\{_fta_tmp_\[@\]\} \) return 0 } # Columnized print of an array of multifield strings. # col_print <array_name> <min_space> < #+ tab_stop [tab_stops]> col_print() { [ $# gt 2 ] || return 0 local a _cp_inp local a _cp_spc local a _cp_line local _cp_min local _cp_mcnt local _cp_pos local _cp_cnt local _cp_tab local i _cp local i _cpf local _cp_fld # WARNING: FOLLOWING LINE NOT BLANK IT IS QUOTED SPACES. local _cp_max=' set f local IFS=${NO_WSP} eval _cp_inp=\(\ \$\{$1\[@\]\}\ \) [ ${#_cp_inp[@]} gt 0 ] || return 0 # Empty is easy. _cp_mcnt=$2 _cp_min=${_cp_max:1:${_cp_mcnt}} shift shift _cp_cnt=$# for (( _cp = 0 ; _cp < _cp_cnt ; _cp++ )) do _cp_spc[${#_cp_spc[@]}]="${_cp_max:2:$1}" #" shift done _cp_cnt=${#_cp_inp[@]} for (( _cp = 0 ; _cp < _cp_cnt ; _cp++ )) do _cp_pos=1 IFS=${NO_WSP}$'\x20' _cp_line=( ${_cp_inp[${_cp}]} ) IFS=${NO_WSP} for (( _cpf = 0 ; _cpf < ${#_cp_line[@]} ; _cpf++ )) do

'

Appendix A. Contributed Scripts

548

Advanced BashScripting Guide

_cp_tab=${_cp_spc[${_cpf}]:${_cp_pos}} if [ ${#_cp_tab} lt ${_cp_mcnt} ] then _cp_tab="${_cp_min}" fi echo n "${_cp_tab}" (( _cp_pos = ${_cp_pos} + ${#_cp_tab} )) _cp_fld="${_cp_line[${_cpf}]}" echo n ${_cp_fld} (( _cp_pos = ${_cp_pos} + ${#_cp_fld} )) done echo done set +f return 0 } # # # # 'Hunt the Spammer' data flow # # # # # Application return code declare i _hs_RC # Original input, from which IP addresses are removed # After which, domain names to check declare a uc_name # Original input IP addresses are moved here # After which, IP addresses to check declare a uc_address # Names against which address expansion run # Ready for name detail lookup declare a chk_name # Addresses against which name expansion run # Ready for address detail lookup declare a chk_address # Recursion is depthfirstbyname. # The expand_input_address maintains this list #+ to prohibit looking up addresses twice during #+ domain name recursion. declare a been_there_addr been_there_addr=( '127.0.0.1' ) # Whitelist localhost # Names which we have checked (or given up on) declare a known_name # Addresses which we have checked (or given up on) declare a known_address # List # Each #+ with declare of zero or more Blacklist servers to check. 'known_address' will be checked against each server, negative replies and failures suppressed. a list_server

# Indirection limit set to zero == no limit indirect=${SPAMMER_LIMIT:=2} # # # # 'Hunt the Spammer' information output data # # # # # Any domain name may have multiple IP addresses.

Appendix A. Contributed Scripts

549

Advanced BashScripting Guide

# Any IP address may have multiple domain names. # Therefore, track unique addressname pairs. declare a known_pair declare a reverse_pair # In addition to the data flow variables; known_address #+ known_name and list_server, the following are output to the #+ external graphics interface file. # Authority chain, parent > SOA fields. declare a auth_chain # Reference chain, parent name > child name declare a ref_chain # DNS chain domain name > address declare a name_address # Name and service pairs domain name > service declare a name_srvc # Name and resource pairs domain name > Resource Record declare a name_resource # Parent and Child pairs parent name > child name # This MAY NOT be the same as the ref_chain followed! declare a parent_child # Address and Blacklist hit pairs address>server declare a address_hits # Dump interface file data declare f _dot_dump _dot_dump=pend_dummy # Initially a noop # Data dump is enabled by setting the environment variable SPAMMER_DATA #+ to the name of a writable file. declare _dot_file # Helper function for the dumptodotfile function # dump_to_dot <array_name> <prefix> dump_to_dot() { local a _dda_tmp local i _dda_cnt local _dda_form=' '${2}'%04u %s\n' local IFS=${NO_WSP} eval _dda_tmp=\(\ \$\{$1\[@\]\}\ \) _dda_cnt=${#_dda_tmp[@]} if [ ${_dda_cnt} gt 0 ] then for (( _dda = 0 ; _dda < _dda_cnt ; _dda++ )) do printf "${_dda_form}" \ "${_dda}" "${_dda_tmp[${_dda}]}" >>${_dot_file} done fi } # Which will also set _dot_dump to this function . . . dump_dot() { local i _dd_cnt echo '# Data vintage: '$(date R) >${_dot_file}

Appendix A. Contributed Scripts

550

Advanced BashScripting Guide

echo '# ABS Guide: is_spammer.bash; v2, 2004msz' >>${_dot_file} echo >>${_dot_file} echo 'digraph G {' >>${_dot_file} if [ ${#known_name[@]} gt 0 ] then echo >>${_dot_file} echo '# Known domain name nodes' >>${_dot_file} _dd_cnt=${#known_name[@]} for (( _dd = 0 ; _dd < _dd_cnt ; _dd++ )) do printf ' N%04u [label="%s"] ;\n' \ "${_dd}" "${known_name[${_dd}]}" >>${_dot_file} done fi if [ ${#known_address[@]} gt 0 ] then echo >>${_dot_file} echo '# Known address nodes' >>${_dot_file} _dd_cnt=${#known_address[@]} for (( _dd = 0 ; _dd < _dd_cnt ; _dd++ )) do printf ' A%04u [label="%s"] ;\n' \ "${_dd}" "${known_address[${_dd}]}" >>${_dot_file} done fi echo echo echo echo echo >>${_dot_file} '/*' >>${_dot_file} ' * Known relationships :: User conversion to' >>${_dot_file} ' * graphic form by hand or program required.' >>${_dot_file} ' *' >>${_dot_file}

if [ ${#auth_chain[@]} gt 0 ] then echo >>${_dot_file} echo '# Authority ref. edges followed & field source.' >>${_dot_file} dump_to_dot auth_chain AC fi if [ ${#ref_chain[@]} gt 0 ] then echo >>${_dot_file} echo '# Name ref. edges followed and field source.' >>${_dot_file} dump_to_dot ref_chain RC fi if [ ${#name_address[@]} gt 0 ] then echo >>${_dot_file} echo '# Known name>address edges' >>${_dot_file} dump_to_dot name_address NA fi if [ ${#name_srvc[@]} gt 0 ] then echo >>${_dot_file} echo '# Known name>service edges' >>${_dot_file} dump_to_dot name_srvc NS fi

Appendix A. Contributed Scripts

551

Advanced BashScripting Guide

if [ ${#name_resource[@]} gt 0 ] then echo >>${_dot_file} echo '# Known name>resource edges' >>${_dot_file} dump_to_dot name_resource NR fi if [ ${#parent_child[@]} gt 0 ] then echo >>${_dot_file} echo '# Known parent>child edges' >>${_dot_file} dump_to_dot parent_child PC fi if [ ${#list_server[@]} gt 0 ] then echo >>${_dot_file} echo '# Known Blacklist nodes' >>${_dot_file} _dd_cnt=${#list_server[@]} for (( _dd = 0 ; _dd < _dd_cnt ; _dd++ )) do printf ' LS%04u [label="%s"] ;\n' \ "${_dd}" "${list_server[${_dd}]}" >>${_dot_file} done fi unique_lines address_hits address_hits if [ ${#address_hits[@]} gt 0 ] then echo >>${_dot_file} echo '# Known address>Blacklist_hit edges' >>${_dot_file} echo '# CAUTION: dig warnings can trigger false hits.' >>${_dot_file} dump_to_dot address_hits AH fi echo >>${_dot_file} echo ' *' >>${_dot_file} echo ' * That is a lot of relationships. Happy graphing.' >>${_dot_file} echo ' */' >>${_dot_file} echo '}' >>${_dot_file} return 0 } # # # # 'Hunt the Spammer' execution flow # # # # # Execution trace is enabled by setting the #+ environment variable SPAMMER_TRACE to the name of a writable file. declare a _trace_log declare _log_file # Function to fill the trace log trace_logger() { _trace_log[${#_trace_log[@]}]=${_pend_current_} } # Dump trace log to file function variable. declare f _log_dump _log_dump=pend_dummy # Initially a noop. # Dump the trace log to a file. dump_log() { local i _dl_cnt _dl_cnt=${#_trace_log[@]}

Appendix A. Contributed Scripts

552

Advanced BashScripting Guide

for (( _dl = 0 ; _dl < _dl_cnt ; _dl++ )) do echo ${_trace_log[${_dl}]} >> ${_log_file} done _dl_cnt=${#_pending_[@]} if [ ${_dl_cnt} gt 0 ] then _dl_cnt=${_dl_cnt}1 echo '# # # Operations stack not empty # # #' >> ${_log_file} for (( _dl = ${_dl_cnt} ; _dl >= 0 ; _dl )) do echo ${_pending_[${_dl}]} >> ${_log_file} done fi } # # # Utility program 'dig' wrappers # # # # # These wrappers are derived from the #+ examples shown in dig_wrappers.bash. # # The major difference is these return #+ their results as a list in an array. # # See dig_wrappers.bash for details and #+ use that script to develop any changes. # # # # # Short form answer: 'dig' parses answer. # Forward lookup :: Name > Address # short_fwd <domain_name> <array_name> short_fwd() { local a _sf_reply local i _sf_rc local i _sf_cnt IFS=${NO_WSP} echo n '.' # echo 'sfwd: '${1} _sf_reply=( $(dig +short ${1} c in t a 2>/dev/null) ) _sf_rc=$? if [ ${_sf_rc} ne 0 ] then _trace_log[${#_trace_log[@]}]='## Lookup error '${_sf_rc}' on '${1}' ##' # [ ${_sf_rc} ne 9 ] && pend_drop return ${_sf_rc} else # Some versions of 'dig' return warnings on stdout. _sf_cnt=${#_sf_reply[@]} for (( _sf = 0 ; _sf < ${_sf_cnt} ; _sf++ )) do [ 'x'${_sf_reply[${_sf}]:0:2} == 'x;;' ] && unset _sf_reply[${_sf}] done eval $2=\( \$\{_sf_reply\[@\]\} \) fi return 0 } # Reverse lookup :: Address > Name # short_rev <ip_address> <array_name>

Appendix A. Contributed Scripts

553

Advanced BashScripting Guide

short_rev() { local a _sr_reply local i _sr_rc local i _sr_cnt IFS=${NO_WSP} echo n '.' # echo 'srev: '${1} _sr_reply=( $(dig +short x ${1} 2>/dev/null) ) _sr_rc=$? if [ ${_sr_rc} ne 0 ] then _trace_log[${#_trace_log[@]}]='## Lookup error '${_sr_rc}' on '${1}' ##' # [ ${_sr_rc} ne 9 ] && pend_drop return ${_sr_rc} else # Some versions of 'dig' return warnings on stdout. _sr_cnt=${#_sr_reply[@]} for (( _sr = 0 ; _sr < ${_sr_cnt} ; _sr++ )) do [ 'x'${_sr_reply[${_sr}]:0:2} == 'x;;' ] && unset _sr_reply[${_sr}] done eval $2=\( \$\{_sr_reply\[@\]\} \) fi return 0 } # Special format lookup used to query blacklist servers. # short_text <ip_address> <array_name> short_text() { local a _st_reply local i _st_rc local i _st_cnt IFS=${NO_WSP} # echo 'stxt: '${1} _st_reply=( $(dig +short ${1} c in t txt 2>/dev/null) ) _st_rc=$? if [ ${_st_rc} ne 0 ] then _trace_log[${#_trace_log[@]}]='##Text lookup error '${_st_rc}' on '${1}'##' # [ ${_st_rc} ne 9 ] && pend_drop return ${_st_rc} else # Some versions of 'dig' return warnings on stdout. _st_cnt=${#_st_reply[@]} for (( _st = 0 ; _st < ${#_st_cnt} ; _st++ )) do [ 'x'${_st_reply[${_st}]:0:2} == 'x;;' ] && unset _st_reply[${_st}] done eval $2=\( \$\{_st_reply\[@\]\} \) fi return 0 } # The long forms, a.k.a., the parse it yourself versions # # # # # RFC 2782 Service lookups dig +noall +nofail +answer _ldap._tcp.openldap.org t srv _<service>._<protocol>.<domain_name> _ldap._tcp.openldap.org. 3600 IN SRV 0 0 389 ldap.openldap.org. domain TTL Class SRV Priority Weight Port Target

Appendix A. Contributed Scripts

554

Advanced BashScripting Guide

# Forward lookup :: Name > poor man's zone transfer # long_fwd <domain_name> <array_name> long_fwd() { local a _lf_reply local i _lf_rc local i _lf_cnt IFS=${NO_WSP} echo n ':' # echo 'lfwd: '${1} _lf_reply=( $( dig +noall +nofail +answer +authority +additional \ ${1} t soa ${1} t mx ${1} t any 2>/dev/null) ) _lf_rc=$? if [ ${_lf_rc} ne 0 ] then _trace_log[${#_trace_log[@]}]='# Zone lookup err '${_lf_rc}' on '${1}' #' # [ ${_lf_rc} ne 9 ] && pend_drop return ${_lf_rc} else # Some versions of 'dig' return warnings on stdout. _lf_cnt=${#_lf_reply[@]} for (( _lf = 0 ; _lf < ${_lf_cnt} ; _lf++ )) do [ 'x'${_lf_reply[${_lf}]:0:2} == 'x;;' ] && unset _lf_reply[${_lf}] done eval $2=\( \$\{_lf_reply\[@\]\} \) fi return 0 } # The reverse lookup domain name corresponding to the IPv6 address: # 4321:0:1:2:3:4:567:89ab # would be (nibble, I.E: Hexdigit) reversed: # b.a.9.8.7.6.5.0.4.0.0.0.3.0.0.0.2.0.0.0.1.0.0.0.0.0.0.0.1.2.3.4.IP6.ARPA. # Reverse lookup :: Address > poor man's delegation chain # long_rev <rev_ip_address> <array_name> long_rev() { local a _lr_reply local i _lr_rc local i _lr_cnt local _lr_dns _lr_dns=${1}'.inaddr.arpa.' IFS=${NO_WSP} echo n ':' # echo 'lrev: '${1} _lr_reply=( $( dig +noall +nofail +answer +authority +additional \ ${_lr_dns} t soa ${_lr_dns} t any 2>/dev/null) ) _lr_rc=$? if [ ${_lr_rc} ne 0 ] then _trace_log[${#_trace_log[@]}]='# Deleg lkp error '${_lr_rc}' on '${1}' #' # [ ${_lr_rc} ne 9 ] && pend_drop return ${_lr_rc} else # Some versions of 'dig' return warnings on stdout. _lr_cnt=${#_lr_reply[@]} for (( _lr = 0 ; _lr < ${_lr_cnt} ; _lr++ )) do [ 'x'${_lr_reply[${_lr}]:0:2} == 'x;;' ] &&

Appendix A. Contributed Scripts

555

Advanced BashScripting Guide

unset _lr_reply[${_lr}] done eval $2=\( \$\{_lr_reply\[@\]\} \) fi return 0 } # # # Application specific functions # # # # Mung a possible name; suppresses root and TLDs. # name_fixup <string> name_fixup(){ local a _nf_tmp local i _nf_end local _nf_str local IFS _nf_str=$(to_lower ${1}) _nf_str=$(to_dot ${_nf_str}) _nf_end=${#_nf_str}1 [ ${_nf_str:${_nf_end}} != '.' ] && _nf_str=${_nf_str}'.' IFS=${ADR_IFS} _nf_tmp=( ${_nf_str} ) IFS=${WSP_IFS} _nf_end=${#_nf_tmp[@]} case ${_nf_end} in 0) # No dots, only dots. echo return 1 ;; 1) # Only a TLD. echo return 1 ;; 2) # Maybe okay. echo ${_nf_str} return 0 # Needs a lookup table? if [ ${#_nf_tmp[1]} eq 2 ] then # Country coded TLD. echo return 1 else echo ${_nf_str} return 0 fi ;; esac echo ${_nf_str} return 0 } # Grope and mung original input(s). split_input() { [ ${#uc_name[@]} gt 0 ] || return 0 local i _si_cnt local i _si_len local _si_str unique_lines uc_name uc_name _si_cnt=${#uc_name[@]} for (( _si = 0 ; _si < _si_cnt ; _si++ )) do

Appendix A. Contributed Scripts

556

Advanced BashScripting Guide

_si_str=${uc_name[$_si]} if is_address ${_si_str} then uc_address[${#uc_address[@]}]=${_si_str} unset uc_name[$_si] else if ! uc_name[$_si]=$(name_fixup ${_si_str}) then unset ucname[$_si] fi fi done uc_name=( ${uc_name[@]} ) _si_cnt=${#uc_name[@]} _trace_log[${#_trace_log[@]}]='#Input '${_si_cnt}' unchkd name input(s).#' _si_cnt=${#uc_address[@]} _trace_log[${#_trace_log[@]}]='#Input '${_si_cnt}' unchkd addr input(s).#' return 0 } # # # Discovery functions recursively interlocked by external data # # # # # # The leading 'if list is empty; return 0' in each is required. # # # # Recursion limiter # limit_chk() <next_level> limit_chk() { local i _lc_lmt # Check indirection limit. if [ ${indirect} eq 0 ] || [ $# eq 0 ] then # The 'doforever' choice echo 1 # Any value will do. return 0 # OK to continue. else # Limiting is in effect. if [ ${indirect} lt ${1} ] then echo ${1} # Whatever. return 1 # Stop here. else _lc_lmt=${1}+1 # Bump the given limit. echo ${_lc_lmt} # Echo it. return 0 # OK to continue. fi fi } # For each name in uc_name: # Move name to chk_name. # Add addresses to uc_address. # Pend expand_input_address. # Repeat until nothing new found. # expand_input_name <indirection_limit> expand_input_name() { [ ${#uc_name[@]} gt 0 ] || return 0 local a _ein_addr local a _ein_new local i _ucn_cnt local i _ein_cnt local _ein_tst _ucn_cnt=${#uc_name[@]}

Appendix A. Contributed Scripts

557

Advanced BashScripting Guide

if ! _ein_cnt=$(limit_chk ${1}) then return 0 fi for (( _ein = 0 ; _ein < _ucn_cnt ; _ein++ )) do if short_fwd ${uc_name[${_ein}]} _ein_new then for (( _ein_cnt = 0 ; _ein_cnt < ${#_ein_new[@]}; _ein_cnt++ )) do _ein_tst=${_ein_new[${_ein_cnt}]} if is_address ${_ein_tst} then _ein_addr[${#_ein_addr[@]}]=${_ein_tst} fi done fi done unique_lines _ein_addr _ein_addr # Scrub duplicates. edit_exact chk_address _ein_addr # Scrub pending detail. edit_exact known_address _ein_addr # Scrub already detailed. if [ ${#_ein_addr[@]} gt 0 ] # Anything new? then uc_address=( ${uc_address[@]} ${_ein_addr[@]} ) pend_func expand_input_address ${1} _trace_log[${#_trace_log[@]}]='#Add '${#_ein_addr[@]}' unchkd addr inp.#' fi edit_exact chk_name uc_name # Scrub pending detail. edit_exact known_name uc_name # Scrub already detailed. if [ ${#uc_name[@]} gt 0 ] then chk_name=( ${chk_name[@]} ${uc_name[@]} ) pend_func detail_each_name ${1} fi unset uc_name[@] return 0 } # For each address in uc_address: # Move address to chk_address. # Add names to uc_name. # Pend expand_input_name. # Repeat until nothing new found. # expand_input_address <indirection_limit> expand_input_address() { [ ${#uc_address[@]} gt 0 ] || return 0 local a _eia_addr local a _eia_name local a _eia_new local i _uca_cnt local i _eia_cnt local _eia_tst unique_lines uc_address _eia_addr unset uc_address[@] edit_exact been_there_addr _eia_addr _uca_cnt=${#_eia_addr[@]} [ ${_uca_cnt} gt 0 ] && been_there_addr=( ${been_there_addr[@]} ${_eia_addr[@]} ) for (( _eia = 0 ; _eia < _uca_cnt ; _eia++ )) do

Appendix A. Contributed Scripts

558

Advanced BashScripting Guide

if short_rev ${_eia_addr[${_eia}]} _eia_new then for (( _eia_cnt = 0 ; _eia_cnt < ${#_eia_new[@]} ; _eia_cnt++ )) do _eia_tst=${_eia_new[${_eia_cnt}]} if _eia_tst=$(name_fixup ${_eia_tst}) then _eia_name[${#_eia_name[@]}]=${_eia_tst} fi done fi done unique_lines _eia_name _eia_name # Scrub duplicates. edit_exact chk_name _eia_name # Scrub pending detail. edit_exact known_name _eia_name # Scrub already detailed. if [ ${#_eia_name[@]} gt 0 ] # Anything new? then uc_name=( ${uc_name[@]} ${_eia_name[@]} ) pend_func expand_input_name ${1} _trace_log[${#_trace_log[@]}]='#Add '${#_eia_name[@]}' unchkd name inp.#' fi edit_exact chk_address _eia_addr # Scrub pending detail. edit_exact known_address _eia_addr # Scrub already detailed. if [ ${#_eia_addr[@]} gt 0 ] # Anything new? then chk_address=( ${chk_address[@]} ${_eia_addr[@]} ) pend_func detail_each_address ${1} fi return 0 } # The parseityourself zone reply. # The input is the chk_name list. # detail_each_name <indirection_limit> detail_each_name() { [ ${#chk_name[@]} gt 0 ] || return 0 local a _den_chk # Names to check local a _den_name # Names found here local a _den_address # Addresses found here local a _den_pair # Pairs found here local a _den_rev # Reverse pairs found here local a _den_tmp # Line being parsed local a _den_auth # SOA contact being parsed local a _den_new # The zone reply local a _den_pc # ParentChild gets big fast local a _den_ref # So does reference chain local a _den_nr # NameResource can be big local a _den_na # NameAddress local a _den_ns # NameService local a _den_achn # Chain of Authority local i _den_cnt # Count of names to detail local i _den_lmt # Indirection limit local _den_who # Named being processed local _den_rec # Record type being processed local _den_cont # Contact domain local _den_str # Fixed up name string local _den_str2 # Fixed up reverse local IFS=${WSP_IFS} # Local, unique copy of names to check unique_lines chk_name _den_chk unset chk_name[@] # Done with globals.

Appendix A. Contributed Scripts

559

Advanced BashScripting Guide

# Less any names already known edit_exact known_name _den_chk _den_cnt=${#_den_chk[@]} # If anything left, add to known_name. [ ${_den_cnt} gt 0 ] && known_name=( ${known_name[@]} ${_den_chk[@]} ) # for the list of (previously) unknown names . . . for (( _den = 0 ; _den < _den_cnt ; _den++ )) do _den_who=${_den_chk[${_den}]} if long_fwd ${_den_who} _den_new then unique_lines _den_new _den_new if [ ${#_den_new[@]} eq 0 ] then _den_pair[${#_den_pair[@]}]='0.0.0.0 '${_den_who} fi # Parse each line in the reply. for (( _line = 0 ; _line < ${#_den_new[@]} ; _line++ )) do IFS=${NO_WSP}$'\x09'$'\x20' _den_tmp=( ${_den_new[${_line}]} ) IFS=${WSP_IFS} # If usable record and not a warning message . . . if [ ${#_den_tmp[@]} gt 4 ] && [ 'x'${_den_tmp[0]} != 'x;;' ] then _den_rec=${_den_tmp[3]} _den_nr[${#_den_nr[@]}]=${_den_who}' '${_den_rec} # Begin at RFC1033 (+++) case ${_den_rec} in #<name> [<ttl>] [<class>] SOA <origin> <person> SOA) # Start Of Authority if _den_str=$(name_fixup ${_den_tmp[0]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_achn[${#_den_achn[@]}]=${_den_who}' '${_den_str}' SOA' # SOA origin domain name of master zone record if _den_str2=$(name_fixup ${_den_tmp[4]}) then _den_name[${#_den_name[@]}]=${_den_str2} _den_achn[${#_den_achn[@]}]=${_den_who}' '${_den_str2}' SOA.O' fi # Responsible party email address (possibly bogus). # Possibility of [email protected] ignored. set f if _den_str2=$(name_fixup ${_den_tmp[5]}) then IFS=${ADR_IFS} _den_auth=( ${_den_str2} ) IFS=${WSP_IFS} if [ ${#_den_auth[@]} gt 2 ] then _den_cont=${_den_auth[1]} for (( _auth = 2 ; _auth < ${#_den_auth[@]} ; _auth++ )) do _den_cont=${_den_cont}'.'${_den_auth[${_auth}]} done

Appendix A. Contributed Scripts

560

Advanced BashScripting Guide

_den_name[${#_den_name[@]}]=${_den_cont}'.' _den_achn[${#_den_achn[@]}]=${_den_who}' '${_den_cont}'. SOA.C' fi fi set +f fi ;;

A) # IP(v4) Address Record if _den_str=$(name_fixup ${_den_tmp[0]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_pair[${#_den_pair[@]}]=${_den_tmp[4]}' '${_den_str} _den_na[${#_den_na[@]}]=${_den_str}' '${_den_tmp[4]} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' A' else _den_pair[${#_den_pair[@]}]=${_den_tmp[4]}' unknown.domain' _den_na[${#_den_na[@]}]='unknown.domain '${_den_tmp[4]} _den_ref[${#_den_ref[@]}]=${_den_who}' unknown.domain A' fi _den_address[${#_den_address[@]}]=${_den_tmp[4]} _den_pc[${#_den_pc[@]}]=${_den_who}' '${_den_tmp[4]} ;; NS) # Name Server Record # Domain name being serviced (may be other than current) if _den_str=$(name_fixup ${_den_tmp[0]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' NS' # Domain name of service provider if _den_str2=$(name_fixup ${_den_tmp[4]}) then _den_name[${#_den_name[@]}]=${_den_str2} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str2}' NSH' _den_ns[${#_den_ns[@]}]=${_den_str2}' NS' _den_pc[${#_den_pc[@]}]=${_den_str}' '${_den_str2} fi fi ;; MX) # Mail Server Record # Domain name being serviced (wildcards not handled here) if _den_str=$(name_fixup ${_den_tmp[0]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' MX' fi # Domain name of service provider if _den_str=$(name_fixup ${_den_tmp[5]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' MXH' _den_ns[${#_den_ns[@]}]=${_den_str}' MX' _den_pc[${#_den_pc[@]}]=${_den_who}' '${_den_str} fi ;; PTR) # Reverse address record # Special name

Appendix A. Contributed Scripts

561

Advanced BashScripting Guide

if _den_str=$(name_fixup ${_den_tmp[0]}) then _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' PTR' # Host name (not a CNAME) if _den_str2=$(name_fixup ${_den_tmp[4]}) then _den_rev[${#_den_rev[@]}]=${_den_str}' '${_den_str2} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str2}' PTRH' _den_pc[${#_den_pc[@]}]=${_den_who}' '${_den_str} fi fi ;; AAAA) # IP(v6) Address Record if _den_str=$(name_fixup ${_den_tmp[0]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_pair[${#_den_pair[@]}]=${_den_tmp[4]}' '${_den_str} _den_na[${#_den_na[@]}]=${_den_str}' '${_den_tmp[4]} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' AAAA' else _den_pair[${#_den_pair[@]}]=${_den_tmp[4]}' unknown.domain' _den_na[${#_den_na[@]}]='unknown.domain '${_den_tmp[4]} _den_ref[${#_den_ref[@]}]=${_den_who}' unknown.domain' fi # No processing for IPv6 addresses _den_pc[${#_den_pc[@]}]=${_den_who}' '${_den_tmp[4]} ;; CNAME) # Alias name record # Nickname if _den_str=$(name_fixup ${_den_tmp[0]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' CNAME' _den_pc[${#_den_pc[@]}]=${_den_who}' '${_den_str} fi # Hostname if _den_str=$(name_fixup ${_den_tmp[4]}) then _den_name[${#_den_name[@]}]=${_den_str} _den_ref[${#_den_ref[@]}]=${_den_who}' '${_den_str}' CHOST' _den_pc[${#_den_pc[@]}]=${_den_who}' '${_den_str} fi ;; TXT) ;; esac fi done else # Lookup error == 'A' record 'unknown address' _den_pair[${#_den_pair[@]}]='0.0.0.0 '${_den_who} fi done # Control dot array growth. unique_lines _den_achn _den_achn # Works best, all the same. edit_exact auth_chain _den_achn # Works best, unique items. if [ ${#_den_achn[@]} gt 0 ] then IFS=${NO_WSP} auth_chain=( ${auth_chain[@]} ${_den_achn[@]} )

# #

Appendix A. Contributed Scripts

562

Advanced BashScripting Guide

IFS=${WSP_IFS} fi unique_lines _den_ref _den_ref # Works best, all the same. edit_exact ref_chain _den_ref # Works best, unique items. if [ ${#_den_ref[@]} gt 0 ] then IFS=${NO_WSP} ref_chain=( ${ref_chain[@]} ${_den_ref[@]} ) IFS=${WSP_IFS} fi unique_lines _den_na _den_na edit_exact name_address _den_na if [ ${#_den_na[@]} gt 0 ] then IFS=${NO_WSP} name_address=( ${name_address[@]} ${_den_na[@]} ) IFS=${WSP_IFS} fi unique_lines _den_ns _den_ns edit_exact name_srvc _den_ns if [ ${#_den_ns[@]} gt 0 ] then IFS=${NO_WSP} name_srvc=( ${name_srvc[@]} ${_den_ns[@]} ) IFS=${WSP_IFS} fi unique_lines _den_nr _den_nr edit_exact name_resource _den_nr if [ ${#_den_nr[@]} gt 0 ] then IFS=${NO_WSP} name_resource=( ${name_resource[@]} ${_den_nr[@]} ) IFS=${WSP_IFS} fi unique_lines _den_pc _den_pc edit_exact parent_child _den_pc if [ ${#_den_pc[@]} gt 0 ] then IFS=${NO_WSP} parent_child=( ${parent_child[@]} ${_den_pc[@]} ) IFS=${WSP_IFS} fi # Update list known_pair (Address and Name). unique_lines _den_pair _den_pair edit_exact known_pair _den_pair if [ ${#_den_pair[@]} gt 0 ] # Anything new? then IFS=${NO_WSP} known_pair=( ${known_pair[@]} ${_den_pair[@]} ) IFS=${WSP_IFS} fi # Update list of reverse pairs. unique_lines _den_rev _den_rev edit_exact reverse_pair _den_rev if [ ${#_den_rev[@]} gt 0 ] # Anything new?

Appendix A. Contributed Scripts

563

Advanced BashScripting Guide

then IFS=${NO_WSP} reverse_pair=( ${reverse_pair[@]} ${_den_rev[@]} ) IFS=${WSP_IFS} fi # Check indirection limit give up if reached. if ! _den_lmt=$(limit_chk ${1}) then return 0 fi # Execution engine is LIFO. Order of pend operations is important. # Did we define any new addresses? unique_lines _den_address _den_address # Scrub duplicates. edit_exact known_address _den_address # Scrub already processed. edit_exact un_address _den_address # Scrub already waiting. if [ ${#_den_address[@]} gt 0 ] # Anything new? then uc_address=( ${uc_address[@]} ${_den_address[@]} ) pend_func expand_input_address ${_den_lmt} _trace_log[${#_trace_log[@]}]='# Add '${#_den_address[@]}' unchkd addr. #' fi # Did we find any new names? unique_lines _den_name _den_name # Scrub duplicates. edit_exact known_name _den_name # Scrub already processed. edit_exact uc_name _den_name # Scrub already waiting. if [ ${#_den_name[@]} gt 0 ] # Anything new? then uc_name=( ${uc_name[@]} ${_den_name[@]} ) pend_func expand_input_name ${_den_lmt} _trace_log[${#_trace_log[@]}]='#Added '${#_den_name[@]}' unchkd name#' fi return 0 } # The parseityourself delegation reply # Input is the chk_address list. # detail_each_address <indirection_limit> detail_each_address() { [ ${#chk_address[@]} gt 0 ] || return 0 unique_lines chk_address chk_address edit_exact known_address chk_address if [ ${#chk_address[@]} gt 0 ] then known_address=( ${known_address[@]} ${chk_address[@]} ) unset chk_address[@] fi return 0 } # # # Application specific output functions # # # # Pretty print the known pairs. report_pairs() { echo echo 'Known network pairs.' col_print known_pair 2 5 30 if [ ${#auth_chain[@]} gt 0 ] then

Appendix A. Contributed Scripts

564

Advanced BashScripting Guide

echo echo 'Known chain of authority.' col_print auth_chain 2 5 30 55 fi if [ ${#reverse_pair[@]} gt 0 ] then echo echo 'Known reverse pairs.' col_print reverse_pair 2 5 55 fi return 0 } # Check an address against the list of blacklist servers. # A good place to capture for GraphViz: address>status(server(reports)) # check_lists <ip_address> check_lists() { [ $# eq 1 ] || return 1 local a _cl_fwd_addr local a _cl_rev_addr local a _cl_reply local i _cl_rc local i _ls_cnt local _cl_dns_addr local _cl_lkup split_ip ${1} _cl_fwd_addr _cl_rev_addr _cl_dns_addr=$(dot_array _cl_rev_addr)'.' _ls_cnt=${#list_server[@]} echo ' Checking address '${1} for (( _cl = 0 ; _cl < _ls_cnt ; _cl++ )) do _cl_lkup=${_cl_dns_addr}${list_server[${_cl}]} if short_text ${_cl_lkup} _cl_reply then if [ ${#_cl_reply[@]} gt 0 ] then echo ' Records from '${list_server[${_cl}]} address_hits[${#address_hits[@]}]=${1}' '${list_server[${_cl}]} _hs_RC=2 for (( _clr = 0 ; _clr < ${#_cl_reply[@]} ; _clr++ )) do echo ' '${_cl_reply[${_clr}]} done fi fi done return 0 } # # # The usual application glue # # # # Who did it? credits() { echo echo 'Advanced Bash Scripting Guide: is_spammer.bash, v2, 2004msz' } # How to use it? # (See also, "Quickstart" at end of script.) usage() {

Appendix A. Contributed Scripts

565

Advanced BashScripting Guide

cat <<'_usage_statement_' The script is_spammer.bash requires either one or two arguments. arg 1) a) b) c) May be one of: A domain name An IPv4 address The name of a file with any mix of names and addresses, one per line.

arg 2) May be one of: a) A Blacklist server domain name b) The name of a file with Blacklist server domain names, one per line. c) If not present, a default list of (free) Blacklist servers is used. d) If a filename of an empty, readable, file is given, Blacklist server lookup is disabled. All script output is written to stdout. Return codes: 0 > All OK, 1 > Script failure, 2 > Something is Blacklisted. Requires the external program 'dig' from the 'bind9' set of DNS programs. See: http://www.isc.org The domain name lookup depth limit defaults to 2 levels. Set the environment variable SPAMMER_LIMIT to change. SPAMMER_LIMIT=0 means 'unlimited' Limit may also be set on the command line. If arg#1 is an integer, the limit is set to that value and then the above argument rules are applied. Setting the environment variable 'SPAMMER_DATA' to a filename will cause the script to write a GraphViz graphic file. For the development version; Setting the environment variable 'SPAMMER_TRACE' to a filename will cause the execution engine to log a function call trace. _usage_statement_ } # The default list of Blacklist servers: # Many choices, see: http://www.spews.org/lists.html declare a default_servers # See: http://www.spamhaus.org (Conservative, well maintained) default_servers[0]='sblxbl.spamhaus.org' # See: http://ordb.org (Open mail relays) default_servers[1]='relays.ordb.org' # See: http://www.spamcop.net/ (You can report spammers here) default_servers[2]='bl.spamcop.net' # See: http://www.spews.org (An 'early detect' system) default_servers[3]='l2.spews.dnsbl.sorbs.net' # See: http://www.dnsbl.us.sorbs.net/using.shtml default_servers[4]='dnsbl.sorbs.net' # See: http://dsbl.org/usage (Various mail relay lists) default_servers[5]='list.dsbl.org' default_servers[6]='multihop.dsbl.org'

Appendix A. Contributed Scripts

566

Advanced BashScripting Guide

default_servers[7]='unconfirmed.dsbl.org' # User input argument #1 setup_input() { if [ e ${1} ] && [ r ${1} ] # Name of readable file then file_to_array ${1} uc_name echo 'Using filename >'${1}'< as input.' else if is_address ${1} # IP address? then uc_address=( ${1} ) echo 'Starting with address >'${1}'<' else # Must be a name. uc_name=( ${1} ) echo 'Starting with domain name >'${1}'<' fi fi return 0 } # User input argument #2 setup_servers() { if [ e ${1} ] && [ r ${1} ] # Name of a readable file then file_to_array ${1} list_server echo 'Using filename >'${1}'< as blacklist server list.' else list_server=( ${1} ) echo 'Using blacklist server >'${1}'<' fi return 0 } # User environment variable SPAMMER_TRACE live_log_die() { if [ ${SPAMMER_TRACE:=} ] # Wants trace log? then if [ ! e ${SPAMMER_TRACE} ] then if ! touch ${SPAMMER_TRACE} 2>/dev/null then pend_func echo $(printf '%q\n' \ 'Unable to create log file >'${SPAMMER_TRACE}'<') pend_release exit 1 fi _log_file=${SPAMMER_TRACE} _pend_hook_=trace_logger _log_dump=dump_log else if [ ! w ${SPAMMER_TRACE} ] then pend_func echo $(printf '%q\n' \ 'Unable to write log file >'${SPAMMER_TRACE}'<') pend_release exit 1 fi _log_file=${SPAMMER_TRACE} echo '' > ${_log_file} _pend_hook_=trace_logger _log_dump=dump_log

Appendix A. Contributed Scripts

567

Advanced BashScripting Guide

fi fi return 0 } # User environment variable SPAMMER_DATA data_capture() { if [ ${SPAMMER_DATA:=} ] # Wants a data dump? then if [ ! e ${SPAMMER_DATA} ] then if ! touch ${SPAMMER_DATA} 2>/dev/null then pend_func echo $(printf '%q]n' \ 'Unable to create data output file >'${SPAMMER_DATA}'<') pend_release exit 1 fi _dot_file=${SPAMMER_DATA} _dot_dump=dump_dot else if [ ! w ${SPAMMER_DATA} ] then pend_func echo $(printf '%q\n' \ 'Unable to write data output file >'${SPAMMER_DATA}'<') pend_release exit 1 fi _dot_file=${SPAMMER_DATA} _dot_dump=dump_dot fi fi return 0 } # Grope user specified arguments. do_user_args() { if [ $# gt 0 ] && is_number $1 then indirect=$1 shift fi case $# in # Did user treat us well? 1) if ! setup_input $1 # Needs error checking. then pend_release $_log_dump exit 1 fi list_server=( ${default_servers[@]} ) _list_cnt=${#list_server[@]} echo 'Using default blacklist server list.' echo 'Search depth limit: '${indirect} ;; 2) if ! setup_input $1 # Needs error checking. then pend_release $_log_dump exit 1

Appendix A. Contributed Scripts

568

Advanced BashScripting Guide

fi if ! setup_servers $2 # Needs error checking. then pend_release $_log_dump exit 1 fi echo 'Search depth limit: '${indirect} ;; *) pend_func usage pend_release $_log_dump exit 1 ;; esac return 0 } # A general purpose debug tool. # list_array <array_name> list_array() { [ $# eq 1 ] || return 1 # One argument required. local a _la_lines set f local IFS=${NO_WSP} eval _la_lines=\(\ \$\{$1\[@\]\}\ \) echo echo "Element count "${#_la_lines[@]}" array "${1} local _ln_cnt=${#_la_lines[@]} for (( _i = 0; _i < ${_ln_cnt}; _i++ )) do echo 'Element '$_i' >'${_la_lines[$_i]}'<' done set +f return 0 } # # # 'Hunt the Spammer' program code # # # pend_init # Ready stack engine. pend_func credits # Last thing to print. # # # Deal with user # # # live_log_die data_capture echo do_user_args $@

# Setup debug trace log. # Setup data capture file.

# # # Haven't exited yet There is some hope # # # # Discovery group Execution engine is LIFO pend # in reverse order of execution. _hs_RC=0 # Hunt the Spammer return code pend_mark pend_func report_pairs # Report nameaddress pairs. # The two detail_* are mutually recursive functions. # They also pend expand_* functions as required. # These two (the last of ???) exit the recursion. pend_func detail_each_address # Get all resources of addresses. pend_func detail_each_name # Get all resources of names.

Appendix A. Contributed Scripts

569

Advanced BashScripting Guide

# The two expand_* are mutually recursive functions, #+ which pend additional detail_* functions as required. pend_func expand_input_address 1 # Expand input names by address. pend_func expand_input_name 1 # #xpand input addresses by name. # Start with a unique set of names and addresses. pend_func unique_lines uc_address uc_address pend_func unique_lines uc_name uc_name # Separate mixed input of names and addresses. pend_func split_input pend_release # # # Pairs reported Unique list of IP addresses found echo _ip_cnt=${#known_address[@]} if [ ${#list_server[@]} eq 0 ] then echo 'Blacklist server list empty, none checked.' else if [ ${_ip_cnt} eq 0 ] then echo 'Known address list empty, none checked.' else _ip_cnt=${_ip_cnt}1 # Start at top. echo 'Checking Blacklist servers.' for (( _ip = _ip_cnt ; _ip >= 0 ; _ip )) do pend_func check_lists $( printf '%q\n' ${known_address[$_ip]} ) done fi fi pend_release $_dot_dump # Graphics file dump $_log_dump # Execution trace echo

############################## # Example output from script # ############################## :<<'_is_spammer_outputs_' ./is_spammer.bash 0 web4.alojamentos7.com Starting with domain name >web4.alojamentos7.com< Using default blacklist server list. Search depth limit: 0 .:....::::...:::...:::.......::..::...:::.......:: Known network pairs. 66.98.208.97 web4.alojamentos7.com. 66.98.208.97 ns1.alojamentos7.com. 69.56.202.147 ns2.alojamentos.ws. 66.98.208.97 alojamentos7.com. 66.98.208.97 web.alojamentos7.com. 69.56.202.146 ns1.alojamentos.ws. 69.56.202.146 alojamentos.ws. 66.235.180.113 ns1.alojamentos.org. 66.235.181.192 ns2.alojamentos.org. 66.235.180.113 alojamentos.org. 66.235.180.113 web6.alojamentos.org.

Appendix A. Contributed Scripts

570

Advanced BashScripting Guide

216.234.234.30 12.96.160.115 216.185.111.52 69.56.141.4 216.185.111.40 216.185.111.40 216.185.111.52 ns1.theplanet.com. ns2.theplanet.com. mail1.theplanet.com. spooling.theplanet.com. theplanet.com. www.theplanet.com. mail.theplanet.com.

Checking Blacklist servers. Checking address 66.98.208.97 Records from dnsbl.sorbs.net "Spam Received See: http://www.dnsbl.sorbs.net/lookup.shtml?66.98.208.97" Checking address 69.56.202.147 Checking address 69.56.202.146 Checking address 66.235.180.113 Checking address 66.235.181.192 Checking address 216.185.111.40 Checking address 216.234.234.30 Checking address 12.96.160.115 Checking address 216.185.111.52 Checking address 69.56.141.4 Advanced Bash Scripting Guide: is_spammer.bash, v2, 2004msz _is_spammer_outputs_ exit ${_hs_RC} #################################################### # The script ignores everything from here on down # #+ because of the 'exit' command, just above. # ####################################################

Quickstart ========== Prerequisites Bash version 2.05b or 3.00 (bash version) A version of Bash which supports arrays. Array support is included by default Bash configurations. 'dig,' version 9.x.x (dig $HOSTNAME, see first line of output) A version of dig which supports the +short options. See: dig_wrappers.bash for details.

Optional Prerequisites 'named,' a local DNS caching program. Any flavor will do. Do twice: dig $HOSTNAME Check near bottom of output for: SERVER: 127.0.0.1#53 That means you have one running.

Optional Graphics Support 'date,' a standard *nix thing. (date R) dot Program to convert graphic description file to a

Appendix A. Contributed Scripts

571

Advanced BashScripting Guide

diagram. (dot V) A part of the GraphViz set of programs. See: [http://www.research.att.com/sw/tools/graphviz||GraphViz] 'dotty,' a visual editor for graphic description files. Also a part of the GraphViz set of programs.

Quick Start In the same directory as the is_spammer.bash script; Do: ./is_spammer.bash Usage Details 1. Blacklist server choices. (a) To use default, builtin list: Do nothing. (b) To use your own list: i. Create a file with a single Blacklist server domain name per line. ii. Provide that filename as the last argument to the script. (c) To use a single Blacklist server: Last argument to the script. (d) To disable Blacklist lookups: i. Create an empty file (touch spammer.nul) Your choice of filename. ii. Provide the filename of that empty file as the last argument to the script. 2. Search depth limit. (a) To use the default value of 2: Do nothing. (b) To set a different limit: A limit of 0 means: no limit. i. export SPAMMER_LIMIT=1 or whatever limit you want. ii. OR provide the desired limit as the first argument to the script. 3. Optional execution trace log. (a) To use the default setting of no log output: Do nothing. (b) To write an execution trace log: export SPAMMER_TRACE=spammer.log or whatever filename you want. 4. Optional graphic description file.

Appendix A. Contributed Scripts

572

Advanced BashScripting Guide

(a) To use the default setting of no graphic file: Do nothing. (b) To write a GraphViz graphic description file: export SPAMMER_DATA=spammer.dot or whatever filename you want. 5. Where to start the search. (a) Starting with a single domain name: i. Without a command line search limit: First argument to script. ii. With a command line search limit: Second argument to script. (b) Starting with a single IP address: i. Without a command line search limit: First argument to script. ii. With a command line search limit: Second argument to script. (c) Starting with (mixed) multiple name(s) and/or address(es): Create a file with one name or address per line. Your choice of filename. i. Without a command line search limit: Filename as first argument to script. ii. With a command line search limit: Filename as second argument to script. 6. What to do with the display output. (a) To view display output on screen: Do nothing. (b) To save display output to a file: Redirect stdout to a filename. (c) To discard display output: Redirect stdout to /dev/null. 7. Temporary end of decision making. press RETURN wait (optionally, watch the dots and colons). 8. Optionally check the return code. (a) Return code 0: All OK (b) Return code 1: Script setup failure (c) Return code 2: Something was blacklisted. 9. Where is my graph (diagram)? The script does not directly produce a graph (diagram). It only produces a graphic description file. You can process the graphic descriptor file that was output with the 'dot' program.

Appendix A. Contributed Scripts

573

Advanced BashScripting Guide

Until you edit that descriptor file, to describe the relationships you want shown, all that you will get is a bunch of labeled name and address nodes. All of the script's discovered relationships are within a comment block in the graphic descriptor file, each with a descriptive heading. The editing required to draw a line between a pair of nodes from the information in the descriptor file may be done with a text editor. Given these lines somewhere in the descriptor file: # Known domain name nodes N0000 [label="guardproof.info."] ; N0002 [label="third.guardproof.info."] ;

# Known address nodes A0000 [label="61.141.32.197"] ;

/* # Known name>address edges NA0000 third.guardproof.info. 61.141.32.197

# Known parent>child edges PC0000 guardproof.info. third.guardproof.info. */ Turn that into the following lines by substituting node identifiers into the relationships: # Known domain name nodes N0000 [label="guardproof.info."] ; N0002 [label="third.guardproof.info."] ;

# Known address nodes A0000 [label="61.141.32.197"] ;

# PC0000 guardproof.info. third.guardproof.info. N0000>N0002 ;

Appendix A. Contributed Scripts

574

Advanced BashScripting Guide

# NA0000 third.guardproof.info. 61.141.32.197 N0002>A0000 ;

/* # Known name>address edges NA0000 third.guardproof.info. 61.141.32.197

# Known parent>child edges PC0000 guardproof.info. third.guardproof.info. */ Process that with the 'dot' program, and you have your first network diagram. In addition to the conventional graphic edges, the descriptor file includes similar format pairdata that describes services, zone records (subgraphs?), blacklisted addresses, and other things which might be interesting to include in your graph. This additional information could be displayed as different node shapes, colors, line sizes, etc. The descriptor file can also be read and edited by a Bash script (of course). You should be able to find most of the functions required within the "is_spammer.bash" script. # End Quickstart.

Additional Note ========== ==== Michael Zick points out that there is a "makeviz.bash" interactive Web site at rediris.es. Can't give the full URL, since this is not a publically accessible site.

Another antispam script.

Example A29. Spammer Hunt

#!/bin/bash # whx.sh: "whois" spammer lookup # Author: Walter Dnes # Slight revisions (first section) by ABS Guide author. # Used in ABS Guide with permission. # Needs version 3.x or greater of Bash to run (because of =~ operator).

Appendix A. Contributed Scripts

575

Advanced BashScripting Guide

# Commented by script author and ABS Guide author.

E_BADARGS=65 E_NOHOST=66 E_TIMEOUT=67 E_UNDEF=68 HOSTWAIT=10 OUTFILE=whois.txt PORT=4321

# # # # # # #

Missing commandline arg. Host not found. Host lookup timed out. Some other (undefined) error. Specify up to 10 seconds for host query reply. The actual wait may be a bit longer. Output file.

if [ z "$1" ] # Check for (required) commandline arg. then echo "Usage: $0 domain name or IP address" exit $E_BADARGS fi

if [[ "$1" =~ "[azAZ][azAZ]$" ]] # Ends in two alpha chars? then # It's a domain name && must do host lookup. IPADDR=$(host W $HOSTWAIT $1 | awk '{print $4}') # Doing host lookup to get IP address. # Extract final field. else IPADDR="$1" # Commandline arg was IP address. fi echo; echo "IP Address is: "$IPADDR""; echo if [ e "$OUTFILE" ] then rm f "$OUTFILE" echo "Stale output file \"$OUTFILE\" removed."; echo fi

# Sanity checks. # (This section needs more work.) # =============================== if [ z "$IPADDR" ] # No response. then echo "Host not found!" exit $E_NOHOST # Bail out. fi if [[ "$IPADDR" =~ "^[;;]" ]] # ;; connection timed out; no servers could be reached then echo "Host lookup timed out!" exit $E_TIMEOUT # Bail out. fi if [[ "$IPADDR" =~ "[(NXDOMAIN)]$" ]] # Host xxxxxxxxx.xxx not found: 3(NXDOMAIN) then echo "Host not found!" exit $E_NOHOST # Bail out. fi

Appendix A. Contributed Scripts

576

Advanced BashScripting Guide

if [[ "$IPADDR" =~ "[(SERVFAIL)]$" ]] # Host xxxxxxxxx.xxx not found: 2(SERVFAIL) then echo "Host not found!" exit $E_NOHOST # Bail out. fi

# ======================== Main body of script ======================== AFRINICquery() { # Define the function that queries AFRINIC. Echo a notification to the #+ screen, and then run the actual query, redirecting output to $OUTFILE. echo "Searching for $IPADDR in whois.afrinic.net" whois h whois.afrinic.net "$IPADDR" > $OUTFILE # Check for presence of reference to an rwhois. # Warn about nonfunctional rwhois.infosat.net server #+ and attempt rwhois query. if grep e "^remarks: .*rwhois\.[^ ]\+" "$OUTFILE" then echo " " >> $OUTFILE echo "***" >> $OUTFILE echo "***" >> $OUTFILE echo "Warning: rwhois.infosat.net was not working as of 2005/02/02" >> $OUTFILE echo " when this script was written." >> $OUTFILE echo "***" >> $OUTFILE echo "***" >> $OUTFILE echo " " >> $OUTFILE RWHOIS=`grep "^remarks: .*rwhois\.[^ ]\+" "$OUTFILE" | tail n 1 |\ sed "s/\(^.*\)\(rwhois\..*\)\(:4.*\)/\2/"` whois h ${RWHOIS}:${PORT} "$IPADDR" >> $OUTFILE fi } APNICquery() { echo "Searching for $IPADDR in whois.apnic.net" whois h whois.apnic.net "$IPADDR" > $OUTFILE # # #+ # #+ # # #+ # #+ Just about every country has its own internet registrar. I don't normally bother consulting them, because the regional registry usually supplies sufficient information. There are a few exceptions, where the regional registry simply refers to the national registry for direct data. These are Japan and South Korea in APNIC, and Brasil in LACNIC. The following if statement checks $OUTFILE (whois.txt) for the presence of "KR" (South Korea) or "JP" (Japan) in the country field. If either is found, the query is rerun against the appropriate national registry. if grep E "^country:[ ]+KR$" "$OUTFILE" then echo "Searching for $IPADDR in whois.krnic.net" whois h whois.krnic.net "$IPADDR" >> $OUTFILE elif grep E "^country:[ ]+JP$" "$OUTFILE" then echo "Searching for $IPADDR in whois.nic.ad.jp" whois h whois.nic.ad.jp "$IPADDR"/e >> $OUTFILE

Appendix A. Contributed Scripts

577

Advanced BashScripting Guide

fi } ARINquery() { echo "Searching for $IPADDR in whois.arin.net" whois h whois.arin.net "$IPADDR" > $OUTFILE # Several large internet providers listed by ARIN have their own #+ internal whois service, referred to as "rwhois". # A large block of IP addresses is listed with the provider #+ under the ARIN registry. # To get the IP addresses of 2ndlevel ISPs or other large customers, #+ one has to refer to the rwhois server on port 4321. # I originally started with a bunch of "if" statements checking for #+ the larger providers. # This approach is unwieldy, and there's always another rwhois server #+ that I didn't know about. # A more elegant approach is to check $OUTFILE for a reference #+ to a whois server, parse that server name out of the comment section, #+ and rerun the query against the appropriate rwhois server. # The parsing looks a bit ugly, with a long continued line inside #+ backticks. # But it only has to be done once, and will work as new servers are added. #@ ABS Guide author comment: it isn't all that ugly, and is, in fact, #@+ an instructive use of Regular Expressions. if grep E "^Comment: .*rwhois.[^ ]+" "$OUTFILE" then RWHOIS=`grep e "^Comment:.*rwhois\.[^ ]\+" "$OUTFILE" | tail n 1 |\ sed "s/^\(.*\)\(rwhois\.[^ ]\+\)\(.*$\)/\2/"` echo "Searching for $IPADDR in ${RWHOIS}" whois h ${RWHOIS}:${PORT} "$IPADDR" >> $OUTFILE fi } LACNICquery() { echo "Searching for $IPADDR in whois.lacnic.net" whois h whois.lacnic.net "$IPADDR" > $OUTFILE # The following if statement checks $OUTFILE (whois.txt) for the presence of #+ "BR" (Brasil) in the country field. # If it is found, the query is rerun against whois.registro.br. if grep E "^country:[ ]+BR$" "$OUTFILE" then echo "Searching for $IPADDR in whois.registro.br" whois h whois.registro.br "$IPADDR" >> $OUTFILE fi } RIPEquery() { echo "Searching for $IPADDR in whois.ripe.net" whois h whois.ripe.net "$IPADDR" > $OUTFILE } # # # # Initialize a few variables. * slash8 is the most significant octet * slash16 consists of the two most significant octets * octet2 is the second most significant octet

Appendix A. Contributed Scripts

578

Advanced BashScripting Guide

slash8=`echo $IPADDR | cut d. f 1` if [ z "$slash8" ] # Yet another sanity check. then echo "Undefined error!" exit $E_UNDEF fi slash16=`echo $IPADDR | cut d. f 12` # ^ Period specified as 'cut" delimiter. if [ z "$slash16" ] then echo "Undefined error!" exit $E_UNDEF fi octet2=`echo $slash16 | cut d. f 2` if [ z "$octet2" ] then echo "Undefined error!" exit $E_UNDEF fi

# #

Check for various odds and ends of reserved space. There is no point in querying for those addresses.

if [ $slash8 == 0 ]; then echo $IPADDR is '"This Network"' space\; Not querying elif [ $slash8 == 10 ]; then echo $IPADDR is RFC1918 space\; Not querying elif [ $slash8 == 14 ]; then echo $IPADDR is '"Public Data Network"' space\; Not querying elif [ $slash8 == 127 ]; then echo $IPADDR is loopback space\; Not querying elif [ $slash16 == 169.254 ]; then echo $IPADDR is linklocal space\; Not querying elif [ $slash8 == 172 ] && [ $octet2 ge 16 ] && [ $octet2 le 31 ];then echo $IPADDR is RFC1918 space\; Not querying elif [ $slash16 == 192.168 ]; then echo $IPADDR is RFC1918 space\; Not querying elif [ $slash8 ge 224 ]; then echo $IPADDR is either Multicast or reserved space\; Not querying elif [ $slash8 ge 200 ] && [ $slash8 le 201 ]; then LACNICquery "$IPADDR" elif [ $slash8 ge 202 ] && [ $slash8 le 203 ]; then APNICquery "$IPADDR" elif [ $slash8 ge 210 ] && [ $slash8 le 211 ]; then APNICquery "$IPADDR" elif [ $slash8 ge 218 ] && [ $slash8 le 223 ]; then APNICquery "$IPADDR" # If we got this far without making a decision, query ARIN. # If a reference is found in $OUTFILE to APNIC, AFRINIC, LACNIC, or RIPE, #+ query the appropriate whois server. else ARINquery "$IPADDR" if grep "whois.afrinic.net" "$OUTFILE"; then AFRINICquery "$IPADDR" elif grep E "^OrgID:[ ]+RIPE$" "$OUTFILE"; then RIPEquery "$IPADDR" elif grep E "^OrgID:[ ]+APNIC$" "$OUTFILE"; then APNICquery "$IPADDR" elif grep E "^OrgID:[ ]+LACNIC$" "$OUTFILE"; then LACNICquery "$IPADDR" fi fi

Appendix A. Contributed Scripts

579

Advanced BashScripting Guide

#@ # # #@ # # Try also: wget http://logi.cc/nw/whois.php3?ACTION=doQuery&DOMAIN=$IPADDR We've now finished the querying. Echo a copy of the final result to the screen.

cat $OUTFILE # Or "less $OUTFILE" . . .

exit 0 #@ #@ #@ #@+ #@+ #@ ABS Guide author comments: Nothing fancy here, but still a very useful tool for hunting spammers. Sure, the script can be cleaned up some, and it's still a bit buggy, (exercise for reader), but all the same, it's a nice piece of coding by Walter Dnes. Thank you!

"Little Monster's" front end to wget.

Example A30. Making wget easier to use

#!/bin/bash # wgetter2.bash # # # # Author: Little Monster [[email protected]] ==> Used in ABS Guide with permission of script author. ==> This script still needs debugging and fixups (exercise for reader). ==> It could also use some additional editing in the comments.

# This is wgetter2 #+ a Bash script to make wget a bit more friendly, and save typing. # Carefully crafted by Little Monster. # More or less complete on 02/02/2005. # If you think this script can be improved, #+ email me at: [email protected] # ==> and cc: to the author of the ABS Guide, please. # This script is licenced under the GPL. # You are free to copy, alter and reuse it, #+ but please don't try to claim you wrote it. # Log your changes here instead. # ======================================================================= # changelog: # # # # # # # # # # 07/02/2005. 02/02/2005. 29/01/2005. 22/11/2004. 01/12/2004. 01/12/2004. Fixups by Little Monster. Minor additions by Little Monster. (See after # +++++++++++ ) Minor stylistic edits and cleanups by author of ABS Guide. Added exit error codes. Finished initial version of second version of wgetter: wgetter2 is born. Changed 'runn' function so it can be run 2 ways either ask for a file name or have one input on the CL. Made sensible handling of no URL's given.

Appendix A. Contributed Scripts

580

Advanced BashScripting Guide

# # # # # # # # # # # # 01/12/2004. Made loop of main options, so you don't have to keep calling wgetter 2 all the time. Runs as a session instead. 01/12/2004. Added looping to 'runn' function. Simplified and improved. 01/12/2004. Added state to recursion setting. Enables reuse of previous value. 05/12/2004. Modified the file detection routine in the 'runn' function so it's not fooled by empty values, and is cleaner. 01/02/2004. Added cookie finding routine from later version (which isn't ready yet), so as not to have hardcoded paths. ======================================================================= abnormal exit. # Usage message, then quit. # No commandline args entered. # No URLs passed to script. # No save filename passed to script. # User decides to quit.

# Error codes for E_USAGE=67 E_NO_OPTS=68 E_NO_URLS=69 E_NO_SAVEFILE=70 E_USER_EXIT=71

# Basic default wget command we want to use. # This is the place to change it, if required. # NB: if using a proxy, set http_proxy = yourproxy in .wgetrc. # Otherwise delete proxy=on, below. # ==================================================================== CommandA="wget nc c t 5 progress=bar randomwait proxy=on r" # ====================================================================

# # Set some other variables and explain them. pattern=" A .jpg,.JPG,.jpeg,.JPEG,.gif,.GIF,.htm,.html,.shtml,.php" # wget's option to only get certain types of file. # comment out if not using today=`date +%F` # Used for a filename. home=$HOME # Set HOME to an internal variable. # In case some other path is used, change it here. depthDefault=3 # Set a sensible default recursion. Depth=$depthDefault # Otherwise user feedback doesn't tie in properly. RefA="" # Set blank referring page. Flag="" # Default to not saving anything, #+ or whatever else might be wanted in future. lister="" # Used for passing a list of urls directly to wget. Woptions="" # Used for passing wget some options for itself. inFile="" # Used for the run function. newFile="" # Used for the run function. savePath="$home/wsave" Config="$home/.wgetter2rc" # This is where some variables can be stored, #+ if permanently changed from within the script. Cookie_List="$home/.cookielist" # So we know where the cookies are kept . . . cFlag="" # Part of the cookie file selection routine. # Define the options available. Easy to change letters here if needed. # These are the optional options; you don't just wait to be asked. save=s cook=c # Save command instead of executing it. # Change cookie file for this session.

Appendix A. Contributed Scripts

581

Advanced BashScripting Guide

help=h # Usage guide. list=l # Pass wget the i option and URL list. runn=r # Run saved commands as an argument to the option. inpu=i # Run saved commands interactively. wopt=w # Allow to enter options to pass directly to wget. #

if [ z echo echo exit fi

"$1" ]; then # Make sure we get something for wget to eat. "You must at least enter a URL or option!" "$help for usage." $E_NO_OPTS

# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # added added added added added added added added added added added added if [ ! e "$Config" ]; then # See if configuration file exists. echo "Creating configuration file, $Config" echo "# This is the configuration file for wgetter2" > "$Config" echo "# Your customised settings will be saved in this file" >> "$Config" else source $Config # Import variables we set outside the script. fi if [ ! e "$Cookie_List" ]; then # Set up a list of cookie files, if there isn't one. echo "Hunting for cookies . . ." find name cookies.txt >> $Cookie_List # Create the list of cookie files. fi # Isolate this in its own 'if' statement, #+ in case we got interrupted while searching. if [ z "$cFlag" ]; then # If we haven't already done this . . . echo # Make a nice space after the command prompt. echo "Looks like you haven't set up your source of cookies yet." n=0 # Make sure the counter #+ doesn't contain random values. while read; do Cookies[$n]=$REPLY # Put the cookie files we found into an array. echo "$n) ${Cookies[$n]}" # Create a menu. n=$(( n + 1 )) # Increment the counter. done < $Cookie_List # Feed the read statement. echo "Enter the number of the cookie file you want to use." echo "If you won't be using cookies, just press RETURN." echo echo "I won't be asking this again. Edit $Config" echo "If you decide to change at a later date" echo "or use the ${cook} option for per session changes." read if [ ! z $REPLY ]; then # User didn't just press return. Cookie=" loadcookies ${Cookies[$REPLY]}" # Set the variable here as well as in the config file. echo "Cookie=\" loadcookies ${Cookies[$REPLY]}\"" >> $Config fi echo "cFlag=1" >> $Config # So we know not to ask again. fi # end added section end added section end added section end added section # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Appendix A. Contributed Scripts

582

Advanced BashScripting Guide

# Another variable. # This one may or may not be subject # A bit like the small print. CookiesON=$Cookie # echo "cookie file is $CookiesON" # # echo "home is ${home}" # #

to variation.

For debugging. For debugging. Got caught with this one!

wopts() { echo "Enter options to pass to wget." echo "It is assumed you know what you're doing." echo echo "You can pass their arguments here too." # That is to say, everything passed here is passed to wget. read Wopts # Read in the options to be passed to wget. Woptions=" $Wopts" # ^ Why the leading space? # Assign to another variable. # Just for fun, or something . . . echo "passing options ${Wopts} to wget" # Mainly for debugging. # Is cute. return }

save_func() { echo "Settings will be saved." if [ ! d $savePath ]; then # See if directory exists. mkdir $savePath # Create the directory to save things in #+ if it isn't already there. fi Flag=S # Tell the final bit of code what to do. # Set a flag since stuff is done in main. return }

usage() # Tell them how it works. { echo "Welcome to wgetter. This is a front end to wget." echo "It will always run wget with these options:" echo "$CommandA" echo "and the pattern to match: $pattern \ (which you can change at the top of this script)." echo "It will also ask you for recursion depth, \ and if you want to use a referring page." echo "Wgetter accepts the following options:"

Appendix A. Contributed Scripts

583

Advanced BashScripting Guide

echo "" echo "$help : Display this help." echo "$save : Save the command to a file $savePath/wget($today) \ instead of running it." echo "$runn : Run saved wget commands instead of starting a new one " echo "Enter filename as argument to this option." echo "$inpu : Run saved wget commands interactively " echo "The script will ask you for the filename." echo "$cook : Change the cookies file for this session." echo "$list : Tell wget to use URL's from a list instead of \ from the command line." echo "$wopt : Pass any other options direct to wget." echo "" echo "See the wget man page for additional options \ you can pass to wget." echo "" exit $E_USAGE } # End here. Don't process anything else.

list_func() # Gives the user the option to use the i option to wget, #+ and a list of URLs. { while [ 1 ]; do echo "Enter the name of the file containing URL's (press q to change your mind)." read urlfile if [ ! e "$urlfile" ] && [ "$urlfile" != q ]; then # Look for a file, or the quit option. echo "That file does not exist!" elif [ "$urlfile" = q ]; then # Check quit option. echo "Not using a url list." return else echo "using $urlfile." echo "If you gave url's on the command line, I'll use those first." # Report wget standard behaviour to the user. lister=" i $urlfile" # This is what we want to pass to wget. return fi done }

cookie_func() # Give the user the option to use a different cookie file. { while [ 1 ]; do echo "Change the cookies file. Press return if you don't want to change it." read Cookies # NB: this is not the same as Cookie, earlier. # There is an 's' on the end. # Bit like chocolate chips. if [ z "$Cookies" ]; then # Escape clause for wusses. return elif [ ! e "$Cookies" ]; then echo "File does not exist. Try again." # Keep em going . . . else CookiesON=" loadcookies $Cookies" # File is good use it! return

Appendix A. Contributed Scripts

584

Advanced BashScripting Guide

fi done }

run_func() { if [ z "$OPTARG" ]; then # Test to see if we used the inline option or the query one. if [ ! d "$savePath" ]; then # If directory doesn't exist . . . echo "$savePath does not appear to exist." echo "Please supply path and filename of saved wget commands:" read newFile until [ f "$newFile" ]; do # Keep going till we get something. echo "Sorry, that file does not exist. Please try again." # Try really hard to get something. read newFile done

# # if [ z ( grep wget ${newfile} ) ]; then # Assume they haven't got the right file and bail out. # echo "Sorry, that file does not contain wget commands. Aborting." # exit # fi # # This is bogus code. # It doesn't actually work. # If anyone wants to fix it, feel free! #

filePath="${newFile}" else echo "Save path is $savePath" echo "Please enter name of the file which you want to use." echo "You have a choice of:" ls $savePath # Give them a choice. read inFile until [ f "$savePath/$inFile" ]; do # Keep going till #+ we get something. if [ ! f "${savePath}/${inFile}" ]; then # If file doesn't exist. echo "Sorry, that file does not exist. Please choose from:" ls $savePath # If a mistake is made. read inFile fi done filePath="${savePath}/${inFile}" # Make one variable . . . fi else filePath="${savePath}/${OPTARG}" # Which can be many things . . . fi if [ ! f "$filePath" ]; then # If a bogus file got through. echo "You did not specify a suitable file." echo "Run this script with the ${save} option first." echo "Aborting." exit $E_NO_SAVEFILE fi echo "Using: $filePath" while read; do

Appendix A. Contributed Scripts

585

Advanced BashScripting Guide

eval $REPLY echo "Completed: $REPLY" done < $filePath # Feed the actual file we are using into a 'while' loop. exit }

# Fish out any options we are using for the script. # This is based on the demo in "Learning The Bash Shell" (O'Reilly). while getopts ":$save$cook$help$list$runn:$inpu$wopt" opt do case $opt in $save) save_func;; # Save some wgetter sessions for later. $cook) cookie_func;; # Change cookie file. $help) usage;; # Get help. $list) list_func;; # Allow wget to use a list of URLs. $runn) run_func;; # Useful if you are calling wgetter from, #+ for example, a cron script. $inpu) run_func;; # When you don't know what your files are named. $wopt) wopts;; # Pass options directly to wget. \?) echo "Not a valid option." echo "Use ${wopt} to pass options directly to wget," echo "or ${help} for help";; # Catch anything else. esac done shift $((OPTIND 1)) # Do funky magic stuff with $#.

if [ z "$1" ] && [ z "$lister" ]; then # We should be left with at least one URL #+ on the command line, unless a list is #+ being used catch empty CL's. echo "No URL's given! You must enter them on the same line as wgetter2." echo "E.g., wgetter2 http://somesite http://anothersite." echo "Use $help option for more information." exit $E_NO_URLS # Bail out, with appropriate error code. fi URLS=" $@" # Use this so that URL list can be changed if we stay in the option loop. while [ 1 ]; do # This is where we ask for the most used options. # (Mostly unchanged from version 1 of wgetter) if [ z $curDepth ]; then Current="" else Current=" Current value is $curDepth" fi echo "How deep should I go? \ (integer: Default is $depthDefault.$Current)" read Depth # Recursion how far should we go? inputB="" # Reset this to blank on each pass of the loop. echo "Enter the name of the referring page (default is none)." read inputB # Need this for some sites. echo "Do you want to have the output logged to the terminal" echo "(y/n, default is yes)?" read noHide # Otherwise wget will just log it to a file. case $noHide in # Now you see me, now you don't.

Appendix A. Contributed Scripts

586

Advanced BashScripting Guide

y|Y ) hide="";; n|N ) hide=" b";; * ) hide="";; esac if [ z ${Depth} ]; then # User accepted either default or current depth, #+ in which case Depth is now empty. if [ z ${curDepth} ]; then # See if a depth was set on a previous iteration. Depth="$depthDefault" # Set the default recursion depth if nothing #+ else to use. else Depth="$curDepth" # Otherwise, set the one we used before. fi fi Recurse=" l $Depth" # Set how deep we want to go. curDepth=$Depth # Remember setting for next time. if [ ! z $inputB ]; then RefA=" referer=$inputB" fi

# Option to use referring page.

WGETTER="${CommandA}${pattern}${hide}${RefA}${Recurse}\ ${CookiesON}${lister}${Woptions}${URLS}" # Just string the whole lot together . . . # NB: no embedded spaces. # They are in the individual elements so that if any are empty, #+ we don't get an extra space. if [ z "${CookiesON}" ] && [ "$cFlag" = "1" ] ; then echo "Warning can't find cookie file" # This should be changed, #+ in case the user has opted to not use cookies. fi if [ "$Flag" = "S" ]; then echo "$WGETTER" >> $savePath/wget${today} # Create a unique filename for today, or append to it if it exists. echo "$inputB" >> $savePath/sitelist${today} # Make a list, so it's easy to refer back to, #+ since the whole command is a bit confusing to look at. echo "Command saved to the file $savePath/wget${today}" # Tell the user. echo "Referring page URL saved to the file$ \ savePath/sitelist${today}" # Tell the user. Saver=" with save option" # Stick this somewhere, so it appears in the loop if set. else echo "*****************" echo "*****Getting*****" echo "*****************" echo "" echo "$WGETTER" echo "" echo "*****************" eval "$WGETTER" fi echo "" echo "Starting over$Saver."

Appendix A. Contributed Scripts

587

Advanced BashScripting Guide

echo "If you want to stop, press q." echo "Otherwise, enter some URL's:" # Let them go again. Tell about save option being set. read case $REPLY in # Need to change this to a 'trap' clause. q|Q ) exit $E_USER_EXIT;; # Exercise for the reader? * ) URLS=" $REPLY";; esac echo "" done

exit 0

Example A31. A "podcasting" script

#!/bin/bash # # # #+ # # #+ # bashpodder.sh: By Linc 10/1/2004 Find the latest script at http://linc.homeunix.org:8080/scripts/bashpodder Last revision 12/14/2004 Many Contributors! If you use this and have made improvements or have comments drop me an email at linc dot fessenden at gmail dot com I'd appreciate it! ABS Guide extra comments.

# ==>

# ==> Author of this script has kindly granted permission # ==>+ for inclusion in ABS Guide.

# ==> ################################################################ # # ==> What is "podcasting"? # ==> It's broadcasting "radio shows" over the Internet. # ==> These shows can be played on iPods and other music file players. # ==> This script makes it possible. # ==> See documentation at the script author's site, above. # ==> ################################################################

# Make script crontab friendly: cd $(dirname $0) # ==> Change to directory where this script lives. # datadir is the directory you want podcasts saved to: datadir=$(date +%Y%m%d) # ==> Will create a directory with the name: YYYYMMDD # Check for and create datadir if necessary: if test ! d $datadir then mkdir $datadir

Appendix A. Contributed Scripts

588

Advanced BashScripting Guide

fi # Delete any temp file: rm f temp.log # Read the bp.conf file and wget any url not already in the podcast.log file: while read podcast do # ==> Main action follows. file=$(wget q $podcast O | tr '\r' '\n' | tr \' \" | \ sed n 's/.*url="\([^"]*\)".*/\1/p') for url in $file do echo $url >> temp.log if ! grep "$url" podcast.log > /dev/null then wget q P $datadir "$url" fi done done < bp.conf # Move dynamically created log file to permanent log file: cat podcast.log >> temp.log sort temp.log | uniq > podcast.log rm temp.log # Create an m3u playlist: ls $datadir | grep v m3u > $datadir/podcast.m3u

exit 0 ################################################# For a different scripting approach to Podcasting, see Phil Salkie's article, "Internet Radio to Podcast with Shell Tools" in the September, 2005 issue of LINUX JOURNAL, http://www.linuxjournal.com/article/8171 #################################################

Example A32. Nightly backup to a firewire HD

#!/bin/bash # nightlybackup.sh # http://www.richardneill.org/source.php#nightlybackuprsync # Copyright (c) 2005 Richard Neill <[email protected]>. # This is Free Software licensed under the GNU GPL. # ==> Included in ABS Guide with script author's kind permission. # ==> (Thanks!) # #+ # # # # #+ # #+ This does a backup from the host computer to a locally connected firewire HDD using rsync and ssh. It then rotates the backups. Run it via cron every night at 5am. This only backs up the home directory. If ownerships (other than the user's) should be preserved, then run the rsync process as root (and reinstate the o). We save every day for 7 days, then every week for 4 weeks, then every month for 3 months.

# See: http://www.mikerubel.org/computers/rsync_snapshots/ #+ for more explanation of the theory. # Save as: $HOME/bin/nightlybackup_firewirehdd.sh

Appendix A. Contributed Scripts

589

Advanced BashScripting Guide

# # # Known bugs: i) Ideally, we want to exclude ~/.tmp and the browser caches.

# ii) If the user is sitting at the computer at 5am, #+ and files are modified while the rsync is occurring, #+ then the BACKUP_JUSTINCASE branch gets triggered. # To some extent, this is a #+ feature, but it also causes a "diskspace leak".

##### BEGIN CONFIGURATION SECTION ############################################ LOCAL_USER=rjn # User whose home directory should be backed up. MOUNT_POINT=/backup # Mountpoint of backup drive. # NO trailing slash! # This must be unique (eg using a udev symlink) SOURCE_DIR=/home/$LOCAL_USER # NO trailing slash it DOES matter to rsync. BACKUP_DEST_DIR=$MOUNT_POINT/backup/`hostname s`.${LOCAL_USER}.nightly_backup DRY_RUN=false #If true, invoke rsync with n, to do a dry run. # Comment out or set to false for normal use. VERBOSE=false # If true, make rsync verbose. # Comment out or set to false otherwise. COMPRESS=false # If true, compress. # Good for internet, bad on LAN. # Comment out or set to false otherwise. ### Exit Codes ### E_VARS_NOT_SET=64 E_COMMANDLINE=65 E_MOUNT_FAIL=70 E_NOSOURCEDIR=71 E_UNMOUNTED=72 E_BACKUP=73 ##### END CONFIGURATION SECTION ##############################################

# Check if [ z [ z [ z [ z then echo exit fi

that all the important variables have been set: "$LOCAL_USER" ] || "$SOURCE_DIR" ] || "$MOUNT_POINT" ] || "$BACKUP_DEST_DIR" ] 'One of the variables is not set! Edit the file: $0. BACKUP FAILED.' $E_VARS_NOT_SET

if [ "$#" != 0 ] # If commandline param(s) . . . then # Here document(ation). cat <<ENDOFTEXT Automatic Nightly backup run from cron. Read the source for more details: $0 The backup directory is $BACKUP_DEST_DIR . It will be created if necessary; initialisation is no longer required. WARNING: Contents of $BACKUP_DEST_DIR are rotated. Directories named 'backup.\$i' will eventually be DELETED. We keep backups from every day for 7 days (18), then every week for 4 weeks (912),

Appendix A. Contributed Scripts

590

Advanced BashScripting Guide

then every month for 3 months (1315). You may wish to add this to your crontab using 'crontab e' # Back up files: $SOURCE_DIR to $BACKUP_DEST_DIR #+ every night at 3:15 am 15 03 * * * /home/$LOCAL_USER/bin/nightlybackup_firewirehdd.sh Don't forget to verify the backups are working, especially if you don't read cron's mail!" ENDOFTEXT exit $E_COMMANDLINE fi

# Parse the options. # ================== if [ "$DRY_RUN" == "true" ]; then DRY_RUN="n" echo "WARNING:" echo "THIS IS A 'DRY RUN'!" echo "No data will actually be transferred!" else DRY_RUN="" fi if [ "$VERBOSE" == "true" ]; then VERBOSE="v" else VERBOSE="" fi if [ "$COMPRESS" == "true" ]; then COMPRESS="z" else COMPRESS="" fi

# Every week (actually of 8 days) and every month, #+ extra backups are preserved. DAY_OF_MONTH=`date +%d` # Day of month (01..31). if [ $DAY_OF_MONTH = 01 ]; then # First of month. MONTHSTART=true elif [ $DAY_OF_MONTH = 08 \ o $DAY_OF_MONTH = 16 \ o $DAY_OF_MONTH = 24 ]; then # Day 8,16,24 (use 8, not 7 to better handle 31day months) WEEKSTART=true fi

# Check that the HDD is mounted. # At least, check that *something* is mounted here! # We can use something unique to the device, rather than just guessing #+ the scsiid by having an appropriate udev rule in #+ /etc/udev/rules.d/10rules.local #+ and by putting a relevant entry in /etc/fstab. # Eg: this udev rule: # BUS="scsi", KERNEL="sd*", SYSFS{vendor}="WDC WD16", # SYSFS{model}="00JB00GVA0 ", NAME="%k", SYMLINK="lacie_1394d%n"

Appendix A. Contributed Scripts

591

Advanced BashScripting Guide

if mount | grep $MOUNT_POINT >/dev/null; then echo "Mount point $MOUNT_POINT is indeed mounted. OK" else echo n "Attempting to mount $MOUNT_POINT..." # If it isn't mounted, try to mount it. sudo mount $MOUNT_POINT 2>/dev/null if mount | grep $MOUNT_POINT >/dev/null; then UNMOUNT_LATER=TRUE echo "OK" # Note: Ensure that this is also unmounted #+ if we exit prematurely with failure. else echo "FAILED" echo e "Nothing is mounted at $MOUNT_POINT. BACKUP FAILED!" exit $E_MOUNT_FAIL fi fi

# Check that source dir exists and is readable. if [ ! r $SOURCE_DIR ] ; then echo "$SOURCE_DIR does not exist, or cannot be read. BACKUP FAILED." exit $E_NOSOURCEDIR fi

# # # #

Check that the backup directory structure is as it should be. If not, create it. Create the subdirectories. Note that backup.0 will be created as needed by rsync.

for ((i=1;i<=15;i++)); do if [ ! d $BACKUP_DEST_DIR/backup.$i ]; then if /bin/mkdir p $BACKUP_DEST_DIR/backup.$i ; then # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ No [ ] test brackets. Why? echo "Warning: directory $BACKUP_DEST_DIR/backup.$i is missing," echo "or was not initialised. (Re)creating it." else echo "ERROR: directory $BACKUP_DEST_DIR/backup.$i" echo "is missing and could not be created." if [ "$UNMOUNT_LATER" == "TRUE" ]; then # Before we exit, unmount the mount point if necessary. cd sudo umount $MOUNT_POINT && echo "Unmounted $MOUNT_POINT again. Giving up." fi exit $E_UNMOUNTED fi fi done

# Set the permission to 700 for security #+ on an otherwise permissive multiuser system. if ! /bin/chmod 700 $BACKUP_DEST_DIR ; then echo "ERROR: Could not set permissions on $BACKUP_DEST_DIR to 700." if [ "$UNMOUNT_LATER" == "TRUE" ]; then # Before we exit, unmount the mount point if necessary. cd ; sudo umount $MOUNT_POINT && echo "Unmounted $MOUNT_POINT again. Giving up."

Appendix A. Contributed Scripts

592

Advanced BashScripting Guide

fi exit $E_UNMOUNTED fi # Create the symlink: current > backup.1 if required. # A failure here is not critical. cd $BACKUP_DEST_DIR if [ ! h current ] ; then if ! /bin/ln s backup.1 current ; then echo "WARNING: could not create symlink current > backup.1" fi fi

# Now, do the rsync. echo "Now doing backup with rsync..." echo "Source dir: $SOURCE_DIR" echo e "Backup destination dir: $BACKUP_DEST_DIR\n"

/usr/bin/rsync $DRY_RUN $VERBOSE a S delete modifywindow=60 \ linkdest=../backup.1 $SOURCE_DIR $BACKUP_DEST_DIR/backup.0/ # #+ # # # #+ Only warn, rather than exit if the rsync since it may only be a minor problem. E.g., if one file is not readable, rsync This shouldn't prevent the rotation. Not using, e.g., `date +%a` since these are just full of links and don't consume failed, will fail. directories *that much* space.

if [ $? != 0 ]; then BACKUP_JUSTINCASE=backup.`date +%F_%T`.justincase echo "WARNING: the rsync process did not entirely succeed." echo "Something might be wrong. Saving an extra copy at: $BACKUP_JUSTINCASE" echo "WARNING: if this occurs regularly, a LOT of space will be consumed," echo "even though these are just hardlinks!" fi # Save a readme in the backup parent directory. # Save another one in the recent subdirectory. echo "Backup of $SOURCE_DIR on `hostname` was last run on \ `date`" > $BACKUP_DEST_DIR/README.txt echo "This backup of $SOURCE_DIR on `hostname` was created on \ `date`" > $BACKUP_DEST_DIR/backup.0/README.txt # If we are not in a dry run, rotate the backups. [ z "$DRY_RUN" ] && # Check how full the backup disk is. # Warn if 90%. if 98% or more, we'll probably fail, so give up. # (Note: df can output to more than one line.) # We test this here, rather than before #+ so that rsync may possibly have a chance. DISK_FULL_PERCENT=`/bin/df $BACKUP_DEST_DIR | tr "\n" ' ' | awk '{print $12}' | grep oE [09]+ ` echo "Disk space check on backup partition \ $MOUNT_POINT $DISK_FULL_PERCENT% full." if [ $DISK_FULL_PERCENT gt 90 ]; then echo "Warning: Disk is greater than 90% full." fi if [ $DISK_FULL_PERCENT gt 98 ]; then

Appendix A. Contributed Scripts

593

Advanced BashScripting Guide

echo "Error: Disk is full! Giving up." if [ "$UNMOUNT_LATER" == "TRUE" ]; then # Before we exit, unmount the mount point if necessary. cd; sudo umount $MOUNT_POINT && echo "Unmounted $MOUNT_POINT again. Giving up." fi exit $E_UNMOUNTED fi

# Create an extra backup. # If this copy fails, give up. if [ n "$BACKUP_JUSTINCASE" ]; then if ! /bin/cp al $BACKUP_DEST_DIR/backup.0 $BACKUP_DEST_DIR/$BACKUP_JUSTINCASE then echo "ERROR: Failed to create extra copy \ $BACKUP_DEST_DIR/$BACKUP_JUSTINCASE" if [ "$UNMOUNT_LATER" == "TRUE" ]; then # Before we exit, unmount the mount point if necessary. cd ;sudo umount $MOUNT_POINT && echo "Unmounted $MOUNT_POINT again. Giving up." fi exit $E_UNMOUNTED fi fi

# At start of month, rotate the oldest 8. if [ "$MONTHSTART" == "true" ]; then echo e "\nStart of month. \ Removing oldest backup: $BACKUP_DEST_DIR/backup.15" && /bin/rm rf $BACKUP_DEST_DIR/backup.15 && echo "Rotating monthly,weekly backups: \ $BACKUP_DEST_DIR/backup.[814] > $BACKUP_DEST_DIR/backup.[915]" && /bin/mv $BACKUP_DEST_DIR/backup.14 $BACKUP_DEST_DIR/backup.15 && /bin/mv $BACKUP_DEST_DIR/backup.13 $BACKUP_DEST_DIR/backup.14 && /bin/mv $BACKUP_DEST_DIR/backup.12 $BACKUP_DEST_DIR/backup.13 && /bin/mv $BACKUP_DEST_DIR/backup.11 $BACKUP_DEST_DIR/backup.12 && /bin/mv $BACKUP_DEST_DIR/backup.10 $BACKUP_DEST_DIR/backup.11 && /bin/mv $BACKUP_DEST_DIR/backup.9 $BACKUP_DEST_DIR/backup.10 && /bin/mv $BACKUP_DEST_DIR/backup.8 $BACKUP_DEST_DIR/backup.9 # At start of week, rotate the secondoldest 4. elif [ "$WEEKSTART" == "true" ]; then echo e "\nStart of week. \ Removing oldest weekly backup: $BACKUP_DEST_DIR/backup.12" /bin/rm rf $BACKUP_DEST_DIR/backup.12 &&

&&

echo "Rotating weekly backups: \ $BACKUP_DEST_DIR/backup.[811] > $BACKUP_DEST_DIR/backup.[912]" && /bin/mv $BACKUP_DEST_DIR/backup.11 $BACKUP_DEST_DIR/backup.12 && /bin/mv $BACKUP_DEST_DIR/backup.10 $BACKUP_DEST_DIR/backup.11 && /bin/mv $BACKUP_DEST_DIR/backup.9 $BACKUP_DEST_DIR/backup.10 && /bin/mv $BACKUP_DEST_DIR/backup.8 $BACKUP_DEST_DIR/backup.9 else echo e "\nRemoving oldest daily backup: $BACKUP_DEST_DIR/backup.8" /bin/rm rf $BACKUP_DEST_DIR/backup.8 fi &&

&&

# Every day, rotate the newest 8.

Appendix A. Contributed Scripts

594

Advanced BashScripting Guide

echo "Rotating daily backups: \ $BACKUP_DEST_DIR/backup.[17] > $BACKUP_DEST_DIR/backup.[28]" /bin/mv $BACKUP_DEST_DIR/backup.7 $BACKUP_DEST_DIR/backup.8 /bin/mv $BACKUP_DEST_DIR/backup.6 $BACKUP_DEST_DIR/backup.7 /bin/mv $BACKUP_DEST_DIR/backup.5 $BACKUP_DEST_DIR/backup.6 /bin/mv $BACKUP_DEST_DIR/backup.4 $BACKUP_DEST_DIR/backup.5 /bin/mv $BACKUP_DEST_DIR/backup.3 $BACKUP_DEST_DIR/backup.4 /bin/mv $BACKUP_DEST_DIR/backup.2 $BACKUP_DEST_DIR/backup.3 /bin/mv $BACKUP_DEST_DIR/backup.1 $BACKUP_DEST_DIR/backup.2 /bin/mv $BACKUP_DEST_DIR/backup.0 $BACKUP_DEST_DIR/backup.1 SUCCESS=true && && && && && && && && &&

if

[ "$UNMOUNT_LATER" == "TRUE" ]; then # Unmount the mount point if it wasn't mounted to begin with. cd ; sudo umount $MOUNT_POINT && echo "Unmounted $MOUNT_POINT again."

fi

if [ "$SUCCESS" == "true" ]; then echo 'SUCCESS!' exit 0 fi # Should have already exited if backup worked. echo 'BACKUP FAILED! Is this just a dry run? Is the disk full?) ' exit $E_BACKUP

Example A33. An expanded cd command

########################################################################### # # cdll # by Phil Braham # # ############################################ # Latest version of this script available from # http://freshmeat.net/projects/cd/ # ############################################ # # .cd_new # # An enhancement of the Unix cd command # # There are unlimited stack entries and special entries. The stack # entries keep the last cd_maxhistory # directories that have been used. The special entries can be # assigned to commonly used directories. # # The special entries may be preassigned by setting the environment # variables CDSn or by using the u or U command. # # The following is a suggestion for the .profile file: # # . cdll # Set up the cd command # alias cd='cd_new' # Replace the cd command # cd U # Upload preassigned entries for # #+ the stack and special entries # cd D # Set nondefault mode # alias @="cd_new @" # Allow @ to be used to get history

Appendix A. Contributed Scripts

595

Advanced BashScripting Guide

# # For help type: # # cd h or # cd H # # ########################################################################### # # Version 1.2.1 # # Written by Phil Braham Realtime Software Pty Ltd # ([email protected]) # Please send any suggestions or enhancements to the author (also at # [email protected]) # ############################################################################ cd_hm () { ${PRINTF} "%s" "cd [dir] [09] [@[s|h] [g [<dir>]] [d] \ [D] [r<n>] [dir|09] [R<n>] [<dir>|09] [s<n>] [S<n>] [u] [U] [f] [F] [h] [H] [v] <dir> Go to directory 0n Go to previous directory (0 is previous, 1 is last but 1 etc) n is up to max history (default is 50) @ List history and special entries @h List history entries @s List special entries g [<dir>] Go to literal name (bypass special names) This is to allow access to dirs called '0','1','h' etc d Change default action verbose. (See note) D Change default action silent. (See note) s<n> Go to the special entry <n>* S<n> Go to the special entry <n> and replace it with the current dir* r<n> [<dir>] Go to directory <dir> and then put it on special entry <n>* R<n> [<dir>] Go to directory <dir> and put current dir on special entry <n>* a<n> Alternative suggested directory. See note below. f [<file>] File entries to <file>. u [<file>] Update entries from <file>. If no filename supplied then default file (${CDPath}${2:"$CDFile"}) is used F and U are silent versions v Print version number h Help H Detailed help *The special entries (0 9) are held until log off, replaced by another entry or updated with the u command Alternative suggested directories: If a directory is not found then CD will suggest any possibilities. These are directories starting with the same letters and if any are found they are listed prefixed with a<n> where <n> is a number. It's possible to go to the directory by entering cd a<n> on the command line. The directory for r<n> or R<n> may be a number.

Appendix A. Contributed Scripts

596

Advanced BashScripting Guide

For example: $ cd r3 4 $ cd R3 4 $ cd s3 Go to history entry 4 and put it on special entry 3 Put current dir on the special entry 3 and go to history entry 4 Go to special entry 3 used without a number

Note that commands R,r,S and s may be and refer to 0: $ cd s Go to special entry 0 $ cd S Go to special entry 0 entry 0 current dir $ cd r 1 Go to history entry 1 $ cd r Go to history entry 0 " if ${TEST} "$CD_MODE" = "PREV" then ${PRINTF} "$cd_mnset" else ${PRINTF} "$cd_mset" fi }

and make special and put it on special entry 0 and put it on special entry 0

cd_Hm () { cd_hm ${PRINTF} "%s" " The previous directories (0$cd_maxhistory) are stored in the environment variables CD[0] CD[$cd_maxhistory] Similarly the special directories S0 $cd_maxspecial are in the environment variable CDS[0] CDS[$cd_maxspecial] and may be accessed from the command line The default pathname for the f and u commands is $CDPath The default filename for the f and u commands is $CDFile Set the following environment variables: CDL_PROMPTLEN Set to the length of prompt you require. Prompt string is set to the right characters of the current directory. If not set then prompt is left unchanged CDL_PROMPT_PRE Set to the string to prefix the prompt. Default is: nonroot: \"\\[\\e[01;34m\\]\" (sets colour to blue). root: \"\\[\\e[01;31m\\]\" (sets colour to red). CDL_PROMPT_POST Set to the string to suffix the prompt. Default is: nonroot: \"\\[\\e[00m\\]$\" (resets colour and displays $). root: \"\\[\\e[00m\\]#\" (resets colour and displays #). CDPath Set the default path for the f & u options. Default is home directory CDFile Set the default filename for the f & u options. Default is cdfile " cd_version } cd_version () {

Appendix A. Contributed Scripts

597

Advanced BashScripting Guide

printf "Version: ${VERSION_MAJOR}.${VERSION_MINOR} Date: ${VERSION_DATE}\n" } # # Truncate right. # # params: # p1 string # p2 length to truncate to # # returns string in tcd # cd_right_trunc () { local tlen=${2} local plen=${#1} local str="${1}" local diff local filler="<" if ${TEST} ${plen} le ${tlen} then tcd="${str}" else let diff=${plen}${tlen} elen=3 if ${TEST} ${diff} le 2 then let elen=${diff} fi tlen=${tlen} let tlen=${tlen}+${elen} tcd=${filler:0:elen}${str:tlen} fi } # # Three versions of do history: # cd_dohistory packs history and specials side by side # cd_dohistoryH Shows only hstory # cd_dohistoryS Shows only specials # cd_dohistory () { cd_getrc ${PRINTF} "History:\n" local i count=${cd_histcount} while ${TEST} ${count} ge 0 do cd_right_trunc "${CD[count]}" ${cd_lchar} ${PRINTF} "%2d %${cd_lchar}.${cd_lchar}s " ${count} "${tcd}" cd_right_trunc "${CDS[count]}" ${cd_rchar} ${PRINTF} "S%d %${cd_rchar}.${cd_rchar}s\n" ${count} "${tcd}" count=${count}1 done } cd_dohistoryH () { cd_getrc ${PRINTF} "History:\n" local i count=${cd_maxhistory}

Appendix A. Contributed Scripts

598

Advanced BashScripting Guide

while ${TEST} ${count} ge 0 do ${PRINTF} "${count} %${cd_flchar}.${cd_flchar}s\n" ${CD[$count]} count=${count}1 done } cd_dohistoryS () { cd_getrc ${PRINTF} "Specials:\n" local i count=${cd_maxspecial} while ${TEST} ${count} ge 0 do ${PRINTF} "S${count} %${cd_flchar}.${cd_flchar}s\n" ${CDS[$count]} count=${count}1 done } cd_getrc () { cd_flchar=$(stty a | awk F \; '/rows/ { print $2 $3 }' | awk F \ '{ print $4 }') if ${TEST} ${cd_flchar} ne 0 then cd_lchar=${cd_flchar}/25 cd_rchar=${cd_flchar}/25 cd_flchar=${cd_flchar}5 else cd_flchar=${FLCHAR:=75} # cd_flchar is used for for the @s & @h history cd_lchar=${LCHAR:=35} cd_rchar=${RCHAR:=35} fi } cd_doselection () { local i nm=0 cd_doflag="TRUE" if ${TEST} "${CD_MODE}" = "PREV" then if ${TEST} z "$cd_npwd" then cd_npwd=0 fi fi tm=$(echo "${cd_npwd}" | cut b 1) if ${TEST} "${tm}" = "" then pm=$(echo "${cd_npwd}" | cut b 2) nm=$(echo "${cd_npwd}" | cut d $pm f2) case "${pm}" in a) cd_npwd=${cd_sugg[$nm]} ;; s) cd_npwd="${CDS[$nm]}" ;; S) cd_npwd="${CDS[$nm]}" ; CDS[$nm]=`pwd` ;; r) cd_npwd="$2" ; cd_specDir=$nm ; cd_doselection "$1" "$2";; R) cd_npwd="$2" ; CDS[$nm]=`pwd` ; cd_doselection "$1" "$2";; esac fi if ${TEST} "${cd_npwd}" != "." a "${cd_npwd}" \

Appendix A. Contributed Scripts

599

Advanced BashScripting Guide

!= ".." a "${cd_npwd}" le ${cd_maxhistory} >>/dev/null 2>&1 then cd_npwd=${CD[$cd_npwd]} else case "$cd_npwd" in @) cd_dohistory ; cd_doflag="FALSE" ;; @h) cd_dohistoryH ; cd_doflag="FALSE" ;; @s) cd_dohistoryS ; cd_doflag="FALSE" ;; h) cd_hm ; cd_doflag="FALSE" ;; H) cd_Hm ; cd_doflag="FALSE" ;; f) cd_fsave "SHOW" $2 ; cd_doflag="FALSE" ;; u) cd_upload "SHOW" $2 ; cd_doflag="FALSE" ;; F) cd_fsave "NOSHOW" $2 ; cd_doflag="FALSE" ;; U) cd_upload "NOSHOW" $2 ; cd_doflag="FALSE" ;; g) cd_npwd="$2" ;; d) cd_chdefm 1; cd_doflag="FALSE" ;; D) cd_chdefm 0; cd_doflag="FALSE" ;; r) cd_npwd="$2" ; cd_specDir=0 ; cd_doselection "$1" "$2";; R) cd_npwd="$2" ; CDS[0]=`pwd` ; cd_doselection "$1" "$2";; s) cd_npwd="${CDS[0]}" ;; S) cd_npwd="${CDS[0]}" ; CDS[0]=`pwd` ;; v) cd_version ; cd_doflag="FALSE";; esac fi } cd_chdefm () { if ${TEST} "${CD_MODE}" = then CD_MODE="" if ${TEST} $1 eq then ${PRINTF} fi else CD_MODE="PREV" if ${TEST} $1 eq then ${PRINTF} fi fi }

"PREV"

1 "${cd_mset}"

1 "${cd_mnset}"

cd_fsave () { local sfile=${CDPath}${2:"$CDFile"} if ${TEST} "$1" = "SHOW" then ${PRINTF} "Saved to %s\n" $sfile fi ${RM} f ${sfile} local i count=0 while ${TEST} ${count} le ${cd_maxhistory} do echo "CD[$count]=\"${CD[$count]}\"" >> ${sfile} count=${count}+1 done count=0 while ${TEST} ${count} le ${cd_maxspecial} do echo "CDS[$count]=\"${CDS[$count]}\"" >> ${sfile}

Appendix A. Contributed Scripts

600

Advanced BashScripting Guide

count=${count}+1 done } cd_upload () { local sfile=${CDPath}${2:"$CDFile"} if ${TEST} "${1}" = "SHOW" then ${PRINTF} "Loading from %s\n" ${sfile} fi . ${sfile} } cd_new () { local i count local i choose=0 cd_npwd="${1}" cd_specDir=1 cd_doselection "${1}" "${2}" if ${TEST} ${cd_doflag} = "TRUE" then if ${TEST} "${CD[0]}" != "`pwd`" then count=$cd_maxhistory while ${TEST} $count gt 0 do CD[$count]=${CD[$count1]} count=${count}1 done CD[0]=`pwd` fi command cd "${cd_npwd}" 2>/dev/null if ${TEST} $? eq 1 then ${PRINTF} "Unknown dir: %s\n" "${cd_npwd}" local i ftflag=0 for i in "${cd_npwd}"* do if ${TEST} d "${i}" then if ${TEST} ${ftflag} eq 0 then ${PRINTF} "Suggest:\n" ftflag=1 fi ${PRINTF} "\ta${choose} %s\n" "$i" cd_sugg[$choose]="${i}" choose=${choose}+1 fi done fi fi if ${TEST} ${cd_specDir} ne 1 then CDS[${cd_specDir}]=`pwd` fi

Appendix A. Contributed Scripts

601

Advanced BashScripting Guide

if ${TEST} ! z "${CDL_PROMPTLEN}" then cd_right_trunc "${PWD}" ${CDL_PROMPTLEN} cd_rp=${CDL_PROMPT_PRE}${tcd}${CDL_PROMPT_POST} export PS1="$(echo ne ${cd_rp})" fi } ######################################################################### # # # Initialisation here # # # ######################################################################### # VERSION_MAJOR="1" VERSION_MINOR="2.1" VERSION_DATE="24MAY2003" # alias cd=cd_new # # Set up commands RM=/bin/rm TEST=test PRINTF=printf # Use builtin printf ######################################################################### # # # Change this to modify the default pre and post prompt strings. # # These only come into effect if CDL_PROMPTLEN is set. # # # ######################################################################### if ${TEST} ${EUID} eq 0 then # CDL_PROMPT_PRE=${CDL_PROMPT_PRE:="$HOSTNAME@"} CDL_PROMPT_PRE=${CDL_PROMPT_PRE:="\\[\\e[01;31m\\]"} # Root is in red CDL_PROMPT_POST=${CDL_PROMPT_POST:="\\[\\e[00m\\]#"} else CDL_PROMPT_PRE=${CDL_PROMPT_PRE:="\\[\\e[01;34m\\]"} # Users in blue CDL_PROMPT_POST=${CDL_PROMPT_POST:="\\[\\e[00m\\]$"} fi ######################################################################### # # cd_maxhistory defines the max number of history entries allowed. typeset i cd_maxhistory=50 ######################################################################### # # cd_maxspecial defines the number of special entries. typeset i cd_maxspecial=9 # # ######################################################################### # # cd_histcount defines the number of entries displayed in #+ the history command. typeset i cd_histcount=9 # ######################################################################### export CDPath=${HOME}/ # Change these to use a different # #+ default path and filename # export CDFile=${CDFILE:=cdfile} # for the u and f commands # #

Appendix A. Contributed Scripts

602

Advanced BashScripting Guide

######################################################################### # typeset i cd_lchar cd_rchar cd_flchar # This is the number of chars to allow for the # cd_flchar=${FLCHAR:=75} #+ cd_flchar is used for for the @s & @h history# typeset ax CD CDS # cd_mset="\n\tDefault mode is now set entering cd with no parameters \ has the default action\n\tUse cd d or D for cd to go to \ previous directory with no parameters\n" cd_mnset="\n\tNondefault mode is now set entering cd with no \ parameters is the same as entering cd 0\n\tUse cd d or \ D to change default cd action\n" # ==================================================================== #

: <<DOCUMENTATION Written by Phil Braham. Realtime Software Pty Ltd. Released under GNU license. Free to use. Please pass any modifications or comments to the author Phil Braham: [email protected] ======================================================================= cdll is a replacement for cd and incorporates similar functionality to the bash pushd and popd commands but is independent of them. This version of cdll has been tested on Linux using Bash. It will work on most Linux versions but will probably not work on other shells without modification. Introduction ============ cdll allows easy moving about between directories. When changing to a new directory the current one is automatically put onto a stack. By default 50 entries are kept, but this is configurable. Special directories can be kept for easy access by default up to 10, but this is configurable. The most recent stack entries and the special entries can be easily viewed. The directory stack and special entries can be saved to, and loaded from, a file. This allows them to be set up on login, saved before logging out or changed when moving project to project. In addition, cdll provides a flexible command prompt facility that allows, for example, a directory name in colour that is truncated from the left if it gets too long.

Setting up cdll =============== Copy cdll to either your local home directory or a central directory such as /usr/bin (this will require root access). Copy the file cdfile to your home directory. It will require read and write access. This a default file that contains a directory stack and special entries.

Appendix A. Contributed Scripts

603

Advanced BashScripting Guide

To replace the cd command you must add commands to your login script. The login script is one or more of: /etc/profile ~/.bash_profile ~/.bash_login ~/.profile ~/.bashrc /etc/bash.bashrc.local To setup your login, ~/.bashrc is recommended, for global (and root) setup add the commands to /etc/bash.bashrc.local To set up on login, add the command: . <dir>/cdll For example if cdll is in your local home directory: . ~/cdll If in /usr/bin then: . /usr/bin/cdll If you want to use this instead of the buitin cd command then add: alias cd='cd_new' We would also recommend the following commands: alias @='cd_new @' cd U cd D If you want to use cdll's prompt facilty then add the following: CDL_PROMPTLEN=nn Where nn is a number described below. Initially 99 would be suitable number. Thus the script looks something like this: ###################################################################### # CD Setup ###################################################################### CDL_PROMPTLEN=21 # Allow a prompt length of up to 21 characters . /usr/bin/cdll # Initialise cdll alias cd='cd_new' # Replace the built in cd command alias @='cd_new @' # Allow @ at the prompt to display history cd U # Upload directories cd D # Set default action to nonposix ###################################################################### The full meaning of these commands will become clear later. There are a couple of caveats. If another program changes the directory without calling cdll, then the directory won't be put on the stack and also if the prompt facility is used then this will not be updated. Two programs that can do this are pushd and popd. To update the prompt and stack simply enter: cd . Note that if the previous entry on the stack is the current directory then the stack is not updated. Usage ===== cd [dir] [09] [@[s|h] [g <dir>] [d] [D] [r<n>]

Appendix A. Contributed Scripts

604

Advanced BashScripting Guide

[dir|09] [R<n>] [<dir>|09] [s<n>] [S<n>] [u] [U] [f] [F] [h] [H] [v] <dir> 0n Go to directory Goto previous directory (0 is previous, 1 is last but 1, etc.) n is up to max history (default is 50) @ List history and special entries (Usually available as $ @) @h List history entries @s List special entries g [<dir>] Go to literal name (bypass special names) This is to allow access to dirs called '0','1','h' etc d Change default action verbose. (See note) D Change default action silent. (See note) s<n> Go to the special entry <n> S<n> Go to the special entry <n> and replace it with the current dir r<n> [<dir>] Go to directory <dir> and then put it on special entry <n> R<n> [<dir>] Go to directory <dir> and put current dir on special entry <n> a<n> Alternative suggested directory. See note below. f [<file>] File entries to <file>. u [<file>] Update entries from <file>. If no filename supplied then default file (~/cdfile) is used F and U are silent versions v Print version number h Help H Detailed help

Examples ======== These examples assume nondefault mode is set (that is, cd with no parameters will go to the most recent stack directory), that aliases have been set up for cd and @ as described above and that cd's prompt facility is active and the prompt length is 21 characters. /home/phil$ @ # List the entries with the @ History: # Output of the @ command ..... # Skipped these entries for brevity 1 /home/phil/ummdev S1 /home/phil/perl # Most recent two history entries 0 /home/phil/perl/eg S0 /home/phil/umm/ummdev # and two special entries are shown /home/phil$ cd /home/phil/utils/Cdll # Now change directories /home/phil/utils/Cdll$ @ # Prompt reflects the directory. History: # New history ..... 1 /home/phil/perl/eg S1 /home/phil/perl # History entry 0 has moved to 1 0 /home/phil S0 /home/phil/umm/ummdev # and the most recent has entered

Appendix A. Contributed Scripts

605

Advanced BashScripting Guide

To go to a history entry: /home/phil/utils/Cdll$ cd 1 # Go to history entry 1. /home/phil/perl/eg$ # Current directory is now what was 1 To go to a special entry: /home/phil/perl/eg$ cd s1 # Go to special entry 1 /home/phil/umm/ummdev$ # Current directory is S1 To go to a directory called, for example, 1: /home/phil$ cd g 1 # g ignores the special meaning of 1 /home/phil/1$ To put current directory on the special list as S1: cd r1 . # OR cd R1 . # These have the same effect if the directory is #+ . (the current directory) To go to a directory and add it as a special The directory for r<n> or R<n> may be a number. For example: $ cd r3 4 Go to history entry 4 and put it on special entry 3 $ cd R3 4 Put current dir on the special entry 3 and go to history entry 4 $ cd s3 Go to special entry 3 Note that commands R,r,S and s may be refer to 0: $ cd s Go to special entry 0 $ cd S Go to special entry 0 current dir $ cd r 1 Go to history entry 1 $ cd r Go to history entry 0 used without a number and

and make special entry 0 and put it on special entry 0 and put it on special entry 0

Alternative suggested directories: If a directory possibilities. and if any are where <n> is a by entering cd is not found, then CD will suggest any These are directories starting with the same letters found they are listed prefixed with a<n> number. It's possible to go to the directory a<n> on the command line.

Use cd d or D to change default cd action. cd H will show current action. The history entries (0n) are stored in the environment variables CD[0] CD[n] Similarly the special directories S0 9 are in the environment variable CDS[0] CDS[9] and may be accessed from the command line, for example: ls l ${CDS[3]} cat ${CD[8]}/file.txt

Appendix A. Contributed Scripts

606

Advanced BashScripting Guide

The default pathname for the f and u commands is ~ The default filename for the f and u commands is cdfile

Configuration ============= The following environment variables can be set: CDL_PROMPTLEN Set to the length of prompt you require. Prompt string is set to the right characters of the current directory. If not set, then prompt is left unchanged. Note that this is the number of characters that the directory is shortened to, not the total characters in the prompt. CDL_PROMPT_PRE Set to the string to prefix the prompt. Default is: nonroot: "\\[\\e[01;34m\\]" (sets colour to blue). root: "\\[\\e[01;31m\\]" (sets colour to red). CDL_PROMPT_POST Default is: nonroot: root: Set to the string to suffix the prompt. "\\[\\e[00m\\]$" (resets colour and displays $). "\\[\\e[00m\\]#" (resets colour and displays #).

Note: CDL_PROMPT_PRE & _POST only t CDPath Set the Default CDFile Set the Default default path for the f & u options. is home directory default filename for the f & u options. is cdfile

There are three variables defined in the file cdll which control the number of entries stored or displayed. They are in the section labeled 'Initialisation here' towards the end of the file. cd_maxhistory cd_maxspecial cd_histcount The number Default is The number Default is The number displayed. of history 50. of special 9. of history Default is entries stored. entries allowed. and special entries 9.

Note that cd_maxspecial should be >= cd_histcount to avoid displaying special entries that can't be set.

Version: 1.2.1 Date: 24MAY2003 DOCUMENTATION

To end this section, a review of the basics . . . and more.

Example A34. Basics Reviewed

Appendix A. Contributed Scripts

607

Advanced BashScripting Guide

#!/bin/bash # basicsreviewed.bash # File extension == *.bash == specific to Bash # # # # # # Copyright (c) Michael S. Zick, 2003; All rights reserved. License: Use in any form, for any purpose. Revision: $ID$ Edited for layout by M.C. (author of the "Advanced Bash Scripting Guide")

# # # #+

This script tested under Bash versions 2.04, 2.05a and 2.05b. It may not work with earlier versions. This demonstration script generates one intentional "command not found" error message. See line 394.

# The current Bash maintainer, Chet Ramey, has fixed the items noted #+ for an upcoming version of Bash.

###### ### Pipe the output of this script to 'more' ### ###+ else it will scroll off the page. ### ### ### ### You may also redirect its output ### ###+ to a file for examination. ### ######

# Most of the following points are described at length in #+ the text of the foregoing "Advanced Bash Scripting Guide." # This demonstration script is mostly just a reorganized presentation. # msz # Variables are not typed unless otherwise specified. # Variables are named. Names must contain a nondigit. # File descriptor names (as in, for example: 2>&1) #+ contain ONLY digits. # Parameters and Bash array elements are numbered. # (Parameters are very similar to Bash arrays.) # A variable name may be undefined (null reference). unset VarNull # A variable name may be defined but empty (null contents). VarEmpty='' # Two, adjacent, single quotes. # A variable name my be defined and nonempty VarSomething='Literal' # A variable may contain: # * A whole number as a signed 32bit (or larger) integer # * A string # A variable may also be an array. # A string may contain embedded blanks and may be treated

Appendix A. Contributed Scripts

608

Advanced BashScripting Guide

#+ as if it where a function name with optional arguments. # The names of variables and the names of functions #+ are in different namespaces.

# A variable may be defined as a Bash array either explicitly or #+ implicitly by the syntax of the assignment statement. # Explicit: declare a ArrayVar

# The echo command is a builtin. echo $VarSomething # The printf command is a builtin. # Translate %s as: StringFormat printf %s $VarSomething # No linebreak specified, none output. echo # Default, only linebreak output.

# The Bash parser word breaks on whitespace. # Whitespace, or the lack of it is significant. # (This holds true in general; there are, of course, exceptions.)

# Translate the DOLLAR_SIGN character as: ContentOf. # ExtendedSyntax way of writing ContentOf: echo ${VarSomething} # The ${ ... } ExtendedSyntax allows more than just the variable #+ name to be specified. # In general, $VarSomething can always be written as: ${VarSomething}. # Call this script with arguments to see the following in action.

# Outside of doublequotes, the special characters @ and * #+ specify identical behavior. # May be pronounced as: AllElementsOf. # Without specification of a name, they refer to the #+ predefined parameter BashArray.

# GlobPattern references echo $* echo ${*}

# All parameters to script or function # Same

# Bash disables filename expansion for GlobPatterns. # Only character matching is active.

# AllElementsOf references

Appendix A. Contributed Scripts

609

Advanced BashScripting Guide

echo $@ echo ${@} # Same as above # Same as above

# Within doublequotes, the behavior of GlobPattern references #+ depends on the setting of IFS (Input Field Separator). # Within doublequotes, AllElementsOf references behave the same.

# Specifying only the name of a variable holding a string refers #+ to all elements (characters) of a string.

# To specify an element (character) of a string, #+ the ExtendedSyntax reference notation (see below) MAY be used.

# Specifying only the name of a Bash array references #+ the subscript zero element, #+ NOT the FIRST DEFINED nor the FIRST WITH CONTENTS element. # Additional qualification is needed to reference other elements, #+ which means that the reference MUST be written in ExtendedSyntax. # The general form is: ${name[subscript]}. # The string forms may also be used: ${name:subscript} #+ for BashArrays when referencing the subscript zero element.

# BashArrays are implemented internally as linked lists, #+ not as a fixed area of storage as in some programming languages.

# # # #+ # ### # #+ ### # ### # ### # # ### # ### # # # # # ###

Characteristics of Bash arrays (BashArrays): If not otherwise specified, BashArray subscripts begin with subscript number zero. Literally: [0] This is called zerobased indexing. If not otherwise specified, BashArrays are subscript packed (sequential subscripts without subscript gaps). Negative subscripts are not allowed. Elements of a BashArray need not all be of the same type. Elements of a BashArray may be undefined (null reference). That is, a BashArray my be "subscript sparse." Elements of a BashArray may be defined and empty (null contents). Elements of a BashArray may contain: * A whole number as a signed 32bit (or larger) integer * A string * A string formated so that it appears to be a function name + with optional arguments

Appendix A. Contributed Scripts

610

Advanced BashScripting Guide

# Defined elements of a BashArray may be undefined (unset). # That is, a subscript packed BashArray may be changed # + into a subscript sparse BashArray. ### # Elements may be added to a BashArray by defining an element #+ not previously defined. ### # For these reasons, I have been calling them "BashArrays". # I'll return to the generic term "array" from now on. # msz

# Demo time initialize the previously declared ArrayVar as a #+ sparse array. # (The 'unset ... ' is just documentation here.) unset ArrayVar[0] ArrayVar[1]=one ArrayVar[2]='' unset ArrayVar[3] ArrayVar[4]='four' # # # # # Just for the record Unquoted literal Defined, and empty Just for the record Quoted literal

# Translate the %q format as: QuotedRespectingIFSRules. echo echo ' Outside of doublequotes ' ### printf %q ${ArrayVar[*]} # GlobPattern AllElementsOf echo echo 'echo command:'${ArrayVar[*]} ### printf %q ${ArrayVar[@]} # AllElementsOf echo echo 'echo command:'${ArrayVar[@]} # The use of doublequotes may be translated as: EnableSubstitution. # There are five cases recognized for the IFS setting. echo echo ' Within doublequotes Default IFS of spacetabnewline ' IFS=$'\x20'$'\x09'$'\x0A' # These three bytes, #+ in exactly this order.

printf %q "${ArrayVar[*]}" # GlobPattern AllElementsOf echo echo 'echo command:'"${ArrayVar[*]}" ### printf %q "${ArrayVar[@]}" # AllElementsOf echo echo 'echo command:'"${ArrayVar[@]}"

echo echo ' Within doublequotes First character of IFS is ^ ' # Any printing, nonwhitespace character should do the same. IFS='^'$IFS # ^ + space tab newline ###

Appendix A. Contributed Scripts

611

Advanced BashScripting Guide

printf %q "${ArrayVar[*]}" # GlobPattern AllElementsOf echo echo 'echo command:'"${ArrayVar[*]}" ### printf %q "${ArrayVar[@]}" # AllElementsOf echo echo 'echo command:'"${ArrayVar[@]}"

echo echo ' Within doublequotes Without whitespace in IFS ' IFS='^:%!' ### printf %q "${ArrayVar[*]}" # GlobPattern AllElementsOf echo echo 'echo command:'"${ArrayVar[*]}" ### printf %q "${ArrayVar[@]}" # AllElementsOf echo echo 'echo command:'"${ArrayVar[@]}"

echo echo ' Within doublequotes IFS set and empty ' IFS='' ### printf %q "${ArrayVar[*]}" # GlobPattern AllElementsOf echo echo 'echo command:'"${ArrayVar[*]}" ### printf %q "${ArrayVar[@]}" # AllElementsOf echo echo 'echo command:'"${ArrayVar[@]}"

echo echo ' Within doublequotes IFS undefined ' unset IFS ### printf %q "${ArrayVar[*]}" # GlobPattern AllElementsOf echo echo 'echo command:'"${ArrayVar[*]}" ### printf %q "${ArrayVar[@]}" # AllElementsOf echo echo 'echo command:'"${ArrayVar[@]}"

# Put IFS back to the default. # Default is exactly these three bytes. IFS=$'\x20'$'\x09'$'\x0A' # In exactly this order. # Interpretation of the above outputs: # A GlobPattern is I/O; the setting of IFS matters. ### # An AllElementsOf does not consider IFS settings. ### # Note the different output using the echo command and the #+ quoted format operator of the printf command.

Recall:

Appendix A. Contributed Scripts

612

Advanced BashScripting Guide

# Parameters are similar to arrays and have the similar behaviors. ### # The above examples demonstrate the possible variations. # To retain the shape of a sparse array, additional script #+ programming is required. ### # The source code of Bash has a routine to output the #+ [subscript]=value array assignment format. # As of version 2.05b, that routine is not used, #+ but that might change in future releases.

# The length of a string, measured in nonnull elements (characters): echo echo ' Nonquoted references ' echo 'NonNull character count: '${#VarSomething}' characters.' # test='Lit'$'\x00''eral' # echo ${#test} # $'\x00' is a null character. # See that?

# The length of an array, measured in defined elements, #+ including null content elements. echo echo 'Defined content count: '${#ArrayVar[@]}' elements.' # That is NOT the maximum subscript (4). # That is NOT the range of the subscripts (1 . . 4 inclusive). # It IS the length of the linked list. ### # Both the maximum subscript and the range of the subscripts may #+ be found with additional script programming. # The length of a string, measured in nonnull elements (characters): echo echo ' Quoted, GlobPattern references ' echo 'NonNull character count: '"${#VarSomething}"' characters.' # The length of an array, measured in defined elements, #+ including nullcontent elements. echo echo 'Defined element count: '"${#ArrayVar[*]}"' elements.' # # # #+ Interpretation: Substitution does not effect the ${# ... } operation. Suggestion: Always use the AllElementsOf character if that is what is intended (independence from IFS).

# Define a simple function. # I include an underscore in the name #+ to make it distinctive in the examples below. ### # Bash separates variable names and function names #+ in different namespaces. # The MarkOne eyeball isn't that advanced. ### _simple() { echo n 'SimpleFunc'$@ # Newlines are swallowed in } #+ result returned in any case.

Appendix A. Contributed Scripts

613

Advanced BashScripting Guide

# The ( ... ) notation invokes a command or function. # The $( ... ) notation is pronounced: ResultOf.

# Invoke the function _simple echo echo ' Output of function _simple ' _simple # Try passing arguments. echo # or (_simple) # Try passing arguments. echo echo ' Is there a variable of that name? ' echo $_simple not defined # No variable by that name. # Invoke the result of function _simple (Error msg intended) ### $(_simple) # # echo ### # The first word of the result of function _simple #+ is neither a valid Bash command nor the name of a defined function. ### # This demonstrates that the output of _simple is subject to evaluation. ### # Interpretation: # A function can be used to generate inline Bash commands.

# Gives an error message: line 394: SimpleFunc: command not found

# A simple function where the first word of result IS a bash command: ### _print() { echo n 'printf %q '$@ } echo ' Outputs of function _print ' _print parm1 parm2 # An Output NOT A Command. echo $(_print parm1 parm2) # Executes: printf %q parm1 parm2 # See above IFS examples for the #+ various possibilities.

echo $(_print $VarSomething) echo # The predictable result.

# Function variables # echo echo ' Function variables '

Appendix A. Contributed Scripts

614

Advanced BashScripting Guide

# A variable may represent a signed integer, a string or an array. # A string may be used like a function name with optional arguments. # set vx declare f funcVar funcVar=_print $funcVar parm1 echo funcVar=$(_print ) $funcVar $funcVar $VarSomething echo funcVar=$(_print $VarSomething) $funcVar echo funcVar="$(_print $VarSomething)" $funcVar echo # #+ # # # Enable if desired #+ in namespace of functions # Contains name of function. # Same as _print at this point.

# Contains result of function. # No input, No output. # The predictable result.

# $VarSomething replaced HERE. # The expansion is part of the #+ variable contents. # $VarSomething replaced HERE. # The expansion is part of the #+ variable contents.

The difference between the unquoted and the doublequoted versions above can be seen in the "protect_literal.sh" example. The first case above is processed as two, unquoted, BashWords. The second case above is processed as one, quoted, BashWord.

# Delayed replacement # echo echo ' Delayed replacement ' funcVar="$(_print '$VarSomething')" # No replacement, single BashWord. eval $funcVar # $VarSomething replaced HERE. echo VarSomething='NewThing' eval $funcVar echo

# $VarSomething replaced HERE.

# Restore the original setting trashed above. VarSomething=Literal # #+ # #+ There are a pair of functions demonstrated in the "protect_literal.sh" and "unprotect_literal.sh" examples. These are general purpose functions for delayed replacement literals containing variables.

# REVIEW: # # A string can be considered a ClassicArray of elements (characters). # A string operation applies to all elements (characters) of the string #+ (in concept, anyway).

Appendix A. Contributed Scripts

615

Advanced BashScripting Guide

### # The notation: ${array_name[@]} represents all elements of the #+ BashArray: array_name. ### # The ExtendedSyntax string operations can be applied to all #+ elements of an array. ### # This may be thought of as a ForEach operation on a vector of strings. ### # Parameters are similar to an array. # The initialization of a parameter array for a script #+ and a parameter array for a function only differ #+ in the initialization of ${0}, which never changes its setting. ### # Subscript zero of the script's parameter array contains #+ the name of the script. ### # Subscript zero of a function's parameter array DOES NOT contain #+ the name of the function. # The name of the current function is accessed by the $FUNCNAME variable. ### # A quick, review list follows (quick, not short). echo echo echo echo echo echo echo echo echo echo echo echo

' Test (but not change) ' ' null reference ' n ${VarNull'NotSet'}' ' ${VarNull} n ${VarNull:'NotSet'}' ' ${VarNull} ' null contents ' n ${VarEmpty'Empty'}' ' ${VarEmpty} n ${VarEmpty:'Empty'}' ' ${VarEmpty}

# # # #

NotSet NewLine only NotSet Newline only

# # # #

Only the space Newline only Empty Newline only

echo ' contents ' echo ${VarSomething'Content'} echo ${VarSomething:'Content'} echo ' Sparse Array ' echo ${ArrayVar[@]'not set'} # # # # # # ASCIIArt time State Y==yes, Unset Y Empty N Contents N

# Literal # Literal

N==no : Y Y N

${# ... } == 0 ${# ... } == 0 ${# ... } > 0

# Either the first and/or the second part of the tests #+ may be a command or a function invocation string. echo echo ' Test 1 for undefined ' declare i t _decT() { t=$t1 } # Null reference, set: t == 1 t=${#VarNull}

# Results in zero.

Appendix A. Contributed Scripts

616

Advanced BashScripting Guide

${VarNull _decT } echo $t # Null contents, set: t == 0 t=${#VarEmpty} ${VarEmpty _decT } echo $t # Function executes, t now 1.

# Results in zero. # _decT function NOT executed.

# Contents, set: t == number of nonnull characters VarSomething='_simple' # Set to valid function name. t=${#VarSomething} # nonzero length ${VarSomething _decT } # Function _simple executed. echo $t # Note the AppendTo action. # Exercise: clean up that example. unset t unset _decT VarSomething=Literal echo echo ' Test and Change ' echo ' Assignment if null reference ' echo n ${VarNull='NotSet'}' ' # NotSet NotSet echo ${VarNull} unset VarNull echo ' Assignment if null reference ' echo n ${VarNull:='NotSet'}' ' # NotSet NotSet echo ${VarNull} unset VarNull echo ' No assignment if null contents ' echo n ${VarEmpty='Empty'}' ' # Space only echo ${VarEmpty} VarEmpty='' echo ' Assignment if null contents ' echo n ${VarEmpty:='Empty'}' ' echo ${VarEmpty} VarEmpty=''

# Empty Empty

echo ' No change if already has contents ' echo ${VarSomething='Content'} # Literal echo ${VarSomething:='Content'} # Literal

# "Subscript sparse" BashArrays ### # BashArrays are subscript packed, beginning with #+ subscript zero unless otherwise specified. ### # The initialization of ArrayVar was one way #+ to "otherwise specify". Here is the other way: ### echo declare a ArraySparse ArraySparse=( [1]=one [2]='' [4]='four' ) # [0]=null reference, [2]=null content, [3]=null reference echo ' ArraySparse List ' # Within doublequotes, default IFS, GlobPattern

Appendix A. Contributed Scripts

617

Advanced BashScripting Guide

IFS=$'\x20'$'\x09'$'\x0A' printf %q "${ArraySparse[*]}" echo # Note that the output does not distinguish between "null content" #+ and "null reference". # Both print as escaped whitespace. ### # Note also that the output does NOT contain escaped whitespace #+ for the "null reference(s)" prior to the first defined element. ### # This behavior of 2.04, 2.05a and 2.05b has been reported #+ and may change in a future version of Bash. # To output a sparse array and maintain the [subscript]=value #+ relationship without change requires a bit of programming. # One possible code fragment: ### # local l=${#ArraySparse[@]} # Count of defined elements # local f=0 # Count of found subscripts # local i=0 # Subscript to test ( # Anonymous inline function for (( l=${#ArraySparse[@]}, f = 0, i = 0 ; f < l ; i++ )) do # 'if defined then...' ${ArraySparse[$i]+ eval echo '\ ['$i']='${ArraySparse[$i]} ; (( f++ )) } done ) # The reader coming upon the above code fragment cold #+ might want to review "command lists" and "multiple commands on a line" #+ in the text of the foregoing "Advanced Bash Scripting Guide." ### # Note: # The "read a array_name" version of the "read" command #+ begins filling array_name at subscript zero. # ArraySparse does not define a value at subscript zero. ### # The user needing to read/write a sparse array to either #+ external storage or a communications socket must invent #+ a read/write code pair suitable for their purpose. ### # Exercise: clean it up. unset ArraySparse echo echo ' Conditional alternate (But not change) ' echo ' No alternate if null reference ' echo n ${VarNull+'NotSet'}' ' echo ${VarNull} unset VarNull echo ' No alternate if null reference ' echo n ${VarNull:+'NotSet'}' ' echo ${VarNull} unset VarNull echo ' Alternate if null contents ' echo n ${VarEmpty+'Empty'}' ' echo ${VarEmpty} VarEmpty=''

# Empty

Appendix A. Contributed Scripts

618

Advanced BashScripting Guide

echo ' No alternate if null contents ' echo n ${VarEmpty:+'Empty'}' ' echo ${VarEmpty} VarEmpty='' echo ' Alternate if already has contents ' # Alternate literal echo n ${VarSomething+'Content'}' ' echo ${VarSomething} # Invoke function echo n ${VarSomething:+ $(_simple) }' ' echo ${VarSomething} echo echo ' Sparse Array ' echo ${ArrayVar[@]+'Empty'} echo echo ' Test 2 for undefined ' declare i t _incT() { t=$t+1 } # Note: # This is the same test used in the sparse array #+ listing code fragment. # Null reference, set: t == 1 t=${#VarNull}1 ${VarNull+ _incT } echo $t' Null reference' # Null contents, set: t == 0 t=${#VarEmpty}1 ${VarEmpty+ _incT } echo $t' Null content'

# Space only

# Content Literal

# SimpleFunc Literal

# An array of 'Empty'(ies)

# Results in minusone. # Does not execute.

# Results in minusone. # Executes.

# Contents, set: t == (number of nonnull characters) t=${#VarSomething}1 # nonnull length minusone ${VarSomething+ _incT } # Executes. echo $t' Contents' # Exercise: clean up that example. unset t unset _incT # ${name?err_msg} ${name:?err_msg} # These follow the same rules but always exit afterwards #+ if an action is specified following the question mark. # The action following the question mark may be a literal #+ or a function result. ### # ${name?} ${name:?} are testonly, the return can be tested.

Appendix A. Contributed Scripts

619

Advanced BashScripting Guide

# Element operations # echo echo ' Trailing subelement selection ' # Strings, Arrays and Positional parameters

# Call this script with multiple arguments #+ to see the parameter selections. echo echo echo echo ' All ' ${VarSomething:0} ${ArrayVar[@]:0} ${@:0}

# # # #

all nonnull characters all elements with content all parameters with content; ignoring parameter[0]

echo echo echo echo echo

' All after ' ${VarSomething:1} ${ArrayVar[@]:1} ${@:2}

# all nonnull after character[0] # all after element[0] with content # all after param[1] with content

echo echo ' Range after ' echo ${VarSomething:4:3}

# ral # Three characters after # character[3]

echo ' Sparse array gotch ' echo ${ArrayVar[@]:1:2} # four The only element with content. # Two elements after (if that many exist). # the FIRST WITH CONTENTS #+ (the FIRST WITH CONTENTS is being #+ considered as if it #+ were subscript zero). # Executed as if Bash considers ONLY array elements with CONTENT # printf %q "${ArrayVar[@]:0:3}" # Try this one # #+ # # #+ In versions 2.04, 2.05a and 2.05b, Bash does not handle sparse arrays as expected using this notation. The current Bash maintainer, Chet Ramey, has corrected this for an upcoming version of Bash.

echo ' Nonsparse array ' echo ${@:2:2} # Two parameters following parameter[1] # New victims for string vector examples: stringZ=abcABC123ABCabc arrayZ=( abcabc ABCABC 123123 ABCABC abcabc ) sparseZ=( [1]='abcabc' [3]='ABCABC' [4]='' [5]='123123' ) echo echo echo echo echo echo echo

' ' ' ' ' '

Victim string '$stringZ' ' Victim array '${arrayZ[@]}' ' Sparse array '${sparseZ[@]}' ' [0]==null ref, [2]==null ref, [4]==null content ' [1]=abcabc [3]=ABCABC [5]=123123 ' nonnullreference count: '${#sparseZ[@]}' elements'

Appendix A. Contributed Scripts

620

Advanced BashScripting Guide

echo echo ' Prefix subelement removal ' echo ' GlobPattern match must include the first character. ' echo ' GlobPattern may be a literal or a function result. ' echo

# Function returning a simple, Literal, GlobPattern _abc() { echo n 'abc' } echo echo echo echo ' Shortest prefix ' ${stringZ#123} ${stringZ#$(_abc)} ${arrayZ[@]#abc}

# Unchanged (not a prefix). # ABC123ABCabc # Applied to each element.

# Fixed by Chet Ramey for an upcoming version of Bash. # echo ${sparseZ[@]#abc} # Version2.05b core dumps. # The it would be nice FirstSubscriptOf # echo ${#sparseZ[@]#*} # This is NOT valid Bash. echo echo echo echo echo

' Longest prefix ' ${stringZ##1*3} ${stringZ##a*C} ${arrayZ[@]##a*c}

# Unchanged (not a prefix) # abc # ABCABC 123123 ABCABC

# Fixed by Chet Ramey for an upcoming version of Bash # echo ${sparseZ[@]##a*c} # Version2.05b core dumps. echo echo echo echo echo echo echo echo echo

' Suffix subelement removal ' ' GlobPattern match must include the last character. ' ' GlobPattern may be a literal or a function result. ' ' Shortest suffix ' ${stringZ%1*3} ${stringZ%$(_abc)} ${arrayZ[@]%abc}

# Unchanged (not a suffix). # abcABC123ABC # Applied to each element.

# Fixed by Chet Ramey for an upcoming version of Bash. # echo ${sparseZ[@]%abc} # Version2.05b core dumps. # The it would be nice LastSubscriptOf # echo ${#sparseZ[@]%*} # This is NOT valid Bash. echo echo echo echo echo

' Longest suffix ' ${stringZ%%1*3} ${stringZ%%b*c} ${arrayZ[@]%%b*c}

# Unchanged (not a suffix) # a # a ABCABC 123123 ABCABC a

# Fixed by Chet Ramey for an upcoming version of Bash. # echo ${sparseZ[@]%%b*c} # Version2.05b core dumps. echo echo echo echo echo

' ' ' '

Subelement replacement ' Subelement at any location in string. ' First specification is a GlobPattern ' GlobPattern may be a literal or GlobPattern function result. '

Appendix A. Contributed Scripts

621

Advanced BashScripting Guide

echo ' Second specification may be a literal or function result. ' echo ' Second specification may be unspecified. Pronounce that' echo ' as: ReplaceWithNothing (Delete) ' echo

# Function returning a simple, Literal, GlobPattern _123() { echo n '123' } echo echo echo echo echo echo echo echo echo echo echo ' Replace first occurrence ' ${stringZ/$(_123)/999} # Changed (123 is a component). ${stringZ/ABC/xyz} # xyzABC123ABCabc ${arrayZ[@]/ABC/xyz} # Applied to each element. ${sparseZ[@]/ABC/xyz} # Works as expected.

' Delete first occurrence ' ${stringZ/$(_123)/} ${stringZ/ABC/} ${arrayZ[@]/ABC/} ${sparseZ[@]/ABC/}

# The replacement need not be a literal, #+ since the result of a function invocation is allowed. # This is general to all forms of replacement. echo echo ' Replace first occurrence with ResultOf ' echo ${stringZ/$(_123)/$(_simple)} # Works as expected. echo ${arrayZ[@]/ca/$(_simple)} # Applied to each element. echo ${sparseZ[@]/ca/$(_simple)} # Works as expected. echo echo echo echo echo echo echo echo echo echo echo echo

' Replace all occurrences ' ${stringZ//[b2]/X} ${stringZ//abc/xyz} ${arrayZ[@]//abc/xyz} ${sparseZ[@]//abc/xyz}

# # # #

Xout b's and 2's xyzABC123ABCxyz Applied to each element. Works as expected.

' Delete all occurrences ' ${stringZ//[b2]/} ${stringZ//abc/} ${arrayZ[@]//abc/} ${sparseZ[@]//abc/}

echo echo ' Prefix subelement replacement ' echo ' Match must include the first character. ' echo echo echo echo echo echo ' Replace prefix occurrences ' ${stringZ/#[b2]/X} # Unchanged (neither is a prefix). ${stringZ/#$(_abc)/XYZ} # XYZABC123ABCabc ${arrayZ[@]/#abc/XYZ} # Applied to each element. ${sparseZ[@]/#abc/XYZ} # Works as expected.

echo echo ' Delete prefix occurrences ' echo ${stringZ/#[b2]/}

Appendix A. Contributed Scripts

622

Advanced BashScripting Guide

echo ${stringZ/#$(_abc)/} echo ${arrayZ[@]/#abc/} echo ${sparseZ[@]/#abc/} echo echo ' Suffix subelement replacement ' echo ' Match must include the last character. ' echo echo echo echo echo echo echo echo echo echo echo echo ' Replace suffix occurrences ' ${stringZ/%[b2]/X} # Unchanged (neither is a suffix). ${stringZ/%$(_abc)/XYZ} # abcABC123ABCXYZ ${arrayZ[@]/%abc/XYZ} # Applied to each element. ${sparseZ[@]/%abc/XYZ} # Works as expected.

' Delete suffix occurrences ' ${stringZ/%[b2]/} ${stringZ/%$(_abc)/} ${arrayZ[@]/%abc/} ${sparseZ[@]/%abc/}

echo echo ' Special cases of null GlobPattern ' echo echo ' Prefix all ' # null substring pattern means 'prefix' echo ${stringZ/#/NEW} # NEWabcABC123ABCabc echo ${arrayZ[@]/#/NEW} # Applied to each element. echo ${sparseZ[@]/#/NEW} # Applied to nullcontent also. # That seems reasonable. echo echo ' Suffix all ' # null substring pattern means 'suffix' echo ${stringZ/%/NEW} # abcABC123ABCabcNEW echo ${arrayZ[@]/%/NEW} # Applied to each element. echo ${sparseZ[@]/%/NEW} # Applied to nullcontent also. # That seems reasonable. echo echo ' Special case ForEach GlobPattern ' echo ' This is a nicetohave dream ' echo _GenFunc() { echo n ${0} # Illustration only. # Actually, that would be an arbitrary computation. } # All occurrences, matching the AnyThing pattern. # Currently //*/ does not match nullcontent nor nullreference. # /#/ and /%/ does match nullcontent but not nullreference. echo ${sparseZ[@]//*/$(_GenFunc)}

# A possible syntax would be to make #+ the parameter notation used within this construct mean: # ${1} The full element # ${2} The prefix, if any, to the matched subelement # ${3} The matched subelement

Appendix A. Contributed Scripts

623

Advanced BashScripting Guide

# ${4} The suffix, if any, to the matched subelement # # echo ${sparseZ[@]//*/$(_GenFunc ${3})} # Same as ${1} here. # Perhaps it will be implemented in a future version of Bash.

exit 0

Appendix A. Contributed Scripts

624

Appendix B. Reference Cards

The following reference cards provide a useful summary of certain scripting concepts. The foregoing text treats these matters in more depth, as well as giving usage examples.

Table B1. Special Shell Variables Meaning Name of script Positional parameter #1 Positional parameters #2 #9 Positional parameter #10 Number of positional parameters All the positional parameters (as a single word) * "$@" All the positional parameters (as separate strings) ${#*} Number of command line parameters passed to script ${#@} Number of command line parameters passed to script $? Return value $$ Process ID (PID) of script $ Flags passed to script (using set) $_ Last argument of previous command $! Process ID (PID) of last job run in background * Must be quoted, otherwise it defaults to "$@". Variable $0 $1 $2 $9 ${10} $# "$*"

Table B2. TEST Operators: Binary Comparison Operator Meaning Operator String Comparison = == != \< \> z n Appendix B. Reference Cards Meaning

Arithmetic Comparison eq Equal to ne lt le gt ge Not equal to Less than Less than or equal to Greater than Greater than or equal to

Equal to Equal to Not equal to Less than (ASCII) * Greater than (ASCII) * String is empty String is not empty 625

Advanced BashScripting Guide

Arithmetic Comparison within double parentheses (( ... )) > Greater than >= Greater than or equal to < Less than <= Less than or equal to * If within a doublebracket [[ ... ]] test construct, then no escape \ is needed.

Table B3. TEST Operators: Files Operator e f d h L b c p S t N O G Tests Whether File exists File is a regular file File is a directory File is a symbolic link File is a symbolic link File is a block device File is a character device File is a pipe File is a socket File is associated with a terminal File modified since it was last read You own the file Group id of file same as yours Operator s r w x g u k Tests Whether File is not zero size File has read permission File has write permission File has execute permission sgid flag set suid flag set "sticky bit" set

F1 nt F2 F1 ot F2 F1 ef F2

File F1 is newer than F2 * File F1 is older than F2 * Files F1 and F2 are hard links to the same file *

"NOT" (reverses sense of above tests) * Binary operator (requires two operands). !

Table B4. Parameter Substitution and Expansion Expression ${var} ${varDEFAULT} ${var:DEFAULT} ${var=DEFAULT} ${var:=DEFAULT} Meaning Value of var, same as $var If var not set, evaluate expression as $DEFAULT * If var not set or is empty, evaluate expression as $DEFAULT * If var not set, evaluate expression as $DEFAULT * If var not set, evaluate expression as $DEFAULT *

Appendix B. Reference Cards

626

Advanced BashScripting Guide ${var+OTHER} ${var:+OTHER} If var set, evaluate expression as $OTHER, otherwise as null string If var set, evaluate expression as $OTHER, otherwise as null string If var not set, print $ERR_MSG * If var not set, print $ERR_MSG *

${var?ERR_MSG} ${var:?ERR_MSG} ${!varprefix*}

Matches all previously declared variables beginning with varprefix ${!varprefix@} Matches all previously declared variables beginning with varprefix * Of course if var is set, evaluate the expression as $var.

Table B5. String Operations Expression ${#string} ${string:position} ${string:position:length} Meaning Length of $string Extract substring from $string at $position Extract $length characters substring from $string at $position Strip shortest match of $substring from front of $string Strip longest match of $substring from front of $string Strip shortest match of $substring from back of $string Strip longest match of $substring from back of $string Replace first match of $substring with $replacement Replace all matches of $substring with $replacement If $substring matches front end of $string, substitute $replacement for $substring If $substring matches back end of $string, substitute $replacement for $substring

${string#substring} ${string##substring} ${string%substring} ${string%%substring}

${string/substring/replacement} ${string//substring/replacement} ${string/#substring/replacement} ${string/%substring/replacement}

expr match "$string" '$substring'

Length of matching $substring* at beginning of $string 627

Appendix B. Reference Cards

Advanced BashScripting Guide expr "$string" : '$substring' expr index "$string" $substring Length of matching $substring* at beginning of $string Numerical position in $string of first character in $substring that matches Extract $length characters from $string starting at $position Extract $substring* at beginning of $string

expr substr $string $position $length expr match "$string" '\($substring\)' expr "$string" : '\($substring\)' Extract $substring* at beginning of $string expr match "$string" Extract $substring* at end of $string '.*\($substring\)' expr "$string" : '.*\($substring\)' Extract $substring* at end of $string * Where $substring is a regular expression.

Table B6. Miscellaneous Constructs Expression Brackets if [ CONDITION ] if [[ CONDITION ]] Array[1]=element1 [az] Curly Brackets ${variable} ${!variable} { command1; command2; . . . commandN; } {string1,string2,string3,...} {a..z} {} Interpretation

Test construct Extended test construct Array initialization Range of characters within a Regular Expression

Parameter substitution Indirect variable reference Block of code Brace expansion Extended brace expansion Text replacement, after find and xargs

Parentheses ( command1; command2 ) Array=(element1 element2 element3) result=$(COMMAND) >(COMMAND) <(COMMAND) Double Parentheses Appendix B. Reference Cards

Command group executed within a subshell Array initialization Execute command in subshell and assign result to variable Process substitution Process substitution

628

Advanced BashScripting Guide (( var = 78 )) var=$(( 20 + 5 )) Quoting "$variable" 'string' Back Quotes result=`COMMAND` Integer arithmetic Integer arithmetic, with variable assignment

"Weak" quoting "Strong" quoting

Execute command in subshell and assign result to variable

Appendix B. Reference Cards

629

Appendix C. A Sed and Awk MicroPrimer

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. sed: a noninteractive text file editor awk: a fieldoriented pattern processing language with a Clike syntax 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 wellbehaved 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 335 and Example 924).

C.1. Sed
Sed is a noninteractive 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. [94] 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.

Table C1. Basic sed operators Operator [addressrange]/p [addressrange]/d s/pattern1/pattern2/ [addressrange]/s/pattern1/pattern2/ Name print delete substitute substitute Effect Print [specified address range] Delete [specified address range] Substitute pattern2 for first instance of pattern1 in a line Substitute pattern2 for first instance of pattern1 in a line, over addressrange replace any character in pattern1 with the corresponding character in pattern2, over 630

[addressrange]/y/pattern1/pattern2/

transform

Appendix C. A Sed and Awk MicroPrimer

Advanced BashScripting Guide addressrange (equivalent of tr) Operate on every pattern match within each matched line of input

global

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 e '/^$/d' $filename # The e option causes the next string to be interpreted as an editing instruction. # (If passing only a single instruction to sed, the "e" is optional.) # The "strong" quotes ('') protect the RE characters in the instruction #+ from reinterpretation as special characters by the body of the script. # (This reserves RE expansion of the instruction for sed.) # # Operates on the text contained in file $filename.

In certain cases, a sed editing command will not work with single quotes.
filename=file1.txt pattern=BEGIN sed "/^$pattern/d" "$filename" # Works as specified. # sed '/^$pattern/d' "$filename" has unexpected results. # In this instance, with strong quoting (' ... '), #+ "$pattern" will not expand to "BEGIN".

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 may be omitted.
sed n '/xzy/p' # The n option # Otherwise all # The e option $filename tells sed to print only those lines matching the pattern. input lines would print. not necessary here since there is only a single editing instruction.

Table C2. Examples of sed operators Notation 8d /^$/d 1,/^$/d /Jones/p s/Windows/Linux/ s/BSOD/stability/g s/ *$// s/00*/0/g /GUI/d s/GUI//g Effect Delete 8th line of input. Delete all blank lines. Delete from beginning of input up to, and including first blank line. Print only lines containing "Jones" (with n option). Substitute "Linux" for first instance of "Windows" found in each input line. Substitute "stability" for every instance of "BSOD" found in each input line. Delete all spaces at the end of every line. Compress all consecutive sequences of zeroes into a single zero. Delete all lines containing "GUI". Delete all instances of "GUI", leaving the remainder of each line intact.

Appendix C. A Sed and Awk MicroPrimer

631

Advanced BashScripting Guide Substituting a zerolength 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

A backslash forces the sed replacement command to continue on to the next line. This has the effect of using the newline at the end of the first line as the replacement string.
s/^ /g */\

This substitution replaces linebeginning 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.
/[09AZaz]/,/^$/{ /^$/d }

This deletes only the first of each set of consecutive blank lines. That might be useful for singlespacing a text file, but retaining the blank line(s) between paragraphs. The usual delimiter that sed uses is /. However, sed allows other delimiters, such as %. This is useful when / is part of a replacement string, as in a file pathname. See Example 109 and Example 1529. A quick way to doublespace a text file is sed G filename. For illustrative examples of sed within shell scripts, see: 1. Example 331 2. Example 332 3. Example 153 4. Example A2 5. Example 1515 6. Example 1524 7. Example A12 8. Example A17 9. Example 1529 10. Example 109 11. Example 1543 12. Example A1 13. Example 1513 14. Example 1511 15. Example A10 16. Example 1812 17. Example 1516 18. Example A29 For a more extensive treatment of sed, check the appropriate references in the Bibliography.

Appendix C. A Sed and Awk MicroPrimer

632

Advanced BashScripting Guide

C.2. Awk
Awk is a fullfeatured 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 delimited by whitespace, though there are options for changing this. Awk parses and operates on each separate field. This makes it ideal for handling structured text files especially tables data organized into consistent chunks, such as rows and columns. Strong quoting and curly brackets enclose blocks of awk code within a shell script.
echo one two | awk '{print $1}' # one echo one two | awk '{print $2}' # two

awk '{print $3}' $filename # Prints field #3 of file $filename to stdout. awk '{print $1 $5 $6}' $filename # Prints fields #1, #5, and #6 of file $filename.

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. The following example illustrates how awk can add textparsing tools to a shell script.

Example C1. Counting Letter Occurrences

#! /bin/sh # lettercount2.sh: Counting letter occurrences in a text file. # # Script by nyal [[email protected]]. # Used in ABS Guide with permission. # Recommented and reformatted by ABS Guide author. # Version 1.1: Modified to work with gawk 3.1.3. # (Will still work with earlier versions.)

INIT_TAB_AWK="" # Parameter to initialize awk script. count_case=0 FILE_PARSE=$1

Appendix C. A Sed and Awk MicroPrimer

633

Advanced BashScripting Guide

E_PARAMERR=65 usage() { echo "Usage: lettercount.sh file letters" 2>&1 # For example: ./lettercount2.sh filename.txt a b c exit $E_PARAMERR # Too few arguments passed to script. } if [ ! f "$1" ] ; then echo "$1: No such file." 2>&1 usage # Print usage message and exit. fi if [ z "$2" ] ; then echo "$2: No letters specified." 2>&1 usage fi shift # Letters specified. for letter in `echo $@` # For each one . . . do INIT_TAB_AWK="$INIT_TAB_AWK tab_search[${count_case}] = \ \"$letter\"; final_tab[${count_case}] = 0; " # Pass as parameter to awk script below. count_case=`expr $count_case + 1` done # DEBUG: # echo $INIT_TAB_AWK; cat $FILE_PARSE | # Pipe the target file to the following awk script. # # # # Earlier version of script: awk v tab_search=0 v final_tab=0 v tab=0 v \ nb_letter=0 v chara=0 v chara2=0 \

awk \ "BEGIN { $INIT_TAB_AWK } \ { split(\$0, tab, \"\"); \ for (chara in tab) \ { for (chara2 in tab_search) \ { if (tab_search[chara2] == tab[chara]) { final_tab[chara2]++ } } } } \ END { for (chara in final_tab) \ { print tab_search[chara] \" => \" final_tab[chara] } }" # # Nothing all that complicated, just . . . #+ forloops, iftests, and a couple of specialized functions. exit $? # Compare this script to lettercount.sh.

For simpler examples of awk within shell scripts, see: 1. Example 1413 2. Example 198 3. Example 1529 Appendix C. A Sed and Awk MicroPrimer 634

Advanced BashScripting Guide 4. Example 335 5. Example 924 6. Example 1420 7. Example 272 8. Example 273 9. Example 103 10. Example 1555 11. Example 929 12. Example 154 13. Example 914 14. Example 3316 15. Example 108 16. Example 334 17. Example 1548 That's all the awk we'll cover here, folks, but there's lots more to learn. See the appropriate references in the Bibliography.

Appendix C. A Sed and Awk MicroPrimer

635

Appendix D. Exit Codes With Special Meanings

Table D1. Reserved Exit Codes Exit Code Number 1 2 126 Meaning Catchall for general errors Misuse of shell builtins (according to Bash documentation) Command invoked cannot execute Example let "var1 = 1/0" Comments Miscellaneous errors, such as "divide by zero" Seldom seen, usually defaults to exit code 1 Permission problem or command is not an executable Possible problem with $PATH or a typo exit takes only integer args in the range 0 255 (see footnote) $? returns 137 (128 + 9)

127 128

"command not found" Invalid argument to exit exit 3.14159

128+n 130

Fatal error signal "n" Script terminated by ControlC

kill 9 $PPID of script

ControlC is fatal error signal 2, (130 = 128 + 2, see above) 255* Exit status out of range exit 1 exit takes only integer args in the range 0 255 According to the above table, exit codes 1 2, 126 165, and 255 [95] have special meanings, and should therefore be avoided for userspecified exit parameters. Ending a script with exit 127 would certainly cause confusion when troubleshooting (is the error code a "command not found" or a userdefined one?). However, many scripts use an exit 1 as a general bailout upon error. Since exit code 1 signifies so many possible errors, this probably would not be helpful in debugging. There has been an attempt to systematize exit status numbers (see /usr/include/sysexits.h), but this is intended for C and C++ programmers. A similar standard for scripting might be appropriate. The author of this document proposes restricting userdefined exit codes to the range 64 113 (in addition to 0, for success), to conform with the C/C++ standard. This would allot 50 valid codes, and make troubleshooting scripts more straightforward. All userdefined exit codes in the accompanying examples to this document now conform to this standard, except where overriding circumstances exist, as in Example 92. 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 Cshell or tcsh may give different values in some cases.

Appendix D. Exit Codes With Special Meanings

636

Appendix E. A Detailed Introduction to I/O and I/O Redirection

written by Stphane Chazelas, and revised by the document author 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:
bash$ cat /etc/passwd >& cat: standard output: Bad file descriptor

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). ls > /dev/null means running ls with its fd 1 connected to /dev/null.
bash$ lsof a p $$ d0,1,2 COMMAND PID USER FD TYPE DEVICE SIZE NODE NAME bash 363 bozo 0u CHR 136,1 3 /dev/pts/1 bash 363 bozo 1u CHR 136,1 3 /dev/pts/1 bash 363 bozo 2u CHR 136,1 3 /dev/pts/1

bash$ exec 2> /dev/null bash$ lsof a p $$ d0,1,2 COMMAND PID USER FD TYPE DEVICE SIZE NODE NAME bash 371 bozo 0u CHR 136,1 3 /dev/pts/1 bash 371 bozo 1u CHR 136,1 3 /dev/pts/1 bash 371 bozo 2w CHR 1,3 120 /dev/null

bash$ bash c 'lsof a p $$ d0,1,2' | cat COMMAND PID USER FD TYPE DEVICE SIZE NODE NAME lsof 379 root 0u CHR 136,1 3 /dev/pts/1 lsof 379 root 1w FIFO 0,0 7118 pipe lsof 379 root 2u CHR 136,1 3 /dev/pts/1

bash$ echo "$(bash c 'lsof a p $$ d0,1,2' 2>&1)" COMMAND PID USER FD TYPE DEVICE SIZE NODE NAME lsof 426 root 0u CHR 136,1 3 /dev/pts/1 lsof 426 root 1w FIFO 0,0 7520 pipe

Appendix E. A Detailed Introduction to I/O and I/O Redirection

637

Advanced BashScripting Guide

lsof 426 root 2w FIFO 0,0 7520 pipe

This works for different types of redirection. Exercise: Analyze the following script.
#! /usr/bin/env bash mkfifo /tmp/fifo1 /tmp/fifo2 while read a; do echo "FIFO1: $a"; done < /tmp/fifo1 & exec 7> /tmp/fifo1 exec 8> >(while read a; do echo "FD8: $a, to fd7"; done >&7) 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 echo 1st, sleep 1 echo 2nd, sleep 1 echo 3rd, sleep 1 echo 4th, sleep 1 echo 5th, sleep 1 echo 6th, sleep 1 echo 7th, sleep 1 echo 8th, sleep 1 echo 9th, to stdout to stderr >&2 to fd 3 >&3 to fd 4 >&4 to fd 5 >&5 through a pipe | sed 's/.*/PIPE: &, to fd 5/' >&5 to fd 6 >&6 to fd 7 >&7 to fd 8 >&8

) 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. # Good luck! exit 0

Appendix E. A Detailed Introduction to I/O and I/O Redirection

638

Appendix F. CommandLine Options

Many executables, whether binaries or script files, accept options to modify their runtime behavior. For example: from the command line, typing command o would invoke command, with option o.

F.1. Standard CommandLine Options

Over time, there has evolved a loose standard for the meanings of command line option flags. The GNU utilities conform more closely to this "standard" than older UNIX utilities. Traditionally, UNIX commandline options consist of a dash, followed by one or more lowercase letters. The GNU utilities added a doubledash, followed by a complete word or compound word. The two most widelyaccepted options are: h help Help: Give usage message and exit. v version Version: Show program version and exit. Other common options are: a all All: show all information or operate on all arguments. l list List: list files or arguments without taking other action. o Output filename q quiet Quiet: suppress stdout. r R Appendix F. CommandLine Options 639

Advanced BashScripting Guide recursive Recursive: Operate recursively (down directory tree). v verbose Verbose: output additional information to stdout or stderr. z compress Compress: apply compression (usually gzip). However: In tar and gawk: f file File: filename follows. In cp, mv, rm: f force Force: force overwrite of target file(s). Many UNIX and Linux utilities deviate from this "standard," so it is dangerous to assume that a given option will behave in a standard way. Always check the man page for the command in question when in doubt. A complete table of recommended options for the GNU utilities is available at the GNU standards page.

F.2. Bash CommandLine Options

Bash itself has a number of commandline options. Here are some of the more useful ones. c Read commands from the following string and assign any arguments to the positional parameters.
bash$ bash c 'set a b c d; IFS="+;"; echo "$*"' a+b+c+d

r restricted Appendix F. CommandLine Options 640

Advanced BashScripting Guide Runs the shell, or a script, in restricted mode. posix Forces Bash to conform to POSIX mode. version Display Bash version information and exit. End of options. Anything further on the command line is an argument, not an option.

Appendix F. CommandLine Options

641

Appendix G. Important Files

startup files 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 Bournetype shells, not just Bash [96]) /etc/bashrc systemwide functions and aliases for Bash $HOME/.bash_profile userspecific Bash environmental default settings, found in each user's home directory (the local counterpart to /etc/profile) $HOME/.bashrc userspecific 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 K for a sample .bashrc file. logout file $HOME/.bash_logout userspecific instruction file, found in each user's home directory. Upon exit from a login (Bash) shell, the commands in this file execute.

Appendix G. Important Files

642

Appendix H. Important System Directories

Sysadmins and anyone else writing administrative scripts should be intimately familiar with the following system directories. /bin Binaries (executables). Basic system programs and utilities (such as bash). /usr/bin [97] More system binaries. /usr/local/bin Miscellaneous binaries local to the particular machine. /sbin System binaries. Basic system administrative programs and utilities (such as fsck). /usr/sbin More system administrative programs and utilities. /etc Et cetera. Systemwide configuration scripts. Of particular interest are the /etc/fstab (filesystem table), /etc/mtab (mounted filesystem table), and the /etc/inittab files. /etc/rc.d Boot scripts, on Red Hat and derivative distributions of Linux. /usr/share/doc Documentation for installed packages. /usr/man The systemwide manpages. /dev Device directory. Entries (but not mount points) for physical and virtual devices. See Chapter 27. /proc Process directory. Contains information and statistics about running processes and kernel parameters. See Chapter 27. /sys Systemwide device directory. Contains information and statistics about device and device names. This is newly added to Linux with the 2.6.X kernels. /mnt Mount. Directory for mounting hard drive partitions, such as /mnt/dos, and physical devices. In newer Linux distros, the /media directory has taken over as the preferred mount point for I/O Appendix H. Important System Directories 643

Advanced BashScripting Guide devices. /media In newer Linux distros, the preferred mount point for I/O devices, such as CD ROMs or USB flash drives. /var Variable (changeable) system files. This is a catchall "scratchpad" directory for data generated while a Linux/UNIX machine is running. /var/log Systemwide log files. /var/spool/mail User mail spool. /lib Systemwide library files. /usr/lib More systemwide library files. /tmp System temporary files. /boot System boot directory. The kernel, module links, system map, and boot manager reside here. Altering files in this directory may result in an unbootable system.

Appendix H. Important System Directories

644

Appendix I. 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 # Script by Stphane Chazelas, #+ modified by Bruno Haible, bugfixed by Alfredo Pironti. . gettext.sh E_CDERROR=65 error() { printf "$@" >&2 exit $E_CDERROR } cd $var || error "`eval_gettext \"Can\'t cd to \\\$var.\"`" # The triple backslashes (escapes) in front of $var needed #+ "because eval_gettext expects a string #+ where the variable values have not yet been substituted." # per Bruno Haible read p "`gettext \"Enter the value: \"`" var # ...

# #

Alfredo Pironti comments:

# This script has been modified to not use the $"..." syntax in #+ favor of the "`gettext \"...\"`" syntax. # This is ok, but with the new localized.sh program, the commands #+ "bash D filename" and "bash dumppostring filename" #+ will produce no output #+ (because those command are only searching for the $"..." strings)! # The ONLY way to extract strings from the new file is to use the # 'xgettext' program. However, the xgettext program is buggy. # Note that 'xgettext' has another bug. # # The shell fragment: # gettext s "I like Bash" # will be correctly extracted, but . . . # xgettext s "I like Bash" # . . . fails! # 'xgettext' will extract "s" because #+ the command only extracts the #+ very first argument after the 'gettext' word.

Appendix I. Localization

645

Advanced BashScripting Guide

# # # # #+ # # #+ # #+ #+ # # # #+ Escape characters: To localize a sentence like echo e "Hello\tworld!" you must use echo e "`gettext \"Hello\\tworld\"`" The "double escape character" before the `t' is needed because 'gettext' will search for a string like: 'Hello\tworld' This is because gettext will read one literal `\') and will output a string like "Bonjour\tmonde", so the 'echo' command will display the message correctly. You may not use echo "`gettext e \"Hello\tworld\"`" due to the xgettext bug explained above.

# Let's localize the following shell fragment: # echo "h display help and exit" # # First, one could do this: # echo "`gettext \"h display help and exit\"`" # This way 'xgettext' will work ok, #+ but the 'gettext' program will read "h" as an option! # # One solution could be # echo "`gettext \"h display help and exit\"`" # This way 'gettext' will work, #+ but 'xgettext' will extract "", as referred to above. # # The workaround you may use to get this string localized is # echo e "`gettext \"\\0h display help and exit\"`" # We have added a \0 (NULL) at the beginning of the sentence. # This way 'gettext' works correctly, as does 'xgettext.' # Moreover, the NULL character won't change the behavior #+ of the 'echo' command. # bash$ bash D localized.sh "Can't cd to %s." "Enter the value: "

This lists all the localized text. (The D option lists doublequoted strings prefixed by a $, without executing the script.)
bash$ bash dumppostrings localized.sh #: a:6 msgid "Can't cd to %s." msgstr "" #: a:7 msgid "Enter the value: " msgstr ""

The dumppostrings option to Bash resembles the D option, but uses gettext "po" format. Bruno Haible points out: Starting with gettext0.12.2, xgettext o localized.sh is recommended instead of bash dumppostrings localized.sh, because xgettext . . .

Appendix I. Localization

646

Advanced BashScripting Guide 1. understands the gettext and eval_gettext commands (whereas bash dumppostrings understands only its deprecated $"..." syntax) 2. can extract comments placed by the programmer, intended to be read by the translator. This shell code is then not specific to Bash any more; it works the same way with Bash 1.x and other /bin/sh implementations. Now, build a language.po file for each language that the script will be translated into, specifying the msgstr. Alfredo Pironti gives the following example: fr.po:
#: a:6 msgid "Can't cd to $var." msgstr "Impossible de se positionner dans le repertoire $var." #: a:7 msgid "Enter the value: " msgstr "Entrez la valeur : " # #+ #+ #+ The string are dumped with the variable names, not with the %s syntax, similar to C programs. This is a very cool feature if the programmer uses variable names that make sense!

Then, run msgfmt. msgfmt o localized.sh.mo fr.po Place the resulting localized.sh.mo file in the /usr/local/share/locale/fr/LC_MESSAGES directory, and at the beginning of the script, insert the lines:
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 # ...

The TEXTDOMAIN and TEXTDOMAINDIR variables need to be set and exported to the environment. This should be done within the script itself. Appendix I. Localization 647

Advanced BashScripting Guide This appendix written by Stphane Chazelas, with modifications suggested by Alfredo Pironti, and by Bruno Haible, maintainer of GNU gettext.

Appendix I. Localization

648

Appendix J. History Commands

The Bash shell provides commandline tools for editing and manipulating a user's command history. This is primarily a convenience, a means of saving keystrokes. Bash history commands: 1. history 2. fc
bash$ history 1 mount /mnt/cdrom 2 cd /mnt/cdrom 3 ls ...

Internal variables associated with Bash history commands: 1. $HISTCMD 2. $HISTCONTROL 3. $HISTIGNORE 4. $HISTFILE 5. $HISTFILESIZE 6. $HISTSIZE 7. $HISTTIMEFORMAT (Bash, ver. 3.0 or later) 8. !! 9. !$ 10. !# 11. !N 12. !N 13. !STRING 14. !?STRING? 15. ^STRING^string^ Unfortunately, the Bash history tools find no use in scripting.
#!/bin/bash # history.sh # Attempt to use 'history' command in a script. history # Script produces no output. # History commands do not work within a script. bash$ ./history.sh (no output)

The Advancing in the Bash Shell site gives a good introduction to the use of history commands in Bash.

Appendix J. History Commands

649

Appendix K. A Sample .bashrc File

The ~/.bashrc file determines the behavior of interactive shells. A good look at this file can lead to a better understanding of Bash. 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.

Example K1. Sample .bashrc file

#=============================================================== # # PERSONAL $HOME/.bashrc FILE for bash2.05a (or later) # # Last modified: Tue Apr 15 20:32:34 CEST 2003 # # 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 but based # on Redhat's default .bashrc file # > Modified for Linux. # The majority of the code you'll find here is based on code found # on Usenet (or internet). # This bashrc file is a bit overcrowded remember it is just # just an example. Tailor it to your needs # # #=============================================================== # > Comments added by HOWTO author. # > And then edited again by ER :) # # 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 your mileage may vary.... # The problem is that different types of terminals give # different answers to 'who am i'...... # I have not found a 'universal' method yet # function get_xserver () { case $TERM in xterm )

Appendix K. A Sample .bashrc File

650

Advanced BashScripting Guide

XSERVER=$(who am i | awk '{print $NF}' | tr d ')''(' ) # AnePieter Wieringa suggests the following alternative: # I_AM=$(who am i) # SERVER=${I_AM#*(} # SERVER=${SERVER%*)} XSERVER=${XSERVER%%:*} ;; aterm | rxvt) # find some code that works here..... ;; esac } if [ z ${DISPLAY:=""} ]; then get_xserver if [[ z ${XSERVER} || ${XSERVER} == $(hostname) || ${XSERVER} == "unix" ]]; then DISPLAY=":0.0" # Display on local host else DISPLAY=${XSERVER}:0.0 # Display on remote host fi fi export DISPLAY # # Some settings # ulimit S c 0 set o notify set o noclobber set o ignoreeof set o nounset #set o xtrace # Enable shopt s shopt s shopt s shopt s shopt s shopt s shopt s shopt s shopt s shopt s # Don't want any coredumps

# Useful for debuging

options: cdspell cdable_vars checkhash checkwinsize mailwarn sourcepath no_empty_cmd_completion # bash>=2.04 only cmdhist histappend histreedit histverify extglob # Necessary for programmable completion

# Disable options: shopt u mailwarn unset MAILCHECK

# I don't want my shell to warn me of incoming mail

export TIMEFORMAT=$'\nreal %3R\tuser %3U\tsys %3S\tpcpu %P\n' export HISTIGNORE="&:bg:fg:ll:h" export HOSTFILE=$HOME/.hosts # Put a list of remote hosts in ~/.hosts

# # Greeting, motd etc...

Appendix K. A Sample .bashrc File

651

Advanced BashScripting Guide

# # Define some colors first: red='\e[0;31m' RED='\e[1;31m' blue='\e[0;34m' BLUE='\e[1;34m' cyan='\e[0;36m' CYAN='\e[1;36m' NC='\e[0m' # No Color # > Nice. Has the same effect as using "ansi.sys" in DOS. # Looks best on a black background..... echo e "${CYAN}This is BASH ${RED}${BASH_VERSION%.*}\ ${CYAN} DISPLAY on ${RED}$DISPLAY${NC}\n" date if [ x /usr/games/fortune ]; then /usr/games/fortune s # makes our day a bit more fun.... :) fi function _exit() # function to run upon exit of shell { echo e "${RED}Hasta la vista, baby${NC}" } trap _exit EXIT # # Shell Prompt # if [[ "${DISPLAY#$HOST}" != ":0.0" && "${DISPLAY}" != ":0" ]]; then HILIT=${red} # remote machine: prompt will be partly red else HILIT=${cyan} # local machine: prompt will be partly cyan fi # > Replace instances of \W with \w in prompt functions below #+ > to get display of full path name. function fastprompt() { unset PROMPT_COMMAND case $TERM in *term | rxvt ) PS1="${HILIT}[\h]$NC \W > \[\033]0;\${TERM} [\u@\h] \w\007\]" ;; linux ) PS1="${HILIT}[\h]$NC \W > " ;; *) PS1="[\h] \W > " ;; esac } function powerprompt() { _powerprompt() { LOAD=$(uptime|sed e "s/.*: \([^,]*\).*/\1/" e "s/ //g") } PROMPT_COMMAND=_powerprompt case $TERM in *term | rxvt )

Appendix K. A Sample .bashrc File

652

Advanced BashScripting Guide

PS1="${HILIT}[\A \$LOAD]$NC\n[\h \#] \W > \ \[\033]0;\${TERM} [\u@\h] \w\007\]" ;; linux ) PS1="${HILIT}[\A \$LOAD]$NC\n[\h \#] \w > " ;; * ) PS1="[\A \$LOAD]\n[\h \#] \w > " ;; esac } powerprompt # This is the default prompt might be slow. # If too slow, use fastprompt instead.

#=============================================================== # # 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 bash2.04 # examples. # #=============================================================== # # Personnal Aliases # alias rm='rm i' alias cp='cp i' alias mv='mv i' # > Prevents accidentally clobbering files. alias mkdir='mkdir p' alias alias alias alias alias alias alias alias alias alias alias # The alias alias alias alias alias alias alias alias alias alias h='history' j='jobs l' r='rlogin' which='type all' ..='cd ..' path='echo e ${PATH//:/\\n}' print='/usr/bin/lp o nobanner d $LPDEST' # Assumes LPDEST is defined pjet='enscript h G fCourier9 d $LPDEST' # Prettyprint using enscript background='xv root quit max rmode 5' # Put a picture in the background du='du kh' df='df kTh' 'ls' family (this assumes la='ls Al' ls='ls hF color' lx='ls lXB' lk='ls lSr' lc='ls lcr' lu='ls lur' lr='ls lR' lt='ls ltr' lm='ls al |more' tree='tree Csu' you use the GNU ls) # show hidden files # add colors for filetype recognition # sort by extension # sort by size # sort by change time # sort by access time # recursive ls # sort by date # pipe through 'more' # nice alternative to 'ls'

Appendix K. A Sample .bashrc File

653

Advanced BashScripting Guide

# 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 z4 g e M X F R P%t?f%f \ :stdin .?pb%pb\%:?lbLine %lb:?bbByte %bb:...' # spelling typos highly personnal :) alias xs='cd' alias vf='cd' alias moer='more' alias moew='more' alias kk='ll' # # 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 () { for i ; do xtitle The $(basename $1|tr d .[:digit:]) manual command man F a "$i" done } function ll() { ls l "$@"| egrep "^d" ; ls lXB "$@" 2>&| egrep v "^d|total "; } function te() # wrapper around xemacs/gnuserv { if [ "$(gnuclient batch eval t 2>&)" == "t" ]; then gnuclient q "$@"; else ( xemacs "$@" &); fi } # # File & strings related functions: # # Find a file with a pattern in name:

Appendix K. A Sample .bashrc File

654

Advanced BashScripting Guide

function ff() { find . type f iname '*'$*'*' ls ; } # Find a file with pattern $1 in name and Execute $2 on it: function fe() { find . type f iname '*'$1'*' exec "${2:file}" {} \; # find pattern in a set of filesand highlight them: function fstr() { OPTIND=1 local case="" local usage="fstr: find string in files. Usage: fstr [i] \"pattern\" [\"filename pattern\"] " while getopts :it opt do case "$opt" in i) case="i " ;; *) echo "$usage"; return;; esac done shift $(( $OPTIND 1 )) if [ "$#" lt 1 ]; then echo "$usage" return; fi local SMSO=$(tput smso) local RMSO=$(tput rmso) find . type f name "${2:*}" print0 | xargs 0 grep sn ${case} "$1" 2>& | \ sed "s/$1/${SMSO}\0${RMSO}/gI" | more } function cuttail() # Cut last n lines in file, 10 by default. { nlines=${2:10} sed n e :a e "1,${nlines}!{P;N;D;};N;ba" $1 } function lowercase() # move filenames to lowercase { for file ; do filename=${file##*/} case "$filename" in */*) dirname==${file%/*} ;; *) dirname=.;; esac nf=$(echo $filename | tr AZ az) newname="${dirname}/${nf}" if [ "$nf" != "$filename" ]; then mv "$file" "$newname" echo "lowercase: $file > $newname" else echo "lowercase: $file not changed." fi done } function swap() # swap 2 filenames around { local TMPFILE=tmp.$$

; }

Appendix K. A Sample .bashrc File

655

Advanced BashScripting Guide

mv "$1" $TMPFILE mv "$2" "$1" mv $TMPFILE "$2" }

# # Process/system related functions: # function my_ps() { ps $@ u $USER o pid,%cpu,%mem,bsdtime,command ; } function pp() { my_ps f | awk '!/awk/ && $0~var' var=${1:".*"} ; } # This function is roughly the same as 'killall' on linux # but has no equivalent (that I know of) on Solaris function killps() # kill by process name { local pid pname sig="TERM" # default signal if [ "$#" lt 1 ] || [ "$#" gt 2 ]; then echo "Usage: killps [SIGNAL] pattern" return; fi if [ $# = 2 ]; then sig=$1 ; fi for pid in $(my_ps| awk '!/awk/ && $0~pat { print $1 }' pat=${!#} ) ; do pname=$(my_ps | awk '$1~var { print $5 }' var=$pid ) if ask "Kill process $pid <$pname> with signal $sig?" then kill $sig $pid fi done } function my_ip() # get IP adresses { MY_IP=$(/sbin/ifconfig ppp0 | awk '/inet/ { print $2 } ' | \ sed e s/addr://) MY_ISP=$(/sbin/ifconfig ppp0 | awk '/PtP/ { print $3 } ' | \ sed e s/PtP://) } function ii() # get current host related info { echo e "\nYou are logged on ${RED}$HOST" echo e "\nAdditionnal information:$NC " ; uname a echo e "\n${RED}Users logged on:$NC " ; w h echo e "\n${RED}Current date :$NC " ; date echo e "\n${RED}Machine stats :$NC " ; uptime echo e "\n${RED}Memory stats :$NC " ; free my_ip 2>& ; echo e "\n${RED}Local IP Address :$NC" ; echo ${MY_IP:"Not connected"} echo e "\n${RED}ISP Address :$NC" ; echo ${MY_ISP:"Not connected"} echo } # Misc utilities: function repeat() { local i max max=$1; shift; # repeat n times command

Appendix K. A Sample .bashrc File

656

Advanced BashScripting Guide

for ((i=1; i <= max ; i++)); do eval "$@"; done } function ask() { echo n "$@" '[y/n] ' ; read ans case "$ans" in y*|Y*) return 0 ;; *) return 1 ;; esac } #======================================================================= # # PROGRAMMABLE COMPLETION ONLY SINCE BASH2.04 # Most are taken from the bash 2.05 documentation and from Ian McDonalds # 'Bash completion' package # (http://www.caliban.org/bash/index.shtml#completion) # You will in fact need bash2.05a for some features # #======================================================================= if [ "${BASH_VERSION%.*}" \< "2.05" ]; then echo "You will need to upgrade to version 2.05 \ for programmable completion" return fi shopt s extglob set +o nounset complete complete complete complete complete complete complete complete complete complete complete A A A A A A A A A A A hostname export variable enabled alias function user # necessary # otherwise some completions will fail rsh rcp telnet rlogin r ftp ping disk printenv export local readonly unset builtin alias unalias function su mail finger # > Clike syntax

helptopic help # currently same as builtins shopt shopt stopped P '%' bg job P '%' fg jobs disown mkdir rmdir o default cd

complete A directory complete A directory

# Compression complete f o default X complete f o default X complete f o default X complete f o default X complete f o default X complete f o default X complete f o default X complete f o default X # Postscript,pdf,dvi..... complete f o default X complete f o default X complete f o default X

'*.+(zip|ZIP)' '!*.+(zip|ZIP)' '*.+(z|Z)' '!*.+(z|Z)' '*.+(gz|GZ)' '!*.+(gz|GZ)' '*.+(bz2|BZ2)' '!*.+(bz2|BZ2)'

zip unzip compress uncompress gzip gunzip bzip2 bunzip2

'!*.ps' gs ghostview ps2pdf ps2ascii '!*.dvi' dvips dvipdf xdvi dviselect dvitype '!*.pdf' acroread pdf2ps

Appendix K. A Sample .bashrc File

657

Advanced BashScripting Guide

complete f o complete f o complete f o complete f o complete f o # Multimedia complete f o complete f o complete f o default default default default default X X X X X '!*.+(pdf|ps)' gv '!*.texi*' makeinfo texi2dvi texi2html texi2pdf '!*.tex' tex latex slitex '!*.lyx' lyx '!*.+(htm*|HTM*)' lynx html2ps

default X '!*.+(jp*g|gif|xpm|png|bmp)' xv gimp default X '!*.+(mp3|MP3)' mpg123 mpg321 default X '!*.+(ogg|OGG)' ogg123

complete f o default X '!*.pl'

perl perl5

# This is a 'universal' completion function it works when commands have # a socalled 'long options' mode , ie: 'ls all' instead of 'ls a' _get_longopts () { $1 help | sed e '//!d' e 's/.*\([^[:space:].,]*\).*/\1/'| \ grep ^"$2" |sort u ; } _longopts_func () { case "${2:*}" in *) ;; *) return ;; esac case "$1" in \~*) eval cmd="$1" ;; *) cmd="$1" ;; esac COMPREPLY=( $(_get_longopts ${1} ${2} ) ) } complete complete o default F _longopts_func configure bash o default F _longopts_func wget id info a2ps ls recode

_make_targets () { local mdef makef gcmd cur prev i COMPREPLY=() cur=${COMP_WORDS[COMP_CWORD]} prev=${COMP_WORDS[COMP_CWORD1]} # if prev argument is f, return possible filename completions. # we could be a little smarter here and return matches against # `makefile Makefile *.mk', whatever exists case "$prev" in *f) COMPREPLY=( $(compgen f $cur ) ); return 0;; esac # if we want an option, return the possible posix options case "$cur" in ) COMPREPLY=(e f i k n p q r S s t); return 0;; esac # make reads `makefile' before `Makefile' if [ f makefile ]; then

Appendix K. A Sample .bashrc File

658

Advanced BashScripting Guide

mdef=makefile elif [ f Makefile ]; then mdef=Makefile else mdef=*.mk fi

# local convention

# before we scan for targets, see if a makefile name was specified # with f for (( i=0; i < ${#COMP_WORDS[@]}; i++ )); do if [[ ${COMP_WORDS[i]} == *f ]]; then eval makef=${COMP_WORDS[i+1]} # eval for tilde expansion break fi done [ z "$makef" ] && makef=$mdef # if we have a partial word to complete, restrict completions to # matches of that word if [ n "$2" ]; then gcmd='grep "^$2"' ; else gcmd=cat ; fi # 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 ) ) } complete F _make_targets X '+($*|*.[cho])' make gmake pmake

# cvs(1) completion _cvs () { local cur prev COMPREPLY=() cur=${COMP_WORDS[COMP_CWORD]} prev=${COMP_WORDS[COMP_CWORD1]} if [ $COMP_CWORD eq 1 ] || [ COMPREPLY=( $( compgen W export history import log tag update' $cur )) else COMPREPLY=( $( compgen f fi return 0 } complete F _cvs cvs _killall () { local cur prev COMPREPLY=() cur=${COMP_WORDS[COMP_CWORD]} # get a list of processes (the first sed evaluation # takes care of swapped out processes, the second # takes care of getting the basename of the process) COMPREPLY=( $( /usr/bin/ps u $USER o comm | \ sed e '1,1d' e 's#[]\[]##g' e 's#^.*/##'| \ "${prev:0:1}" = "" ]; then 'add admin checkout commit diff \ rdiff release remove rtag status \

$cur ))

Appendix K. A Sample .bashrc File

659

Advanced BashScripting Guide

awk '{if ($0 ~ /^'$cur'/) print $0}' )) return 0 } complete F _killall killall killps

# # # # # # #

A metacommand completion function for commands like sudo(8), which need to first complete on a command, then complete according to that command's own completion definition currently not quite foolproof (e.g. mount and umount don't work properly), but still quite useful By Ian McDonald, modified by me.

_my_command() { local cur func cline cspec COMPREPLY=() cur=${COMP_WORDS[COMP_CWORD]} if [ $COMP_CWORD = 1 ]; then COMPREPLY=( $( compgen c $cur ) ) elif complete p ${COMP_WORDS[1]} &>/dev/null; then cspec=$( complete p ${COMP_WORDS[1]} ) if [ "${cspec%%F *}" != "${cspec}" ]; then # complete F <function> # # COMP_CWORD and COMP_WORDS() are not readonly, # so we can set them before handing off to regular # completion routine # set current token number to 1 less than now COMP_CWORD=$(( $COMP_CWORD 1 )) # get function name func=${cspec#*F } func=${func%% *} # get current command line minus initial command cline="${COMP_LINE#$1 }" # split current command line tokens into array COMP_WORDS=( $cline ) $func $cline elif [ "${cspec#*[abcdefgjkvu]}" != "" ]; then # complete [abcdefgjkvu] #func=$( echo $cspec | sed e 's/^.*\([abcdefgjkvu]\).*$/\1/' ) func=$( echo $cspec | sed e 's/^complete//' e 's/[^ ]*$//' ) COMPREPLY=( $( eval compgen $func $cur ) ) elif [ "${cspec#*A}" != "$cspec" ]; then # complete A <type> func=${cspec#*A } func=${func%% *} COMPREPLY=( $( compgen A $func $cur ) ) fi else COMPREPLY=( $( compgen f $cur ) ) fi }

complete o default F _my_command nohup exec eval \

Appendix K. A Sample .bashrc File

660

Advanced BashScripting Guide

trace truss strace sotruss gdb complete o default F _my_command command type which man nice # # # # Local Variables: mode:shellscript shshell:bash End:

Appendix K. A Sample .bashrc File

661

Appendix L. Converting DOS Batch Files to Shell Scripts

Quite a number of programmers learned scripting on a PC running DOS. Even the crippled DOS batch file language allowed writing some fairly powerful scripts and applications, though they often required extensive kludges and workarounds. Occasionally, the need still arises to convert an old DOS batch file to a UNIX shell script. This is generally not difficult, as DOS batch file operators are only a limited subset of the equivalent shell scripting ones.

Table L1. Batch file keywords / variables / operators, and their shell equivalents Batch File Operator % / \ == !==! | @ * > >> < %VAR% REM NOT NUL ECHO ECHO. ECHO OFF FOR %%VAR IN (LIST) DO :LABEL GOTO PAUSE CHOICE IF Shell Script Equivalent $ / = != | set +v * > >> < $VAR # ! /dev/null echo echo set +v for var in [list]; do none (unnecessary) none (use a function) sleep case or select if Meaning commandline parameter prefix command option flag directory path separator (equalto) string comparison test (not equalto) string comparison test pipe do not echo current command filename "wild card" file redirection (overwrite) file redirection (append) redirect stdin environmental variable comment negate following test "black hole" for burying command output echo (many more option in Bash) echo blank line do not echo command(s) following "for" loop label jump to another location in the script pause or wait an interval menu choice iftest 662

Appendix L. Converting DOS Batch Files to Shell Scripts

Advanced BashScripting Guide test if file exists if replaceable parameter "N" not present CALL source or . (dot operator) "include" another script COMMAND /C source or . (dot operator) "include" another script (same as CALL) SET export set an environmental variable SHIFT shift left shift commandline argument list SGN lt or gt sign (of integer) ERRORLEVEL $? exit status CON stdin "console" (stdin) PRN /dev/lp0 (generic) printer device LPT1 /dev/lp0 first printer device COM1 /dev/ttyS0 first serial port 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. IF EXIST FILENAME IF !%N==! if [ e filename ] if [ z "$N" ]

Table L2. DOS commands and their UNIX equivalents DOS Command ASSIGN ATTRIB CD CHDIR CLS COMP COPY CtlC CtlZ DEL DELTREE DIR ERASE EXIT FC FIND MD MKDIR UNIX Equivalent ln chmod cd cd clear diff, comm, cmp cp CtlC CtlD rm rm rf ls l rm exit comm, cmp grep mkdir mkdir Effect link file or directory change file permissions change directory change directory clear screen file compare file copy break (signal) EOF (endoffile) delete file(s) delete directory recursively directory listing delete file(s) exit current process file compare find strings in files make directory make directory 663

Appendix L. Converting DOS Batch Files to Shell Scripts

Advanced BashScripting Guide MORE MOVE PATH REN RENAME RD RMDIR SORT TIME TYPE XCOPY more mv $PATH mv mv rmdir rmdir sort date cat cp text file paging filter move path to executables rename (move) rename (move) remove directory remove directory sort file display system time output file to stdout (extended) file copy

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. DOS supports a very limited and incompatible subset of filename wildcard expansion, recognizing only the * and ? characters. Converting a DOS batch file into a shell script is generally straightforward, and the result ofttimes reads better than the original.

Example L1. VIEWDATA.BAT: DOS Batch File

REM VIEWDATA REM INSPIRED BY AN EXAMPLE IN "DOS POWERTOOLS" REM BY PAUL SOMERSON

@ECHO OFF IF !%1==! GOTO VIEWDATA REM IF NO COMMANDLINE ARG... FIND "%1" C:\BOZO\BOOKLIST.TXT GOTO EXIT0 REM PRINT LINE WITH STRING MATCH, THEN EXIT. :VIEWDATA TYPE C:\BOZO\BOOKLIST.TXT | MORE REM SHOW ENTIRE FILE, 1 PAGE AT A TIME. :EXIT0

The script conversion is somewhat of an improvement.

Appendix L. Converting DOS Batch Files to Shell Scripts

664

Advanced BashScripting Guide Example L2. viewdata.sh: Shell Script Conversion of VIEWDATA.BAT
#!/bin/bash # viewdata.sh # Conversion of VIEWDATA.BAT to shell script. DATAFILE=/home/bozo/datafiles/bookcollection.data ARGNO=1 # @ECHO OFF if [ $# lt "$ARGNO" ] then less $DATAFILE else grep "$1" $DATAFILE fi exit 0 Command unnecessary here. # IF !%1==! GOTO VIEWDATA # TYPE C:\MYDIR\BOOKLIST.TXT | MORE # FIND "%1" C:\MYDIR\BOOKLIST.TXT

# :EXIT0

# GOTOs, labels, smokeandmirrors, and flimflam unnecessary. # The converted script is short, sweet, and clean, #+ which is more than can be said for the original.

Ted Davis' Shell Scripts on the PC site has a set of comprehensive tutorials on the oldfashioned art of batch file programming. Certain of his ingenious techniques could conceivably have relevance for shell scripts.

Appendix L. Converting DOS Batch Files to Shell Scripts

665

Appendix M. Exercises
M.1. Analyzing Scripts
Examine the following script. Run it, then explain what it does. Annotate the script and rewrite it in a more compact and elegant manner.
#!/bin/bash MAX=10000

for((nr=1; nr<$MAX; nr++)) do let "t1 = nr % 5" if [ "$t1" ne 3 ] then continue fi let "t2 = nr % 7" if [ "$t2" ne 4 ] then continue fi let "t3 = nr % 9" if [ "$t3" ne 5 ] then continue fi break done echo "Number = $nr" # What happens when you comment out this line? Why?

exit 0

Explain what the following script does. It is really just a parameterized commandline pipe.
#!/bin/bash DIRNAME=/usr/bin FILETYPE="shell script" LOGFILE=logfile file "$DIRNAME"/* | fgrep "$FILETYPE" | tee $LOGFILE | wc l exit 0

A reader sent in the following code snippet. Appendix M. Exercises 666

Advanced BashScripting Guide

while read LINE do echo $LINE done < `tail f /var/log/messages`

He wished to write a script tracking changes to the system log file, /var/log/messages. Unfortunately, the above code block hangs and does nothing useful. Why? Fix this so it does work. (Hint: rather than redirecting the stdin of the loop, try a pipe.) Analyze the following "oneliner" (here split into two lines for clarity) contributed by Rory Winston:
export SUM=0; for f in $(find src name "*.java"); do export SUM=$(($SUM + $(wc l $f | awk '{ print $1 }'))); done; echo $SUM

Hint: First, break the script up into bitesized sections. Then, carefully examine its use of doubleparentheses arithmetic, the export command, the find command, the wc command, and awk. Analyze Example A10, and reorganize it in a simplified and more logical style. See how many of the 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.

M.2. Writing Scripts

Write a script to carry out each of the following tasks. EASY Home Directory Listing 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. Selfreproducing Script Write a script that backs itself up, that is, copies itself to a file named backup.sh. Hint: Use the cat command and the appropriate positional parameter. Converting for loops to while and until loops Convert the for loops in Example 101 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 doublespacing the file.

Appendix M. Exercises

667

Advanced BashScripting Guide 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 triplespace the target file. Finally, write a script to remove all blank lines from the target file, singlespacing it. Backwards Listing Write a script that echoes itself to stdout, but backwards. Automatically Decompressing Files 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" 6digit 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/yourname) that have been modified in the last 24 hours. Hint: use find. Checking whether a process is still running Given a process ID (PID) as an argument, this script will check, at userspecified intervals, whether the given process is still running. You may use the ps and sleep commands. 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 Integer or String Write a script function that determines if an argument passed to it is an integer or a string. The function will return TRUE (0) if passed an integer, and FALSE (1) if passed a string. Hint: What does the following expression return when $1 is not an integer? expr $1 + 0 Managing Disk Space 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. Removing Inactive Accounts Inactive accounts on a network waste disk space and may become a security risk. Write an administrative script (to be invoked by root or the cron daemon) that checks for and deletes user accounts that have not been accessed within the last 90 days. Enforcing Disk Quotas

Appendix M. Exercises

668

Advanced BashScripting Guide Write a script for a multiuser system that checks users' disk usage. If a user surpasses the preset limit (100 MB, for example) in her /home/username directory, then the script will automatically send her a warning email. The script will use the du and mail commands. As an option, it will allow setting and enforcing quotas using the quota and setquota commands. Logged in User Information For all logged in users, show their real names and the time and date of their last login. Hint: use who, lastlog, and parse /etc/passwd. Safe Delete Write, as a script, a "safe" delete command, srm.sh. Filenames passed as commandline 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 238. 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 wellknown formula, x = ( B +/ sqrt( B^2 4AC ) ) / 2A. Sum of Matching Numbers Find the sum of all fivedigit 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. Some examples of matching numbers are 42057, 74638, and 89515. Lucky Numbers 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, easytoread tabular form. Logging Logins Parse /var/log/messages to produce a nicely formatted file of user logins and login times. The script may need to run as root. (Hint: Search for the string "LOGIN.") PrettyPrinting a Data File Certain database and spreadsheet packages use savefiles with commaseparated values (CSVs). Other applications often need to parse these files. Given a data file with commaseparated fields, of the form: Appendix M. Exercises 669

Advanced BashScripting Guide

Jones,Bill,235 S. Williams St.,Denver,CO,80221,(303) 2447989 Smith,Tom,404 Polk Ave.,Los Angeles,CA,90003,(213) 8795612 ...

Reformat the data and print it out to stdout in labeled, evenlyspaced columns. Justification Given ASCII text input either from stdin or a file, adjust the word spacing to rightjustify each line to a userspecified linewidth, then send the output to stdout. Mailing List Using the mail command, write a script that manages a simple mailing list. The script automatically emails the monthly company newsletter, read from a specified text file, and sends it to all the addresses on the mailing list, which the script reads from another specified file. Generating Passwords Generate pseudorandom 8character passwords, using characters in the ranges [09], [AZ], [az]. Each password must contain at least two digits. Checking for Broken Links Using lynx with the traversal option, write a script that checks a Web site for broken links. DIFFICULT Testing Passwords Write a script to check and validate passwords. The object is to flag "weak" or easily guessed password candidates. A trial password will be input to the script as a command line parameter. To be considered acceptable, a password must meet the following minimum qualifications: Minimum length of 8 characters Must contain at least one numeric character Must contain at least one of the following nonalphabetic characters: @, #, $, %, &, *, +, , = Optional: Do a dictionary check on every sequence of at least four consecutive alphabetic characters in the password under test. This will eliminate passwords containing embedded "words" found in a standard dictionary. Enable the script to check all the passwords on your system. These may or may not reside in /etc/passwd. This exercise tests mastery of Regular Expressions. Cross Reference Write a script that generates a crossreference (concordance) on a target file. The output will be a listing of all word occurrences in the target file, along with the line numbers in which each word occurs. Traditionally, linked list constructs would be used in such applications. Therefore, you should investigate arrays in the course of this exercise. Example 1511 is probably not a good place to start. Square Root Write a script to calculate square roots of numbers using Newton's Method. The algorithm for this, expressed as a snippet of Bash pseudocode is:
# (Isaac) Newton's Method for speedy extraction #+ of square roots. guess = $argument # $argument is the number to find the square root of.

Appendix M. Exercises

670

Advanced BashScripting Guide

# $guess is each successive calculated "guess" or trial solution #+ of the square root. # Our first "guess" at a square root is the argument itself. oldguess = 0 # $oldguess is the previous $guess. tolerance = .000001 # To how close a tolerance we wish to calculate. loopcnt = 0 # Let's keep track of how many times through the loop. # Some arguments will require more loop iterations than others.

while [ ABS( $guess $oldguess ) gt $tolerance ] # ^^^^^^^^^^^^^^^^^^^^^^^ Fix up syntax, of course. # #+ # #+ do oldguess = $guess # # # # # #+ #+ # #+ #+ # # Update $oldguess to previous $guess. "ABS" is a (floating point) function to find the absolute value of the difference between the two terms. So, as long as difference between current and previous trial solution (guess) exceeds the tolerance, keep looping.

======================================================= guess = ( $oldguess + ( $argument / $oldguess ) ) / 2.0 = 1/2 ( ($oldguess **2 + $argument) / $oldguess ) equivalent to: = 1/2 ( $oldguess + $argument / $oldguess ) that is, "averaging out" the trial solution and the proportion of argument deviation (in effect, splitting the error in half). This converges on an accurate solution with surprisingly few loop iterations . . . for arguments > $tolerance, of course. ======================================================= # Update loop counter.

(( loopcnt++ )) done

It's a simple enough recipe, and should be easy enough to convert into a working Bash script. The problem, though, is that Bash has no native support for floating point numbers. So, the script writer needs to use bc or possibly awk to convert the numbers and do the calculations. It gets rather messy . . . Logging File Accesses 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. Monitoring Processes Write a script to continually monitor all running processes and to keep track of how many child processes each parent spawns. If a process spawns more than five children, then the script sends an email to the system administrator (or root) with all relevant information, including the time, PID of the parent, PIDs of the children, etc. The script writes a report to a log file every ten minutes. 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 Appendix M. Exercises 671

Advanced BashScripting Guide Convert a given text file to HTML. This noninteractive 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 an XML file to both HTML and text format. Chasing Spammers Write a script that analyzes a spam email by doing DNS lookups on the IP addresses in the headers to identify the relay hosts as well as the originating ISP. The script will forward the unaltered spam message to the responsible ISPs. Of course, it will be necessary to filter out your own ISP's IP address, so you don't end up complaining about yourself. As necessary, use the appropriate network analysis commands. For some ideas, see Example 1537 and Example A28. Optional: Write a script that searches through a list of email messages and deletes the spam according to specified filters. Creating man pages Write a script that automates the process of creating man pages. Given a text file which contains information to be formatted into a man page, the script will read the file, then invoke the appropriate groff commands to output the corresponding man page to stdout. The text file contains blocks of information under the standard man page headings, i.e., "NAME," "SYNOPSIS," "DESCRIPTION," etc. See Example 1526. Morse Code 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:
Invoke the "morse.sh" script with "script" as an argument to convert to Morse.

$ sh morse.sh script ... _._. ._. .. .__. _ s c r i p t

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 4byte hex number, and the final field the ASCII equivalent of the previous 8 fields. The obvious followup to this is to extend the hex dump script into a disassembler. Using a lookup table, or some other clever gimmick, convert the hex values into 80x86 op codes. Emulating a Shift Register Using Example 2614 as an inspiration, write a script that emulates a 64bit shift register as an array. Implement functions to load the register, shift left, shift right, and rotate it. Finally, write a function Appendix M. Exercises 672

Advanced BashScripting Guide that interprets the register contents as eight 8bit ASCII characters. Determinant Solve a 4 x 4 determinant. Hidden Words Write a "wordfind" 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. Optional: Write a script that solves wordfind puzzles. To keep this from becoming too difficult, the solution script will find only horizontal and vertical words. (Hint: Treat each row and column as a string, and search for substrings.) Anagramming Anagram 4letter 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. Word Ladders A "word ladder" is a sequence of words, with each successive word in the sequence differing from the previous one by a single letter. For example, to "ladder" from mark to vase:
mark > park > part > past > vast > vase ^ ^ ^ ^ ^

Write a script that solves word ladder puzzles. Given a starting and an ending word, the script will list all intermediate steps in the "ladder." Note that all words in the sequence must be legitimate dictionary words. 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. 1. Choose a section of the text at least 100 words in length. 2. Count the number of sentences (a portion of a sentence truncated by the boundary of the text section counts as one). 3. Find the average number of words per sentence. AVE_WDS_SEN = TOTAL_WORDS / SENTENCES 4. Count the number of "difficult" words in the segment those containing at least 3 syllables. Divide this quantity by total words to get the proportion of difficult words. PRO_DIFF_WORDS = LONG_WORDS / TOTAL_WORDS 5. The Gunning fog index is the sum of the above two quantities, multiplied by 0.4, then rounded to the nearest integer. G_FOG_INDEX = int ( 0.4 * ( AVE_WDS_SEN + PRO_DIFF_WORDS ) ) 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 ruleofthumb formula might consider the number of letters in a word and the vowelconsonant 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. Appendix M. Exercises 673

Advanced BashScripting Guide Calculating PI using Buffon's Needle The Eighteenth Century French mathematician de Buffon came up with a novel experiment. Repeatedly drop a needle of length "n" onto a wooden floor composed of long and narrow parallel boards. The cracks separating the equalwidth floorboards are a fixed distance "d" apart. Keep track of the total drops and the number of times the needle intersects a crack on the floor. The ratio of these two quantities turns out to be a fractional multiple of PI. In the spirit of Example 1545, write a script that runs a Monte Carlo simulation of Buffon's Needle. To simplify matters, set the needle length equal to the distance between the cracks, n = d. Hint: there are actually two critical variables: the distance from the center of the needle to the crack nearest to it, and the angle of the needle to that crack. You may use bc to handle the calculations. Playfair Cipher Implement the Playfair (Wheatstone) Cipher in a script. The Playfair Cipher encrypts text by substitution of "digrams" (2letter groupings). It is traditional to use a 5 x 5 letter scrambledalphabet key square for the encryption and decryption.
C A I P V O B K Q W D F L R X E G M T Y S H N U 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, in order from left to right, skipping letters already used. To encrypt, separate the plaintext message into digrams (2letter groups). If a group has two identical letters, delete the second, and form a new group. If there is a single letter left over at the end, insert a "null" character, typically an "X." THIS IS A TOP SECRET MESSAGE TH IS IS AT OP SE CR ET ME SA GE For each digram, there are three possibilities. 1) Both letters will be on the same row of the key square For each letter, substitute the one immediately to the right, in that row. If necessary, wrap around left to the beginning of the row. or 2) Both letters will be in the same column of the key square For each letter, substitute the one immediately below it, in that row. If necessary, wrap around to the top of the column. 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.

The "TH" digram falls under case #3.

Appendix M. Exercises

674

Advanced BashScripting Guide

G H M N T U T > U H > G

(Rectangle with "T" and "H" at corners)

The "SE" digram falls under case #1. C O D E S (Row containing "S" and "E") S > C E > S (wraps around left to beginning of row)

========================================================================= To decrypt encrypted text, reverse the above procedure under cases #1 and #2 (move in opposite direction for substitution). Under case #3, just take the remaining two corners of the rectangle.

Helen Fouche Gaines' classic work, ELEMENTARY CRYPTANALYSIS (1939), gives a fairly detailed rundown on the Playfair Cipher and its solution methods.

This script will have three main sections I. Generating the "key square", based on a userinput keyword. II. Encrypting a "plaintext" message. III. Decrypting encrypted text. The script will make extensive use of arrays and functions. 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 M. Exercises

675

Appendix N. Revision History

This document first appeared as a 60page HOWTO in the late spring of 2000. Since then, it has gone through quite a number of updates and revisions. This book could not have been written without the assistance of the Linux community, and especially of the volunteers of the Linux Documentation Project.

Table N1. Revision History Release 0.1 0.2 0.3 0.4 0.5 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7 Date 14 Jun 2000 30 Oct 2000 12 Feb 2001 08 Jul 2001 03 Sep 2001 14 Oct 2001 06 Jan 2002 31 Mar 2002 02 Jun 2002 16 Jun 2002 13 Jul 2002 29 Sep 2002 05 Jan 2003 10 May 2003 21 Jun 2003 24 Aug 2003 14 Sep 2003 31 Oct 2003 03 Jan 2004 25 Jan 2004 15 Feb 2004 15 Mar 2004 18 Apr 2004 11 Jul 2004 03 Oct 2004 14 Nov 2004 06 Feb 2005 20 Mar 2005 08 May 2005 05 Jun 2005 28 Aug 2005 23 Oct 2005 Comments Initial release. Bugs fixed, plus much additional material and more example scripts. Major update. Complete revision and expansion of the book. Major update: Bugfixes, material added, sections reorganized. Stable release: Bugfixes, reorganization, material added. Bugfixes, material and scripts added. Bugfixes, material and scripts added. TANGERINE release: A few bugfixes, much more material and scripts added. MANGO release: A number of typos fixed, more material and scripts. PAPAYA release: A few bugfixes, much more material and scripts added. POMEGRANATE release: Bugfixes, more material, one more script. COCONUT release: A couple of bugfixes, more material, one more script. BREADFRUIT release: A number of bugfixes, more scripts and material. PERSIMMON release: Bugfixes, and more material. GOOSEBERRY release: Major update. HUCKLEBERRY release: Bugfixes, and more material. CRANBERRY release: Major update. STRAWBERRY release: Bugfixes and more material. MUSKMELON release: Bugfixes. STARFRUIT release: Bugfixes and more material. SALAL release: Minor update. MULBERRY release: Minor update. ELDERBERRY release: Minor update. LOGANBERRY release: Major update. BAYBERRY release: Bugfix update. BLUEBERRY release: Minor update. RASPBERRY release: Bugfixes, much material added. TEABERRY release: Bugfixes, stylistic revisions. BOXBERRY release: Bugfixes, some material added. POKEBERRY release: Bugfixes, some material added. WHORTLEBERRY release: Bugfixes, some material added. 676

Appendix N. Revision History

Advanced BashScripting Guide 3.8 3.9 4.0 4.1 4.2 26 Feb 2006 15 May 2006 18 Jun 2006 08 Oct 2006 10 Dec 2006 BLAEBERRY release: Bugfixes, some material added. SPICEBERRY release: Bugfixes, some material added. WINTERBERRY release: Major reorganization. WAXBERRY release: Minor update. SPARKLEBERRY release: Important update.

Appendix N. Revision History

677

Appendix O. Mirror Sites

The latest update of this document, as an archived "tarball" including both the SGML source and rendered HTML, may be downloaded from the author's home site. The main mirror site for this document is the Linux Documentation Project, which maintains many other Guides and HOWTOs as well. Sunsite/Metalab/ibiblio.org also mirrors the ABS Guide. Yet another mirror site for this document is morethan.org.

Appendix O. Mirror Sites

678

Appendix P. To Do List
A comprehensive survey of incompatibilities between Bash and the classic Bourne shell. Same as above, but for the Korn shell (ksh). A primer on CGI programming, using Bash. Here's a simple CGI script to get you started.

Example P1. Print the server environment

#!/bin/bash # May have to change the location for your site. # (At the ISP's servers, Bash may not be in the usual place.) # Other places: /usr/bin or /usr/local/bin # Might even try it without any path in shabang. # testcgi.sh # by Michael Zick # Used with permission

# Disable filename globbing. set f # Header tells browser what to expect. echo Contenttype: text/plain echo echo CGI/1.0 test script report: echo echo environment settings: set echo echo whereis bash? whereis bash echo

echo who are we? echo ${BASH_VERSINFO[*]} echo echo argc is $#. argv is "$*". echo # CGI/1.0 expected environment variables. echo echo echo echo echo echo echo echo echo SERVER_SOFTWARE = $SERVER_SOFTWARE SERVER_NAME = $SERVER_NAME GATEWAY_INTERFACE = $GATEWAY_INTERFACE SERVER_PROTOCOL = $SERVER_PROTOCOL SERVER_PORT = $SERVER_PORT REQUEST_METHOD = $REQUEST_METHOD HTTP_ACCEPT = "$HTTP_ACCEPT" PATH_INFO = "$PATH_INFO" PATH_TRANSLATED = "$PATH_TRANSLATED"

Appendix P. To Do List

679

Advanced BashScripting Guide

echo echo echo echo echo echo echo echo SCRIPT_NAME = "$SCRIPT_NAME" QUERY_STRING = "$QUERY_STRING" REMOTE_HOST = $REMOTE_HOST REMOTE_ADDR = $REMOTE_ADDR REMOTE_USER = $REMOTE_USER AUTH_TYPE = $AUTH_TYPE CONTENT_TYPE = $CONTENT_TYPE CONTENT_LENGTH = $CONTENT_LENGTH

exit 0 # Here document to give short instructions. :<<'_test_CGI_' 1) Drop this in your http://domain.name/cgibin directory. 2) Then, open http://domain.name/cgibin/testcgi.sh. _test_CGI_

Any volunteers?

Appendix P. To Do List

680

Appendix Q. Copyright
The Advanced Bash Scripting Guide is copyright 2000, by Mendel Cooper. The author also asserts copyright on all previous versions of this document. [98] This blanket copyright recognizes and protects the rights of all contributors to this document. 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.
A. Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. HOWEVER, in the event that the author or maintainer of this document cannot be contacted, the Linux Documentation Project will have the right to take over custodianship of the document and name a new maintainer, who would then have the right to update and modify the document. This document may NOT be distributed encrypted or with any form of DRM (Digital Rights Management) embedded in it. Nor may this document be bundled with other DRMed works. Distribution of the work or derivative of the work in any standard (paper) book form is prohibited unless prior permission is obtained from the copyright holder.

B.

C.

Provision A, above, explicitly prohibits relabeling this document. An example of relabeling is the insertion of company logos or navigation bars into the cover, title page, or the text. The author grants the following exemptions. 1. Nonprofit organizations, such as the Linux Documentation Project and Sunsite. 2. "Pureplay" Linux distributors, such as Debian, Red Hat, Mandrake, SuSE, and others. Without explicit written permission from the author, distributors and publishers (including online publishers) are prohibited from imposing any additional conditions, strictures, or provisions on this document or any previous version of it. As of this update, the author asserts that he has not entered into any contractual obligations that would alter the foregoing declarations. 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." If you display or distribute this document or any previous version thereof under any license except the one above, then you are required to obtain the author's written permission. Failure to do so may terminate your distribution rights. 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 classroom and instructional purposes. Certain of the scripts contained in this document are, where noted, released into the Public Domain. These scripts are exempt from the foregoing license and copyright restrictions. The commercial print and other rights to this book are available. Please contact the author if interested.

Appendix Q. Copyright

681

Advanced BashScripting Guide The author produced this book in a manner consistent with the spirit of the LDP Manifesto.

Linux is a trademark registered to Linus Torvalds. Unix and UNIX are trademarks registered to the Open Group. MS Windows is a trademark registered to the Microsoft Corp. Solaris is a trademark registered to Sun, Inc. OSX is a trademark registered to Apple, Inc. Yahoo is a trademark registered to Yahoo, Inc. Pentium is a trademark registered to Intel, Inc. Thinkpad is a trademark registered to Lenovo, Inc. Scrabble is a trademark registered to Hasbro, Inc. All other commercial trademarks mentioned in the body of this work are registered to their respective owners. Hyun Jin Cha has done a Korean translation of version 1.0.11 of this book. Spanish, Portuguese, French, (another French), German, Italian, Russian, Czech, Chinese, and Dutch translations are also available or in progress. 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. Notes [1] [2] [3] These are referred to as builtins, features internal to the shell. Many of the features of ksh88, and even a few from the updated ksh93 have been merged into Bash. By convention, userwritten shell scripts that are Bourne shell compliant generally take a name with a .sh extension. System scripts, such as those found in /etc/rc.d, do not conform to this nomenclature. Some flavors of UNIX (those based on 4.2 BSD) allegedly take a fourbyte magic number, requiring a blank after the ! #! /bin/sh. However, according to Sven Mascheck, this is probably a myth. 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. If, in fact, the script includes an extra #! line, then bash will interpret it as a comment.
#!/bin/bash echo "Part 1 of script." a=1 #!/bin/bash # This does *not* launch a new script.

[4] [5]

Appendix Q. Copyright

682

Advanced BashScripting Guide

echo "Part 2 of script." echo $a # Value of $a stays at 1.

[6]

This allows some cute tricks.

#!/bin/rm # Selfdeleting script. # Nothing much seems to happen when you run this... except that the file disappears. WHATEVER=65 echo "This line will never print (betcha!)." exit $WHATEVER # Doesn't matter. The script will not exit here. # Try an echo $? after script termination. # You'll get a 0, not a 65.

Also, try starting a README file with a #!/bin/more, and making it executable. The result is a selflisting documentation file. (A here document using cat is possibly a better alternative see Example 183). [7] Portable Operating System Interface, an attempt to standardize UNIXlike OSes. The POSIX specifications are listed on the Open Group site. [8] If Bash is your default shell, then the #! isn't necessary at the beginning of a script. However, if launching a script from a different shell, such as tcsh, then you will need the #!. [9] Caution: invoking a Bash script by sh scriptname turns off Bashspecific extensions, and the script may therefore fail to execute. [10] A script needs read, as well as execute permission for it to run, since the shell needs to be able to read it. [11] 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 by default included in a user's $PATH. It is therefore necessary to explicitly invoke the script in the current directory with a ./scriptname. [12] A PID, or process ID, is a number assigned to a running process. The PIDs of running processes may be viewed with a ps command.

Definition: A process is an executing program, sometimes referred to as a job. [13] The shell does the brace expansion. The command itself acts upon the result of the expansion. [14] Exception: a code block in braces as part of a pipe may run as a subshell.
ls | { read firstline; read secondline; } # Error. The code block in braces runs as a subshell, #+ so the output of "ls" cannot be passed to variables within the block. echo "First line is $firstline; second line is $secondline" # Will not work. # Thanks, S.C.

[15] A linefeed ("newline") is also a whitespace character. This explains why a blank line, consisting only of a linefeed, is considered whitespace. [16] The process calling the script sets the $0 parameter. By convention, this parameter is the name of the script. See the manpage for execv. [17] Appendix Q. Copyright 683

Advanced BashScripting Guide Unless there is a file named first in the current working directory. Yet another reason to quote. (Thank you, Harald Koenig, for pointing this out. [18] It also has sideeffects on the value of the variable (see below) [19] Encapsulating "!" within double quotes gives an error when used from the command line. This is interpreted as a history command. Within a script, though, this problem does not occur, since the Bash history mechanism is disabled then. Of more concern is the apparently inconsistent behavior of "\" within double quotes.
bash$ echo hello\! hello! bash$ echo "hello\!" hello\!

bash$ echo e x\ty xty bash$ echo e "x\ty" x y

What happens is that double quotes normally escape the "\" escape character, so that it echoes literally. However, the e option to echo changes that. It causes the "\t" to be interpreted as a tab. (Thank you, Wayne Pollock, for pointing this out, and Geoff Lee for explaining it.) [20] "Word splitting", in this context, means dividing a character string into a number of separate and discrete arguments. [21] Per the 1913 edition of Webster's Dictionary:
Deprecate . . . To to to to to to pray against, as an evil; seek to avert by prayer; desire the removal of; seek deliverance from; express deep regret for; disapprove of strongly.

[22] Be aware that suid binaries may open security holes. The suid flag has no effect on shell scripts. [23] On modern UNIX systems, the sticky bit is no longer used for files, only on directories. [24] 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). [25] The PID of the currently running script is $$, of course. [26] Somewhat analogous to recursion, in this context nesting refers to a pattern embedded within a larger pattern. One of the definitions of nest, according to the 1913 edition of Webster's Dictionary, illustrates this beautifully: "A collection of boxes, cases, or the like, of graduated size, each put within the one next larger." [27] Appendix Q. Copyright 684

Advanced BashScripting Guide The words "argument" and "parameter" are often used interchangeably. In the context of this document, they have the same precise meaning: a variable passed to a script or function. This applies to either commandline arguments or parameters passed to a function. If $parameter is null in a noninteractive script, it will terminate with a 127 exit status (the Bash error code for "command not found"). True "randomness," insofar as it exists at all, can only be found in certain incompletely understood natural phenomena such as radioactive decay. Computers can only simulate randomness, and computergenerated sequences of "random" numbers are therefore referred to as pseudorandom. The seed of a computergenerated pseudorandom number series can be considered an identification label. For example, think of the pseudorandom series with a seed of 23 as series #23. A property of a pseurandom number series is the length of the cycle before it starts repeating itself. A good pseurandom generator will produce series with very long cycles. Iteration: Repeated execution of a command or group of commands while a given condition holds, or until a given condition is met. These are shell builtins, whereas other loop commands, such as while and case, are keywords. For purposes of command substitution, a command may be an external system command, an internal scripting builtin, or even a script function. In a more technically correct sense, command substitution extracts the stdout of a command, then assigns it to a variable using the = operator. In fact, nesting with backticks is also possible, but only by escaping the inner backticks, as John Default points out.
word_count=` wc w \`ls l | awk '{print $9}'\` `

[28] [29] [30]

[31]

[32] [33] [34] [35] [36]

[37] An exception to this is the time command, listed in the official Bash documentation as a keyword. [38] 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. [39] Technically, an exit only terminates the process (or shell) in which it is running, not the parent process. [40] Unless the exec is used to reassign file descriptors. [41] Hashing is a method of creating lookup keys for data stored in a table. The data items themselves are "scrambled" to create keys, using one of a number of simple mathematical algorithms (methods, or recipes). An advantage of hashing is that it is fast. A disadvantage is that "collisions" where a single key maps to more than one data item are possible. For examples of hashing see Example A21 and Example A22. [42] The readline library is what Bash uses for reading input in an interactive shell. [43] The C source for a number of loadable builtins is typically found in the /usr/share/doc/bash?.??/functions directory. Note that the f option to enable is not portable to all systems. [44] The same effect as autoload can be achieved with typeset fu. [45] Dotfiles are files whose names begin with a dot, such as ~/.Xdefaults. Such filenames do not appear in a normal ls listing (although an ls a will show them), and they cannot be deleted by an Appendix Q. Copyright 685

Advanced BashScripting Guide accidental rm rf *. Dotfiles are generally used as setup and configuration files in a user's home directory. And even when xargs is not strictly necessary, it can speed up execution of a command involving batchprocessing of multiple files. This is only true of the GNU version of tr, not the generic version often found on commercial UNIX systems. An archive, in the sense discussed here, is simply a set of related files stored in a single location. A tar czvf archive_name.tar.gz * will include dotfiles in directories below the current working directory. This is an undocumented GNU tar "feature". 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 wellknown example. Creates a temporary directory when invoked with the d option. 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 wander about behind the scenes, silently carrying out their appointed tasks. This is actually a script adapted from the Debian Linux distribution. The print queue is the group of jobs "waiting in line" to be printed. For an excellent overview of this topic, see Andy Vaught's article, Introduction to Named Pipes, in the September, 1997 issue of Linux Journal. EBCDIC (pronounced "ebbsidick") 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.
cat $file | dd conv=swab,ebcdic > $file_encrypted # Encode (looks like gibberish). # Might as well switch bytes (swab), too, for a little extra obscurity. cat $file_encrypted | dd conv=swab,ascii > $file_plaintext # Decode.

[46] [47] [48] [49] [50] [51] [52]

[53] [54] [55] [56]

[57] A macro is a symbolic constant that expands into a command string or a set of operations on parameters. [58] This is the case on a Linux machine or a UNIX system with disk quotas. [59] The userdel command will fail if the particular user being deleted is still logged on. [60] For more detail on burning CDRs, see Alex Withers' article, Creating CDs, in the October, 1999 issue of Linux Journal. [61] The c option to mke2fs also invokes a check for bad blocks. [62] Since only root has write permission in the /var/lock directory, a user script cannot set a lock file there. [63] Operators of singleuser Linux systems generally prefer something simpler for backups, such as tar. [64] NAND is the logical notand operator. Its effect is somewhat similar to subtraction. [65] The killall system script should not be confused with the killall command in /usr/bin. [66] 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. Appendix Q. Copyright 686

Advanced BashScripting Guide

#!/bin/bash sed e 'N;s/.*/[&]/' << EOF line1 line2 EOF # OUTPUT: # [line1 # line2] # Here Document

echo awk '{ $0=$1 "\n" $2; if (/line.1/) {print}}' << EOF line 1 line 2 EOF # OUTPUT: # line # 1

# Thanks, S.C. exit 0

[67] Filename expansion means expanding filename patterns or templates containing special characters. For example, example.??? might expand to example.001 and/or example.txt. [68] Filename expansion can match dotfiles, but only if the pattern explicitly includes the dot as a literal character.
~/[.]bashrc ~/?bashrc # # # #+ # # # Will not expand to ~/.bashrc Neither will this. Wild cards and metacharacters will NOT expand to a dot in globbing. Will expand to ~/.bashrc Likewise. Likewise.

~/.[b]ashrc ~/.ba?hrc ~/.bashr*

# Setting the "dotglob" option turns this off. # Thanks, S.C.

[69] 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. [70] 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 email, SUBJECT: RE: File descriptor 5 is held open). Best leave this particular fd alone. [71] An external command invoked with an exec does not (usually) fork off a subprocess / subshell. [72] This has the same effect as a named pipe (temp file), and, in fact, named pipes were at one time used in process substitution. [73] The return command is a Bash builtin. [74] Herbert Mayer defines recursion as ". . . expressing an algorithm by using a simpler version of that same algorithm . . ." A recursive function is one that calls itself. [75] Too many levels of recursion may crash a script with a segfault. Appendix Q. Copyright 687

Advanced BashScripting Guide

#!/bin/bash # # Warning: Running this script could possibly lock up your system! If you're lucky, it will segfault before using up all available memory.

recursive_function () { echo "$1" # Makes the function do something, and hastens the segfault. (( $1 < $2 )) && recursive_function $(( $1 + 1 )) $2; # As long as 1st parameter is less than 2nd, #+ increment 1st and recurse. } recursive_function 1 50000 # Recurse 50,000 levels! # Most likely segfaults (depending on stack size, set by ulimit m). # Recursion this deep might cause even a C program to segfault, #+ by using up all the memory allotted to the stack.

echo "This will probably not print." exit 0 # This script will not exit normally. # Thanks, Stphane Chazelas.

[76] However, aliases do seem to expand positional parameters. [77] The entries in /dev provide mount points for physical and virtual devices. These entries use very little drive space. Some devices, such as /dev/null, /dev/zero, and /dev/urandom are virtual. They are not actual physical devices and exist only in software. [78] 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. [79] Of course, the mount point /mnt/flashdrive must exist. If not, then, as root, mkdir /mnt/flashdrive. To actually mount the drive, use the following command: mount /mnt/flashdrive Newer Linux distros automount flash drives in the /media directory. A socket is a communications node associated with a specific I/O port. (This is analogous to a hardware socket, or receptacle, for a connecting cable.) It permits data transfer between hardware devices on the same machine, between machines on the same network, between machines across different networks, and, of course, between machines at different locations on the Internet. Certain system commands, such as procinfo, free, vmstat, lsdev, and uptime do this as well. Rocky Bernstein's Bash debugger partially makes up for this lack. By convention, signal 0 is assigned to exit. Setting the suid permission on the script itself has no effect. In this context, "magic numbers" have an entirely different meaning than the magic numbers used to designate file types. Quite a number of Linux utilities are, in fact, shell wrappers. Some examples are /usr/bin/pdf2ps, /usr/bin/batch, and /usr/X11R6/bin/xmkmf.

[80]

[81] [82] [83] [84] [85] [86] [87]

Appendix Q. Copyright

688

Advanced BashScripting Guide ANSI is, of course, the acronym for the American National Standards Institute. This august body establishes and maintains various technical and industrial standards. See Marius van Oers' article, Unix Shell Scripting Malware, and also the Denning reference in the bibliography. Chet Ramey promises associative arrays (a Perl feature) in a future Bash release. As of version 3, this has not yet happened. This is the notorious flog it to death technique. In fact, the author is a school dropout and has no credentials or qualifications. Those who can, do. Those who can't . .. get an MCSE. Emails from certain spaminfested TLDs (61, 202, 211, 218, 220, etc.) will be trapped by spam filters and deleted unread. If your ISP is located on one of these, please use a Webmail account to contact the author. If no address range is specified, the default is all lines. Out of range exit values can result in unexpected exit codes. An exit value greater than 255 returns an exit code modulo 256. For example, exit 3809 gives an exit code of 225 (3809 % 256 = 225). This does not apply to csh, tcsh, and other shells not related to or descended from the classic Bourne shell (sh). Some early UNIX systems had a fast, smallcapacity fixed disk (containing /, the root partition), and a second drive which was larger, but slower (containing /usr and other partitions). The most frequently used programs and utilities therefore resided on the smallbutfast drive, in /bin, and the others on the slower drive, in /usr/bin.

[88] [89] [90] [91] [92] [93]

[94] [95] [96] [97]

This likewise accounts for the split between /sbin and /usr/sbin, /lib and /usr/lib, etc. [98] The author intends that this book be released into the Public Domain after a period of 14 years, that is, in 2014. In the early years of the American republic this was the duration statutorily granted to a copyrighted work.

Appendix Q. Copyright

689