holm/shorewall_code
1
0
Fork 0
forked from extern/shorewall_code
Code Pull Requests Activity

Final update to Shorewall-perl documeation

Browse Source 
git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@7612 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
This commit is contained in:
teastep 2007-11-03 01:36:54 +00:00
parent d7257f3604
commit f57c2d8e92
1 changed files with 44 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/Shorewall-perl.xml
View File

@ -734,7 +734,7 @@ loc net ACCEPT</programlisting>
compiler function can be called repeatedly with different inputs.</para>
</section>
<section>
<section id="Chains">
<title>Shorewall::Chains</title>
<para><programlisting>use lib '/usr/share/shorewall-perl';
@ -971,5 +971,48 @@ my $chainref7 = $filter_table{$name};</programlisting>Shorewall::Chains is
</varlistentry>
</variablelist>
</section>
<section id="Config">
<title>Shorewall::Config</title>
<para><programlisting>use lib '/usr/share/shorewall-perl';
use Shorewall::Config;
warning message "This entry is bogus";
fatal_error "You have made an error";
progress_message "This will only be seen if VERBOSITY &gt;= 2";
progress_message2 "This will only be seen if VERBOSITY &gt;= 1";
progress_message3 "This will be seen unless VERBOSITY &lt; 0";
</programlisting><programlisting>use lib '/usr/share/shorewall-perl';
use Shorewall::Chains qw/shorewall/;
shorewall $config_file_entry;</programlisting>The Shorewall::Config module
provides basic services to Shorewall-perl. By default, it exports the
functions that produce progress messages and warning/error
messages.</para>
<para>To issue a warning message, call <emphasis
role="bold">warning_message()</emphasis>. The single argument describes
the warning.</para>
<para>To raise a fatal error, call <emphasis
role="bold">fatal_error()</emphasis>. Again, the single argument
described the error. </para>
<para>In both cases, the function will augment the warning/error with
the current configuration file and line number, if any. fatal_error()
raised an exception via either <emphasis
role="bold">confess()</emphasis> or <emphasis
role="bold">die()</emphasis>.</para>
<para>The three 'progress message' functions conditionally produce
output depending on the current verbosity setting.</para>
<para>The <emphasis role="bold">shorewall()</emphasis> function is used
by <ulink url="configuration_file_basics.html%23Embedded">embedded Perl
scripts</ulink> to generate entries to be included in the current
configuration file.</para>
</section>
</section>
</article>