open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge PR102: add man pages

Browse Source 
Closes #69
This commit is contained in:
Brian Warner 2016-12-15 19:48:26 -08:00
commit da53c78d56
2 changed files with 85 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/wormhole-server.8 Normal file
View File

@ -0,0 +1,41 @@
.TH WORMHOLE-SERVER "8" "July 2016"
.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
.SH SEE ALSO
.BR wormhole (1)
.SH AUTHORS
Brian Warner <warner-magic-wormhole@lothar.com>
.PP
This manual was written by Jameson Rollins
<jrollins@finestructure.net> for the Debian project (and may be used
by others).

44
docs/wormhole.1 Normal file
View File

@ -0,0 +1,44 @@
.TH WORMHOLE "1" "July 2016" "" "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
.SH SEE ALSO
.BR wormhole-server (8)
.SH AUTHORS
Brian Warner <warner-magic-wormhole@lothar.com>
.PP
This manual was written by Jameson Rollins
<jrollins@finestructure.net> for the Debian project (and may be used
by others).