From 5e5a4ea716082faea8c6ea035450ffb1283c5a4c Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Wed, 22 Nov 2006 23:29:21 +0000
Subject: [PATCH] New syntax convention in policy manpage

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@4981 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 manpages/shorewall-netmap.xml | 13 +++++++++----
 manpages/shorewall-policy.xml | 31 ++++++++++++++++++++++++-------
 2 files changed, 33 insertions(+), 11 deletions(-)

diff --git a/manpages/shorewall-netmap.xml b/manpages/shorewall-netmap.xml
index 9b18bc333..18affccbb 100644
--- a/manpages/shorewall-netmap.xml
+++ b/manpages/shorewall-netmap.xml
@@ -33,7 +33,9 @@
 
     <variablelist>
       <varlistentry>
-        <term><emphasis role="bold">TYPE</emphasis></term>
+        <term><emphasis role="bold">TYPE</emphasis> — <emphasis
+        role="bold">DNAT</emphasis>|<emphasis
+        role="bold">SNAT</emphasis></term>
 
         <listitem>
           <para>Must be DNAT or SNAT.</para>
@@ -49,7 +51,8 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">NET1</emphasis></term>
+        <term><emphasis role="bold">NET1</emphasis> —
+        <emphasis>network-address</emphasis></term>
 
         <listitem>
           <para>Network in CIDR format (e.g., 192.168.1.0/24).</para>
@@ -57,7 +60,8 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">INTERFACE</emphasis></term>
+        <term><emphasis role="bold">INTERFACE</emphasis> —
+        <emphasis>interface</emphasis></term>
 
         <listitem>
           <para>The name of a network interface. The interface must be defined
@@ -66,7 +70,8 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">NET2</emphasis></term>
+        <term><emphasis role="bold">NET2</emphasis> —
+        <emphasis>network-address</emphasis></term>
 
         <listitem>
           <para>Network in CIDR format</para>
diff --git a/manpages/shorewall-policy.xml b/manpages/shorewall-policy.xml
index d71db5c17..34fecdd85 100644
--- a/manpages/shorewall-policy.xml
+++ b/manpages/shorewall-policy.xml
@@ -52,7 +52,9 @@
 
     <variablelist>
       <varlistentry>
-        <term><emphasis role="bold">SOURCE</emphasis></term>
+        <term><emphasis role="bold">SOURCE</emphasis> —
+        <emphasis>zone</emphasis>|<emphasis
+        role="bold">$FW</emphasis>|<emphasis role="bold">all</emphasis></term>
 
         <listitem>
           <para>Source zone. Must be the name of a zone defined in
@@ -61,7 +63,9 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">DEST</emphasis></term>
+        <term><emphasis role="bold">DEST</emphasis> —
+        <emphasis>zone</emphasis>|<emphasis
+        role="bold">$FW</emphasis>|<emphasis role="bold">all</emphasis></term>
 
         <listitem>
           <para>Destination zone. Must be the name of a zone defined in
@@ -70,7 +74,14 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">POLICY</emphasis></term>
+        <term><emphasis role="bold">POLICY</emphasis> — {<emphasis
+        role="bold">ACCEPT</emphasis>|<emphasis
+        role="bold">DROP</emphasis>|<emphasis
+        role="bold">REJECT</emphasis>|<emphasis
+        role="bold">CONTINUE</emphasis>|<emphasis
+        role="bold">NONE</emphasis>}[<emphasis
+        role="bold">:</emphasis>{<emphasis>default-action-or-macro</emphasis>|<emphasis
+        role="bold">None</emphasis>}]</term>
 
         <listitem>
           <para>Policy if no match from the rules file is found. Must be
@@ -155,7 +166,9 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">LOG LEVEL</emphasis> (Optional)</term>
+        <term><emphasis role="bold">LOG LEVEL</emphasis> (Optional) —
+        [<emphasis>log-level</emphasis>|<emphasis
+        role="bold">ULOG</emphasis>]</term>
 
         <listitem>
           <para>If supplied, each connection handled under the default POLICY
@@ -173,11 +186,15 @@
       </varlistentry>
 
       <varlistentry>
-        <term><emphasis role="bold">BURST:LIMIT</emphasis></term>
+        <term><emphasis role="bold">BURST:LIMIT</emphasis> —
+        <emphasis>rate</emphasis><emphasis role="bold">/</emphasis>{<emphasis
+        role="bold">second</emphasis>|<emphasis
+        role="bold">minute</emphasis>}:<emphasis>burst</emphasis></term>
 
         <listitem>
-          <para>If passed, specifies the maximum TCP connection rate and the
-          size of an acceptable burst. If not specified, TCP connections are
+          <para>If passed, specifies the maximum TCP connection
+          <emphasis>rate</emphasis> and the size of an acceptable
+          <emphasis>burst</emphasis>. If not specified, TCP connections are
           not limited.</para>
         </listitem>
       </varlistentry>