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