From c43ee9edc58d59c0738fd1d775712c0ebe7b6f69 Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Fri, 24 Mar 2006 18:39:36 +0000
Subject: [PATCH] Update Extension Script doc for 3.2

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@3727 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 docs/shorewall_extension_scripts.xml | 47 ++++++++++++++++++----------
 1 file changed, 31 insertions(+), 16 deletions(-)

diff --git a/docs/shorewall_extension_scripts.xml b/docs/shorewall_extension_scripts.xml
index 630da7dd2..593a44dc1 100644
--- a/docs/shorewall_extension_scripts.xml
+++ b/docs/shorewall_extension_scripts.xml
@@ -15,10 +15,10 @@
       </author>
     </authorgroup>
 
-    <pubdate>2005-10-31</pubdate>
+    <pubdate>2006-03-24</pubdate>
 
     <copyright>
-      <year>2001-2005</year>
+      <year>2001-2006</year>
 
       <holder>Thomas M. Eastep</holder>
     </copyright>
@@ -178,14 +178,24 @@
     </listitem>
 
     <listitem>
-      <para>if you run commands other than <command>iptables</command> that
-      must be re-run in order to restore the firewall to its current state
-      then you must save the commands to the <firstterm>restore
-      file</firstterm>. The restore file is a temporary file in <filename
-      class="directory">/var/lib/shorewall</filename> that will be renamed
-      <filename>/var/lib/shorewall/restore-base</filename> at the successful
-      completion of the Shorewall command. The <command>shorewall
-      save</command> command combines
+      <para>Many of the extension scripts get executed for both the shorewall
+      start and shorewall restart commands. You can determine which command is
+      being executed using the contents of $COMMAND.</para>
+
+      <programlisting>if [ $COMMAND = start ]; then
+   ...</programlisting>
+    </listitem>
+
+    <listitem>
+      <para><emphasis role="bold">Shorewall versions 3.0.x and earlier
+      only.</emphasis> If you run commands other than
+      <command>iptables</command> that must be re-run in order to restore the
+      firewall to its current state then you must save the commands to the
+      <firstterm>restore file</firstterm>. The restore file is a temporary
+      file in <filename class="directory">/var/lib/shorewall</filename> that
+      will be renamed <filename>/var/lib/shorewall/restore-base</filename> at
+      the successful completion of the Shorewall command. The
+      <command>shorewall save</command> command combines
       <filename>/var/lib/shorewall/restore-base</filename> with the output of
       <command>iptables-save</command> to produce the
       <filename>/var/lib/shorewall/restore</filename> script.</para>
@@ -226,12 +236,17 @@
     </listitem>
 
     <listitem>
-      <para>Many of the extension scripts get executed for both the shorewall
-      start and shorewall restart commands. You can determine which command is
-      being executed using the contents of $COMMAND.</para>
-
-      <programlisting>if [ $COMMAND = start ]; then
-   ...</programlisting>
+      <para><emphasis role="bold">Shorewall version 3.2.0 and later
+      only.</emphasis> When compiling your firewall configuration, Shorewall
+      copies extension scripts directly into the "compiled" program where they
+      are executed in-line during processing of the start, restart and restore
+      commands. When copying a script, Shorewall indents the script to match
+      the surrounding code; if you have 'awk' installed on the system where
+      the configuration is being compiled, Shorewall can correctly handle line
+      continuation in your script ("\" as the last character on a line). If
+      you do not have awk, you may not use line continuation in your scripts.
+      Also beware that quoted strings continued from one line to another will
+      have extra whitespace inserted as a result of indentation.</para>
     </listitem>
   </itemizedlist>