added notes on Ubuntu installation
[idzebra-moved-to-github.git] / doc / installation.xml
index c3f04b4..729743c 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.19 2006-04-25 12:26:26 marc Exp $ -->
+<!-- $Id: installation.xml,v 1.26 2006-06-30 10:45:09 marc Exp $ -->
  <chapter id="installation">
   <title>Installation</title>
   <para>
     By default this will install the Zebra executables in 
     <filename>/usr/local/bin</filename>,
     and the standard configuration files in 
-    <filename>/usr/local/share/idzebra</filename>
+    <filename>/usr/local/share/idzebra-2.0</filename>
     You can override this with the <literal>--prefix</literal> option
     to configure.
    </para>
   </sect1>
 
   <sect1 id="installation.debian"><title>GNU/Debian</title>
-   <sect2 id="installation.debianlinux"><title>GNU/Debian Linux</title>
+   <sect2 id="installation.debianlinux"><title>GNU/Debian Linux on
+   i686 Platform</title>
     <para>
-     Index Data provides pre-compiled <literal>GNU/Debian
+     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>
      <literal>/etc/apt/sources.list</literal> configuration file,
      either the <literal>Sarge</literal> sources found at
      <screen>
-      deb http://www.indexdata.dk/debian indexdata/sarge released
-      deb-src http://www.indexdata.dk/debian indexdata/sarge released
+      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://www.indexdata.dk/debian indexdata/etch released
-      deb-src http://www.indexdata.dk/debian indexdata/etch released
+      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>
      <ulink url="http://indexdata.dk/zebra/">Zebra</ulink> indexer is
      easily installed issuing
      <screen>
-      apt-get install idzebra idzebra-doc
+      apt-get install idzebra-2.0 idzebra-2.0-doc
      </screen>
     </para>
    </sect2>
    
    <sect2 id="installation.debianother">
-    <title>GNU/Debian On Other Platforms</title>
+    <title>GNU/Debian and Ubuntu/Debian On Other Platforms</title>
     <para>
      These <ulink url="http://indexdata.dk/zebra/">Zebra</ulink>
      packages are specifically compiled for
      <literal>/etc/apt/sources.list</literal> configuration file,
      that is either the <literal>Sarge</literal> sources
      <screen>
-      deb-src http://www.indexdata.dk/debian indexdata/sarge released
+      deb-src http://ftp.indexdata.dk/t/debian sarge main
      </screen>
      or the <literal>Etch</literal> sources
      <screen>
-      deb-src http://www.indexdata.dk/debian indexdata/etch released
+      deb-src http://ftp.indexdata.dk/t/debian etch main
      </screen>
      After refreshing the package cache with the command
      <screen>
       apt-get update
+      apt-get build-dep idzebra-2.0
      </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
+      apt-get source --compile idzebra-2.0
      </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
+      dpkg -i install idzebra-2.0*.deb libidzebra-2.0*.deb
      </screen>
     </para>
    </sect2>
    </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