upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-07-10 10:42:09 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
borgbackup/docs/usage/info.rst.inc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

91 lines
9.9 KiB
PHP
Raw Normal View History

update usage files
2016-07-05 17:30:08 -04: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 10:42:16 -05:00
.. _borg_info:
borg info
---------
docs: usage: avoid bash highlight, [options] instead of <options>
2017-06-06 18:44:53 -04: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 10:42:16 -05:00
build_usage build_man
2024-09-26 01:57:01 -04:00
borg [common options] info [options] [NAME]
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 19:28:18 -04:00
ran build_usage
2017-06-20 09:22:24 -04:00
.. only:: html
.. class:: borg-options-table
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``NAME`` | specify the archive name |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage / build_man
2025-04-21 15:07:46 -04:00
| **options** |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--json`` | format output as JSON |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage build_man
2025-12-23 12:00:09 -05:00
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. See "borg help match-archives". |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage build_man
2025-12-23 12:00:09 -05:00
| | ``--first N`` | consider the first N archives after other filters are applied |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage build_man
2025-12-23 12:00:09 -05:00
| | ``--last N`` | consider the last N archives after other filters are applied |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage build_man
2025-12-23 12:00:09 -05:00
| | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g., 7d or 12m. |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage build_man
2025-12-23 12:00:09 -05:00
| | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g., 7d or 12m. |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage build_man
2025-12-23 12:00:09 -05:00
| | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g., 7d or 12m. |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
build_usage build_man
2025-12-23 12:00:09 -05:00
| | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g., 7d or 12m. |
build_usage / build_man
2024-10-03 06:23:03 -04:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
ran build_usage
2017-06-20 09:22:24 -04:00
.. raw:: html
<script type='text/javascript'>
docs: use DOM ready event, not document loaded event
2017-06-20 09:48:30 -04:00
$(document).ready(function () {
ran build_usage
2017-06-20 09:22:24 -04:00
$('.borg-options-table colgroup').remove();
})
</script>
.. only:: latex
build_usage build_man
2024-09-26 01:57:01 -04:00
NAME
specify the archive name
ran build_usage
2017-06-20 09:22:24 -04:00
build_usage / build_man
2025-04-21 15:07:46 -04:00
options
ran build_usage
2017-06-20 09:22:24 -04:00
--json format output as JSON
:ref:`common_options`
|
python setup.py build_usage
2017-07-23 11:12:01 -04:00
Archive filters
build_usage build_man
2025-12-23 12:00:09 -05:00
-a PATTERN, --match-archives PATTERN only consider archives matching all patterns. See "borg help match-archives".
build_usage / build_man
2024-10-03 06:23:03 -04:00
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
build_usage build_man
2025-12-23 12:00:09 -05:00
--first N consider the first N archives after other filters are applied
--last N consider the last N archives after other filters are applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
--newest TIMESPAN consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g., 7d or 12m.
--older TIMESPAN consider archives older than (now - TIMESPAN), e.g., 7d or 12m.
--newer TIMESPAN consider archives newer than (now - TIMESPAN), e.g., 7d or 12m.
ran build_usage
2017-06-20 05:49:26 -04:00
ran build_usage
2016-10-01 12:23:36 -04:00
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 10:42:16 -05:00
Description
~~~~~~~~~~~
build_usage / build_man / doc updates
2022-06-23 19:19:19 -04:00
This command displays detailed information about the specified archive.
Merge branch '1.0-maint'
2016-07-05 19:33:53 -04:00
ran build_usage
2016-10-01 12:23:36 -04: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
build_usage build_man
2025-12-23 12:00:09 -05:00
mean different things:
ran build_usage
2016-08-27 18:17:24 -04:00
ran build_usage
2016-10-01 12:23:36 -04:00
This archive / deduplicated size = amount of data stored ONLY for this archive
build_usage (master) also: add new borgfs.rst.inc
2017-11-25 08:35:52 -05:00
= unique chunks of this archive.
build_usage build_man
2025-12-23 12:00:09 -05:00
All archives / deduplicated size = amount of data stored in the repository
build_usage build_man
2022-08-07 13:20:34 -04:00
= all chunks in the repository.
Reference in a new issue Copy permalink