list.rst.inc 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. _borg_list:
  2. borg list
  3. ---------
  4. ::
  5. usage: borg list [-h] [--critical] [--error] [--warning] [--info] [--debug]
  6. [--lock-wait N] [--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. --critical work on log level CRITICAL
  17. --error work on log level ERROR
  18. --warning work on log level WARNING (default)
  19. --info, -v, --verbose
  20. work on log level INFO
  21. --debug work on log level DEBUG
  22. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  23. --show-rc show/log the return code (rc)
  24. --no-files-cache do not load/update the file metadata cache used to
  25. detect unchanged files
  26. --umask M set umask to M (local and remote, default: 0077)
  27. --remote-path PATH set remote path to executable (default: "borg")
  28. --short only print file/directory names, nothing else
  29. --list-format LISTFORMAT
  30. specify format for archive file listing (default:
  31. "{mode} {user:6} {group:6} {size:8d} {isomtime}
  32. {path}{extra}{NEWLINE}") Special "{formatkeys}" exists
  33. to list available keys
  34. -P PREFIX, --prefix PREFIX
  35. only consider archive names starting with this prefix
  36. Description
  37. ~~~~~~~~~~~
  38. This command lists the contents of a repository or an archive.