Localized the 'full' and 'incremental' string in the start stop backup module.
[BackupPC.git] / conf / config.pl
index 0c661a1..8c58140 100644 (file)
@@ -29,7 +29,7 @@
 #   Craig Barratt  <cbarratt@users.sourceforge.net>
 #
 # COPYRIGHT
-#   Copyright (C) 2001  Craig Barratt
+#   Copyright (C) 2001-2003  Craig Barratt
 #
 #   See http://backuppc.sourceforge.net.
 #
@@ -152,6 +152,24 @@ $Conf{MaxOldLogFiles} = 14;
 #
 $Conf{DfPath} = '/bin/df';
 
+#
+# Command to run df.  The following variables are substituted at run-time:
+#
+#   $dfPath      path to df ($Conf{DfPath})
+#   $topDir      top-level BackupPC data directory
+#
+$Conf{DfCmd} = '$dfPath $topDir';
+
+#
+# Full path to various commands for archiving
+#
+
+$Conf{SplitPath} = '/usr/bin/split';
+$Conf{ParPath}   = '/usr/bin/par';
+$Conf{CatPath}   = '/bin/cat';
+$Conf{GzipPath}  = '/bin/gzip';
+$Conf{Bzip2Path} = '/usr/bin/bzip2';
+
 #
 # Maximum threshold for disk utilization on the __TOPDIR__ filesystem.
 # If the output from $Conf{DfPath} reports a percentage larger than
@@ -172,6 +190,8 @@ $Conf{TrashCleanSleepSec} = 300;
 #
 # List of DHCP address ranges we search looking for PCs to backup.
 # This is an array of hashes for each class C address range.
+# This is only needed if hosts in the conf/hosts file have the
+# dhcp flag set.
 #
 # Examples:
 #    # to specify 192.10.10.20 to 192.10.10.250 as the DHCP address pool
@@ -218,6 +238,17 @@ $Conf{InstallDir}   = '';
 #
 $Conf{BackupPCUserVerify} = 1;
 
+#
+# Maximum number of hardlinks supported by the $TopDir file system
+# that BackupPC uses.  Most linux or unix file systems should support
+# at least 32000 hardlinks per file, or 64K in other cases.  If a pool
+# file already has this number of hardlinks, a new pool file is created
+# so that new hardlinks can be accommodated.  This limit will only
+# be hit if an identical file appears at least this number of times
+# across all the backups.
+#
+$Conf{HardLinkMax} = 31999;
+
 ###########################################################################
 # What to backup and when to do it
 # (can be overridden in the per-PC config.pl)
@@ -242,7 +273,7 @@ $Conf{SmbShareName} = 'C$';
 $Conf{SmbShareUserName} = '';
 
 #
-# Smbclient share password.  This is passed to smbclient via the PASSWD
+# Smbclient share password.  This is passed to smbclient via its PASSWD
 # environment variable.  There are several ways you can tell BackupPC
 # the smb share password.  In each case you should be very careful about
 # security.  If you put the password here, make sure that this file is
@@ -272,6 +303,14 @@ $Conf{SmbSharePasswd} = '';
 # use this option instead of $Conf{TarShareName} since a new tar is
 # run for each entry in $Conf{TarShareName}.
 #
+# On the other hand, if you add --one-file-system to $Conf{TarClientCmd}
+# you can backup each file system separately, which makes restoring one
+# bad file system easier.  In this case you would list all of the mount
+# points here, since you can't get the same result with
+# $Conf{BackupFilesOnly}:
+#
+#     $Conf{TarShareName} = ['/', '/var', '/data', '/boot'];
+#
 # This setting only matters if $Conf{XferMethod} = 'tar'.
 #
 $Conf{TarShareName} = '/';
@@ -286,6 +325,22 @@ $Conf{TarShareName} = '/';
 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
 # will make the actual backup interval a bit longer.
 #
+# There are two special values for $Conf{FullPeriod}:
+#
+#   -1   Don't do any regular backups on this machine.  Manually
+#        requested backups (via the CGI interface) will still occur.
+#
+#   -2   Don't do any backups on this machine.  Manually requested
+#        backups (via the CGI interface) will be ignored.
+#
+# These special settings are useful for a client that is no longer
+# being backed up (eg: a retired machine), but you wish to keep the
+# last backups available for browsing or restoring to other machines.
+#
+# Also, you might create a virtual client (by setting $Conf{ClientNameAlias})
+# for restoring to a DVD or permanent media and you would set
+# $Conf{FullPeriod} to -2 so that it is never backed up.
+#
 $Conf{FullPeriod} = 6.97;
 
 #
@@ -377,6 +432,13 @@ $Conf{IncrFill} = 0;
 #
 $Conf{RestoreInfoKeepCnt} = 10;
 
