named-checkzone.docbook 13.9 KB
Newer Older
1 2 3
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
               "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
Brian Wellington's avatar
Brian Wellington committed
4
<!--
Mark Andrews's avatar
Mark Andrews committed
5
 - Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
6
 - Copyright (C) 2000-2002  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
7 8 9 10 11
 -
 - Permission to use, copy, modify, and distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
Mark Andrews's avatar
Mark Andrews committed
12 13 14 15 16 17 18
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
Brian Wellington's avatar
Brian Wellington committed
19
-->
Mark Andrews's avatar
Mark Andrews committed
20

21
<!-- $Id: named-checkzone.docbook,v 1.20 2005/06/20 01:03:48 marka Exp $ -->
22 23 24 25 26 27 28 29 30 31 32
<refentry>
  <refentryinfo>
    <date>June 13, 2000</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>named-checkzone</application></refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

33 34 35 36 37 38 39 40 41 42
  <docinfo>
    <copyright>
      <year>2004</year>
      <year>2005</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
Mark Andrews's avatar
Mark Andrews committed
43
      <holder>Internet Software Consortium.</holder>
44 45 46
    </copyright>
  </docinfo>

47 48
  <refnamediv>
    <refname><application>named-checkzone</application></refname>
49 50
    <refname><application>named-compilezone</application></refname>
    <refpurpose>zone file validity checking or converting tool</refpurpose>
51 52 53 54 55 56
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>named-checkzone</command>
      <arg><option>-d</option></arg>
Mark Andrews's avatar
Mark Andrews committed
57
      <arg><option>-j</option></arg>
58
      <arg><option>-q</option></arg>
59
      <arg><option>-v</option></arg>
60
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
61 62
      <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
      <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
63
      <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
64
      <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
65
      <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
66
      <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
67
      <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
      <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
      <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-D</option></arg>
      <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
      <arg choice="req">zonename</arg>
      <arg choice="req">filename</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>named-compilezone</command>
      <arg><option>-d</option></arg>
      <arg><option>-j</option></arg>
      <arg><option>-q</option></arg>
      <arg><option>-v</option></arg>
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
      <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
      <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
      <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
      <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
      <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
      <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
      <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
      <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
91 92
      <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
93
      <arg><option>-D</option></arg>
94
      <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
95 96 97 98 99 100 101
      <arg choice="req">zonename</arg>
      <arg choice="req">filename</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
102 103 104 105 106
    <para><command>named-checkzone</command>
      checks the syntax and integrity of a zone file.  It performs the
      same checks as <command>named</command> does when loading a
      zone.  This makes <command>named-checkzone</command> useful for
      checking zone files before configuring them into a name server.
107
    </para>
108 109 110 111 112 113 114 115 116 117
    <para>
        <command>named-compilezone</command> is similar to
	<command>named-checkzone</command>, but it always dumps the
        zone contents to a specified file in a specified format.
	Additionally, it applies stricter check levels by default,
        since the dump output will be used as an actual zone file
	loaded by <command>named</command>.
	When manaully specified otherwise, the check levels must at
        least be as strict as those specified in the
	<command>named</command> configuration file.
118 119 120 121 122 123 124 125
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-d</term>
126 127 128 129 130
        <listitem>
          <para>
            Enable debugging.
          </para>
        </listitem>
131 132 133 134
      </varlistentry>

      <varlistentry>
        <term>-q</term>
135 136 137 138 139
        <listitem>
          <para>
            Quiet mode - exit code only.
          </para>
        </listitem>
140 141
      </varlistentry>

142 143
      <varlistentry>
        <term>-v</term>
144 145 146 147 148 149
        <listitem>
          <para>
            Print the version of the <command>named-checkzone</command>
            program and exit.
          </para>
        </listitem>
150 151
      </varlistentry>

152
      <varlistentry>
153
        <term>-j</term>
154 155
        <listitem>
          <para>
156 157
            When loading the zone file read the journal if it exists.
          </para>
158
        </listitem>
159
      </varlistentry>
160

161 162
      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
163 164 165 166 167
        <listitem>
          <para>
            Specify the class of the zone.  If not specified "IN" is assumed.
          </para>
        </listitem>
168 169
      </varlistentry>

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
      <varlistentry>
        <term>-i <replaceable class="parameter">mode</replaceable></term>
	<listitem>
	  <para>
	      Perform post load zone integrity checks.  Possible modes are
	      <command>"full"</command> (default),
	      <command>"local"</command> and
	      <command>"none"</command>.
	  </para>
	  <para>
	      Mode <command>"full"</command> checks that MX records
	      refer to A or AAAA record (both in-zone and out-of-zone
	      hostnames).  Mode <command>"local"</command> only
	      checks MX records which refer to in-zone hostnames.
	  </para>
	  <para>
	      Mode <command>"full"</command> checks that SRV records
	      refer to A or AAAA record (both in-zone and out-of-zone
	      hostnames).  Mode <command>"local"</command> only
	      checks SRV records which refer to in-zone hostnames.
	  </para>
	  <para>
	      Mode <command>"full"</command> checks that delegation NS
	      records refer to A or AAAA record (both in-zone and out-of-zone
	      hostnames).  It also checks that glue addresses records
	      in the zone match those advertised by the child.
	      Mode <command>"local"</command> only checks NS records which
	      refer to in-zone hostnames or that some required glue exists,
	      that is when the nameserver is in a child zone.
	  </para>
	  <para>
	      Mode <command>"none"</command> disables the checks.
	  </para>
	</listitem>
      </varlistentry>

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
      <varlistentry>
	<term>-f <replaceable class="parameter">format</replaceable></term>
	<listitem>
	  <para>
	    Specify the format of the zone file.
	    Possible formats are <command>"text"</command> (default)
	    and <command>"raw"</command>.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-F <replaceable class="parameter">format</replaceable></term>
	<listitem>
	  <para>
	    Specify the format of the output file specified.
	    Possible formats are <command>"text"</command> (default)
	    and <command>"raw"</command>.
	    For <command>named-checkzone</command>,
	    this does not cause any effects unless it dumps the zone
	    contents.
	  </para>
	</listitem>
      </varlistentry>

