xref: /minix3/external/bsd/bind/dist/bin/check/named-checkconf.html (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1*00b67f09SDavid van Moolenbroek<!--
2*00b67f09SDavid van Moolenbroek - Copyright (C) 2004, 2005, 2007, 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
3*00b67f09SDavid van Moolenbroek - Copyright (C) 2000-2002 Internet Software Consortium.
4*00b67f09SDavid van Moolenbroek -
5*00b67f09SDavid van Moolenbroek - Permission to use, copy, modify, and/or distribute this software for any
6*00b67f09SDavid van Moolenbroek - purpose with or without fee is hereby granted, provided that the above
7*00b67f09SDavid van Moolenbroek - copyright notice and this permission notice appear in all copies.
8*00b67f09SDavid van Moolenbroek -
9*00b67f09SDavid van Moolenbroek - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10*00b67f09SDavid van Moolenbroek - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11*00b67f09SDavid van Moolenbroek - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12*00b67f09SDavid van Moolenbroek - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13*00b67f09SDavid van Moolenbroek - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14*00b67f09SDavid van Moolenbroek - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15*00b67f09SDavid van Moolenbroek - PERFORMANCE OF THIS SOFTWARE.
16*00b67f09SDavid van Moolenbroek-->
17*00b67f09SDavid van Moolenbroek<!-- Id -->
18*00b67f09SDavid van Moolenbroek<html>
19*00b67f09SDavid van Moolenbroek<head>
20*00b67f09SDavid van Moolenbroek<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
21*00b67f09SDavid van Moolenbroek<title>named-checkconf</title>
22*00b67f09SDavid van Moolenbroek<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
23*00b67f09SDavid van Moolenbroek</head>
24*00b67f09SDavid van Moolenbroek<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25*00b67f09SDavid van Moolenbroek<a name="man.named-checkconf"></a><div class="titlepage"></div>
26*00b67f09SDavid van Moolenbroek<div class="refnamediv">
27*00b67f09SDavid van Moolenbroek<h2>Name</h2>
28*00b67f09SDavid van Moolenbroek<p><span class="application">named-checkconf</span> &#8212; named configuration file syntax checking tool</p>
29*00b67f09SDavid van Moolenbroek</div>
30*00b67f09SDavid van Moolenbroek<div class="refsynopsisdiv">
31*00b67f09SDavid van Moolenbroek<h2>Synopsis</h2>
32*00b67f09SDavid van Moolenbroek<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>
33*00b67f09SDavid van Moolenbroek</div>
34*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
35*00b67f09SDavid van Moolenbroek<a name="id2543411"></a><h2>DESCRIPTION</h2>
36*00b67f09SDavid van Moolenbroek<p><span><strong class="command">named-checkconf</strong></span>
37*00b67f09SDavid van Moolenbroek      checks the syntax, but not the semantics, of a
38*00b67f09SDavid van Moolenbroek      <span><strong class="command">named</strong></span> configuration file.  The file is parsed
39*00b67f09SDavid van Moolenbroek      and checked for syntax errors, along with all files included by it.
40*00b67f09SDavid van Moolenbroek      If no file is specified, <code class="filename">/etc/named.conf</code> is read
41*00b67f09SDavid van Moolenbroek      by default.
42*00b67f09SDavid van Moolenbroek    </p>
43*00b67f09SDavid van Moolenbroek<p>
44*00b67f09SDavid van Moolenbroek      Note: files that <span><strong class="command">named</strong></span> reads in separate
45*00b67f09SDavid van Moolenbroek      parser contexts, such as <code class="filename">rndc.key</code> and
46*00b67f09SDavid van Moolenbroek      <code class="filename">bind.keys</code>, are not automatically read
47*00b67f09SDavid van Moolenbroek      by <span><strong class="command">named-checkconf</strong></span>.  Configuration
48*00b67f09SDavid van Moolenbroek      errors in these files may cause <span><strong class="command">named</strong></span> to
49*00b67f09SDavid van Moolenbroek      fail to run, even if <span><strong class="command">named-checkconf</strong></span> was
50*00b67f09SDavid van Moolenbroek      successful.  <span><strong class="command">named-checkconf</strong></span> can be run
51*00b67f09SDavid van Moolenbroek      on these files explicitly, however.
52*00b67f09SDavid van Moolenbroek    </p>
53*00b67f09SDavid van Moolenbroek</div>
54*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
55*00b67f09SDavid van Moolenbroek<a name="id2543460"></a><h2>OPTIONS</h2>
56*00b67f09SDavid van Moolenbroek<div class="variablelist"><dl>
57*00b67f09SDavid van Moolenbroek<dt><span class="term">-h</span></dt>
58*00b67f09SDavid van Moolenbroek<dd><p>
59*00b67f09SDavid van Moolenbroek            Print the usage summary and exit.
60*00b67f09SDavid van Moolenbroek          </p></dd>
61*00b67f09SDavid van Moolenbroek<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
62*00b67f09SDavid van Moolenbroek<dd><p>
63*00b67f09SDavid van Moolenbroek            Chroot to <code class="filename">directory</code> so that include
64*00b67f09SDavid van Moolenbroek            directives in the configuration file are processed as if
65*00b67f09SDavid van Moolenbroek            run by a similarly chrooted named.
66*00b67f09SDavid van Moolenbroek          </p></dd>
67*00b67f09SDavid van Moolenbroek<dt><span class="term">-v</span></dt>
68*00b67f09SDavid van Moolenbroek<dd><p>
69*00b67f09SDavid van Moolenbroek            Print the version of the <span><strong class="command">named-checkconf</strong></span>
70*00b67f09SDavid van Moolenbroek            program and exit.
71*00b67f09SDavid van Moolenbroek          </p></dd>
72*00b67f09SDavid van Moolenbroek<dt><span class="term">-p</span></dt>
73*00b67f09SDavid van Moolenbroek<dd><p>
74*00b67f09SDavid van Moolenbroek	    Print out the <code class="filename">named.conf</code> and included files
75*00b67f09SDavid van Moolenbroek	    in canonical form if no errors were detected.
76*00b67f09SDavid van Moolenbroek          </p></dd>
77*00b67f09SDavid van Moolenbroek<dt><span class="term">-x</span></dt>
78*00b67f09SDavid van Moolenbroek<dd><p>
79*00b67f09SDavid van Moolenbroek	    When printing the configuration files in canonical
80*00b67f09SDavid van Moolenbroek            form, obscure shared secrets by replacing them with
81*00b67f09SDavid van Moolenbroek            strings of question marks ('?'). This allows the
82*00b67f09SDavid van Moolenbroek            contents of <code class="filename">named.conf</code> and related
83*00b67f09SDavid van Moolenbroek            files to be shared &#8212; for example, when submitting
84*00b67f09SDavid van Moolenbroek            bug reports &#8212; without compromising private data.
85*00b67f09SDavid van Moolenbroek            This option cannot be used without <code class="option">-p</code>.
86*00b67f09SDavid van Moolenbroek          </p></dd>
87*00b67f09SDavid van Moolenbroek<dt><span class="term">-z</span></dt>
88*00b67f09SDavid van Moolenbroek<dd><p>
89*00b67f09SDavid van Moolenbroek	    Perform a test load of all master zones found in
90*00b67f09SDavid van Moolenbroek	    <code class="filename">named.conf</code>.
91*00b67f09SDavid van Moolenbroek          </p></dd>
92*00b67f09SDavid van Moolenbroek<dt><span class="term">-j</span></dt>
93*00b67f09SDavid van Moolenbroek<dd><p>
94*00b67f09SDavid van Moolenbroek            When loading a zonefile read the journal if it exists.
95*00b67f09SDavid van Moolenbroek          </p></dd>
96*00b67f09SDavid van Moolenbroek<dt><span class="term">filename</span></dt>
97*00b67f09SDavid van Moolenbroek<dd><p>
98*00b67f09SDavid van Moolenbroek            The name of the configuration file to be checked.  If not
99*00b67f09SDavid van Moolenbroek            specified, it defaults to <code class="filename">/etc/named.conf</code>.
100*00b67f09SDavid van Moolenbroek          </p></dd>
101*00b67f09SDavid van Moolenbroek</dl></div>
102*00b67f09SDavid van Moolenbroek</div>
103*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
104*00b67f09SDavid van Moolenbroek<a name="id2543604"></a><h2>RETURN VALUES</h2>
105*00b67f09SDavid van Moolenbroek<p><span><strong class="command">named-checkconf</strong></span>
106*00b67f09SDavid van Moolenbroek      returns an exit status of 1 if
107*00b67f09SDavid van Moolenbroek      errors were detected and 0 otherwise.
108*00b67f09SDavid van Moolenbroek    </p>
109*00b67f09SDavid van Moolenbroek</div>
110*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
111*00b67f09SDavid van Moolenbroek<a name="id2543616"></a><h2>SEE ALSO</h2>
112*00b67f09SDavid van Moolenbroek<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
113*00b67f09SDavid van Moolenbroek      <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
114*00b67f09SDavid van Moolenbroek      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
115*00b67f09SDavid van Moolenbroek    </p>
116*00b67f09SDavid van Moolenbroek</div>
117*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
118*00b67f09SDavid van Moolenbroek<a name="id2543645"></a><h2>AUTHOR</h2>
119*00b67f09SDavid van Moolenbroek<p><span class="corpauthor">Internet Systems Consortium</span>
120*00b67f09SDavid van Moolenbroek    </p>
121*00b67f09SDavid van Moolenbroek</div>
122*00b67f09SDavid van Moolenbroek</div></body>
123*00b67f09SDavid van Moolenbroek</html>
124