extern/shorewall_code
1
0
Fork 1
mirror of https://gitlab.com/shorewall/code.git synced 2025-01-09 07:08:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix broken link

Browse Source 
git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@8133 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
This commit is contained in:
teastep 2008-02-01 23:03:27 +00:00
parent 82e525d0f5
commit 9a396bee3b
2 changed files with 211 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/Shorewall-4.xml
View File

@ -282,6 +282,28 @@
4.0.6.</para> 4.0.6.</para>
</footnote></entry> </footnote></entry>
</row> </row>
<row>
<entry valign="middle">Shorewall-common 4.0.7</entry>
<entry>Shorewall-shell 4.0.5 - 4.0.8</entry>
<entry>Shorewall-perl 4.0.5 - 4.0.8<footnote>
<para>Shorewall-perl 4.0.6 and later require Shorewall-lite
4.0.6 or later</para>
</footnote></entry>
</row>
<row>
<entry valign="middle">Shorewall-common 4.0.8</entry>
<entry>Shorewall-shell 4.0.5 - 4.0.8</entry>
<entry>Shorewall-perl 4.0.5 - 4.0.8<footnote>
<para>Shorewall-perl 4.0.6 and later require Shorewall-lite
4.0.6 or later</para>
</footnote></entry>
</row>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>

247
docs/Shorewall-perl.xml
View File

