man.named-checkconf.html 7.26 KB
Newer Older
Tinderbox User's avatar
Tinderbox User committed
1 2
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--
Tinderbox User's avatar
Tinderbox User committed
3
 - Copyright (C) 2000-2019 Internet Systems Consortium, Inc. ("ISC")
Tinderbox User's avatar
Tinderbox User committed
4 5 6 7 8 9 10 11 12
 - 
 - 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/.
-->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>named-checkconf</title>
Tinderbox User's avatar
Tinderbox User committed
13
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
Tinderbox User's avatar
Tinderbox User committed
14
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
15
<link rel="up" href="Bv9ARM.ch12.html" title="Manual pages">
16
<link rel="prev" href="man.mdig.html" title="mdig">
Tinderbox User's avatar
Tinderbox User committed
17 18 19 20 21 22 23 24
<link rel="next" href="man.named-checkzone.html" title="named-checkzone">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center"><span class="application">named-checkconf</span></th></tr>
<tr>
<td width="20%" align="left">
25
<a accesskey="p" href="man.mdig.html">Prev</a></td>
Tinderbox User's avatar
Tinderbox User committed
26 27 28 29 30 31 32 33 34
<th width="60%" align="center">Manual pages</th>
<td width="20%" align="right"><a accesskey="n" href="man.named-checkzone.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="refentry">
<a name="man.named-checkconf"></a><div class="titlepage"></div>
Tinderbox User's avatar
Tinderbox User committed
35 36 37 38 39 40 41 42
  
  

  

  

  <div class="refnamediv">
Tinderbox User's avatar
Tinderbox User committed
43
<h2>Name</h2>
Tinderbox User's avatar
Tinderbox User committed
44 45 46 47
<p>
    <span class="application">named-checkconf</span>
     &#8212; named configuration file syntax checking tool
  </p>
Tinderbox User's avatar
Tinderbox User committed
48
</div>
Tinderbox User's avatar
Tinderbox User committed
49 50

  <div class="refsynopsisdiv">
Tinderbox User's avatar
Tinderbox User committed
51
<h2>Synopsis</h2>
Tinderbox User's avatar
Tinderbox User committed
52 53
    <div class="cmdsynopsis"><p>
      <code class="command">named-checkconf</code> 
Tinderbox User's avatar
Tinderbox User committed
54
       [<code class="option">-chjlvz</code>]
Tinderbox User's avatar
Tinderbox User committed
55
       [<code class="option">-p</code>
Tinderbox User's avatar
Tinderbox User committed
56
	 [<code class="option">-x</code>
Tinderbox User's avatar
Tinderbox User committed
57 58 59 60 61 62 63
      ]]
       [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>]
       {filename}
    </p></div>
  </div>

  <div class="refsection">
Tinderbox User's avatar
Tinderbox User committed
64
<a name="id-1.13.22.7"></a><h2>DESCRIPTION</h2>
Tinderbox User's avatar
Tinderbox User committed
65 66

    <p><span class="command"><strong>named-checkconf</strong></span>
Tinderbox User's avatar
Tinderbox User committed
67 68 69 70 71 72
      checks the syntax, but not the semantics, of a
      <span class="command"><strong>named</strong></span> configuration file.  The file is parsed
      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>
Tinderbox User's avatar
Tinderbox User committed
73
    <p>
Tinderbox User's avatar
Tinderbox User committed
74 75 76 77 78 79 80 81 82
      Note: files that <span class="command"><strong>named</strong></span> reads in separate
      parser contexts, such as <code class="filename">rndc.key</code> and
      <code class="filename">bind.keys</code>, are not automatically read
      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
      on these files explicitly, however.
    </p>
Tinderbox User's avatar
Tinderbox User committed
83 84 85
  </div>

  <div class="refsection">
Tinderbox User's avatar
Tinderbox User committed
86
<a name="id-1.13.22.8"></a><h2>OPTIONS</h2>
Tinderbox User's avatar
Tinderbox User committed
87 88

    <div class="variablelist"><dl class="variablelist">
Tinderbox User's avatar
Tinderbox User committed
89
<dt><span class="term">-h</span></dt>
Tinderbox User's avatar
Tinderbox User committed
90 91
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
92
            Print the usage summary and exit.
Tinderbox User's avatar
Tinderbox User committed
93 94
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
95
<dt><span class="term">-j</span></dt>
Tinderbox User's avatar
Tinderbox User committed
96 97
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
98
            When loading a zonefile read the journal if it exists.
