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