+#
+# Number of archive logs to keep.  BackupPC remembers information about
+# each archive request.  This number per archive client will be kept around before
+# the oldest ones are pruned.
+#
+$Conf{ArchiveInfoKeepCnt} = 10;
+
 #
 # List of directories or files to backup.  If this is defined, only these
 # directories or files will be backed up.
@@ -400,7 +462,7 @@ $Conf{RestoreInfoKeepCnt} = 10;
 #    $Conf{BackupFilesOnly} = {
 #       'c' => ['/myFiles', '/important'],      # these are for 'c' share
 #       'd' => ['/moreFiles', '/archive'],      # these are for 'd' share
-#    }
+#    };
 #
 $Conf{BackupFilesOnly} = undef;
 
@@ -425,9 +487,13 @@ $Conf{BackupFilesOnly} = undef;
 # For tar, if the exclude file contains a "/" it is assumed to be anchored
 # at the start of the string.  Since all the tar paths start with "./",
 # BackupPC prepends a "." if the exclude file starts with a "/".  Note
-# that GNU tar version >= 1.3.7 is required for the exclude option to
-# work correctly.  For linux or unix machines it is recommended to add
-# "/proc" to $Conf{BackupFilesExclude}.
+# that GNU tar version >= 1.13.7 is required for the exclude option to
+# work correctly.  For linux or unix machines you should add
+# "/proc" to $Conf{BackupFilesExclude} unless you have specified
+# --one-file-system in $Conf{TarClientCmd} or --one-file-system in
+# $Conf{RsyncArgs}.  Also, for tar, do not use a trailing "/" in
+# the directory name: a trailing "/" causes the name to not match
+# and the directory will not be excluded.
 #
 # Examples:
 #    $Conf{BackupFilesExclude} = '/temp';
@@ -436,7 +502,7 @@ $Conf{BackupFilesOnly} = undef;
 #    $Conf{BackupFilesExclude} = {
 #       'c' => ['/temp', '/winnt/tmp'],         # these are for 'c' share
 #       'd' => ['/junk', '/dont_back_this_up'], # these are for 'd' share
-#    }
+#    };
 #
 $Conf{BackupFilesExclude} = undef;
 
@@ -481,6 +547,14 @@ $Conf{BlackoutHourBegin}    = 7.0;
 $Conf{BlackoutHourEnd}      = 19.5;
 $Conf{BlackoutWeekDays}     = [1, 2, 3, 4, 5];
 
+#
+# A backup of a share that has zero files is considered fatal. This is
+# used to catch miscellaneous Xfer errors that result in no files being
+# backed up.  If you have shares that might be empty (and therefore an
+# empty backup is valid) you should set this flag to 0.
+#
+$Conf{BackupZeroFilesIsFatal} = 1;
+
 ###########################################################################
 # General per-PC configuration settings
 # (can be overridden in the per-PC config.pl)
@@ -492,13 +566,18 @@ $Conf{BlackoutWeekDays}     = [1, 2, 3, 4, 5];
 #
 # The valid values are:
 #
-#   - 'smb': use smbclient and the SMB protocol.  Only choice for WinXX.
+#   - 'smb':    backup and restore via smbclient and the SMB protocol.
+#               Best choice for WinXX.
 #
-#   - 'tar': use tar, tar over ssh, rsh or nfs.  Best choice for
-#            linux/unix.
+#   - 'rsync':  backup and restore via rsync (via rsh or ssh).
+#               Best choice for linux/unix.  Can also work on WinXX.
 #
-# A future version should support 'rsync' as a transport method for
-# more efficient backup of linux/unix machines (and perhaps WinXX??).
+#   - 'rsyncd': backup and restre via rsync daemon on the client.
+#               Best choice for linux/unix if you have rsyncd running on
+#               the client.  Can also work on WinXX.
+#
+#   - 'tar':    backup and restore via tar, tar over ssh, rsh or nfs.
+#               Good choice for linux/unix.
 #
 $Conf{XferMethod} = 'smb';
 
@@ -515,17 +594,32 @@ $Conf{XferMethod} = 'smb';
 $Conf{SmbClientPath} = '/usr/bin/smbclient';
 
 #
-# Additional optional arguments to smbclient.
+# Commands to run smbclient for a full dump, incremental dump or a restore.
+# This setting only matters if $Conf{XferMethod} = 'smb'.
 #
-# Some users have reported that the -b option can be used to improve
-# performance of smbclient.  The default value is 4096, and if you
-# find smbclient has low throughput you might try a value of 2048, eg:
+# The following variables are substituted at run-time:
 #
-#     $Conf{SmbClientArgs} = '-b 2048';
+#    $smbClientPath   same as $Conf{SmbClientPath}
+#    $host            host to backup/restore
+#    $hostIP          host IP address
+#    $shareName       share name
+#    $userName        user name
+#    $fileList        list of files to backup (based on exclude/include)
+#    $I_option        optional -I option to smbclient
+#    $X_option        exclude option (if $fileList is an exclude list)
+#    $timeStampFile   start time for incremental dump
 #