@ -499,8 +499,8 @@ loc net ACCEPT</programlisting>
</listitem> </listitem>
<listitem> <listitem>
<para> In the SOURCE column of the rules file, when an interface <para>In the SOURCE column of the rules file, when an interface name
name is followed by a list of IP addresses, the behavior of is followed by a list of IP addresses, the behavior of
Shorewall-perl differs from that of Shorewall-shell.</para> Shorewall-perl differs from that of Shorewall-shell.</para>
<para>Example:<programlisting>#ACTION SOURCE DEST PROTO DEST <para>Example:<programlisting>#ACTION SOURCE DEST PROTO DEST
@ -514,7 +514,7 @@ ACCEPT loc:eth0:192.168.1.3,192.168.1.5 $FW tcp 22</programlisting>Wit
Shorewall-perl.<programlisting>#ACTION SOURCE DEST PROTO DEST Shorewall-perl.<programlisting>#ACTION SOURCE DEST PROTO DEST
# PORT(S) # PORT(S)
ACCEPT loc:eth0:192.168.1.3,eth0:192.168.1.5 $fw tcp 22</programlisting> ACCEPT loc:eth0:192.168.1.3,eth0:192.168.1.5 $fw tcp 22</programlisting>
Shorewall-perl does not support this alternative syntax. </para> Shorewall-perl does not support this alternative syntax.</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
</section> </section>
@ -681,7 +681,20 @@ ACCEPT loc:eth0:192.168.1.3,eth0:192.168.1.5 $fw tcp 22</programlisting>
role="bold">--refresh=</emphasis>&lt;<emphasis>chainlist</emphasis>&gt;</member> role="bold">--refresh=</emphasis>&lt;<emphasis>chainlist</emphasis>&gt;</member>
</simplelist>If given, the compiled script's 'refresh' command will </simplelist>If given, the compiled script's 'refresh' command will
refresh the chains in the comma-separated refresh the chains in the comma-separated
&lt;<emphasis>chainlist</emphasis>&gt; rather than 'blacklst'.</para> &lt;<emphasis>chainlist</emphasis>&gt; rather than
'blacklst'.<simplelist>
<member><emphasis
role="bold">--log</emphasis>=&lt;logfile&gt;</member>
</simplelist></para>
<para>Added in Shorewall 4.1. If given, compiler will log to this file
provider that --log_verbosity is &gt; -1.<simplelist>
<member><emphasis
role="bold">--log_verbosity</emphasis>=-1|0|1|2</member>
</simplelist></para>
<para>Added in Shorewall 4.1. If given, controls the verbosity of
logging to the log specified by the --log parameter.</para>
<para>Example (compiles the configuration in the current directory <para>Example (compiles the configuration in the current directory
generating a script named 'firewall' and using VERBOSITY generating a script named 'firewall' and using VERBOSITY
@ -700,75 +713,193 @@ set +a
<section id="Compiler"> <section id="Compiler">
<title>Shorewall::Compiler</title> <title>Shorewall::Compiler</title>
<para><programlisting> use lib '/usr/share/shorewall-perl'; <section id="Compiler-4.0">
<title>Shorewall 4.0</title>
<para><programlisting> use lib '/usr/share/shorewall-perl';
use Shorewall::Compiler; use Shorewall::Compiler;
compiler $filename, $directory, $verbose, $options $chains</programlisting>Arguments compiler $filename, $directory, $verbose, $options $chains</programlisting>Arguments
to the compiler are:</para> to the compiler are:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>$filename</term> <term>$filename</term>
<listitem> <listitem>
<para>Name of the compiled script to be created. If the arguments <para>Name of the compiled script to be created. If the
evaluates to false, the configuration is syntax checked.</para> arguments evaluates to false, the configuration is syntax
</listitem> checked.</para>
</varlistentry> </listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term>$directory</term> <term>$directory</term>
<listitem> <listitem>
<para>The directory containing the configuration. If passed as '', <para>The directory containing the configuration. If passed as
then <filename class="directory">/etc/shorewall/</filename> is '', then <filename class="directory">/etc/shorewall/</filename>
assumed.</para> is assumed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>$verbose</term> <term>$verbose</term>
<listitem> <listitem>
<para>The verbosity level that the compiler will run with <para>The verbosity level that the compiler will run with
(0-2).<note> (0-2).<note>
<para>The VERBOSITY setting in the <para>The VERBOSITY setting in the
<filename>shorewall.conf</filename> file read by the compiler <filename>shorewall.conf</filename> file read by the
will determine the default verbosity for the compiled compiler will determine the default verbosity for the
program.</para> compiled program.</para>
</note></para> </note></para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>$options</term> <term>$options</term>
<listitem> <listitem>
<para>A bitmap of options. Shorewall::Compiler exports three <para>A bitmap of options. Shorewall::Compiler exports three
constants to help building this argument:<simplelist> constants to help building this argument:<simplelist>
<member>EXPORT = 0x01</member> <member>EXPORT = 0x01</member>
<member>TIMESTAMP = 0x02</member> <member>TIMESTAMP = 0x02</member>
<member>DEBUG = 0x04</member> <member>DEBUG = 0x04</member>
</simplelist></para> </simplelist></para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>$chains</term> <term>$chains</term>
<listitem> <listitem>
<para>A comma-separated list of chains that the generated script's <para>A comma-separated list of chains that the generated
'refresh' command will reload. If passed as an empty string, then script's 'refresh' command will reload. If passed as an empty
'blacklist' is assumed.</para> string, then 'blacklist' is assumed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>The compiler raises an exception with 'die' if it encounters an <para>The compiler raises an exception with 'die' if it encounters an
error; $@ contains the 'ERROR' messages describing the problem. The error; $@ contains the 'ERROR' messages describing the problem. The
compiler function can be called repeatedly with different inputs.</para> compiler function can be called repeatedly with different
inputs.</para>
</section>
<section>
<title>Shorewall 4.1 and Later</title>
<para>To avoid a proliferation of parameters to
Shorewall::Compiler::compile(), that function has been changed to use
named parameters. Parameter names are:</para>
<variablelist>
<varlistentry>
<term>object</term>
<listitem>
<para>Object file. If omitted or '', the configuration is syntax
checked.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>directory</term>
<listitem>
<para>Directory. If omitted or '', configuration files are
located using CONFIG_PATH. Otherwise, the directory named by
this parameter is searched first.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>verbosity</term>
<listitem>
<para>Verbosity; range -1 to 2</para>
</listitem>
</varlistentry>
<varlistentry>
<term>timestamp</term>
<listitem>
<para>0|1 -- timestamp messages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>debug</term>
<listitem>
<para>0|1 -- include stack trace in warning/error
messages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>export</term>
<listitem>
<para>0|1 -- compile for export.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>chains</term>
<listitem>
<para>List of chains to be reloaded by 'refresh'</para>
</listitem>
</varlistentry>
<varlistentry>
<term>log</term>
<listitem>
<para>File to log compiler messages to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>log_verbosity</term>
<listitem>
<para>Log Verbosity; range -1 to 2.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Those parameters that are supplied must have defined values.
Defaults are: <simplelist>
<member>object '' ('check' command)</member>
<member>directory ''</member>
<member>verbosity 1</member>
<member>timestamp 0</member>
<member>debug 0</member>
<member>export 0</member>
<member>chains ''</member>
<member>log ''</member>
<member>log_verbosity -1</member>
</simplelist></para>
<para>Example: <programlisting>use lib '/usr/share/shorewall-perl/';
use Shorewall::Compiler;
compiler( object =&gt; '/root/firewall', log =&gt; '/root/compile.log', log_verbosity =&gt; 2 ); </programlisting></para>
</section>
</section> </section>
<section id="Chains"> <section id="Chains">
@ -1049,7 +1180,7 @@ shorewall $config_file_entry;</programlisting>The Shorewall::Config module
output depending on the current verbosity setting.</para> output depending on the current verbosity setting.</para>
<para>The <emphasis role="bold">shorewall()</emphasis> function is used <para>The <emphasis role="bold">shorewall()</emphasis> function is used
by <ulink url="configuration_file_basics.html%23Embedded">embedded Perl by <ulink url="configuration_file_basics.htm#Embedded">embedded Perl
scripts</ulink> to generate entries to be included in the current scripts</ulink> to generate entries to be included in the current
configuration file.</para> configuration file.</para>
</section> </section>