borgbackup/borg
1
1
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-09-11 12:36:12 +03:00
Code Issues Projects Releases Wiki Activity

compact: improve docs

Browse Source 
- say when it is useful
- point to --verbose and --progress
This commit is contained in:
Thomas Waldmann 2019-05-06 23:00:45 +02:00
parent 8b75dde0fa
commit 4b1cbc8319
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/borg/archiver.py
View File

@ -2777,12 +2777,16 @@ def define_archive_filters_group(subparser, *, sort_by=True, first_last=True):
This command frees repository space by compacting segments.
Use this regularly to avoid running out of space - you do not need to use this
after each borg command though.
after each borg command though. It is especially useful after deleting archives,
because only compaction will really free repository space.
borg compact does not need a key, so it is possible to invoke it from the
client or also from the server.
Depending on the amount of segments that need compaction, it may take a while.
Depending on the amount of segments that need compaction, it may take a while,
so consider using the ``--progress`` option.
When using ``--verbose``, borg will output an estimate of the freed space.
See :ref:`separate_compaction` in Additional Notes for more details.
""")