From c35735b9f686a71905096c3ce91bf92cf7f240e2 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Mon, 4 May 2020 11:21:09 -0500 Subject: Add usage --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 9f99934..449730b 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit 1.4.1-21-gabe81