extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2025-02-23 21:21:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update manpages with COMMENT documented.

Browse Source 
Signed-off-by: Tom Eastep <teastep@shorewall.net>

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@9718 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
This commit is contained in:
teastep 2009-03-20 16:47:27 +00:00
parent 7cf6243d29
commit 92e6f2d001
8 changed files with 78 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/Accounting.xml
View File

@ -45,15 +45,16 @@
<title>Accounting Basics</title>
<para>Shorewall accounting rules are described in the file
<filename>/etc/shorewall/accounting</filename>. By default, the accounting
rules are placed in a chain called <quote>accounting</quote> and can thus
be displayed using <quote>shorewall[-lite] show accounting</quote>. All
traffic passing into, out of, or through the firewall traverses the
accounting chain including traffic that will later be rejected by
interface options such as <quote>tcpflags</quote> and
<quote>maclist</quote>. If your kernel doesn't support the connection
tracking match extension (Kernel 2.4.21) then some traffic rejected under
<quote>norfc1918</quote> will not traverse the accounting chain.</para>
<filename><filename>/etc/shorewall/accounting</filename></filename>. By
default, the accounting rules are placed in a chain called
<quote>accounting</quote> and can thus be displayed using
<quote>shorewall[-lite] show -x accounting</quote>. All traffic passing
into, out of, or through the firewall traverses the accounting chain
including traffic that will later be rejected by interface options such as
<quote>tcpflags</quote> and <quote>maclist</quote>. If your kernel doesn't
support the connection tracking match extension (Kernel 2.4.21) then some
traffic rejected under <quote>norfc1918</quote> will not traverse the
accounting chain.</para>
<para>The columns in the accounting file are as follows:</para>

2
docs/configuration_file_basics.xml
View File

@ -286,7 +286,7 @@ ACCEPT net $FW tcp www #This is an end-of-line comment</progra
</listitem>
<listitem>
<para><filename>/etc/shorewall/raw</filename></para>
<para><filename>/etc/shorewall/notrack</filename></para>
</listitem>
<listitem>

12
manpages/shorewall-accounting.xml
View File

@ -75,6 +75,18 @@
<emphasis>chain</emphasis></para>
</listitem>
</varlistentry>
<varlistentry>
<term>COMMENT</term>
<listitem>
<para>The remainder of the line is treated as a comment which
is attached to subsequent rules until another COMMENT line is
found or until the end of the file is reached. To stop adding
comments to rules, use a line with only the word
COMMENT.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

12
manpages/shorewall-masq.xml
View File

@ -43,11 +43,11 @@
<variablelist>
<varlistentry>
<term><emphasis role="bold">INTERFACE</emphasis> - [<emphasis
<term><emphasis role="bold">INTERFACE</emphasis> - {[<emphasis
role="bold">+</emphasis>]<emphasis>interfacelist</emphasis>[<emphasis
role="bold">:</emphasis>[<emphasis>digit</emphasis>]][<emphasis
role="bold">:</emphasis>[<emphasis>address</emphasis>[<emphasis
role="bold">,</emphasis><emphasis>address</emphasis>]...[<emphasis>exclusion</emphasis>]]</term>
role="bold">,</emphasis><emphasis>address</emphasis>]...[<emphasis>exclusion</emphasis>]]|COMMENT}</term>
<listitem>
<para>Outgoing <emphasis>interfacelist</emphasis>. Prior to
@ -99,6 +99,14 @@
<para>This feature should only be required if you need to insert
rules in this file that preempt entries in <ulink
url="shorewall-nat.html">shorewall-nat</ulink>(5).</para>
<para>Comments may be attached to Netfilter rules generated from
entries in this file through the use of COMMENT lines. These lines
begin with the word COMMENT; the remainder of the line is treated as
a comment which is attached to subsequent rules until another
COMMENT line is found or until the end of the file is reached. To
stop adding comments to rules, use a line with only the word
COMMENT.</para>
</listitem>
</varlistentry>

