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