From 9f311abd7927cf267bf9479f5498d4d2b904491e Mon Sep 17 00:00:00 2001 From: Andrey Bienkowski Date: Fri, 4 Feb 2022 17:37:33 +0000 Subject: [PATCH] Doc: borg key export: add examples (#6227) docs: borg key export: add examples see: https://github.com/borgbackup/borg/issues/6204#issuecomment-1027150308 --- src/borg/archiver.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 7560c557c..357a55f17 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -4131,6 +4131,18 @@ def define_borg_mount(parser): repository in the config file. A backup is thus not strictly needed, but guards against the repository becoming inaccessible if the file is damaged for some reason. + + Examples:: + + borg key export /path/to/repo > encrypted-key-backup + borg key export --paper /path/to/repo > encrypted-key-backup.txt + borg key export --qr-html /path/to/repo > encrypted-key-backup.html + # Or pass the output file as an argument instead of redirecting stdout: + borg key export /path/to/repo encrypted-key-backup + borg key export --paper /path/to/repo encrypted-key-backup.txt + borg key export --qr-html /path/to/repo encrypted-key-backup.html + + """) subparser = key_parsers.add_parser('export', parents=[common_parser], add_help=False, description=self.do_key_export.__doc__,