named-checkconf.docbook revision 704e6c8876907aac0bf7380effca8bca400d4acd
499b34cea04a46823d003d4c0520c8b03e8513cbBrian Wellington<!ENTITY mdash "—">]>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley - Copyright (C) 2000-2002, 2004, 2005, 2007, 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley - This Source Code Form is subject to the terms of the Mozilla Public
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - License, v. 2.0. If a copy of the MPL was not distributed with this
15a44745412679c30a6d022733925af70a38b715David Lawrence - file, You can obtain one at http://mozilla.org/MPL/2.0/.
15a44745412679c30a6d022733925af70a38b715David Lawrence<!-- Converted by db4-upgrade version 1.0 -->
15a44745412679c30a6d022733925af70a38b715David Lawrence<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.named-checkconf">
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refentryinfo>
2d6ff29a077032b4a1cbfe9fe6ef42715de251dbAndreas Gustafsson <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
9c3531d72aeaad6c5f01efe6a1c82023e1379e4dDavid Lawrence </refentryinfo>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refentrytitle><application>named-checkconf</application></refentrytitle>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </copyright>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refnamediv>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refname><application>named-checkconf</application></refname>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refpurpose>named configuration file syntax checking tool</refpurpose>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </refnamediv>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refsynopsisdiv>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <arg choice="opt" rep="norepeat"><option>-h</option></arg>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <arg choice="opt" rep="norepeat"><option>-v</option></arg>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <arg choice="opt" rep="norepeat"><option>-j</option></arg>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <arg choice="opt" rep="norepeat"><option>-p</option></arg>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <arg choice="opt" rep="norepeat"><option>-x</option></arg>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <arg choice="opt" rep="norepeat"><option>-z</option></arg>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </cmdsynopsis>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </refsynopsisdiv>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refsection><info><title>DESCRIPTION</title></info>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley checks the syntax, but not the semantics, of a
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <command>named</command> configuration file. The file is parsed
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley and checked for syntax errors, along with all files included by it.
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley If no file is specified, <filename>/etc/named.conf</filename> is read
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley Note: files that <command>named</command> reads in separate
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley parser contexts, such as <filename>rndc.key</filename> and
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <filename>bind.keys</filename>, are not automatically read
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley by <command>named-checkconf</command>. Configuration
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley errors in these files may cause <command>named</command> to
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley fail to run, even if <command>named-checkconf</command> was
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley successful. <command>named-checkconf</command> can be run
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley on these files explicitly, however.
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </refsection>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <variablelist>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <varlistentry>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley Print the usage summary and exit.
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </varlistentry>
904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley <varlistentry>
a9179fca2377919901b2d3dd15da2eb87612a533Bob Halley <term>-t <replaceable class="parameter">directory</replaceable></term>
904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley Chroot to <filename>directory</filename> so that include
904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley directives in the configuration file are processed as if
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley run by a similarly chrooted <command>named</command>.
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </varlistentry>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <varlistentry>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley Print the version of the <command>named-checkconf</command>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley program and exit.
a9179fca2377919901b2d3dd15da2eb87612a533Bob Halley </varlistentry>
a9179fca2377919901b2d3dd15da2eb87612a533Bob Halley <varlistentry>
a9179fca2377919901b2d3dd15da2eb87612a533Bob Halley Print out the <filename>named.conf</filename> and included files
d981ca645597116d227a48bf37cc5edc061c854dBob Halley in canonical form if no errors were detected.
a9179fca2377919901b2d3dd15da2eb87612a533Bob Halley </varlistentry>
a9179fca2377919901b2d3dd15da2eb87612a533Bob Halley <varlistentry>
e6bd97dded968f82e26b270842b789bff7bca422Mark Andrews When printing the configuration files in canonical
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson form, obscure shared secrets by replacing them with
328b755376af8a1527cb4a32cbaa31d03cb859b9Andreas Gustafsson strings of question marks ('?'). This allows the
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson contents of <filename>named.conf</filename> and related
0c8649cea98afc061dd2938fd315df53b8fc35caAndreas Gustafsson files to be shared — for example, when submitting
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson bug reports — without compromising private data.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson This option cannot be used without <option>-p</option>.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson </varlistentry>
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <varlistentry>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley Perform a test load of all master zones found in
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence </varlistentry>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <varlistentry>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley When loading a zonefile read the journal if it exists.
368b37b616234fce3d23099eb180f1dd38e1fb62Mark Andrews </varlistentry>
389c749a5ee18f1c0d6278ae49f2aae5d5f0d2dcMark Andrews <varlistentry>
389c749a5ee18f1c0d6278ae49f2aae5d5f0d2dcMark Andrews The name of the configuration file to be checked. If not
389c749a5ee18f1c0d6278ae49f2aae5d5f0d2dcMark Andrews specified, it defaults to <filename>/etc/named.conf</filename>.
29c818c7d40fc8898b062903ec703851328a4deaMark Andrews </varlistentry>
29c818c7d40fc8898b062903ec703851328a4deaMark Andrews </variablelist>
29c818c7d40fc8898b062903ec703851328a4deaMark Andrews <refsection><info><title>RETURN VALUES</title></info>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley returns an exit status of 1 if
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley errors were detected and 0 otherwise.
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence </refsection>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </citerefentry>,
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <citerefentry>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </citerefentry>,
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
c6dcc4cc989a7aae39ce7263c1d3e1d5758fb91bBob Halley </refsection>