b42681c4e9
Replace the hard-coded paths for various BIND 9 files (configuration, pid, etc.) in the man pages and ARM with compile-time values using the sphinx-build replace system. This is more complicated, because the restructured text specification doesn't allow |substitions| inside ``code-blocks``, so for each specific file we had to create own substition which is sub-optimal, but it is only way how to do this without adding Sphinx extension.
122 lines
4.2 KiB
Plaintext
122 lines
4.2 KiB
Plaintext
.\" 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
|
|
..
|
|
.TH "RNDC-CONFGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
|
|
.SH NAME
|
|
rndc-confgen \- rndc key generation tool
|
|
.SH SYNOPSIS
|
|
.sp
|
|
\fBrndc\-confgen\fP [\fB\-a\fP] [\fB\-A\fP algorithm] [\fB\-b\fP keysize] [\fB\-c\fP keyfile] [\fB\-h\fP] [\fB\-k\fP keyname] [\fB\-p\fP port] [\fB\-s\fP address] [\fB\-t\fP chrootdir] [\fB\-u\fP user]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fBrndc\-confgen\fP generates configuration files for \fBrndc\fP\&. It can be
|
|
used as a convenient alternative to writing the \fBrndc.conf\fP file and
|
|
the corresponding \fBcontrols\fP and \fBkey\fP statements in \fBnamed.conf\fP
|
|
by hand. Alternatively, it can be run with the \fB\-a\fP option to set up a
|
|
\fBrndc.key\fP file and avoid the need for a \fBrndc.conf\fP file and a
|
|
\fBcontrols\fP statement altogether.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \fB\-a\fP
|
|
This option sets automatic \fBrndc\fP configuration, which creates a file
|
|
\fB@sysconfdir@/rndc.key\fP that is read by both \fBrndc\fP and \fBnamed\fP on startup.
|
|
The \fBrndc.key\fP file defines a default command channel and
|
|
authentication key allowing \fBrndc\fP to communicate with \fBnamed\fP on
|
|
the local host with no further configuration.
|
|
.sp
|
|
If a more elaborate configuration than that generated by
|
|
\fBrndc\-confgen \-a\fP is required, for example if rndc is to be used
|
|
remotely, run \fBrndc\-confgen\fP without the \fB\-a\fP option
|
|
and set up \fBrndc.conf\fP and \fBnamed.conf\fP as directed.
|
|
.TP
|
|
.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.
|
|
.TP
|
|
.B \fB\-b keysize\fP
|
|
This option specifies the size of the authentication key in bits. The size must be between
|
|
1 and 512 bits; the default is the hash size.
|
|
.TP
|
|
.B \fB\-c keyfile\fP
|
|
This option is used with the \fB\-a\fP option to specify an alternate location for
|
|
\fBrndc.key\fP\&.
|
|
.TP
|
|
.B \fB\-h\fP
|
|
This option prints a short summary of the options and arguments to
|
|
\fBrndc\-confgen\fP\&.
|
|
.TP
|
|
.B \fB\-k keyname\fP
|
|
This option specifies the key name of the \fBrndc\fP authentication key. This must be a
|
|
valid domain name. The default is \fBrndc\-key\fP\&.
|
|
.TP
|
|
.B \fB\-p port\fP
|
|
This option specifies the command channel port where \fBnamed\fP listens for
|
|
connections from \fBrndc\fP\&. The default is 953.
|
|
.TP
|
|
.B \fB\-q\fP
|
|
This option prevets printing the written path in automatic configuration mode.
|
|
.TP
|
|
.B \fB\-s address\fP
|
|
This option specifies the IP address where \fBnamed\fP listens for command\-channel
|
|
connections from \fBrndc\fP\&. The default is the loopback address
|
|
127.0.0.1.
|
|
.TP
|
|
.B \fB\-t chrootdir\fP
|
|
This option is used with the \fB\-a\fP option to specify a directory where \fBnamed\fP
|
|
runs chrooted. An additional copy of the \fBrndc.key\fP is
|
|
written relative to this directory, so that it is found by the
|
|
chrooted \fBnamed\fP\&.
|
|
.TP
|
|
.B \fB\-u user\fP
|
|
This option is used with the \fB\-a\fP option to set the owner of the generated \fBrndc.key\fP file.
|
|
If \fB\-t\fP is also specified, only the file in the chroot
|
|
area has its owner changed.
|
|
.UNINDENT
|
|
.SH EXAMPLES
|
|
.sp
|
|
To allow \fBrndc\fP to be used with no manual configuration, run:
|
|
.sp
|
|
\fBrndc\-confgen \-a\fP
|
|
.sp
|
|
To print a sample \fBrndc.conf\fP file and the corresponding \fBcontrols\fP and
|
|
\fBkey\fP statements to be manually inserted into \fBnamed.conf\fP, run:
|
|
.sp
|
|
\fBrndc\-confgen\fP
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fBrndc(8)\fP, \fBrndc.conf(5)\fP, \fBnamed(8)\fP, BIND 9 Administrator Reference Manual.
|
|
.SH AUTHOR
|
|
Internet Systems Consortium
|
|
.SH COPYRIGHT
|
|
2022, Internet Systems Consortium
|
|
.\" Generated by docutils manpage writer.
|
|
.
|