Change makefiles so that html files are automatically installed and
[idzebra-moved-to-github.git] / doc / installation.xml
index e1c77d3..c19627f 100644 (file)
@@ -1,25 +1,23 @@
-<!-- $Id: installation.xml,v 1.28 2006-08-14 19:56:50 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.29 2006-09-03 21:37:26 adam Exp $ -->
  <chapter id="installation">
   <title>Installation</title>
   <para>
    Zebra is written in ANSI C and was implemented with portability in mind. 
-   We primarily use <ulink url="http://gcc.gnu.org/">GCC</ulink> on UNIX and 
-   <ulink url="http://msdn.microsoft.com/vstudio/">
-    Microsoft Visual C++</ulink>
-   on Windows.
+   We primarily use <ulink url="&url.gcc;">GCC</ulink> on UNIX and 
+   <ulink url="&url.vstudio;">Microsoft Visual C++</ulink> on Windows.
   </para>
 
   <para>
    The software is regularly tested on
-   <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>,
-   <ulink url="http://www.redhat.com/">Redhat Linux</ulink>,
-   <ulink url="http://www.gentoo.org/">Gentoo Linux</ulink>,
-   <ulink url="http://www.suse.com/">SuSE Linux</ulink>,
-   <ulink url="http://www.freebsd.org/">FreeBSD (i386)</ulink>,
-   <ulink url="http://www.apple.com/macosx/">MAC OSX</ulink>,
-   <ulink url="http://www.sun.com/software/solaris/">SunOS 5.8
+   <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
+   <ulink url="&url.redhat;">Redhat Linux</ulink>,
+   <ulink url="&url.gentoo;">Gentoo Linux</ulink>,
+   <ulink url="&url.suse;">SuSE Linux</ulink>,
+   <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
+   <ulink url="&url.macosx;">MAC OSX</ulink>,
+   <ulink url="&url.solaris;">SunOS 5.8
     (sparc)</ulink>,
-   <ulink url="http://www.microsoft.com/windows2000/">Windows 2000</ulink>.
+   <ulink url="&url.windows2000;">Windows 2000</ulink>.
   </para>
   
   <para>
 
    <variablelist>
     <varlistentry>
-     <term><ulink url="http://www.indexdata.dk/yaz/">yaz</ulink>
+     <term><ulink url="&url.yaz;">yaz</ulink>
       (required)</term>
      <listitem>
       <para>
-       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.
+       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.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><ulink url="http://www.gnu.org/software/libiconv/">iconv</ulink>
+     <term><ulink url="&url.libiconv;">iconv</ulink>
       (optional)</term>
      <listitem>
       <para>
@@ -49,7 +48,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><ulink url="http://expat.sourceforge.net/">Expat</ulink>
+     <term><ulink url="&url.expat;">Expat</ulink>
       (optional)</term>
      <listitem>
       <para>
     </varlistentry>
     
     <varlistentry>
-     <term><ulink url="http://www.perl.com/">Perl</ulink> (optional)</term>
-     <listitem>
-      <para>
-       Perl is required if you're going to use the Zebra perl
-       filter facility or the Zebra perl API. Perl is preinstalled
-       on many Unixes. We've not tried the Perl extension on 
-       Windows ourselves.
-      </para>
-     </listitem>
-    </varlistentry>
-    
-    <varlistentry>
-     <term><ulink url="http://www.tcl.tk/">Tcl</ulink> (optional)</term>
+     <term><ulink url="&url.tcl;">Tcl</ulink> (optional)</term>
      <listitem>
       <para>
        Tcl is required if you  need to use the Tcl record filter
@@ -85,8 +72,8 @@
     
     <varlistentry>
      <term>
-      <ulink url="http://www.gnu.org/software/autoconf/">Autoconf</ulink>,
-      <ulink url="http://www.gnu.org/software/automake/">Automake</ulink>
+      <ulink url="&url.autoconf;">Autoconf</ulink>,
+      <ulink url="&url.automake;">Automake</ulink>
       (optional)</term>
      <listitem>
       <para>
@@ -98,7 +85,7 @@
     </varlistentry>
     
     <varlistentry>
-     <term><ulink url="http://docbook.org/">Docbook</ulink>
+     <term><ulink url="&url.docbook;">Docbook</ulink>
       and friends (optional)</term>
      <listitem>
       <para>
    </variablelist>
   </para>
 
-  <sect1 id="installation.unix"><title>UNIX</title>
+  <section id="installation-unix"><title>UNIX</title>
    <para>
     On Unix, GCC works fine, but any native
     C compiler should be possible to use as long as it is 
     You can override this with the <literal>--prefix</literal> option
     to configure.
    </para>
