mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-24 00:37:56 +00:00
174 lines
4.4 KiB
Groff
174 lines
4.4 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-RLIST" 1 "2023-02-26" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-rlist \- List the archives contained in a repository
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] rlist [options]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command lists the archives contained in a repository.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-consider\-checkpoints
|
|
Show checkpoint archives in the repository contents list (default: hidden).
|
|
.TP
|
|
.B \-\-short
|
|
only print the archive names, nothing else
|
|
.TP
|
|
.BI \-\-format \ FORMAT
|
|
specify format for archive listing (default: \(dq{archive:<36} {time} [{id}]{NL}\(dq)
|
|
.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 archive names matching the pattern. see \(dqborg help match\-archives\(dq.
|
|
.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
|
|
.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 oder 12m.
|
|
.TP
|
|
.BI \-\-newer \ TIMESPAN
|
|
consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m.
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
$ borg rlist
|
|
Monday Mon, 2016\-02\-15 19:15:11
|
|
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
|
|
\&...
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH NOTES
|
|
.SS The FORMAT specifier syntax
|
|
.sp
|
|
The \fB\-\-format\fP option uses python\(aqs \fI\%format string syntax\fP\&.
|
|
.sp
|
|
Examples:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
$ borg rlist \-\-format \(aq{archive}{NL}\(aq
|
|
ArchiveFoo
|
|
ArchiveBar
|
|
\&...
|
|
|
|
# {VAR:NUMBER} \- pad to NUMBER columns.
|
|
# Strings are left\-aligned, numbers are right\-aligned.
|
|
# Note: time columns except \(ga\(gaisomtime\(ga\(ga, \(ga\(gaisoctime\(ga\(ga and \(ga\(gaisoatime\(ga\(ga cannot be padded.
|
|
$ borg rlist \-\-format \(aq{archive:36} {time} [{id}]{NL}\(aq /path/to/repo
|
|
ArchiveFoo Thu, 2021\-12\-09 10:22:28 [0b8e9a312bef3f2f6e2d0fc110c196827786c15eba0188738e81697a7fa3b274]
|
|
\&...
|
|
.ft P
|
|
.fi
|
|
.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
|
|
.IP \(bu 2
|
|
TAB
|
|
.IP \(bu 2
|
|
CR
|
|
.IP \(bu 2
|
|
LF
|
|
.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
|
|
start: time (start) of creation of the archive
|
|
.IP \(bu 2
|
|
time: alias of \(dqstart\(dq
|
|
.IP \(bu 2
|
|
end: time (end) of creation of the archive
|
|
.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
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|