]> git.ipfire.org Git - thirdparty/openvpn.git/commitdiff
doc: improve Windows-specific options section
authorHeiko Hund <heiko@ist.eigentlich.net>
Fri, 13 Mar 2026 10:37:07 +0000 (11:37 +0100)
committerGert Doering <gert@greenie.muc.de>
Sat, 14 Mar 2026 16:53:21 +0000 (17:53 +0100)
Change-Id: I29a33ac23f3c1a7cf16196aecc46ec3597a22175
Signed-off-by: Heiko Hund <heiko@ist.eigentlich.net>
Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1574
Message-Id: <20260313103707.14534-1-frank@lichtenheld.com>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg36084.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit 3459f09f497addac98f5d3e11d7e13e29d711336)

doc/man-sections/windows-options.rst

index af2fb4543f1c83dea414b6a8a9d5353135cc816d..8d7dcbb7699bb36d64ad40dec41018463f374d0e 100644 (file)
@@ -1,6 +1,12 @@
 Windows-Specific Options
 -------------------------
 
+These options are considered unknown on non-Windows platforms, resulting
+in fatal error (except ``--route-method``). You may want to use
+``--setenv opt`` or ``--ignore-unknown-option`` to ignore said error.
+Note that pushing unknown options from server does not trigger fatal
+errors.
+
 --allow-nonadmin TAP-adapter
   (Standalone) Set ``TAP-adapter`` to allow access from non-administrative
   accounts. If ``TAP-adapter`` is omitted, all TAP adapters on the system
@@ -16,12 +22,6 @@ Windows-Specific Options
   one inside the tunnel. It uses Windows Filtering Platform (WFP) and
   works on Windows Vista or later.
 
-  This option is considered unknown on non-Windows platforms and
-  unsupported on Windows XP, resulting in fatal error. You may want to use
-  ``--setenv opt`` or ``--ignore-unknown-option`` (not suitable for
-  Windows XP) to ignore said error. Note that pushing unknown options from
-  server does not trigger fatal errors.
-
 --cryptoapicert select-string
   *(Windows/OpenSSL Only)* Load the certificate and private key from the
   Windows Certificate System Store.