File storeBackup-1.19.config.default of Package storeBackup

# configuration file for storeBackup.pl

# the file format is very simple:
# if you specify a path, you have to quote the following characters:
# backslash ->  '\\'
# lf        ->  '\n'
# tab       ->  '\t'
# space     ->  '\ '
# this replacement is done for the following options:
# sourceDir, targetDir, logFile, lockFile, userGroupStatFile,
# logInBackupDirFileName, compressWith, exceptDirs
#
# If the options to one key a spread over multiple lines, continuation
# lines have to begin with a white space (blank or tab)! An option
# (like 'sourceDirs') has to begin in the first column.
#
# you can use single quotes to mask special characters

# source directory (*** must be specified ***)
sourceDir=

# target directory (*** must be specified ***)
targetDir=

# directory for temporary file, default is /tmp
tmpDir=

# List of other backup directories to consider for
# hard linking. Format (examples):
# /backupDir/2002.08.29_08.25.28 -> consider this backupDir
# or
# 0:/backupDir    -> last (youngest) backup in /backupDir
# 1:/backupDir    -> first before last backup in /backupDir
# n:/backupDir    -> n'th before last backup in /backupDir
# 3-5:/backupDir  -> 3rd, 4th and 5th in /backupDir
# all:/backupDir  -> all in /backupDir
# This option is respective useful, if you want to hard link
# to backup trees from different backups. If you make these
# backups in order (never parallel), you should use 0:backupDir to
# the other backup dirs. If it is possible, that they can run in
# parallel, you should use 1:backupDir to avoid useless copies in
# the backup. This option should be used for *all* backups, which
# should share hard links (vice versa). Naturally, all the backups
# with joined hard links have to be in the same file system!
otherBackupDirs=

# lock file, if exist, new instances will finish if
# an old is allready running
lockFile=

# remove the lock files before deleting old backups
# default ('no') is to delete the lock file after deleting
# possible values are 'yes' and 'no'
unlockBeforeDel=

# Directories to except from backing up (relative path).
# You can use shell type wildcards.
# These directories have to be separated by space or newline.
exceptDirs=

# Directories to include in the backup (relative path inside of the backup).
# You can use shell type wildcards.
# These directories have to be separated by space or newline.
includeDirs=

# This option gives you the possibility to exclude a combination of perl
# regular expressions. These patterns have to describe a file name with its
# relative path in the backup. You have to mask a '/' with '\/'
# inside the pattern. If you are not familiar with perl pattern
# matching, you should tye `man perlretut` and read some documentation.
# The combination of patterns can be made with 'and', 'or', 'not,
# '(' or ')'. If you want to use one of the keywords as a pattern,
# it has to be written differently, eg. write 'and' as 'a[n]d'.
# !!! '(' and ')' _have_to_be_separated_ by white space!!!
# You can say:
# exceptPattern = ( \/opt\/ or \/optional\/ ) and not \/(.+?)\/myproc\/
# This means: Exclude the directories '/opt/' and '/optional/'. But do
# not exclude all directories beginning with /*/myproc/.
# If here is defined a rule, and it matches, then the file will not
# be saved.
exceptPattern=

# For explanations, see 'exceptPattern'.
# All include / except paramters will be checked:
#
# General rule: A file which is
#
# not in 'exceptDirs' and
# in 'includeDirs' and
# does not match 'exceptPattern' (with full relative path) and
# matches 'includePattern' (with full relative path)
#
# will be saved! In all cases you have to define _relative_ paths from your
# sourceDir! if you additionally use 'followLinks', interpret the
# specified symbolic links as directories.
includePattern=

# continue if one or more of the exceptional directories
# do not exist (no is stopping processing)
contExceptDirsErr=no

# do not save the specified types of files, allowed: Sbcfpl
# S - file is a socket
# b - file is a block special file
# c - file is a character special file
# f - file is a plain file
# p - file is a named pipe
# l - file is a symbolic link
# Sbc is not yet implemented, but you can suppress a 
# warning if you specify them with this option
exceptTypes=

# exec job before starting the backup, checks lockFile (-L)
# before starting (e.g. can be used for rsync)
# stops execution if job returs exit status != 0
precommand=

# exec job after finishing the backup,
# but before erasing of old backups
# reports if job returs exit status != 0
postcommand=

# follow symbolic links like directories up to depth
# 0 -> do not follow links
followLinks=0

# compress command (with options), default is <bzip2>
compress=bzip2

# uncompress command (with options), default is <bzip2 -d>
uncompress=bzip2 -d

# postfix to add after compression, default is <.bz2>
postfix=.bz2

# maximal number of parallel compress operations,
# default = 4
noCompress=4

# length of queue to store files before compression,
# default = 1000
queueCompress=1000

# maximal number of parallel copy operations,
# default = 1
noCopy=1

# length of queue to store files before copying,
# default = 1000
queueCopy=1000

# maximum bandwidth, KBytes per second per copying process
# storeBackup uses rsync for this option, make shure it is installed
# default = 0 -> no limit, use cp for copying
copyBWLimit=0

# write statistics about used space in log file
# default is 'no'
withUserGroupStat=no

