DataBackup.config

Package: WA2L/SimpleBackup 1.0.67
Section: Configuration Files (4)
Updated: 11 July 2021
Index Return to Main Contents

NAME

DataBackup.config - configuration cheat sheet for DataBackup

SYNOPSIS

etc/DataBackup.cfg

etc/DataBackup.BACKUPNAME.cfg

lib/DataBackup.report.html

lib/DataBackup.report.LANG.html

lib/DataBackup.report.css

lib/DataBackup.report.js

AVAILABILITY

WA2L/SimpleBackup

DESCRIPTION

This is the cheat sheet for all DataBackup configuration settings that gives a brief overview of all configuration settings and variables within the WA2L/SimpleBackup package.

FILEFORMAT

OPTIONS

SHORTCUT INDEX

Description of the shortcuts used in the settings overview table below. An X marks where the setting is valid.

SETTING

setting, variable.

MND

mandatory setting.

TYPE

type of setting entry:

TAG: fix string.
BOOL: Boolean setting, as: True/False, Yes/No, On/Off, 1/0.
INT: integer value.
TEXT: text string.
PATH: path including drive letter.
VAR: variable.
ENV: environment variable.
SDIR: sub-directory without drive letter.
CHAR: single character.

CFG

setting in DataBackup.cfg file.

BKP

setting in DataBackup.BACKUPNAME.cfg file.

G: setting valid in [GENERAL] section.
B: setting valid in [BACKUPSET] section.
X: setting valid in any section.

HTM

setting in DataBackup.report.LANG.html or DataBackup.report.html file or file as defined in REPORTHTML setting.

CSS

setting in DataBackup.report.css file or file as defined in REPORTCSS setting.

JS

setting in DataBackup.report.js file or file as defined in REPORTJS setting.

SHORT DESCRIPTION

short description of the related element.

SETTINGS OVERVIEW: SECTIONS

SETTING	MND	TYPE	CFG	BKP	HTM	CSS	JS	SHORT DESCRIPTION

[BACKUPSET]	X	TAG		B				Backup set in backup definition
[DATABACKUP]	X	TAG	X					Main section in DataBackup.cfg
[GENERAL]	X	TAG		G				General section in backup def.

SETTINGS OVERVIEW: SETTINGS

SETTING	MND	TYPE	CFG	BKP	HTM	CSS	JS	SHORT DESCRIPTION

ABSOLUTELINKS		BOOL	X	G				Absolute hyperlinks to log files
AUTOSHUTDOWN		BOOL		G				Automatic shutdown after backup
BACKUPMODE		TAG	X	G				Mode of backup
BACKUPSTARTLAG		INT	X	G				Pause before starting backup
BROWSERBIN		PATH	X	G				Browser to show backup report
BROWSEROPT		TEXT	X	G				Options to BROWSERBIN
CODEPAGE		INT	X	G				Code page of console outputs
COLORS		BOOL	X	G				Color output mode
DEACTIVATED		BOOL		B				Backup set deactivation
DEBUG		BOOL	X					Debug mode
DESCRIPTION		TEXT		X				Backup(Set) description
DESTINATION_BASEDIR	X	SDIR		G				Destination base directory
DESTINATION_DRIVE	X	CHAR		G				Destination drive
DESTINATION_DRIVENAME		TEXT		G				Destination drive name
DRIVERETRIES		INT	X	G				Retries to find drive
ENABLECOMPAIR		BOOL	X	G				Compare source and backup sizes
ENABLEFINISHSOUND		BOOL	X	G				Play sound at end of backup
ENABLELOGSMOOTHING		BOOL	X	G				Cleanup log file
ENABLEREPORT		BOOL	X	G				Create backup report
ENABLEREPORTHISTORY		BOOL	X	G				Historicize created backup report
ENABLEREPORTLOAD		BOOL	X	G				Load backup report into browser
ENABLESHUTDOWN		BOOL	X	G				Enable shutdown dialog
EXCLUDE_DIRS		PATH		B				Exclude directories from backup
EXCLUDE_FILES		TEXT		B				Exclude files from backup
FINISHSOUND		TEXT	X	G				Finish mp3 sound file
HTMLCHARSET		TEXT	X	G				Character set of backup report
INTERACTIVE		BOOL		G				Disable interactive execution
LISTDIRS		BOOL	X	G				List all proceeded directories
LOWSPACE		INT	X	G				MBytes to report dest. low space
MESSAGEBOXES		BOOL	X	G				User interaction by messagebox
MESSAGEDISPLAYDURATION		INT	X	G				Duration of message display
NOEXECUTE		BOOL	X	G				Only messages, no execution
NOSLEEP		BOOL	X	G				Avoid hibernating during backup
NOTIFICATION		BOOL	X	G				Notification on completion
POSTEXEC		FILE		G				Execute script after backup
POSTEXEC_OPTIONS		TEXT		G				Options for post exec script
PREEXEC		FILE		G				Execute script before backup
PREEXEC_OPTIONS		TEXT		G				Options for pre exec script
REPORTCSS		PATH	X	G				CSS file for report generation
REPORTHTML		PATH	X	G				HTML file for report generation
REPORTJS		PATH	X	G				JavaScript file for report
RETRIES		INT	X	X				Copy retries on open files etc.
SHUTDOWNDELAY		INT	X	G				Delay before shutdown execution
SOURCE_BASEDIR		SDIR		B				Source base directory
SOURCE_DIRECTORIES	X	SDIR		B				Source directories to backup
SOURCE_DRIVE	X	CHAR		B				Source drive letter
SOURCE_DRIVENAME		TEXT		B				Source drive name
STATSSAMPLES		INT	X	G				Number of samples for forecast

