1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-23 00:07:38 +00:00
borg/docs/man/borg-repo-compress.1

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

92 lines
2.6 KiB
Groff
Raw Normal View History

2023-01-02 22:51:22 +00:00
.\" 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
..
2024-10-03 10:23:03 +00:00
.TH "BORG-REPO-COMPRESS" 1 "2024-10-03" "" "borg backup tool"
2023-01-02 22:51:22 +00:00
.SH NAME
2024-09-08 15:52:10 +00:00
borg-repo-compress \- Repository (re-)compression
2023-01-02 22:51:22 +00:00
.SH SYNOPSIS
.sp
2024-09-08 15:52:10 +00:00
borg [common options] repo\-compress [options]
2023-01-02 22:51:22 +00:00
.SH DESCRIPTION
.sp
Repository (re\-)compression (and/or re\-obfuscation).
.sp
2024-09-07 20:31:48 +00:00
Reads all chunks in the repository and recompresses them if they are not already
using the compression type/level and obfuscation level given via \fB\-\-compression\fP\&.
2023-01-02 22:51:22 +00:00
.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
Please note that this command can not work in low (or zero) free disk space
conditions.
.sp
2024-09-08 15:52:10 +00:00
If the \fBborg repo\-compress\fP process receives a SIGINT signal (Ctrl\-C), the repo
2023-01-02 22:51:22 +00:00
will be committed and compacted and borg will terminate cleanly afterwards.
.sp
2024-09-08 15:52:10 +00:00
Both \fB\-\-progress\fP and \fB\-\-stats\fP are recommended when \fBborg repo\-compress\fP
2023-01-02 22:51:22 +00:00
is used interactively.
.sp
2024-09-08 15:52:10 +00:00
You do \fBnot\fP need to run \fBborg compact\fP after \fBborg repo\-compress\fP\&.
2023-01-02 22:51:22 +00:00
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
2024-07-19 18:40:15 +00:00
.SS optional arguments
2023-01-02 22:51:22 +00:00
.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
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# recompress repo contents
2024-09-08 15:52:10 +00:00
$ borg repo\-compress \-\-progress \-\-compression=zstd,3
2023-01-02 22:51:22 +00:00
# recompress and obfuscate repo contents
2024-09-08 15:52:10 +00:00
$ borg repo\-compress \-\-progress \-\-compression=obfuscate,1,zstd,3
2023-01-02 22:51:22 +00:00
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
The Borg Collective
.\" Generated by docutils manpage writer.
.