Update doc/common
[yaz-moved-to-github.git] / doc / installation.xml
index fb4c17e..25c0ef1 100644 (file)
@@ -1,4 +1,3 @@
-<!-- $Id: installation.xml,v 1.40 2008-01-17 21:45:05 adam Exp $ -->
 <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1 id="installation-introduction"><title>Introduction</title>
    <para>
     The software is regularly tested on
     <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
-    <ulink url="&url.redhat;">Redhat Linux</ulink>,
+    <ulink url="&url.centos;">CentOS</ulink>,
     <ulink url="&url.ubuntu;">Ubuntu Linux</ulink>,
     <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
     <ulink url="&url.macosx;">MAC OSX</ulink>,
-    <ulink url="&url.solaris;">SunOS 5.8 (sparc)</ulink>,
-    <ulink url="&url.windows2000;">Windows 2000</ulink>,
-    <ulink url="&url.windows2003server;">Windows 2003 server</ulink>.
+    <ulink url="&url.solaris;">SunOS 5.10 (sparc)</ulink>,
+    Windows 7, Windows Xp.
    </para>
    
    <para>
 
    <para>
     We provide 
-    <ulink url="&url.debian;">Debian GNU/Linux</ulink>
+    <ulink url="&url.debian;">Debian GNU/Linux</ulink> (i386 and amd64),
+    <ulink url="&url.ubuntu;">Ubuntu</ulink> (i386 and amd64)
     and 
-    <ulink url="&url.redhat;">Redhat</ulink> packages for &yaz;. 
-    Only i386 binary packages are available. You should be able to
-    create packages for other CPUs by building them from the source
-    package.
+    <ulink url="&url.centos;">CentOS</ulink> (amd64 only) packages for &yaz;. 
+    You should be able to create packages for other CPUs by building
+    them from the source package.
    </para>
    
+   <para>
+    YAZ is also part of several packages repositories. Some of them are
+   </para>    
+
+   <itemizedlist>
+    <listitem>
+     <para>
+      Solaris CSW: <ulink url="http://www.opencsw.org/packages/yaz/"/>
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Solaris: <ulink url="http://unixpackages.com"/>
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      FreeBSD: <ulink url="http://www.freshports.org/net/yaz"/>
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Debian: <ulink url="http://packages.debian.org/search?keywords=yaz"/>
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      Ubuntu: <ulink url="https://launchpad.net/ubuntu/+source/yaz"/>
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      NetBSD:
+      <ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
+     </para>
+    </listitem>
+    <listitem>
+     <para>
+      OpenBSD:
+      <ulink url="http://www.openbsd.org/4.4_packages/powerpc/yaz-3.0.24.tgz-long.html"/>
+     </para>
+    </listitem>
+   </itemizedlist>
+    
    <sect2 id="installation.source.unix">
     <title>Compiling from source on Unix</title>
     
 
     <para>
      YAZ 3.0.16 and later includes a wrapper for the 
-     <ulink url="%url.icu;">ICU</ulink> 
+     <ulink url="&url.icu;">ICU</ulink> 
      (International Components for Unicode).
      In order to use this, the developer version of the ICU library
      must be available.
        <listitem><para>Compile &yaz; with 
          <ulink url="&url.libxslt;">libxslt</ulink> in directory
          <replaceable>prefix</replaceable>. 
-         Use this option if you want SRU support.
+         Use this option if you want XSLT and XML support.
          By default, configure will
          search for libxslt on the system. Use this option if it
          libxslt is not found automatically. Alternatively, 
          <literal>--without-xslt</literal>, can be used to force &yaz;
         not to use libxslt.
+        </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry><term>
+        <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
+       </term>
+       <listitem><para>Compile &yaz; with 
+         <ulink url="&url.libxml2;">libxml2</ulink> in directory
+         <replaceable>prefix</replaceable>. 
+         Use this option if you want &yaz; to use XML and support SRU.
+         By default, configure will
+         search for libxml2 on the system. Use this option if it
+         libxml2 is not found automatically. Alternatively, 
+         <literal>--without-xml2</literal>, can be used to force &yaz;
+        not to use libxml2.
+        </para>
+        <para>
+          Note that option <literal>--with-xslt</literal>
+          also enables libxml2.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry><term>
+        <literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
+       </term>
+       <listitem><para>&yaz; will be linked with the GNU TLS libraries and
+         an SSL COMSTACK will be provided. By default configure enables
+         SSL support for YAZ if the GNU TLS development libraries are found
+         on the system.
         </para></listitem>
       </varlistentry>
 
         <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.
