Using common entities

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

diff --git a/doc/installation.xml b/doc/installation.xml
index 95a6c61..dbd3d46 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,17 +1,17 @@
 <chapter id="installation">
 <chapter id="installation">

-  <!-- $Id: installation.xml,v 1.10 2004-03-31 18:28:05 adam Exp $ -->
+  <!-- $Id: installation.xml,v 1.18 2006-04-27 13:04:39 adam Exp $ -->

   <title>Installation</title>
   <para>
    You need a C++ compiler to compile and use YAZ++.
   <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.
+   The software was implemented using <ulink url="&url.gcc;">GCC</ulink>
+   so we know that works well with YAZ++. From time to time the
+   software is 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 
   </para>
   <para>
    YAZ++ is built on top of the 

-   <ulink url="http://indexdata.dk/yaz/">YAZ</ulink>
+   <ulink url="&url.yaz;">YAZ</ulink>

    toolkit.
    You need to install that first.
    For some platforms there are binary packages for YAZ.
    toolkit.
    You need to install that first.
    For some platforms there are binary packages for YAZ.

@@ -38,7 +38,7 @@
        </para></listitem>
      </varlistentry>
      <varlistentry>
        </para></listitem>
      </varlistentry>
      <varlistentry>

-      <term><literal>--with-yazconfig </literal>directory</term>
+      <term><literal>--with-yaz </literal>directory</term>

       <listitem><para>
         Specifies the location of <filename>yaz-config</filename>.
         The <filename>yaz-config</filename> program is generated in
       <listitem><para>
         Specifies the location of <filename>yaz-config</filename>.
         The <filename>yaz-config</filename> program is generated in

@@ -52,15 +52,6 @@
         what you want.
        </para></listitem>
      </varlistentry>
         what you want.
        </para></listitem>
      </varlistentry>

-     <varlistentry>
-      <term><literal>--with-xslt </literal>directory</term>
-      <listitem><para>
-        Specifies prefix for libxslt (and libxml2).
-       configure must be able to locate <command>xslt-config</command>
-       in PREFIX/bin. If this option is omitted, configure looks
-       for <command>xslt-config</command> in the current PATH.
-       </para></listitem>
-     </varlistentry>

     </variablelist>
     For the whole list of <literal>configure</literal> options, refer
     to the help:
     </variablelist>
     For the whole list of <literal>configure</literal> options, refer
     to the help:

@@ -79,16 +70,7 @@
     This is what you have after successful compilation:
     <variablelist>
      <varlistentry>
     This is what you have after successful compilation:
     <variablelist>
      <varlistentry>

-      <term><literal>proxy/yaz-proxy</literal></term> 
-      <listitem><para>
-        The YAZ <link linkend="proxy">Z39.50 Proxy</link>.
-       This program gets installed in your binaries directory
-       (<parameter>prefix</parameter><literal>/bin</literal>).
-       </para></listitem>
-     </varlistentry>
-
-     <varlistentry>
-      <term><literal>src/libyazcpp.la</literal></term> 
+      <term><literal>src/libyazpp.la</literal></term> 

       <listitem><para>
         The YAZ++ library.
        This library gets installed in your libraries directory
       <listitem><para>
         The YAZ++ library.
        This library gets installed in your libraries directory

@@ -97,7 +79,7 @@
      </varlistentry>
      
      <varlistentry>
      </varlistentry>
      
      <varlistentry>

-      <term><literal>src/libzoomcpp.la</literal></term> 
+      <term><literal>src/libzoompp.la</literal></term> 

       <listitem><para>
         The <link linkend="zoom">ZOOM-C++</link> library.
        This library gets installed in your libraries directory
       <listitem><para>
         The <link linkend="zoom">ZOOM-C++</link> library.
        This library gets installed in your libraries directory

@@ -106,25 +88,16 @@
      </varlistentry>
      
      <varlistentry>
      </varlistentry>
      
      <varlistentry>

