diff --git a/docs/wormhole-server.1 b/docs/wormhole-server.1 new file mode 100644 index 0000000..af9b2e2 --- /dev/null +++ b/docs/wormhole-server.1 @@ -0,0 +1,33 @@ +.TH WORMHOLE-SERVER "1" "July 2016" "wormhole-server 0.8.1" "User Commands" +.SH NAME +wormhole-server \- Securely and simply transfer data between computers +.SH SYNOPSIS +.B wormhole-server +[\fI\,OPTIONS\/\fR] \fI\,COMMAND \/\fR[\fI\,ARGS\/\fR]... +.SH DESCRIPTION +.IP +Control a relay server (most users shouldn't need to worry about this and +can use the default server). +.SH OPTIONS +.TP +\fB\-\-help\fR +Show this message and exit. +.SS "Commands:" +.TP +count\-channels +Count active channels +.TP +count\-events +Count events +.TP +restart +Re\-start a relay server +.TP +start +Start a relay server +.TP +stop +Stop a relay server +.TP +tail\-usage +Follow the latest usage diff --git a/docs/wormhole.1 b/docs/wormhole.1 new file mode 100644 index 0000000..077cda9 --- /dev/null +++ b/docs/wormhole.1 @@ -0,0 +1,36 @@ +.TH WORMHOLE "1" "July 2016" "wormhole 0.8.1" "User Commands" +.SH NAME +wormhole \- Securely and simply transfer data between computers +.SH SYNOPSIS +.B wormhole +[\fI\,OPTIONS\/\fR] \fI\,COMMAND \/\fR[\fI\,ARGS\/\fR]... +.SH DESCRIPTION +.IP +Create a Magic Wormhole and communicate through it. +.IP +Wormholes are created by speaking the same magic CODE in two different +places at the same time. Wormholes are secure against anyone who doesn't +use the same code. +.SH OPTIONS +.TP +\fB\-\-relay\-url\fR URL +rendezvous relay to use +.TP +\fB\-\-transit\-helper\fR tcp:HOST:PORT +transit relay to use +.TP +\fB\-\-dump\-timing\fR FILE.json +(debug) write timing data to file +.TP +\fB\-\-version\fR +Show the version and exit. +.TP +\fB\-\-help\fR +Show this message and exit. +.SS "Commands:" +.TP +receive +Receive a text message, file, or directory... +.TP +send +Send a text message, file, or directory