mirror of
https://gitlab.isc.org/isc-projects/bind9
synced 2025-08-31 06:25:31 +00:00
Make sure ddns-confgen man page stays up to date
This commit is contained in:
@@ -75,6 +75,7 @@ MANPAGES_RST = \
|
||||
|
||||
man_MANS = \
|
||||
arpaname.1 \
|
||||
ddns-confgen.8 \
|
||||
delv.1 \
|
||||
dig.1 \
|
||||
dnstap-read.1 \
|
||||
|
@@ -60,6 +60,7 @@ master_doc = 'index'
|
||||
# pylint: disable=line-too-long
|
||||
man_pages = [
|
||||
('arpaname', 'arpaname', 'translate IP addresses to the corresponding ARPA names', author, 1),
|
||||
('ddns-confgen', 'ddns-confgen', 'ddns key generation tool', author, 8),
|
||||
('delv', 'delv', 'DNS lookup and validation utility', author, 1),
|
||||
('dig', 'dig', 'DNS lookup utility', author, 1),
|
||||
('dnssec-cds', 'dnssec-cds', 'change DS records for a child zone based on CDS/CDNSKEY', author, 1),
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "DDNS-CONFGEN" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
|
||||
.TH "DDNS-CONFGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
|
||||
.SH NAME
|
||||
ddns-confgen \- ddns key generation tool
|
||||
.
|
||||
@@ -39,61 +39,61 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.sp
|
||||
\fBtsig\-keygen\fP and \fBddns\-confgen\fP are invocation methods for a
|
||||
utility that generates keys for use in TSIG signing. The resulting keys
|
||||
can be used, for example, to secure dynamic DNS updates to a zone or for
|
||||
can be used, for example, to secure dynamic DNS updates to a zone, or for
|
||||
the \fBrndc\fP command channel.
|
||||
.sp
|
||||
When run as \fBtsig\-keygen\fP, a domain name can be specified on the
|
||||
command line which will be used as the name of the generated key. If no
|
||||
command line to be used as the name of the generated key. If no
|
||||
name is specified, the default is \fBtsig\-key\fP\&.
|
||||
.sp
|
||||
When run as \fBddns\-confgen\fP, the generated key is accompanied by
|
||||
configuration text and instructions that can be used with \fBnsupdate\fP
|
||||
When run as \fBddns\-confgen\fP, the key name can specified using \fB\-k\fP
|
||||
parameter and defaults to \fBddns\-key\fP\&. The generated key is accompanied
|
||||
by configuration text and instructions that can be used with \fBnsupdate\fP
|
||||
and \fBnamed\fP when setting up dynamic DNS, including an example
|
||||
\fBupdate\-policy\fP statement. (This usage similar to the \fBrndc\-confgen\fP
|
||||
command for setting up command channel security.)
|
||||
\fBupdate\-policy\fP statement. (This usage is similar to the \fBrndc\-confgen\fP
|
||||
command for setting up command\-channel security.)
|
||||
.sp
|
||||
Note that \fBnamed\fP itself can configure a local DDNS key for use with
|
||||
\fBnsupdate \-l\fP: it does this when a zone is configured with
|
||||
\fBnsupdate \-l\fP; it does this when a zone is configured with
|
||||
\fBupdate\-policy local;\fP\&. \fBddns\-confgen\fP is only needed when a more
|
||||
elaborate configuration is required: for instance, if \fBnsupdate\fP is to
|
||||
be used from a remote system.
|
||||
.SH OPTIONS
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
\fB\-a\fP algorithm
|
||||
Specifies the algorithm to use for the TSIG key. Available choices
|
||||
are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and
|
||||
hmac\-sha512. The default is hmac\-sha256. Options are
|
||||
.B \fB\-a algorithm\fP
|
||||
This option specifies the algorithm to use for the TSIG key. Available
|
||||
choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384,
|
||||
and hmac\-sha512. The default is hmac\-sha256. Options are
|
||||
case\-insensitive, and the "hmac\-" prefix may be omitted.
|
||||
.TP
|
||||
\fB\-h\fP
|
||||
Prints a short summary of options and arguments.
|
||||
.B \fB\-h\fP
|
||||
This option prints a short summary of options and arguments.
|
||||
.TP
|
||||
\fB\-k\fP keyname
|
||||
Specifies the key name of the DDNS authentication key. The default is
|
||||
\fBddns\-key\fP when neither the \fB\-s\fP nor \fB\-z\fP option is specified;
|
||||
otherwise, the default is \fBddns\-key\fP as a separate label followed
|
||||
by the argument of the option, e.g., \fBddns\-key.example.com.\fP The
|
||||
key name must have the format of a valid domain name, consisting of
|
||||
letters, digits, hyphens and periods.
|
||||
.B \fB\-k keyname\fP
|
||||
This option specifies the key name of the DDNS authentication key. The
|
||||
default is \fBddns\-key\fP when neither the \fB\-s\fP nor \fB\-z\fP option is
|
||||
specified; otherwise, the default is \fBddns\-key\fP as a separate label
|
||||
followed by the argument of the option, e.g., \fBddns\-key.example.com.\fP
|
||||
The key name must have the format of a valid domain name, consisting of
|
||||
letters, digits, hyphens, and periods.
|
||||
.TP
|
||||
\fB\-q\fP
|
||||
(\fBddns\-confgen\fP only.) Quiet mode: Print only the key, with no
|
||||
explanatory text or usage examples; This is essentially identical to
|
||||
.B \fB\-q\fP (\fBddns\-confgen\fP only)
|
||||
This option enables quiet mode, which prints only the key, with no
|
||||
explanatory text or usage examples. This is essentially identical to
|
||||
\fBtsig\-keygen\fP\&.
|
||||
.TP
|
||||
\fB\-s\fP name
|
||||
(\fBddns\-confgen\fP only.) Generate configuration example to allow
|
||||
dynamic updates of a single hostname. The example \fBnamed.conf\fP text
|
||||
shows how to set an update policy for the specified name using the
|
||||
"name" nametype. The default key name is ddns\-key.name. Note that the
|
||||
"self" nametype cannot be used, since the name to be updated may
|
||||
differ from the key name. This option cannot be used with the \fB\-z\fP
|
||||
option.
|
||||
.B \fB\-s name\fP (\fBddns\-confgen\fP only)
|
||||
This option generates a configuration example to allow dynamic updates
|
||||
of a single hostname. The example \fBnamed.conf\fP text shows how to set
|
||||
an update policy for the specified name using the "name" nametype. The
|
||||
default key name is \fBddns\-key.name\fP\&. Note that the "self" nametype
|
||||
cannot be used, since the name to be updated may differ from the key
|
||||
name. This option cannot be used with the \fB\-z\fP option.
|
||||
.TP
|
||||
\fB\-z\fP zone
|
||||
(\fBddns\-confgen\fP only.) Generate configuration example to allow
|
||||
dynamic updates of a zone: The example \fBnamed.conf\fP text shows how
|
||||
.B \fB\-z zone\fP (\fBddns\-confgen\fP only)
|
||||
This option generates a configuration example to allow
|
||||
dynamic updates of a zone. The example \fBnamed.conf\fP text shows how
|
||||
to set an update policy for the specified zone using the "zonesub"
|
||||
nametype, allowing updates to all subdomain names within that zone.
|
||||
This option cannot be used with the \fB\-s\fP option.
|
||||
|
Reference in New Issue
Block a user