bind9/bin/check/named-checkconf.html

159 lines
5.3 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2001-03-29 19:08:35 -05:00
<!--
2016-07-21 03:53:18 -04:00
- Copyright (C) 2000-2002, 2004, 2005, 2007, 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
2005-05-11 02:05:43 -04:00
-
2016-07-21 03:53:18 -04:00
- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
2001-03-29 19:08:35 -05:00
-->
<html lang="en">
2005-05-11 02:05:43 -04:00
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-checkconf</title>
2015-10-07 00:11:09 -04:00
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
2005-05-11 02:05:43 -04:00
</head>
2015-10-07 00:11:09 -04:00
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
2005-07-19 02:12:24 -04:00
<a name="man.named-checkconf"></a><div class="titlepage"></div>
2016-12-06 20:09:50 -05:00
<div class="refnamediv">
2005-05-11 02:05:43 -04:00
<h2>Name</h2>
2016-12-06 20:09:50 -05:00
<p>
<span class="application">named-checkconf</span>
&#8212; named configuration file syntax checking tool
</p>
2005-05-11 02:05:43 -04:00
</div>
2016-12-06 20:09:50 -05:00
<div class="refsynopsisdiv">
2005-05-11 02:05:43 -04:00
<h2>Synopsis</h2>
2016-12-06 20:09:50 -05:00
<div class="cmdsynopsis"><p>
<code class="command">named-checkconf</code>
[<code class="option">-hjvz</code>]
[<code class="option">-p</code>
2016-10-05 21:09:07 -04:00
[<code class="option">-x</code>
2016-12-06 20:09:50 -05:00
]]
[<code class="option">-t <em class="replaceable"><code>directory</code></em></code>]
{filename}
</p></div>
</div>
<div class="refsection">
2015-10-07 00:11:09 -04:00
<a name="id-1.7"></a><h2>DESCRIPTION</h2>
2016-12-06 20:09:50 -05:00
<p><span class="command"><strong>named-checkconf</strong></span>
2009-12-28 20:14:03 -05:00
checks the syntax, but not the semantics, of a
2015-10-06 01:45:21 -04:00
<span class="command"><strong>named</strong></span> configuration file. The file is parsed
2009-12-28 20:14:03 -05:00
and checked for syntax errors, along with all files included by it.
If no file is specified, <code class="filename">/etc/named.conf</code> is read
by default.
</p>
2016-12-06 20:09:50 -05:00
<p>
2015-10-06 01:45:21 -04:00
Note: files that <span class="command"><strong>named</strong></span> reads in separate
2009-12-28 20:14:03 -05:00
parser contexts, such as <code class="filename">rndc.key</code> and
<code class="filename">bind.keys</code>, are not automatically read
2015-10-06 01:45:21 -04:00
by <span class="command"><strong>named-checkconf</strong></span>. Configuration
errors in these files may cause <span class="command"><strong>named</strong></span> to
fail to run, even if <span class="command"><strong>named-checkconf</strong></span> was
successful. <span class="command"><strong>named-checkconf</strong></span> can be run
2009-12-28 20:14:03 -05:00
on these files explicitly, however.
2005-05-11 02:05:43 -04:00
</p>
2016-12-06 20:09:50 -05:00
</div>
<div class="refsection">
2015-10-07 00:11:09 -04:00
<a name="id-1.8"></a><h2>OPTIONS</h2>
2016-12-06 20:09:50 -05:00
<div class="variablelist"><dl class="variablelist">
2007-05-21 00:09:03 -04:00
<dt><span class="term">-h</span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2007-05-21 00:09:03 -04:00
Print the usage summary and exit.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2016-10-05 21:09:07 -04:00
<dt><span class="term">-j</span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2016-10-05 21:09:07 -04:00
When loading a zonefile read the journal if it exists.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2016-10-05 21:09:07 -04:00
<dt><span class="term">-p</span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2016-10-05 21:09:07 -04:00
Print out the <code class="filename">named.conf</code> and included files
in canonical form if no errors were detected.
See also the <code class="option">-x</code> option.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2005-05-11 02:05:43 -04:00
<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2009-07-13 21:13:07 -04:00
Chroot to <code class="filename">directory</code> so that include
2005-05-11 02:05:43 -04:00
directives in the configuration file are processed as if
2015-10-06 01:45:21 -04:00
run by a similarly chrooted <span class="command"><strong>named</strong></span>.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2005-05-11 02:05:43 -04:00
<dt><span class="term">-v</span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2015-10-06 01:45:21 -04:00
Print the version of the <span class="command"><strong>named-checkconf</strong></span>
2005-05-11 02:05:43 -04:00
program and exit.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2014-01-10 20:05:06 -05:00
<dt><span class="term">-x</span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2014-01-10 20:05:06 -05:00
When printing the configuration files in canonical
form, obscure shared secrets by replacing them with
strings of question marks ('?'). This allows the
contents of <code class="filename">named.conf</code> and related
files to be shared &#8212; for example, when submitting
bug reports &#8212; without compromising private data.
This option cannot be used without <code class="option">-p</code>.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2005-05-11 02:05:43 -04:00
<dt><span class="term">-z</span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2007-05-08 23:33:51 -04:00
Perform a test load of all master zones found in
<code class="filename">named.conf</code>.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2005-05-11 02:05:43 -04:00
<dt><span class="term">filename</span></dt>
2016-12-06 20:09:50 -05:00
<dd>
<p>
2005-05-11 02:05:43 -04:00
The name of the configuration file to be checked. If not
specified, it defaults to <code class="filename">/etc/named.conf</code>.
2016-12-06 20:09:50 -05:00
</p>
</dd>
2005-05-11 02:05:43 -04:00
</dl></div>
2016-12-06 20:09:50 -05:00
</div>
<div class="refsection">
2015-10-07 00:11:09 -04:00
<a name="id-1.9"></a><h2>RETURN VALUES</h2>
2016-12-06 20:09:50 -05:00
<p><span class="command"><strong>named-checkconf</strong></span>
2005-05-11 02:05:43 -04:00
returns an exit status of 1 if
errors were detected and 0 otherwise.
</p>
2016-12-06 20:09:50 -05:00
</div>
<div class="refsection">
2015-10-07 00:11:09 -04:00
<a name="id-1.10"></a><h2>SEE ALSO</h2>
2016-12-06 20:09:50 -05:00
<p><span class="citerefentry">
<span class="refentrytitle">named</span>(8)
</span>,
<span class="citerefentry">
<span class="refentrytitle">named-checkzone</span>(8)
</span>,
2005-05-11 02:05:43 -04:00
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
2016-12-06 20:09:50 -05:00
</div>
2005-05-11 02:05:43 -04:00
</div></body>
</html>