summaryrefslogtreecommitdiff
path: root/bin/confgen/rndc-confgen.8
diff options
context:
space:
mode:
Diffstat (limited to 'bin/confgen/rndc-confgen.8')
-rw-r--r--bin/confgen/rndc-confgen.8122
1 files changed, 69 insertions, 53 deletions
diff --git a/bin/confgen/rndc-confgen.8 b/bin/confgen/rndc-confgen.8
index 1276344e372ec..85d31510049ef 100644
--- a/bin/confgen/rndc-confgen.8
+++ b/bin/confgen/rndc-confgen.8
@@ -1,4 +1,4 @@
-.\" Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
+.\" Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.\" Copyright (C) 2001, 2003 Internet Software Consortium.
.\"
.\" Permission to use, copy, modify, and/or distribute this software for any
@@ -13,58 +13,73 @@
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $Id$
-.\"
.hy 0
.ad l
-.\" Title: rndc\-confgen
+'\" t
+.\" Title: rndc-confgen
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
-.\" Date: June 15, 2009
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\" Date: 2009-06-15
.\" Manual: BIND9
-.\" Source: BIND9
+.\" Source: ISC
+.\" Language: English
.\"
-.TH "RNDC\-CONFGEN" "8" "June 15, 2009" "BIND9" "BIND9"
+.TH "RNDC\-CONFGEN" "8" "2009\-06\-15" "ISC" "BIND9"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
.SH "NAME"
-rndc\-confgen \- rndc key generation tool
+rndc-confgen \- rndc key generation tool
.SH "SYNOPSIS"
-.HP 13
+.HP \w'\fBrndc\-confgen\fR\ 'u
\fBrndc\-confgen\fR [\fB\-a\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-c\ \fR\fB\fIkeyfile\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\fB\-s\ \fR\fB\fIaddress\fR\fR] [\fB\-t\ \fR\fB\fIchrootdir\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR]
.SH "DESCRIPTION"
.PP
\fBrndc\-confgen\fR
generates configuration files for
-\fBrndc\fR. It can be used as a convenient alternative to writing the
-\fIrndc.conf\fR
+\fBrndc\fR\&. It can be used as a convenient alternative to writing the
+rndc\&.conf
file and the corresponding
\fBcontrols\fR
and
\fBkey\fR
statements in
-\fInamed.conf\fR
-by hand. Alternatively, it can be run with the
+named\&.conf
+by hand\&. Alternatively, it can be run with the
\fB\-a\fR
option to set up a
-\fIrndc.key\fR
+rndc\&.key
file and avoid the need for a
-\fIrndc.conf\fR
+rndc\&.conf
file and a
\fBcontrols\fR
-statement altogether.
+statement altogether\&.
.SH "OPTIONS"
.PP
\-a
.RS 4
Do automatic
\fBrndc\fR
-configuration. This creates a file
-\fIrndc.key\fR
+configuration\&. This creates a file
+rndc\&.key
in
-\fI/etc\fR
+/etc
(or whatever
\fIsysconfdir\fR
was specified as when
@@ -73,13 +88,13 @@ was built) that is read by both
\fBrndc\fR
and
\fBnamed\fR
-on startup. The
-\fIrndc.key\fR
+on startup\&. The
+rndc\&.key
file defines a default command channel and authentication key allowing
\fBrndc\fR
to communicate with
\fBnamed\fR
-on the local host with no further configuration.
+on the local host with no further configuration\&.
.sp
Running
\fBrndc\-confgen \-a\fR
@@ -87,8 +102,8 @@ allows BIND 9 and
\fBrndc\fR
to be used as drop\-in replacements for BIND 8 and
\fBndc\fR, with no changes to the existing BIND 8
-\fInamed.conf\fR
-file.
+named\&.conf
+file\&.
.sp
If a more elaborate configuration than that generated by
\fBrndc\-confgen \-a\fR
@@ -97,15 +112,15 @@ is required, for example if rndc is to be used remotely, you should run
without the
\fB\-a\fR
option and set up a
-\fIrndc.conf\fR
+rndc\&.conf
and
-\fInamed.conf\fR
-as directed.
+named\&.conf
+as directed\&.
.RE
.PP
\-b \fIkeysize\fR
.RS 4
-Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is 128.
+Specifies the size of the authentication key in bits\&. Must be between 1 and 512 bits; the default is 128\&.
.RE
.PP
\-c \fIkeyfile\fR
@@ -113,19 +128,19 @@ Specifies the size of the authentication key in bits. Must be between 1 and 512
Used with the
\fB\-a\fR
option to specify an alternate location for
-\fIrndc.key\fR.
+rndc\&.key\&.
.RE
.PP
\-h
.RS 4
Prints a short summary of the options and arguments to
-\fBrndc\-confgen\fR.
+\fBrndc\-confgen\fR\&.
.RE
.PP
\-k \fIkeyname\fR
.RS 4
-Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is
-\fBrndc\-key\fR.
+Specifies the key name of the rndc authentication key\&. This must be a valid domain name\&. The default is
+\fBrndc\-key\fR\&.
.RE
.PP
\-p \fIport\fR
@@ -133,18 +148,18 @@ Specifies the key name of the rndc authentication key. This must be a valid doma
Specifies the command channel port where
\fBnamed\fR
listens for connections from
-\fBrndc\fR. The default is 953.
+\fBrndc\fR\&. The default is 953\&.
.RE
.PP
\-r \fIrandomfile\fR
.RS 4
-Specifies a source of random data for generating the authorization. If the operating system does not provide a
-\fI/dev/random\fR
-or equivalent device, the default source of randomness is keyboard input.
-\fIrandomdev\fR
-specifies the name of a character device or file containing random data to be used instead of the default. The special value
-\fIkeyboard\fR
-indicates that keyboard input should be used.
+Specifies a source of random data for generating the authorization\&. If the operating system does not provide a
+/dev/random
+or equivalent device, the default source of randomness is keyboard input\&.
+randomdev
+specifies the name of a character device or file containing random data to be used instead of the default\&. The special value
+keyboard
+indicates that keyboard input should be used\&.
.RE
.PP
\-s \fIaddress\fR
@@ -152,7 +167,7 @@ indicates that keyboard input should be used.
Specifies the IP address where
\fBnamed\fR
listens for command channel connections from
-\fBrndc\fR. The default is the loopback address 127.0.0.1.
+\fBrndc\fR\&. The default is the loopback address 127\&.0\&.0\&.1\&.
.RE
.PP
\-t \fIchrootdir\fR
@@ -161,10 +176,10 @@ Used with the
\fB\-a\fR
option to specify a directory where
\fBnamed\fR
-will run chrooted. An additional copy of the
-\fIrndc.key\fR
+will run chrooted\&. An additional copy of the
+rndc\&.key
will be written relative to this directory so that it will be found by the chrooted
-\fBnamed\fR.
+\fBnamed\fR\&.
.RE
.PP
\-u \fIuser\fR
@@ -172,10 +187,10 @@ will be written relative to this directory so that it will be found by the chroo
Used with the
\fB\-a\fR
option to set the owner of the
-\fIrndc.key\fR
-file generated. If
+rndc\&.key
+file generated\&. If
\fB\-t\fR
-is also specified only the file in the chroot area has its owner changed.
+is also specified only the file in the chroot area has its owner changed\&.
.RE
.SH "EXAMPLES"
.PP
@@ -186,13 +201,13 @@ to be used with no manual configuration, run
\fBrndc\-confgen \-a\fR
.PP
To print a sample
-\fIrndc.conf\fR
+rndc\&.conf
file and corresponding
\fBcontrols\fR
and
\fBkey\fR
statements to be manually inserted into
-\fInamed.conf\fR, run
+named\&.conf, run
.PP
\fBrndc\-confgen\fR
.SH "SEE ALSO"
@@ -200,12 +215,13 @@ statements to be manually inserted into
\fBrndc\fR(8),
\fBrndc.conf\fR(5),
\fBnamed\fR(8),
-BIND 9 Administrator Reference Manual.
+BIND 9 Administrator Reference Manual\&.
.SH "AUTHOR"
.PP
-Internet Systems Consortium
+\fBInternet Systems Consortium, Inc\&.\fR
.SH "COPYRIGHT"
-Copyright \(co 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
+.br
+Copyright \(co 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2001, 2003 Internet Software Consortium.
.br