Files
bind9/doc/man/named.8in
2020-06-01 09:54:46 +02:00

261 lines
8.9 KiB
Plaintext

.\" Man page generated from reStructuredText.
.
.TH "NAMED" "8" "@RELEASE_DATE@" "@BIND9_VERSION@" "BIND 9"
.SH NAME
named \- Internet domain name server
.
.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
..
.SH SYNOPSIS
.sp
\fBnamed\fP [ [\fB\-4\fP] | [\fB\-6\fP] ] [\fB\-c\fP config\-file] [\fB\-d\fP debug\-level] [\fB\-D\fP string] [\fB\-E\fP engine\-name] [\fB\-f\fP] [\fB\-g\fP] [\fB\-L\fP logfile] [\fB\-M\fP option] [\fB\-m\fP flag] [\fB\-n\fP #cpus] [\fB\-p\fP port] [\fB\-s\fP] [\fB\-S\fP #max\-socks] [\fB\-t\fP directory] [\fB\-U\fP #listeners] [\fB\-u\fP user] [\fB\-v\fP] [\fB\-V\fP] [\fB\-X\fP lock\-file] [\fB\-x\fP cache\-file]
.SH DESCRIPTION
.sp
\fBnamed\fP is a Domain Name System (DNS) server, part of the BIND 9
distribution from ISC. For more information on the DNS, see \fI\%RFC 1033\fP,
\fI\%RFC 1034\fP, and \fI\%RFC 1035\fP\&.
.sp
When invoked without arguments, \fBnamed\fP will read the default
configuration file \fB/etc/named.conf\fP, read any initial data, and
listen for queries.
.SH OPTIONS
.INDENT 0.0
.TP
\fB\-4\fP
Use IPv4 only even if the host machine is capable of IPv6. \fB\-4\fP and
\fB\-6\fP are mutually exclusive.
.TP
\fB\-6\fP
Use IPv6 only even if the host machine is capable of IPv4. \fB\-4\fP and
\fB\-6\fP are mutually exclusive.
.TP
\fB\-c\fP config\-file
Use config\-file as the configuration file instead of the default,
\fB/etc/named.conf\fP\&. To ensure that reloading the configuration file
continues to work after the server has changed its working directory
due to to a possible \fBdirectory\fP option in the configuration file,
config\-file should be an absolute pathname.
.TP
\fB\-d\fP debug\-level
Set the daemon\(aqs debug level to debug\-level. Debugging traces from
\fBnamed\fP become more verbose as the debug level increases.
.TP
\fB\-D\fP string
Specifies a string that is used to identify a instance of \fBnamed\fP
in a process listing. The contents of string are not examined.
.TP
\fB\-E\fP engine\-name
When applicable, specifies the hardware to use for cryptographic
operations, such as a secure key store used for signing.
.sp
When BIND is built with OpenSSL PKCS#11 support, this defaults to the
string "pkcs11", which identifies an OpenSSL engine that can drive a
cryptographic accelerator or hardware service module. When BIND is
built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it
defaults to the path of the PKCS#11 provider library specified via
"\-\-with\-pkcs11".
.TP
\fB\-f\fP
Run the server in the foreground (i.e. do not daemonize).
.TP
\fB\-g\fP
Run the server in the foreground and force all logging to \fBstderr\fP\&.
.TP
\fB\-L\fP logfile
Log to the file \fBlogfile\fP by default instead of the system log.
.TP
\fB\-M\fP option
Sets the default memory context options. If set to external, this
causes the internal memory manager to be bypassed in favor of
system\-provided memory allocation functions. If set to fill, blocks
of memory will be filled with tag values when allocated or freed, to
assist debugging of memory problems. (nofill disables this behavior,
and is the default unless \fBnamed\fP has been compiled with developer
options.)
.TP
\fB\-m\fP flag
Turn on memory usage debugging flags. Possible flags are usage,
trace, record, size, and mctx. These correspond to the
ISC_MEM_DEBUGXXXX flags described in \fB<isc/mem.h>\fP\&.
.TP
\fB\-n\fP #cpus
Create #cpus worker threads to take advantage of multiple CPUs. If
not specified, \fBnamed\fP 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\fP port
Listen for queries on port port. If not specified, the default is
port 53.
.TP
\fB\-s\fP
Write memory usage statistics to \fBstdout\fP on exit.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This option is mainly of interest to BIND 9 developers and may be
removed or changed in a future release.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
\fB\-S\fP #max\-socks
Allow \fBnamed\fP to use up to #max\-socks sockets. The default value is
21000 on systems built with default configuration options, and 4096
on systems built with "configure \-\-with\-tuning=small".
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This option should be unnecessary for the vast majority of users.
The use of this option could even be harmful because the specified
value may exceed the limitation of the underlying system API. It
is therefore set only when the default configuration causes
exhaustion of file descriptors and the operational environment is
known to support the specified number of sockets. Note also that
the actual maximum number is normally a little fewer than the
specified value because \fBnamed\fP reserves some file descriptors
for its internal use.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
\fB\-t\fP directory
Chroot to directory after processing the command line arguments, but
before reading the configuration file.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
This option should be used in conjunction with the \fB\-u\fP option,
as chrooting a process running as root doesn\(aqt enhance security on
most systems; the way \fBchroot(2)\fP is defined allows a process
with root privileges to escape a chroot jail.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
\fB\-U\fP #listeners
Use #listeners worker threads to listen for incoming UDP packets on
each address. If not specified, \fBnamed\fP will calculate a default
value based on the number of detected CPUs: 1 for 1 CPU, and the
number of detected CPUs minus one for machines with more than 1 CPU.
This cannot be increased to a value higher than the number of CPUs.
If \fB\-n\fP has been set to a higher value than the number of detected
CPUs, then \fB\-U\fP may be increased as high as that value, but no
higher. On Windows, the number of UDP listeners is hardwired to 1 and
this option has no effect.
.TP
\fB\-u\fP user
Setuid to user after completing privileged operations, such as
creating sockets that listen on privileged ports.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
On Linux, \fBnamed\fP uses the kernel\(aqs capability mechanism to drop
all root privileges except the ability to \fBbind(2)\fP to a
privileged port and set process resource limits. Unfortunately,
this means that the \fB\-u\fP option only works when \fBnamed\fP 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)\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
\fB\-v\fP
Report the version number and exit.
.TP
\fB\-V\fP
Report the version number and build options, and exit.
.TP
\fB\-X\fP lock\-file
Acquire a lock on the specified file at runtime; this helps to
prevent duplicate \fBnamed\fP instances from running simultaneously.
Use of this option overrides the \fBlock\-file\fP option in
\fBnamed.conf\fP\&. If set to \fBnone\fP, the lock file check is disabled.
.TP
\fB\-x\fP cache\-file
Load data from cache\-file into the cache of the default view.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
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.
.UNINDENT
.UNINDENT
.SH SIGNALS
.sp
In routine operation, signals should not be used to control the
nameserver; \fBrndc\fP should be used instead.
.INDENT 0.0
.TP
.B SIGHUP
Force a reload of the server.
.TP
.B SIGINT, SIGTERM
Shut down the server.
.UNINDENT
.sp
The result of sending any other signals to the server is undefined.
.SH CONFIGURATION
.sp
The \fBnamed\fP configuration file is too complex to describe in detail
here. A complete description is provided in the BIND 9 Administrator
Reference Manual.
.sp
\fBnamed\fP inherits the \fBumask\fP (file creation mode mask) from the
parent process. If files created by \fBnamed\fP, such as journal files,
need to have custom permissions, the \fBumask\fP should be set explicitly
in the script used to start the \fBnamed\fP process.
.SH FILES
.INDENT 0.0
.TP
.B \fB/etc/named.conf\fP
The default configuration file.
.TP
.B \fB/var/run/named/named.pid\fP
The default process\-id file.
.UNINDENT
.SH SEE ALSO
.sp
\fI\%RFC 1033\fP, \fI\%RFC 1034\fP, \fI\%RFC 1035\fP, \fBnamed\-checkconf(8)\fP, \fBnamed\-checkzone(8)\fP, \fBrndc(8), :manpage:\(ganamed.conf(5)\fP, BIND 9 Administrator Reference Manual.
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
2020, Internet Systems Consortium
.\" Generated by docutils manpage writer.
.