From b50ddc6f811f402f79851ea90c78295f06a1e030 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 3 Sep 2013 12:14:14 -0400 Subject: [PATCH] Add the DNS ERRORS section to the man page, in preparation for the dns library bump. --- doc/man1/haeredes.1 | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/man1/haeredes.1 b/doc/man1/haeredes.1 index 900b4c6..a614993 100644 --- a/doc/man1/haeredes.1 +++ b/doc/man1/haeredes.1 @@ -91,6 +91,28 @@ example, to use 10 threads, .nf $ haeredes [OPTIONS] [DELEGATES] \fI+RTS -N10\fR .fi +.SH DNS ERRORS +.P +There are three types of DNS errors that can occur: +.nr step 1 1 +.IP \n[step] 2 +Timeouts. If the query times out, we don't get an answer back. The +timeout can be adjusted with the \fB\-\-timeout\fR flag. +.IP \n+[step] +Sequence number mismatches. Every DNS query is sent with a sequence +number; if the response has a different sequence number than the one +we sent, something is wrong (foul play, or a bug somewhere in the +stack). +.IP \n+[step] +Unexpected RDATA. If we ask for an \fIA\fR record, we expect to get a +response for an \fIA\fR record. If we get something else -- well, +something went wrong. +.P +Haeredes is designed to ignore these errors. A timeout or bad response +to a query is not an indication that something is wrong with the DNS +for the supplied domains. There might be something else wrong with +your (caching/recursive) DNS infrastructure, but it isn't one of the +problems that Haeredes is designed to detect. .SH OPTIONS .IP \fB\-\-no\-append\-root\fR,\ \fB-n\fR -- 2.44.2