diff --git a/bin/rndc/Makefile.in b/bin/rndc/Makefile.in index b6dc25241f..bf9713cd3c 100644 --- a/bin/rndc/Makefile.in +++ b/bin/rndc/Makefile.in @@ -13,7 +13,7 @@ # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -# $Id: Makefile.in,v 1.21 2001/03/27 00:44:41 bwelling Exp $ +# $Id: Makefile.in,v 1.22 2001/03/28 01:00:58 halley Exp $ srcdir = @srcdir@ VPATH = @srcdir@ @@ -47,7 +47,11 @@ OBJS = rndc.@O@ SRCS = rndc.c -MANPAGES = rndc.8 rndc.conf.5 +MANPAGES = rndc.8 + +HTMLPAGES = rndc.html + +MANOBJS = ${MANPAGES} ${HTMLPAGES} @BIND9_MAKE_RULES@ @@ -58,6 +62,11 @@ rndc.@O@: rndc.c rndc: ${OBJS} ${DEPLIBS} ${LIBTOOL} ${PURIFY} ${CC} ${CFLAGS} -o $@ ${OBJS} ${LIBS} +doc man:: ${MANOBJS} + +docclean manclean maintainer-clean:: + rm -f ${MANOBJS} + installdirs: $(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${sbindir} $(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8 @@ -68,5 +77,5 @@ install:: rndc installdirs ${INSTALL_DATA} rndc.8 ${DESTDIR}${mandir}/man8 ${INSTALL_DATA} rndc.conf.5 ${DESTDIR}${mandir}/man5 -clean distclean:: +clean distclean maintainer-clean:: rm -f ${TARGETS} diff --git a/bin/rndc/rndc.8 b/bin/rndc/rndc.8 index 520c8f1b4a..f99c1cc320 100644 --- a/bin/rndc/rndc.8 +++ b/bin/rndc/rndc.8 @@ -12,147 +12,96 @@ .\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. - -.\" $Id: rndc.8,v 1.15 2001/02/17 01:25:34 bwelling Exp $ - -.Dd Jun 30, 2000 -.Dt RNDC 8 -.Os BIND9 9 -.ds vT BIND9 Programmer's Manual -.Sh NAME -.Nm rndc -.Nd name server control utility -.Sh SYNOPSIS -.Nm rndc -.Op Fl c Ar config-file -.Op Fl M -.Op Fl m -.Op Fl p Ar port# -.Op Fl s Ar server -.Op Fl v -.Op Fl y Ar key_id -.Ar command .... -.Sh DESCRIPTION -This command allows the system administrator to control the operation -of a name server. -It supersedes the -.Xr ndc 8 -utility that was provided in old BIND releases. -If -.Nm rndc -is invoked with no command line options or arguments, it -prints a short summary of the supported commands and the available -options and their arguments. -.Pp -.Nm rndc -communicates with the name server over a TCP connection, -sending commands authenticated with digital signatures. -In the current versions of -.Nm rndc -and -.Xr named 8 -the only supported encryption algorithm is HMAC-MD5, which uses a -shared secret on each end of the connection. -This provides TSIG-style authentication for the command request -and the name server's response. -All commands sent over the channel -must be signed by a key_id known to the server. -.Pp -.Nm rndc -reads its default configuration file, -.Pa /etc/rndc.conf -to determine how to contact the name server and decide what algorithm -and keys it should use. -The -.Fl c -option can be used to specify an alternate configuration file. -.Pp -.Ar server -is the name or address of the server which matches a -.Dv server -statement in the configuration file for -.Nm rndc . -If no -.Ar server -is supplied on the command line, the host named by the -.Dv default-server -clause in the -.Dv option -statement of the configuration file will be used. -.Pp -The -.Fl p -option can be used to make -.Nm rndc -send commands to TCP port number -.Ar port# -on the system running the name server instead of BIND 9's -default control channel port of 953. -.Pp -The -.Fl y -option identifies the -.Ar key_id -to use from the configuration file. -.Ar key_id -must be known by -.Xr named -with the same algorithm and secret string in order for -control message validation to succeed. -If no -.Fl y -option is provided, -.Nm rndc -will first look for a -.Dv key -clause in the -.Dv server -statement of the server being used, or if no -.Dv server -statement is present for that host, then the -.Dv default-key -clause of the -.Dv options -statement. -Note that the configuration file for -.Nm rndc -contains shared secrets which are used to send authenticated -control commands to name servers. -It should therefore not have general read or write access. -.Pp -The -.Fl M , -.Fl m , -and -.Fl v -options provided debugging information and are primarily of interest -to the BIND 9 developers. -They might be changed or removed in future releases. -.Pp -For the complete set of commands supported by rndc, see the -BIND 9 Administrator Reference Manual or run -.Nm rndc -without arguments to see its help message. -.Pp -.Sh LIMITATIONS -.Nm rndc -does not yet support all the commands of the BIND 8 -.Xr ndc -utility. -.Pp -There is currently no way to provide the shared secret for a key_id -without using the configuration file. -.Pp +.TH "RNDC" "8" "June 30, 2000" "BIND9" "" +.SH NAME +rndc \- name server control utility +.SH SYNOPSIS +.sp +\fBrndc\fR [ \fB-c \fIconfig-file\fB\fR ] [ \fB-s \fIserver\fB\fR ] [ \fB-p \fIport\fB\fR ] [ \fB-v\fR ] [ \fB-y \fIkey_id\fB\fR ] [ \fBcommand\fR\fI...\fR ] +.SH "DESCRIPTION" +.PP +\fBrndc\fR controls the operation of a name +server. It supersedes the \fBndc\fR utility +that was provided in old BIND releases. If +\fBrndc\fR is invoked with no command line +options or arguments, it prints a short summary of the +supported commands and the available options and their +arguments. +.PP +\fBrndc\fR communicates with the name server +over a TCP connection, sending commands authenticated with +digital signatures. In the current versions of +\fBrndc\fR and \fBnamed\fR named +the only supported authentication algorithm is HMAC-MD5, +which uses a shared secret on each end of the connection. +This provides TSIG-style authentication for the command +request and the name server's response. All commands sent +over the channel must be signed by a key_id known to the +server. +.PP +\fBrndc\fR reads a configuration file to +determine how to contact the name server and decide what +algorithm and key it should use. +.SH "OPTIONS" +.TP +\fB-c \fIconfig-file\fB\fR +Use \fIconfig-file\fR +as the configuration file instead of the default, +\fI/etc/rndc.conf\fR. +.TP +\fB-s \fIserver\fB\fR +\fIserver\fR is +the name or address of the server which matches a +server statement in the configuration file for +\fBrndc\fR. If no server is supplied on the +command line, the host named by the default-server clause +in the option statement of the configuration file will be +used. +.TP +\fB-p \fIport\fB\fR +Send commands to TCP port +\fIport\fR instead +of BIND 9's default control channel port, 953. +.TP +\fB-y \fIkeyid\fB\fR +Use the key \fIkeyid\fR +from the configuration file. +\fIkeyid\fR must be +known by named with the same algorithm and secret string +in order for control message validation to succeed. +If no \fIkeyid\fR +is specified, \fBrndc\fR will first look +for a key clause in the server statement of the server +being used, or if no server statement is present for that +host, then the default-key clause of the options statement. +Note that the configuration file contains shared secrets +which are used to send authenticated control commands +to name servers. It should therefore not have general read +or write access. +.TP +\fB-v\fR +Enable verbose logging. +.PP +For the complete set of commands supported by \fBrndc\fR, +see the BIND 9 Administrator Reference Manual or run +\fBrndc\fR without arguments to see its help message. +.PP +.SH "LIMITATIONS" +.PP +\fBrndc\fR does not yet support all the commands of +the BIND 8 \fBndc\fR utility. +.PP +There is currently no way to provide the shared secret for a +\fBkey_id\fR without using the configuration file. +.PP Several error messages could be clearer. -For example, trying to connect -from an address that is not in the list of acceptable addresses -configured into -.Xr named -will result in the error message "end of file" when the server -unceremoniously closes the connection. -.Sh SEE ALSO -.Xr rndc.conf 5 , -.Xr named 8 , -.Xr named.conf 5 , -.Xr RFC2845 , -.Xr ndc 8 . +.SH "SEE ALSO" +.PP +\fBrndc.conf\fR(5), +\fBnamed\fR(8), +\fBnamed.conf\fR(5) +\fBndc\fR(8), +\fIBIND 9 Administrator Reference Manual\fR. +.SH "AUTHOR" +.PP +Internet Software Consortium diff --git a/bin/rndc/rndc.docbook b/bin/rndc/rndc.docbook new file mode 100644 index 0000000000..b1b7e271ef --- /dev/null +++ b/bin/rndc/rndc.docbook @@ -0,0 +1,195 @@ + + + + + June 30, 2000 + + + + rndc + 8 + BIND9 + + + + rndc + name server control utility + + + + + rndc + + + + + + command + + + + + DESCRIPTION + + rndc controls the operation of a name + server. It supersedes the ndc utility + that was provided in old BIND releases. If + rndc is invoked with no command line + options or arguments, it prints a short summary of the + supported commands and the available options and their + arguments. + + + rndc communicates with the name server + over a TCP connection, sending commands authenticated with + digital signatures. In the current versions of + rndc and named named + the only supported authentication algorithm is HMAC-MD5, + which uses a shared secret on each end of the connection. + This provides TSIG-style authentication for the command + request and the name server's response. All commands sent + over the channel must be signed by a key_id known to the + server. + + + rndc reads a configuration file to + determine how to contact the name server and decide what + algorithm and key it should use. + + + + + OPTIONS + + + + -c config-file + + + Use config-file + as the configuration file instead of the default, + /etc/rndc.conf. + + + + + + -s server + + + server is + the name or address of the server which matches a + server statement in the configuration file for + rndc. If no server is supplied on the + command line, the host named by the default-server clause + in the option statement of the configuration file will be + used. + + + + + + -p port + + + Send commands to TCP port + port instead + of BIND 9's default control channel port, 953. + + + + + + -y keyid + + + Use the key keyid + from the configuration file. + keyid must be + known by named with the same algorithm and secret string + in order for control message validation to succeed. + If no keyid + is specified, rndc will first look + for a key clause in the server statement of the server + being used, or if no server statement is present for that + host, then the default-key clause of the options statement. + Note that the configuration file contains shared secrets + which are used to send authenticated control commands + to name servers. It should therefore not have general read + or write access. + + + + + + -v + + + Enable verbose logging. + + + + + + + + For the complete set of commands supported by rndc, + see the BIND 9 Administrator Reference Manual or run + rndc without arguments to see its help message. + + + + + + LIMITATIONS + + rndc does not yet support all the commands of + the BIND 8 ndc utility. + + + There is currently no way to provide the shared secret for a + without using the configuration file. + + + Several error messages could be clearer. + + + + + SEE ALSO + + + rndc.conf + 5 + , + + named + 8 + , + + named.conf + 5 + + + ndc + 8 + , + BIND 9 Administrator Reference Manual. + + + + + AUTHOR + + Internet Software Consortium + + + + + + + diff --git a/bin/rndc/rndc.html b/bin/rndc/rndc.html new file mode 100644 index 0000000000..c0fa9d246f --- /dev/null +++ b/bin/rndc/rndc.html @@ -0,0 +1,380 @@ + +rndc

