compact.rst.inc 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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] REPOSITORY
  7. .. only:: html
  8. .. class:: borg-options-table
  9. +-------------------------------------------------------+-----------------------+-------------------------------------------+
  10. | **positional arguments** |
  11. +-------------------------------------------------------+-----------------------+-------------------------------------------+
  12. | | ``REPOSITORY`` | repository to compact |
  13. +-------------------------------------------------------+-----------------------+-------------------------------------------+
  14. | **optional arguments** |
  15. +-------------------------------------------------------+-----------------------+-------------------------------------------+
  16. | | ``--cleanup-commits`` | cleanup commit-only 17-byte segment files |
  17. +-------------------------------------------------------+-----------------------+-------------------------------------------+
  18. | .. class:: borg-common-opt-ref |
  19. | |
  20. | :ref:`common_options` |
  21. +-------------------------------------------------------+-----------------------+-------------------------------------------+
  22. .. raw:: html
  23. <script type='text/javascript'>
  24. $(document).ready(function () {
  25. $('.borg-options-table colgroup').remove();
  26. })
  27. </script>
  28. .. only:: latex
  29. REPOSITORY
  30. repository to compact
  31. optional arguments
  32. --cleanup-commits cleanup commit-only 17-byte segment files
  33. :ref:`common_options`
  34. |
  35. Description
  36. ~~~~~~~~~~~
  37. This command frees repository space by compacting segments.
  38. Use this regularly to avoid running out of space - you do not need to use this
  39. after each borg command though.
  40. borg compact does not need a key, so it is possible to invoke it from the
  41. client or also from the server.
  42. Depending on the amount of segments that need compaction, it may take a while.
  43. See :ref:`separate_compaction` in Additional Notes for more details.