1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-09 13:53:09 +00:00
borg/docs/usage/info.rst.inc

91 lines
9.9 KiB
PHP
Raw Normal View History

2016-07-05 23:30:08 +02:00
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_info:
borg info
---------
.. code-block:: none
2024-09-26 07:57:01 +02:00
borg [common options] info [options] [NAME]
2017-06-20 15:22:24 +02:00
.. only:: html
.. class:: borg-options-table
2024-10-03 12:23:03 +02:00
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``NAME`` | specify the archive name |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--json`` | format output as JSON |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; 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 |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--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. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
2017-06-20 15:22:24 +02:00
.. raw:: html
<script type='text/javascript'>
$(document).ready(function () {
2017-06-20 15:22:24 +02:00
$('.borg-options-table colgroup').remove();
})
</script>
.. only:: latex
2024-09-26 07:57:01 +02:00
NAME
specify the archive name
2017-06-20 15:22:24 +02:00
2024-07-19 20:40:15 +02:00
optional arguments
2017-06-20 15:22:24 +02:00
--json format output as JSON
:ref:`common_options`
|
2017-07-23 17:12:01 +02:00
Archive filters
2024-10-03 12:23:03 +02:00
-a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
2022-10-02 15:51:17 +02:00
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
2023-02-26 21:30:28 +01:00
--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.
2024-02-20 17:11:43 +01:00
--older TIMESPAN consider archives older than (now - TIMESPAN), e.g. 7d or 12m.
2023-02-26 21:30:28 +01:00
--newer TIMESPAN consider archives newer than (now - TIMESPAN), e.g. 7d or 12m.
2017-06-20 11:49:26 +02:00
2016-10-01 18:23:36 +02:00
Description
~~~~~~~~~~~
2022-06-24 01:19:19 +02:00
This command displays detailed information about the specified archive.
2016-07-06 01:33:53 +02:00
2016-10-01 18:23:36 +02: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:
2016-08-28 00:17:24 +02:00
2016-10-01 18:23:36 +02:00
This archive / deduplicated size = amount of data stored ONLY for this archive
= unique chunks of this archive.
2016-10-01 18:23:36 +02:00
All archives / deduplicated size = amount of data stored in the repo
2022-08-07 19:20:34 +02:00
= all chunks in the repository.