aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjames <james@e7ae566f-a301-0410-adde-c780ea21d3b5>2008-11-18 03:29:44 +0000
committerjames <james@e7ae566f-a301-0410-adde-c780ea21d3b5>2008-11-18 03:29:44 +0000
commit04663e4205b0c9eaaa4a5eee70fc5d23ca4bc44d (patch)
tree8fc2aec6cf01f67d73d4287089935b996538f094
parentMinor options check fix: --no-name-remapping is a (diff)
downloadopenvpn-04663e4205b0c9eaaa4a5eee70fc5d23ca4bc44d.tar.xz
Cleaned up man page synopsis.
git-svn-id: http://svn.openvpn.net/projects/openvpn/branches/BETA21/openvpn@3507 e7ae566f-a301-0410-adde-c780ea21d3b5
-rw-r--r--openvpn.8275
1 files changed, 2 insertions, 273 deletions
diff --git a/openvpn.8 b/openvpn.8
index c78ad4b..790501d 100644
--- a/openvpn.8
+++ b/openvpn.8
@@ -26,7 +26,7 @@
.\" LP paragraph
.\" IP indented paragraph
.\" TP hanging label
-.TH openvpn 8 "4 November 2008"
+.TH openvpn 8 "17 November 2008"
.\"*********************************************************
.SH NAME
openvpn \- secure IP tunnel daemon.
@@ -36,278 +36,7 @@ openvpn \- secure IP tunnel daemon.
.nh
.in +4
.ti -4
-.B openvpn
-[\ \fB\-\-help\fR\ ]
-.in -4
-.ti +4
-.hy
-
-.nh
-.in +4
-.ti -4
-.B openvpn
-[\ \fB\-\-config\fR\ \fIfile\fR\ ]
-.in -4
-.ti +4
-.hy
-
-.nh
-.in +4
-.ti -4
-.B openvpn
-[\ \fB\-\-genkey\fR\ ]
-[\ \fB\-\-secret\fR\ \fIfile\fR\ ]
-.in -4
-.ti +4
-.hy
-
-.nh
-.in +4
-.ti -4
-.B openvpn
-[\ \fB\-\-mktun\fR\ ]
-[\ \fB\-\-rmtun\fR\ ]
-[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\fR\ ]
-[\ \fB\-\-dev\-type\fR\ \fIdevice\-type\fR\ ]
-[\ \fB\-\-dev\-node\fR\ \fInode\fR\ ]
-[\ \fB\-\-lladdr\fR\ \fIaddress\fR\ ]
-[\ \fB\-\-user\fR\ \fIuser\fR\ ]
-[\ \fB\-\-group\fR\ \fIgroup\fR\ ]
-.in -4
-.ti +4
-.hy
-
-.nh
-.in +4
-.ti -4
-.B openvpn
-[\ \fB\-\-test\-crypto\fR\ ]
-[\ \fB\-\-secret\fR\ \fIfile\fR\ ]
-[\ \fB\-\-auth\fR\ \fIalg\fR\ ]
-[\ \fB\-\-cipher\fR\ \fIalg\fR\ ]
-[\ \fB\-\-engine\fR\ ]
-[\ \fB\-\-keysize\fR\ \fIn\fR\ ]
-[\ \fB\-\-no\-replay\fR\ ]
-[\ \fB\-\-no\-iv\fR\ ]
-.in -4
-.ti +4
-.hy
-
-.nh
-.in +4
-.ti -4
-.B openvpn
-[\ \fB\-\-allow\-nonadmin\fR\ \fI[TAP\-adapter]\fR\ ]
-[\ \fB\-\-allow\-pull\-fqdn\fR\ ]
-[\ \fB\-\-askpass\fR\ \fI[file]\fR\ ]
-[\ \fB\-\-auth\-nocache\fR\ ]
-[\ \fB\-\-auth\-retry\fR\ \fItype\fR\ ]
-[\ \fB\-\-auth\-user\-pass\-optional\fR\ ]
-[\ \fB\-\-auth\-user\-pass\-verify\fR\ \fIscript\fR\ ]
-[\ \fB\-\-auth\-user\-pass\fR\ \fIup\fR\ ]
-[\ \fB\-\-auth\fR\ \fIalg\fR\ ]
-[\ \fB\-\-auto\-proxy\fR\ ]
-[\ \fB\-\-bcast\-buffers\fR\ \fIn\fR\ ]
-[\ \fB\-\-ca\fR\ \fIfile\fR\ ]
-[\ \fB\-\-ccd\-exclusive\fR\ ]
-[\ \fB\-\-cd\fR\ \fIdir\fR\ ]
-[\ \fB\-\-cert\fR\ \fIfile\fR\ ]
-[\ \fB\-\-chroot\fR\ \fIdir\fR\ ]
-[\ \fB\-\-cipher\fR\ \fIalg\fR\ ]
-[\ \fB\-\-client\-cert\-not\-required\fR\ ]
-[\ \fB\-\-client\-config\-dir\fR\ \fIdir\fR\ ]
-[\ \fB\-\-client\-connect\fR\ \fIscript\fR\ ]
-[\ \fB\-\-client\-disconnect\fR\ ]
-[\ \fB\-\-client\-to\-client\fR\ ]
-[\ \fB\-\-client\fR\ ]
-[\ \fB\-\-comp\-lzo\fR\ \fI[mode]\fR\ ]
-[\ \fB\-\-comp\-noadapt\fR\ ]
-[\ \fB\-\-config\fR\ \fIfile\fR\ ]
-[\ \fB\-\-connect\-freq\fR\ \fIn\ sec\fR\ ]
-[\ \fB\-\-connect\-retry\fR\ \fIn\fR\ ]
-[\ \fB\-\-connect\-retry\-max\fR\ \fIn\fR\ ]
-[\ \fB\-\-crl\-verify\fR\ \fIcrl\fR\ ]
-[\ \fB\-\-cryptoapicert\fR\ \fIselect\-string\fR\ ]
-[\ \fB\-\-daemon\fR\ \fI[progname]\fR\ ]
-[\ \fB\-\-dev\-node\fR\ \fInode\fR\ ]
-[\ \fB\-\-dev\-type\fR\ \fIdevice\-type\fR\ ]
-[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\ |\ null\fR\ ]
-[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\fR\ ]
-[\ \fB\-\-dh\fR\ \fIfile\fR\ ]
-[\ \fB\-\-dhcp\-option\fR\ \fItype\ [parm]\fR\ ]
-[\ \fB\-\-dhcp\-release\fR\ ]
-[\ \fB\-\-dhcp\-renew\fR\ ]
-[\ \fB\-\-disable\-occ\fR\ ]
-[\ \fB\-\-disable\fR\ ]
-[\ \fB\-\-down\-pre\fR\ ]
-[\ \fB\-\-down\fR\ \fIcmd\fR\ ]
-[\ \fB\-\-duplicate\-cn\fR\ ]
-[\ \fB\-\-echo\fR\ \fI[parms...]\fR\ ]
-[\ \fB\-\-engine\fR\ \fI[engine\-name]\fR\ ]
-[\ \fB\-\-explicit\-exit\-notify\fR\ \fI[n]\fR\ ]
-[\ \fB\-\-fast\-io\fR\ ]
-[\ \fB\-\-float\fR\ ]
-[\ \fB\-\-fragment\fR\ \fImax\fR\ ]
-[\ \fB\-\-genkey\fR\ ]
-[\ \fB\-\-group\fR\ \fIgroup\fR\ ]
-[\ \fB\-\-hand\-window\fR\ \fIn\fR\ ]
-[\ \fB\-\-hash\-size\fR\ \fIr\ v\fR\ ]
-[\ \fB\-\-help\fR\ ]
-[\ \fB\-\-http\-proxy\-option\fR\ \fItype\ [parm]\fR\ ]
-[\ \fB\-\-http\-proxy\-retry\fR\ ]
-[\ \fB\-\-http\-proxy\-timeout\fR\ \fIn\fR\ ]
-[\ \fB\-\-http\-proxy\fR\ \fIserver\ port\ [authfile]\ [auth\-method]\fR\ ]
-[\ \fB\-\-ifconfig\-noexec\fR\ ]
-[\ \fB\-\-ifconfig\-nowarn\fR\ ]
-[\ \fB\-\-ifconfig\-pool\-linear\fR\ ]
-[\ \fB\-\-ifconfig\-pool\-persist\fR\ \fIfile\ [seconds]\fR\ ]
-[\ \fB\-\-ifconfig\-pool\fR\ \fIstart\-IP\ end\-IP\ [netmask]\fR\ ]
-[\ \fB\-\-ifconfig\-push\fR\ \fIlocal\ remote\-netmask\fR\ ]
-[\ \fB\-\-ifconfig\fR\ \fIl\ rn\fR\ ]
-[\ \fB\-\-inactive\fR\ \fIn\ [bytes]\fR\ ]
-[\ \fB\-\-inetd\fR\ \fI[wait|nowait]\ [progname]\fR\ ]
-[\ \fB\-\-ip\-win32\fR\ \fImethod\fR\ ]
-[\ \fB\-\-ipchange\fR\ \fIcmd\fR\ ]
-[\ \fB\-\-iproute\fR\ \fIcmd\fR\ ]
-[\ \fB\-\-iroute\fR\ \fInetwork\ [netmask]\fR\ ]
-[\ \fB\-\-keepalive\fR\ \fIn\ m\fR\ ]
-[\ \fB\-\-key\-method\fR\ \fIm\fR\ ]
-[\ \fB\-\-key\fR\ \fIfile\fR\ ]
-[\ \fB\-\-keysize\fR\ \fIn\fR\ ]
-[\ \fB\-\-learn\-address\fR\ \fIcmd\fR\ ]
-[\ \fB\-\-link\-mtu\fR\ \fIn\fR\ ]
-[\ \fB\-\-local\fR\ \fIhost\fR\ ]
-[\ \fB\-\-log\-append\fR\ \fIfile\fR\ ]
-[\ \fB\-\-log\fR\ \fIfile\fR\ ]
-[\ \fB\-\-suppress-timestamps\fR\ ]
-[\ \fB\-\-lport\fR\ \fIport\fR\ ]
-[\ \fB\-\-management\-client\-auth\fR\ ]
-[\ \fB\-\-management\-client\-group\fR\ \fIg\fR\ ]
-[\ \fB\-\-management\-client\-pf\fR\ ]
-[\ \fB\-\-management\-client\-user\fR\ \fIu\fR\ ]
-[\ \fB\-\-management\-forget\-disconnect\fR\ ]
-[\ \fB\-\-management\-hold\fR\ ]
-[\ \fB\-\-management\-log\-cache\fR\ \fIn\fR\ ]
-[\ \fB\-\-management\-signal\fR\ ]
-[\ \fB\-\-management\-query\-passwords\fR\ ]
-[\ \fB\-\-management\fR\ \fIIP\ port\ [pw\-file]\fR\ ]
-[\ \fB\-\-max\-clients\fR\ \fIn\fR\ ]
-[\ \fB\-\-max\-routes\-per\-client\fR\ \fIn\fR\ ]
-[\ \fB\-\-mktun\fR\ ]
-[\ \fB\-\-mlock\fR\ ]
-[\ \fB\-\-mode\fR\ \fIm\fR\ ]
-[\ \fB\-\-mssfix\fR\ \fImax\fR\ ]
-[\ \fB\-\-mtu\-disc\fR\ \fItype\fR\ ]
-[\ \fB\-\-mtu\-test\fR\ ]
-[\ \fB\-\-mute\-replay\-warnings\fR\ ]
-[\ \fB\-\-mute\fR\ \fIn\fR\ ]
-[\ \fB\-\-nice\fR\ \fIn\fR\ ]
-[\ \fB\-\-no\-iv\fR\ ]
-[\ \fB\-\-no\-name\-remapping\fR\ ]
-[\ \fB\-\-no\-replay\fR\ ]
-[\ \fB\-\-bind\fR\ ]
-[\ \fB\-\-nobind\fR\ ]
-[\ \fB\-\-ns\-cert\-type\fR\ \fIclient|server\fR\ ]
-[\ \fB\-\-passtos\fR\ ]
-[\ \fB\-\-pause\-exit\fR\ ]
-[\ \fB\-\-persist\-key\fR\ ]
-[\ \fB\-\-persist\-local\-ip\fR\ ]
-[\ \fB\-\-persist\-remote\-ip\fR\ ]
-[\ \fB\-\-persist\-tun\fR\ ]
-[\ \fB\-\-ping\-exit\fR\ \fIn\fR\ ]
-[\ \fB\-\-ping\-restart\fR\ \fIn\fR\ ]
-[\ \fB\-\-ping\-timer\-rem\fR\ ]
-[\ \fB\-\-ping\fR\ \fIn\fR\ ]
-[\ \fB\-\-pkcs11\-cert\-private\fR\ \fI[0|1]...\fR\ ]
-[\ \fB\-\-pkcs11\-id\fR\ \fIname\fR\ ]
-[\ \fB\-\-pkcs11\-id\-management\fR\ ]
-[\ \fB\-\-pkcs11\-pin\-cache\fR\ \fIseconds\fR\ ]
-[\ \fB\-\-pkcs11\-private\-mode\fR\ \fImode...\fR\ ]
-[\ \fB\-\-pkcs11\-protected\-authentication\fR\ \fI[0|1]...\fR\ ]
-[\ \fB\-\-pkcs11\-providers\fR\ \fIprovider...\fR\ ]
-[\ \fB\-\-pkcs12\fR\ \fIfile\fR\ ]
-[\ \fB\-\-plugin\fR\ \fImodule\-pathname\ init\-string\fR\ ]
-[\ \fB\-\-port\fR\ \fIport\fR\ ]
-[\ \fB\-\-port\-share\fR\ \fIhost\ port\fR\ ]
-[\ \fB\-\-proto\fR\ \fIp\fR\ ]
-[\ \fB\-\-pull\fR\ ]
-[\ \fB\-\-push\-reset\fR\ ]
-[\ \fB\-\-push\fR\ \fI"option"\fR\ ]
-[\ \fB\-\-rcvbuf\fR\ \fIsize\fR\ ]
-[\ \fB\-\-redirect\-gateway\fR\ \fIflags...\fR\ ]
-[\ \fB\-\-remap\-usr1\fR\ \fIsignal\fR\ ]
-[\ \fB\-\-remote\-random\fR\ ]
-[\ \fB\-\-remote\fR\ \fIhost\ [port]\fR\ ]
-[\ \fB\-\-remote\-cert\-ku\ \fIv...\fR\ ]
-[\ \fB\-\-remote\-cert\-eku\ \fIoid\fR\ ]
-[\ \fB\-\-remote\-cert\-tls\ \fIt\fR\ ]
-[\ \fB\-\-reneg\-bytes\fR\ \fIn\fR\ ]
-[\ \fB\-\-reneg\-pkts\fR\ \fIn\fR\ ]
-[\ \fB\-\-reneg\-sec\fR\ \fIn\fR\ ]
-[\ \fB\-\-replay\-persist\fR\ \fIfile\fR\ ]
-[\ \fB\-\-replay\-window\fR\ \fIn\ [t]\fR\ ]
-[\ \fB\-\-resolv\-retry\fR\ \fIn\fR\ ]
-[\ \fB\-\-rmtun\fR\ ]
-[\ \fB\-\-route\-delay\fR\ \fI[n]\ [w]\fR\ ]
-[\ \fB\-\-route\-gateway\fR\ \fIgw\fR\ ]
-[\ \fB\-\-route\-method\fR\ \fIm\fR\ ]
-[\ \fB\-\-route\-metric\fR\ \fIm\fR\ ]
-[\ \fB\-\-route\-noexec\fR\ ]
-[\ \fB\-\-route\-nopull\fR\ ]
-[\ \fB\-\-route\-up\fR\ \fIcmd\fR\ ]
-[\ \fB\-\-route\fR\ \fInetwork\ [netmask]\ [gateway]\ [metric]\fR\ ]
-[\ \fB\-\-rport\fR\ \fIport\fR\ ]
-[\ \fB\-\-script\-security\fR\ \fIlevel\fR\ ]
-[\ \fB\-\-secret\fR\ \fIfile\ [direction]\fR\ ]
-[\ \fB\-\-secret\fR\ \fIfile\fR\ ]
-[\ \fB\-\-server\-bridge\fR\ \fIgateway\ netmask\ pool\-start\-IP\ pool\-end\-IP\fR\ ]
-[\ \fB\-\-server\fR\ \fInetwork\ netmask\fR\ ]
-[\ \fB\-\-service\fR\ \fIexit\-event\ [0|1]\fR\ ]
-[\ \fB\-\-setenv\fR\ \fIname\ value\fR\ ]
-[\ \fB\-\-setenv\-safe\fR\ \fIname\ value\fR\ ]
-[\ \fB\-\-shaper\fR\ \fIn\fR\ ]
-[\ \fB\-\-show\-adapters\fR\ ]
-[\ \fB\-\-show\-ciphers\fR\ ]
-[\ \fB\-\-show\-digests\fR\ ]
-[\ \fB\-\-show\-engines\fR\ ]
-[\ \fB\-\-show\-pkcs11\-ids\fR\ \fIprovider\ [cert_private]\fR\ ]
-[\ \fB\-\-show\-net\-up\fR\ ]
-[\ \fB\-\-show\-net\fR\ ]
-[\ \fB\-\-show\-tls\fR\ ]
-[\ \fB\-\-show\-valid\-subnets\fR\ ]
-[\ \fB\-\-single\-session\fR\ ]
-[\ \fB\-\-sndbuf\fR\ \fIsize\fR\ ]
-[\ \fB\-\-socks\-proxy\-retry\fR\ ]
-[\ \fB\-\-socks\-proxy\fR\ \fIserver\ [port]\fR\ ]
-[\ \fB\-\-status\fR\ \fIfile\ [n]\fR\ ]
-[\ \fB\-\-status\-version\fR\ \fIn\fR\ ]
-[\ \fB\-\-syslog\fR\ \fI[progname]\fR\ ]
-[\ \fB\-\-tap\-sleep\fR\ \fIn\fR\ ]
-[\ \fB\-\-tcp\-queue\-limit\fR\ \fIn\fR\ ]
-[\ \fB\-\-test\-crypto\fR\ ]
-[\ \fB\-\-tls\-auth\fR\ \fIfile\ [direction]\fR\ ]
-[\ \fB\-\-tls\-cipher\fR\ \fIl\fR\ ]
-[\ \fB\-\-tls\-client\fR\ ]
-[\ \fB\-\-tls\-exit\fR\ ]
-[\ \fB\-\-tls\-remote\fR\ \fIx509name\fR\ ]
-[\ \fB\-\-tls\-server\fR\ ]
-[\ \fB\-\-tls\-timeout\fR\ \fIn\fR\ ]
-[\ \fB\-\-tls\-verify\fR\ \fIcmd\fR\ ]
-[\ \fB\-\-tmp\-dir\fR\ \fIdir\fR\ ]
-[\ \fB\-\-topology\fR\ \fImode\fR\ ]
-[\ \fB\-\-tran\-window\fR\ \fIn\fR\ ]
-[\ \fB\-\-tun\-ipv6\fR\ ]
-[\ \fB\-\-tun\-mtu\-extra\fR\ \fIn\fR\ ]
-[\ \fB\-\-tun\-mtu\fR\ \fIn\fR\ ]
-[\ \fB\-\-txqueuelen\fR\ \fIn\fR\ ]
-[\ \fB\-\-up\-delay\fR\ ]
-[\ \fB\-\-up\-restart\fR\ ]
-[\ \fB\-\-up\fR\ \fIcmd\fR\ ]
-[\ \fB\-\-user\fR\ \fIuser\fR\ ]
-[\ \fB\-\-username\-as\-common\-name\fR\ ]
-[\ \fB\-\-verb\fR\ \fIn\fR\ ]
-[\ \fB\-\-win\-sys\fR\ \fIpath|'env'\fR\ ]
-[\ \fB\-\-writepid\fR\ \fIfile\fR\ ]
+.B openvpn [ options ... ]
.in -4
.ti +4
.hy