named-checkconf.docbook revision 0c27b3fe77ac1d5094ba3521e8142d9e7973133f
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<!DOCTYPE book [
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater<!ENTITY mdash "&#8212;">]>
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater<!--
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - Copyright (C) 2000-2002, 2004, 2005, 2007, 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater -
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - This Source Code Form is subject to the terms of the Mozilla Public
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt - License, v. 2.0. If a copy of the MPL was not distributed with this
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater - file, You can obtain one at http://mozilla.org/MPL/2.0/.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt-->
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater<!-- Converted by db4-upgrade version 1.0 -->
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkconf">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <info>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <date>2014-01-10</date>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </info>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refentryinfo>
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater <corpname>ISC</corpname>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </refentryinfo>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refmeta>
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater <refentrytitle><application>named-checkconf</application></refentrytitle>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <manvolnum>8</manvolnum>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refmiscinfo>BIND9</refmiscinfo>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </refmeta>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <docinfo>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <copyright>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2004</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2005</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2007</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2009</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2014</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2015</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2016</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </copyright>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <copyright>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2000</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2001</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <year>2002</year>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <holder>Internet Software Consortium.</holder>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </copyright>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </docinfo>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refnamediv>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refname><application>named-checkconf</application></refname>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refpurpose>named configuration file syntax checking tool</refpurpose>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </refnamediv>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater <refsynopsisdiv>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <cmdsynopsis sepchar=" ">
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <command>named-checkconf</command>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="opt" rep="norepeat"><option>-h</option></arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="opt" rep="norepeat"><option>-v</option></arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="opt" rep="norepeat"><option>-j</option></arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="req" rep="norepeat">filename</arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="opt" rep="norepeat"><option>-p</option></arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="opt" rep="norepeat"><option>-x</option></arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <arg choice="opt" rep="norepeat"><option>-z</option></arg>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </cmdsynopsis>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </refsynopsisdiv>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refsection><info><title>DESCRIPTION</title></info>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para><command>named-checkconf</command>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt checks the syntax, but not the semantics, of a
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <command>named</command> configuration file. The file is parsed
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt and checked for syntax errors, along with all files included by it.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt If no file is specified, <filename>/etc/named.conf</filename> is read
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt by default.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Note: files that <command>named</command> reads in separate
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt parser contexts, such as <filename>rndc.key</filename> and
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <filename>bind.keys</filename>, are not automatically read
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater by <command>named-checkconf</command>. Configuration
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt errors in these files may cause <command>named</command> to
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt fail to run, even if <command>named-checkconf</command> was
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt successful. <command>named-checkconf</command> can be run
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt on these files explicitly, however.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </refsection>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <refsection><info><title>OPTIONS</title></info>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <variablelist>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <term>-h</term>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Print the usage summary and exit.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <term>-t <replaceable class="parameter">directory</replaceable></term>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Chroot to <filename>directory</filename> so that include
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt directives in the configuration file are processed as if
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt run by a similarly chrooted <command>named</command>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <term>-v</term>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Print the version of the <command>named-checkconf</command>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt program and exit.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <term>-p</term>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Print out the <filename>named.conf</filename> and included files
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt in canonical form if no errors were detected.
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <term>-x</term>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para>
9210d8796eaf4125ac58c034f9b5ca167857a55aAutomatic Updater When printing the configuration files in canonical
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt form, obscure shared secrets by replacing them with
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt strings of question marks ('?'). This allows the
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt contents of <filename>named.conf</filename> and related
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt files to be shared &mdash; for example, when submitting
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt bug reports &mdash; without compromising private data.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt This option cannot be used without <option>-p</option>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <term>-z</term>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt Perform a test load of all master zones found in
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <filename>named.conf</filename>.
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </para>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </listitem>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt </varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <varlistentry>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <term>-j</term>
76786c2904942b708d8a7a4659df74da5dc9446eEvan Hunt <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>
</refsection>
<refsection><info><title>RETURN VALUES</title></info>
<para><command>named-checkconf</command>
returns an exit status of 1 if
errors were detected and 0 otherwise.
</para>
</refsection>
<refsection><info><title>SEE ALSO</title></info>
<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>
</refsection>
</refentry>