list.rst.inc 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. .. _borg_list:
  2. borg list
  3. ---------
  4. ::
  5. borg list <options> REPOSITORY_OR_ARCHIVE PATH
  6. positional arguments
  7. REPOSITORY_OR_ARCHIVE
  8. repository/archive to list contents of
  9. PATH
  10. paths to list; patterns are supported
  11. optional arguments
  12. ``--short``
  13. | only print file/directory names, nothing else
  14. ``--format``, ``--list-format``
  15. | specify format for file listing
  16. | (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}")
  17. ``-P``, ``--prefix``
  18. | only consider archive names starting with this prefix
  19. ``-e PATTERN``, ``--exclude PATTERN``
  20. | exclude paths matching PATTERN
  21. ``--exclude-from EXCLUDEFILE``
  22. | read exclude patterns from EXCLUDEFILE, one per line
  23. `Common options`_
  24. |
  25. Description
  26. ~~~~~~~~~~~
  27. This command lists the contents of a repository or an archive.
  28. See the "borg help patterns" command for more help on exclude patterns.
  29. The following keys are available for --format when listing files:
  30. - type
  31. - mode
  32. - uid
  33. - gid
  34. - user
  35. - group
  36. - path: path interpreted as text (might be missing non-text characters, see bpath)
  37. - bpath: verbatim POSIX path, can contain any character except NUL
  38. - source: link target for links (identical to linktarget)
  39. - linktarget
  40. - size
  41. - csize: compressed size
  42. - num_chunks: number of chunks in this file
  43. - unique_chunks: number of unique chunks in this file
  44. - mtime
  45. - ctime
  46. - atime
  47. - isomtime
  48. - isoctime
  49. - isoatime
  50. - md5
  51. - sha1
  52. - sha224
  53. - sha256
  54. - sha384
  55. - sha512
  56. - archiveid
  57. - archivename
  58. - extra: prepends {source} with " -> " for soft links and " link to " for hard links
  59. - NEWLINE: OS dependent line separator
  60. - NL: alias of NEWLINE
  61. - NUL: NUL character for creating print0 / xargs -0 like ouput, see bpath
  62. - SPACE
  63. - TAB
  64. - CR
  65. - LF