named-checkconf.docbook revision 85c5ed3577655f4f710f0af5ee93edd71c336055
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley [<!ENTITY mdash "&#8212;">]>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley<!--
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - Copyright (C) 2004, 2005, 2007, 2009 Internet Systems Consortium, Inc. ("ISC")
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - Copyright (C) 2000-2002 Internet Software Consortium.
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley -
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - Permission to use, copy, modify, and/or distribute this software for any
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - purpose with or without fee is hereby granted, provided that the above
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - copyright notice and this permission notice appear in all copies.
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley -
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley - PERFORMANCE OF THIS SOFTWARE.
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley-->
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley<!-- $Id: named-checkconf.docbook,v 1.22 2009/12/28 23:21:16 each Exp $ -->
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley<refentry id="man.named-checkconf">
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refentryinfo>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <date>June 14, 2000</date>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </refentryinfo>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refmeta>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refentrytitle><application>named-checkconf</application></refentrytitle>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <manvolnum>8</manvolnum>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refmiscinfo>BIND9</refmiscinfo>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </refmeta>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <docinfo>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <copyright>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <year>2004</year>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <year>2005</year>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <year>2007</year>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <year>2009</year>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </copyright>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <copyright>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <year>2000</year>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <year>2001</year>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <year>2002</year>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <holder>Internet Software Consortium.</holder>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </copyright>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </docinfo>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refnamediv>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refname><application>named-checkconf</application></refname>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refpurpose>named configuration file syntax checking tool</refpurpose>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </refnamediv>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refsynopsisdiv>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <cmdsynopsis>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <command>named-checkconf</command>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <arg><option>-h</option></arg>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <arg><option>-v</option></arg>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <arg><option>-j</option></arg>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <arg choice="req">filename</arg>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <arg><option>-p</option></arg>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <arg><option>-z</option></arg>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </cmdsynopsis>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </refsynopsisdiv>
705a1d752e32d89efc787e1f25d51777565afbc4Bob Halley
705a1d752e32d89efc787e1f25d51777565afbc4Bob Halley <refsect1>
705a1d752e32d89efc787e1f25d51777565afbc4Bob Halley <title>DESCRIPTION</title>
42c479991fd6ae1a3189ca24fb1773ea27f30aa1Mark Andrews <para><command>named-checkconf</command>
42c479991fd6ae1a3189ca24fb1773ea27f30aa1Mark Andrews checks the syntax, but not the semantics, of a
705a1d752e32d89efc787e1f25d51777565afbc4Bob Halley <command>named</command> configuration file. The file is parsed
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley and checked for syntax errors, along with all files included by it.
5f42ef032d72001370d8bd5cd9ea3a5d032a67c8James Brister If no file is specified, <filename>/etc/named.conf</filename> is read
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley by default.
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </para>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <para>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley Note: files that <command>named</command> reads in separate
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley parser contexts, such as <filename>rndc.key</filename> and
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <filename>bind.keys</filename>, are not automatically read
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley by <command>named-checkconf</command>. Configuration
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley errors in these files may cause <command>named</command> to
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley fail to run, even if <command>named-checkconf</command> was
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley successful. <command>named-checkconf</command> can be run
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley on these files explicitly, however.
5f42ef032d72001370d8bd5cd9ea3a5d032a67c8James Brister </para>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley </refsect1>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <refsect1>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <title>OPTIONS</title>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <variablelist>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <varlistentry>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <term>-h</term>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <listitem>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <para>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff Print the usage summary and exit.
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </para>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </listitem>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </varlistentry>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <varlistentry>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <term>-t <replaceable class="parameter">directory</replaceable></term>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <listitem>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <para>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff Chroot to <filename>directory</filename> so that include
443ad8c09c31634a21ef73794aca32594543829dMichael Graff directives in the configuration file are processed as if
443ad8c09c31634a21ef73794aca32594543829dMichael Graff run by a similarly chrooted named.
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </para>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </listitem>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </varlistentry>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <varlistentry>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <term>-v</term>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <listitem>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <para>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff Print the version of the <command>named-checkconf</command>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff program and exit.
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </para>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </listitem>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff </varlistentry>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <varlistentry>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <term>-p</term>
443ad8c09c31634a21ef73794aca32594543829dMichael Graff <listitem>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley <para>
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley Print out the <filename>named.conf</filename> and included files
9679032ec8ea97edcc993deb3d3dfcf54655cb52Bob Halley in canonical form if no errors were detected.
</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:
-->