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) How to redirect to a file and get input from a file ...
  63 Redirection operators can be used to redirect the ouput from a program from the display screen to a file where it is saved (or many other places too, like your printer or to another program where it can be used as input).
  64
  65
  66 | Command | Description                                                                                                                     |
  67 |---------|---------------------------------------------------------------------------------------------------------------------------------|
  68 | `>`     | write `stdout` to a new file; overwrites any file with that name (e.g., `ls *.md > mardkownfiles.txt`)                          |
  69 | `>>`    | append `stdout` to a previously existing file; if the file does not exist, it is created (e.g., `ls *.md >> markdownfiles.txt`) |
  70 | `<`     | assigns the information in a file to a variable, loop, etc (e.g., `n < markdownfiles.md`)                                       |
  71
  72
  73
  74 #### b.1) How to use the output of one command as the input to another with a pipe...
  75 A special kind of redirection is called a pipe and is denoted by `|`.
  76
  77
  78 | Command | Description                                                                                                                                           |
  79 |---------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
  80 | `|`     | Output from one command line program can be used as input to another one (e.g. `ls *.md | head` gives you the first 5 `*.md` files in your directory) |
  81
  82
  83
  84
  85 ##### Example:
  86
  87     ls *.md | head | sed -i `s/markdown/software/g`
  88
  89 changes all the instances of the word `markdown` to `software` in the first 5 `*.md` files in your current directory.
  90
  91
  92
  93
  94 ## 4. How to repeat operations using a loop...
  95 Loops assign a value in a list or counter to a variable that takes on a different value each time through the loop.
  96 There are 2 primary kinds of loops: `for` loops and `while` loops.
  97
  98 ### a) For loop
  99 For loops loop through variables in a list
 100
 101
 102     for varname in list
 103     do
 104         command 1
 105         command 2
 106     done
 107
 108 where,
 109
 110 *  `for`, `in`, `do`, and `done` are keywords
 111 *  `list` contains a list of values separated by spaces. e.g. `list` can be replaced by `1 2 3 4 5 6` or by `Bob Mary Sue Greg`. `list` can also be a variable:
 112
 113 --
 114
 115     list[0]=Sam
 116     list[1]=Lynne
 117     list[2]=Dhavide
 118     list[3]=Trevor
 119     .
 120     .
 121     .
 122     list[n]=Mark
 123
 124 which is referenced in the loop by:
 125
 126     for varname in ${list[@]}
 127     do
 128         command 1
 129         command 2
 130     done
 131
 132
 133 _Note:_ Bash is zero indexed, so counting always starts at `0`, not `1`.
 134
 135
 136 ### b) While Loop
 137 While loops loop through the commands until a condition is met. For example
 138
 139     COUNTER=0
 140     while [ ${COUNTER} -lt 10 ]; do
 141         command 1
 142         command 2
 143         COUNTER=`expr ${COUNTER} + 1`
 144     done
 145
 146 continues the loop as long as the value in the variable COUNTER is less than 10 (incremented by 1 on each iteration of the loop).
 147
 148 *  `while`, `do`, and `done` are keywords
 149
 150
 151 #### b.1) Commonly used conditional operators
 152
 153 | Operator | Definition               |
 154 |----------|--------------------------|
 155 | `-eq`    | is equal to              |
 156 | `-ne`    | is not equal to          |
 157 | `-gt`    | greater than             |
 158 | `-ge`    | greater than or equal to |
 159 | `-lt`    | less than                |
 160 | `-le`    | less than or equal to    |
 161
 162
 163
 164
 165
 166 ## 6. Finding Things
 167 ### a) How to select lines matching patterns in text files...
 168
 169 | Example command | Description |
 170 |-----------------|-------------|
 171 | `grep [options] day haiku.txt` | finds every instance of the string `day` in the file haiku.txt and pipes it to standard output |
 172
 173 | grep options |  |
 174 |--------------|--|
 175 | `-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 |
 176 | `-i` | makes matching case-insensitive |
 177 | `-n` | limits the number of lines that match to the first n matches |
 178 | `-v` | shows lines that do not match the pattern (inverts the match) |
 179 | `-w` | outputs instances where the pattern is a whole word |
 180
 181 ### b) How to find files with certain properties...
 182 * **`find . -type d` -->
 183         * **`-type [df]`** --> d lists directories; f lists files
 184         * **`-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
 185         * **`-mindepth n`** --> starts `find`'s search n levels below the working directory
 186
 187 ### c) How to use one command's output as arguments to another command...
 188
 189 ### d) How are text and binary files different?...
 190