From bd767a3ed2a0383483912a8662bc72ec0c04e829 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Mon, 17 Sep 2018 16:06:38 +0200 Subject: [PATCH] man: Add documentation for IP tunnel hook Signed-off-by: Michael Tremer --- Makefile.am | 2 +- man/network-zone-6to4-tunnel.xml | 179 ------------------------------- man/network-zone-ip-tunnel.xml | 116 ++++++++++++++++++++ 3 files changed, 117 insertions(+), 180 deletions(-) delete mode 100644 man/network-zone-6to4-tunnel.xml create mode 100644 man/network-zone-ip-tunnel.xml diff --git a/Makefile.am b/Makefile.am index 69a1170e..809c824f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -443,9 +443,9 @@ MANPAGES = \ man/network-vpn.8 \ man/network-vpn-security-policies.8 \ man/network-zone.8 \ - man/network-zone-6to4-tunnel.8 \ man/network-zone-bridge.8 \ man/network-zone-config-pppoe-server.8 \ + man/network-zone-ip-tunnel.8 \ man/network-zone-modem.8 \ man/network-zone-pppoe.8 \ man/network-zone-wireless.8 diff --git a/man/network-zone-6to4-tunnel.xml b/man/network-zone-6to4-tunnel.xml deleted file mode 100644 index 8126e821..00000000 --- a/man/network-zone-6to4-tunnel.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - network-zone-6to4-tunnel - network - - - - Developer - Michael - Tremer - michael.tremer@ipfire.org - - - - - - network-zone-6to4-tunnel - 8 - - - - network-zone-6to4-tunnel - Network Configuration Control Program - - - - - network zone new ZONE 6to4-tunnel ... - - - - network zone ZONE edit ... - - - - - Description - - - The 6to4-tunnel hook is used to create IPv6 tunnels over IPv4 networks - where the provider does not provide native IPv6. - - - Hurricane Electric offers a free tunnelbroker service on - http://www.tunnelbroker.net, that can be used with this hook. - - - - - Options - - - The following options are understood: - - - - - - - - - - - The address of the tunnel endpoint server. - - - This is the IPv4 address of the server, to where - the tunnel is created. - - - - - - - - - - - - The local IPv4 address that is used to connect to - the server. - - - Attention! In case your local tunnel endpoint is behind - a NAT, you need to configure the internet IP address instead - of the public IP address. - - - - - - - - - - - - The local IPv6 address of your tunnel. - - - - - - - Optional arguments, that can be used to automatically update the - tunnel endpoint IPv4 address with tunnelbroker.net: - - - - - - - - - - - Determines whether the tunnel endpoint IPv4 address should - be automatically updated or not. - - - - - - - - - - - - The username of your tunnelbroker.net account. - - - - - - - - - - - - The password of your tunnelbroker.net account. - - - - - - - - - - - - The ID of this tunnel, given to you by tunnelbroker.net. - - - - - - - - See Also - - - - network - 8 - , - - network-zone - 8 - - - - diff --git a/man/network-zone-ip-tunnel.xml b/man/network-zone-ip-tunnel.xml new file mode 100644 index 00000000..cd3fa639 --- /dev/null +++ b/man/network-zone-ip-tunnel.xml @@ -0,0 +1,116 @@ + + + + + + network-zone-ip-tunnel + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-zone-ip-tunnel + 8 + + + + network-zone-ip-tunnel + Network Configuration Control Program + + + + + network zone new ZONE ip-tunnel ... + + + + network zone ZONE edit ... + + + + + Description + + + The ip-tunnel hook is used to create IP tunnels that use protocols + like GRE to encapsulate IP packets. + + + + + Options + + + The following options are understood: + + + + + + + + + + + Sets the protocol that is being used to encapsulate + IP packets. + Currently only gre is supported. + + + + + + + + + + + + The address of the peer that terminates the remote + end of this tunnel. + + + + + + + + + + + + The local IP address the tunnel originates from. + + + + This is optional and if unset a useful default will be used. + + + + + + + + See Also + + + + network + 8 + , + + network-zone + 8 + + + + -- 2.39.2