Better looking frontpage

[yaz-moved-to-github.git] / doc / installation.xml

diff --git a/doc/installation.xml b/doc/installation.xml
index 02d6c98..7f55b56 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.16 2003-03-18 13:30:21 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.19 2003-11-19 21:17:26 adam Exp $ -->
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1><title>Introduction</title>
@@ -248,56 +248,77 @@
     <para>
      The following files are generated by the make process:
      <variablelist>
-      <varlistentry><term><filename>lib/libyaz.la</filename></term>
+      <varlistentry><term><filename>src/libyaz.la</filename></term>
        <listitem><para>
          Main &yaz; library. This is no ordinary library. It's
          a Libtool archive.
          By default, &yaz; creates a static library in 
          <filename>lib/.libs/libyaz.a</filename>.
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
       
-      <varlistentry><term><filename>lib/libyazthread.la</filename></term>
+      <varlistentry><term><filename>src/libyazthread.la</filename></term>
        <listitem><para>
          When threading is supported/enabled by configure this Libtool
          library is created. It includes functions that allows &yaz;
          to use threads.
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
       
       <varlistentry><term><filename>ztest/yaz-ztest</filename></term>
        <listitem><para>Test Z39.50 server. 
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
       
       <varlistentry><term><filename>client/yaz-client</filename></term>
        <listitem><para>Z39.50 client for testing the protocol.
          See chapter <link linkend="client">
           YAZ client</link> for more information.
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
       
-      <varlistentry><term><filename>yaz-config</filename></term>
+      <varlistentry><term><filename>util/yaz-config</filename></term>
        <listitem><para>A Bourne-shell script, generated by configure, that
          specifies how external applications should compile - and link with
          &yaz;.
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
       
-      <varlistentry><term><filename>yaz-comp</filename></term>
+      <varlistentry><term><filename>util/yaz-asncomp</filename></term>
        <listitem><para>The ASN.1 compiler for &yaz;. Requires the
          Tcl Shell, <application>tclsh</application>, in
          <literal>PATH</literal> to operate.
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
+      
+      <varlistentry><term><filename>util/yaz-iconv</filename></term>
+       <listitem><para>This program converts data in one character set to
+        another. This command exercises the YAZ character set
+        conversion API.
+        </para></listitem>
+      </varlistentry>
+       
+      <varlistentry><term><filename>util/yaz-marcdump</filename></term>
+       <listitem><para>This program parses ISO2709 encoded MARC records
+        and prints them in line-format or XML.
+        </para></listitem>
+      </varlistentry>
       
-      <varlistentry><term><filename>zoom/zoomsh</filename></term>
+     <varlistentry><term><filename>zoom/zoomsh</filename></term>
        <listitem><para>
          A simple shell implemented on top of the 
          <link linkend="zoom">ZOOM</link> functions.
          The shell is a command line application that allows you to enter
          simple commands to perform ZOOM operations.
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
       
       <varlistentry><term><filename>zoom/zoomtst1</filename>, 
         <filename>zoom/zoomtst2</filename>, ..</term>
        <listitem><para>
          Several small applications that demonstrates the ZOOM API.
-        </para></listitem></varlistentry>
+        </para></listitem>
+      </varlistentry>
      </variablelist>
      
     </para>
@@ -458,6 +479,22 @@
       </varlistentry>
 
       <varlistentry>
+       <term><literal>HAVE_BISON</literal>,
+        <literal>BISON</literal></term>
+       <listitem><para>
+         If GNU Bison is present, you might set <literal>HAVE_ICONV</literal>
+         to 1 and specify the Bison executable in <literal>BISON</literal>.
+         Bison is only required if you use the CVS version of
+         YAZ or if you modify the grammar for CQL
+         (<filename>cql.y</filename>).
+        </para>
+        <para>
+         GNU Bison for Windows is part of 
+         <ulink url="http://unxutils.sourceforge.net/">unxutils</ulink>.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
        <term><literal>HAVE_ICONV</literal>,
         <literal>ICONV_DIR</literal></term>
        <listitem><para>
@@ -466,7 +503,7 @@
          <literal>ICONV_DIR</literal> to the iconv source directory.
         </para></listitem>
       </varlistentry>
-
+      
       <varlistentry>
        <term><literal>HAVE_LIBXML2</literal>,
         <literal>LIBXML2_DIR</literal></term>
@@ -479,7 +516,7 @@
         </para>
 
         <para>
-         You can get libxml2 and iconv binaries from
+         Windows versions of libxml2 and iconv can be found
          <ulink url="http://www.zlatkovic.com/projects/libxml/binaries.html">
           here</ulink>.
         </para>