rndc

Name

rndc -- name server control utility

Synopsis

rndc [-c config-file] [-s server] [-p port] [-v] [-y key_id] [command...]

DESCRIPTION

rndc controls the operation of a name + server. It supersedes the ndc utility + that was provided in old BIND releases. If + rndc is invoked with no command line + options or arguments, it prints a short summary of the + supported commands and the available options and their + arguments. +

rndc communicates with the name server + over a TCP connection, sending commands authenticated with + digital signatures. In the current versions of + rndc and named named + the only supported authentication algorithm is HMAC-MD5, + which uses a shared secret on each end of the connection. + This provides TSIG-style authentication for the command + request and the name server's response. All commands sent + over the channel must be signed by a key_id known to the + server. +

rndc reads a configuration file to + determine how to contact the name server and decide what + algorithm and key it should use. +

OPTIONS

-c config-file

Use config-file + as the configuration file instead of the default, + /etc/rndc.conf. +

-s server

server is + the name or address of the server which matches a + server statement in the configuration file for + rndc. If no server is supplied on the + command line, the host named by the default-server clause + in the option statement of the configuration file will be + used. +

-p port

Send commands to TCP port + port instead + of BIND 9's default control channel port, 953. +

-y keyid

Use the key keyid + from the configuration file. + keyid must be + known by named with the same algorithm and secret string + in order for control message validation to succeed. + If no keyid + is specified, rndc will first look + for a key clause in the server statement of the server + being used, or if no server statement is present for that + host, then the default-key clause of the options statement. + Note that the configuration file contains shared secrets + which are used to send authenticated control commands + to name servers. It should therefore not have general read + or write access. +

-v

Enable verbose logging. +

For the complete set of commands supported by rndc, + see the BIND 9 Administrator Reference Manual or run + rndc without arguments to see its help message. +

LIMITATIONS

rndc does not yet support all the commands of + the BIND 8 ndc utility. +

There is currently no way to provide the shared secret for a + key_id without using the configuration file. +

Several error messages could be clearer. +

SEE ALSO

rndc.conf(5), + named(8), + named.conf(5) + ndc(8), + BIND 9 Administrator Reference Manual. +

AUTHOR

Internet Software Consortium +

\ No newline at end of file