Library version rework; add 'where-used' information to libraries

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@4555 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb

Shorewall/compiler

@@ -4785,8 +4785,8 @@ __EOF__
 
     local version=\$(cat \${SHAREDIR}/version)
 
-    if [ \${LIBVERSION:-0} -lt 30200 ]; then
-	fatal_error "This script requires Shorewall version 3.2.3 or later; current version is \$version"
+    if [ \${SHOREWALL_LIBVERSION:-0} -lt 30200 ]; then
+	fatal_error "This script requires Shorewall version 3.3.2 or later; current version is \$version"
     fi
     #
     # These variables are required by the library functions called in this script

Shorewall/lib.accounting

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when the accounting file is
+# non-empty.
+#
 
 #
 # Process a record from the accounting file

Shorewall/lib.actions

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when USE_ACTIONS=Yes
+# (either explicitly specified or defaulted).
+#
 
 #
 # Add one Filter Rule from an action -- Helper function for the action file processor

Shorewall/lib.base

@@ -20,8 +20,15 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library contains the code common to all Shorewall components. It is copied into
+# the compiled script with the -e compiler flag is specified and is loaded by 
+# /sbin/shorewall, /usr/share/shorewall/compiler and /usr/share/shorewall/firewall. It
+# is also released as part of Shorewall Lite where it is used by /sbin/shorewall-lite 
+# and /usr/share/shorewall-lite/shorecap.
+#
 
-LIBVERSION=30200
+SHOREWALL_LIBVERSION=30302
 
 [ -n "${VARDIR:=/var/lib/shorewall}" ]
 [ -n "${SHAREDIR:=/usr/share/shorewall}" ]
@@ -1269,5 +1276,3 @@ get_device_mtu() # $1 = device
 	echo 1500
     fi
 }
-
-SHOREWALL_LIBRARY=Loaded

Shorewall/lib.config

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library contains the code common to /usr/share/shorewall/compiler and
+# /usr/share/shorewall/firewall
+#
 
 #
 # Replace commas with spaces and echo the result

Shorewall/lib.dynamiczones

@@ -1,6 +1,6 @@
 #!/bin/sh
 #
-# Shorewall 3.2 -- /usr/share/shorewall/lib.dynamicrules
+# Shorewall 3.2 -- /usr/share/shorewall/lib.dynamiczones
 #
 #     This program is under GPL [http://www.gnu.org/copyleft/gpl.htm]
 #
@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/firewall when processing
+# the 'add' and 'delete' commands.
+#
 
 #
 # Add a host or networks to a zone

Shorewall/lib.maclist

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when the maclist option
+# is specified in an entry in the interfaces file.
+#
 
 #
 # Set up MAC Verification

Shorewall/lib.nat

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when any of the following
+# configuration files are non-empty: masq, nat, netmap
+#
 
 #
 # Set up Source NAT (including masquerading)

Shorewall/lib.providers

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when the providers file is
+# non-empty.
+#
 
 #
 # Process the providers file

Shorewall/lib.proxyarp

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when the 'proxyarp' option is
+# specified in the interfaces file or when the proxyarp file is non-empty.
+#
 
 #
 # Setup Proxy ARP

Shorewall/lib.tc

@@ -25,6 +25,12 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when TC_ENABLED=Internal 
+# and the tcdevices and/or the tcclasses file is non-empty. It is also loaded under
+# the same circumstances by the compiled firewall script when processing the
+# 'refresh' command.
+#
 
 #
 # Arne Bernin's 'tc4shorewall'

Shorewall/lib.tcrules

@@ -20,6 +20,11 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when the tcrules file is
+# non-empty. It is also loaded by the compiled firewall script under the same
+# condition when the script is processing the 'refresh' command.
+#
 
 #
 # Process a TC Rule - $MARKING_CHAIN is assumed to contain the name of the

Shorewall/lib.tunnels

@@ -20,6 +20,10 @@
 #	You should have received a copy of the GNU General Public License
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
+#
+# This library is loaded by /usr/share/shorewall/compiler when the tunnels file is 
+# non-empty.
+#
 
 #
 # Set up ipsec tunnels

Shorewall/rules

@@ -301,7 +301,7 @@
 #			Otherwise, a separate rule will be generated for each
 #			port.
 #
-#	CLIENT PORT(S)	(Optional) Port(s) used by the client. If omitted,
+#	SOURCE PORT(S)	(Optional) Port(s) used by the client. If omitted,
 #			any source port is acceptable. Specified as a comma-
 #			separated list of port names, port numbers or port
 #			ranges.