From 59f640c28d61fea1efff5b1386dcf1a08dd0aad7 Mon Sep 17 00:00:00 2001 From: Arne Schwabe Date: Wed, 12 May 2021 15:15:10 +0200 Subject: [PATCH] Document stub-v2 being basically an alias for no compression at all Signed-off-by: Arne Schwabe Acked-by: Gert Doering Message-Id: <20210512131511.1309914-9-arne@rfc2549.org> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22346.html Signed-off-by: Gert Doering --- doc/man-sections/protocol-options.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst index 4b6928c68..34d4255ee 100644 --- a/doc/man-sections/protocol-options.rst +++ b/doc/man-sections/protocol-options.rst @@ -96,6 +96,11 @@ configured in a compatible way between both the local and remote side. other variants always add one extra framing byte compared to no compression framing. + Especially :code:`stub-v2` is essentially identical to no compression and + no compression framing as its header indicates IP version 5 in a tun setup + and can (ab)used to complete disable compression to clients. (See the + :code:`migrate option below) + If the ``algorithm`` parameter is :code:`stub`, :code:`stub-v2` or empty, compression will be turned off, but the packet framing for compression will still be enabled, allowing a different setting to be pushed later. -- 2.47.2