173658f2b9b1ce95c04e41dd9c406e6f4c677812
[swc-modular-shell.git] / shell_cheatsheet.md
1 # Basic Shell Commands
2 ***
3
4 ## 1. Shell Basics:
5 * **`.`** (a single period) --> refers to the current directory
6 * **`..`** (a double period) --> refers to the directory above the current directory
7 * **`~`** --> refers to your home directory. _Note:_ this command does NOT work on Windows machines (Mac and Linux are okay)
8 * **`*`** --> wildcard (multiple characters). `*.txt` will match all files in the current directory that end with `.txt`
9 * **`?`** --> wildcard (single character). `?.txt` will match `a.txt` and `b.txt`, but not `ab.txt`
10 * **`cd ./dirname`** --> changes the current directory to the directory `dirname` 
11 * **`ls -F`** --> tells you what files and directories are in the current directory
12
13
14
15 ## 2. Creating Things:
16 ### a) How to create new files and directories...
17 * **`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
18 * **`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)
19
20 ### b) How to delete files and directories...
21 #### _Remember that deleting is forever. There is NO going back_
22 * **`rm ./filename`** --> deletes a file called `filename` from the current directory 
23 * **`rmdir ./dirname`** --> deletes the directory `dirname` from the current directory. _Note:_ `dirname` must be empty for `rmdir` to run.
24
25 ### c) How to copy and rename files and directories...
26 * **`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`
27 * **`cp tmp/filename .`** --> copies the file `filename` from the directory `tmp` to the current directory. _Note:_ _(i)_ the original file is still there
28
29
30
31 ## 3. Pipes and Filters
32 ### a) How to use wildcards to match filenames...
33 ### b) That wildcards are expanded by the shell before commands are run...
34 ### c) How to redirect a command's output to a file...
35 ### d) How to redirect a command's input from a file...
36 ### e) How to use the output of one command as the input to another with a pipe...
37 ### f) That combining single-purpose filters with pipes is the most productive way to use the shell...
38 ### g) That if a program conforms to Unix conventions, it can easily be combined with others...
39
40
41
42 ## 4. Variables
43 ### a) Assignment
44 * **`varname=1`** -->
45
46 ### b) Indexing 
47 * **`varname[0]`** --> _Note:_ the shell is zero indexed.  That means you always start counting from zero
48
49 ### c) Referencing
50 * **`${varname}` -->
51 * **`${varname[@]` --> 
52
53  
54
55 ## 5. Loops
56 NEED TO DO VARIABLE ASSIGNMENT FIRST!!!!
57 ### a) How to repeat operations using a loop...
58 * **`for`** -->  
59     `for filename in *.dat
60     do
61       mv ${filename} ${newname}
62     done`
63     
64 * **`while`** -->
65     `count=0   
66      while ${count} -lte 6
67      do
68        COMMAND HERE
69      done`
70
71 ### b) That the loop variable takes on a different value each time through the loop...
72 ### c) The difference between a variable's name and its value...
73 ### d) Why spaces and some punctuation characters shouldn't be used in files' names...
74 ### e) How to display history and re-use commands...
75 * **`history`** --> displays your command history to the standard output (usually the screen)
76
77
78
79 ## 6. Shell Scripts
80 ### a) How to store shell commands in a file...
81 ### b) How to run a shell script...
82 ### c) How to pass filenames into a shell script...
83
84
85
86 ## 7. Finding Things
87 ### a) How to select lines matching patterns in text files...
88 * **`grep [options] day haiku.txt`** --> finds every instance of the string `day` in the file haiku.txt and pipes it to standard output. 
89         * **`-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
90         * **`-i`** --> makes matching case-insensitive
91         * **`-n`** --> limits the number of lines that match to the first n matches
92         * **`-v`** --> shows lines that do not match the pattern (inverts the match)                    
93         * **`-w`** --> outputs instances where the pattern is a whole word
94
95 ### b) How to find files with certain properties...
96 * **`find . -type d` -->
97         * **`-type [df]`** --> d lists directories; f lists files
98         * **`-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
99         * **`-mindepth n`** --> starts `find`'s search n levels below the working directory
100         
101 ### c) How to use one command's output as arguments to another command...
102
103 ### d) How are text and binary files different?...
104