Removed / in doc install rule to avoid double-slash (cygwin)

[yaz-moved-to-github.git] / doc / yaz-client-man.xml

diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index 6186110..1114339 100644 (file)
--- a/doc/yaz-client-man.xml
+++ b/doc/yaz-client-man.xml
@@ -5,11 +5,15 @@
      %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.10 2006-05-28 19:56:25 adam Exp $ -->
+<!-- $Id: yaz-client-man.xml,v 1.16 2007-06-03 14:59:34 adam Exp $ -->
 <refentry id="yaz-client">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
  
  <refmeta>
   <refentrytitle>yaz-client</refentrytitle>
@@ -18,7 +22,7 @@
  
  <refnamediv>
   <refname>yaz-client</refname>
-  <refpurpose>Z39.50/SRW client for implementors</refpurpose>
+  <refpurpose>Z39.50/SRU client for implementors</refpurpose>
  </refnamediv>
 
  <refsynopsisdiv>
@@ -28,6 +32,7 @@
    <arg choice="opt"><option>-b <replaceable>filename</replaceable></option></arg>
    <arg choice="opt"><option>-c <replaceable>filename</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>
@@ -39,23 +44,33 @@
 
  </refsynopsisdiv>
   
-  <refsect1><title>DESCRIPTION</title>
-   <para>
-    <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 targets and SRW 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.
-   </para>
+ <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>
-   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.
+   If the <replaceable>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 +110,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>
@@ -156,10 +181,10 @@
     <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>