From 8eac9170573bcff0c1a6d7488cf419e5f3779be2 Mon Sep 17 00:00:00 2001
From: teastep <teastep@fbd18981-670d-0410-9b5c-8dc0c1a9a2bb>
Date: Wed, 13 Jun 2007 18:40:09 +0000
Subject: [PATCH] Update Documentation in compiler.pl

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@6534 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
---
 Shorewall-perl/compiler.pl | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/Shorewall-perl/compiler.pl b/Shorewall-perl/compiler.pl
index 6a37f17a9..cf74ce11d 100755
--- a/Shorewall-perl/compiler.pl
+++ b/Shorewall-perl/compiler.pl
@@ -21,7 +21,25 @@
 #	along with this program; if not, write to the Free Software
 #	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA
 #
-# See usage() function below for command line syntax.
+# Usage:
+#
+#         compiler.pl [ <option> ... ] [ <filename> ]
+#
+#     Options:
+#
+#         --export                    # Compile for export
+#         --verbosity=<number>        # Set VERBOSITY
+#         --directory=<directory>     # Directory where configuration resides (default is /etc/shorewall)
+#         --timestamp                 # Timestamp all progress messages
+#
+# Default values for compiler options are given in environmental variables as follows:
+#
+#	   Option                 Variable
+#
+#	   --verbosity		  VERBOSE
+#	   --export		  EXPORT
+#	   --directory		  SHOREWALL_DIR
+#	   --timestamp		  TIMESTAMP
 #
 use strict;
 use lib '/usr/share/shorewall-perl';
@@ -34,7 +52,7 @@ sub usage() {
 }
 
 #
-#                                     E x e c u t i o n   S t a r t s   H e r e
+#                                     E x e c u t i o n   B e g i n s   H e r e
 #
 my $export        = $ENV{EXPORT}        || 0;
 my $shorewall_dir = $ENV{SHOREWALL_DIR} || '';