2018-07-12 20:00:19 +00:00
|
|
|
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
|
|
|
|
|
|
.. _borg_compact:
|
|
|
|
|
|
|
|
|
|
borg compact
|
|
|
|
|
------------
|
|
|
|
|
.. code-block:: none
|
|
|
|
|
|
2019-09-06 22:27:17 +00:00
|
|
|
borg [common options] compact [options] [REPOSITORY]
|
2018-07-12 20:00:19 +00:00
|
|
|
|
|
|
|
|
.. only:: html
|
|
|
|
|
|
|
|
|
|
.. class:: borg-options-table
|
|
|
|
|
|
2020-04-12 17:51:49 +00:00
|
|
|
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
|
|
|
|
| **positional arguments** |
|
|
|
|
|
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
|
|
|
|
| | ``REPOSITORY`` | repository to compact |
|
|
|
|
|
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
|
|
|
|
| **optional arguments** |
|
|
|
|
|
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
|
|
|
|
| | ``--cleanup-commits`` | cleanup commit-only 17-byte segment files |
|
|
|
|
|
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
|
|
|
|
| | ``--threshold PERCENT`` | set minimum threshold for saved space in PERCENT (Default: 10) |
|
|
|
|
|
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
|
|
|
|
| .. class:: borg-common-opt-ref |
|
|
|
|
|
| |
|
|
|
|
|
| :ref:`common_options` |
|
|
|
|
|
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
2018-07-12 20:00:19 +00:00
|
|
|
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<script type='text/javascript'>
|
|
|
|
|
$(document).ready(function () {
|
|
|
|
|
$('.borg-options-table colgroup').remove();
|
|
|
|
|
})
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
.. only:: latex
|
|
|
|
|
|
|
|
|
|
REPOSITORY
|
|
|
|
|
repository to compact
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
optional arguments
|
2020-04-12 17:51:49 +00:00
|
|
|
--cleanup-commits cleanup commit-only 17-byte segment files
|
|
|
|
|
--threshold PERCENT set minimum threshold for saved space in PERCENT (Default: 10)
|
2018-07-12 20:00:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
:ref:`common_options`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
This command frees repository space by compacting segments.
|
|
|
|
|
|
|
|
|
|
Use this regularly to avoid running out of space - you do not need to use this
|
2019-09-06 22:27:17 +00:00
|
|
|
after each borg command though. It is especially useful after deleting archives,
|
|
|
|
|
because only compaction will really free repository space.
|
2018-07-12 20:00:19 +00:00
|
|
|
|
|
|
|
|
borg compact does not need a key, so it is possible to invoke it from the
|
|
|
|
|
client or also from the server.
|
|
|
|
|
|
2019-09-06 22:27:17 +00:00
|
|
|
Depending on the amount of segments that need compaction, it may take a while,
|
|
|
|
|
so consider using the ``--progress`` option.
|
|
|
|
|
|
2020-04-12 17:51:49 +00:00
|
|
|
A segment is compacted if the amount of saved space is above the percentage value
|
2021-02-06 00:32:02 +00:00
|
|
|
given by the ``--threshold`` option. If omitted, a threshold of 10% is used.
|
2019-09-06 22:27:17 +00:00
|
|
|
When using ``--verbose``, borg will output an estimate of the freed space.
|
|
|
|
|
|
|
|
|
|
After upgrading borg (server) to 1.2+, you can use ``borg compact --cleanup-commits``
|
|
|
|
|
to clean up the numerous 17byte commit-only segments that borg 1.1 did not clean up
|
|
|
|
|
due to a bug. It is enough to do that once per repository.
|
2018-07-12 20:00:19 +00:00
|
|
|
|
|
|
|
|
See :ref:`separate_compaction` in Additional Notes for more details.
|