14
manpages/shorewall-nat.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-nat</refentrytitle>
@ -38,7 +40,7 @@
<variablelist>
<varlistentry>
<term><emphasis role="bold">EXTERNAL</emphasis> -
<emphasis>address</emphasis></term>
{<emphasis>address</emphasis>|COMMENT}</term>
<listitem>
<para>External IP Address - this should NOT be the primary IP
@ -52,6 +54,14 @@
<para>To stop the comment from being attached to further rules,
simply include COMMENT on a line by itself.</para>
<para>Comments may be attached to Netfilter rules generated from
entries in this file through the use of COMMENT lines. These lines
begin with the word COMMENT; the remainder of the line is treated as
a comment which is attached to subsequent rules until another
COMMENT line is found or until the end of the file is reached. To
stop adding comments to rules, use a line with only the word
COMMENT.</para>
</listitem>
</varlistentry>
@ -151,4 +161,4 @@
shorewall-tcclasses(5), shorewall-tcdevices(5), shorewall-tcrules(5),
shorewall-tos(5), shorewall-tunnels(5), shorewall-zones(5)</para>
</refsect1>
</refentry>
</refentry>

10
manpages/shorewall-notrack.xml
View File

@ -35,7 +35,7 @@
<variablelist>
<varlistentry>
<term>SOURCE ‒
<emphasis>zone</emphasis>[:<emphasis>interface</emphasis>][:<emphasis>address-list</emphasis>]</term>
{<emphasis>zone</emphasis>[:<emphasis>interface</emphasis>][:<emphasis>address-list</emphasis>]|COMMENT}</term>
<listitem>
<para>where <replaceable>zone</replaceable> is the name of a zone,
@ -44,6 +44,14 @@
list of addresses (may contain exclusion - see <ulink
url="shorewall-exclusion.html">shorewall-exclusion</ulink>
(5)).</para>
<para>Comments may be attached to Netfilter rules generated from
entries in this file through the use of COMMENT lines. These lines
begin with the word COMMENT; the remainder of the line is treated as
a comment which is attached to subsequent rules until another
COMMENT line is found or until the end of the file is reached. To
stop adding comments to rules, use a line with only the word
COMMENT.</para>
</listitem>
</varlistentry>

14
manpages/shorewall-tunnels.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-tunnels</refentrytitle>
@ -39,7 +41,7 @@
role="bold">ipip</emphasis>|<emphasis
role="bold">gre</emphasis>|l2tp|<emphasis
role="bold">pptpclient</emphasis>|<emphasis
role="bold">pptpserver</emphasis>|{<emphasis
role="bold">pptpserver</emphasis>|COMMENT|{<emphasis
role="bold">openvpn</emphasis>|<emphasis
role="bold">openvpnclient</emphasis>|<emphasis
role="bold">openvpnserver</emphasis>}[:{<emphasis
@ -97,6 +99,14 @@
role="bold">tcp</emphasis> or <emphasis role="bold">udp</emphasis>
(6 or 17), then it may optionally be followed by ":" and a port
number.</para>
<para>Comments may be attached to Netfilter rules generated from
entries in this file through the use of COMMENT lines. These lines
begin with the word COMMENT; the remainder of the line is treated as
a comment which is attached to subsequent rules until another
COMMENT line is found or until the end of the file is reached. To
stop adding comments to rules, use a line with only the word
COMMENT.</para>
</listitem>
</varlistentry>
@ -272,4 +282,4 @@
shorewall.conf(5), shorewall-tcclasses(5), shorewall-tcdevices(5),
shorewall-tcrules(5), shorewall-tos(5), shorewall-zones(5)</para>
</refsect1>
</refentry>
</refentry>

12
manpages6/shorewall6-accounting.xml
View File

@ -75,6 +75,18 @@
<emphasis>chain</emphasis></para>
</listitem>
</varlistentry>
<varlistentry>
<term>COMMENT</term>
<listitem>
<para>The remainder of the line is treated as a comment which
is attached to subsequent rules until another COMMENT line is
found or until the end of the file is reached. To stop adding
comments to rules, use a line with only the word
COMMENT.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>