1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
From: Teemu Hukkanen <tjhukkan@iki.fi>
Date: Mon, 18 Mar 2024 14:28:01 +0200
Subject: Improve manpages
Add examples, adapted from the README file.
Add SEE ALSO section.
Fix dash quoting in htc.1.
Forwarded: yes
---
htc.1 | 25 +++++++++++++++++++++++--
hts.1 | 26 ++++++++++++++++++++++++--
2 files changed, 47 insertions(+), 4 deletions(-)
diff --git a/htc.1 b/htc.1
index 73f10b1..c577262 100644
--- a/htc.1
+++ b/htc.1
@@ -21,7 +21,7 @@ A summary of options are included below.
.B \-h, \-\-help
Show summary of options.
.TP
-.B \-c, \-\-content-length BYTES
+.B \-c, \-\-content\-length BYTES
use HTTP PUT requests of BYTES size (k, M, and G postfixes recognized)
.TP
.B \-d, \-\-device DEVICE
@@ -58,7 +58,7 @@ use stdin/stdout for communication (implies \-\-no\-daemon)
.B \-T, \-\-timeout TIME
timeout, in milliseconds, before sending padding to a buffering proxy
.TP
-.B \-U, \-\-user-agent STRING
+.B \-U, \-\-user\-agent STRING
specify User-Agent value in HTTP requests
.TP
.B \-R, \-\-base\-uri STRING
@@ -71,6 +71,27 @@ output version information and exit
.B \-w, \-\-no-daemon
don't fork into the background
+.SH EXAMPLES
+.TP
+Start httptunnel server
+.B hts \-F localhost:22 8888
+Aat host REMOTE, set up httptunnel server to listen on port 8888 and
+forward to localhost:22
+.TP
+Start httptunnel client
+.B htc \-F 2222 \-P PROXY_ADDRESS:8000 REMOTE_IP:8888
+At host LOCAL, set up httptunnel client to forward localhost:2222 to
+REMOTE_IP:8888 via a local proxy at PROXY_ADDRESS:8000
+.TP
+Or, if using a buffering HTTP proxy
+.B htc \-F 2222 \-P PROXY_ADDRESS:8000 -B 48K REMOTE_IP:8888
+.TP
+Now you can connect through the tunnel on host LOCAL
+.B ssh ssh://localhost:2222
+
.SH AUTHOR
This manual page was contributed by Teemu Hukkanen <tjhukkan@iki.fi>,
and was originally written for the Debian GNU/Linux system.
+
+.SH SEE ALSO
+.MR hts 1
diff --git a/hts.1 b/hts.1
index 9399746..6c672c7 100644
--- a/hts.1
+++ b/hts.1
@@ -22,7 +22,7 @@ A summary of options are included below.
.B \-h, \-\-help
Show summary of options.
.TP
-.B \-c, \-\-content-length BYTES
+.B \-c, \-\-content\-length BYTES
use HTTP PUT requests of BYTES size (k, M, and G postfixes recognized)
.TP
.B \-d, \-\-device DEVICE
@@ -46,7 +46,7 @@ always write Content-Length bytes in requests
.B \-V, \-\-version
output version information and exit
.TP
-.B \-w, \-\-no-daemon
+.B \-w, \-\-no\-daemon
don't fork into the background
.TP
.B \-p, \-\-pid\-file LOCATION
@@ -57,6 +57,28 @@ chroot to LOCATION before serving clients
.TP
.B \-u, \-\-user USER
change user and group identities before serving clients
+
+.SH EXAMPLES
+.TP
+Start httptunnel server
+.B hts \-F localhost:22 8888
+Aat host REMOTE, set up httptunnel server to listen on port 8888 and
+forward to localhost:22
+.TP
+Start httptunnel client
+.B htc \-F 2222 \-P PROXY_ADDRESS:8000 REMOTE_IP:8888
+At host LOCAL, set up httptunnel client to forward localhost:2222 to
+REMOTE_IP:8888 via a local proxy at PROXY_ADDRESS:8000
+.TP
+Or, if using a buffering HTTP proxy
+.B htc \-F 2222 \-P PROXY_ADDRESS:8000 -B 48K REMOTE_IP:8888
+.TP
+Now you can connect through the tunnel on host LOCAL
+.B ssh ssh://localhost:2222
+
.SH AUTHOR
This manual page was contributed by Teemu Hukkanen <tjhukkan@iki.fi>,
and was originally written for the Debian GNU/Linux system.
+
+.SH SEE ALSO
+.MR htc 1
|
