Clean up ambiguity between file and filename.
[swc-modular-shell.git] / shell / Readme.md
1 # The Shell
2
3 **Material by Paul Wilson, Milad Fatenejad, Sasha Wood, and Radhika Khetani**
4
5 # What is the shell how do I access the shell?
6
7 The *shell* is a program that presents a command line interface
8 which allows you to control your computer using commands entered
9 with a keyboard instead of controlling graphical user interfaces
10 (GUIs) with a mouse/keyboard combination.
11
12 Use a browser to open the tutorial on github, located at:
13     https://github.com/USERNAME/boot-camps/tree/YYYY-MM-PLACE
14
15 Click on the directory named `shell`.
16
17 A *terminal* is a program you run that gives you access to the
18 shell. There are many different terminal programs that vary across
19 operating systems.
20          
21 There are many reasons to learn about the shell. In my opinion, the
22 most important reasons are that: 
23
24 1.  It is very common to encounter the shell and
25     command-line-interfaces in scientific computing, so you will
26     probably have to learn it eventually 
27
28 2.  The shell is a really powerful way of interacting with your
29     computer. GUIs and the shell are complementary - by knowing both
30     you will greatly expand the range of tasks you can accomplish with
31     your computer. You will also be able to perform many tasks more
32     efficiently.
33
34 The shell is just a program and there are many different shell
35 programs that have been developed. The most common shell (and the one
36 we will use) is called the Bourne-Again SHell (bash). Even if bash is
37 not the default shell, it is usually installed on most systems and can be
38 started by typing `bash` in the terminal. Many commands, especially a
39 lot of the basic ones, work across the various shells but many things
40 are different. I recommend sticking with bash and learning it well.
41 ([Here is a link for more information](http://en.wikipedia.org/wiki/Bash_(Unix_shell))
42
43 To open a terminal, just single click on the "Terminal" icon on the
44 Desktop.
45
46 # The Example: Manipulating Experimental Data Files
47
48 We will spend most of our time learning about the basics of the shell
49 by manipulating some experimental data from a hearing test. To get
50 the data for this test, you will need internet access. Just enter the
51 command:
52
53     git clone -b YYYY-MM-PLACE https://github.com/USERNAME/boot-camps.git
54
55 This command will grab all of the data needed for this workshop from
56 the internet.  (We will talk about the `git` command later in the
57 workshop.)
58
59 # Let's get started
60
61 One very basic command is `echo`. This command just prints text to
62 the terminal. Try the command:
63
64     echo Hello, World
65
66 Then press enter. You should see the text "Hello, World" printed back
67 to you. The echo command is useful for printing from a shell script,
68 for displaying variables, and for generating known values to pass
69 to other programs.
70
71 ## Moving around the file system
72
73 Let's learn how to move around the file system using command line
74 programs. This is really easy to do using a GUI (just click on
75 things). Once you learn the basic commands, you'll see that it is
76 really easy to do in the shell too. 
77
78 First we have to know where we are. The program `pwd` (print working
79 directory) tells you where you are sitting in the directory tree. The
80 command `ls` will list the files in files in the current
81 directory. Directories are often called "folders" because of how they
82 are represented in GUIs. Directories are just listings of files. They
83 can contain other files or directories.
84
85 Whenever you start up a terminal, you will start in a special
86 directory called the *home* directory. Every user has their own home
87 directory where they have full access to do whatever they want. In
88 this case, the `pwd` command tells us that we are in the `/home/swc`
89 directory. This is the home directory for the `swc` user. That is our
90 user name. You can always find out your user name by entering the
91 command `whoami`. 
92
93 ## File Types
94
95 When you enter the `ls` command lists the contents of the current
96 directory. There are several items in the home directory, notice that
97 they are all colored blue. This tells us that all of these items are
98 directories as opposed to files.
99
100 Lets create an empty file using the `touch` command. Enter the
101 command:
102
103     touch testfile
104
105 Then list the contents of the directory again. You should see that a
106 new entry, called `testfile`, exists. It is colored white meaning that
107 it is a file, as opposed to a directory. The `touch` command just
108 creates an empty file. 
109
110 Some terminals will not color the directory entries in this very
111 convenient way. In those terminals, use `ls -F` instead of `ls`. The
112 `-F` argument modifies the results so that a slash is placed at the
113 end of directories. If the file is *executable* meaning that it can be
114 run like a program, then a star will be placed at the end of of the
115 file name.
116
117 You can also use the command `ls -l` to see whether items in a
118 directory are files or directories. `ls -l` gives a lot more
119 information too, such as the size of the file and information about
120 the owner. If the entry is a directory, then the first letter will be
121 a "d". The fifth column shows you the size of the entries in
122 bytes. Notice that `testfile` has a size of zero.
123
124 Now, let's get rid of `testfile`. To remove a file, just enter the
125 command:
126
127     rm testfile
128
129 The `rm` command can be used to remove files. If you enter `ls` again,
130 you will see that `testfile` is gone.
131
132
133 ## Changing Directories
134
135 Now, let's move to a different directory. The command `cd` (change
136 directory) is used to move around. Let's move into the `boot-camps`
137 directory. Enter the following command:
138
139     cd boot-camps
140
141 Use the `ls` command to see what is inside this directory.  This
142 directory contains all of the material for this boot camp. Now move to
143 the directory containing the data for the shell tutorial:
144
145     cd shell
146
147 Now use the `ls` command to see what is inside this directory. You
148 will see that there is an entry which is green. This means that this
149 is an executable. If you use `ls -F` you will see that this file ends
150 with a star.
151
152 If you enter the `cd` command by itself, you will return to the home
153 directory. Try this, and then navigate back to the `shell`
154 directory.
155
156 ## Arguments
157
158 Most programs take additional arguments that control their exact
159 behavior. For example, `-F` and `-l` are arguments to `ls`.  The `ls`
160 program, like many programs, take a lot of arguments. But how do we
161 know what the options are to particular commands?
162
163 Most commonly used shell programs have a manual. You can access the
164 manual using the `man` program. Try entering:
165
166     man ls
167
168 This will open the manual page for `ls`. Use the space key to go
169 forward and b to go backwards. When you are done reading, just hit `q`
170 to quit.
171
172 Programs that are run from the shell can get extremely complicated. To
173 see an example, open up the manual page for the `find` program,
174 which we will use later this session. No one can possibly learn all of
175 these arguments, of course. So you will probably find yourself
176 referring back to the manual page frequently.
177
178 * * * *
179 **Short Exercise**
180
181 1. Use the manual page for `ls` to guess what you would expect from
182 using the arguments `-l`, '-t', '-r' at the same time.
183 2. Try the following and see if you can figure out what they do, either by examining the results or consulting the manual page.
184    * `ls -lS` (equivalent to `ls -l -S`)
185    * `ls -lt` (equivalent to `ls -l -t`)
186    * `ls -1`  (that's the number one, not a letter 'ell')
187
188 * * * *
189
190
191 ## Examining the contents of other directories
192
193 By default, the `ls` commands lists the contents of the working
194 directory (i.e. the directory you are in). You can always find the
195 directory you are in using the `pwd` command. However, you can also
196 give `ls` the names of other directories to view. Navigate to the
197 home directory if you are not already there. Then enter the
198 command:
199
200     ls boot-camps
201
202 This will list the contents of the `boot-camps` directory without
203 you having to navigate there. Now enter:
204
205     ls boot-camps/shell
206
207 This prints the contents of `shell`. The `cd` command works in a
208 similar way. Try entering:
209
210     cd boot-camps/shell
211
212 and you will jump directly to `shell` without having to go through
213 the intermediate directory.
214
215 ## Full vs. Relative Paths
216
217 The `cd` command takes an argument which is the directory
218 name. Directories can be specified using either a *relative* path a
219 full *path*. The directories on the computer are arranged into a
220 hierarchy. The full path tells you where a directory is in that
221 hierarchy. Navigate to the home directory. Now, enter the `pwd`
222 command and you should see:
223
224     /home/swc
225
226 which is the full name of your home directory. This tells you that you
227 are in a directory called `swc`, which sits inside a directory called
228 `home` which sits inside the very top directory in the hierarchy. The
229 very top of the hierarchy is a directory called `/` which is usually
230 referred to as the *root directory*. So, to summarize: `swc` is a
231 directory in `home` which is a directory in `/`.
232
233 Now enter the following command:
234
235     cd /home/swc/boot-camps/shell
236
237 This jumps to `shell`. Now go back to the home directory. We saw
238 earlier that the command:
239
240     cd boot-camps/shell
241
242 had the same effect - it took us to the `shell` directory. But,
243 instead of specifying the full path
244 (`/home/swc/boot-camps/shell`), we specified a *relative path*. In
245 other words, we specified the path relative to our current
246 directory. A full path always starts with a `/`. A relative path does
247 not. You can usually use either a full path or a relative path
248 depending on what is most convenient. If we are in the home directory,
249 it is more convenient to just enter the relative path since it
250 involves less typing.
251
252 Over time, it will become easier for you to keep a mental note of the
253 structure of the directories that you are using hand how to quickly
254 navigate amongst them.
255
256 * * * *
257 **Short Exercise**
258
259 Now, list the contents of the /bin directory. Do you see anything
260 familiar in there?
261
262 * * * * 
263
264 ## Saving time with shortcuts, wild cards, and tab completion
265
266 ### Shortcuts
267
268 There are some shortcuts which you should know about. Dealing with the
269 home directory is very common. So, in the shell the tilde character,
270 `~`, is a shortcut for your home directory. Navigate to the `shell`
271 directory, then enter the command:
272
273     ls ~
274
275 This prints the contents of your home directory, without you having to
276 type the full path. The shortcut `..` always refers to the directory
277 above your current directory. Thus: 
278
279     ls ..
280
281 prints the contents of the `/home/swc/boot-camps`. You can chain
282 these together, so:
283
284     ls ../../
285
286 prints the contents of `/home/swc` which is your home
287 directory. Finally, the special directory `.` always refers to your
288 current directory. So, `ls`, `ls .`, and `ls ././././.` all do the
289 same thing, they print the contents of the current directory. This may
290 seem like a useless shortcut right now, but we'll see when it is
291 needed in a little while.
292
293 To summarize, while you are in the `shell` directory, the commands
294 `ls ~`, `ls ~/.`, `ls ../../`, and `ls /home/swc` all do exactly the
295 same thing. These shortcuts are not necessary, they are provided for
296 your convenience.
297
298 ### Our data set: Cochlear Implants
299
300 A cochlear implant is a small electronic device that is surgically
301 implanted in the inner ear to give deaf people a sense of
302 hearing. More than a quarter of a million people have them, but there
303 is still no widely-accepted benchmark to measure their effectiveness.
304 In order to establish a baseline for such a benchmark, our supervisor
305 got teenagers with CIs to listen to audio files on their computer and
306 report:
307
308 1.  the quietest sound they could hear
309 2.  the lowest and highest tones they could hear
310 3.  the narrowest range of frequencies they could discriminate
311
312 To participate, subjects attended our laboratory and one of our lab
313 techs played an audio sample, and recorded their data - when they
314 first heard the sound, or first heard a difference in the sound.  Each
315 set of test results were written out to a text file, one set per file.
316 Each participant has a unique subject ID, and a made-up subject name.
317 Each experiment has a unique experiment ID. The experiment has
318 collected 351 files so far.
319
320 The data is a bit of a mess! There are inconsistent file names, there
321 are extraneous "NOTES" files that we'd like to get rid of, and the
322 data is spread across many directories. We are going to use shell
323 commands to get this data into shape. By the end we would like to:
324
325 1.  Put all of the data into one directory called "alldata"
326
327 2.  Have all of the data files in there, and ensure that every file
328     has a ".txt" extension
329
330 3.  Get rid of the extraneous "NOTES" files
331
332 If we can get through this example in the available time, we will move
333 onto more advanced shell topics...
334
335 ### Wild cards
336
337 Navigate to the `~/boot-camps/shell/data/THOMAS` directory. This
338 directory contains our hearing test data for THOMAS. If we type `ls`,
339 we will see that there are a bunch of files which are just four digit
340 numbers. By default, `ls` lists all of the files in a given
341 directory. The `*` character is a shortcut for "everything". Thus, if
342 you enter `ls *`, you will see all of the contents of a given
343 directory. Now try this command:
344
345     ls *1
346
347 This lists every file that ends with a `1`. This command:
348
349     ls /usr/bin/*.sh
350
351 Lists every file in `/usr/bin` that ends in the characters `.sh`. And
352 this command:
353
354     ls *4*1
355
356 lists every file in the current directory whose name contains the
357 number `4`, and ends with the number `1`. There are four such files:
358 `0241`, `0341`, `0431`, and `0481`.
359
360 So how does this actually work? Well...when the shell (bash) sees a
361 word that contains the `*` character, it automatically looks for filenames
362 that match the given pattern. In this case, it identified four such
363 files. Then, it replaced the `*4*1` with the list of files, separated
364 by spaces. In other words, the two commands:
365
366     ls *4*1
367     ls 0241 0341 0431 0481
368
369 are exactly identical. The `ls` command cannot tell the difference
370 between these two things.
371
372 * * * *
373 **Short Exercise**
374
375 Do each of the following using a single `ls` command without
376 navigating to a different directory.
377
378 1.  List all of the files in `/bin` that contain the letter `a`
379 2.  List all of the files in `/bin` that contain the letter `a` or the letter `b`
380 3.  List all of the files in `/bin` that contain the letter `a` AND the letter `b`
381
382 * * * *
383
384 ### Tab Completion
385
386 Navigate to the home directory. Typing out directory names can waste a
387 lot of time. When you start typing out the name of a directory, then
388 hit the tab key, the shell will try to fill in the rest of the
389 directory name. For example, enter:
390
391     cd b<tab>
392
393 The shell will fill in the rest of the directory name for
394 `boot-camps`. Now enter:
395
396     ls s<tab><tab>
397
398 When you hit the first tab, nothing happens. The reason is that there
399 are multiple directories in the home directory which start with
400 `s`. Thus, the shell does not know which one to fill in. When you hit
401 tab again, the shell will list the possible choices. 
402
403 Tab completion can also fill in the names of programs. For example,
404 enter `e<tab><tab>`. You will see the name of every program that
405 starts with an `e`. One of those is `echo`. If you enter `ec<tab>` you
406 will see that tab completion works.
407
408 ## Command History
409
410 You can easily access previous commands.  Hit the up arrow.  
411 Hit it again.  You can step backwards through your command history. 
412 The down arrow takes your forwards in the command history.  
413
414 ^-C will cancel the command you are writing, and give you a fresh prompt.
415
416 ^-R will do a reverse-search through your command history.  This
417 is very useful.
418
419 ## Which program?
420
421 Commands like `ls`, `rm`, `echo`, and `cd` are just ordinary programs
422 on the computer. A program is just a file that you can *execute*. The
423 program `which` tells you the location of a particular program. For
424 example:
425
426     which ls
427
428 Will return "/bin/ls". Thus, we can see that `ls` is a program that
429 sits inside of the `/bin` directory. Now enter:
430
431     which find
432
433 You will see that `find` is a program that sits inside of the
434 `/usr/bin` directory.
435
436 So ... when we enter a program name, like `ls`, and hit enter, how
437 does the shell know where to look for that program? How does it know
438 to run `/bin/ls` when we enter `ls`. The answer is that when we enter
439 a program name and hit enter, there are a few standard places that the
440 shell automatically looks. If it can't find the program in any of
441 those places, it will print an error saying "command not found". Enter
442 the command:
443
444     echo $PATH
445
446 This will print out the value of the `PATH` environment variable. More
447 on environment variables later. Notice that a list of directories,
448 separated by colon characters, is listed. These are the places the
449 shell looks for programs to run. If your program is not in this list,
450 then an error is printed. The shell ONLY checks in the places listed
451 in the `PATH` environment variable. 
452
453 Navigate to the `shell` directory and list the contents. You will
454 notice that there is a program (executable file) called `hello` in
455 this directory. Now, try to run the program by entering:
456
457     hello
458
459 You should get an error saying that hello cannot be found. That is
460 because the directory `/home/swc/boot-camps/shell` is not in the
461 `PATH`. You can run the `hello` program by entering:
462
463     ./hello
464
465 Remember that `.` is a shortcut for the current working
466 directory. This tells the shell to run the `hello` program which is
467 located right here. So, you can run any program by entering the path
468 to that program. You can run `hello` equally well by specifying:
469
470     /home/swc/boot-camps/shell/hello
471
472 Or by entering:
473
474     ../shell/hello
475
476 When there are no `/` characters, the shell assumes you want to look
477 in one of the default places for the program.
478
479
480 ## Examining Files
481
482 We now know how to switch directories, run programs, and look at the
483 contents of directories, but how do we look at the contents of files?
484
485 The easiest way to examine a file is to just print out all of the
486 contents using the program `cat`. Enter the following command:
487
488     cat ex_data.txt
489
490 This prints out the contents of the `ex_data.txt` file. If you enter:
491
492     cat ex_data.txt ex_data.txt
493
494 It will print out the contents of `ex_data.txt` twice. `cat` just
495 takes a list of file names and writes them out one after another (this
496 is where the name comes from, `cat` is short for concatenate). 
497
498 * * * *
499 **Short Exercises**
500
501 1.  Print out the contents of the `~/boot-camps/shell/dictionary.txt`
502     file. What does this file contain?
503
504 2.  Without changing directories, (you should still be in `shell`),
505     use one short command to print the contents of all of the files in
506     the `/home/swc/boot-camps/shell/data/THOMAS` directory.
507
508 * * * *
509
510 `cat` is a terrific program, but when the file is really big, it can
511 be annoying to use. The program, `less`, is useful for this
512 case. Enter the following command:
513
514     less ~/boot-camps/shell/dictionary.txt
515
516 `less` opens the file, and lets you navigate through it. The commands
517 are identical to the `man` program. 
518
519 **Some commands in `less`**
520
521 | key     | action |
522 | ------- | ---------- | 
523 | "space" | to go forward |
524 |  "b"    | to go backwarsd |
525 |  "g"    | to go to the beginning |
526 |  "G"    | to go to the end |
527 |  "q"    | to quit |
528
529 `less` also gives you a way of searching through files. Just hit the
530 "/" key to begin a search. Enter the name of the word you would like
531 to search for and hit enter. It will jump to the next location where
532 that word is found. Try searching the `dictionary.txt` file for the
533 word "cat". If you hit "/" then "enter", `less` will just repeat
534 the previous search. `less` searches from the current location and
535 works its way forward. If you are at the end of the file and search
536 for the word "cat", `less` will not find it. You need to go to the
537 beginning of the file and search.
538
539 Remember, the `man` program actually uses `less` internally and
540 therefore uses the same commands, so you can search documentation
541 using "/" as well!
542
543 * * * *
544 **Short Exercise**
545
546 Use the commands we've learned so far to figure out how to search
547 in reverse while using `less`.
548
549 * * * * 
550
551
552 ## Redirection
553
554 Let's turn to the experimental data from the hearing tests that we
555 began with. This data is located in the `~/boot-camps/shell/data`
556 directory. Each subdirectory corresponds to a particular participant
557 in the study. Navigate to the `Bert` subdirectory in `data`.  There
558 are a bunch of text files which contain experimental data
559 results. Lets print them all:
560
561     cat au*
562
563 Now enter the following command:
564
565     cat au* > ../all_data
566
567 This tells the shell to take the output from the `cat au*` command and
568 dump it into a new file called `../all_data`. To verify that this
569 worked, examine the `all_data` file. If `all_data` had already
570 existed, we would overwritten it. So the `>` character tells the shell
571 to take the output from what ever is on the left and dump it into the
572 file on the right. The `>>` characters do almost the same thing,
573 except that they will append the output to the file if it already
574 exists.
575
576 * * * *
577 **Short Exercise**
578
579 Use `>>`, to append the contents of all of the files whose names
580 contain the number 4 in the directory:
581
582     /home/swc/boot-camps/shell/data/gerdal
583
584 to the existing `all_data` file. Thus, when you are done `all_data`
585 should contain all of the experiment data from Bert and any
586 experimental data file from gerdal with filenames that contain the
587 number 4.
588
589 * * * *
590
591
592 ## Creating, moving, copying, and removing
593
594 We've created a file called `all_data` using the redirection operator
595 `>`. This file is critical - it's our analysis results - so we want to
596 make copies so that the data is backed up.
597 Lets copy the file using the `cp` command. The `cp`
598 command backs up the file. Navigate to the `data` directory and enter:
599
600     cp all_data all_data_backup
601
602 Now `all_data_backup` has been created as a copy of `all_data`. We can
603 move files around using the command `mv`. Enter this command:
604
605     mv all_data_backup /tmp/
606
607 This moves `all_data_backup` into the directory `/tmp`. The directory
608 `/tmp` is a special directory that all users can write to. It is a
609 temporary place for storing files. Data stored in `/tmp` is
610 automatically deleted when the computer shuts down.
611
612 The `mv` command is also how you rename files. Since this file is so
613 important, let's rename it:
614
615     mv all_data all_data_IMPORTANT
616
617 Now the file name has been changed to all_data_IMPORTANT. Let's delete
618 the backup file now:
619
620     rm /tmp/all_data_backup
621
622 The `mkdir` command is used to make a directory. Just enter `mkdir`
623 followed by a space, then the directory name. 
624
625 * * * *
626 **Short Exercise**
627
628 Do the following:
629
630 1.  Rename the `all_data_IMPORTANT` file to `all_data`.
631 2.  Create a directory in the `data` directory called `foo`
632 3.  Then, copy the `all_data` file into `foo`
633
634 * * * *
635
636 By default, `rm`, will NOT delete directories. You can tell `rm` to
637 delete a directory using the `-r` option. Enter the following command:
638
639     rm -r foo
640
641
642 ## Count the words
643
644 The `wc` program (word count) counts the number of lines, words, and
645 characters in one or more files. Make sure you are in the `data`
646 directory, then enter the following command:
647
648     wc Bert/* gerdal/*4*
649
650 For each of the files indicated, `wc` has printed a line with three
651 numbers. The first is the number of lines in that file. The second is
652 the number of words. Finally, the total number of characters is
653 indicated. The final line contains this information summed over all of
654 the files. Thus, there were 10445 characters in total. 
655
656 Remember that the `Bert/*` and `gerdal/*4*` files were merged
657 into the `all_data` file. So, we should see that `all_data` contains
658 the same number of characters:
659
660     wc all_data
661
662 Every character in the file takes up one byte of disk space. Thus, the
663 size of the file in bytes should also be 10445. Let's confirm this:
664
665     ls -l all_data
666
667 Remember that `ls -l` prints out detailed information about a file and
668 that the fifth column is the size of the file in bytes.
669
670 * * * *
671 **Short Exercise**
672
673 Figure out how to get `wc` to print the length of the longest line in
674 `all_data`.
675
676 * * * *
677
678 ## The awesome power of the Pipe
679
680 Suppose I wanted to only see the total number of character, words, and
681 lines across the files `Bert/*` and `gerdal/*4*`. I don't want to
682 see the individual counts, just the total. Of course, I could just do:
683
684     wc all_data
685
686 Since this file is a concatenation of the smaller files. Sure, this
687 works, but I had to create the `all_data` file to do this. Thus, I
688 have wasted a precious 7062 bytes of hard disk space. We can do this
689 *without* creating a temporary file, but first I have to show you two
690 more commands: `head` and `tail`. These commands print the first few,
691 or last few, lines of a file, respectively. Try them out on
692 `all_data`:
693
694     head all_data
695     tail all_data
696
697 The `-n` option to either of these commands can be used to print the
698 first or last `n` lines of a file. To print the first/last line of the
699 file use:
700
701     head -n 1 all_data
702     tail -n 1 all_data
703
704 Let's turn back to the problem of printing only the total number of
705 lines in a set of files without creating any temporary files. To do
706 this, we want to tell the shell to take the output of the `wc Bert/*
707 gerdal/*4*` and send it into the `tail -n 1` command. The `|`
708 character (called pipe) is used for this purpose. Enter the following
709 command:
710
711     wc Bert/* gerdal/Data0559 | tail -n 1
712
713 This will print only the total number of lines, characters, and words
714 across all of these files. What is happening here? Well, `tail`, like
715 many command line programs will read from the *standard input* when it
716 is not given any files to operate on. In this case, it will just sit
717 there waiting for input. That input can come from the user's keyboard
718 *or from another program*. Try this:
719
720     tail -n 2
721
722 Notice that your cursor just sits there blinking. Tail is waiting for
723 data to come in. Now type:
724
725     French
726     fries
727     are
728     good
729
730 then CONTROL+d. You should is the lines:
731
732     are
733     good
734
735 printed back at you. The CONTROL+d keyboard shortcut inserts an
736 *end-of-file* character. It is sort of the standard way of telling the
737 program "I'm done entering data". The `|` character is replaces the
738 data from the keyboard with data from another command. You can string
739 all sorts of commands together using the pipe. 
740
741 The philosophy behind these command line programs is that none of them
742 really do anything all that impressive. BUT when you start chaining
743 them together, you can do some really powerful things really
744 efficiently. If you want to be proficient at using the shell, you must
745 learn to become proficient with the pipe and redirection operators:
746 `|`, `>`, `>>`.
747
748
749 ### A sorting example
750
751 Let's create a file with some words to sort for the next example. We
752 want to create a file which contains the following names:
753
754     Bob
755     Alice
756     Diane
757     Charles
758
759 To do this, we need a program which allows us to create text
760 files. There are many such programs, the easiest one which is
761 installed on almost all systems is called `nano`. Navigate to `/tmp`
762 and enter the following command:
763
764     nano toBeSorted
765
766 Now enter the four names as shown above. When you are done, press
767 CONTROL+O to write out the file. Press enter to use the file name
768 `toBeSorted`. Then press CONTROL+x to exit `nano`.
769
770 When you are back to the command line, enter the command:
771
772     sort toBeSorted
773
774 Notice that the names are now printed in alphabetical order.
775
776 * * * *
777 **Short Exercise**
778
779 Use the `echo` command and the append operator, `>>`, to append your
780 name to the file, then sort it and make a new file called Sorted.
781
782 * * * *
783
784 Let's navigate back to `~/boot-camps/shell/data`. Enter the following command:
785
786     wc Bert/* | sort -k 3 -n
787
788 We are already familiar with what the first of these two commands
789 does: it creates a list containing the number of characters, words,
790 and lines in each file in the `Bert` directory. This list is then
791 piped into the `sort` command, so that it can be sorted. Notice there
792 are two options given to sort:
793
794 1.  `-k 3`: Sort based on the third column
795 2.  `-n`: Sort in numerical order as opposed to alphabetical order
796
797 Notice that the files are sorted by the number of characters.
798
799 * * * *
800 **Short Exercise**
801
802 1. Use the `man` command to find out how to sort the output from `wc` in
803 reverse order.
804
805 2. Combine the `wc`, `sort`, `head` and `tail` commands so that only the
806 `wc` information for the largest file is listed
807
808 Hint: To print the smallest file, use:
809
810     wc Bert/* | sort -k 3 -n | head -n 1
811
812 * * * * 
813
814 Printing the smallest file seems pretty useful. We don't want to type
815 out that long command often. Let's create a simple script, a simple
816 program, to run this command. The program will look at all of the
817 files in the current directory and print the information about the
818 smallest one. Let's call the script `smallest`. We'll use `nano` to
819 create this file. Navigate to the `data` directory, then:
820
821     nano smallest
822
823 Then enter the following text:
824
825     #!/bin/bash
826     wc * | sort -k 3 -n | head -n 1
827
828 Now, `cd` into the `Bert` directory and enter the command
829 `../smallest`. Notice that it says permission denied. This happens
830 because we haven't told the shell that this is an executable
831 file. If you do `ls -l ../smallest`, it will show you the permissions on 
832 the left of the listing.
833
834 Enter the following commands:
835
836     chmod a+x ../smallest
837     ../smallest
838
839 The `chmod` command is used to modify the permissions of a file. This
840 particular command modifies the file `../smallest` by giving all users
841 (notice the `a`) permission to execute (notice the `x`) the file. If
842 you enter:
843
844     ls -l ../smallest
845
846 You will see that the file name is green and the permissions have changed. 
847 Congratulations, you just created your first shell script!
848
849 # Searching files
850
851 You can search the contents of a file using the command `grep`. The
852 `grep` program is very powerful and useful especially when combined
853 with other commands by using the pipe. Navigate to the `Bert`
854 directory. Every data file in this directory has a line which says
855 "Range". The range represents the smallest frequency range that can be
856 discriminated. Lets list all of the ranges from the tests that Bert
857 conducted:
858
859     grep Range *
860
861 * * * * 
862 **Short Exercise**
863
864 Create an executable script called `smallestrange` in the `data`
865 directory, that is similar to the `smallest` script, but prints the
866 file containing the file with the smallest Range. Use the commands
867 `grep`, `sort`, and `tail` to do this.
868
869 * * * * 
870
871
872 # Finding files
873
874 The `find` program can be used to find files based on arbitrary
875 criteria. Navigate to the `data` directory and enter the following
876 command:
877
878     find . -print
879
880 This prints the name of every file or directory, recursively, starting
881 from the current directory. Let's exclude all of the directories:
882
883     find . -type f -print
884
885 This tells `find` to locate only files. Now try these commands:
886
887     find . -type f -name "*1*"
888     find . -type f -name "*1*" -or -name "*2*" -print
889     find . -type f -name "*1*" -and -name "*2*" -print
890
891 The `find` command can acquire a list of files and perform some
892 operation on each file. Try this command out:
893
894     find . -type f -exec grep Volume {} \;
895
896 This command finds every file starting from `.`. Then it searches each
897 file for a line which contains the word "Volume". The `{}` refers to
898 the name of each file. The trailing `\;` is used to terminate the
899 command.  This command is slow, because it is calling a new instance
900 of `grep` for each item the `find` returns.
901
902 A faster way to do this is to use the `xargs` command:
903
904     find . -type f -print | xargs grep Volume
905
906 `find` generates a list of all the files we are interested in, 
907 then we pipe them to `xargs`.  `xargs` takes the items given to it 
908 and passes them as arguments to `grep`.  `xargs` generally only creates
909 a single instance of `grep` (or whatever program it is running).
910
911 * * * * 
912 **Short Exercise**
913
914 Navigate to the `data` directory. Use one `find` command to perform each
915 of the operations listed below (except number 2, which does not
916 require a `find` command):
917
918 1.  Find any file whose name is "NOTES" within `data` and delete it 
919
920 2.  Create a new directory called `cleaneddata`
921
922 3.  Move all of the files within `data` to the `cleaneddata` directory
923
924 4.  Rename all of the files to ensure that they end in `.txt` (note:
925     it is ok for the file name to end in `.txt.txt`
926
927 Hint: If you make a mistake and need to start over just do the
928 following:
929
930 1.  Navigate to the `shell` directory
931
932 2.  Delete the `data` directory
933
934 3.  Enter the command: `git checkout -- data` You should see that the
935     data directory has reappeared in its original state
936
937 **BONUS**
938
939 Redo exercise 4, except rename only the files which do not already end
940 in `.txt`. You will have to use the `man` command to figure out how to
941 search for files which do not match a certain name. 
942
943 * * * * 
944
945
946
947 ## Bonus:
948
949 **backtick, xargs**: Example find all files with certain text
950
951 **alias** -> rm -i
952
953 **variables** -> use a path example
954
955 **.bashrc**
956
957 **du**
958
959 **ln**
960
961 **ssh and scp**
962
963 **Regular Expressions**
964
965 **Permissions**
966
967 **Chaining commands together**