named-checkzone.docbook 9.96 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.19 2005/05/19 04:58:59 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 49 50 51 52 53 54 55
  <refnamediv>
    <refname><application>named-checkzone</application></refname>
    <refpurpose>zone file validity checking tool</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>named-checkzone</command>
      <arg><option>-d</option></arg>
Mark Andrews's avatar
Mark Andrews committed
56
      <arg><option>-j</option></arg>
57
      <arg><option>-q</option></arg>
58
      <arg><option>-v</option></arg>
59
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
60
      <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
61
      <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
62
      <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
63
      <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
64
      <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
65 66
      <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
67
      <arg><option>-D</option></arg>
68
      <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
69 70 71 72 73 74 75
      <arg choice="req">zonename</arg>
      <arg choice="req">filename</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
76 77 78 79 80
    <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.
81 82 83 84 85 86 87 88 89
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-d</term>
90 91 92 93 94
        <listitem>
          <para>
            Enable debugging.
          </para>
        </listitem>
95 96 97 98
      </varlistentry>

      <varlistentry>
        <term>-q</term>
99 100 101 102 103
        <listitem>
          <para>
            Quiet mode - exit code only.
          </para>
        </listitem>
104 105
      </varlistentry>

106 107
      <varlistentry>
        <term>-v</term>
108 109 110 111 112 113
        <listitem>
          <para>
            Print the version of the <command>named-checkzone</command>
            program and exit.
          </para>
        </listitem>
114 115
      </varlistentry>

116
      <varlistentry>
117
        <term>-j</term>
118 119
        <listitem>
          <para>
120 121
            When loading the zone file read the journal if it exists.
          </para>
122
        </listitem>
123
      </varlistentry>
124

125 126
      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
127 128 129 130 131
        <listitem>
          <para>
            Specify the class of the zone.  If not specified "IN" is assumed.
          </para>
        </listitem>
132 133
      </varlistentry>

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
      <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>

170 171
      <varlistentry>
        <term>-k <replaceable class="parameter">mode</replaceable></term>
172 173 174 175 176 177 178 179 180
        <listitem>
          <para>
            Perform <command>"check-name"</command> checks with
            the specified failure mode.
            Possible modes are <command>"fail"</command>,
            <command>"warn"</command> (default) and
            <command>"ignore"</command>.
          </para>
        </listitem>
181 182
      </varlistentry>

183 184 185 186 187 188 189 190 191 192 193 194
      <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>

195 196
      <varlistentry>
        <term>-n <replaceable class="parameter">mode</replaceable></term>
197 198 199 200 201 202 203 204
        <listitem>
          <para>
            Specify whether NS 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>
205 206
      </varlistentry>

207 208 209 210
      <varlistentry>
        <term>-o <replaceable class="parameter">filename</replaceable></term>
        <listitem>
          <para>
211
            Write zone output to <filename>filename</filename>.
212 213 214 215
          </para>
        </listitem>
      </varlistentry>

216 217 218 219
      <varlistentry>
        <term>-t <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
220 221 222 223
            chroot to <filename>directory</filename> so that
            include
            directives in the configuration file are processed as if
            run by a similarly chrooted named.
224 225 226 227 228 229 230 231
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-w <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
232 233 234 235 236
            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>.
237 238 239 240
          </para>
        </listitem>
      </varlistentry>

241 242
      <varlistentry>
        <term>-D</term>
243 244 245 246 247
        <listitem>
          <para>
            Dump zone file in canonical format.
          </para>
        </listitem>
248 249
      </varlistentry>

250 251
      <varlistentry>
        <term>-W <replaceable class="parameter">mode</replaceable></term>
252 253 254 255 256 257 258 259 260 261
        <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>
262 263
      </varlistentry>

264 265
      <varlistentry>
        <term>zonename</term>
266 267 268 269 270
        <listitem>
          <para>
            The domain name of the zone being checked.
          </para>
        </listitem>
271 272 273 274
      </varlistentry>

      <varlistentry>
        <term>filename</term>
275 276 277 278 279
        <listitem>
          <para>
            The name of the zone file.
          </para>
        </listitem>
280 281 282 283 284 285 286 287
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>RETURN VALUES</title>
288 289 290 291
    <para><command>named-checkzone</command>
      returns an exit status of 1 if
      errors were detected and 0 otherwise.
    </para>
292 293 294 295
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
296 297
    <para><citerefentry>
        <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
298 299 300 301 302 303 304 305
      </citerefentry>,
      <citetitle>RFC 1035</citetitle>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
306
    <para><corpauthor>Internet Systems Consortium</corpauthor>
307 308 309
    </para>
  </refsect1>

310
</refentry><!--
311 312 313 314
 - Local variables:
 - mode: sgml
 - End:
-->