-# This setting only matters if $Conf{XferMethod} = 'smb'.
-#
-$Conf{SmbClientArgs} = '';
+$Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
+           . ' $I_option -U $userName -E -N -d 1'
+            . ' -c tarmode\\ full -Tc$X_option - $fileList';
+
+$Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
+           . ' $I_option -U $userName -E -N -d 1'
+           . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
+
+$Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
+            . ' $I_option -U $userName -E -N -d 1'
+            . ' -c tarmode\\ full -Tx -';
 
 #
 # Full command to run tar on the client.  GNU tar is required.  You will
@@ -546,8 +640,7 @@ $Conf{SmbClientArgs} = '';
 # are sufficient to read all the files you want to backup.  Also, you
 # will probably want to add "/proc" to $Conf{BackupFilesExclude}.
 #
-# Several variables are substituted at run-time.  The following variables
-# are substituted at run-time:
+# The following variables are substituted at run-time:
 #
 #   $host        host name
 #   $hostIP      host's IP address
@@ -571,6 +664,9 @@ $Conf{TarClientCmd} = '$sshPath -q -n -l root $host'
 # Extra tar arguments for full backups.  Several variables are substituted at
 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
 #
+# If you are running tar locally (ie: without rsh or ssh) then remove the
+# "+" so that the argument is no longer shell escaped.
+#
 # This setting only matters if $Conf{XferMethod} = 'tar'.
 #
 $Conf{TarFullArgs} = '$fileList+';
@@ -597,6 +693,9 @@ $Conf{TarFullArgs} = '$fileList+';
 #          attribute change, meaning the file will always be included
 #          in each new incremental dump.
 #
+# If you are running tar locally (ie: without rsh or ssh) then remove the
+# "+" so that the argument is no longer shell escaped.
+#
 # This setting only matters if $Conf{XferMethod} = 'tar'.
 #
 $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
@@ -622,6 +721,220 @@ $Conf{TarClientRestoreCmd} = '$sshPath -q -l root $host'
 #
 $Conf{TarClientPath} = '/bin/tar';
 
