List more dependencies

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

diff --git a/doc/installation.xml b/doc/installation.xml
index fab423e..9cc450d 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,9 +1,10 @@
 <chapter id="installation">
-  <!-- $Id: installation.xml,v 1.3 2004-04-15 12:04:01 adam Exp $ -->
+  <!-- $Id: installation.xml,v 1.8 2005-02-07 09:50:23 adam Exp $ -->
   <title>Installation</title>
   <para>
    You need a C++ compiler to compile and use YAZ proxy.
-   The software was implemented using GCC so we know that works
+   The software was implemented using
+   <ulink url="http://gcc.gnu.org/">GCC</ulink> so we know that works
    well with YAZ proxy. From time to time the software has been
    compiled on Windows using Visual C++. Other compilers should
    work too. Let us know of portability problems, etc. with
@@ -15,15 +16,26 @@
    <ulink url="http://indexdata.dk/yazplusplus/">YAZ++</ulink>
    toolkits.
    You need to install these first.
-   For some platforms there are binary packages for YAZ/YAZ++.
+   For some platforms there are binary packages available for YAZ/YAZ++.
   </para>
   <para>
    We also highly recommend that
    <ulink url="http://xmlsoft.org/">libxml2</ulink> and
-   <ulink url="http://xmlsoft.org/XSLT/">libxslt</ulink> are installed.
+   <ulink url="http://xmlsoft.org/XSLT/">libXSLT</ulink> are installed.
    YAZ must be configured with libxml2 support.
-   If not, SRW/SRU is not supported.
-   The YAZ Proxy uses libxslt for record conversions via XSLT.
+   If not, 
+   <ulink url="http://www.loc.gov/z3950/agency/zing/srw/">SRW/SRU</ulink>
+   is not supported.
+   The YAZ Proxy uses libXSLT for record conversions via XSLT.
+  </para>
+  <para>
+   YAZ proxy may also use USEMARCON to convert between MARC
+   formats. This is useful if you want the proxy to offer more
+   MARC record types than the backend target supports. Get USEMARCON
+   from:
+   <ulink url="http://www.bl.uk/services/bibliographic/usemarcon.html">
+    British Library USEMARCON page
+   </ulink>.
   </para>
   <section id="unix">
    <title>Building on Unix</title>
@@ -47,7 +59,7 @@
        </para></listitem>
      </varlistentry>
      <varlistentry>
-      <term><literal>--with-yazppconfig </literal>directory</term>
+      <term><literal>--with-yazpp </literal>directory</term>
       <listitem><para>
         Specifies the location of <filename>yaz++-config</filename>.
         The <filename>yaz++-config</filename> program is generated in
@@ -64,12 +76,21 @@
      <varlistentry>
       <term><literal>--with-xslt </literal>directory</term>
       <listitem><para>
-        Specifies prefix for libxslt (and libxml2).
+        Specifies prefix for libXSLT (and libxml2).
        configure must be able to locate <command>xslt-config</command>
        in PREFIX/bin. If this option is omitted, configure looks
        for <command>xslt-config</command> in the current PATH.
        </para></listitem>
      </varlistentry>
+     <varlistentry>
+      <term><literal>--with-usemarcon </literal>directory</term>
+      <listitem><para>
+        Specifies USEMARCON installation prefix.
+       configure must be able to locate <command>usemarcon-config</command>
+       in PREFIX/bin. If this option is omitted, configure looks
+       for <command>usemarcon-config</command> in the current PATH.
+       </para></listitem>
+     </varlistentry>
     </variablelist>
     For the whole list of <literal>configure</literal> options, refer
     to the help:
@@ -117,8 +138,11 @@
      <varlistentry>
       <term><literal>etc</literal></term> 
       <listitem><para>
-       Various files that may be read by YAZ proxy - including
-       configuration file, XSLT files, CQL to RPN conversion.
+       Various files such as
+       configuration files, XSLT files, CQL to RPN conversion files,
+       a sample start/stop control script
+       <filename>yazproxy.ctl.sh</filename> that can be used as
+       template for an <filename>/etc/init.d</filename> script.
        These files are installed in the YAZ proxy's data area
        (<parameter>prefix</parameter><literal>/share/yazproxy</literal>).
        </para></listitem>
@@ -184,7 +208,7 @@
        If <literal>HAVE_LIBXSLT</literal> is set to 1, the proxy is compiled
        with XSLT and XML support. In this configuration, set 
        <literal>LIBXSLT_DIR</literal> to the 
-       <ulink url="http://www.xmlsoft.org/">libxslt</ulink> source
+       <ulink url="http://www.xmlsoft.org/">libXSLT</ulink> source
        directory.
        </para>
        
@@ -196,7 +220,7 @@
        </note>
        
        <para>
-       Windows versions of libxslt, libxml2, zlib and iconv can be found
+       Windows versions of libXSLT, libxml2, zlib and iconv can be found
        <ulink url="http://www.zlatkovic.com/libxml.en.html">
         here</ulink>.
        </para>