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

   1 .\" Copyright (C) 2004-2007, 2009-2011, 2013 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000-2002 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or 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$
  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\-h\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\-L\ \fR\fB\fIserial\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-S\ \fR\fB\fImode\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\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\-L\ \fR\fB\fIserial\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {\fB\-o\ \fR\fB\fIfilename\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 \-h
  62 .RS 4
  63 Print the usage summary and exit.
  64 .RE
  65 .PP
  66 \-q
  67 .RS 4
  68 Quiet mode \- exit code only.
  69 .RE
  70 .PP
  71 \-v
  72 .RS 4
  73 Print the version of the
  74 \fBnamed\-checkzone\fR
  75 program and exit.
  76 .RE
  77 .PP
  78 \-j
  79 .RS 4
  80 When loading the zone file read the journal if it exists.
  81 .RE
  82 .PP
  83 \-c \fIclass\fR
  84 .RS 4
  85 Specify the class of the zone. If not specified, "IN" is assumed.
  86 .RE
  87 .PP
  88 \-i \fImode\fR
  89 .RS 4
  90 Perform post\-load zone integrity checks. Possible modes are
  91 \fB"full"\fR
  92 (default),
  93 \fB"full\-sibling"\fR,
  94 \fB"local"\fR,
  95 \fB"local\-sibling"\fR
  96 and
  97 \fB"none"\fR.
  98 .sp
  99 Mode
 100 \fB"full"\fR
 101 checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
 102 \fB"local"\fR
 103 only checks MX records which refer to in\-zone hostnames.
 104 .sp
 105 Mode
 106 \fB"full"\fR
 107 checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
 108 \fB"local"\fR
 109 only checks SRV records which refer to in\-zone hostnames.
 110 .sp
 111 Mode
 112 \fB"full"\fR
 113 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
 114 \fB"local"\fR
 115 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.
 116 .sp
 117 Mode
 118 \fB"full\-sibling"\fR
 119 and
 120 \fB"local\-sibling"\fR
 121 disable sibling glue checks but are otherwise the same as
 122 \fB"full"\fR
 123 and
 124 \fB"local"\fR
 125 respectively.
 126 .sp
 127 Mode
 128 \fB"none"\fR
 129 disables the checks.
 130 .RE
 131 .PP
 132 \-f \fIformat\fR
 133 .RS 4
 134 Specify the format of the zone file. Possible formats are
 135 \fB"text"\fR
 136 (default) and
 137 \fB"raw"\fR.
 138 .RE
 139 .PP
 140 \-F \fIformat\fR
 141 .RS 4
 142 Specify the format of the output file specified. For
 143 \fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents.
 144 .sp
 145 Possible formats are
 146 \fB"text"\fR
 147 (default) and
 148 \fB"raw"\fR
 149 or
 150 \fB"raw=N"\fR, which store the zone in a binary format for rapid loading by
 151 \fBnamed\fR.
 152 \fB"raw=N"\fR
 153 specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of
 154 \fBnamed\fR; if N is 1, the file can be read by release 9.9.0 or higher. The default is 1.
 155 .RE
 156 .PP
 157 \-k \fImode\fR
 158 .RS 4
 159 Perform
 160 \fB"check\-names"\fR
 161 checks with the specified failure mode. Possible modes are
 162 \fB"fail"\fR
 163 (default for
 164 \fBnamed\-compilezone\fR),
 165 \fB"warn"\fR
 166 (default for
 167 \fBnamed\-checkzone\fR) and
 168 \fB"ignore"\fR.
 169 .RE
 170 .PP
 171 \-L \fIserial\fR
 172 .RS 4
 173 When compiling a zone to 'raw' format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.)
 174 .RE
 175 .PP
 176 \-m \fImode\fR
 177 .RS 4
 178 Specify whether MX records should be checked to see if they are addresses. Possible modes are
 179 \fB"fail"\fR,
 180 \fB"warn"\fR
 181 (default) and
 182 \fB"ignore"\fR.
 183 .RE
 184 .PP
 185 \-M \fImode\fR
 186 .RS 4
 187 Check if a MX record refers to a CNAME. Possible modes are
 188 \fB"fail"\fR,
 189 \fB"warn"\fR
 190 (default) and
 191 \fB"ignore"\fR.
 192 .RE
 193 .PP
 194 \-n \fImode\fR
 195 .RS 4
 196 Specify whether NS records should be checked to see if they are addresses. Possible modes are
 197 \fB"fail"\fR
 198 (default for
 199 \fBnamed\-compilezone\fR),
 200 \fB"warn"\fR
 201 (default for
 202 \fBnamed\-checkzone\fR) and
 203 \fB"ignore"\fR.
 204 .RE
 205 .PP
 206 \-o \fIfilename\fR
 207 .RS 4
 208 Write zone output to
 209 \fIfilename\fR. If
 210 \fIfilename\fR
 211 is
 212 \fI\-\fR
 213 then write to standard out. This is mandatory for
 214 \fBnamed\-compilezone\fR.
 215 .RE
 216 .PP
 217 \-r \fImode\fR
 218 .RS 4
 219 Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are
 220 \fB"fail"\fR,
 221 \fB"warn"\fR
 222 (default) and
 223 \fB"ignore"\fR.
 224 .RE
 225 .PP
 226 \-s \fIstyle\fR
 227 .RS 4
 228 Specify the style of the dumped zone file. Possible styles are
 229 \fB"full"\fR
 230 (default) and
 231 \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
 232 \fBnamed\-checkzone\fR
 233 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.
 234 .RE
 235 .PP
 236 \-S \fImode\fR
 237 .RS 4
 238 Check if a SRV record refers to a CNAME. Possible modes are
 239 \fB"fail"\fR,
 240 \fB"warn"\fR
 241 (default) and
 242 \fB"ignore"\fR.
 243 .RE
 244 .PP
 245 \-t \fIdirectory\fR
 246 .RS 4
 247 Chroot to
 248 \fIdirectory\fR
 249 so that include directives in the configuration file are processed as if run by a similarly chrooted named.
 250 .RE
 251 .PP
 252 \-T \fImode\fR
 253 .RS 4
 254 Check if Sender Policy Framework records (TXT and SPF) both exist or both don't exist. A warning is issued if they don't match. Possible modes are
 255 \fB"warn"\fR
 256 (default),
 257 \fB"ignore"\fR.
 258 .RE
 259 .PP
 260 \-w \fIdirectory\fR
 261 .RS 4
 262 chdir to
 263 \fIdirectory\fR
 264 so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in
 265 \fInamed.conf\fR.
 266 .RE
 267 .PP
 268 \-D
 269 .RS 4
 270 Dump zone file in canonical format. This is always enabled for
 271 \fBnamed\-compilezone\fR.
 272 .RE
 273 .PP
 274 \-W \fImode\fR
 275 .RS 4
 276 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
 277 \fB"warn"\fR
 278 (default) and
 279 \fB"ignore"\fR.
 280 .RE
 281 .PP
 282 zonename
 283 .RS 4
 284 The domain name of the zone being checked.
 285 .RE
 286 .PP
 287 filename
 288 .RS 4
 289 The name of the zone file.
 290 .RE
 291 .SH "RETURN VALUES"
 292 .PP
 293 \fBnamed\-checkzone\fR
 294 returns an exit status of 1 if errors were detected and 0 otherwise.
 295 .SH "SEE ALSO"
 296 .PP
 297 \fBnamed\fR(8),
 298 \fBnamed\-checkconf\fR(8),
 299 RFC 1035,
 300 BIND 9 Administrator Reference Manual.
 301 .SH "AUTHOR"
 302 .PP
 303 Internet Systems Consortium
 304 .SH "COPYRIGHT"
 305 Copyright \(co 2004\-2007, 2009\-2011, 2013 Internet Systems Consortium, Inc. ("ISC")
 306 .br
 307 Copyright \(co 2000\-2002 Internet Software Consortium.
 308 .br