-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
- <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+ <!ENTITY % local SYSTEM "local.ent">
+ %local;
+ <!ENTITY % entities SYSTEM "entities.ent">
+ %entities;
+ <!ENTITY % common SYSTEM "common/common.ent">
+ %common;
]>
-<!-- $Id: yaz-client-man.xml,v 1.4 2004-12-09 09:27:51 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.11 2006-06-13 16:01:51 adam Exp $ -->
<refentry id="yaz-client">
<refmeta>
<refnamediv>
<refname>yaz-client</refname>
- <refpurpose>Z39.50/SRW client for implementors</refpurpose>
+ <refpurpose>Z39.50/SRU client for implementors</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>yaz-client</command>
- <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
<arg choice="opt"><option>-a <replaceable>filename</replaceable></option></arg>
+ <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
<arg choice="opt"><option>-c <replaceable>filename</replaceable></option></arg>
- <arg choice="opt"><option>-q <replaceable>filename</replaceable></option></arg>
+ <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
+ <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
+ <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
<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>-k <replaceable>size</replaceable></option></arg>
- <arg choice="opt"><option>-x</option></arg>
+ <arg choice="opt"><option>-xV</option></arg>
<arg choice="opt">addr</arg>
</cmdsynopsis>
<refsect1><title>DESCRIPTION</title>
<para>
- <command>yaz-client</command> is a Z39.50/SRW client (origin) with a
+ <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
simple command line interface that allows you to test behavior and
- performance of Z39.50 targets and SRW servers.
+ performance of Z39.50 targets and SRU servers.
</para>
<para>
If the <replaceable>addr</replaceable> is specified, the client creates
- a connection to the Z39.50/SRW target at the address given.
+ a connection to the Z39.50/SRU target at the address given.
</para>
<para>
When <command>yaz-client</command> is invoked it attemps to read the
<title>OPTIONS</title>
<variablelist>
<varlistentry>
- <term>-m <replaceable>filename</replaceable></term>
- <listitem><para>
- If specified, retrieved records will be appended to the file given.
- </para></listitem>
- </varlistentry>
- <varlistentry>
<term>-a <replaceable>filename</replaceable></term>
<listitem><para>
If specified, logging of protocol packages will be appended
- file given. The special filename <literal>-</literal>
- (dash) denotes standard output.
+ file given. If <replaceable>filename</replaceable> is
+ specified as <literal>-</literal>, the output is written
+ to <literal>stdout</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
- <term>-u <replaceable>auth</replaceable></term>
+ <term>-b <replaceable>filename</replaceable></term>
<listitem><para>
- If specified, the <replaceable>auth</replaceable> string
- will be used for authentication.
+ If specified, YAZ will dump BER data in readable notation
+ to the file specified. If <replaceable>filename</replaceable>
+ is specified as <literal>-</literal> the output is written
+ to <literal>stdout</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
</para></listitem>
</varlistentry>
<varlistentry>
- <term>-q <replaceable>filename</replaceable></term>
+ <term>-d <replaceable>dump</replaceable></term>
<listitem><para>
- If specified, CQL configuration will be read from
- the file given.
+ If specified, YAZ will dump BER data for all PDUs sent and received
+ to individual files, named
+ <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
+ where DDD is 001, 002, 003, ..
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-k <replaceable>size</replaceable></term>
+ <listitem><para>
+ Sets preferred messages and maximum record size for Initialize
+ Request in kilobytes. Default value is 1024 (1 MB).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-m <replaceable>filename</replaceable></term>
+ <listitem><para>
+ If specified, retrieved records will be appended to the file given.
</para></listitem>
</varlistentry>
-
<varlistentry>
<term>-p <replaceable>addr</replaceable></term>
<listitem><para>
given.
</para></listitem>
</varlistentry>
-
<varlistentry>
- <term>-k <replaceable>size</replaceable></term>
+ <term>-q <replaceable>filename</replaceable></term>
<listitem><para>
- Sets preferred messages and maximum record size for Initialize
- Request in kilobytes. Default value is 1024 (1 MB).
+ If specified, CQL configuration will be read from
+ the file given.
</para></listitem>
</varlistentry>
-
<varlistentry>
- <term>-x</term>
- <listitem><para>
- Makes the YAZ client print hex dumps of packages sent and received
- on standard output.
+ <term>-u <replaceable>auth</replaceable></term>
+ <listitem><para>
+ If specified, the <replaceable>auth</replaceable> string
+ will be used for authentication.
</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term>-V</term>
+ <listitem><para>
+ Prints YAZ version.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-x</term>
+ <listitem><para>
+ Makes the YAZ client print hex dumps of packages sent and received
+ on standard output.
+ </para></listitem>
+ </varlistentry>
</variablelist>
</refsect1>
<refsect1>
projects / yaz-moved-to-github.git / blobdiff