named-checkconf.docbook revision 30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence<!ENTITY mdash "—">]>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff - Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff - Copyright (C) 2000-2002 Internet Software Consortium.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff - Permission to use, copy, modify, and/or distribute this software for any
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff - purpose with or without fee is hereby granted, provided that the above
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff - copyright notice and this permission notice appear in all copies.
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
d3498432822fb487e58f8f72bb5f880dd8307d7dMichael Sawyer - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
d3498432822fb487e58f8f72bb5f880dd8307d7dMichael Sawyer - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
d3498432822fb487e58f8f72bb5f880dd8307d7dMichael Sawyer - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
d3498432822fb487e58f8f72bb5f880dd8307d7dMichael Sawyer - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
d3498432822fb487e58f8f72bb5f880dd8307d7dMichael Sawyer - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
d3498432822fb487e58f8f72bb5f880dd8307d7dMichael Sawyer - PERFORMANCE OF THIS SOFTWARE.
f9354808d122036e66e9f007a4bb12d4aa936aaeAndreas Gustafsson<!-- Converted by db4-upgrade version 1.0 -->
f9354808d122036e66e9f007a4bb12d4aa936aaeAndreas Gustafsson<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkconf">
b1d234eb75e2804e09d89178a76df39c321db51bBrian Wellington <refentryinfo>
58007c5fde59b756174280d26916eb27f593e6ccBob Halley <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
58007c5fde59b756174280d26916eb27f593e6ccBob Halley </refentryinfo>
58007c5fde59b756174280d26916eb27f593e6ccBob Halley <refentrytitle><application>named-checkconf</application></refentrytitle>
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <holder>Internet Software Consortium.</holder>
a55d0a9080c8ef4117d2fc27f63220a56afb2434Andreas Gustafsson <refname><application>named-checkconf</application></refname>
7e4d75a5daeaaf8a7f559f9bd7fbf540184e235cMark Andrews <refpurpose>named configuration file syntax checking tool</refpurpose>
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence <refsynopsisdiv>
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence <arg choice="opt" rep="norepeat"><option>-h</option></arg>
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence <arg choice="opt" rep="norepeat"><option>-v</option></arg>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <arg choice="opt" rep="norepeat"><option>-j</option></arg>
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <arg choice="req" rep="norepeat">filename</arg>
58007c5fde59b756174280d26916eb27f593e6ccBob Halley <arg choice="opt" rep="norepeat"><option>-p</option></arg>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <arg choice="opt" rep="norepeat"><option>-x</option></arg>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <arg choice="opt" rep="norepeat"><option>-z</option></arg>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </cmdsynopsis>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </refsynopsisdiv>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <refsection><info><title>DESCRIPTION</title></info>
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence checks the syntax, but not the semantics, of a
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence <command>named</command> configuration file. The file is parsed
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence and checked for syntax errors, along with all files included by it.
58007c5fde59b756174280d26916eb27f593e6ccBob Halley If no file is specified, <filename>/etc/named.conf</filename> is read
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff Note: files that <command>named</command> reads in separate
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff parser contexts, such as <filename>rndc.key</filename> and
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <filename>bind.keys</filename>, are not automatically read
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff by <command>named-checkconf</command>. Configuration
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff errors in these files may cause <command>named</command> to
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff fail to run, even if <command>named-checkconf</command> was
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff successful. <command>named-checkconf</command> can be run
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff on these files explicitly, however.
58007c5fde59b756174280d26916eb27f593e6ccBob Halley </refsection>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <refsection><info><title>OPTIONS</title></info>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <variablelist>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff Print the usage summary and exit.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <term>-t <replaceable class="parameter">directory</replaceable></term>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff Chroot to <filename>directory</filename> so that include
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff directives in the configuration file are processed as if
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff run by a similarly chrooted <command>named</command>.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff Print the version of the <command>named-checkconf</command>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff program and exit.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff Print out the <filename>named.conf</filename> and included files
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff in canonical form if no errors were detected.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff When printing the configuration files in canonical
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff form, obscure shared secrets by replacing them with
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff strings of question marks ('?'). This allows the
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff contents of <filename>named.conf</filename> and related
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff files to be shared — for example, when submitting
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff bug reports — without compromising private data.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff This option cannot be used without <option>-p</option>.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff Perform a test load of all master zones found in
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </varlistentry>
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence <varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff When loading a zonefile read the journal if it exists.
615f17d0171dd807c6803b25a255a8ea2051fbd4David Lawrence </varlistentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <varlistentry>
a1ed420875df8a6956f32d84538a7f0740e6951fAndreas Gustafsson The name of the configuration file to be checked. If not
58007c5fde59b756174280d26916eb27f593e6ccBob Halley specified, it defaults to <filename>/etc/named.conf</filename>.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </varlistentry>
58007c5fde59b756174280d26916eb27f593e6ccBob Halley </variablelist>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </refsection>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <refsection><info><title>RETURN VALUES</title></info>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff returns an exit status of 1 if
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff errors were detected and 0 otherwise.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </refsection>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <refsection><info><title>SEE ALSO</title></info>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </citerefentry>,
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <citerefentry>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </citerefentry>,
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
5a0ffa97751ef1ff29d1bf9d7f332eeb9f8edc21Michael Graff </refsection>