Tinderbox User's avatar
Tinderbox User committed
99 100
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
101
<dt><span class="term">-l</span></dt>
Tinderbox User's avatar
Tinderbox User committed
102 103
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
104 105 106
            List all the configured zones. Each line of output
            contains the zone name, class (e.g. IN), view, and type
            (e.g. master or slave).
Tinderbox User's avatar
Tinderbox User committed
107 108
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
109 110 111 112 113 114 115 116
<dt><span class="term">-c</span></dt>
<dd>
          <p>
	    Check "core" configuration only. This suppresses the loading
	    of plugin modules, and causes all parameters to
	    <span class="command"><strong>plugin</strong></span> statements to be ignored.
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
117
<dt><span class="term">-p</span></dt>
Tinderbox User's avatar
Tinderbox User committed
118 119
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
120 121 122
	    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.
Tinderbox User's avatar
Tinderbox User committed
123 124
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
125
<dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
Tinderbox User's avatar
Tinderbox User committed
126 127
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
128 129 130
            Chroot to <code class="filename">directory</code> so that include
            directives in the configuration file are processed as if
            run by a similarly chrooted <span class="command"><strong>named</strong></span>.
Tinderbox User's avatar
Tinderbox User committed
131 132
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
133
<dt><span class="term">-v</span></dt>
Tinderbox User's avatar
Tinderbox User committed
134 135
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
136 137
            Print the version of the <span class="command"><strong>named-checkconf</strong></span>
            program and exit.
Tinderbox User's avatar
Tinderbox User committed
138 139
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
140
<dt><span class="term">-x</span></dt>
Tinderbox User's avatar
Tinderbox User committed
141 142
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
143 144 145 146 147 148 149
	    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>.
Tinderbox User's avatar
Tinderbox User committed
150 151
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
152
<dt><span class="term">-z</span></dt>
Tinderbox User's avatar
Tinderbox User committed
153 154
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
155 156
	    Perform a test load of all master zones found in
	    <code class="filename">named.conf</code>.
Tinderbox User's avatar
Tinderbox User committed
157 158
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
159
<dt><span class="term">filename</span></dt>
Tinderbox User's avatar
Tinderbox User committed
160 161
<dd>
          <p>
Tinderbox User's avatar
Tinderbox User committed
162 163
            The name of the configuration file to be checked.  If not
            specified, it defaults to <code class="filename">/etc/named.conf</code>.
Tinderbox User's avatar
Tinderbox User committed
164 165
          </p>
        </dd>
Tinderbox User's avatar
Tinderbox User committed
166
</dl></div>
Tinderbox User's avatar
Tinderbox User committed
167 168 169 170

  </div>

  <div class="refsection">
Tinderbox User's avatar
Tinderbox User committed
171
<a name="id-1.13.22.9"></a><h2>RETURN VALUES</h2>
Tinderbox User's avatar
Tinderbox User committed
172 173

    <p><span class="command"><strong>named-checkconf</strong></span>
Tinderbox User's avatar
Tinderbox User committed
174 175 176
      returns an exit status of 1 if
      errors were detected and 0 otherwise.
    </p>
Tinderbox User's avatar
Tinderbox User committed
177 178 179
  </div>

  <div class="refsection">
Tinderbox User's avatar
Tinderbox User committed
180
<a name="id-1.13.22.10"></a><h2>SEE ALSO</h2>
Tinderbox User's avatar
Tinderbox User committed
181 182 183 184 185 186 187

    <p><span class="citerefentry">
        <span class="refentrytitle">named</span>(8)
      </span>,
      <span class="citerefentry">
        <span class="refentrytitle">named-checkzone</span>(8)
      </span>,
Tinderbox User's avatar
Tinderbox User committed
188 189
      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
    </p>
Tinderbox User's avatar
Tinderbox User committed
190
  </div>
Tinderbox User's avatar
Tinderbox User committed
191 192 193 194 195 196
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
197
<a accesskey="p" href="man.mdig.html">Prev</a></td>
198
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch12.html">Up</a></td>
Tinderbox User's avatar
Tinderbox User committed
199 200 201 202 203
<td width="40%" align="right"><a accesskey="n" href="man.named-checkzone.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
204
<span class="application">mdig</span></td>
Tinderbox User's avatar
Tinderbox User committed
205 206 207 208 209 210
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top"><span class="application">named-checkzone</span>
</td>
</tr>
</table>
</div>
Tinderbox User's avatar
Tinderbox User committed
211
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.14.1 (Stable Release)</p>
Tinderbox User's avatar
Tinderbox User committed
212 213
</body>
</html>