xref: /freebsd/contrib/unbound/doc/unbound-checkconf.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-checkconf
38*b2efd602SCy Schubert
39*b2efd602SCy Schubertunbound-checkconf(8)
40*b2efd602SCy Schubert====================
41*b2efd602SCy Schubert
42*b2efd602SCy SchubertSynopsis
43*b2efd602SCy Schubert--------
44*b2efd602SCy Schubert
45*b2efd602SCy Schubert**unbound-checkconf** [``-hf``] [``-o option``] [cfgfile]
46*b2efd602SCy Schubert
47*b2efd602SCy SchubertDescription
48*b2efd602SCy Schubert-----------
49*b2efd602SCy Schubert
50*b2efd602SCy Schubert``unbound-checkconf`` checks the configuration file for the
51*b2efd602SCy Schubert:doc:`unbound(8)</manpages/unbound>` DNS resolver for syntax and other errors.
52*b2efd602SCy SchubertThe config file syntax is described in
53*b2efd602SCy Schubert:doc:`unbound.conf(5)</manpages/unbound.conf>`.
54*b2efd602SCy Schubert
55*b2efd602SCy SchubertThe available options are:
56*b2efd602SCy Schubert
57*b2efd602SCy Schubert.. option:: -h
58*b2efd602SCy Schubert
59*b2efd602SCy Schubert    Show the version and commandline option help.
60*b2efd602SCy Schubert
61*b2efd602SCy Schubert.. option:: -f
62*b2efd602SCy Schubert
63*b2efd602SCy Schubert    Print full pathname, with chroot applied to it.
64*b2efd602SCy Schubert    Use with the :option:`-o` option.
65*b2efd602SCy Schubert
66*b2efd602SCy Schubert.. option:: -q
67*b2efd602SCy Schubert
68*b2efd602SCy Schubert    Make the operation quiet, suppress output on success.
69*b2efd602SCy Schubert
70*b2efd602SCy Schubert.. option:: -o <option>
71*b2efd602SCy Schubert
72*b2efd602SCy Schubert    If given, after checking the config file the value of this option is
73*b2efd602SCy Schubert    printed to stdout.
74*b2efd602SCy Schubert    For ``""`` (disabled) options an empty line is printed.
75*b2efd602SCy Schubert
76*b2efd602SCy Schubert.. option:: cfgfile
77*b2efd602SCy Schubert
78*b2efd602SCy Schubert    The config file to read with settings for Unbound.
79*b2efd602SCy Schubert    It is checked.
80*b2efd602SCy Schubert    If omitted, the config file at the default location is checked.
81*b2efd602SCy Schubert
82*b2efd602SCy SchubertExit Code
83*b2efd602SCy Schubert---------
84*b2efd602SCy Schubert
85*b2efd602SCy SchubertThe ``unbound-checkconf`` program exits with status code 1 on error, 0 for a
86*b2efd602SCy Schubertcorrect config file.
87*b2efd602SCy Schubert
88*b2efd602SCy SchubertFiles
89*b2efd602SCy Schubert-----
90*b2efd602SCy Schubert
91*b2efd602SCy Schubert@ub_conf_file@
92*b2efd602SCy Schubert    Unbound configuration file.
93*b2efd602SCy Schubert
94*b2efd602SCy SchubertSee Also
95*b2efd602SCy Schubert--------
96*b2efd602SCy Schubert
97*b2efd602SCy Schubert:doc:`unbound.conf(5)</manpages/unbound.conf>`,
98*b2efd602SCy Schubert:doc:`unbound(8)</manpages/unbound>`.
99