BASH Programming - Introduction HOW-To
BASH Programming - Introduction HOW-To
BASH Programming - Introduction HOW-To
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
1. Introduction
1.1 Getting the latest version 1.2 Requisites 1.3 Uses of this document
4. Pipes
4.1 What they are and why you'll want to use them 4.2 Sample: simple pipe with sed 4.3 Sample: an alternative to ls -l *.txt
5. Variables
5.1 Sample: Hello World! using variables 5.2 Sample: A very simple backup script (little bit better) 5.3 Local variables
6. Conditionals
6.1 Dry Theory 6.2 Sample: Basic conditional example if .. then 6.3 Sample: Basic conditional example if .. then ... else
1 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
8. Functions
8.1 Functions sample 8.2 Functions with parameters sample
9. User interfaces
9.1 Using select to make simple menus 9.2 Using the command line
10. Misc
10.1 Reading user input with read 10.2 Arithmetic evaluation 10.3 Finding bash 10.4 Getting the return value of a program 10.5 Capturing a commands output 10.6 Multiple source files
11. Tables
11.1 String comparison operators 11.2 String comparison examples 11.3 Arithmetic operators 11.4 Arithmetic relational operators 11.5 Useful commands
2 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
1.2 Requisites
Familiarity with GNU/Linux command lines, and familiarity with basic programming concepts is helpful. While this is not a programming introduction, it explains (or at least tries) many basic concepts.
This script has only two lines. The first indicates the system which program to use to run the file. The second line is the only action performed by this script, which prints 'Hello World' on the terminal. If you get something like ./hello.sh: Command not found. Probably the first line '#!/bin/bash' is wrong, issue whereis bash or see 'finding bash' to see how sould you write this line.
3 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
In this script, instead of printing a message on the terminal, we create a tar-ball of a user's home directory. This is NOT intended to be used, a more useful backup script is presented later in this document.
1 'represents' stdout and 2 stderr. A little note for seeing this things: with the less command you can view both stdout (which will remain on the buffer) and the stderr that will be printed on the screen, but erased as you try to 'browse' the buffer.
Here, a file called 'ls-l.txt' will be created and it will contain what you would see on the screen if you type the command 'ls -l' and execute it.
Here, a file called 'grep-errors.txt' will be created and it will contain what you would see the stderr portion of the output of the 'grep da *' command.
Here, the stdout portion of the command is sent to stderr, you may notice that in differen ways.
4 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
Here, the stderr portion of the command is sent to stdout, if you pipe to less, you'll see that lines that normally 'dissapear' (as they are written to stderr) are being kept now (because they're on stdout).
This (thinking on the cron entry) will delete every file called 'core' in any directory. Notice that you should be pretty sure of what a command is doing if you are going to wipe it's output.
4. Pipes
This section explains in a very simple and practical way how to use pipes, nd why you may want it.
4.1 What they are and why you'll want to use them
Pipes let you use (very simple, I insist) the output of a program as the input of another one
Here, the following happens: first the command ls -l is executed, and it's output, instead of being printed, is sent (piped) to the sed program, which in turn, prints what it has to.
Here, the output of the program ls -l is sent to the grep program, which, in turn, will print lines which match the regex "\.txt$".
5. Variables
5 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
You can use variables as in any programming languages. There are no data types. A variable in bash can contain a number, a character, a string of characters. You have no need to declare a variable, just assigning a value to its reference will create it.
Line 2 creates a variable called STR and assigns the string "Hello World!" to it. Then the VALUE of this variable is retrieved by putting the '$' in at the beginning. Please notice (try it!) that if you don't use the '$' sign, the output of the program will be different, and probably not what you want it to be.
This script introduces another thing. First of all, you should be familiarized with the variable creation and assignation on line 2. Notice the expression '$(date +%Y%m%d)'. If you run the script you'll notice that it runs the command inside the parenthesis, capturing its output. Notice that in this script, the output filename will be different every day, due to the format switch to the date command(+%Y%m%d). You can change this by specifying a different format. Some more examples: echo ls echo $(ls)
6. Conditionals
Conditionals let you decide whether to perform an action or not, this decision is taken by evaluating an expression.
6 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
The code to be executed if the expression within braces is true can be found after the 'then' word and before 'fi' which indicates the end of the conditionally executed code.
7 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
On the second line, we declare i to be the variable that will take the different values contained in $( ls ). The third line could be longer if needed, or there could be more lines before the done (4). 'done' (4) indicates that the code that used the value of $i has finished and $i can take a new value. This script has very little sense, but a more useful way to use the for loop would be to use it to match only certain files on the previous example
This script 'emulates' the well known (C, Pascal, perl, etc) 'for' structure
8 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
#!/bin/bash COUNTER=20 until [ $COUNTER -lt 10 ]; do echo COUNTER $COUNTER let COUNTER-=1 done
8. Functions
As in almost any programming language, you can use functions to group pieces of code in a more logical way or practice the divine art of recursion. Declaring a function is just a matter of writing function my_func { my_code }. Calling a function is just like calling another program, you just write its name.
Lines 2-4 contain the 'quit' function. Lines 5-7 contain the 'hello' function If you are not absolutely sure about what this script does, please try it!. Notice that a functions don't need to be declared in any specific order. When running the script you'll notice that first: the function 'hello' is called, second the 'quit' function, and the program never reaches line 10.
This script is almost identically to the previous one. The main difference is the funcion 'e'. This function, prints the first argument it receives. Arguments, within funtions, are treated in the same manner as arguments given to the script.
9 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
If you run this script you'll see that it is a programmer's dream for text based menus. You'll probably notice that it's very similar to the 'for' construction, only rather than looping for each 'word' in $OPTIONS, it prompts the user.
What this script does should be clear to you. The expression in the first conditional tests if the program has received an argument ($1) and quits if it didn't, showing the user a little usage message. The rest of the script should be clear at this point.
As a variant, you can get multiple values with read, this example may clarify this.
#!/bin/bash echo Please, enter your firstname and lastname read FN LN echo "Hi! $LN, $FN !"
10 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
11 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
This illustrates how to capture the return value of a program, I assume that the directory dada does not exist. (This was also suggested by mike)
#!/bin/bash cd /dada &> /dev/null echo rv: $? cd $(pwd) &> /dev/null echo rv: $?
12 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
I quote here a note from a mail, sent buy Andreas Beck, refering to use if [ $1 = $2 ]. This is not quite a good idea, as if either $S1 or $S2 is empty, you will get a parse error. x$1=x$2 or "$1"="$2" is better.
13 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
sed (stream editor) Sed is a non-interactive editor. Instead of altering a file by moving the cursor on the screen, you use a script of editing instructions to sed, plus the name of the file to edit. You can also describe sed as a filter. Let's have a look at some examples:
$sed 's/to_be_replaced/replaced/g' /tmp/dummy
Sed replaces the string 'to_be_replaced' with the string 'replaced' and reads from the /tmp/dummy file. The result will be sent to stdout (normally the console) but you can also add '> capture' to the end of the line above so that sed sends the output to the file 'capture'.
$sed 12, 18d /tmp/dummy
Sed shows all lines except lines 12 to 18. The original file is not altered by this command. awk (manipulation of datafiles, text retrieval and processing) Many implementations of the AWK programming language exist (most known interpreters are GNU's gawk and 'new awk' mawk.) The principle is simple: AWK scans for a pattern, and for every matching pattern a action will be performed. Again, I've created a dummy file containing the following lines: "test123 test tteesstt"
$awk '/test/ {print}' /tmp/dummy
test123 test The pattern AWK looks for is 'test' and the action it performs when it found a line in the file /tmp/dummy with the string 'test' is 'print'.
$awk '/test/ {i=i+1} END {print i}' /tmp/dummy
3 When you're searching for many patterns, you should replace the text between the quotes with '-f file.awk' so you can put all patterns and actions in 'file.awk'. grep (print lines matching a search pattern) We've already seen quite a few grep commands in the previous chapters, that display the lines matching a pattern. But grep can do more.
$grep "look for this" /var/log/messages -c
12 The string "look for this" has been found 12 times in the file /var/log/messages.
14 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
[ok, this example was a fake, the /var/log/messages was tweaked :-)] wc (counts lines, words and bytes) In the following example, we see that the output is not what we expected. The dummy file, as used in this example, contains the following text: "bash introduction howto test file"
$wc --words --lines --bytes /tmp/dummy
2 5 34 /tmp/dummy Wc doesn't care about the parameter order. Wc always prints them in a standard order, which is, as you can see: . sort (sort lines of text files) This time the dummy file contains the following text: "b c a"
$sort /tmp/dummy
This is what the output looks like: a b c Commands shouldn't be that easy :-) bc (a calculator programming language) Bc is accepting calculations from command line (input from file. not from redirector or pipe), but also from a user interface. The following demonstration shows some of the commands. Note that I start bc using the -q parameter to avoid a welcome message.
$bc -q
15 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
sqrt(9) 3 while (i != 9) { i = i + 1; print i } 123456789 quit tput (initialize a terminal or query terminfo database) A little demonstration of tput's capabilities:
$tput cup 10 4
Clears screen and prompt appears at (y1,x1). Note that (y0,x0) is the upper left corner.
$tput cols
80 Shows the number of characters possible in x direction. It it higly recommended to be familiarized with these programs (at least). There are tons of little programs that will let you do real magic on the command line. [some samples are taken from man pages or FAQs]
12. More Scripts 12.1 Applying a command to all files in a directory. 12.2 Sample: A very simple backup script (little bit better)
#!/bin/bash SRCD="/home/" TGTD="/var/backups/" OF=home-$(date +%Y%m%d).tgz tar -cZf $TGTD$OF $SRCD
16 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
#!/bin/sh # renna: rename multiple files according to several rules # written by felix hudson Jan - 2000 #first check for the various 'modes' that this program has #if the first ($1) condition matches then we execute that portion of the #program and then exit # check for the prefix condition if [ $1 = p ]; then #we now get rid of the mode ($1) variable and prefix ($2) prefix=$2 ; shift ; shift # a quick check to see if any files were given # if none then its better not to do anything than rename some non-existent # files!! if [$1 = ]; then echo "no files given" exit 0 fi # this for loop iterates through all of the files that we gave the program # it does one rename per file given for file in $* do mv ${file} $prefix$file done #we now exit the program exit 0 fi # check for a suffix rename # the rest of this part is virtually identical to the previous section # please see those notes if [ $1 = s ]; then suffix=$2 ; shift ; shift if [$1 = ]; then echo "no files given" exit 0 fi for file in $* do mv ${file} $file$suffix done exit 0 fi # check for the replacement rename if [ $1 = r ]; then shift # i included this bit as to not damage any files if the user does not specify # anything to be done # just a safety measure if [ $# -lt 3 ] ; then echo "usage: renna r [expression] [replacement] files... " exit 0 fi # remove other information OLD=$1 ; NEW=$2 ; shift ; shift
17 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
# # # # # #
this for loop iterates through all of the files that we give the program it does one rename per file given using the program 'sed' this is a sinple command line program that parses standard input and replaces a set expression with a give string here we pass it the file name ( as standard input) and replace the nessesary text
for file in $* do new=`echo ${file} | sed s/${OLD}/${NEW}/g` mv ${file} $new done exit 0 fi # if # so echo echo echo echo exit we have reached here then nothing proper was passed to the program we tell the user how to use it "usage;" " renna p [prefix] files.." " renna s [suffix] files.." " renna r [expression] [replacement] files.." 0
# done!
13. When something goes wrong (debugging) 13.1 Ways Calling BASH
A nice thing to do is to add on the first line
#!/bin/bash -x
18 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
14.2 Translations
Italian: by William Ghelfi (wizzy at tiscalinet.it) is here French: by Laurent Martelli is missed Korean: Minseok Park http://kldp.org Korean: Chun Hye Jin unknown Spanish: unknow http://www.insflug.org I guess there are more translations, but I don't have any info of them, if you have it, please, mail it to me so I update this section.
14.3 Thanks to
People who translated this document to other languages (previous section). Nathan Hurst for sending a lot of corrections. Jon Abbott for sending comments about evaluating arithmetic expressions. Felix Hudson for writing the renna script Kees van den Broek (for sending many corrections, re-writting usefull comands section) Mike (pink) made some suggestions about locating bash and testing files Fiesh make a nice suggestion for the loops section. Lion suggested to mention a common error (./hello.sh: Command not found.) Andreas Beck made several corrections and coments.
14.4 History
New translations included and minor correcitons. Added the section usefull commands re-writen by Kess. More corrections and suggestions incorporated. Samples added on string comparison. v0.8 droped the versioning, I guess the date is enought. v0.7 More corrections and some old TO-DO sections written. v0.6 Minor corrections. v0.5 Added the redirection section. v0.4 disapperd from its location due to my ex-boss and thid doc found it's new place at the proper url: www.linuxdoc.org. prior: I don't rememeber and I didn't use rcs nor cvs :(
19 of 20
1/26/2012 11:22 AM
http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html
20 of 20
1/26/2012 11:22 AM