mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-27 02:08:54 +00:00
8e36075fe9
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
49 lines
2.1 KiB
PHP
49 lines
2.1 KiB
PHP
.. _borg_extract:
|
|
|
|
borg extract
|
|
------------
|
|
::
|
|
|
|
usage: borg extract [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
|
|
[--remote-path PATH] [-n] [-e PATTERN]
|
|
[--exclude-from EXCLUDEFILE] [--numeric-owner]
|
|
[--strip-components NUMBER] [--stdout] [--sparse]
|
|
ARCHIVE [PATH [PATH ...]]
|
|
|
|
Extract archive contents
|
|
|
|
positional arguments:
|
|
ARCHIVE archive to extract
|
|
PATH paths to extract
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
-v, --verbose verbose output
|
|
--show-rc show/log the return code (rc)
|
|
--no-files-cache do not load/update the file metadata cache used to
|
|
detect unchanged files
|
|
--umask M set umask to M (local and remote, default: 63)
|
|
--remote-path PATH set remote path to executable (default: "borg")
|
|
-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
|
|
|
|
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.
|