zoomsh: offer option -a apdulog

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

diff --git a/doc/installation.xml b/doc/installation.xml
index 4e61cbe..7a1b906 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -20,8 +20,8 @@
     <ulink url="&url.ubuntu;">Ubuntu Linux</ulink>,
     <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
     <ulink url="&url.macosx;">MAC OSX</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.10 (sparc)</ulink>,
-    Windows 7, Windows Xp.
+    <ulink url="&url.solaris;">Solaris</ulink>,
+    Windows 7, Windows XP.

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

@@ -103,12 +103,6 @@
       <ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
      </para>
     </listitem>
       <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">
    </itemizedlist>
 
    <sect2 id="installation.source.unix">

@@ -133,13 +127,14 @@
      <ulink url="&url.icu;">ICU</ulink>
      (International Components for Unicode).
      In order to use this, the developer version of the ICU library
      <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.
+     must be available. ICU support is recommended for applications
+     such as Pazpar2 and Zebra.

     </para>
 
     <para>
      The <ulink url="&url.libxslt;">libxslt</ulink>,
      <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
     </para>
 
     <para>
      The <ulink url="&url.libxslt;">libxslt</ulink>,
      <ulink url="&url.libxml2;">libxml2</ulink> librararies are required

-     if &yaz; is to support SRU.
+     if &yaz; is to support SRU/Solr.

      These libraries are very portable and should compile out-of-the
      box on virtually all Unix platforms. It is available in binary
      forms for Linux and others.
      These libraries are very portable and should compile out-of-the
      box on virtually all Unix platforms. It is available in binary
      forms for Linux and others.

@@ -152,19 +147,19 @@
      <ulink url="&url.libtool;">Libtool</ulink>
      are used to generate Makefiles and configure &yaz; for the system.
      You do <emphasis>not</emphasis> these tools unless you're using the
      <ulink url="&url.libtool;">Libtool</ulink>
      are used to generate Makefiles and configure &yaz; for the system.
      You do <emphasis>not</emphasis> these tools unless you're using the

-     CVS version of &yaz;.
+     Git version of &yaz;.

     </para>
 
     <para>
      The CQL parser for &yaz; is built using
      GNU <ulink url="&url.bison;">Bison</ulink>.
     </para>
 
     <para>
      The CQL parser for &yaz; is built using
      GNU <ulink url="&url.bison;">Bison</ulink>.

-     This tool is only needed if you're using the CVS version of &yaz;.
+     This tool is only needed if you're using the Git version of &yaz;.

     </para>
 
     <para>
      &yaz; includes a tiny ASN.1 compiler. This compiler is
      written in <ulink url="&url.tcl;">Tcl</ulink>.
     </para>
 
     <para>
      &yaz; includes a tiny ASN.1 compiler. This compiler is
      written in <ulink url="&url.tcl;">Tcl</ulink>.

-     But as for Bison you do not need it unless you're using CVS
+     But as for Bison you do not need it unless you're using Git

      version of &yaz; or you're using the compiler to built own codecs
      for private ASN.1.
     </para>
      version of &yaz; or you're using the compiler to built own codecs
      for private ASN.1.
     </para>

@@ -280,7 +275,7 @@
        <listitem><para>Compile &yaz; with
          <ulink url="&url.libxml2;">libxml2</ulink> in directory
          <replaceable>prefix</replaceable>.
        <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.
+         Use this option if you want &yaz; to use XML and support SRU/Solr.

          By default, configure will
          search for libxml2 on the system. Use this option if it
          libxml2 is not found automatically. Alternatively,
          By default, configure will
          search for libxml2 on the system. Use this option if it
          libxml2 is not found automatically. Alternatively,

@@ -305,21 +300,33 @@
       </varlistentry>
 
       <varlistentry><term>
       </varlistentry>
 
       <varlistentry><term>

-        <literal>--with-openssl</literal>[=<replaceable>prefix</replaceable>]
+        <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]

        </term>
        </term>

