Shorewall 4.5 Documentation Updates

Signed-off-by: Tom Eastep <teastep@shorewall.net>

docs/Anatomy.xml

@@ -5,7 +5,7 @@
   <!--$Id$-->
 
   <articleinfo>
-    <title>Anatomy of Shorewall 4.4</title>
+    <title>Anatomy of Shorewall 4.5</title>
 
     <authorgroup>
       <author>
@@ -22,6 +22,8 @@
 
       <year>2009</year>
 
+      <year>2012</year>
+
       <holder>Thomas M. Eastep</holder>
     </copyright>
 
@@ -39,9 +41,15 @@
   <section id="Products">
     <title>Products</title>
 
-    <para>Shorewall 4.4 consists of four packages.</para>
+    <para>Shorewall 4.5 consists of six packages.</para>
 
     <orderedlist>
+      <listitem>
+        <para><emphasis role="bold">Shorewall Core</emphasis>. This package
+        contains the core Shorewall shell libraries and is required to install
+        any of the other packages.</para>
+      </listitem>
+
       <listitem>
         <para><emphasis role="bold">Shorewall</emphasis>. This package must be
         installed on at least one system in your network. It contains
@@ -71,6 +79,14 @@
         generated. These scripts are copied to the firewall systems where they
         run under the control of Shorewall-lite.</para>
       </listitem>
+
+      <listitem>
+        <para>Shorewall-init. An add-on to any of the above packages that
+        allows the firewall state to be altered in reaction to interfaces
+        coming up and going down. Where Upstart is not being used, this
+        package can also be configured to place the firewall in a safe state
+        prior to bringing up the network interfaces.</para>
+      </listitem>
     </orderedlist>
   </section>
 
@@ -158,13 +174,13 @@
         </listitem>
 
         <listitem>
-          <para><filename>macro.*</filename> - The standard Shorewall <ulink
+          <para><filename>Macros/*</filename> - The standard Shorewall <ulink
           url="Macros.html">macros</ulink>.</para>
         </listitem>
 
         <listitem>
-          <para><filename>modules</filename> - File that drives the loading of
+          <para><filename>modules.*</filename> - File that drives the loading
-          Netfilter kernel modules. May be overridden by
+          of Netfilter kernel modules. May be overridden by
           <filename>/etc/shorewall/modules</filename>.</para>
         </listitem>
 
@@ -364,6 +380,11 @@
           the other shell programs.</para>
         </listitem>
 
+        <listitem>
+          <para><filename>Macros/*</filename> - The standard Shorewall6 <ulink
+          url="Macros.html">macros</ulink>.</para>
+        </listitem>
+
         <listitem>
           <para><filename>modules</filename> - File that drives the loading of
           Netfilter kernel modules. May be overridden by
@@ -521,14 +542,14 @@
         </listitem>
 
         <listitem>
-          <para><filename>lib.*</filename> - Shell function libraries used by
+          <para><filename>lib.base</filename> - Shell function librarie used
-          the other shell programs. These are copies of the corresponding
+          by the other shell programs. This is a thin wrapper around
-          libraries in the Shorewall product.</para>
+          <filename>/usr/share/shorewall/lib.base</filename>.</para>
         </listitem>
 
         <listitem>
-          <para><filename>modules</filename> - File that drives the loading of
+          <para><filename>modules</filename>* - Files that drive the loading
-          Netfilter kernel modules. May be overridden by
+          of Netfilter kernel modules. May be overridden by
           <filename>/etc/shorewall-lite/modules</filename>.</para>
         </listitem>
 
@@ -711,14 +732,14 @@
         </listitem>
 
         <listitem>
-          <para><filename>lib.*</filename> - Shell function libraries used by
+          <para><filename>lib.base</filename> - Shell function librarie used
-          the other shell programs. These are copies of the corresponding
+          by the other shell programs. This is a thin wrapper around
-          libraries in the Shorewall product.</para>
+          <filename>/usr/share/shorewall/lib.base</filename>.</para>
         </listitem>
 
         <listitem>
-          <para><filename>modules</filename> - File that drives the loading of
+          <para><filename>modules</filename>* - Files that drive the loading
-          Netfilter kernel modules. May be overridden by
+          of Netfilter kernel modules. May be overridden by
           <filename>/etc/shorewall-lite/modules</filename>.</para>
         </listitem>
 

docs/Build.xml

@@ -22,6 +22,8 @@
 
       <year>2010</year>
 
+      <year>2012</year>
+
       <holder>Thomas M. Eastep</holder>
     </copyright>
 
@@ -57,6 +59,10 @@
       <para>The development branch of each product is kept here.</para>
 
       <itemizedlist>
+        <listitem>
+          <para>Shorewall-core.</para>
+        </listitem>
+
         <listitem>
           <para>Shorewall</para>
         </listitem>
@@ -315,7 +321,7 @@
                 <term>c</term>
 
                 <listitem>
-                  <para>Build the shorewall package.</para>
+                  <para>Build the shorewall-core package.</para>
                 </listitem>
               </varlistentry>
 
@@ -359,6 +365,14 @@
                 </listitem>
               </varlistentry>
 
+              <varlistentry>
+                <term>s</term>
+
+                <listitem>
+                  <para>Build the shorewall package.</para>
+                </listitem>
+              </varlistentry>
+
               <varlistentry>
                 <term>x</term>
 
@@ -431,7 +445,7 @@
                 <term>c</term>
 
                 <listitem>
-                  <para>Upload the shorewall package.</para>
+                  <para>Upload the shorewall-core package.</para>
                 </listitem>
               </varlistentry>
 
@@ -451,6 +465,14 @@
                 </listitem>
               </varlistentry>
 
+              <varlistentry>
+                <term>s</term>
+
+                <listitem>
+                  <para>Upload the shorewall package.</para>
+                </listitem>
+              </varlistentry>
+
               <varlistentry>
                 <term>6</term>
 

docs/Documentation_Index.xml

@@ -5,7 +5,7 @@
   <!--/$Id$-->
 
   <articleinfo>
-    <title>Shorewall 4.4 Documentation</title>
+    <title>Shorewall 4.5 Documentation</title>
 
     <authorgroup>
       <author>
@@ -18,7 +18,7 @@
     <pubdate><?dbtimestamp format="Y/m/d"?></pubdate>
 
     <copyright>
-      <year>2001-2011</year>
+      <year>2001-2012</year>
 
       <holder>Thomas M. Eastep</holder>
     </copyright>

docs/Shorewall-4.xml

@@ -146,9 +146,18 @@
     </itemizedlist>
   </section>
 
+  <section>
+    <title>Shorewall 4.5</title>
+
+    <para>Shorewall 4.5 adds an additional <emphasis
+    role="bold">Shorewall-core</emphasis> package. This package contains the
+    core Shorewall shell libraries that are required by the other
+    packages.</para>
+  </section>
+
   <section id="Prereqs">
-    <title>Prerequisites for using the Shorewall Version 4.2/4.4 Perl-based
+    <title>Prerequisites for using the Shorewall Version 4.2/4.4/4.5
-    Compiler</title>
+    Perl-based Compiler</title>
 
     <itemizedlist>
       <listitem>
@@ -188,6 +197,11 @@
       <listitem>
         <para>Perl <emphasis role="bold">Scalar::Util </emphasis>Module</para>
       </listitem>
+
+      <listitem>
+        <para>Perl <emphasis role="bold">Digest::SHA1</emphasis> Module
+        (Shorewall 4.5 only)</para>
+      </listitem>
     </itemizedlist>
 
     <para>Please note that there are <ulink url="IPv6Support.html">additional