mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-25 01:06:50 +00:00
207 lines
7.8 KiB
Groff
207 lines
7.8 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH BORG-RECREATE 1 "2021-05-11" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-recreate \- Re-create archives
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] recreate [options] [REPOSITORY_OR_ARCHIVE] [PATH...]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
Recreate the contents of existing archives.
|
|
.sp
|
|
recreate is a potentially dangerous function and might lead to data loss
|
|
(if used wrongly). BE VERY CAREFUL!
|
|
.sp
|
|
Important: Repository disk space is \fBnot\fP freed until you run \fBborg compact\fP\&.
|
|
.sp
|
|
\fB\-\-exclude\fP, \fB\-\-exclude\-from\fP, \fB\-\-exclude\-if\-present\fP, \fB\-\-keep\-exclude\-tags\fP
|
|
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.
|
|
.sp
|
|
Note that all paths in an archive are relative, therefore absolute patterns/paths
|
|
will \fInot\fP match (\fB\-\-exclude\fP, \fB\-\-exclude\-from\fP, PATHs).
|
|
.sp
|
|
\fB\-\-recompress\fP allows one to change the compression of existing data in archives.
|
|
Due to how Borg stores compressed size information this might display
|
|
incorrect information for archives that were not recreated at the same time.
|
|
There is no risk of data loss by this.
|
|
.sp
|
|
\fB\-\-chunker\-params\fP will re\-chunk all files in the archive, this can be
|
|
used to have upgraded Borg 0.xx or Attic archives deduplicate with
|
|
Borg 1.x archives.
|
|
.sp
|
|
\fBUSE WITH CAUTION.\fP
|
|
Depending on the PATHs and patterns given, recreate can be used to permanently
|
|
delete files from archives.
|
|
When in doubt, use \fB\-\-dry\-run \-\-verbose \-\-list\fP to see how patterns/PATHS are
|
|
interpreted. See \fIlist_item_flags\fP in \fBborg create\fP for details.
|
|
.sp
|
|
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.
|
|
.sp
|
|
With \fB\-\-target\fP the original archive is not replaced, instead a new archive is created.
|
|
.sp
|
|
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.
|
|
.sp
|
|
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.
|
|
.sp
|
|
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).
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B REPOSITORY_OR_ARCHIVE
|
|
repository or archive to recreate
|
|
.TP
|
|
.B PATH
|
|
paths to recreate; patterns are supported
|
|
.UNINDENT
|
|
.SS optional arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-list
|
|
output verbose list of items (files, dirs, ...)
|
|
.TP
|
|
.BI \-\-filter \ STATUSCHARS
|
|
only display items with the given status characters (listed in borg create \-\-help)
|
|
.TP
|
|
.B \-n\fP,\fB \-\-dry\-run
|
|
do not change anything
|
|
.TP
|
|
.B \-s\fP,\fB \-\-stats
|
|
print statistics at end
|
|
.UNINDENT
|
|
.SS Exclusion options
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN
|
|
exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-exclude\-from \ EXCLUDEFILE
|
|
read exclude patterns from EXCLUDEFILE, one per line
|
|
.TP
|
|
.BI \-\-pattern \ PATTERN
|
|
experimental: include/exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-patterns\-from \ PATTERNFILE
|
|
experimental: read include/exclude patterns from PATTERNFILE, one per line
|
|
.TP
|
|
.B \-\-exclude\-caches
|
|
exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.bford.info/cachedir/spec.html\fP)
|
|
.TP
|
|
.BI \-\-exclude\-if\-present \ NAME
|
|
exclude directories that are tagged by containing a filesystem object with the given NAME
|
|
.TP
|
|
.B \-\-keep\-exclude\-tags
|
|
if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive
|
|
.UNINDENT
|
|
.SS Archive options
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-\-target \ TARGET
|
|
create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
|
|
.TP
|
|
.BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS
|
|
write checkpoint every SECONDS seconds (Default: 1800)
|
|
.TP
|
|
.BI \-\-comment \ COMMENT
|
|
add a comment text to the archive
|
|
.TP
|
|
.BI \-\-timestamp \ TIMESTAMP
|
|
manually specify the archive creation date/time (UTC, yyyy\-mm\-ddThh:mm:ss format). alternatively, give a reference file/directory.
|
|
.TP
|
|
.BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION
|
|
select compression algorithm, see the output of the "borg help compression" command for details.
|
|
.TP
|
|
.BI \-\-recompress \ MODE
|
|
recompress data chunks according to \fIMODE\fP and \fB\-\-compression\fP\&. Possible modes are \fIif\-different\fP: recompress if current compression is with a different compression algorithm (the level is not considered); \fIalways\fP: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and \fInever\fP: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, \fIif\-different\fP will be used. Not passing \-\-recompress is equivalent to "\-\-recompress never".
|
|
.TP
|
|
.BI \-\-chunker\-params \ PARAMS
|
|
specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or \fIdefault\fP to use the current defaults. default: buzhash,19,23,21,4095
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
# Make old (Attic / Borg 0.xx) archives deduplicate with Borg 1.x archives.
|
|
# Archives created with Borg 1.1+ and the default chunker params are skipped
|
|
# (archive ID stays the same).
|
|
$ borg recreate /mnt/backup \-\-chunker\-params default \-\-progress
|
|
|
|
# Create a backup with little but fast compression
|
|
$ borg create /mnt/backup::archive /some/files \-\-compression lz4
|
|
# Then compress it \- this might take longer, but the backup has already completed,
|
|
# so no inconsistencies from a long\-running backup job.
|
|
$ borg recreate /mnt/backup::archive \-\-recompress \-\-compression zlib,9
|
|
|
|
# Remove unwanted files from all archives in a repository.
|
|
# Note the relative path for the \-\-exclude option \- archives only contain relative paths.
|
|
$ borg recreate /mnt/backup \-\-exclude home/icke/Pictures/drunk_photos
|
|
|
|
# Change archive comment
|
|
$ borg create \-\-comment "This is a comment" /mnt/backup::archivename ~
|
|
$ borg info /mnt/backup::archivename
|
|
Name: archivename
|
|
Fingerprint: ...
|
|
Comment: This is a comment
|
|
\&...
|
|
$ borg recreate \-\-comment "This is a better comment" /mnt/backup::archivename
|
|
$ borg info /mnt/backup::archivename
|
|
Name: archivename
|
|
Fingerprint: ...
|
|
Comment: This is a better comment
|
|
\&...
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-placeholders(1)\fP, \fIborg\-compression(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|