xref: /netbsd-src/external/mpl/bind/dist/bin/check/named-checkconf.rst (revision f0fde9902fd4d72ded2807793acc7bfaa1ebf243)
1..
2   Copyright (C) Internet Systems Consortium, Inc. ("ISC")
3
4   This Source Code Form is subject to the terms of the Mozilla Public
5   License, v. 2.0. If a copy of the MPL was not distributed with this
6   file, you can obtain one at https://mozilla.org/MPL/2.0/.
7
8   See the COPYRIGHT file distributed with this work for additional
9   information regarding copyright ownership.
10
11..
12   Copyright (C) Internet Systems Consortium, Inc. ("ISC")
13
14   This Source Code Form is subject to the terms of the Mozilla Public
15   License, v. 2.0. If a copy of the MPL was not distributed with this
16   file, You can obtain one at http://mozilla.org/MPL/2.0/.
17
18   See the COPYRIGHT file distributed with this work for additional
19   information regarding copyright ownership.
20
21
22.. highlight: console
23
24.. _man_named-checkconf:
25
26named-checkconf - named configuration file syntax checking tool
27---------------------------------------------------------------
28
29Synopsis
30~~~~~~~~
31
32:program:`named-checkconf` [**-chjlvz**] [**-p** [**-x** ]] [**-t** directory] {filename}
33
34Description
35~~~~~~~~~~~
36
37``named-checkconf`` checks the syntax, but not the semantics, of a
38``named`` configuration file. The file, along with all files included by it, is parsed and checked for syntax
39errors. If no file is specified,
40``/etc/named.conf`` is read by default.
41
42Note: files that ``named`` reads in separate parser contexts, such as
43``rndc.key`` and ``bind.keys``, are not automatically read by
44``named-checkconf``. Configuration errors in these files may cause
45``named`` to fail to run, even if ``named-checkconf`` was successful.
46However, ``named-checkconf`` can be run on these files explicitly.
47
48Options
49~~~~~~~
50
51``-h``
52   This option prints the usage summary and exits.
53
54``-j``
55   When loading a zonefile, this option instructs ``named`` to read the journal if it exists.
56
57``-l``
58   This option lists all the configured zones. Each line of output contains the zone
59   name, class (e.g. IN), view, and type (e.g. primary or secondary).
60
61``-c``
62   This option specifies that only the "core" configuration should be checked. This suppresses the loading of
63   plugin modules, and causes all parameters to ``plugin`` statements to
64   be ignored.
65
66``-i``
67   This option ignores warnings on deprecated options.
68
69``-p``
70   This option prints out the ``named.conf`` and included files in canonical form if
71   no errors were detected. See also the ``-x`` option.
72
73``-t directory``
74   This option instructs ``named`` to chroot to ``directory``, so that ``include`` directives in the
75   configuration file are processed as if run by a similarly chrooted
76   ``named``.
77
78``-v``
79   This option prints the version of the ``named-checkconf`` program and exits.
80
81``-x``
82   When printing the configuration files in canonical form, this option obscures
83   shared secrets by replacing them with strings of question marks
84   (``?``). This allows the contents of ``named.conf`` and related files
85   to be shared - for example, when submitting bug reports -
86   without compromising private data. This option cannot be used without
87   ``-p``.
88
89``-z``
90   This option performs a test load of all zones of type ``primary`` found in ``named.conf``.
91
92``filename``
93   This indicates the name of the configuration file to be checked. If not specified,
94   it defaults to ``/etc/named.conf``.
95
96Return Values
97~~~~~~~~~~~~~
98
99``named-checkconf`` returns an exit status of 1 if errors were detected
100and 0 otherwise.
101
102See Also
103~~~~~~~~
104
105:manpage:`named(8)`, :manpage:`named-checkzone(8)`, BIND 9 Administrator Reference Manual.
106