+#
+# Path to rsync executable on the client
+#
+$Conf{RsyncClientPath} = '/bin/rsync';
+
+#
+# Full command to run rsync on the client machine.  The following variables
+# are substituted at run-time:
+#
+#        $host           host name being backed up
+#        $hostIP         host's IP address
+#        $shareName      share name to backup (ie: top-level directory path)
+#        $rsyncPath      same as $Conf{RsyncClientPath}
+#        $sshPath        same as $Conf{SshPath}
+#        $argList        argument list, built from $Conf{RsyncArgs},
+#                        $shareName, $Conf{BackupFilesExclude} and
+#                        $Conf{BackupFilesOnly}
+#
+# This setting only matters if $Conf{XferMethod} = 'rsync'.
+#
+$Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList+';
+
+#
+# Full command to run rsync for restore on the client.  The following
+# variables are substituted at run-time:
+#
+#        $host           host name being backed up
+#        $hostIP         host's IP address
+#        $shareName      share name to backup (ie: top-level directory path)
+#        $rsyncPath      same as $Conf{RsyncClientPath}
+#        $sshPath        same as $Conf{SshPath}
+#        $argList        argument list, built from $Conf{RsyncArgs},
+#                        $shareName, $Conf{BackupFilesExclude} and
+#                        $Conf{BackupFilesOnly}
+#
+# This setting only matters if $Conf{XferMethod} = 'rsync'.
+#
+$Conf{RsyncClientRestoreCmd} = '$sshPath -l root $host $rsyncPath $argList+';
+
+#
+# Share name to backup.  For $Conf{XferMethod} = "rsync" this should
+# be a file system path, eg '/' or '/home'.
+#
+# For $Conf{XferMethod} = "rsyncd" this should be the name of the module
+# to backup (ie: the name from /etc/rsynd.conf).
+#
+# This can also be a list of multiple file system paths or modules.
+# For example, by adding --one-file-system to $Conf{RsyncArgs} you
+# can backup each file system separately, which makes restoring one
+# bad file system easier.  In this case you would list all of the mount
+# points:
+#
+#     $Conf{RsyncShareName} = ['/', '/var', '/data', '/boot'];
+#
+$Conf{RsyncShareName} = '/';
+
+#
+# Rsync daemon port on the client, for $Conf{XferMethod} = "rsyncd".
+#
+$Conf{RsyncdClientPort} = 873;
+
+#
+# Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
+# The user name and password are stored on the client in whatever file
+# the "secrets file" parameter in rsyncd.conf points to
+# (eg: /etc/rsyncd.secrets).
+#
+$Conf{RsyncdUserName} = '';
+
+#
+# Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
+# The user name and password are stored on the client in whatever file
+# the "secrets file" parameter in rsyncd.conf points to
+# (eg: /etc/rsyncd.secrets).
+#
+$Conf{RsyncdPasswd} = '';
+
+#
+# Whether authentication is mandatory when connecting to the client's
+# rsyncd.  By default this is on, ensuring that BackupPC will refuse to
+# connect to an rsyncd on the client that is not password protected.
+# Turn off at your own risk.
+#
+$Conf{RsyncdAuthRequired} = 1;
+
+#
+# Arguments to rsync for backup.  Do not edit the first set unless you
+# have a thorough understanding of how File::RsyncP works.
+#
+# Examples of additional arguments that should work are --exclude/--include,
+# eg:
+#
+#     $Conf{RsyncArgs} = [
+#           # original arguments here
+#           '-v',
+#           '--exclude', '/proc',
+#           '--exclude', '*.tmp',
+#     ];
+#
+$Conf{RsyncArgs} = [
+           #
+           # Do not edit these!
+           #
+            '--numeric-ids',
+            '--perms',
+            '--owner',
+            '--group',
+            '--devices',
+            '--links',
+            '--times',
+            '--block-size=2048',
+            '--recursive',
+           #
+           # Add additional arguments here
+           #
+];
+
+#
+# Arguments to rsync for restore.  Do not edit the first set unless you
+# have a thorough understanding of how File::RsyncP works.
+#
+#
+$Conf{RsyncRestoreArgs} = [
+           #
+           # Do not edit these!
+           #
+           "--numeric-ids",
+           "--perms",
+           "--owner",
+           "--group",
+           "--devices",
+           "--links",
+           "--times",
+           "--block-size=2048",
+           "--relative",
+           "--ignore-times",
+           "--recursive",
+           #
+           # Add additional arguments here
+           #
+];
+
+#
+# Amount of verbosity in Rsync Xfer log files.  0 means be quiet,
+# 1 will give will give one line per file, 2 will also show skipped
+# files on incrementals, higher values give more output.  10 will
+# include byte dumps of all data read/written, which will make the
+# log files huge.
+#
+$Conf{RsyncLogLevel} = 1;
+
+#
+# Archive Destination
+#
+# The Destination of the archive
+# e.g. /tmp for file archive or /dev/nst0 for device archive
+#
+$Conf{ArchiveDest} = '/tmp';
+
+#
+# Archive Compression type
+#
+# The valid values are:
+#
+#   - 'none':  No Compression
+#
+#   - 'gzip':  Medium Compression. Recommended.
+#
+#   - 'bzip2': High Compression but takes longer.
+#
+$Conf{ArchiveComp} = 'gzip';
+
+#
+# Archive Parity Files
+#
+# The number of Parity Files to generate.
+# Uses the commandline par available from
+# http://parchive.sourceforge.net
+#
+# Only useful for file dumps.
+#
+# Set to 0 to disable this feature.
+#
+$Conf{ArchivePar} = 0;
+
+#
+# Archive Size Split
+#
+# Only for file archives. Splits the output into 
+# the specified size * 1,000,000.
+# e.g. to split into 650,000,000 bytes, specify 650 below.
+#
+$Conf{ArchiveSplit} = 650;
+
+#
+# Archive Command
+#
+# This is the command that is called to actually run the archive process
+#  The following variables are substituted at run-time:
+#
+#   $Installdir    The installation directory of BackupPC
+#   $tarCreatePath The path to BackupPC_tarCreate
+#   $splitpath     The path to the split program
+#   $parpath       The path to the par program
+#   $host          The host to archive
+#   $backupnumber  The backup number of the host to archive
+#   $compression   The path to the compression program
+#   $compext       The extension assigned to the compression type
+#   $splitsize     The number of bytes to split archives into
+#   $archiveloc    The location to put the archive
+#   $parfile       The number of par files to create
+#
+$Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archivecd $tarCreatePath $splitpath $parpath $host $backupnumber $compression $compext $splitsize $archiveloc $parfile /';
+
 #
 # Full path for ssh. Security caution: normal users should not
 # allowed to write to this file or directory.
@@ -637,6 +950,45 @@ $Conf{SshPath} = '/usr/bin/ssh';
 #
 $Conf{NmbLookupPath} = '/usr/bin/nmblookup';
 
+#
+# NmbLookup command.  Given an IP address, does an nmblookup on that
+# IP address.  The following variables are substituted at run-time:
+#
+#   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
+#   $host               IP address
+#
+# This command is only used for DHCP hosts: given an IP address, this
+# command should try to find its NetBios name.
+#
+$Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
+
+#
+# NmbLookup command.  Given a netbios name, finds that host by doing
+# a NetBios lookup.  Several variables are substituted at run-time:
+#
+#   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
+#   $host               NetBios name
+#
+# In some cases you might need to change the broadcast address, for
+# example if nmblookup uses 192.168.255.255 by default and you find
+# that doesn't work, try 192.168.1.255 (or your equivalent class C
+# address) using the -B option:
+#
+#    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -B 192.168.1.255 $host';
+#
+# If you use a WINS server and your machines don't respond to
+# multicast NetBios requests you can use this (replace 1.2.3.4
+# with the IP address of your WINS server):
+#
+#    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -R -U 1.2.3.4 $host';
+#
+# This is preferred over multicast since it minimizes network traffic.
+#
+# Experiment manually for your site to see what form of nmblookup command
+# works.
+#
+$Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
+
 #
 # For fixed IP address hosts, BackupPC_dump can also verify the netbios
 # name to ensure it matches the host name.  An error is generated if
