1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-24 16:55:36 +00:00
borg/docs/usage/list.rst.inc
Antoine Beaupré 8e36075fe9 commit usage files directly into git
the generation of those files was causing us way too much pain to
justify automatically generating them all the time.

those will have to be re-generated with `build_api` or `build_usage`
as appropriate, for example when function signatures or commandline
flags change.

see #384
2015-11-13 10:42:52 -05:00

32 lines
1.1 KiB
HTML

.. _borg_list:
borg list
---------
::
usage: borg list [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [--short] [-p PREFIX]
[REPOSITORY_OR_ARCHIVE]
List archive or repository contents
positional arguments:
REPOSITORY_OR_ARCHIVE
repository/archive to list contents of
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--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: 63)
--remote-path PATH set remote path to executable (default: "borg")
--short only print file/directory names, nothing else
-p PREFIX, --prefix PREFIX
only consider archive names starting with this prefix
Description
~~~~~~~~~~~
This command lists the contents of a repository or an archive.