Documentation clarifications (#791).
This commit is contained in:
parent
da034c316a
commit
8b9abc6cf8
2 changed files with 12 additions and 8 deletions
|
@ -216,7 +216,7 @@ properties:
|
||||||
Store configuration files used to create a backup in the backup
|
Store configuration files used to create a backup in the backup
|
||||||
itself. Defaults to true. Changing this to false prevents "borgmatic
|
itself. Defaults to true. Changing this to false prevents "borgmatic
|
||||||
bootstrap" from extracting configuration files from the backup.
|
bootstrap" from extracting configuration files from the backup.
|
||||||
example: true
|
example: false
|
||||||
source_directories_must_exist:
|
source_directories_must_exist:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |
|
description: |
|
||||||
|
@ -287,14 +287,17 @@ properties:
|
||||||
retry_wait:
|
retry_wait:
|
||||||
type: integer
|
type: integer
|
||||||
description: |
|
description: |
|
||||||
Wait time between retries (in seconds) to allow transient issues to
|
Wait time between retries (in seconds) to allow transient issues
|
||||||
pass. Increases after each retry as a form of backoff. Defaults to 0
|
to pass. Increases after each retry by that same wait time as a
|
||||||
(no wait).
|
form of backoff. Defaults to 0 (no wait).
|
||||||
example: 10
|
example: 10
|
||||||
temporary_directory:
|
temporary_directory:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
Directory where temporary files are stored. Defaults to $TMPDIR.
|
Directory where temporary Borg files are stored. Defaults to
|
||||||
|
$TMPDIR. See "Resource Usage" at
|
||||||
|
https://borgbackup.readthedocs.io/en/stable/usage/general.html for
|
||||||
|
details.
|
||||||
example: /path/to/tmpdir
|
example: /path/to/tmpdir
|
||||||
ssh_command:
|
ssh_command:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
@ -149,9 +149,10 @@ borgmatic umount --mount-point /mnt
|
||||||
|
|
||||||
<span class="minilink minilink-addedin">New in version 1.7.15</span> borgmatic
|
<span class="minilink minilink-addedin">New in version 1.7.15</span> borgmatic
|
||||||
automatically stores all the configuration files used to create an archive
|
automatically stores all the configuration files used to create an archive
|
||||||
inside the archive itself. This is useful in cases where you've lost a
|
inside the archive itself. They are stored in the archive using their full
|
||||||
configuration file or you want to see what configurations were used to create a
|
paths from the machine being backed up. This is useful in cases where you've
|
||||||
particular archive.
|
lost a configuration file or you want to see what configurations were used to
|
||||||
|
create a particular archive.
|
||||||
|
|
||||||
To extract the configuration files from an archive, use the `config bootstrap`
|
To extract the configuration files from an archive, use the `config bootstrap`
|
||||||
action. For example:
|
action. For example:
|
||||||
|
|
Loading…
Reference in a new issue