node-zoom
Version:
1,356 lines (1,346 loc) • 360 kB
text/xml
<?xml version="1.0" standalone="no"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
<!ENTITY % local SYSTEM "local.ent">
%local;
<!ENTITY % entities SYSTEM "entities.ent">
%entities;
<!ENTITY % idcommon SYSTEM "common/common.ent">
%idcommon;
]>
<book>
<bookinfo>
<title>YAZ User's Guide and Reference</title>
<authorgroup>
<author><firstname>Sebastian</firstname><surname>Hammer</surname></author>
<author><firstname>Adam</firstname><surname>Dickmeiss</surname></author>
<author><firstname>Mike</firstname><surname>Taylor</surname></author>
<author><firstname>Heikki</firstname><surname>Levanto</surname></author>
<author><firstname>Dennis</firstname><surname>Schafroth</surname></author>
</authorgroup>
<releaseinfo>&version;</releaseinfo>
<copyright>
<year>©right-year;</year>
<holder>Index Data</holder>
</copyright>
<abstract>
<simpara>
This document is the programmer's guide and reference to the &yaz;
package version &version;. &yaz; is a compact toolkit that provides
access to the Z39.50 and SRU/Solr protocols, as well as a set of
higher-level tools for implementing the server and client
roles, respectively.
The documentation can be used on its own, or as a reference when
looking at the example applications provided with the package.
</simpara>
<simpara>
<inlinemediaobject>
<imageobject>
<imagedata fileref="common/id.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="common/id.eps" format="EPS"/>
</imageobject>
</inlinemediaobject>
</simpara></abstract>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>
&yaz; is a C/C++ library for information retrieval applications
using the Z39.50/SRU/Solr protocols for information retrieval.
</para>
<para>
Properties of &yaz;:
<itemizedlist>
<listitem>
<para>
Complete
<ulink url="&url.z39.50;">Z39.50</ulink> version 3 support.
Amendments and Z39.50-2002 revision is supported.
</para>
</listitem>
<listitem>
<para>
Supports
<ulink url="&url.sru;">SRU GET/POST/SOAP</ulink>
version 1.1, 1.2 and 2.0 (over HTTP and HTTPS).
</para>
</listitem>
<listitem>
<para>
Includes BER encoders/decoders for the
<ulink url="&url.ill;">ISO ILL</ulink>
protocol.
</para>
</listitem>
<listitem>
<para>
Supports
<ulink url="&url.solr;">Solr</ulink> Web Service version 1.4.x
(client side only)
</para>
</listitem>
<listitem>
<para>
Supports the following transports: BER over TCP/IP
(<ulink url="&url.ber.over.tcpip;">RFC1729</ulink>),
BER over unix local socket, and
<ulink url="&url.http.1.1;">HTTP 1.1</ulink>.
</para>
</listitem>
<listitem>
<para>
Secure Socket Layer support using
<ulink url="&url.gnutls;">GnuTLS</ulink>.
If enabled, &yaz; uses HTTPS transport (for SOAP) or
"Secure BER" (for Z39.50).
</para>
</listitem>
<listitem>
<para>
Offers
<ulink url="&url.zoom;">ZOOM</ulink> C API implementing
Z39.50, SRU and Solr Web Service.
</para>
</listitem>
<listitem>
<para>
The &yaz; library offers a set of useful utilities
related to the protocols, such as MARC (ISO2709) parser,
CCL (ISO8777) parser,
<ulink url="&url.cql;">CQL</ulink>
parser, memory management routines, character set conversion.
</para>
</listitem>
<listitem>
<para>
Portable code. &yaz; compiles out-of-the box on most Unixes and
on Windows using Microsoft Visual C++.
</para>
</listitem>
<listitem>
<para>
Fast operation. The C based BER encoders/decoders as well
as the server component of &yaz; is very fast.
</para>
</listitem>
<listitem>
<para>
Liberal license that allows for commercial use of &yaz;.
</para>
</listitem>
</itemizedlist>
</para>
<sect1 id="introduction.reading">
<title>Reading this Manual</title>
<para>
Most implementors only need to read a fraction of the
material in thie manual, so a quick walkthrough of the chapters
is in order.
</para>
<itemizedlist>
<listitem>
<para>
<xref linkend="installation"/> contains installation
instructions for &yaz;. You don't need reading this
if you expect to download &yaz; binaries.
However, the chapter contains information about how
to make <emphasis>your</emphasis> application link
with &yaz;.
</para>
</listitem>
<listitem>
<para>
<xref linkend="zoom"/> describes the ZOOM API of &yaz;.
This is definitely worth a read if you wish to develop a Z39.50/SRU
client.
</para>
</listitem>
<listitem>
<para>
<xref linkend="server"/> describes the generic frontend server
and explains how to develop server Z39.50/SRU applications for &yaz;.
Obviously worth reading if you're to develop a server.
</para>
</listitem>
<listitem>
<para>
<xref linkend="yaz-client"/> describes how to use the &yaz; Z39.50
client. If you're developer and wish to test your server
or a server from another party, you might find this chapter
useful.
</para>
</listitem>
<listitem>
<para>
<xref linkend="asn"/> documents the most commonly used Z39.50
C data structures offered by the &yaz; API. Client
developers using ZOOM and non-Z39.50 implementors may skip this.
</para>
</listitem>
<listitem>
<para>
<xref linkend="soap"/> describes how SRU and SOAP is used
in &yaz;. Only if you're developing SRU applications
this section is a must.
</para>
</listitem>
<listitem>
<para>
<xref linkend="tools"/> contains sections for the various
tools offered by &yaz;. Scan through the material quickly
and see what's relevant to you! SRU implementors
might find the <link linkend="cql">CQL</link> section
particularly useful.
</para>
</listitem>
<listitem>
<para>
<xref linkend="odr"/> goes through the details of the
ODR module which is the work horse that encodes and decodes
BER packages. Implementors using ZOOM only, do <emphasis>not</emphasis>
need reading this.
Most other Z39.50 implementors only need to read the first two
sections (<xref linkend="odr.introduction"/> and
<xref linkend="odr.use"/>).
</para>
</listitem>
<listitem>
<para>
<xref linkend="comstack"/> describes the network layer module
COMSTACK. Implementors using ZOOM or the generic frontend server
may skip this. Others, presumably, handling client/server
communication on their own should read this.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="introduction.api">
<title>The API</title>
<para>
The <ulink url="&url.yaz;">&yaz;</ulink>
toolkit offers several different levels of access to the
<ulink url="&url.z39.50;">ISO23950/Z39.50</ulink>,
<ulink url="&url.ill;">ILL</ulink> and
<ulink url="&url.sru;">SRU</ulink>
protocols.
The level that you need to use depends on your requirements, and
the role (server or client) that you want to implement.
If you're developing a client application you should consider the
<link linkend="zoom">ZOOM</link> API.
It is, by far, the easiest way to develop clients in C.
Server implementers should consider the
<link linkend="server">generic frontend server</link>.
None of those high-level APIs support the whole protocol, but
they do include most facilities used in existing Z39.50 applications.
</para>
<para>
If you're using 'exotic' functionality (meaning anything not included in
the high-level APIs), developing non-standard extensions to Z39.50 or
you're going to develop an ILL application you'll have to learn the lower
level APIs of &yaz;.
</para>
<para>
The YAZ toolkit modules is shown in figure <xref linkend="yaz.layer"/>.
</para>
<figure id="yaz.layer">
<title>YAZ layers</title>
<mediaobject>
<imageobject>
<imagedata fileref="apilayer.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="apilayer.eps" format="EPS"/>
</imageobject>
</mediaobject>
</figure>
<para>
There are four layers.
<itemizedlist>
<listitem>
<para>A client or server application (or both).
This layer includes ZOOM and the generic frontend server.
</para>
</listitem>
<listitem>
<para>
The second layer provides a C represenation of the
protocol units (packages) for Z39.50 ASN.1, ILL ASN.1,
SRU.
</para>
</listitem>
<listitem>
<para>
The third layer encodes and decodes protocol data units to
simple packages (buffer with certain length). The &odr; module
encodes and decodes BER whereas the HTTP modules encodes and
decodes HTTP ruquests/responses.
</para>
</listitem>
<listitem>
<para>
The lowest layer is &comstack; which exchanges the encoded packages
with a peer process over a network.
</para>
</listitem>
</itemizedlist>
</para>
<para>
The &asn; module represents the ASN.1 definition of
the Z39.50 protocol. It establishes a set of type and
structure definitions, with one structure for each of the top-level
PDUs, and one structure or type for each of the contained ASN.1 types.
For primitive types, or other types that are defined by the ASN.1
standard itself (such as the EXTERNAL type), the C representation is
provided by the &odr; (Open Data Representation) subsystem.
</para>
<para>
&odr; is a basic mechanism for representing an
ASN.1 type in the C programming language, and for implementing BER
encoders and decoders for values of that type. The types defined in
the &asn; module generally have the prefix <literal>Z_</literal>, and
a suffix corresponding to the name of the type in the ASN.1
specification of the protocol (generally Z39.50-1995). In the case of
base types (those originating in the ASN.1 standard itself), the prefix
<literal>Odr_</literal> is sometimes seen. Either way, look for
the actual definition in either <filename>z-core.h</filename> (for the types
from the protocol), <filename>odr.h</filename> (for the primitive ASN.1
types).
The &asn; library also provides functions (which are, in turn,
defined using &odr; primitives) for encoding and decoding data values.
Their general form is
<funcsynopsis>
<funcprototype><funcdef>int <function>z_<replaceable>xxx</replaceable></function></funcdef>
<paramdef>ODR <parameter>o</parameter></paramdef>
<paramdef>Z_<replaceable>xxx</replaceable> **<parameter>p</parameter></paramdef>
<paramdef>int <parameter>optional</parameter></paramdef>
<paramdef>const char *<parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
(note the lower-case "z" in the function name)
</para>
<note>
<para>
If you are using the premade definitions of the &asn; module, and you
are not adding new protocol of your own, the only parts of &odr; that you
need to worry about are documented in
<xref linkend="odr.use"/>.
</para>
</note>
<para>
When you have created a BER-encoded buffer, you can use the &comstack;
subsystem to transmit (or receive) data over the network. The &comstack;
module provides simple functions for establishing a connection
(passively or actively, depending on the role of your application),
and for exchanging BER-encoded PDUs over that connection. When you
create a connection endpoint, you need to specify what transport to
use (TCP/IP, SSL or UNIX sockets).
For the remainder of the connection's lifetime, you don't have
to worry about the underlying transport protocol at all - the &comstack;
will ensure that the correct mechanism is used.
</para>
<para>
We call the combined interfaces to &odr;, &asn;, and &comstack; the service
level API. It's the API that most closely models the Z39.50
service/protocol definition, and it provides unlimited access to all
fields and facilities of the protocol definitions.
</para>
<para>
The reason that the &yaz; service-level API is a conglomerate of the
APIs from three different submodules is twofold. First, we wanted to allow
the user a choice of different options for each major task. For instance,
if you don't like the protocol API provided by &odr;/&asn;, you
can use SNACC or BERUtils instead, and still have the benefits of the
transparent transport approach of the &comstack; module. Secondly,
we realize that you may have to fit the toolkit into an existing
event-processing structure, in a way that is incompatible with
the &comstack; interface or some other part of &yaz;.
</para>
</sect1>
</chapter>
<chapter id="installation">
<title>Compilation and Installation</title>
<sect1 id="installation-introduction">
<title>Introduction</title>
<para>
The latest version of the software will generally be found at:
</para>
<para>
<ulink url="&url.yaz.download;"/>
</para>
<para>
We have tried our best to keep the software portable, and on many
platforms, you should be able to compile everything with little or
no changes.
</para>
<para>
The software is regularly tested on
<ulink url="&url.debian;">Debian GNU/Linux</ulink>,
<ulink url="&url.centos;">CentOS</ulink>,
<ulink url="&url.ubuntu;">Ubuntu Linux</ulink>,
<ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
<ulink url="&url.macosx;">MAC OSX</ulink>,
<ulink url="&url.solaris;">Solaris</ulink>,
Windows 7, Windows XP.
</para>
<para>
Some versions have be known to work on HP/UX,
DEC Unix, <ulink url="&url.netbsd;">NetBSD</ulink>,
<ulink url="&url.openbsd;">OpenBSD</ulink>,
IBM AIX,
Data General DG/UX (with some CFLAGS tinkering),
SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
environment and the GUSI socket libraries),
IBM AS/400 .
</para>
<para>
If you move the software to other platforms, we'd be grateful if you'd
let us know about it. If you run into difficulties, we will try to help
if we can, and if you solve the problems, we would be happy to include
your fixes in the next release. So far, we have mostly avoided
<literal>#ifdefs</literal> for individual platforms, and we'd
like to keep it that way as far as it makes sense.
</para>
<para>
We maintain a mailing-list for the purpose of announcing new releases and
bug-fixes, as well as general discussion. Subscribe by
filling-in the form
<ulink url="&url.yaz.mailinglist;">here</ulink>.
General questions and problems can be directed at
<ulink url="&url.yaz.mail;"/>, or the address given at the top of
this document.
</para>
</sect1>
<sect1 id="installation.unix"><title>UNIX</title>
<para>
We provide
<ulink url="&url.debian;">Debian GNU/Linux</ulink> (i386 and amd64),
<ulink url="&url.ubuntu;">Ubuntu</ulink> (i386 and amd64)
and
<ulink url="&url.centos;">CentOS</ulink> (amd64 only) packages for &yaz;.
You should be able to create packages for other CPUs by building
them from the source package.
</para>
<para>
YAZ is also part of several packages repositories. Some of them are
</para>
<itemizedlist>
<listitem>
<para>
Solaris CSW: <ulink url="http://www.opencsw.org/packages/yaz/"/>
</para>
</listitem>
<listitem>
<para>
Solaris: <ulink url="http://unixpackages.com"/>
</para>
</listitem>
<listitem>
<para>
FreeBSD: <ulink url="http://www.freshports.org/net/yaz"/>
</para>
</listitem>
<listitem>
<para>
Debian: <ulink url="http://packages.debian.org/search?keywords=yaz"/>
</para>
</listitem>
<listitem>
<para>
Ubuntu: <ulink url="https://launchpad.net/ubuntu/+source/yaz"/>
</para>
</listitem>
<listitem>
<para>
NetBSD:
<ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
</para>
</listitem>
</itemizedlist>
<sect2 id="installation.source.unix">
<title>Compiling from source on Unix</title>
<para>
Note that if your system doesn't have a native ANSI C compiler, you may
have to acquire one separately. We recommend
<ulink url="&url.gcc;">GCC</ulink>.
</para>
<para>
If you wish to use character set conversion facilities in &yaz; or if you
are compiling &yaz; for use with Zebra it is a good idea to ensure that
the iconv library is installed. Some Unixes today already have it
- if not, we suggest
<ulink url="&url.libiconv;">GNU libiconv</ulink>.
</para>
<para>
YAZ 3.0.16 and later includes a wrapper for the
<ulink url="&url.icu;">ICU</ulink>
(International Components for Unicode).
In order to use this, the developer version of the ICU library
must be available. ICU support is recommended for applications
such as Pazpar2 and Zebra.
</para>
<para>
The <ulink url="&url.libxslt;">libxslt</ulink>,
<ulink url="&url.libxml2;">libxml2</ulink> librararies are required
if &yaz; is to support SRU/Solr.
These libraries are very portable and should compile out-of-the
box on virtually all Unix platforms. It is available in binary
forms for Linux and others.
</para>
<para>
The GNU tools
<ulink url="&url.autoconf;">Autoconf</ulink>,
<ulink url="&url.automake;">Automake</ulink> and
<ulink url="&url.libtool;">Libtool</ulink>
are used to generate Makefiles and configure &yaz; for the system.
You do <emphasis>not</emphasis> these tools unless you're using the
Git version of &yaz;.
</para>
<para>
The CQL parser for &yaz; is built using
GNU <ulink url="&url.bison;">Bison</ulink>.
This tool is only needed if you're using the Git version of &yaz;.
</para>
<para>
&yaz; includes a tiny ASN.1 compiler. This compiler is
written in <ulink url="&url.tcl;">Tcl</ulink>.
But as for Bison you do not need it unless you're using Git
version of &yaz; or you're using the compiler to built own codecs
for private ASN.1.
</para>
<para>
Generally it should be sufficient to run configure without options,
like this:
</para>
<screen>
./configure
</screen>
<para>
The configure script attempts to use use the C compiler specified by
the <literal>CC</literal> environment variable. If not set, GNU C will be
used if it is available. The <literal>CFLAGS</literal> environment
variable holds options to be passed to the C compiler. If you're using
Bourne-compatible shell you may pass something like this to use a
particular C compiler with optimization enabled:
</para>
<screen>
CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
</screen>
<para>
To customize &yaz;, the configure script also accepts a set of options.
The most important are:
<variablelist>
<varlistentry>
<term>
<literal>--prefix</literal>=<replaceable>prefix</replaceable>
</term>
<listitem>
<para>Specifies installation prefix for &yaz;. This is
only needed if you run <literal>make install</literal> later to
perform a "system" installation. The prefix is
<literal>/usr/local</literal> if not specified.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--enable-tcpd</literal>
</term>
<listitem>
<para>The front end server will be built using Wietse's
<ulink url="&url.tcpwrapper;">TCP wrapper library</ulink>.
It allows you to allow/deny clients depending on IP number.
The TCP wrapper library is often used in GNU/Linux and
BSD distributions.
See
<citerefentry>
<refentrytitle>hosts_access</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
and
<citerefentry>
<refentrytitle>tcpd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--enable-threads</literal>
</term>
<listitem>
<para>&yaz; will be built using POSIX threads.
Specifically, <constant>_REENTRANT</constant> will be defined during
compilation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--disable-shared</literal>
</term>
<listitem>
<para>The make process will not create shared
libraries (also known as shared objects <filename>.so</filename>).
By default, shared libraries are created -
equivalent to <literal>--enable-shared</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--disable-shared</literal>
</term>
<listitem>
<para>The make process will not create
static libraries (<filename>.a</filename>).
By default, static libraries are created -
equivalent to <literal>--enable-static</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem>
<para>Compile &yaz; with iconv library in directory
<replaceable>prefix</replaceable>. By default configure will
search for iconv on the system. Use this option if it
doesn't find iconv. Alternatively,
<literal>--without-iconv</literal>, can be uset to force &yaz;
not to use iconv.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem>
<para>Compile &yaz; with
<ulink url="&url.libxslt;">libxslt</ulink> in directory
<replaceable>prefix</replaceable>.
Use this option if you want XSLT and XML support.
By default, configure will
search for libxslt on the system. Use this option if it
libxslt is not found automatically. Alternatively,
<literal>--without-xslt</literal>, can be used to force &yaz;
not to use libxslt.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem>
<para>Compile &yaz; with
<ulink url="&url.libxml2;">libxml2</ulink> in directory
<replaceable>prefix</replaceable>.
Use this option if you want &yaz; to use XML and support SRU/Solr.
By default, configure will
search for libxml2 on the system. Use this option if it
libxml2 is not found automatically. Alternatively,
<literal>--without-xml2</literal>, can be used to force &yaz;
not to use libxml2.
</para>
<para>
Note that option <literal>--with-xslt</literal>
also enables libxml2.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem>
<para>&yaz; will be linked with the GNU TLS libraries and
an SSL COMSTACK will be provided. By default configure enables
SSL support for YAZ if the GNU TLS development libraries are found
on the system.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem>
<para>&yaz; will be linked the
<ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
If prefix is not given, the libraries exposed by the script
<application>icu-config</application> will be used if found.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-libgcrypt</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem>
<para>&yaz; will be linked with
<ulink url="&url.libgcrypt;">Libgcrypt</ulink> in the prefix if given.
If prefix is not given, the libraries exposed by the script
<application>libgcrypt-config</application> will be used if found.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-memcached</literal>
</term>
<listitem>
<para>&yaz; will be linked with
<ulink url="&url.libmemcached;">libMemcached</ulink> to allow
for result-set caching for ZOOM.
The prefix can not be given. Note that YAZ will only search
for libMemcached if Libgcrypt is also enabled.
Note that 0.40 of libmemcached is required.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>--with-redis</literal>
</term>
<listitem>
<para>&yaz; will be linked with the hiredis C library
to allow for result-set caching for ZOOM on a
<ulink url="&url.redis;">redis</ulink> server.
The prefix can not be given. Note that YAZ will only search
for hiredis if Libgcrypt is also enabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
When configured, build the software by typing:
<screen>
make
</screen>
</para>
<para>
The following files are generated by the make process:
<variablelist>
<varlistentry>
<term><filename>src/libyaz.la</filename></term>
<listitem><para>
Main &yaz; library. This is no ordinary library. It's
a Libtool archive.
By default, &yaz; creates a static library in
<filename>lib/.libs/libyaz.a</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>src/libyaz_server.la</filename></term>
<listitem><para>
Generic Frontend server. This is an add-on for libyaz.la.
Code in this library uses POSIX threads functions - if POSIX
threads are available on the platform.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>src/libyaz_icu.la</filename></term>
<listitem><para>
Functions that wrap the ICU library.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>ztest/yaz-ztest</filename></term>
<listitem><para>Test Z39.50 server.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>client/yaz-client</filename></term>
<listitem><para>Z39.50 client for testing the protocol.
See chapter <link linkend="yaz-client">
YAZ client</link> for more information.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>util/yaz-config</filename></term>
<listitem><para>A Bourne-shell script, generated by configure, that
specifies how external applications should compile - and link with
&yaz;.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>util/yaz-asncomp</filename></term>
<listitem><para>The ASN.1 compiler for &yaz;. Requires the
Tcl Shell, <application>tclsh</application>, in
<literal>PATH</literal> to operate.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>util/yaz-iconv</filename></term>
<listitem><para>This program converts data in one character set to
another. This command exercises the YAZ character set
conversion API.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>util/yaz-marcdump</filename></term>
<listitem><para>This program parses ISO2709 encoded MARC records
and prints them in line-format or XML.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>util/yaz-icu</filename></term>
<listitem><para>This program exposes the ICU wrapper library if that
is enabled for YAZ. Only if ICU is available this program is
useful.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>util/yaz-url</filename></term>
<listitem><para>This program is a simple HTTP page fetcher ala
wget or curl.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>zoom/zoomsh</filename></term>
<listitem><para>
A simple shell implemented on top of the
<link linkend="zoom">ZOOM</link> functions.
The shell is a command line application that allows you to enter
simple commands to perform ZOOM operations.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>zoom/zoomtst1</filename>,
<filename>zoom/zoomtst2</filename>, ..</term>
<listitem><para>
Several small applications that demonstrates the ZOOM API.
</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>
If you wish to install &yaz; in system directories
<filename>/usr/local/bin</filename>,
<filename>/usr/local/lib</filename> .. etc, you can type:
</para>
<screen>
make install
</screen>
<para>
You probably need to have root access in order to perform this.
You must specify the <literal>--prefix</literal> option for configure if
you wish to install &yaz; in other directories than the default
<filename>/usr/local/</filename>.
</para>
<para>
If you wish to perform an un-installation of &yaz;, use:
</para>
<screen>
make uninstall
</screen>
<para>
This will only work if you haven't reconfigured &yaz; (and therefore
changed installation prefix). Note that uninstall will not
remove directories created by make install, e.g.
<filename>/usr/local/include/yaz</filename>.
</para>
</sect2>
<sect2 id="installation-linking-yaz-unix">
<title>How to make apps using YAZ on UNIX</title>
<para>
This section describes how to compile - and link your own
applications using the &yaz; toolkit.
If you're used to Makefiles this shouldn't be hard. As for
other libraries you have used before, you have to set a proper include
path for your C/C++ compiler and specify the location of
&yaz; libraries. You can do it by hand, but generally we suggest
you use the <filename>yaz-config</filename> that is generated
by <filename>configure</filename>. This is especially
important if you're using the threaded version of &yaz; which
require you to pass more options to your linker/compiler.
</para>
<para>
The <filename>yaz-config</filename> script accepts command line
options that makes the <filename>yaz-config</filename> script print
options that you should use in your make process.
The most important ones are:
<literal>--cflags</literal>, <literal>--libs</literal>
which prints C compiler flags, and linker flags respectively.
</para>
<para>
A small and complete <literal>Makefile</literal> for a C
application consisting of one source file,
<filename>myprog.c</filename>, may look like this:
<screen>
YAZCONFIG=/usr/local/bin/yaz-config
CFLAGS=`$(YAZCONFIG) --cflags`
LIBS=`$(YAZCONFIG) --libs`
myprog: myprog.o
$(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
</screen>
</para>
<para>
The CFLAGS variable consists of a C compiler directive that will set
the include path to the <emphasis>parent</emphasis> directory
of <filename>yaz</filename>. That is, if &yaz; header files were
installed in <filename>/usr/local/include/yaz</filename>,
then include path is set to <filename>/usr/local/include</filename>.
Therefore, in your applications you should use
<screen>
#include <yaz/proto.h>
</screen>
and <emphasis>not</emphasis>
<screen>
#include <proto.h>
</screen>
</para>
<para>
For Libtool users, the <filename>yaz-config</filename> script provides
a different variant of option <literal>--libs</literal>, called
<literal>--lalibs</literal> that returns the name of the
Libtool archive(s) for &yaz; rather than the ordinary ones.
</para>
<para>
For applications using the threaded version of &yaz;,
specify <literal>threads</literal> after the
other options. When <literal>threads</literal> is given,
more flags and linker flags will be printed by
<filename>yaz-config</filename>. If our previous example was
using threads, you'd have to modify the lines that set
<literal>CFLAGS</literal> and <literal>LIBS</literal> as
follows:
<screen>
CFLAGS=`$(YAZCONFIG) --cflags threads`
LIBS=`$(YAZCONFIG) --libs threads`
</screen>
There is no need specify POSIX thread libraries in your Makefile.
The <literal>LIBS</literal> variable includes that as well.
</para>
</sect2>
</sect1>
<sect1 id="installation.win32">
<title>Windows</title>
<para>The easiest way to install YAZ on Windows is by downloading
an installer from
<ulink url="&url.yaz.download.win32;">here</ulink>.
The installer comes with source too - in case you wish to
compile YAZ with different compiler options, etc.
</para>
<sect2 id="installation.win32.source">
<title>Compiling from Source on Windows</title>
<para>
&yaz; is shipped with "makefiles" for the NMAKE tool that comes
with <ulink url="&url.vstudio;">
Microsoft Visual Studio</ulink>. It has been tested with
Microsoft Visual Studio 2013.
</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
<filename>makefile</filename> file (for example by using notepad).
The following summarizes the most important settings in that file:
<variablelist>
<varlistentry>
<term><literal>DEBUG</literal></term>
<listitem><para>
If set to 1, the software is
compiled with debugging libraries (code generation is
multi-threaded debug DLL).
If set to 0, the software is compiled with release libraries
(code generation is multi-threaded DLL).
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
<listitem><para>
If <literal>HAVE_TCL</literal> is set to 1, nmake will
use the ASN.1 compiler (<ulink url="&url.tcl;">Tcl</ulink> based).
You must set <literal>TCL</literal> to the full path of the Tcl
interpreter. A Windows version of Tcl is part of
<ulink url="&url.gitwindows;">Git for Windows</ulink>.
</para>
<para>
If you do not have Tcl installed, set
<literal>HAVE_TCL</literal> to 0.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>HAVE_BISON</literal>,
<literal>BISON</literal></term>
<listitem><para>
If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
to 1 and specify the Bison executable in <literal>BISON</literal>.
Bison is only required if you use the Git version of
YAZ or if you modify the grammar for CQL
(<filename>cql.y</filename>).
</para>
<para>
A Windows version of GNU Bison is part of
<ulink url="&url.gitwindows;">Git for Windows</ulink>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>HAVE_ICONV</literal>,
<literal>ICONV_DIR</literal></term>
<listitem><para>
If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
with iconv support. In this configuration, set
<literal>ICONV_DIR</literal> to the iconv source directory.
</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, YAZ is compiled
with SRU support. In this configuration, set
<literal>LIBXML2_DIR</literal> to the
<ulink url="&url.libxml2;">libxml2</ulink> source directory.
</para>
<para>
You can get pre-compiled Libxml2+Libxslt DLLs and headers from
<ulink url="&url.libxml2.download.windows;">here</ulink>.
Should you with to compile those libraries yourself, refer to
to <xref linkend="installation.windows.libxml2"/>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>HAVE_LIBXSLT</literal>,
<literal>LIBXSLT_DIR</literal></term>
<listitem>
<para>
If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
with XSLT support. In this configuration, set
<literal>LIBXSLT_DIR</literal> to the
<ulink url="&url.libxslt;">libxslt</ulink> source directory.
</para>
<note>
<para>
libxslt depends libxml2.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>HAVE_ICU</literal>,
<literal>ICU_DIR</literal></term>
<listitem>
<para>
If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
with <ulink url="&url.icu;">ICU</ulink> support.
In this configuration, set
<literal>ICU_DIR</literal> to the
<ulink url="&url.icu;">ICU</ulink> source directory.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
When satisfied with the settings in the makefile, type
<screen>
nmake
</screen>
</para>
<note>
<para>
If the <filename>nmake</filename> command is not found on your system
you probably haven't defined the environment variables required to
use that tool. To fix that, find and run the batch file
<filename>vcvars32.bat</filename>. You need to run it from within
the command prompt or set the environment variables "globally";
otherwise it doesn't work.
</para>
</note>
<para>
If you wish to recompile &yaz; - for example if you modify
settings in the <filename>makefile</filename> you can delete
object files, etc by running.
<screen>
nmake clean
</screen>
</para>
<para>
The following files are generated upon successful compilation:
<variablelist>
<varlistentry>
<term><filename>bin/yaz&soversion;.dll</filename> /
<filename>bin/yaz&soversion;d.dll</filename></term>
<listitem><para>
&yaz; Release/Debug DLL.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>lib/yaz&soversion;.lib</filename> /
<filename>lib/yaz&soversion;d.lib</filename></term>
<listitem><para>
Import library for <filename>yaz&soversion;.dll</filename> /
<filename>yaz&soversion;d.dll</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/yaz_cond&soversion;.dll</filename> /
<filename>bin/yaz_cond&soversion;d.dll</filename></term>
<listitem><para>
Release/Debug DLL for condition variable utilities (condvar.c).
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>lib/yaz_cond&soversion;.lib</filename> /
<filename>lib/yaz_cond&soversion;d.lib</filename></term>
<listitem><para>
Import library for <filename>yaz_cond&soversion;.dll</filename> /
<filename>yaz_cond&soversion;d.dll</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/yaz_icu&soversion;.dll</filename> /
<filename>bin/yaz_icu&soversion;d.dll</filename></term>
<listitem><para>
Release/Debug DLL for the ICU wrapper utility.
Only build if HAVE_ICU is 1.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>lib/yaz_icu&soversion;.lib</filename> /
<filename>lib/yaz_icu&soversion;d.lib</filename></term>
<listitem><para>
Import library for <filename>yaz_icu&soversion;.dll</filename> /
<filename>yaz_icu&soversion;d.dll</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/yaz-ztest.exe</filename></term>
<listitem><para>
Z39.50 multi-threaded test/example server. It's a WIN32
console application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/yaz-client.exe</filename></term>
<listitem><para>
&yaz; Z39.50 client application. It's a WIN32 console application.
See chapter <link linkend="yaz-client">YAZ client</link> for more
information.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/yaz-icu.exe</filename></term>
<listitem><para>This program exposes the ICU wrapper library if that
is enabled for YAZ. Only if ICU is available this program is
build.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/zoomsh.exe</filename></term>
<listitem><para>
Simple console application implemented on top of the
<link linkend="zoom">ZOOM</link> functions.
The application is a command line shell that allows you to enter
simple commands to perform ZOOM operations.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>bin/zoomtst1.exe</filename>,
<filename>bin/zoomtst2.exe</filename>, ..</term>
<listitem><para>
Several small applications that demonstrates the ZOOM API.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
<sect2 id="installation-linking-yaz-win32">
<title>How to make apps using YAZ on Windows</title>
<para>
This section will go though the process of linking your Windows
applications with &yaz;.
</para>
<para>
Some people are confused by the fact that we use the nmake
tool to build &yaz;. They think they have to do that too - in order
to make their Windows applications work with &yaz;. The good news is that
you don't have to. You can use the integrated environment of
Visual Studio if desired for your own application.
</para>
<para>
When setting up a project or Makefile you have to set the following:
<variablelist>
<varlistentry>
<term>include path</term>
<listitem><para>
Set it to the <filename>include</filename> directory of &yaz;.
</para></listitem>
</varlistentry>
<varlistentry>
<term>import library <filename>yaz&soversion;.lib</filename></term>
<listitem><para>
You must link with this library. It's located in the
sub directory <filename>lib</filename> of &yaz;.
If you want to link with the debug version of &yaz;, you must
link against <filename>yaz&soversion;d.lib</filename> instead.
</para></listitem>
</varlistentry>
<varlistentry>
<term>dynamic link library
<filename>yaz&soversion;.dll</filename>
</term>
<listitem><para>
This DLL must be in your execution path when you invoke
your application. Specifically, you should distribute this
DLL with your application.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
<sect2 id="installation.windows.libxml2">
<title>Compiling Libxml2 and Libxslt on windows</title>
<para>
Download libxml2 and Libxslt source and unpack it.
In the example below we install Libxml2 2.9.2 and Libxslt 1.1.28
for 32-bit, so we use the destination directories
libxml2.2.9.2.win32 and libxslt-1.1.28.win32 to reflect both
version and architecture.
<screen>
cd win32
cscript configure.js prefix=c:\libxml2-2.9.2.win32 iconv=no
nmake
nmake install
</screen>
</para>
<para>
For Libxslt it is similar. We must ensure that compilation of
Libxslt links against the already installed libxml2.
<screen>
cd win32
cscript configure.js prefix=c:\libxslt-1.1.28.win32 iconv=no \
lib=c:\libxmlt-2.9.2.win32\lib \
include=c:\libxmlt-2.9.2.win32\include\libxml2
nmake
nmake install
</screen>
</para>
</sect2>
</sect1>
</chapter>
<!--
### Still to document:
ZOOM_connection_errcode(c)
ZOOM_connection_errmsg(c)
ZOOM_connection_addinfo(c)
ZOOM_connection_addinfo(c)
ZOOM_connection_diagset(c);
ZOOM_connection_save_apdu_wrbuf
ZOOM_diag_str(error)
ZOOM_resultset_record_immediate(s, pos)
ZOOM_resultset_cache_reset(r)
ZOOM_options_set_callback(opt, function, handle)
ZOOM_options_create_with_parent2(parent1, parent2)
ZOOM_options_getl(opt, name, len)
ZOOM_options_setl(opt, name, value, len)
ZOOM_options_get_bool(opt, name, defa)
ZOOM_options_get_int(opt, name, defa)
ZOOM_options_set_int(opt, name, value)
-->
<chapter id="zoom">
<title>ZOOM</title>
<para>
&zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
an initiative started by Mike Taylor (Mike is from the UK, which
explains the peculiar name of the model). The goal of &zoom; is to
provide a common Z39.50 client API not bound to a particular
programming language or toolkit.
</para>
<para>
From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
You can make SRU ZOOM connections by specifying scheme
<literal>http://</literal> for the hostname for a connection.
The dialect of SRU used is specified by the value of the
connection's <literal>sru</literal> option, which may be SRU over
HTTP GET (<literal>get</literal>),
SRU over HTTP POST (<literal>post</literal>), (SRU over
SOAP) (<literal>soap</literal>) or <literal>solr</literal>
(<ulink url="&url.solr;">Solr</ulink> Web Service).
Using the facility for embedding options in target strings, a
connection can be forced to use SRU rather the SRW (the default) by
prefixing the target string with <literal>sru=get,</literal>, like this:
<literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
</para>
<para>
<ulink url="&url.solr;">Solr</ulink> protocol support was added to
YAZ in version 4.1.0, as a dialect of a SRU protocol, since both are
HTTP based protocols.
</para>
<para>
The lack of a simple Z39.50 client API for &yaz; has become more
and more apparent over time. So when the first &zoom; specification
became available,
an implementation for &yaz; was quickly developed. For the first time, it is
now as easy (or easier!) to develop clients than servers with &yaz;. This
chapter describes the &zoom; C binding. Before going further, please
reconsider whether C is the right programming language for the job.
There are other language bindings available for &yaz;, and still
more
are in active development. See the
<ulink url="&url.zoom;">ZOOM web-site</ulink> for
more information.
</para>
<para>
In order to fully understand this chapter you should read and
try the example programs <literal>zoomtst1.c</literal>,
<literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
directory.
</para>
<para>
The C language misses features found in object oriented languages
such as C++, Java, etc. For example, you'll have to manually,
destroy all objects you create, even though you may think of them as
temporary. Most objects has a <literal>_create</literal> - and a
<literal>_destroy</literal> variant.
All objects are in fact pointers to internal stuff, but you don't see
that because of typedefs. All destroy methods should gracefully ignore a
<literal>NULL</literal> pointer.
</para>
<para>
In each of the sections below you'll find a sub section called
protocol behavior, that describes how the API maps to the Z39.50
protocol.
</para>
<sect1 id="zoom-connections">
<title>Connections</title>
<para>The Connection object is a session with a target.
</para>
<synopsis>
#include <yaz/zoom.h>
ZOOM_connection ZOOM_connection_new(const char *host, int portnum);
ZOOM_connection ZOOM_connection_create(ZOOM_options options);
void ZOOM_connection_connect(ZOOM_connection c, const char *host,
int portnum);
void ZOOM_connection_destroy(ZOOM_connection c);
</synopsis>
<para>
Connection objects are created with either function
<function>ZOOM_connection_new</function> or
<function>ZOOM_connection_create</function>.
The former creates and automatically attempts to establish a network
connection with the target. The latter doesn't establish
a connection immediately, thus allowing you to specify options
before establishing network connection using the function
<function>ZOOM_connection_connect</function>.
If the port number, <literal>portnum</literal>, is zero, the
<literal>host</literal> is consulted for a port specification.
If no port is given, 210 is used. A colon denotes the beginning of
a port number in the host string. If the host string includes a
slash, the following part specifies a database for the connection.
</para>
<para>
You can prefix the host with a scheme followed by colon. The
default scheme is <literal>tcp</literal> (Z39.50 protocol).
The scheme <literal>http</literal> selects SRU/get o