Fix comments

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

diff --git a/doc/installation.xml b/doc/installation.xml
index 75bfa57..91ab15b 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.14 2002-09-25 20:38:36 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.17 2003-05-16 14:39:57 adam Exp $ -->

  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1><title>Introduction</title>
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1><title>Introduction</title>

@@ -12,34 +12,29 @@
    <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
    <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.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>.
+   </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),
+    SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
+    environment and the GUSI socket libraries), IBM AS/400 .

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

@@ -69,7 +64,10 @@
   <sect1 id="installation.unix"><title>UNIX</title>
 
    <para>
   <sect1 id="installation.unix"><title>UNIX</title>
 
    <para>

-    We provide Debian GNU/Linux and Redhat packages for YAZ. 
+    We provide 
+    <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>
+    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
     package.
     Only i386 binary packages are available. You should be able to
     create packages for other CPU's by building them from the source
     package.

@@ -83,8 +81,25 @@
      have to acquire one separately. We recommend
      <ulink url="http://gcc.gnu.org/">GCC</ulink>.
     </para>
      have to acquire one separately. We recommend
      <ulink url="http://gcc.gnu.org/">GCC</ulink>.
     </para>

+
+    <para>
+     If you wish to use character set conversion facilities in &yaz; or if you
+     are compiling &yaz; for use with Zebra it is a good idea to ensure that
+     the iconv library is installed. Some Unixes today already have it
+     - if not, we suggest 
+     <ulink url="http://www.gnu.org/software/libiconv/">GNU iconv</ulink>.
+    </para>
+

     <para>
     <para>

-     For UNIX, the GNU tools
+     The XML C library <ulink url="http://www.xmlsoft.org/">libxml2</ulink>
+     is required if &yaz; is to support SRW (and SOAP).
+     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.
+    </para>
+
+    <para>
+     The GNU tools

      <ulink url="http://www.gnu.org/software/autoconf/">Autoconf</ulink>,
      <ulink url="http://www.gnu.org/software/automake/">Automake</ulink> and
      <ulink url="http://www.gnu.org/software/libtool/">Libtool</ulink>
      <ulink url="http://www.gnu.org/software/autoconf/">Autoconf</ulink>,
      <ulink url="http://www.gnu.org/software/automake/">Automake</ulink> and
      <ulink url="http://www.gnu.org/software/libtool/">Libtool</ulink>

@@ -92,15 +107,21 @@
      You do <emphasis>not</emphasis> these tools unless you're using the
      CVS version of &yaz;.
     </para>
      You do <emphasis>not</emphasis> these tools unless you're using the
      CVS version of &yaz;.
     </para>

-    
+

     <para>
     <para>

-     If you wish to use character set conversion facilities in YAZ or if you
-     are compiling YAZ for use with Zebra it is a good idea to ensure that
-     the iconv library is installed. Most Unixes today already have it
-     - if not, we suggest 
-     <ulink url="http://www.gnu.org/software/libiconv/">GNU iconv</ulink>.
+     The CQL parser for &yaz; is built using
+     GNU <ulink url="http://www.gnu.org/software/bison/">Bison</ulink>.
+     This tool is only needed if you're using the CVS version of &yaz;.

     </para>
     </para>

-    
+        
+    <para>
+     &yaz; includes a tiny ASN.1 compiler. This compiler is
+     written in <ulink url="http://www.tcl.tk/">Tcl</ulink>.
+     But as for Bison you do not need it unless you're using CVS
+     version of &yaz; or you're using the compiler to built own codecs
+     for private ASN.1. 
+    </para>
+     

     <para>
      Generally it should be sufficient to run configure without options,
      like this:
     <para>
      Generally it should be sufficient to run configure without options,
      like this:

@@ -128,8 +149,9 @@
      The most important are:
      
      <variablelist>
      The most important are:
      
      <variablelist>

