aboutsummaryrefslogtreecommitdiff
path: root/doc/man-sections
diff options
context:
space:
mode:
authorArne Schwabe2022-01-01 17:25:19 +0100
committerGert Doering2022-01-27 18:09:37 +0100
commit29453c37c1f3aa420a894996dd7be4a4f8393c5a (patch)
tree8bf80df16886f031a9f24d1143144a6a3886b072 /doc/man-sections
parent0f7cd474118deeced48168ed9cec0806e7f4cc15 (diff)
downloadopenvpn-29453c37c1f3aa420a894996dd7be4a4f8393c5a.zip
openvpn-29453c37c1f3aa420a894996dd7be4a4f8393c5a.tar.gz
Deprecate link-mtu
This options might have been useful in the past but nowadays it has a very unclear semantics, so better remove/deprecate it. Signed-off-by: Arne Schwabe <arne@rfc2549.org> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20220101162532.2251835-2-arne@rfc2549.org> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg23496.html Signed-off-by: Gert Doering <gert@greenie.muc.de>
Diffstat (limited to 'doc/man-sections')
-rw-r--r--doc/man-sections/link-options.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/man-sections/link-options.rst b/doc/man-sections/link-options.rst
index 32e72a1..b1ae4e7 100644
--- a/doc/man-sections/link-options.rst
+++ b/doc/man-sections/link-options.rst
@@ -82,10 +82,15 @@ the local and the remote host.
ping-restart 60 # Argument: timeout
--link-mtu n
- Sets an upper bound on the size of UDP packets which are sent between
+ **DEPRECATED** 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.*
+ Due to variable header size of IP header (20 bytes for IPv4 and 40 bytes
+ for IPv6) and dynamically negotiated data channel cipher, this option
+ is not reliable. It is recommended to set tun-mtu with enough headroom
+ instead.
+
--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