Document join in yaz-icu man page
[yaz-moved-to-github.git] / doc / yaz-client-man.xml
index 3325fa5..b097a34 100644 (file)
@@ -1,5 +1,5 @@
-<!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.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
  <refentryinfo>
   <productname>YAZ</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
+
  <refmeta>
   <refentrytitle>yaz-client</refentrytitle>
   <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">Commands</refmiscinfo>
  </refmeta>
+
  <refnamediv>
   <refname>yaz-client</refname>
   <refpurpose>Z39.50/SRU client for implementors</refpurpose>
   </cmdsynopsis>
 
  </refsynopsisdiv>
-  
+
  <refsect1><title>DESCRIPTION</title>
   <para>
-   <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 SRU servers.
+   <command>yaz-client</command> is a
+   <ulink url="&url.z39.50;">Z39.50</ulink>/<ulink url="&url.sru;">SRU</ulink>
+   client (origin) with a simple command line interface that allows
+   you to test behavior and performance of Z39.50 targets and SRU servers.
+  </para>
+  <para>
+   From YAZ version 4.1.0 <command>yaz-client</command> may also operate as a
+   <ulink url="&url.solr;">SOLR</ulink> Web Service
+   client.
   </para>
   <para>
    If the <replaceable>server-addr</replaceable> is specified, the client creates
@@ -61,7 +69,7 @@
    commands from one of the following files:
    <itemizedlist>
     <listitem><para>
-      Command file if it is given by option -f. 
+      Command file if it is given by option -f.
      </para></listitem>
     <listitem><para>
       <filename>.yazclientrc</filename> in current working directory.
     <varlistentry>
      <term>-d <replaceable>dump</replaceable></term>
      <listitem><para>
-       If specified, YAZ will dump BER data for all PDUs sent and received 
+       If specified, YAZ will dump BER data for all PDUs sent and received
        to individual files, named
-       <replaceable>dump</replaceable>.DDD.<literal>raw</literal>, 
+       <replaceable>dump</replaceable>.DDD.<literal>raw</literal>,
        where DDD is 001, 002, 003, ..
       </para></listitem>
     </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).
+      Request in kilobytes. Default value is 65536 (64 MB).
       </para></listitem>
     </varlistentry>
     <varlistentry>
      <listitem><para>
        If specified, the client will use the proxy at the address
        given. YAZ client will
-       connect to a proxy on the address and port given. 
+       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>
      <term>-t <replaceable>displaycharset</replaceable></term>
      <listitem><para>
        If displaycharset is given, it specifies name of the character set of the
-       output (on the terminal on which YAZ client is running). 
+       output (on the terminal on which YAZ client is running).
       </para></listitem>
     </varlistentry>
     <varlistentry>
      </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 
+       is a integer or a named LOG item - one of
        <literal>fatal</literal>,
        <literal>debug</literal>,
        <literal>warn</literal>,