named-checkzone.docbook 7.11 KB
Newer Older
1
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
Brian Wellington's avatar
Brian Wellington committed
2
<!--
Mark Andrews's avatar
Mark Andrews committed
3
 - Copyright (C) 2004, 2005  Internet Systems Consortium, Inc. ("ISC")
Mark Andrews's avatar
Mark Andrews committed
4
 - Copyright (C) 2001, 2002  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
5 6 7 8 9
 -
 - 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
10 11 12 13 14 15 16
 - 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
17 18
-->

Mark Andrews's avatar
Mark Andrews committed
19
<!-- $Id: named-checkzone.docbook,v 1.14 2005/01/10 23:43:12 marka Exp $ -->
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

<refentry>
  <refentryinfo>
    <date>June 13, 2000</date>
  </refentryinfo>

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

  <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
41
      <arg><option>-j</option></arg>
42
      <arg><option>-q</option></arg>
43
      <arg><option>-v</option></arg>
44
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
45
      <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
46
      <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
47
      <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
48 49
      <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
50
      <arg><option>-D</option></arg>
51
      <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
      <arg choice="req">zonename</arg>
      <arg choice="req">filename</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <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.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-d</term>
	<listitem>
	  <para>
	      Enable debugging.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>-q</term>
	<listitem>
	  <para>
	      Quiet mode - exit code only.
	  </para>
	</listitem>
      </varlistentry>

90 91 92 93 94 95 96 97 98 99
      <varlistentry>
        <term>-v</term>
	<listitem>
	  <para>
	      Print the version of the <command>named-checkzone</command>
	      program and exit.
	  </para>
	</listitem>
      </varlistentry>

100
      <varlistentry>
101
        <term>-j</term>
102 103
        <listitem>
          <para>
104
              When loading the zone file read the journal if it exists.
105 106 107
          </para>   
        </listitem>

108 109 110 111 112 113 114 115 116
      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
	<listitem>
	  <para>
	      Specify the class of the zone.  If not specified "IN" is assumed.
	  </para>
	</listitem>
      </varlistentry>

117 118 119 120 121 122 123 124 125 126 127 128
      <varlistentry>
        <term>-k <replaceable class="parameter">mode</replaceable></term>
	<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>
      </varlistentry>

129 130 131 132 133 134 135 136 137 138 139 140
      <varlistentry>
        <term>-n <replaceable class="parameter">mode</replaceable></term>
	<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>
      </varlistentry>

141 142 143 144 145 146 147 148 149
      <varlistentry>
        <term>-o <replaceable class="parameter">filename</replaceable></term>
        <listitem>
          <para>
	      Write zone output to <filename>directory</filename>.
          </para>
        </listitem>
      </varlistentry>

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
      <varlistentry>
        <term>-t <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
              chroot to <filename>directory</filename> so that include
              directives in the configuration file are processed as if
              run by a similarly chrooted named.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-w <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
              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>.
          </para>
        </listitem>
      </varlistentry>

173 174 175 176 177 178 179 180 181
      <varlistentry>
        <term>-D</term>
	<listitem>
	  <para>
	      Dump zone file in canonical format.
	  </para>
	</listitem>
      </varlistentry>

182 183 184 185 186 187 188 189 190 191 192 193 194
      <varlistentry>
        <term>-W <replaceable class="parameter">mode</replaceable></term>
	<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>
      </varlistentry>

195 196 197 198 199 200 201 202 203 204 205 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 231 232 233 234 235 236 237 238
      <varlistentry>
        <term>zonename</term>
	<listitem>
	  <para>
	       The domain name of the zone being checked.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
        <term>filename</term>
	<listitem>
	  <para>
	       The name of the zone file.
	  </para>
	</listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>RETURN VALUES</title>
    <para>
        <command>named-checkzone</command> returns an exit status of 1 if
	errors were detected and 0 otherwise.
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>named</refentrytitle>
	<manvolnum>8</manvolnum>
      </citerefentry>,
      <citetitle>RFC 1035</citetitle>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>
Mark Andrews's avatar
Mark Andrews committed
239
        <corpauthor>Internet Systems Consortium</corpauthor>
240 241 242 243 244 245 246 247 248 249 250
    </para>
  </refsect1>

</refentry>

<!--
 - Local variables:
 - mode: sgml
 - End:
-->