mirror of https://github.com/borgbackup/borg.git
156 lines
4.8 KiB
Groff
156 lines
4.8 KiB
Groff
.\" 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
|
|
..
|
|
.TH "BORG-DELETE" 1 "2022-02-19" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-delete \- Delete an existing repository or archives
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command deletes an archive from the repository or the complete repository.
|
|
.sp
|
|
Important: When deleting archives, repository disk space is \fBnot\fP freed until
|
|
you run \fBborg compact\fP\&.
|
|
.sp
|
|
When you delete a complete repository, the security info and local cache for it
|
|
(if any) are also deleted. Alternatively, you can delete just the local cache
|
|
with the \fB\-\-cache\-only\fP option, or keep the security info with the
|
|
\fB\-\-keep\-security\-info\fP option.
|
|
.sp
|
|
When in doubt, use \fB\-\-dry\-run \-\-list\fP to see what would be deleted.
|
|
.sp
|
|
When using \fB\-\-stats\fP, you will get some statistics about how much data was
|
|
deleted \- the "Deleted data" deduplicated size there is most interesting as
|
|
that is how much your repository will shrink.
|
|
Please note that the "All archives" stats refer to the state after deletion.
|
|
.sp
|
|
You can delete multiple archives by specifying their common prefix, if they
|
|
have one, using the \fB\-\-prefix PREFIX\fP option. You can also specify a shell
|
|
pattern to match multiple archives using the \fB\-\-glob\-archives GLOB\fP option
|
|
(for more info on these patterns, see \fIborg_patterns\fP). Note that these
|
|
two options are mutually exclusive.
|
|
.sp
|
|
To avoid accidentally deleting archives, especially when using glob patterns,
|
|
it might be helpful to use the \fB\-\-dry\-run\fP to test out the command without
|
|
actually making any changes to the repository.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B REPOSITORY_OR_ARCHIVE
|
|
repository or archive to delete
|
|
.TP
|
|
.B ARCHIVE
|
|
archives to delete
|
|
.UNINDENT
|
|
.SS optional arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-n\fP,\fB \-\-dry\-run
|
|
do not change repository
|
|
.TP
|
|
.B \-\-list
|
|
output verbose list of archives
|
|
.TP
|
|
.B \-s\fP,\fB \-\-stats
|
|
print statistics for the deleted archive
|
|
.TP
|
|
.B \-\-cache\-only
|
|
delete only the local cache for the given repository
|
|
.TP
|
|
.B \-\-force
|
|
force deletion of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work.
|
|
.TP
|
|
.B \-\-keep\-security\-info
|
|
keep the local security info when deleting a repository
|
|
.TP
|
|
.B \-\-save\-space
|
|
work slower, but using less space
|
|
.UNINDENT
|
|
.SS Archive filters
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX
|
|
only consider archive names starting with this prefix.
|
|
.TP
|
|
.BI \-a \ GLOB\fR,\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.
|
|
.TP
|
|
.BI \-\-sort\-by \ KEYS
|
|
Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
|
|
.TP
|
|
.BI \-\-first \ N
|
|
consider first N archives after other filters were applied
|
|
.TP
|
|
.BI \-\-last \ N
|
|
consider last N archives after other filters were applied
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
# delete a single backup archive:
|
|
$ borg delete /path/to/repo::Monday
|
|
# actually free disk space:
|
|
$ borg compact /path/to/repo
|
|
|
|
# delete all archives whose names begin with the machine\(aqs hostname followed by "\-"
|
|
$ borg delete \-\-prefix \(aq{hostname}\-\(aq /path/to/repo
|
|
|
|
# delete all archives whose names contain "\-2012\-"
|
|
$ borg delete \-\-glob\-archives \(aq*\-2012\-*\(aq /path/to/repo
|
|
|
|
# see what would be deleted if delete was run without \-\-dry\-run
|
|
$ borg delete \-\-list \-\-dry\-run \-a \(aq*\-May\-*\(aq /path/to/repo
|
|
|
|
# delete the whole repository and the related local cache:
|
|
$ borg delete /path/to/repo
|
|
You requested to completely DELETE the repository *including* all archives it contains:
|
|
repo Mon, 2016\-02\-15 19:26:54
|
|
root\-2016\-02\-15 Mon, 2016\-02\-15 19:36:29
|
|
newname Mon, 2016\-02\-15 19:50:19
|
|
Type \(aqYES\(aq if you understand this and want to continue: YES
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP, \fIborg\-compact(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|