Browse Source

compact: improve docs

- say when it is useful
- point to --verbose and --progress
Thomas Waldmann 6 years ago
parent
commit
4b1cbc8319
1 changed files with 6 additions and 2 deletions
  1. 6 2
      src/borg/archiver.py

+ 6 - 2
src/borg/archiver.py

@@ -2777,12 +2777,16 @@ class Archiver:
         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.
         """)