mirror of
https://github.com/borgbackup/borg.git
synced 2026-10-12 02:11:36 +00:00
215 lines
6.5 KiB
Groff
215 lines
6.5 KiB
Groff
.\" Man page generated from reStructuredText
|
|
.\" by the Docutils 0.22.4 manpage writer.
|
|
.
|
|
.
|
|
.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-repo-list" "1" "2026-09-27" "" "borg backup tool"
|
|
.SH Name
|
|
borg-repo-list \- List the archives contained in a repository.
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] repo\-list [options]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command lists the archives contained in a repository.
|
|
.SS Grouping archives
|
|
.sp
|
|
\fB\-\-group\-by\fP lists the archives grouped by the given comma\-separated archive
|
|
attributes, each group preceded by a header line naming it:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.EX
|
|
$ borg repo\-list \-\-group\-by name,host \-\-format \(aq{archive} {time}{NL}\(aq
|
|
Group (name=\(aqhome\(aq, host=\(aqhost1\(aq):
|
|
home Thu, 2026\-06\-04 18:00:00 +0200
|
|
home Wed, 2026\-06\-03 18:00:00 +0200
|
|
|
|
Group (name=\(aqhome\(aq, host=\(aqhost2\(aq):
|
|
home Thu, 2026\-06\-04 19:00:00 +0200
|
|
.EE
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Valid keys are \fBname\fP, \fBhost\fP, \fBuser\fP and \fBtags\fP; borg\(aqs internal tags (starting
|
|
with \fB@\fP) do not affect grouping. Archives without \fBhost\fP / \fBuser\fP metadata (e.g.
|
|
archives transferred from a borg 1.x repository) form their own group.
|
|
.sp
|
|
These are the same keys and the same grouping that \fBborg prune \-\-group\-by\fP uses, so
|
|
this is a way to see which archives a prune run will consider together before running
|
|
it. Without \fB\-\-group\-by\fP, archives are listed as before, ungrouped.
|
|
.sp
|
|
With \fB\-\-json\fP, no header lines are emitted; each archive gets a \fBgroup\fP object
|
|
instead.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-short
|
|
only print the archive IDs, nothing else
|
|
.TP
|
|
.B \-\-from\-borg1
|
|
repository is Borg 1.x
|
|
.TP
|
|
.BI \-\-format \ FORMAT
|
|
specify format for archive listing (default: \(dq{id:.8} {time} {archive:<15} {tags:<10} {username:<10} {hostname:<10} {comment:.40}{NL}\(dq)
|
|
.TP
|
|
.BI \-\-group\-by \ KEYS
|
|
comma\-separated list of archive attributes to group the listed archives by; valid keys are: name, host, user, tags; default is to not group
|
|
.TP
|
|
.B \-\-json
|
|
Format output as JSON. The form of \fB\-\-format\fP is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text.
|
|
.UNINDENT
|
|
.SS Archive filters
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
|
|
only consider archives matching all patterns. See \(dqborg help match\-archives\(dq.
|
|
.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
|
|
consider the first N archives after other filters are applied
|
|
.TP
|
|
.BI \-\-last \ N
|
|
consider the last N archives after other filters are applied
|
|
.TP
|
|
.BI \-\-oldest \ TIMESPAN
|
|
consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
|
|
.TP
|
|
.BI \-\-newest \ TIMESPAN
|
|
consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g., 7d or 12m.
|
|
.TP
|
|
.BI \-\-older \ TIMESPAN
|
|
consider archives older than (now \- TIMESPAN), e.g., 7d or 12m.
|
|
.TP
|
|
.BI \-\-newer \ TIMESPAN
|
|
consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
|
|
.TP
|
|
.B \-\-deleted
|
|
consider only soft\-deleted archives.
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.EX
|
|
$ borg repo\-list
|
|
76fcb5c7 Sat, 2026\-08\-29 14:36:22 +0200 docs tw MacBook\-Pro this is a comment
|
|
19356ae3 Sat, 2026\-08\-29 14:36:23 +0200 scripts tw MacBook\-Pro
|
|
7dd5756a Sat, 2026\-08\-29 14:36:23 +0200 scripts tw MacBook\-Pro
|
|
99b712ef Sat, 2026\-08\-29 14:36:23 +0200 src tw MacBook\-Pro
|
|
7698cd9e Sat, 2026\-08\-29 14:36:24 +0200 scripts tw MacBook\-Pro
|
|
f49f8762 Sat, 2026\-08\-29 14:36:24 +0200 docs tw MacBook\-Pro
|
|
\&...
|
|
.EE
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH NOTES
|
|
.SS The FORMAT specifier syntax
|
|
.sp
|
|
The \fB\-\-format\fP option uses Python\(aqs format string syntax \%<https://\:docs\:.python\:.org/\:3\:.11/\:library/\:string\:.html#\:formatstrings>\&.
|
|
.sp
|
|
Examples:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.EX
|
|
$ borg repo\-list \-\-format \(aq{archive}{NL}\(aq
|
|
ArchiveFoo
|
|
ArchiveBar
|
|
\&...
|
|
|
|
# {VAR:NUMBER} \- pad to NUMBER columns.
|
|
# Strings are left\-aligned, numbers are right\-aligned.
|
|
# Note: the time keys (time, start, end) can not be padded \- for them, the
|
|
# format spec is a strftime format string, e.g. {time:%Y\-%m\-%d}.
|
|
$ borg repo\-list \-\-format \(aq{archive:36} {time} [{id}]{NL}\(aq
|
|
ArchiveFoo Thu, 2021\-12\-09 10:22:28 [0b8e9...3b274]
|
|
\&...
|
|
.EE
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
The following keys are always available:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
NEWLINE: OS dependent line separator
|
|
.IP \(bu 2
|
|
NL: alias of NEWLINE
|
|
.IP \(bu 2
|
|
NUL: NUL character for creating print0 / xargs \-0 like output
|
|
.IP \(bu 2
|
|
SPACE: space character
|
|
.IP \(bu 2
|
|
TAB: tab character
|
|
.IP \(bu 2
|
|
CR: carriage return character
|
|
.IP \(bu 2
|
|
LF: line feed character
|
|
.UNINDENT
|
|
.sp
|
|
Keys available only when listing archives in a repository:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
archive: archive name
|
|
.IP \(bu 2
|
|
name: alias of \(dqarchive\(dq
|
|
.IP \(bu 2
|
|
comment: archive comment
|
|
.IP \(bu 2
|
|
id: internal ID of the archive
|
|
.IP \(bu 2
|
|
tags: archive tags
|
|
.IP \(bu 2
|
|
time: nominal time of the archive
|
|
.IP \(bu 2
|
|
start: start time of the archive operation
|
|
.IP \(bu 2
|
|
end: end time of the archive operation
|
|
.IP \(bu 2
|
|
command_line: command line which was used to create the archive
|
|
.IP \(bu 2
|
|
hostname: hostname of host on which this archive was created
|
|
.IP \(bu 2
|
|
username: username of user who created this archive
|
|
.IP \(bu 2
|
|
size: size of this archive (data plus metadata, not considering compression and deduplication)
|
|
.IP \(bu 2
|
|
nfiles: count of files in this archive
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH Author
|
|
The Borg Collective
|
|
.\" End of generated man page.
|