README
1
2/*
3** Distributed with 'doc' Version 2.2.2 from <Brad Knowles> 20010514
4*/
5
6UPDATED RELEASE: 2.2.2 (2001/05/14)
7
8Merged changes from previous private-only version of doc 2.1.5 into
9the 2.2.1 version I received from Jim Griffin.
10
11=====================================================
12
13UPDATED RELEASE: 2.2.1 (20010330)
14
15Updated contact information. Modified 'doc' shell script and
16supporting awk programs to accommodate changes in command line
17options (+pfset) and reply format (SOA) introduced with BIND 9.+.
18Corrected list of DiG error status returns and modified 'diff'
19commands to ignore changes in amount of white space, blank lines,
20or case.
21
22=====================================================
23
24UPDATED RELEASE: 2.1.5 (2001/05/13)
25
26There have been a couple of updates since this file was last
27modified. This script has now been modified to work with the "dig"
28utility that comes with BIND version 8, as opposed to the version
29of "dig" that came with BIND 4 (primarily just changing some
30arguments that are used/recognized).
31
32In addition, I've updated references to addresses and dates, and
33I've added a feature whereby we check to see if any of the nameservers
34we encounter support the "version.bind" record (new with BIND 8),
35and if so we log the contents of their response to our query.
36
37This is likely to be the last release of doc for BIND 8, as BIND
389 has been out a while, and we need to modify the code yet once
39again, because the arguments to dig have changed yet once again.
40So far, all efforts to produce a unified version of doc that can
41deal with any version of dig have failed.
42
43=====================================================
44
45UPDATED RELEASE: 2.1.2 (7/12/95)
46
47Updated all references to employers and email addresses, resulting
48from a recent change in employment. Verified that recent code changes
49in the way BIND 4.9.3-BETA20 (up to 4.9.3-BETA24) reports certain
50information does not break doc.
51
52=====================================================
53
54UPDATED RELEASE: 2.1.1 (5/27/95)
55
56Added code to handle more robustly parent (delegating) domains that
57are not one level up from the domain being tested.
58
59Added code to force entire domain string to be all lower case, since
60the DNS is not case-sensitive (and keeping the case caused some
61comparisons to fail).
62
63=====================================================
64
65UPDATED RELEASE: 2.1 (2/16/95)
66
67Took over maintenance of DOC from previous authors.
68
69Added code to do the equivalent of a "sort | uniq" on the NS records
70returned by dig. Otherwise, the ADDAUTH option of recent versions of
71BIND could return a set of nameservers in the DATA section as well as
72the AUTHORITY section, and unnecessary checking would be performed.
73
74=====================================================
75
76UPDATED RELEASE: 2.0.1 (9/12/90)
77
78Includes fixes for two portability bugs:
79
80 1) On some systems (e.g. SunOS 4.1), the shell exit code is an unsigned
81 8 bit value. This differs from the development environment where
82 negative values were also returned. This affected values
83 returned by auxiliary files: doc1.awk & doc3.awk.
84
85 2) Some shells did not handle things like "@ cnt2++ " correctly.
86 Variable names were changed where appropriate.
87
88=====================================================
89
90Greetings,
91
92This is a the second public release of Doc - Version 2.1.
93Doc (domain obscenity control) is a program which diagnoses
94misbehaving domains by sending queries off to the appropriate
95DNS nameservers, and performing simple analysis on the responses.
96
97IMPORTANT: Doc requires version 2.0 of the DNS query tool `dig`
98 (domain internet groper).
99
100Files contained in this distribution:
101
102README - You're looking at it.
103INFO - Documents current procedure
104doc.8 - man page
105doc.txt - ASCII man page
106doc - Shell script for automated domain test
107doc1.awk - simple awk file used by `doc`
108doc3.awk - simple awk file used by `doc`
109doc4.awk - simple awk file used by `doc`
110RFC.XXXX - Draft of RFC about Automated Domain testing
111log.isi.edu. - Sample run for isi.edu. domain
112
113
114Required files NOT in the distribution:
115
116Dig (Version 2.0) - DNS query program required to run `doc`
117 Available via anonymous ftp from:
118 venera.isi.edu. pub/dig.2.0.tar.Z
119
120
121SETUP/CONFIGURATION
122
123'Doc' is a csh script, so no complex porting effort will be required.
124Other than the first few aliases and pointers to directories that you
125will edit in the 'doc' shell file itself, no changes should be necessary.
126
127
128Doc-V.2.1 is an initial implementation of an automated domain testing
129tool. We expect considerable design modification and implementation
130changes to be made as experience is gained through use in the
131Internet. At some point, we expect the design to stabilize and a
132production version, implemented in something other than the current
133UNIX-tool patchwork, to be released.
134
135Comments and discussion are very much welcome.
136
137Brad Knowles (BKnowles@aol.net)
138