debian compat 9

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

diff --git a/doc/installation.xml b/doc/installation.xml
index 4c32b9d..364e4fd 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,9 +1,9 @@
 <chapter id="installation">
-  <!-- $Id: installation.xml,v 1.4 2004-04-21 08:16:42 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="&url.gcc;">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
@@ -11,20 +11,30 @@
   </para>
   <para>
    YAZ proxy is built on top of the 
-   <ulink url="http://indexdata.dk/yaz/">YAZ</ulink> and
-   <ulink url="http://indexdata.dk/yazplusplus/">YAZ++</ulink>
+   <ulink url="&url.yaz;">YAZ</ulink> and
+   <ulink url="&url.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="&url.libxml2;">libxml2</ulink> and
+   <ulink url="&url.libxslt;">libXSLT</ulink> are installed.
    YAZ must be configured with libxml2 support.
-   If not, SRW/SRU is not supported.
+   If not, 
+   <ulink url="&url.sru;">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="&url.usemarcon;">British Library USEMARCON page
+   </ulink>.
+  </para>
   <section id="unix">
    <title>Building on Unix</title>
    <para>On UNIX, the software is compiled as follows:
@@ -47,16 +57,16 @@
        </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
+        Specifies the location of <filename>yazpp-config</filename>.
+        The <filename>yazpp-config</filename> program is generated in
         the source directory of YAZ++ as well as the binaries
         directory when YAZ++ is installed (via make install).
         </para>
        <para>
         If you don't supply this option, <literal>configure</literal> will
-        look for <filename>yaz++-config</filename> in directories of the
+        look for <filename>yazpp-config</filename> in directories of the
         <envar>PATH</envar> environment - which is nearly always
         what you want.
        </para></listitem>
@@ -70,6 +80,15 @@
        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 +136,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>
@@ -131,7 +153,7 @@
    <title>Building on Windows</title>
    <para>
     YAZ++ is shipped with "makefiles" for the NMAKE tool that comes
-    with <ulink url="http://msdn.microsoft.com/vstudio/">
+    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.
@@ -184,7 +206,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="&url.libxslt;">libXSLT</ulink> source
        directory.
        </para>
        
@@ -197,7 +219,7 @@
        
        <para>
        Windows versions of libXSLT, libxml2, zlib and iconv can be found
-       <ulink url="http://www.zlatkovic.com/libxml.en.html">
+       <ulink url="&url.libxml2.download.win32;">
         here</ulink>.
        </para>
       </listitem>
@@ -221,7 +243,7 @@
        If <literal>HAVE_LIBXML2</literal> is set to 1, the proxy is compiled
        with XML support. In this configuration, set 
        <literal>LIBXML2_DIR</literal> to the 
-       <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory
+       <ulink url="&url.libxml2;">libxml2</ulink> source directory
        and
        <literal>ZLIB_DIR</literal> to the zlib directory.
        </para>