1 files changed, 18 insertions, 0 deletions

@@ -43,6 +43,24 @@ example.com  ted  localhost:6989  localhost:6667  /path/to/key.pub  [..]
 **rest** is more command-line options, if there's anything else you'd like to
 include in the command.
 
+## Usage
+
+```
+mrgrctrnl: make magic ssh tunnels
+usage:  mrgrctrnl [-h] [-k]
+        mrgrctrnl [-n] [-c CONF | -s SSH]
+
+options:
+        -h      show this help
+        -k      kill all processes and exit
+        -r      restart mrgrctrnl
+        -n      do a dry run: just print what would happen
+        -c CONFIG       use a different CONFIG file instead of
+                        $XDG_CONFIG_HOME/mrgrctrnl/config
+        -s CMDLINE      directly input an ssh CMDLINE --
+                        don't load the config file.
+```
+
 ## Requirements
 
 - POSIX environment