-<!-- $Id: client.xml,v 1.14 2002-09-16 14:16:31 adam Exp $ -->
+<!-- $Id: client.xml,v 1.15 2003-05-19 20:45:07 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 client. It supports a fair amount
- of the functionality of the Z39.50-1995 standard
+ yaz-client is a line-mode Z39.50/SRW 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.
<simpara>
in a UNIX shell / WIN32 console. The <replaceable>zurl</replaceable>,
- specifies a Z39.50 host and, if specified, the client first tries to
- establish connection with the Z39.50 target on the host.
+ specifies a Z39.50/SRW host and, if specified, the client first tries to
+ establish connection with the Z39.50/SRW target.
+ </simpara>
+ <simpara>
Options are prefixed by <literal>-</literal> followed by a
particular letter.
</simpara>
<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 marc, one would have to type
+ 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 SOAP SRW service. Connect to it via HTTP
+ as follows:
+ <screen>
+ yaz-client http://bagel.indexdata.dk:210/marc
+ </screen>
</para>
- <screen>
- yaz-client bagel.indexdata.dk:210/marc
- </screen>
<para>
In order to enable APDU log and connect to localhost, port 210 (default)
and database Default (default) you'd write:
- </para>
- <screen>
- yaz-client -a - localhost
- </screen>
+ <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.
- </para>
<screen>
yaz-client -k 5120 unix:/tmp/yaz
- </screen>
+ </screen>
+ </para>
</sect1>
<sect1 id="client.commands"><title>Commands</title>
<para>
<!--
- $Id: yaz-client-commands.xml,v 1.2 2003-02-27 19:55:37 adam Exp $
+ $Id: yaz-client-commands.xml,v 1.3 2003-05-19 20:45:07 adam Exp $
Commands for YAZ client.
Included in both manual and man page for yaz-client.
-->
Syntax:
</para>
<para>
- [<literal>(tcp|ssl|unix)':'</literal>]<replaceable>host</replaceable>
- [:<replaceable>port</replaceable>][/<replaceable>base></replaceable>]
+ [<literal>(tcp|ssl|unix|http)':'</literal>]<replaceable>host</replaceable>
+ [:<replaceable>port</replaceable>][/<replaceable>base</replaceable>]
</para>
</listitem>
</varlistentry>
<literal>quit</literal>
</term>
<listitem>
- <para>Ends YAZ client</para>
+ <para>Quits YAZ client</para>
</listitem>
</varlistentry>
<varlistentry><term>
</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><term>
+ <literal>charset</literal>
+ <replaceable>negotiationcharset</replaceable>
+ [<replaceable>outputcharset</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>outputcharset</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>
+ <note>
+ <para>
+ Since character set negotation takes effect in the Z39.50
+ Initialize Request you should issue this command before
+ command <literal>open</literal> is used.
+ </para>
+ </note>
+ <note>
+ <para>
+ MARC records are not covered by Z39.50 character set negotiation.
+ See <literal>marccharset</literal>.
+ </para>
+ </note>
+ </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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
<literal>set_cclfields</literal>
<replaceable>filename</replaceable>
</term>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
]>
-<!-- $Id: yaz-client.sgml,v 1.4 2002-10-23 10:11:44 adam Exp $ -->
+<!-- $Id: yaz-client.sgml,v 1.5 2003-05-19 20:45:07 adam Exp $ -->
<refentry id="yaz-client">
<refmeta>
<refnamediv>
<refname>yaz-client</refname>
- <refpurpose>Z39.50 client for implementors</refpurpose>
+ <refpurpose>Z39.50/SRW client for implementors</refpurpose>
</refnamediv>
<refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para>
- <command>yaz-client</command> is a Z39.50 client (origin) with a
+ <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
simple command line interface that allows you to test behavior and
- performance of Z39.50 servers (targets).
+ performance of Z39.50 targets and SRW servers.
</para>
<para>
<command>yaz-client-ssl</command> is identical to
</para>
<para>
If the <replaceable>addr</replaceable> is specified, the client creates
- a connection to the Z39.50 target at the address.
+ a connection to the Z39.50/SRW target at the address.
</para>
</refsect1>
<refsect1>
-<!-- $Id: zoom.xml,v 1.25 2003-05-12 22:38:40 adam Exp $ -->
+<!-- $Id: zoom.xml,v 1.26 2003-05-19 20:45:07 adam Exp $ -->
<chapter id="zoom"><title>ZOOM</title>
<para>
&zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
</sect2>
<sect2><title>SRW Protocol behavior</title>
<para>
- The SRW protocol doesn't feature an Init Request, so
+ The SRW protocol doesn't feature an Inititialize Request, so
the connection phase merely establishes a TCP/IP connection
with the SOAP service.
</para>
- <para>None of the ZOOM connection options
+ <para>Most of the ZOOM connection options do not
affect SRW and they are ignored. However, future versions
of &yaz; might honor <literal>implementationName</literal> and
put that as part of User-Agent header for HTTP requests.
- The <literal>charset</literal>, and <literal>lang</literal>
- might also affect HTTP headers in future releases.
+ </para>
+ <para>
+ The <literal>charset</literal> is used in the Content-Type header
+ of HTTP requests.
</para>
</sect2>
</sect1>
projects / yaz-moved-to-github.git / commitdiff