contrib/bind9/bin/check/named-checkconf.html

   1 <!--
   2  - Copyright (C) 2004, 2005, 2007, 2009, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2002 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 </head>
  23 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
  24 <a name="man.named-checkconf"></a><div class="titlepage"></div>
  25 <div class="refnamediv">
  26 <h2>Name</h2>
  27 <p><span class="application">named-checkconf</span> &#8212; named configuration file syntax checking tool</p>
  28 </div>
  29 <div class="refsynopsisdiv">
  30 <h2>Synopsis</h2>
  31 <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>
  32 </div>
  33 <div class="refsection">
  34 <a name="id-1.7"></a><h2>DESCRIPTION</h2>
  35 <p><span class="command"><strong>named-checkconf</strong></span>
  36       checks the syntax, but not the semantics, of a
  37       <span class="command"><strong>named</strong></span> configuration file.  The file is parsed
  38       and checked for syntax errors, along with all files included by it.
  39       If no file is specified, <code class="filename">/etc/named.conf</code> is read
  40       by default.
  41     </p>
  42 <p>
  43       Note: files that <span class="command"><strong>named</strong></span> reads in separate
  44       parser contexts, such as <code class="filename">rndc.key</code> and
  45       <code class="filename">bind.keys</code>, are not automatically read
  46       by <span class="command"><strong>named-checkconf</strong></span>.  Configuration
  47       errors in these files may cause <span class="command"><strong>named</strong></span> to
  48       fail to run, even if <span class="command"><strong>named-checkconf</strong></span> was
  49       successful.  <span class="command"><strong>named-checkconf</strong></span> can be run
  50       on these files explicitly, however.
  51     </p>
  52 </div>
  53 <div class="refsection">
  54 <a name="id-1.8"></a><h2>OPTIONS</h2>
  55 <div class="variablelist"><dl class="variablelist">
  56 <dt><span class="term">-h</span></dt>
  57 <dd><p>
  58             Print the usage summary and exit.
  59           </p></dd>
  60 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
  61 <dd><p>
  62             Chroot to <code class="filename">directory</code> so that include
  63             directives in the configuration file are processed as if
  64             run by a similarly chrooted named.
  65           </p></dd>
  66 <dt><span class="term">-v</span></dt>
  67 <dd><p>
  68             Print the version of the <span class="command"><strong>named-checkconf</strong></span>
  69             program and exit.
  70           </p></dd>
  71 <dt><span class="term">-p</span></dt>
  72 <dd><p>
  73             Print out the <code class="filename">named.conf</code> and included files
  74             in canonical form if no errors were detected.
  75           </p></dd>
  76 <dt><span class="term">-x</span></dt>
  77 <dd><p>
  78             When printing the configuration files in canonical
  79             form, obscure shared secrets by replacing them with
  80             strings of question marks ('?'). This allows the
  81             contents of <code class="filename">named.conf</code> and related
  82             files to be shared &#8212; for example, when submitting
  83             bug reports &#8212; without compromising private data.
  84             This option cannot be used without <code class="option">-p</code>.
  85           </p></dd>
  86 <dt><span class="term">-z</span></dt>
  87 <dd><p>
  88             Perform a test load of all master zones found in
  89             <code class="filename">named.conf</code>.
  90           </p></dd>
  91 <dt><span class="term">-j</span></dt>
  92 <dd><p>
  93             When loading a zonefile read the journal if it exists.
  94           </p></dd>
  95 <dt><span class="term">filename</span></dt>
  96 <dd><p>
  97             The name of the configuration file to be checked.  If not
  98             specified, it defaults to <code class="filename">/etc/named.conf</code>.
  99           </p></dd>
 100 </dl></div>
 101 </div>
 102 <div class="refsection">
 103 <a name="id-1.9"></a><h2>RETURN VALUES</h2>
 104 <p><span class="command"><strong>named-checkconf</strong></span>
 105       returns an exit status of 1 if
 106       errors were detected and 0 otherwise.
 107     </p>
 108 </div>
 109 <div class="refsection">
 110 <a name="id-1.10"></a><h2>SEE ALSO</h2>
 111 <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 112       <span class="citerefentry"><span class="refentrytitle">named-checkzone</span>(8)</span>,
 113       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 114     </p>
 115 </div>
 116 </div></body>
 117 </html>