1
.\" $Id: zonecheck.1,v 1.16 2004/02/13 13:03:24 sdalu Exp $
4
.\" CONTACT : zonecheck@nic.fr
5
.\" AUTHOR : Stephane D'Alu <sdalu@nic.fr>
7
.\" CREATED : 2003/08/26 10:20:35
8
.\" REVISION : $Revision: 1.16 $
9
.\" DATE : $Date: 2004/02/13 13:03:24 $
11
.\" CONTRIBUTORS: (see also CREDITS file)
14
.\" LICENSE : GPL v2 (or MIT/X11-like after agreement)
15
.\" COPYRIGHT : AFNIC (c) 2003
17
.\" This file is part of ZoneCheck.
19
.\" ZoneCheck is free software; you can redistribute it and/or modify it
20
.\" under the terms of the GNU General Public License as published by
21
.\" the Free Software Foundation; either version 2 of the License, or
22
.\" (at your option) any later version.
24
.\" ZoneCheck is distributed in the hope that it will be useful, but
25
.\" WITHOUT ANY WARRANTY; without even the implied warranty of
26
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27
.\" General Public License for more details.
29
.\" You should have received a copy of the GNU General Public License
30
.\" along with ZoneCheck; if not, write to the Free Software Foundation,
31
.\" Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
36
.\" this is like a comment request when escape mechanism is off
41
.c ---------------------------------------------------------------------
50
.\" End of macro definitions
53
.TH ZONECHECK 1 "26 January 2003"
55
zonecheck \- DNS zone checking tool
81
The DNS is a critical resource for every network application, quite important to ensure that a zone or domain name is correctly configured in the DNS.
83
\fIZoneCheck\fP is intended to help solving misconfigurations or inconsistencies usually revealed by an increase in the latency of the application, up to the output of unexpected/inconsistant results.
87
It doesn't necessary make sense to combine some options together, if
88
that case happens the most recent option will be taken into account,
89
silently discarding the others.
91
\fB--lang\fR \fIlang\fR
92
Select another language (en, fr, ...). The syntax is the same as for the
93
environment variable \fILANG\fR.
96
\fB--debug\fR, \fB-d\fR \fIlvl\fR
97
Select the debugging messages to print or activate debugging code.
98
This parameter will override the value of the environment variable \fIZC_DEBUG\fR.
100
The available options are:
101
0x0001 : Initialisation
102
0x0002 : Localization / Internationalisation
103
0x0004 : Configuration
105
0x0010 : Loading tests
106
0x0020 : Tests performed
107
0x0040 : Debugging messages from tests
108
0x0400 : Information about cached object
109
0x0800 : Debugger itself
111
0x1000 : Crazy Debug, don't try this at home!
112
0x2000 : NResolv module debugging messages
113
0x4000 : Disable caching
114
0x8000 : Don't try to rescue exceptions
116
\fB--help\fR, \fB-h\fR
117
Show a short description of the different options available in \fIZoneCheck\fR.
120
\fB--version\fR, \fB-V\fR
121
Display the version and exit.
124
\fB--batch\fR, \fB-B\fR \fIfilename\fR
125
Data is read in batch mode from the \fIfilename\fR or \fBstdin\fR if '-'
127
The syntax for the batch mode processing is as follow:
129
or DOM=domainname NS=ns1;ns2=ip1,ip2
132
\fB--config\fR, \fB-c\fR \fIfilename\fR
133
Specify the location of the configuration file (default is \fIzc.conf\fR).
136
\fB--testdir\fR \fIdirectory\fR
137
Location of the directory holding the tests definition.
140
\fB--profile\fR, \fB-P\fR \fIprofilename\fR
141
Force uses of profile \fIprofilename\fR.
144
\fB--category\fR, \fB-C\fR \fIcatlist\fR
145
Limit the test to perform to the categories specified by \fIcatlist\fR.
146
The syntax for the catgory description is as follow:
147
allow=[+|] disallow=[-|!] subcomponent=: separator=,
149
don't perform DNS tests that are not SOA related
152
\fB--test\fR, \fB-T\fR \fItestname\fR
153
\fItestname\fR is the test to perform. In this case failing to pass
154
the test is considered as fatal.
158
List all the tests available.
161
\fB--testdesc\fR \fIdesctype\fR
162
Give a description of the test, the possible values for \fIdesctype\fR
163
are \fBname\fR, \fBsuccess\fR, \fBfailure\fR, \fBexplanation\fR.
166
\fB--resolver\fR, \fB-r\fR \fIresolver\fR
167
Resolver to use (only IP address is accepted) for finding the information
168
about the tested zone,
169
by default the name servers used are the one specified in
170
\fI/etc/resolv.conf\fR. Note that for finding the name servers the zone
171
should already have been delegated.
174
\fB--ns\fR, \fB-n\fR \fInslist\fR
175
List of nameservers for the domain. Nameservers name are separated by
176
a semicolon, the name can be followed by the equal sign and its
177
IP addresses separated by a colon.
179
This can give the following example: ns1;ns2=ip1,ip2;ns3=ip3
182
\fB--quiet\fR, \fB-q\fR
183
Don't display extra titles.
186
\fB--one\fR, \fB-1\fR
187
Only display the most relevant message in a compact format.
190
\fB--tagonly\fR, \fB-g\fR
191
Display only tag. This option should be used for scripting.
194
\fB--verbose\fR, \fB-v\fR \fIoptions\fR
195
Display extra information, they can be prefix by '-' or '!'
196
to remove the effect, available options are:
201
Print a short summary about the domain name and its nameservers.
203
\fBtestname\fR, \fBn\fR
204
Print the name of the test when reporting a test status.
206
\fBexplain\fR, \fBx\fR
207
Print an explanation for failed tests (reference to RFC, ...).
209
\fBdetails\fR, \fBd\fR
210
Print a detailed description of the failure (name or value of the resource involved).
212
\fBreportok\fR, \fBo\fR
213
Report test even if they passed.
215
\fBfatalonly\fR, \fBf\fR
216
Only print fatal errors.
218
\fBtestdesc\fR, \fBt\fR
219
Print the test description before performing it.
221
\fBcounter\fR, \fBc\fR
222
Display a test progression bar (this option is not always available
223
according to the output media).
226
\fBtestdesc\fR and \fBcounter\fR are mutually exclusive.
230
\fB--output\fR, \fB-o\fR \fIoptions\fR
231
Output rendering/format selection, avalaible options are:
234
\fBbyseverity\fR, \fBbs\fR [default]
235
Output is sorted/merged by severity.
237
\fBbyhost\fR, \fBbh\fR
238
Output is sorted/merged by host.
240
\fBtext\fR, \fBt\fR [default]
247
Output XML. (experimental)
250
Use a GTK window to display the result (requires GTK binding).
253
The following set are mutually exclusive: [\fBbyseverity\fR|\fBbyhost\fR] and [\fBtext\fR|\fBhtml\fR].
257
\fB--error\fR, \fB-e\fR \fIoptions\fR
258
Behaviour in case of error, available options are:
261
\fBallfatal\fR, \fBaf\fR
262
All error are considered as fatals.
264
\fBallwarning\fR, \fBaw\fR
265
All error are considered as warnings.
267
\fBdfltseverity\fR, \fBds\fR [default]
268
Use the severity associated with the test.
270
\fBstop\fR, \fBs\fR [default]
271
Stop on the first fatal error.
273
\fIWARNING:\fR the current implementation stop on the first error but for each server.
275
\fBnostop\fR, \fBns\fR
276
Never stop (even on fatal error). This generally result in a lot of errors or unexpected results due to the previous fatal error.
279
The following set are mutually exclusive: [\fBallfatal\fR|\fBallwarning\fR|\fBdfltseverity\fR] and [\fBstop\fR|\fBnostop\fR].
283
\fB--transp\fR, \fB-t\fR \fIoptions\fR
284
Transport/routing layer selection, available options are:
287
\fBipv4\fR, \fB4\fR [default]
288
Use the IPv4 routing protocol.
290
\fBipv6\fR, \fB6\fR [default]
291
Use the IPv6 routing protocol.
294
Use the UDP transport layer.
297
Use the TCP transport layer.
299
\fBstd\fR, \fBs\fR [default]
300
Use the UDP with fallback to TCP for truncated messages.
303
\fBudp\fR, \fBtcp\fR and \fBstd\fR are mutually exclusive.
307
\fB--ipv4\fR, \fB-4\fR
308
Only check the zone with IPv4 connectivity.
311
\fB--ipv6\fR, \fB-6\fR
312
Only check the zone with IPv6 connectivity.
315
\fB--preset\fR \fIname\fR
316
Use of a preset configuration defined in the zc.conf configuration file.
319
\fB--option\fR \fIoptions\fR
320
Set extra options. The syntax is: -,-opt,opt,opt=foo
325
Specify the lang and eventually the encoding to use to display messages.
326
For examples: fr, fr_CA, fr.latin1, fr_CA.utf8, ...
329
Directory where the configuration file and the different profiles are located.
332
Name of the configuration file to use (defaul to zc.conf), it is
333
override by the \fB--config\fR option.
335
.I ZC_LOCALIZATION_DIR
336
Directory where all the localization files are located.
339
Directory where all the tests are located, it is override by the
340
\fB--testdir\fR option.
343
Path relative to the web server to use when generating HTML pages.
346
The variable as the same effect as the \fBdebug\fR parameter, but its
347
main advantage is that it is taken into account from the beginning of
351
The variable as the same effect as the undocumented \fBINPUT\fR parameter,
352
it allows to chose the input interface used by \fIZoneCheck\fR, the currently
353
supported values are: \fBcli\fR, \fBcgi\fR, \fBinetd\fR and \fBgtk\fR (requires GTK/ruby binding). But other interfaces doesn't accept the same parameters as the one described here.
356
Restrict the IP stack available to IPv4 or IPv6, for that set it respectively to 4 or 6.
357
This is particularly useful if you have an IPv6 stack on your computer but don't have the connectivity, in that case define ZC_IP_STACK=4.
360
If ruby-libxml is installed, this parser will be used instead of rexml for speed improvement, but you can force the use of rexml by setting ZC_XML_PARSER to rexml.
363
The following variables are mainly useful when it is not possible for the user to specify alternative value with the selected input interface: \fIZC_CONFIG_DIR\fR, \fIZC_CONFIG_FILE\fR, \fIZC_LOCALIZATION_DIR\fR, \fIZC_TEST_DIR\fR.
364
Such a case happen when using the cgi interface, and you don't want the user to read an arbitrary configuration file, but as the provider of the service you want to use another configuration.
367
The following exit status can be reported by \fIZoneCheck\fR:
370
Everything went fine, no fatal errors were reported, the domain configuration
374
The program completed but some tests failed with a fatal severity, the
375
domain is NOT correctly configured.
378
The program completed but some tests failed due with a fatal severity
379
due to \fItimeout\fR occuring, the domain has been considered as NOT correctly
380
configured, but you could want to check again later. \fIThis is currently
384
The user aborted the program before it's completion.
387
An error which is not directly related to the tests performed has occured
388
(ie: something went wrong).
391
The user (you?) didn't bother reading the man page...
395
\fB\fI/usr/local/etc/zonecheck/zc.conf\fB\fR
396
The default configuration file.
398
\fB\fI/usr/local/etc/zonecheck/*.rules\fB\fR
399
The test sequence to use for different domains.
401
\fB\fI/usr/local/libexec/zc/test\fB\fR
402
Contains the code of the tests performed by ZoneCheck.
404
\fB\fI/usr/local/libexec/zc/locale\fB\fR
405
Contains the different translations.
407
\fB\fI/usr/local/libexec/zc/www\fB\fR
408
Contains a website sample for the web interface.
412
Test the domain_name with IPv6 only connectivity, print
413
a summary information about the tested domain as well as explanations
414
and details of failed tests.
417
\fBzonecheck -6 --verbose=i,x,d domain_name\fP
421
Work in batch mode, where domains are read from stdin, a progress bar
422
indicates how many tests remain, and only short report is written.
425
\fBzonecheck -v c -1 -B -\fP
429
Ask for the 'error' message associated with the test 'soa'.
432
\fBzonecheck --testdesc error -T soa\fP
436
Only print tests which have failed and the result (succeed/failed),
437
this would be ideal for giving people, through email fir example,
438
a short description of why their domains are not correctly configured.
441
\fBzonecheck -q -vn,d,x,f domain_name\fP
445
If you want to test your domain, you will certainly like to use these
446
parameters (the use of IPv4 only as been forced because now people have
447
computer with IPv6 stack but very few have the IPv6 connectivity, so
448
autodetection will failed).
451
\fBzonecheck -4 -vi,x,d,c domain_name\fP
456
\fIRFC 1033\fR, \fIRFC 1034\fR, \fIRFC 1035\fR,
460
Stephane D'Alu with the help of people working at AFNIC is the author
461
of this version, but don't forget also to take a look at the CREDITS file
462
available in the distribution.
465
ZoneCheck was initiated and developed by engineers working at NIC France (INRIA's service) to check the correct configuration of a zone before delegating a domain name under .fr. Its development continued at AFNIC, which took over the activities of NIC France on January 1 1998.
467
ZoneCheck-1.* was created in 1995 by Benoit Grange and has been maintained by him until 1997. The prototype was a script using the dig command, which evolved into a perl program based on the DNS resolver Resolv5. Vincent Gillet maintained the programme in 1998. This task has been taken over by Erwan Mas and Philippe Lubrano from 1998 until now.
469
ZoneCheck-2.* is a rewrite from scratch done in ruby at the end of 2002 by Stephane D'Alu, so as to create a modular and extensible version. And is the current version of ZoneCheck.
472
Please send problems, bugs, questions, desirable enhancements,
473
source code contributions, by using the interface provided by:
476
http://savannah.nongnu.org/projects/zonecheck
479
You can also consult the \fIZoneCheck\fP homepage for more information:
482
http://www.zonecheck.fr/
added
removed
man/zonecheck.1