@@ -659,9 +1011,35 @@ $Conf{FixedIPNetBiosNameCheck} = 0;
 $Conf{PingPath} = '/bin/ping';
 
 #
-# Options for the ping command.
+# Ping command.  The following variables are substituted at run-time:
+#
+#   $pingPath      path to ping ($Conf{PingPath})
+#   $host          host name
+#
+# Wade Brown reports that on solaris 2.6 and 2.7 ping -s returns the wrong
+# 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.
+#
+$Conf{PingCmd} = '$pingPath -c 1 $host';
+
+#
+# Path to init.d script and command to use that script to start the
+# server from the CGI interface.  The following variables are substituted
+# at run-time:
+#
+#   $sshPath           path to ssh ($Conf{SshPath})
+#   $serverHost        same as $Conf{ServerHost}
+#   $serverInitdPath   path to init.d script ($Conf{ServerInitdPath})
+#
+# Example:
+#
+# $Conf{ServerInitdPath}     = '/etc/init.d/backuppc';
+# $Conf{ServerInitdStartCmd} = '$sshPath -l root $serverHost'
+#                            . ' $serverInitdPath start'
+#                            . ' < /dev/null >& /dev/null';
 #
-$Conf{PingArgs} = '-c 1 $host';
+$Conf{ServerInitdPath} = '';
+$Conf{ServerInitdStartCmd} = '';
 
 #
 # Compression level to use on files.  0 means no compression.  Compression
@@ -719,7 +1097,7 @@ $Conf{PingMaxMsec} = 20;
 # Despite the name, this parameter sets the timeout for all transport
 # methods (tar, smb etc).
 #
-$Conf{SmbClientTimeout} = 7200;
+$Conf{ClientTimeout} = 7200;
 
 #
 # Maximum number of log files we keep around in each PC's directory
@@ -734,6 +1112,103 @@ $Conf{SmbClientTimeout} = 7200;
 #
 $Conf{MaxOldPerPCLogFiles} = 12;
 
+#
+# Optional commands to run before and after dumps and restores.
+# Stdout from these commands will be written to the Xfer (or Restore)
+# log file.  One example of using these commands would be to
+# shut down and restart a database server, or to dump a database
+# to files for backup.  Example:
+#
+#    $Conf{DumpPreUserCmd} = '$sshPath -l root $host /usr/bin/dumpMysql';
+#
+# The following variable substitutions are made at run time for
+# $Conf{DumpPreUserCmd} and $Conf{DumpPostUserCmd}:
+#
+#        $type         type of dump (incr or full)
+#        $xferOK       1 if the dump succeeded, 0 if it didn't
+#        $client       client name being backed up
+#        $host         host name (could be different from client name if
+#                                 $Conf{ClientNameAlias} is set)
+#        $hostIP       IP address of host
+#        $user         user name from the hosts file
+#        $moreUsers    list of additional users from the hosts file
+#        $share        the first share name
+#        $shares       list of all the share names
+#        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
+#        $sshPath      value of $Conf{SshPath},
+#
+# The following variable substitutions are made at run time for
+# $Conf{RestorePreUserCmd} and $Conf{RestorePostUserCmd}:
+#
+#        $client       client name being backed up
+#        $xferOK       1 if the restore succeeded, 0 if it didn't
+#        $host         host name (could be different from client name if
+#                                 $Conf{ClientNameAlias} is set)
+#        $hostIP       IP address of host
+#        $user         user name from the hosts file
+#        $moreUsers    list of additional users from the hosts file
+#        $share        the first share name
+#        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
+#        $sshPath      value of $Conf{SshPath},
+#        $type         set to "restore"
+#        $bkupSrcHost  host name of the restore source
+#        $bkupSrcShare share name of the restore source
+#        $bkupSrcNum   backup number of the restore source
+#        $pathHdrSrc   common starting path of restore source
+#        $pathHdrDest  common starting path of destination
+#        $fileList     list of files being restored
+#
+# The following variable substitutions are made at run time for
+# $Conf{ArchivePreUserCmd} and $Conf{ArchivePostUserCmd}:
+#
+#        $client       client name being backed up
+#        $xferOK       1 if the archive succeeded, 0 if it didn't
+#        $host         Name of the archive host
+#        $user         user name from the hosts file
+#        $share        the first share name
+#        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
+#        $HostList     list of hosts being archived
+#        $BackupList   list of backup numbers for the hosts being archived
+#        $archiveloc   location where the archive is sent to
+#        $parfile      number of par files being generated
+#        $compression  compression program being used (eg: cat, gzip, bzip2)
+#        $compext      extension used for compression type (eg: raw, gz, bz2)
+#        $splitsize    size of the files that the archive creates
+#        $sshPath      value of $Conf{SshPath},
+#        $type         set to "archive"
+#
+$Conf{DumpPreUserCmd}     = undef;
+$Conf{DumpPostUserCmd}    = undef;
+$Conf{RestorePreUserCmd}  = undef;
+$Conf{RestorePostUserCmd} = undef;
+$Conf{ArchivePreUserCmd}  = undef;
+$Conf{ArchivePostUserCmd} = undef;
+
+#
+# Override the client's host name.  This allows multiple clients
+# to all refer to the same physical host.  This should only be
+# set in the per-PC config file and is only used by BackupPC at
+# the last moment prior to generating the command used to backup
+# that machine (ie: the value of $Conf{ClientNameAlias} is invisible
+# everywhere else in BackupPC).  The setting can be a host name or
+# IP address, eg:
+#
+#         $Conf{ClientNameAlias} = 'realHostName';
+#         $Conf{ClientNameAlias} = '192.1.1.15';
+#
+# will cause the relevant smb/tar/rsync backup/restore commands to be
+# directed to realHostName, not the client name.
+#
+# Note: this setting doesn't work for hosts with DHCP set to 1.
+#
+$Conf{ClientNameAlias} = undef;
+
+#
+# Advanced option for asking BackupPC to load additional perl modules.
+# Can be a list (array ref) of module names to load at startup.
+#
+$Conf{PerlModuleLoad}     = undef;
+
 ###########################################################################
 # Email reminders, status and messages
 # (can be overridden in the per-PC config.pl)
