summaryrefslogtreecommitdiffstats
path: root/docs/man/borg-list.1
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2017-03-27 01:58:19 +0200
committerThomas Waldmann <tw@waldmann-edv.de>2017-03-27 01:58:19 +0200
commit85bfcd439c3d8d3e674b013db8146343c902361d (patch)
treec9ef90475f32d8ed77ea33354af9aea1a5288559 /docs/man/borg-list.1
parentacd3da62f4a764721e1c5e2f40e8b2659ed4d989 (diff)
ran setup.py build_man
Diffstat (limited to 'docs/man/borg-list.1')
-rw-r--r--docs/man/borg-list.155
1 files changed, 32 insertions, 23 deletions
diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1
index 74e5a2780..be02614e0 100644
--- a/docs/man/borg-list.1
+++ b/docs/man/borg-list.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-LIST 1 "2017-02-12" "" "borg backup tool"
+.TH BORG-LIST 1 "2017-03-26" "" "borg backup tool"
.SH NAME
borg-list \- List archive or repository contents
.
@@ -60,11 +60,8 @@ only print file/directory names, nothing else
specify format for file listing
(default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}")
.TP
-.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN
-exclude paths matching PATTERN
-.TP
-.BI \-\-exclude\-from \ EXCLUDEFILE
-read exclude patterns from EXCLUDEFILE, one per line
+.B \-\-json
+format output as JSON. The form of \-\-format is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
.UNINDENT
.SS filters
.INDENT 0.0
@@ -81,6 +78,30 @@ consider first N archives after other filters were applied
.BI \-\-last \ N
consider last N archives after other filters were applied
.UNINDENT
+.SS Exclusion options
+.INDENT 0.0
+.TP
+.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN
+exclude paths matching PATTERN
+.TP
+.BI \-\-exclude\-from \ EXCLUDEFILE
+read exclude patterns from EXCLUDEFILE, one per line
+.TP
+.B \-\-exclude\-caches
+exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.brynosaurus.com/cachedir/spec.html\fP)
+.TP
+.BI \-\-exclude\-if\-present \ NAME
+exclude directories that are tagged by containing a filesystem object with the given NAME
+.TP
+.B \-\-keep\-exclude\-tags\fP,\fB \-\-keep\-tag\-files
+if tag objects are specified with \-\-exclude\-if\-present, don\(aqt omit the tag objects themselves from the backup archive
+.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
@@ -141,7 +162,7 @@ Keys for listing repository archives:
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
-archive: archive name interpreted as text (might be missing non\-text characters, see barchive)
+archive, name: archive name interpreted as text (might be missing non\-text characters, see barchive)
.IP \(bu 2
barchive: verbatim archive name, can contain any character except NUL
.IP \(bu 2
@@ -183,6 +204,10 @@ size
.IP \(bu 2
csize: compressed size
.IP \(bu 2
+dsize: deduplicated size
+.IP \(bu 2
+dcsize: deduplicated compressed size
+.IP \(bu 2
num_chunks: number of chunks in this file
.IP \(bu 2
unique_chunks: number of unique chunks in this file
@@ -199,10 +224,6 @@ isoctime
.IP \(bu 2
isoatime
.IP \(bu 2
-blake2b
-.IP \(bu 2
-blake2s
-.IP \(bu 2
md5
.IP \(bu 2
sha1
@@ -213,20 +234,8 @@ 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
-shake_128
-.IP \(bu 2
-shake_256
-.IP \(bu 2
archiveid
.IP \(bu 2
archivename