Document the --shorewallrc parameter to compiler.pl

Signed-off-by: Tom Eastep <teastep@shorewall.net>
This commit is contained in:
Tom Eastep 2012-05-08 07:59:22 -07:00
parent 1d6e6b65db
commit 089d980dae

View File

@ -182,7 +182,7 @@
<entry>init</entry>
<entry></entry>
<entry/>
</row>
<row>
@ -191,39 +191,39 @@
<entry>start</entry>
<entry></entry>
<entry/>
</row>
<row>
<entry></entry>
<entry/>
<entry>started</entry>
<entry></entry>
<entry/>
</row>
<row>
<entry></entry>
<entry/>
<entry>stop</entry>
<entry></entry>
<entry/>
</row>
<row>
<entry></entry>
<entry/>
<entry>stopped</entry>
<entry></entry>
<entry/>
</row>
<row>
<entry></entry>
<entry/>
<entry>tcclear</entry>
<entry></entry>
<entry/>
</row>
</tbody>
</tgroup>
@ -821,6 +821,14 @@ DNAT- net 192.168.1.3 tcp 21</programl
<para>Added in Shorewall 4.4.26. Search path for configuration
files.</para>
<simplelist>
<member><emphasis
role="bold">--shorewallrc=<replaceable>path</replaceable></emphasis></member>
</simplelist>
<para>Added in Shorewall 4.5.1. Specifies the location of the
<filename>shorewallrc</filename> file.</para>
<para>Example (compiles the configuration in the current directory
generating a script named 'firewall' and using VERBOSITY
2).<programlisting><emphasis role="bold">/usr/share/shorewall/compiler.pl -v 2 -d . firewall</emphasis></programlisting><note>
@ -965,6 +973,15 @@ set +a
for input files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>shorewallrc</term>
<listitem>
<para>Pathname of the shorewallrc file. Added in Shorewall
4.5.1.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Those parameters that are supplied must have defined values.
@ -998,7 +1015,9 @@ set +a
<member>config_path: Contents of
<filename>/var/lib/shorewall/configpath</filename> or
<filename>/var/lib/shorewall6/configpath</filename> depending on the
setting of <emphasis role="bold">family</emphasis>. </member>
setting of <emphasis role="bold">family</emphasis>.</member>
<member>shorewallrc: ''.</member>
</simplelist></para>
<para>Example: <programlisting>use lib '/usr/share/shorewall/';
@ -1035,7 +1054,7 @@ my $chainref7 = $filter_table{$name};</programlisting>Shorewall::Chains is
(<filename>/usr/share/shorewall-perl/Shorewall/Chains.pm</filename>).</para>
<para>The module export the chain table along with three hash references
into the table:<literal></literal></para>
into the table:<literal/></para>
<variablelist>
<varlistentry>