named-checkzone.docbook revision 2dafa707cc9af9cca66d68c1d2c3af0c768c2900
303N/A<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
303N/A "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
303N/A [<!ENTITY mdash "&#8212;">]>
303N/A<!--
303N/A - Copyright (C) 2004-2006 Internet Systems Consortium, Inc. ("ISC")
303N/A - Copyright (C) 2000-2002 Internet Software Consortium.
303N/A -
303N/A - Permission to use, copy, modify, and distribute this software for any
303N/A - purpose with or without fee is hereby granted, provided that the above
303N/A - copyright notice and this permission notice appear in all copies.
303N/A -
303N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
303N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
303N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
303N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
303N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
303N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
303N/A - PERFORMANCE OF THIS SOFTWARE.
303N/A-->
303N/A
2319N/A<!-- $Id: named-checkzone.docbook,v 1.26 2006/08/30 22:57:16 marka Exp $ -->
303N/A<refentry id="man.named-checkzone">
303N/A <refentryinfo>
303N/A <date>June 13, 2000</date>
303N/A </refentryinfo>
2319N/A
303N/A <refmeta>
303N/A <refentrytitle><application>named-checkzone</application></refentrytitle>
303N/A <manvolnum>8</manvolnum>
844N/A <refmiscinfo>BIND9</refmiscinfo>
2319N/A </refmeta>
303N/A
1258N/A <docinfo>
303N/A <copyright>
2899N/A <year>2004</year>
2899N/A <year>2005</year>
303N/A <year>2006</year>
303N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
303N/A </copyright>
303N/A <copyright>
303N/A <year>2000</year>
303N/A <year>2001</year>
303N/A <year>2002</year>
303N/A <holder>Internet Software Consortium.</holder>
303N/A </copyright>
303N/A </docinfo>
303N/A
303N/A <refnamediv>
303N/A <refname><application>named-checkzone</application></refname>
303N/A <refname><application>named-compilezone</application></refname>
303N/A <refpurpose>zone file validity checking or converting tool</refpurpose>
303N/A </refnamediv>
303N/A
303N/A <refsynopsisdiv>
303N/A <cmdsynopsis>
303N/A <command>named-checkzone</command>
303N/A <arg><option>-d</option></arg>
303N/A <arg><option>-j</option></arg>
303N/A <arg><option>-q</option></arg>
303N/A <arg><option>-v</option></arg>
303N/A <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
303N/A <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
303N/A <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
303N/A <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-M <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
303N/A <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
303N/A <arg><option>-S <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
303N/A <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
401N/A <arg><option>-D</option></arg>
303N/A <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg choice="req">zonename</arg>
303N/A <arg choice="req">filename</arg>
303N/A </cmdsynopsis>
303N/A <cmdsynopsis>
303N/A <command>named-compilezone</command>
303N/A <arg><option>-d</option></arg>
303N/A <arg><option>-j</option></arg>
303N/A <arg><option>-q</option></arg>
303N/A <arg><option>-v</option></arg>
2465N/A <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
2465N/A <arg><option>-C <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
303N/A <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
303N/A <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
303N/A <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
303N/A <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
303N/A <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
303N/A <arg><option>-D</option></arg>
303N/A <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
303N/A <arg choice="req">zonename</arg>
303N/A <arg choice="req">filename</arg>
303N/A </cmdsynopsis>
303N/A </refsynopsisdiv>
303N/A
303N/A <refsect1>
303N/A <title>DESCRIPTION</title>
303N/A <para><command>named-checkzone</command>
2375N/A checks the syntax and integrity of a zone file. It performs the
2375N/A same checks as <command>named</command> does when loading a
2465N/A zone. This makes <command>named-checkzone</command> useful for
303N/A checking zone files before configuring them into a name server.
2465N/A </para>
303N/A <para>
303N/A <command>named-compilezone</command> is similar to
303N/A <command>named-checkzone</command>, but it always dumps the
303N/A zone contents to a specified file in a specified format.
303N/A Additionally, it applies stricter check levels by default,
303N/A since the dump output will be used as an actual zone file
303N/A loaded by <command>named</command>.
303N/A When manaully specified otherwise, the check levels must at
303N/A least be as strict as those specified in the
303N/A <command>named</command> configuration file.
303N/A </para>
2465N/A </refsect1>
303N/A
303N/A <refsect1>
303N/A <title>OPTIONS</title>
303N/A
<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>
<varlistentry>
<term>-v</term>
<listitem>
<para>
Print the version of the <command>named-checkzone</command>
program and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-j</term>
<listitem>
<para>
When loading the zone file read the journal if it exists.
</para>
</listitem>
</varlistentry>
<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>
<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>"full-sibling"</command>,
<command>"local"</command>,
<command>"local-sibling"</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>"full-sibling"</command> and
<command>"local-sibling"</command> disable sibling glue
checks but are otherwise the same as <command>"full"</command>
and <command>"local"</command> respectively.
</para>
<para>
Mode <command>"none"</command> disables the checks.
</para>
</listitem>
</varlistentry>
<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>
<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>
(default for <command>named-compilezone</command>),
<command>"warn"</command>
(default for <command>named-checkzone</command>) and
<command>"ignore"</command>.
</para>
</listitem>
</varlistentry>
<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>
<varlistentry>
<term>-M <replaceable class="parameter">mode</replaceable></term>
<listitem>
<para>
Check if a MX record refers to a CNAME.
Possible modes are <command>"fail"</command>,
<command>"warn"</command> (default) and
<command>"ignore"</command>.
</para>
</listitem>
</varlistentry>
<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>
(default for <command>named-compilezone</command>),
<command>"warn"</command>
(default for <command>named-checkzone</command>) and
<command>"ignore"</command>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-o <replaceable class="parameter">filename</replaceable></term>
<listitem>
<para>
Write zone output to <filename>filename</filename>.
This is mandatory for <command>named-compilezone</command>.
</para>
</listitem>
</varlistentry>
<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>"relative"</command>.
The full format is most suitable for processing
automatically by a separate script.
On the other hand, the relative 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>
<varlistentry>
<term>-S <replaceable class="parameter">mode</replaceable></term>
<listitem>
<para>
Check if a SRV record refers to a CNAME.
Possible modes are <command>"fail"</command>,
<command>"warn"</command> (default) and
<command>"ignore"</command>.
</para>
</listitem>
</varlistentry>
<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>
<varlistentry>
<term>-D</term>
<listitem>
<para>
Dump zone file in canonical format.
This is always enabled for <command>named-compilezone</command>.
</para>
</listitem>
</varlistentry>
<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>
<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.
</para>
</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><corpauthor>Internet Systems Consortium</corpauthor>
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->