mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

rcompress docs / examples / markup fixes

This commit is contained in:
Thomas Waldmann 2022-10-02 15:39:10 +02:00
parent c6785c8f15
commit 5d8d21df4d
4 changed files with 92 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/usage/rcompress.rst Normal file
View File

@ -0,0 +1,12 @@
.. include:: rcompress.rst.inc
Examples
~~~~~~~~
::
# recompress repo contents
$ borg rcompress --progress --compression=zstd,3
# recompress and obfuscate repo contents
$ borg rcompress --progress --compression=obfuscate,1,zstd,3

78
docs/usage/rcompress.rst.inc Normal file
View File

@ -0,0 +1,78 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_rcompress:
borg rcompress
--------------
.. code-block:: none
borg [common options] rcompress [options]
.. only:: html
.. class:: borg-options-table
+-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| **optional arguments** |
+-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details. |
+-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``-s``, ``--stats`` | print statistics |
+-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800) |
+-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
.. raw:: html
<script type='text/javascript'>
$(document).ready(function () {
$('.borg-options-table colgroup').remove();
})
</script>
.. only:: latex
optional arguments
-C COMPRESSION, --compression COMPRESSION select compression algorithm, see the output of the "borg help compression" command for details.
-s, --stats print statistics
-c SECONDS, --checkpoint-interval SECONDS write checkpoint every SECONDS seconds (Default: 1800)
:ref:`common_options`
|
Description
~~~~~~~~~~~
Repository (re-)compression (and/or re-obfuscation).
Reads all chunks in the repository (in on-disk order, this is important for
compaction) and recompresses them if they are not already using the compression
type/level and obfuscation level given via ``--compression``.
If the outcome of the chunk processing indicates a change in compression
type/level or obfuscation level, the processed chunk is written to the repository.
Please note that the outcome might not always be the desired compression
type/level - if no compression gives a shorter output, that might be chosen.
Every ``--checkpoint-interval``, progress is committed to the repository and
the repository is compacted (this is to keep temporary repo space usage in bounds).
A lower checkpoint interval means lower temporary repo space usage, but also
slower progress due to higher overhead (and vice versa).
Please note that this command can not work in low (or zero) free disk space
conditions.
If the ``borg rcompress``process receives a SIGINT signal (Ctrl-C), the repo
will be committed and compacted and borg will terminate cleanly afterwards.
Both ``--progress`` and ``--stats`` are recommended when ``borg rcompress``
is used interactively.
You do **not** need to run ``borg compact`` after ``borg rcompress``.

1
src/borg/archiver/help_cmd.py
View File

@ -262,6 +262,7 @@ class HelpMixIn:
This is very powerful, but can also get rather complicated.
Examples::
# id: style
borg delete --match-archives 'id:archive-with-crap'
borg delete -a 'id:archive-with-crap' # same, using short option

2
src/borg/archiver/rcompress_cmd.py
View File

@ -203,7 +203,7 @@ class RCompressMixIn:
Please note that this command can not work in low (or zero) free disk space
conditions.
If the ``borg rcompress``process receives a SIGINT signal (Ctrl-C), the repo
If the ``borg rcompress`` process receives a SIGINT signal (Ctrl-C), the repo
will be committed and compacted and borg will terminate cleanly afterwards.
Both ``--progress`` and ``--stats`` are recommended when ``borg rcompress``