Skip to content

Help Command (help)

Reference for pgBackRest help command options and behavior.

Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified (e.g. pgbackrest help backup) then a full description of the command will be displayed along with a list of valid options. If an option is specified in addition to a command (e.g. pgbackrest help backup type) then a full description of the option as it applies to the command will be displayed.

Command Options

Display Help Option (--help)

Display help.

Displays help even if the help command is not specified and overrides the --version option.

default: n
example: --help

Display Version Option (--version)

Display version.

Displays version even if the version or help command is not specified.

default: n
example: --version
Last modified September 8, 2026 · refactor(docs): move component documentation under /docs (f643529)
Adapted from pgBackRest documentation (v2.59.1), Copyright (c) 2015-2026 The PostgreSQL Global Development Group and David Steele, under MIT License. See attribution and change history.