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

   1 .\" Copyright (C) 2004-2007, 2009-2011, 2013-2015 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 .hy 0
  17 .ad l
  18 '\" t
  19 .\"     Title: named-checkzone
  20 .\"    Author:
  21 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
  22 .\"      Date: 2013-04-29
  23 .\"    Manual: BIND9
  24 .\"    Source: ISC
  25 .\"  Language: English
  26 .\"
  27 .TH "NAMED\-CHECKZONE" "8" "2013\-04\-29" "ISC" "BIND9"
  28 .\" -----------------------------------------------------------------
  29 .\" * Define some portability stuff
  30 .\" -----------------------------------------------------------------
  31 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32 .\" http://bugs.debian.org/507673
  33 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .ie \n(.g .ds Aq \(aq
  36 .el       .ds Aq '
  37 .\" -----------------------------------------------------------------
  38 .\" * set default formatting
  39 .\" -----------------------------------------------------------------
  40 .\" disable hyphenation
  41 .nh
  42 .\" disable justification (adjust text to left margin only)
  43 .ad l
  44 .\" -----------------------------------------------------------------
  45 .\" * MAIN CONTENT STARTS HERE *
  46 .\" -----------------------------------------------------------------
  47 .SH "NAME"
  48 named-checkzone, named-compilezone \- zone file validity checking or converting tool
  49 .SH "SYNOPSIS"
  50 .HP \w'\fBnamed\-checkzone\fR\ 'u
  51 \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}
  52 .HP \w'\fBnamed\-compilezone\fR\ 'u
  53 \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}
  54 .SH "DESCRIPTION"
  55 .PP
  56 \fBnamed\-checkzone\fR
  57 checks the syntax and integrity of a zone file\&. It performs the same checks as
  58 \fBnamed\fR
  59 does when loading a zone\&. This makes
  60 \fBnamed\-checkzone\fR
  61 useful for checking zone files before configuring them into a name server\&.
  62 .PP
  63 \fBnamed\-compilezone\fR
  64 is similar to
  65 \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
  66 \fBnamed\fR\&. When manually specified otherwise, the check levels must at least be as strict as those specified in the
  67 \fBnamed\fR
  68 configuration file\&.
  69 .SH "OPTIONS"
  70 .PP
  71 \-d
  72 .RS 4
  73 Enable debugging\&.
  74 .RE
  75 .PP
  76 \-h
  77 .RS 4
  78 Print the usage summary and exit\&.
  79 .RE
  80 .PP
  81 \-q
  82 .RS 4
  83 Quiet mode \- exit code only\&.
  84 .RE
  85 .PP
  86 \-v
  87 .RS 4
  88 Print the version of the
  89 \fBnamed\-checkzone\fR
  90 program and exit\&.
  91 .RE
  92 .PP
  93 \-j
  94 .RS 4
  95 When loading the zone file read the journal if it exists\&.
  96 .RE
  97 .PP
  98 \-c \fIclass\fR
  99 .RS 4
 100 Specify the class of the zone\&. If not specified, "IN" is assumed\&.
 101 .RE
 102 .PP
 103 \-i \fImode\fR
 104 .RS 4
 105 Perform post\-load zone integrity checks\&. Possible modes are
 106 \fB"full"\fR
 107 (default),
 108 \fB"full\-sibling"\fR,
 109 \fB"local"\fR,
 110 \fB"local\-sibling"\fR
 111 and
 112 \fB"none"\fR\&.
 113 .sp
 114 Mode
 115 \fB"full"\fR
 116 checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode
 117 \fB"local"\fR
 118 only checks MX records which refer to in\-zone hostnames\&.
 119 .sp
 120 Mode
 121 \fB"full"\fR
 122 checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames)\&. Mode
 123 \fB"local"\fR
 124 only checks SRV records which refer to in\-zone hostnames\&.
 125 .sp
 126 Mode
 127 \fB"full"\fR
 128 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
 129 \fB"local"\fR
 130 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\&.
 131 .sp
 132 Mode
 133 \fB"full\-sibling"\fR
 134 and
 135 \fB"local\-sibling"\fR
 136 disable sibling glue checks but are otherwise the same as
 137 \fB"full"\fR
 138 and
 139 \fB"local"\fR
 140 respectively\&.
 141 .sp
 142 Mode
 143 \fB"none"\fR
 144 disables the checks\&.
 145 .RE
 146 .PP
 147 \-f \fIformat\fR
 148 .RS 4
 149 Specify the format of the zone file\&. Possible formats are
 150 \fB"text"\fR
 151 (default) and
 152 \fB"raw"\fR\&.
 153 .RE
 154 .PP
 155 \-F \fIformat\fR
 156 .RS 4
 157 Specify the format of the output file specified\&. For
 158 \fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents\&.
 159 .sp
 160 Possible formats are
 161 \fB"text"\fR
 162 (default) and
 163 \fB"raw"\fR
 164 or
 165 \fB"raw=N"\fR, which store the zone in a binary format for rapid loading by
 166 \fBnamed\fR\&.
 167 \fB"raw=N"\fR
 168 specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of
 169 \fBnamed\fR; if N is 1, the file can be read by release 9\&.9\&.0 or higher\&. The default is 1\&.
 170 .RE
 171 .PP
 172 \-k \fImode\fR
 173 .RS 4
 174 Perform
 175 \fB"check\-names"\fR
 176 checks with the specified failure mode\&. Possible modes are
 177 \fB"fail"\fR
 178 (default for
 179 \fBnamed\-compilezone\fR),
 180 \fB"warn"\fR
 181 (default for
 182 \fBnamed\-checkzone\fR) and
 183 \fB"ignore"\fR\&.
 184 .RE
 185 .PP
 186 \-L \fIserial\fR
 187 .RS 4
 188 When compiling a zone to \*(Aqraw\*(Aq format, set the "source serial" value in the header to the specified serial number\&. (This is expected to be used primarily for testing purposes\&.)
 189 .RE
 190 .PP
 191 \-m \fImode\fR
 192 .RS 4
 193 Specify whether MX records should be checked to see if they are addresses\&. Possible modes are
 194 \fB"fail"\fR,
 195 \fB"warn"\fR
 196 (default) and
 197 \fB"ignore"\fR\&.
 198 .RE
 199 .PP
 200 \-M \fImode\fR
 201 .RS 4
 202 Check if a MX record refers to a CNAME\&. Possible modes are
 203 \fB"fail"\fR,
 204 \fB"warn"\fR
 205 (default) and
 206 \fB"ignore"\fR\&.
 207 .RE
 208 .PP
 209 \-n \fImode\fR
 210 .RS 4
 211 Specify whether NS records should be checked to see if they are addresses\&. Possible modes are
 212 \fB"fail"\fR
 213 (default for
 214 \fBnamed\-compilezone\fR),
 215 \fB"warn"\fR
 216 (default for
 217 \fBnamed\-checkzone\fR) and
 218 \fB"ignore"\fR\&.
 219 .RE
 220 .PP
 221 \-o \fIfilename\fR
 222 .RS 4
 223 Write zone output to
 224 filename\&. If
 225 filename
 226 is
 227 \-
 228 then write to standard out\&. This is mandatory for
 229 \fBnamed\-compilezone\fR\&.
 230 .RE
 231 .PP
 232 \-r \fImode\fR
 233 .RS 4
 234 Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS\&. Possible modes are
 235 \fB"fail"\fR,
 236 \fB"warn"\fR
 237 (default) and
 238 \fB"ignore"\fR\&.
 239 .RE
 240 .PP
 241 \-s \fIstyle\fR
 242 .RS 4
 243 Specify the style of the dumped zone file\&. Possible styles are
 244 \fB"full"\fR
 245 (default) and
 246 \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
 247 \fBnamed\-checkzone\fR
 248 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\&.
 249 .RE
 250 .PP
 251 \-S \fImode\fR
 252 .RS 4
 253 Check if a SRV record refers to a CNAME\&. Possible modes are
 254 \fB"fail"\fR,
 255 \fB"warn"\fR
 256 (default) and
 257 \fB"ignore"\fR\&.
 258 .RE
 259 .PP
 260 \-t \fIdirectory\fR
 261 .RS 4
 262 Chroot to
 263 directory
 264 so that include directives in the configuration file are processed as if run by a similarly chrooted named\&.
 265 .RE
 266 .PP
 267 \-T \fImode\fR
 268 .RS 4
 269 Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF\-formatted TXT record is not also present\&. Possible modes are
 270 \fB"warn"\fR
 271 (default),
 272 \fB"ignore"\fR\&.
 273 .RE
 274 .PP
 275 \-w \fIdirectory\fR
 276 .RS 4
 277 chdir to
 278 directory
 279 so that relative filenames in master file $INCLUDE directives work\&. This is similar to the directory clause in
 280 named\&.conf\&.
 281 .RE
 282 .PP
 283 \-D
 284 .RS 4
 285 Dump zone file in canonical format\&. This is always enabled for
 286 \fBnamed\-compilezone\fR\&.
 287 .RE
 288 .PP
 289 \-W \fImode\fR
 290 .RS 4
 291 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
 292 \fB"warn"\fR
 293 (default) and
 294 \fB"ignore"\fR\&.
 295 .RE
 296 .PP
 297 zonename
 298 .RS 4
 299 The domain name of the zone being checked\&.
 300 .RE
 301 .PP
 302 filename
 303 .RS 4
 304 The name of the zone file\&.
 305 .RE
 306 .SH "RETURN VALUES"
 307 .PP
 308 \fBnamed\-checkzone\fR
 309 returns an exit status of 1 if errors were detected and 0 otherwise\&.
 310 .SH "SEE ALSO"
 311 .PP
 312 \fBnamed\fR(8),
 313 \fBnamed-checkconf\fR(8),
 314 RFC 1035,
 315 BIND 9 Administrator Reference Manual\&.
 316 .SH "AUTHOR"
 317 .PP
 318 \fBInternet Systems Consortium, Inc\&.\fR
 319 .SH "COPYRIGHT"
 320 .br
 321 Copyright \(co 2004-2007, 2009-2011, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
 322 .br
 323 Copyright \(co 2000-2002 Internet Software Consortium.
 324 .br