named-checkconf.docbook revision 0c27b3fe77ac1d5094ba3521e8142d9e7973133f
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews<!ENTITY mdash "—">]>
e999539fb3e45b2617571e0e3ecd651992291701Mark Andrews - Copyright (C) 2000-2002, 2004, 2005, 2007, 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
2a40fdc2d34adb8a5c72a748449699666032d461Mark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews - License, v. 2.0. If a copy of the MPL was not distributed with this
a3b428812703d22a605a9f882e71ed65f0ffdc65Mark Andrews - file, You can obtain one at http://mozilla.org/MPL/2.0/.
ac4e70ff8955669341f435bc0a734a17c01af124Mark Andrews<!-- Converted by db4-upgrade version 1.0 -->
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkconf">
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <refentryinfo>
c718d15a9a95054ee3c71540c02335426071fc6dMark Andrews <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews </refentryinfo>
c718d15a9a95054ee3c71540c02335426071fc6dMark Andrews <refentrytitle><application>named-checkconf</application></refentrytitle>
c718d15a9a95054ee3c71540c02335426071fc6dMark Andrews <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews </copyright>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </copyright>
3f6174bffe227be44e241a29d186add00c032ff6Mark Andrews <refnamediv>
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews <refname><application>named-checkconf</application></refname>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refpurpose>named configuration file syntax checking tool</refpurpose>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews </refnamediv>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <refsynopsisdiv>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <arg choice="opt" rep="norepeat"><option>-h</option></arg>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <arg choice="opt" rep="norepeat"><option>-v</option></arg>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <arg choice="opt" rep="norepeat"><option>-j</option></arg>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <arg choice="req" rep="norepeat">filename</arg>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <arg choice="opt" rep="norepeat"><option>-p</option></arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="opt" rep="norepeat"><option>-x</option></arg>
26a77b80bb7ee886c6fa704348d5e80a011d8811Mark Andrews <arg choice="opt" rep="norepeat"><option>-z</option></arg>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </cmdsynopsis>
6f046a065e5543f8cd7e2f24991c65d2372f4c8dMark Andrews </refsynopsisdiv>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refsection><info><title>DESCRIPTION</title></info>
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews checks the syntax, but not the semantics, of a
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <command>named</command> configuration file. The file is parsed
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews and checked for syntax errors, along with all files included by it.
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews If no file is specified, <filename>/etc/named.conf</filename> is read
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson Note: files that <command>named</command> reads in separate
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews parser contexts, such as <filename>rndc.key</filename> and
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <filename>bind.keys</filename>, are not automatically read
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson by <command>named-checkconf</command>. Configuration
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews errors in these files may cause <command>named</command> to
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson fail to run, even if <command>named-checkconf</command> was
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews successful. <command>named-checkconf</command> can be run
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington on these files explicitly, however.
80f9a970ae6681c08529ef209eaabbe078c27ca3Mark Andrews </refsection>
46e873c835bf7d9ec3e1097e0aceb8db5b1ae93aMark Andrews <refsection><info><title>OPTIONS</title></info>
605bd686e437162b5ab65ac4e7c1be0bba1886ddMark Andrews <variablelist>
45eca3a5d46ed15aee14d81f6cb6c9fb6f365344Mark Andrews <varlistentry>
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews Print the usage summary and exit.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews </varlistentry>
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews <varlistentry>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <term>-t <replaceable class="parameter">directory</replaceable></term>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Chroot to <filename>directory</filename> so that include
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews directives in the configuration file are processed as if
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews run by a similarly chrooted <command>named</command>.
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews </varlistentry>
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews <varlistentry>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Print the version of the <command>named-checkconf</command>
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews program and exit.
d56e188030368b835122d759ebbf8d9613c166f4Mark Andrews </varlistentry>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <varlistentry>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Print out the <filename>named.conf</filename> and included files
b7aab05edae933e169d5f83c653935b17c7f0a8bMark Andrews in canonical form if no errors were detected.
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews When printing the configuration files in canonical
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews form, obscure shared secrets by replacing them with
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews strings of question marks ('?'). This allows the
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews contents of <filename>named.conf</filename> and related
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews files to be shared — for example, when submitting
0d3490f93bb980fde704055e74c1b508987a5fe4Mark Andrews bug reports — without compromising private data.
5147281cb8e25c599d759dfa65fdb6f9125efefbMark Andrews This option cannot be used without <option>-p</option>.
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <varlistentry>
1eb1e1e838d2ea00b166c918bf50764a95826be8Mark Andrews Perform a test load of all master zones found in
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </varlistentry>
45eca3a5d46ed15aee14d81f6cb6c9fb6f365344Mark Andrews <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington When loading a zonefile read the journal if it exists.
c718d15a9a95054ee3c71540c02335426071fc6dMark Andrews </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington The name of the configuration file to be checked. If not
8ae412a86ed138263796195eed82a4716e7effcbMark Andrews specified, it defaults to <filename>/etc/named.conf</filename>.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </variablelist>
6b5c57e52ac8c3e0af1547be3140ebbfb41a85b3Mark Andrews </refsection>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refsection><info><title>RETURN VALUES</title></info>
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews returns an exit status of 1 if
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews errors were detected and 0 otherwise.
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews </refsection>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <refsection><info><title>SEE ALSO</title></info>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews </citerefentry>,
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews <citerefentry>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </citerefentry>,
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews </refsection>