1
0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2024-12-14 10:13:05 +02:00
pgbackrest/test/expect/help-help-001.log
David Steele df7d633683 Improvements to command/command-line help:
* Move repository options into a separate section in command/command-line help. (Suggested by Stephen Frost.)
* Fix description of --online based on the command context.
* Remove vestigial repository options from backup command.
2017-07-26 09:33:10 -04:00

119 lines
4.7 KiB
Plaintext

run 001 - base
==============
> [BACKREST-BIN] version
------------------------------------------------------------------------------------------------------------------------------------
[BACKREST-NAME-VERSION]
> [BACKREST-BIN] help
------------------------------------------------------------------------------------------------------------------------------------
[BACKREST-NAME-VERSION] - General help
Usage:
pgbackrest [options] [command]
Commands:
archive-get Get a WAL segment from the archive.
archive-push Push a WAL segment to the archive.
backup Backup a database cluster.
check Check the configuration.
expire Expire backups that exceed retention.
help Get help.
info Retrieve information about backups.
restore Restore a database cluster.
stanza-create Create the required stanza data.
stanza-upgrade Upgrade a stanza.
start Allow pgBackRest processes to run.
stop Stop pgBackRest processes from running.
version Get version.
Use 'pgbackrest help [command]' for more information.
> [BACKREST-BIN] help version
------------------------------------------------------------------------------------------------------------------------------------
[BACKREST-NAME-VERSION] - 'version' command help
Get version.
Displays installed pgBackRest version.
> [BACKREST-BIN] help --output=json --stanza=main info
------------------------------------------------------------------------------------------------------------------------------------
[BACKREST-NAME-VERSION] - 'info' command help
Retrieve information about backups.
The info command operates on a single stanza or all stanzas. Text output is the
default and gives a human-readable summary of backups for the stanza(s)
requested. This format is subject to change with any release.
For machine-readable output use --output=json. The JSON output contains far
more information than the text output, however this feature is currently
experimental so the format may change between versions.
Command Options:
--output output format [current=json, default=text]
General Options:
--buffer-size buffer size for file operations [default=4194304]
--cmd-ssh path to ssh client executable [default=ssh]
--compress-level compression level for stored files [default=6]
--compress-level-network compression level for network transfer when
compress=n [default=3]
--config pgBackRest configuration file
[default=/etc/pgbackrest.conf]
--lock-path path where lock files are stored
[default=/tmp/pgbackrest]
--protocol-timeout protocol timeout [default=1830]
--stanza defines the stanza [current=main]
Log Options:
--log-level-console level for console logging [default=warn]
--log-level-file level for file logging [default=info]
--log-level-stderr level for stderr logging [default=warn]
--log-path path where log files are stored
[default=/var/log/pgbackrest]
--log-timestamp enable timestamp in logging [default=y]
Repository Options:
--backup-cmd pgBackRest exe path on the backup host
[default=[BACKREST-BIN]]
--backup-config pgBackRest backup host configuration file
[default=/etc/pgbackrest.conf]
--backup-host backup host when operating remotely via SSH
--backup-user backup host user when backup-host is set
[default=backrest]
--repo-path repository path where WAL segments and backups
stored [default=/var/lib/pgbackrest]
--repo-s3-bucket s3 repository bucket
--repo-s3-ca-file s3 SSL CA File
--repo-s3-ca-path s3 SSL CA Path
--repo-s3-endpoint s3 repository endpoint
--repo-s3-host s3 repository host
--repo-s3-key s3 repository access key
--repo-s3-key-secret s3 repository secret access key
--repo-s3-region s3 repository region
--repo-s3-verify-ssl verify S3 server certificate [default=y]
--repo-type type of storage used for the repository
[default=posix]
Use 'pgbackrest help info [option]' for more information.
> [BACKREST-BIN] help --output=json --stanza=main info output
------------------------------------------------------------------------------------------------------------------------------------
[BACKREST-NAME-VERSION] - 'info' command - 'output' option help
Output format.
The following output types are supported:
* text - Human-readable summary of backup information.
* json - Exhaustive machine-readable backup information in JSON format.
current: json
default: text