upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-05-28 04:03:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

extract: document how to use wildcards in PATHs

Browse source 
Fixes https://github.com/borgbackup/borg/issues/8589
This commit is contained in:
Atemu 2024-12-20 09:55:21 +01:00 committed by Thomas Waldmann
parent 924d94be75
commit 908c506e3f
No known key found for this signature in database
GPG key ID: 243ACFA951F78E01
2 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/usage/extract.rst
View file

@ -19,5 +19,8 @@ Examples
# Extract the "src" directory but exclude object files
$ borg extract /path/to/repo::my-files home/USERNAME/src --exclude '*.o'
# Extract only the C files
$ borg extract /path/to/repo::my-files 'sh:home/USERNAME/src/*.c'
# Restore a raw device (must not be active/in use/mounted at that time)
$ borg extract --stdout /path/to/repo::my-sdx | dd of=/dev/sdx bs=10M

12
src/borg/archiver.py
View file

@ -4371,11 +4371,15 @@ class Archiver:
# borg extract
extract_epilog = process_epilog("""
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.
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 ``PATH`` arguments. The default interpretation
for the paths to extract is `pp:` which is a literal path-prefix match. If you want
to use e.g. a wildcard, you must select a different pattern style such as `sh:` or
`fm:`. See :ref:`borg_patterns` for more information.
The file selection can be further 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