mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-25 17:27:31 +00:00
127 lines
3.5 KiB
Groff
127 lines
3.5 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.
|
|
.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 "2022-02-19" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-import-tar \- Create a backup archive from a tarball
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] import\-tar [options] ARCHIVE 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: zstd \-d
|
|
.IP \(bu 2
|
|
\&.tar.lz4: lz4 \-d
|
|
.UNINDENT
|
|
.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
|
|
import\-tar is a lossy conversion:
|
|
BSD flags, ACLs, extended attributes (xattrs), atime and ctime are not exported.
|
|
Timestamp resolution is limited to whole seconds, not the nanosecond resolution
|
|
otherwise supported by Borg.
|
|
.sp
|
|
A \fB\-\-sparse\fP option (as found in borg create) is not supported.
|
|
.sp
|
|
import\-tar reads POSIX.1\-1988 (ustar), POSIX.1\-2001 (pax), GNU tar, UNIX V7 tar
|
|
and SunOS tar with extended attributes.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B ARCHIVE
|
|
name of archive to create (must be also a valid directory name)
|
|
.TP
|
|
.B TARFILE
|
|
input tar file. "\-" to read from stdin instead.
|
|
.UNINDENT
|
|
.SS optional arguments
|
|
.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)
|
|
.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 (UTC, yyyy\-mm\-ddThh:mm:ss format). alternatively, give a reference file/directory.
|
|
.TP
|
|
.BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS
|
|
write checkpoint every SECONDS seconds (Default: 1800)
|
|
.TP
|
|
.BI \-\-chunker\-params \ PARAMS
|
|
specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: buzhash,19,23,21,4095
|
|
.TP
|
|
.BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION
|
|
select compression algorithm, see the output of the "borg help compression" command for details.
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|