-       <listitem><para>&yaz; will be linked with the OpenSSL libraries and
-         an SSL COMSTACK will be provided. If OpenSSL is enabled, GNU TLS
-         is automatically disabled.
+       <listitem><para>&yaz; will be linked the
+       <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
+       If prefix is not given, the libraries exposed by the script
+       <application>icu-config</application> will be used if found.

         </para></listitem>
       </varlistentry>
 
       <varlistentry><term>
         </para></listitem>
       </varlistentry>
 
       <varlistentry><term>

-        <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
+        <literal>--with-libgcrypt</literal>[=<replaceable>prefix</replaceable>]

        </term>
        </term>

-       <listitem><para>&yaz; will be linked the
-       <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
+       <listitem><para>&yaz; will be linked with
+       <ulink url="&url.libgcrypt;">Libgcrypt</ulink> in the prefix if given.

        If prefix is not given, the libraries exposed by the script
        If prefix is not given, the libraries exposed by the script

-       <application>icu-config</application> will be used if found.
+       <application>libgcrypt-config</application> will be used if found.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry><term>
+        <literal>--with-memcached</literal>
+       </term>
+       <listitem><para>&yaz; will be linked with
+       <ulink url="&url.libmemcached;">libMemcached</ulink> to allow
+       for result-set caching for ZOOM.
+       The prefix can not be given. Note that YAZ will only search
+       for libMemcached if Libgcrypt is also enabled.

         </para></listitem>
       </varlistentry>
 
         </para></listitem>
       </varlistentry>
 

@@ -405,6 +412,12 @@
         </para></listitem>
       </varlistentry>
 
         </para></listitem>
       </varlistentry>
 

+      <varlistentry><term><filename>util/yaz-url</filename></term>
+       <listitem><para>This program is a simple HTTP page fetcher ala
+         wget or curl.
+        </para></listitem>
+      </varlistentry>
+

      <varlistentry><term><filename>zoom/zoomsh</filename></term>
        <listitem><para>
          A simple shell implemented on top of the
      <varlistentry><term><filename>zoom/zoomsh</filename></term>
        <listitem><para>
          A simple shell implemented on top of the

@@ -536,7 +549,7 @@
     an installer from
     <ulink url="&url.yaz.download.win32;">here</ulink>.
     The installer comes with source too - in case you wish to
     an installer from
     <ulink url="&url.yaz.download.win32;">here</ulink>.
     The installer comes with source too - in case you wish to

-    compile YAZ with different Compiler options etc.
+    compile YAZ with different compiler options, etc.

    </para>
 
    <sect2 id="installation.win32.source">
    </para>
 
    <sect2 id="installation.win32.source">

@@ -544,9 +557,8 @@
     <para>
      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
      with <ulink url="&url.vstudio;">
     <para>
      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
      with <ulink url="&url.vstudio;">

-      Microsoft Visual Studio</ulink>.
-     Version 6 and .NET has been tested. We expect that &yaz; compiles
-     with version 5 as well.
+     Microsoft Visual Studio</ulink>. It has been tested with
+     Microsoft Visual Studio 2003/2005/2008.

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

@@ -572,7 +584,8 @@
          If <literal>HAVE_TCL</literal> is set to 1, nmake will
          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
          If <literal>HAVE_TCL</literal> is set to 1, nmake will
          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.
+         interpreter. A Windows version of Tcl is part of
+         <ulink url="&url.gitwindows;">Git for Windows</ulink>.

         </para>
         <para>
          If you do not have Tcl installed, set
         </para>
         <para>
          If you do not have Tcl installed, set

@@ -584,15 +597,15 @@
        <term><literal>HAVE_BISON</literal>,
         <literal>BISON</literal></term>
        <listitem><para>
        <term><literal>HAVE_BISON</literal>,
         <literal>BISON</literal></term>
        <listitem><para>

-         If GNU Bison is present, you might set <literal>HAVE_ICONV</literal>
+         If GNU Bison is present, you might set <literal>HAVE_BISON</literal>

          to 1 and specify the Bison executable in <literal>BISON</literal>.
          to 1 and specify the Bison executable in <literal>BISON</literal>.

-         Bison is only required if you use the CVS version of
+         Bison is only required if you use the Git 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
          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="&url.unxutils;">unxutils</ulink>.
