DataBackup.cfg

NAME

SYNOPSIS

AVAILABILITY

DESCRIPTION

FILEFORMAT

The settings for the DataBackup command have to follow the section with the name [DATABACKUP].

The file format is OPTION=VALUE

Between the OPTION, the = and the VALUE are no spaces.

You can comment out any OPTION or completely remove the related setting line to use the default settings.

OPTIONS

All options (except DEBUG) defined in this configuration file can be overwritten in the backup definition file DataBackup.BACKUPNAME.cfg .

Therefore in this file defaults that are valid for all backups can be defined.

BACKUPMODE

mode of the backup. Available modes are: BACKUP, UPDATE_TARGET and SYNCHRONIZE and have the following characteristics:

BACKUP

save data conserving the complete data path names and purge extra files from destination when they do not exist any more on the source side.
The save path is:
<DESTINATION_DRIVE>:\<DESTINATION_BASEDIR>\<COMPUTERNAME>\<SOURCE_DRIVE>\<SOURCE_BASEDIR>\...

SYNCHRONIZE

save data directories and purge extra files from destination when they do not exist any more on the source side.
The save path is:
<DESTINATION_DRIVE>:\<DESTINATION_BASEDIR>\...

UPDATE_TARGET

save data directories and conserve all extra files from destination, also when they do not exist any more on the source side.
The save path is:
<DESTINATION_DRIVE>:\<DESTINATION_BASEDIR>\...

Example: BACKUPMODE=UPDATE_TARGET

Default: BACKUPMODE=BACKUP

MESSAGEBOXES

query user thru message pop up boxes instead of key presses on the keyboard.

When connecting thru SSH and executing DataBackup the user is not queried thru message pop up boxes.

Example: MESSAGEBOXES=True

Default: MESSAGEBOXES=False

MESSAGEDISPLAYDURATION

duration in seconds by which the output is paused when displaying the big error and warning messages.

Example: MESSAGEDISPLAYDURATION=10

Default: MESSAGEDISPLAYDURATION=2

BACKUPSTARTLAG

duration in seconds by which the start of the backup is delayed. This delay allows the user to view the selected actions before it is scrolled away by further outputs.

Example: BACKUPSTARTLAG=15

Default: BACKUPSTARTLAG=3

NOEXECUTE

if NOEXECUTE is set to True, there are no backups or file deletes performed, only messages are written to the console and the backup session log file.

Pre- and post-exec scripts are executed even when NOEXECUTE is set to True.

The aim of this option in the DataBackup.cfg file is to test all backup specifications without actually running it.

if NOEXECUTE is set to False, or if the option is missing from the configuration file, backups are performed.

Example: NOEXECUTE=True

Default: NOEXECUTE=False

ENABLESHUTDOWN

when ENABLESHUTDOWN is set to True the user can select to shut down the system after the completion of the backup.
If this setting is set to False the user is not prompted for the possibility of system shut down.

Example: ENABLESHUTDOWN=False

Default: ENABLESHUTDOWN=True

SHUTDOWNDELAY

number of seconds the system shut down is delayed after the completion of the backup run.

Example: SHUTDOWNDELAY=600

Default: SHUTDOWNDELAY=300

ENABLECOMPAIR

if this setting is set to True the source and destination directory sizes are compared. If it is set to False no comparison takes place.

Example: ENABLECOMPAIR=False

Default: ENABLECOMPAIR=True

ENABLELOGSMOOTHING

when set to True, the progress percentage number (0.0% ... 100%) lines are removed from the log file.

Example: ENABLELOGSMOOTHING=False

Default: ENABLELOGSMOOTHING=True

ENABLEFINISHSOUND

to play a sound after the completion of the backup, specify True, else specify False.

Example: ENABLEFINISHSOUND=False

Default: ENABLEFINISHSOUND=True

FINISHSOUND

With this setting you can specify a specific sound to play after the completion of the backup. The sound file has to be specified without the .mp3 file suffix.

The sound files must reside in the var/sounds/ directory.

A fun ressource of cool sounds is http://www.serienoldies.de/serien/80er/ which contains lots of themes of TV series from the 30ies until the 90ies.

If you specify FINISHSOUND=SPEAK: text message , the given text message is spoken in English language.

Example: FINISHSOUND=SPEAK: Backup is completed now!

Example: FINISHSOUND=Knight Rider

Default: FINISHSOUND=Big Ben

COLORS

by default the output is colored to enhance readability of the output. If this colorful output is not desired turn it off by setting this option to False which causes to change the output to a greenish color scheme.

Example: COLORS=False

Default: COLORS=True

OPACITY

set opacity in percentage of the output window during backup execution. The value can be set between 30 and 100.

Example: OPACITY=80

Default: OPACITY=89

DEBUG

enable debug mode of DataBackup by setting DEBUG to True, else set it to False.

Example: DEBUG=True

Default: DEBUG=False

NOSLEEP

If NOSLEEP is set to True the system will not go to sleep and will not hibernate when plugged in due to inactivity.

Inactivity only looks at user activity (mouse or keyboard), running programs do not count. Therefore even if running a backup task, the system would go to sleep or hibernate during that activity, what is not wanted in this case.

Example: NOSLEEP=False

