list.rst.inc 1.8 KB

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