Home Explore Help
Sign In
mirrors
/
borg
mirror of https://github.com/borgbackup/borg
2
0
Fork 0
Files Issues 0 Wiki
Tree: c201654f45
Branches Tags
borg
/
docs
/
usage
/
list.rst.inc

list.rst.inc 2.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 
  1. .. _borg_list:
    2. 

  2. 

  3. borg list
    4. 

  4. ---------
    5. 

  5. ::
    6. 

  6. 

  7.     borg list <options> REPOSITORY_OR_ARCHIVE PATH
    8. 

  8. 

  9. positional arguments
    10. 

  10.     REPOSITORY_OR_ARCHIVE
    11. 

  11.         repository/archive to list contents of
    12. 

  12.     PATH
    13. 

  13.         paths to list; patterns are supported
    14. 

  14. 

  15. optional arguments
    16. 

  16.     ``--short``
    17. 

  17.         | only print file/directory names, nothing else
    18. 

  18.     ``--format``, ``--list-format``
    19. 

  19.         | specify format for file listing
    20. 

  20.         |                                 (default: "{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NL}")
    21. 

  21.     ``-P``, ``--prefix``
    22. 

  22.         | only consider archive names starting with this prefix
    23. 

  23.     ``-e PATTERN``, ``--exclude PATTERN``
    24. 

  24.         | exclude paths matching PATTERN
    25. 

  25.     ``--exclude-from EXCLUDEFILE``
    26. 

  26.         | read exclude patterns from EXCLUDEFILE, one per line
    27. 

  27. 

  28. `Common options`_
    29. 

  29.     |
    30. 

  30. 

  31. Description
    32. 

  32. ~~~~~~~~~~~
    33. 

  33. 

  34. This command lists the contents of a repository or an archive.
    35. 

  35. 

  36. See the "borg help patterns" command for more help on exclude patterns.
    37. 

  37. 

  38. The following keys are available for --format:
    39. 

  39.  - NEWLINE: OS dependent line separator
    40. 

  40.  - NL: alias of NEWLINE
    41. 

  41.  - NUL: NUL character for creating print0 / xargs -0 like output, see barchive/bpath
    42. 

  42.  - SPACE
    43. 

  43.  - TAB
    44. 

  44.  - CR
    45. 

  45.  - LF
    46. 

  46. 

  47. -- Keys for listing repository archives:
    48. 

  48.  - archive: archive name interpreted as text (might be missing non-text characters, see barchive)
    49. 

  49.  - barchive: verbatim archive name, can contain any character except NUL
    50. 

  50.  - time: time of creation of the archive
    51. 

  51.  - id: internal ID of the archive
    52. 

  52. 

  53. -- Keys for listing archive files:
    54. 

  54.  - type
    55. 

  55.  - mode
    56. 

  56.  - uid
    57. 

  57.  - gid
    58. 

  58.  - user
    59. 

  59.  - group
    60. 

  60.  - path: path interpreted as text (might be missing non-text characters, see bpath)
    61. 

  61.  - bpath: verbatim POSIX path, can contain any character except NUL
    62. 

  62.  - source: link target for links (identical to linktarget)
    63. 

  63.  - linktarget
    64. 

  64.  - flags
    65. 

  65. 

  66.  - size
    67. 

  67.  - csize: compressed size
    68. 

  68.  - num_chunks: number of chunks in this file
    69. 

  69.  - unique_chunks: number of unique chunks in this file
    70. 

  70. 

  71.  - mtime
    72. 

  72.  - ctime
    73. 

  73.  - atime
    74. 

  74.  - isomtime
    75. 

  75.  - isoctime
    76. 

  76.  - isoatime
    77. 

  77. 

  78.  - md5
    79. 

  79.  - sha1
    80. 

  80.  - sha224
    81. 

  81.  - sha256
    82. 

  82.  - sha384
    83. 

  83.  - sha512
    84. 

  84. 

  85.  - archiveid
    86. 

  86.  - archivename
    87. 

  87.  - extra: prepends {source} with " -> " for soft links and " link to " for hard links
    88.