From 6211a3dc793d7bec99243ffefe6454e1d4e5012a Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Fri, 19 Jul 2024 19:44:38 +0200 Subject: [PATCH] key export: move examples to docs --- docs/usage/key.rst | 12 ++++++++++++ src/borg/archiver/key_cmds.py | 12 ------------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/usage/key.rst b/docs/usage/key.rst index 07b517a43..728db27eb 100644 --- a/docs/usage/key.rst +++ b/docs/usage/key.rst @@ -45,4 +45,16 @@ Fully automated using environment variables: .. include:: key_export.rst.inc +Examples +~~~~~~~~ +:: + + borg key export > encrypted-key-backup + borg key export --paper > encrypted-key-backup.txt + borg key export --qr-html > encrypted-key-backup.html + # Or pass the output file as an argument instead of redirecting stdout: + borg key export encrypted-key-backup + borg key export --paper encrypted-key-backup.txt + borg key export --qr-html encrypted-key-backup.html + .. include:: key_import.rst.inc diff --git a/src/borg/archiver/key_cmds.py b/src/borg/archiver/key_cmds.py index c3b4e457d..1afa666a3 100644 --- a/src/borg/archiver/key_cmds.py +++ b/src/borg/archiver/key_cmds.py @@ -160,18 +160,6 @@ def build_parser_keys(self, subparsers, common_parser, mid_common_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(