Import bind 9.5.2 vendor sources.
[dragonfly.git] / contrib / bind-9.5.2 / bin / check / named-checkzone.8
1 .\" Copyright (C) 2004-2007, 2009 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: named-checkzone.8,v 1.42.130.2 2009/07/11 01:43:26 tbox 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\-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\-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 \-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. Possible formats are
143 \fB"text"\fR
144 (default) and
145 \fB"raw"\fR. For
146 \fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents.
147 .RE
148 .PP
149 \-k \fImode\fR
150 .RS 4
151 Perform
152 \fB"check\-names"\fR
153 checks with the specified failure mode. Possible modes are
154 \fB"fail"\fR
155 (default for
156 \fBnamed\-compilezone\fR),
157 \fB"warn"\fR
158 (default for
159 \fBnamed\-checkzone\fR) and
160 \fB"ignore"\fR.
161 .RE
162 .PP
163 \-m \fImode\fR
164 .RS 4
165 Specify whether MX records should be checked to see if they are addresses. Possible modes are
166 \fB"fail"\fR,
167 \fB"warn"\fR
168 (default) and
169 \fB"ignore"\fR.
170 .RE
171 .PP
172 \-M \fImode\fR
173 .RS 4
174 Check if a MX record refers to a CNAME. Possible modes are
175 \fB"fail"\fR,
176 \fB"warn"\fR
177 (default) and
178 \fB"ignore"\fR.
179 .RE
180 .PP
181 \-n \fImode\fR
182 .RS 4
183 Specify whether NS records should be checked to see if they are addresses. Possible modes are
184 \fB"fail"\fR
185 (default for
186 \fBnamed\-compilezone\fR),
187 \fB"warn"\fR
188 (default for
189 \fBnamed\-checkzone\fR) and
190 \fB"ignore"\fR.
191 .RE
192 .PP
193 \-o \fIfilename\fR
194 .RS 4
195 Write zone output to
196 \fIfilename\fR. If
197 \fIfilename\fR
198 is
199 \fI\-\fR
200 then write to standard out. This is mandatory for
201 \fBnamed\-compilezone\fR.
202 .RE
203 .PP
204 \-s \fIstyle\fR
205 .RS 4
206 Specify the style of the dumped zone file. Possible styles are
207 \fB"full"\fR
208 (default) and
209 \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
210 \fBnamed\-checkzone\fR
211 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.
212 .RE
213 .PP
214 \-S \fImode\fR
215 .RS 4
216 Check if a SRV record refers to a CNAME. Possible modes are
217 \fB"fail"\fR,
218 \fB"warn"\fR
219 (default) and
220 \fB"ignore"\fR.
221 .RE
222 .PP
223 \-t \fIdirectory\fR
224 .RS 4
225 Chroot to
226 \fIdirectory\fR
227 so that include directives in the configuration file are processed as if run by a similarly chrooted named.
228 .RE
229 .PP
230 \-w \fIdirectory\fR
231 .RS 4
232 chdir to
233 \fIdirectory\fR
234 so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in
235 \fInamed.conf\fR.
236 .RE
237 .PP
238 \-D
239 .RS 4
240 Dump zone file in canonical format. This is always enabled for
241 \fBnamed\-compilezone\fR.
242 .RE
243 .PP
244 \-W \fImode\fR
245 .RS 4
246 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
247 \fB"warn"\fR
248 (default) and
249 \fB"ignore"\fR.
250 .RE
251 .PP
252 zonename
253 .RS 4
254 The domain name of the zone being checked.
255 .RE
256 .PP
257 filename
258 .RS 4
259 The name of the zone file.
260 .RE
261 .SH "RETURN VALUES"
262 .PP
263 \fBnamed\-checkzone\fR
264 returns an exit status of 1 if errors were detected and 0 otherwise.
265 .SH "SEE ALSO"
266 .PP
267 \fBnamed\fR(8),
268 \fBnamed\-checkconf\fR(8),
269 RFC 1035,
270 BIND 9 Administrator Reference Manual.
271 .SH "AUTHOR"
272 .PP
273 Internet Systems Consortium
274 .SH "COPYRIGHT"
275 Copyright \(co 2004\-2007, 2009 Internet Systems Consortium, Inc. ("ISC")
276 .br
277 Copyright \(co 2000\-2002 Internet Software Consortium.
278 .br