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