* Add run-time check that IO::Dirent is functioning correctly,
[BackupPC.git] / conf / config.pl
index 7113463..411138c 100644 (file)
@@ -207,6 +207,10 @@ $Conf{DfPath} = '';
 #   $dfPath      path to df ($Conf{DfPath})
 #   $topDir      top-level BackupPC data directory
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{DfCmd} = '$dfPath $topDir';
 
 #
@@ -332,6 +336,10 @@ $Conf{PerlModuleLoad}     = undef;
 #                            . ' $serverInitdPath start'
 #                            . ' < /dev/null >& /dev/null';
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{ServerInitdPath} = '';
 $Conf{ServerInitdStartCmd} = '';
 
@@ -938,6 +946,10 @@ $Conf{SmbClientPath} = '';
 #    $X_option        exclude option (if $fileList is an exclude list)
 #    $timeStampFile   start time for incremental dump
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
            . ' $I_option -U $userName -E -N -d 1'
             . ' -c tarmode\\ full -Tc$X_option - $fileList';
@@ -948,6 +960,10 @@ $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
 #
 # Same variable substitutions are applied as $Conf{SmbClientFullCmd}.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
            . ' $I_option -U $userName -E -N -d 1'
            . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
@@ -962,6 +978,10 @@ $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
 # You should set $Conf{SmbClientRestoreCmd} to undef and the
 # corresponding CGI restore option will be removed.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
             . ' $I_option -U $userName -E -N -d 1'
             . ' -c tarmode\\ full -Tx -';
@@ -1032,6 +1052,10 @@ $Conf{TarShareName} = '/';
 #
 # This setting only matters if $Conf{XferMethod} = 'tar'.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{TarClientCmd} = '$sshPath -q -x -n -l root $host'
                     . ' env LC_ALL=C $tarPath -c -v -f - -C $shareName+'
                     . ' --totals';
@@ -1089,6 +1113,10 @@ $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
 # $Conf{TarClientRestoreCmd} to undef and the corresponding CGI
 # restore option will be removed.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host'
                   . ' env LC_ALL=C $tarPath -x -p --numeric-owner --same-owner'
                   . ' -v -f - -C $shareName+';
@@ -1138,6 +1166,10 @@ $Conf{RsyncClientCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
 #
 # This setting only matters if $Conf{XferMethod} = 'rsync'.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{RsyncClientRestoreCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
 
 #
@@ -1345,6 +1377,10 @@ $Conf{BackupPCdCmd} = '$bpcdPath $host $shareName $poolDir XXXX $poolCompress $t
 #
 # This setting only matters if $Conf{XferMethod} = 'backuppcd'.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{BackupPCdRestoreCmd} = '$bpcdPath TODO';
 
 
@@ -1413,6 +1449,10 @@ $Conf{ArchiveSplit} = 0;
 #   $archiveloc    The location to put the archive
 #   $parfile       The amount of parity data to create (percentage)
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost'
        . ' $tarCreatePath $splitpath $parpath $host $backupnumber'
        . ' $compression $compext $splitsize $archiveloc $parfile *';
@@ -1442,6 +1482,10 @@ $Conf{NmbLookupPath} = '';
 # This command is only used for DHCP hosts: given an IP address, this
 # command should try to find its NetBios name.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
 
 #
@@ -1469,6 +1513,10 @@ $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
 # Experiment manually for your site to see what form of nmblookup command
 # works.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
 
 #
@@ -1502,6 +1550,10 @@ $Conf{PingPath} = '';
 # exit status (0 even on failure).  Replace with "ping $host 1", which
 # gets the correct exit status but we don't get the round-trip time.
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{PingCmd} = '$pingPath -c 1 $host';
 
 #
@@ -1648,6 +1700,10 @@ $Conf{MaxOldPerPCLogFiles} = 12;
 #        $type         set to "archive"
 #        $cmdType      set to ArchivePreUserCmd or ArchivePostUserCmd
 #
+# Note: all Cmds are executed directly without a shell, so the prog name
+# needs to be a full path and you can't include shell syntax like
+# redirection and pipes; put that in a script if you need it.
+#
 $Conf{DumpPreUserCmd}     = undef;
 $Conf{DumpPostUserCmd}    = undef;
 $Conf{DumpPreShareCmd}    = undef;
@@ -1938,8 +1994,8 @@ $Conf{CgiNavBarLinks} = [
         lname => "Documentation",    # actually displays $Lang->{Documentation}
     },
     {
-        link  => "http://backuppc.sourceforge.net/faq",
-        name  => "FAQ",              # displays literal "FAQ"
+        link  => "http://backuppc.wiki.sourceforge.net",
+        name  => "Wiki",              # displays literal "Wiki"
     },
     {
         link  => "http://backuppc.sourceforge.net",