[Openvpn-devel,v2] doc: add "ovpn-dco" to usage and man page

Message ID 20220917163425.351-1-lstipakov@gmail.com
State Accepted
Headers show
Series [Openvpn-devel,v2] doc: add "ovpn-dco" to usage and man page | expand

Commit Message

Lev Stipakov Sept. 17, 2022, 6:34 a.m. UTC
From: Lev Stipakov <lev@openvpn.net>

While on it, remove redundant sentence
and quotation mark from --windows-driver man

Signed-off-by: Lev Stipakov <lev@openvpn.net>

 - mark ovpn-dco adapter as default, instead
of tap-windows6

 - mention that ovpn-dco requires --dev tun

 doc/man-sections/windows-options.rst | 6 +++---
 src/openvpn/options.c                | 3 ++-
 2 files changed, 5 insertions(+), 4 deletions(-)


Gert Doering Sept. 17, 2022, 7:05 a.m. UTC | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

"That was an easy one", after the plugin/script auth related stuff :-)

Your patch has been applied to the master branch.

commit 7de4be94e297ab1ea87ab17934f2026d7124239c
Author: Lev Stipakov
Date:   Sat Sep 17 19:34:25 2022 +0300

     doc: add ovpn-dco to usage and man page

     Signed-off-by: Lev Stipakov <lev@openvpn.net>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20220917163425.351-1-lstipakov@gmail.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg25240.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>

kind regards,

Gert Doering


diff --git a/doc/man-sections/windows-options.rst b/doc/man-sections/windows-options.rst
index c389fbc4..368f7b19 100644
--- a/doc/man-sections/windows-options.rst
+++ b/doc/man-sections/windows-options.rst
@@ -238,7 +238,7 @@  Windows-Specific Options
   logged when this is found in the configuration file.
 --windows-driver drv
-  Specifies which tun driver to use. Values are :code:`tap-windows6`
-  (default) and :code:`wintun`.  This is a Windows-only option.
-  :code:`wintun`" requires ``--dev tun`` and the OpenVPN process to run
+  Specifies which tun driver to use. Values are :code:`ovpn-dco` (default),
+  :code:`tap-windows6` and :code:`wintun`. :code:`ovpn-dco` and :code:`wintun`
+  require ``--dev tun``. :code:`wintun` also requires OpenVPN process to run
   elevated, or be invoked using the Interactive Service.
diff --git a/src/openvpn/options.c b/src/openvpn/options.c
index d7954ebc..45fbb634 100644
--- a/src/openvpn/options.c
+++ b/src/openvpn/options.c
@@ -749,7 +749,8 @@  static const char usage_message[] =
     "--show-net-up   : Show " PACKAGE_NAME "'s view of routing table and net adapter list\n"
     "                  after TAP adapter is up and routes have been added.\n"
     "--windows-driver   : Which tun driver to use?\n"
-    "                     tap-windows6 (default)\n"
+    "                     ovpn-dco (default)\n"
+    "                     tap-windows6\n"
     "                     wintun\n"
     "--block-outside-dns   : Block DNS on other network adapters to prevent DNS leaks\n"
     "Windows Standalone Options:\n"