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-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-checkzone.docbook,v 1.11.18.21 2007/08/28 07:19:55 tbox Exp $ -->
  22 <refentry id="man.named-checkzone">
  23   <refentryinfo>
  24     <date>June 13, 2000</date>
  25   </refentryinfo>
  26
  27   <refmeta>
  28     <refentrytitle><application>named-checkzone</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>2006</year>
  38       <year>2007</year>
  39       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  40     </copyright>
  41     <copyright>
  42       <year>2000</year>
  43       <year>2001</year>
  44       <year>2002</year>
  45       <holder>Internet Software Consortium.</holder>
  46     </copyright>
  47   </docinfo>
  48
  49   <refnamediv>
  50     <refname><application>named-checkzone</application></refname>
  51     <refname><application>named-compilezone</application></refname>
  52     <refpurpose>zone file validity checking or converting tool</refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>named-checkzone</command>
  58       <arg><option>-d</option></arg>
  59       <arg><option>-j</option></arg>
  60       <arg><option>-q</option></arg>
  61       <arg><option>-v</option></arg>
  62       <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
  63       <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
  64       <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
  65       <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
  66       <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
  67       <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
  68       <arg><option>-M <replaceable class="parameter">mode</replaceable></option></arg>
  69       <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
  70       <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
  71       <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
  72       <arg><option>-S <replaceable class="parameter">mode</replaceable></option></arg>
  73       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  74       <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
  75       <arg><option>-D</option></arg>
  76       <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
  77       <arg choice="req">zonename</arg>
  78       <arg choice="req">filename</arg>
  79     </cmdsynopsis>
  80     <cmdsynopsis>
  81       <command>named-compilezone</command>
  82       <arg><option>-d</option></arg>
  83       <arg><option>-j</option></arg>
  84       <arg><option>-q</option></arg>
  85       <arg><option>-v</option></arg>
  86       <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
  87       <arg><option>-C <replaceable class="parameter">mode</replaceable></option></arg>
  88       <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
  89       <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
  90       <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
  91       <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
  92       <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
  93       <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
  94       <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
  95       <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
  96       <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
  97       <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
  98       <arg><option>-D</option></arg>
  99       <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
 100       <arg choice="req">zonename</arg>
 101       <arg choice="req">filename</arg>
 102     </cmdsynopsis>
 103   </refsynopsisdiv>
 104
 105   <refsect1>
 106     <title>DESCRIPTION</title>
 107     <para><command>named-checkzone</command>
 108       checks the syntax and integrity of a zone file.  It performs the
 109       same checks as <command>named</command> does when loading a
 110       zone.  This makes <command>named-checkzone</command> useful for
 111       checking zone files before configuring them into a name server.
 112     </para>
 113     <para>
 114         <command>named-compilezone</command> is similar to
 115         <command>named-checkzone</command>, but it always dumps the
 116         zone contents to a specified file in a specified format.
 117         Additionally, it applies stricter check levels by default,
 118         since the dump output will be used as an actual zone file
 119         loaded by <command>named</command>.
 120         When manually specified otherwise, the check levels must at
 121         least be as strict as those specified in the
 122         <command>named</command> configuration file.
 123      </para>
 124   </refsect1>
 125
 126   <refsect1>
 127     <title>OPTIONS</title>
 128
 129     <variablelist>
 130       <varlistentry>
 131         <term>-d</term>
 132         <listitem>
 133           <para>
 134             Enable debugging.
 135           </para>
 136         </listitem>
 137       </varlistentry>
 138
 139       <varlistentry>
 140         <term>-q</term>
 141         <listitem>
 142           <para>
 143             Quiet mode - exit code only.
 144           </para>
 145         </listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term>-v</term>
 150         <listitem>
 151           <para>
 152             Print the version of the <command>named-checkzone</command>
 153             program and exit.
 154           </para>
 155         </listitem>
 156       </varlistentry>
 157
 158       <varlistentry>
 159         <term>-j</term>
 160         <listitem>
 161           <para>
 162             When loading the zone file read the journal if it exists.
 163           </para>
 164         </listitem>
 165       </varlistentry>
 166
 167       <varlistentry>
 168         <term>-c <replaceable class="parameter">class</replaceable></term>
 169         <listitem>
 170           <para>
 171             Specify the class of the zone.  If not specified "IN" is assumed.
 172           </para>
 173         </listitem>
 174       </varlistentry>
 175
 176       <varlistentry>
 177         <term>-i <replaceable class="parameter">mode</replaceable></term>
 178         <listitem>
 179           <para>
 180               Perform post-load zone integrity checks.  Possible modes are
 181               <command>"full"</command> (default),
 182               <command>"full-sibling"</command>,
 183               <command>"local"</command>,
 184               <command>"local-sibling"</command> and
 185               <command>"none"</command>.
 186           </para>
 187           <para>
 188               Mode <command>"full"</command> checks that MX records
 189               refer to A or AAAA record (both in-zone and out-of-zone
 190               hostnames).  Mode <command>"local"</command> only
 191               checks MX records which refer to in-zone hostnames.
 192           </para>
 193           <para>
 194               Mode <command>"full"</command> checks that SRV records
 195               refer to A or AAAA record (both in-zone and out-of-zone
 196               hostnames).  Mode <command>"local"</command> only
 197               checks SRV records which refer to in-zone hostnames.
 198           </para>
 199           <para>
 200               Mode <command>"full"</command> checks that delegation NS
 201               records refer to A or AAAA record (both in-zone and out-of-zone
 202               hostnames).  It also checks that glue address records
 203               in the zone match those advertised by the child.
 204               Mode <command>"local"</command> only checks NS records which
 205               refer to in-zone hostnames or that some required glue exists,
 206               that is when the nameserver is in a child zone.
 207           </para>
 208           <para>
 209               Mode <command>"full-sibling"</command> and
 210               <command>"local-sibling"</command> disable sibling glue
 211               checks but are otherwise the same as <command>"full"</command>
 212               and <command>"local"</command> respectively.
 213           </para>
 214           <para>
 215               Mode <command>"none"</command> disables the checks.
 216           </para>
 217         </listitem>
 218       </varlistentry>
 219
 220       <varlistentry>
 221         <term>-f <replaceable class="parameter">format</replaceable></term>
 222         <listitem>
 223           <para>
 224             Specify the format of the zone file.
 225             Possible formats are <command>"text"</command> (default)
 226             and <command>"raw"</command>.
 227           </para>
 228         </listitem>
 229       </varlistentry>
 230
 231       <varlistentry>
 232         <term>-F <replaceable class="parameter">format</replaceable></term>
 233         <listitem>
 234           <para>
 235             Specify the format of the output file specified.
 236             Possible formats are <command>"text"</command> (default)
 237             and <command>"raw"</command>.
 238             For <command>named-checkzone</command>,
 239             this does not cause any effects unless it dumps the zone
 240             contents.
 241           </para>
 242         </listitem>
 243       </varlistentry>
 244
 245       <varlistentry>
 246         <term>-k <replaceable class="parameter">mode</replaceable></term>
 247         <listitem>
 248           <para>
 249             Perform <command>"check-names"</command> checks with the
 250             specified failure mode.
 251             Possible modes are <command>"fail"</command>
 252             (default for <command>named-compilezone</command>),
 253             <command>"warn"</command>
 254             (default for <command>named-checkzone</command>) and
 255             <command>"ignore"</command>.
 256           </para>
 257         </listitem>
 258       </varlistentry>
 259
 260       <varlistentry>
 261         <term>-m <replaceable class="parameter">mode</replaceable></term>
 262         <listitem>
 263           <para>
 264             Specify whether MX records should be checked to see if they
 265             are addresses.  Possible modes are <command>"fail"</command>,
 266             <command>"warn"</command> (default) and
 267             <command>"ignore"</command>.
 268           </para>
 269         </listitem>
 270       </varlistentry>
 271
 272       <varlistentry>
 273         <term>-M <replaceable class="parameter">mode</replaceable></term>
 274         <listitem>
 275           <para>
 276             Check if a MX record refers to a CNAME.
 277             Possible modes are <command>"fail"</command>,
 278             <command>"warn"</command> (default) and
 279             <command>"ignore"</command>.
 280           </para>
 281         </listitem>
 282       </varlistentry>
 283
 284       <varlistentry>
 285         <term>-n <replaceable class="parameter">mode</replaceable></term>
 286         <listitem>
 287           <para>
 288             Specify whether NS records should be checked to see if they
 289             are addresses.
 290             Possible modes are <command>"fail"</command>
 291             (default for <command>named-compilezone</command>),
 292             <command>"warn"</command>
 293             (default for <command>named-checkzone</command>) and
 294             <command>"ignore"</command>.
 295           </para>
 296         </listitem>
 297       </varlistentry>
 298
 299       <varlistentry>
 300         <term>-o <replaceable class="parameter">filename</replaceable></term>
 301         <listitem>
 302           <para>
 303             Write zone output to <filename>filename</filename>.
 304             This is mandatory for <command>named-compilezone</command>.
 305           </para>
 306         </listitem>
 307       </varlistentry>
 308
 309       <varlistentry>
 310         <term>-s <replaceable class="parameter">style</replaceable></term>
 311         <listitem>
 312           <para>
 313             Specify the style of the dumped zone file.
 314             Possible styles are <command>"full"</command> (default)
 315             and <command>"relative"</command>.
 316             The full format is most suitable for processing
 317             automatically by a separate script.
 318             On the other hand, the relative format is more
 319             human-readable and is thus suitable for editing by hand.
 320             For <command>named-checkzone</command>
 321             this does not cause any effects unless it dumps the zone
 322             contents.
 323             It also does not have any meaning if the output format
 324             is not text.
 325           </para>
 326         </listitem>
 327       </varlistentry>
 328
 329       <varlistentry>
 330         <term>-S <replaceable class="parameter">mode</replaceable></term>
 331         <listitem>
 332           <para>
 333             Check if a SRV record refers to a CNAME.
 334             Possible modes are <command>"fail"</command>,
 335             <command>"warn"</command> (default) and
 336             <command>"ignore"</command>.
 337           </para>
 338         </listitem>
 339       </varlistentry>
 340
 341       <varlistentry>
 342         <term>-t <replaceable class="parameter">directory</replaceable></term>
 343         <listitem>
 344           <para>
 345             Chroot to <filename>directory</filename> so that
 346             include
 347             directives in the configuration file are processed as if
 348             run by a similarly chrooted named.
 349           </para>
 350         </listitem>
 351       </varlistentry>
 352
 353       <varlistentry>
 354         <term>-w <replaceable class="parameter">directory</replaceable></term>
 355         <listitem>
 356           <para>
 357             chdir to <filename>directory</filename> so that
 358             relative
 359             filenames in master file $INCLUDE directives work.  This
 360             is similar to the directory clause in
 361             <filename>named.conf</filename>.
 362           </para>
 363         </listitem>
 364       </varlistentry>
 365
 366       <varlistentry>
 367         <term>-D</term>
 368         <listitem>
 369           <para>
 370             Dump zone file in canonical format.
 371             This is always enabled for <command>named-compilezone</command>.
 372           </para>
 373         </listitem>
 374       </varlistentry>
 375
 376       <varlistentry>
 377         <term>-W <replaceable class="parameter">mode</replaceable></term>
 378         <listitem>
 379           <para>
 380             Specify whether to check for non-terminal wildcards.
 381             Non-terminal wildcards are almost always the result of a
 382             failure to understand the wildcard matching algorithm (RFC 1034).
 383             Possible modes are <command>"warn"</command> (default)
 384             and
 385             <command>"ignore"</command>.
 386           </para>
 387         </listitem>
 388       </varlistentry>
 389
 390       <varlistentry>
 391         <term>zonename</term>
 392         <listitem>
 393           <para>
 394             The domain name of the zone being checked.
 395           </para>
 396         </listitem>
 397       </varlistentry>
 398
 399       <varlistentry>
 400         <term>filename</term>
 401         <listitem>
 402           <para>
 403             The name of the zone file.
 404           </para>
 405         </listitem>
 406       </varlistentry>
 407
 408     </variablelist>
 409
 410   </refsect1>
 411
 412   <refsect1>
 413     <title>RETURN VALUES</title>
 414     <para><command>named-checkzone</command>
 415       returns an exit status of 1 if
 416       errors were detected and 0 otherwise.
 417     </para>
 418   </refsect1>
 419
 420   <refsect1>
 421     <title>SEE ALSO</title>
 422     <para><citerefentry>
 423         <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
 424       </citerefentry>,
 425       <citerefentry>
 426         <refentrytitle>named-checkconf</refentrytitle><manvolnum>8</manvolnum>
 427       </citerefentry>,
 428       <citetitle>RFC 1035</citetitle>,
 429       <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
 430     </para>
 431   </refsect1>
 432
 433   <refsect1>
 434     <title>AUTHOR</title>
 435     <para><corpauthor>Internet Systems Consortium</corpauthor>
 436     </para>
 437   </refsect1>
 438
 439 </refentry><!--
 440  - Local variables:
 441  - mode: sgml
 442  - End:
 443 -->