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  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.8.18.10 2007/08/28 07:19:55 tbox 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       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  39     </copyright>
  40     <copyright>
  41       <year>2000</year>
  42       <year>2001</year>
  43       <year>2002</year>
  44       <holder>Internet Software Consortium.</holder>
  45     </copyright>
  46   </docinfo>
  47
  48   <refnamediv>
  49     <refname><application>named-checkconf</application></refname>
  50     <refpurpose>named configuration file syntax checking tool</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <cmdsynopsis>
  55       <command>named-checkconf</command>
  56       <arg><option>-v</option></arg>
  57       <arg><option>-j</option></arg>
  58       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  59       <arg choice="req">filename</arg>
  60       <arg><option>-z</option></arg>
  61     </cmdsynopsis>
  62   </refsynopsisdiv>
  63
  64   <refsect1>
  65     <title>DESCRIPTION</title>
  66     <para><command>named-checkconf</command>
  67       checks the syntax, but not the semantics, of a named
  68       configuration file.
  69     </para>
  70   </refsect1>
  71
  72   <refsect1>
  73     <title>OPTIONS</title>
  74
  75     <variablelist>
  76       <varlistentry>
  77         <term>-t <replaceable class="parameter">directory</replaceable></term>
  78         <listitem>
  79           <para>
  80             Chroot to <filename>directory</filename> so that
  81             include
  82             directives in the configuration file are processed as if
  83             run by a similarly chrooted named.
  84           </para>
  85         </listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term>-v</term>
  90         <listitem>
  91           <para>
  92             Print the version of the <command>named-checkconf</command>
  93             program and exit.
  94           </para>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term>-z</term>
 100         <listitem>
 101           <para>
 102             Perform a test load of all master zones found in
 103             <filename>named.conf</filename>.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>-j</term>
 110         <listitem>
 111           <para>
 112             When loading a zonefile read the journal if it exists.
 113           </para>
 114         </listitem>
 115       </varlistentry>
 116
 117       <varlistentry>
 118         <term>filename</term>
 119         <listitem>
 120           <para>
 121             The name of the configuration file to be checked.  If not
 122             specified, it defaults to <filename>/etc/named.conf</filename>.
 123           </para>
 124         </listitem>
 125       </varlistentry>
 126
 127     </variablelist>
 128
 129   </refsect1>
 130
 131   <refsect1>
 132     <title>RETURN VALUES</title>
 133     <para><command>named-checkconf</command>
 134       returns an exit status of 1 if
 135       errors were detected and 0 otherwise.
 136     </para>
 137   </refsect1>
 138
 139   <refsect1>
 140     <title>SEE ALSO</title>
 141     <para><citerefentry>
 142         <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
 143       </citerefentry>,
 144       <citerefentry>
 145         <refentrytitle>named-checkzone</refentrytitle><manvolnum>8</manvolnum>
 146       </citerefentry>,
 147       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 148     </para>
 149   </refsect1>
 150
 151   <refsect1>
 152     <title>AUTHOR</title>
 153     <para><corpauthor>Internet Systems Consortium</corpauthor>
 154     </para>
 155   </refsect1>
 156
 157 </refentry><!--
 158  - Local variables:
 159  - mode: sgml
 160  - End:
 161 -->