From cc890aa6fa48b78da94021780e050088ca4d9bfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Thu, 15 Dec 2016 10:25:28 -0500 Subject: [PATCH 1/4] import manpages from Debian project --- docs/wormhole-server.1 | 33 +++++++++++++++++++++++++++++++++ docs/wormhole.1 | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 docs/wormhole-server.1 create mode 100644 docs/wormhole.1 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 From cdc25e533acbf88217b1cdbe8bb840ded7864f61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Thu, 15 Dec 2016 10:35:49 -0500 Subject: [PATCH 2/4] move wormhole-server to section 8 this is where admin commands and daemons belong, according to intro(8) --- docs/{wormhole-server.1 => wormhole-server.8} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{wormhole-server.1 => wormhole-server.8} (100%) diff --git a/docs/wormhole-server.1 b/docs/wormhole-server.8 similarity index 100% rename from docs/wormhole-server.1 rename to docs/wormhole-server.8 From 7bade97bc2bf1bae57ac31b93ad040fcd526e92e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Thu, 15 Dec 2016 10:36:16 -0500 Subject: [PATCH 3/4] add cross-refs and authors --- docs/wormhole-server.8 | 8 ++++++++ docs/wormhole.1 | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/wormhole-server.8 b/docs/wormhole-server.8 index af9b2e2..1889793 100644 --- a/docs/wormhole-server.8 +++ b/docs/wormhole-server.8 @@ -31,3 +31,11 @@ Stop a relay server .TP tail\-usage Follow the latest usage +.SH SEE ALSO +.BR wormhole (1) +.SH AUTHORS +Brian Warner +.PP +This manual was written by Jameson Rollins + for the Debian project (and may be used +by others). diff --git a/docs/wormhole.1 b/docs/wormhole.1 index 077cda9..e995714 100644 --- a/docs/wormhole.1 +++ b/docs/wormhole.1 @@ -34,3 +34,11 @@ 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 +.PP +This manual was written by Jameson Rollins + for the Debian project (and may be used +by others). From d7441cfe8a7cebc9b4281e80d91ebeb5de80122c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Thu, 15 Dec 2016 10:36:32 -0500 Subject: [PATCH 4/4] remove out of date version numbers --- docs/wormhole-server.8 | 2 +- docs/wormhole.1 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/wormhole-server.8 b/docs/wormhole-server.8 index 1889793..b0b7862 100644 --- a/docs/wormhole-server.8 +++ b/docs/wormhole-server.8 @@ -1,4 +1,4 @@ -.TH WORMHOLE-SERVER "1" "July 2016" "wormhole-server 0.8.1" "User Commands" +.TH WORMHOLE-SERVER "8" "July 2016" .SH NAME wormhole-server \- Securely and simply transfer data between computers .SH SYNOPSIS diff --git a/docs/wormhole.1 b/docs/wormhole.1 index e995714..2de0cfb 100644 --- a/docs/wormhole.1 +++ b/docs/wormhole.1 @@ -1,4 +1,4 @@ -.TH WORMHOLE "1" "July 2016" "wormhole 0.8.1" "User Commands" +.TH WORMHOLE "1" "July 2016" "" "User Commands" .SH NAME wormhole \- Securely and simply transfer data between computers .SH SYNOPSIS