mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-23 08:16:54 +00:00
243 lines
6.5 KiB
Groff
243 lines
6.5 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-LIST" 1 "2024-09-26" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-list \- List archive contents
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] list [options] NAME [PATH...]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command lists the contents of an archive.
|
|
.sp
|
|
For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
|
|
.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
|
|
.TP
|
|
.B PATH
|
|
paths to list; patterns are supported
|
|
.UNINDENT
|
|
.SS optional arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-short
|
|
only print file/directory names, nothing else
|
|
.TP
|
|
.BI \-\-format \ FORMAT
|
|
specify format for file listing (default: \(dq{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}\(dq)
|
|
.TP
|
|
.B \-\-json\-lines
|
|
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.
|
|
.UNINDENT
|
|
.SS Include/Exclude options
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN
|
|
exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-exclude\-from \ EXCLUDEFILE
|
|
read exclude patterns from EXCLUDEFILE, one per line
|
|
.TP
|
|
.BI \-\-pattern \ PATTERN
|
|
include/exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-patterns\-from \ PATTERNFILE
|
|
read include/exclude patterns from PATTERNFILE, one per line
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
$ borg list root\-2016\-02\-15
|
|
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
|
|
\&...
|
|
|
|
$ borg list root\-2016\-02\-15 \-\-pattern \(dq\- bin/ba*\(dq
|
|
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
|
|
\&...
|
|
|
|
$ borg list archiveA \-\-format=\(dq{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}\(dq
|
|
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
|
|
\-rw\-rw\-r\-\- user user 1416192 Sun, 2015\-02\-01 11:00:00 code/myproject/file.text
|
|
\&...
|
|
|
|
$ borg list archiveA \-\-pattern \(aq+ re:\e.ext$\(aq \-\-pattern \(aq\- re:^.*$\(aq
|
|
\-rw\-rw\-r\-\- user user 1416192 Sun, 2015\-02\-01 11:00:00 code/myproject/file.ext
|
|
\&...
|
|
|
|
$ borg list archiveA \-\-pattern \(aq+ re:.ext$\(aq \-\-pattern \(aq\- re:^.*$\(aq
|
|
\-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
|
|
\&...
|
|
.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 list \-\-format \(aq{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}\(aq ArchiveFoo
|
|
\-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.
|
|
$ borg list \-\-format \(aq{mode} {user:>6} {group:>6} {size:<8} {mtime} {path}{extra}{NL}\(aq ArchiveFoo
|
|
\-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:
|
|
.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 files in an archive:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
type: file type (file, dir, symlink, ...)
|
|
.IP \(bu 2
|
|
mode: file mode (as in stat)
|
|
.IP \(bu 2
|
|
uid: user id of file owner
|
|
.IP \(bu 2
|
|
gid: group id of file owner
|
|
.IP \(bu 2
|
|
user: user name of file owner
|
|
.IP \(bu 2
|
|
group: group name of file owner
|
|
.IP \(bu 2
|
|
path: file path
|
|
.IP \(bu 2
|
|
target: link target for symlinks
|
|
.IP \(bu 2
|
|
hlid: hard link identity (same if hardlinking same fs object)
|
|
.IP \(bu 2
|
|
flags: file flags
|
|
.IP \(bu 2
|
|
size: file size
|
|
.IP \(bu 2
|
|
num_chunks: number of chunks in this file
|
|
.IP \(bu 2
|
|
mtime: file modification time
|
|
.IP \(bu 2
|
|
ctime: file change time
|
|
.IP \(bu 2
|
|
atime: file access time
|
|
.IP \(bu 2
|
|
isomtime: file modification time (ISO 8601 format)
|
|
.IP \(bu 2
|
|
isoctime: file change time (ISO 8601 format)
|
|
.IP \(bu 2
|
|
isoatime: file access time (ISO 8601 format)
|
|
.IP \(bu 2
|
|
blake2b
|
|
.IP \(bu 2
|
|
blake2s
|
|
.IP \(bu 2
|
|
md5
|
|
.IP \(bu 2
|
|
sha1
|
|
.IP \(bu 2
|
|
sha224
|
|
.IP \(bu 2
|
|
sha256
|
|
.IP \(bu 2
|
|
sha384
|
|
.IP \(bu 2
|
|
sha3_224
|
|
.IP \(bu 2
|
|
sha3_256
|
|
.IP \(bu 2
|
|
sha3_384
|
|
.IP \(bu 2
|
|
sha3_512
|
|
.IP \(bu 2
|
|
sha512
|
|
.IP \(bu 2
|
|
xxh64: XXH64 checksum of this file (note: this is NOT a cryptographic hash!)
|
|
.IP \(bu 2
|
|
archiveid: internal ID of the archive
|
|
.IP \(bu 2
|
|
archivename: name of the archive
|
|
.IP \(bu 2
|
|
extra: prepends {target} with \(dq \-> \(dq for soft links and \(dq link to \(dq for hard links
|
|
.IP \(bu 2
|
|
health: either \(dqhealthy\(dq (file ok) or \(dqbroken\(dq (if file has all\-zero replacement chunks)
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP, \fIborg\-info(1)\fP, \fIborg\-diff(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-repo\-list(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|