@@ -770,38 +1245,36 @@ $Conf{EMailFromUserName} = '';
 $Conf{EMailAdminUserName} = '';
 
 #
-# This message is sent to a user if their PC has never been backed up.
-# If your mailer needs a fully-qualified To name, then change "$user"
-# to "$user@mydomain.com" in the template, eg:
+# Destination domain name for email sent to users.  By default
+# this is empty, meaning email is sent to plain, unqualified
+# addresses.  Otherwise, set it to the destintation domain, eg:
 #
-#      To: $user@mydomain.com
+#    $Cong{EMailUserDestDomain} = '@mydomain.com';
 #
-$Conf{EMailNoBackupEverMesg} = <<'EOF';
-To: $user
-cc:
-Subject: $subj
-
-Dear $userName,
-
-Your PC ($host) has never been successfully backed up by our
-PC backup software.  PC backups should occur automatically
-when your PC is connected to the network.  You should contact
-computer support if:
-
-  - Your PC has been regularly connected to the network, meaning
-    there is some configuration or setup problem preventing
-    backups from occurring.
-
-  - You don't want your PC backed up and you want these email
-    messages to stop.
-
-Otherwise, please make sure your PC is connected to the network
-next time you are in the office.
+# With this setting user email will be set to 'user@mydomain.com'.
+#
+$Conf{EMailUserDestDomain} = '';
 
-Regards,
-BackupPC Genie
-http://backuppc.sourceforge.net
-EOF
+#
+# This subject and message is sent to a user if their PC has never been
+# backed up.
+#
+# These values are language-dependent.  The default versions can be
+# found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
+# need to change the message, copy it here and edit it, eg:
+#
+#   $Conf{EMailNoBackupEverMesg} = <<'EOF';
+#   To: $user$domain
+#   cc:
+#   Subject: $subj
+#   
+#   Dear $userName,
+#   
+#   This is a site-specific email message.
+#   EOF
+#
+$Conf{EMailNoBackupEverSubj} = undef;
+$Conf{EMailNoBackupEverMesg} = undef;
 
 #
 # How old the most recent backup has to be before notifying user.
@@ -811,40 +1284,25 @@ EOF
 $Conf{EMailNotifyOldBackupDays} = 7.0;
 
 #
-# This message is sent to a user if their PC has not recently been
-# backed up (ie: more than $Conf{EMailNotifyOldBackupDays} days ago).
+# This subject and message is sent to a user if their PC has not recently
+# been backed up (ie: more than $Conf{EMailNotifyOldBackupDays} days ago).
 #
-# If your mailer needs a fully-qualified To name, then change "$user"
-# to "$user@mydomain.com" in the template, eg:
+# These values are language-dependent.  The default versions can be
+# found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
+# need to change the message, copy it here and edit it, eg:
 #
-#      To: $user@mydomain.com
+#   $Conf{EMailNoBackupRecentMesg} = <<'EOF';
+#   To: $user$domain
+#   cc:
+#   Subject: $subj
+#   
+#   Dear $userName,
+#   
+#   This is a site-specific email message.
+#   EOF
 #
