mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-27 20:49:04 +00:00
Code Issues Releases Wiki Activity
bind/doc/man/dnssec-importkey.1in

127 lines
4.7 KiB
Plaintext
Raw Normal View History

Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02: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
..
Regenerate man pages with docutils 0.17.1 The Debian 10 (buster) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.2.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2021-09-16 10:57:04 +02:00
.TH "DNSSEC-IMPORTKEY" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.SH NAME
dnssec-importkey \- import DNSKEY records from external systems so they can be managed
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.SH SYNOPSIS
.sp
\fBdnssec\-importkey\fP [\fB\-K\fP directory] [\fB\-L\fP ttl] [\fB\-P\fP date/offset] [\fB\-P\fP sync date/offset] [\fB\-D\fP date/offset] [\fB\-D\fP sync date/offset] [\fB\-h\fP] [\fB\-v\fP level] [\fB\-V\fP] {keyfile}
.sp
\fBdnssec\-importkey\fP {\fB\-f\fP filename} [\fB\-K\fP directory] [\fB\-L\fP ttl] [\fB\-P\fP date/offset] [\fB\-P\fP sync date/offset] [\fB\-D\fP date/offset] [\fB\-D\fP sync date/offset] [\fB\-h\fP] [\fB\-v\fP level] [\fB\-V\fP] [dnsname]
.SH DESCRIPTION
.sp
\fBdnssec\-importkey\fP reads a public DNSKEY record and generates a pair
Remove the .key from the beginning of the line in rst file The handling of . (dot) characted at the beginning of the line has changed between the sphinx-doc versions, and it was constantly giving us trouble when generating man pages when using different sphinx-doc. This commit just changes the source rst file, so there's no more . (dot) the beginning of the line.
2020-09-30 21:12:15 +02:00
of .key/.private files. The DNSKEY record may be read from an
existing .key file, in which case a corresponding .private file is
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
generated, or it may be read from any other file or from the standard
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
input, in which case both .key and .private files are generated.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.sp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
The newly created .private file does \fInot\fP contain private key data, and
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
cannot be used for signing. However, having a .private file makes it
possible to set publication (\fB\-P\fP) and deletion (\fB\-D\fP) times for the
key, which means the public key can be added to and removed from the
DNSKEY RRset on schedule even if the true private key is stored offline.
.SH OPTIONS
.INDENT 0.0
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-f filename\fP
This option indicates the zone file mode. Instead of a public keyfile name, the argument is the
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
DNS domain name of a zone master file, which can be read from
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
\fBfilename\fP\&. If the domain name is the same as \fBfilename\fP, then it may be
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
omitted.
.sp
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
If \fBfilename\fP is set to \fB"\-"\fP, then the zone data is read from the
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
standard input.
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-K directory\fP
This option sets the directory in which the key files are to reside.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-L ttl\fP
This option sets the default TTL to use for this key when it is converted into a
DNSKEY RR. This is the TTL used when the key is imported into a zone,
unless there was already a DNSKEY RRset in
place, in which case the existing TTL takes precedence. Setting the default TTL to \fB0\fP or \fBnone\fP
removes it from the key.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-h\fP
This option emits a usage message and exits.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-v level\fP
This option sets the debugging level.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-V\fP
This option prints version information.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.UNINDENT
.SH TIMING OPTIONS
.sp
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
argument begins with a \fB+\fP or \fB\-\fP, it is interpreted as an offset from
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
the present time. For convenience, if such an offset is followed by one
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
of the suffixes \fBy\fP, \fBmo\fP, \fBw\fP, \fBd\fP, \fBh\fP, or \fBmi\fP, then the offset is
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
computed in years (defined as 365 24\-hour days, ignoring leap years),
months (defined as 30 24\-hour days), weeks, days, hours, or minutes,
respectively. Without a suffix, the offset is computed in seconds. To
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
explicitly prevent a date from being set, use \fBnone\fP or \fBnever\fP\&.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.INDENT 0.0
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-P date/offset\fP
This option sets the date on which a key is to be published to the zone. After
that date, the key is included in the zone but is not used
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
to sign it.
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-P sync date/offset\fP
This option sets the date on which CDS and CDNSKEY records that match this key
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
are to be published to the zone.
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-D date/offset\fP
This option sets the date on which the key is to be deleted. After that date, the
key is no longer included in the zone. (However, it may remain in the key
repository.)
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.TP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
.B \fB\-D sync date/offset\fP
This option sets the date on which the CDS and CDNSKEY records that match this
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
key are to be deleted.
.UNINDENT
.SH FILES
.sp
A keyfile can be designed by the key identification \fBKnnnn.+aaa+iiiii\fP
Update the generated files after the source manpages update
2020-07-02 10:53:16 +02:00
or the full file name \fBKnnnn.+aaa+iiiii.key\fP, as generated by
\fBdnssec\-keygen\fP\&.
Fix formatting of See Also section header
2020-07-01 15:16:51 +00:00
.SH SEE ALSO
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.sp
\fBdnssec\-keygen(8)\fP, \fBdnssec\-signzone(8)\fP, BIND 9 Administrator Reference Manual,
\fI\%RFC 5011\fP\&.
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
Update copyright date in man pages
2021-01-11 12:01:51 +01:00
2021, Internet Systems Consortium
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.\" Generated by docutils manpage writer.
.
Reference in New Issue Copy Permalink