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