mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-25 01:06:50 +00:00
Merge pull request #4198 from ThomasWaldmann/docs-json
docs: --format is required for some expensive-to-compute values
This commit is contained in:
commit
f7a5d3fb15
1 changed files with 10 additions and 0 deletions
|
@ -340,6 +340,16 @@ username
|
|||
comment
|
||||
Archive comment, if any
|
||||
|
||||
Some keys/values are more expensive to compute than others (e.g. because it requires opening the archive,
|
||||
not just the manifest). To optimize for speed, `borg list repo` does not determine these values except
|
||||
when they are requested. The `--format` option is used for that (for normal mode as well as for `--json`
|
||||
mode), so, to have the comment included in the json output, you will need:
|
||||
|
||||
::
|
||||
|
||||
borg list repo --format "{name}{comment}" --json`
|
||||
|
||||
|
||||
Example of a simple archive listing (``borg list --last 1 --json``)::
|
||||
|
||||
{
|
||||
|
|
Loading…
Reference in a new issue