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

Update man pages for required '?' in COMMENT, SECTION and FORMAT lines

Browse Source 
Signed-off-by: Tom Eastep <teastep@shorewall.net>
This commit is contained in:
Tom Eastep 2015-08-22 08:00:38 -07:00
parent 5ead22aa48
commit a30fdb356d
20 changed files with 78 additions and 172 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Shorewall/manpages/shorewall-accounting.xml
View File

@ -81,13 +81,9 @@
<para>Section headers have the form:</para>
<para><option>[?]SECTION</option>
<para><option>?SECTION</option>
<replaceable>section-name</replaceable></para>
<para>The optional "?" was added in Shorewalll 4.6.0 and is preferred.
Existing configurations may be converted to use this form using the
<command>shorewall update</command> command.</para>
<para>When sections are enabled:</para>
<itemizedlist>
@ -357,19 +353,14 @@
</varlistentry>
<varlistentry>
<term><emphasis role="bold">[?]COMMENT</emphasis></term>
<term><emphasis role="bold">?COMMENT</emphasis></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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym
for COMMENT and is preferred.</para>
</note>
?COMMENT.</para>
</listitem>
</varlistentry>
</variablelist>

11
Shorewall/manpages/shorewall-blrules.xml
View File

@ -186,20 +186,15 @@
</varlistentry>
<varlistentry>
<term><emphasis role="bold">[?]COMMENT</emphasis></term>
<term><emphasis role="bold">?COMMENT</emphasis></term>
<listitem>
<para>The rest of the line will be attached as a comment to
the Netfilter rule(s) generated by the following entries. The
comment will appear delimited by "/* ... */" in the output of
"shorewall show &lt;chain&gt;". To stop the comment from being
attached to further rules, simply include COMMENT on a line by
itself.</para>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym
for COMMENT and is preferred.</para>
</note>
attached to further rules, simply include ?COMMENT on a line
by itself.</para>
</listitem>
</varlistentry>

19
Shorewall/manpages/shorewall-conntrack.xml
View File

@ -56,7 +56,7 @@
<replaceable>format</replaceable>.</para>
<simplelist>
<member><emphasis role="bold">[?]FORMAT</emphasis>
<member><emphasis role="bold">?FORMAT</emphasis>
<replaceable>format</replaceable></member>
</simplelist>
@ -64,21 +64,14 @@
role="bold">1</emphasis>,<emphasis role="bold">2</emphasis> or <emphasis
role="bold">3</emphasis>.</para>
<para>Format 3 was introduced in Shorewall 4.5.10. The optional '?' was
introduced in Shorewall 4.5.11 and ?FORMAT is the preferred form; the form
without the '?' is deprecated.</para>
<para>Format 3 was introduced in Shorewall 4.5.10.</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
in this file through the use of ?COMMENT lines. These lines begin with
?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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for COMMENT
and is preferred.</para>
</note>
line containing only ?COMMENT.</para>
<para>The columns in the file are as follows (where the column name is
followed by a different name in parentheses, the different name is used in

5
Shorewall/manpages/shorewall-interfaces.xml
View File

@ -54,12 +54,9 @@
<para>The format is specified by a line as follows:</para>
<blockquote>
<para><emphasis role="bold">[?]FORMAT {1|2}</emphasis></para>
<para><emphasis role="bold">?FORMAT {1|2}</emphasis></para>
</blockquote>
<para>The optional '?' was introduced in Shorewall 4.5.11 and ?FORMAT is
the preferred form; the form without the '?' is deprecated.</para>
<para>The columns in the file are as follows.</para>
<variablelist>

2
Shorewall/manpages/shorewall-mangle.xml
View File

@ -207,7 +207,7 @@
<command>shorewall show mangle</command></para>
<para>To stop the comment from being attached to further
rules, simply include COMMENT on a line by itself.</para>
rules, simply include ?COMMENT on a line by itself.</para>
</listitem>
</varlistentry>

19
Shorewall/manpages/shorewall-masq.xml
View File

@ -51,7 +51,7 @@
role="bold">+</emphasis>]<emphasis>interfacelist</emphasis>[<emphasis
role="bold">:</emphasis>[<emphasis>digit</emphasis>]][<emphasis
role="bold">:</emphasis>[<emphasis>dest-address</emphasis>[<emphasis
role="bold">,</emphasis><emphasis>dest-address</emphasis>]...[<emphasis>exclusion</emphasis>]]|[?]COMMENT}</term>
role="bold">,</emphasis><emphasis>dest-address</emphasis>]...[<emphasis>exclusion</emphasis>]]|?COMMENT}</term>
<listitem>
<para>Outgoing <emphasis>interfacelist</emphasis>. This may be a
@ -113,17 +113,12 @@
url="/manpages/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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for
COMMENT and is preferred.</para>
</note>
entries in this file through the use of ?COMMENT lines. These lines
begin with ?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 containing only
?COMMENT.</para>
<para>Beginning with Shorewall 4.6.0, a new syntax is also accepted.
With the exception of the leading '+', the interfacelist and

