diff options
author | Thomas Waldmann <tw@waldmann-edv.de> | 2017-08-27 22:18:45 +0200 |
---|---|---|
committer | Thomas Waldmann <tw@waldmann-edv.de> | 2017-08-27 22:18:45 +0200 |
commit | 168293ea807329d1a0cfa7213b2ae1a309be8326 (patch) | |
tree | 271dd261fd234c123c24816fb6d005e084e404a3 /docs/man/borg-list.1 | |
parent | 9f61747dae65d96f7eeaabd5c2a0b8ad40b40b13 (diff) |
python setup.py build_man1.1.0rc2
Diffstat (limited to 'docs/man/borg-list.1')
-rw-r--r-- | docs/man/borg-list.1 | 45 |
1 files changed, 27 insertions, 18 deletions
diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index 3bceff410..d26bcaba8 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-06-18" "" "borg backup tool" +.TH BORG-LIST 1 "2017-08-27" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents . @@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .SH SYNOPSIS .sp -borg [common options] list <options> REPOSITORY_OR_ARCHIVE PATH +borg [common options] list [options] [REPOSITORY_OR_ARCHIVE] [PATH...] .SH DESCRIPTION .sp This command lists the contents of a repository or an archive. @@ -56,9 +56,8 @@ paths to list; patterns are supported .B \-\-short only print file/directory names, nothing else .TP -.B \-\-format\fP,\fB \-\-list\-format -specify format for file listing -(default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}") +.BI \-\-format \ FORMAT\fP,\fB \ \-\-list\-format \ FORMAT +specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {mtime} {path}{extra}{NL}") .TP .B \-\-json Only valid for listing repository contents. 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. A "barchive" key is therefore not available. @@ -66,16 +65,16 @@ Only valid for listing repository contents. Format output as JSON. The form of \ .B \-\-json\-lines Only valid for listing archive contents. 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. A "bpath" key is therefore not available. .UNINDENT -.SS filters +.SS Archive filters .INDENT 0.0 .TP -.B \-P\fP,\fB \-\-prefix +.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX only consider archive names starting with this prefix. .TP -.B \-a\fP,\fB \-\-glob\-archives +.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP -.B \-\-sort\-by +.BI \-\-sort\-by \ KEYS Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp .TP .BI \-\-first \ N @@ -93,6 +92,12 @@ exclude paths matching PATTERN .BI \-\-exclude\-from \ EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line .TP +.BI \-\-pattern \ PATTERN +experimental: include/exclude paths matching PATTERN +.TP +.BI \-\-patterns\-from \ PATTERNFILE +experimental: read include/exclude patterns from PATTERNFILE, 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 @@ -100,13 +105,7 @@ exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.brynosauru 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 -experimental: include/exclude paths matching PATTERN -.TP -.BI \-\-patterns\-from \ PATTERNFILE -experimental: read include/exclude patterns from PATTERNFILE, one per line +if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive .UNINDENT .SH EXAMPLES .INDENT 0.0 @@ -162,13 +161,23 @@ LF Keys for listing repository archives: .INDENT 0.0 .IP \(bu 2 -archive, name: archive name interpreted as text (might be missing non\-text characters, see barchive) +name: archive name interpreted as text (might be missing non\-text characters, see barchive) +.IP \(bu 2 +archive: 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 -time: time of creation of the archive +comment: archive comment interpreted as text (might be missing non\-text characters, see bcomment) +.IP \(bu 2 +bcomment: verbatim archive comment, can contain any character except NUL .IP \(bu 2 id: internal ID of the archive +.IP \(bu 2 +time: time (start) of creation of the archive +.IP \(bu 2 +start: time (start) of creation of the archive +.IP \(bu 2 +end: time (end) of creation of the archive .UNINDENT .sp Keys for listing archive files: |