X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=2c17e0a906f60d825d397cefb6fdd0d0c2a4e829;hb=7a60e6ae656c6bc2825b6244c88bbd59106f3da9;hp=9e445d4bc9ae3922fe218ebd285abc66b77de6f4;hpb=10e81e043068151fd32d623ace21222ab6c91ea3;p=yaz-moved-to-github.git

diff --git a/doc/installation.xml b/doc/installation.xml
index 9e445d4..2c17e0a 100644
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.15 2003-02-18 20:21:22 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.24 2004-05-01 23:45:43 adam Exp $ -->
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1><title>Introduction</title>
@@ -12,34 +12,31 @@
    <para>
     We have tried our best to keep the software portable, and on many
     platforms, you should be able to compile everything with little or
-    no changes.
-    So far, the software has been ported to the following platforms with
-    little or no difficulties.
-    
-    <itemizedlist>
-     <listitem><para>Unix systems</para>
-      <itemizedlist>
-       <listitem><para>HP/UX</para></listitem>
-       <listitem><para>SunOS/Solaris</para></listitem>
-       <listitem><para>DEC Unix</para></listitem>
-       <listitem><para>BSDs: FreeBSD, OpenBSD, NetBSD</para></listitem>
-       <listitem><para>MAC OSX</para></listitem>
-       <listitem><para>Linux</para></listitem>
-       <listitem><para>IBM AIX</para></listitem>
-       <listitem><para>Data General DG/UX (with some CFLAGS tinkering)
-        </para></listitem>
-       <listitem><para>SGI/IRIX</para></listitem>
-       <listitem><para>DDE Supermax</para></listitem>
-      </itemizedlist></listitem>
-     <listitem><para>Non-unix systems</para>
-      <itemizedlist>
-       <listitem><para>Apple Macintosh (using the Codewarrior programming
-         environment and the GUSI socket libraries)</para></listitem>
-       <listitem><para>MS Windows 95/98/NT/2K/XP (Win32)</para></listitem>
-       <listitem><para>IBM AS/400</para></listitem>
-      </itemizedlist></listitem>
-    </itemizedlist>
-    
+    no changes. 
+   </para>
+
+   <para>
+    The software is regularly tested on
+    <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>,
+    <ulink url="http://www.redhat.com/">Redhat Linux</ulink>,
+    <ulink url="http://www.gentoo.org/">Gentoo Linux</ulink>,
+    <ulink url="http://www.freebsd.org/">FreeBSD (i386)</ulink>,
+    <ulink url="http://www.apple.com/macosx/">MAC OSX</ulink>,
+    <ulink url="http://wwws.sun.com/software/solaris/">
+     SunOS 5.8 (sparc)</ulink>,
+    <ulink url="http://www.microsoft.com/windows2000/">
+     Windows 2000</ulink>.
+   </para>
+   
+   <para>
+    Some versions have be known to work on HP/UX,
+    DEC Unix, <ulink url="http://www.netbsd.org/">NetBSD</ulink>,
+    <ulink url="http://www.openbsd.org/">OpenBSD</ulink>,
+    IBM AIX,
+    Data General DG/UX (with some CFLAGS tinkering),
+    SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
+    environment and the GUSI socket libraries),
+    IBM AS/400 .
    </para>
 
    <para>
@@ -74,7 +71,7 @@
     and 
     <ulink url="http://www.redhat.com/">Redhat</ulink> packages for &yaz;. 
     Only i386 binary packages are available. You should be able to
-    create packages for other CPU's by building them from the source
+    create packages for other CPUs by building them from the source
     package.
    </para>
    
@@ -97,7 +94,7 @@
 
     <para>
      The XML C library <ulink url="http://www.xmlsoft.org/">libxml2</ulink>
-     is required if &yaz; is to support SRW (and SOAP).
+     is required if &yaz; is to support SRW and SRU.
      This library is very portable and should compile out-of-the
      box on virtually all Unix platforms. It is available in binary
      forms for Linux and others.
@@ -253,56 +250,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>
@@ -426,8 +444,8 @@
     <para>
      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
      with <ulink url="http://msdn.microsoft.com/vstudio/">
-      Microsoft Visual C++</ulink>.
-     Version 6 has been tested. We expect that &yaz; compiles
+      Microsoft Visual Studio</ulink>.
+     Version 6 and .NET has been tested. We expect that &yaz; compiles
      with version 5 as well.
     </para>
     <para>
@@ -463,6 +481,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>
+         A Windows version of GNU Bison 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>
@@ -471,23 +505,31 @@
          <literal>ICONV_DIR</literal> to the iconv source directory.
         </para></listitem>
       </varlistentry>
-
+      
       <varlistentry>
        <term><literal>HAVE_LIBXML2</literal>,
         <literal>LIBXML2_DIR</literal></term>
        <listitem>
         <para>
          If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
-         with SRW (and SOAP) support. In this configuration, set 
+         with SRW and SRU support. In this configuration, set 
          <literal>LIBXML2_DIR</literal> to the 
-         <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory.
+         <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory
+	 and
+	 <literal>ZLIB_DIR</literal> to the zlib directory.
         </para>
 
         <para>
-         You can get libxml2 and iconv binaries from
-         <ulink url="http://www.zlatkovic.com/projects/libxml/binaries.html">
-          here</ulink>.
+         Windows versions of libxml2, zlib and iconv can be found
+	 <ulink url="http://www.zlatkovic.com/libxml.en.html">
+	  Igor Zlatkovi&#x0107;' site</ulink>.
         </para>
+
+	<note>
+	 <para>
+	  YAZ is not using ZLIB. But libxml2 is.
+	 </para>
+	</note>
        </listitem>
       </varlistentry>