# write statistics about used space in name file
#		    will be overridden each time
# if no file name is given, nothing will be written
# format is:
# identifier uid userName value
# identifier gid groupName value
userGroupStatFile=

# do not compress or copy files with the following
# suffix (uppercase included):
# (if you set this to '.*', no files will be compressed)
exceptSuffix=.zip .bz2 .gz .tgz .jpg .gif .tiff .tif .mpeg .mpg .mp3 .ogg .gpg .png


# like --exceptSuffix, but do not replace defaults, add
addExceptSuffix=

# default is 'yes', if you do not want this, say 'no'
compressMD5File=yes

# permissions of .md5checkSumFile, default is 0600
chmodMD5File=0600

# verbose messages, about exceptPattern and includePattern
# default is 'no'
verbose=no

# generate debug messages, levels are 0 (none, default),
# 1 (some), 2 (many) messages
debug=0

# reset access time in the source directory - but this will
# change ctime (time of last modification of file status
# information
# default is 'no', if you want this, say 'yes'
resetAtime=

# do not delete any old backup (e.g. specified via --keepAll or
# --keepWeekday) but print a message. This is for testing.
# Values are 'on' and 'off'. Default is 'off' which means to delete.
doNotDelete=

# keep backups which are not older than the specified amount
# of time. This is like a default value for all days in
# --keepWeekday. Begins deleting at the end of the script
# the time range has to be specified in format 'dhms', e.g.
# 10d4h means 10 days and 4 hours
# default = 30d;
# An archive flag is not possible with this parameter (see below).
keepAll=

# keep backups for the specified days for the specified
# amount of time. Overwrites the default values choosen in
# --keepAll. 'Mon,Wed:40d Sat:60d10m' means:
# keep backups of Mon and Wed 40days + 5mins
# keep backups of Sat 60days + 10mins
# keep backups of the rest of the days like spcified in
# --keepAll (default 30d)
# you can also set the 'archive flag'.
# 'Mon,Wed:a40d Sat:60d10m' means:
# keep backups of Mon and Wed 40days + 5mins + 'archive'
# keep backups of Sat 60days + 10mins
# keep backups of the rest of the days like specified in
# --keepAll (default 30d)
# If you also use the 'archive flag' it means to not
# delete the affected directories via --keepMaxNumber:
# a10d4h means 10 days and 4 hours and 'archive flag'
keepWeekday=

# do not delete the first backup of a year
# format is timePeriod with possible 'archive flag'
keepFirstOfYear=

# do not delete the last backup of a year
# format is timePeriod with possible 'archive flag'
keepLastOfYear=

# do not delete the first backup of a month
# format is timePeriod with possible 'archive flag'
keepFirstOfMonth=

# do not delete the last backup of a month
# format is timePeriod with possible 'archive flag'
keepLastOfMonth=

# default: 'Sun'. This value is used for calculating
# --keepFirstOfWeek and --keepLastOfWeek
firstDayOfWeek=

# do not delete the first backup of a week
# format is timePeriod with possible 'archive flag'
keepFirstOfWeek=

# do not delete the last backup of a week
# format is timePeriod with possible 'archive flag'
keepLastOfWeek=

# keep multiple backups of one day up to timePeriod
# format is timePeriod, 'archive flag' is not possible
# default is 7d
keepDuplicate=

# Keep that miminum of backups. Multiple backups of one
# day are counted as one backup.
keepMinNumber=

# Try to keep only that maximum of backups. If you have more
# backups, the following sequence of deleting will happen:
# - delete all duplicates of a day, beginning with the old
#   once, except the oldest of every day
# - if this is not enough, delete the rest of the backups
#   beginning with the oldest, but *never* a backup with
#   the 'archive flag' or the last backup
keepMaxNumber=

# print progress report after each 'number' files
# Default is 0, which means no reports.
progressReport=

# print depth of actual readed directory during backup
# default is 'no', values are 'yes' and 'no'
printDepth=

# ignore read errors in source directory; not readable
# directories does not cause storeBackup.pl to stop processing
# Values are 'on' and 'off'. Default is 'off' which means not
# to ignore them
ignoreReadError=

# name of the log file (default is STDOUT)
logFile=

# if you specify a log file with --logFile you can
# additionally print the output to STDOUT with this flag
# Values are 'on' and 'off'. Default is 'off'.
plusLogStdout=

# output in logfile with time: 'yes' or 'no'
# default = 'yes'
withTime=

# maximal length of file, default = 1e6
maxFilelen=

# number of old log files, default = 5
noOfOldFiles=

# save log files with date and time instead of deleting the
# old (with [-noOldFiles]): 'yes' or 'no', default = 'no'
saveLogs=

# compress saved log files (e.g. with 'gzip -9')
# default is 'bzip2'
compressWith=

# write log file (also) in the backup directory:
# 'yes' or 'no', default is 'no'
# Be aware that this log does not contain all error
# messages of the one specified with --logFile!
# Some errors are possible before the backup
# directory is created.
logInBackupDir=

# compress the log file in the backup directory:
# 'yes' or 'no', default is 'yes'
compressLogInBackupDir=

# filename to use for writing the above log file,
# default is '.storeBackup.log'
logInBackupDirFileName=