X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=8ea4d7892b001a9859ee13e9665029d252c6e728;hb=2ba3d1d3bf2b57c7ac462b347cb18f06820ac73a;hp=0523298026eb29c4070aa56e1a27301f1eef971d;hpb=103dc949161eb23f38ee58cffcf8f039ef679cb8;p=yaz-moved-to-github.git

diff --git a/doc/installation.xml b/doc/installation.xml
index 0523298..8ea4d78 100644
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.18 2003-05-27 21:44:10 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.26 2004-08-19 07:48:00 adam Exp $ -->
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1><title>Introduction</title>
@@ -20,21 +20,23 @@
     <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.netbsd.org/Ports/cobalt/">
-     NetBSD (Cobalt MIPS)</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 SP3</ulink>.
+     Windows 2000</ulink>.
    </para>
    
    <para>
     Some versions have be known to work on HP/UX,
-    DEC Unix, OpenBSD, IBM AIX, Data General DG/UX (with some CFLAGS tinkering),
+    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 .
+    environment and the GUSI socket libraries),
+    IBM AS/400 .
    </para>
 
    <para>
@@ -69,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>
    
@@ -92,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.
@@ -248,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-asncomp</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>zoom/zoomsh</filename></term>
+      <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>
        <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>
@@ -421,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>
@@ -468,7 +491,7 @@
          (<filename>cql.y</filename>).
         </para>
         <para>
-         GNU Bison for Windows is part of 
+         A Windows version of GNU Bison is part of 
          <ulink url="http://unxutils.sourceforge.net/">unxutils</ulink>.
         </para></listitem>
       </varlistentry>
@@ -489,16 +512,24 @@
        <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>
-         Windows versions of libxml2 and iconv can be found
-         <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>
 
@@ -534,7 +565,7 @@
      <variablelist>
       <varlistentry><term><filename>bin/yaz.dll</filename></term>
        <listitem><para>
-         &yaz; multi-threaded Dynamic Link Library.
+         &yaz; release mode multi-threaded Dynamic Link Library.
         </para></listitem></varlistentry>
       
       <varlistentry><term><filename>lib/yaz.lib</filename></term>
@@ -542,6 +573,16 @@
          Import library for <filename>yaz.dll</filename>.
         </para></listitem></varlistentry>
       
+      <varlistentry><term><filename>bin/yazd.dll</filename></term>
+       <listitem><para>
+         &yaz; debug mode multi-threaded Dynamic Link Library.
+        </para></listitem></varlistentry>
+      
+      <varlistentry><term><filename>lib/yazd.lib</filename></term>
+       <listitem><para>
+         Import library for <filename>yazd.dll</filename>.
+        </para></listitem></varlistentry>
+      
       <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
        <listitem><para>
          &yaz; Z39.50 client application. It's a WIN32 console application.
@@ -596,6 +637,8 @@
        </term><listitem><para>
          You must link with this library. It's located in the 
          sub directory <filename>lib</filename> of &yaz;.
+	 If you want to link with the debug version of &yaz;, you must
+	 link with <filename>yazd.dll</filename> instead.
         </para></listitem></varlistentry>
       <varlistentry><term>dynamic link library <filename>yaz.dll</filename>
        </term><listitem><para>