diff options
Diffstat (limited to 'contrib/unbound/doc/unbound.rst')
-rw-r--r-- | contrib/unbound/doc/unbound.rst | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/contrib/unbound/doc/unbound.rst b/contrib/unbound/doc/unbound.rst new file mode 100644 index 000000000000..eb36aa0cad3b --- /dev/null +++ b/contrib/unbound/doc/unbound.rst @@ -0,0 +1,119 @@ +.. + WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE + +.. + IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE + +.. + IT HELPS PEOPLE DIFFING THE CHANGES + +.. + WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE + +.. + IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE + +.. + IT HELPS PEOPLE DIFFING THE CHANGES + +.. + WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE + +.. + IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE + +.. + IT HELPS PEOPLE DIFFING THE CHANGES + +.. + WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE + +.. + IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE + +.. + IT HELPS PEOPLE DIFFING THE CHANGES + +.. program:: unbound + +unbound(8) +========== + +Synopsis +-------- + +**unbound** [``-hdpv``] [``-c <cfgfile>``] + +Description +----------- + +``unbound`` is a caching DNS resolver. + +It uses a built in list of authoritative nameservers for the root zone (``.``), +the so called root hints. +On receiving a DNS query it will ask the root nameservers for an answer and +will in almost all cases receive a delegation to a top level domain (TLD) +authoritative nameserver. +It will then ask that nameserver for an answer. +It will recursively continue until an answer is found or no answer is available +(NXDOMAIN). +For performance and efficiency reasons that answer is cached for a certain time +(the answer's time-to-live or TTL). +A second query for the same name will then be answered from the cache. +Unbound can also do DNSSEC validation. + +To use a locally running Unbound for resolving put: + +.. code-block:: text + + nameserver 127.0.0.1 + +into *resolv.conf(5)*. + +If authoritative DNS is needed as well using :external+nsd:doc:`manpages/nsd`, +careful setup is required because authoritative nameservers and resolvers are +using the same port number (53). + +The available options are: + +.. option:: -h + + Show the version number and commandline option help, and exit. + +.. option:: -c <cfgfile> + + Set the config file with settings for unbound to read instead of reading the + file at the default location, :file:`@ub_conf_file@`. + The syntax is described in :doc:`unbound.conf(5)</manpages/unbound.conf>`. + +.. option:: -d + + Debug flag: do not fork into the background, but stay attached to the + console. + This flag will also delay writing to the log file until the thread-spawn + time, so that most config and setup errors appear on stderr. + If given twice or more, logging does not switch to the log file or to + syslog, but the log messages are printed to stderr all the time. + +.. option:: -p + + Don't use a pidfile. + This argument should only be used by supervision systems which can ensure + that only one instance of Unbound will run concurrently. + +.. option:: -v + + Increase verbosity. + If given multiple times, more information is logged. + This is in addition to the verbosity (if any) from the config file. + +.. option:: -V + + Show the version number and build options, and exit. + +See Also +-------- + +:doc:`unbound.conf(5)</manpages/unbound.conf>`, +:doc:`unbound-checkconf(8)</manpages/unbound-checkconf>`, +:external+nsd:doc:`manpages/nsd`. |