-      <varlistentry><term><literal>--prefix </literal>path</term>
-       <listitem><para>Specifies installation prefix. This is
+      <varlistentry><term>
+        <literal>--prefix</literal>=<replaceable>prefix</replaceable></term>
+       <listitem><para>Specifies installation prefix for &yaz;. This is

          only needed if you run <literal>make install</literal> later to
          perform a "system" installation. The prefix is
          <literal>/usr/local</literal> if not specified.
          only needed if you run <literal>make install</literal> later to
          perform a "system" installation. The prefix is
          <literal>/usr/local</literal> if not specified.

@@ -153,18 +175,14 @@
          </citerefentry>.
         </para></listitem>
       </varlistentry>
          </citerefentry>.
         </para></listitem>
       </varlistentry>

+

       <varlistentry><term><literal>--enable-threads</literal></term>
        <listitem><para>&yaz; will be built using POSIX threads.
        Specifically, <constant>_REENTRANT</constant> will be defined during
          compilation.
         </para></listitem>
       </varlistentry>
       <varlistentry><term><literal>--enable-threads</literal></term>
        <listitem><para>&yaz; will be built using POSIX threads.
        Specifically, <constant>_REENTRANT</constant> will be defined during
          compilation.
         </para></listitem>
       </varlistentry>

-      <varlistentry><term><literal>--with-openssl</literal></term>
-       <listitem><para>&yaz; will be linked with the OpenSSL libraries and
-         an SSL COMSTACK will be provided. Note that SSL support is still
-         experimental.
-        </para></listitem>
-      </varlistentry>
+

       <varlistentry><term><literal>--enable-shared</literal></term>
        <listitem><para>The make process will create shared
          libraries (also known as shared objects <filename>.so</filename>).
       <varlistentry><term><literal>--enable-shared</literal></term>
        <listitem><para>The make process will create shared
          libraries (also known as shared objects <filename>.so</filename>).

@@ -172,6 +190,7 @@
          equivalent to <literal>--disable-shared</literal>.
         </para></listitem>
       </varlistentry>
          equivalent to <literal>--disable-shared</literal>.
         </para></listitem>
       </varlistentry>

+

       <varlistentry><term><literal>--disable-shared</literal></term>
        <listitem><para>The make process will not create
          static libraries (<filename>.a</filename>).
       <varlistentry><term><literal>--disable-shared</literal></term>
        <listitem><para>The make process will not create
          static libraries (<filename>.a</filename>).

@@ -181,15 +200,40 @@
       </varlistentry>
       
       <varlistentry><term>
       </varlistentry>
       
       <varlistentry><term>

-        <literal>--with-iconv</literal>[=<replaceable>dir</replaceable>]</term>
-       <listitem><para>Compile YAZ with iconv library in directory
-         <replaceable>dir</replaceable>. By default configure will
+        <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
+       </term>
+       <listitem><para>Compile &yaz; with iconv library in directory
+         <replaceable>prefix</replaceable>. By default configure will

          search for iconv on your system. Use this option if it
          doesn't find iconv. Alternatively you can use 
          search for iconv on your system. Use this option if it
          doesn't find iconv. Alternatively you can use 

-         <literal>--without-iconv</literal> to force YAZ not to use
+         <literal>--without-iconv</literal> to force &yaz; not to use

          iconv.
         </para></listitem>
       </varlistentry>
          iconv.
         </para></listitem>
       </varlistentry>

+
+      <varlistentry><term>
+        <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
+       </term>
+       <listitem><para>Compile &yaz; with 
+         <ulink url="http://www.xmlsoft.org/">libxml2</ulink> in directory
+         <replaceable>prefix</replaceable>. 
+         Use this option if you want SOAP support.
+         By default configure will
+         search for libxml2 on your system. Use this option if it
+         doesn't find libxml2. Alternatively you can use 
+         <literal>--without-xml2</literal> to force &yaz; not to use
+         libxml2.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry><term>
+        <literal>--with-openssl</literal>[=<replaceable>prefix</replaceable>]
+       </term>
+       <listitem><para>&yaz; will be linked with the OpenSSL libraries and
+         an SSL COMSTACK will be provided. Note that SSL support is still
+         experimental.
+        </para></listitem>
+      </varlistentry>

       
      </variablelist>
      
       
      </variablelist>
      

