From 9a396bee3b083987e783987dc0f0b19099bbbf0f Mon Sep 17 00:00:00 2001 From: teastep Date: Fri, 1 Feb 2008 23:03:27 +0000 Subject: [PATCH] Fix broken link git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@8133 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb --- docs/Shorewall-4.xml | 22 ++++ docs/Shorewall-perl.xml | 247 ++++++++++++++++++++++++++++++---------- 2 files changed, 211 insertions(+), 58 deletions(-) diff --git a/docs/Shorewall-4.xml b/docs/Shorewall-4.xml index 2cccb4a5b..9797cb08b 100644 --- a/docs/Shorewall-4.xml +++ b/docs/Shorewall-4.xml @@ -282,6 +282,28 @@ 4.0.6. + + + Shorewall-common 4.0.7 + + Shorewall-shell 4.0.5 - 4.0.8 + + Shorewall-perl 4.0.5 - 4.0.8 + Shorewall-perl 4.0.6 and later require Shorewall-lite + 4.0.6 or later + + + + + Shorewall-common 4.0.8 + + Shorewall-shell 4.0.5 - 4.0.8 + + Shorewall-perl 4.0.5 - 4.0.8 + Shorewall-perl 4.0.6 and later require Shorewall-lite + 4.0.6 or later + + diff --git a/docs/Shorewall-perl.xml b/docs/Shorewall-perl.xml index d263b88a1..baafa3155 100644 --- a/docs/Shorewall-perl.xml +++ b/docs/Shorewall-perl.xml @@ -499,8 +499,8 @@ loc net ACCEPT - In the SOURCE column of the rules file, when an interface - name is followed by a list of IP addresses, the behavior of + In the SOURCE column of the rules file, when an interface name + is followed by a list of IP addresses, the behavior of Shorewall-perl differs from that of Shorewall-shell. Example:#ACTION SOURCE DEST PROTO DEST @@ -514,7 +514,7 @@ ACCEPT loc:eth0:192.168.1.3,192.168.1.5 $FW tcp 22Wit Shorewall-perl.#ACTION SOURCE DEST PROTO DEST # PORT(S) ACCEPT loc:eth0:192.168.1.3,eth0:192.168.1.5 $fw tcp 22 - Shorewall-perl does not support this alternative syntax. + Shorewall-perl does not support this alternative syntax. @@ -681,7 +681,20 @@ ACCEPT loc:eth0:192.168.1.3,eth0:192.168.1.5 $fw tcp 22 role="bold">--refresh=<chainlist> If given, the compiled script's 'refresh' command will refresh the chains in the comma-separated - <chainlist> rather than 'blacklst'. + <chainlist> rather than + 'blacklst'. + --log=<logfile> + + + Added in Shorewall 4.1. If given, compiler will log to this file + provider that --log_verbosity is > -1. + --log_verbosity=-1|0|1|2 + + + Added in Shorewall 4.1. If given, controls the verbosity of + logging to the log specified by the --log parameter. Example (compiles the configuration in the current directory generating a script named 'firewall' and using VERBOSITY @@ -700,75 +713,193 @@ set +a
Shorewall::Compiler - use lib '/usr/share/shorewall-perl'; +
+ Shorewall 4.0 + + use lib '/usr/share/shorewall-perl'; use Shorewall::Compiler; compiler $filename, $directory, $verbose, $options $chainsArguments - to the compiler are: + to the compiler are: - - - $filename + + + $filename - - Name of the compiled script to be created. If the arguments - evaluates to false, the configuration is syntax checked. - - + + Name of the compiled script to be created. If the + arguments evaluates to false, the configuration is syntax + checked. + + - - $directory + + $directory - - The directory containing the configuration. If passed as '', - then /etc/shorewall/ is - assumed. - - + + The directory containing the configuration. If passed as + '', then /etc/shorewall/ + is assumed. + + - - $verbose + + $verbose - - The verbosity level that the compiler will run with - (0-2). - The VERBOSITY setting in the - shorewall.conf file read by the compiler - will determine the default verbosity for the compiled - program. - - - + + The verbosity level that the compiler will run with + (0-2). + The VERBOSITY setting in the + shorewall.conf file read by the + compiler will determine the default verbosity for the + compiled program. + + + - - $options + + $options - - A bitmap of options. Shorewall::Compiler exports three - constants to help building this argument: - EXPORT = 0x01 + + A bitmap of options. Shorewall::Compiler exports three + constants to help building this argument: + EXPORT = 0x01 - TIMESTAMP = 0x02 + TIMESTAMP = 0x02 - DEBUG = 0x04 - - - + DEBUG = 0x04 + + + - - $chains + + $chains - - A comma-separated list of chains that the generated script's - 'refresh' command will reload. If passed as an empty string, then - 'blacklist' is assumed. - - - + + A comma-separated list of chains that the generated + script's 'refresh' command will reload. If passed as an empty + string, then 'blacklist' is assumed. + + + - The compiler raises an exception with 'die' if it encounters an - error; $@ contains the 'ERROR' messages describing the problem. The - compiler function can be called repeatedly with different inputs. + The compiler raises an exception with 'die' if it encounters an + error; $@ contains the 'ERROR' messages describing the problem. The + compiler function can be called repeatedly with different + inputs. +
+ +
+ Shorewall 4.1 and Later + + To avoid a proliferation of parameters to + Shorewall::Compiler::compile(), that function has been changed to use + named parameters. Parameter names are: + + + + object + + + Object file. If omitted or '', the configuration is syntax + checked. + + + + + directory + + + Directory. If omitted or '', configuration files are + located using CONFIG_PATH. Otherwise, the directory named by + this parameter is searched first. + + + + + verbosity + + + Verbosity; range -1 to 2 + + + + + timestamp + + + 0|1 -- timestamp messages. + + + + + debug + + + 0|1 -- include stack trace in warning/error + messages. + + + + + export + + + 0|1 -- compile for export. + + + + + chains + + + List of chains to be reloaded by 'refresh' + + + + + log + + + File to log compiler messages to. + + + + + log_verbosity + + + Log Verbosity; range -1 to 2. + + + + + Those parameters that are supplied must have defined values. + Defaults are: + object '' ('check' command) + + directory '' + + verbosity 1 + + timestamp 0 + + debug 0 + + export 0 + + chains '' + + log '' + + log_verbosity -1 + + + Example: use lib '/usr/share/shorewall-perl/'; +use Shorewall::Compiler; + +compiler( object => '/root/firewall', log => '/root/compile.log', log_verbosity => 2 ); +
@@ -1049,7 +1180,7 @@ shorewall $config_file_entry;The Shorewall::Config module output depending on the current verbosity setting. The shorewall() function is used - by embedded Perl + by embedded Perl scripts to generate entries to be included in the current configuration file.