Backup4all uses for each action a small application that runs independently from the main application. They can be used to create batch files.
The command line parameters for backup action are described bellow.
Backup jobs
Syntax
bBackup [{/f|/d|/i|/r}] job_name [/e][/c] [-Priority{1|2|3|4}]
Formatting legend
Italic - Information that must be supplied by the user
Bold - Elements that the user must type exactly as shown
/ - Switches are preceded by slash
[] - Elements between square brackets are optional
| - Vertical line separates possible choices
{} - Items between braces are a set of choices from which the user must choose only one
Command line backup can have as parameters an ".ini" file (with its full path), a ".bkc" file (with its full path) or the name of the backup job. The ".ini" or ".bkc" file must exist in the specified path, the backup job must be defined in Backup4all or otherwise the backup will not run.
Switches that apply to this parameter (case insensitive, preceded by "/" or "-"):
- /f - force the execution of a full backup
- /d - force the execution of a differential backup
- /i - force the execution of an incremental backup
- /r - execute the backup with its defined type in Backup Properties (this is the default behavior when the backup name is specified without switches)
- /e - erase the disc(Floppy/CD/DVD/Blu-ray) before backup
- /c - deletes the .bkc file and all zip files associated with the named backup job
If the backup job to be executed has the backup type set to Mirror, then a mirror backup will be performed and the "/f", "/d", "/i" switches will be ignored even if they are set.
For the priority level you can select a value between 1-4, as 1 is the lowest priority and 4 is the highest priority.
Examples
To execute a backup for My Pictures job, with the default backup type, use:
bBackup /r "My Pictures" -Priority 2
To force a full backup on the backup job associated with the IE Favorites.bkc located in the "E:\Backup Destination" folder, use:
bBackup /f "E:\Backup Destination\IE Favorites..bkc" - Priority 2
To force an incremental backup on the My Documents backup job, use:
bBackup /i "My Documents" - Priority 2
Tags
Syntax
bTagBackup tag_ name [-Priority{1|2|3|4}]
You can also have as parameter an existing tag. This tag must be defined in Backup4all, otherwise the backup will not run.
Switch to apply to this parameter (case insensitive, preceded by "/" or "-"):
For the priority level you can select a value between 1-4, as 1 is the lowest priority and 4 is the highest priority.
Examples
To execute all backup jobs from the Samples tag, use:
bTagBackup Samples -Priority 2
Backup4all returns exit codes after each task execution (backup, independent test or cleanup).
As a general case, if the backup was successful, the exit code is 0, otherwise is different.
Here are the possible exit codes:
- 0 : action was successful
- 1 : action has not started, parameter errors, syntax errors, other errors
- 2 : action finished with errors
- 3 : action was finished with warnings
- 4 : independent test was finished with errors
- 5 : independent test was finished with warnings
Backup job definitions (".ini" files) are saved separately for each Windows user. These files can be found in the "AppData\Softland\Backup4all 9\IniFiles" folder of your user profile (if it's not changed in the File->Options->File locations window). Backup catalogs (".bkc" files) are saved locally and in the backup destination together with the backup files. When a backup job is executed for the first time, a.bkc file is created. There is only one.bkc file for each backup job.
The command line application uses the same engine, same configuration files and the same log files as the main application. It always performs an unattended backup. You can use Backup4all's interface to define backup jobs and backup tags which can be used later as parameters for the command line application. You can create a shortcut to a backup job or to a backup tag so you won't have to use complicated paths. To create a shortcut, use the Create Shortcut menu item from the File menu.