<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" 
[
<!ENTITY version "$Name: ZC-2_0_4 $">
<!ENTITY faq     SYSTEM "common/faq.xml">
<!ENTITY config  SYSTEM "common/config.xml">
<!ENTITY install SYSTEM "common/install.xml">
]>


<book>
  <bookinfo>
    <title>ZoneCheck II</title>
    <author>
      <firstname>Stephane</firstname>
      <surname>D'Alu</surname>
    </author>
    <copyright>
      <year>2002</year>
      <holder role="mailto:zonecheck@nic.fr">AFNIC</holder>
    </copyright>
    <legalnotice>
      <para>This legal mumbo jumbo will stop evil.</para>
    </legalnotice>

    <releaseinfo>&version;</releaseinfo>

    <abstract>
      <para>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.

      ZoneCheck 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.
      </para>
    </abstract>
  </bookinfo>
  
  <chapter>
    <title>Installation</title>
      &install;
  </chapter>


  <chapter>
    <title>Configuration</title>
      &config;
  </chapter>

  <chapter>
    <title>Overview</title>

    <para>
    information
    warning
    fatal
    error
</para>

    <para>
    test description
    error message
    detailed error
    explanation
    referer
</para>
  </chapter>

  <chapter>
    <title>Internal</title>
      <para>toto</para>
  </chapter>


  <chapter>
    <title>Using ZoneCheck</title>
    
    <section>
      <title>Input</title>

      <section>
	<title>Command Line Interface (CLI)</title>


	<itemizedlist>
	  <listitem>
	    <para><option>--lang</option></para>
	    <para>Select another language (en, fr, ...). 
            The syntax is the same as for the environment variable
            <envar>LANG</envar>.</para>
	  </listitem>

	  <listitem>
	    <para><option>-d <replaceable>lvl</replaceable></option>, 
                  <option>--debug <replaceable>lvl</replaceable></option></para>
            <para> Select the debugging messages to print or activate
            debugging code.  This parameter will override the value of
            the environment variable <envar>ZC_DEBUG</envar>.</para>

	    <para> The available options are:
<segmentedlist>
<?dbhtml list-presentation="table"?>
<segtitle>Code</segtitle>
<segtitle>Description</segtitle>
<seglistitem><seg>0x0001</seg><seg>Initialisation</seg></seglistitem>
<seglistitem><seg>0x0002</seg><seg>Localization / Internationalisation</seg></seglistitem>
<seglistitem><seg>0x0004</seg><seg>Configuration</seg></seglistitem>
<seglistitem><seg>0x0008</seg><seg>Autoconf</seg></seglistitem>
<seglistitem><seg>0x0010</seg><seg>Loading tests</seg></seglistitem>
<seglistitem><seg>0x0020</seg><seg>Tests performed</seg></seglistitem>
<seglistitem><seg>0x0040</seg><seg>Debugging messages from tests</seg></seglistitem>
<seglistitem><seg>0x0400</seg><seg>Information about cached object</seg></seglistitem>
<seglistitem><seg>0x0800</seg><seg>Debugger itself</seg></seglistitem>

<seglistitem><seg>0x1000</seg><seg>Crazy Debug, don't try this at home!</seg></seglistitem>
<seglistitem><seg>0x2000</seg><seg>NResolv module debugging messages</seg></seglistitem>
<seglistitem><seg>0x4000</seg><seg>Disable caching</seg></seglistitem>
<seglistitem><seg>0x8000</seg><seg>Don't try to rescue exceptions</seg></seglistitem>
</segmentedlist>

            </para>
	  </listitem>

	  <listitem>
	    <para><option>-h</option>, <option>--help</option></para>
            <para>Show a short description of the different options  available  in <application>ZoneCheck</application></para>
	  </listitem>

	  <listitem>
	    <para><option>-V</option>, <option>--version</option></para>
	    <para>print the <application>ZoneCheck</application>
            version and exit</para>
	  </listitem>


	  <listitem>
	    <para><option>-q</option>, <option>--quiet</option></para>
	    <para>don't display extra titles</para>
	  </listitem>


	  <listitem>
	    <para><option>-B <replaceable>where</replaceable></option>, 
            <option>--batch <replaceable>where</replaceable></option></para>
            <para>read data from the file specified by <replaceable>where
            </replaceable> (<literal>stdin</literal> is used if 
            '<literal>-</literal>' is specified)</para>
	  </listitem>

	  <listitem>
	    <para><option>-c <replaceable>cfgfile</replaceable></option>,
	    <option>--config <replaceable>cfgfile</replaceable></option></para>
            <para>specify the location of the configuration file
            (default is <filename>etc/zonecheck/zc.conf</filename>)</para>
	  </listitem>

	  <listitem>
	    <para><option>--testdir <replaceable>directory</replaceable></option></para>
	    <para>specify the <replaceable>directory</replaceable>
	    where all the tests are located</para>
	  </listitem>

	  <listitem>
	    <para><option>-C
	    <replaceable>catlist</replaceable></option>,
	    <option>--category <replaceable>catlist</replaceable></option>
            </para>
	    <para>limit the test to the specified category list
	    (<replaceable>catlist</replaceable>); the list is comma
	    separeted and we stop on the first match. If the category
	    start with <literal>-</literal> or <literal>!</literal>
	    the test should not belong to that category, if it starts
	    with nothing or <literal>+</literal> the test should
	    belong to it. It is possible to have subcategories which
	    are delimited by <literal>:</literal>. Here is an example
	    that says don't perform DNS tests that are not SOA
	    related: <literal>dns:soa,!dns,+</literal></para>
	  </listitem>

	  <listitem>
	    <para><option>-T <replaceable>testname</replaceable></option>,
            <option>--test <replaceable>testname</replaceable></option></para>
	    <para>only the test <replaceable>testname</replaceable> will
            be performed and its severity will default to 
            <literal>fatal</literal></para>
	  </listitem>

	  <listitem>
	    <para><option>-r <replaceable>host</replaceable></option>,
            <option>--resolver <replaceable>host</replaceable></option></para>
	    <para>the nameserver running on <replaceable>host</replaceable>
            will be used as the local resolver instead of taking this
            information from <filename>/etc/resolv.conf</filename></para>
	  </listitem>

	  <listitem>
	    <para><option>-n <replaceable>nameservers</replaceable></option>,
            <option>--ns <replaceable>nameservers</replaceable></option></para>

	    <para><replaceable>nameservers</replaceable> is the exhaustive
            list of nameservers that are primary or secondary for the zone,
            they are separated by a semicolon, if IP
	    addresses should be specified the hostname must be
	    followed by the equal sign and a coma separated list of
	    IP addresses. For example: <literal>ns1.toto.fr=192.168.1.5,192.168.1.6;ns2.toto.fr</literal> </para>
	  </listitem>

	  <listitem>
	    <para><option>-1</option>, <option>--one</option></para>
	    <para>only display the most relevant message, particularly 
            useful for batch mode</para>
	  </listitem>

	  <listitem>
	    <para><option>-g</option>, <option>--tagonly</option></para>
	    <para>display tag instead of sentences, this option should be used
             when writing scripts</para>
	  </listitem>

	  <listitem>
	    <para><option>-e <replaceable>list</replaceable></option>, 
            <option>--error <replaceable>list</replaceable></option></para>
	  </listitem>

	  <listitem>
	    <para><option>-t <replaceable>list</replaceable></option>,
            <option>--transp <replaceable>list</replaceable></option></para>
<para><replaceable>list</replaceable></para>
	  </listitem>

	  <listitem>
	    <para><option>-v <replaceable>list</replaceable></option>,
            <option>--verbose <replaceable>list</replaceable></option></para>
<para><replaceable>list</replaceable></para>
	  </listitem>

	  <listitem>
	    <para><option>-o <replaceable>list</replaceable></option>,
             <option>--output <replaceable>list</replaceable></option></para>
<para><replaceable>list</replaceable></para>
	  </listitem>

	  <listitem>
	    <para><option>-4</option>, <option>--ipv4</option></para>
	    <para>use IPv4 connectivity only</para>
	  </listitem>

	  <listitem>
	    <para><option>-6</option>, <option>--ipv6</option></para>
	    <para>use IPv6 connectivity only</para>
	  </listitem>

	  <listitem>
	    <para><option>--testlist</option></para>
	    <para>list all the available tests</para>
	  </listitem>

	  <listitem>
	    <para><option>--testdesc <replaceable>type</replaceable></option></para>
	    <para><replaceable>type</replaceable>s is one of the keyword

<literal>name</literal> <literal>expl</literal> <literal>error</literal></para>
	  </listitem>

	</itemizedlist>

	<screen>% <userinput>zc -4 -v c,x,d,i afnic.fr</userinput>
ZONE  : afnic.fr.
NS &lt;= : ns1.nic.fr. [192.93.0.1]
NS    : ns2.nic.fr. [192.93.0.4]
NS    : ns3.nic.fr. [192.134.0.49, 2001:660:1180:1:192:134::49]

==&gt; SUCCED
</screen>
      </section>
      
      <section>
	<title>Common Gateway Interface (CGI)</title>
      <para>
	<itemizedlist>
	  <listitem>
 <para><option>lang</option> = [ fr | en | ... ]</para>
          </listitem>
 <listitem> 
<para>quiet</para></listitem>
 <listitem> 
<para> - one\n</para></listitem>
 <listitem> 
<para> - verbose  = [ i|intro, n|testname, x|explain, d|details,\n\
                t|testdesc, c|counter, o|reportok ]\n\
	<itemizedlist>
	  <listitem><para>
     - intro\n\</para></listitem>
<listitem><para>          - testname\n\</para></listitem>
<listitem><para>     - explain\n\</para></listitem>
<listitem><para>     - details\n\</para></listitem>
<listitem><para>     - progress = [ t|testdesc | c|counter ]\n\</para></listitem>
<listitem><para>     - reportok\n\</para></listitem>
</itemizedlist>
</para>
</listitem>
 <listitem> 
<para> - output   = [ bs|byseverity, bh|byhost, t|text, h|html ]\n\
     - report   = bs|byseverity | bh|byhost\n\
     - format   = h|html | text\n\</para></listitem>
 <listitem> 
<para> - error    = [ af|allfatal, aw|allwarning, std|standard,\n\
                s|stop, ns|nostop ]\n\
     - errorlvl  = [ af|allfatal | aw|allwarning | std|standard ]\n\
     - dontstop \n\</para></listitem>
 <listitem> 
<para> - transp   = [ ipv4, ipv6, udp, tcp, std ]\n\
     - transp3   = [ ipv4, ipv6 ]\n\
     - transp4   = [ udp | tcp | std ]\n\</para></listitem>
 <listitem> 
<para> - category = cat1,!cat2:subcat1,cat2,!cat3,+\n\
     - chkmail (!mail)\n\
     - chkrir  (!rir)\n\
     - chkzone (!dns:axfr)\n\</para></listitem>
 <listitem> 
<para> - ns       = ns1=ip1,ip2;ns2=ip3;ns3\n\
               (WARNING: in URL '%3b' should be used instead of ';')\n\
     - ns0  .. nsX   = nameserver name\n\
     - ips0 .. ipsX  = coma separated ip addresses\n\</para></listitem>
 <listitem> 
<para> - zone     = zone to test\n\</para></listitem>

</itemizedlist>
</para>
      </section>
      
      <section>
	<title>Graphical User Interface (GUI)</title>
      <para>toto


<screenshot>
<graphic scalefit="1" scale="50%" fileref="../pics/gtk_input.png"/>
</screenshot>

<screenshot>
<graphic scalefit="1" scale="50%" fileref="../pics/gtk_option.png"/>
</screenshot>

<screenshot>
<graphic scalefit="1" scale="50%" fileref="../pics/gtk_expert.png"/>
</screenshot>




</para>
      </section>
    </section>

    <section>
      <title>Output</title>
      
      <section>
	<title>Text</title>
      <para>toto</para>
      </section>

      <section>
	<title>HTML</title>
      <para>toto</para>
      </section>

      <section>
	<title>GTK</title>
      <para>toto</para>
      </section>
    </section>

  </chapter>


  <chapter>
    <title>FAQ</title>
      
 &faq;  

  </chapter>


  <chapter>
    <title>Writing tests</title>
    
    <section>
      <title>Available methods</title>
      <para>titi</para>
    </section>

    <section>
      <title>Framework</title>
      <para>titi</para>
    </section>

    <section>
      <title>Localisation</title>
      <para>The format of the message catalog is as follow:
<screen> line       : '#' comment              # a comment
            | tag ':' definition       # a tag definition
            | tag '=' tag              # a link to another tag
            | '[' prefix ']'           # a prefix to append to other tags

 prefix     : tag                      # the tag to use as prefix
            | '*'                      # don't use a prefix

 definition : string                   # a string
            | string '\' definition    # with posibility of continuation '\'

 tag        : [a-zA-Z0-9_]+</screen>



</para>
    </section>


  </chapter>

  <chapter>
    <title>About this book</title> 
    <para>
      This book was hard
      work if you look at the history and momentum behind the LDP and
      DocBook and SGML and XML and....and....and...</para>
    
    <section><title>Copyrights and Trademarks</title> <para>Copyright
	&copy; 2001 Foo Bar</para>
    </section>

    <section><title>Purpose/Scope</title> 
      <para>This guide is tightly scoped with one purpose; to process.</para>
    </section>
  </chapter>
  

  <appendix>
    <title>Implemented tests</title>
      <para>toto</para>
  </appendix>
</book>