xref: /minix3/external/bsd/bind/dist/doc/arm/man.named-checkconf.html (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1*00b67f09SDavid van Moolenbroek<!--
2*00b67f09SDavid van Moolenbroek - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
3*00b67f09SDavid van Moolenbroek - Copyright (C) 2000-2003 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: man.named-checkconf.html,v 1.5 2015/09/03 07:33:34 christos Exp $ -->
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<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
24*00b67f09SDavid van Moolenbroek<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
25*00b67f09SDavid van Moolenbroek<link rel="prev" href="man.dnssec-verify.html" title="dnssec-verify">
26*00b67f09SDavid van Moolenbroek<link rel="next" href="man.named-checkzone.html" title="named-checkzone">
27*00b67f09SDavid van Moolenbroek</head>
28*00b67f09SDavid van Moolenbroek<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
29*00b67f09SDavid van Moolenbroek<div class="navheader">
30*00b67f09SDavid van Moolenbroek<table width="100%" summary="Navigation header">
31*00b67f09SDavid van Moolenbroek<tr><th colspan="3" align="center"><span class="application">named-checkconf</span></th></tr>
32*00b67f09SDavid van Moolenbroek<tr>
33*00b67f09SDavid van Moolenbroek<td width="20%" align="left">
34*00b67f09SDavid van Moolenbroek<a accesskey="p" href="man.dnssec-verify.html">Prev</a>�</td>
35*00b67f09SDavid van Moolenbroek<th width="60%" align="center">Manual pages</th>
36*00b67f09SDavid van Moolenbroek<td width="20%" align="right">�<a accesskey="n" href="man.named-checkzone.html">Next</a>
37*00b67f09SDavid van Moolenbroek</td>
38*00b67f09SDavid van Moolenbroek</tr>
39*00b67f09SDavid van Moolenbroek</table>
40*00b67f09SDavid van Moolenbroek<hr>
41*00b67f09SDavid van Moolenbroek</div>
42*00b67f09SDavid van Moolenbroek<div class="refentry" lang="en">
43*00b67f09SDavid van Moolenbroek<a name="man.named-checkconf"></a><div class="titlepage"></div>
44*00b67f09SDavid van Moolenbroek<div class="refnamediv">
45*00b67f09SDavid van Moolenbroek<h2>Name</h2>
46*00b67f09SDavid van Moolenbroek<p><span class="application">named-checkconf</span> &#8212; named configuration file syntax checking tool</p>
47*00b67f09SDavid van Moolenbroek</div>
48*00b67f09SDavid van Moolenbroek<div class="refsynopsisdiv">
49*00b67f09SDavid van Moolenbroek<h2>Synopsis</h2>
50*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>
51*00b67f09SDavid van Moolenbroek</div>
52*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
53*00b67f09SDavid van Moolenbroek<a name="id2643746"></a><h2>DESCRIPTION</h2>
54*00b67f09SDavid van Moolenbroek<p><span><strong class="command">named-checkconf</strong></span>
55*00b67f09SDavid van Moolenbroek      checks the syntax, but not the semantics, of a
56*00b67f09SDavid van Moolenbroek      <span><strong class="command">named</strong></span> configuration file.  The file is parsed
57*00b67f09SDavid van Moolenbroek      and checked for syntax errors, along with all files included by it.
58*00b67f09SDavid van Moolenbroek      If no file is specified, <code class="filename">/etc/named.conf</code> is read
59*00b67f09SDavid van Moolenbroek      by default.
60*00b67f09SDavid van Moolenbroek    </p>
61*00b67f09SDavid van Moolenbroek<p>
62*00b67f09SDavid van Moolenbroek      Note: files that <span><strong class="command">named</strong></span> reads in separate
63*00b67f09SDavid van Moolenbroek      parser contexts, such as <code class="filename">rndc.key</code> and
64*00b67f09SDavid van Moolenbroek      <code class="filename">bind.keys</code>, are not automatically read
65*00b67f09SDavid van Moolenbroek      by <span><strong class="command">named-checkconf</strong></span>.  Configuration
66*00b67f09SDavid van Moolenbroek      errors in these files may cause <span><strong class="command">named</strong></span> to
67*00b67f09SDavid van Moolenbroek      fail to run, even if <span><strong class="command">named-checkconf</strong></span> was
68*00b67f09SDavid van Moolenbroek      successful.  <span><strong class="command">named-checkconf</strong></span> can be run
69*00b67f09SDavid van Moolenbroek      on these files explicitly, however.
70*00b67f09SDavid van Moolenbroek    </p>
71*00b67f09SDavid van Moolenbroek</div>
72*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
73*00b67f09SDavid van Moolenbroek<a name="id2643816"></a><h2>OPTIONS</h2>
74*00b67f09SDavid van Moolenbroek<div class="variablelist"><dl>
75*00b67f09SDavid van Moolenbroek<dt><span class="term">-h</span></dt>
76*00b67f09SDavid van Moolenbroek<dd><p>
77*00b67f09SDavid van Moolenbroek            Print the usage summary and exit.
78*00b67f09SDavid van Moolenbroek          </p></dd>
79*00b67f09SDavid van Moolenbroek<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
80*00b67f09SDavid van Moolenbroek<dd><p>
81*00b67f09SDavid van Moolenbroek            Chroot to <code class="filename">directory</code> so that include
82*00b67f09SDavid van Moolenbroek            directives in the configuration file are processed as if
83*00b67f09SDavid van Moolenbroek            run by a similarly chrooted named.
84*00b67f09SDavid van Moolenbroek          </p></dd>
85*00b67f09SDavid van Moolenbroek<dt><span class="term">-v</span></dt>
86*00b67f09SDavid van Moolenbroek<dd><p>
87*00b67f09SDavid van Moolenbroek            Print the version of the <span><strong class="command">named-checkconf</strong></span>
88*00b67f09SDavid van Moolenbroek            program and exit.
89*00b67f09SDavid van Moolenbroek          </p></dd>
90*00b67f09SDavid van Moolenbroek<dt><span class="term">-p</span></dt>
91*00b67f09SDavid van Moolenbroek<dd><p>
92*00b67f09SDavid van Moolenbroek	    Print out the <code class="filename">named.conf</code> and included files
93*00b67f09SDavid van Moolenbroek	    in canonical form if no errors were detected.
94*00b67f09SDavid van Moolenbroek          </p></dd>
95*00b67f09SDavid van Moolenbroek<dt><span class="term">-x</span></dt>
96*00b67f09SDavid van Moolenbroek<dd><p>
97*00b67f09SDavid van Moolenbroek	    When printing the configuration files in canonical
98*00b67f09SDavid van Moolenbroek            form, obscure shared secrets by replacing them with
99*00b67f09SDavid van Moolenbroek            strings of question marks ('?'). This allows the
100*00b67f09SDavid van Moolenbroek            contents of <code class="filename">named.conf</code> and related
101*00b67f09SDavid van Moolenbroek            files to be shared &#8212; for example, when submitting
102*00b67f09SDavid van Moolenbroek            bug reports &#8212; without compromising private data.
103*00b67f09SDavid van Moolenbroek            This option cannot be used without <code class="option">-p</code>.
104*00b67f09SDavid van Moolenbroek          </p></dd>
105*00b67f09SDavid van Moolenbroek<dt><span class="term">-z</span></dt>
106*00b67f09SDavid van Moolenbroek<dd><p>
107*00b67f09SDavid van Moolenbroek	    Perform a test load of all master zones found in
108*00b67f09SDavid van Moolenbroek	    <code class="filename">named.conf</code>.
109*00b67f09SDavid van Moolenbroek          </p></dd>
110*00b67f09SDavid van Moolenbroek<dt><span class="term">-j</span></dt>
111*00b67f09SDavid van Moolenbroek<dd><p>
112*00b67f09SDavid van Moolenbroek            When loading a zonefile read the journal if it exists.
113*00b67f09SDavid van Moolenbroek          </p></dd>
114*00b67f09SDavid van Moolenbroek<dt><span class="term">filename</span></dt>
115*00b67f09SDavid van Moolenbroek<dd><p>
116*00b67f09SDavid van Moolenbroek            The name of the configuration file to be checked.  If not
117*00b67f09SDavid van Moolenbroek            specified, it defaults to <code class="filename">/etc/named.conf</code>.
118*00b67f09SDavid van Moolenbroek          </p></dd>
119*00b67f09SDavid van Moolenbroek</dl></div>
120*00b67f09SDavid van Moolenbroek</div>
121*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
122*00b67f09SDavid van Moolenbroek<a name="id2644177"></a><h2>RETURN VALUES</h2>
123*00b67f09SDavid van Moolenbroek<p><span><strong class="command">named-checkconf</strong></span>
124*00b67f09SDavid van Moolenbroek      returns an exit status of 1 if
125*00b67f09SDavid van Moolenbroek      errors were detected and 0 otherwise.
126*00b67f09SDavid van Moolenbroek    </p>
127*00b67f09SDavid van Moolenbroek</div>
128*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
129*00b67f09SDavid van Moolenbroek<a name="id2644190"></a><h2>SEE ALSO</h2>
130*00b67f09SDavid van Moolenbroek<p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
131*00b67f09SDavid van Moolenbroek      <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
132*00b67f09SDavid van Moolenbroek      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
133*00b67f09SDavid van Moolenbroek    </p>
134*00b67f09SDavid van Moolenbroek</div>
135*00b67f09SDavid van Moolenbroek<div class="refsect1" lang="en">
136*00b67f09SDavid van Moolenbroek<a name="id2644220"></a><h2>AUTHOR</h2>
137*00b67f09SDavid van Moolenbroek<p><span class="corpauthor">Internet Systems Consortium</span>
138*00b67f09SDavid van Moolenbroek    </p>
139*00b67f09SDavid van Moolenbroek</div>
140*00b67f09SDavid van Moolenbroek</div>
141*00b67f09SDavid van Moolenbroek<div class="navfooter">
142*00b67f09SDavid van Moolenbroek<hr>
143*00b67f09SDavid van Moolenbroek<table width="100%" summary="Navigation footer">
144*00b67f09SDavid van Moolenbroek<tr>
145*00b67f09SDavid van Moolenbroek<td width="40%" align="left">
146*00b67f09SDavid van Moolenbroek<a accesskey="p" href="man.dnssec-verify.html">Prev</a>�</td>
147*00b67f09SDavid van Moolenbroek<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
148*00b67f09SDavid van Moolenbroek<td width="40%" align="right">�<a accesskey="n" href="man.named-checkzone.html">Next</a>
149*00b67f09SDavid van Moolenbroek</td>
150*00b67f09SDavid van Moolenbroek</tr>
151*00b67f09SDavid van Moolenbroek<tr>
152*00b67f09SDavid van Moolenbroek<td width="40%" align="left" valign="top">
153*00b67f09SDavid van Moolenbroek<span class="application">dnssec-verify</span>�</td>
154*00b67f09SDavid van Moolenbroek<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
155*00b67f09SDavid van Moolenbroek<td width="40%" align="right" valign="top">�<span class="application">named-checkzone</span>
156*00b67f09SDavid van Moolenbroek</td>
157*00b67f09SDavid van Moolenbroek</tr>
158*00b67f09SDavid van Moolenbroek</table>
159*00b67f09SDavid van Moolenbroek</div>
160*00b67f09SDavid van Moolenbroek<p style="text-align: center;">BIND 9.10.2-P4</p>
161*00b67f09SDavid van Moolenbroek</body>
162*00b67f09SDavid van Moolenbroek</html>
163