Browse code

Cleaned up man page synopsis.

git-svn-id: http://svn.openvpn.net/projects/openvpn/branches/BETA21/openvpn@3507 e7ae566f-a301-0410-adde-c780ea21d3b5

james authored on 2008/11/18 12:29:44
Showing 1 changed files
... ...
@@ -26,7 +26,7 @@
26 26
 .\" LP paragraph
27 27
 .\" IP indented paragraph
28 28
 .\" TP hanging label
29
-.TH openvpn 8 "4 November 2008"
29
+.TH openvpn 8 "17 November 2008"
30 30
 .\"*********************************************************
31 31
 .SH NAME
32 32
 openvpn \- secure IP tunnel daemon.
... ...
@@ -36,278 +36,7 @@ openvpn \- secure IP tunnel daemon.
36 36
 .nh
37 37
 .in +4
38 38
 .ti -4
39
-.B openvpn
40
-[\ \fB\-\-help\fR\ ]
41
-.in -4
42
-.ti +4
43
-.hy
44
-
45
-.nh
46
-.in +4
47
-.ti -4
48
-.B openvpn
49
-[\ \fB\-\-config\fR\ \fIfile\fR\ ]
50
-.in -4
51
-.ti +4
52
-.hy
53
-
54
-.nh
55
-.in +4
56
-.ti -4
57
-.B openvpn
58
-[\ \fB\-\-genkey\fR\ ]
59
-[\ \fB\-\-secret\fR\ \fIfile\fR\ ]
60
-.in -4
61
-.ti +4
62
-.hy
63
-
64
-.nh
65
-.in +4
66
-.ti -4
67
-.B openvpn
68
-[\ \fB\-\-mktun\fR\ ]
69
-[\ \fB\-\-rmtun\fR\ ]
70
-[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\fR\ ]
71
-[\ \fB\-\-dev\-type\fR\ \fIdevice\-type\fR\ ]
72
-[\ \fB\-\-dev\-node\fR\ \fInode\fR\ ]
73
-[\ \fB\-\-lladdr\fR\ \fIaddress\fR\ ]
74
-[\ \fB\-\-user\fR\ \fIuser\fR\ ]
75
-[\ \fB\-\-group\fR\ \fIgroup\fR\ ]
76
-.in -4
77
-.ti +4
78
-.hy
79
-
80
-.nh
81
-.in +4
82
-.ti -4
83
-.B openvpn
84
-[\ \fB\-\-test\-crypto\fR\ ]
85
-[\ \fB\-\-secret\fR\ \fIfile\fR\ ]
86
-[\ \fB\-\-auth\fR\ \fIalg\fR\ ]
87
-[\ \fB\-\-cipher\fR\ \fIalg\fR\ ]
88
-[\ \fB\-\-engine\fR\ ]
89
-[\ \fB\-\-keysize\fR\ \fIn\fR\ ]
90
-[\ \fB\-\-no\-replay\fR\ ]
91
-[\ \fB\-\-no\-iv\fR\ ]
92
-.in -4
93
-.ti +4
94
-.hy
95
-
96
-.nh
97
-.in +4
98
-.ti -4
99
-.B openvpn
100
-[\ \fB\-\-allow\-nonadmin\fR\ \fI[TAP\-adapter]\fR\ ]
101
-[\ \fB\-\-allow\-pull\-fqdn\fR\ ]
102
-[\ \fB\-\-askpass\fR\ \fI[file]\fR\ ]
103
-[\ \fB\-\-auth\-nocache\fR\ ]
104
-[\ \fB\-\-auth\-retry\fR\ \fItype\fR\ ]
105
-[\ \fB\-\-auth\-user\-pass\-optional\fR\ ]
106
-[\ \fB\-\-auth\-user\-pass\-verify\fR\ \fIscript\fR\ ]
107
-[\ \fB\-\-auth\-user\-pass\fR\ \fIup\fR\ ]
108
-[\ \fB\-\-auth\fR\ \fIalg\fR\ ]
109
-[\ \fB\-\-auto\-proxy\fR\ ]
110
-[\ \fB\-\-bcast\-buffers\fR\ \fIn\fR\ ]
111
-[\ \fB\-\-ca\fR\ \fIfile\fR\ ]
112
-[\ \fB\-\-ccd\-exclusive\fR\ ]
113
-[\ \fB\-\-cd\fR\ \fIdir\fR\ ]
114
-[\ \fB\-\-cert\fR\ \fIfile\fR\ ]
115
-[\ \fB\-\-chroot\fR\ \fIdir\fR\ ]
116
-[\ \fB\-\-cipher\fR\ \fIalg\fR\ ]
117
-[\ \fB\-\-client\-cert\-not\-required\fR\ ]
118
-[\ \fB\-\-client\-config\-dir\fR\ \fIdir\fR\ ]
119
-[\ \fB\-\-client\-connect\fR\ \fIscript\fR\ ]
120
-[\ \fB\-\-client\-disconnect\fR\ ]
121
-[\ \fB\-\-client\-to\-client\fR\ ]
122
-[\ \fB\-\-client\fR\ ]
123
-[\ \fB\-\-comp\-lzo\fR\ \fI[mode]\fR\ ]
124
-[\ \fB\-\-comp\-noadapt\fR\ ]
125
-[\ \fB\-\-config\fR\ \fIfile\fR\ ]
126
-[\ \fB\-\-connect\-freq\fR\ \fIn\ sec\fR\ ]
127
-[\ \fB\-\-connect\-retry\fR\ \fIn\fR\ ]
128
-[\ \fB\-\-connect\-retry\-max\fR\ \fIn\fR\ ]
129
-[\ \fB\-\-crl\-verify\fR\ \fIcrl\fR\ ]
130
-[\ \fB\-\-cryptoapicert\fR\ \fIselect\-string\fR\ ]
131
-[\ \fB\-\-daemon\fR\ \fI[progname]\fR\ ]
132
-[\ \fB\-\-dev\-node\fR\ \fInode\fR\ ]
133
-[\ \fB\-\-dev\-type\fR\ \fIdevice\-type\fR\ ]
134
-[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\ |\ null\fR\ ]
135
-[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\fR\ ]
136
-[\ \fB\-\-dh\fR\ \fIfile\fR\ ]
137
-[\ \fB\-\-dhcp\-option\fR\ \fItype\ [parm]\fR\ ]
138
-[\ \fB\-\-dhcp\-release\fR\ ]
139
-[\ \fB\-\-dhcp\-renew\fR\ ]
140
-[\ \fB\-\-disable\-occ\fR\ ]
141
-[\ \fB\-\-disable\fR\ ]
142
-[\ \fB\-\-down\-pre\fR\ ]
143
-[\ \fB\-\-down\fR\ \fIcmd\fR\ ]
144
-[\ \fB\-\-duplicate\-cn\fR\ ]
145
-[\ \fB\-\-echo\fR\ \fI[parms...]\fR\ ]
146
-[\ \fB\-\-engine\fR\ \fI[engine\-name]\fR\ ]
147
-[\ \fB\-\-explicit\-exit\-notify\fR\ \fI[n]\fR\ ]
148
-[\ \fB\-\-fast\-io\fR\ ]
149
-[\ \fB\-\-float\fR\ ]
150
-[\ \fB\-\-fragment\fR\ \fImax\fR\ ]
151
-[\ \fB\-\-genkey\fR\ ]
152
-[\ \fB\-\-group\fR\ \fIgroup\fR\ ]
153
-[\ \fB\-\-hand\-window\fR\ \fIn\fR\ ]
154
-[\ \fB\-\-hash\-size\fR\ \fIr\ v\fR\ ]
155
-[\ \fB\-\-help\fR\ ]
156
-[\ \fB\-\-http\-proxy\-option\fR\ \fItype\ [parm]\fR\ ]
157
-[\ \fB\-\-http\-proxy\-retry\fR\ ]
158
-[\ \fB\-\-http\-proxy\-timeout\fR\ \fIn\fR\ ]
159
-[\ \fB\-\-http\-proxy\fR\ \fIserver\ port\ [authfile]\ [auth\-method]\fR\ ]
160
-[\ \fB\-\-ifconfig\-noexec\fR\ ]
161
-[\ \fB\-\-ifconfig\-nowarn\fR\ ]
162
-[\ \fB\-\-ifconfig\-pool\-linear\fR\ ]
163
-[\ \fB\-\-ifconfig\-pool\-persist\fR\ \fIfile\ [seconds]\fR\ ]
164
-[\ \fB\-\-ifconfig\-pool\fR\ \fIstart\-IP\ end\-IP\ [netmask]\fR\ ]
165
-[\ \fB\-\-ifconfig\-push\fR\ \fIlocal\ remote\-netmask\fR\ ]
166
-[\ \fB\-\-ifconfig\fR\ \fIl\ rn\fR\ ]
167
-[\ \fB\-\-inactive\fR\ \fIn\ [bytes]\fR\ ]
168
-[\ \fB\-\-inetd\fR\ \fI[wait|nowait]\ [progname]\fR\ ]
169
-[\ \fB\-\-ip\-win32\fR\ \fImethod\fR\ ]
170
-[\ \fB\-\-ipchange\fR\ \fIcmd\fR\ ]
171
-[\ \fB\-\-iproute\fR\ \fIcmd\fR\ ]
172
-[\ \fB\-\-iroute\fR\ \fInetwork\ [netmask]\fR\ ]
173
-[\ \fB\-\-keepalive\fR\ \fIn\ m\fR\ ]
174
-[\ \fB\-\-key\-method\fR\ \fIm\fR\ ]
175
-[\ \fB\-\-key\fR\ \fIfile\fR\ ]
176
-[\ \fB\-\-keysize\fR\ \fIn\fR\ ]
177
-[\ \fB\-\-learn\-address\fR\ \fIcmd\fR\ ]
178
-[\ \fB\-\-link\-mtu\fR\ \fIn\fR\ ]
179
-[\ \fB\-\-local\fR\ \fIhost\fR\ ]
180
-[\ \fB\-\-log\-append\fR\ \fIfile\fR\ ]
181
-[\ \fB\-\-log\fR\ \fIfile\fR\ ]
182
-[\ \fB\-\-suppress-timestamps\fR\ ]
183
-[\ \fB\-\-lport\fR\ \fIport\fR\ ]
184
-[\ \fB\-\-management\-client\-auth\fR\ ]
185
-[\ \fB\-\-management\-client\-group\fR\ \fIg\fR\ ]
186
-[\ \fB\-\-management\-client\-pf\fR\ ]
187
-[\ \fB\-\-management\-client\-user\fR\ \fIu\fR\ ]
188
-[\ \fB\-\-management\-forget\-disconnect\fR\ ]
189
-[\ \fB\-\-management\-hold\fR\ ]
190
-[\ \fB\-\-management\-log\-cache\fR\ \fIn\fR\ ]
191
-[\ \fB\-\-management\-signal\fR\ ]
192
-[\ \fB\-\-management\-query\-passwords\fR\ ]
193
-[\ \fB\-\-management\fR\ \fIIP\ port\ [pw\-file]\fR\ ]
194
-[\ \fB\-\-max\-clients\fR\ \fIn\fR\ ]
195
-[\ \fB\-\-max\-routes\-per\-client\fR\ \fIn\fR\ ]
196
-[\ \fB\-\-mktun\fR\ ]
197
-[\ \fB\-\-mlock\fR\ ]
198
-[\ \fB\-\-mode\fR\ \fIm\fR\ ]
199
-[\ \fB\-\-mssfix\fR\ \fImax\fR\ ]
200
-[\ \fB\-\-mtu\-disc\fR\ \fItype\fR\ ]
201
-[\ \fB\-\-mtu\-test\fR\ ]
202
-[\ \fB\-\-mute\-replay\-warnings\fR\ ]
203
-[\ \fB\-\-mute\fR\ \fIn\fR\ ]
204
-[\ \fB\-\-nice\fR\ \fIn\fR\ ]
205
-[\ \fB\-\-no\-iv\fR\ ]
206
-[\ \fB\-\-no\-name\-remapping\fR\ ]
207
-[\ \fB\-\-no\-replay\fR\ ]
208
-[\ \fB\-\-bind\fR\ ]
209
-[\ \fB\-\-nobind\fR\ ]
210
-[\ \fB\-\-ns\-cert\-type\fR\ \fIclient|server\fR\ ]
211
-[\ \fB\-\-passtos\fR\ ]
212
-[\ \fB\-\-pause\-exit\fR\ ]
213
-[\ \fB\-\-persist\-key\fR\ ]
214
-[\ \fB\-\-persist\-local\-ip\fR\ ]
215
-[\ \fB\-\-persist\-remote\-ip\fR\ ]
216
-[\ \fB\-\-persist\-tun\fR\ ]
217
-[\ \fB\-\-ping\-exit\fR\ \fIn\fR\ ]
218
-[\ \fB\-\-ping\-restart\fR\ \fIn\fR\ ]
219
-[\ \fB\-\-ping\-timer\-rem\fR\ ]
220
-[\ \fB\-\-ping\fR\ \fIn\fR\ ]
221
-[\ \fB\-\-pkcs11\-cert\-private\fR\ \fI[0|1]...\fR\ ]
222
-[\ \fB\-\-pkcs11\-id\fR\ \fIname\fR\ ]
223
-[\ \fB\-\-pkcs11\-id\-management\fR\ ]
224
-[\ \fB\-\-pkcs11\-pin\-cache\fR\ \fIseconds\fR\ ]
225
-[\ \fB\-\-pkcs11\-private\-mode\fR\ \fImode...\fR\ ]
226
-[\ \fB\-\-pkcs11\-protected\-authentication\fR\ \fI[0|1]...\fR\ ]
227
-[\ \fB\-\-pkcs11\-providers\fR\ \fIprovider...\fR\ ]
228
-[\ \fB\-\-pkcs12\fR\ \fIfile\fR\ ]
229
-[\ \fB\-\-plugin\fR\ \fImodule\-pathname\ init\-string\fR\ ]
230
-[\ \fB\-\-port\fR\ \fIport\fR\ ]
231
-[\ \fB\-\-port\-share\fR\ \fIhost\ port\fR\ ]
232
-[\ \fB\-\-proto\fR\ \fIp\fR\ ]
233
-[\ \fB\-\-pull\fR\ ]
234
-[\ \fB\-\-push\-reset\fR\ ]
235
-[\ \fB\-\-push\fR\ \fI"option"\fR\ ]
236
-[\ \fB\-\-rcvbuf\fR\ \fIsize\fR\ ]
237
-[\ \fB\-\-redirect\-gateway\fR\ \fIflags...\fR\ ]
238
-[\ \fB\-\-remap\-usr1\fR\ \fIsignal\fR\ ]
239
-[\ \fB\-\-remote\-random\fR\ ]
240
-[\ \fB\-\-remote\fR\ \fIhost\ [port]\fR\ ]
241
-[\ \fB\-\-remote\-cert\-ku\ \fIv...\fR\ ]
242
-[\ \fB\-\-remote\-cert\-eku\ \fIoid\fR\ ]
243
-[\ \fB\-\-remote\-cert\-tls\ \fIt\fR\ ]
244
-[\ \fB\-\-reneg\-bytes\fR\ \fIn\fR\ ]
245
-[\ \fB\-\-reneg\-pkts\fR\ \fIn\fR\ ]
246
-[\ \fB\-\-reneg\-sec\fR\ \fIn\fR\ ]
247
-[\ \fB\-\-replay\-persist\fR\ \fIfile\fR\ ]
248
-[\ \fB\-\-replay\-window\fR\ \fIn\ [t]\fR\ ]
249
-[\ \fB\-\-resolv\-retry\fR\ \fIn\fR\ ]
250
-[\ \fB\-\-rmtun\fR\ ]
251
-[\ \fB\-\-route\-delay\fR\ \fI[n]\ [w]\fR\ ]
252
-[\ \fB\-\-route\-gateway\fR\ \fIgw\fR\ ]
253
-[\ \fB\-\-route\-method\fR\ \fIm\fR\ ]
254
-[\ \fB\-\-route\-metric\fR\ \fIm\fR\ ]
255
-[\ \fB\-\-route\-noexec\fR\ ]
256
-[\ \fB\-\-route\-nopull\fR\ ]
257
-[\ \fB\-\-route\-up\fR\ \fIcmd\fR\ ]
258
-[\ \fB\-\-route\fR\ \fInetwork\ [netmask]\ [gateway]\ [metric]\fR\ ]
259
-[\ \fB\-\-rport\fR\ \fIport\fR\ ]
260
-[\ \fB\-\-script\-security\fR\ \fIlevel\fR\ ]
261
-[\ \fB\-\-secret\fR\ \fIfile\ [direction]\fR\ ]
262
-[\ \fB\-\-secret\fR\ \fIfile\fR\ ]
263
-[\ \fB\-\-server\-bridge\fR\ \fIgateway\ netmask\ pool\-start\-IP\ pool\-end\-IP\fR\ ]
264
-[\ \fB\-\-server\fR\ \fInetwork\ netmask\fR\ ]
265
-[\ \fB\-\-service\fR\ \fIexit\-event\ [0|1]\fR\ ]
266
-[\ \fB\-\-setenv\fR\ \fIname\ value\fR\ ]
267
-[\ \fB\-\-setenv\-safe\fR\ \fIname\ value\fR\ ]
268
-[\ \fB\-\-shaper\fR\ \fIn\fR\ ]
269
-[\ \fB\-\-show\-adapters\fR\ ]
270
-[\ \fB\-\-show\-ciphers\fR\ ]
271
-[\ \fB\-\-show\-digests\fR\ ]
272
-[\ \fB\-\-show\-engines\fR\ ]
273
-[\ \fB\-\-show\-pkcs11\-ids\fR\ \fIprovider\ [cert_private]\fR\ ]
274
-[\ \fB\-\-show\-net\-up\fR\ ]
275
-[\ \fB\-\-show\-net\fR\ ]
276
-[\ \fB\-\-show\-tls\fR\ ]
277
-[\ \fB\-\-show\-valid\-subnets\fR\ ]
278
-[\ \fB\-\-single\-session\fR\ ]
279
-[\ \fB\-\-sndbuf\fR\ \fIsize\fR\ ]
280
-[\ \fB\-\-socks\-proxy\-retry\fR\ ]
281
-[\ \fB\-\-socks\-proxy\fR\ \fIserver\ [port]\fR\ ]
282
-[\ \fB\-\-status\fR\ \fIfile\ [n]\fR\ ]
283
-[\ \fB\-\-status\-version\fR\ \fIn\fR\ ]
284
-[\ \fB\-\-syslog\fR\ \fI[progname]\fR\ ]
285
-[\ \fB\-\-tap\-sleep\fR\ \fIn\fR\ ]
286
-[\ \fB\-\-tcp\-queue\-limit\fR\ \fIn\fR\ ]
287
-[\ \fB\-\-test\-crypto\fR\ ]
288
-[\ \fB\-\-tls\-auth\fR\ \fIfile\ [direction]\fR\ ]
289
-[\ \fB\-\-tls\-cipher\fR\ \fIl\fR\ ]
290
-[\ \fB\-\-tls\-client\fR\ ]
291
-[\ \fB\-\-tls\-exit\fR\ ]
292
-[\ \fB\-\-tls\-remote\fR\ \fIx509name\fR\ ]
293
-[\ \fB\-\-tls\-server\fR\ ]
294
-[\ \fB\-\-tls\-timeout\fR\ \fIn\fR\ ]
295
-[\ \fB\-\-tls\-verify\fR\ \fIcmd\fR\ ]
296
-[\ \fB\-\-tmp\-dir\fR\ \fIdir\fR\ ]
297
-[\ \fB\-\-topology\fR\ \fImode\fR\ ]
298
-[\ \fB\-\-tran\-window\fR\ \fIn\fR\ ]
299
-[\ \fB\-\-tun\-ipv6\fR\ ]
300
-[\ \fB\-\-tun\-mtu\-extra\fR\ \fIn\fR\ ]
301
-[\ \fB\-\-tun\-mtu\fR\ \fIn\fR\ ]
302
-[\ \fB\-\-txqueuelen\fR\ \fIn\fR\ ]
303
-[\ \fB\-\-up\-delay\fR\ ]
304
-[\ \fB\-\-up\-restart\fR\ ]
305
-[\ \fB\-\-up\fR\ \fIcmd\fR\ ]
306
-[\ \fB\-\-user\fR\ \fIuser\fR\ ]
307
-[\ \fB\-\-username\-as\-common\-name\fR\ ]
308
-[\ \fB\-\-verb\fR\ \fIn\fR\ ]
309
-[\ \fB\-\-win\-sys\fR\ \fIpath|'env'\fR\ ]
310
-[\ \fB\-\-writepid\fR\ \fIfile\fR\ ]
39
+.B openvpn [ options ... ]
311 40
 .in -4
312 41
 .ti +4
313 42
 .hy