list.rst.inc 2.0 KB

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