2016-07-05 23:33:53 +00:00
.. IMPORTANT : this file is auto - generated from borg ' s built - in help , do not edit !
2016-04-07 09:29:52 +00:00
.. _borg_recreate :
borg recreate
-------------
2017-06-06 22:44:53 +00:00
.. code - block :: none
2016-04-07 09:29:52 +00:00
2022-06-23 23:19:19 +00:00
borg [ common options ] recreate [ options ] [ PATH ... ]
2016-04-10 12:09:05 +00:00
2017-06-20 13:22:24 +00:00
.. only :: html
.. class :: borg - options - table
2022-06-23 23:19:19 +00:00
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ** positional arguments ** |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` PATH `` | paths to recreate ; patterns are supported |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ** optional arguments ** |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- list `` | output verbose list of items ( files , dirs , ... ) |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- filter STATUSCHARS `` | only display items with the given status characters ( listed in borg create -- help ) |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - n `` , `` -- dry - run `` | do not change anything |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - s `` , `` -- stats `` | print statistics at end |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| .. class :: borg - common - opt - ref |
| |
| : ref : `common_options` |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ** Exclusion options ** |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - e PATTERN `` , `` -- exclude PATTERN `` | exclude paths matching PATTERN |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- exclude - from EXCLUDEFILE `` | read exclude patterns from EXCLUDEFILE , one per line |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- pattern PATTERN `` | include / exclude paths matching PATTERN |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- patterns - from PATTERNFILE `` | read include / exclude patterns from PATTERNFILE , one per line |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- exclude - caches `` | exclude directories that contain a CACHEDIR . TAG file ( http :// www . bford . info / cachedir / spec . html ) |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- exclude - if - present NAME `` | exclude directories that are tagged by containing a filesystem object with the given NAME |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- keep - exclude - tags `` | if tag objects are specified with `` -- exclude - if - present `` , don ' t omit the tag objects themselves from the backup archive |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ** Archive filters ** — Archive filters can be applied to repository targets . |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - P PREFIX `` , `` -- prefix PREFIX `` | only consider archive names starting with this prefix . |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - a GLOB `` , `` -- glob - archives GLOB `` | only consider archive names matching the glob . sh : rules apply , see " borg help patterns " . `` -- prefix `` and `` -- glob - archives `` are mutually exclusive . |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- sort - by KEYS `` | Comma - separated list of sorting keys ; valid keys are : timestamp , name , id ; default is : timestamp |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- first N `` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- last N `` | consider last N archives after other filters were applied |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- target TARGET `` | create a new archive with the name ARCHIVE , do not replace existing archive ( only applies for a single archive ) |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - c SECONDS `` , `` -- checkpoint - interval SECONDS `` | write checkpoint every SECONDS seconds ( Default : 1800 ) |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- comment COMMENT `` | add a comment text to the archive |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- timestamp TIMESTAMP `` | manually specify the archive creation date / time ( UTC , yyyy - mm - ddThh : mm : ss format ) . alternatively , give a reference file / directory . |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` - C COMPRESSION `` , `` -- compression COMPRESSION `` | select compression algorithm , see the output of the " borg help compression " command for details . |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- 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 " . |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | `` -- 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 |
+-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2017-06-20 13:22:24 +00:00
.. raw :: html
< script type = 'text/javascript' >
2017-06-20 13:48:30 +00:00
$ ( document ) . ready ( function () {
2017-06-20 13:22:24 +00:00
$ ( '.borg-options-table colgroup' ) . remove ();
})
</ script >
.. only :: latex
PATH
paths to recreate ; patterns are supported
optional arguments
-- list output verbose list of items ( files , dirs , ... )
2017-07-23 15:12:01 +00:00
-- filter STATUSCHARS only display items with the given status characters ( listed in borg create -- help )
2017-06-20 13:22:24 +00:00
- n , -- dry - run do not change anything
- s , -- stats print statistics at end
: ref : `common_options`
|
Exclusion options
- e PATTERN , -- exclude PATTERN exclude paths matching PATTERN
-- exclude - from EXCLUDEFILE read exclude patterns from EXCLUDEFILE , one per line
2022-02-05 16:22:33 +00:00
-- pattern PATTERN include / exclude paths matching PATTERN
-- patterns - from PATTERNFILE read include / exclude patterns from PATTERNFILE , one per line
2019-02-24 19:39:42 +00:00
-- exclude - caches exclude directories that contain a CACHEDIR . TAG file ( http :// www . bford . info / cachedir / spec . html )
2017-06-20 13:22:24 +00:00
-- exclude - if - present NAME exclude directories that are tagged by containing a filesystem object with the given NAME
2019-02-24 19:39:42 +00:00
-- keep - exclude - tags if tag objects are specified with `` -- exclude - if - present `` , don ' t omit the tag objects themselves from the backup archive
2017-06-20 13:22:24 +00:00
2022-06-23 23:19:19 +00:00
Archive filters
- P PREFIX , -- prefix PREFIX only consider archive names starting with this prefix .
- a GLOB , -- glob - archives GLOB only consider archive names matching the glob . sh : rules apply , see " borg help patterns " . `` -- prefix `` and `` -- glob - archives `` are mutually exclusive .
-- sort - by KEYS Comma - separated list of sorting keys ; valid keys are : timestamp , name , id ; default is : timestamp
-- first N consider first N archives after other filters were applied
-- last N consider last N archives after other filters were applied
2017-06-20 13:22:24 +00:00
-- target TARGET create a new archive with the name ARCHIVE , do not replace existing archive ( only applies for a single archive )
- c SECONDS , -- checkpoint - interval SECONDS write checkpoint every SECONDS seconds ( Default : 1800 )
-- comment COMMENT add a comment text to the archive
-- timestamp TIMESTAMP manually specify the archive creation date / time ( UTC , yyyy - mm - ddThh : mm : ss format ) . alternatively , give a reference file / directory .
- C COMPRESSION , -- compression COMPRESSION select compression algorithm , see the output of the " borg help compression " command for details .
2020-10-04 18:32:38 +00:00
-- 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 " .
2019-02-24 19:39:42 +00:00
-- 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
2017-06-20 09:49:26 +00:00
2016-04-10 12:09:05 +00:00
2016-04-07 09:29:52 +00:00
Description
~~~~~~~~~~~
Recreate the contents of existing archives .
2020-10-04 18:32:38 +00:00
recreate is a potentially dangerous function and might lead to data loss
( if used wrongly ) . BE VERY CAREFUL !
2016-12-14 02:42:38 +00:00
2018-07-12 20:00:19 +00:00
Important : Repository disk space is ** not ** freed until you run `` borg compact `` .
2020-10-04 18:32:38 +00:00
`` -- exclude `` , `` -- exclude - from `` , `` -- exclude - if - present `` , `` -- keep - exclude - tags ``
and PATH have the exact same semantics as in " borg create " , but they only check
for files in the archives and not in the local file system . If PATHs are specified ,
the resulting archives will only contain files from these PATHs .
2016-04-07 09:29:52 +00:00
2016-08-27 22:17:24 +00:00
Note that all paths in an archive are relative , therefore absolute patterns / paths
2017-06-17 10:28:42 +00:00
will * not * match ( `` -- exclude `` , `` -- exclude - from `` , PATHs ) .
2016-08-27 22:17:24 +00:00
2018-01-03 10:42:12 +00:00
`` -- recompress `` allows one to change the compression of existing data in archives .
2016-04-07 09:29:52 +00:00
Due to how Borg stores compressed size information this might display
2016-04-10 13:59:10 +00:00
incorrect information for archives that were not recreated at the same time .
2016-04-07 09:29:52 +00:00
There is no risk of data loss by this .
2017-06-17 10:28:42 +00:00
`` -- chunker - params `` will re - chunk all files in the archive , this can be
2016-04-07 09:29:52 +00:00
used to have upgraded Borg 0. xx or Attic archives deduplicate with
Borg 1. x archives .
2017-06-09 17:22:18 +00:00
** USE WITH CAUTION .**
2016-04-10 13:59:10 +00:00
Depending on the PATHs and patterns given , recreate can be used to permanently
delete files from archives .
2017-06-17 10:28:42 +00:00
When in doubt , use `` -- dry - run -- verbose -- list `` to see how patterns / PATHS are
2020-10-04 18:32:38 +00:00
interpreted . See : ref : `list_item_flags` in `` borg create `` for details .
2016-04-07 09:29:52 +00:00
The archive being recreated is only removed after the operation completes . The
archive that is built during the operation exists at the same time at
" <ARCHIVE>.recreate " . The new archive will have a different archive ID .
2017-06-17 10:28:42 +00:00
With `` -- target `` the original archive is not replaced , instead a new archive is created .
2016-08-27 22:17:24 +00:00
2018-07-12 20:00:19 +00:00
When rechunking ( or recompressing ), space usage can be substantial - expect
at least the entire deduplicated size of the archives using the previous
chunker ( or compression ) params .
2017-11-25 13:35:52 +00:00
If you recently ran borg check -- repair and it had to fix lost chunks with all - zero
replacement chunks , please first run another backup for the same data and re - run
borg check -- repair afterwards to heal any archives that had lost chunks which are
still generated from the input data .
Important : running borg recreate to re - chunk will remove the chunks_healthy
metadata of all items with replacement chunks , so healing will not be possible
any more after re - chunking ( it is also unlikely it would ever work : due to the
change of chunking parameters , the missing chunk likely will never be seen again
even if you still have the data that produced it ) .