From c030bc900c046d0038c26f6293f7a0fa535aedec Mon Sep 17 00:00:00 2001
From: Tom Eastep <teastep@shorewall.net>
Date: Fri, 19 Feb 2010 08:12:56 -0800
Subject: [PATCH] List variable names to be avoided in manpages and config file
 basics doc.

Signed-off-by: Tom Eastep <teastep@shorewall.net>
---
 docs/configuration_file_basics.xml | 39 +++++++++++++++++++++++++++---
 manpages/shorewall-params.xml      | 37 +++++++++++++++++++++++++++-
 manpages6/shorewall6-params.xml    | 33 +++++++++++++++++++++++++
 3 files changed, 105 insertions(+), 4 deletions(-)

diff --git a/docs/configuration_file_basics.xml b/docs/configuration_file_basics.xml
index 06b97e124..f560d252c 100644
--- a/docs/configuration_file_basics.xml
+++ b/docs/configuration_file_basics.xml
@@ -5,7 +5,7 @@
   <!--$Id$-->
 
   <articleinfo>
-    <title>Configuration Files Tips and Tricks</title>
+    <title>Configuration Files Tips and Hints</title>
 
     <authorgroup>
       <author>
@@ -611,6 +611,39 @@ SHELL cat /etc/shorewall/rules.d/*.rules</programlisting></para>
     to distinguish them from variables used internally within the Shorewall
     programs</para>
 
+    <para>The following variable names must be avoided:</para>
+
+    <simplelist>
+      <member>Any option from <ulink
+      url="shorewall.conf.html">shorewall.conf</ulink> (5)</member>
+
+      <member>DEBUG</member>
+
+      <member>EXPORT</member>
+
+      <member>FAST</member>
+
+      <member>IPT_OPTIONS</member>
+
+      <member>NOROUTES</member>
+
+      <member>PROFILE</member>
+
+      <member>PURGE</member>
+
+      <member>RESTOREPATH</member>
+
+      <member>SHOREWALL_DIR</member>
+
+      <member>TEST</member>
+
+      <member>USE_VERBOSITY</member>
+
+      <member>VERBOSE</member>
+
+      <member>VERBOSE_OFFSET</member>
+    </simplelist>
+
     <para>Example:</para>
 
     <blockquote>
@@ -1194,7 +1227,7 @@ DNAT       net        loc:192.168.1.3 tcp       4000:4100</programlisting>
     <firstterm>burst</firstterm> value are given.</para>
 
     <para>Example from <ulink
-    url="manpages/shorewall.conf.html">shorewall.conf</ulink> (5): </para>
+    url="manpages/shorewall.conf.html">shorewall.conf</ulink> (5):</para>
 
     <simplelist>
       <member>LOGRATE=10/minute</member>
@@ -1202,7 +1235,7 @@ DNAT       net        loc:192.168.1.3 tcp       4000:4100</programlisting>
       <member>LOGBURST=5</member>
     </simplelist>
 
-    <para> For each logging rule, the first time the rule is reached, the
+    <para>For each logging rule, the first time the rule is reached, the
     packet will be logged; in fact, since the burst is 5, the first five
     packets will be logged. After this, it will be 6 seconds (1 minute divided
     by the rate of 10) before a message will be logged from the rule,
diff --git a/manpages/shorewall-params.xml b/manpages/shorewall-params.xml
index 6e0cd8798..acb3e20a9 100644
--- a/manpages/shorewall-params.xml
+++ b/manpages/shorewall-params.xml
@@ -1,4 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
 <refentry>
   <refmeta>
     <refentrytitle>shorewall-params</refentrytitle>
@@ -27,6 +29,39 @@
     to distinguish them from variables used internally within the Shorewall
     programs</para>
 
+    <para>The following variable names must be avoided:</para>
+
+    <simplelist>
+      <member>Any option from <ulink
+      url="shorewall.conf.html">shorewall.conf</ulink> (5)</member>
+
+      <member>DEBUG</member>
+
+      <member>EXPORT</member>
+
+      <member>FAST</member>
+
+      <member>IPT_OPTIONS</member>
+
+      <member>NOROUTES</member>
+
+      <member>PROFILE</member>
+
+      <member>PURGE</member>
+
+      <member>RESTOREPATH</member>
+
+      <member>SHOREWALL_DIR</member>
+
+      <member>TEST</member>
+
+      <member>USE_VERBOSITY</member>
+
+      <member>VERBOSE</member>
+
+      <member>VERBOSE_OFFSET</member>
+    </simplelist>
+
     <para>Example params file:</para>
 
     <programlisting>NET_IF=eth0
@@ -67,4 +102,4 @@ net     eth0            130.252.100.255 routefilter,norfc1918</programlisting>
     shorewall-tcclasses(5), shorewall-tcdevices(5), shorewall-tcrules(5),
     shorewall-tos(5), shorewall-tunnels(5), shorewall-zones(5)</para>
   </refsect1>
-</refentry>
\ No newline at end of file
+</refentry>
diff --git a/manpages6/shorewall6-params.xml b/manpages6/shorewall6-params.xml
index e3e5bc715..4feca348c 100644
--- a/manpages6/shorewall6-params.xml
+++ b/manpages6/shorewall6-params.xml
@@ -29,6 +29,39 @@
     to distinguish them from variables used internally within the Shorewall
     programs</para>
 
+    <para>The following variable names must be avoided:</para>
+
+    <simplelist>
+      <member>Any option from <ulink
+      url="shorewall6.conf.html">shorewall6.conf</ulink> (5)</member>
+
+      <member>DEBUG</member>
+
+      <member>EXPORT</member>
+
+      <member>FAST</member>
+
+      <member>IPT_OPTIONS</member>
+
+      <member>NOROUTES</member>
+
+      <member>PROFILE</member>
+
+      <member>PURGE</member>
+
+      <member>RESTOREPATH</member>
+
+      <member>SHOREWALL_DIR</member>
+
+      <member>TEST</member>
+
+      <member>USE_VERBOSITY</member>
+
+      <member>VERBOSE</member>
+
+      <member>VERBOSE_OFFSET</member>
+    </simplelist>
+
     <para>Example params file:</para>
 
     <programlisting>NET_IF=eth0