本文へ移動

ヘルプコマンド (help)

pgBackRestのhelpコマンドのオプションおよび動作に関するリファレンス。

3つのレベルのヘルプが用意されています。コマンドが指定されない場合は、一般のヘルプが表示されます。コマンドが指定された場合(例:pgbackrest help backup)、そのコマンドの詳細な説明と有効なオプションの一覧が表示されます。コマンドに加えてオプションが指定された場合(例:pgbackrest help backup type)、そのオプションがコマンドに適用される際の詳細な説明が表示されます。

コマンドオプション

ヘルプ表示オプション (--help)

ヘルプを表示します。

ヘルプを表示します。helpコマンドが指定されていなくても同様に機能し、--versionオプションを上書きします。

default: n
example: --help

バージョン表示オプション (--version)

バージョンを表示します。

バージョン情報を表示します。versionまたはhelpコマンドが指定されていなくても同様です。

default: n
example: --version