-<!-- $Id: frontend.xml,v 1.26 2006-04-12 18:25:21 adam Exp $ -->
+<!-- $Id: frontend.xml,v 1.27 2006-04-24 09:21:35 adam Exp $ -->
<chapter id="server"><title>Generic server</title>
<sect1><title>Introduction</title>
</example>
<example><title>Setting up Apache as SRW/SRU Frontend</title>
<para>
- If you use <ulink url="http://httpd.apache.org/">Apache</ulink>
+ If you use <ulink url="&url.apache;">Apache</ulink>
as your public web server and want to offer HTTP port 80
access to the YAZ server on 210, you can use the
- <ulink url="http://httpd.apache.org/docs/mod/mod_proxy.html#proxypass">
+ <ulink url="&url.apache.directive.proxypass;">
<literal>ProxyPass</literal></ulink>
directive.
If you have virtual host
</example>
</sect1>
<sect1 id="server.vhosts"><title>Virtual Hosts</title>
- &gfs-virtual;
+ &gfs-virtual;
</sect1>
</chapter>
-<!-- $Id: installation.xml,v 1.26 2004-08-19 07:48:00 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.27 2006-04-24 09:21:35 adam Exp $ -->
<chapter id="installation"><title>Compilation and Installation</title>
<sect1><title>Introduction</title>
The latest version of the software will generally be found at:
</para>
<para>
- <ulink url="http://ftp.indexdata.dk/pub/yaz/">
- http://ftp.indexdata.dk/pub/yaz/</ulink>
+ <ulink url="&url.yaz.download;"/>
</para>
<para>
We have tried our best to keep the software portable, and on many
<para>
The software is regularly tested on
- <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>,
- <ulink url="http://www.redhat.com/">Redhat Linux</ulink>,
- <ulink url="http://www.gentoo.org/">Gentoo Linux</ulink>,
- <ulink url="http://www.freebsd.org/">FreeBSD (i386)</ulink>,
- <ulink url="http://www.apple.com/macosx/">MAC OSX</ulink>,
- <ulink url="http://wwws.sun.com/software/solaris/">
- SunOS 5.8 (sparc)</ulink>,
- <ulink url="http://www.microsoft.com/windows2000/">
- Windows 2000</ulink>.
+ <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
+ <ulink url="&url.redhat;">Redhat Linux</ulink>,
+ <ulink url="&url.gentoo;">Gentoo Linux</ulink>,
+ <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
+ <ulink url="&url.macosx;">MAC OSX</ulink>,
+ <ulink url="&url.solaris;">SunOS 5.8 (sparc)</ulink>,
+ <ulink url="&url.windows2000;">,
+ Windows 2000</ulink>,
+ <ulink url="&url.windows2003server;">,
+ Windows 2003 server</ulink>.
</para>
<para>
Some versions have be known to work on HP/UX,
- DEC Unix, <ulink url="http://www.netbsd.org/">NetBSD</ulink>,
- <ulink url="http://www.openbsd.org/">OpenBSD</ulink>,
+ 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
<para>
We maintain a mailing-list for the purpose of announcing new releases and
- bug-fixes, as well as general discussion. Subscribe by sending mail to
- <ulink url="mailto:yaz-request@indexdata.dk">
- yaz-request@indexdata.dk
- </ulink> or fill-in the form
- <ulink url="http://www.indexdata.dk/mailman/listinfo/yazlist">
- here</ulink>.
+ 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="mailto:yaz-help@indexdata.dk">
- yaz-help@indexdata.dk
- </ulink>, or the address given at the top of this document.
+ <ulink url="&url.yaz.mail;"/>, or the address given at the top of
+ this document.
</para>
</sect1>
<para>
We provide
- <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>
+ <ulink url="&url.debian;">Debian GNU/Linux</ulink>
and
- <ulink url="http://www.redhat.com/">Redhat</ulink> packages for &yaz;.
+ <ulink url="&url.redhat;">Redhat</ulink> packages for &yaz;.
Only i386 binary packages are available. You should be able to
create packages for other CPUs by building them from the source
package.
<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="http://gcc.gnu.org/">GCC</ulink>.
+ <ulink url="&url.gcc;">GCC</ulink>.
</para>
<para>
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="http://www.gnu.org/software/libiconv/">GNU iconv</ulink>.
+ <ulink url="&url.libiconv;">GNU libiconv</ulink>.
</para>
<para>
- The XML C library <ulink url="http://www.xmlsoft.org/">libxml2</ulink>
+ The XML C library <ulink url="&url.libxml2;">libxml2</ulink>
is required if &yaz; is to support SRW and SRU.
This library is very portable and should compile out-of-the
box on virtually all Unix platforms. It is available in binary
<para>
The GNU tools
- <ulink url="http://www.gnu.org/software/autoconf/">Autoconf</ulink>,
- <ulink url="http://www.gnu.org/software/automake/">Automake</ulink> and
- <ulink url="http://www.gnu.org/software/libtool/">Libtool</ulink>
+ <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
CVS version of &yaz;.
<para>
The CQL parser for &yaz; is built using
- GNU <ulink url="http://www.gnu.org/software/bison/">Bison</ulink>.
+ GNU <ulink url="&url.bison;">Bison</ulink>.
This tool is only needed if you're using the CVS version of &yaz;.
</para>
<para>
&yaz; includes a tiny ASN.1 compiler. This compiler is
- written in <ulink url="http://www.tcl.tk/">Tcl</ulink>.
+ written in <ulink url="&url.tcl;">Tcl</ulink>.
But as for Bison you do not need it unless you're using CVS
version of &yaz; or you're using the compiler to built own codecs
for private ASN.1.
</varlistentry>
<varlistentry><term><literal>--enable-tcpd</literal></term>
<listitem><para>The front end server will be built using Wietse's
- <ulink url="ftp://ftp.porcupine.org/pub/security/index.html">
- TCP wrapper library</ulink>. It allows you to allow/deny
- clients depending on IP number. The TCP wrapper library is
- often used in Linux/BSD distributions.
+ <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>
<literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem><para>Compile &yaz; with
- <ulink url="http://www.xmlsoft.org/">libxml2</ulink> in directory
+ <ulink url="&url.libxml2;">libxml2</ulink> in directory
<replaceable>prefix</replaceable>.
Use this option if you want SOAP support.
By default configure will
<para>The easiest way to install YAZ on Windows is by downloading
an installer from
- <ulink url="http://ftp.indexdata.dk/pub/yaz/win32">here</ulink>.
+ <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>
<title>Compiling from Source on WIN32</title>
<para>
&yaz; is shipped with "makefiles" for the NMAKE tool that comes
- with <ulink url="http://msdn.microsoft.com/vstudio/">
+ with <ulink url="&url.vstudio;">
Microsoft Visual Studio</ulink>.
Version 6 and .NET has been tested. We expect that &yaz; compiles
with version 5 as well.
</para>
<para>
A Windows version of GNU Bison is part of
- <ulink url="http://unxutils.sourceforge.net/">unxutils</ulink>.
+ <ulink url="&url.unxutils;">unxutils</ulink>.
</para></listitem>
</varlistentry>
If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
with SRW and SRU support. In this configuration, set
<literal>LIBXML2_DIR</literal> to the
- <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory
+ <ulink url="&url.libxml2;">libxml2</ulink> source directory
and
<literal>ZLIB_DIR</literal> to the zlib directory.
</para>
<para>
Windows versions of libxml2, zlib and iconv can be found
- <ulink url="http://www.zlatkovic.com/libxml.en.html">
+ <ulink url="&url.libxml2.download.win32;">
Igor Zlatković' site</ulink>.
</para>
-<!-- $Id: introduction.xml,v 1.19 2005-06-27 22:03:59 adam Exp $ -->
+<!-- $Id: introduction.xml,v 1.20 2006-04-24 09:21:35 adam Exp $ -->
<chapter id="introduction"><title>Introduction</title>
<para>
<itemizedlist>
<listitem><para>
Complete
- <ulink url="http://www.loc.gov/z3950/agency/">Z39.50</ulink>
- version 3 support. Amendments and Z39.50-2002 revision is
- supported.
+ <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="http://www.loc.gov/z3950/agency/zing/srw/">SRW/SRU</ulink>
+ <ulink url="&url.sru;">SRW/SRU</ulink>
version 1.1 (over HTTP and HTTPS).
</para></listitem>
<listitem><para>
Includes BER encoders/decoders for the
- <ulink url="http://www.nlc-bnc.ca/iso/ill/">ISO ILL</ulink>
+ <ulink url="&url.ill;">ISO ILL</ulink>
protocol.
</para></listitem>
<listitem><para>
Supports the following transports: BER over TCP/IP
- (<ulink url="http://www.faqs.org/rfcs/rfc1729.html">RFC1729</ulink>),
+ (<ulink url="&url.ber.over.tcpip;">RFC1729</ulink>),
BER over unix local socket, and
- <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616.html">HTTP
- 1.1</ulink>.
+ <ulink url="&url.http.1.1;">HTTP 1.1</ulink>.
</para></listitem>
<listitem><para>
Secure Socket Layer support using
- <ulink url="http://www.openssl.org/">OpenSSL</ulink>.
+ <ulink url="&url.openssl;">OpenSSL</ulink>.
If enabled, &yaz; uses HTTPS transport (for SOAP) or
"Secure BER" (for Z39.50).
</para></listitem>
<listitem><para>
Offers
- <ulink url="http://zoom.z3950.org/">ZOOM</ulink>
- C API implementing both Z39.50 and SRW.
+ <ulink url="&url.zoom;">ZOOM</ulink> C API implementing both
+ Z39.50 and SRW.
</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="http://www.loc.gov/z3950/agency/zing/cql/">CQL</ulink>
+ <ulink url="&url.cql;">CQL</ulink>
parser, memory management routines, character set conversion.
</para></listitem>
<listitem><para>
<sect1 id="introduction.api"><title>The API</title>
<para>
- The <ulink url="http://www.indexdata.dk/yaz/">&yaz;</ulink>
+ The <ulink url="&url.yaz;">&yaz;</ulink>
toolkit offers several different levels of access to the
- <ulink url="http://www.loc.gov/z3950/agency/">ISO23950/Z39.50</ulink>,
- <ulink url="http://www.nlc-bnc.ca/iso/ill/">ILL</ulink> and
- <ulink url="http://www.loc.gov/z3950/agency/zing/srw/">SRW</ulink>
+ <ulink url="&url.z39.50">ISO23950/Z39.50</ulink>,
+ <ulink url="&url.ill;">ILL</ulink> and
+ <ulink url="&url.sru/">SRU</ulink>/<ulink url="&url.srw/">SRW</ulink>
protocols.
The level that you need to use depends on your requirements, and
the role (server or client) that you want to implement.
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.
+ they do include most facilities used in existing Z39.50 applications.
</para>
<para>
If you're using 'exotic' functionality (meaning anything not included in
-<!-- $Id: odr.xml,v 1.14 2004-08-13 07:30:06 adam Exp $ -->
+<!-- $Id: odr.xml,v 1.15 2006-04-24 09:21:35 adam Exp $ -->
<chapter id="odr"><title>The ODR Module</title>
<sect1 id="odr.introduction"><title>Introduction</title>
<tip>
<para>
There is an ASN.1 tutorial available at
- <ulink url="http://asn1.elibel.tm.fr/en/introduction/">this site</ulink>.
+ <ulink url="&url.asn.1.tutorial;">this site</ulink>.
This site also has standards for ASN.1 (X.680) and BER (X.690)
- <ulink url="http://asn1.elibel.tm.fr/en/standards/">online</ulink>.
+ <ulink url="&url.asn.1.standards/">online</ulink>.
</para>
</tip>
-<!-- $Id: soap.xml,v 1.5 2003-11-19 22:05:15 adam Exp $ -->
+<!-- $Id: soap.xml,v 1.6 2006-04-24 09:21:35 adam Exp $ -->
<chapter id="soap"><title>SOAP and SRW</title>
<sect1 id="soap.introduction"><title>Introduction</title>
<para>
&yaz; uses a very simple implementation of
- <ulink url="http://www.w3.org/TR/SOAP/">SOAP</ulink> that only,
+ <ulink url="&url.soap;">SOAP</ulink> that only,
currenly, supports what is sufficient to offer SRW functionality.
The implementation uses the
- <ulink url="http://www.xmlsoft.org/html/libxml-tree.html">tree
- API</ulink> of libxml2 to encode and decode SOAP packages.
+ <ulink url="&url.libxml2.api.tree;">tree API</ulink> of
+ libxml2 to encode and decode SOAP packages.
</para>
<para>
Like the Z39.50 ASN.1 module, the &yaz; SRW implementation uses
-<!-- $Id: tools.xml,v 1.46 2005-04-26 19:51:31 adam Exp $ -->
+<!-- $Id: tools.xml,v 1.47 2006-04-24 09:21:35 adam Exp $ -->
<chapter id="tools"><title>Supporting Tools</title>
<para>
<literal>@and</literal>. Its semantics are described in
section 3.7.2 (Proximity) of Z39.50 the standard itself, which
can be read on-line at
- <ulink url="http://lcweb.loc.gov/z3950/agency/markup/09.html"/>
+ <ulink url="&url.z39.50.proximity;"/>
</para>
<para>
In PQF, the proximity operation is represented by a sequence
</itemizedlist>
(The numeric values of the relation and well-known unit-code
parameters are taken straight from
- <ulink url="http://lcweb.loc.gov/z3950/agency/asn1.html#ProximityOperator"
+ <ulink url="&url.z39.50.proximity.asn1;"
>the ASN.1</ulink> of the proximity structure in the standard.)
</para>
</sect3>
</table>
</para>
<para>
- The complete list of Bib-1 attributes can be found
- <ulink url="http://lcweb.loc.gov/z3950/agency/defns/bib1.html">
- here
- </ulink>.
+ Refer to the complete
+ <ulink url="&url.z39.50.attset.bib1;">list of Bib-1 attributes</ulink>
</para>
<para>
It is also possible to specify non-numeric attribute values,
</sect2>
<sect2 id="tools.cql"><title>CQL</title>
<para>
- <ulink url="http://www.loc.gov/z3950/agency/zing/cql/">CQL</ulink>
+ <ulink url="&url.cql;">CQL</ulink>
- Common Query Language - was defined for the
- <ulink url="http://www.loc.gov/z3950/agency/zing/srw/">SRW</ulink>
- protocol.
+ <ulink url="&url.srw;">SRW</ulink> protocol.
In many ways CQL has a similar syntax to CCL.
The objective of CQL is different. Where CCL aims to be
an end-user language, CQL is <emphasis>the</emphasis> protocol
<tip>
<para>
If you are new to CQL, read the
- <ulink url="http://zing.z3950.org/cql/intro.html">Gentle
- Introduction</ulink>.
+ <ulink url="&url.cql.intro;">Gentle Introduction</ulink>.
</para>
</tip>
<para>
<listitem>
<para>
The parser converts CQL to
- <ulink url="http://www.loc.gov/z3950/agency/zing/cql/xcql.html">
- XCQL</ulink>.
+ <ulink url="&url.xcql;">XCQL</ulink>.
XCQL is an XML representation of CQL.
XCQL is part of the SRW specification. However, since SRU
supports CQL only, we don't expect XCQL to be widely used.
returns a non-zero SRW error code; otherwise zero is returned
(conversion successful). The meanings of the numeric error
codes are listed in the SRW specifications at
- <ulink url="http://www.loc.gov/srw/diagnostic-list.html"/>
+ <ulink url="&url.sru.diagnostics.list;"/>
</para>
<para>
If conversion fails, more information can be obtained by calling
<para>
again, corresponding to the specific OIDs defined by the standard.
Refer to the
- <ulink url="http://lcweb.loc.gov/z3950/agency/defns/oids.html">
+ <ulink url="&url.z39.50.oids;">
Registry of Z39.50 Object Identifiers</ulink> for the
whole list.
</para>
<!--
- $Id: yaz-client-commands.xml,v 1.11 2005-11-04 17:15:30 mike Exp $
+ $Id: yaz-client-commands.xml,v 1.12 2006-04-24 09:21:35 adam Exp $
Commands for YAZ client.
Included in both manual and man page for yaz-client.
-->
together with the search result.
See the
<ulink
- url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink>
for more details.
the search result.
See the
<ulink
- url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink> for more details.
</para>
<literal>lslb</literal> and <literal>ssub</literal>.
See the
<ulink
- url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink>
for more details.
yaz-client supports all the record syntaxes that currently
are registered. See
<ulink
- url="http://lcweb.loc.gov/z3950/agency/defns/oids.html#5">
+ url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
Z39.50 Standard
</ulink>
for more details. Commonly used records syntaxes include usmarc,
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY % common SYSTEM "common/common.ent">
+ %common;
<!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
]>
-<!-- $Id: yaz-client-man.xml,v 1.5 2005-06-21 07:34:26 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.6 2006-04-24 09:21:35 adam Exp $ -->
<refentry id="yaz-client">
<refmeta>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-<!-- $Id: yaz-man.xml,v 1.4 2006-03-31 09:54:48 adam Exp $ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY % common SYSTEM "common/common.ent">
+ %common;
+]>
+<!-- $Id: yaz-man.xml,v 1.5 2006-04-24 09:21:35 adam Exp $ -->
<refentry id="yaz">
<refmeta>
<refentrytitle>yaz</refentrytitle>
<filename><replaceable>prefix</replaceable>/share/doc/yaz</filename>)
</para>
<para>
- <ulink url="http://www.indexdata.dk/yaz/">YAZ home page</ulink>.
+ <ulink url="&url.yaz;">YAZ home page</ulink>.
</para>
<para>
- <ulink url="http://www.loc.gov/z3950/agency/">Z39.50 Maintenance
- Agency Page</ulink>.
+ <ulink url="&url.z39.50;">Z39.50 Maintenance Agency Page</ulink>.
</para>
</refsect1>
</refentry>
<?xml version="1.0" standalone="no"?>
-<!-- $Id: yaz.xml.in,v 1.19 2005-10-15 10:40:37 adam Exp $ -->
+<!-- $Id: yaz.xml.in,v 1.20 2006-04-24 09:21:35 adam Exp $ -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4//EN"
"@DTD_DIR@/docbookx.dtd" [
<!ENTITY version "@VERSION@">
<!ENTITY % entities SYSTEM "entities.ent">
%entities;
+ <!ENTITY % common SYSTEM "common/common.ent">
+ %common;
]>
<book id="yaz">
&bookinfo;
ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm)
ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
-->
-<!-- $Id: zoom.xml,v 1.46 2005-12-21 16:45:38 mike Exp $ -->
+<!-- $Id: zoom.xml,v 1.47 2006-04-24 09:21:35 adam Exp $ -->
<chapter id="zoom"><title>ZOOM</title>
<para>
&zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
There are other language bindings available for &yaz;, and still
more
are in active development. See the
- <ulink url="http://zoom.z3950.org/">ZOOM web-site</ulink> for
+ <ulink url="&url.zoom;">ZOOM web-site</ulink> for
more information.
</para>
<para>
If either option <literal>lang</literal> or <literal>charset</literal>
is set, then
- <ulink url="http://lcweb.loc.gov/z3950/agency/defns/charneg-3.html">
+ <ulink url="&url.z39.50.charneg;">
Character Set and Language Negotiation</ulink> is in effect.
</para>
<synopsis>
<listitem><para>The record is returned in XML if possible.
SRW/SRU and Z39.50 records with transfer syntax XML are
returned verbatim. MARC records are returned in
- <ulink url="http://www.loc.gov/standards/marcxml/">
+ <ulink url="&url.marcxml;">
MARCXML
</ulink>
(converted from ISO2709 to MARCXML by YAZ).
</para>
<para>
Most
- <ulink url="http://www.loc.gov/marc/">
- MARC21
- </ulink>
+ <ulink url="&url.marc21;">MARC21</ulink>
records uses the
- <ulink url="http://www.loc.gov/marc/specifications/speccharmarc8.html">
- MARC-8
- </ulink>
+ <ulink url="&url.marc8;">MARC-8</ulink>
character set encoding.
An application that wishes to display in Latin-1 would use
<screen>