doc/installation.xml

   1 <chapter id="installation">
   2   <!-- $Id: installation.xml,v 1.3 2002-10-22 08:23:57 adam Exp $ -->
   3   <title>Installation</title>
   4   <para>
   5    You need a C++ compiler to compile and use YAZ++.
   6    The software was implemented using GCC so we know that works
   7    well with YAZ++. From time to time the software has been
   8    compiled on Windows using Visual C++. Other compilers should
   9    work too. Let us know of portability problems, etc. with
  10    your system!
  11   </para>
  12   <para>
  13    YAZ++ is built on top of the
  14    <ulink url="http://indexdata.dk/yaz/">YAZ</ulink>
  15    toolkit.
  16    You need to install that first.
  17    For some platforms there are binary packages for YAZ.
  18   </para>
  19   <section id="unix">
  20    <title>UNIX</title>
  21    <para>On UNIX, the software is compiled as follows:
  22     <screen>
  23      ./configure
  24      make
  25      su
  26      make install
  27     </screen>
  28    </para>
  29    <para>
  30     You can supply options for the configure script.
  31     The most useful ones are:
  32     <variablelist>
  33      <varlistentry>
  34       <term><literal>--prefix </literal>directory</term>
  35       <listitem><para>
  36         Specifies installation prefix. By default
  37         <literal>/usr/local</literal> is used.
  38        </para></listitem>
  39      </varlistentry>
  40      <varlistentry>
  41       <term><literal>--with-yazconfig </literal>directory</term>
  42       <listitem><para>
  43         Specifies location of <filename>yaz-config</filename>.
  44         The <filename>yaz-config</filename> is generated in
  45         the source directory of YAZ as well as the binaries
  46         directory when YAZ is installed (via make install).
  47         </para>
  48        <para>
  49         If you don't supply this option, configure, will
  50         look for <filename>yaz-config</filename> in directories of the
  51         <literal>PATH</literal> environment.
  52        </para></listitem>
  53      </varlistentry>
  54     </variablelist>
  55     For the whole list of configure options, refer to the help:
  56     <literal>./configure --help</literal>.
  57    </para>
  58    <para>
  59     This is a list of what you have after successful compilation:
  60     <variablelist>
  61      <varlistentry>
  62       <term>src/yaz-proxy</term>
  63       <listitem><para>
  64         Z39.50 Proxy. This program gets installed in
  65         your binaries directory (prefix<literal>/bin</literal>).
  66        </para></listitem>
  67      </varlistentry>
  68      <varlistentry>
  69       <term>lib/libyaz++.la</term>
  70       <listitem><para>
  71         YAZ++ library. This library gets installed in your
  72         libraries directory (prefix<literal>/lib</literal>).
  73        </para></listitem>
  74      </varlistentry>
  75
  76      <varlistentry>
  77       <term>include/yaz++/*.h</term>
  78       <listitem><para>
  79         Various header files. All these are installed in
  80         your header files area (prefix<literal>/include/yaz++</literal>).
  81        </para></listitem>
  82      </varlistentry>
  83
  84      <varlistentry>
  85       <term>yaz++-config</term>
  86       <listitem><para>
  87         Bourne shell script utility that returns CFLAGS/LIBS
  88         needed in order to compile with the YAZ++ library.
  89         This script gets installed in your binaries directory
  90         (prefix<literal>/bin</literal>).
  91        </para></listitem>
  92      </varlistentry>
  93
  94      <varlistentry>
  95       <term>zoom/zclient</term>
  96       <listitem><para>
  97         ZOOM C++ demonstration client. This client does not
  98         get installed in the system directories.
  99        </para></listitem>
 100      </varlistentry>
 101
 102      <varlistentry>
 103       <term>src/yaz-my-client</term>
 104       <listitem><para>
 105         YAZ C++ demonstration client. This client does not
 106         get installed in the system directories.
 107        </para></listitem>
 108      </varlistentry>
 109
 110      <varlistentry>
 111       <term>src/yaz-my-server</term>
 112       <listitem><para>
 113         YAZ C++ demonstration server. This server does not
 114         get installed in the system directories.
 115        </para></listitem>
 116      </varlistentry>
 117     </variablelist>
 118    </para>
 119   </section>
 120  </chapter>
 121  <!-- Keep this comment at the end of the file
 122  Local variables:
 123  mode: sgml
 124  sgml-omittag:t
 125  sgml-shorttag:t
 126  sgml-minimize-attributes:nil
 127  sgml-always-quote-attributes:t
 128  sgml-indent-step:1
 129  sgml-indent-data:t
 130  sgml-parent-document: "yaz++.xml"
 131  sgml-local-catalogs: nil
 132  sgml-namecase-general:t
 133  End:
 134  -->