Bump copyright year
[idzebra-moved-to-github.git] / doc / installation.xml
index 328c1c2..d0670d1 100644 (file)
@@ -1,8 +1,7 @@
-<!-- $Id: installation.xml,v 1.34 2007-02-02 09:58:39 marc Exp $ -->
  <chapter id="installation">
   <title>Installation</title>
   <para>
-   &zebra; is written in ANSI C and was implemented with portability in mind. 
+   &zebra; is written in &acro.ansi; C and was implemented with portability in mind. 
    We primarily use <ulink url="&url.gcc;">GCC</ulink> on UNIX and 
    <ulink url="&url.vstudio;">Microsoft Visual C++</ulink> on Windows.
   </para>
@@ -10,7 +9,7 @@
   <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.redhat;">Red Hat Linux</ulink>,
    <ulink url="&url.gentoo;">Gentoo Linux</ulink>,
    <ulink url="&url.suse;">SuSE Linux</ulink>,
    <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
 
    <variablelist>
     <varlistentry>
-     <term><ulink url="&url.yaz;">yaz</ulink>
+     <term><ulink url="&url.yaz;">&yaz;</ulink>
       (required)</term>
      <listitem>
       <para>
-       &zebra; uses YAZ to support <ulink url="&url.z39.50;">Z39.50</ulink> / 
-       <ulink url="&url.sru;">SRU</ulink>.
-       Also the memory management utilites from YAZ is used by &zebra;.
+       &zebra; uses &yaz; to support <ulink url="&url.z39.50;">&acro.z3950;</ulink> / 
+       <ulink url="&url.sru;">&acro.sru;</ulink>.
+       Zebra also uses a lot of other utilities (not related to networking),
+       such as memory management and XML support.
+      </para>
+      <para>
+       For the <link linkend="record-model-domxml">DOM XML</link>
+       / <link linkend="record-model-alvisxslt">ALVIS</link>
+       record filters, &yaz; must be compiled with 
+       <ulink url="&url.libxml2;">Libxml2</ulink>
+       and
+       <ulink url="&url.libxslt;">Libxslt</ulink>
+       support and Libxml2 must be version 2.6.15 or later.
       </para>
      </listitem>
     </varlistentry>
@@ -52,7 +61,7 @@
       (optional)</term>
      <listitem>
       <para>
-       XML parser. If you're going to index real XML you should
+       &acro.xml; parser. If you're going to index real &acro.xml; you should
        install this (filter grs.xml). On most systems you should be able
        to find binary Expat packages.
       </para>
    <para>
     On Unix, GCC works fine, but any native
     C compiler should be possible to use as long as it is 
-    ANSI C compliant.
+    &acro.ansi; C compliant.
    </para>
    
    <para>
       <term><literal>zebrasrv</literal></term>
       <listitem>
        <para>
-        The Z39.50 server and search engine.
+        The &acro.z3950; server and search engine.
        </para>
       </listitem>
      </varlistentry>
        <para>
        The <literal>.so</literal>-files are &zebra; record filter modules.
        There are modules for reading 
-       MARC (<filename>mod-grs-marc.so</filename>),
-       XML (<filename>mod-grs-xml.so</filename>) , etc. 
+       &acro.marc; (<filename>mod-grs-marc.so</filename>),
+       &acro.xml; (<filename>mod-grs-xml.so</filename>) , etc. 
        </para>
       </listitem>
      </varlistentry>
      <varlistentry>
       <term><literal>YAZDIR</literal></term>
       <listitem><para>
-        Directory of YAZ source. &zebra;'s makefile expects to find
+        Directory of &yaz; source. &zebra;'s makefile expects to find
         <filename>yaz.lib</filename>, <filename>yaz.dll</filename> 
         in <replaceable>yazdir</replaceable><literal>/lib</literal> and
         <replaceable>yazdir</replaceable><literal>/bin</literal> respectively.
     <para>
      The <literal>DEBUG</literal> setting in the makefile for &zebra; must
      be set to the same value as <literal>DEBUG</literal> setting in the
-     makefile for YAZ.
+     makefile for &yaz;.
      If not, the &zebra; server/indexer will crash.
     </para>
    </warning>
     </para>
    </note>
    <para>
-    The attribute set defintion files may no longer contain
+    The attribute set definition files may no longer contain
     redirection to other fields. 
     For example the following snippet of
     a custom <filename>custom/bib1.att</filename> 
-    Bib-1 attribute set definition file is no
+    &acro.bib1; attribute set definition file is no
     longer supported:
     <screen>
      att 1016            Any           1016,4,1005,62
    </para>
    <para>
     Similar behaviour can be expressed in the new release by defining
-    a new index <literal>Any:w</literal> in all GRS
+    a new index <literal>Any:w</literal> in all &acro.grs1;
     <filename>*.abs</filename> record indexing configuration files.
     The above example configuration needs to make the changes
     from version 1.3.x indexing instructions
     <screen>
      att 1016            Body-of-text
     </screen>
-    with equivalent outcome without editing all  GRS
+    with equivalent outcome without editing all  &acro.grs1;
     <filename>*.abs</filename> record indexing configuration files.
    </para>
 
    <para>
     Server installations which use the special
-    <literal>IDXPATH</literal> attribute set must add the following
+    <literal>&acro.idxpath;</literal> attribute set must add the following
     line to the <filename>zebra.cfg</filename> configuration file:
     <screen>
      attset: idxpath.att