mirror of https://github.com/borgbackup/borg.git
Merge pull request #4199 from ThomasWaldmann/docs-json-1.1
docs: --format is required for some expensive-to-compute values
This commit is contained in:
commit
6996ba7c52
|
@ -340,6 +340,16 @@ username
|
||||||
comment
|
comment
|
||||||
Archive comment, if any
|
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``)::
|
Example of a simple archive listing (``borg list --last 1 --json``)::
|
||||||
|
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in New Issue