X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-man.xml;h=3325fa567d6064ff7acaa80623ce7837f1c6fcb9;hb=66490c4cd60228c4036596003a8f24373cbd0fd8;hp=9122f6e277c82d3f76ad769215aa91618487824c;hpb=21f7c16c6b1b694405dbc1760d3d6cb3caac38f6;p=yaz-moved-to-github.git

diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index 9122f6e..3325fa5 100644
--- a/doc/yaz-client-man.xml
+++ b/doc/yaz-client-man.xml
@@ -5,11 +5,14 @@
      %local;
      <!ENTITY % entities SYSTEM "entities.ent">
      %entities;
-     <!ENTITY % common SYSTEM "common/common.ent">
-     %common;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: yaz-client-man.xml,v 1.11 2006-06-13 16:01:51 adam Exp $ -->
 <refentry id="yaz-client">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
  
  <refmeta>
   <refentrytitle>yaz-client</refentrytitle>
@@ -24,38 +27,52 @@
  <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.
-   </para>
-   <para>
-    If the <replaceable>addr</replaceable> is specified, the client creates
-    a connection to the Z39.50/SRU target at the address given.
-   </para>
+ <refsect1><title>DESCRIPTION</title>
   <para>
-   When <command>yaz-client</command> is invoked it attemps to read the
-   following files:
-   <literal>$HOME/.yazclientrc</literal> (home directory, Unix only) and
-   <literal>.yazclientrc</literal> (current directory - any platform)
-   For those files that are readable, the YAZ client executes commands
-   in those files. See COMMANDS section for description of commands.
+   <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.
+  </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>
+   When <command>yaz-client</command> is started it tries to read
+   commands from one of the following files:
+   <itemizedlist>
+    <listitem><para>
+      Command file if it is given by option -f. 
+     </para></listitem>
+    <listitem><para>
+      <filename>.yazclientrc</filename> in current working directory.
+     </para></listitem>
+    <listitem><para>
+      <filename>.yazclientrc</filename> in the user's home directory.
+      The value of the <literal>HOME</literal> is used to determine
+      the home directory. Normally, <literal>HOME</literal> is only set
+      on POSIX systems such as Linux, FreeBSD, Solaris.
+     </para></listitem>
+   </itemizedlist>
   </para>
  </refsect1>
   <refsect1>
@@ -95,6 +112,16 @@
        where DDD is 001, 002, 003, ..
       </para></listitem>
     </varlistentry>
+
+    <varlistentry>
+     <term>-f <replaceable>cmdfile</replaceable></term>
+     <listitem><para>
+      Reads commands from <replaceable>cmdfile</replaceable>. When
+      this option is used, YAZ client does not read .yazclientrc
+      from current directory or home directory.
+      </para></listitem>
+    </varlistentry>
+
     <varlistentry>
      <term>-k <replaceable>size</replaceable></term>
      <listitem><para>
@@ -109,10 +136,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>
@@ -123,12 +153,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>
@@ -151,15 +203,47 @@
    </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>
    </para>
    <para>
-    <filename>.yazclientrc</filename>
+    <filename>$HOME/.yazclientrc</filename>
    </para>
    <para>
-    <filename>$HOME/.yazclientrc</filename>
+    <filename>$HOME/.yazclient.history</filename>
    </para>
   </refsect1>
   <refsect1><title>SEE ALSO</title>
@@ -168,18 +252,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>