Halaman utama Jelajahi Bantuan
Masuk
mirrors
/
borg
cermin dari https://github.com/borgbackup/borg
2
0
Fork 0
Berkas Masalah 0 Wiki
Pohon: 2f6197df0c
Ranting Tag
borg
/
docs
/
usage
/
recreate.rst.inc

recreate.rst.inc 40 KB
Riwayat Mentahan

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167 
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
    2. 

  2. 

  3. .. _borg_recreate:
    4. 

  4. 

  5. borg recreate
    6. 

  6. -------------
    7. 

  7. .. code-block:: none
    8. 

  8. 

  9.     borg [common options] recreate [options] [REPOSITORY_OR_ARCHIVE] [PATH...]
    10. 

  10. 

  11. .. only:: html
    12. 

  12. 

  13.     .. class:: borg-options-table
    14. 

  14. 

  15.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    16. 

  16.     | **positional arguments**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    17. 

  17.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    18. 

  18.     |                                                       | ``REPOSITORY_OR_ARCHIVE``                         | repository or archive to recreate                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    19. 

  19.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    20. 

  20.     |                                                       | ``PATH``                                          | paths to recreate; patterns are supported                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    21. 

  21.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22.     | **optional arguments**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    23. 

  23.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24.     |                                                       | ``--list``                                        | output verbose list of items (files, dirs, ...)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    25. 

  25.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26.     |                                                       | ``--filter STATUSCHARS``                          | only display items with the given status characters (listed in borg create --help)                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    27. 

  27.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28.     |                                                       | ``-n``, ``--dry-run``                             | do not change anything                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    29. 

  29.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30.     |                                                       | ``-s``, ``--stats``                               | print statistics at end                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    31. 

  31.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32.     | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    33. 

  33.     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
    34. 

  34.     | :ref:`common_options`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    35. 

  35.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36.     | **Exclusion options**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    37. 

  37.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38.     |                                                       | ``-e PATTERN``, ``--exclude PATTERN``             | exclude paths matching PATTERN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    39. 

  39.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40.     |                                                       | ``--exclude-from EXCLUDEFILE``                    | read exclude patterns from EXCLUDEFILE, one per line                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    41. 

  41.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42.     |                                                       | ``--pattern PATTERN``                             | include/exclude paths matching PATTERN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    43. 

  43.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44.     |                                                       | ``--patterns-from PATTERNFILE``                   | read include/exclude patterns from PATTERNFILE, one per line                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    45. 

  45.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46.     |                                                       | ``--exclude-caches``                              | exclude directories that contain a CACHEDIR.TAG file (http://www.bford.info/cachedir/spec.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    47. 

  47.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48.     |                                                       | ``--exclude-if-present NAME``                     | exclude directories that are tagged by containing a filesystem object with the given NAME                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    49. 

  49.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50.     |                                                       | ``--keep-exclude-tags``                           | if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    51. 

  51.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52.     | **Archive options**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    53. 

  53.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54.     |                                                       | ``--target TARGET``                               | create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    55. 

  55.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56.     |                                                       | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    57. 

  57.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58.     |                                                       | ``--comment COMMENT``                             | add a comment text to the archive                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    59. 

  59.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60.     |                                                       | ``--timestamp TIMESTAMP``                         | manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.                                                                                                                                                                                                                                                                                                                                                                                                                          |
    61. 

  61.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62.     |                                                       | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    63. 

  63.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64.     |                                                       | ``--recompress MODE``                             | recompress data chunks according to `MODE` and ``--compression``. Possible modes are `if-different`: recompress if current compression is with a different compression algorithm (the level is not considered); `always`: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and `never`: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, `if-different` will be used. Not passing --recompress is equivalent to "--recompress never". |
    65. 

  65.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66.     |                                                       | ``--chunker-params PARAMS``                       | specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: buzhash,19,23,21,4095                                                                                                                                                                                                                                                                                                                                                                              |
    67. 

  67.     +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. 

  69.     .. raw:: html
    70. 

  70. 

  71.         <script type='text/javascript'>
    72. 

  72.         $(document).ready(function () {
    73. 

  73.             $('.borg-options-table colgroup').remove();
    74. 

  74.         })
    75. 

  75.         </script>
    76. 

  76. 

  77. .. only:: latex
    78. 

  78. 

  79.     REPOSITORY_OR_ARCHIVE
    80. 

  80.         repository or archive to recreate
    81. 

  81.     PATH
    82. 

  82.         paths to recreate; patterns are supported
    83. 

  83. 

  84. 

  85.     optional arguments
    86. 

  86.         --list          output verbose list of items (files, dirs, ...)
    87. 

  87.         --filter STATUSCHARS    only display items with the given status characters (listed in borg create --help)
    88. 

  88.         -n, --dry-run    do not change anything
    89. 

  89.         -s, --stats     print statistics at end
    90. 

  90. 

  91. 

  92.     :ref:`common_options`
    93. 

  93.         |
    94. 

  94. 

  95.     Exclusion options
    96. 

  96.         -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
    97. 

  97.         --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
    98. 

  98.         --pattern PATTERN                 include/exclude paths matching PATTERN
    99. 

  99.         --patterns-from PATTERNFILE       read include/exclude patterns from PATTERNFILE, one per line
    100. 

  100.         --exclude-caches                  exclude directories that contain a CACHEDIR.TAG file (http://www.bford.info/cachedir/spec.html)
    101. 

  101.         --exclude-if-present NAME         exclude directories that are tagged by containing a filesystem object with the given NAME
    102. 

  102.         --keep-exclude-tags               if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
    103. 

  103. 

  104. 

  105.     Archive options
    106. 

  106.         --target TARGET                               create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
    107. 

  107.         -c SECONDS, --checkpoint-interval SECONDS     write checkpoint every SECONDS seconds (Default: 1800)
    108. 

  108.         --comment COMMENT                             add a comment text to the archive
    109. 

  109.         --timestamp TIMESTAMP                         manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.
    110. 

  110.         -C COMPRESSION, --compression COMPRESSION     select compression algorithm, see the output of the "borg help compression" command for details.
    111. 

  111.         --recompress MODE                             recompress data chunks according to `MODE` and ``--compression``. Possible modes are `if-different`: recompress if current compression is with a different compression algorithm (the level is not considered); `always`: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and `never`: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, `if-different` will be used. Not passing --recompress is equivalent to "--recompress never".
    112. 

  112.         --chunker-params PARAMS                       specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: buzhash,19,23,21,4095
    113. 

  113. 

  114. 

  115. Description
    116. 

  116. ~~~~~~~~~~~
    117. 

  117. 

  118. Recreate the contents of existing archives.
    119. 

  119. 

  120. recreate is a potentially dangerous function and might lead to data loss
    121. 

  121. (if used wrongly). BE VERY CAREFUL!
    122. 

  122. 

  123. Important: Repository disk space is **not** freed until you run ``borg compact``.
    124. 

  124. 

  125. ``--exclude``, ``--exclude-from``, ``--exclude-if-present``, ``--keep-exclude-tags``
    126. 

  126. and PATH have the exact same semantics as in "borg create", but they only check
    127. 

  127. for files in the archives and not in the local file system. If PATHs are specified,
    128. 

  128. the resulting archives will only contain files from these PATHs.
    129. 

  129. 

  130. Note that all paths in an archive are relative, therefore absolute patterns/paths
    131. 

  131. will *not* match (``--exclude``, ``--exclude-from``, PATHs).
    132. 

  132. 

  133. ``--recompress`` allows one to change the compression of existing data in archives.
    134. 

  134. Due to how Borg stores compressed size information this might display
    135. 

  135. incorrect information for archives that were not recreated at the same time.
    136. 

  136. There is no risk of data loss by this.
    137. 

  137. 

  138. ``--chunker-params`` will re-chunk all files in the archive, this can be
    139. 

  139. used to have upgraded Borg 0.xx or Attic archives deduplicate with
    140. 

  140. Borg 1.x archives.
    141. 

  141. 

  142. **USE WITH CAUTION.**
    143. 

  143. Depending on the PATHs and patterns given, recreate can be used to permanently
    144. 

  144. delete files from archives.
    145. 

  145. When in doubt, use ``--dry-run --verbose --list`` to see how patterns/PATHS are
    146. 

  146. interpreted. See :ref:`list_item_flags` in ``borg create`` for details.
    147. 

  147. 

  148. The archive being recreated is only removed after the operation completes. The
    149. 

  149. archive that is built during the operation exists at the same time at
    150. 

  150. "<ARCHIVE>.recreate". The new archive will have a different archive ID.
    151. 

  151. 

  152. With ``--target`` the original archive is not replaced, instead a new archive is created.
    153. 

  153. 

  154. When rechunking (or recompressing), space usage can be substantial - expect
    155. 

  155. at least the entire deduplicated size of the archives using the previous
    156. 

  156. chunker (or compression) params.
    157. 

  157. 

  158. If you recently ran borg check --repair and it had to fix lost chunks with all-zero
    159. 

  159. replacement chunks, please first run another backup for the same data and re-run
    160. 

  160. borg check --repair afterwards to heal any archives that had lost chunks which are
    161. 

  161. still generated from the input data.
    162. 

  162. 

  163. Important: running borg recreate to re-chunk will remove the chunks_healthy
    164. 

  164. metadata of all items with replacement chunks, so healing will not be possible
    165. 

  165. any more after re-chunking (it is also unlikely it would ever work: due to the
    166. 

  166. change of chunking parameters, the missing chunk likely will never be seen again
    167. 

  167. even if you still have the data that produced it).
    168.