-      <term><literal>proxy/libyazproxy.la</literal></term> 
-      <listitem><para>
-        The YAZ proxy library. This library gets installed in
-       your libraries directory
-       (<parameter>prefix</parameter><literal>/lib</literal>).
-       </para></listitem>
-     </varlistentry>
-
-     <varlistentry>
-      <term><literal>include/yaz++/*.h</literal></term> 
+      <term><literal>include/yazpp/*.h</literal></term> 

       <listitem><para>
         Various C++ header files, which you'll need for YAZ++
        development. All these are installed in your header files area
       <listitem><para>
         Various C++ header files, which you'll need for YAZ++
        development. All these are installed in your header files area

-       (<parameter>prefix</parameter><literal>/include/yaz++</literal>).
+       (<parameter>prefix</parameter><literal>/include/yazpp</literal>).

        </para></listitem>
      </varlistentry>
      
      <varlistentry>
        </para></listitem>
      </varlistentry>
      
      <varlistentry>

-      <term><literal>yaz++-config</literal></term> 
+      <term><literal>yazpp-config</literal></term> 

       <listitem><para>
         A Bourne shell-script utility that returns the values of the
        <envar>CFLAGS</envar> and <envar>LIBS</envar>
       <listitem><para>
         A Bourne shell-script utility that returns the values of the
        <envar>CFLAGS</envar> and <envar>LIBS</envar>

@@ -165,9 +138,8 @@
    <title>Building on Windows</title>
    <para>
     YAZ++ is shipped with "makefiles" for the NMAKE tool that comes
    <title>Building on Windows</title>
    <para>
     YAZ++ is shipped with "makefiles" for the NMAKE tool that comes

-    with <ulink url="http://msdn.microsoft.com/vstudio/">
-     Microsoft Visual Studio</ulink>.
-    Version 6 and .NET has been tested. We expect that YAZ++ compiles
+    with <ulink url="&url.vstudio;">Microsoft Visual Studio</ulink>.
+    Version 6 and .NET 2003 has been tested. We expect that YAZ++ compiles

     with version 5 as well.
    </para>
     <para>
     with version 5 as well.
    </para>
     <para>

@@ -188,65 +160,11 @@
        (code generation is multi-threaded DLL).
        </para></listitem>
      </varlistentry>
        (code generation is multi-threaded DLL).
        </para></listitem>
      </varlistentry>

-
-     <varlistentry>
-      <term><literal>HAVE_XSLT</literal>,
-       <literal>LIBXSLT_DIR</literal></term>
-      <listitem>
-       <para>
-       If <literal>HAVE_LIBXSLT</literal> is set to 1, the proxy is compiled
-       with XSLT and XML support. In this configuration, set 
-       <literal>LIBXSLT_DIR</literal> to the 
-       <ulink url="http://www.xmlsoft.org/">libxslt</ulink> source
-       directory.
-       </para>
-       
-       <note>
-       <para>
-        If you enable libXSLT you have to enable libxml2 and its
-        sub components zlib and iconv as well.
-       </para>
-       </note>
-       
-       <para>
-       Windows versions of libxslt, libxml2, zlib and iconv can be found
-       <ulink url="http://www.zlatkovic.com/libxml.en.html">
-        here</ulink>.
-       </para>
-      </listitem>
-     </varlistentry>
-
-     <varlistentry>
-      <term><literal>HAVE_ICONV</literal>,
-       <literal>ICONV_DIR</literal></term>
+     <varlistentry><term><literal>YAZ_DIR</literal></term>

       <listitem><para>
       <listitem><para>

-       If <literal>HAVE_ICONV</literal> is set to 1, the proxy is
-       compiled with iconv support. In this configuration, set 
-       <literal>ICONV_DIR</literal> to the iconv source directory.
+       Specifies the directory of the YAZ source.

        </para></listitem>
      </varlistentry>
        </para></listitem>
      </varlistentry>

-     
-     <varlistentry>
-      <term><literal>HAVE_LIBXML2</literal>,
-       <literal>LIBXML2_DIR</literal></term>
-      <listitem>
-       <para>
-       If <literal>HAVE_LIBXML2</literal> is set to 1, the proxy is compiled
-       with XML support. In this configuration, set 
-       <literal>LIBXML2_DIR</literal> to the 
-       <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory
-       and
-       <literal>ZLIB_DIR</literal> to the zlib directory.
-       </para>
-       
-       <note>
-       <para>
-        YAZ++ is not using ZLIB. But libxml2 is.
-       </para>
-       </note>
-      </listitem>
-     </varlistentry>
-     

     </variablelist>
    </para>
    <para>
     </variablelist>
    </para>
    <para>

@@ -282,27 +200,11 @@
        YAZ++ DLL . Includes ZOOM C++ as well.
        </para></listitem></varlistentry>
      
        YAZ++ DLL . Includes ZOOM C++ as well.
        </para></listitem></varlistentry>
      

-     <varlistentry><term><filename>lib/yaz.lib</filename></term>
+     <varlistentry><term><filename>lib/yazpp.lib</filename></term>

       <listitem><para>
        Import library for <filename>yazpp.dll</filename>.
        </para></listitem></varlistentry>
      
       <listitem><para>
        Import library for <filename>yazpp.dll</filename>.
        </para></listitem></varlistentry>
      

-     <varlistentry><term><filename>bin/yazproxy.dll</filename></term>
-      <listitem><para>
-       YAZ proxy DLL.
-       </para></listitem></varlistentry>
-     
-     <varlistentry><term><filename>lib/yazproxy.lib</filename></term>
-      <listitem><para>
-       Import library for <filename>yazproxy.dll</filename>.
-       </para></listitem></varlistentry>
-     
-     <varlistentry><term><filename>bin/yaz-proxy.exe</filename></term>
-      <listitem><para>
-       YAZ proxy. It's a WIN32 console application.
-       See <xref linkend="proxy"/> for more information.
-       </para></listitem></varlistentry>
-     

      <varlistentry><term><filename>bin/zclient.exe</filename></term>
       <listitem><para>
        ZOOM C++ demo client. A simple WIN32 console application.
      <varlistentry><term><filename>bin/zclient.exe</filename></term>
       <listitem><para>
        ZOOM C++ demo client. A simple WIN32 console application.

@@ -323,7 +225,7 @@
  sgml-always-quote-attributes:t
  sgml-indent-step:1
  sgml-indent-data:t
  sgml-always-quote-attributes:t
  sgml-indent-step:1
  sgml-indent-data:t

- sgml-parent-document: "yaz++.xml"
+ sgml-parent-document: "yazpp.xml"

  sgml-local-catalogs: nil
  sgml-namecase-general:t
  End:
  sgml-local-catalogs: nil
  sgml-namecase-general:t
  End: