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

   1 <!--
   2  - Copyright (C) 2004-2012 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 <!-- $Id$ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>named-checkconf</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  24 <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
  25 <link rel="prev" href="man.dnssec-signzone.html" title="dnssec-signzone">
  26 <link rel="next" href="man.named-checkzone.html" title="named-checkzone">
  27 </head>
  28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  29 <div class="navheader">
  30 <table width="100%" summary="Navigation header">
  31 <tr><th colspan="3" align="center"><span class="application">named-checkconf</span></th></tr>
  32 <tr>
  33 <td width="20%" align="left">
  34 <a accesskey="p" href="man.dnssec-signzone.html">Prev</a> </td>
  35 <th width="60%" align="center">Manual pages</th>
  36 <td width="20%" align="right"> <a accesskey="n" href="man.named-checkzone.html">Next</a>
  37 </td>
  38 </tr>
  39 </table>
  40 <hr>
  41 </div>
  42 <div class="refentry" lang="en">
  43 <a name="man.named-checkconf"></a><div class="titlepage"></div>
  44 <div class="refnamediv">
  45 <h2>Name</h2>
  46 <p><span class="application">named-checkconf</span> &#8212; named configuration file syntax checking tool</p>
  47 </div>
  48 <div class="refsynopsisdiv">
  49 <h2>Synopsis</h2>
  50 <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">-z</code>]</p></div>
  51 </div>
  52 <div class="refsect1" lang="en">
  53 <a name="id2617093"></a><h2>DESCRIPTION</h2>
  54 <p><span><strong class="command">named-checkconf</strong></span>
  55       checks the syntax, but not the semantics, of a
  56       <span><strong class="command">named</strong></span> configuration file.  The file is parsed
  57       and checked for syntax errors, along with all files included by it.
  58       If no file is specified, <code class="filename">/etc/named.conf</code> is read
  59       by default.
  60     </p>
  61 <p>
  62       Note: files that <span><strong class="command">named</strong></span> reads in separate
  63       parser contexts, such as <code class="filename">rndc.key</code> and
  64       <code class="filename">bind.keys</code>, are not automatically read
  65       by <span><strong class="command">named-checkconf</strong></span>.  Configuration
  66       errors in these files may cause <span><strong class="command">named</strong></span> to
  67       fail to run, even if <span><strong class="command">named-checkconf</strong></span> was
  68       successful.  <span><strong class="command">named-checkconf</strong></span> can be run
  69       on these files explicitly, however.
  70     </p>
  71 </div>
  72 <div class="refsect1" lang="en">
  73 <a name="id2617163"></a><h2>OPTIONS</h2>
  74 <div class="variablelist"><dl>
  75 <dt><span class="term">-h</span></dt>
  76 <dd><p>
  77             Print the usage summary and exit.
  78           </p></dd>
  79 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
  80 <dd><p>
  81             Chroot to <code class="filename">directory</code> so that include
  82             directives in the configuration file are processed as if
  83             run by a similarly chrooted named.
  84           </p></dd>
  85 <dt><span class="term">-v</span></dt>
  86 <dd><p>
  87             Print the version of the <span><strong class="command">named-checkconf</strong></span>
  88             program and exit.
  89           </p></dd>
  90 <dt><span class="term">-p</span></dt>
  91 <dd><p>
  92             Print out the <code class="filename">named.conf</code> and included files
  93             in canonical form if no errors were detected.
  94           </p></dd>
  95 <dt><span class="term">-z</span></dt>
  96 <dd><p>
  97             Perform a test load of all master zones found in
  98             <code class="filename">named.conf</code>.
  99           </p></dd>
 100 <dt><span class="term">-j</span></dt>
 101 <dd><p>
 102             When loading a zonefile read the journal if it exists.
 103           </p></dd>
 104 <dt><span class="term">filename</span></dt>
 105 <dd><p>
 106             The name of the configuration file to be checked.  If not
 107             specified, it defaults to <code class="filename">/etc/named.conf</code>.
 108           </p></dd>
 109 </dl></div>
 110 </div>
 111 <div class="refsect1" lang="en">
 112 <a name="id2617298"></a><h2>RETURN VALUES</h2>
 113 <p><span><strong class="command">named-checkconf</strong></span>
 114       returns an exit status of 1 if
 115       errors were detected and 0 otherwise.
 116     </p>
 117 </div>
 118 <div class="refsect1" lang="en">
 119 <a name="id2617312"></a><h2>SEE ALSO</h2>
 120 <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 121       <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
 122       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 123     </p>
 124 </div>
 125 <div class="refsect1" lang="en">
 126 <a name="id2617341"></a><h2>AUTHOR</h2>
 127 <p><span class="corpauthor">Internet Systems Consortium</span>
 128     </p>
 129 </div>
 130 </div>
 131 <div class="navfooter">
 132 <hr>
 133 <table width="100%" summary="Navigation footer">
 134 <tr>
 135 <td width="40%" align="left">
 136 <a accesskey="p" href="man.dnssec-signzone.html">Prev</a> </td>
 137 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 138 <td width="40%" align="right"> <a accesskey="n" href="man.named-checkzone.html">Next</a>
 139 </td>
 140 </tr>
 141 <tr>
 142 <td width="40%" align="left" valign="top">
 143 <span class="application">dnssec-signzone</span> </td>
 144 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 145 <td width="40%" align="right" valign="top"> <span class="application">named-checkzone</span>
 146 </td>
 147 </tr>
 148 </table>
 149 </div>
 150 </body>
 151 </html>