summaryrefslogtreecommitdiffstats
path: root/docs/man/borg-key-change-passphrase.1
diff options
context:
space:
mode:
authorMarian Beermann <public@enkore.de>2017-06-18 12:13:28 +0200
committerMarian Beermann <public@enkore.de>2017-06-18 12:13:28 +0200
commit1e2835eb1df7300e71d54b8e808051a0acfb6c55 (patch)
treeac71e7b7ea1ed7c6848eef66139970d264617970 /docs/man/borg-key-change-passphrase.1
parentc7dda0aca9c554fd6c55418186ceeca22aa375ba (diff)
docs: man pages, usage.
Diffstat (limited to 'docs/man/borg-key-change-passphrase.1')
-rw-r--r--docs/man/borg-key-change-passphrase.146
1 files changed, 45 insertions, 1 deletions
diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1
index 6457d3a7f..88d1b2c1a 100644
--- a/docs/man/borg-key-change-passphrase.1
+++ b/docs/man/borg-key-change-passphrase.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2017-05-17" "" "borg backup tool"
+.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2017-06-18" "" "borg backup tool"
.SH NAME
borg-key-change-passphrase \- Change repository key file passphrase
.
@@ -43,6 +43,50 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.sp
REPOSITORY
+.SH EXAMPLES
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# Create a key file protected repository
+$ borg init \-\-encryption=keyfile \-v /path/to/repo
+Initializing repository at "/path/to/repo"
+Enter new passphrase:
+Enter same passphrase again:
+Remember your passphrase. Your data will be inaccessible without it.
+Key in "/root/.config/borg/keys/mnt_backup" created.
+Keep this key safe. Your data will be inaccessible without it.
+Synchronizing chunks cache...
+Archives: 0, w/ cached Idx: 0, w/ outdated Idx: 0, w/o cached Idx: 0.
+Done.
+
+# Change key file passphrase
+$ borg key change\-passphrase \-v /path/to/repo
+Enter passphrase for key /root/.config/borg/keys/mnt_backup:
+Enter new passphrase:
+Enter same passphrase again:
+Remember your passphrase. Your data will be inaccessible without it.
+Key updated
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Fully automated using environment variables:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ BORG_NEW_PASSPHRASE=old borg init \-e=repokey repo
+# now "old" is the current passphrase.
+$ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase repo
+# now "new" is the current passphrase.
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP