diff options
Diffstat (limited to 'usr.sbin/bind/bin/named/named.8')
| -rw-r--r-- | usr.sbin/bind/bin/named/named.8 | 330 |
1 files changed, 192 insertions, 138 deletions
diff --git a/usr.sbin/bind/bin/named/named.8 b/usr.sbin/bind/bin/named/named.8 index cb54937993a..d0020600e40 100644 --- a/usr.sbin/bind/bin/named/named.8 +++ b/usr.sbin/bind/bin/named/named.8 @@ -1,182 +1,236 @@ -.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") -.\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium. -.\" +.\" Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (C) 2000, 2001, 2003 Internet Software Consortium. +.\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY -.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING 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. .\" -.\" $ISC: named.8,v 1.17.208.3 2004/06/03 05:35:47 marka Exp $ +.\" $ISC: named.8,v 1.20.18.15 2007/06/20 02:26:58 marka Exp $ +.\" +.hy 0 +.ad l +.\" Title: named +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> +.\" Date: June 30, 2000 +.\" Manual: BIND9 +.\" Source: BIND9 .\" -.TH "NAMED" "8" "June 30, 2000" "BIND9" "" -.SH NAME +.TH "NAMED" "8" "June 30, 2000" "BIND9" "BIND9" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" named \- Internet domain name server -.SH SYNOPSIS -.sp -\fBnamed\fR [ \fB-4\fR ] [ \fB-6\fR ] [ \fB-c \fIconfig-file\fB\fR ] [ \fB-d \fIdebug-level\fB\fR ] [ \fB-f\fR ] [ \fB-g\fR ] [ \fB-i \fIpid_file\fB\fR ] [ \fB-n \fI#cpus\fB\fR ] [ \fB-p \fIport\fB\fR ] [ \fB-s\fR ] [ \fB-t \fIdirectory\fB\fR ] [ \fB-u \fIuser\fB\fR ] [ \fB-v\fR ] [ \fB-x \fIcache-file\fB\fR ] +.SH "SYNOPSIS" +.HP 6 +\fBnamed\fR [\fB\-4\fR] [\fB\-6\fR] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-x\ \fR\fB\fIcache\-file\fR\fR] .SH "DESCRIPTION" .PP -\fBnamed\fR is a Domain Name System (DNS) server, -part of the BIND 9 distribution from ISC. For more -information on the DNS, see RFCs 1033, 1034, and 1035. -.PP -When invoked without arguments, \fBnamed\fR will -fork into two processes for privilege separation. -\fBchroot()\fR to \fI/var/named\fR, -read the default configuration file -\fI/var/named/etc/named.conf\fR, read any initial -data, and listen for queries. The privileged process -will communicate with the child and bind to privileged -ports on its behalf. See CAVEATS section below. +\fBnamed\fR +is a Domain Name System (DNS) server, part of the BIND 9 distribution from ISC. For more information on the DNS, see RFCs 1033, 1034, and 1035. +.PP +When invoked without arguments, +\fBnamed\fR +will read the default configuration file +\fI/etc/named.conf\fR, read any initial data, and listen for queries. .SH "OPTIONS" -.TP -\fB-4\fR +.PP +\-4 +.RS 4 Use IPv4 only even if the host machine is capable of IPv6. -\fB-4\fR and \fB-6\fR are mutually -exclusive. -.TP -\fB-6\fR +\fB\-4\fR +and +\fB\-6\fR +are mutually exclusive. +.RE +.PP +\-6 +.RS 4 Use IPv6 only even if the host machine is capable of IPv4. -\fB-4\fR and \fB-6\fR are mutually -exclusive. -.TP -\fB-c \fIconfig-file\fB\fR -Use \fIconfig-file\fR as the -configuration file instead of the default, -\fI/var/named/etc/named.conf\fR. To -ensure that reloading the configuration file continues -to work after the server has changed its working -directory due to a possible -\fBdirectory\fR option in the configuration -file, \fIconfig-file\fR should be -an absolute pathname. -.TP -\fB-d \fIdebug-level\fB\fR -Set the daemon's debug level to \fIdebug-level\fR. -Debugging traces from \fBnamed\fR become -more verbose as the debug level increases. -.TP -\fB-f\fR +\fB\-4\fR +and +\fB\-6\fR +are mutually exclusive. +.RE +.PP +\-c \fIconfig\-file\fR +.RS 4 +Use +\fIconfig\-file\fR +as the configuration file instead of the default, +\fI/etc/named.conf\fR. To ensure that reloading the configuration file continues to work after the server has changed its working directory due to to a possible +\fBdirectory\fR +option in the configuration file, +\fIconfig\-file\fR +should be an absolute pathname. +.RE +.PP +\-d \fIdebug\-level\fR +.RS 4 +Set the daemon's debug level to +\fIdebug\-level\fR. Debugging traces from +\fBnamed\fR +become more verbose as the debug level increases. +.RE +.PP +\-f +.RS 4 Run the server in the foreground (i.e. do not daemonize). -.TP -\fB-g\fR -Run the server in the foreground and force all logging -to \fIstderr\fR. -.TP -\fB-i \fIpid_file\fB\fR -Specifies the file that contains the process ID of \fBnamed\fR. -The default is \fI/var/run/named.pid\fR. -.TP -\fB-n \fI#cpus\fB\fR -Create \fI#cpus\fR worker threads -to take advantage of multiple CPUs. If not specified, -\fBnamed\fR will try to determine the -number of CPUs present and create one thread per CPU. -If it is unable to determine the number of CPUs, a -single worker thread will be created. -.TP -\fB-p \fIport\fB\fR -Listen for queries on port \fIport\fR. If not -specified, the default is port 53. -.TP -\fB-s\fR -Write memory usage statistics to \fIstdout\fR on exit. -.sp +.RE +.PP +\-g +.RS 4 +Run the server in the foreground and force all logging to +\fIstderr\fR. +.RE +.PP +\-m \fIflag\fR +.RS 4 +Turn on memory usage debugging flags. Possible flags are +\fIusage\fR, +\fItrace\fR, +\fIrecord\fR, +\fIsize\fR, and +\fImctx\fR. These correspond to the ISC_MEM_DEBUGXXXX flags described in +\fI<isc/mem.h>\fR. +.RE +.PP +\-n \fI#cpus\fR +.RS 4 +Create +\fI#cpus\fR +worker threads to take advantage of multiple CPUs. If not specified, +\fBnamed\fR +will try to determine the number of CPUs present and create one thread per CPU. If it is unable to determine the number of CPUs, a single worker thread will be created. +.RE +.PP +\-p \fIport\fR +.RS 4 +Listen for queries on port +\fIport\fR. If not specified, the default is port 53. +.RE +.PP +\-s +.RS 4 +Write memory usage statistics to +\fIstdout\fR +on exit. .RS .B "Note:" -This option is mainly of interest to BIND 9 developers -and may be removed or changed in a future release. -.RE -.sp -.TP -\fB-t \fIdirectory\fB\fR -\fBchroot()\fR to \fIdirectory\fR after -processing the command line arguments, but before -reading the configuration file. -By default, \fBnamed\fR \fBchroot()\fR's to \fI/var/named\fR. -.sp +This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release. +.RE +.RE +.PP +\-t \fIdirectory\fR +.RS 4 +Chroot to +\fIdirectory\fR +after processing the command line arguments, but before reading the configuration file. .RS .B "Warning:" This option should be used in conjunction with the -\fB-u\fR option, as chrooting a process -running as root doesn't enhance security on most -systems; the way \fBchroot()\fR is -defined allows a process with root privileges to -escape a chroot jail. -.RE -.sp -.TP -\fB-u \fIuser\fB\fR -\fBsetuid()\fR to \fIuser\fR after completing -privileged operations, such as creating sockets that -listen on privileged ports. -By default, \fBnamed\fR will run as user \fInamed\fR. -.sp -.TP -\fB-v\fR +\fB\-u\fR +option, as chrooting a process running as root doesn't enhance security on most systems; the way +\fBchroot(2)\fR +is defined allows a process with root privileges to escape a chroot jail. +.RE +.RE +.PP +\-u \fIuser\fR +.RS 4 +Setuid to +\fIuser\fR +after completing privileged operations, such as creating sockets that listen on privileged ports. +.RS +.B "Note:" +On Linux, +\fBnamed\fR +uses the kernel's capability mechanism to drop all root privileges except the ability to +\fBbind(2)\fR +to a privileged port and set process resource limits. Unfortunately, this means that the +\fB\-u\fR +option only works when +\fBnamed\fR +is run on kernel 2.2.18 or later, or kernel 2.3.99\-pre3 or later, since previous kernels did not allow privileges to be retained after +\fBsetuid(2)\fR. +.RE +.RE +.PP +\-v +.RS 4 Report the version number and exit. -.TP -\fB-x \fIcache-file\fB\fR -Load data from \fIcache-file\fR into the -cache of the default view. -.sp +.RE +.PP +\-x \fIcache\-file\fR +.RS 4 +Load data from +\fIcache\-file\fR +into the cache of the default view. .RS .B "Warning:" -This option must not be used. It is only of interest -to BIND 9 developers and may be removed or changed in a -future release. +This option must not be used. It is only of interest to BIND 9 developers and may be removed or changed in a future release. +.RE .RE -.sp .SH "SIGNALS" .PP -In routine operation, signals should not be used to control -the nameserver; \fBrndc\fR should be used -instead. -.TP -\fBSIGHUP\fR +In routine operation, signals should not be used to control the nameserver; +\fBrndc\fR +should be used instead. +.PP +SIGHUP +.RS 4 Force a reload of the server. -.TP -\fBSIGINT, SIGTERM\fR +.RE +.PP +SIGINT, SIGTERM +.RS 4 Shut down the server. +.RE .PP The result of sending any other signals to the server is undefined. -.PP .SH "CONFIGURATION" .PP -The \fBnamed\fR configuration file is too complex -to describe in detail here. A complete description is -provided in the \fIBIND 9 Administrator Reference -Manual\fR. +The +\fBnamed\fR +configuration file is too complex to describe in detail here. A complete description is provided in the +BIND 9 Administrator Reference Manual. .SH "FILES" -.TP -\fB\fI/var/named/etc/named.conf\fB\fR +.PP +\fI/etc/named.conf\fR +.RS 4 The default configuration file. -.TP -\fB\fI/var/run/named.pid\fB\fR -The default process-id file. +.RE +.PP +\fI/var/run/named.pid\fR +.RS 4 +The default process\-id file. +.RE .SH "SEE ALSO" .PP -\fIRFC 1033\fR, -\fIRFC 1034\fR, -\fIRFC 1035\fR, +RFC 1033, +RFC 1034, +RFC 1035, +\fBnamed\-checkconf\fR(8), +\fBnamed\-checkzone\fR(8), \fBrndc\fR(8), \fBlwresd\fR(8), -\fIBIND 9 Administrator Reference Manual\fR. +\fBnamed.conf\fR(5), +BIND 9 Administrator Reference Manual. .SH "AUTHOR" .PP Internet Systems Consortium -.SH "CAVEATS" -\fBnamed\fR runs privilege separated for binding -the privileged ports after an interface or address -change. The privileged process will only allow -\fBnamed\fR to bind to default ports. Make sure -you use unprivileged (>1024) ports if you change -any of the default ports in \fBnamed's\fR -configuration or on the command-line. +.SH "COPYRIGHT" +Copyright \(co 2004\-2007 Internet Systems Consortium, Inc. ("ISC") +.br +Copyright \(co 2000, 2001, 2003 Internet Software Consortium. +.br |