htmlhelp.hhp
toc.hhc
std-oid-table.xml
+manref.xml
-## $Id: Makefile.am,v 1.84 2007-11-12 11:13:05 adam Exp $
+## $Id: Makefile.am,v 1.85 2007-11-21 09:04:46 adam Exp $
SUBDIRS = common
XMLFILES=bookinfo.xml introduction.xml installation.xml \
indexdata.xml \
asn.xml tools.xml odr.xml comstack.xml frontend.xml license.xml \
- future.xml client.xml ziffy.xml zoom.xml credits.xml gfs-options.xml \
+ future.xml ziffy.xml zoom.xml credits.xml gfs-options.xml \
yaz.xml yaz-client-commands.xml soap.xml gfs-virtual.xml gfs-synopsis.xml \
- std-oid-table.xml
+ std-oid-table.xml manref.xml
HTMLFILES = index.html
pdfjadetex yazj.tex >/dev/null
pdfjadetex yazj.tex >/dev/null
+manref.xml: $(REFFILES) $(srcdir)/common/stripref.xsl
+ rm -f manref.xml
+ for i in $(REFFILES); do \
+ xsltproc $(srcdir)/common/stripref.xsl $(srcdir)/$$i | sed 1d >>manref.xml; \
+ done
+
apilayer.png:
tgif -print -xbm apilayer.obj
xbmtopbm <apilayer.xbm|pnmtopng >apilayer.png
+++ /dev/null
-<!-- $Id: client.xml,v 1.19 2006-06-13 16:01:51 adam Exp $ -->
- <chapter id="client"><title>The YAZ client</title>
- <sect1 id="client.introduction"><title>Introduction</title>
- <para>
- yaz-client is a line-mode Z39.50/SRU client. It supports a fair amount
- of the functionality of the Z39.50v3 standard.
- Its primary purpose is to exercise the package, and verify that
- the protocol works OK.
- For the same reason some commands offers more functionality than others.
- Commands that exercises common Z39.50 services such as search and present
- have more features than less common supported services, such as Extended
- Services (ItemOrder, ItemUpdate,..).
- </para>
- </sect1>
- <sect1 id="client.invoking"><title>Invoking the YAZ client</title>
- <para>
- It can be started by typing
- </para>
- <cmdsynopsis>
- <command>yaz-client</command>
- <arg>-m <replaceable>fname</replaceable></arg>
- <arg>-a <replaceable>fname</replaceable></arg>
- <arg>-c <replaceable>fname</replaceable></arg>
- <arg>-q <replaceable>fname</replaceable></arg>
- <arg>-v <replaceable>level</replaceable></arg>
- <arg>-p <replaceable>target</replaceable></arg>
- <arg>-u <replaceable>auth</replaceable></arg>
- <arg>-k <replaceable>size</replaceable></arg>
- <arg>zurl</arg>
- </cmdsynopsis>
-
- <simpara>
- in a UNIX shell / WIN32 console. The <replaceable>zurl</replaceable>,
- specifies a Z39.50/SRU host and, if specified, the client first tries to
- establish connection with the Z39.50/SRU target.
- </simpara>
- <simpara>
- Options are prefixed by <literal>-</literal> followed by a
- particular letter.
- </simpara>
- <simpara>
- The following options are supported:
- </simpara>
- <variablelist>
- <varlistentry><term>
- <literal>-m</literal> <replaceable>fname</replaceable>
- </term><listitem>
- <simpara>All retrieved transfer records are appended to file
- <replaceable>fname</replaceable>. All records as returned by a
- target(s) in Search Responses and Present Responses are appended
- verbatim to the file.
- </simpara></listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>-a</literal> <replaceable>fname</replaceable>
- </term><listitem>
- <simpara>Pretty-print log of APDUs sent and received is appended
- to the file <replaceable>fname</replaceable>.
- If <replaceable>fname</replaceable> is <literal>-</literal> (minus)
- the APDU log is written to <literal>stderr</literal>.
- </simpara></listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>-c</literal> <replaceable>fname</replaceable>
- </term><listitem>
- <simpara>Sets the filename for CCL fields to
- <replaceable>fname</replaceable>. If this option is not given the
- YAZ client reads CCL fields from file <literal>default.bib</literal>.
- </simpara></listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>-q</literal> <replaceable>fname</replaceable>
- </term><listitem>
- <simpara>Sets the filename for CQL fields to
- <replaceable>fname</replaceable>. If this option is not given the
- YAZ client reads CQL fields from file
- <literal>/usr/local/share/yaz/etc/pqf.properties</literal>.
- </simpara></listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>-v</literal> <replaceable>level</replaceable>
- </term><listitem>
- <simpara>Sets the LOG level to <replaceable>level</replaceable>.
- Level is a sequence of tokens separated by comma. Each token
- is a integer or a named LOG item - one of
- <literal>fatal</literal>,
- <literal>debug</literal>,
- <literal>warn</literal>,
- <literal>log</literal>,
- <literal>malloc</literal>,
- <literal>all</literal>,
- <literal>none</literal>.
- </simpara></listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>-p</literal> <replaceable>target</replaceable>
- </term><listitem>
- <simpara>Specifies proxy address. When set YAZ client will
- connect to a proxy on the address and port given.
- The actual target will be specified as part of the InitRequest
- to inform the proxy about actual target.
- </simpara></listitem>
- </varlistentry>
- <varlistentry><term>
- <literal>-u</literal> <replaceable>auth</replaceable>
- </term><listitem>
- <simpara>Specifies authentication. Usually the form
- <replaceable>user</replaceable>/<replaceable>password</replaceable>
- is used. This option does the same thing as the
- <literal>auth</literal> command.
- </simpara></listitem>
- </varlistentry>
-
- <varlistentry><term>
- <literal>-k</literal> <replaceable>size</replaceable>
- </term><listitem>
- <simpara>Specifies the maximum messages size in kilobytes.
- The default maximum message size for the YAZ client is 1024
- (1 MB).
- </simpara></listitem>
- </varlistentry>
-
- </variablelist>
- <para>
- In order to connect to Index Data's test Z39.50 server on
- <literal>bagel.indexdata.dk</literal>, port 210 and with the
- database name <literal>marc</literal>, one could type
- <screen>
- yaz-client bagel.indexdata.dk:210/marc
- </screen>
- </para>
- <para>
- The same server is also a SRU service. Connect to it via HTTP
- as follows:
- <screen>
- yaz-client http://bagel.indexdata.dk:210/marc
- </screen>
- </para>
- <para>
- In order to enable APDU log and connect to localhost, port 210 (default)
- and database Default (default) you'd write:
- <screen>
- yaz-client -a - localhost
- </screen>
- </para>
- <para>
- The following command connects to a local server via UNIX
- socket <filename>/tmp/yaz</filename> and sets maximum message size to
- 5 MB.
- <screen>
- yaz-client -k 5120 unix:/tmp/yaz
- </screen>
- </para>
- </sect1>
- <sect1 id="client.commands"><title>Commands</title>
- <para>
- When the YAZ client has read options and connected to a target, if given,
- it will display <literal>Z></literal> and await your command.
- Commands are executed by hitting the return key.
- You can always issue the command <literal>?</literal> to see the list
- of available commands.
- </para>
- <para>
- The commands are (the letters in parenthesis are short
- names for the commands):
- </para>
-
- &yaz-client-commands;
-
- </sect1>
- <sect1 id="client.searching"><title>Searching</title>
- <para>
- The simplest example of a Prefix Query would be something like
- <screen>
- f knuth
- </screen>
- or
- <screen>
- f "donald knuth"
- </screen>
- In those queries no attributes was specified.
- This leaves it up to the server what fields to search but
- most servers will search in all fields. Some servers does not
- support this feature though, and require that some attributes
- are defined. To add one attribute you could do:
- <screen>
- f @attr 1=4 computer
- </screen>
- where we search in the title field, since the use(1) is title(4).
- If we want to search in the author field <emphasis>and</emphasis>
- in the title field, and in the title field using right truncation
- it could look something like this:
- <screen>
- f @and @attr 1=1003 knuth @attr 1=4 @attr 5=1 computer
- </screen>
- Finally using a mix of Bib-1 and GILS attributes could look
- something like this:
- <screen>
- f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather
- </screen>
- For the full specification of the Prefix Query see the section
- <link linkend="PQF">Prefix Query Format</link>.
- </para>
- </sect1>
- </chapter>
-
- <!-- 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: entities.ent,v 1.7 2007-08-13 16:57:40 mike Exp $ -->
+<!-- $Id: entities.ent,v 1.8 2007-11-21 09:04:46 adam Exp $ -->
<!ENTITY yaz "YAZ">
<!ENTITY bookinfo SYSTEM "bookinfo.xml">
<!ENTITY chap-introduction SYSTEM "introduction.xml">
<!ENTITY chap-installation SYSTEM "installation.xml">
<!ENTITY chap-zoom SYSTEM "zoom.xml">
-<!ENTITY chap-client SYSTEM "client.xml">
<!ENTITY chap-ziffy SYSTEM "ziffy.xml">
<!ENTITY chap-asn SYSTEM "asn.xml">
<!ENTITY chap-soap SYSTEM "soap.xml">
<!ENTITY gfs-synopsis SYSTEM "gfs-synopsis.xml">
<!ENTITY gfs-virtual SYSTEM "gfs-virtual.xml">
<!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
+<!ENTITY manref SYSTEM "manref.xml">
<!ENTITY asn "Z39.50 ASN.1">
<!ENTITY odr "<acronym>ODR</acronym>">
<!ENTITY comstack "<acronym>COMSTACK</acronym>">
-<!-- $Id: installation.xml,v 1.37 2007-05-06 20:27:14 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.38 2007-11-21 09:04:46 adam Exp $ -->
<chapter id="installation"><title>Compilation and Installation</title>
<sect1 id="installation-introduction"><title>Introduction</title>
<varlistentry><term><filename>client/yaz-client</filename></term>
<listitem><para>Z39.50 client for testing the protocol.
- See chapter <link linkend="client">
+ See chapter <link linkend="yaz-client">
YAZ client</link> for more information.
</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="client">YAZ client</link> for more
+ See chapter <link linkend="yaz-client">YAZ client</link> for more
information.
</para></listitem></varlistentry>
-<!-- $Id: introduction.xml,v 1.26 2007-09-18 19:19:16 adam Exp $ -->
+<!-- $Id: introduction.xml,v 1.27 2007-11-21 09:04:46 adam Exp $ -->
<chapter id="introduction"><title>Introduction</title>
<para>
<listitem>
<para>
- <xref linkend="client"/> describes how to use the &yaz; Z39.50
+ <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.
<!--
- $Id: yaz-client-commands.xml,v 1.20 2007-08-24 13:25:13 adam Exp $
+ $Id: yaz-client-commands.xml,v 1.21 2007-11-21 09:04:46 adam Exp $
Commands for YAZ client.
Included in both manual and man page for yaz-client.
-->
<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>.
+ <link linkend="command-querytype">querytype</link> for more information.
</para>
</listitem>
</varlistentry>
<!ENTITY % idcommon SYSTEM "common/common.ent">
%idcommon;
]>
-<!-- $Id: yaz-client-man.xml,v 1.16 2007-06-03 14:59:34 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.17 2007-11-21 09:04:46 adam Exp $ -->
<refentry id="yaz-client">
<refentryinfo>
<productname>YAZ</productname>
<arg choice="opt"><option>-p <replaceable>addr</replaceable></option></arg>
<arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
<arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
+ <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
<arg choice="opt"><option>-xV</option></arg>
<arg choice="opt">addr</arg>
</cmdsynopsis>
<term>-p <replaceable>addr</replaceable></term>
<listitem><para>
If specified, the client will use the proxy at the address
- given.
+ given. YAZ client will
+ connect to a proxy on the address and port given.
+ The actual target will be specified as part of the InitRequest
+ to inform the proxy about actual target.
</para></listitem>
</varlistentry>
<varlistentry>
will be used for authentication.
</para></listitem>
</varlistentry>
+ <varlistentry><term>
+ <literal>-v</literal> <replaceable>level</replaceable>
+ </term><listitem>
+ <simpara>Sets the LOG level to <replaceable>level</replaceable>.
+ Level is a sequence of tokens separated by comma. Each token
+ is a integer or a named LOG item - one of
+ <literal>fatal</literal>,
+ <literal>debug</literal>,
+ <literal>warn</literal>,
+ <literal>log</literal>,
+ <literal>malloc</literal>,
+ <literal>all</literal>,
+ <literal>none</literal>.
+ </simpara></listitem>
+ </varlistentry>
<varlistentry>
<term>-V</term>
<listitem><para>
</para>
&yaz-client-commands;
</refsect1>
+ <refsect1><title>EXAMPLE</title>
+ <para>
+ The simplest example of a Prefix Query would be something like
+ <screen>
+ f knuth
+ </screen>
+ or
+ <screen>
+ f "donald knuth"
+ </screen>
+ In those queries no attributes was specified.
+ This leaves it up to the server what fields to search but
+ most servers will search in all fields. Some servers does not
+ support this feature though, and require that some attributes
+ are defined. To add one attribute you could do:
+ <screen>
+ f @attr 1=4 computer
+ </screen>
+ where we search in the title field, since the use(1) is title(4).
+ If we want to search in the author field <emphasis>and</emphasis>
+ in the title field, and in the title field using right truncation
+ it could look something like this:
+ <screen>
+ f @and @attr 1=1003 knuth @attr 1=4 @attr 5=1 computer
+ </screen>
+ Finally using a mix of Bib-1 and GILS attributes could look
+ something like this:
+ <screen>
+ f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather
+ </screen>
+ </para>
+ </refsect1>
<refsect1><title>FILES</title>
<para>
<filename>yaz-<version>/client/client.c</filename>
<manvolnum>7</manvolnum>
</citerefentry>
</para>
- <para>
- Section "The YAZ Client" in the YAZ manual.
- </para>
- <para id="PQF">
- Section "Prefix Query Format" in the YAZ manual.
- </para>
- <para id="CCL">
- Section "Common Command Language" in the YAZ manual.
- </para>
- <para id="CQL">
- Section "Common Query Language" in the YAZ manual.
- </para>
</refsect1>
</refentry>
<!ENTITY % idcommon SYSTEM "common/common.ent">
%idcommon;
]>
-<!-- $Id: yaz-icu-man.xml,v 1.2 2007-11-12 11:43:47 adam Exp $ -->
-<refentry id="zoomsh">
+<!-- $Id: yaz-icu-man.xml,v 1.3 2007-11-21 09:04:47 adam Exp $ -->
+<refentry id="yaz-icu">
<refentryinfo>
<productname>YAZ</productname>
<productnumber>&version;</productnumber>
<!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
<!ENTITY reference-tools-cql-map 'section "CCL Qualifiers"'>
]>
-<!-- $Id: yaz-ztest-man.xml,v 1.17 2007-08-13 16:58:27 mike Exp $ -->
+<!-- $Id: yaz-ztest-man.xml,v 1.18 2007-11-21 09:04:47 adam Exp $ -->
<refentry id="yaz-ztest">
<refentryinfo>
<productname>YAZ</productname>
<filename>yaz-<version>/include/yaz/backend.h</filename>
</para>
</refsect1>
- <refsect1 id="tools.retrieval"><title>Retrieval Facility</title>
- <para>
- Refer to the "Retrieval Facility" in the YAZ manual
- </para>
- </refsect1>
- <refsect1 id="cql.to.rpn"><title>CQL to RPN conversions</title>
- <para>
- Refer to the "Specification of CQL to RPN mappings" in YAZ manual.
- </para>
- </refsect1>
<refsect1><title>SEE ALSO</title>
<para>
<citerefentry>
<?xml version="1.0" standalone="no"?>
-<!-- $Id: yaz.xml,v 1.24 2007-05-22 11:10:08 adam Exp $ -->
+<!-- $Id: yaz.xml,v 1.25 2007-11-21 09:04:47 adam Exp $ -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
"http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
[
&chap-installation;
&chap-zoom;
&chap-frontend;
- &chap-client;
&chap-ziffy;
&chap-asn;
&chap-soap;
&chap-comstack;
&chap-future;
+ <reference id="reference">
+ <title>Reference</title>
+ <partintro id="reference-introduction">
+ <para>
+ The material in this chapter is drawn directly from the individual
+ manual entries.
+ </para>
+ </partintro>
+ &manref;
+ </reference>
+
<appendix id="list-oids"><title>List of Object Identifiers</title>
<para>
These is a list of object identifiers that are built into YAZ.
projects / yaz-moved-to-github.git / commitdiff