@@ -271,7 +315,7 @@
     <para>
      You probably need to have root access in order to perform this.
      You must specify the <literal>--prefix</literal> option for configure if
     <para>
      You probably need to have root access in order to perform this.
      You must specify the <literal>--prefix</literal> option for configure if

-    you wish to install &yaz; in other directories than the default 
+     you wish to install &yaz; in other directories than the default 

      <filename>/usr/local/</filename>.
     </para>
     
      <filename>/usr/local/</filename>.
     </para>
     

@@ -376,8 +420,10 @@
     <title>Compiling from Source on WIN32</title>
     <para>
      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
     <title>Compiling from Source on WIN32</title>
     <para>
      &yaz; is shipped with "makefiles" for the NMAKE tool that comes

-     with Microsoft Visual C++. Version 6 has been tested. We expect that
-     &yaz; should compile with version 5 as well.
+     with <ulink url="http://msdn.microsoft.com/vstudio/">
+      Microsoft Visual C++</ulink>.
+     Version 6 has been tested. We expect that &yaz; compiles
+     with version 5 as well.

     </para>
     <para>
      Start a command prompt and switch the sub directory
     </para>
     <para>
      Start a command prompt and switch the sub directory

@@ -397,22 +443,64 @@
          (code generation is multi-threaded DLL).
         </para></listitem>
       </varlistentry>
          (code generation is multi-threaded DLL).
         </para></listitem>
       </varlistentry>

-      <varlistentry><term><literal>TCL</literal></term>
+      <varlistentry>
+       <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
+       <listitem><para>
+         If <literal>HAVE_TCL</literal> is set to 1, nmake will
+         use the ASN.1 compiler (Tcl based). You must set
+         <literal>TCL</literal> to the full path of the Tcl
+         interpreter.
+        </para>
+        <para>
+         If you do not have Tcl installed, set
+         <literal>HAVE_TCL</literal> to 0.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><literal>HAVE_BISON</literal>,
+        <literal>BISON</literal></term>

        <listitem><para>
        <listitem><para>

-         Specifies the name of the Tcl shell (EXE-file).
-         You do not need setting this or installing Tcl unless you wish
-         to change or add ASN.1 for &yaz;.
+         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>
         </para></listitem>
       </varlistentry>
 
       <varlistentry>

-       <term><literal>HAVE_ICONV</literal>, <literal>ICONV_DIR</literal></term>
+       <term><literal>HAVE_ICONV</literal>,
+        <literal>ICONV_DIR</literal></term>

        <listitem><para>
          If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
          with iconv support. In this configuration, set 
          <literal>ICONV_DIR</literal> to the iconv source directory.
         </para></listitem>
       </varlistentry>
        <listitem><para>
          If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
          with iconv support. In this configuration, set 
          <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 
+         <literal>LIBXML2_DIR</literal> to the 
+         <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory.
+        </para>
+
+        <para>
+         Windows versions of libxml2 and iconv can be found
+         <ulink url="http://www.zlatkovic.com/projects/libxml/binaries.html">
+          here</ulink>.
+        </para>
+       </listitem>
+      </varlistentry>

 
      </variablelist>
     </para>
 
      </variablelist>
     </para>

@@ -421,13 +509,17 @@
      <screen>
       nmake
      </screen>
      <screen>
       nmake
      </screen>

-     If command <filename>nmake</filename> is not found on your system
-     you probably haven't defined the environment variables required to
-     use that tool. To fix that, find and run the batch file
-     <filename>vcvars32.bat</filename>. You need to run it from within
-     the command prompt or set the environment variables "globally";
-     otherwise it doesn't work.

     </para>
     </para>

+    <note>
+     <para>
+      If the <filename>nmake</filename> command is not found on your system
+      you probably haven't defined the environment variables required to
+      use that tool. To fix that, find and run the batch file
+      <filename>vcvars32.bat</filename>. You need to run it from within
+      the command prompt or set the environment variables "globally";
+      otherwise it doesn't work.
+     </para>
+    </note>

     <para>
      If you wish to recompile &yaz; - for example if you modify
      settings in the <filename>makefile</filename> you can delete
     <para>
      If you wish to recompile &yaz; - for example if you modify
      settings in the <filename>makefile</filename> you can delete