Default: NOSLEEP=True

NOTIFICATION

Show a notification in the windows notification area on backup completion.

Example: NOTIFICATION=False

Default: NOTIFICATION=True

STATSSAMPLES

number of values of past backup runs to be used to estimate the backup duration. If set to 0 the values of all past backup runs are used.

Example: STATSSAMPLES=30

Default: STATSSAMPLES=5

CODEPAGE

set the output window (console) code page to display the characters correctly.

Unicode characters will only display if the current console font contains the characters. So use a TrueType font like Lucida Console instead of the CMD default Raster Font.

See also http://ss64.com/nt/chcp.html regarding code pages.

Example: CODEPAGE=861

Default: CODEPAGE=1252

LISTDIRS

to list all processed directories, set this option to True, to only list files/directories where something has changed, set it to False.

Example: LISTDIRS=True

Default: LISTDIRS=False

RETRIES

Number of retries, when a file cannot be copied (e.g. because it is open). The pause between two retries is 10 s.

Example: RETRIES=10

Default: RETRIES=2

DRIVERETRIES

Number of retries to access the source and target disks. The pause between two retries is 6 s.

Therefore, if a backup is started, but the external disk has not been powered on you have one minute time to do so without to restart the backup.

Also sometimes it takes some time when you connect an USB stick (or MP3 player) for the system to recognize it.

When a scheduled backup is started in interactive mode using the INTERACTIVE=True setting, the DRIVERETRIES setting should be changed to a higher value to improve the possibility that drives are accessible that are in power save or standby mode or network drives connected thru DFS (Distributed File System), the 'automounter' of Microsoft™ Windows.

Example: DRIVERETRIES=20

Default: DRIVERETRIES=10

ENABLEREPORT

when set to True a report of the backup is created and written to var/report/DataBackup.BACKUPNAME.report.html .

To get a report containing data, the ENABLECOMPAIR setting has to be set to True.

Example: ENABLEREPORT=False

Default: ENABLEREPORT=True

ENABLEREPORTHISTORY

when set to True a the report of the backup is historicized that does mean the current created report is also saved as var/report/DataBackup.BACKUPNAME.report.<NOW>.html .

To get a historicized report, the ENABLEREPORT setting has to be set to True.

Example: ENABLEREPORTHISTORY=False

Default: ENABLEREPORTHISTORY=True

ENABLEREPORTLOAD

when set to True the created report is loaded into the default browser on the system at backup completion.

This setting has only an effect when ENABLEREPORT=True is active.

When connecting thru SSH and executing DataBackup the report is not loaded into the browser.

Example: ENABLEREPORTLOAD=False

Default: ENABLEREPORTLOAD=True

ABSOLUTELINKS

when set to True the hyperlink in the Logfile column of the backup report is an absolute path name, if set to False the hyperlink is relative to the var/report directory.

Example: ABSOLUTELINKS=True

Default: ABSOLUTELINKS=False

REPORTHTML

the HTML file specified in this setting is used as template to create the backup report.
See databackup.report(4) for more information.

Example: REPORTHTML=c:\Users\fred\myDataBackup.report.html

Example: REPORTHTML=%INSTALLDIR%\lib\DataBackup.report.de.html

Default: REPORTHTML=lib\DataBackup.report.html

REPORTCSS

style sheet loaded into the REPORTHTML file.
See databackup.report(4) for more information.

Example: REPORTCSS=c:\Users\fred\myDataBackup.report.css

Default: REPORTCSS=lib\DataBackup.report.css

REPORTJS

JavaScript file loaded into the REPORTHTML file.
See databackup.report(4) for more information.

Example: REPORTJS=c:\Users\fred\myDataBackup.report.js

Default: REPORTJS=lib\DataBackup.report.js

HTMLCHARSET

character set defined in the generated HTML backup report file.

Example: HTMLCHARSET=ISO-8859-1

Default: HTMLCHARSET=utf-8

BROWSERBIN

executable of a web-browser o be used to show the backup report.

If no BROWSERBIN is defined, DataBackup starts the system default browser.

Example: BROWSERBIN=%INSTALLDRIVE%:\Programs\WA2LWinTools\bin\run.exe

Example: BROWSERBIN=%INSTALLDRIVE%:\Programs\OperaPortable\OperaPortable.exe

Default: BROWSERBIN=

BROWSEROPT

additional options to browser defined in BROWSERBIN.

Example: BROWSEROPT=Opera

Example: BROWSEROPT=--user-data-dir="%INSTALLDRIVE%:\Data\Browser\Opera\%USERNAME%"

Default: BROWSEROPT=

LOWSPACE

Minimal amount of free space on destination drive in megabytes before reporting "Low disk space on destination!" in backup report.

Example: LOWSPACE=1024

Default: LOWSPACE=10240

VARIABLES

EXAMPLES

1) Simple example configuration file

#
# WA2LSimpleBackup/etc/DataBackup.cfg - Configuration file for DataBackup
#
# [00] 08.02.2016 CWa   Initial Version
#

[DATABACKUP]

COLORS=False
FINISHSOUND=Kojak

SEE ALSO

NOTES

BUGS

AUTHOR

COPYRIGHT

This is free software; see WA2LSimpleBackup/man/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.