2017-05-16 22:09:41 +00:00
|
|
|
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
|
|
|
|
|
|
.. _borg_export-tar:
|
|
|
|
|
|
|
|
|
|
borg export-tar
|
|
|
|
|
---------------
|
2017-06-06 22:44:53 +00:00
|
|
|
.. code-block:: none
|
2017-05-16 22:09:41 +00:00
|
|
|
|
2017-06-06 22:44:53 +00:00
|
|
|
borg [common options] export-tar [options] ARCHIVE FILE PATH
|
2017-05-16 22:09:41 +00:00
|
|
|
|
|
|
|
|
positional arguments
|
|
|
|
|
ARCHIVE
|
|
|
|
|
archive to export
|
|
|
|
|
FILE
|
|
|
|
|
output tar file. "-" to write to stdout instead.
|
|
|
|
|
PATH
|
|
|
|
|
paths to extract; patterns are supported
|
|
|
|
|
|
|
|
|
|
optional arguments
|
|
|
|
|
``--tar-filter``
|
|
|
|
|
| filter program to pipe data through
|
|
|
|
|
``--list``
|
|
|
|
|
| output verbose list of items (files, dirs, ...)
|
|
|
|
|
``-e PATTERN``, ``--exclude PATTERN``
|
|
|
|
|
| exclude paths matching PATTERN
|
|
|
|
|
``--exclude-from EXCLUDEFILE``
|
|
|
|
|
| read exclude patterns from EXCLUDEFILE, one per line
|
|
|
|
|
``--pattern PATTERN``
|
2017-06-09 17:24:45 +00:00
|
|
|
| experimental: include/exclude paths matching PATTERN
|
2017-05-16 22:09:41 +00:00
|
|
|
``--patterns-from PATTERNFILE``
|
2017-06-09 17:24:45 +00:00
|
|
|
| experimental: read include/exclude patterns from PATTERNFILE, one per line
|
2017-05-16 22:09:41 +00:00
|
|
|
``--strip-components NUMBER``
|
|
|
|
|
| Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
|
|
|
|
|
|
2017-06-06 22:06:36 +00:00
|
|
|
:ref:`common_options`
|
2017-05-16 22:09:41 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
This command creates a tarball from an archive.
|
|
|
|
|
|
|
|
|
|
When giving '-' as the output FILE, Borg will write a tar stream to standard output.
|
|
|
|
|
|
2017-06-17 10:28:42 +00:00
|
|
|
By default (``--tar-filter=auto``) Borg will detect whether the FILE should be compressed
|
2017-05-16 22:09:41 +00:00
|
|
|
based on its file extension and pipe the tarball through an appropriate filter
|
|
|
|
|
before writing it to FILE:
|
|
|
|
|
|
|
|
|
|
- .tar.gz: gzip
|
|
|
|
|
- .tar.bz2: bzip2
|
|
|
|
|
- .tar.xz: xz
|
|
|
|
|
|
2017-06-17 10:28:42 +00:00
|
|
|
Alternatively a ``--tar-filter`` program may be explicitly specified. It should
|
2017-05-16 22:09:41 +00:00
|
|
|
read the uncompressed tar stream from stdin and write a compressed/filtered
|
|
|
|
|
tar stream to stdout.
|
|
|
|
|
|
|
|
|
|
The generated tarball uses the GNU tar format.
|
|
|
|
|
|
|
|
|
|
export-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.
|
|
|
|
|
|
2017-06-17 10:28:42 +00:00
|
|
|
A ``--sparse`` option (as found in borg extract) is not supported.
|
2017-05-16 22:09:41 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
See the output of the "borg help patterns" command for more help on exclude patterns.
|
|
|
|
|
|
|
|
|
|
``--progress`` can be slower than no progress display, since it makes one additional
|
|
|
|
|
pass over the archive metadata.
|
