Remove useless dash escapes from the man-page
PATCH 1/1 Remove useless dash escapes from the man-page
From: Samuli Seppänen <[email protected]...>
This patch is against the release/2.3 branch
Trac: 512
Signed-off-by Samuli Seppänen <[email protected]...>
--- doc/openvpn.8 | 1800 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 900 insertions(+), 900 deletions(-)
doc/openvpn.8 +900 -900
@@ -37,7 +37,7 @@ .TH openvpn 8 "17 November 2008" .\"********************************************************* .SH NAME -openvpn \- secure IP tunnel daemon. +openvpn - secure IP tunnel daemon. .\"********************************************************* .SH SYNOPSIS .ft 3
@@ -97,25 +97,25 @@ with a relatively lightweight footprint. .SH OPTIONS OpenVPN allows any option to be placed either on the command line or in a configuration file. Though all command line options are preceded -by a double-leading-dash ("\-\-"), this prefix can be removed when +by a double-leading-dash ("--"), this prefix can be removed when an option is placed in a configuration file. .\"********************************************************* .TP -.B \-\-help +.B --help Show options. .\"********************************************************* .TP -.B \-\-config file +.B --config file Load additional config options from .B file where each line corresponds to one command line option, -but with the leading '\-\-' removed. +but with the leading '--' removed. If -.B \-\-config file +.B --config file is the only option to the openvpn command, the -.B \-\-config +.B --config can be removed, and the command can be given as .B openvpn file
@@ -187,25 +187,25 @@ secret static.key .\"********************************************************* .SS Tunnel Options: .TP -.B \-\-mode m +.B --mode m Set OpenVPN major mode. By default, OpenVPN runs in point-to-point mode ("p2p"). OpenVPN 2.0 introduces a new mode ("server") which implements a multi-client server capability. .\"********************************************************* .TP -.B \-\-local host +.B --local host Local host name or IP address for bind. If specified, OpenVPN will bind to this address only. If unspecified, OpenVPN will bind to all interfaces. .\"********************************************************* .TP -.B \-\-remote host [port] [proto] +.B --remote host [port] [proto] Remote host name or IP address. On the client, multiple -.B \-\-remote +.B --remote options may be specified for redundancy, each referring to a different OpenVPN server. Specifying multiple -.B \-\-remote +.B --remote options for this purpose is a special case of the more general connection-profile feature. See the .B <connection>
@@ -214,7 +214,7 @@ documentation below. The OpenVPN client will try to connect to a server at .B host:port in the order specified by the list of -.B \-\-remote +.B --remote options. .B proto
@@ -229,18 +229,18 @@ one server. Note that since UDP is connectionless, connection failure is defined by the -.B \-\-ping +.B --ping and -.B \-\-ping-restart +.B --ping-restart options. Note the following corner case: If you use multiple -.B \-\-remote +.B --remote options, AND you are dropping root privileges on the client with -.B \-\-user +.B --user and/or -.B \-\-group, +.B --group, AND the client is running a non-Windows OS, if the client needs to switch to a different server, and that server pushes back different TUN/TAP or route settings, the client may lack
@@ -248,7 +248,7 @@ the necessary privileges to close and reopen the TUN/TAP interface. This could cause the client to exit with a fatal error. If -.B \-\-remote +.B --remote is unspecified, OpenVPN will listen for packets from any IP address, but will not act on those packets unless they pass all authentication tests. This requirement for authentication
@@ -257,7 +257,7 @@ trusted IP addresses (it is very easy to forge a source IP address on a UDP packet). When used in TCP mode, -.B \-\-remote +.B --remote will act as a filter, rejecting connections from any host which does not match .B host.
@@ -270,7 +270,7 @@ chosen, providing a sort of basic load-balancing and failover capability. .\"********************************************************* .TP -.B \-\-remote-random-hostname +.B --remote-random-hostname Prepend a random string (6 bytes, 12 hex characters) to hostname to prevent DNS caching. For example, "foo.bar.gov" would be modified to "<random-chars>.foo.bar.gov".
@@ -289,7 +289,7 @@ and An OpenVPN client will try each connection profile sequentially until it achieves a successful connection. -.B \-\-remote-random +.B --remote-random can be used to initially "scramble" the connection list.
@@ -393,22 +393,22 @@ were declared in all blocks below it. .\"********************************************************* .TP -.B \-\-proto-force p +.B --proto-force p When iterating through connection profiles, only consider profiles using protocol .B p ('tcp'|'udp'). .\"********************************************************* .TP -.B \-\-remote-random +.B --remote-random When multiple -.B \-\-remote +.B --remote address/ports are specified, or if connection profiles are being used, initially randomize the order of the list as a kind of basic load-balancing measure. .\"********************************************************* .TP -.B \-\-proto p +.B --proto p Use protocol .B p for communicating with remote host.
@@ -422,17 +422,17 @@ or The default protocol is .B udp when -.B \-\-proto +.B --proto is not specified. For UDP operation, -.B \-\-proto udp +.B --proto udp should be specified on both peers. For TCP operation, one peer must use -.B \-\-proto tcp-server +.B --proto tcp-server and the other must use -.B \-\-proto tcp-client. +.B --proto tcp-client. A peer started with .B tcp-server will wait indefinitely for an incoming connection. A peer
@@ -440,9 +440,9 @@ started with .B tcp-client will attempt to connect, and if that fails, will sleep for 5 seconds (adjustable via the -.B \-\-connect-retry +.B --connect-retry option) and try again infinite or up to N retries (adjustable via the -.B \-\-connect-retry-max +.B --connect-retry-max option). Both TCP client and server will simulate a SIGUSR1 restart signal if either side resets the connection.
@@ -462,9 +462,9 @@ application-level UDP protocols, or tunneling protocols which don't possess a built-in reliability layer. .\"********************************************************* .TP -.B \-\-connect-retry n +.B --connect-retry n For -.B \-\-proto tcp-client, +.B --proto tcp-client, take .B n as the
@@ -472,29 +472,29 @@ number of seconds to wait between connection retries (default=5). .\"********************************************************* .TP -.B \-\-connect-timeout n +.B --connect-timeout n For -.B \-\-proto tcp-client, +.B --proto tcp-client, set connection timeout to .B n seconds (default=10). .\"********************************************************* .TP -.B \-\-connect-retry-max n +.B --connect-retry-max n For -.B \-\-proto tcp-client, +.B --proto tcp-client, take .B n as the number of retries of connection attempt (default=infinite). .\"********************************************************* .TP -.B \-\-show-proxy-settings +.B --show-proxy-settings Show sensed HTTP or SOCKS proxy settings. Currently, only Windows clients support this option. .\"********************************************************* .TP -.B \-\-http-proxy server port [authfile|'auto'|'auto-nct'] [auth-method] +.B --http-proxy server port [authfile|'auto'|'auto-nct'] [auth-method] Connect to remote host through an HTTP proxy at address .B server and port
@@ -529,32 +529,32 @@ determine the authentication method, but to reject weak authentication protocols such as HTTP Basic Authentication. .\"********************************************************* .TP -.B \-\-http-proxy-retry +.B --http-proxy-retry Retry indefinitely on HTTP proxy errors. If an HTTP proxy error occurs, simulate a SIGUSR1 reset. .\"********************************************************* .TP -.B \-\-http-proxy-timeout n +.B --http-proxy-timeout n Set proxy timeout to .B n seconds, default=5. .\"********************************************************* .TP -.B \-\-http-proxy-option type [parm] +.B --http-proxy-option type [parm] Set extended HTTP proxy options. Repeat to set multiple options. -.B VERSION version \-\- +.B VERSION version -- Set HTTP version number to .B version (default=1.0). -.B AGENT user-agent \-\- +.B AGENT user-agent -- Set HTTP "User-Agent" string to .B user-agent. .\"********************************************************* .TP -.B \-\-socks-proxy server [port] [authfile] +.B --socks-proxy server [port] [authfile] Connect to remote host through a Socks5 proxy at address .B server and port
@@ -565,14 +565,14 @@ and port "stdin" to prompt from console. .\"********************************************************* .TP -.B \-\-socks-proxy-retry +.B --socks-proxy-retry Retry indefinitely on Socks proxy errors. If a Socks proxy error occurs, simulate a SIGUSR1 reset. .\"********************************************************* .TP -.B \-\-resolv-retry n +.B --resolv-retry n If hostname resolve fails for -.B \-\-remote, +.B --remote, retry resolve for .B n seconds before failing.
@@ -582,18 +582,18 @@ Set to "infinite" to retry indefinitely. By default, -.B \-\-resolv-retry infinite +.B --resolv-retry infinite is enabled. You can disable by setting n=0. .\"********************************************************* .TP -.B \-\-float +.B --float Allow remote peer to change its IP address and/or port number, such as due to DHCP (this is the default if -.B \-\-remote +.B --remote is not used). -.B \-\-float +.B --float when specified with -.B \-\-remote +.B --remote allows an OpenVPN session to initially connect to a peer at a known address, however if packets arrive from a new address and pass all authentication tests, the new address
@@ -602,14 +602,14 @@ you are connecting to a peer which holds a dynamic address such as a dial-in user or DHCP client. Essentially, -.B \-\-float +.B --float tells OpenVPN to accept authenticated packets from any address, not only the address which was specified in the -.B \-\-remote +.B --remote option. .\"********************************************************* .TP -.B \-\-ipchange cmd +.B --ipchange cmd Run command .B cmd when our remote ip-address is initially authenticated or
@@ -629,11 +629,11 @@ is executed two arguments are appended after any arguments specified in .B cmd ip_address port_number Don't use -.B \-\-ipchange +.B --ipchange in -.B \-\-mode server +.B --mode server mode. Use a -.B \-\-client-connect +.B --client-connect script instead. See the "Environmental Variables" section below for
@@ -660,41 +660,41 @@ reestablish a connection with its most recently authenticated peer on its new IP address. .\"********************************************************* .TP -.B \-\-port port +.B --port port TCP/UDP port number for both local and remote. The current default of 1194 represents the official IANA port number assignment for OpenVPN and has been used since version 2.0-beta17. Previous versions used port 5000 as the default. .\"********************************************************* .TP -.B \-\-lport port +.B --lport port TCP/UDP port number for bind. .\"********************************************************* .TP -.B \-\-rport port +.B --rport port TCP/UDP port number for remote. .\"********************************************************* .TP -.B \-\-bind +.B --bind Bind to local address and port. This is the default unless any of -.B \-\-proto tcp-client +.B --proto tcp-client , -.B \-\-http-proxy +.B --http-proxy or -.B \-\-socks-proxy +.B --socks-proxy are used. .\"********************************************************* .TP -.B \-\-nobind +.B --nobind Do not bind to local address and port. The IP stack will allocate a dynamic port for returning packets. Since the value of the dynamic port could not be known in advance by a peer, this option is only suitable for peers which will be initiating connections by using the -.B \-\-remote +.B --remote option. .\"********************************************************* .TP -.B \-\-dev tunX | tapX | null +.B --dev tunX | tapX | null TUN/TAP virtual network device ( .B X can be omitted for a dynamic device.)
@@ -712,7 +712,7 @@ devices encapsulate IPv4 or IPv6 (OSI Layer 3) while devices encapsulate Ethernet 802.3 (OSI Layer 2). .\"********************************************************* .TP -.B \-\-dev-type device-type +.B --dev-type device-type Which device type are we using? .B device-type should be
@@ -722,60 +722,60 @@ or .B tap (OSI Layer 2). Use this option only if the TUN/TAP device used with -.B \-\-dev +.B --dev does not begin with .B tun or .B tap. .\"********************************************************* .TP -.B \-\-topology mode +.B --topology mode Configure virtual addressing topology when running in -.B \-\-dev tun +.B --dev tun mode. This directive has no meaning in -.B \-\-dev tap +.B --dev tap mode, which always uses a .B subnet topology. If you set this directive on the server, the -.B \-\-server +.B --server and -.B \-\-server-bridge +.B --server-bridge directives will automatically push your chosen topology setting to clients as well. This directive can also be manually pushed to clients. Like the -.B \-\-dev +.B --dev directive, this directive must always be compatible between client and server. .B mode can be one of: -.B net30 \-\- +.B net30 -- Use a point-to-point topology, by allocating one /30 subnet per client. This is designed to allow point-to-point semantics when some or all of the connecting clients might be Windows systems. This is the default on OpenVPN 2.0. -.B p2p \-\- +.B p2p -- Use a point-to-point topology where the remote endpoint of the client's tun interface always points to the local endpoint of the server's tun interface. This mode allocates a single IP address per connecting client. Only use when none of the connecting clients are Windows systems. This mode is functionally equivalent to the -.B \-\-ifconfig-pool-linear +.B --ifconfig-pool-linear directive which is available in OpenVPN 2.0 and is now deprecated. -.B subnet \-\- +.B subnet -- Use a subnet rather than a point-to-point topology by configuring the tun interface with a local IP address and subnet mask, similar to the topology used in -.B \-\-dev tap +.B --dev tap and ethernet bridging mode. This mode allocates a single IP address per connecting client and works on Windows as well. Only available when server and clients are OpenVPN 2.1 or higher, or OpenVPN 2.0.x which has been manually patched with the -.B \-\-topology +.B --topology directive code. When used on Windows, requires version 8.2 or higher of the TAP-Win32 driver. When used on *nix, requires that the tun driver supports an
@@ -785,38 +785,38 @@ command which sets a subnet instead of a remote endpoint IP address. This option exists in OpenVPN 2.1 or higher. .\"********************************************************* .TP -.B \-\-tun-ipv6 +.B --tun-ipv6 Build a tun link capable of forwarding IPv6 traffic. Should be used in conjunction with -.B \-\-dev tun +.B --dev tun or -.B \-\-dev tunX. +.B --dev tunX. A warning will be displayed if no specific IPv6 TUN support for your OS has been compiled into OpenVPN. See below for further IPv6-related configuration options. .\"********************************************************* .TP -.B \-\-dev-node node +.B --dev-node node Explicitly set the device node rather than using /dev/net/tun, /dev/tun, /dev/tap, etc. If OpenVPN cannot figure out whether .B node is a TUN or TAP device based on the name, you should also specify -.B \-\-dev-type tun +.B --dev-type tun or -.B \-\-dev-type tap. +.B --dev-type tap. Under Mac OS X this option can be used to specify the default tun implementation. Using -.B \-\-dev\-node utun +.B --dev-node utun forces usage of the native Darwin tun kernel support. Use -.B \-\-dev\-node utunN +.B --dev-node utunN to select a specific utun instance. To force using the tun.kext (/dev/tunX) use -.B \-\-dev\-node tun\fR. +.B --dev-node tun\fR. When not specifying a -.B \-\-dev\-node +.B --dev-node option openvpn will first try to open utun, and fall back to tun.kext. On Windows systems, select the TAP-Win32 adapter which
@@ -825,24 +825,24 @@ is named in the Network Connections Control Panel or the raw GUID of the adapter enclosed by braces. The -.B \-\-show-adapters +.B --show-adapters option under Windows can also be used to enumerate all available TAP-Win32 adapters and will show both the network connections control panel name and the GUID for each TAP-Win32 adapter. .TP -.B \-\-lladdr address +.B --lladdr address Specify the link layer address, more commonly known as the MAC address. Only applied to TAP devices. .\"********************************************************* .TP -.B \-\-iproute cmd +.B --iproute cmd Set alternate command to execute instead of default iproute2 command. May be used in order to execute OpenVPN in unprivileged environment. .\"********************************************************* .TP -.B \-\-ifconfig l rn +.B --ifconfig l rn Set TUN/TAP adapter parameters. .B l is the IP address of the local VPN endpoint.
@@ -857,7 +857,7 @@ which is being created or connected to. For TUN devices, which facilitate virtual point-to-point IP connections, the proper usage of -.B \-\-ifconfig +.B --ifconfig is to use two private IP addresses which are not a member of any existing subnet which is in use.
@@ -871,7 +871,7 @@ you will be pinging across the VPN. For TAP devices, which provide the ability to create virtual ethernet segments, -.B \-\-ifconfig +.B --ifconfig is used to set an IP address and subnet mask just as a physical ethernet adapter would be
@@ -892,42 +892,42 @@ standard interface to the different ifconfig implementations on different platforms. -.B \-\-ifconfig +.B --ifconfig parameters which are IP addresses can also be specified as a DNS or /etc/hosts file resolvable name. For TAP devices, -.B \-\-ifconfig +.B --ifconfig should not be used if the TAP interface will be getting an IP address lease from a DHCP server. .\"********************************************************* .TP -.B \-\-ifconfig-noexec +.B --ifconfig-noexec Don't actually execute ifconfig/netsh commands, instead pass -.B \-\-ifconfig +.B --ifconfig parameters to scripts using environmental variables. .\"********************************************************* .TP -.B \-\-ifconfig-nowarn +.B --ifconfig-nowarn Don't output an options consistency check warning if the -.B \-\-ifconfig +.B --ifconfig option on this side of the connection doesn't match the remote side. This is useful when you want to retain the overall benefits of the options consistency check (also see -.B \-\-disable-occ +.B --disable-occ option) while only disabling the ifconfig component of the check. For example, if you have a configuration where the local host uses -.B \-\-ifconfig +.B --ifconfig but the remote host does not, use -.B \-\-ifconfig-nowarn +.B --ifconfig-nowarn on the local host. This option will also silence warnings about potential
@@ -935,7 +935,7 @@ address conflicts which occasionally annoy more experienced users by triggering "false positive" warnings. .\"********************************************************* .TP -.B \-\-route network/IP [netmask] [gateway] [metric] +.B --route network/IP [netmask] [gateway] [metric] Add route to routing table after connection is established. Multiple routes can be specified. Routes will be automatically torn down in reverse order prior to
@@ -949,20 +949,20 @@ while at the same time providing portable semantics across OpenVPN's platform space. .B netmask -default \-\- 255.255.255.255 +default -- 255.255.255.255 .B gateway -default \-\- taken from -.B \-\-route-gateway +default -- taken from +.B --route-gateway or the second parameter to -.B \-\-ifconfig +.B --ifconfig when -.B \-\-dev tun +.B --dev tun is specified. .B metric -default \-\- taken from -.B \-\-route-metric +default -- taken from +.B --route-metric otherwise 0. The default can be specified by leaving an option blank or setting
@@ -977,37 +977,37 @@ also be specified as a DNS or /etc/hosts file resolvable name, or as one of three special keywords: .B vpn_gateway -\-\- The remote VPN endpoint address +-- The remote VPN endpoint address (derived either from -.B \-\-route-gateway +.B --route-gateway or the second parameter to -.B \-\-ifconfig +.B --ifconfig when -.B \-\-dev tun +.B --dev tun is specified). .B net_gateway -\-\- The pre-existing IP default gateway, read from the routing +-- The pre-existing IP default gateway, read from the routing table (not supported on all OSes). .B remote_host -\-\- The -.B \-\-remote +-- The +.B --remote address if OpenVPN is being run in client mode, and is undefined in server mode. .\"********************************************************* .TP -.B \-\-max-routes n +.B --max-routes n Allow a maximum number of n -.B \-\-route +.B --route options to be specified, either in the local configuration file, or pulled from an OpenVPN server. By default, n=100. .\"********************************************************* .TP -.B \-\-route-gateway gw|'dhcp' +.B --route-gateway gw|'dhcp' Specify a default gateway .B gw for use with -.B \-\-route. +.B --route. If .B dhcp
@@ -1016,14 +1016,14 @@ the gateway address will be extracted from a DHCP negotiation with the OpenVPN server-side LAN. .\"********************************************************* .TP -.B \-\-route-metric m +.B --route-metric m Specify a default metric .B m for use with -.B \-\-route. +.B --route. .\"********************************************************* .TP -.B \-\-route-delay [n] [w] +.B --route-delay [n] [w] Delay .B n seconds (default=0) after connection
@@ -1031,16 +1031,16 @@ establishment, before adding routes. If .B n is 0, routes will be added immediately upon connection establishment. If -.B \-\-route-delay +.B --route-delay is omitted, routes will be added immediately after TUN/TAP device open and -.B \-\-up +.B --up script execution, before any -.B \-\-user +.B --user or -.B \-\-group +.B --group privilege downgrade (or -.B \-\-chroot +.B --chroot execution.) This option is designed to be useful in scenarios where DHCP is
@@ -1049,18 +1049,18 @@ tap adapter addresses. The delay will give the DHCP handshake time to complete before routes are added. On Windows, -.B \-\-route-delay +.B --route-delay tries to be more intelligent by waiting .B w seconds (w=30 by default) for the TAP-Win32 adapter to come up before adding routes. .\"********************************************************* .TP -.B \-\-route-up cmd +.B --route-up cmd Run command .B cmd after routes are added, subject to -.B \-\-route-delay. +.B --route-delay. .B cmd consists of a path to script (or executable program), optionally
@@ -1071,7 +1071,7 @@ See the "Environmental Variables" section below for additional parameters passed as environmental variables. .\"********************************************************* .TP -.B \-\-route-pre-down cmd +.B --route-pre-down cmd Run command .B cmd before routes are removed upon disconnection.
@@ -1085,17 +1085,17 @@ See the "Environmental Variables" section below for additional parameters passed as environmental variables. .\"********************************************************* .TP -.B \-\-route-noexec +.B --route-noexec Don't add or remove routes automatically. Instead pass routes to -.B \-\-route-up +.B --route-up script using environmental variables. .\"********************************************************* .TP -.B \-\-route-nopull +.B --route-nopull When used with -.B \-\-client +.B --client or -.B \-\-pull, +.B --pull, accept options pushed by server EXCEPT for routes and dhcp options like DNS servers.
@@ -1105,16 +1105,16 @@ however note that this option still allows the server to set the TCP/IP properties of the client's TUN/TAP interface. .\"********************************************************* .TP -.B \-\-allow-pull-fqdn +.B --allow-pull-fqdn Allow client to pull DNS names from server (rather than being limited to IP address) for -.B \-\-ifconfig, -.B \-\-route, +.B --ifconfig, +.B --route, and -.B \-\-route-gateway. +.B --route-gateway. .\"********************************************************* .TP -.B \-\-client-nat snat|dnat network netmask alias +.B --client-nat snat|dnat network netmask alias This pushable client option sets up a stateless one-to-one NAT rule on packet addresses (not ports), and is useful in cases where routes or ifconfig settings pushed to the client would
@@ -1134,12 +1134,12 @@ Use (destination NAT) for remote resources. Set -.B \-\-verb 6 +.B --verb 6 for debugging info showing the transformation of src/dest addresses in packets. .\"********************************************************* .TP -.B \-\-redirect-gateway flags... +.B --redirect-gateway flags... Automatically execute routing commands to cause all outgoing IP traffic to be redirected over the VPN. This is a client-side option.
@@ -1147,7 +1147,7 @@ This option performs three steps: .B (1) Create a static route for the -.B \-\-remote +.B --remote address which forwards to the pre-existing default gateway. This is done so that .B (3)
@@ -1158,11 +1158,11 @@ Delete the default gateway route. .B (3) Set the new default gateway to be the VPN endpoint address (derived either from -.B \-\-route-gateway +.B --route-gateway or the second parameter to -.B \-\-ifconfig +.B --ifconfig when -.B \-\-dev tun +.B --dev tun is specified). When the tunnel is torn down, all of the above steps are reversed so
@@ -1170,7 +1170,7 @@ that the original default route is restored. Option flags: -.B local \-\- +.B local -- Add the .B local flag if both OpenVPN servers are directly connected via a common subnet,
@@ -1180,48 +1180,48 @@ flag will cause step .B 1 above to be omitted. -.B autolocal \-\- +.B autolocal -- Try to automatically determine whether to enable .B local flag above. -.B def1 \-\- +.B def1 -- Use this flag to override the default gateway by using 0.0.0.0/1 and 128.0.0.0/1 rather than 0.0.0.0/0. This has the benefit of overriding but not wiping out the original default gateway. -.B bypass-dhcp \-\- +.B bypass-dhcp -- Add a direct route to the DHCP server (if it is non-local) which bypasses the tunnel (Available on Windows clients, may not be available on non-Windows clients). -.B bypass-dns \-\- +.B bypass-dns -- Add a direct route to the DNS server(s) (if they are non-local) which bypasses the tunnel (Available on Windows clients, may not be available on non-Windows clients). -.B block-local \-\- +.B block-local -- Block access to local LAN when the tunnel is active, except for the LAN gateway itself. This is accomplished by routing the local LAN (except for the LAN gateway address) into the tunnel. .\"********************************************************* .TP -.B \-\-link-mtu n +.B --link-mtu n Sets an upper bound on the size of UDP packets which are sent between OpenVPN peers. It's best not to set this parameter unless you know what you're doing. .\"********************************************************* .\"********************************************************* .TP -.B \-\-redirect-private [flags] -Like \-\-redirect-gateway, but omit actually changing the default +.B --redirect-private [flags] +Like --redirect-gateway, but omit actually changing the default gateway. Useful when pushing private subnets. .\"********************************************************* .TP -.B \-\-tun-mtu n +.B --tun-mtu n Take the TUN device MTU to be .B n and derive the link MTU
@@ -1237,17 +1237,17 @@ MTU problems often manifest themselves as connections which hang during periods of active usage. It's best to use the -.B \-\-fragment +.B --fragment and/or -.B \-\-mssfix +.B --mssfix options to deal with MTU sizing issues. .\"********************************************************* .TP -.B \-\-tun-mtu-extra n +.B --tun-mtu-extra n Assume that the TUN/TAP device might return as many as .B n bytes more than the -.B \-\-tun-mtu +.B --tun-mtu size on read. This parameter defaults to 0, which is sufficient for most TUN devices. TAP devices may introduce additional overhead in excess of the MTU size, and a setting of 32 is the default when TAP devices are used.
@@ -1255,34 +1255,34 @@ This parameter only controls internal OpenVPN buffer sizing, so there is no transmission overhead associated with using a larger value. .\"********************************************************* .TP -.B \-\-mtu-disc type +.B --mtu-disc type Should we do Path MTU discovery on TCP/UDP channel? Only supported on OSes such as Linux that supports the necessary system call to set. .B 'no' -\-\- Never send DF (Don't Fragment) frames +-- Never send DF (Don't Fragment) frames .br .B 'maybe' -\-\- Use per-route hints +-- Use per-route hints .br .B 'yes' -\-\- Always DF (Don't Fragment) +-- Always DF (Don't Fragment) .br .\"********************************************************* .TP -.B \-\-mtu-test +.B --mtu-test To empirically measure MTU on connection startup, add the -.B \-\-mtu-test +.B --mtu-test option to your configuration. OpenVPN will send ping packets of various sizes to the remote peer and measure the largest packets which were successfully received. The -.B \-\-mtu-test +.B --mtu-test process normally takes about 3 minutes to complete. .\"********************************************************* .TP -.B \-\-fragment max +.B --fragment max Enable internal datagram fragmentation so that no UDP datagrams are sent which are larger than
@@ -1292,24 +1292,24 @@ bytes. The .B max parameter is interpreted in the same way as the -.B \-\-link-mtu +.B --link-mtu parameter, i.e. the UDP packet size after encapsulation overhead has been added in, but not including the UDP header itself. The -.B \-\-fragment +.B --fragment option only makes sense when you are using the UDP protocol ( -.B \-\-proto udp +.B --proto udp ). -.B \-\-fragment +.B --fragment adds 4 bytes of overhead per datagram. See the -.B \-\-mssfix +.B --mssfix option below for an important related option to -.B \-\-fragment. +.B --fragment. It should also be noted that this option is not meant to replace UDP fragmentation at the IP stack level. It is only meant as a
@@ -1322,7 +1322,7 @@ internal fragmentation capability may be your only option, such as tunneling a UDP multicast stream which requires fragmentation. .\"********************************************************* .TP -.B \-\-mssfix max +.B --mssfix max Announce to TCP sessions running over the tunnel that they should limit their send packet sizes such that after OpenVPN has encapsulated them, the resulting UDP packet size that OpenVPN sends to its peer will not
@@ -1334,33 +1334,33 @@ bytes. The default value is The .B max parameter is interpreted in the same way as the -.B \-\-link-mtu +.B --link-mtu parameter, i.e. the UDP packet size after encapsulation overhead has been added in, but not including the UDP header itself. The -.B \-\-mssfix +.B --mssfix option only makes sense when you are using the UDP protocol for OpenVPN peer-to-peer communication, i.e. -.B \-\-proto udp. +.B --proto udp. -.B \-\-mssfix +.B --mssfix and -.B \-\-fragment +.B --fragment can be ideally used together, where -.B \-\-mssfix +.B --mssfix will try to keep TCP from needing packet fragmentation in the first place, and if big packets come through anyhow (from protocols other than TCP), -.B \-\-fragment +.B --fragment will internally fragment them. Both -.B \-\-fragment +.B --fragment and -.B \-\-mssfix +.B --mssfix are designed to work around cases where Path MTU discovery is broken on the network path between OpenVPN peers.
@@ -1369,41 +1369,41 @@ connection which successfully starts, but then stalls during active usage. If -.B \-\-fragment +.B --fragment and -.B \-\-mssfix +.B --mssfix are used together, -.B \-\-mssfix +.B --mssfix will take its default .B max parameter from the -.B \-\-fragment max +.B --fragment max option. Therefore, one could lower the maximum UDP packet size to 1300 (a good first try for solving MTU-related connection problems) with the following options: -.B \-\-tun-mtu 1500 \-\-fragment 1300 \-\-mssfix +.B --tun-mtu 1500 --fragment 1300 --mssfix .\"********************************************************* .TP -.B \-\-sndbuf size +.B --sndbuf size Set the TCP/UDP socket send buffer size. Currently defaults to 65536 bytes. .\"********************************************************* .TP -.B \-\-rcvbuf size +.B --rcvbuf size Set the TCP/UDP socket receive buffer size. Currently defaults to 65536 bytes. .\"********************************************************* .TP -.B \-\-mark value +.B --mark value Mark encrypted packets being sent with value. The mark value can be matched in policy routing and packetfilter rules. This option is only supported in Linux and does nothing on other operating systems. .\"********************************************************* .TP -.B \-\-socket-flags flags... +.B --socket-flags flags... Apply the given flags to the OpenVPN transport socket. Currently, only .B TCP_NODELAY
@@ -1420,12 +1420,12 @@ This option is pushable from server to client, and should be used on both client and server for maximum effect. .\"********************************************************* .TP -.B \-\-txqueuelen n +.B --txqueuelen n (Linux only) Set the TX queue length on the TUN/TAP interface. Currently defaults to 100. .\"********************************************************* .TP -.B \-\-shaper n +.B --shaper n Limit bandwidth of outgoing tunnel data to .B n bytes per second on the TCP/UDP port.
@@ -1462,7 +1462,7 @@ OpenVPN allows to be between 100 bytes/sec and 100 Mbytes/sec. .\"********************************************************* .TP -.B \-\-inactive n [bytes] +.B --inactive n [bytes] Causes OpenVPN to exit after .B n seconds of inactivity on the TUN/TAP device. The time length of
@@ -1486,18 +1486,18 @@ internally by OpenVPN and are not an indication of actual user activity. .\"********************************************************* .TP -.B \-\-ping n +.B --ping n Ping remote over the TCP/UDP control channel if no packets have been sent for at least .B n seconds (specify -.B \-\-ping +.B --ping on both peers to cause ping packets to be sent in both directions since OpenVPN ping packets are not echoed like IP ping packets). When used in one of OpenVPN's secure modes (where -.B \-\-secret, \-\-tls-server, +.B --secret, --tls-server, or -.B \-\-tls-client +.B --tls-client is specified), the ping packet will be cryptographically secure.
@@ -1510,33 +1510,33 @@ pass will not time out. (2) To provide a basis for the remote to test the existence of its peer using the -.B \-\-ping-exit +.B --ping-exit option. .\"********************************************************* .TP -.B \-\-ping-exit n +.B --ping-exit n Causes OpenVPN to exit after .B n seconds pass without reception of a ping or other packet from remote. This option can be combined with -.B \-\-inactive, \-\-ping, +.B --inactive, --ping, and -.B \-\-ping-exit +.B --ping-exit to create a two-tiered inactivity disconnect. For example, -.B openvpn [options...] \-\-inactive 3600 \-\-ping 10 \-\-ping-exit 60 +.B openvpn [options...] --inactive 3600 --ping 10 --ping-exit 60 when used on both peers will cause OpenVPN to exit within 60 seconds if its peer disconnects, but will exit after one hour if no actual tunnel data is exchanged. .\"********************************************************* .TP -.B \-\-ping-restart n +.B --ping-restart n Similar to -.B \-\-ping-exit, +.B --ping-exit, but trigger a .B SIGUSR1 restart after
@@ -1555,13 +1555,13 @@ as If the peer cannot be reached, a restart will be triggered, causing the hostname used with -.B \-\-remote +.B --remote to be re-resolved (if -.B \-\-resolv-retry +.B --resolv-retry is also specified). In server mode, -.B \-\-ping-restart, \-\-inactive, +.B --ping-restart, --inactive, or any other type of internally generated signal will always be applied to individual client instance objects, never to whole server itself.
@@ -1570,14 +1570,14 @@ which would normally cause a restart, will cause the deletion of the client instance object instead. In client mode, the -.B \-\-ping-restart +.B --ping-restart parameter is set to 120 seconds by default. This default will hold until the client pulls a replacement value from the server, based on the -.B \-\-keepalive +.B --keepalive setting in the server configuration. To disable the 120 second default, set -.B \-\-ping-restart 0 +.B --ping-restart 0 on the client. See the signals section below for more information
@@ -1587,23 +1587,23 @@ on Note that the behavior of .B SIGUSR1 can be modified by the -.B \-\-persist-tun, \-\-persist-key, \-\-persist-local-ip, +.B --persist-tun, --persist-key, --persist-local-ip, and -.B \-\-persist-remote-ip +.B --persist-remote-ip options. Also note that -.B \-\-ping-exit +.B --ping-exit and -.B \-\-ping-restart +.B --ping-restart are mutually exclusive and cannot be used together. .\"********************************************************* .TP -.B \-\-keepalive n m +.B --keepalive n m A helper directive designed to simplify the expression of -.B \-\-ping +.B --ping and -.B \-\-ping-restart +.B --ping-restart in server mode configurations. The server timeout is set twice the value of the second argument.
@@ -1611,7 +1611,7 @@ This ensures that a timeout is detected on client side before the server side drops the connection. For example, -.B \-\-keepalive 10 60 +.B --keepalive 10 60 expands as follows: .nf
@@ -1630,24 +1630,24 @@ expands as follows: .fi .\"********************************************************* .TP -.B \-\-ping-timer-rem +.B --ping-timer-rem Run the -.B \-\-ping-exit +.B --ping-exit / -.B \-\-ping-restart +.B --ping-restart timer only if we have a remote address. Use this option if you are starting the daemon in listen mode (i.e. without an explicit -.B \-\-remote +.B --remote peer), and you don't want to start clocking timeouts until a remote peer connects. .\"********************************************************* .TP -.B \-\-persist-tun +.B --persist-tun Don't close and reopen TUN/TAP device or run up/down scripts across .B SIGUSR1 or -.B \-\-ping-restart +.B --ping-restart restarts. .B SIGUSR1
@@ -1657,14 +1657,14 @@ but which offers finer-grained control over reset options. .\"********************************************************* .TP -.B \-\-persist-key +.B --persist-key Don't re-read key files across .B SIGUSR1 or -.B \-\-ping-restart. +.B --ping-restart. This option can be combined with -.B \-\-user nobody +.B --user nobody to allow restarts triggered by the .B SIGUSR1 signal.
@@ -1677,29 +1677,29 @@ This option solves the problem by persisting keys across resets, so they don't need to be re-read. .\"********************************************************* .TP -.B \-\-persist-local-ip +.B --persist-local-ip Preserve initially resolved local IP address and port number across .B SIGUSR1 or -.B \-\-ping-restart +.B --ping-restart restarts. .\"********************************************************* .TP -.B \-\-persist-remote-ip +.B --persist-remote-ip Preserve most recently authenticated remote IP address and port number across .B SIGUSR1 or -.B \-\-ping-restart +.B --ping-restart restarts. .\"********************************************************* .TP -.B \-\-mlock +.B --mlock Disable paging by calling the POSIX mlockall function. Requires that OpenVPN be initially run as root (though OpenVPN can subsequently downgrade its UID using the -.B \-\-user +.B --user option). Using this option ensures that key material and tunnel
@@ -1711,22 +1711,22 @@ would not be able to scan the system swap file to recover previously used ephemeral keys, which are used for a period of time governed by the -.B \-\-reneg +.B --reneg options (see below), then are discarded. The downside of using -.B \-\-mlock +.B --mlock is that it will reduce the amount of physical memory available to other applications. .\"********************************************************* .TP -.B \-\-up cmd +.B --up cmd Run command .B cmd after successful TUN/TAP device open (pre -.B \-\-user +.B --user UID change). .B cmd
@@ -1740,13 +1740,13 @@ private subnets which exist at the other end of the VPN connection into the tunnel. For -.B \-\-dev tun +.B --dev tun execute as: .B cmd tun_dev tun_mtu link_mtu ifconfig_local_ip ifconfig_remote_ip [ init | restart ] For -.B \-\-dev tap +.B --dev tap execute as: .B cmd tap_dev tap_mtu link_mtu ifconfig_local_ip ifconfig_netmask [ init | restart ]
@@ -1769,62 +1769,62 @@ In this context, the last command line parameter passed to the script will be .I init. If the -.B \-\-up-restart +.B --up-restart option is also used, the up script will be called for restarts as well. A restart is considered to be a partial reinitialization of OpenVPN where the TUN/TAP instance is preserved (the -.B \-\-persist-tun +.B --persist-tun option will enable such preservation). A restart can be generated by a SIGUSR1 signal, a -.B \-\-ping-restart +.B --ping-restart timeout, or a connection reset when the TCP protocol is enabled with the -.B \-\-proto +.B --proto option. If a restart occurs, and -.B \-\-up-restart +.B --up-restart has been specified, the up script will be called with .I restart as the last parameter. The following standalone example shows how the -.B \-\-up +.B --up script can be called in both an initialization and restart context. (NOTE: for security reasons, don't run the following example unless UDP port 9999 is blocked by your firewall. Also, the example will run indefinitely, so you should abort with control-c). -.B openvpn \-\-dev tun \-\-port 9999 \-\-verb 4 \-\-ping-restart 10 \-\-up 'echo up' \-\-down 'echo down' \-\-persist-tun \-\-up-restart +.B openvpn --dev tun --port 9999 --verb 4 --ping-restart 10 --up 'echo up' --down 'echo down' --persist-tun --up-restart Note that OpenVPN also provides the -.B \-\-ifconfig +.B --ifconfig option to automatically ifconfig the TUN device, eliminating the need to define an -.B \-\-up +.B --up script, unless you also want to configure routes in the -.B \-\-up +.B --up script. If -.B \-\-ifconfig +.B --ifconfig is also specified, OpenVPN will pass the ifconfig local and remote endpoints on the command line to the -.B \-\-up +.B --up script so that they can be used to configure routes such as: .B route add -net 10.0.0.0 netmask 255.255.255.0 gw $5 .\"********************************************************* .TP -.B \-\-up-delay +.B --up-delay Delay TUN/TAP open and possible -.B \-\-up +.B --up script execution until after TCP/UDP connection establishment with peer. In -.B \-\-proto udp +.B --proto udp mode, this option normally requires the use of -.B \-\-ping +.B --ping to allow connection initiation to be sensed in the absence of tunnel data, since UDP is a "connectionless" protocol.
@@ -1833,14 +1833,14 @@ transitioning to "connected" until connection establishment, i.e. the receipt of the first authenticated packet from the peer. .\"********************************************************* .TP -.B \-\-down cmd +.B --down cmd Run command .B cmd after TUN/TAP device close (post -.B \-\-user +.B --user UID change and/or -.B \-\-chroot +.B --chroot ). .B cmd consists of a path to script (or executable program), optionally
@@ -1849,42 +1849,42 @@ and/or escaped using a backslash, and should be separated by one or more spaces. Called with the same parameters and environmental variables as the -.B \-\-up +.B --up option above. Note that if you reduce privileges by using -.B \-\-user +.B --user and/or -.B \-\-group, +.B --group, your -.B \-\-down +.B --down script will also run at reduced privilege. .\"********************************************************* .TP -.B \-\-down-pre +.B --down-pre Call -.B \-\-down +.B --down cmd/script before, rather than after, TUN/TAP close. .\"********************************************************* .TP -.B \-\-up-restart +.B --up-restart Enable the -.B \-\-up +.B --up and -.B \-\-down +.B --down scripts to be called for restarts as well as initial program start. This option is described more fully above in the -.B \-\-up +.B --up option documentation. .\"********************************************************* .TP -.B \-\-setenv name value +.B --setenv name value Set a custom environmental variable .B name=value to pass to script. .\"********************************************************* .TP -.B \-\-setenv FORWARD_COMPATIBLE 1 +.B --setenv FORWARD_COMPATIBLE 1 Relax config file syntax checking so that unknown directives will trigger a warning but not a fatal error, on the assumption that a given unknown directive might be valid
@@ -1906,10 +1906,10 @@ Versions prior to OpenVPN 2.3.3 will always ignore options set with the directive. See also -.B \-\-ignore-unknown-option +.B --ignore-unknown-option .\"********************************************************* .TP -.B \-\-setenv-safe name value +.B --setenv-safe name value Set a custom environmental variable .B OPENVPN_name=value to pass to script.
@@ -1920,13 +1920,13 @@ is a safety precaution to prevent a LD_PRELOAD style attack from a malicious or compromised server. .\"********************************************************* .TP -.B \-\-ignore-unknown-option opt1 opt2 opt3 ... optN +.B --ignore-unknown-option opt1 opt2 opt3 ... optN When one of options .B opt1 ... optN is encountered in the configuration file the configuration file parsing does not fail if this OpenVPN version does not support the option. Multiple -.B \-\-ignore-unknown-option +.B --ignore-unknown-option options can be given to support a larger number of options to ignore. This option should be used with caution, as there are good security
@@ -1935,27 +1935,27 @@ config file. Having said that, there are valid reasons for wanting new software features to gracefully degrade when encountered by older software versions. -.B \-\-ignore-unknown-option +.B --ignore-unknown-option is available since OpenVPN 2.3.3. .\"********************************************************* .TP -.B \-\-script-security level +.B --script-security level This directive offers policy-level control over OpenVPN's usage of external programs and scripts. Lower .B level values are more restrictive, higher values are more permissive. Settings for .B level: -.B 0 \-\- +.B 0 -- Strictly no calling of external programs. .br -.B 1 \-\- +.B 1 -- (Default) Only call built-in executables such as ifconfig, ip, route, or netsh. .br -.B 2 \-\- +.B 2 -- Allow calling of built-in executables and user-defined scripts. .br -.B 3 \-\- +.B 3 -- Allow passwords to be passed to scripts via environmental variables (potentially unsafe). OpenVPN releases before v2.3 also supported a
@@ -1980,7 +1980,7 @@ example, if you have a Visual Basic script, you must use this syntax now: .nf .ft 3 .in +4 -\-\-up 'C:\\\\Windows\\\\System32\\\\wscript.exe C:\\\\Program\\ Files\\\\OpenVPN\\\\config\\\\my-up-script.vbs' +--up 'C:\\\\Windows\\\\System32\\\\wscript.exe C:\\\\Program\\ Files\\\\OpenVPN\\\\config\\\\my-up-script.vbs' .in -4 .ft .fi
@@ -1994,19 +1994,19 @@ flag was removed is due to the security implications with shell expansions when executing scripts via the system() call. .\"********************************************************* .TP -.B \-\-disable-occ +.B --disable-occ Don't output a warning message if option inconsistencies are detected between peers. An example of an option inconsistency would be where one peer uses -.B \-\-dev tun +.B --dev tun while the other peer uses -.B \-\-dev tap. +.B --dev tap. Use of this option is discouraged, but is provided as a temporary fix in situations where a recent version of OpenVPN must connect to an old version. .\"********************************************************* .TP -.B \-\-user user +.B --user user Change the user ID of the OpenVPN process to .B user after initialization, dropping privileges in the process.
@@ -2028,7 +2028,7 @@ you want to reset an OpenVPN daemon with a signal (for example in response to a DHCP reset), you should make use of one or more of the -.B \-\-persist +.B --persist options to ensure that OpenVPN doesn't need to execute any privileged operations in order to restart (such as re-reading key files or running
@@ -2036,16 +2036,16 @@ or running on the TUN device). .\"********************************************************* .TP -.B \-\-group group +.B --group group Similar to the -.B \-\-user +.B --user option, this option changes the group ID of the OpenVPN process to .B group after initialization. .\"********************************************************* .TP -.B \-\-cd dir +.B --cd dir Change directory to .B dir prior to reading any files such as
@@ -2057,16 +2057,16 @@ to the current directory such as "." or "..". This option is useful when you are running OpenVPN in -.B \-\-daemon +.B --daemon mode, and you want to consolidate all of your OpenVPN control files in one location. .\"********************************************************* .TP -.B \-\-chroot dir +.B --chroot dir Chroot to .B dir after initialization. -.B \-\-chroot +.B --chroot essentially redefines .B dir as being the top
@@ -2086,7 +2086,7 @@ are executed after the chroot operation. Note: if OpenVPN is built using the PolarSSL SSL library, -.B \-\-chroot +.B --chroot will only work if a /dev/urandom device node is available inside the chroot directory .B dir.
@@ -2095,22 +2095,22 @@ This is due to the way PolarSSL works (it wants to open at startup) and nothing OpenVPN can influence. .\"********************************************************* .TP -.B \-\-setcon context +.B --setcon context Apply SELinux .B context after initialization. This essentially provides the ability to restrict OpenVPN's rights to only network I/O operations, thanks to SELinux. This goes further than -.B \-\-user +.B --user and -.B \-\-chroot +.B --chroot in that those two, while being great security features, unfortunately do not protect against privilege escalation by exploitation of a vulnerable system call. You can of course combine all three, but please note that since setcon requires access to /proc you will have to provide -it inside the chroot directory (e.g. with mount \-\-bind). +it inside the chroot directory (e.g. with mount --bind). Since the setcon operation is delayed until after initialization, OpenVPN can be restricted to just
@@ -2122,13 +2122,13 @@ allow many things required only during initialization. Like with chroot, complications can result when scripts or restarts are executed after the setcon operation, which is why you should really consider using the -.B \-\-persist-key +.B --persist-key and -.B \-\-persist-tun +.B --persist-tun options. .\"********************************************************* .TP -.B \-\-daemon [progname] +.B --daemon [progname] Become a daemon after all initialization functions are completed. This option will cause all message and error output to be sent to the syslog file (such as /var/log/messages),
@@ -2137,10 +2137,10 @@ ifconfig commands, which will go to /dev/null unless otherwise redirected. The syslog redirection occurs immediately at the point that -.B \-\-daemon +.B --daemon is parsed on the command line even though the daemonization point occurs later. If one of the -.B \-\-log +.B --log options is present, it will supercede syslog redirection.
@@ -2156,7 +2156,7 @@ When unspecified, defaults to "openvpn". When OpenVPN is run with the -.B \-\-daemon +.B --daemon option, it will try to delay daemonization until the majority of initialization functions which are capable of generating fatal errors are complete. This means that initialization scripts can test the return status of the
@@ -2166,25 +2166,25 @@ has correctly initialized and entered the packet forwarding event loop. In OpenVPN, the vast majority of errors which occur after initialization are non-fatal. .\"********************************************************* .TP -.B \-\-syslog [progname] +.B --syslog [progname] Direct log output to system logger, but do not become a daemon. See -.B \-\-daemon +.B --daemon directive above for description of .B progname parameter. .TP -.B \-\-errors-to-stderr +.B --errors-to-stderr Output errors to stderr instead of stdout unless log output is redirected by one of the -.B \-\-log +.B --log options. .\"********************************************************* .TP -.B \-\-passtos +.B --passtos Set the TOS field of the tunnel packet to what the payload's TOS is. .\"********************************************************* .TP -.B \-\-inetd [wait|nowait] [progname] +.B --inetd [wait|nowait] [progname] Use this option when OpenVPN is being run from the inetd or .BR xinetd(8) server.
@@ -2195,7 +2195,7 @@ option must match what is specified in the inetd/xinetd config file. The .B nowait mode can only be used with -.B \-\-proto tcp-server. +.B --proto tcp-server. The default is .B wait. The
@@ -2207,16 +2207,16 @@ see the OpenVPN FAQ: .I http://openvpn.net/faq.html#oneport This option precludes the use of -.B \-\-daemon, \-\-local, +.B --daemon, --local, or -.B \-\-remote. +.B --remote. Note that this option causes message and error output to be handled in the same way as the -.B \-\-daemon +.B --daemon option. The optional .B progname parameter is also handled exactly as in -.B \-\-daemon. +.B --daemon. Also note that in .B wait
@@ -2226,7 +2226,7 @@ on using OpenVPN with xinetd: .I http://openvpn.net/1xhowto.html .\"********************************************************* .TP -.B \-\-log file +.B --log file Output logging messages to .B file, including output to stdout/stderr which
@@ -2237,44 +2237,44 @@ already exists it will be truncated. This option takes effect immediately when it is parsed in the command line and will supercede syslog output if -.B \-\-daemon +.B --daemon or -.B \-\-inetd +.B --inetd is also specified. This option is persistent over the entire course of an OpenVPN instantiation and will not be reset by SIGHUP, SIGUSR1, or -.B \-\-ping-restart. +.B --ping-restart. Note that on Windows, when OpenVPN is started as a service, logging occurs by default without the need to specify this option. .\"********************************************************* .TP -.B \-\-log-append file +.B --log-append file Append logging messages to .B file. If .B file does not exist, it will be created. This option behaves exactly like -.B \-\-log +.B --log except that it appends to rather than truncating the log file. .\"********************************************************* .TP -.B \-\-suppress-timestamps +.B --suppress-timestamps Avoid writing timestamps to log messages, even when they otherwise would be prepended. In particular, this applies to log messages sent to stdout. .\"********************************************************* .TP -.B \-\-writepid file +.B --writepid file Write OpenVPN's main process ID to .B file. .\"********************************************************* .TP -.B \-\-nice n +.B --nice n Change process priority after initialization ( .B n
@@ -2283,14 +2283,14 @@ greater than 0 is lower priority, less than zero is higher priority). .\"********************************************************* .\".TP -.\".B \-\-nice-work n +.\".B --nice-work n .\"Change priority of background TLS work thread. The TLS thread .\"feature is enabled when OpenVPN is built .\"with pthread support, and you are running OpenVPN .\"in TLS mode (i.e. with -.\".B \-\-tls-client +.\".B --tls-client .\"or -.\".B \-\-tls-server +.\".B --tls-server .\"specified). .\" .\"Using a TLS thread offloads the CPU-intensive process of SSL/TLS-based
@@ -2300,12 +2300,12 @@ less than zero is higher priority). .\"The parameter .\".B n .\"is interpreted exactly as with the -.\".B \-\-nice +.\".B --nice .\"option above, but in relation to the work thread rather .\"than the main thread. .\"********************************************************* .TP -.B \-\-fast-io +.B --fast-io (Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding a call to poll/epoll/select prior to the write operation. The purpose of such a call would normally be to block until the device
@@ -2316,17 +2316,17 @@ by avoiding the poll/epoll/select call, improving CPU efficiency by 5% to 10%. This option can only be used on non-Windows systems, when -.B \-\-proto udp +.B --proto udp is specified, and when -.B \-\-shaper +.B --shaper is NOT specified. .\"********************************************************* .TP -.B \-\-multihome +.B --multihome Configure a multi-homed UDP server. This option needs to be used when a server has more than one IP address (e.g. multiple interfaces, or secondary IP addresses), and is not using -.B \-\-local +.B --local to force binding to one specific address only. This option will add some extra lookups to the packet path to ensure that the UDP reply packets are always sent from the address that the client is
@@ -2342,7 +2342,7 @@ IPv4-mapped case (some distributions have ported this to earlier kernel versions, though). .\"********************************************************* .TP -.B \-\-echo [parms...] +.B --echo [parms...] Echo .B parms to log output.
@@ -2351,7 +2351,7 @@ Designed to be used to send messages to a controlling application which is receiving the OpenVPN log output. .\"********************************************************* .TP -.B \-\-remap-usr1 signal +.B --remap-usr1 signal Control whether internally or externally generated SIGUSR1 signals are remapped to SIGHUP (restart without persisting state) or
@@ -2362,20 +2362,20 @@ can be set to "SIGHUP" or "SIGTERM". By default, no remapping occurs. .\"********************************************************* .TP -.B \-\-verb n +.B --verb n Set output verbosity to .B n (default=1). Each level shows all info from the previous levels. Level 3 is recommended if you want a good summary of what's happening without being swamped by output. -.B 0 \-\- +.B 0 -- No output except fatal errors. .br -.B 1 to 4 \-\- +.B 1 to 4 -- Normal usage range. .br -.B 5 \-\- +.B 5 -- Output .B R and
@@ -2383,12 +2383,12 @@ and characters to the console for each packet read and write, uppercase is used for TCP/UDP packets and lowercase is used for TUN/TAP packets. .br -.B 6 to 11 \-\- +.B 6 to 11 -- Debug info range (see errlevel.h for additional information on debug levels). .\"********************************************************* .TP -.B \-\-status file [n] +.B --status file [n] Write operational status to .B file every
@@ -2400,21 +2400,21 @@ Status can also be written to the syslog by sending a signal. .\"********************************************************* .TP -.B \-\-status-version [n] +.B --status-version [n] Choose the status file format version number. Currently .B n can be 1, 2, or 3 and defaults to 1. .\"********************************************************* .TP -.B \-\-mute n +.B --mute n Log at most .B n consecutive messages in the same category. This is useful to limit repetitive logging of similar message types. .\"********************************************************* .TP -.B \-\-comp-lzo [mode] -Use fast LZO compression \-\- may add up to 1 byte per +.B --comp-lzo [mode] +Use fast LZO compression -- may add up to 1 byte per packet for incompressible data. .B mode may be "yes", "no", or "adaptive" (default).
@@ -2424,16 +2424,16 @@ compression on or off for individual clients. First, make sure the client-side config file enables selective compression by having at least one -.B \-\-comp-lzo +.B --comp-lzo directive, such as -.B \-\-comp-lzo no. +.B --comp-lzo no. This will turn off compression by default, but allow a future directive push from the server to dynamically change the on/off/adaptive setting. Next in a -.B \-\-client-config-dir +.B --client-config-dir file, specify the compression setting for the client, for example:
@@ -2452,12 +2452,12 @@ setting for the server side of the link, the second sets the client side. .\"********************************************************* .TP -.B \-\-comp-noadapt +.B --comp-noadapt When used in conjunction with -.B \-\-comp-lzo, +.B --comp-lzo, this option will disable OpenVPN's adaptive compression algorithm. Normally, adaptive compression is enabled with -.B \-\-comp-lzo. +.B --comp-lzo. Adaptive compression tries to optimize the case where you have compression enabled, but you are sending predominantly incompressible
@@ -2469,7 +2469,7 @@ the compression efficiency will be very low, triggering openvpn to disable compression for a period of time until the next re-sample test. .\"********************************************************* .TP -.B \-\-management IP port [pw-file] +.B --management IP port [pw-file] Enable a TCP server on .B IP:port to handle daemon management functions.
@@ -2488,9 +2488,9 @@ and set .B port to 'unix'. While the default behavior is to create a unix domain socket that may be connected to by any process, the -.B \-\-management-client-user +.B --management-client-user and -.B \-\-management-client-group +.B --management-client-group directives can be used to restrict access. The management interface provides a special mode where the TCP
@@ -2518,52 +2518,52 @@ be set to 127.0.0.1 (localhost) to restrict accessibility of the management server to local clients. .TP -.B \-\-management-client +.B --management-client Management interface will connect as a TCP/unix domain client to .B IP:port specified by -.B \-\-management +.B --management rather than listen as a TCP server or on a unix domain socket. If the client connection fails to connect or is disconnected, a SIGTERM signal will be generated causing OpenVPN to quit. .\"********************************************************* .TP -.B \-\-management-query-passwords +.B --management-query-passwords Query management channel for private key password and -.B \-\-auth-user-pass +.B --auth-user-pass username/password. Only query the management channel for inputs which ordinarily would have been queried from the console. .\"********************************************************* .TP -.B \-\-management-query-proxy +.B --management-query-proxy Query management channel for proxy server information for a specific -.B \-\-remote +.B --remote (client-only). .\"********************************************************* .TP -.B \-\-management-query-remote +.B --management-query-remote Allow management interface to override -.B \-\-remote +.B --remote directives (client-only). .\"********************************************************* -.B \-\-management-external-key +.B --management-external-key Allows usage for external private key file instead of -.B \-\-key +.B --key option (client-only). .\"********************************************************* .TP -.B \-\-management-forget-disconnect +.B --management-forget-disconnect Make OpenVPN forget passwords when management session disconnects. This directive does not affect the -.B \-\-http-proxy +.B --http-proxy username/password. It is always cached. .\"********************************************************* .TP -.B \-\-management-hold +.B --management-hold Start OpenVPN in a hibernating state, until a client of the management interface explicitly starts it with the
@@ -2571,51 +2571,51 @@ with the command. .\"********************************************************* .TP -.B \-\-management-signal +.B --management-signal Send SIGUSR1 signal to OpenVPN if management session disconnects. This is useful when you wish to disconnect an OpenVPN session on user logoff. For --management-client this option is not needed since a disconnect will always generate a SIGTERM. .\"********************************************************* .TP -.B \-\-management-log-cache n +.B --management-log-cache n Cache the most recent .B n lines of log file history for usage by the management channel. .\"********************************************************* .TP -.B \-\-management-up-down +.B --management-up-down Report tunnel up/down events to management interface. .B .\"********************************************************* .TP -.B \-\-management-client-auth +.B --management-client-auth Gives management interface client the responsibility to authenticate clients after their client certificate has been verified. See management-notes.txt in OpenVPN distribution for detailed notes. .\"********************************************************* .TP -.B \-\-management-client-pf +.B --management-client-pf Management interface clients must specify a packet filter file for each connecting client. See management-notes.txt in OpenVPN distribution for detailed notes. .\"********************************************************* .TP -.B \-\-management-client-user u +.B --management-client-user u When the management interface is listening on a unix domain socket, only allow connections from user .B u. .\"********************************************************* .TP -.B \-\-management-client-group g +.B --management-client-group g When the management interface is listening on a unix domain socket, only allow connections from group .B g. .\"********************************************************* .TP -.B \-\-plugin module-pathname [init-string] +.B --plugin module-pathname [init-string] Load plug-in module from the file .B module-pathname, passing
@@ -2651,7 +2651,7 @@ the connection to be authenticated. .SS Server Mode Starting with OpenVPN 2.0, a multi-client TCP/UDP server mode is supported, and can be enabled with the -.B \-\-mode server +.B --mode server option. In server mode, OpenVPN will listen on a single port for incoming client connections. All client connections will be routed through a single tun or tap
@@ -2661,7 +2661,7 @@ on sufficiently fast hardware. SSL/TLS authentication must be used in this mode. .\"********************************************************* .TP -.B \-\-server network netmask ['nopool'] +.B --server network netmask ['nopool'] A helper directive designed to simplify the configuration of OpenVPN's server mode. This directive will set up an OpenVPN server which will allocate addresses to clients
@@ -2671,7 +2671,7 @@ for use as the server-side endpoint of the local TUN/TAP interface. For example, -.B \-\-server 10.8.0.0 255.255.255.0 +.B --server 10.8.0.0 255.255.255.0 expands as follows: .nf
@@ -2704,23 +2704,23 @@ expands as follows: .fi Don't use -.B \-\-server +.B --server if you are ethernet bridging. Use -.B \-\-server-bridge +.B --server-bridge instead. .\"********************************************************* .TP -.B \-\-server-bridge gateway netmask pool-start-IP pool-end-IP +.B --server-bridge gateway netmask pool-start-IP pool-end-IP .TP -.B \-\-server-bridge ['nogw'] +.B --server-bridge ['nogw'] A helper directive similar to -.B \-\-server +.B --server which is designed to simplify the configuration of OpenVPN's server mode in ethernet bridging configurations. If -.B \-\-server-bridge +.B --server-bridge is used without any parameters, it will enable a DHCP-proxy mode, where connecting OpenVPN clients will receive an IP address for their TAP adapter from the DHCP server running
@@ -2748,7 +2748,7 @@ IP/netmask on the bridge interface. The and .B netmask parameters to -.B \-\-server-bridge +.B --server-bridge can be set to either the IP/netmask of the bridge interface, or the IP/netmask of the default gateway/router on the bridged
@@ -2780,7 +2780,7 @@ push "route-gateway 10.8.0.4" .fi In another example, -.B \-\-server-bridge +.B --server-bridge (without parameters) expands as follows: .nf
@@ -2795,7 +2795,7 @@ push "route-gateway dhcp" .fi Or -.B \-\-server-bridge nogw +.B --server-bridge nogw expands as follows: .nf
@@ -2808,13 +2808,13 @@ tls-server .fi .\"********************************************************* .TP -.B \-\-push "option" +.B --push "option" Push a config file option back to the client for remote execution. Note that .B option must be enclosed in double quotes (""). The client must specify -.B \-\-pull +.B --pull in its config file. The set of options which can be pushed is limited by both feasibility and security. Some options such as those which would execute scripts
@@ -2825,26 +2825,26 @@ cannot be pushed because the client needs to know them before the connection to the server can be initiated. This is a partial list of options which can currently be pushed: -.B \-\-route, \-\-route-gateway, \-\-route-delay, \-\-redirect-gateway, -.B \-\-ip-win32, \-\-dhcp-option, -.B \-\-inactive, \-\-ping, \-\-ping-exit, \-\-ping-restart, -.B \-\-setenv, -.B \-\-persist-key, \-\-persist-tun, \-\-echo, -.B \-\-comp-lzo, -.B \-\-socket-flags, -.B \-\-sndbuf, \-\-rcvbuf +.B --route, --route-gateway, --route-delay, --redirect-gateway, +.B --ip-win32, --dhcp-option, +.B --inactive, --ping, --ping-exit, --ping-restart, +.B --setenv, +.B --persist-key, --persist-tun, --echo, +.B --comp-lzo, +.B --socket-flags, +.B --sndbuf, --rcvbuf .\"********************************************************* .TP -.B \-\-push-reset +.B --push-reset Don't inherit the global push list for a specific client instance. Specify this option in a client-specific context such as with a -.B \-\-client-config-dir +.B --client-config-dir configuration file. This option will ignore -.B \-\-push +.B --push options at the global config file level. .TP -.B \-\-push-peer-info +.B --push-peer-info Push additional information about the client to server. The additional information consists of the following data:
@@ -2859,24 +2859,24 @@ IV_LZO_STUB=1 -- if client was built with LZO stub capability UV_<name>=<value> -- client environment variables whose names start with "UV_" .\"********************************************************* .TP -.B \-\-disable +.B --disable Disable a particular client (based on the common name) from connecting. Don't use this option to disable a client due to key or password compromise. Use a CRL (certificate revocation list) instead (see the -.B \-\-crl-verify +.B --crl-verify option). This option must be associated with a specific client instance, which means that it must be specified either in a client instance config file using -.B \-\-client-config-dir +.B --client-config-dir or dynamically generated using a -.B \-\-client-connect +.B --client-connect script. .\"********************************************************* .TP -.B \-\-ifconfig-pool start-IP end-IP [netmask] +.B --ifconfig-pool start-IP end-IP [netmask] Set aside a pool of subnets to be dynamically allocated to connecting clients, similar to a DHCP server. For tun-style
@@ -2889,7 +2889,7 @@ parameter will also be pushed to clients. .\"********************************************************* .TP -.B \-\-ifconfig-pool-persist file [seconds] +.B --ifconfig-pool-persist file [seconds] Persist/unpersist ifconfig-pool data to .B file,
@@ -2904,7 +2904,7 @@ IP address assigned to them from the ifconfig-pool. Maintaining a long-term association is good for clients because it allows them to effectively use the -.B \-\-persist-tun +.B --persist-tun option. .B file
@@ -2925,32 +2925,32 @@ suggestions only, based on past associations between a common name and IP address. They do not guarantee that the given common name will always receive the given IP address. If you want guaranteed assignment, use -.B \-\-ifconfig-push +.B --ifconfig-push .\"********************************************************* .TP -.B \-\-ifconfig-pool-linear +.B --ifconfig-pool-linear Modifies the -.B \-\-ifconfig-pool +.B --ifconfig-pool directive to allocate individual TUN interface addresses for clients rather than /30 subnets. NOTE: This option is incompatible with Windows clients. This option is deprecated, and should be replaced with -.B \-\-topology p2p +.B --topology p2p which is functionally equivalent. .\"********************************************************* .TP -.B \-\-ifconfig-push local remote-netmask [alias] +.B --ifconfig-push local remote-netmask [alias] Push virtual IP endpoints for client tunnel, -overriding the \-\-ifconfig-pool dynamic allocation. +overriding the --ifconfig-pool dynamic allocation. The parameters .B local and .B remote-netmask are set according to the -.B \-\-ifconfig +.B --ifconfig directive which you want to execute on the client machine to configure the remote end of the tunnel. Note that the parameters .B local
@@ -2972,13 +2972,13 @@ will refer to the client view. This option must be associated with a specific client instance, which means that it must be specified either in a client instance config file using -.B \-\-client-config-dir +.B --client-config-dir or dynamically generated using a -.B \-\-client-connect +.B --client-connect script. Remember also to include a -.B \-\-route +.B --route directive in the main OpenVPN config file which encloses .B local, so that the kernel will know to route it
@@ -2988,23 +2988,23 @@ OpenVPN's internal client IP address selection algorithm works as follows: .B 1 -\-\- Use -.B \-\-client-connect script +-- Use +.B --client-connect script generated file for static IP (first choice). .br .B 2 -\-\- Use -.B \-\-client-config-dir +-- Use +.B --client-config-dir file for static IP (next choice). .br .B 3 -\-\- Use -.B \-\-ifconfig-pool +-- Use +.B --ifconfig-pool allocation for dynamic IP (last choice). .br .\"********************************************************* .TP -.B \-\-iroute network [netmask] +.B --iroute network [netmask] Generate an internal route to a specific client. The .B netmask
@@ -3015,36 +3015,36 @@ the server to a particular client, regardless of where the client is connecting from. Remember that you must also add the route to the system routing table as well (such as by using the -.B \-\-route +.B --route directive). The reason why two routes are needed is that the -.B \-\-route +.B --route directive routes the packet from the kernel to OpenVPN. Once in OpenVPN, the -.B \-\-iroute +.B --iroute directive routes to the specific client. This option must be specified either in a client instance config file using -.B \-\-client-config-dir +.B --client-config-dir or dynamically generated using a -.B \-\-client-connect +.B --client-connect script. The -.B \-\-iroute +.B --iroute directive also has an important interaction with -.B \-\-push +.B --push "route ...". -.B \-\-iroute +.B --iroute essentially defines a subnet which is owned by a particular client (we will call this client A). If you would like other clients to be able to reach A's subnet, you can use -.B \-\-push +.B --push "route ..." together with -.B \-\-client-to-client +.B --client-to-client to effect this. In order for all clients to see A's subnet, OpenVPN must push this route to all clients EXCEPT for A, since the subnet is already owned by A.
@@ -3053,11 +3053,11 @@ not pushing a route to a client if it matches one of the client's iroutes. .\"********************************************************* .TP -.B \-\-client-to-client +.B --client-to-client Because the OpenVPN server mode handles multiple clients through a single tun or tap interface, it is effectively a router. The -.B \-\-client-to-client +.B --client-to-client flag tells OpenVPN to internally route client-to-client traffic rather than pushing all client-originating traffic to the TUN/TAP interface.
@@ -3069,13 +3069,13 @@ if you want to firewall tunnel traffic using custom, per-client rules. .\"********************************************************* .TP -.B \-\-duplicate-cn +.B --duplicate-cn Allow multiple clients with the same common name to concurrently connect. In the absence of this option, OpenVPN will disconnect a client instance upon connection of a new client having the same common name. .\"********************************************************* .TP -.B \-\-client-connect cmd +.B --client-connect cmd Run .B command cmd on client connection.
@@ -3100,7 +3100,7 @@ to be applied on the server when the client connects, it should write it to the file named by the last argument. See the -.B \-\-client-config-dir +.B --client-config-dir option below for options which can be legally used in a dynamically generated config file.
@@ -3112,18 +3112,18 @@ returns a non-zero error status, it will cause the client to be disconnected. .\"********************************************************* .TP -.B \-\-client-disconnect cmd +.B --client-disconnect cmd Like -.B \-\-client-connect +.B --client-connect but called on client instance shutdown. Will not be called unless the -.B \-\-client-connect +.B --client-connect script and plugins (if defined) were previously called on this instance with successful (0) status returns. The exception to this rule is if the -.B \-\-client-disconnect +.B --client-disconnect command or plugins are cascaded, and at least one client-connect function succeeded, then ALL of the client-disconnect functions for scripts and plugins will be called on client instance object deletion,
@@ -3131,16 +3131,16 @@ even in cases where some of the related client-connect functions returned an error status. The -.B \-\-client-disconnect +.B --client-disconnect command is passed the same pathname as the corresponding -.B \-\-client-connect +.B --client-connect command as its last argument. (after any arguments specified in .B cmd ). .B .\"********************************************************* .TP -.B \-\-client-config-dir dir +.B --client-config-dir dir Specify a directory .B dir for custom client config files. After
@@ -3156,9 +3156,9 @@ after it has dropped it's root privileges. This file can specify a fixed IP address for a given client using -.B \-\-ifconfig-push, +.B --ifconfig-push, as well as fixed subnets owned by the client using -.B \-\-iroute. +.B --iroute. One of the useful properties of this option is that it allows client configuration files to be conveniently
@@ -3167,19 +3167,19 @@ without needing to restart the server. The following options are legal in a client-specific context: -.B \-\-push, \-\-push-reset, \-\-iroute, \-\-ifconfig-push, +.B --push, --push-reset, --iroute, --ifconfig-push, and -.B \-\-config. +.B --config. .\"********************************************************* .TP -.B \-\-ccd-exclusive +.B --ccd-exclusive Require, as a condition of authentication, that a connecting client has a -.B \-\-client-config-dir +.B --client-config-dir file. .\"********************************************************* .TP -.B \-\-tmp-dir dir +.B --tmp-dir dir Specify a directory .B dir for temporary files. This directory will be used by
@@ -3191,7 +3191,7 @@ after it has dropped it's root privileges. This directory will be used by in the following cases: * -.B \-\-client-connect +.B --client-connect scripts to dynamically generate client-specific configuration files.
@@ -3205,7 +3205,7 @@ when using deferred auth method plugin hook to pass filtering rules via pf_file .\"********************************************************* .TP -.B \-\-hash-size r v +.B --hash-size r v Set the size of the real address hash table to .B r and the virtual address table to
@@ -3213,13 +3213,13 @@ and the virtual address table to By default, both tables are sized at 256 buckets. .\"********************************************************* .TP -.B \-\-bcast-buffers n +.B --bcast-buffers n Allocate .B n buffers for broadcast datagrams (default=256). .\"********************************************************* .TP -.B \-\-tcp-queue-limit n +.B --tcp-queue-limit n Maximum number of output packets queued before TCP (default=64). When OpenVPN is tunneling data from a TUN/TAP device to a
@@ -3231,7 +3231,7 @@ OpenVPN will start to drop outgoing packets directed at this client. .\"********************************************************* .TP -.B \-\-tcp-nodelay +.B --tcp-nodelay This macro sets the TCP_NODELAY socket flag on the server as well as pushes it to connecting clients. The TCP_NODELAY flag disables the Nagle algorithm on TCP sockets causing
@@ -3254,13 +3254,13 @@ The macro expands as follows: .fi .\"********************************************************* .TP -.B \-\-max-clients n +.B --max-clients n Limit server to a maximum of .B n concurrent clients. .\"********************************************************* .TP -.B \-\-max-routes-per-client n +.B --max-routes-per-client n Allow a maximum of .B n internal routes per client (default=256).
@@ -3270,9 +3270,9 @@ server with packets appearing to come from many unique MAC addresses, forcing the server to deplete virtual memory as its internal routing table expands. This directive can be used in a -.B \-\-client-config-dir +.B --client-config-dir file or auto-generated by a -.B \-\-client-connect +.B --client-connect script to override the global value for a particular client. Note that this
@@ -3280,7 +3280,7 @@ directive affects OpenVPN's internal routing table, not the kernel routing table. .\"********************************************************* .TP -.B \-\-stale-routes-check n [t] +.B --stale-routes-check n [t] Remove routes haven't had activity for .B n seconds (i.e. the ageing time).
@@ -3296,10 +3296,10 @@ is not present it defaults to This option helps to keep the dynamic routing table small. See also -.B \-\-max-routes-per-client +.B --max-routes-per-client .\"********************************************************* .TP -.B \-\-connect-freq n sec +.B --connect-freq n sec Allow a maximum of .B n new connections per
@@ -3313,12 +3313,12 @@ DoS scenario, legitimate connections might also be refused. For the best protection against DoS attacks in server mode, use -.B \-\-proto udp +.B --proto udp and -.B \-\-tls-auth. +.B --tls-auth. .\"********************************************************* .TP -.B \-\-learn-address cmd +.B --learn-address cmd Run command .B cmd to validate client virtual addresses or routes.
@@ -3332,19 +3332,19 @@ Three arguments will be appended to any arguments in .B cmd as follows: -.B [1] operation \-\- +.B [1] operation -- "add", "update", or "delete" based on whether or not the address is being added to, modified, or deleted from OpenVPN's internal routing table. .br -.B [2] address \-\- +.B [2] address -- The address being learned or unlearned. This can be an IPv4 address such as "198.162.10.14", an IPv4 subnet such as "198.162.10.0/24", or an ethernet MAC address (when -.B \-\-dev tap +.B --dev tap is being used) such as "00:FF:01:02:03:04". .br -.B [3] common name \-\- +.B [3] common name -- The common name on the certificate associated with the client linked to this address. Only present for "add" or "update" operations, not "delete".
@@ -3364,7 +3364,7 @@ policies with regard to the client's high-level common name, rather than the low level client virtual addresses. .\"********************************************************* .TP -.B \-\-auth-user-pass-verify cmd method +.B --auth-user-pass-verify cmd method Require the client to provide a username/password (possibly in addition to a client certificate) for authentication.
@@ -3400,10 +3400,10 @@ will be passed as an argument to and the file will be automatically deleted by OpenVPN after the script returns. The location of the temporary file is controlled by the -.B \-\-tmp-dir +.B --tmp-dir option, and will default to the current directory if unspecified. For security, consider setting -.B \-\-tmp-dir +.B --tmp-dir to a volatile storage medium such as .B /dev/shm (if available) to prevent the username/password file from touching the hard drive.
@@ -3435,7 +3435,7 @@ For a sample script that performs PAM authentication, see in the OpenVPN source distribution. .\"********************************************************* .TP -.B \-\-opt-verify +.B --opt-verify Clients that connect with options that are incompatible with those of the server will be disconnected.
@@ -3445,16 +3445,16 @@ comp-lzo, fragment, keydir, cipher, auth, keysize, secret, no-replay, no-iv, tls-auth, key-method, tls-server, and tls-client. This option requires that -.B \-\-disable-occ +.B --disable-occ NOT be used. .\"********************************************************* .TP -.B \-\-auth-user-pass-optional +.B --auth-user-pass-optional Allow connections by clients that do not specify a username/password. Normally, when -.B \-\-auth-user-pass-verify +.B --auth-user-pass-verify or -.B \-\-management-client-auth +.B --management-client-auth is specified (or an authentication plugin module), the OpenVPN server daemon will require connecting clients to specify a username and password. This option makes the submission of a username/password
@@ -3467,35 +3467,35 @@ to empty strings (""). The authentication module/script MUST have logic to detect this condition and respond accordingly. .\"********************************************************* .TP -.B \-\-client-cert-not-required +.B --client-cert-not-required Don't require client certificate, client will authenticate using username/password only. Be aware that using this directive is less secure than requiring certificates from all clients. If you use this directive, the entire responsibility of authentication will rest on your -.B \-\-auth-user-pass-verify +.B --auth-user-pass-verify script, so keep in mind that bugs in your script could potentially compromise the security of your VPN. If you don't use this directive, but you also specify an -.B \-\-auth-user-pass-verify +.B --auth-user-pass-verify script, then OpenVPN will perform double authentication. The client certificate verification AND the -.B \-\-auth-user-pass-verify +.B --auth-user-pass-verify script will need to succeed in order for a client to be authenticated and accepted onto the VPN. .\"********************************************************* .TP -.B \-\-username-as-common-name +.B --username-as-common-name For -.B \-\-auth-user-pass-verify +.B --auth-user-pass-verify authentication, use the authenticated username as the common name, rather than the common name from the client cert. .\"********************************************************* .TP -.B \-\-compat\-names [no\-remapping] (DEPRECATED) +.B --compat-names [no-remapping] (DEPRECATED) Until OpenVPN v2.3 the format of the X.509 Subject fields was formatted like this: .IP
@@ -3509,7 +3509,7 @@ underscore ('_'). The X.509 Subject string as returned by the environmental variable, could additionally contain colon (':') or equal ('='). .IP When using the -.B \-\-compat\-names +.B --compat-names option, this old formatting and remapping will be re-enabled again. This is purely implemented for compatibility reasons when using older plug-ins or scripts which does not handle the new formatting or UTF-8 characters.
@@ -3521,17 +3521,17 @@ standardised format. It now looks like: C=US, L=Somewhere, CN=John Doe, [email protected]... .IP The new default format in OpenVPN v2.3 also does not do the character remapping -which happened earlier. This new format enables proper support for UTF\-8 +which happened earlier. This new format enables proper support for UTF-8 characters in the usernames, X.509 Subject fields and Common Name variables and -it complies to the RFC 2253, UTF\-8 String Representation of Distinguished +it complies to the RFC 2253, UTF-8 String Representation of Distinguished Names. The -.B no\-remapping +.B no-remapping mode flag can be used with the .B -\-\-compat\-names -option to be compatible with the now deprecated \-\-no\-name\-remapping option. +--compat-names +option to be compatible with the now deprecated --no-name-remapping option. It is only available at the server. When this mode flag is used, the Common Name, Subject, and username strings are allowed to include any printable character including space, but excluding control characters such as tab, newline, and
@@ -3541,30 +3541,30 @@ carriage-return. no-remapping is only available on the server side. This option is immediately deprecated. It is only implemented to make the transition to the new formatting less intrusive. It will be removed either in OpenVPN v2.4 or v2.5. So please make sure you use the -.B \-\-verify-x509-name +.B --verify-x509-name option instead of -.B \-\-tls-remote +.B --tls-remote as soon as possible and update your scripts where necessary. .\"********************************************************* .TP -.B \-\-no\-name\-remapping (DEPRECATED) +.B --no-name-remapping (DEPRECATED) The -.B \-\-no\-name\-remapping +.B --no-name-remapping option is an alias for -.B \-\-compat\-names\ no\-remapping. +.B --compat-names\ no-remapping. It ensures compatibility with server configurations using the -.B \-\-no\-name\-remapping +.B --no-name-remapping option. .B Please note: This option is now deprecated. It will be removed either in OpenVPN v2.4 or v2.5. So please make sure you support the new X.509 name formatting described with the -.B \-\-compat\-names +.B --compat-names option as soon as possible. .\"********************************************************* .TP -.B \-\-port-share host port [dir] +.B --port-share host port [dir] When run in TCP server mode, share the OpenVPN port with another application, such as an HTTPS server. If OpenVPN senses a connection to its port which is using a non-OpenVPN
@@ -3589,13 +3589,13 @@ Not implemented on Windows. .SS Client Mode Use client mode when connecting to an OpenVPN server which has -.B \-\-server, \-\-server-bridge, +.B --server, --server-bridge, or -.B \-\-mode server +.B --mode server in it's configuration. .\"********************************************************* .TP -.B \-\-client +.B --client A helper directive designed to simplify the configuration of OpenVPN's client mode. This directive is equivalent to:
@@ -3609,33 +3609,33 @@ of OpenVPN's client mode. This directive is equivalent to: .fi .\"********************************************************* .TP -.B \-\-pull +.B --pull This option must be used on a client which is connecting to a multi-client server. It indicates to OpenVPN that it should accept options pushed by the server, provided they are part of the legal set of pushable options (note that the -.B \-\-pull +.B --pull option is implied by -.B \-\-client +.B --client ). In particular, -.B \-\-pull +.B --pull allows the server to push routes to the client, so you should not use -.B \-\-pull +.B --pull or -.B \-\-client +.B --client in situations where you don't trust the server to have control over the client's routing table. .\"********************************************************* .TP -.B \-\-auth-user-pass [up] +.B --auth-user-pass [up] Authenticate with server using username/password. .B up is a file containing username/password on 2 lines (Note: OpenVPN will only read passwords from a file if it has been built -with the \-\-enable-password-save configure option, or on Windows +with the --enable-password-save configure option, or on Windows by defining ENABLE_PASSWORD_SAVE in win/settings.in). If
@@ -3644,12 +3644,12 @@ is omitted, username/password will be prompted from the console. The server configuration must specify an -.B \-\-auth-user-pass-verify +.B --auth-user-pass-verify script to verify the username/password provided by the client. .\"********************************************************* .TP -.B \-\-auth-retry type +.B --auth-retry type Controls how OpenVPN responds to username/password verification errors such as the client-side response to an AUTH_FAILED message from the server or verification failure of the private key password.
@@ -3660,33 +3660,33 @@ of error. An AUTH_FAILED message is generated by the server if the client fails -.B \-\-auth-user-pass +.B --auth-user-pass authentication, or if the server-side -.B \-\-client-connect +.B --client-connect script returns an error status when the client tries to connect. .B type can be one of: -.B none \-\- +.B none -- Client will exit with a fatal error (this is the default). .br -.B nointeract \-\- +.B nointeract -- Client will retry the connection without requerying for an -.B \-\-auth-user-pass +.B --auth-user-pass username/password. Use this option for unattended clients. .br -.B interact \-\- +.B interact -- Client will requery for an -.B \-\-auth-user-pass +.B --auth-user-pass username/password and/or private key password before attempting a reconnection. Note that while this option cannot be pushed, it can be controlled from the management interface. .\"********************************************************* .TP -.B \-\-static\-challenge t e +.B --static-challenge t e Enable static challenge/response protocol using challenge text .B t, with
@@ -3697,18 +3697,18 @@ echo flag given by The echo flag indicates whether or not the user's response to the challenge should be echoed. -See management\-notes.txt in the OpenVPN distribution for a +See management-notes.txt in the OpenVPN distribution for a description of the OpenVPN challenge/response protocol. .\"********************************************************* .TP -.B \-\-server-poll-timeout n +.B --server-poll-timeout n when polling possible remote servers to connect to in a round-robin fashion, spend no more than .B n seconds waiting for a response before trying the next server. .\"********************************************************* .TP -.B \-\-explicit-exit-notify [n] +.B --explicit-exit-notify [n] In UDP client mode or point-to-point mode, send server/peer an exit notification if tunnel is restarted or OpenVPN process is exited. In client mode, on exit/restart, this
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
1.9.1
Part of the diff is not shown here. View the raw message.
Am 31.03.2015 um 08:44 schrieb [email protected]...:
Quoted 15 lines
From: Samuli Seppänen <[email protected]...>
This patch is against the release/2.3 branch
Trac: 512
Signed-off-by Samuli Seppänen <[email protected]...>--- doc/openvpn.8 | 1800 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 900 insertions(+), 900 deletions(-)doc/openvpn.8 +0
-0
doc/openvpn.8 line 40
Quoted 5 lines
doc/openvpn.8 +1
-1@@ -37,7 +37,7 @@ .TH openvpn 8 "17 November 2008" .\"********************************************************* .SH NAME -openvpn \- secure IP tunnel daemon. +openvpn - secure IP tunnel daemon.
I am concerned this will cause misformattings and inability to search for options with leading dashes on some systems - I don't recall versions, but I do know that some systems used some sort of Unicode (soft?) hyphen for a simple non-escaped MINUS character (ASCII 0x2B).
So, for the release/2.3 branch, NAK for now, and more questions on the 2.4/trunk.
My objections will be void the moment that we can be sure that those (major) distributions that played with the Unicode outside-ASCII hyphens in *roff have gone out of support, and supported versions no longer modify the plain ASCII minus, but render it verbatim.
Quoted 27 lines
Am 31.03.2015 um 08:44 schrieb [email protected]...:
Quoted 15 lines
From: Samuli Seppänen <[email protected]...>
This patch is against the release/2.3 branch
Trac: 512
Signed-off-by Samuli Seppänen <[email protected]...>--- doc/openvpn.8 | 1800 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 900 insertions(+), 900 deletions(-)doc/openvpn.8 +0
-0doc/openvpn.8 line 40
Quoted 5 lines
doc/openvpn.8 +1
-1@@ -37,7 +37,7 @@ .TH openvpn 8 "17 November 2008" .\"********************************************************* .SH NAME -openvpn \- secure IP tunnel daemon. +openvpn - secure IP tunnel daemon.I am concerned this will cause misformattings and inability to search for options with leading dashes on some systems - I don't recall versions, but I do know that some systems used some sort of Unicode (soft?) hyphen for a simple non-escaped MINUS character (ASCII
0x2B).
Quoted 8 lines
So, for the release/2.3 branch, NAK for now, and more questions on the 2.4/trunk.
My objections will be void the moment that we can be sure that those (major) distributions that played with the Unicode outside-ASCII hyphens in *roff have gone out of support, and supported versions no longer modify the plain ASCII minus, but render it verbatim.
Hi,
Getting back to this after a while... we did quite extensive tests earlier. I recall testing the following operating systems myself:
- Debian 6
- Debian 7
- Ubuntu 10.04
- Ubuntu 12.04
- CentOS 6
I was unable to reproduce the search issue or to trigger any misrendering on any of those platforms. I think RedHat 5 was also tested, but I'm not sure about the BSD-based operating systems.
In any case the man-page is currently a mishmash of escaped and unescaped dashes, so if there is a problem, people are already having it and not caring.
I suggest we do a few additional tests and if no problems are encountered then merge the patch.
Samuli
Quoted 27 lines
Am 31.03.2015 um 08:44 schrieb [email protected]...:
Quoted 15 lines
From: Samuli Seppänen <[email protected]...>
This patch is against the release/2.3 branch
Trac: 512
Signed-off-by Samuli Seppänen <[email protected]...>--- doc/openvpn.8 | 1800 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 900 insertions(+), 900 deletions(-)doc/openvpn.8 +0
-0doc/openvpn.8 line 40
Quoted 5 lines
doc/openvpn.8 +1
-1@@ -37,7 +37,7 @@ .TH openvpn 8 "17 November 2008" .\"********************************************************* .SH NAME -openvpn \- secure IP tunnel daemon. +openvpn - secure IP tunnel daemon.I am concerned this will cause misformattings and inability to search for options with leading dashes on some systems - I don't recall versions, but I do know that some systems used some sort of Unicode (soft?) hyphen for a simple non-escaped MINUS character (ASCII
0x2B).
Quoted 7 lines
So, for the release/2.3 branch, NAK for now, and more questions on the 2.4/trunk.
My objections will be void the moment that we can be sure that those (major) distributions that played with the Unicode outside-ASCII hyphens in *roff have gone out of support, and supported versions no longer modify the plain ASCII minus, but render it verbatim.
Matthias: I did additional research and it seems that escaping dashes in _options_ (but nowhere else) is the correct approach, see
<https://community.openvpn.net/openvpn/ticket/512#comment:9>
Any objections to this approach?
Signature · 5 lines
Samuli Seppänen Community Manager OpenVPN Technologies, Inc irc freenode net: mattock
Quoted 4 lines · Matthias Andree
I am concerned this will cause misformattings and inability to search for options with leading dashes on some systems - I don't recall versions, but I do know that some systems used some sort of Unicode (soft?) hyphen for a simple non-escaped MINUS character (ASCII
0x2B).
cf. https://bugzilla.redhat.com/show_bug.cgi?id=1173619
I'm not sure there *is* a right answer. Groff will interpret a bare '- ' as a hyphen, and may render it in output as U+2010 HYPHEN. It will interpret an escaped '\-' as a minus sign, and may render it in output as U+2212 MINUS SIGN.
I'm not aware of any way to actually *tell* groff that we want the output to be a U+002D HYPHEN-MINUS. Either way, we rely on undefined behaviour of the output drivers which may vary from system to system.
Basically, I think groff is just broken. There is a thread at
http://lists.gnu.org/archive/html/groff/2015-01/threads.html which I've just discovered, but I'm not sure I can see a conclusion there that I understand.
Signature · 1 line
dwmw2
Am 29.04.2015 um 14:07 schrieb David Woodhouse:
Quoted 13 lines · Matthias Andree
Quoted 4 lines
I am concerned this will cause misformattings and inability to search for options with leading dashes on some systems - I don't recall versions, but I do know that some systems used some sort of Unicode (soft?) hyphen for a simple non-escaped MINUS character (ASCII
0x2B).cf. https://bugzilla.redhat.com/show_bug.cgi?id=1173619
I'm not sure there *is* a right answer. Groff will interpret a bare '- ' as a hyphen, and may render it in output as U+2010 HYPHEN. It will interpret an escaped '\-' as a minus sign, and may render it in output as U+2212 MINUS SIGN.
Quoted 8 lines
I'm not aware of any way to actually *tell* groff that we want the output to be a U+002D HYPHEN-MINUS. Either way, we rely on undefined behaviour of the output drivers which may vary from system to system.
Basically, I think groff is just broken. There is a thread at
http://lists.gnu.org/archive/html/groff/2015-01/threads.html which I've just discovered, but I'm not sure I can see a conclusion there that I understand.
That would mean we either go into autoconf territory to test for groff run-time behaviour, or we use a particular unique sequence and do our own post-processing.
Quoted 4 lines
That would mean we either go into autoconf territory to test for groff run-time behaviour, or we use a particular unique sequence and do our own post-processing.
The latter is baaically the approach I took in
http://git.infradead.org/users/dwmw2/openconnect.git/commitdiff/5f15c83f2
Signature · 1 line
dwmw2
Hi,
Quoted 6 lines · David Woodhouse
Quoted 3 lines
That would mean we either go into autoconf territory to test for groff run-time behaviour, or we use a particular unique sequence and do our own post-processing.
The latter is baaically the approach I took in
http://git.infradead.org/users/dwmw2/openconnect.git/commitdiff/5f15c83f2
So you put "−" in the .8 file, which is converted to "-" for HTML - but what happens for "man openconnect"? Will groff understand "−" and output a "proper U+002D HYPHEN-MINUS"? (Not that it's particular fun to edit such .8 files then...)
(There's a famous saying about "it would be much easier to teach them all English" when it comes to internationalization, charsets, and all that pain...)
gert
Signature · 4 lines
USENET is *not* the non-clickable part of WWW!
//www.muc.de/~gert/
Gert Doering - Munich, Germany [email protected]...
fax: +49-89-35655025 [email protected]...Quoted 7 lines · Gert Doering
Hi,
Quoted 4 lines · David Woodhouse
Quoted 3 lines
That would mean we either go into autoconf territory to test for groff run-time behaviour, or we use a particular unique sequence and do our own post-processing.
Quoted 7 lines
Quoted 2 lines
The latter is baaically the approach I took in
http://git.infradead.org/users/dwmw2/openconnect.git/commitdiff/5f51c83f2So you put "−" in the .8 file, which is converted to "-" for HTML - but what happens for "man openconnect"? Will groff understand "−" and output a "proper U+002D HYPHEN-MINUS"? (Not that it's particular fun to edit such .8 files then...)
No, in the .8 file I left it as \-
I then seem to get the desired U+002D output from man(1) in the
terminal, and the patch referenced above is fixing up the −
which we get in XHTML output, for the web rendition which is used at http://www.infradead.org/openconnect/manual.html
Quite why we don't get U+2212 MINUS SIGN in the terminal output too, I don't know. That's just groff being inconsistent.
Quoted 3 lines
(There's a famous saying about "it would be much easier to teach them all English" when it comes to internationalization, charsets, and all that pain...)
Seems rather naïve to assume that sticking solely to English would allow us to stick to ASCII. ∃ lots of reasons to use non-ASCII characters, even when you're sticking to English. ☺
Signature · 1 line
dwmw2