db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-01-30 05:39:12 +02:00
Code Issues Releases Activity

Add documentation for command-line negation.

Browse Source
This commit is contained in:
David Steele 2017-12-15 11:12:37 -05:00
parent 41f5b2cec2
commit 3cc367185e
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/xml/reference.xml
View File

@ -743,7 +743,11 @@
<operation title="{[project]} Command Reference">
<description>The {[project]} Command Reference details all commands and options.</description>
<text>Commands are used to execute the various <backrest/> functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even if it applies to one or more other commands. This includes all the options that may also configured in <file>pgbackrest.conf</file>.</text>
<text>Commands are used to execute the various <backrest/> functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even if it applies to one or more other commands. This includes all the options that may also configured in <file>pgbackrest.conf</file>.
Non-boolean options configured in <file>pgbackrest.conf</file> can be reset to default on the command-line by using the <id>no-</id> prefix. This feature may be used to restore a backup directly on a backup host. Normally, <backrest/> will error because it can see that the database host is remote and restores cannot be done remotely. By adding <br-option>--no-db1-host</br-option> on the command-line, <backrest/> will ignore the remote database host and restore locally. It may be necessary to pass a new <br-option>--db-path</br-option> to force the restore to happen in a specific path, i.e. not the path used on the database host.
If the <id>no-</id> prefix is used with a boolean option then the option is set to false.</text>
<operation-general title="General Options">
<option-list>