contrib/bind9/doc/arm/man.named-checkconf.html

   1 <!--
   2  - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and/or distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <html>
  18 <head>
  19 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  20 <title>named-checkconf</title>
  21 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  22 <link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  23 <link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
  24 <link rel="prev" href="man.dnssec-verify.html" title="dnssec-verify">
  25 <link rel="next" href="man.named-checkzone.html" title="named-checkzone">
  26 </head>
  27 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  28 <div class="navheader">
  29 <table width="100%" summary="Navigation header">
  30 <tr><th colspan="3" align="center"><span class="application">named-checkconf</span></th></tr>
  31 <tr>
  32 <td width="20%" align="left">
  33 <a accesskey="p" href="man.dnssec-verify.html">Prev</a> </td>
  34 <th width="60%" align="center">Manual pages</th>
  35 <td width="20%" align="right"> <a accesskey="n" href="man.named-checkzone.html">Next</a>
  36 </td>
  37 </tr>
  38 </table>
  39 <hr>
  40 </div>
  41 <div class="refentry">
  42 <a name="man.named-checkconf"></a><div class="titlepage"></div>
  43 <div class="refnamediv">
  44 <h2>Name</h2>
  45 <p><span class="application">named-checkconf</span> &#8212; named configuration file syntax checking tool</p>
  46 </div>
  47 <div class="refsynopsisdiv">
  48 <h2>Synopsis</h2>
  49 <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>
  50 </div>
  51 <div class="refsection">
  52 <a name="id-1.14.14.7"></a><h2>DESCRIPTION</h2>
  53 <p><span class="command"><strong>named-checkconf</strong></span>
  54       checks the syntax, but not the semantics, of a
  55       <span class="command"><strong>named</strong></span> configuration file.  The file is parsed
  56       and checked for syntax errors, along with all files included by it.
  57       If no file is specified, <code class="filename">/etc/named.conf</code> is read
  58       by default.
  59     </p>
  60 <p>
  61       Note: files that <span class="command"><strong>named</strong></span> reads in separate
  62       parser contexts, such as <code class="filename">rndc.key</code> and
  63       <code class="filename">bind.keys</code>, are not automatically read
  64       by <span class="command"><strong>named-checkconf</strong></span>.  Configuration
  65       errors in these files may cause <span class="command"><strong>named</strong></span> to
  66       fail to run, even if <span class="command"><strong>named-checkconf</strong></span> was
  67       successful.  <span class="command"><strong>named-checkconf</strong></span> can be run
  68       on these files explicitly, however.
  69     </p>
  70 </div>
  71 <div class="refsection">
  72 <a name="id-1.14.14.8"></a><h2>OPTIONS</h2>
  73 <div class="variablelist"><dl class="variablelist">
  74 <dt><span class="term">-h</span></dt>
  75 <dd><p>
  76             Print the usage summary and exit.
  77           </p></dd>
  78 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
  79 <dd><p>
  80             Chroot to <code class="filename">directory</code> so that include
  81             directives in the configuration file are processed as if
  82             run by a similarly chrooted named.
  83           </p></dd>
  84 <dt><span class="term">-v</span></dt>
  85 <dd><p>
  86             Print the version of the <span class="command"><strong>named-checkconf</strong></span>
  87             program and exit.
  88           </p></dd>
  89 <dt><span class="term">-p</span></dt>
  90 <dd><p>
  91             Print out the <code class="filename">named.conf</code> and included files
  92             in canonical form if no errors were detected.
  93           </p></dd>
  94 <dt><span class="term">-x</span></dt>
  95 <dd><p>
  96             When printing the configuration files in canonical
  97             form, obscure shared secrets by replacing them with
  98             strings of question marks ('?'). This allows the
  99             contents of <code class="filename">named.conf</code> and related
 100             files to be shared &#8212; for example, when submitting
 101             bug reports &#8212; without compromising private data.
 102             This option cannot be used without <code class="option">-p</code>.
 103           </p></dd>
 104 <dt><span class="term">-z</span></dt>
 105 <dd><p>
 106             Perform a test load of all master zones found in
 107             <code class="filename">named.conf</code>.
 108           </p></dd>
 109 <dt><span class="term">-j</span></dt>
 110 <dd><p>
 111             When loading a zonefile read the journal if it exists.
 112           </p></dd>
 113 <dt><span class="term">filename</span></dt>
 114 <dd><p>
 115             The name of the configuration file to be checked.  If not
 116             specified, it defaults to <code class="filename">/etc/named.conf</code>.
 117           </p></dd>
 118 </dl></div>
 119 </div>
 120 <div class="refsection">
 121 <a name="id-1.14.14.9"></a><h2>RETURN VALUES</h2>
 122 <p><span class="command"><strong>named-checkconf</strong></span>
 123       returns an exit status of 1 if
 124       errors were detected and 0 otherwise.
 125     </p>
 126 </div>
 127 <div class="refsection">
 128 <a name="id-1.14.14.10"></a><h2>SEE ALSO</h2>
 129 <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 130       <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
 131       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 132     </p>
 133 </div>
 134 </div>
 135 <div class="navfooter">
 136 <hr>
 137 <table width="100%" summary="Navigation footer">
 138 <tr>
 139 <td width="40%" align="left">
 140 <a accesskey="p" href="man.dnssec-verify.html">Prev</a> </td>
 141 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
 142 <td width="40%" align="right"> <a accesskey="n" href="man.named-checkzone.html">Next</a>
 143 </td>
 144 </tr>
 145 <tr>
 146 <td width="40%" align="left" valign="top">
 147 <span class="application">dnssec-verify</span> </td>
 148 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 149 <td width="40%" align="right" valign="top"> <span class="application">named-checkzone</span>
 150 </td>
 151 </tr>
 152 </table>
 153 </div>
 154 <p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.9.9-P4 (Extended Support Version)</p>
 155 </body>
 156 </html>