More documentation

[yazproxy-moved-to-github.git] / doc / installation.xml

diff --git a/doc/installation.xml b/doc/installation.xml
index 62a5228..fab423e 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,5 +1,5 @@
 <chapter id="installation">
-  <!-- $Id: installation.xml,v 1.2 2004-04-11 11:58:34 adam Exp $ -->
+  <!-- $Id: installation.xml,v 1.3 2004-04-15 12:04:01 adam Exp $ -->
   <title>Installation</title>
   <para>
    You need a C++ compiler to compile and use YAZ proxy.
@@ -17,6 +17,14 @@
    You need to install these first.
    For some platforms there are binary packages for YAZ/YAZ++.
   </para>
+  <para>
+   We also highly recommend that
+   <ulink url="http://xmlsoft.org/">libxml2</ulink> and
+   <ulink url="http://xmlsoft.org/XSLT/">libxslt</ulink> are installed.
+   YAZ must be configured with libxml2 support.
+   If not, SRW/SRU is not supported.
+   The YAZ Proxy uses libxslt for record conversions via XSLT.
+  </para>
   <section id="unix">
    <title>Building on Unix</title>
    <para>On UNIX, the software is compiled as follows:
@@ -70,8 +78,8 @@
    <para>
     Configure uses GCC's C/C++ compiler if available. To specify another
     compiler, set <literal>CXX</literal>. To use other compiler flags,
-    specify <literal>CXXFLAGS</literal>. To use <literal>CC</literal> 
-    with debugging you could use:
+    specify <literal>CXXFLAGS</literal>. For example, to use
+    <literal>CC</literal> with debugging do:
     <screen>
      CXXFLAGS="-g" CXX=CC ./configure
     </screen>
@@ -82,8 +90,8 @@
      <varlistentry>
       <term><literal>src/yazproxy</literal></term> 
       <listitem><para>
-        The YAZ <link linkend="proxy">Z39.50 Proxy</link>.
-       This program gets installed in your binaries directory
+        The YAZ Proxy program.
+       It gets installed in your binaries directory
        (<parameter>prefix</parameter><literal>/bin</literal>).
        </para></listitem>
      </varlistentry>
@@ -92,7 +100,7 @@
       <term><literal>src/libyazproxy.la</literal></term> 
       <listitem><para>
         The YAZ proxy library. This library gets installed in
-       your libraries directory
+       the libraries directory
        (<parameter>prefix</parameter><literal>/lib</literal>).
        </para></listitem>
      </varlistentry>
@@ -100,12 +108,22 @@
      <varlistentry>
       <term><literal>include/yazproxy/*.h</literal></term> 
       <listitem><para>
-        Various C++ header files, which you'll need for YAZ proxy
-       development. All these are installed in your header files area
+        C++ header files, which you'll need for YAZ proxy
+       development. All these are installed in the header files area
        (<parameter>prefix</parameter><literal>/include/yazproxy</literal>).
        </para></listitem>
      </varlistentry>
      
+     <varlistentry>
+      <term><literal>etc</literal></term> 
+      <listitem><para>
+       Various files that may be read by YAZ proxy - including
+       configuration file, XSLT files, CQL to RPN conversion.
+       These files are installed in the YAZ proxy's data area
+       (<parameter>prefix</parameter><literal>/share/yazproxy</literal>).
+       </para></listitem>
+     </varlistentry>
+     
     </variablelist>
    </para>
   </section>
@@ -118,7 +136,16 @@
     Version 6 and .NET has been tested. We expect that YAZ++ compiles
     with version 5 as well.
    </para>
+   <note>
     <para>
+     The YAZ proxy has never been used in production on Windows. Although
+     it compiles and runs, doesn't mean it scale on that platform.
+     Furthermore the
+     YAZ proxy currently doesn't run as a Service - only as a Console
+     application.
+    </para>
+   </note>
+   <para>
     Start a command prompt and switch the sub directory
     <filename>WIN</filename> where the file <filename>makefile</filename>
     is located. Customize the installation by editing the
@@ -137,6 +164,18 @@
        </para></listitem>
      </varlistentry>
 
+     <varlistentry><term><literal>YAZ_DIR</literal></term>
+      <listitem><para>
+       This must be set to the home of the YAZ source directory.
+       </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><literal>YAZPP_DIR</literal></term>
+      <listitem><para>
+       This must be set to the home of the YAZ++ source directory.
+       </para></listitem>
+     </varlistentry>
+
      <varlistentry>
       <term><literal>HAVE_XSLT</literal>,
        <literal>LIBXSLT_DIR</literal></term>
@@ -238,7 +277,6 @@
      <varlistentry><term><filename>bin/yazproxy.exe</filename></term>
       <listitem><para>
        YAZ proxy. It's a WIN32 console application.
-       See <xref linkend="proxy"/> for more information.
        </para></listitem></varlistentry>
      
     </variablelist>