compact.rst.inc 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_compact:
  3. borg compact
  4. ------------
  5. .. code-block:: none
  6. borg [common options] compact [options]
  7. .. only:: html
  8. .. class:: borg-options-table
  9. +-------------------------------------------------------+
  10. | .. class:: borg-common-opt-ref |
  11. | |
  12. | :ref:`common_options` |
  13. +-------------------------------------------------------+
  14. .. raw:: html
  15. <script type='text/javascript'>
  16. $(document).ready(function () {
  17. $('.borg-options-table colgroup').remove();
  18. })
  19. </script>
  20. .. only:: latex
  21. :ref:`common_options`
  22. |
  23. Description
  24. ~~~~~~~~~~~
  25. Free repository space by deleting unused chunks.
  26. borg compact analyzes all existing archives to find out which chunks are
  27. actually used. There might be unused chunks resulting from borg delete or prune,
  28. which can be removed to free space in the repository.
  29. Differently than borg 1.x, borg2's compact needs the borg key if the repo is
  30. encrypted.