X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=578db2e4b2b3bbf995b71254d5e558d53d0a22e2;hp=1114339cbce50931215eb15314cf2fb929a05dc5;hb=b11da5f84991a07de9caf4ab52478e0e5a1028e0;hpb=8cd0ea1bdddd37a48526a3e52045cada428379c5

diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index 1114339..578db2e 100644
--- a/doc/yaz-client-man.xml
+++ b/doc/yaz-client-man.xml
@@ -8,7 +8,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: yaz-client-man.xml,v 1.16 2007-06-03 14:59:34 adam Exp $ -->
 <refentry id="yaz-client">
  <refentryinfo>
   <productname>YAZ</productname>
@@ -28,30 +27,39 @@
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>yaz-client</command>
-   <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>-a <replaceable>apdulog</replaceable></option></arg>
+   <arg choice="opt"><option>-b <replaceable>berdump</replaceable></option></arg>
+   <arg choice="opt"><option>-c <replaceable>cclfile</replaceable></option></arg>
    <arg choice="opt"><option>-d <replaceable>dump</replaceable></option></arg>
    <arg choice="opt"><option>-f <replaceable>cmdfile</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>-m <replaceable>marclog</replaceable></option></arg>
+   <arg choice="opt"><option>-p <replaceable>proxy-addr</replaceable></option></arg>
+   <arg choice="opt"><option>-q <replaceable>cqlfile</replaceable></option></arg>
+   <arg choice="opt"><option>-t <replaceable>dispcharset</replaceable></option></arg>
    <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
-   <arg choice="opt"><option>-xV</option></arg>
-   <arg choice="opt">addr</arg>
+   <arg choice="opt"><option>-v <replaceable>loglevel</replaceable></option></arg>
+   <arg choice="opt"><option>-V</option></arg>
+   <arg choice="opt"><option>-x</option></arg>
+   <arg choice="opt">server-addr</arg>
   </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>
-   If the <replaceable>addr</replaceable> is specified, the client creates
+   From YAZ version 4.0.13, <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
    a connection to the Z39.50/SRU target at the address given.
   </para>
   <para>
@@ -134,10 +142,13 @@
       </para></listitem>
     </varlistentry>
     <varlistentry>
-     <term>-p <replaceable>addr</replaceable></term>
+     <term>-p <replaceable>proxy-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>
@@ -148,12 +159,34 @@
       </para></listitem>
     </varlistentry>
     <varlistentry>
+     <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). 
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
      <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>
+      <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>
@@ -176,6 +209,38 @@
    </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-&lt;version&gt;/client/client.c</filename>
@@ -193,18 +258,10 @@
      <refentrytitle>yaz</refentrytitle>
      <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.
+    <citerefentry>
+     <refentrytitle>bib1-attr</refentrytitle>
+     <manvolnum>7</manvolnum>
+    </citerefentry>
    </para>
   </refsect1>
 </refentry>