* added pl.pm
[BackupPC.git] / conf / config.pl
index af66a76..7113463 100644 (file)
@@ -29,7 +29,7 @@
 #   Craig Barratt  <cbarratt@users.sourceforge.net>
 #
 # COPYRIGHT
-#   Copyright (C) 2001-2003  Craig Barratt
+#   Copyright (C) 2001-2007  Craig Barratt
 #
 #   See http://backuppc.sourceforge.net.
 #
@@ -98,24 +98,22 @@ $Conf{UmaskMode} = 027;
 # you might have only one or two wakeups each night.  This will keep
 # the backup activity after hours.  On the other hand, if you are backing
 # up laptops that are only intermittently connected to the network you
-# will want to have frequent wakeups (eg: hourly) to maximized the chance
+# will want to have frequent wakeups (eg: hourly) to maximize the chance
 # that each laptop is backed up.
 #
 # Examples:
 #     $Conf{WakeupSchedule} = [22.5];         # once per day at 10:30 pm.
-#     $Conf{WakeupSchedule} = [1..23];        # every hour except midnight
 #     $Conf{WakeupSchedule} = [2,4,6,8,10,12,14,16,18,20,22];  # every 2 hours
 #
 # The default value is every hour except midnight.
 #
-# The first entry of $Conf{WakeupSchedule} is when BackupPC_nightly
-# is run.  No other backups can run while BackupPC_nightly is
-# running.  You might want to re-arrange the entries in
-# $Conf{WakeupSchedule} (they don't have to be ascending) so that
-# the first entry is when you want BackupPC_nightly to run
-# (eg: when you don't expect a lot of regular backups to run).
+# The first entry of $Conf{WakeupSchedule} is when BackupPC_nightly is run.
+# You might want to re-arrange the entries in $Conf{WakeupSchedule}
+# (they don't have to be ascending) so that the first entry is when
+# you want BackupPC_nightly to run (eg: when you don't expect a lot
+# of regular backups to run).
 #
-$Conf{WakeupSchedule} = [1..23];
+$Conf{WakeupSchedule} = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23];
 
 #
 # Maximum number of simultaneous backups to run.  If there
@@ -201,7 +199,7 @@ $Conf{MaxOldLogFiles} = 14;
 # Full path to the df command.  Security caution: normal users
 # should not allowed to write to this file or directory.
 #
-$Conf{DfPath} = '/bin/df';
+$Conf{DfPath} = '';
 
 #
 # Command to run df.  The following variables are substituted at run-time:
@@ -214,12 +212,11 @@ $Conf{DfCmd} = '$dfPath $topDir';
 #
 # Full path to various commands for archiving
 #
-
-$Conf{SplitPath} = '/usr/bin/split';
-$Conf{ParPath}   = '/usr/bin/par2';
-$Conf{CatPath}   = '/bin/cat';
-$Conf{GzipPath}  = '/bin/gzip';
-$Conf{Bzip2Path} = '/usr/bin/bzip2';
+$Conf{SplitPath} = '';
+$Conf{ParPath}   = '';
+$Conf{CatPath}   = '';
+$Conf{GzipPath}  = '';
+$Conf{Bzip2Path} = '';
 
 #
 # Maximum threshold for disk utilization on the __TOPDIR__ filesystem.
@@ -648,7 +645,7 @@ $Conf{ArchiveInfoKeepCnt} = 10;
 # the setting is assumed to apply all shares.
 #
 # If a hash is used, a special key "*" means it applies to all
-# shares.
+# shares that don't have a specific entry.
 #
 # Examples:
 #    $Conf{BackupFilesOnly} = '/myFiles';
@@ -698,7 +695,7 @@ $Conf{BackupFilesOnly} = undef;
 # followed by "/*", eg: "/proc/*", instead of just "/proc".
 #
 # If a hash is used, a special key "*" means it applies to all
-# shares.
+# shares that don't have a specific entry.
 #
 # Examples:
 #    $Conf{BackupFilesExclude} = '/temp';
@@ -871,6 +868,17 @@ $Conf{XferLogLevel} = 1;
 #
 $Conf{ClientCharset} = '';
 
+#
+# Prior to 3.x no charset conversion was done by BackupPC.  Backups were
+# stored in what ever charset the XferMethod provided - typically utf8
+# for smbclient and the client's locale settings for rsync and tar (eg:
+# cp1252 for rsync on WinXX and perhaps iso-8859-1 with rsync on linux).
+# This setting tells BackupPC the charset that was used to store file
+# names in old backups taken with BackupPC 2.x, so that non-ascii file
+# names in old backups can be viewed and restored.
+#
+$Conf{ClientCharsetLegacy} = 'iso-8859-1';
+
 #
 # Name of the host share that is backed up when using SMB.  This can be a
 # string or an array of strings if there are multiple shares per host.
@@ -912,7 +920,7 @@ $Conf{SmbSharePasswd} = '';
 #
 # This setting only matters if $Conf{XferMethod} = 'smb'.
 #
-$Conf{SmbClientPath} = '/usr/bin/smbclient';
+$Conf{SmbClientPath} = '';
 
 #
 # Command to run smbclient for a full dump.
@@ -1091,12 +1099,12 @@ $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host'
 #
 # This setting only matters if $Conf{XferMethod} = 'tar'.
 #
-$Conf{TarClientPath} = '/bin/tar';
+$Conf{TarClientPath} = '';
 
 #
 # Path to rsync executable on the client
 #
-$Conf{RsyncClientPath} = '/bin/rsync';
+$Conf{RsyncClientPath} = '';
 
 #
 # Full command to run rsync on the client machine.  The following variables
@@ -1181,7 +1189,7 @@ $Conf{RsyncdAuthRequired} = 1;
 #
 # When rsync checksum caching is enabled (by adding the
 # --checksum-seed=32761 option to $Conf{RsyncArgs}), the cached
