contrib/bind9/bin/check/named-checkzone.8

   1 .\" Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000-2002 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $Id: named-checkzone.8,v 1.18.18.23 2007/06/20 02:26:58 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: named\-checkzone
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  23 .\"      Date: June 13, 2000
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "NAMED\-CHECKZONE" "8" "June 13, 2000" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 named\-checkzone, named\-compilezone \- zone file validity checking or converting tool
  34 .SH "SYNOPSIS"
  35 .HP 16
  36 \fBnamed\-checkzone\fR [\fB\-d\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-M\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-S\ \fR\fB\fImode\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {zonename} {filename}
  37 .HP 18
  38 \fBnamed\-compilezone\fR [\fB\-d\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-C\ \fR\fB\fImode\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {zonename} {filename}
  39 .SH "DESCRIPTION"
  40 .PP
  41 \fBnamed\-checkzone\fR
  42 checks the syntax and integrity of a zone file. It performs the same checks as
  43 \fBnamed\fR
  44 does when loading a zone. This makes
  45 \fBnamed\-checkzone\fR
  46 useful for checking zone files before configuring them into a name server.
  47 .PP
  48 \fBnamed\-compilezone\fR
  49 is similar to
  50 \fBnamed\-checkzone\fR, 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
  51 \fBnamed\fR. When manually specified otherwise, the check levels must at least be as strict as those specified in the
  52 \fBnamed\fR
  53 configuration file.
  54 .SH "OPTIONS"
  55 .PP
  56 \-d
  57 .RS 4
  58 Enable debugging.
  59 .RE
  60 .PP
  61 \-q
  62 .RS 4
  63 Quiet mode \- exit code only.
  64 .RE
  65 .PP
  66 \-v
  67 .RS 4
  68 Print the version of the
  69 \fBnamed\-checkzone\fR
  70 program and exit.
  71 .RE
  72 .PP
  73 \-j
  74 .RS 4
  75 When loading the zone file read the journal if it exists.
  76 .RE
  77 .PP
  78 \-c \fIclass\fR
  79 .RS 4
  80 Specify the class of the zone. If not specified "IN" is assumed.
  81 .RE
  82 .PP
  83 \-i \fImode\fR
  84 .RS 4
  85 Perform post\-load zone integrity checks. Possible modes are
  86 \fB"full"\fR
  87 (default),
  88 \fB"full\-sibling"\fR,
  89 \fB"local"\fR,
  90 \fB"local\-sibling"\fR
  91 and
  92 \fB"none"\fR.
  93 .sp
  94 Mode
  95 \fB"full"\fR
  96 checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
  97 \fB"local"\fR
  98 only checks MX records which refer to in\-zone hostnames.
  99 .sp
 100 Mode
 101 \fB"full"\fR
 102 checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
 103 \fB"local"\fR
 104 only checks SRV records which refer to in\-zone hostnames.
 105 .sp
 106 Mode
 107 \fB"full"\fR
 108 checks that delegation NS records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). It also checks that glue address records in the zone match those advertised by the child. Mode
 109 \fB"local"\fR
 110 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.
 111 .sp
 112 Mode
 113 \fB"full\-sibling"\fR
 114 and
 115 \fB"local\-sibling"\fR
 116 disable sibling glue checks but are otherwise the same as
 117 \fB"full"\fR
 118 and
 119 \fB"local"\fR
 120 respectively.
 121 .sp
 122 Mode
 123 \fB"none"\fR
 124 disables the checks.
 125 .RE
 126 .PP
 127 \-f \fIformat\fR
 128 .RS 4
 129 Specify the format of the zone file. Possible formats are
 130 \fB"text"\fR
 131 (default) and
 132 \fB"raw"\fR.
 133 .RE
 134 .PP
 135 \-F \fIformat\fR
 136 .RS 4
 137 Specify the format of the output file specified. Possible formats are
 138 \fB"text"\fR
 139 (default) and
 140 \fB"raw"\fR. For
 141 \fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents.
 142 .RE
 143 .PP
 144 \-k \fImode\fR
 145 .RS 4
 146 Perform
 147 \fB"check\-names"\fR
 148 checks with the specified failure mode. Possible modes are
 149 \fB"fail"\fR
 150 (default for
 151 \fBnamed\-compilezone\fR),
 152 \fB"warn"\fR
 153 (default for
 154 \fBnamed\-checkzone\fR) and
 155 \fB"ignore"\fR.
 156 .RE
 157 .PP
 158 \-m \fImode\fR
 159 .RS 4
 160 Specify whether MX records should be checked to see if they are addresses. Possible modes are
 161 \fB"fail"\fR,
 162 \fB"warn"\fR
 163 (default) and
 164 \fB"ignore"\fR.
 165 .RE
 166 .PP
 167 \-M \fImode\fR
 168 .RS 4
 169 Check if a MX record refers to a CNAME. Possible modes are
 170 \fB"fail"\fR,
 171 \fB"warn"\fR
 172 (default) and
 173 \fB"ignore"\fR.
 174 .RE
 175 .PP
 176 \-n \fImode\fR
 177 .RS 4
 178 Specify whether NS records should be checked to see if they are addresses. Possible modes are
 179 \fB"fail"\fR
 180 (default for
 181 \fBnamed\-compilezone\fR),
 182 \fB"warn"\fR
 183 (default for
 184 \fBnamed\-checkzone\fR) and
 185 \fB"ignore"\fR.
 186 .RE
 187 .PP
 188 \-o \fIfilename\fR
 189 .RS 4
 190 Write zone output to
 191 \fIfilename\fR. This is mandatory for
 192 \fBnamed\-compilezone\fR.
 193 .RE
 194 .PP
 195 \-s \fIstyle\fR
 196 .RS 4
 197 Specify the style of the dumped zone file. Possible styles are
 198 \fB"full"\fR
 199 (default) and
 200 \fB"relative"\fR. 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
 201 \fBnamed\-checkzone\fR
 202 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.
 203 .RE
 204 .PP
 205 \-S \fImode\fR
 206 .RS 4
 207 Check if a SRV record refers to a CNAME. Possible modes are
 208 \fB"fail"\fR,
 209 \fB"warn"\fR
 210 (default) and
 211 \fB"ignore"\fR.
 212 .RE
 213 .PP
 214 \-t \fIdirectory\fR
 215 .RS 4
 216 Chroot to
 217 \fIdirectory\fR
 218 so that include directives in the configuration file are processed as if run by a similarly chrooted named.
 219 .RE
 220 .PP
 221 \-w \fIdirectory\fR
 222 .RS 4
 223 chdir to
 224 \fIdirectory\fR
 225 so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in
 226 \fInamed.conf\fR.
 227 .RE
 228 .PP
 229 \-D
 230 .RS 4
 231 Dump zone file in canonical format. This is always enabled for
 232 \fBnamed\-compilezone\fR.
 233 .RE
 234 .PP
 235 \-W \fImode\fR
 236 .RS 4
 237 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
 238 \fB"warn"\fR
 239 (default) and
 240 \fB"ignore"\fR.
 241 .RE
 242 .PP
 243 zonename
 244 .RS 4
 245 The domain name of the zone being checked.
 246 .RE
 247 .PP
 248 filename
 249 .RS 4
 250 The name of the zone file.
 251 .RE
 252 .SH "RETURN VALUES"
 253 .PP
 254 \fBnamed\-checkzone\fR
 255 returns an exit status of 1 if errors were detected and 0 otherwise.
 256 .SH "SEE ALSO"
 257 .PP
 258 \fBnamed\fR(8),
 259 \fBnamed\-checkconf\fR(8),
 260 RFC 1035,
 261 BIND 9 Administrator Reference Manual.
 262 .SH "AUTHOR"
 263 .PP
 264 Internet Systems Consortium
 265 .SH "COPYRIGHT"
 266 Copyright \(co 2004\-2007 Internet Systems Consortium, Inc. ("ISC")
 267 .br
 268 Copyright \(co 2000\-2002 Internet Software Consortium.
 269 .br