borg-export-tar - Export archive contents as a tarball
Contents
Description
This command creates a tarball from an archive.
When giving '-' as the output FILE, Borg will write a tar stream to standard output.
By default (--tar-filter=auto) 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:
• .tar.gz or .tgz: gzip
• .tar.bz2 or .tbz: bzip2
• .tar.xz or .txz: xz
• .tar.zstd or .tar.zst: zstd
• .tar.lz4: lz4
Alternatively, a --tar-filter program may be explicitly specified. It should read the uncompressed tar
stream from stdin and write a compressed/filtered tar stream to stdout.
Depending on the -tar-format option, these formats are created:
┌──────────────┬───────────────────────────┬──────────────────────────────┐
│ --tar-format │ Specification │ Metadata │
├──────────────┼───────────────────────────┼──────────────────────────────┤
│ BORG │ BORG specific, like PAX │ all as supported by borg │
├──────────────┼───────────────────────────┼──────────────────────────────┤
│ PAX │ POSIX.1-2001 (pax) format │ GNU + atime/ctime/mtime ns + │
│ │ │ xattrs │
├──────────────┼───────────────────────────┼──────────────────────────────┤
│ GNU │ GNU tar format │ mtime s, no atime/ctime, no │
│ │ │ ACLs/xattrs/bsdflags │
└──────────────┴───────────────────────────┴──────────────────────────────┘
A --sparse option (as found in borg extract) is not supported.
By default the entire archive is extracted but a subset of files and directories can be selected by
passing a list of PATHs as arguments. The file selection can further be restricted by using the
--exclude option.
For more help on include/exclude patterns, see the borg_patterns command output.
--progress can be slower than no progress display, since it makes one additional pass over the archive
metadata.
Name
borg-export-tar - Export archive contents as a tarball
Options
See borg-common(1) for common options of Borg commands.
argumentsNAME specify the archive name
FILE output tar file. "-" to write to stdout instead.
PATH paths to extract; patterns are supported
options--tar-filter
filter program to pipe data through
--list output verbose list of items (files, dirs, ...)
--tar-formatFMT
select tar format: BORG, PAX or GNU
Include/Excludeoptions-ePATTERN, --excludePATTERN
exclude paths matching PATTERN
--exclude-fromEXCLUDEFILE
read exclude patterns from EXCLUDEFILE, one per line
--patternPATTERN
include/exclude paths matching PATTERN
--patterns-fromPATTERNFILE
read include/exclude patterns from PATTERNFILE, one per line
--strip-componentsNUMBER
Remove the specified number of leading path elements. Paths with fewer elements will be silently
skipped.
See Also
borg-common(1)Synopsis
borg [common options] export-tar [options] NAME FILE [PATH...]
