[Openvpn-devel] man: Add missing --server-ipv6

Message ID 20200911154259.13837-1-davids@openvpn.net
State Accepted
Headers show
Series [Openvpn-devel] man: Add missing --server-ipv6 | expand

Commit Message

David Sommerseth Sept. 11, 2020, 5:42 a.m. UTC
During the conversion from .8 to .rst and further reorganizing of the
content into separate files, the --server-ipv6 entry got lost.  This
resurrects it again.

Signed-off-by: David Sommerseth <davids@openvpn.net>
 doc/man-sections/server-options.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)


Gert Doering Sept. 11, 2020, 6:25 a.m. UTC | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

Thanks :)

I have removed one line
  +  This is only accepted if ``--mode server`` or ``--server`` is set.

as this is no longer correct after merging of Antonio's ipv6-only
patch set (but the corresponding doc change might have gotten lost in

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

commit 8120e1ad4f20d4ec1fa9e191f3b15740c4aec448 (master)
commit a4c03b46b24f952489a6ad19a434f2dff13d1276 (release/2.5)
Author: David Sommerseth
Date:   Fri Sep 11 17:42:59 2020 +0200

     man: Add missing --server-ipv6

     Signed-off-by: David Sommerseth <davids@openvpn.net>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20200911154259.13837-1-davids@openvpn.net>
     URL: https://www.mail-archive.com/search?l=mid&q=20200911154259.13837-1-davids@openvpn.net
     Signed-off-by: Gert Doering <gert@greenie.muc.de>

kind regards,

Gert Doering


diff --git a/doc/man-sections/server-options.rst b/doc/man-sections/server-options.rst
index 2009953c..1c25d75a 100644
--- a/doc/man-sections/server-options.rst
+++ b/doc/man-sections/server-options.rst
@@ -639,6 +639,20 @@  fast hardware. SSL/TLS authentication must be used in this mode.
     mode server
+--server-ipv6 args
+  Convenience-function to enable a number of IPv6 related options at once,
+  namely ``--ifconfig-ipv6``, ``--ifconfig-ipv6-pool`` and
+  ``--push tun-ipv6``.
+  Valid syntax:
+  ::
+     server-ipv6 ipv6addr/bits
+  This is only accepted if ``--mode server`` or ``--server`` is set.
+  Pushing of the ``--tun-ipv6`` directive is done for older clients which
+  require an explicit ``--tun-ipv6`` in their configuration.
 --stale-routes-check args
   Remove routes which haven't had activity for ``n`` seconds (i.e. the ageing
   time).  This check is run every ``t`` seconds (i.e. check interval).