From 41ff9b3089673a81b6c73f4cef489d974cfc52b2 Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Thu, 23 Nov 2006 17:48:56 +0000
Subject: [PATCH] New syntax convention in tunnels manpage

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@4993 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 manpages/shorewall-tunnels.xml | 44 +++++++++++++++++++++-------------
 1 file changed, 27 insertions(+), 17 deletions(-)

diff --git a/manpages/shorewall-tunnels.xml b/manpages/shorewall-tunnels.xml
index f1b8d8385..f6d6ed554 100644
--- a/manpages/shorewall-tunnels.xml
+++ b/manpages/shorewall-tunnels.xml
@@ -25,20 +25,25 @@
 
     <variablelist>
       <varlistentry>
-        <term><emphasis role="bold">TYPE</emphasis></term>
+        <term><emphasis role="bold">TYPE</emphasis> — {{<emphasis
+        role="bold">ipsec</emphasis>|<emphasis
+        role="bold">ipsecnat</emphasis>}[<emphasis
+        role="bold">:noah</emphasis>]|<emphasis
+        role="bold">ipip</emphasis>|<emphasis
+        role="bold">gre</emphasis>|<emphasis
+        role="bold">pptpclient</emphasis>|<emphasis
+        role="bold">pptpserver</emphasis>|{<emphasis
+        role="bold">openvpn</emphasis>|<emphasis
+        role="bold">openvpnclient</emphasis>|<emphasis
+        role="bold">openvpnserver</emphasis>}[:{<emphasis
+        role="bold">tcp</emphasis>|<emphasis
+        role="bold">udp</emphasis>}]<emphasis
+        role="bold">[</emphasis>:<emphasis>port</emphasis>]|<emphasis
+        role="bold">generic</emphasis><emphasis
+        role="bold">:</emphasis><emphasis>protocol</emphasis>[<emphasis
+        role="bold">:</emphasis><emphasis>port</emphasis>]}</term>
 
         <listitem>
-          <para>Must be <emphasis role="bold">ipsec</emphasis>, <emphasis
-          role="bold">ipsecnat</emphasis>, <emphasis
-          role="bold">ipip</emphasis>, <emphasis role="bold">gre</emphasis>,
-          <emphasis role="bold">6to4</emphasis>, <emphasis
-          role="bold">pptpclient</emphasis>, <emphasis
-          role="bold">pptpserver</emphasis>, <emphasis
-          role="bold">openvpn</emphasis>, <emphasis
-          role="bold">openvpnclient</emphasis>, <emphasis
-          role="bold">openvpnserver</emphasis> or <emphasis
-          role="bold">generic</emphasis></para>
-
           <para>If the type is <emphasis role="bold">ipsec</emphasis> or
           <emphasis role="bold">ipsecnat</emphasis>, it may be followed by
           <emphasis role="bold">:noah</emphasis> to indicate that the
@@ -71,16 +76,19 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">ZONE</emphasis></term>
+        <term><emphasis role="bold">ZONE</emphasis> -
+        <emphasis>zone</emphasis></term>
 
         <listitem>
-          <para>The zone of the physical interface through which tunnel
-          traffic passes. This is normally your internet zone.</para>
+          <para>The <emphasis>zone</emphasis> of the physical interface
+          through which tunnel traffic passes. This is normally your internet
+          zone.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">GATEWAY</emphasis></term>
+        <term><emphasis role="bold">GATEWAY</emphasis> —
+        <emphasis>address-or-range</emphasis></term>
 
         <listitem>
           <para>The IP address of the remote tunnel gateway. If the remote
@@ -92,7 +100,9 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">GATEWAY ZONES</emphasis> (Optional)</term>
+        <term><emphasis role="bold">GATEWAY ZONES</emphasis> (Optional) —
+        [<emphasis>zone</emphasis>[<emphasis
+        role="bold">,</emphasis><emphasis>zone</emphasis>]...]</term>
 
         <listitem>
           <para>If the gateway system specified in the third column is a