mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-29 11:16:43 +00:00
127 lines
No EOL
10 KiB
PHP
127 lines
No EOL
10 KiB
PHP
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
.. _borg_export-tar:
|
|
|
|
borg export-tar
|
|
---------------
|
|
.. code-block:: none
|
|
|
|
borg [common options] export-tar [options] NAME FILE [PATH...]
|
|
|
|
.. only:: html
|
|
|
|
.. class:: borg-options-table
|
|
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| **positional arguments** |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``NAME`` | specify the archive name |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``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, ...) |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--tar-format FMT`` | select tar format: BORG, PAX or GNU |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| .. class:: borg-common-opt-ref |
|
|
| |
|
|
| :ref:`common_options` |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| **Exclusion options** |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--exclude-from EXCLUDEFILE`` | read exclude patterns from EXCLUDEFILE, one per line |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--pattern PATTERN`` | include/exclude paths matching PATTERN |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--patterns-from PATTERNFILE`` | read include/exclude patterns from PATTERNFILE, one per line |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--strip-components NUMBER`` | Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
|
|
.. raw:: html
|
|
|
|
<script type='text/javascript'>
|
|
$(document).ready(function () {
|
|
$('.borg-options-table colgroup').remove();
|
|
})
|
|
</script>
|
|
|
|
.. only:: latex
|
|
|
|
NAME
|
|
specify the archive name
|
|
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, ...)
|
|
--tar-format FMT select tar format: BORG, PAX or GNU
|
|
|
|
|
|
:ref:`common_options`
|
|
|
|
|
|
|
Exclusion options
|
|
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN
|
|
--exclude-from EXCLUDEFILE read exclude patterns from EXCLUDEFILE, one per line
|
|
--pattern PATTERN include/exclude paths matching PATTERN
|
|
--patterns-from PATTERNFILE read include/exclude patterns from PATTERNFILE, one per line
|
|
--strip-components NUMBER Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.
|
|
|
|
|
|
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: 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 |
|
|
+--------------+---------------------------+----------------------------+
|
|
| 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 :ref:`borg_patterns` command output.
|
|
|
|
``--progress`` can be slower than no progress display, since it makes one additional
|
|
pass over the archive metadata. |