contrib/bind9/bin/check/named-checkzone.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-2007  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000-2003  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-checkzone.docbook,v 1.3.2.2.8.19 2007/08/28 07:19:07 tbox Exp $ -->
  22
  23 <refentry>
  24   <refentryinfo>
  25     <date>June 13, 2000</date>
  26   </refentryinfo>
  27
  28   <refmeta>
  29     <refentrytitle><application>named-checkzone</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       <year>2006</year>
  39       <year>2007</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       <year>2003</year>
  47       <holder>Internet Software Consortium.</holder>
  48     </copyright>
  49   </docinfo>
  50
  51   <refnamediv>
  52     <refname><application>named-checkzone</application></refname>
  53     <refpurpose>zone file validity checking tool</refpurpose>
  54   </refnamediv>
  55
  56   <refsynopsisdiv>
  57     <cmdsynopsis>
  58       <command>named-checkzone</command>
  59       <arg><option>-d</option></arg>
  60       <arg><option>-j</option></arg>
  61       <arg><option>-q</option></arg>
  62       <arg><option>-v</option></arg>
  63       <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
  64       <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
  65       <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
  66       <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
  67       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  68       <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
  69       <arg><option>-D</option></arg>
  70       <arg choice="req">zonename</arg>
  71       <arg choice="req">filename</arg>
  72     </cmdsynopsis>
  73   </refsynopsisdiv>
  74
  75   <refsect1>
  76     <title>DESCRIPTION</title>
  77     <para>
  78         <command>named-checkzone</command> checks the syntax and integrity of
  79         a zone file.  It performs the same checks as <command>named</command>
  80         does when loading a zone.  This makes
  81         <command>named-checkzone</command> useful for checking zone
  82         files before configuring them into a name server.
  83     </para>
  84   </refsect1>
  85
  86   <refsect1>
  87     <title>OPTIONS</title>
  88
  89     <variablelist>
  90       <varlistentry>
  91         <term>-d</term>
  92         <listitem>
  93           <para>
  94               Enable debugging.
  95           </para>
  96         </listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term>-q</term>
 101         <listitem>
 102           <para>
 103               Quiet mode - exit code only.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>-v</term>
 110         <listitem>
 111           <para>
 112               Print the version of the <command>named-checkzone</command>
 113               program and exit.
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117
 118       <varlistentry>
 119         <term>-j</term>
 120         <listitem>
 121           <para>
 122               When loading the zone file read the journal if it exists.
 123           </para>
 124         </listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term>-c <replaceable class="parameter">class</replaceable></term>
 129         <listitem>
 130           <para>
 131               Specify the class of the zone.  If not specified "IN" is assumed.
 132           </para>
 133         </listitem>
 134       </varlistentry>
 135
 136       <varlistentry>
 137         <term>-k <replaceable class="parameter">mode</replaceable></term>
 138         <listitem>
 139           <para>
 140               Perform <command>"check-names"</command> checks with the specified failure mode.
 141               Possible modes are <command>"fail"</command>,
 142               <command>"warn"</command> (default) and
 143               <command>"ignore"</command>.
 144           </para>
 145         </listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term>-n <replaceable class="parameter">mode</replaceable></term>
 150         <listitem>
 151           <para>
 152               Specify whether NS records should be checked to see if they
 153               are addresses.  Possible modes are <command>"fail"</command>,
 154               <command>"warn"</command> (default) and
 155               <command>"ignore"</command>.
 156           </para>
 157         </listitem>
 158       </varlistentry>
 159
 160       <varlistentry>
 161         <term>-o <replaceable class="parameter">filename</replaceable></term>
 162         <listitem>
 163           <para>
 164               Write zone output to <filename>filename</filename>.
 165           </para>
 166         </listitem>
 167       </varlistentry>
 168
 169       <varlistentry>
 170         <term>-t <replaceable class="parameter">directory</replaceable></term>
 171         <listitem>
 172           <para>
 173               Chroot to <filename>directory</filename> so that include
 174               directives in the configuration file are processed as if
 175               run by a similarly chrooted named.
 176           </para>
 177         </listitem>
 178       </varlistentry>
 179
 180       <varlistentry>
 181         <term>-w <replaceable class="parameter">directory</replaceable></term>
 182         <listitem>
 183           <para>
 184               chdir to <filename>directory</filename> so that relative
 185               filenames in master file $INCLUDE directives work.  This
 186               is similar to the directory clause in
 187               <filename>named.conf</filename>.
 188           </para>
 189         </listitem>
 190       </varlistentry>
 191
 192       <varlistentry>
 193         <term>-D</term>
 194         <listitem>
 195           <para>
 196               Dump zone file in canonical format.
 197           </para>
 198         </listitem>
 199       </varlistentry>
 200
 201       <varlistentry>
 202         <term>zonename</term>
 203         <listitem>
 204           <para>
 205                The domain name of the zone being checked.
 206           </para>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry>
 211         <term>filename</term>
 212         <listitem>
 213           <para>
 214                The name of the zone file.
 215           </para>
 216         </listitem>
 217       </varlistentry>
 218
 219     </variablelist>
 220
 221   </refsect1>
 222
 223   <refsect1>
 224     <title>RETURN VALUES</title>
 225     <para>
 226         <command>named-checkzone</command> returns an exit status of 1 if
 227         errors were detected and 0 otherwise.
 228     </para>
 229   </refsect1>
 230
 231   <refsect1>
 232     <title>SEE ALSO</title>
 233     <para>
 234       <citerefentry>
 235         <refentrytitle>named</refentrytitle>
 236         <manvolnum>8</manvolnum>
 237       </citerefentry>,
 238       <citerefentry>
 239         <refentrytitle>named-checkconf</refentrytitle><manvolnum>8</manvolnum>
 240       </citerefentry>,
 241       <citetitle>RFC 1035</citetitle>,
 242       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 243     </para>
 244   </refsect1>
 245
 246   <refsect1>
 247     <title>AUTHOR</title>
 248     <para>
 249         <corpauthor>Internet Systems Consortium</corpauthor>
 250     </para>
 251   </refsect1>
 252
 253 </refentry>
 254
 255 <!--
 256  - Local variables:
 257  - mode: sgml
 258  - End:
 259 -->
 260