-$Conf{EMailNoBackupRecentMesg} = <<'EOF';
-To: $user
-cc:
-Subject: $subj
-
-Dear $userName,
-
-Your PC ($host) has not been successfully backed up for $days days.
-Your PC has been correctly backed up $numBackups times from $firstTime to $days days
-ago.  PC backups should occur automatically when your PC is connected
-to the network.
-
-If your PC has been connected for more than a few hours to the
-network during the last $days days you should contact IS to find
-out why backups are not working.
-
-Otherwise, if you are out of the office, there's not much you can
-do, other than manually copying especially critical files to other
-media.  You should be aware that any files you have created or
-changed in the last $days days (including all new email and
-attachments) cannot be restored if your PC disk crashes.
-
-Regards,
-BackupPC Genie
-http://backuppc.sourceforge.net
-EOF
+$Conf{EMailNoBackupRecentSubj} = undef;
+$Conf{EMailNoBackupRecentMesg} = undef;
 
 #
 # How old the most recent backup of Outlook files has to be before
@@ -853,43 +1311,26 @@ EOF
 $Conf{EMailNotifyOldOutlookDays} = 5.0;
 
 #
-# This message is sent to a user if their Outlook files have not
-# recently been backed up (ie: more than $Conf{EMailNotifyOldOutlookDays}
+# This subject and message is sent to a user if their Outlook files have
+# not recently been backed up (ie: more than $Conf{EMailNotifyOldOutlookDays}
 # days ago).
 #
-# If your mailer needs a fully-qualified To name, then change "$user"
-# to "$user@mydomain.com" in the template, eg:
+# These values are language-dependent.  The default versions can be
+# found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
+# need to change the message, copy it here and edit it, eg:
 #
-#      To: $user@mydomain.com
+#   $Conf{EMailOutlookBackupMesg} = <<'EOF';
+#   To: $user$domain
+#   cc:
+#   Subject: $subj
+#   
+#   Dear $userName,
+#   
+#   This is a site-specific email message.
+#   EOF
 #
-$Conf{EMailOutlookBackupMesg} = <<'EOF';
-To: $user
-cc:
-Subject: $subj
-
-Dear $userName,
-
-The Outlook files on your PC have $howLong.
-These files contain all your email, attachments, contact and calendar
-information.  Your PC has been correctly backed up $numBackups times from
-$firstTime to $lastTime days ago.  However, Outlook locks all its files when
-it is running, preventing these files from being backed up.
-
-It is recommended you backup the Outlook files when you are connected
-to the network by exiting Outlook and all other applications, and,
-using just your browser, go to this link:
-
-    http://myHost/cgi-bin/BackupPC_Admin?host=$host
-
-Select "Start Incr Backup" twice to start a new incremental backup.
-You can select "Return to $host page" and then hit "reload" to check
-the status of the backup.  It should take just a few minutes to
-complete.
-
-Regards,
-BackupPC Genie
-http://backuppc.sourceforge.net
-EOF
+$Conf{EMailOutlookBackupSubj} = undef;
+$Conf{EMailOutlookBackupMesg} = undef;
 
 ###########################################################################
 # CGI user interface configuration settings
@@ -924,6 +1365,21 @@ EOF
 $Conf{CgiAdminUserGroup} = '';
 $Conf{CgiAdminUsers}     = '';
 
+#
+# URL of the BackupPC_Admin CGI script.  Used for email messages.
+#
+$Conf{CgiURL} = undef;
+
+#   
+# Language to use.  See lib/BackupPC/Lang for the list of supported
+# languages, which include English (en), French (fr), Spanish (es),
+# and German (de).
+#
+# Currently the Language setting applies to the CGI interface and email
+# messages sent to users.  Log files and other text is still in English.
+#
+$Conf{Language} = 'en';
+
 #
 # User names that are rendered by the CGI interface can be turned
 # into links into their home page or other information about the
@@ -955,19 +1411,29 @@ $Conf{CgiUserUrlCreate}     = 'mailto:%s';
 $Conf{CgiDateFormatMMDD} = 1;
 
 #
-# Header font and size for CGI interface
+# If set, the complete list of hosts appears in the left navigation
+# bar for administrators.  Otherwise, just the hosts for which the
+# user is listed in the host file (as either the user or in moreUsers)
+# are displayed.
 #
-$Conf{CgiHeaderFontType} = 'arial';
-$Conf{CgiHeaderFontSize} = '3';
+$Conf{CgiNavBarAdminAllHosts} = 0;
 
 #
-# Color scheme for CGI interface.  Default values give a very light blue
-# for the background navigation color and green for the header background.
-# (You call tell I'm a better programmer than graphical designer.)
+# Color scheme for CGI interface.
 #
-$Conf{CgiNavBarBgColor} = '#ddeeee';
 $Conf{CgiHeaderBgColor} = '#99cc33';
 
