upstream/unbound
1
0
Fork 0
mirror of https://github.com/NLnetLabs/unbound.git synced 2025-12-20 23:00:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

manual page warning fix.

Browse source 
git-svn-id: file:///svn/unbound/trunk@608 be551aaa-1e26-0410-a405-d3ace91eadb9
This commit is contained in:
Wouter Wijngaards 2007-09-12 05:59:45 +00:00
parent 26f9ea8942
commit db452ffc16
3 changed files with 8 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/Changelog
View file

@ -1,3 +1,6 @@
12 September 2007: Wouter
- fixup of manual page warnings.
6 September 2007: Wouter 6 September 2007: Wouter
- fixup to find libevent on mac port install. - fixup to find libevent on mac port install.
- fixup size_t vs unsigned portability in validator/sigcrypt. - fixup size_t vs unsigned portability in validator/sigcrypt.

7
doc/unbound.8
View file

@ -17,7 +17,6 @@ unbound
.Op Fl d .Op Fl d
.Op Fl v .Op Fl v
.Op Fl c Ar cfgfile .Op Fl c Ar cfgfile
.Sh DESCRIPTION .Sh DESCRIPTION
.Ic Unbound .Ic Unbound
is an implementation of a DNS resolver, that does caching and is an implementation of a DNS resolver, that does caching and
@ -25,27 +24,21 @@ DNSSEC validation.
.Pp .Pp
The available options are: The available options are:
.Bl -tag -width indent .Bl -tag -width indent
.It Fl h .It Fl h
Show the version and commandline option help. Show the version and commandline option help.
.It Fl c Ar cfgfile .It Fl c Ar cfgfile
Set the config file to read with settings for unbound. The syntax is Set the config file to read with settings for unbound. The syntax is
described in described in
.Xr unbound.conf 5 . .Xr unbound.conf 5 .
.It Fl d .It Fl d
Debug flag, do not fork into the background, but stay attached to the Debug flag, do not fork into the background, but stay attached to the
console. console.
.It Fl v .It Fl v
Increase verbosity. If given multiple times, more information is logged. Increase verbosity. If given multiple times, more information is logged.
This is in addition to the verbosity (if any) from the config file. This is in addition to the verbosity (if any) from the config file.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr unbound.conf 5 . .Xr unbound.conf 5 .
.Sh AUTHORS .Sh AUTHORS
.Ic Unbound .Ic Unbound
developers are mentioned in the CREDITS file in the distribution. developers are mentioned in the CREDITS file in the distribution.

23
doc/unbound.conf.5
View file

