Update documentation to refer to dashless action sub-commands.
This commit is contained in:
parent
cd91dbd4f7
commit
acd6772148
4 changed files with 16 additions and 16 deletions
|
@ -17,15 +17,15 @@ run borgmatic's pruning, creating, or checking actions separately. For
|
||||||
instance, the the following optional flags are available:
|
instance, the the following optional flags are available:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic --prune
|
borgmatic prune
|
||||||
borgmatic --create
|
borgmatic create
|
||||||
borgmatic --check
|
borgmatic check
|
||||||
```
|
```
|
||||||
|
|
||||||
You can run with only one of these flags provided, or you can mix and match
|
You can run with only one of these flags provided, or you can mix and match
|
||||||
any number of them in a single borgmatic run. This supports approaches like
|
any number of them in a single borgmatic run. This supports approaches like
|
||||||
making backups with `--create` on a frequent schedule, while only running
|
making backups with `create` on a frequent schedule, while only running
|
||||||
expensive consistency checks with `--check` on a much less frequent basis from
|
expensive consistency checks with `check` on a much less frequent basis from
|
||||||
a separate cron job.
|
a separate cron job.
|
||||||
|
|
||||||
### Consistency check configuration
|
### Consistency check configuration
|
||||||
|
|
|
@ -29,8 +29,8 @@ functionality:
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic --list
|
borgmatic list
|
||||||
borgmatic --info
|
borgmatic info
|
||||||
```
|
```
|
||||||
|
|
||||||
## Logging
|
## Logging
|
||||||
|
@ -71,8 +71,8 @@ already has this rate limit disabled.
|
||||||
## Scripting borgmatic
|
## Scripting borgmatic
|
||||||
|
|
||||||
To consume the output of borgmatic in other software, you can include an
|
To consume the output of borgmatic in other software, you can include an
|
||||||
optional `--json` flag with `--create`, `--list`, or `--info` to get the
|
optional `--json` flag with `create`, `list`, or `info` to get the output
|
||||||
output formatted as JSON.
|
formatted as JSON.
|
||||||
|
|
||||||
Note that when you specify the `--json` flag, Borg's other non-JSON output is
|
Note that when you specify the `--json` flag, Borg's other non-JSON output is
|
||||||
suppressed so as not to interfere with the captured JSON. Also note that JSON
|
suppressed so as not to interfere with the captured JSON. Also note that JSON
|
||||||
|
|
|
@ -5,10 +5,10 @@ title: How to restore a backup
|
||||||
|
|
||||||
When the worst happens—or you want to test your backups—the first step is
|
When the worst happens—or you want to test your backups—the first step is
|
||||||
to figure out which archive to restore. A good way to do that is to use the
|
to figure out which archive to restore. A good way to do that is to use the
|
||||||
`--list` action:
|
`list` action:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic --list
|
borgmatic list
|
||||||
```
|
```
|
||||||
|
|
||||||
That should yield output looking something like:
|
That should yield output looking something like:
|
||||||
|
@ -22,7 +22,7 @@ Assuming that you want to restore the archive with the most up-to-date files
|
||||||
and therefore the latest timestamp, run a command like:
|
and therefore the latest timestamp, run a command like:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic --extract --archive host-2019-01-02T04:06:07.080910
|
borgmatic extract --archive host-2019-01-02T04:06:07.080910
|
||||||
```
|
```
|
||||||
|
|
||||||
The `--archive` value is the name of the archive to restore. This extracts the
|
The `--archive` value is the name of the archive to restore. This extracts the
|
||||||
|
@ -33,13 +33,13 @@ in the right place before running the command.
|
||||||
## Repository selection
|
## Repository selection
|
||||||
|
|
||||||
If you have a single repository in your borgmatic configuration file(s), no
|
If you have a single repository in your borgmatic configuration file(s), no
|
||||||
problem: the `--extract` action figures out which repository to use.
|
problem: the `extract` action figures out which repository to use.
|
||||||
|
|
||||||
But if you have multiple repositories configured, then you'll need to specify
|
But if you have multiple repositories configured, then you'll need to specify
|
||||||
the repository path containing the archive to extract. Here's an example:
|
the repository path containing the archive to extract. Here's an example:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic --extract --repository repo.borg --archive host-2019-...
|
borgmatic extract --repository repo.borg --archive host-2019-...
|
||||||
```
|
```
|
||||||
|
|
||||||
## Restore particular files
|
## Restore particular files
|
||||||
|
@ -49,7 +49,7 @@ everything from an archive. To do that, tack on one or more `--restore-path`
|
||||||
values. For instance:
|
values. For instance:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic --extract --archive host-2019-... --restore-path /path/1 /path/2
|
borgmatic extract --archive host-2019-... --restore-path /path/1 /path/2
|
||||||
```
|
```
|
||||||
|
|
||||||
Like a whole-archive restore, this also restores into the current directory.
|
Like a whole-archive restore, this also restores into the current directory.
|
||||||
|
|
|
@ -121,7 +121,7 @@ this step if you already have a Borg repository.) To create a repository, run
|
||||||
a command like the following:
|
a command like the following:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic --init --encryption repokey
|
borgmatic init --encryption repokey
|
||||||
```
|
```
|
||||||
|
|
||||||
This uses the borgmatic configuration file you created above to determine
|
This uses the borgmatic configuration file you created above to determine
|
||||||
|
|
Loading…
Reference in a new issue