1<!DOCTYPE book [
2<!ENTITY mdash "&#8212;">]>
3<!--
4 - Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015  Internet Systems Consortium, Inc. ("ISC")
5 - Copyright (C) 2000-2002  Internet Software Consortium.
6 -
7 - Permission to use, copy, modify, and/or distribute this software for any
8 - purpose with or without fee is hereby granted, provided that the above
9 - copyright notice and this permission notice appear in all copies.
10 -
11 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17 - PERFORMANCE OF THIS SOFTWARE.
18-->
19
20<!-- Converted by db4-upgrade version 1.0 -->
21<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkconf">
22  <info>
23    <date>2014-01-10</date>
24  </info>
25  <refentryinfo>
26    <corpname>ISC</corpname>
27    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
28  </refentryinfo>
29
30  <refmeta>
31    <refentrytitle><application>named-checkconf</application></refentrytitle>
32    <manvolnum>8</manvolnum>
33    <refmiscinfo>BIND9</refmiscinfo>
34  </refmeta>
35
36  <docinfo>
37    <copyright>
38      <year>2004</year>
39      <year>2005</year>
40      <year>2007</year>
41      <year>2009</year>
42      <year>2014</year>
43      <year>2015</year>
44      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
45    </copyright>
46    <copyright>
47      <year>2000</year>
48      <year>2001</year>
49      <year>2002</year>
50      <holder>Internet Software Consortium.</holder>
51    </copyright>
52  </docinfo>
53
54  <refnamediv>
55    <refname><application>named-checkconf</application></refname>
56    <refpurpose>named configuration file syntax checking tool</refpurpose>
57  </refnamediv>
58
59  <refsynopsisdiv>
60    <cmdsynopsis sepchar=" ">
61      <command>named-checkconf</command>
62      <arg choice="opt" rep="norepeat"><option>-h</option></arg>
63      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
64      <arg choice="opt" rep="norepeat"><option>-j</option></arg>
65      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
66      <arg choice="req" rep="norepeat">filename</arg>
67      <arg choice="opt" rep="norepeat"><option>-p</option></arg>
68      <arg choice="opt" rep="norepeat"><option>-x</option></arg>
69      <arg choice="opt" rep="norepeat"><option>-z</option></arg>
70    </cmdsynopsis>
71  </refsynopsisdiv>
72
73  <refsection><info><title>DESCRIPTION</title></info>
74
75    <para><command>named-checkconf</command>
76      checks the syntax, but not the semantics, of a
77      <command>named</command> configuration file.  The file is parsed
78      and checked for syntax errors, along with all files included by it.
79      If no file is specified, <filename>/etc/named.conf</filename> is read
80      by default.
81    </para>
82    <para>
83      Note: files that <command>named</command> reads in separate
84      parser contexts, such as <filename>rndc.key</filename> and
85      <filename>bind.keys</filename>, are not automatically read
86      by <command>named-checkconf</command>.  Configuration
87      errors in these files may cause <command>named</command> to
88      fail to run, even if <command>named-checkconf</command> was
89      successful.  <command>named-checkconf</command> can be run
90      on these files explicitly, however.
91    </para>
92  </refsection>
93
94  <refsection><info><title>OPTIONS</title></info>
95
96
97    <variablelist>
98      <varlistentry>
99        <term>-h</term>
100        <listitem>
101          <para>
102            Print the usage summary and exit.
103          </para>
104        </listitem>
105      </varlistentry>
106
107      <varlistentry>
108        <term>-t <replaceable class="parameter">directory</replaceable></term>
109        <listitem>
110          <para>
111            Chroot to <filename>directory</filename> so that include
112            directives in the configuration file are processed as if
113            run by a similarly chrooted named.
114          </para>
115        </listitem>
116      </varlistentry>
117
118      <varlistentry>
119        <term>-v</term>
120        <listitem>
121          <para>
122            Print the version of the <command>named-checkconf</command>
123            program and exit.
124          </para>
125        </listitem>
126      </varlistentry>
127
128      <varlistentry>
129        <term>-p</term>
130        <listitem>
131          <para>
132	    Print out the <filename>named.conf</filename> and included files
133	    in canonical form if no errors were detected.
134          </para>
135        </listitem>
136      </varlistentry>
137
138      <varlistentry>
139        <term>-x</term>
140        <listitem>
141          <para>
142	    When printing the configuration files in canonical
143            form, obscure shared secrets by replacing them with
144            strings of question marks ('?'). This allows the
145            contents of <filename>named.conf</filename> and related
146            files to be shared &mdash; for example, when submitting
147            bug reports &mdash; without compromising private data.
148            This option cannot be used without <option>-p</option>.
149          </para>
150        </listitem>
151      </varlistentry>
152
153      <varlistentry>
154        <term>-z</term>
155        <listitem>
156          <para>
157	    Perform a test load of all master zones found in
158	    <filename>named.conf</filename>.
159          </para>
160        </listitem>
161      </varlistentry>
162
163      <varlistentry>
164        <term>-j</term>
165        <listitem>
166          <para>
167            When loading a zonefile read the journal if it exists.
168          </para>
169        </listitem>
170      </varlistentry>
171
172      <varlistentry>
173        <term>filename</term>
174        <listitem>
175          <para>
176            The name of the configuration file to be checked.  If not
177            specified, it defaults to <filename>/etc/named.conf</filename>.
178          </para>
179        </listitem>
180      </varlistentry>
181
182    </variablelist>
183
184  </refsection>
185
186  <refsection><info><title>RETURN VALUES</title></info>
187
188    <para><command>named-checkconf</command>
189      returns an exit status of 1 if
190      errors were detected and 0 otherwise.
191    </para>
192  </refsection>
193
194  <refsection><info><title>SEE ALSO</title></info>
195
196    <para><citerefentry>
197        <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
198      </citerefentry>,
199      <citerefentry>
200        <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
201      </citerefentry>,
202      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
203    </para>
204  </refsection>
205</refentry>
206