correct typo
[idzebra-moved-to-github.git] / doc / installation.xml
index 24e53b0..d917ca1 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.15 2005-05-24 12:36:26 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.25 2006-06-29 14:02:07 marc Exp $ -->
  <chapter id="installation">
   <title>Installation</title>
   <para>
@@ -32,7 +32,7 @@
       (required)</term>
      <listitem>
       <para>
-       Zebra uses YAZ to support Z39.50/SRW. Also the memory management
+       Zebra uses YAZ to support Z39.50/ <ulink url="http://www.loc.gov/standards/sru/srw/">SRW</ulink>. Also the memory management
        utilites from YAZ is used by Zebra.
       </para>
      </listitem>
     to configure.
    </para>
   </sect1>
+
+  <sect1 id="installation.debian"><title>GNU/Debian</title>
+   <sect2 id="installation.debianlinux"><title>GNU/Debian Linux on
+   i686 Platform</title>
+    <para>
+     Index Data provides pre-compiled <literal>GNU/Debian i686
+      Linux</literal> packages at our Debian package archive, both for
+     the <literal>Sarge</literal> and the <literal>Etch</literal> release. 
+    </para>
+    
+    <para>
+     To install these packages, you need to add two lines to your
+     <literal>/etc/apt/sources.list</literal> configuration file,
+     either the <literal>Sarge</literal> sources found at
+     <screen>
+      deb http://ftp.indexdata.dk/t/debian sarge main
+      deb-src http://ftp.indexdata.dk/t/debian sarge main
+     </screen>
+     or the <literal>Etch</literal> sources from 
+     <screen>
+      deb http://ftp.indexdata.dk/t/debian etch main
+      deb-src http://ftp.indexdata.dk/t/debian etch main
+     </screen>
+     After refreshing the package cache with the command
+     <screen>
+      apt-get update
+     </screen>
+     as <literal>root</literal>, the 
+     <ulink url="http://indexdata.dk/zebra/">Zebra</ulink> indexer is
+     easily installed issuing
+     <screen>
+      apt-get install idzebra idzebra-doc
+     </screen>
+    </para>
+   </sect2>
+   
+   <sect2 id="installation.debianother">
+    <title>GNU/Debian On Other Platforms</title>
+    <para>
+     These <ulink url="http://indexdata.dk/zebra/">Zebra</ulink>
+     packages are specifically compiled for
+     <literal>GNU/Debian Linux</literal> systems. Installation on other 
+     <literal>GNU/Debian</literal> systems is possible by
+     re-compilation the Debian way: you need to add only the 
+     <literal>deb-src</literal> sources lines to the 
+     <literal>/etc/apt/sources.list</literal> configuration file,
+     that is either the <literal>Sarge</literal> sources
+     <screen>
+      deb-src http://ftp.indexdata.dk/t/debian sarge main
+     </screen>
+     or the <literal>Etch</literal> sources
+     <screen>
+      deb-src http://ftp.indexdata.dk/t/debian etch main
+     </screen>
+     After refreshing the package cache with the command
+     <screen>
+      apt-get update
+     </screen>
+     as <literal>root</literal>, the 
+     <ulink url="http://indexdata.dk/zebra/">Zebra</ulink> indexer is
+     recompiled and installed issuing
+     <screen>
+      apt-get build-dep idzebra
+      apt-get source --compile idzebra
+     </screen>
+     as normal user.
+     The compiled <literal>GNU/Debian</literal> packages can then be
+     installed as <literal>root</literal> issuing
+     <screen>
+      dpkg -i install idzebra*.deb idzebra-doc*.deb
+     </screen>
+    </para>
+   </sect2>
+  </sect1>
+
   <sect1 id="installation.win32"><title>WIN32</title>
    <para>The easiest way to install Zebra on Windows is by downloading
     an installer from 
        <literal>EXPAT_DIR</literal></term>
       <listitem><para>
         If <literal>HAVE_EXPAT</literal> is set to 1, Zebra is compiled
-        with Expat support. In this configuration, set 
-        <literal>ZEBRA_DIR</literal> to the Expat source directory.
+        with <ulink url="http://expat.sourceforge.net/">Expat</ulink> support. In this configuration, set 
+        <literal>ZEBRA_DIR</literal> to the <ulink url="http://expat.sourceforge.net/">Expat</ulink> source directory.
        Windows version of Expat can be downloaded from
        <ulink url="http://sourceforge.net/projects/expat/">
         SourceForge
     
    </para>
   </sect1>
+
+
+  <sect1 id="installation-upgrade">
+   <title>Upgrading from Zebra version 1.3.x</title>
+   <para>
+    Zebra's installation directories have changed a bit. In addition,
+    the new loadable modules must be defined in the 
+    master <filename>zebra.cfg</filename> configuration file. The old
+    version 1.3.x configuration options
+    <screen>
+     # profilePath - where to look for config files
+     profilePath: some/local/path:/usr/share/idzebra/tab
+    </screen>
+    must be changed to 
+    <screen>
+     # profilePath - where to look for config files
+     profilePath: some/local/path:/usr/share/idzebra-2.0/tab
+
+     # modulePath - where to look for loadable zebra modules
+     modulePath: /usr/lib/idzebra-2.0/
+    </screen>
+   </para>
+   <para>
+    The internal binary register structures have changed; all Zebra
+    databases must be re-indexed after upgrade.
+   </para>
+   <para>
+    The attribute set defintion files may no longer contain
+    redirection to other fields. 
+    For example the following snippet of
+    a custom <filename>custom/bib1.att</filename> 
+    <literal>Bib-1</literal> attribute set definition file is no
+    longer supported:
+    <screen>
+     att 1016            Any           1016,4,1005,62
+    </screen>
+    and should be changed to 
+    <screen>
+     att 1016            Any
+    </screen>
+   </para>
+   <para>
+    Similar behaviour can be expressed in the new release by defining
+    a new index <literal>Any:w</literal> in all GRS
+    <filename>*.abs</filename> record indexing configuration files.
+    The above example configuration needs to make the changes
+    from version 1.3.x indexing instructions
+    <screen>
+     xelm /*/alternative  Body-of-text:w,Title:s,Title:w
+     xelm /*/title        Body-of-text:w,Title:s,Title:w
+    </screen>
+    to version 2.0.0 indexing instructions
+    <screen>
+     xelm /*/alternative  Any:w,Body-of-text:w,Title:s,Title:w
+     xelm /*/title        Any:w,Body-of-text:w,Title:s,Title:w
+    </screen>
+   </para>
+   <para>
+    It is also possible to map the numerical attribute value  
+    <literal>@attr 1=1016</literal> onto another already existing huge
+    index, in this example, one could for example use the mapping
+    <screen>
+     att 1016            Body-of-text
+    </screen>
+    with equivalent outcome without editing all  GRS
+    <filename>*.abs</filename> record indexing configuration files.
+   </para>
+
+   <para>
+    Server installations which use the special
+    <literal>IDXPATH</literal> attribute set must add the following
+    line to the <filename>zebra.cfg</filename> configuration file:
+    <screen>
+     attset: idxpath.att
+    </screen>
+    </para>
+  </sect1>
+  
  </chapter>
  <!-- Keep this comment at the end of the file
  Local variables: