2018-07-12 20:00:19 +00:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
|
.
|
2021-02-06 00:32:54 +00:00
|
|
|
.TH BORG-COMPACT 1 "2021-02-06" "" "borg backup tool"
|
2018-07-12 20:00:19 +00:00
|
|
|
.SH NAME
|
|
|
|
|
borg-compact \- compact segment files in the repository
|
|
|
|
|
.
|
|
|
|
|
.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
|
|
|
|
|
..
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.sp
|
2019-09-06 22:36:10 +00:00
|
|
|
borg [common options] compact [options] [REPOSITORY]
|
2018-07-12 20:00:19 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.sp
|
|
|
|
|
This command frees repository space by compacting segments.
|
|
|
|
|
.sp
|
|
|
|
|
Use this regularly to avoid running out of space \- you do not need to use this
|
2019-09-06 22:36:10 +00:00
|
|
|
after each borg command though. It is especially useful after deleting archives,
|
|
|
|
|
because only compaction will really free repository space.
|
2018-07-12 20:00:19 +00:00
|
|
|
.sp
|
|
|
|
|
borg compact does not need a key, so it is possible to invoke it from the
|
|
|
|
|
client or also from the server.
|
|
|
|
|
.sp
|
2019-09-06 22:36:10 +00:00
|
|
|
Depending on the amount of segments that need compaction, it may take a while,
|
|
|
|
|
so consider using the \fB\-\-progress\fP option.
|
|
|
|
|
.sp
|
2019-11-01 17:21:26 +00:00
|
|
|
A segment is compacted if the amount of saved space is above the percentage value
|
2021-02-06 00:32:54 +00:00
|
|
|
given by the \fB\-\-threshold\fP option. If omitted, a threshold of 10% is used.
|
2019-09-06 22:36:10 +00:00
|
|
|
When using \fB\-\-verbose\fP, borg will output an estimate of the freed space.
|
|
|
|
|
.sp
|
|
|
|
|
After upgrading borg (server) to 1.2+, you can use \fBborg compact \-\-cleanup\-commits\fP
|
|
|
|
|
to clean up the numerous 17byte commit\-only segments that borg 1.1 did not clean up
|
|
|
|
|
due to a bug. It is enough to do that once per repository.
|
2018-07-12 20:00:19 +00:00
|
|
|
.sp
|
|
|
|
|
See \fIseparate_compaction\fP in Additional Notes for more details.
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.sp
|
|
|
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
|
|
|
.SS arguments
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B REPOSITORY
|
|
|
|
|
repository to compact
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SS optional arguments
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B \-\-cleanup\-commits
|
|
|
|
|
cleanup commit\-only 17\-byte segment files
|
2019-11-01 17:21:26 +00:00
|
|
|
.TP
|
|
|
|
|
.BI \-\-threshold \ PERCENT
|
|
|
|
|
set minimum threshold for saved space in PERCENT (Default: 10)
|
2018-07-12 20:00:19 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.SH EXAMPLES
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
# compact segments and free repo disk space
|
|
|
|
|
$ borg compact /path/to/repo
|
|
|
|
|
|
2019-09-06 22:36:10 +00:00
|
|
|
# same as above plus clean up 17byte commit\-only segments
|
2018-07-12 20:00:19 +00:00
|
|
|
$ borg compact \-\-cleanup\-commits /path/to/repo
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.sp
|
|
|
|
|
\fIborg\-common(1)\fP
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
The Borg Collective
|
|
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.
|
