# Each night, at the first wakeup listed in $Conf{WakeupSchedule},
# BackupPC_nightly is run. Its job is to remove unneeded files
# in the pool, ie: files that only have one link. To avoid race
-# conditions, BackupPC_nightly runs only when there are no backups
-# running, and no backups will start while it runs.
+# conditions, BackupPC_nightly and BackupPC_link cannot run at
+# the same time. Starting in v3.0.0, BackupPC_nightly can run
+# concurrently with backups (BackupPC_dump).
#
# So to reduce the elapsed time, you might want to increase this
# setting to run several BackupPC_nightly processes in parallel
# $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';
#
# . ' $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} = '';
#
$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.
# $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';
#
# 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';
# 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 -';
#
# 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';
# $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+';
#
# 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+';
#
#
# 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';
# $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 *';
# 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';
#
# 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';
#
# 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';
#
# $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;
#
# 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.
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",
BlackoutPeriods => 1,
BackupZeroFilesIsFatal => 1,
ClientCharset => 1,
+ ClientCharsetLegacy => 1,
XferMethod => 1,
XferLogLevel => 1,
SmbShareName => 1,
projects / BackupPC.git / blobdiff