<chapter id="installation">
- <!-- $Id: installation.xml,v 1.18 2006-04-27 13:04:39 adam Exp $ -->
+ <!-- $Id: installation.xml,v 1.19 2006-04-30 12:53:14 adam Exp $ -->
<title>Installation</title>
<para>
You need a C++ compiler to compile and use YAZ++.
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>
This is what you have after successful compilation:
<variablelist>
<varlistentry>
- <term><literal>src/libyazpp.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/libzoompp.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>include/yazpp/*.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/yazpp</literal>).
+ (<parameter>prefix</parameter><filename>/include/yazpp</filename>).
</para></listitem>
</varlistentry>
<varlistentry>
- <term><literal>yazpp-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="&url.vstudio;">Microsoft Visual Studio</ulink>.
- Version 6 and .NET 2003 has been tested. We expect that YAZ++ compiles
- with version 5 as well.
+ 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>YAZ_DIR</literal></term>
+ <varlistentry><term><filename>YAZ_DIR</filename></term>
<listitem><para>
Specifies the directory of the YAZ source.
</para></listitem>
<varlistentry><term><filename>bin/yazpp.dll</filename></term>
<listitem><para>
YAZ++ DLL . Includes ZOOM C++ as well.
+ For the debug version <filename>lib/yazppd.dll</filename>
+ is created instead.
</para></listitem></varlistentry>
<varlistentry><term><filename>lib/yazpp.lib</filename></term>
<listitem><para>
Import library for <filename>yazpp.dll</filename>.
+ For the debug version <filename>lib/yazppd.lib</filename>
+ is created instead.
</para></listitem></varlistentry>
+ <varlistentry><term><filename>bin/yaz-my-client.exe</filename></term>
+ <listitem><para>
+ Z39.50 client demonstrating the YAZ++ API.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>bin/yaz-my-server.exe</filename></term>
+ <listitem><para>
+ 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.
<chapter id="zoom">
- <!-- $Id: zoom.xml,v 1.15 2006-04-25 12:37:05 marc Exp $ -->
+ <!-- $Id: zoom.xml,v 1.16 2006-04-30 12:53:14 adam Exp $ -->
<title>ZOOM-C++</title>
<sect1 id="zoom-introduction">
<title>Introduction</title>
<para>
- <ulink url="http://zoom.z3950.org/">ZOOM</ulink>
+ <ulink url="&url.zoom;">ZOOM</ulink>
is the emerging standard API for information retrieval programming
using the Z39.50 protocol. ZOOM's
- <ulink url="http://zoom.z3950.org/api/">Abstract API</ulink>
+ <ulink url="&url.zoom.api;">Abstract API</ulink>
specifies semantics for classes representing key IR concepts such as
connections, queries, result sets and records; and there are various
- <ulink url="http://zoom.z3950.org/bind/">bindings</ulink>
+ <ulink url="&url.zoom.bind;">bindings</ulink>
specifying how those concepts should be represented in various
programming languages.
</para>
<para>
The YAZ++ library includes an implementation of the <ulink
- url="http://zoom.z3950.org/bind/cplusplus/"
- >C++ binding</ulink>
+ url="&url.zoom.bind.cplusplus;">C++ binding</ulink>
for ZOOM, enabling quick, easy development of client applications.
</para>
<para>
implementation of the C binding. For information on the supported
options and other such details, see the ZOOM-C documentation, which
can be found on-line at
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.tkl"/>
+ <ulink url="&url.yaz.zoom;"/>
</para>
<para>
All of the classes defined by ZOOM-C++ are in the
<para>
<ulink url="http://zoom.z3950.org/api/zoom-1.3.html#3.2"
>Section 3.2 (Connection) of the ZOOM Abstract API</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.tkl#zoom.connections"
- >The Connections section of the ZOOM-C documentation</ulink>
- </para>
- </listitem>
- </itemizedlist>
- </sect2>
- </sect1>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="&url.yaz.zoom.connections;"
+ >The Connections section f the ZOOM-C documentation</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ </sect1>
<sect1 id="zoom-query">
~prefixQuery ();
};
</synopsis>
- <para>
- This class enables a query to be created by compiling YAZ's
- cryptic but powerful
- <ulink url="http://www.indexdata.dk/yaz/doc/tools.tkl#PQF"
- >Prefix Query Notation (PQN)</ulink>.
- </para>
- </sect2>
-
+ <para>
+ This class enables a query to be created by compiling YAZ's
+ cryptic but powerful
+ <ulink url="&url.yaz.pqf;">Prefix Query Notation (PQN)</ulink>.
+ </para>
+ </sect2>
+
<sect2>
<title><literal>ZOOM::CCLQuery</literal></title>
<synopsis>
<para>
This class enables a query to be created using the simpler but
less expressive
- <ulink url="http://www.indexdata.dk/yaz/doc/tools.tkl#CCL"
- >Common Command Language (CCL)</ulink>.
+ <ulink url="&url.yaz.ccl;">Common Command Language (CCL)</ulink>.
The qualifiers recognised by the CCL parser are specified in an
external configuration file in the format described by the YAZ
documentation.
</listitem>
<listitem>
<para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.query.tkl"
+ <ulink url="&url.yaz.zoom.query;"
>The Queries section of the ZOOM-C documentation</ulink>
</para>
</listitem>
</listitem>
<listitem>
<para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.resultsets.tkl"
+ <ulink url="&url.yaz.zoom.resultsets;"
>The Result Sets section of the ZOOM-C documentation</ulink>
</para>
</listitem>
</listitem>
<listitem>
<para>
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.records.tkl"
+ <ulink url="&url.yaz.zoom.records;"
>The Records section of the ZOOM-C documentation</ulink>
</para>
</listitem>
</listitem>
<listitem>
<para>
- <ulink url="http://lcweb.loc.gov/z3950/agency/defns/bib1diag.html"
- >Bib-1 Diagnostics</ulink> on the
- <ulink url="http://lcweb.loc.gov/z3950/agency/"
- >Z39.50 Maintenance Agency</ulink> site.
+ <ulink url="&url.z39.50.diagnostics;">Bib-1 Diagnostics</ulink> on the
+ <ulink url="&url.z39.50;">Z39.50 Maintenance Agency</ulink> site.
</para>
</listitem>
</itemizedlist>
<literal>exception</literal> class and its subclasses. The
closest thing is the <literal>ZOOM_connection_error</literal>
function described in
- <ulink url="http://www.indexdata.dk/yaz/doc/zoom.tkl#zoom.connections"
+ <ulink url="&url.yaz.zoom.connections;"
>The Connections section</ulink> of the documentation.
</para>
</sect2>
projects / yazpp-moved-to-github.git / commitdiff