2026-03-15 09:34:31 -04:00
|
|
|
.\" Man page generated from reStructuredText
|
|
|
|
|
.\" by the Docutils 0.22.4 manpage writer.
|
2017-02-05 08:22:06 -05:00
|
|
|
.
|
|
|
|
|
.
|
|
|
|
|
.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
|
|
|
|
|
..
|
2026-06-16 08:17:43 -04:00
|
|
|
.TH "borg-key-import" "1" "2026-06-16" "" "borg backup tool"
|
2026-03-15 09:34:31 -04:00
|
|
|
.SH Name
|
2025-12-23 12:00:09 -05:00
|
|
|
borg-key-import \- Imports the repository key from backup.
|
2017-02-05 08:22:06 -05:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.sp
|
2022-06-23 19:19:19 -04:00
|
|
|
borg [common options] key import [options] [PATH]
|
2017-02-05 08:22:06 -05:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.sp
|
2018-01-03 09:54:52 -05:00
|
|
|
This command restores a key previously backed up with the export command.
|
2017-02-05 08:22:06 -05:00
|
|
|
.sp
|
|
|
|
|
If the \fB\-\-paper\fP option is given, the import will be an interactive
|
|
|
|
|
process in which each line is checked for plausibility before
|
|
|
|
|
proceeding to the next line. For this format PATH must not be given.
|
2020-10-04 14:33:08 -04:00
|
|
|
.sp
|
|
|
|
|
For repositories using keyfile encryption, the key file which \fBborg key
|
|
|
|
|
import\fP writes to depends on several factors. If the \fBBORG_KEY_FILE\fP
|
|
|
|
|
environment variable is set and non\-empty, \fBborg key import\fP creates
|
|
|
|
|
or overwrites that file named by \fB$BORG_KEY_FILE\fP\&. Otherwise, \fBborg
|
|
|
|
|
key import\fP searches in the \fB$BORG_KEYS_DIR\fP directory for a key file
|
|
|
|
|
associated with the repository. If a key file is found in
|
|
|
|
|
\fB$BORG_KEYS_DIR\fP, \fBborg key import\fP overwrites it; otherwise, \fBborg
|
|
|
|
|
key import\fP creates a new key file in \fB$BORG_KEYS_DIR\fP\&.
|
2017-02-05 08:22:06 -05:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.sp
|
|
|
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
|
|
|
.SS arguments
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B PATH
|
2017-11-25 08:38:04 -05:00
|
|
|
path to the backup (\(aq\-\(aq to read from stdin)
|
2017-02-05 08:22:06 -05:00
|
|
|
.UNINDENT
|
2025-04-21 15:07:46 -04:00
|
|
|
.SS options
|
2017-02-05 08:22:06 -05:00
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2022-06-23 19:19:19 -04:00
|
|
|
.B \-\-paper
|
2017-06-18 06:13:28 -04:00
|
|
|
interactively import from a backup done with \fB\-\-paper\fP
|
2026-06-16 08:17:43 -04:00
|
|
|
.TP
|
|
|
|
|
.BI \-\-key\-location \ LOCATION
|
|
|
|
|
where to store the imported key: \(aqrepokey\(aq (in the repository, default) or \(aqkeyfile\(aq (in the local keys directory)
|
2017-02-05 08:22:06 -05:00
|
|
|
.UNINDENT
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.sp
|
|
|
|
|
\fIborg\-common(1)\fP, \fIborg\-key\-export(1)\fP
|
2026-03-15 09:34:31 -04:00
|
|
|
.SH Author
|
2017-02-05 08:22:06 -05:00
|
|
|
The Borg Collective
|
2026-03-15 09:34:31 -04:00
|
|
|
.\" End of generated man page.
|
