mirror of
https://github.com/borgbackup/borg.git
synced 2026-09-01 14:13:19 +02:00
226 lines
6.6 KiB
Groff
226 lines
6.6 KiB
Groff
.\" Man page generated from reStructuredText
|
|
.\" by the Docutils 0.22.4 manpage writer.
|
|
.
|
|
.
|
|
.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
|
|
..
|
|
.TH "borg-import-tar" "1" "2026-08-29" "" "borg backup tool"
|
|
.SH Name
|
|
borg-import-tar \- Create a backup archive from a tarball
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] import\-tar [options] NAME TARFILE
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command creates a backup archive from a tarball.
|
|
.sp
|
|
When giving \(aq\-\(aq as path, Borg will read a tar stream from standard input.
|
|
.sp
|
|
By default (\-\-tar\-filter=auto) Borg will detect whether the file is compressed
|
|
based on its file extension and pipe the file through an appropriate filter:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\&.tar.gz or .tgz: gzip \-d
|
|
.IP \(bu 2
|
|
\&.tar.bz2 or .tbz: bzip2 \-d
|
|
.IP \(bu 2
|
|
\&.tar.xz or .txz: xz \-d
|
|
.IP \(bu 2
|
|
\&.tar.zstd, .tar.zst or .tzst: zstd (in\-process)
|
|
.IP \(bu 2
|
|
\&.tar.lz4: lz4 \-d
|
|
.UNINDENT
|
|
.sp
|
|
For zstd, Borg decompresses in\-process using libzstd instead of piping through
|
|
an external program. The other formats are piped through the respective
|
|
external filter program.
|
|
.sp
|
|
Alternatively, a \-\-tar\-filter program may be explicitly specified. It should
|
|
read compressed data from stdin and output an uncompressed tar stream on
|
|
stdout.
|
|
.sp
|
|
Most documentation of borg create applies. Note that this command does not
|
|
support excluding files.
|
|
.sp
|
|
A \fB\-\-sparse\fP option (as found in borg create) is not needed: sparse members in
|
|
input tarballs (old GNU and PAX sparse formats) are read correctly and their
|
|
holes are stored as deduplicated all\-zero chunks.
|
|
.sp
|
|
About tar formats and metadata conservation or loss, please see \fBborg export\-tar\fP\&.
|
|
.sp
|
|
import\-tar reads these tar formats:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
BORG: borg specific (PAX\-based)
|
|
.IP \(bu 2
|
|
PAX: POSIX.1\-2001
|
|
.IP \(bu 2
|
|
GNU: GNU tar
|
|
.IP \(bu 2
|
|
POSIX.1\-1988 (ustar)
|
|
.IP \(bu 2
|
|
UNIX V7 tar
|
|
.IP \(bu 2
|
|
SunOS tar with extended attributes
|
|
.UNINDENT
|
|
.sp
|
|
To import multiple tarballs into a single archive, they can be simply
|
|
concatenated (e.g. using \(dqcat\(dq) into a single file, and imported with an
|
|
\fB\-\-ignore\-zeros\fP option to skip through the stop markers between them.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B NAME
|
|
specify the archive name
|
|
.TP
|
|
.B TARFILE
|
|
input tar file. \(dq\-\(dq to read from stdin instead.
|
|
.UNINDENT
|
|
.SS options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-tar\-filter
|
|
filter program to pipe data through
|
|
.TP
|
|
.B \-s\fP,\fB \-\-stats
|
|
print statistics for the created archive
|
|
.TP
|
|
.B \-\-list
|
|
output verbose list of items (files, dirs, ...)
|
|
.TP
|
|
.BI \-\-filter \ STATUSCHARS
|
|
only display items with the given status characters
|
|
.TP
|
|
.B \-\-json
|
|
output stats as JSON (implies \-\-stats)
|
|
.TP
|
|
.B \-\-ignore\-zeros
|
|
ignore zero\-filled blocks in the input tarball
|
|
.UNINDENT
|
|
.SS Archive options
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-\-comment \ COMMENT
|
|
add a comment text to the archive
|
|
.TP
|
|
.BI \-\-timestamp \ TIMESTAMP
|
|
manually specify the archive creation date/time (yyyy\-mm\-ddThh:mm:ss[(+|\-)HH:MM] format, (+|\-)HH:MM is the UTC offset, default: local time zone). Alternatively, give a reference file/directory.
|
|
.TP
|
|
.BI \-\-chunker\-params \ PARAMS
|
|
specify the chunker parameters: buzhash,CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,WINDOW_SIZE or buzhash64,CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,WINDOW_SIZE,NC_LEVEL or fastcdc,CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,NC_LEVEL. default: fastcdc,19,23,21,2
|
|
.TP
|
|
.BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION
|
|
select compression algorithm, see the output of the \(dqborg help compression\(dq command for details.
|
|
.TP
|
|
.BI \-\-digests \ ALGOS
|
|
compute these hash digests over the full content of each file and store them into the archive items. Comma\-separated list of hash algorithm names, e.g. \(dqblake3\(dq, or \(dqnone\(dq. default: none
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.EX
|
|
# Export as an uncompressed tar archive
|
|
$ borg export\-tar Monday Monday.tar
|
|
|
|
# Import an uncompressed tar archive
|
|
$ borg import\-tar Monday Monday.tar
|
|
|
|
# Exclude some file types and compress using gzip
|
|
$ borg export\-tar Monday Monday.tar.gz \-\-exclude \(aq*.so\(aq
|
|
|
|
# Use a higher compression level with gzip
|
|
$ borg export\-tar \-\-tar\-filter=\(dqgzip \-9\(dq Monday Monday.tar.gz
|
|
|
|
# Copy an archive from repoA to repoB
|
|
$ borg \-r repoA export\-tar \-\-tar\-format=BORG archive \- | borg \-r repoB import\-tar archive \-
|
|
|
|
# Export a tar, but instead of storing it on disk, upload it to a remote site using curl
|
|
$ borg export\-tar Monday \- | curl \-\-data\-binary @\- https://somewhere/to/POST
|
|
|
|
# Remote extraction via \(aqtarpipe\(aq
|
|
$ borg export\-tar Monday \- | ssh somewhere \(dqcd extracted; tar x\(dq
|
|
|
|
# Export sparse files (e.g. disk images) as sparse tar members (GNU sparse format 1.0)
|
|
$ borg export\-tar \-\-sparse disk\-images disk\-images.tar
|
|
.EE
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SS Archives transfer script
|
|
.sp
|
|
Outputs a script that copies all archives from repo1 to repo2
|
|
(\fBbash\fP, because it uses process substitution). Remove the \fBecho\fP to
|
|
actually run the commands instead of just printing them:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.EX
|
|
while read \-r N I T
|
|
do
|
|
echo \(dqborg \-r repo1 export\-tar \-\-tar\-format=BORG aid:$I \- | borg \-r repo2 import\-tar \-\-timestamp=$T $N \-\(dq
|
|
done < <(borg \-r repo1 repo\-list \-\-format=\(aq{name} {id} {time:%Y\-%m\-%dT%H:%M:%S}{NL}\(aq)
|
|
.EE
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Kept:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
archive name, archive timestamp
|
|
.IP \(bu 2
|
|
archive contents (all items with metadata and data)
|
|
.UNINDENT
|
|
.sp
|
|
Lost:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
some archive metadata (like the original command line, execution time, etc.)
|
|
.UNINDENT
|
|
.sp
|
|
Please note:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
all data goes over that pipe, again and again for every archive
|
|
.IP \(bu 2
|
|
the pipe is dumb, there is no data or transfer time reduction there due to deduplication
|
|
.IP \(bu 2
|
|
maybe add compression
|
|
.IP \(bu 2
|
|
pipe over ssh for remote transfer
|
|
.IP \(bu 2
|
|
maybe add \fB\-\-sparse\fP to the export\-tar command, so runs of all\-zero chunks
|
|
travel as a compact sparse map instead of literal zeros
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH Author
|
|
The Borg Collective
|
|
.\" End of generated man page.
|