backup_help8
Displays help for backup commands
Usage
backup help
[-topic
<help
string>+]
[-admin]
[-help]
backup h
[-t
<help
string>+]
[-a]
[-h]
Overview
The backup help command displays the complete online help entry (short description and syntax statement) for each operation code specified by the -topic argument. If the -topic argument is omitted, the output includes the first line (name and short description) of the online help entry for every backup command.
To list every backup command whose name or short description includes a specified keyword, use the backup apropos command.
Options
-topic<help string>+-
Indicates each command for which to display the complete online help entry. Omit the
backuppart of the command name, providing only the operation code (for example, specifydump, not backup dump). If this argument is omitted, the output briefly describes everybackupcommand.
-
-help -
Prints the online help for this command. All other valid options are ignored.
Output
The online help entry for each backup command consists of the following two or three lines:
- •
-
The first line names the command and briefly describes its function.
- •
-
The second line lists aliases for the command, if any.
- •
-
The final line, which begins with the string
"Usage", lists the command's options in the prescribed order. Online help entries use the same symbols (for example, brackets) as the reference pages in this document.
Examples
The following example displays the online help entry for the backup dump command:
% backup help dumpbackup dump: start dumpUsage: backup dump -volumeset <volume set name> -dump <dump level name>[-portoffset <TC port offset>] [-at <Date/time to start dump>+][-append] [-n] [-file <load file>] [-help]
Privilege required
None
Releases
10 releases since Debian 4.0 (Etch); the text changed 9 times.