+         an SSL COMSTACK will be provided. If OpenSSL is enabled, GNU TLS
+         is automatically disabled.
         </para></listitem>
       </varlistentry>
 
       <varlistentry><term><filename>src/libyaz_server.la</filename></term>
        <listitem><para>
          Generic Frontend server. This is an add-on for libyaz.la.
-         Code in this library uses POSIX threads functions - if they
-         available on the platform.
+         Code in this library uses POSIX threads functions - if POSIX
+         threads are available on the platform.
+        </para></listitem>
+      </varlistentry>
+      
+      <varlistentry><term><filename>src/libyaz_icu.la</filename></term>
+       <listitem><para>
+         Functions that wrap the ICU library.
         </para></listitem>
       </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
+         use the ASN.1 compiler (<ulink url="&url.tcl;">Tcl</ulink> based).
+         You must set <literal>TCL</literal> to the full path of the Tcl
          interpreter.
         </para>
         <para>
      The following files are generated upon successful compilation:
      
      <variablelist>
-      <varlistentry><term><filename>bin/yaz3.dll</filename> / 
-         <filename>bin/yaz3d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz4.dll</filename> / 
+         <filename>bin/yaz4d.dll</filename></term>
        <listitem><para>
          &yaz; Release/Debug DLL.
         </para></listitem></varlistentry>
       
-      <varlistentry><term><filename>lib/yaz3.lib</filename> / 
-         <filename>lib/yaz3d.lib</filename></term>
+      <varlistentry><term><filename>lib/yaz4.lib</filename> / 
+         <filename>lib/yaz4d.lib</filename></term>
+       <listitem><para>
+         Import library for <filename>yaz4.dll</filename> /
+        <filename>yaz4d.dll</filename>.
+        </para></listitem></varlistentry>
+      
+      <varlistentry><term><filename>bin/yaz_cond4.dll</filename> / 
+         <filename>bin/yaz_cond4d.dll</filename></term>
+       <listitem><para>
+        Release/Debug DLL for condition variable utilities (condvar.c).
+        </para></listitem></varlistentry>
+      
+      <varlistentry><term><filename>lib/yaz_cond4.lib</filename> / 
+         <filename>lib/yaz_cond4d.lib</filename></term>
        <listitem><para>
-         Import library for <filename>yaz3.dll</filename> /
-        <filename>yaz3d.dll</filename>.
+         Import library for <filename>yaz_cond4.dll</filename> /
+        <filename>yaz_cond4d.dll</filename>.
         </para></listitem></varlistentry>
       
-      <varlistentry><term><filename>bin/yaz_icu3.dll</filename> /
-          <filename>bin/yaz_icu3d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz_icu4.dll</filename> /
+          <filename>bin/yaz_icu4d.dll</filename></term>
        <listitem><para>
          Release/Debug DLL for the ICU wrapper utility.
         Only build if HAVE_ICU is 1.
         </para></listitem></varlistentry>
       
-      <varlistentry><term><filename>lib/yaz_icu3.lib</filename> /
-         <filename>lib/yaz_icu3d.lib</filename></term>
+      <varlistentry><term><filename>lib/yaz_icu4.lib</filename> /
+         <filename>lib/yaz_icu4d.lib</filename></term>
        <listitem><para>
-         Import library for <filename>yaz_icu3.dll</filename> /
-        <filename>yaz_icu3d.dll</filename>.
+         Import library for <filename>yaz_icu4.dll</filename> /
+        <filename>yaz_icu4d.dll</filename>.
         </para></listitem></varlistentry>
       
       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
       <varlistentry><term>include path</term><listitem><para>
          Set it to the <filename>include</filename> directory of &yaz;.
         </para></listitem></varlistentry>
-      <varlistentry><term>import library <filename>yaz3.lib</filename>
+      <varlistentry><term>import library <filename>yaz4.lib</filename>
        </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 against <filename>yaz3d.lib</filename> instead.
+        link against <filename>yaz4d.lib</filename> instead.
         </para></listitem></varlistentry>
-      <varlistentry><term>dynamic link library <filename>yaz3.dll</filename>
+      <varlistentry><term>dynamic link library <filename>yaz4.dll</filename>
        </term><listitem><para>
          This DLL must be in your execution path when you invoke
          your application. Specifically, you should distribute this