+#
+# Hilight colors based on status that are used in the PC summary page.
+#
+$Conf{CgiStatusHilightColor} = {
+    Reason_backup_failed           => '#ffcccc',
+    Reason_backup_done             => '#ccffcc',
+    Reason_no_ping                 => '#ffff99',
+    Reason_backup_canceled_by_user => '#ff9900',
+    Status_backup_in_progress      => '#66cc99',
+};
+
 #
 # Additional CGI header text.  For example, if you wanted each CGI page
 # to auto refresh every 900 seconds, you could add this text:
@@ -986,6 +1452,18 @@ $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
 #
 $Conf{CgiImageDir} = '';
 
+#
+# Additional mappings of file name extenions to Content-Type for
+# individual file restore.  See $Ext2ContentType in BackupPC_Admin
+# for the default setting.  You can add additional settings here,
+# or override any default settings.  Example:
+#
+#     $Conf{CgiExt2ContentType} = {
+#                 'pl'  => 'text/plain',
+#          };
+#
+$Conf{CgiExt2ContentType} = { };
+
 #
 # URL (without the leading http://host) for BackupPC's image directory.
 # The CGI script uses this value to serve up image files.
@@ -994,3 +1472,179 @@ $Conf{CgiImageDir} = '';
 #     $Conf{CgiImageDirURL} = '/BackupPC';
 #
 $Conf{CgiImageDirURL} = '';
+
+#
+# CSS stylesheet for the CGI interface.
+#
+$Conf{CSSstylesheet} = <<'EOF';
+<style type="text/css">
+body {
+    font-family:arial,sans-serif;
+    font-size:1em;
+    background-color:#ffffff;
+    margin:2px 5px 0px 2px;
+    height:100%
+}
+
+h1 {
+    font-family:arial,sans-serif;
+    font-size:1.5em;
+    color:#000000
+}
+
+h2 {
+    font-family:arial,sans-serif;
+    font-size:1em;
+    color:#000000
+}
+        
+p {
+    font-family:arial,sans-serif;
+    font-size:.8em
+}
+        
+a {
+    font-family:arial,sans-serif;
+    font-size:1em;
+    color:#3333ff
+}
+        
+a:hover {
+    color:#cc0000;
+    text-decoration:none
+}
+        
+a.NavCurrent {
+    font-weight:bold;
+    padding-left:5px;
+    padding-right:5px;
+}
+        
+a.navbar {
+    padding-left:5px;
+    padding-right:5px;
+}
+
+.h1 {
+    font-family:arial,sans-serif;
+    font-size:1.5em;
+    color:#000000;
+    font-weight:bold;
+    background-color:#99cc33;
+    padding:3px;
+    padding-left:10px
+}
+        
+.h2 {
+    font-family:arial,sans-serif;
+    font-size:1em;
+    color:#000000;
+    font-weight:bold;
+    background-color:#ddeeee;
+    padding:3px;
+    padding-left:10px
+}
+    
+.border {
+    border-bottom:1px solid #000000;
+    border-left:1px dotted #666666
+}
+
+.tableheader {
+    font-weight:bold;
+    background-color:#cccccc
+}
+    
+.fviewheader {
+    font-weight:bold;
+    color:#ffffff;
+    background-color:#999999
+}
+    
+.fviewborder {
+    border-bottom:1px solid #000000;
+    border-left:1px dotted #666666;
+    background-color:#dddddd
+}
+    
+.fviewon {
+    background-color:#cccccc
+}
+
+.fviewoff {
+    background-color:#ffffff
+}
+
+.fview {
+    font-size:13px;
+    font-family:arial,sans-serif;
+    text-decoration:none;
+    line-height:15px
+}
+
+.fviewbold {
+    font-size:13px;
+    font-family:arial,sans-serif;
+    text-decoration:none;
+    line-height:15px;
+    font-weight:bold
+}
+
+.histView {
+    border-bottom:1px solid #000000;
+    border-left:2px solid #ffffff;
+    background-color:#dddddd
+}
+    
+.histViewMis {
+    border-bottom:1px solid #000000;
+    background-color:#ffdddd
+}
+    
+div.NavMenu {
+    width:18%;
+    margin:0px;
+    background-color:#ddeeee;
+}
+             
+div.NavMenu a {
+    font-size:.8em;
+    display:block;
+    margin-left:8px;
+    padding:3px;
+}
+             
+div.NavTitle {
+    padding-left:10px;
+    background-color:#99cc33;
+    font-family:arial,sans-serif;
+    color:#000000;
+    font-weight:bold
+}
+             
+div.HostOn {
+    width:18%;
+    background-color:#ddeeee;
+    padding:3px;
+    padding-left:10px;
+}
+
+div.HostOnContent {
+    background-color:#ddeeee;
+    padding:5px;
+}
+
+div.HostOnContent a {
+    font-size:.8em;
+    display:block;
+}
+
+#Content {
+    float:right;
+    width:80%;
+    left:20%;
+    top:10px;
+    position:absolute;
+}
+</style>
+EOF