Installation instructions

diff --git a/doc/installation.xml b/doc/installation.xml
index b6a9aab..82b86cb 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,10 +1,123 @@
 <chapter id="installation">
- <!-- $Id: installation.xml,v 1.1 2002-10-08 11:55:57 adam Exp $ -->
- <title>Installation</title>
- <para>
-  How to compile this software.
- </para>
-</chapter>
+  <!-- $Id: installation.xml,v 1.2 2002-10-21 13:37:50 adam Exp $ -->
+  <title>Installation</title>
+  <para>
+   You need a C++ compiler to compile and use YAZ++.
+   The software was implemented using GCC so we know that works
+   well with YAZ++. 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
+   your system!
+  </para>
+  <para>
+   YAZ++ is built on top of the 
+   <ulink url="http://indexdata.dk/yaz/">YAZ</ulink>
+   toolkit.
+   You need to install that first.
+   For some platforms there are binary packages for YAZ.
+  </para>
+  <section id="unix">
+   <title>UNIX</title>
+   <para>On UNIX, the software is compiled as follows:
+    <screen>
+     ./configure
+     make
+     su
+     make install
+    </screen>
+   </para>
+   <para>
+    You can supply options for the configure script.
+    The most useful ones are:
+    <variablelist>
+     <varlistentry>
+      <term><literal>--prefix </literal>directory</term>
+      <listitem><para>
+        Specifies installation prefix. By default
+        <literal>/usr/local</literal> is used.
+       </para></listitem>
+     </varlistentry>
+     <varlistentry>
+      <term><literal>--with-yazconfig </literal>directory</term>
+      <listitem><para>
+        Specifies location of <filename>yaz-config</filename>.
+        The <filename>yaz-config</filename> 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, configure, will
+        look for <filename>yaz-config</filename> in directories of the
+        <literal>PATH</literal> environment.
+       </para></listitem>
+     </varlistentry>
+    </variablelist>
+    For the whole list of configure options, refer to the help:
+    <literal>./configure --help</literal>.
+   </para>
+   <para>
+    This is a list of what you have after succesful compilation:
+    <variablelist>
+     <varlistentry>
+      <term>src/yaz-proxy</term> 
+      <listitem><para>
+        Z39.50 Proxy. This program gets installed in
+        your binaries directory (prefix<literal>/bin</literal>).
+       </para></listitem>
+     </varlistentry>
+     <varlistentry>
+      <term>lib/libyaz++.la</term> 
+      <listitem><para>
+        YAZ++ library. This library gets installed in your
+        libraries directory (prefix<literal>/lib</literal>).
+       </para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>include/yaz++/*.h</term> 
+      <listitem><para>
+        Various header files. All these are installed in
+        your header files area (prefix<literal>/include/yaz++</literal>).
+       </para></listitem>
+     </varlistentry>
+     
+     <varlistentry>
+      <term>yaz++-config</term> 
+      <listitem><para>
+        Bourne shell script utility that returns CFLAGS/LIBS
+        needed in order to compile with the YAZ++ library.
+        This script gets installed in your binaries directory
+        (prefix<literal>/bin</literal>).
+       </para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>zoom/zclient</term> 
+      <listitem><para>
+        ZOOM C++ demonstration client. This client does not
+        get installed in the system directories.
+       </para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>src/yaz-my-client</term> 
+      <listitem><para>
+        YAZ C++ demonstration client. This client does not
+        get installed in the system directories.
+       </para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>src/yaz-my-server</term> 
+      <listitem><para>
+        YAZ C++ demonstration server. This server does not
+        get installed in the system directories.
+       </para></listitem>
+     </varlistentry>
+    </variablelist>
+   </para>
+  </section>
+ </chapter>
  <!-- Keep this comment at the end of the file
  Local variables:
  mode: sgml
@@ -14,7 +127,7 @@
  sgml-always-quote-attributes:t
  sgml-indent-step:1
  sgml-indent-data:t
- sgml-parent-document: "zebra.xml"
+ sgml-parent-document: "yaz++.xml"
  sgml-local-catalogs: nil
  sgml-namecase-general:t
  End: