"Fossies" - the Fresh Open Source Software Archive

Member "doc-2.2.3/doc.txt" (12 Jul 1995, 8647 Bytes) of package /linux/misc/dns/old/doc-2.2.3.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 
    2 
    3 
    4  DOC(8)                                                               DOC(8)
    5                                    7/12/95
    6 
    7 
    8 
    9  NAME
   10       doc - diagnose unhealthy DNS domains
   11 
   12  SYNOPSIS
   13       doc [-p] [-e][-w][-v][-d] domain_name [parent_domain_name]
   14 
   15  DESCRIPTION
   16       Doc is an automated tool for verifying (to an extent) that a domain is
   17       configured and functioning correctly.  It makes no attempt to validate
   18       the data inside a domain, only the structure.  The only required
   19       parameter is the valid domain name of an existing domain.  Example:
   20 
   21                 doc isi.edu.
   22 
   23       Previous versions of doc required that you specify the parent
   24       (delegating) domain if it was not precisely one level up from the
   25       domain being checked (or specify the parent nameservers in an
   26       appropriately named file).  Although the option still exists to do
   27       that (and it may be required with some complex configurations), some
   28       heuristics have been added that make some attempt to handle parent
   29       domains that are more than one level up from the current domain.
   30       Additional "short-cut" heuristics have been added in the "in-
   31       addr.arpa" case.  Examples:
   32 
   33            doc isi.edu. edu.             (correct, but not required)
   34            doc isi.edu.                  (this works too)
   35            doc 9.128.in-addr.arpa. arpa. (correct, but not required)
   36            doc 9.128.in-addr.arpa.       (this works too)
   37 
   38       If you have problems, giving the parent information information
   39       explicitly may help.
   40 
   41 
   42  OPTIONS
   43       -p   Skip testing the information held at delegating domain's servers.
   44 
   45            The default operation of doc includes testing that all of the
   46            servers for the delegating (parent) domain agree about the
   47            delegation information held for the domain in question.  Since
   48            inconsistencies discovered at this level may or may not indicate
   49            serious problems, one can choose to skip the parent testing.  If
   50            so, doc uses the first non-authoritative list of NS records from
   51            a parent domain server as those to direct further queries.  If
   52            all of the parent domain servers are additionally authoritative
   53            for the domain, the answer from the last one queried is used.
   54            This may be a useful timesaver if you are regularly checking up
   55            on a large number of domains.  [See also section FILES USED for a
   56            similar functionality.]
   57 
   58 
   59 
   60 
   61 
   62 
   63                                     - 1 -          Formatted:  July 12, 1995
   64 
   65 
   66 
   67 
   68 
   69 
   70  DOC(8)                                                               DOC(8)
   71                                    7/12/95
   72 
   73 
   74 
   75       -[e][w][v][d]  Specify the level of verbosity to standard output.
   76 
   77            The default mode of operation is to only print to standard output
   78            a summary of what is discovered.  In addition, errors made in the
   79            process of testing (i.e. query errors, errors causing doc to
   80            abort, etc) are noted.
   81 
   82                -e    Output comments about errors discovered.
   83                -w    Output comments about warnings issued.
   84                -v    Verbose output. Include misc. comments and output
   85                      confirming correct behavior.
   86                -d    Debug output. Checkpoint current (last)
   87                      nameserver query.
   88 
   89            These output options are cumulative (i.e. -v implies -v -w -e).
   90 
   91            NOTE: Parsing is very simple.  All option flags must come before
   92            the domain names.
   93 
   94  FILES CREATED
   95       In addition to the standard output, doc produces a log file named
   96       log.<domain_name>, which it places in the current directory.  This
   97       file includes all "verbose" level comments, followed by the nameserver
   98       responses to the queries (in a slightly masticated form).
   99 
  100       While running, doc creates several temporary files in the current
  101       directory.  These files have names of the form:
  102 
  103            <domain_name>.*
  104 
  105  FILES USED
  106       Doc expects the auxiliary files: doc1.awk, doc3.awk, and doc4.awk to
  107       reside in the current working directory.  This can be overridden by
  108       changing the program to look for them in a directory indicated in a
  109       shell variable intended for this purpose.  If your System
  110       Administrator installed doc, they'll need to make the necessary
  111       modification.
  112 
  113       Doc looks for the file DNsrv.<parent_domain_name> in the working
  114       directory.  If it exists, doc does not make a standard query to
  115       discover the list of nameservers for the parent domain.  Rather it
  116       queries the list of servers contained in this file to obtain
  117       delegation information for the domain being tested.  This may be
  118       useful if one regularly tests a series of domains, all with the same
  119       delegating zone, where one of the servers in known to be foul.  This
  120       server would simply be omitted from the the DNsrv.* file.
  121 
  122       awk, sed & dig (version 2.0 or higher) are expected to be found in
  123       your normal path.  If not, you may want to alias to the full path
  124       inside of doc itself.
  125 
  126 
  127 
  128 
  129                                     - 2 -          Formatted:  July 12, 1995
  130 
  131 
  132 
  133 
  134 
  135 
  136  DOC(8)                                                               DOC(8)
  137                                    7/12/95
  138 
  139 
  140 
  141  DETAILS
  142       See file INFO (included with distribution tar) for details of
  143       procedure.
  144 
  145 
  146  BUGS
  147       The exit code returned via the shell is only 8 bits.  This could cause
  148       a problem in the value returned by the auxiliary file doc3.awk.  This
  149       hasn't been seen yet (a "poison configuration" is not likely to occur
  150       yet), and hopefully will be corrected if/when doc is re-implemented
  151       (see below).
  152 
  153       The current implementation is fairly simple (albeit not pretty), so it
  154       is not expected to abort unexpectedly.  However, this version (2.0) is
  155       an initial attempt at automating this task.  Further development is
  156       expected in identifying the appropriate queries, analysis, and
  157       subsequent conclusions that are made.  Hopefully once the design of
  158       the test suite has become more stable, a less "patchwork" production
  159       version of doc will be done.
  160 
  161  COMMENTS
  162       The previous authors effectively stopped further development and
  163       support in 1990.  Starting with version 2.1, the official anonymous
  164       FTP site for doc is ftp.vix.com as part of the the latest distribution
  165       of BIND (see the BIND Home Page at <URL:http://www.isc.org/isc/>).  It
  166       will also be separately available in the DNS Resources Directory
  167       <URL:http://www.is.co.za/andras/computer/dnsrd/>.
  168 
  169       Relatively minor modifications have been made with version 2.1, mostly
  170       to make the program a bit more robust in handling parent (delegating)
  171       domains.
  172 
  173       This program is being shared with the rest of the Internet on a
  174       unsupported basis.  If you have any enhancements or changes you have
  175       made, please let me know.  I'd love to see them, with an eye towards
  176       integrating them into my version (and also into the publicly available
  177       version).  However, keep in mind that I'm not getting paid (nor do I
  178       have the time) to support the whole Internet on this tool.
  179 
  180       Now that I have changed employers, and I am going to be involved in
  181       writing all sorts of administrative tools for our internal use, I
  182       intend to use doc and some other programs as "excuses" to learn Perl
  183       and Tcl/Tk.  I hope to make these updated version publicly available,
  184       but I have yet to get formal approval for that.  I will make available
  185       whatever I can, likely through the URLs provided above, and through
  186       related URLs that will be widely publicized.
  187 
  188  INFO
  189       The name doc comes from Domain Obscenity Control, in that the kinds of
  190       structure problems it looks for are considered "obscene" from the
  191       perspective of a well-managed DNS.
  192 
  193 
  194 
  195                                     - 3 -          Formatted:  July 12, 1995
  196 
  197 
  198 
  199 
  200 
  201 
  202  DOC(8)                                                               DOC(8)
  203                                    7/12/95
  204 
  205 
  206 
  207  TO DO
  208       RFC 1537 SOA value conformance checking (warnings only).
  209 
  210  PREVIOUS AUTHORS
  211       Steve Hotz (hotz@isi.edu) Paul Mockapetris (pvm@isi.edu)
  212 
  213  MODIFICATIONS BY
  214       Brad Knowles (BKnowles@aol.net)
  215 
  216  SEE ALSO
  217       dig(1),  bind operators guide (BOG),  RFCs: 1034,1035,1535-
  218       1537,1713,xxxx
  219 
  220 
  221 
  222 
  223 
  224 
  225 
  226 
  227 
  228 
  229 
  230 
  231 
  232 
  233 
  234 
  235 
  236 
  237 
  238 
  239 
  240 
  241 
  242 
  243 
  244 
  245 
  246 
  247 
  248 
  249 
  250 
  251 
  252 
  253 
  254 
  255 
  256 
  257 
  258 
  259 
  260 
  261                                     - 4 -          Formatted:  July 12, 1995
  262 
  263 
  264