extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2024-11-22 07:33:43 +01:00
Code Issues Packages Projects Releases Wiki Activity

List variable names to be avoided in manpages and config file basics doc.

Browse Source 
Signed-off-by: Tom Eastep <teastep@shorewall.net>
This commit is contained in:
Tom Eastep 2010-02-19 08:12:56 -08:00
parent ceff8adc78
commit c030bc900c
3 changed files with 105 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/configuration_file_basics.xml
View File

@ -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,

35
manpages/shorewall-params.xml
View File

@ -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

33
manpages6/shorewall6-params.xml
View File

@ -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