[Openvpn-devel,v2] Improve the documentation for --dhcp-option

Message ID 1597604799-23135-1-git-send-email-selva.nair@gmail.com
State Accepted
Headers show
Series [Openvpn-devel,v2] Improve the documentation for --dhcp-option | expand

Commit Message

Selva Nair Aug. 16, 2020, 9:06 a.m. UTC
From: Selva Nair <selva@gaas2.nanotech.utoronto.ca>

- Stress that these are handled internally only on some platforms
- Correct the statement about wintun 

Signed-off-by: Selva Nair <selva.nair@gmail.com>
v2: Rebase to master and reword to match the new rst version
    Add doc for DOMAIN-SEARCH

 doc/man-sections/vpn-network-options.rst | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)


Gert Doering Aug. 16, 2020, 7:37 p.m. UTC | #1
Acked-by: Gert Doering <gert@greenie.muc.de>


Your patch has been applied to the master and release/2.5 branch.

commit 2da29362cc93aa1b8c24386e162b9cdd3b55c3b1 (master)
commit 64f0b1c07e1d4579cdb3d6a9df27555071c1ed04 (master)
Author: Selva Nair
Date:   Sun Aug 16 15:06:39 2020 -0400

     Improve the documentation for --dhcp-option

     Signed-off-by: Selva Nair <selva.nair@gmail.com>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <1597604799-23135-1-git-send-email-selva.nair@gmail.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg20759.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>

kind regards,

Gert Doering


diff --git a/doc/man-sections/vpn-network-options.rst b/doc/man-sections/vpn-network-options.rst
index 7100c1ae..825dd1ca 100644
--- a/doc/man-sections/vpn-network-options.rst
+++ b/doc/man-sections/vpn-network-options.rst
@@ -93,12 +93,18 @@  routing.
   or :code:`tap`.
 --dhcp-option args
-  Set additional network settings via DHCP.  On Windows, this is parsed by
-  the ``tap-windows6`` or ``wintun`` driver.  On other platforms these
-  options can be picked up by an ``--up`` script or plug-in if it has been
-  pushed by the OpenVPN server.  The option will then be saved in the
-  client's environment before the ``--up`` script is called, under the name
-  :code:`foreign_option_{n}`.
+  Set additional network parameters on supported platforms. May be specified
+  on the client or pushed from the server. On Windows these options are
+  handled by the ``tap-windows6`` driver by default or directly by OpenVPN
+  if dhcp is disabled or the ``wintun`` driver is in use. The
+  ``OpenVPN for Android`` client also handles them internally.
+  On all other platforms these options are only saved in the client's
+  environment under the name :code:`foreign_options_{n}` before the
+  ``--up`` script is called. A plugin or an ``--up`` script must be used to
+  pick up and interpret these as required. Many Linux distributions include
+  such scripts and some third-party user interfaces such as tunnelblick also
+  come with scripts that process these options.
   Valid syntax:
@@ -108,6 +114,11 @@  routing.
   :code:`DOMAIN` ``name``
         Set Connection-specific DNS Suffix to :code:`name`.
+  :code:`DOMAIN-SEARCH` ``name``
+        Add :code:`name` to the domain search list.
+        Repeat this option to add more entries. Up to
+        10 domains are supported.
   :code:`DNS` ``address``
         Set primary domain name server IPv4 or IPv6 address.
         Repeat this option to set secondary DNS server addresses.