mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-26 17:57:59 +00:00
125 lines
No EOL
12 KiB
HTML
125 lines
No EOL
12 KiB
HTML
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
.. _borg_extract:
|
|
|
|
borg extract
|
|
------------
|
|
.. code-block:: none
|
|
|
|
borg [common options] extract [options] ARCHIVE [PATH...]
|
|
|
|
.. only:: html
|
|
|
|
.. class:: borg-options-table
|
|
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| **positional arguments** |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``ARCHIVE`` | archive to extract |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``PATH`` | paths to extract; patterns are supported |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| **optional arguments** |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--list`` | output verbose list of items (files, dirs, ...) |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``-n``, ``--dry-run`` | do not actually change any files |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--numeric-ids`` | only obey numeric user and group identifiers |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--nobsdflags`` | deprecated, use ``--noflags`` instead |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--noflags`` | do not extract/set flags (e.g. NODUMP, IMMUTABLE) |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--noacls`` | do not extract/set ACLs |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--noxattrs`` | do not extract/set xattrs |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--stdout`` | write all extracted data to stdout |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| | ``--sparse`` | create holes in output sparse file from all-zero chunks |
|
|
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
| .. 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
|
|
|
|
ARCHIVE
|
|
archive to extract
|
|
PATH
|
|
paths to extract; patterns are supported
|
|
|
|
|
|
optional arguments
|
|
--list output verbose list of items (files, dirs, ...)
|
|
-n, --dry-run do not actually change any files
|
|
--numeric-owner deprecated, use ``--numeric-ids`` instead
|
|
--numeric-ids only obey numeric user and group identifiers
|
|
--nobsdflags deprecated, use ``--noflags`` instead
|
|
--noflags do not extract/set flags (e.g. NODUMP, IMMUTABLE)
|
|
--noacls do not extract/set ACLs
|
|
--noxattrs do not extract/set xattrs
|
|
--stdout write all extracted data to stdout
|
|
--sparse create holes in output sparse file from all-zero chunks
|
|
|
|
|
|
: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 extracts the contents of an archive. 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.
|
|
|
|
By using ``--dry-run``, you can do all extraction steps except actually writing the
|
|
output data: reading metadata and data chunks from the repo, checking the hash/hmac,
|
|
decrypting, decompressing.
|
|
|
|
``--progress`` can be slower than no progress display, since it makes one additional
|
|
pass over the archive metadata.
|
|
|
|
.. note::
|
|
|
|
Currently, extract always writes into the current working directory ("."),
|
|
so make sure you ``cd`` to the right place before calling ``borg extract``.
|
|
|
|
When parent directories are not extracted (because of using file/directory selection
|
|
or any other reason), borg can not restore parent directories' metadata, e.g. owner,
|
|
group, permission, etc. |