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

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000-2002  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and 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.3.2.1.8.7 2005/05/12 21:35:56 sra Exp $ -->
  22
  23 <refentry>
  24   <refentryinfo>
  25     <date>June 14, 2000</date>
  26   </refentryinfo>
  27
  28   <refmeta>
  29     <refentrytitle><application>named-checkconf</application></refentrytitle>
  30     <manvolnum>8</manvolnum>
  31     <refmiscinfo>BIND9</refmiscinfo>
  32   </refmeta>
  33
  34   <docinfo>
  35     <copyright>
  36       <year>2004</year>
  37       <year>2005</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>
  67         <command>named-checkconf</command> checks the syntax, but not
  68         the semantics, of a named 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 include
  81               directives in the configuration file are processed as if
  82               run by a similarly chrooted named.
  83           </para>
  84         </listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term>-v</term>
  89         <listitem>
  90           <para>
  91               Print the version of the <command>named-checkconf</command>
  92               program and exit.
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96
  97       <varlistentry>
  98         <term>-z</term>
  99         <listitem>
 100           <para>
 101               Perform a check load the master zonefiles found in
 102               <filename>named.conf</filename>.
 103           </para>
 104         </listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term>-j</term>
 109         <listitem>
 110           <para>
 111               When loading a zonefile read the journal if it exists.
 112           </para>
 113         </listitem>
 114       </varlistentry>
 115
 116       <varlistentry>
 117         <term>filename</term>
 118         <listitem>
 119           <para>
 120                The name of the configuration file to be checked.  If not
 121                specified, it defaults to <filename>/etc/named.conf</filename>.
 122           </para>
 123         </listitem>
 124       </varlistentry>
 125
 126     </variablelist>
 127
 128   </refsect1>
 129
 130   <refsect1>
 131     <title>RETURN VALUES</title>
 132     <para>
 133         <command>named-checkconf</command> returns an exit status of 1 if
 134         errors were detected and 0 otherwise.
 135     </para>
 136   </refsect1>
 137
 138   <refsect1>
 139     <title>SEE ALSO</title>
 140     <para>
 141       <citerefentry>
 142         <refentrytitle>named</refentrytitle>
 143         <manvolnum>8</manvolnum>
 144       </citerefentry>,
 145       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 146     </para>
 147   </refsect1>
 148
 149   <refsect1>
 150     <title>AUTHOR</title>
 151     <para>
 152         <corpauthor>Internet Systems Consortium</corpauthor>
 153     </para>
 154   </refsect1>
 155
 156 </refentry>
 157
 158 <!--
 159  - Local variables:
 160  - mode: sgml
 161  - End:
 162 -->
 163