xref: /freebsd/contrib/unbound/doc/unbound-checkconf.rst (revision b2efd602aea8b3cbc3fb215b9611946d04fceb10)
1..
2    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
3
4..
5    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
6
7..
8    IT HELPS PEOPLE DIFFING THE CHANGES
9
10..
11    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
12
13..
14    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
15
16..
17    IT HELPS PEOPLE DIFFING THE CHANGES
18
19..
20    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
21
22..
23    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
24
25..
26    IT HELPS PEOPLE DIFFING THE CHANGES
27
28..
29    WHEN EDITING MAKE SURE EACH SENTENCE STARTS ON A NEW LINE
30
31..
32    IT HELPS RENDERERS TO DO THE RIGHT THING WRT SPACE
33
34..
35    IT HELPS PEOPLE DIFFING THE CHANGES
36
37.. program:: unbound-checkconf
38
39unbound-checkconf(8)
40====================
41
42Synopsis
43--------
44
45**unbound-checkconf** [``-hf``] [``-o option``] [cfgfile]
46
47Description
48-----------
49
50``unbound-checkconf`` checks the configuration file for the
51:doc:`unbound(8)</manpages/unbound>` DNS resolver for syntax and other errors.
52The config file syntax is described in
53:doc:`unbound.conf(5)</manpages/unbound.conf>`.
54
55The available options are:
56
57.. option:: -h
58
59    Show the version and commandline option help.
60
61.. option:: -f
62
63    Print full pathname, with chroot applied to it.
64    Use with the :option:`-o` option.
65
66.. option:: -q
67
68    Make the operation quiet, suppress output on success.
69
70.. option:: -o <option>
71
72    If given, after checking the config file the value of this option is
73    printed to stdout.
74    For ``""`` (disabled) options an empty line is printed.
75
76.. option:: cfgfile
77
78    The config file to read with settings for Unbound.
79    It is checked.
80    If omitted, the config file at the default location is checked.
81
82Exit Code
83---------
84
85The ``unbound-checkconf`` program exits with status code 1 on error, 0 for a
86correct config file.
87
88Files
89-----
90
91@ub_conf_file@
92    Unbound configuration file.
93
94See Also
95--------
96
97:doc:`unbound.conf(5)</manpages/unbound.conf>`,
98:doc:`unbound(8)</manpages/unbound>`.
99