borgbackup/docs/man/borg-undelete.1

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

103 lines
2.7 KiB
Groff
Raw Normal View History

2026-03-15 09:34:31 -04:00
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
2024-11-16 14:14:16 -05:00
.
.
.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
..
2026-06-16 08:17:43 -04:00
.TH "borg-undelete" "1" "2026-06-16" "" "borg backup tool"
2026-03-15 09:34:31 -04:00
.SH Name
2025-12-23 12:00:09 -05:00
borg-undelete \- Undeletes archives.
2024-11-16 14:14:16 -05:00
.SH SYNOPSIS
.sp
borg [common options] undelete [options] [NAME]
.SH DESCRIPTION
.sp
This command undeletes archives in the repository.
.sp
Important: Undeleting archives is only possible before compacting.
Once \fBborg compact\fP has run, all disk space occupied only by the
2025-12-23 12:00:09 -05:00
soft\-deleted archives will be freed, and undeleting is no longer
possible.
2024-11-16 14:14:16 -05:00
.sp
2025-12-23 12:00:09 -05:00
When in doubt, use \fB\-\-dry\-run \-\-list\fP to see what would be
undeleted.
2024-11-16 14:14:16 -05:00
.sp
2025-12-23 12:00:09 -05:00
You can undelete multiple archives by specifying a match pattern using
the \fB\-\-match\-archives PATTERN\fP option (for more information on these
patterns, see \fIborg_patterns\fP).
2024-11-16 14:14:16 -05:00
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0.0
.TP
.B NAME
specify the archive name
.UNINDENT
2025-04-21 15:07:46 -04:00
.SS options
2024-11-16 14:14:16 -05:00
.INDENT 0.0
.TP
.B \-n\fP,\fB \-\-dry\-run
2025-12-23 12:00:09 -05:00
do not change the repository
2024-11-16 14:14:16 -05:00
.TP
.B \-\-list
2025-12-23 12:00:09 -05:00
output a verbose list of archives
2024-11-16 14:14:16 -05:00
.UNINDENT
.SS Archive filters
.INDENT 0.0
.TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
2025-12-23 12:00:09 -05:00
only consider archives matching all patterns. See \(dqborg help match\-archives\(dq.
2024-11-16 14:14:16 -05:00
.TP
.BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP
.BI \-\-first \ N
2025-12-23 12:00:09 -05:00
consider the first N archives after other filters are applied
2024-11-16 14:14:16 -05:00
.TP
.BI \-\-last \ N
2025-12-23 12:00:09 -05:00
consider the last N archives after other filters are applied
2024-11-16 14:14:16 -05:00
.TP
.BI \-\-oldest \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
2024-11-16 14:14:16 -05:00
.TP
.BI \-\-newest \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g., 7d or 12m.
2024-11-16 14:14:16 -05:00
.TP
.BI \-\-older \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives older than (now \- TIMESPAN), e.g., 7d or 12m.
2024-11-16 14:14:16 -05:00
.TP
.BI \-\-newer \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
2024-11-16 14:14:16 -05:00
.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
2026-03-15 09:34:31 -04:00
.SH Author
2024-11-16 14:14:16 -05:00
The Borg Collective
2026-03-15 09:34:31 -04:00
.\" End of generated man page.