Update shell_cheatsheet.md
[swc-modular-shell-hearing.git] / shell_cheatsheet.md
1 # Basic Shell Commands
2 ***
3
4 ## 1. Shell Basics:
5
6 | Command        | Definition                                                                                                     |
7 |----------------|----------------------------------------------------------------------------------------------------------------|  
8 | `.`            | a single period refers to the current directory                                                                |  
9 | `..`           | a double period refers to the directory immediately above the current directory                                |  
10 | `~`            | refers to your home directory. _Note:_ this command does NOT work on Windows machines (Mac and Linux are okay) |  
11 | `cd ./dirname` | changes the current directory to the directory `dirname`                                                       |  
12 | `ls -F`        | tells you what files and directories are in the current directory                                              |  
13
14
15
16 ## 2. Creating Things:
17 ### a) How to create new files and directories..
18
19 | Command           | Definition                                                                                                                                                                                                                                                                                                                                            |  
20 |-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|  
21 | `mkdir ./dirname` | makes a new directory called dirname below the current directory. _Note:_ Windows users will need to use `\` instead of `/` for the path separator                                                                                                                                                                                                    |  
22 | `nano filename`   | if `filename` does not exist, `nano` creates it and opens the `nano` text editor. If the file exists, `nano` opens it. _Note:_ _(i)_ You can use a different text editor if you like.  In gnome Linux, `gedit` works really well too. _(ii)_ `nano` (or `gedit`) create text files. It doesn't matter what the file extension is (or if there is one) |  
23
24 ### b) How to delete files and directories...
25 #### _Remember that deleting is forever. There is NO going back_
26
27 | Command           | Definition                                                                                                       |  
28 |-------------------|------------------------------------------------------------------------------------------------------------------|
29 | `rm ./filename`   | deletes a file called `filename` from the current directory                                                      |  
30 | `rmdir ./dirname` |  deletes the directory `dirname` from the current directory. _Note:_ `dirname` must be empty for `rmdir` to run. |  
31
32 ### c) How to copy and rename files and directories...
33
34 | Command | Definition                                                                                                                                                                                                                    |  
35 |---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|  
36 | `mv tmp/filename .` | moves the file `filename` from the directory `tmp` to the current directory. _Note:_ _(i)_ the original `filename` in `tmp` is deleted. _(ii)_ `mv` can also be used to rename files (e.g., `mv filename newname` |  
37 | `cp tmp/filename .` | copies the file `filename` from the directory `tmp` to the current directory. _Note:_ _(i)_ the original file is still there                                                                                      |  
38
39
40
41 ## 3. Pipes and Filters
42 ### a) How to use wildcards to match filenames...
43 Wildcards are a shell feature that makes the command line much more powerful than any GUI file managers. 
44 Wildcards are particularly useful when you are looking for directories, files, or file content that can
45 vary along a given dimension.  These wildcards can be used with any command that accepts file names or 
46 text strings as arguments.
47
48 #### Table of commonly used wildcards 
49
50 | Wildcard               | Matches                                        |  
51 |------------------------|------------------------------------------------|  
52 | `*`                    | zero or more characters                        |  
53 | `?`                    | exactly one character                          |  
54 | `[abcde]`              | exactly one of the characters listed           |  
55 | `[a-e]`                | exactly one character in the given range       |  
56 | `[!abcde]`             | any character not listed                       |  
57 | `[!a-e]`               | any character that is not in the given range   |  
58 | `{software,carpentry}` | exactly one entire word from the options given |  
59
60 See the cheatsheet on regular expressions for more "wildcard" shortcuts.
61
62 ### b) That wildcards are expanded by the shell before commands are run...
63 ### c) How to redirect a command's output to a file...
64 ### d) How to redirect a command's input from a file...
65 ### e) How to use the output of one command as the input to another with a pipe...
66 ### f) That combining single-purpose filters with pipes is the most productive way to use the shell...
67 ### g) That if a program conforms to Unix conventions, it can easily be combined with others...
68
69
70
71 ## 4. Variables
72 ### a) Assignment
73 * **`varname=1`** -->
74
75 ### b) Indexing 
76 * **`varname[0]`** --> _Note:_ the shell is zero indexed.  That means you always start counting from zero
77
78 ### c) Referencing
79 * **`${varname}` -->
80 * **`${varname[@]` --> 
81
82  
83
84 ## 5. Loops
85 NEED TO DO VARIABLE ASSIGNMENT FIRST!!!!
86 ### a) How to repeat operations using a loop...
87 * **`for`** -->  
88     `for filename in *.dat
89     do
90       mv ${filename} ${newname}
91     done`
92     
93 * **`while`** -->
94     `count=0   
95      while ${count} -lte 6
96      do
97        COMMAND HERE
98      done`
99
100 ### b) That the loop variable takes on a different value each time through the loop...
101 ### c) The difference between a variable's name and its value...
102 ### d) Why spaces and some punctuation characters shouldn't be used in files' names...
103 ### e) How to display history and re-use commands...
104 * **`history`** --> displays your command history to the standard output (usually the screen)
105
106
107
108 ## 6. Shell Scripts
109 ### a) How to store shell commands in a file...
110 ### b) How to run a shell script...
111 ### c) How to pass filenames into a shell script...
112
113
114
115 ## 7. Finding Things
116 ### a) How to select lines matching patterns in text files...
117 * **`grep [options] day haiku.txt`** --> finds every instance of the string `day` in the file haiku.txt and pipes it to standard output. 
118         * **`-E`** --> tells grep you will be using a regular expression. Enclose the regular expression in quotes. _Note:_ the power of `grep` comes from using regular expressions. Please see the regular expressions sheet for examples
119         * **`-i`** --> makes matching case-insensitive
120         * **`-n`** --> limits the number of lines that match to the first n matches
121         * **`-v`** --> shows lines that do not match the pattern (inverts the match)                    
122         * **`-w`** --> outputs instances where the pattern is a whole word
123
124 ### b) How to find files with certain properties...
125 * **`find . -type d` -->
126         * **`-type [df]`** --> d lists directories; f lists files
127         * **`-maxdepth n`** --> `find` automatically searches subdirectories. If you don't want that, specify the number of levels below the working directory you would like to search
128         * **`-mindepth n`** --> starts `find`'s search n levels below the working directory
129         
130 ### c) How to use one command's output as arguments to another command...
131
132 ### d) How are text and binary files different?...
133