2017-02-05 13:22:06 +00:00
. \" 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
. .
2024-09-26 05:57:01 +00:00
.TH "BORG-LIST" 1 "2024-09-26" "" "borg backup tool"
2022-06-23 23:19:19 +00:00
.SH NAME
borg-list \- List archive contents
2017-02-05 13:22:06 +00:00
.SH SYNOPSIS
.sp
2022-06-23 23:19:19 +00:00
borg [common options] list [options] NAME [PATH...]
2017-02-05 13:22:06 +00:00
.SH DESCRIPTION
.sp
2022-06-23 23:19:19 +00:00
This command lists the contents of an archive.
2017-02-05 13:22:06 +00:00
.sp
2022-02-19 17:48:13 +00:00
For more help on include/exclude patterns, see the \fI borg_patterns\fP command output.
2017-02-05 20:17:21 +00:00
.SH OPTIONS
.sp
See \fI borg\- common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0 .0
.TP
2022-06-23 23:19:19 +00:00
.B NAME
specify the archive name
2017-02-05 20:17:21 +00:00
.TP
.B PATH
paths to list; patterns are supported
.UNINDENT
2024-07-19 18:40:15 +00:00
.SS optional arguments
2017-02-05 20:17:21 +00:00
.INDENT 0 .0
.TP
2022-06-23 23:19:19 +00:00
.B \- \- short
2017-02-05 20:17:21 +00:00
only print file/directory names, nothing else
.TP
2022-01-23 14:53:42 +00:00
.BI \- \- format \ FORMAT
2022-09-10 14:03:27 +00:00
specify format for file listing (default: \(dq {mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}\(dq )
2017-02-05 20:17:21 +00:00
.TP
2022-06-23 23:19:19 +00:00
.B \- \- json\-lines
2023-01-02 22:51:22 +00:00
Format output as JSON Lines. 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.
2017-02-05 20:17:21 +00:00
.UNINDENT
2023-06-11 21:10:23 +00:00
.SS Include/Exclude options
2017-03-26 23:58:19 +00:00
.INDENT 0 .0
.TP
2020-10-04 18:33:08 +00:00
.BI \- e \ PATTERN\fR,\fB \ \- \- exclude \ PATTERN
2017-03-26 23:58:19 +00:00
exclude paths matching PATTERN
.TP
.BI \- \- exclude\-from \ EXCLUDEFILE
read exclude patterns from EXCLUDEFILE, one per line
.TP
.BI \- \- pattern \ PATTERN
2022-02-05 16:30:40 +00:00
include/exclude paths matching PATTERN
2017-03-26 23:58:19 +00:00
.TP
.BI \- \- patterns\-from \ PATTERNFILE
2022-02-05 16:30:40 +00:00
read include/exclude patterns from PATTERNFILE, one per line
2017-03-26 23:58:19 +00:00
.UNINDENT
2017-02-05 20:17:21 +00:00
.SH EXAMPLES
.INDENT 0 .0
.INDENT 3 .5
.sp
.nf
.ft C
2022-06-23 23:19:19 +00:00
$ borg list root\- 2016\- 02\- 15
2017-02-05 20:17:21 +00:00
drwxr\- xr\- x root root 0 Mon, 2016\- 02\- 15 17:44:27 .
drwxrwxr\- x root root 0 Mon, 2016\- 02\- 15 19:04:49 bin
\- rwxr\- xr\- x root root 1029624 Thu, 2014\- 11\- 13 00:08:51 bin/bash
lrwxrwxrwx root root 0 Fri, 2015\- 03\- 27 20:24:26 bin/bzcmp \- > bzdiff
\- rwxr\- xr\- x root root 2140 Fri, 2015\- 03\- 27 20:24:22 bin/bzdiff
\& ...
2022-09-10 14:03:27 +00:00
$ borg list root\- 2016\- 02\- 15 \- \- pattern \(dq \- bin/ba*\(dq
2020-12-06 19:45:41 +00:00
drwxr\- xr\- x root root 0 Mon, 2016\- 02\- 15 17:44:27 .
drwxrwxr\- x root root 0 Mon, 2016\- 02\- 15 19:04:49 bin
lrwxrwxrwx root root 0 Fri, 2015\- 03\- 27 20:24:26 bin/bzcmp \- > bzdiff
\- rwxr\- xr\- x root root 2140 Fri, 2015\- 03\- 27 20:24:22 bin/bzdiff
\& ...
2022-09-10 14:03:27 +00:00
$ borg list archiveA \- \- format=\(dq {mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}\(dq
2017-02-05 20:17:21 +00:00
drwxrwxr\- x user user 0 Sun, 2015\- 02\- 01 11:00:00 .
drwxrwxr\- x user user 0 Sun, 2015\- 02\- 01 11:00:00 code
drwxrwxr\- x user user 0 Sun, 2015\- 02\- 01 11:00:00 code/myproject
\- rw\- rw\- r\- \- user user 1416192 Sun, 2015\- 02\- 01 11:00:00 code/myproject/file.ext
2022-01-23 14:53:42 +00:00
\- rw\- rw\- r\- \- user user 1416192 Sun, 2015\- 02\- 01 11:00:00 code/myproject/file.text
\& ...
2023-09-14 13:52:08 +00:00
$ borg list archiveA \- \- pattern \(aq + re:\e .ext$\(aq \- \- pattern \(aq \- re:^.*$\(aq
2022-01-23 14:53:42 +00:00
\- rw\- rw\- r\- \- user user 1416192 Sun, 2015\- 02\- 01 11:00:00 code/myproject/file.ext
\& ...
2023-09-14 13:52:08 +00:00
$ borg list archiveA \- \- pattern \(aq + re:.ext$\(aq \- \- pattern \(aq \- re:^.*$\(aq
2022-01-23 14:53:42 +00:00
\- rw\- rw\- r\- \- user user 1416192 Sun, 2015\- 02\- 01 11:00:00 code/myproject/file.ext
\- rw\- rw\- r\- \- user user 1416192 Sun, 2015\- 02\- 01 11:00:00 code/myproject/file.text
2017-02-05 20:17:21 +00:00
\& ...
.ft P
.fi
.UNINDENT
.UNINDENT
.SH NOTES
2022-01-23 14:53:42 +00:00
.SS The FORMAT specifier syntax
2017-02-05 13:22:06 +00:00
.sp
2022-01-23 14:53:42 +00:00
The \fB \- \- format\fP option uses python\(aq s \fI \% format string syntax\fP \& .
.sp
Examples:
.INDENT 0 .0
.INDENT 3 .5
.sp
.nf
.ft C
2022-06-23 23:19:19 +00:00
$ borg list \- \- format \(aq {mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}\(aq ArchiveFoo
2022-01-23 14:53:42 +00:00
\- rw\- rw\- r\- \- user user 1024 Thu, 2021\- 12\- 09 10:22:17 file\- foo
\& ...
# {VAR:<NUMBER} \- pad to NUMBER columns left\- aligned.
# {VAR:>NUMBER} \- pad to NUMBER columns right\- aligned.
2022-06-23 23:19:19 +00:00
$ borg list \- \- format \(aq {mode} {user:>6} {group:>6} {size:<8} {mtime} {path}{extra}{NL}\(aq ArchiveFoo
2022-01-23 14:53:42 +00:00
\- rw\- rw\- r\- \- user user 1024 Thu, 2021\- 12\- 09 10:22:17 file\- foo
\& ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The following keys are always available:
2022-06-26 18:06:58 +00:00
.INDENT 0 .0
.IP \(bu 2
NEWLINE: OS dependent line separator
.IP \(bu 2
NL: alias of NEWLINE
.IP \(bu 2
2023-01-02 22:51:22 +00:00
NUL: NUL character for creating print0 / xargs \- 0 like output
2022-06-26 18:06:58 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
SPACE: space character
2022-06-26 18:06:58 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
TAB: tab character
2022-06-26 18:06:58 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
CR: carriage return character
2022-06-26 18:06:58 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
LF: line feed character
2022-06-26 18:06:58 +00:00
.UNINDENT
2017-02-05 13:22:06 +00:00
.sp
2022-01-23 14:53:42 +00:00
Keys available only when listing files in an archive:
2017-02-05 13:22:06 +00:00
.INDENT 0 .0
.IP \(bu 2
2023-06-11 21:10:23 +00:00
type: file type (file, dir, symlink, ...)
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
mode: file mode (as in stat)
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
uid: user id of file owner
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
gid: group id of file owner
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
user: user name of file owner
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
group: group name of file owner
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-01-02 22:51:22 +00:00
path: file path
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-02-26 20:30:54 +00:00
target: link target for symlinks
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2022-06-23 23:19:19 +00:00
hlid: hard link identity (same if hardlinking same fs object)
.IP \(bu 2
2023-06-11 21:10:23 +00:00
flags: file flags
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
size: file size
2017-02-05 13:22:06 +00:00
.IP \(bu 2
num_chunks: number of chunks in this file
.IP \(bu 2
2023-06-11 21:10:23 +00:00
mtime: file modification time
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
ctime: file change time
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
atime: file access time
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
isomtime: file modification time (ISO 8601 format)
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
isoctime: file change time (ISO 8601 format)
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
isoatime: file access time (ISO 8601 format)
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2020-10-04 18:33:08 +00:00
blake2b
.IP \(bu 2
blake2s
.IP \(bu 2
2017-02-05 13:22:06 +00:00
md5
.IP \(bu 2
sha1
.IP \(bu 2
sha224
.IP \(bu 2
sha256
.IP \(bu 2
sha384
.IP \(bu 2
2020-10-04 18:33:08 +00:00
sha3_224
.IP \(bu 2
sha3_256
.IP \(bu 2
sha3_384
.IP \(bu 2
sha3_512
.IP \(bu 2
2017-02-05 13:22:06 +00:00
sha512
.IP \(bu 2
2019-09-06 22:36:10 +00:00
xxh64: XXH64 checksum of this file (note: this is NOT a cryptographic hash!)
.IP \(bu 2
2023-06-11 21:10:23 +00:00
archiveid: internal ID of the archive
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-06-11 21:10:23 +00:00
archivename: name of the archive
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2023-02-26 20:30:54 +00:00
extra: prepends {target} with \(dq \- > \(dq for soft links and \(dq link to \(dq for hard links
2017-02-05 13:22:06 +00:00
.IP \(bu 2
2022-09-10 14:03:27 +00:00
health: either \(dq healthy\(dq (file ok) or \(dq broken\(dq (if file has all\- zero replacement chunks)
2017-02-05 13:22:06 +00:00
.UNINDENT
.SH SEE ALSO
.sp
2024-09-08 15:52:10 +00:00
\fI borg\- common(1)\fP , \fI borg\- info(1)\fP , \fI borg\- diff(1)\fP , \fI borg\- prune(1)\fP , \fI borg\- patterns(1)\fP , \fI borg\- repo\- list(1)\fP
2017-02-05 13:22:06 +00:00
.SH AUTHOR
The Borg Collective
. \" Generated by docutils manpage writer.
.