borg/docs/usage/list.rst.inc

89 lines
2.9 KiB
PHP

.. _borg_list:
borg list
---------
::
usage: borg list [-h] [-v] [--debug] [--lock-wait N] [--show-version]
[--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [--short] [--format FORMAT] [-P PREFIX]
[-e PATTERN] [--exclude-from EXCLUDEFILE]
[REPOSITORY_OR_ARCHIVE] [PATH [PATH ...]]
List archive or repository contents
positional arguments:
REPOSITORY_OR_ARCHIVE
repository/archive to list contents of
PATH paths to list; patterns are supported
optional arguments:
-h, --help show this help message and exit
-v, --verbose, --info
enable informative (verbose) output, work on log level
INFO
--debug enable debug output, work on log level DEBUG
--lock-wait N wait for the lock, but max. N seconds (default: 1).
--show-version show/log the borg version
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 0077)
--remote-path PATH set remote path to executable (default: "borg")
--short only print file/directory names, nothing else
--format FORMAT, --list-format FORMAT
specify format for file listing (default: "{mode}
{user:6} {group:6} {size:8d} {isomtime}
{path}{extra}{NL}")
-P PREFIX, --prefix PREFIX
only consider archive names starting with this prefix
-e PATTERN, --exclude PATTERN
exclude paths matching PATTERN
--exclude-from EXCLUDEFILE
read exclude patterns from EXCLUDEFILE, one per line
Description
~~~~~~~~~~~
This command lists the contents of a repository or an archive.
See the "borg help patterns" command for more help on exclude patterns.
The following keys are available for --format when listing files:
- archiveid
- archivename
- atime
- bpath: verbatim POSIX path, can contain any character except NUL
- csize: compressed size
- ctime
- extra
- gid
- group
- isoatime
- isoctime
- isomtime
- linktarget
- md5
- mode
- mtime
- num_chunks: number of chunks in this file
- path: path interpreted as text (might be missing non-text characters, see bpath)
- sha1
- sha224
- sha256
- sha384
- sha512
- size
- source: link target for links (identical to linktarget)
- type
- uid
- unique_chunks: number of unique chunks in this file
- user
- CR
- LF
- NEWLINE: OS dependent line separator
- NL: alias of NEWLINE
- NUL: NUL character for creating print0 / xargs -0 like ouput, see bpath
- SPACE
- TAB