From d2988444c0682cfc5e05fd134ee247c42819402b Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sat, 7 May 2016 18:53:58 +0200 Subject: [PATCH] better help / docs for borg extract --dry-run, fixes #1022 --- borg/archiver.py | 4 ++++ docs/usage.rst | 3 +++ 2 files changed, 7 insertions(+) diff --git a/borg/archiver.py b/borg/archiver.py index 42c6e4212..42cb0ba08 100644 --- a/borg/archiver.py +++ b/borg/archiver.py @@ -1401,6 +1401,10 @@ class Archiver: 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. """) subparser = subparsers.add_parser('extract', parents=[common_parser], add_help=False, description=self.do_extract.__doc__, diff --git a/docs/usage.rst b/docs/usage.rst index f4b0b52ae..600af4fea 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -327,6 +327,9 @@ Examples # Extract entire archive and list files while processing $ borg extract -v --list /path/to/repo::my-files + # Verify whether an archive could be successfully extracted, but do not write files to disk + $ borg extract --dry-run /path/to/repo::my-files + # Extract the "src" directory $ borg extract /path/to/repo::my-files home/USERNAME/src