mirror of https://github.com/borgbackup/borg.git
164 lines
3.6 KiB
Groff
164 lines
3.6 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-EXPORT-TAR" 1 "2024-02-20" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-export-tar \- Export archive contents as a tarball
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] export\-tar [options] NAME FILE [PATH...]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command creates a tarball from an archive.
|
|
.sp
|
|
When giving \(aq\-\(aq as the output FILE, Borg will write a tar stream to standard output.
|
|
.sp
|
|
By default (\fB\-\-tar\-filter=auto\fP) Borg will detect whether the FILE should be compressed
|
|
based on its file extension and pipe the tarball through an appropriate filter
|
|
before writing it to FILE:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\&.tar.gz or .tgz: gzip
|
|
.IP \(bu 2
|
|
\&.tar.bz2 or .tbz: bzip2
|
|
.IP \(bu 2
|
|
\&.tar.xz or .txz: xz
|
|
.IP \(bu 2
|
|
\&.tar.zstd or .tar.zst: zstd
|
|
.IP \(bu 2
|
|
\&.tar.lz4: lz4
|
|
.UNINDENT
|
|
.sp
|
|
Alternatively, a \fB\-\-tar\-filter\fP program may be explicitly specified. It should
|
|
read the uncompressed tar stream from stdin and write a compressed/filtered
|
|
tar stream to stdout.
|
|
.sp
|
|
Depending on the \fB\-tar\-format\fP option, these formats are created:
|
|
.TS
|
|
center;
|
|
|l|l|l|.
|
|
_
|
|
T{
|
|
\-\-tar\-format
|
|
T} T{
|
|
Specification
|
|
T} T{
|
|
Metadata
|
|
T}
|
|
_
|
|
T{
|
|
BORG
|
|
T} T{
|
|
BORG specific, like PAX
|
|
T} T{
|
|
all as supported by borg
|
|
T}
|
|
_
|
|
T{
|
|
PAX
|
|
T} T{
|
|
POSIX.1\-2001 (pax) format
|
|
T} T{
|
|
GNU + atime/ctime/mtime ns
|
|
T}
|
|
_
|
|
T{
|
|
GNU
|
|
T} T{
|
|
GNU tar format
|
|
T} T{
|
|
mtime s, no atime/ctime,
|
|
no ACLs/xattrs/bsdflags
|
|
T}
|
|
_
|
|
.TE
|
|
.sp
|
|
A \fB\-\-sparse\fP option (as found in borg extract) is not supported.
|
|
.sp
|
|
By default the entire archive is extracted but a subset of files and directories
|
|
can be selected by passing a list of \fBPATHs\fP as arguments.
|
|
The file selection can further be restricted by using the \fB\-\-exclude\fP option.
|
|
.sp
|
|
For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
|
|
.sp
|
|
\fB\-\-progress\fP can be slower than no progress display, since it makes one additional
|
|
pass over the archive metadata.
|
|
.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 FILE
|
|
output tar file. \(dq\-\(dq to write to stdout instead.
|
|
.TP
|
|
.B PATH
|
|
paths to extract; patterns are supported
|
|
.UNINDENT
|
|
.SS options
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-tar\-filter
|
|
filter program to pipe data through
|
|
.TP
|
|
.B \-\-list
|
|
output verbose list of items (files, dirs, ...)
|
|
.TP
|
|
.BI \-\-tar\-format \ FMT
|
|
select tar format: BORG, PAX or GNU
|
|
.UNINDENT
|
|
.SS Include/Exclude 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
|
|
include/exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-patterns\-from \ PATTERNFILE
|
|
read include/exclude patterns from PATTERNFILE, one per line
|
|
.TP
|
|
.BI \-\-strip\-components \ NUMBER
|
|
Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|