-  </sect1>
+  </section>
 
-  <sect1 id="installation.debian"><title>GNU/Debian</title>
-   <sect2 id="installation.debianlinux"><title>GNU/Debian Linux on
+  <section id="installation-debian"><title>GNU/Debian</title>
+   <section id="installation-debian-linux"><title>GNU/Debian Linux on
    i686 Platform</title>
     <para>
      Index Data provides pre-compiled GNU/Debian i686 Linux packages
       apt-get update
      </screen>
      as <literal>root</literal>, the 
-     <ulink url="http://indexdata.dk/zebra/">Zebra</ulink> indexer is
+     <ulink url="&url.idzebra;">Zebra</ulink> indexer is
      easily installed issuing
      <screen>
       apt-get install idzebra-2.0 idzebra-2.0-doc
      </screen>
     </para>
-   </sect2>
+   </section>
    
-   <sect2 id="installation.debianother">
+   <section id="installation-debia-nother">
     <title>Ubuntu/Debian and GNU/Debian on other platforms</title>
     <para>
-     These <ulink url="http://indexdata.dk/zebra/">Zebra</ulink>
+     These <ulink url="&url.idzebra;">Zebra</ulink>
      packages are specifically compiled for
      GNU/Debian Linux systems. Installation on other 
      GNU/Debian systems is possible by
       apt-get build-dep idzebra-2.0
      </screen>
      as <literal>root</literal>, the 
-     <ulink url="http://indexdata.dk/zebra/">Zebra</ulink> indexer is
+     <ulink url="&url.idzebra;">Zebra</ulink> indexer is
      recompiled and installed issuing
      <screen>
       apt-get source --compile idzebra-2.0
       dpkg -i install idzebra-2.0*.deb libidzebra-2.0*.deb
      </screen>
     </para>
-   </sect2>
-  </sect1>
+   </section>
+  </section>
 
-  <sect1 id="installation.win32"><title>WIN32</title>
+  <section id="installation-win32"><title>WIN32</title>
    <para>The easiest way to install Zebra on Windows is by downloading
     an installer from 
     <ulink url="http://ftp.indexdata.dk/pub/zebra/win32/">here</ulink>.
    
    <para>
     Zebra is shipped with "makefiles" for the NMAKE tool that comes
-    with <ulink url="http://msdn.microsoft.com/vstudio/">
-     Microsoft Visual C++</ulink>.
-    Version 6 has been tested. We expect that zebra compiles
-    with version 5 as well.
+    with <ulink url="&url.vstudio;">Microsoft Visual C++</ulink>.
+    Version 2003 and 2005 has been tested. We expect that zebra compiles
+    with version 6 as well.
    </para>
    <para>
     Start a command prompt and switch the sub directory
        <literal>EXPAT_DIR</literal></term>
       <listitem><para>
         If <literal>HAVE_EXPAT</literal> is set to 1, Zebra is compiled
-        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.
+        with <ulink url="&url.expat;">Expat</ulink> support.
+       In this configuration, set 
+        <literal>ZEBRA_DIR</literal> to the Expat source directory.
        Windows version of Expat can be downloaded from
-       <ulink url="http://sourceforge.net/projects/expat/">
-        SourceForge
-       </ulink>.
+       <ulink url="&url.expat;">SourceForge</ulink>.
        </para></listitem>
      </varlistentry>
      
         with iconv support. In this configuration, set 
         <literal>ICONV_DIR</literal> to the iconv source directory.
         Iconv binaries can be downloaded from
-        <ulink url="http://www.zlatkovic.com/projects/libxml/binaries.html">
-         this site
-       </ulink>.
+        <ulink url="&url.libxml2.download.win32;">this site</ulink>.
        </para>
       </listitem>
      </varlistentry>
       </term>
       <listitem><para>
         Define these symbols if Zebra is to be compiled with
-       <ulink url="http://sources.redhat.com/bzip2/">BZIP2</ulink>
-       record compression support.
+       <ulink url="&url.bzip2;">BZIP2</ulink> record compression support.
        </para></listitem>
      </varlistentry>
      
     </variablelist>
     
    </para>
-  </sect1>
+  </section>
 
 
-  <sect1 id="installation-upgrade">
+  <section id="installation-upgrade">
    <title>Upgrading from Zebra version 1.3.x</title>
    <para>
     Zebra's installation directories have changed a bit. In addition,
      attset: idxpath.att
     </screen>
     </para>
-  </sect1>
+  </section>
   
  </chapter>
  <!-- Keep this comment at the end of the file