2017-02-05 13:22:06 +00:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
|
.
|
|
|
|
|
.
|
|
|
|
|
.nr rst2man-indent-level 0
|
|
|
|
|
.
|
|
|
|
|
.de1 rstReportMargin
|
|
|
|
|
\\$1 \\n[an-margin]
|
|
|
|
|
level \\n[rst2man-indent-level]
|
|
|
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
-
|
|
|
|
|
\\n[rst2man-indent0]
|
|
|
|
|
\\n[rst2man-indent1]
|
|
|
|
|
\\n[rst2man-indent2]
|
|
|
|
|
..
|
|
|
|
|
.de1 INDENT
|
|
|
|
|
.\" .rstReportMargin pre:
|
|
|
|
|
. RS \\$1
|
|
|
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
|
|
|
. nr rst2man-indent-level +1
|
|
|
|
|
.\" .rstReportMargin post:
|
|
|
|
|
..
|
|
|
|
|
.de UNINDENT
|
|
|
|
|
. RE
|
|
|
|
|
.\" indent \\n[an-margin]
|
|
|
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.nr rst2man-indent-level -1
|
|
|
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
|
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
|
|
|
..
|
2022-06-23 23:19:19 +00:00
|
|
|
.TH "BORG-KEY-EXPORT" 1 "2022-06-25" "" "borg backup tool"
|
|
|
|
|
.SH NAME
|
|
|
|
|
borg-key-export \- Export the repository key for backup
|
2017-02-05 13:22:06 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.sp
|
2022-06-23 23:19:19 +00:00
|
|
|
borg [common options] key export [options] [PATH]
|
2017-02-05 13:22:06 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.sp
|
|
|
|
|
If repository encryption is used, the repository is inaccessible
|
2018-01-03 10:42:12 +00:00
|
|
|
without the key. This command allows one to backup this essential key.
|
2017-11-25 13:38:04 +00:00
|
|
|
Note that the backup produced does not include the passphrase itself
|
|
|
|
|
(i.e. the exported key stays encrypted). In order to regain access to a
|
|
|
|
|
repository, one needs both the exported key and the original passphrase.
|
2017-02-05 13:22:06 +00:00
|
|
|
.sp
|
2017-11-25 13:38:04 +00:00
|
|
|
There are three backup formats. The normal backup format is suitable for
|
2017-02-05 13:22:06 +00:00
|
|
|
digital storage as a file. The \fB\-\-paper\fP backup format is optimized
|
|
|
|
|
for printing and typing in while importing, with per line checks to
|
2017-11-25 13:38:04 +00:00
|
|
|
reduce problems with manual input. The \fB\-\-qr\-html\fP creates a printable
|
|
|
|
|
HTML template with a QR code and a copy of the \fB\-\-paper\fP\-formatted key.
|
2017-02-05 13:22:06 +00:00
|
|
|
.sp
|
|
|
|
|
For repositories using keyfile encryption the key is saved locally
|
|
|
|
|
on the system that is capable of doing backups. To guard against loss
|
|
|
|
|
of this key, the key needs to be backed up independently of the main
|
|
|
|
|
data backup.
|
|
|
|
|
.sp
|
|
|
|
|
For repositories using the repokey encryption the key is saved in the
|
|
|
|
|
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.
|
2022-02-05 16:30:40 +00:00
|
|
|
.sp
|
|
|
|
|
Examples:
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
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
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2017-02-05 13:22:06 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.sp
|
|
|
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
|
|
|
.SS arguments
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B PATH
|
|
|
|
|
where to store the backup
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SS optional arguments
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-paper
|
2017-02-05 13:22:06 +00:00
|
|
|
Create an export suitable for printing and later type\-in
|
2017-03-26 23:58:19 +00:00
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-qr\-html
|
2017-03-26 23:58:19 +00:00
|
|
|
Create an html file suitable for printing and later type\-in or qr scan
|
2017-02-05 13:22:06 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.sp
|
|
|
|
|
\fIborg\-common(1)\fP, \fIborg\-key\-import(1)\fP
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
The Borg Collective
|
|
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.
|
