mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-29 11:16:43 +00:00
73fac09dda
also: add new borgfs.rst.inc
87 lines
No EOL
8.8 KiB
HTML
87 lines
No EOL
8.8 KiB
HTML
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
.. _borg_info:
|
|
|
|
borg info
|
|
---------
|
|
.. code-block:: none
|
|
|
|
borg [common options] info [options] [REPOSITORY_OR_ARCHIVE]
|
|
|
|
.. only:: html
|
|
|
|
.. class:: borg-options-table
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| **positional arguments** |
|
|
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``REPOSITORY_OR_ARCHIVE`` | archive or repository to display information about |
|
|
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| **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. |
|
|
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``-P PREFIX``, ``--prefix PREFIX`` | only consider archive names starting with this prefix. |
|
|
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
|
|
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``--sort-by KEYS`` | 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 |
|
|
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. raw:: html
|
|
|
|
<script type='text/javascript'>
|
|
$(document).ready(function () {
|
|
$('.borg-options-table colgroup').remove();
|
|
})
|
|
</script>
|
|
|
|
.. only:: latex
|
|
|
|
REPOSITORY_OR_ARCHIVE
|
|
archive or repository to display information about
|
|
|
|
|
|
optional arguments
|
|
--json format output as JSON
|
|
|
|
|
|
:ref:`common_options`
|
|
|
|
|
|
|
Archive filters
|
|
-P PREFIX, --prefix PREFIX only consider archive names starting with this prefix.
|
|
-a GLOB, --glob-archives GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
|
|
--sort-by KEYS 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
|
|
|
|
|
|
Description
|
|
~~~~~~~~~~~
|
|
|
|
This command displays detailed information about the specified archive or repository.
|
|
|
|
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:
|
|
|
|
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
|
|
= all chunks in the repository.
|
|
|
|
Borg archives can only contain a limited amount of file metadata.
|
|
The size of an archive relative to this limit depends on a number of factors,
|
|
mainly the number of files, the lengths of paths and other metadata stored for files.
|
|
This is shown as *utilization of maximum supported archive size*. |