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