extract.rst.inc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. .. _borg_extract:
  2. borg extract
  3. ------------
  4. ::
  5. borg extract <options> ARCHIVE PATH
  6. positional arguments
  7. ARCHIVE
  8. archive to extract
  9. PATH
  10. paths to extract; patterns are supported
  11. optional arguments
  12. ``--list``
  13. | output verbose list of items (files, dirs, ...)
  14. ``-n``, ``--dry-run``
  15. | do not actually change any files
  16. ``-e PATTERN``, ``--exclude PATTERN``
  17. | exclude paths matching PATTERN
  18. ``--exclude-from EXCLUDEFILE``
  19. | read exclude patterns from EXCLUDEFILE, one per line
  20. ``--numeric-owner``
  21. | only obey numeric user and group identifiers
  22. ``--strip-components NUMBER``
  23. | Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
  24. ``--stdout``
  25. | write all extracted data to stdout
  26. ``--sparse``
  27. | create holes in output sparse file from all-zero chunks
  28. `Common options`_
  29. |
  30. Description
  31. ~~~~~~~~~~~
  32. This command extracts the contents of an archive. By default the entire
  33. archive is extracted but a subset of files and directories can be selected
  34. by passing a list of ``PATHs`` as arguments. The file selection can further
  35. be restricted by using the ``--exclude`` option.
  36. See the output of the "borg help patterns" command for more help on exclude patterns.