+         <ulink url="&url.gitwindows;">Git for Windows</ulink>.

         </para></listitem>
       </varlistentry>
 
         </para></listitem>
       </varlistentry>
 

@@ -697,44 +710,44 @@
      The following files are generated upon successful compilation:
 
      <variablelist>
      The following files are generated upon successful compilation:
 
      <variablelist>

-      <varlistentry><term><filename>bin/yaz4.dll</filename> /
-         <filename>bin/yaz4d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz&soversion;.dll</filename> /
+         <filename>bin/yaz&soversion;d.dll</filename></term>

        <listitem><para>
          &yaz; Release/Debug DLL.
         </para></listitem></varlistentry>
 
        <listitem><para>
          &yaz; Release/Debug DLL.
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>lib/yaz4.lib</filename> /
-         <filename>lib/yaz4d.lib</filename></term>
+      <varlistentry><term><filename>lib/yaz&soversion;.lib</filename> /
+         <filename>lib/yaz&soversion;d.lib</filename></term>

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

-         Import library for <filename>yaz4.dll</filename> /
-        <filename>yaz4d.dll</filename>.
+         Import library for <filename>yaz&soversion;.dll</filename> /
+        <filename>yaz&soversion;d.dll</filename>.

         </para></listitem></varlistentry>
 
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>bin/yaz_cond4.dll</filename> /
-         <filename>bin/yaz_cond4d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz_cond&soversion;.dll</filename> /
+         <filename>bin/yaz_cond&soversion;d.dll</filename></term>

        <listitem><para>
         Release/Debug DLL for condition variable utilities (condvar.c).
         </para></listitem></varlistentry>
 
        <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>
+      <varlistentry><term><filename>lib/yaz_cond&soversion;.lib</filename> /
+         <filename>lib/yaz_cond&soversion;d.lib</filename></term>

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

-         Import library for <filename>yaz_cond4.dll</filename> /
-        <filename>yaz_cond4d.dll</filename>.
+         Import library for <filename>yaz_cond&soversion;.dll</filename> /
+        <filename>yaz_cond&soversion;d.dll</filename>.

         </para></listitem></varlistentry>
 
         </para></listitem></varlistentry>
 

-      <varlistentry><term><filename>bin/yaz_icu4.dll</filename> /
-          <filename>bin/yaz_icu4d.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz_icu&soversion;.dll</filename> /
+          <filename>bin/yaz_icu&soversion;d.dll</filename></term>

        <listitem><para>
          Release/Debug DLL for the ICU wrapper utility.
         Only build if HAVE_ICU is 1.
         </para></listitem></varlistentry>
 
        <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_icu4.lib</filename> /
-         <filename>lib/yaz_icu4d.lib</filename></term>
+      <varlistentry><term><filename>lib/yaz_icu&soversion;.lib</filename> /
+         <filename>lib/yaz_icu&soversion;d.lib</filename></term>

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

-         Import library for <filename>yaz_icu4.dll</filename> /
-        <filename>yaz_icu4d.dll</filename>.
+         Import library for <filename>yaz_icu&soversion;.dll</filename> /
+        <filename>yaz_icu&soversion;d.dll</filename>.

         </para></listitem></varlistentry>
 
       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
         </para></listitem></varlistentry>
 
       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>

@@ -794,14 +807,15 @@
       <varlistentry><term>include path</term><listitem><para>
          Set it to the <filename>include</filename> directory of &yaz;.
         </para></listitem></varlistentry>
       <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>yaz4.lib</filename>
+      <varlistentry><term>import library <filename>yaz&soversion;.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
        </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>yaz4d.lib</filename> instead.
+        link against <filename>yaz&soversion;d.lib</filename> instead.

         </para></listitem></varlistentry>
         </para></listitem></varlistentry>

-      <varlistentry><term>dynamic link library <filename>yaz4.dll</filename>
+      <varlistentry><term>dynamic link library
+         <filename>yaz&soversion;.dll</filename>

        </term><listitem><para>
          This DLL must be in your execution path when you invoke
          your application. Specifically, you should distribute this
        </term><listitem><para>
          This DLL must be in your execution path when you invoke
          your application. Specifically, you should distribute this