11
Shorewall/manpages/shorewall-nat.xml
View File

@ -44,25 +44,20 @@
<variablelist>
<varlistentry>
<term><emphasis role="bold">EXTERNAL</emphasis> -
{<emphasis>address</emphasis>|[?]COMMENT}</term>
{<emphasis>address</emphasis>|?COMMENT}</term>
<listitem>
<para>External IP Address - this should NOT be the primary IP
address of the interface named in the next column and must not be a
DNS Name.</para>
<para>If you put COMMENT in this column, the rest of the line will
<para>If you put ?COMMENT in this column, the rest of the line will
be attached as a comment to the Netfilter rule(s) generated by the
following entries in the file. The comment will appear delimited by
"/* ... */" in the output of "shorewall show nat"</para>
<para>To stop the comment from being attached to further rules,
simply include COMMENT on a line by itself.</para>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for
COMMENT and is preferred.</para>
</note>
simply include ?COMMENT on a line by itself.</para>
</listitem>
</varlistentry>

21
Shorewall/manpages/shorewall-rules.xml
View File

@ -42,12 +42,8 @@
</warning>
<para>The rules file is divided into sections. Each section is introduced
by a "Section Header" which is a line beginning with [?]SECTION and
followed by the section name.</para>
<para>The optional "?" was added in Shorewalll 4.6.0 and is preferred.
Existing configurations may be converted to use this form using the
<command>shorewall update</command> command.</para>
by a "Section Header" which is a line beginning with ?SECTION and followed
by the section name.</para>
<para>Sections are as follows and must appear in the order listed:</para>
@ -142,7 +138,7 @@
role="bold">ESTABLISHED</emphasis> and <emphasis
role="bold">RELATED</emphasis> sections and place all of your
non-blacklisting rules in the NEW section (That's after the line that
reads SECTION NEW').</para>
reads ?SECTION NEW').</para>
</note>
<warning>
@ -305,20 +301,15 @@
</varlistentry>
<varlistentry>
<term><emphasis role="bold">[?]COMMENT</emphasis></term>
<term><emphasis role="bold">?COMMENT</emphasis></term>
<listitem>
<para>the rest of the line will be attached as a comment to
the Netfilter rule(s) generated by the following entries. The
comment will appear delimited by "/* ... */" in the output of
"shorewall show &lt;chain&gt;". To stop the comment from being
attached to further rules, simply include COMMENT on a line by
itself.</para>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym
for COMMENT and is preferred.</para>
</note>
attached to further rules, simply include ?COMMENT on a line
by itself.</para>
</listitem>
</varlistentry>

13
Shorewall/manpages/shorewall-secmarks.xml
View File

@ -43,7 +43,7 @@
<variablelist>
<varlistentry>
<term><emphasis role="bold">SECMARK -
{SAVE|RESTORE|<replaceable>context</replaceable>|COMMENT
{SAVE|RESTORE|<replaceable>context</replaceable>|?COMMENT
<replaceable>comment</replaceable>}</emphasis></term>
<listitem>
@ -78,19 +78,14 @@
</varlistentry>
<varlistentry>
<term>[?]COMMENT</term>
<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
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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym
for COMMENT and is preferred.</para>
</note>
?COMMENT.</para>
</listitem>
</varlistentry>
</variablelist>

14
Shorewall/manpages/shorewall-tunnels.xml
View File

@ -43,7 +43,7 @@
role="bold">ipip</emphasis>|<emphasis
role="bold">gre</emphasis>|l2tp|<emphasis
role="bold">pptpclient</emphasis>|<emphasis
role="bold">pptpserver</emphasis>|[?]COMMENT|{<emphasis
role="bold">pptpserver</emphasis>|?COMMENT|{<emphasis
role="bold">openvpn</emphasis>|<emphasis
role="bold">openvpnclient</emphasis>|<emphasis
role="bold">openvpnserver</emphasis>}[:{<emphasis
@ -107,12 +107,12 @@
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>
entries in this file through the use of /COMMENT lines. These lines
begin with ?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 containing only
?COMMENT.</para>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for

11
Shorewall6/manpages/shorewall6-accounting.xml
View File

@ -299,19 +299,14 @@
</varlistentry>
<varlistentry>
<term><emphasis role="bold">[?]COMMENT</emphasis></term>
<term><emphasis role="bold">?COMMENT</emphasis></term>
<listitem>
<para>The remainder of the line is treated as a comment which
is attached to subsequent rules until another COMMENT line is
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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym
for COMMENT and is preferred.</para>
</note>
?COMMENT.</para>
</listitem>
</varlistentry>
</variablelist>

9
Shorewall6/manpages/shorewall6-blrules.xml
View File

@ -187,20 +187,15 @@
</varlistentry>
<varlistentry>
<term><emphasis role="bold">[?]COMMENT</emphasis></term>
<term><emphasis role="bold">?COMMENT</emphasis></term>
<listitem>
<para>the rest of the line will be attached as a comment to
the Netfilter rule(s) generated by the following entries. The
comment will appear delimited by "/* ... */" in the output of
"shorewall6 show &lt;chain&gt;". To stop the comment from
being attached to further rules, simply include COMMENT on a
being attached to further rules, simply include ?COMMENT on a
line by itself.</para>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym
for COMMENT and is preferred.</para>
</note>
</listitem>
</varlistentry>

19
Shorewall6/manpages/shorewall6-conntrack.xml
View File

@ -56,7 +56,7 @@
<replaceable>format</replaceable>.</para>
<simplelist>
<member><emphasis role="bold">[?]FORMAT</emphasis>
<member><emphasis role="bold">?FORMAT</emphasis>
<replaceable>format</replaceable></member>
</simplelist>
@ -64,21 +64,14 @@
role="bold">1</emphasis>,<emphasis role="bold">2</emphasis> or <emphasis
role="bold">3</emphasis>.</para>
<para>Format 3 was introduced in Shorewall 4.5.10. The optional '?' was
introduced in Shorewall 4.5.11 and ?FORMAT is the preferred form; the form
without the '?' is deprecated.</para>
<para>Format 3 was introduced in Shorewall 4.5.10.</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
in this file through the use of ?COMMENT lines. These lines begin with
?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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for COMMENT
and is preferred.</para>
</note>
line with only ?COMMENT.</para>
<para>The columns in the file are as follows (where the column name is
followed by a different name in parentheses, the different name is used in

5
Shorewall6/manpages/shorewall6-interfaces.xml
View File

@ -54,12 +54,9 @@
<para>The format is specified by a line as follows:</para>
<blockquote>
<para><emphasis role="bold">[?]FORMAT {1|2}</emphasis></para>
<para><emphasis role="bold">?FORMAT {1|2}</emphasis></para>
</blockquote>
<para>The optional '?' was introduced in Shorewall 4.5.11 and ?FORMAT is
the preferred form; the form without the '?' is deprecated.</para>
<para>The columns in the file are as follows.</para>
<variablelist>

2
Shorewall6/manpages/shorewall6-mangle.xml
View File

@ -208,7 +208,7 @@
<command>shorewall show mangle</command></para>
<para>To stop the comment from being attached to further
rules, simply include COMMENT on a line by itself.</para>
rules, simply include ?COMMENT on a line by itself.</para>
</listitem>
</varlistentry>

19
Shorewall6/manpages/shorewall6-masq.xml
View File

@ -50,7 +50,7 @@
<term><emphasis role="bold">INTERFACE:DEST</emphasis> - {[<emphasis
role="bold">+</emphasis>]<emphasis>interfacelist</emphasis>|[<emphasis
role="bold">:</emphasis>[<emphasis>dest-address</emphasis>[<emphasis
role="bold">,</emphasis><emphasis>dest-address</emphasis>]...[<emphasis>exclusion</emphasis>]]|[?]COMMENT}</term>
role="bold">,</emphasis><emphasis>dest-address</emphasis>]...[<emphasis>exclusion</emphasis>]]|?COMMENT}</term>
<listitem>
<para>Outgoing <emphasis>interfacelist</emphasis>. This may be a
@ -86,17 +86,12 @@
as are ipset names preceded by a plus sign '+'.</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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for
COMMENT and is preferred.</para>
</note>
entries in this file through the use of ?COMMENT lines. These lines
begin with ?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 containing only
?COMMENT.</para>
<para>Beginning with Shorewall 4.6.0, a new syntax is also accepted.
With the exception of the leading '+', the interfacelist and

14
Shorewall6/manpages/shorewall6-nat.xml
View File

@ -31,8 +31,7 @@
<warning>
<para>If all you want to do is simple port forwarding, do NOT use this
file. See <ulink
url="/FAQ.htm#faq1">http://www.shorewall.net/FAQ.htm#faq1</ulink>.
</para>
url="/FAQ.htm#faq1">http://www.shorewall.net/FAQ.htm#faq1</ulink>.</para>
</warning>
<para>The columns in the file are as follows (where the column name is
@ -42,25 +41,20 @@
<variablelist>
<varlistentry>
<term><emphasis role="bold">EXTERNAL</emphasis> -
{<emphasis>address</emphasis>|[?]COMMENT}</term>
{<emphasis>address</emphasis>|?COMMENT}</term>
<listitem>
<para>External IP Address - this should NOT be the primary IP
address of the interface named in the next column and must not be a
DNS Name.</para>
<para>If you put COMMENT in this column, the rest of the line will
<para>If you put ?COMMENT in this column, the rest of the line will
be attached as a comment to the Netfilter rule(s) generated by the
following entries in the file. The comment will appear delimited by
"/* ... */" in the output of "shorewall show nat"</para>
<para>To stop the comment from being attached to further rules,
simply include COMMENT on a line by itself.</para>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for
COMMENT and is preferred.</para>
</note>
simply include ?COMMENT on a line by itself.</para>
</listitem>
</varlistentry>

10
Shorewall6/manpages/shorewall6-rules.xml
View File

@ -35,12 +35,8 @@
request. All rules are terminating except LOG and QUEUE rules.</para>
<para>The rules file is divided into sections. Each section is introduced
by a "Section Header" which is a line beginning with [?]SECTION and
followed by the section name.</para>
<para>The optional "?" was added in Shorewalll 4.6.0 and is preferred.
Existing configurations may be converted to use this form using the
<command>shorewall6 update</command> command.</para>
by a "Section Header" which is a line beginning with ?SECTION and followed
by the section name.</para>
<para>Sections are as follows and must appear in the order listed:</para>
@ -134,7 +130,7 @@
states, then it is suggested that you omit the <emphasis
role="bold">ESTABLISHED</emphasis> and <emphasis
role="bold">RELATED</emphasis> sections and place all of your rules in
the NEW section (That's after the line that reads SECTION NEW').</para>
the NEW section (That's after the line that reads ?SECTION NEW').</para>
</note>
<warning>

14
Shorewall6/manpages/shorewall6-secmarks.xml
View File

@ -43,8 +43,7 @@
<variablelist>
<varlistentry>
<term><emphasis role="bold">SECMARK -
{SAVE|RESTORE|<replaceable>context</replaceable>|[?]COMMENT
<replaceable>comment</replaceable>}</emphasis></term>
{SAVE|RESTORE|<replaceable>context</replaceable>|?COMMENT}</emphasis></term>
<listitem>
<variablelist>
@ -78,19 +77,14 @@
</varlistentry>
<varlistentry>
<term>[?]COMMENT</term>
<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
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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym
for COMMENT and is preferred.</para>
</note>
?COMMENT.</para>
</listitem>
</varlistentry>
</variablelist>

17
Shorewall6/manpages/shorewall6-tunnels.xml
View File

@ -44,7 +44,7 @@
role="bold">ipsecnat</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
@ -102,17 +102,12 @@
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
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>
<note>
<para>Beginning with Shorewall 4.5.11, ?COMMENT is a synonym for
COMMENT and is preferred.</para>
</note>
?COMMENT.</para>
</listitem>
</varlistentry>