Browse code

basic documentation of IPv6 related options and their syntax

Gert Doering authored on 2010/02/17 00:36:08
Showing 1 changed files
... ...
@@ -789,6 +789,8 @@ or
789 789
 .B \-\-dev tunX.
790 790
 A warning will be displayed
791 791
 if no specific IPv6 TUN support for your OS has been compiled into OpenVPN.
792
+
793
+See below for further IPv6-related configuration options.
792 794
 .\"*********************************************************
793 795
 .TP
794 796
 .B \-\-dev-node node
... ...
@@ -4936,6 +4938,57 @@ if certificates are stored as private objects.
4936 4936
 .B \-\-verb
4937 4937
 option can be used BEFORE this option to produce debugging information.
4938 4938
 .\"*********************************************************
4939
+.SS IPv6 Related Options
4940
+.\"*********************************************************
4941
+The following options exist to support IPv6 tunneling in peer-to-peer
4942
+and client-server mode.  As of now, this is just very basic
4943
+documentation of the IPv6-related options. More documentation can be
4944
+found on http://greenie.muc.de/ipv6/openvpn.html.
4945
+.TP
4946
+.B --ifconfig-ipv6 ipv6addr/bits ipv6remote
4947
+configure IPv6 address
4948
+.B ipv6addr/bits
4949
+on the ``tun'' device.  The second parameter is used as route target for
4950
+.B --route-ipv6
4951
+if no gateway is specified.
4952
+.TP
4953
+.B --route-ipv6 ipv6addr/bits [gateway] [metric]
4954
+setup IPv6 routing in the system to send the specified IPv6 network
4955
+into OpenVPN's ``tun'' device
4956
+.TP
4957
+.B --server-ipv6 ipv6addr/bits
4958
+convenience-function to enable a number of IPv6 related options at
4959
+once, namely
4960
+.B --ifconfig-ipv6, --ifconfig-ipv6-pool, --tun-ipv6
4961
+and
4962
+.B --push tun-ipv6
4963
+Is only accepted if ``--mode server'' or ``--server'' is set.
4964
+.TP
4965
+.B --ifconfig-ipv6-pool ipv6addr/bits
4966
+Specify an IPv6 address pool for dynamic assignment to clients.  The
4967
+pool starts at
4968
+.B ipv6addr
4969
+and increments by +1 for every new client (linear mode).  The
4970
+.B /bits
4971
+setting controls the size of the pool.
4972
+.TP
4973
+.B --ifconfig-ipv6-push ipv6addr/bits ipv6remote
4974
+for ccd/ per-client static IPv6 interface configuration, see
4975
+.B --client-config-dir
4976
+and
4977
+.B --ifconfig-push
4978
+for more details.
4979
+.TP
4980
+.B --iroute-ipv6 ipv6addr/bits
4981
+for ccd/ per-client static IPv6 route configuration, see
4982
+.B --iroute
4983
+for more details how to setup and use this, and how
4984
+.B --iroute
4985
+and
4986
+.B --route
4987
+interact.
4988
+
4989
+.\"*********************************************************
4939 4990
 .SH SCRIPTING AND ENVIRONMENTAL VARIABLES
4940 4991
 OpenVPN exports a series
4941 4992
 of environmental variables for use by user-defined scripts.