mirror of https://github.com/borgbackup/borg.git
101 lines
3.0 KiB
Groff
101 lines
3.0 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.TH "BORG-RCOMPRESS" 1 "2024-02-20" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-rcompress \- Repository (re-)compression
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] rcompress [options]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
Repository (re\-)compression (and/or re\-obfuscation).
|
|
.sp
|
|
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 \fB\-\-compression\fP\&.
|
|
.sp
|
|
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.
|
|
.sp
|
|
Every \fB\-\-checkpoint\-interval\fP, 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).
|
|
.sp
|
|
Please note that this command can not work in low (or zero) free disk space
|
|
conditions.
|
|
.sp
|
|
If the \fBborg rcompress\fP process receives a SIGINT signal (Ctrl\-C), the repo
|
|
will be committed and compacted and borg will terminate cleanly afterwards.
|
|
.sp
|
|
Both \fB\-\-progress\fP and \fB\-\-stats\fP are recommended when \fBborg rcompress\fP
|
|
is used interactively.
|
|
.sp
|
|
You do \fBnot\fP need to run \fBborg compact\fP after \fBborg rcompress\fP\&.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS options
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION
|
|
select compression algorithm, see the output of the \(dqborg help compression\(dq command for details.
|
|
.TP
|
|
.B \-s\fP,\fB \-\-stats
|
|
print statistics
|
|
.TP
|
|
.BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS
|
|
write checkpoint every SECONDS seconds (Default: 1800)
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
# recompress repo contents
|
|
$ borg rcompress \-\-progress \-\-compression=zstd,3
|
|
|
|
# recompress and obfuscate repo contents
|
|
$ borg rcompress \-\-progress \-\-compression=obfuscate,1,zstd,3
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|