list.rst.inc 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. .. _borg_list:
  2. borg list
  3. ---------
  4. ::
  5. usage: borg list [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
  6. [--no-files-cache] [--umask M] [--remote-path PATH] [--short]
  7. [--list-format LISTFORMAT] [-P PREFIX]
  8. [REPOSITORY_OR_ARCHIVE]
  9. List archive or repository contents
  10. positional arguments:
  11. REPOSITORY_OR_ARCHIVE
  12. repository/archive to list contents of
  13. optional arguments:
  14. -h, --help show this help message and exit
  15. -v, --verbose, --info
  16. enable informative (verbose) output, work on log level
  17. INFO
  18. --debug enable debug output, work on log level DEBUG
  19. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  20. --show-rc show/log the return code (rc)
  21. --no-files-cache do not load/update the file metadata cache used to
  22. detect unchanged files
  23. --umask M set umask to M (local and remote, default: 0077)
  24. --remote-path PATH set remote path to executable (default: "borg")
  25. --short only print file/directory names, nothing else
  26. --list-format LISTFORMAT
  27. specify format for archive file listing (default:
  28. "{mode} {user:6} {group:6} {size:8d} {isomtime}
  29. {path}{extra}{NEWLINE}") Special "{formatkeys}" exists
  30. to list available keys
  31. -P PREFIX, --prefix PREFIX
  32. only consider archive names starting with this prefix
  33. Description
  34. ~~~~~~~~~~~
  35. This command lists the contents of a repository or an archive.