diff options
Diffstat (limited to 'docs/man/borg-prune.1')
-rw-r--r-- | docs/man/borg-prune.1 | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index dcb817a6e..941a398d9 100644 --- a/docs/man/borg-prune.1 +++ b/docs/man/borg-prune.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PRUNE 1 "2017-05-17" "" "borg backup tool" +.TH BORG-PRUNE 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-prune \- Prune repository archives according to specified rules . @@ -42,7 +42,7 @@ automated backup scripts wanting to keep a certain number of historic backups. Also, prune automatically removes checkpoint archives (incomplete archives left behind by interrupted backup runs) except if the checkpoint is the latest archive (and thus still needed). Checkpoint archives are not considered when -comparing archive counts against the retention limits (\-\-keep\-X). +comparing archive counts against the retention limits (\fB\-\-keep\-X\fP). .sp If a prefix is set with \-P, then only archives that start with the prefix are considered for deletion and only those archives count towards the totals @@ -55,14 +55,14 @@ If you have multiple sequences of archives with different data sets (e.g. from different machines) in one shared repository, use one prune call per data set that matches only the respective archives using the \-P option. .sp -The "\-\-keep\-within" option takes an argument of the form "<int><char>", -where char is "H", "d", "w", "m", "y". For example, "\-\-keep\-within 2d" means +The \fB\-\-keep\-within\fP option takes an argument of the form "<int><char>", +where char is "H", "d", "w", "m", "y". For example, \fB\-\-keep\-within 2d\fP means to keep all archives that were created within the past 48 hours. "1m" is taken to mean "31d". The archives kept with this option do not count towards the totals specified by any other options. .sp A good procedure is to thin out more and more the older your backups get. -As an example, "\-\-keep\-daily 7" means to keep the latest backup on each day, +As an example, \fB\-\-keep\-daily 7\fP means to keep the latest backup on each day, up to 7 most recent days with backups (days without backups do not count). The rules are applied from secondly to yearly, and backups selected by previous rules do not count towards those of later rules. The time that each backup @@ -70,7 +70,7 @@ starts is used for pruning purposes. Dates and times are interpreted in the local timezone, and weeks go from Monday to Sunday. Specifying a negative number of archives to keep means that there is no limit. .sp -The "\-\-keep\-last N" option is doing the same as "\-\-keep\-secondly N" (and it will +The \fB\-\-keep\-last N\fP option is doing the same as \fB\-\-keep\-secondly N\fP (and it will keep the last N archives under the assumption that you do not create more than one backup archive in the same second). .SH OPTIONS @@ -121,12 +121,18 @@ number of monthly archives to keep .B \-y\fP,\fB \-\-keep\-yearly number of yearly archives to keep .TP -.B \-P\fP,\fB \-\-prefix -only consider archive names starting with this prefix -.TP .B \-\-save\-space work slower, but using less space .UNINDENT +.SS filters +.INDENT 0.0 +.TP +.B \-P\fP,\fB \-\-prefix +only consider archive names starting with this prefix. +.TP +.B \-a\fP,\fB \-\-glob\-archives +only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. +.UNINDENT .SH EXAMPLES .sp Be careful, prune is a potentially dangerous command, it will remove backup |