diff options
Diffstat (limited to 'docs/man/borg-prune.1')
| -rw-r--r-- | docs/man/borg-prune.1 | 48 |
1 files changed, 21 insertions, 27 deletions
diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index 5074d012e..0cbb7f772 100644 --- a/docs/man/borg-prune.1 +++ b/docs/man/borg-prune.1 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PRUNE 1 "2022-04-14" "" "borg backup tool" -.SH NAME -borg-prune \- Prune repository archives according to specified rules . .nr rst2man-indent-level 0 . @@ -30,9 +27,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. +.TH "BORG-PRUNE" 1 "2022-06-25" "" "borg backup tool" +.SH NAME +borg-prune \- Prune repository archives according to specified rules .SH SYNOPSIS .sp -borg [common options] prune [options] [REPOSITORY] +borg [common options] prune [options] .SH DESCRIPTION .sp The prune command prunes a repository by deleting all archives not matching @@ -91,52 +91,46 @@ Please note that the "All archives" stats refer to the state after pruning. .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. -.SS arguments -.INDENT 0.0 -.TP -.B REPOSITORY -repository to prune -.UNINDENT .SS optional arguments .INDENT 0.0 .TP -.B \-n\fP,\fB \-\-dry\-run +.B \-n\fP,\fB \-\-dry\-run do not change repository .TP -.B \-\-force +.B \-\-force force pruning of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work. .TP -.B \-s\fP,\fB \-\-stats +.B \-s\fP,\fB \-\-stats print statistics for the deleted archive .TP -.B \-\-list +.B \-\-list output verbose list of archives it keeps/prunes .TP .BI \-\-keep\-within \ INTERVAL keep all archives within this time interval .TP -.B \-\-keep\-last\fP,\fB \-\-keep\-secondly +.B \-\-keep\-last\fP,\fB \-\-keep\-secondly number of secondly archives to keep .TP -.B \-\-keep\-minutely +.B \-\-keep\-minutely number of minutely archives to keep .TP -.B \-H\fP,\fB \-\-keep\-hourly +.B \-H\fP,\fB \-\-keep\-hourly number of hourly archives to keep .TP -.B \-d\fP,\fB \-\-keep\-daily +.B \-d\fP,\fB \-\-keep\-daily number of daily archives to keep .TP -.B \-w\fP,\fB \-\-keep\-weekly +.B \-w\fP,\fB \-\-keep\-weekly number of weekly archives to keep .TP -.B \-m\fP,\fB \-\-keep\-monthly +.B \-m\fP,\fB \-\-keep\-monthly number of monthly archives to keep .TP -.B \-y\fP,\fB \-\-keep\-yearly +.B \-y\fP,\fB \-\-keep\-yearly number of yearly archives to keep .TP -.B \-\-save\-space +.B \-\-save\-space work slower, but using less space .UNINDENT .SS Archive filters @@ -167,21 +161,21 @@ first so you will see what it would do without it actually doing anything. .ft C # Keep 7 end of day and 4 additional end of week archives. # Do a dry\-run without actually deleting anything. -$ borg prune \-v \-\-list \-\-dry\-run \-\-keep\-daily=7 \-\-keep\-weekly=4 /path/to/repo +$ borg prune \-v \-\-list \-\-dry\-run \-\-keep\-daily=7 \-\-keep\-weekly=4 # Same as above but only apply to archive names starting with the hostname # of the machine followed by a "\-" character: -$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-prefix=\(aq{hostname}\-\(aq /path/to/repo +$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-prefix=\(aq{hostname}\-\(aq # actually free disk space: -$ borg compact /path/to/repo +$ borg compact # Keep 7 end of day, 4 additional end of week archives, # and an end of month archive for every month: -$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-keep\-monthly=\-1 /path/to/repo +$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-keep\-monthly=\-1 # Keep all backups in the last 10 days, 4 additional end of week archives, # and an end of month archive for every month: -$ borg prune \-v \-\-list \-\-keep\-within=10d \-\-keep\-weekly=4 \-\-keep\-monthly=\-1 /path/to/repo +$ borg prune \-v \-\-list \-\-keep\-within=10d \-\-keep\-weekly=4 \-\-keep\-monthly=\-1 .ft P .fi .UNINDENT |