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