231 232
      <varlistentry>
        <term>-k <replaceable class="parameter">mode</replaceable></term>
233 234
        <listitem>
          <para>
235 236 237 238 239 240
            Perform <command>"check-name"</command> checks with the
	    specified failure mode.
            Possible modes are <command>"fail"</command>
	    (default for <command>named-compilezone</command>),
            <command>"warn"</command>
	    (default for <command>named-checkzone</command>) and
241 242 243
            <command>"ignore"</command>.
          </para>
        </listitem>
244 245
      </varlistentry>

246 247 248 249 250 251 252 253 254 255 256 257
      <varlistentry>
        <term>-m <replaceable class="parameter">mode</replaceable></term>
        <listitem>
          <para>
            Specify whether MX records should be checked to see if they
            are addresses.  Possible modes are <command>"fail"</command>,
            <command>"warn"</command> (default) and
            <command>"ignore"</command>.
          </para>
        </listitem>
      </varlistentry>

258 259
      <varlistentry>
        <term>-n <replaceable class="parameter">mode</replaceable></term>
260 261 262
        <listitem>
          <para>
            Specify whether NS records should be checked to see if they
263 264 265 266 267
            are addresses.
	    Possible modes are <command>"fail"</command>
	    (default for <command>named-compilezone</command>),
            <command>"warn"</command>
	    (default for <command>named-checkzone</command>) and
268 269 270
            <command>"ignore"</command>.
          </para>
        </listitem>
271 272
      </varlistentry>

273 274 275 276
      <varlistentry>
        <term>-o <replaceable class="parameter">filename</replaceable></term>
        <listitem>
          <para>
277
            Write zone output to <filename>filename</filename>.
278
	    This is mandatory for <command>named-compilezone</command>.
279 280 281 282
          </para>
        </listitem>
      </varlistentry>

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
      <varlistentry>
	<term>-s <replaceable class="parameter">style</replaceable></term>
	<listitem>
	  <para>
	    Specify the style of the dumped zone file.
	    Possible styles are <command>"full"</command> (default)
	    and <command>"default"</command>.
	    The full format is most suitable for processing
	    automatically by a separate script.
	    On the other hand, the default format is more
	    human-readable and is thus suitable for editing by hand.
	    For <command>named-checkzone</command>
	    this does not cause any effects unless it dumps the zone
	    contents.
	    It also does not have any meaning if the output format
	    is not text.
	  </para>
	</listitem>
      </varlistentry>

303 304 305 306
      <varlistentry>
        <term>-t <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
307 308 309 310
            chroot to <filename>directory</filename> so that
            include
            directives in the configuration file are processed as if
            run by a similarly chrooted named.
311 312 313 314 315 316 317 318
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-w <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
319 320 321 322 323
            chdir to <filename>directory</filename> so that
            relative
            filenames in master file $INCLUDE directives work.  This
            is similar to the directory clause in
            <filename>named.conf</filename>.
324 325 326 327
          </para>
        </listitem>
      </varlistentry>

328 329
      <varlistentry>
        <term>-D</term>
330 331 332
        <listitem>
          <para>
            Dump zone file in canonical format.
333
	    This is always enabled for <command>named-compilezone</command>.
334 335
          </para>
        </listitem>
336 337
      </varlistentry>

338 339
      <varlistentry>
        <term>-W <replaceable class="parameter">mode</replaceable></term>
340 341 342 343 344 345 346 347 348 349
        <listitem>
          <para>
            Specify whether to check for non-terminal wildcards.
            Non-terminal wildcards are almost always the result of a
            failure to understand the wildcard matching algorithm (RFC 1034).
            Possible modes are <command>"warn"</command> (default)
            and
            <command>"ignore"</command>.
          </para>
        </listitem>
350 351
      </varlistentry>

352 353
      <varlistentry>
        <term>zonename</term>
354 355 356 357 358
        <listitem>
          <para>
            The domain name of the zone being checked.
          </para>
        </listitem>
359 360 361 362
      </varlistentry>

      <varlistentry>
        <term>filename</term>
363 364 365 366 367
        <listitem>
          <para>
            The name of the zone file.
          </para>
        </listitem>
368 369 370 371 372 373 374 375
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>RETURN VALUES</title>
376 377 378 379
    <para><command>named-checkzone</command>
      returns an exit status of 1 if
      errors were detected and 0 otherwise.
    </para>
380 381 382 383
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
384 385
    <para><citerefentry>
        <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
386 387 388 389 390 391 392 393
      </citerefentry>,
      <citetitle>RFC 1035</citetitle>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
394
    <para><corpauthor>Internet Systems Consortium</corpauthor>
395 396 397
    </para>
  </refsect1>

398
</refentry><!--
399 400 401 402
 - Local variables:
 - mode: sgml
 - End:
-->