borg/docs/usage/extract.rst.inc

.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!

.. _borg_extract:

borg extract
------------
::

    borg extract <options> ARCHIVE PATH

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
    ``-e PATTERN``, ``--exclude PATTERN``
        | exclude paths matching PATTERN
    ``--exclude-from EXCLUDEFILE``
        | read exclude patterns from EXCLUDEFILE, one per line
    ``--numeric-owner``
        | only obey numeric user and group identifiers
    ``--strip-components NUMBER``
        | Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
    ``--stdout``
        | write all extracted data to stdout
    ``--sparse``
        | create holes in output sparse file from all-zero chunks

`Common options`_
    |

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.

See the output of the "borg help patterns" command for more help on exclude patterns.

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.
update usage files 2016-07-05 21:30:08 +00:00			`.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!`

commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384 2015-11-13 15:42:16 +00:00			`.. _borg_extract:`

			`borg extract`
			`------------`
			`::`

Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour. 2016-04-09 23:28:18 +00:00			`borg extract <options> ARCHIVE PATH`

			`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`
			``-e PATTERN``, ``--exclude PATTERN``
			`\| exclude paths matching PATTERN`
			``--exclude-from EXCLUDEFILE``
			`\| read exclude patterns from EXCLUDEFILE, one per line`
			``--numeric-owner``
			`\| only obey numeric user and group identifiers`
			``--strip-components NUMBER``
			`\| Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.`
			``--stdout``
			`\| write all extracted data to stdout`
			``--sparse``
			`\| create holes in output sparse file from all-zero chunks`

			`Common options`_
			`\|`

commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384 2015-11-13 15:42:16 +00:00			`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.

			`See the output of the "borg help patterns" command for more help on exclude patterns.`
Merge branch '1.0-maint' 2016-07-05 23:33:53 +00:00
			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.`