From: Mike Taylor <mike@indexdata.com>
Date: Fri, 23 May 2003 00:24:04 +0000 (+0000)
Subject: Document yaz-client's CQL2RPN query-type, the set_cqlfile command and the -q command... 
X-Git-Tag: YAZ.2.0.2.RH.2~1
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=dd8e61419f08a386271a8e308141aab8131b27f6;p=yaz-moved-to-github.git

Document yaz-client's CQL2RPN query-type, the set_cqlfile command and the -q command-line options
---

diff --git a/doc/client.xml b/doc/client.xml
index 266bf16..a00c041 100644
--- a/doc/client.xml
+++ b/doc/client.xml
@@ -1,4 +1,4 @@
-<!-- $Id: client.xml,v 1.15 2003-05-19 20:45:07 adam Exp $ -->
+<!-- $Id: client.xml,v 1.16 2003-05-23 00:24:04 mike Exp $ -->
  <chapter id="client"><title>The YAZ client</title>
   <sect1 id="client.introduction"><title>Introduction</title>
    <para>
@@ -21,6 +21,7 @@
     <arg>-m <replaceable>fname</replaceable></arg>
     <arg>-a <replaceable>fname</replaceable></arg>
     <arg>-c <replaceable>fname</replaceable></arg>
+    <arg>-q <replaceable>fname</replaceable></arg>
     <arg>-v <replaceable>level</replaceable></arg>
     <arg>-p <replaceable>target</replaceable></arg>
     <arg>-u <replaceable>auth</replaceable></arg>
@@ -68,6 +69,15 @@
       </simpara></listitem>
     </varlistentry>
     <varlistentry><term>
+      <literal>-q</literal> <replaceable>fname</replaceable>
+     </term><listitem>
+      <simpara>Sets the filename for CQL fields to
+       <replaceable>fname</replaceable>. If this option is not given the
+       YAZ client reads CQL fields from file
+       <literal>/usr/local/share/yaz/etc/pqf.properties</literal>.
+      </simpara></listitem>
+    </varlistentry>
+    <varlistentry><term>
       <literal>-v</literal> <replaceable>level</replaceable>
      </term><listitem>
       <simpara>Sets the LOG level to <replaceable>level</replaceable>.
diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml
index 1494d01..446ce34 100644
--- a/doc/yaz-client-commands.xml
+++ b/doc/yaz-client-commands.xml
@@ -1,5 +1,5 @@
 <!-- 
-   $Id: yaz-client-commands.xml,v 1.3 2003-05-19 20:45:07 adam Exp $
+   $Id: yaz-client-commands.xml,v 1.4 2003-05-23 00:24:04 mike Exp $
    Commands for YAZ client.
    Included in both manual and man page for yaz-client.
 -->
@@ -246,11 +246,15 @@
   </term>
   <listitem>
    <para>Sets the query type as used by command <literal>find</literal>.
-    The following is supported: <literal>prefix</literal> for 
-    <link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
-    <literal>ccl</literal> for CCL search (Type-2
-    Query), <literal>cql</literal> for CQL or <literal>ccl2rpn</literal> for
-    <link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
+    The following is supported:
+    <literal>prefix</literal> for
+	<link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
+    <literal>ccl</literal> for CCL search (Type-2 Query),
+    <literal>cql</literal> for CQL (Type-104 search with CQL OID),
+    <literal>ccl2rpn</literal> for
+	<link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
+    <literal>cql2rpn</literal> for
+	CQL to RPN conversion (Type-1 Query).
    </para>
   </listitem>
  </varlistentry>
@@ -438,6 +442,18 @@
  </varlistentry>
 
  <varlistentry><term>
+   <literal>set_cqlfields</literal>
+   <replaceable>filename</replaceable>
+  </term>
+  <listitem>
+   <para>Specifies that CQL fields should be read from file
+    file <replaceable>filename</replaceable>. This command does the
+    thing as option <literal>-q</literal>.
+   </para>
+  </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
    <literal>register_oid</literal>
    <replaceable>name</replaceable>
    <replaceable>class</replaceable>
diff --git a/doc/yaz-client.sgml b/doc/yaz-client.sgml
index d52cb30..93a3200 100644
--- a/doc/yaz-client.sgml
+++ b/doc/yaz-client.sgml
@@ -1,7 +1,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
      <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
 ]>
-<!-- $Id: yaz-client.sgml,v 1.5 2003-05-19 20:45:07 adam Exp $ -->
+<!-- $Id: yaz-client.sgml,v 1.6 2003-05-23 00:24:04 mike Exp $ -->
 <refentry id="yaz-client">
  
  <refmeta>
@@ -20,6 +20,7 @@
    <arg choice="opt"><option>-m <replaceable>filename</replaceable></option></arg>
    <arg choice="opt"><option>-a <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>-p <replaceable>addr</replaceable></option></arg>
    <arg choice="opt"><option>-u <replaceable>auth</replaceable></option></arg>
    <arg choice="opt"><option>-k <replaceable>size</replaceable></option></arg>
@@ -82,6 +83,13 @@
       </para></listitem>
     </varlistentry>
     <varlistentry>
+     <term>-q <replaceable>filename</replaceable></term>
+     <listitem><para>
+       If specified, CQL configuration will be read from
+       the file given.
+      </para></listitem>
+    </varlistentry>
+    <varlistentry>
      <term>-p <replaceable>addr</replaceable></term>
      <listitem><para>
        If specified, the client will use the proxy at the address
@@ -118,6 +126,9 @@
    <para id="CCL">
     Section "Common Command Language" in the YAZ manual.
    </para>
+   <para id="CQL">
+    Section "Common QUery Language" in the YAZ manual.
+   </para>
   </refsect1>
 </refentry>