mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-26 01:37:20 +00:00
Code Issues Releases Wiki Activity
borg/docs/usage/info.rst.inc

46 lines
1.5 KiB
PHP
Raw Normal View History

update usage files
2016-07-05 21:30:08 +00:00
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
.. _borg_info:
borg info
---------
docs: usage: avoid bash highlight, [options] instead of <options>
2017-06-06 22:44:53 +00:00
.. code-block:: none
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
docs: usage: avoid bash highlight, [options] instead of <options>
2017-06-06 22:44:53 +00:00
borg [common options] info [options] REPOSITORY_OR_ARCHIVE
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-09 23:28:18 +00:00
positional arguments
ran build_usage
2016-08-27 22:17:24 +00:00
REPOSITORY_OR_ARCHIVE
archive or repository to display information about
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-09 23:28:18 +00:00
ran setup.py build_usage
2017-03-26 23:45:45 +00:00
optional arguments
``--json``
| format output as JSON
docs: split usage
2017-06-06 22:06:36 +00:00
:ref:`common_options`
Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour.
2016-04-09 23:28:18 +00:00
|
ran build_usage
2016-10-01 16:23:36 +00:00
filters
``-P``, ``--prefix``
python setup.py build_usage
2017-06-17 10:28:42 +00:00
| only consider archive names starting with this prefix.
``-a``, ``--glob-archives``
| only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
ran build_usage
2016-10-01 16:23:36 +00:00
``--sort-by``
| Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
``--first N``
| consider first N archives after other filters were applied
``--last N``
| consider last N archives after other filters were applied
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
Description
~~~~~~~~~~~
ran build_usage
2016-08-27 22:17:24 +00:00
This command displays detailed information about the specified archive or repository.
Merge branch '1.0-maint'
2016-07-05 23:33:53 +00:00
ran build_usage
2016-10-01 16:23:36 +00:00
Please note that the deduplicated sizes of the individual archives do not add
up to the deduplicated size of the repository ("all archives"), because the two
are meaning different things:
ran build_usage
2016-08-27 22:17:24 +00:00
ran build_usage
2016-10-01 16:23:36 +00:00
This archive / deduplicated size = amount of data stored ONLY for this archive
= unique chunks of this archive.
All archives / deduplicated size = amount of data stored in the repo
ran setup.py build_usage
2017-03-26 23:45:45 +00:00
= all chunks in the repository.
Reference in a new issue Copy permalink