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