Hi, I corrected some errors in the manpages. I started with "shorewall".
Tom, please tell me if you like this format and the patches at all. If you like them, I can send you a similar patch set for shorewall6, too. -Thomas
From 2aaeaa4f2da7aae92177ced0530f1deff86f44a9 Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:45:29 +0100 Subject: [PATCH 11/14] The "-i" option from the "reload" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 6ced1f6..9dc34ef 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1351,8 +1351,8 @@ and causes a Perl stack trace to be included with each compiler-generated error and warning message.</para> - <para>The -i option was added in Shorewall 4.6.0 and causes a - warning message to be issued if the line current line contains + <para>The <option>-i</option> option was added in Shorewall 4.6.0 + and causes a warning message to be issued if the line current line contains alternative input specifications following a semicolon (";"). Such lines will be handled incorrectly if INLINE_MATCHES is set to Yes in <ulink -- 2.1.3
From 8000e920dada9f1030462ed363115c756b65584b Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:48:34 +0100 Subject: [PATCH 12/14] The "-i" option from the "restart" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 9dc34ef..fb61b05 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1406,8 +1406,8 @@ and causes a Perl stack trace to be included with each compiler-generated error and warning message.</para> - <para>The -i option was added in Shorewall 4.6.0 and causes a - warning message to be issued if the line current line contains + <para>The <option>-i</option> option was added in Shorewall 4.6.0 + and causes a warning message to be issued if the line current line contains alternative input specifications following a semicolon (";"). Such lines will be handled incorrectly if INLINE_MATCHES is set to Yes in <ulink -- 2.1.3
From 614224745d851c6793b860ba55a95746c6cfe6f2 Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:51:16 +0100 Subject: [PATCH 13/14] Additional small corrections for restart command's options. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index fb61b05..fe82c4b 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1387,7 +1387,7 @@ table to be flushed; the <command>conntrack</command> utility must be installed to use this option.</para> - <para>The <option>-d </option>option causes the compiler to run + <para>The <option>-d</option> option causes the compiler to run under the Perl debugger.</para> <para>The <option>-f</option> option suppresses the compilation step @@ -1399,7 +1399,7 @@ and performs the compilation step unconditionally, overriding the AUTOMAKE setting in <ulink url="/manpages/shorewall.conf.html">shorewall.conf</ulink>(5). When - both <option>-f</option> and <option>-c</option>are present, the + both <option>-f</option> and <option>-c</option> are present, the result is determined by the option that appears last.</para> <para>The <option>-T</option> option was added in Shorewall 4.5.3 -- 2.1.3
From 8b742422b7493420601ef13f8847f89cad077e1b Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 16:03:50 +0100 Subject: [PATCH 14/14] Some punctuation space problems corrected. --- Shorewall/manpages/shorewall.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index fe82c4b..3c21914 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1574,7 +1574,7 @@ <listitem> <para>Added in Shorewall 4.6.2. Displays the dynamic chain along with any chains produced by entries in - shorewall-blrules(5).The <emphasis role="bold">-x</emphasis> + shorewall-blrules(5). The <emphasis role="bold">-x</emphasis> option is passed directly through to iptables and causes actual packet and byte counts to be displayed. Without this option, those counts are abbreviated.</para> @@ -1740,7 +1740,7 @@ <listitem> <para>Displays the Netfilter nat table using the command - <emphasis role="bold">iptables -t nat -L -n -v</emphasis>.The + <emphasis role="bold">iptables -t nat -L -n -v</emphasis>. The <emphasis role="bold">-x</emphasis> option is passed directly through to iptables and causes actual packet and byte counts to be displayed. Without this option, those counts are @@ -1773,7 +1773,7 @@ <listitem> <para>Displays the Netfilter raw table using the command - <emphasis role="bold">iptables -t raw -L -n -v</emphasis>.The + <emphasis role="bold">iptables -t raw -L -n -v</emphasis>. The <emphasis role="bold">-x</emphasis> option is passed directly through to iptables and causes actual packet and byte counts to be displayed. Without this option, those counts are -- 2.1.3
From e91ebaf924443952773423e4608b438b2cfc433e Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:08:51 +0100 Subject: [PATCH 01/14] "nolock" option wasn't marked as option. --- Shorewall/manpages/shorewall.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 73e3593..4d8a267 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -774,7 +774,7 @@ used for debugging. See <ulink url="/starting_and_stopping_shorewall.htm#Trace">http://www.shorewall.net/starting_and_stopping_shorewall.htm#Trace</ulink>.</para> - <para>The nolock <option>option</option> prevents the command from + <para>The <option>nolock</option> option prevents the command from attempting to acquire the Shorewall lockfile. It is useful if you need to include <command>shorewall</command> commands in <filename>/etc/shorewall/started</filename>.</para> -- 2.1.3
From 06ce86bb7c083d9169f3e50bb5b565eea7881f49 Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:17:45 +0100 Subject: [PATCH 02/14] The "-i" option from the "check" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 4d8a267..f6a4a52 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -877,10 +877,11 @@ and causes a Perl stack trace to be included with each compiler-generated error and warning message.</para> - <para>The -i option was added in Shorewall 4.6.0 and causes a - warning message to be issued if the line current line contains - alternative input specifications following a semicolon (";"). Such - lines will be handled incorrectly if INLINE_MATCHES is set to Yes in + <para>The <option>-i</option> option was added in Shorewall 4.6.0 + and causes a warning message to be issued if the line current line + contains alternative input specifications following a semicolon + (";"). Such lines will be handled incorrectly if INLINE_MATCHES is + set to Yes in <ulink url="/manpages/shorewall.conf.html">shorewall.conf</ulink>(5).</para> </listitem> -- 2.1.3
From c89570afee5a0f09285a7ffd834e6842111f5ae2 Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:23:10 +0100 Subject: [PATCH 03/14] The "-e" option from the "compile" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index f6a4a52..da32dd3 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -921,11 +921,11 @@ compile -- -</command>) to suppress the 'Compiling...' message normally generated by <filename>/sbin/shorewall</filename>.</para> - <para>When -e is specified, the compilation is being performed on a - system other than where the compiled script will run. This option - disables certain configuration options that require the script to be - compiled where it is to be run. The use of -e requires the presence - of a configuration file named <filename>capabilities</filename> + <para>When <option>-e</option> is specified, the compilation is being + performed on a system other than where the compiled script will run. + This option disables certain configuration options that require the + script to be compiled where it is to be run. The use of <option>-e</option> + requires the presence of a configuration file named <filename>capabilities</filename> which may be produced using the command <emphasis role="bold">shorewall-lite show -f capabilities > capabilities</emphasis> on a system with Shorewall Lite -- 2.1.3
From 02bc5975c0b808315c9302a46c190d3aa4dd1bd0 Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:24:36 +0100 Subject: [PATCH 04/14] The compile command wasn't marked as command like all the other commands. --- Shorewall/manpages/shorewall.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index da32dd3..046e1c8 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -926,9 +926,8 @@ This option disables certain configuration options that require the script to be compiled where it is to be run. The use of <option>-e</option> requires the presence of a configuration file named <filename>capabilities</filename> - which may be produced using the command <emphasis - role="bold">shorewall-lite show -f capabilities > - capabilities</emphasis> on a system with Shorewall Lite + which may be produced using the command <command>shorewall-lite show -f + capabilities > capabilities</command> on a system with Shorewall Lite installed</para> <para>The <emphasis role="bold">-c</emphasis> option was added in -- 2.1.3
From a9e1090112ba8de53de1ebb65b80b8e0c6477edc Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:27:51 +0100 Subject: [PATCH 05/14] The "-c" option from the "compile" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 046e1c8..a470a94 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -930,8 +930,8 @@ capabilities > capabilities</command> on a system with Shorewall Lite installed</para> - <para>The <emphasis role="bold">-c</emphasis> option was added in - Shorewall 4.5.17 and causes conditional compilation of a script. The + <para>The <option>-c</option> option was added in Shorewall 4.5.17 + and causes conditional compilation of a script. The script specified by <replaceable>pathname</replaceable> (or implied if <emphasis role="bold">pathname</emphasis> is omitted) is compiled if it doesn't exist or if there is any file in the -- 2.1.3
From 4b8d15189b4fe1d7a22caeeccc61160c91f361bf Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:29:09 +0100 Subject: [PATCH 06/14] The "-i" option from the "compile" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index a470a94..ef79dae 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -951,8 +951,8 @@ and causes a Perl stack trace to be included with each compiler-generated error and warning message.</para> - <para>The -i option was added in Shorewall 4.6.0 and causes a - warning message to be issued if the line current line contains + <para>The <option>-i</option> option was added in Shorewall 4.6.0 and + causes a warning message to be issued if the line current line contains alternative input specifications following a semicolon (";"). Such lines will be handled incorrectly if INLINE_MATCHES is set to Yes in <ulink -- 2.1.3
From 8e1a77e7bbae25d91c6782663762dff3a7c310ec Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:33:05 +0100 Subject: [PATCH 07/14] The "-m" option from the "dump" command should be listed without the "-x" option. --- Shorewall/manpages/shorewall.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index ef79dae..4c3113a 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1021,9 +1021,10 @@ <para>The <emphasis role="bold">-x</emphasis> option causes actual packet and byte counts to be displayed. Without that option, these - counts are abbreviated. The <emphasis role="bold">-m</emphasis> - option causes any MAC addresses included in Shorewall log messages - to be displayed.</para> + counts are abbreviated.</para> + + <para>The <emphasis role="bold">-m</emphasis> option causes any MAC + addresses included in Shorewall log messages to be displayed.</para> <para>The <emphasis role="bold">-l</emphasis> option causes the rule number for each Netfilter rule to be displayed.</para> -- 2.1.3
From 8670997231ee99e3da528be369027abb176900cf Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:39:13 +0100 Subject: [PATCH 08/14] The "-i" option from the "load" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 4c3113a..0fbf560 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1189,8 +1189,8 @@ and causes a Perl stack trace to be included with each compiler-generated error and warning message.</para> - <para>The -i option was added in Shorewall 4.6.0 and causes a - warning message to be issued if the line current line contains + <para>The <option>-i</option> option was added in Shorewall 4.6.0 and + causes a warning message to be issued if the line current line contains alternative input specifications following a semicolon (";"). Such lines will be handled incorrectly if INLINE_MATCHES is set to Yes in <ulink -- 2.1.3
From 878e678792bc2362fa99adf7fb78b43b2899ebb2 Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:41:31 +0100 Subject: [PATCH 09/14] The "-i" option from the "refresh" command wasn't marked as an option. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 0fbf560..2e2971b 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1282,8 +1282,8 @@ and causes a Perl stack trace to be included with each compiler-generated error and warning message.</para> - <para>The -i option was added in Shorewall 4.6.0 and causes a - warning message to be issued if the line current line contains + <para>The <option>-i</option> option was added in Shorewall 4.6.0 + and causes a warning message to be issued if the line current line contains alternative input specifications following a semicolon (";"). Such lines will be handled incorrectly if INLINE_MATCHES is set to Yes in <ulink -- 2.1.3
From e22105d221ca15a2d42e905a5989d621a907ba9e Mon Sep 17 00:00:00 2001 From: Thomas D <[email protected]> Date: Sun, 9 Nov 2014 15:42:57 +0100 Subject: [PATCH 10/14] Additional small corrections for refresh command's options. --- Shorewall/manpages/shorewall.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Shorewall/manpages/shorewall.xml b/Shorewall/manpages/shorewall.xml index 2e2971b..6ced1f6 100644 --- a/Shorewall/manpages/shorewall.xml +++ b/Shorewall/manpages/shorewall.xml @@ -1275,7 +1275,7 @@ <para>The <option>-n</option> option was added in Shorewall 4.5.3 causes Shorewall to avoid updating the routing table(s).</para> - <para>The <option>-d </option>option was added in Shorewall 4.5.3 + <para>The <option>-d</option> option was added in Shorewall 4.5.3 causes the compiler to run under the Perl debugger.</para> <para>The <option>-T</option> option was added in Shorewall 4.5.3 @@ -1289,7 +1289,7 @@ <ulink url="/manpages/shorewall.conf.html">shorewall.conf</ulink>(5).</para> - <para>The -<option>D</option> option was added in Shorewall 4.5.3 + <para>The <option>-D</option> option was added in Shorewall 4.5.3 and causes Shorewall to look in the given <emphasis>directory</emphasis> first for configuration files.</para> -- 2.1.3
------------------------------------------------------------------------------
_______________________________________________ Shorewall-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/shorewall-devel
