summaryrefslogtreecommitdiffstats
path: root/docs/man/borg-prune.1
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2017-08-27 22:18:45 +0200
committerThomas Waldmann <tw@waldmann-edv.de>2017-08-27 22:18:45 +0200
commit168293ea807329d1a0cfa7213b2ae1a309be8326 (patch)
tree271dd261fd234c123c24816fb6d005e084e404a3 /docs/man/borg-prune.1
parent9f61747dae65d96f7eeaabd5c2a0b8ad40b40b13 (diff)
python setup.py build_man1.1.0rc2
Diffstat (limited to 'docs/man/borg-prune.1')
-rw-r--r--docs/man/borg-prune.129
1 files changed, 21 insertions, 8 deletions
diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1
index 941a398d9..92b2cd35f 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-06-18" "" "borg backup tool"
+.TH BORG-PRUNE 1 "2017-08-27" "" "borg backup tool"
.SH NAME
borg-prune \- Prune repository archives according to specified rules
.
@@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
-borg [common options] prune <options> REPOSITORY
+borg [common options] prune [options] [REPOSITORY]
.SH DESCRIPTION
.sp
The prune command prunes a repository by deleting all archives not matching
@@ -97,7 +97,7 @@ print statistics for the deleted archive
.B \-\-list
output verbose list of archives it keeps/prunes
.TP
-.BI \-\-keep\-within \ WITHIN
+.BI \-\-keep\-within \ INTERVAL
keep all archives within this time interval
.TP
.B \-\-keep\-last\fP,\fB \-\-keep\-secondly
@@ -124,13 +124,13 @@ number of yearly archives to keep
.B \-\-save\-space
work slower, but using less space
.UNINDENT
-.SS filters
+.SS Archive filters
.INDENT 0.0
.TP
-.B \-P\fP,\fB \-\-prefix
+.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX
only consider archive names starting with this prefix.
.TP
-.B \-a\fP,\fB \-\-glob\-archives
+.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB
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
@@ -145,8 +145,6 @@ prefix "foo" if you do not also want to match "foobar".
.sp
It is strongly recommended to always run \fBprune \-v \-\-list \-\-dry\-run ...\fP
first so you will see what it would do without it actually doing anything.
-.sp
-There is also a visualized prune example in \fBdocs/misc/prune\-example.txt\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
@@ -171,6 +169,21 @@ $ borg prune \-v \-\-list \-\-keep\-within=10d \-\-keep\-weekly=4 \-\-keep\-mont
.fi
.UNINDENT
.UNINDENT
+.sp
+There is also a visualized prune example in \fBdocs/misc/prune\-example.txt\fP:
+.IP "System Message: ERROR/3 (docs/virtmanpage.rst:, line 140)"
+Unknown directive type "highlight".
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+\&.. highlight:: none
+
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP