-<!-- $Id: asn.xml,v 1.16 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: asn.xml,v 1.17 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="asn"><title>The Z39.50 ASN.1 Module</title>
<sect1 id="asn.introduction"><title>Introduction</title>
<para>
</sect1>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: bookinfo.xml,v 1.3 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: bookinfo.xml,v 1.4 2006-04-25 11:25:08 marc Exp $ -->
<bookinfo>
<title>YAZ User's Guide and Reference</title>
<author><firstname>Sebastian</firstname><surname>Hammer</surname></author>
</inlinemediaobject>
</simpara></abstract>
</bookinfo>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: client.xml,v 1.17 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: client.xml,v 1.18 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="client"><title>The YAZ client</title>
<sect1 id="client.introduction"><title>Introduction</title>
<para>
</sect1>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: comstack.xml,v 1.12 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: comstack.xml,v 1.13 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="comstack"><title>The COMSTACK Module</title>
<sect1 id="comstack.synopsis"><title>Synopsis (blocking mode)</title>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: credits.xml,v 1.15 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: credits.xml,v 1.16 2006-04-25 11:25:08 marc Exp $ -->
<appendix id="credits"><title>Credits</title>
<para>
This appendix lists individuals that have contributed in the development
</itemizedlist>
</appendix>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: frontend.xml,v 1.28 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: frontend.xml,v 1.29 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="server"><title>Generic server</title>
<sect1><title>Introduction</title>
</sect1>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: future.xml,v 1.10 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: future.xml,v 1.11 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="future"><title>Future Directions</title>
<para>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
<!--
- $Id: gfs-options.xml,v 1.4 2006-04-24 12:41:00 marc Exp $
+ $Id: gfs-options.xml,v 1.5 2006-04-25 11:25:08 marc Exp $
Options for generic frontend server and yaz-ztest.
Included in both manual and man page for yaz-ztest
-->
+
<variablelist>
<varlistentry><term><literal>-a </literal>
</varlistentry>
</variablelist>
-<!-- Keep this Emacs mode comment at the end of the file
+
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "yaz.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
<!--
- $Id: gfs-synopsis.xml,v 1.2 2006-04-24 12:41:00 marc Exp $
+ $Id: gfs-synopsis.xml,v 1.3 2006-04-25 11:25:08 marc Exp $
cmd description of YAZ GFS application.
Included in both manual and man page for yaz-ztest
-->
<arg choice="opt" rep="repeat">listener-spec</arg>
</cmdsynopsis>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "yaz.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-
<!--
- $Id: gfs-virtual.xml,v 1.5 2006-04-24 12:41:00 marc Exp $
+ $Id: gfs-virtual.xml,v 1.6 2006-04-25 11:25:08 marc Exp $
Description of the virtual host mechanism in YAZ GFS
Included in both manual and man page for yaz-ztest
-->
via listener <literal>"internal"</literal>.
</para>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "yaz.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-
-<!-- $Id: indexdata.xml,v 1.8 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: indexdata.xml,v 1.9 2006-04-25 11:25:08 marc Exp $ -->
<appendix id="indexdata"><title>About Index Data</title>
<para>
</para>
</appendix>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: installation.xml,v 1.28 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: installation.xml,v 1.29 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="installation"><title>Compilation and Installation</title>
<sect1><title>Introduction</title>
</sect1>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: introduction.xml,v 1.22 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: introduction.xml,v 1.23 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="introduction"><title>Introduction</title>
<para>
</para>
</sect1>
</chapter>
-<!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document:"yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: license.xml,v 1.11 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: license.xml,v 1.12 2006-04-25 11:25:08 marc Exp $ -->
<appendix id="license"><title>License</title>
<sect1 id="license.indexdata"><title>Index Data Copyright</title>
</sect1>
</appendix>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: odr.xml,v 1.17 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: odr.xml,v 1.18 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="odr"><title>The ODR Module</title>
<sect1 id="odr.introduction"><title>Introduction</title>
</para>
</sect1>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!-- $Id: tools.xml,v 1.48 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: tools.xml,v 1.49 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="tools"><title>Supporting Tools</title>
<para>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+]>
<refentry id="yaz-asncomp">
<refmeta>
</para>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
<!--
- $Id: yaz-client-commands.xml,v 1.13 2006-04-24 12:41:00 marc Exp $
+ $Id: yaz-client-commands.xml,v 1.14 2006-04-25 11:25:08 marc Exp $
Commands for YAZ client.
Included in both manual and man page for yaz-client.
-->
<para>Sets the limit for when no records should be returned
together with the search result.
See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink>
for more details.
<para>Sets the limit for when all records should be returned with
the search result.
See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink> for more details.
</para>
number of records in the result set is between the values of
<literal>lslb</literal> and <literal>ssub</literal>.
See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink>
for more details.
<para>Sets the preferred transfer syntax for retrieved records.
yaz-client supports all the record syntaxes that currently
are registered. See
- <ulink url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
Z39.50 Standard
</ulink>
for more details. Commonly used records syntaxes include usmarc,
</varlistentry>
</variablelist>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "yaz.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
-<!ENTITY % common SYSTEM "common/common.ent">
-<!-- $Id: yaz-client-man.xml,v 1.7 2006-04-24 12:41:00 marc Exp $ --><!-- Index Data software --><!ENTITY url.indexdata "http://www.indexdata.com/">
-<!ENTITY url.yaz "http://www.indexdata.com/yaz/">
-<!ENTITY url.yaz.download "http://ftp.indexdata.com/pub/yaz/">
-<!ENTITY url.yaz.download.win32 "http://ftp.indexdata.com/pub/yaz/win32/">
-<!ENTITY url.yaz.mailinglist "http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist">
-<!ENTITY url.yaz.mail "mailto:yaz-help@indexdata.dk">
-<!ENTITY url.yazplusplus "http://www.indexdata.com/yazplusplus/">
-<!ENTITY url.yazproxy "http://www.indexdata.com/yazproxy/">
-<!ENTITY url.idzebra "http://www.indexdata.com/zebra/">
-<!ENTITY url.idzebra.mailinglist "http://lists.indexdata.dk/cgi-bin/mailman/listinfo/zebralist">
-<!ENTITY url.metaproxy "http://www.indexdata.com/metaproxy/">
-<!-- Specifications and Standards --><!ENTITY url.w3c "http://www.w3.org/">
-<!ENTITY url.xml "http://www.w3.org/XML/">
-<!ENTITY url.sru "http://www.loc.gov/standards/sru/">
-<!ENTITY url.sru.diagnostics "http://www.loc.gov/standards/sru/diagnostics.html">
-<!ENTITY url.sru.diagnostics.list "http://www.loc.gov/standards/sru/diagnostics-list.html">
-<!ENTITY url.srw "http://www.loc.gov/standards/sru/srw/">
-<!ENTITY url.soap "http://www.w3.org/TR/soap/">
-<!ENTITY url.z39.50 "http://www.loc.gov/z3950/agency/">
-<!ENTITY url.z39.50.doc "http://www.loc.gov/z3950/agency/markup/toc.html">
-<!ENTITY url.z39.50.asn.1 "http://www.loc.gov/z3950/agency/asn1.html">
-<!ENTITY url.z39.50.diagnostics "http://www.loc.gov/z3950/agency/defns/bib1diag.html">
-<!ENTITY url.z39.50.attset.bib1 "http://www.loc.gov/z3950/agency/defns/bib1.html">
-<!ENTITY url.z39.50.charneg "http://www.loc.gov/z3950/agency/defns/charneg-3.html">
-<!ENTITY url.z39.50.proximity "http://www.loc.gov/z3950/agency/markup/09.html#3.7.2">
-<!ENTITY url.z39.50.proximity.asn1 "http://www.loc.gov/z3950/agency/asn1.html#ProximityOperator">
-<!ENTITY url.z39.50.oids "http://www.loc.gov/z3950/agency/defns/oids.html">
-<!ENTITY url.asn.1.tutorial "http://asn1.elibel.tm.fr/en/introduction/">
-<!ENTITY url.asn.1.standards "http://asn1.elibel.tm.fr/en/standards/">
-<!ENTITY url.cql "http://www.loc.gov/standards/sru/cql/">
-<!ENTITY url.cql.intro "http://zing.z3950.org/cql/intro.html">
-<!ENTITY url.xcql "http://www.loc.gov/standards/sru/xml-files/srw-types.xsd">
-<!ENTITY url.zoom "http://zoom.z3950.org/">
-<!ENTITY url.marc21 "http://www.loc.gov/marc/">
-<!ENTITY url.marc8 "http://www.loc.gov/marc/specifications/speccharmarc8.html">
-<!ENTITY url.marcxml "http://www.loc.gov/standards/marcxml/">
-<!ENTITY url.ill "http://www.nlc-bnc.ca/iso/ill/">
-<!ENTITY url.ber.over.tcpip "http://www.faqs.org/rfcs/rfc1729.html">
-<!ENTITY url.http "http://www.w3.org/Protocols/">
-<!ENTITY url.http.1.1 "http://www.w3.org/Protocols/rfc2616/rfc2616.html">
-<!-- External libraries + tools --><!ENTITY url.apache "http://httpd.apache.org/">
-<!ENTITY url.apache.directive.proxypass "http://httpd.apache.org/docs/mod/mod_proxy.html#proxypass">
-<!ENTITY url.bison "http://www.gnu.org/software/bison/">
-<!ENTITY url.libxml2 "http://xmlsoft.org/">
-<!ENTITY url.libxml2.api "http://www.xmlsoft.org/html/index.html">
-<!ENTITY url.libxml2.api.tree "http://www.xmlsoft.org/html/libxml-tree.html">
-<!ENTITY url.libxslt "http://xmlsoft.org/XSLT/">
-<!ENTITY url.libxml2.download.win32 "http://www.zlatkovic.com/libxml.en.html">
-<!ENTITY url.autoconf "http://www.gnu.org/software/autoconf/">
-<!ENTITY url.automake "http://www.gnu.org/software/automake/">
-<!ENTITY url.libtool "http://www.gnu.org/software/libtool/">
-<!ENTITY url.libiconv "http://www.gnu.org/software/libiconv/">
-<!ENTITY url.tcl "http://www.tcl.tk/">
-<!ENTITY url.perl "http://www.perl.com/">
-<!ENTITY url.gcc "http://gcc.gnu.org/">
-<!ENTITY url.vstudio "http://msdn.microsoft.com/vstudio/">
-<!ENTITY url.boost "http://www.boost.org/">
-<!ENTITY url.boost.compilers.status "http://www.boost.org/status/compiler_status.html">
-<!ENTITY url.openssl "http://www.openssl.org/">
-<!ENTITY url.unxutils "http://unxutils.sourceforge.net/">
-<!ENTITY url.tcpwrapper "ftp://ftp.porcupine.org/pub/security/index.html">
-<!-- Operating Systems --><!ENTITY url.linux.kernel "http://www.kernel.org/">
-<!ENTITY url.debian "http://www.debian.org/">
-<!ENTITY url.redhat "http://www.redhat.com/">
-<!ENTITY url.gentoo "http://www.gentoo.org/">
-<!ENTITY url.freebsd "http://www.freebsd.org/">
-<!ENTITY url.macosx "http://www.apple.com/macosx/">
-<!ENTITY url.solaris "http://www.sun.com/software/solaris/">
-<!ENTITY url.windows2000 "http://www.microsoft.com/windows2000/">
-<!ENTITY url.windows2003server "http://www.microsoft.com/windowsserver2003/default.mspx">
-<!ENTITY url.netbsd "http://www.netbsd.org/">
-<!ENTITY url.openbsd "http://www.openbsd.org/">
-<!ENTITY url.ubunto "http://www.ubuntu.com/">
-<!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
+<!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.7 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.8 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="yaz-client">
<refmeta>
<para>
The YAZ client accepts the following commands.
</para>
-
-<!--
- $Id: yaz-client-man.xml,v 1.7 2006-04-24 12:41:00 marc Exp $
- Commands for YAZ client.
- Included in both manual and man page for yaz-client.
--->
-<variablelist>
- <varlistentry id="command-open"><term>
- <literal>open </literal><replaceable>zurl</replaceable>
- </term>
- <listitem>
- <para>Opens a connection to a server. The syntax for
- <replaceable>zurl</replaceable> is the same as described
- above for connecting from the command line.
- </para>
- <para>
- Syntax:
- </para>
- <para>
- [<literal>(tcp|ssl|unix|http)':'</literal>]<replaceable>host</replaceable>
- [:<replaceable>port</replaceable>][/<replaceable>base</replaceable>]
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>quit</literal>
- </term>
- <listitem>
- <para>Quits YAZ client</para>
- </listitem>
- </varlistentry>
- <varlistentry id="command-find"><term>
- <literal>find </literal><replaceable>query</replaceable></term>
- <listitem>
- <para>Sends a Search Request using the <replaceable>query</replaceable>
- given. By default the query is assumed to be PQF. See command
- <link linkend="command-querytype"><literal>querytype</literal></link>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>delete</literal> <replaceable>setname</replaceable></term>
- <listitem>
- <para>Deletes result set with name <replaceable>setname</replaceable>
- on the server.</para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>base </literal><replaceable>base1</replaceable>
- <replaceable>base2</replaceable> ...
- </term>
- <listitem>
- <para>Sets the name(s) of the database(s) to search. One or more
- databases may be specified separated by blanks. This commands overrides
- the database given in <replaceable>zurl</replaceable>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>show </literal>
- [<replaceable>start</replaceable>[+<replaceable>number</replaceable>]]
- </term>
- <listitem>
- <para>Fetches records by sending a Present Request from the start
- position given by
- <replaceable>start</replaceable>
- a number of records given by <replaceable>number</replaceable>. If
- <replaceable>start</replaceable> is not given, then the client
- will fetch from position of the last retrieved record plus 1. If
- <replaceable>number</replaceable> is not given, then one record will
- be fetched at a time.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>scan</literal> <replaceable>term</replaceable>
- </term>
- <listitem>
- <simpara>Scans
- database index for a term. The syntax resembles the syntax
- for <link linkend="command-find"><literal>find</literal></link>.
- If you want to scan for the word <literal>water</literal> you could
- write
- </simpara>
- <screen>
- scan water
- </screen>
- <simpara>
- but if you want to scan only in, say the title field, you would write
- </simpara>
- <screen>
- scan @attr 1=4 water
- </screen>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>scanpos</literal> <replaceable>pos</replaceable>
- </term>
- <listitem>
- <simpara>
- Sets preferred position for scan. This value
- is used in next scan. By default position is 1.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>scansize</literal> <replaceable>size</replaceable>
- </term>
- <listitem>
- <simpara>
- Sets number of entries to be returned by scan. Default
- number of entries is 20.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>scanstep</literal> <replaceable>step</replaceable>
- </term>
- <listitem>
- <simpara>
- Set step-size for scan. This value is used in next scan
- sent to the target. By default step-size is 0.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry id="sortspec"><term>
- <literal>sort</literal> <replaceable>sortspecs</replaceable>
- </term>
- <listitem>
- <para>Sorts a result set. The sort command takes a
- sequence of space-separated sort specifications, with each sort
- specification consisting of two space-separated words (so that the
- whole specification list is made up of an even number of words).
- The first word of each specification
- holds a field (sort criterion) and the second holds flags.
- If the sort criterion includes <literal>=</literal> it is assumed
- that the <literal>SortKey</literal> is of type
- <literal>sortAttributes</literal> using Bib-1: in this case
- the integer before <literal>=</literal> is
- the attribute type and the integer following <literal>=</literal>
- is the attribute value.
- If no <literal>=</literal> is in the criterion it is treated as a
- sortfield of type InternationalString.
- The flags word of each sort specification must consist of
- <literal>s</literal>
- for case sensitive or <literal>i</literal> for case insensitive, and
- <literal><</literal> for ascending order or <literal>></literal>
- for descending order.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>sort+</literal>
- </term>
- <listitem>
- <para>Same as <literal>sort</literal> but stores the sorted
- result set in a new result set.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>authentication</literal> <replaceable>openauth</replaceable>
- </term>
- <listitem>
- <para>Sets up a authentication string if a server requires
- authentication (v2 OpenStyle). The authentication string is first
- sent to the server when the
- <link linkend="command-open"><literal>open</literal></link> command is
- issued and the Z39.50 Initialize Request is sent, so this command
- must be used before <literal>open</literal> in order to be effective.
- A common convention for the <replaceable>authopen</replaceable> string
- is that the username - and password is separated by a slash, e.g.
- <literal>myusername/mysecret</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>list_all</literal>
- </term>
- <listitem>
- <para>This command displays status and values for many settings.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>lslb</literal> <replaceable>n</replaceable>
- </term>
- <listitem>
- <para>Sets the limit for when no records should be returned
- together with the search result.
- See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
- Z39.50 standard
- </ulink>
- for more details.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>ssub</literal> <replaceable>n</replaceable>
- </term>
- <listitem>
- <para>Sets the limit for when all records should be returned with
- the search result.
- See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
- Z39.50 standard
- </ulink> for more details.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>mspn</literal> <replaceable>n</replaceable>
- </term>
- <listitem>
- <para>Sets the number of records should be returned if the
- number of records in the result set is between the values of
- <literal>lslb</literal> and <literal>ssub</literal>.
- See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
- Z39.50 standard
- </ulink>
- for more details.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>status</literal>
- </term>
- <listitem>
- <para>Displays the values of <literal>lslb</literal>,
- <literal>ssub</literal> and <literal>mspn</literal>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>setname</literal>
- </term>
- <listitem>
- <para>Switches named result sets on and off. Default is on.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>cancel</literal>
- </term>
- <listitem>
- <para>Sends a Trigger Resource Control Request to the target.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>format</literal> <replaceable>oid</replaceable>
- </term>
- <listitem>
- <para>Sets the preferred transfer syntax for retrieved records.
- yaz-client supports all the record syntaxes that currently
- are registered. See
- <ulink url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
- Z39.50 Standard
- </ulink>
- for more details. Commonly used records syntaxes include usmarc,
- sutrs, grs1 and xml.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>elements</literal> <replaceable>e</replaceable>
- </term>
- <listitem>
- <para>Sets the element set name for the records. Many targets support
- element sets are B (for brief) and F (for full).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>close</literal>
- </term>
- <listitem>
- <para>Sends a Z39.50 Close APDU and closes connection with the peer
- </para>
- </listitem>
- </varlistentry>
- <varlistentry id="command-querytype"><term>
- <literal>querytype</literal> <replaceable>type</replaceable>
- </term>
- <listitem>
- <para>Sets the query type as used by command
- <link linkend="command-find"><literal>find</literal></link>.
- The following is supported:
- <literal>prefix</literal> for
- <link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
- <literal>ccl</literal> for CCL search (Type-2 Query),
- <literal>cql</literal> for CQL (Type-104 search with CQL OID),
- <literal>ccl2rpn</literal> for
- <link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
- <literal>cql2rpn</literal> for
- CQL to RPN conversion (Type-1 Query).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>attributeset</literal> <replaceable>set</replaceable>
- </term>
- <listitem>
- <para>
- Sets attribute set OID for prefix queries (RPN, Type-1).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>refid</literal> <replaceable>id</replaceable>
- </term>
- <listitem>
- <para>Sets reference ID for Z39.50 Request(s).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>itemorder</literal>
- <replaceable>type</replaceable> <replaceable>no</replaceable>
- </term>
- <listitem>
- <para>Sends an Item Order Request using the ILL External.
- <replaceable>type</replaceable> is either 1 or 2 which corresponds to
- ILL-Profile 1 and 2 respectively. The <replaceable>no</replaceable>
- is the Result Set position of the record to be ordered.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>update</literal>
- <replaceable>action</replaceable>
- <replaceable>recid</replaceable>
- <replaceable>doc</replaceable>
- </term>
- <listitem>
- <para>Sends Item Update Request. The <replaceable>action</replaceable>
- argument must be the action type: one of <literal>insert</literal>,
- <literal>replace</literal>, <literal>delete</literal> and
- <literal>update</literal>. The second argument,
- <replaceable>recid</replaceable>, is the
- record identifier (any string). Third argument which is optional is
- the record document for the request. If doc is a quoted string
- (double quotes) the string content is used verbatim. If doc is not
- a quoted string, it is assumed to be a filename which is read, then
- sent as the docuemnt content. If doc is omitted, the last received
- record (as parf of present response or piggybacked search response)
- is used for the update.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>.</literal>
- <replaceable>filename</replaceable>
- </term>
- <listitem>
- <para>Executes list of commands from
- file <replaceable>filename</replaceable>, just like source on
- most UNIX shells.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>!</literal>
- <replaceable>args</replaceable>
- </term>
- <listitem>
- <para>Executes command <replaceable>args</replaceable> in subshell
- using the <literal>system</literal> call.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>push_command</literal>
- <replaceable>command</replaceable>
- </term>
- <listitem>
- <para>The push_command takes another command as its argument.
- That command is then added to the history information (so
- you can retrieve it later). The command itself is not
- executed. This command only works if you have GNU readline/history
- enabled.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>set_apdufile</literal>
- <replaceable>filename</replaceable>
- </term>
- <listitem>
- <para>Sets that APDU should be logged to file
- <replaceable>filename</replaceable>. Another way to achieve
- APDU log is by using command-line option <literal>-a</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>set_auto_reconnect</literal>
- <replaceable>flag</replaceable>
- </term>
- <listitem>
- <para>Specifies whether YAZ client automatically reconnect if
- target closes connection (Z39.50 only).
- </para>
- <para>
- <replaceable>flag</replaceable> must be either
- <literal>on</literal> or <literal>off</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="command-set-auto-wait"><term>
- <literal>set_auto_wait</literal>
- <replaceable>flag</replaceable>
- </term>
- <listitem>
- <para>Specifies whether YAZ client should wait for
- response protocol packages after a request.
- By default YAZ client waits (on) for response packages immediately
- after a command (find, show) has been issued. If <literal>off</literal>
- is used, YAZ client does not attempt to receive packages automatically.
- These will have to be manually received when command
- <link linkend="command-wait-response">
- <literal>wait_response</literal>
- </link> is used.
- </para>
- <para>
- <replaceable>flag</replaceable> must be either
- <literal>on</literal> or <literal>off</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>set_marcdump</literal>
- <replaceable>filename</replaceable>
- </term>
- <listitem>
- <para>Specifies that all retrieved records should be appended to
- file <replaceable>filename</replaceable>. This command does the
- thing as option <literal>-m</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>schema</literal>
- <replaceable>schemaid</replaceable>
- </term>
- <listitem>
- <para>Specifies schema for retrieval.
- Schema may be specified as an OID for Z39.50.
- For SRW, schema is a simple string URI.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="command-charset"><term>
- <literal>charset</literal>
- <replaceable>negotiationcharset</replaceable>
- [<replaceable>displaycharset</replaceable>]
- [[<replaceable>marccharset</replaceable>]]
- </term>
- <listitem>
- <para>Specifies character set (encoding) for Z39.50
- negotiation / SRW encoding and/or character set for output (terminal).
- </para>
- <para>
- <replaceable>negotiationcharset</replaceable> is the name
- of the character set to be negotiated by the server. The special name
- <literal>-</literal> for <replaceable>negotiationcharset</replaceable>
- specifies <emphasis>no</emphasis> character set to be negotiated.
- </para>
- <para>
- If <replaceable>displaycharset</replaceable> is given, it specifies name
- of the character set of the output (on the terminal on which
- YAZ client is running). To disable conversion of characters
- to the output encoding, the special name <literal>-</literal> (dash)
- can be used.
- If the special name <literal>auto</literal> is given, YAZ client will
- convert strings to the encoding of the
- terminal as returned by <function>nl_langinfo</function> call.
- </para>
- <para>
- If <replaceable>marcharset</replaceable> is given, it specifies name
- of the character set of retrieved MARC records from server. See
- also <literal>marcharset</literal> command.
- </para>
- <note>
- <para>
- Since character set negotation takes effect in the Z39.50
- Initialize Request you should issue this command before
- command <link linkend="command-open"><literal>open</literal></link>
- is used.
- </para>
- </note>
- <note>
- <para>
- MARC records are not covered by Z39.50 character set negotiation,
- so that's why there is a separate character that must be known
- in order to do meaningful converson(s).
- </para>
- </note>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>negcharset</literal>
- <replaceable>charset</replaceable>
- </term>
- <listitem>
- <para>Specifies character set for negotiation (Z39.50). The
- argument is the same as second argument for command
- <link linkend="command-charset"><literal>charset</literal></link>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>displaycharset</literal>
- <replaceable>charset</replaceable>
- </term>
- <listitem>
- <para>Specifies character set for output (display). The
- argument is the same as second argument for command
- <link linkend="command-charset"><literal>charset</literal></link>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>marccharset</literal>
- <replaceable>charset</replaceable>
- </term>
- <listitem>
- <para>Specifies character set for retrieved MARC records so
- that YAZ client can display them in a character suitable
- for your display. See <literal>charset</literal> command.
- If <literal>auto</literal> is given, YAZ will assume
- that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1
- for all other MARC variants. The charset argument is the
- same as third argument for command
- <link linkend="command-charset"><literal>charset</literal></link>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>set_cclfile</literal>
- <replaceable>filename</replaceable>
- </term>
- <listitem>
- <para>Specifies that CCL fields should be read from file
- file <replaceable>filename</replaceable>. This command does the
- thing as option <literal>-c</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>set_cqlfile</literal>
- <replaceable>filename</replaceable>
- </term>
- <listitem>
- <para>Specifies that CQL fields should be read from file
- file <replaceable>filename</replaceable>. This command does the
- thing as option <literal>-q</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>register_oid</literal>
- <replaceable>name</replaceable>
- <replaceable>class</replaceable>
- <replaceable>OID</replaceable>
- </term>
- <listitem>
- <para>This command allows you to register your own object
- identifier - so that instead of entering a long dot-notation
- you can use a short name instead.
- The <replaceable>name</replaceable> is your
- name for the OID, <replaceable>class</replaceable> is the
- class, and <replaceable>OID</replaceable> is the raw OID in
- dot notation. Class is one <literal>appctx</literal>,
- <literal>absyn</literal>, <literal>attet</literal>,
- <literal>transyn</literal>, <literal>diagset</literal>,
- <literal>recsyn</literal>, <literal>resform</literal>,
- <literal>accform</literal>, <literal>extserv</literal>,
- <literal>userinfo</literal>, <literal>elemspec</literal>,
- <literal>varset</literal>, <literal>schema</literal>,
- <literal>tagset</literal>, <literal>general</literal>.
- If you're in doubt use the <literal>general</literal>
- class.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>register_tab</literal>
- <replaceable>command</replaceable>
- <replaceable>string</replaceable>
- </term>
- <listitem>
- <para>This command registers a TAB completion string for
- the command given.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>sleep</literal>
- <replaceable>seconds</replaceable>
- </term>
- <listitem>
- <para>This command makes YAZ client sleep (be idle) for
- the number of seconds given.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="command-wait-response"><term>
- <literal>wait_response</literal>
- [ <replaceable>number</replaceable>]
- </term>
- <listitem>
- <para>This command makes YAZ client wait for a number of
- response packages from target. If <replaceable>number</replaceable> is
- omitted, 1 is assumed.
- </para>
- <para>This command is rarely used and is only useful if command
- <link linkend="command-set-auto-wait">
- <literal>set_auto_wait</literal>
- </link> is set to off.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="command-xmles"><term>
- <literal>xmles</literal>
- <replaceable>OID</replaceable>
- <replaceable>doc</replaceable>
- </term>
- <listitem>
- <para>Sends XML Extended Services request using the OID and doc given.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>zversion</literal>
- <replaceable>ver</replaceable>
- </term>
- <listitem>
- <para>This command sets Z39.50 version for negotiation.
- Should be used before
- <link linkend="command-open"><literal>open</literal></link>.
- By default 3 (version 3) is used.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>options</literal>
- <replaceable>op1 op2..</replaceable>
- </term>
- <listitem>
- <para>This command sets Z39.50 options for negotiation.
- Should be used before
- <link linkend="command-open"><literal>open</literal></link>.
- </para>
- <para>
- The following options are supported:
- <literal>search</literal>,
- <literal>present</literal>,
- <literal>delSet</literal>,
- <literal>resourceReport</literal>,
- <literal>triggerResourceCtrl</literal>,
- <literal>resourceCtrl</literal>,
- <literal>accessCtrl</literal>,
- <literal>scan</literal>,
- <literal>sort</literal>,
- <literal>extendedServices</literal>,
- <literal>level_1Segmentation</literal>,
- <literal>level_2Segmentation</literal>,
- <literal>concurrentOperations</literal>,
- <literal>namedResultSets</literal>,
- <literal>encapsulation</literal>,
- <literal>resultCount</literal>,
- <literal>negotiationModel</literal>,
- <literal>duplicationDetection</literal>,
- <literal>queryType104</literal>,
- <literal>pQESCorrection</literal>,
- <literal>stringSchema</literal>.
- </para>
- </listitem>
- </varlistentry>
-
-</variablelist>
-<!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
-
+ &yaz-client-commands;
</refsect1>
<refsect1><title>FILES</title>
<para>
</para>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
->
-<!-- $Id: yaz-config-man.xml,v 1.4 2006-04-24 12:41:00 marc Exp $ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- $Id: yaz-config-man.xml,v 1.5 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="yaz-config">
<refmeta>
<refentrytitle>yaz-config</refentrytitle>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
->
-<!-- $Id: yaz-iconv-man.xml,v 1.2 2006-04-24 12:41:00 marc Exp $ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- $Id: yaz-iconv-man.xml,v 1.3 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="yaz-iconv">
<refmeta>
<refentrytitle>yaz-iconv</refentrytitle>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
->
-<!-- $Id: yaz-log-man.xml,v 1.3 2006-04-24 12:41:00 marc Exp $ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- $Id: yaz-log-man.xml,v 1.4 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="yaz-log">
<refmeta>
<refentrytitle>yaz-log</refentrytitle>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
-<!ENTITY % common SYSTEM "common/common.ent">
-<!-- $Id: yaz-man.xml,v 1.6 2006-04-24 12:41:00 marc Exp $ --><!-- Index Data software --><!ENTITY url.indexdata "http://www.indexdata.com/">
-<!ENTITY url.yaz "http://www.indexdata.com/yaz/">
-<!ENTITY url.yaz.download "http://ftp.indexdata.com/pub/yaz/">
-<!ENTITY url.yaz.download.win32 "http://ftp.indexdata.com/pub/yaz/win32/">
-<!ENTITY url.yaz.mailinglist "http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist">
-<!ENTITY url.yaz.mail "mailto:yaz-help@indexdata.dk">
-<!ENTITY url.yazplusplus "http://www.indexdata.com/yazplusplus/">
-<!ENTITY url.yazproxy "http://www.indexdata.com/yazproxy/">
-<!ENTITY url.idzebra "http://www.indexdata.com/zebra/">
-<!ENTITY url.idzebra.mailinglist "http://lists.indexdata.dk/cgi-bin/mailman/listinfo/zebralist">
-<!ENTITY url.metaproxy "http://www.indexdata.com/metaproxy/">
-<!-- Specifications and Standards --><!ENTITY url.w3c "http://www.w3.org/">
-<!ENTITY url.xml "http://www.w3.org/XML/">
-<!ENTITY url.sru "http://www.loc.gov/standards/sru/">
-<!ENTITY url.sru.diagnostics "http://www.loc.gov/standards/sru/diagnostics.html">
-<!ENTITY url.sru.diagnostics.list "http://www.loc.gov/standards/sru/diagnostics-list.html">
-<!ENTITY url.srw "http://www.loc.gov/standards/sru/srw/">
-<!ENTITY url.soap "http://www.w3.org/TR/soap/">
-<!ENTITY url.z39.50 "http://www.loc.gov/z3950/agency/">
-<!ENTITY url.z39.50.doc "http://www.loc.gov/z3950/agency/markup/toc.html">
-<!ENTITY url.z39.50.asn.1 "http://www.loc.gov/z3950/agency/asn1.html">
-<!ENTITY url.z39.50.diagnostics "http://www.loc.gov/z3950/agency/defns/bib1diag.html">
-<!ENTITY url.z39.50.attset.bib1 "http://www.loc.gov/z3950/agency/defns/bib1.html">
-<!ENTITY url.z39.50.charneg "http://www.loc.gov/z3950/agency/defns/charneg-3.html">
-<!ENTITY url.z39.50.proximity "http://www.loc.gov/z3950/agency/markup/09.html#3.7.2">
-<!ENTITY url.z39.50.proximity.asn1 "http://www.loc.gov/z3950/agency/asn1.html#ProximityOperator">
-<!ENTITY url.z39.50.oids "http://www.loc.gov/z3950/agency/defns/oids.html">
-<!ENTITY url.asn.1.tutorial "http://asn1.elibel.tm.fr/en/introduction/">
-<!ENTITY url.asn.1.standards "http://asn1.elibel.tm.fr/en/standards/">
-<!ENTITY url.cql "http://www.loc.gov/standards/sru/cql/">
-<!ENTITY url.cql.intro "http://zing.z3950.org/cql/intro.html">
-<!ENTITY url.xcql "http://www.loc.gov/standards/sru/xml-files/srw-types.xsd">
-<!ENTITY url.zoom "http://zoom.z3950.org/">
-<!ENTITY url.marc21 "http://www.loc.gov/marc/">
-<!ENTITY url.marc8 "http://www.loc.gov/marc/specifications/speccharmarc8.html">
-<!ENTITY url.marcxml "http://www.loc.gov/standards/marcxml/">
-<!ENTITY url.ill "http://www.nlc-bnc.ca/iso/ill/">
-<!ENTITY url.ber.over.tcpip "http://www.faqs.org/rfcs/rfc1729.html">
-<!ENTITY url.http "http://www.w3.org/Protocols/">
-<!ENTITY url.http.1.1 "http://www.w3.org/Protocols/rfc2616/rfc2616.html">
-<!-- External libraries + tools --><!ENTITY url.apache "http://httpd.apache.org/">
-<!ENTITY url.apache.directive.proxypass "http://httpd.apache.org/docs/mod/mod_proxy.html#proxypass">
-<!ENTITY url.bison "http://www.gnu.org/software/bison/">
-<!ENTITY url.libxml2 "http://xmlsoft.org/">
-<!ENTITY url.libxml2.api "http://www.xmlsoft.org/html/index.html">
-<!ENTITY url.libxml2.api.tree "http://www.xmlsoft.org/html/libxml-tree.html">
-<!ENTITY url.libxslt "http://xmlsoft.org/XSLT/">
-<!ENTITY url.libxml2.download.win32 "http://www.zlatkovic.com/libxml.en.html">
-<!ENTITY url.autoconf "http://www.gnu.org/software/autoconf/">
-<!ENTITY url.automake "http://www.gnu.org/software/automake/">
-<!ENTITY url.libtool "http://www.gnu.org/software/libtool/">
-<!ENTITY url.libiconv "http://www.gnu.org/software/libiconv/">
-<!ENTITY url.tcl "http://www.tcl.tk/">
-<!ENTITY url.perl "http://www.perl.com/">
-<!ENTITY url.gcc "http://gcc.gnu.org/">
-<!ENTITY url.vstudio "http://msdn.microsoft.com/vstudio/">
-<!ENTITY url.boost "http://www.boost.org/">
-<!ENTITY url.boost.compilers.status "http://www.boost.org/status/compiler_status.html">
-<!ENTITY url.openssl "http://www.openssl.org/">
-<!ENTITY url.unxutils "http://unxutils.sourceforge.net/">
-<!ENTITY url.tcpwrapper "ftp://ftp.porcupine.org/pub/security/index.html">
-<!-- Operating Systems --><!ENTITY url.linux.kernel "http://www.kernel.org/">
-<!ENTITY url.debian "http://www.debian.org/">
-<!ENTITY url.redhat "http://www.redhat.com/">
-<!ENTITY url.gentoo "http://www.gentoo.org/">
-<!ENTITY url.freebsd "http://www.freebsd.org/">
-<!ENTITY url.macosx "http://www.apple.com/macosx/">
-<!ENTITY url.solaris "http://www.sun.com/software/solaris/">
-<!ENTITY url.windows2000 "http://www.microsoft.com/windows2000/">
-<!ENTITY url.windows2003server "http://www.microsoft.com/windowsserver2003/default.mspx">
-<!ENTITY url.netbsd "http://www.netbsd.org/">
-<!ENTITY url.openbsd "http://www.openbsd.org/">
-<!ENTITY url.ubunto "http://www.ubuntu.com/">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY % common SYSTEM "common/common.ent">
+ %common;
]>
-<!-- $Id: yaz-man.xml,v 1.6 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: yaz-man.xml,v 1.7 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="yaz">
<refmeta>
<refentrytitle>yaz</refentrytitle>
<filename><replaceable>prefix</replaceable>/share/doc/yaz</filename>)
</para>
<para>
- <ulink url="http://www.indexdata.com/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>
-<!-- Keep this Emacs mode comment at the end of the file
+
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
->
-<!-- $Id: yaz-marcdump-man.xml,v 1.7 2006-04-24 12:41:00 marc Exp $ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- $Id: yaz-marcdump-man.xml,v 1.8 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="yaz-marcdump">
<refmeta>
<refentrytitle>yaz-marcdump</refentrytitle>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
-<!ENTITY gfs-options SYSTEM "gfs-options.xml">
-<!ENTITY gfs-virtual SYSTEM "gfs-virtual.xml">
-<!ENTITY gfs-synopsis SYSTEM "gfs-synopsis.xml">
-<!ENTITY gfs-synopsis-app "yaz-ztest">
-<!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY gfs-options SYSTEM "gfs-options.xml">
+ <!ENTITY gfs-virtual SYSTEM "gfs-virtual.xml">
+ <!ENTITY gfs-synopsis SYSTEM "gfs-synopsis.xml">
+ <!ENTITY gfs-synopsis-app "yaz-ztest">
+ <!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
]>
-<!-- $Id: yaz-ztest-man.xml,v 1.8 2006-04-24 12:41:00 marc Exp $ -->
+<!-- $Id: yaz-ztest-man.xml,v 1.9 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="yaz-ztest">
<refmeta>
</refnamediv>
<refsynopsisdiv>
- <!--
- $Id: yaz-ztest-man.xml,v 1.8 2006-04-24 12:41:00 marc Exp $
- cmd description of YAZ GFS application.
- Included in both manual and man page for yaz-ztest
--->
-
-<cmdsynopsis>
- <command>yaz-ztest</command>
- <arg choice="opt"><option>-install</option></arg>
- <arg choice="opt"><option>-installa</option></arg>
- <arg choice="opt"><option>-remove</option></arg>
- <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
- <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
- <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
- <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
- <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
- <arg choice="opt"><option>-f <replaceable>vconfig</replaceable></option></arg>
- <arg choice="opt"><option>-C <replaceable>fname</replaceable></option></arg>
- <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
- <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
- <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
- <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
- <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
- <arg choice="opt"><option>-ziDST1</option></arg>
- <arg choice="opt" rep="repeat">listener-spec</arg>
-</cmdsynopsis>
-
-<!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
-
+ &gfs-synopsis;
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
-
-<!--
- $Id: yaz-ztest-man.xml,v 1.8 2006-04-24 12:41:00 marc Exp $
- Options for generic frontend server and yaz-ztest.
- Included in both manual and man page for yaz-ztest
--->
-<variablelist>
-
- <varlistentry><term><literal>-a </literal>
- <replaceable>file</replaceable></term>
- <listitem><para>
- Specify a file for dumping PDUs (for diagnostic purposes).
- The special name <literal>-</literal> (dash) sends output to
- <literal>stderr</literal>.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-S</literal></term>
- <listitem><para>
- Don't fork or make threads on connection requests. This is good for
- debugging, but not recommended for real operation: Although the
- server is asynchronous and non-blocking, it can be nice to keep
- a software malfunction (okay then, a crash) from affecting all
- current users.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-1</literal></term>
- <listitem><para>
- Like <literal>-S</literal> but after one session the server
- exits. This mode is for debugging <emphasis>only</emphasis>.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-T</literal></term>
- <listitem><para>
- Operate the server in threaded mode. The server creates a thread
- for each connection rather than a fork a process. Only available
- on UNIX systems that offers POSIX threads.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-s</literal></term>
- <listitem><para>
- Use the SR protocol (obsolete).
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-z</literal></term>
- <listitem><para>
- Use the Z39.50 protocol (default). This option and <literal>-s</literal>
- complement each other.
- You can use both multiple times on the same command
- line, between listener-specifications (see below). This way, you
- can set up the server to listen for connections in both protocols
- concurrently, on different local ports.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-l </literal>
- <replaceable>file</replaceable></term>
- <listitem><para>The logfile.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-c </literal>
- <replaceable>config</replaceable></term>
- <listitem><para>A user option that serves as a specifier for some
- sort of configuration, usually a filename.
- The argument to this option is transferred to member
- <literal>configname</literal> of the
- <literal>statserv_options_block</literal>.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-f </literal>
- <replaceable>vconfig</replaceable></term>
- <listitem><para>This specifies an XML file that describes
- one or more YAZ frontend virtual servers.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-C </literal>
- <replaceable>fname</replaceable></term>
- <listitem><para>Sets SSL certificate file name for server (PEM).
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-v </literal>
- <replaceable>level</replaceable></term>
- <listitem><para>
- The log level. Use a comma-separated list of members of the set
- {fatal,debug,warn,log,malloc,all,none}.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-u </literal>
- <replaceable>uid</replaceable></term>
- <listitem><para>
- Set user ID. Sets the real UID of the server process to that of the
- given user. It's useful if you aren't comfortable with having the
- server run as root, but you need to start it as such to bind a
- privileged port.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-w </literal>
- <replaceable>dir</replaceable></term>
- <listitem><para>
- The server changes to this directory during before listening
- on incoming connections. This option is useful
- when the server is operating from the <application>inetd</application>
- daemon (see <literal>-i</literal>).
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-p </literal>
- <replaceable>pidfile</replaceable></term>
- <listitem><para>
- Specifies that the server should write its Process ID to
- file given by <replaceable>pidfile</replaceable>.
- A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-i</literal></term>
- <listitem><para>
- Use this to make the the server run from the
- <application>inetd</application> server (UNIX only).
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-D</literal></term>
- <listitem><para>
- Use this to make the server put itself in the background and
- run as a daemon. If neither <literal>-i</literal> nor
- <literal>-D</literal> is given, the server starts in the foreground.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-install</literal></term>
- <listitem><para>
- Use this to install the server as an NT service
- (Windows NT/2000/XP only).
- Control the server by going to the Services in the Control Panel.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-installa</literal></term>
- <listitem><para>
- Use this to install and activate the server as an NT service
- (Windows NT/2000/XP only).
- Control the server by going to the Services in the Control Panel.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-remove</literal></term>
- <listitem><para>
- Use this to remove the server from the NT services
- (Windows NT/2000/XP only).
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-t </literal>
- <replaceable>minutes</replaceable></term>
- <listitem><para>
- Idle session timeout, in minutes.
- </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-k </literal>
- <replaceable>size</replaceable></term>
- <listitem><para>
- Maximum record size/message size, in kilobytes.
- </para></listitem>
- </varlistentry>
-
- <varlistentry><term><literal>-d </literal>
- <replaceable>daemon</replaceable></term>
- <listitem><para>
- Set name of daemon to be used in hosts access file.
- 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>-m </literal>
- <replaceable>time-format</replaceable></term>
- <listitem><para>
- Sets the format of time-stamps in the log-file. Specify a string in
- the input format to <literal>strftime()</literal>.
- </para></listitem>
- </varlistentry>
-
-</variablelist>
-<!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
-
+ &gfs-options;
</refsect1>
<refsect1><title>VIRTUAL HOSTS</title>
- <!--
- $Id: yaz-ztest-man.xml,v 1.8 2006-04-24 12:41:00 marc Exp $
- Description of the virtual host mechanism in YAZ GFS
- Included in both manual and man page for yaz-ztest
--->
-
-<para>
- The Virtual hosts mechanism allows a YAZ frontend server to
- support multiple backends. A backend is selected on the basis of
- the TCP/IP binding (port+listening adddress) and/or the virtual host.
-</para>
-<para>
- A backend can be configured to execute in a particular working
- directory. Or the YAZ frontend may perform CQL to RPN conversion, thus
- allowing traditional Z39.50 backends to be offered as a SRW/SRU
- service. SRW/SRU Explain information for a particular backend may also
- be specified.
-</para>
-<para>
- For the HTTP protocol, the virtual host is specified in the Host header.
- For the Z39.50 protocol, the virtual host is specified as in the
- Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1.
-</para>
-<note>
- <para>
- Not all Z39.50 clients allows the VHOST information to be set.
- For those the selection of the backend must rely on the
- TCP/IP information alone (port and address).
- </para>
-</note>
-<para>
- The YAZ frontend server uses XML to describe the backend
- configurations. Command-line option <literal>-f</literal>
- specifies filename of the XML configuration.
-</para>
-<para>
- The configuration uses the root element <literal>yazgfs</literal>.
- This element includes a list of <literal>listen</literal> elements,
- followed by one or more <literal>server</literal> elements.
-</para>
-<para>
- The <literal>listen</literal> describes listener (transport end point),
- such as TCP/IP, Unix file socket or SSL server. Content for
- a listener:
- <variablelist>
- <varlistentry><term>CDATA (required)</term>
- <listitem>
- <para>
- The CDATA for the <literal>listen</literal> element holds the
- listener string, such as <literal>tcp:@:210</literal>,
- <literal>tcp:server1:2100</literal>,
- etc.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term>attribute <literal>id</literal> (optional)</term>
- <listitem>
- <para>
- identifier for this listener. This may be referred to from
- server sections.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <note>
- <para>
- We expect more information to be added for the listen section in
- a future version, such as CERT file for SSL servers.
- </para>
- </note>
-</para>
-<para>
- The <literal>server</literal> describes a server and the parameters
- for this server type. Content for a server:
- <variablelist>
- <varlistentry><term>attribute <literal>id</literal> (optional)</term>
- <listitem>
- <para>
- Identifier for this server. Currently not used for anything,
- but it might be for logging purposes.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>attribute <literal>listenref</literal> (optional)</term>
- <listitem>
- <para>
- Specifies listener for this server. If this attribute is not
- given, the server is accessible from all listener. In order
- for the server to be used for real, howeever, the virtual host
- must match (if specified in the configuration).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>element <literal>config</literal> (optional)</term>
- <listitem>
- <para>
- Specifies the server configuration. This is equivalent
- to the config specified using command line option
- <literal>-c</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>element <literal>directory</literal> (optional)</term>
- <listitem>
- <para>
- Specifies a working directory for this backend server. If
- specifid, the YAZ fronend changes current working directory
- to this directory whenever a backend of this type is
- started (backend handler bend_start), stopped (backend handler hand_stop)
- and initialized (bend_init).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>element <literal>host</literal> (optional)</term>
- <listitem>
- <para>
- Specifies the virtual host for this server. If this is specified
- a client <emphasis>must</emphasis> specify this host string in
- order to use this backend.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>element <literal>cql2rpn</literal> (optional)</term>
- <listitem>
- <para>
- Specifies a filename that includes CQL to RPN conversion for this
- backend server. See section "Specifiction of CQL to RPN mappings"
- If given, the backend server will only "see" a Type-1/RPN query.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>element <literal>stylesheet</literal> (optional)</term>
- <listitem>
- <para>
- Specifies the stylesheet reference to be part of SRU HTTP responses
- when the client does not specify one. If neither this is given, nor
- the client specifies one, no stylesheet reference is part of the
- SRU HTTP response.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>element <literal>docpath</literal> (optional)</term>
- <listitem>
- <para>
- Specifies a path for local file access using HTTP. All URLs with
- a leading prefix (/ exluded) that matches the value of docpath
- are used for file access. For example, if the server is to offer
- access in directory <literal>xsl</literal>, the docpath would be
- <literal>xsl</literal> and all URLs of the form
- <literal>http://host/exl</literal> will result in a local file access.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>element <literal>explain</literal> (optional)</term>
- <listitem>
- <para>
- Specifies SRW/SRU ZeeRex content for this server. Copied verbatim
- to the client. As things are now, some of the Explain content
- seeem redundant because host information, etc. is also stored
- elsewhere.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-</para>
-
-<para>
- The XML below configures a server that accepts connections from
- two ports, TCP/IP port 9900 and a local UNIX file socket.
- We name the TCP/IP server <literal>public</literal> and the
- other server <literal>internal</literal>.
- </para>
- <screen>
- <![CDATA[
- <yazgfs>
- <listen id="public">tcp:@:9900</listen>
- <listen id="internal">unix:/var/tmp/socket</listen>
- <server id="server1">
- <host>server1.mydomain</host>
- <directory>/var/www/s1</directory>
- <config>config.cfg</config>
- </server>
- <server id="server2">
- <host>server2.mydomain</host>
- <directory>/var/www/s2</directory>
- <config>config.cfg</config>
- <cql2rpn>../etc/pqf.properties</cql2rpn>
- <explain xmlns="http://explain.z3950.org/dtd/2.0/">
- <serverInfo>
- <host>server2.mydomain</host>
- <port>9900</port>
- <database>a</database>
- </serverInfo>
- </explain>
- </server>
- <server id="server3" listenref="internal">
- <directory>/var/www/s3</directory>
- <config>config.cfg</config>
- </server>
- </yazgfs>
-]]>
- </screen>
-<para>
- There are three configured backend servers. The first two
- servers, <literal>"server1"</literal> and <literal>"server2"</literal>,
- can be reached by both listener addresses - since
- no <literal>listenref</literal> attribute is specified.
- In order to distinguish between the two a virtual host has
- been specified for each of server in the <literal>host</literal>
- elements.
-</para>
-<para>
- For <literal>"server2"</literal> elements for CQL to RPN conversion
- is supported and explain information has been added (a short one here
- to keep the example small).
-</para>
-<para>
- The third server, <literal>"server3"</literal> can only be reached
- via listener <literal>"internal"</literal>.
-</para>
-
-<!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
-
+ &gfs-virtual;
</refsect1>
<refsect1><title>FILES</title>
<para>
</para>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
<?xml version="1.0" standalone="no"?>
-<!-- $Id: yaz.xml.in,v 1.21 2006-04-24 12:54:08 marc Exp $ -->
+<!-- $Id: yaz.xml.in,v 1.22 2006-04-25 11:25:08 marc Exp $ -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4//EN"
"@DTD_DIR@/docbookx.dtd" [
<!ENTITY version "@VERSION@">
&app-credits;
</book>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
-
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.48 2006-04-24 12:41:01 marc Exp $ -->
+<!-- $Id: zoom.xml,v 1.49 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="zoom"><title>ZOOM</title>
<para>
&zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
</sect1>
</chapter>
- <!-- Keep this Emacs mode comment at the end of the file
-Local variables:
-mode: nxml
-End:
--->
-
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
-<!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY zoomsh-commands SYSTEM "zoomsh-commands.xml">
]>
-<!-- $Id: zoomsh-man.xml,v 1.2 2006-04-24 12:41:01 marc Exp $ -->
+<!-- $Id: zoomsh-man.xml,v 1.3 2006-04-25 11:25:08 marc Exp $ -->
<refentry id="zoomsh">
<refmeta>
</para>
</refsect1>
</refentry>
-<!-- Keep this Emacs mode comment at the end of the file
+
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->
projects / yaz-moved-to-github.git / commitdiff