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

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004, 2005, 2007, 2009, 2014  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000-2002  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and/or distribute this software for any
   9  - purpose with or without fee is hereby granted, provided that the above
  10  - copyright notice and this permission notice appear in all copies.
  11  -
  12  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18  - PERFORMANCE OF THIS SOFTWARE.
  19 -->
  20
  21 <!-- $Id: named-checkconf.docbook,v 1.22 2009/12/28 23:21:16 each Exp $ -->
  22 <refentry id="man.named-checkconf">
  23   <refentryinfo>
  24     <date>June 14, 2000</date>
  25   </refentryinfo>
  26
  27   <refmeta>
  28     <refentrytitle><application>named-checkconf</application></refentrytitle>
  29     <manvolnum>8</manvolnum>
  30     <refmiscinfo>BIND9</refmiscinfo>
  31   </refmeta>
  32
  33   <docinfo>
  34     <copyright>
  35       <year>2004</year>
  36       <year>2005</year>
  37       <year>2007</year>
  38       <year>2009</year>
  39       <year>2014</year>
  40       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  41     </copyright>
  42     <copyright>
  43       <year>2000</year>
  44       <year>2001</year>
  45       <year>2002</year>
  46       <holder>Internet Software Consortium.</holder>
  47     </copyright>
  48   </docinfo>
  49
  50   <refnamediv>
  51     <refname><application>named-checkconf</application></refname>
  52     <refpurpose>named configuration file syntax checking tool</refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>named-checkconf</command>
  58       <arg><option>-h</option></arg>
  59       <arg><option>-v</option></arg>
  60       <arg><option>-j</option></arg>
  61       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  62       <arg choice="req">filename</arg>
  63       <arg><option>-p</option></arg>
  64       <arg><option>-x</option></arg>
  65       <arg><option>-z</option></arg>
  66     </cmdsynopsis>
  67   </refsynopsisdiv>
  68
  69   <refsect1>
  70     <title>DESCRIPTION</title>
  71     <para><command>named-checkconf</command>
  72       checks the syntax, but not the semantics, of a
  73       <command>named</command> configuration file.  The file is parsed
  74       and checked for syntax errors, along with all files included by it.
  75       If no file is specified, <filename>/etc/named.conf</filename> is read
  76       by default.
  77     </para>
  78     <para>
  79       Note: files that <command>named</command> reads in separate
  80       parser contexts, such as <filename>rndc.key</filename> and
  81       <filename>bind.keys</filename>, are not automatically read
  82       by <command>named-checkconf</command>.  Configuration
  83       errors in these files may cause <command>named</command> to
  84       fail to run, even if <command>named-checkconf</command> was
  85       successful.  <command>named-checkconf</command> can be run
  86       on these files explicitly, however.
  87     </para>
  88   </refsect1>
  89
  90   <refsect1>
  91     <title>OPTIONS</title>
  92
  93     <variablelist>
  94       <varlistentry>
  95         <term>-h</term>
  96         <listitem>
  97           <para>
  98             Print the usage summary and exit.
  99           </para>
 100         </listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term>-t <replaceable class="parameter">directory</replaceable></term>
 105         <listitem>
 106           <para>
 107             Chroot to <filename>directory</filename> so that include
 108             directives in the configuration file are processed as if
 109             run by a similarly chrooted named.
 110           </para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term>-v</term>
 116         <listitem>
 117           <para>
 118             Print the version of the <command>named-checkconf</command>
 119             program and exit.
 120           </para>
 121         </listitem>
 122       </varlistentry>
 123
 124       <varlistentry>
 125         <term>-p</term>
 126         <listitem>
 127           <para>
 128             Print out the <filename>named.conf</filename> and included files
 129             in canonical form if no errors were detected.
 130           </para>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term>-x</term>
 136         <listitem>
 137           <para>
 138             When printing the configuration files in canonical
 139             form, obscure shared secrets by replacing them with
 140             strings of question marks ('?'). This allows the
 141             contents of <filename>named.conf</filename> and related
 142             files to be shared &mdash; for example, when submitting
 143             bug reports &mdash; without compromising private data.
 144             This option cannot be used without <option>-p</option>.
 145           </para>
 146         </listitem>
 147       </varlistentry>
 148
 149       <varlistentry>
 150         <term>-z</term>
 151         <listitem>
 152           <para>
 153             Perform a test load of all master zones found in
 154             <filename>named.conf</filename>.
 155           </para>
 156         </listitem>
 157       </varlistentry>
 158
 159       <varlistentry>
 160         <term>-j</term>
 161         <listitem>
 162           <para>
 163             When loading a zonefile read the journal if it exists.
 164           </para>
 165         </listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term>filename</term>
 170         <listitem>
 171           <para>
 172             The name of the configuration file to be checked.  If not
 173             specified, it defaults to <filename>/etc/named.conf</filename>.
 174           </para>
 175         </listitem>
 176       </varlistentry>
 177
 178     </variablelist>
 179
 180   </refsect1>
 181
 182   <refsect1>
 183     <title>RETURN VALUES</title>
 184     <para><command>named-checkconf</command>
 185       returns an exit status of 1 if
 186       errors were detected and 0 otherwise.
 187     </para>
 188   </refsect1>
 189
 190   <refsect1>
 191     <title>SEE ALSO</title>
 192     <para><citerefentry>
 193         <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
 194       </citerefentry>,
 195       <citerefentry>
 196         <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
 197       </citerefentry>,
 198       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 199     </para>
 200   </refsect1>
 201
 202   <refsect1>
 203     <title>AUTHOR</title>
 204     <para><corpauthor>Internet Systems Consortium</corpauthor>
 205     </para>
 206   </refsect1>
 207
 208 </refentry><!--
 209  - Local variables:
 210  - mode: sgml
 211  - End:
 212 -->