named-checkconf.docbook revision ff6de396a93b9b73a37173059a595f3d295b57cb
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews [<!ENTITY mdash "&#8212;">]>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews<!--
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - Copyright (C) 2004, 2005, 2007, 2009 Internet Systems Consortium, Inc. ("ISC")
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - Copyright (C) 2000-2002 Internet Software Consortium.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews -
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - purpose with or without fee is hereby granted, provided that the above
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - copyright notice and this permission notice appear in all copies.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews -
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews - PERFORMANCE OF THIS SOFTWARE.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews-->
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews<!-- $Id: named-checkconf.docbook,v 1.22 2009/12/28 23:21:16 each Exp $ -->
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews<refentry id="man.named-checkconf">
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refentryinfo>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <date>June 14, 2000</date>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refentryinfo>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refmeta>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refentrytitle><application>named-checkconf</application></refentrytitle>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <manvolnum>8</manvolnum>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refmiscinfo>BIND9</refmiscinfo>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refmeta>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <docinfo>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <copyright>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2004</year>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2005</year>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2007</year>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2009</year>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </copyright>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <copyright>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2000</year>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2001</year>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <year>2002</year>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <holder>Internet Software Consortium.</holder>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </copyright>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </docinfo>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refnamediv>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refname><application>named-checkconf</application></refname>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refpurpose>named configuration file syntax checking tool</refpurpose>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refnamediv>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refsynopsisdiv>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <cmdsynopsis>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <command>named-checkconf</command>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-h</option></arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-v</option></arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-j</option></arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg choice="req">filename</arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-p</option></arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-x</option></arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <arg><option>-z</option></arg>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </cmdsynopsis>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refsynopsisdiv>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refsect1>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <title>DESCRIPTION</title>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para><command>named-checkconf</command>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews checks the syntax, but not the semantics, of a
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <command>named</command> configuration file. The file is parsed
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews and checked for syntax errors, along with all files included by it.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews If no file is specified, <filename>/etc/named.conf</filename> is read
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews by default.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews Note: files that <command>named</command> reads in separate
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews parser contexts, such as <filename>rndc.key</filename> and
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <filename>bind.keys</filename>, are not automatically read
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews by <command>named-checkconf</command>. Configuration
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews errors in these files may cause <command>named</command> to
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews fail to run, even if <command>named-checkconf</command> was
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews successful. <command>named-checkconf</command> can be run
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews on these files explicitly, however.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </refsect1>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <refsect1>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <title>OPTIONS</title>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <variablelist>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <varlistentry>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <term>-h</term>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <listitem>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews Print the usage summary and exit.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </listitem>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </varlistentry>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <varlistentry>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <term>-t <replaceable class="parameter">directory</replaceable></term>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <listitem>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews Chroot to <filename>directory</filename> so that include
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews directives in the configuration file are processed as if
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews run by a similarly chrooted named.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </listitem>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </varlistentry>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <varlistentry>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <term>-v</term>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <listitem>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews Print the version of the <command>named-checkconf</command>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews program and exit.
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </para>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </listitem>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews </varlistentry>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <varlistentry>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <term>-p</term>
3b83676e079a799f97ad8b76c057e6ecb0426b1dMark Andrews <listitem>
c3c8823fed039b3a2b8e5ca8bc2f3301d1dd840eMark Andrews <para>
Print out the <filename>named.conf</filename> and included files
in canonical form if no errors were detected.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-x</term>
<listitem>
<para>
When printing the configuration files in canonical
form, obscure shared secrets by replacing them with
strings of question marks ('?'). This allows the
contents of <filename>named.conf</filename> and related
files to be shared &mdash; for example, when submitting
bug reports &mdash; without compromising private data.
This option cannot be used without <option>-p</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-z</term>
<listitem>
<para>
Perform a test load of all master zones found in
<filename>named.conf</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-j</term>
<listitem>
<para>
When loading a zonefile read the journal if it exists.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>filename</term>
<listitem>
<para>
The name of the configuration file to be checked. If not
specified, it defaults to <filename>/etc/named.conf</filename>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para><command>named-checkconf</command>
returns an exit status of 1 if
errors were detected and 0 otherwise.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry>
<refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>BIND 9 Administrator Reference Manual</citetitle>.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->