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