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