@ -20,11 +20,9 @@ is used to configure
.Xr unbound 8 . .Xr unbound 8 .
The file format has attributes and values. Some attributes have attributes inside them. The file format has attributes and values. Some attributes have attributes inside them.
The notation is: attribute: value. The notation is: attribute: value.
.Pp
Comments start with # and last to the end of line. Empty lines are Comments start with # and last to the end of line. Empty lines are
ignored as is whitespace at the beginning of a line. ignored as is whitespace at the beginning of a line.
.El
.Sh EXAMPLE .Sh EXAMPLE
An example config file is shown below. Copy this to /etc/unbound/unbound.conf An example config file is shown below. Copy this to /etc/unbound/unbound.conf
and start the server with: and start the server with:
@ -37,7 +35,6 @@ Most settings are the defaults. Stop the server with:
.fi .fi
Below is a minimal config file. The source distribution contains an extensive Below is a minimal config file. The source distribution contains an extensive
example.conf file with all the options. example.conf file with all the options.
.nf .nf
# unbound.conf(5) config file for unbound(8). # unbound.conf(5) config file for unbound(8).
server: server:
@ -48,19 +45,15 @@ server:
pidfile: "/etc/unbound/unbound.pid" pidfile: "/etc/unbound/unbound.pid"
# verbosity: 1 # uncomment and increase to get more logging. # verbosity: 1 # uncomment and increase to get more logging.
.fi .fi
.El
.Sh FILE FORMAT .Sh FILE FORMAT
There must be whitespace between keywords. Attribute keywords end with a colon ':'. An attribute There must be whitespace between keywords. Attribute keywords end with a colon ':'. An attribute
is followed by its containing attributes, or a value. is followed by its containing attributes, or a value.
.Pp .Pp
Files can be included using the Files can be included using the
.Ic include: .Ic include:
directive. It can appear anywhere, and takes a single filename as an argument. directive. It can appear anywhere, and takes a single filename as an argument.
Processing continues as if the text from the included file was copied into Processing continues as if the text from the included file was copied into
the config file at that point. the config file at that point.
.Ss Server Options .Ss Server Options
There may only be one There may only be one
.Ic server: .Ic server:
@ -140,7 +133,7 @@ If given a chroot is done to the given directory. The default is none ("").
.It \fBusername:\fR <name> .It \fBusername:\fR <name>
If given, after binding the port the user privileges are dropped. Default is If given, after binding the port the user privileges are dropped. Default is
not to change user, username: "". not to change user, username: "".
.Pp
If this user is not capable of binding the If this user is not capable of binding the
port, reloads (by signal HUP) will still retain the opened ports. port, reloads (by signal HUP) will still retain the opened ports.
If you change the port number in the config file, and that new port number If you change the port number in the config file, and that new port number
@ -169,13 +162,13 @@ version is returned.
Set the target fetch policy used by unbound to determine if it should fetch Set the target fetch policy used by unbound to determine if it should fetch
nameserver target addresses opportunistically. The policy is described per nameserver target addresses opportunistically. The policy is described per
dependency depth. dependency depth.
.Pp
The number of values determines the maximum dependency depth The number of values determines the maximum dependency depth
that unbound will pursue in answering a query. that unbound will pursue in answering a query.
A value of -1 means to fetch all targets opportunistically for that dependency A value of -1 means to fetch all targets opportunistically for that dependency
depth. A value of 0 means to fetch on demand only. A positive value fetches depth. A value of 0 means to fetch on demand only. A positive value fetches
that many targets opportunistically. that many targets opportunistically.
.Pp
Enclose the list between quotes ("") and put spaces between numbers. Enclose the list between quotes ("") and put spaces between numbers.
The default is "3 2 1 0 0". Setting all zeroes, "0 0 0 0 0" gives behaviour The default is "3 2 1 0 0". Setting all zeroes, "0 0 0 0 0" gives behaviour
closer to that of BIND 9, while setting "-1 -1 -1 -1 -1" gives behaviour closer to that of BIND 9, while setting "-1 -1 -1 -1 -1" gives behaviour
@ -246,7 +239,6 @@ Number of slabs in the key cache. Slabs reduce lock contention by threads.
Must be set to a power of 2. Setting (close) to the number of cpus is a Must be set to a power of 2. Setting (close) to the number of cpus is a
reasonable guess. reasonable guess.
.El .El
.Ss Stub Zone Options .Ss Stub Zone Options
There may be multiple There may be multiple
.Ic stub-zone: .Ic stub-zone:
@ -261,7 +253,6 @@ Name of stub zone nameserver. Is itself resolved before it is used.
IP address of stub zone nameserver. Can be IP 4 or IP 6. IP address of stub zone nameserver. Can be IP 4 or IP 6.
To use a nondefault port for DNS communication append '@' with the port number. To use a nondefault port for DNS communication append '@' with the port number.
.El .El
.Ss Forward Zone Options .Ss Forward Zone Options
There may be multiple There may be multiple
.Ic forward-zone: .Ic forward-zone:
@ -279,7 +270,6 @@ Name of server to forward to. Is itself resolved before it is used.
IP address of server to forward to. Can be IP 4 or IP 6. IP address of server to forward to. Can be IP 4 or IP 6.
To use a nondefault port for DNS communication append '@' with the port number. To use a nondefault port for DNS communication append '@' with the port number.
.El .El
.Sh MEMORY CONTROL EXAMPLE .Sh MEMORY CONTROL EXAMPLE
In the example config settings below memory usage is reduced. Some service In the example config settings below memory usage is reduced. Some service
levels are lower, notable very large data and a high TCP load are no longer levels are lower, notable very large data and a high TCP load are no longer
@ -287,8 +277,8 @@ supported. Very large data and high TCP loads are exceptional for the DNS.
DNSSEC validation is enabled, just add trust anchors. DNSSEC validation is enabled, just add trust anchors.
If you do not have to worry about programs using more than 1 meg of memory, If you do not have to worry about programs using more than 1 meg of memory,
the below example is not for you. Use the defaults to receive full service. the below example is not for you. Use the defaults to receive full service.
.Pp
.nf .nf
# example settings that reduce memory usage # example settings that reduce memory usage
server: server:
num-threads: 1 num-threads: 1
@ -310,9 +300,6 @@ server:
harden-short-bufsize: "yes" harden-short-bufsize: "yes"
do-ip6: no # save a bit of memory if not used. do-ip6: no # save a bit of memory if not used.
.fi .fi
.El
.Sh FILES .Sh FILES
.Bl -tag -width indent .Bl -tag -width indent
.It Pa /etc/unbound .It Pa /etc/unbound