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