named-checkconf.html revision 5fa6a064b8301e4f274bd132fd577def59e4fb4c
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<!--
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - Copyright (C) 2000-2002 Internet Software Consortium.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg -
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - Permission to use, copy, modify, and/or distribute this software for any
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - purpose with or without fee is hereby granted, provided that the above
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - copyright notice and this permission notice appear in all copies.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg -
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg - PERFORMANCE OF THIS SOFTWARE.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg-->
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<!-- $Id$ -->
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<html>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<head>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<title>named-checkconf</title>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</head>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<a name="man.named-checkconf"></a><div class="titlepage"></div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="refnamediv">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<h2>Name</h2>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<p><span class="application">named-checkconf</span> &#8212; named configuration file syntax checking tool</p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="refsynopsisdiv">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<h2>Synopsis</h2>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="cmdsynopsis"><p><code class="command">named-checkconf</code> [<code class="option">-h</code>] [<code class="option">-v</code>] [<code class="option">-j</code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] {filename} [<code class="option">-p</code>] [<code class="option">-x</code>] [<code class="option">-z</code>]</p></div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="refsect1" lang="en">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<a name="id2543411"></a><h2>DESCRIPTION</h2>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<p><span><strong class="command">named-checkconf</strong></span>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg checks the syntax, but not the semantics, of a
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg <span><strong class="command">named</strong></span> configuration file. The file is parsed
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg and checked for syntax errors, along with all files included by it.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg If no file is specified, <code class="filename">/etc/named.conf</code> is read
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg by default.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg Note: files that <span><strong class="command">named</strong></span> reads in separate
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg parser contexts, such as <code class="filename">rndc.key</code> and
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg <code class="filename">bind.keys</code>, are not automatically read
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg by <span><strong class="command">named-checkconf</strong></span>. Configuration
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg errors in these files may cause <span><strong class="command">named</strong></span> to
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg fail to run, even if <span><strong class="command">named-checkconf</strong></span> was
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg successful. <span><strong class="command">named-checkconf</strong></span> can be run
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg on these files explicitly, however.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="refsect1" lang="en">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<a name="id2543460"></a><h2>OPTIONS</h2>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="variablelist"><dl>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">-h</span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg Print the usage summary and exit.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg Chroot to <code class="filename">directory</code> so that include
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg directives in the configuration file are processed as if
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg run by a similarly chrooted named.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">-v</span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg Print the version of the <span><strong class="command">named-checkconf</strong></span>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg program and exit.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">-p</span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg Print out the <code class="filename">named.conf</code> and included files
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg in canonical form if no errors were detected.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">-x</span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg When printing the configuration files in canonical
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg form, obscure shared secrets by replacing them with
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg strings of question marks ('?'). This allows the
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg contents of <code class="filename">named.conf</code> and related
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg files to be shared &#8212; for example, when submitting
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg bug reports &#8212; without compromising private data.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg This option cannot be used without <code class="option">-p</code>.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">-z</span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg Perform a test load of all master zones found in
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg <code class="filename">named.conf</code>.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">-j</span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg When loading a zonefile read the journal if it exists.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dt><span class="term">filename</span></dt>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<dd><p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg The name of the configuration file to be checked. If not
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg specified, it defaults to <code class="filename">/etc/named.conf</code>.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p></dd>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</dl></div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="refsect1" lang="en">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<a name="id2543604"></a><h2>RETURN VALUES</h2>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<p><span><strong class="command">named-checkconf</strong></span>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg returns an exit status of 1 if
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg errors were detected and 0 otherwise.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="refsect1" lang="en">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<a name="id2543616"></a><h2>SEE ALSO</h2>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<div class="refsect1" lang="en">
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<a name="id2543645"></a><h2>AUTHOR</h2>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg<p><span class="corpauthor">Internet Systems Consortium</span>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg </p>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</div></body>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg</html>
13b501825bce68e7e49b4bc775da93e38d9bd9f3fuankg