fixes #894 Added explanation how user can override configlets to the comment in each configlet file; also removing comments from configlet before processing variables and ifs

build_num

@@ -1 +1 @@
-#define BUILD_NUM 2191
+#define BUILD_NUM 2192

src/compiler_lib/Configlet.cpp

@@ -112,6 +112,7 @@ bool Configlet::reload(const std::string &_prefix, const QString &file_name)
                 QString line = ts.readLine();
                 code.push_back(line);
             } while (!ts.atEnd());
+            removeComments();
             return true;
         }
     }
@@ -161,8 +162,21 @@ QString Configlet::expand()
     QRegExp var_re("\\{\\{\\$([^}]*)\\}\\}", Qt::CaseSensitive, QRegExp::RegExp2);
     var_re.setMinimal(true);
 
-    QStringList res;
-    QString all_code = code.join("\n");
+    // remove comments before processing {{$var}} and {{if var}} so we can
+    // use these in comments
+    QString all_code;
+    if (remove_comments)
+    {
+        QStringList res;
+        foreach(QString line, code)
+        {
+            if (line.startsWith(comment_str)) continue;
+            res.push_back(line);
+        }
+        all_code = res.join("\n");
+    } else
+        all_code = code.join("\n");
+
     while (all_code.contains(var_re))
     {
         QString var = var_re.cap(1);
@@ -180,30 +194,18 @@ QString Configlet::expand()
 
     while (processIf(all_code, 0));
 
-    QStringList code_lines = all_code.split("\n");
-    if (remove_comments)
-    {
-        res.clear();
-        foreach(QString line, code_lines)
-        {
-            if (line.startsWith(comment_str)) continue;
-            res.push_back(line);
-        }
-        code_lines = res;
-    }
-
     if (collapse_empty_strings)
     {
-        res.clear();
-        foreach(QString line, code_lines)
+        QStringList res;
+        foreach(QString line, all_code.split("\n"))
         {
             if (line.trimmed().isEmpty()) continue;
             res.push_back(line);
         }
-        code_lines = res;
+        return res.join("\n");
     }
 
-    return code_lines.join("\n");
+    return all_code;
 }
 
 /*

src/res/configlets/bsd/installer_commands_reg_user

@@ -1,9 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/bsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
 ##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ## These are commands built-in policy installer runs on the firewall if
 ## installation is performed using regular user account for authentication

src/res/configlets/bsd/installer_commands_root

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/bsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/bsd/kernel_vars

@@ -1,2 +1,13 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/bsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 

src/res/configlets/bsd/shell_functions

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/bsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 log() {
     echo "$1"

src/res/configlets/bsd/tools

@@ -1,3 +1,14 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/bsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Set path to all utilities that we need

src/res/configlets/freebsd/kernel_vars

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/freebsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 {{if have_freebsd_ip_forward}}$SYSCTL -w net.inet.ip.forwarding={{$freebsd_ip_forward}}{{endif}}
 {{if have_freebsd_ipv6_forward}}$SYSCTL -w net.inet6.ip6.forwarding={{$freebsd_ipv6_forward}}{{endif}}

src/res/configlets/freebsd/tools

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/freebsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Set path to all utilities that we need
 
 PFCTL="{{$path_pfctl}}"

src/res/configlets/ios/script_skeleton

@@ -1,7 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Double '##' comments are removed when configlet is processed.
-## Single '#' comments stay.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ios/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 {{$top_comment}}
 
 {{$errors_and_warnings}}

src/res/configlets/ipcop/installer_commands_reg_user

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/ipcop/installer_commands_root

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/ipcop/kernel_vars

@@ -1,3 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Fwbuilder does not control kernel variables on IPCOP
 

src/res/configlets/ipcop/script_skeleton

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 {{$top_comment}}
 
 {{$shell_debug}}

src/res/configlets/ipcop/shell_functions

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 log() {
     echo "$1"

src/res/configlets/ipcop/update_addresses

@@ -1,3 +1,14 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ## 
 ## fwbuilder does not manage ip addresses of interfaces on IPCOP

src/res/configlets/ipcop/update_bonding

@@ -1,3 +1,14 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ## 
 ## fwbuilder does not manage bonding interfaces on IPCOP

src/res/configlets/ipcop/update_bridge

@@ -1,3 +1,14 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ## 
 ## fwbuilder does not manage bridge interfaces on IPCOP

src/res/configlets/ipcop/update_vlans

@@ -1,3 +1,14 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipcop/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ## 
 ## fwbuilder does not manage vlans on IPCOP

src/res/configlets/ipf/activation

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipf/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 {{if dyn_addr}}
 {{if filter}}
 cat {{$remote_file}} | grep -v '#' | {{$interface_name_substitution_commands}} | $IPF {{$ipf_debug}} -I -f -

src/res/configlets/ipf/script_skeleton

@@ -1,7 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Double '##' comments are removed when configlet is processed.
-## Single '#' comments stay.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipf/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 {{$top_comment}}
 
 {{$errors_and_warnings}}

src/res/configlets/ipfw/script_skeleton

@@ -1,7 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Double '##' comments are removed when configlet is processed.
-## Single '#' comments stay.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/ipfw/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 {{$top_comment}}
 
 {{$errors_and_warnings}}

src/res/configlets/linux24/automatic_rules

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+
 ## Each rule must start with {{$begin_rule}} and end with
 ## {{$end_rule}}.  Variable $begin_rule has value "$IPTABLES -A" if
 ## generated script is in the shell script format, or just empty

src/res/configlets/linux24/check_utilities

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 find_program() {
   PGM=$1

src/res/configlets/linux24/constants

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Place any constant definitions for the generated script here
 ## This code appears at the very top of the script.
 

src/res/configlets/linux24/ip_forwarding

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 {{if ipv4}}
 echo {{$ipv4_forw}} > /proc/sys/net/ipv4/ip_forward

src/res/configlets/linux24/kernel_vars

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 {{if if_linux24_ip_dynaddr}} echo {{$linux24_ip_dynaddr}} > /proc/sys/net/ipv4/ip_dynaddr {{endif}}
 {{if if_linux24_rp_filter}} echo {{$linux24_rp_filter}} > /proc/sys/net/ipv4/conf/all/rp_filter {{endif}}

src/res/configlets/linux24/load_modules

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## This is the body of the shell function load_modules(). I keep
 ## function definition in the script_skeleton configlet to make it
 ## more readable (the function and call to it are in the file, both

src/res/configlets/linux24/prolog_epilog_functions

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 prolog_commands() {
     echo "Running prolog script"
 {{$prolog_script}}

src/res/configlets/linux24/reset_iptables

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 reset_iptables_v4() {
   $IPTABLES -P OUTPUT  DROP
   $IPTABLES -P INPUT   DROP

src/res/configlets/linux24/routing_functions

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 # ============== ROUTING RULES ============== 
 

src/res/configlets/linux24/run_time_wrappers

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 {{if no_wrapper}}
 {{$command}}

src/res/configlets/linux24/script_body_iptables_restore

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ##  iptables-restore method, not single rule compile
 {{if have_script}}
 (

src/res/configlets/linux24/script_body_single_rule

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## this template is used for single rule compile, both
 ## iptables-restore and regular, as well as for the regular
 ## (not iptables-restore) script

src/res/configlets/linux24/update_bonding

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ############ bonding ###########################################
 ## cat /proc/net/bonding/bond0
 ## Ethernet Channel Bonding Driver: v3.5.0 (November 4, 2008)

src/res/configlets/linux24/update_bridge

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ############ bridge ############################################
 ## brctl  show
 ## bridge name   bridge id               STP enabled     interfaces

src/res/configlets/linux24/update_vlans

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/linux24/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ############ VLAN ##############################################
 ## /proc/net/vlan/config
 ##

src/res/configlets/macosx/installer_commands_reg_user

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/macosx/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/macosx/installer_commands_root

@@ -1,9 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/macosx/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
 ##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ## These are commands built-in policy installer runs on the firewall if
 ## installation is performed using root account for authentication

src/res/configlets/macosx/kernel_vars

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/macosx/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 {{if have_macosx_ip_forward}}$SYSCTL -w net.inet.ip.forwarding={{$macosx_ip_forward}}{{endif}}
 {{if have_macosx_ip_sourceroute}}$SYSCTL -w net.inet.ip.sourceroute={{$macosx_ip_sourceroute}}{{endif}}

src/res/configlets/macosx/tools

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/macosx/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Set path to all utilities that we need
 
 IPFW="{{$path_ipfw}}"

src/res/configlets/openbsd/kernel_vars

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/openbsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 {{if have_openbsd_ip_directed_broadcast}}$SYSCTL -w net.inet.ip.directed-broadcast={{$openbsd_ip_directed_broadcast}}{{endif}}
 {{if have_openbsd_ip_forward}}$SYSCTL -w net.inet.ip.forwarding={{$openbsd_ip_forward}}{{endif}}

src/res/configlets/openbsd/tools

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/openbsd/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Set path to all utilities that we need
 
 PFCTL="{{$path_pfctl}}"

src/res/configlets/pf/activation

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pf/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 $PFCTL {{$pfctl_debug}} {{if anchor}}-a {{$anchor_name}}{{endif}} \
     {{if pf_version_lt_3_2}}-R{{endif}} {{if pf_version_ge_3_2}}-f{{endif}} \
     {{$remote_file}} || exit 1

src/res/configlets/pf/script_skeleton

@@ -1,7 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Double '##' comments are removed when configlet is processed.
-## Single '#' comments stay.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pf/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 {{$top_comment}}
 
 {{$errors_and_warnings}}

src/res/configlets/pix_os/failover_commands_6

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## 
 ## http://www.cisco.com/en/US/docs/security/pix/pix63/configuration/guide/failover.html
 ##

src/res/configlets/pix_os/failover_commands_7

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## 
 ## failover
 ## failover lan unit primary

src/res/configlets/pix_os/failover_interface_6

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 nameif {{$interface_name}} {{$interface_label}} security{{$security_level}}
 {{if configure_interface_address}}ip address {{$interface_label}} {{$address}} {{$netmask}} {{endif}}

src/res/configlets/pix_os/failover_interface_7

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 interface {{$interface_name}}
   description LAN/STATE Failover Interface

src/res/configlets/pix_os/ntp

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 {{if clear}}
 {{if pix_version_lt_70}}

src/res/configlets/pix_os/regular_interface_6

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 {{if static_address}}
 nameif {{$interface_name}} {{$interface_label}} security{{$security_level}}

src/res/configlets/pix_os/regular_interface_7

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 
 {{if static_address}}

src/res/configlets/pix_os/script_skeleton

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Double '##' comments are removed when configlet is processed.
 ## Single '#' comments stay.
 {{$top_comment}}

src/res/configlets/pix_os/snmp

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 {{if clear}}
 {{if pix_version_lt_70}}

src/res/configlets/pix_os/vlan_parent_interface_6

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 
 

src/res/configlets/pix_os/vlan_parent_interface_7

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 interface {{$interface_name}}
   no nameif

src/res/configlets/pix_os/vlan_subinterface_6

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## interface ethernet0 vlan3 logical
 
 {{if static_address}}

src/res/configlets/pix_os/vlan_subinterface_7

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/pix_os/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 
 {{if static_address}}
 

src/res/configlets/solaris/installer_commands_reg_user

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/solaris/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/solaris/installer_commands_root

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/solaris/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/solaris/kernel_vars

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/solaris/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 {{if have_solaris_ip_forward}}ndd -set /dev/ip ip_forwarding {{$solaris_ip_forward}}{{endif}}
 {{if have_solaris_ip_ignore_redirect}}ndd -set /dev/ip ip_ignore_redirect  {{$solaris_ip_ignore_redirect}}{{endif}}

src/res/configlets/solaris/tools

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/solaris/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Set path to all utilities that we need
 
 IPFW="{{$path_ipfw}}"

src/res/configlets/sveasoft/installer_commands_reg_user

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/sveasoft/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/sveasoft/installer_commands_root

@@ -1,8 +1,15 @@
 ## -*- mode: shell-script; -*- 
 ##
-## Lines that start with "##" will be removed before this code is
-## added to the generated script. Regular shell comments can be added
-## using single "#", these will appear in the script.
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/sveasoft/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 ##
 ##
 ## These are commands built-in policy installer runs on the firewall if

src/res/configlets/sveasoft/script_skeleton

@@ -1,5 +1,16 @@
 ## -*- mode: shell-script; -*- 
 ##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/sveasoft/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
+##
 ## Note that /bin/sh on Sveasoft (busybox) does not like empty shell
 ## functions and fails with an error "36: Syntax error: "}" unexpected"
 ## Will call /bin/true as a placeholder so that if some other

src/res/configlets/sveasoft/shell_functions

@@ -1,4 +1,15 @@
 ## -*- mode: shell-script; -*- 
+##
+## To be able to make changes to the part of configuration created
+## from this configlet you need to copy this file to the directory
+## fwbuilder/configlets/sveasoft/ in your home directory and modify it.
+## Double "##" comments are removed during processing but single "#"
+## comments are be retained and appear in the generated script. Empty
+## lines are removed as well.  
+##
+## Configlets support simple macro language with these constructs:
+## {{$var}} is variable expansion
+## {{if var}} is conditional operator.
 
 log() {
     echo "$1"

test/pf/quick-cmp.sh

@@ -7,6 +7,6 @@ for f in $(ls *.fw.orig *.conf.orig)
 do
     V="$f   <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<"
     echo "echo \"$V\" | cut -c1-72"
-    new_f=$(echo $f | sed 's/.org//')
+    new_f=$(echo $f | sed 's/.orig//')
     echo "$DIFFCMD $f $new_f"
 done