SETTINGS OVERVIEW: AVAILABLE CONFIGURATION FILE VARIABLES

SETTING	MND	TYPE	CFG	BKP	HTM	CSS	JS	SHORT DESCRIPTION

%BACKUPNAME%		VAR	X	X				Name of backup
%COMPUTERNAME%		ENV	X	X				Computer name where backup runs
%DAY%		VAR	X	X				Day of month
%HOUR%		VAR	X	X				Hour
%INSTALLDIR%		VAR	X	X				Package installation directory
%INSTALLDRIVE%		VAR	X	X				Package installation drive letter
%LASTYEAR%		VAR	X	X				Last year
%MIN%		VAR	X	X				Minute
%MONTH%		VAR	X	X				Month of year
%MONTHNAME%		VAR	X	X				Month name
%NOW%		VAR	X	X				Reverse date and time of today
%PROGRAMFILES%		VAR	X	X				ProgramFiles directory
%QUARTER%		VAR	X	X				Quarter (1-4) in year
%SEC%		VAR	X	X				Seconds
%SEMESTER%		VAR	X	X				Semester (1-2) in year
%SOURCE_DRIVE%		VAR	X	X				Source drive
%SYSTEMROOT%		VAR	X	X				SystemRoot directory
%TEMP%		ENV	X	X				System temp directory
%TIMER%		VAR	X	X				Seconds since the epoch
%TMP%		ENV	X	X				System temp directory
%TODAY%		VAR	X	X				Reverse date of today
%TODAYMIL%		VAR	X	X				Military date format of today
%TRIMESTER%		VAR	X	X				Trimester (1-3) in year
%USERDOMAIN%		ENV	X	X				Domain name of the computer
%USERNAME%		ENV	X	X				User login name
%WDAY%		VAR	X	X				Weekday number
%WDAYNAME%		VAR	X	X				Weekday name
%WEEK%		VAR	X	X				Year week number
%YDAY%		VAR	X	X				Year day number
%YEAR%		VAR	X	X				Year

SETTINGS OVERVIEW: AVAILABLE REPORT FILE VARIABLES

SETTING	MND	TYPE	CFG	BKP	HTM	CSS	JS	SHORT DESCRIPTION

@BACKUPCONFIGFILE@		VAR			X	X	X	Config file of backup
@BACKUPMODE@		VAR			X	X	X	Backup mode
@BACKUPNAME@		VAR			X	X	X	Backup name
@CHARSET@		VAR			X	X	X	Report character set
@DATE@		VAR			X	X	X	Date
@LOWSPACE@		VAR			X	X	X	megabytes of low space message
@LOWSPACE_MESSAGE_DISPLAY@		VAR			X	X	X	"block" on LOWSPACE else "none"
@NOW@		VAR			X	X	X	Reverse date and time of today
@TODAYMIL@		VAR			X	X	X	Military date format of today
@DESCRIPTION@		VAR			X	X	X	Backup description
@DESTINATION_BASEDIR@		VAR			X	X	X	Destination base dir
@DESTINATION_DRIVE@		VAR			X	X	X	Destination drive letter
@DESTINATION_DRIVENAME@		VAR			X	X	X	Destination drive name
@GBYTESMAX@		VAR			X	X	X	Max GBytes of all backups
@GBYTESMIN@		VAR			X	X	X	Min GBytes of all backups
@HOSTNAME@		ENV			X	X	X	Computer name
@PROGNAME@		VAR			X	X	X	Backup program name
@TARGET_DRIVE@		VAR			X	X	X	Target drive letter
@TIME@		VAR			X	X	X	Time
@TOTALBACKUPRUNS@		VAR			X	X	X	Number of backup runs
@USER@		ENV			X	X	X	User login name
@VERSION@		VAR			X	X	X	Backup program version
@YEAR@		VAR			X	X	X	Year

EXAMPLES

NOTES

BUGS

AUTHOR

databackup.config was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

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.

Index

SHORTCUT INDEX
SETTINGS OVERVIEW: SECTIONS
SETTINGS OVERVIEW: SETTINGS
SETTINGS OVERVIEW: AVAILABLE CONFIGURATION FILE VARIABLES
SETTINGS OVERVIEW: AVAILABLE REPORT FILE VARIABLES

This document was created by man2html using the manual pages.
Time: 16:29:44 GMT, September 14, 2024