<chapter id="installation">
- <!-- $Id: installation.xml,v 1.10 2004-03-31 18:28:05 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.
+ 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
- <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.
</para>
<section id="unix">
- <title>Building on Unix</title>
+ <title>Installation on Unix (from source)</title>
<para>On UNIX, the software is compiled as follows:
<screen>
$ ./configure
<term><literal>--prefix </literal>directory</term>
<listitem><para>
Specifies installation prefix. By default
- <literal>/usr/local</literal> is used.
+ <filename>/usr/local</filename> is used.
</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
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:
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><filename>src/libyazpp.la</filename></term>
<listitem><para>
The YAZ++ library.
This library gets installed in your libraries directory
- (<parameter>prefix</parameter><literal>/lib</literal>).
+ (<parameter>prefix</parameter><filename>/lib</filename>).
</para></listitem>
</varlistentry>
<varlistentry>
- <term><literal>src/libzoomcpp.la</literal></term>
+ <term><filename>src/libzoompp.la</filename></term>
<listitem><para>
The <link linkend="zoom">ZOOM-C++</link> library.
This library gets installed in your libraries directory
- (<parameter>prefix</parameter><literal>/lib</literal>).
+ (<parameter>prefix</parameter><filename>/lib</filename>).
</para></listitem>
</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><filename>include/yazpp/*.h</filename></term>
<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><filename>/include/yazpp</filename>).
</para></listitem>
</varlistentry>
<varlistentry>
- <term><literal>yaz++-config</literal></term>
+ <term><filename>yazpp-config</filename></term>
<listitem><para>
A Bourne shell-script utility that returns the values of the
<envar>CFLAGS</envar> and <envar>LIBS</envar>
environment variables
needed in order to compile your applications with the YAZ++
library. This script gets installed in your binaries directory
- (<parameter>prefix</parameter><literal>/bin</literal>).
+ (<parameter>prefix</parameter><filename>/bin</filename>).
</para></listitem>
</varlistentry>
<varlistentry>
- <term><literal>zoom/zclient</literal></term>
+ <term><filename>zoom/zclient</filename></term>
<listitem><para>
ZOOM C++ demonstration client that uses the ZOOM C++ classes.
This client does not get installed in the system directories.
</varlistentry>
<varlistentry>
- <term><literal>src/yaz-my-client</literal></term>
+ <term><filename>src/yaz-my-client</filename></term>
<listitem><para>
YAZ C++ demonstration client. This client does not
get installed in the system directories.
</varlistentry>
<varlistentry>
- <term><literal>src/yaz-my-server</literal></term>
+ <term><filename>src/yaz-my-server</filename></term>
<listitem><para>
YAZ C++ demonstration server. This server does not
get installed in the system directories.
</para>
</section>
<section id="windows">
- <title>Building on Windows</title>
+ <title>Installation 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 version 5 as well.
+ with <ulink url="&url.vstudio;">Microsoft Visual Studio</ulink>.
+ Version 2003 (7) and 2005 (8) has been tested.
+ We expect that YAZ++ compiles with versions 5 and 6 as well.
</para>
- <para>
+ <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
(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><filename>YAZ_DIR</filename></term>
<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>
-
- <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>
The following files are generated upon successful compilation:
<variablelist>
- <varlistentry><term><filename>bin/yazpp.dll</filename></term>
+ <varlistentry><term><filename>bin/yazpp_1.dll</filename></term>
<listitem><para>
YAZ++ DLL . Includes ZOOM C++ as well.
+ For the debug version <filename>lib/yazpp_1_d.dll</filename>
+ is created instead.
</para></listitem></varlistentry>
- <varlistentry><term><filename>lib/yaz.lib</filename></term>
- <listitem><para>
- Import library for <filename>yazpp.dll</filename>.
- </para></listitem></varlistentry>
-
- <varlistentry><term><filename>bin/yazproxy.dll</filename></term>
+ <varlistentry><term><filename>lib/yazpp_1.lib</filename></term>
<listitem><para>
- YAZ proxy DLL.
+ Import library for <filename>yazpp_1.dll</filename>.
+ For the debug version <filename>lib/yazpp_1_d.lib</filename>
+ is created instead.
</para></listitem></varlistentry>
- <varlistentry><term><filename>lib/yazproxy.lib</filename></term>
+ <varlistentry><term><filename>bin/yaz-my-client.exe</filename></term>
<listitem><para>
- Import library for <filename>yazproxy.dll</filename>.
+ Z39.50 client demonstrating the YAZ++ API.
</para></listitem></varlistentry>
-
- <varlistentry><term><filename>bin/yaz-proxy.exe</filename></term>
+
+ <varlistentry><term><filename>bin/yaz-my-server.exe</filename></term>
<listitem><para>
- YAZ proxy. It's a WIN32 console application.
- See <xref linkend="proxy"/> for more information.
+ Z39.50 server demonstrating the YAZ++ API.
</para></listitem></varlistentry>
-
+
<varlistentry><term><filename>bin/zclient.exe</filename></term>
<listitem><para>
ZOOM C++ demo client. A simple WIN32 console application.
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:
projects / yazpp-moved-to-github.git / blobdiff