3.4 BART Subcommands

This section describes the syntax and usage of the BART subcommands.

All subcommands support a help option (-h, --help). If the help option is specified, information is displayed regarding that particular subcommand. The subcommand, itself, is not executed.

The following is an example of the help option for the BACKUP subcommand:

-bash-4.2$ bart BACKUP --help

bart: backup and recovery tool

 

Usage:

bart BACKUP [OPTION]...

 

Options:

-h, --help Show this help message and exit

-s, --server Name of the server or 'all' (full backups only) to specify all

servers

-F, --format=p|t Backup output format (tar (default) or plain)

-z, --gzip Enables gzip compression of tar files

-c, --compress-level Specifies the compression level (1 through 9, 9 being best

compression)

 

--backup-name Specify a friendly name for the current backup

--parent Specify parent backup for incremental backup

--check Verify checksum of required mbm files

Note: In the following sections, the help option is omitted from the syntax diagrams for the purpose of providing clarity for the subcommand options.

For clarity, the syntax diagrams also show only the single-character form of the option. The Options subsections list both the single-character and multi-character forms of the options.