xref: /freebsd/contrib/unbound/doc/unbound.rst (revision b2efd602aea8b3cbc3fb215b9611946d04fceb10)
1*b2efd602SCy Schubert..
2*b2efd602SCy Schubert    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
3*b2efd602SCy Schubert
4*b2efd602SCy Schubert..
5*b2efd602SCy Schubert    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
6*b2efd602SCy Schubert
7*b2efd602SCy Schubert..
8*b2efd602SCy Schubert    IT HELPS PEOPLE DIFFING THE CHANGES
9*b2efd602SCy Schubert
10*b2efd602SCy Schubert..
11*b2efd602SCy Schubert    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
12*b2efd602SCy Schubert
13*b2efd602SCy Schubert..
14*b2efd602SCy Schubert    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
15*b2efd602SCy Schubert
16*b2efd602SCy Schubert..
17*b2efd602SCy Schubert    IT HELPS PEOPLE DIFFING THE CHANGES
18*b2efd602SCy Schubert
19*b2efd602SCy Schubert..
20*b2efd602SCy Schubert    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
21*b2efd602SCy Schubert
22*b2efd602SCy Schubert..
23*b2efd602SCy Schubert    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
24*b2efd602SCy Schubert
25*b2efd602SCy Schubert..
26*b2efd602SCy Schubert    IT HELPS PEOPLE DIFFING THE CHANGES
27*b2efd602SCy Schubert
28*b2efd602SCy Schubert..
29*b2efd602SCy Schubert    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
30*b2efd602SCy Schubert
31*b2efd602SCy Schubert..
32*b2efd602SCy Schubert    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
33*b2efd602SCy Schubert
34*b2efd602SCy Schubert..
35*b2efd602SCy Schubert    IT HELPS PEOPLE DIFFING THE CHANGES
36*b2efd602SCy Schubert
37*b2efd602SCy Schubert.. program:: unbound
38*b2efd602SCy Schubert
39*b2efd602SCy Schubertunbound(8)
40*b2efd602SCy Schubert==========
41*b2efd602SCy Schubert
42*b2efd602SCy SchubertSynopsis
43*b2efd602SCy Schubert--------
44*b2efd602SCy Schubert
45*b2efd602SCy Schubert**unbound** [``-hdpv``] [``-c <cfgfile>``]
46*b2efd602SCy Schubert
47*b2efd602SCy SchubertDescription
48*b2efd602SCy Schubert-----------
49*b2efd602SCy Schubert
50*b2efd602SCy Schubert``unbound`` is a caching DNS resolver.
51*b2efd602SCy Schubert
52*b2efd602SCy SchubertIt uses a built in list of authoritative nameservers for the root zone (``.``),
53*b2efd602SCy Schubertthe so called root hints.
54*b2efd602SCy SchubertOn receiving a DNS query it will ask the root nameservers for an answer and
55*b2efd602SCy Schubertwill in almost all cases receive a delegation to a top level domain (TLD)
56*b2efd602SCy Schubertauthoritative nameserver.
57*b2efd602SCy SchubertIt will then ask that nameserver for an answer.
58*b2efd602SCy SchubertIt will recursively continue until an answer is found or no answer is available
59*b2efd602SCy Schubert(NXDOMAIN).
60*b2efd602SCy SchubertFor performance and efficiency reasons that answer is cached for a certain time
61*b2efd602SCy Schubert(the answer's time-to-live or TTL).
62*b2efd602SCy SchubertA second query for the same name will then be answered from the cache.
63*b2efd602SCy SchubertUnbound can also do DNSSEC validation.
64*b2efd602SCy Schubert
65*b2efd602SCy SchubertTo use a locally running Unbound for resolving put:
66*b2efd602SCy Schubert
67*b2efd602SCy Schubert.. code-block:: text
68*b2efd602SCy Schubert
69*b2efd602SCy Schubert   nameserver 127.0.0.1
70*b2efd602SCy Schubert
71*b2efd602SCy Schubertinto *resolv.conf(5)*.
72*b2efd602SCy Schubert
73*b2efd602SCy SchubertIf authoritative DNS is needed as well using :external+nsd:doc:`manpages/nsd`,
74*b2efd602SCy Schubertcareful setup is required because authoritative nameservers and resolvers are
75*b2efd602SCy Schubertusing the same port number (53).
76*b2efd602SCy Schubert
77*b2efd602SCy SchubertThe available options are:
78*b2efd602SCy Schubert
79*b2efd602SCy Schubert.. option:: -h
80*b2efd602SCy Schubert
81*b2efd602SCy Schubert Show the version number and commandline option help, and exit.
82*b2efd602SCy Schubert
83*b2efd602SCy Schubert.. option:: -c <cfgfile>
84*b2efd602SCy Schubert
85*b2efd602SCy Schubert   Set the config file with settings for unbound to read instead of reading the
86*b2efd602SCy Schubert   file at the default location, :file:`@ub_conf_file@`.
87*b2efd602SCy Schubert   The syntax is described in :doc:`unbound.conf(5)</manpages/unbound.conf>`.
88*b2efd602SCy Schubert
89*b2efd602SCy Schubert.. option:: -d
90*b2efd602SCy Schubert
91*b2efd602SCy Schubert   Debug flag: do not fork into the background, but stay attached to the
92*b2efd602SCy Schubert   console.
93*b2efd602SCy Schubert   This flag will also delay writing to the log file until the thread-spawn
94*b2efd602SCy Schubert   time, so that most config and setup errors appear on stderr.
95*b2efd602SCy Schubert   If given twice or more, logging does not switch to the log file or to
96*b2efd602SCy Schubert   syslog, but the log messages are printed to stderr all the time.
97*b2efd602SCy Schubert
98*b2efd602SCy Schubert.. option:: -p
99*b2efd602SCy Schubert
100*b2efd602SCy Schubert   Don't use a pidfile.
101*b2efd602SCy Schubert   This argument should only be used by supervision systems which can ensure
102*b2efd602SCy Schubert   that only one instance of Unbound will run concurrently.
103*b2efd602SCy Schubert
104*b2efd602SCy Schubert.. option:: -v
105*b2efd602SCy Schubert
106*b2efd602SCy Schubert   Increase verbosity.
107*b2efd602SCy Schubert   If given multiple times, more information is logged.
108*b2efd602SCy Schubert   This is in addition to the verbosity (if any) from the config file.
109*b2efd602SCy Schubert
110*b2efd602SCy Schubert.. option:: -V
111*b2efd602SCy Schubert
112*b2efd602SCy Schubert   Show the version number and build options, and exit.
113*b2efd602SCy Schubert
114*b2efd602SCy SchubertSee Also
115*b2efd602SCy Schubert--------
116*b2efd602SCy Schubert
117*b2efd602SCy Schubert:doc:`unbound.conf(5)</manpages/unbound.conf>`,
118*b2efd602SCy Schubert:doc:`unbound-checkconf(8)</manpages/unbound-checkconf>`,
119*b2efd602SCy Schubert:external+nsd:doc:`manpages/nsd`.
120