aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/einhyrningsinsctl.1.ronn31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/einhyrningsinsctl.1.ronn b/doc/einhyrningsinsctl.1.ronn
new file mode 100644
index 0000000..1c9056f
--- /dev/null
+++ b/doc/einhyrningsinsctl.1.ronn
@@ -0,0 +1,31 @@
+einhyrningsinsctl(1) -- control of einhyrningsins
+=================================================
+
+## SYNOPSIS
+
+`einhyrningsinsctl` [OPTIONS] [-e CMD]
+
+## DESCRIPTION
+
+Tiny shell client for einhyrningsins(1), which connects to a control socket
+(UNIX domain socket) and either sends a single command or acts as an
+interactive shell.
+
+ * `-e`, `--execute`=CMD:
+ Instead of starting a shell, just execute the CMD.
+ * `-d`, `--socket-path`=PATH:
+ Where to look for the control socket (a UNIX domain socket).
+ Defaults to `/tmp/einhorn.sock`.
+ * `-h`, `--help`:
+ Summary of options (of course)
+ * `--version`:
+ Prints version number
+
+## COPYRIGHT
+Copyright 2016 Bryan Newbold
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
+This is free software: you are free to change and redistribute it. There is NO
+WARRANTY, to the extent permitted by law.
+
+## SEE ALSO
+`einhorn (1)`, `einhyrningsins(1)`