Browse code

Improve the documentation for --dhcp-option

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

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>
(cherry picked from commit 2da29362cc93aa1b8c24386e162b9cdd3b55c3b1)

Selva Nair authored on 2020/08/17 04:06:39
Showing 1 changed files
... ...
@@ -93,12 +93,18 @@ routing.
93 93
   or :code:`tap`.
94 94
 
95 95
 --dhcp-option args
96
-  Set additional network settings via DHCP.  On Windows, this is parsed by
97
-  the ``tap-windows6`` or ``wintun`` driver.  On other platforms these
98
-  options can be picked up by an ``--up`` script or plug-in if it has been
99
-  pushed by the OpenVPN server.  The option will then be saved in the
100
-  client's environment before the ``--up`` script is called, under the name
101
-  :code:`foreign_option_{n}`.
96
+  Set additional network parameters on supported platforms. May be specified
97
+  on the client or pushed from the server. On Windows these options are
98
+  handled by the ``tap-windows6`` driver by default or directly by OpenVPN
99
+  if dhcp is disabled or the ``wintun`` driver is in use. The
100
+  ``OpenVPN for Android`` client also handles them internally.
101
+
102
+  On all other platforms these options are only saved in the client's
103
+  environment under the name :code:`foreign_options_{n}` before the
104
+  ``--up`` script is called. A plugin or an ``--up`` script must be used to
105
+  pick up and interpret these as required. Many Linux distributions include
106
+  such scripts and some third-party user interfaces such as tunnelblick also
107
+  come with scripts that process these options.
102 108
 
103 109
   Valid syntax:
104 110
   ::
... ...
@@ -108,6 +114,11 @@ routing.
108 108
   :code:`DOMAIN` ``name``
109 109
         Set Connection-specific DNS Suffix to :code:`name`.
110 110
 
111
+  :code:`DOMAIN-SEARCH` ``name``
112
+        Add :code:`name` to the domain search list.
113
+        Repeat this option to add more entries. Up to
114
+        10 domains are supported.
115
+
111 116
   :code:`DNS` ``address``
112 117
         Set primary domain name server IPv4 or IPv6 address.
113 118
         Repeat this option to set secondary DNS server addresses.