-# checksums can be occaisonally verified to make sure the file
+# checksums can be occasionally verified to make sure the file
 # contents matches the cached checksums.  This is to avoid the
 # risk that disk problems might cause the pool file contents to
 # get corrupted, but the cached checksums would make BackupPC
@@ -1231,9 +1239,11 @@ $Conf{RsyncArgs} = [
             '--recursive',
 
            #
-           # If you are using a patched client rsync that supports the
-           # --checksum-seed option (see http://backuppc.sourceforge.net),
-           # then uncomment this to enabled rsync checksum cachcing
+           # Rsync >= 2.6.3 supports the --checksum-seed option
+            # which allows rsync checksum caching on the server.
+           # Uncomment this to enable rsync checksum caching if
+            # you have a recent client rsync version and you want
+            # to enable checksum caching.
            #
            #'--checksum-seed=32761',
 
@@ -1268,9 +1278,11 @@ $Conf{RsyncRestoreArgs} = [
            '--recursive',
 
            #
-           # If you are using a patched client rsync that supports the
-           # --checksum-seed option (see http://backuppc.sourceforge.net),
-           # then uncomment this to enabled rsync checksum cachcing
+           # Rsync >= 2.6.3 supports the --checksum-seed option
+            # which allows rsync checksum caching on the server.
+           # Uncomment this to enable rsync checksum caching if
+            # you have a recent client rsync version and you want
+            # to enable checksum caching.
            #
            #'--checksum-seed=32761',
 
@@ -1293,7 +1305,7 @@ $Conf{BackupPCdShareName} = '/';
 #
 # Path to backuppcd executable on the server
 #
-$Conf{BackupPCdPath} = '/usr/bin/backuppcd';
+$Conf{BackupPCdPath} = '';
 
 #
 # Full command to run backuppcd on the server to backup a given
@@ -1409,7 +1421,7 @@ $Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost'
 # Full path for ssh. Security caution: normal users should not
 # allowed to write to this file or directory.
 #
-$Conf{SshPath} = '/usr/bin/ssh';
+$Conf{SshPath} = '';
 
 #
 # Full path for nmblookup. Security caution: normal users should not
@@ -1418,7 +1430,7 @@ $Conf{SshPath} = '/usr/bin/ssh';
 # nmblookup is from the Samba distribution. nmblookup is used to get the
 # netbios name, necessary for DHCP hosts.
 #
-$Conf{NmbLookupPath} = '/usr/bin/nmblookup';
+$Conf{NmbLookupPath} = '';
 
 #
 # NmbLookup command.  Given an IP address, does an nmblookup on that
@@ -1478,7 +1490,7 @@ $Conf{FixedIPNetBiosNameCheck} = 0;
 #
 #     $Conf{PingPath} = '/bin/echo';
 #
-$Conf{PingPath} = '/bin/ping';
+$Conf{PingPath} = '';
 
 #
 # Ping command.  The following variables are substituted at run-time:
@@ -1695,7 +1707,7 @@ $Conf{ClientNameAlias} = undef;
 # Full path to the sendmail command.  Security caution: normal users
 # should not allowed to write to this file or directory.
 #
-$Conf{SendmailPath} = '/usr/sbin/sendmail';
+$Conf{SendmailPath} = '';
 
 #
 # Minimum period between consecutive emails to a single user.
@@ -1861,8 +1873,8 @@ $Conf{CgiURL} = undef;
 #   
 # Language to use.  See lib/BackupPC/Lang for the list of supported
 # languages, which include English (en), French (fr), Spanish (es),
-# German (de), Italian (it), Dutch (nl) and Portuguese Brazillian
-# (pt_br).
+# German (de), Italian (it), Dutch (nl), Polish (pl), Portuguese
+# Brazillian (pt_br) and Chinese (zh_CH).
 #
 # Currently the Language setting applies to the CGI interface and email
 # messages sent to users.  Log files and other text are still in English.
@@ -1894,8 +1906,9 @@ $Conf{CgiUserHomePageCheck} = '';
 $Conf{CgiUserUrlCreate}     = 'mailto:%s';
 
 #
-# Date display format for CGI interface.  True for US-style dates (MM/DD)
-# and zero for international dates (DD/MM).
+# Date display format for CGI interface.  A value of 1 uses US-style
+# dates (MM/DD), a value of 2 uses full YYYY-MM-DD format, and zero
+# for international dates (DD/MM).
 #
 $Conf{CgiDateFormatMMDD} = 1;
 
@@ -2032,6 +2045,7 @@ $Conf{CgiUserConfigEdit} = {
         BlackoutPeriods           => 1,
         BackupZeroFilesIsFatal    => 1,
         ClientCharset             => 1,
+        ClientCharsetLegacy       => 1,
         XferMethod                => 1,
         XferLogLevel              => 1,
         SmbShareName              => 1,
@@ -2045,15 +2059,18 @@ $Conf{CgiUserConfigEdit} = {
         TarIncrArgs               => 1,
         TarClientCmd              => 0,
         TarClientRestoreCmd       => 0,
+        TarClientPath             => 0,
         RsyncShareName            => 1,
         RsyncdClientPort          => 1,
         RsyncdPasswd              => 1,
+        RsyncdUserName            => 1,
         RsyncdAuthRequired        => 1,
         RsyncCsumCacheVerifyProb  => 1,
         RsyncArgs                 => 1,
         RsyncRestoreArgs          => 1,
         RsyncClientCmd            => 0,
         RsyncClientRestoreCmd     => 0,
+        RsyncClientPath           => 0,
         ArchiveDest               => 1,
         ArchiveComp               => 1,
         ArchivePar                => 1,