Added chapter about YAZ client.

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

diff --git a/doc/tools.xml b/doc/tools.xml
index 4b2a9a1..33de66e 100644 (file)
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -1,9 +1,9 @@
-<!-- $Id: tools.xml,v 1.2 2001-07-19 23:29:40 adam Exp $ -->
+<!-- $Id: tools.xml,v 1.4 2001-08-08 19:33:21 adam Exp $ -->
  <chapter><title>Supporting Tools</title>
-
+  
   <para>
    In support of the service API - primarily the ASN module, which
-   provides the programmatic interface to the Z39.50 APDUs, YAZ contains
+   provides the programmatic interface to the Z39.50 APDUs, &yaz; contains
    a collection of tools that support the development of applications.
   </para>
 
@@ -51,9 +51,8 @@ int p_query_attset (const char *arg);
      to provide a memory source (the structure created is released on
      the next call to <function>odr_reset()</function> on the stream), a
      protocol identifier (one of the constants <token>PROTO_Z3950</token> and
-     <token>PROTO_SR</token>), an attribute set
-     reference, and finally a null-terminated string holding the query
-     string.
+     <token>PROTO_SR</token>), an attribute set reference, and
+     finally a null-terminated string holding the query string.
     </para>
     <para>
      If the parse went well, <function>p_query_rpn()</function> returns a
@@ -74,13 +73,13 @@ int p_query_attset (const char *arg);
     </para>
 
     <screen>
-     Query ::= &lsqb; AttSet &rsqb; QueryStruct.
+     Query ::= &lsqb; '@attrset' AttSet &rsqb; QueryStruct.
 
      AttSet ::= string.
 
-     QueryStruct ::= { Attribute } Simple | Complex.
+     QueryStruct ::= &lsqb; Attribute &rsqb; Simple | Complex.
 
-     Attribute ::= '@attr' AttributeType '=' AttributeValue.
+     Attribute ::= '@attr' &lsqb; AttSet &rsqb; AttributeType '=' AttributeValue.
 
      AttributeType ::= integer.
 
@@ -139,6 +138,8 @@ int p_query_attset (const char *arg);
      @attr 4=1 @attr 1=4 "self portrait"
 
      @prox 0 3 1 2 k 2 dylan zimmerman
+
+     @and @attr 2=4 @attr gils 1=2038 -114 @attr 2=2 @attr gils 1=2039 -109
     </screen>
 
    </sect2>
@@ -264,12 +265,12 @@ int p_query_attset (const char *arg);
       title-index. In this case, the user could specify
      </para>
 
-     <screen>>
+     <screen>
       ti,ranked=knuth computer
      </screen>
      <para>
-      and the <literal>ranked</literal> would map to structure=free-form-text
-      (4=105) and the <literal>ti</literal> would map to title (1=4).
+      and the <literal>ranked</literal> would map to relation=relevance
+      (2=102) and the <literal>ti</literal> would map to title (1=4).
      </para>
 
      <para>
@@ -341,8 +342,8 @@ int p_query_attset (const char *arg);
       To parse a simple string with a FIND query use the function
      </para>
      <screen>
-      struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str,
-      int *error, int *pos);
+struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str,
+                                   int *error, int *pos);
      </screen>
      <para>
       which takes the CCL profile (<literal>bibset</literal>) and query
@@ -591,7 +592,7 @@ typedef struct oident
     The function
    </para>
 
-   <screen><
+   <screen>
     oid_value oid_getvalbyname(const char *name);
    </screen>
 
@@ -686,7 +687,7 @@ typedef struct oident
 
   </sect1>
  </chapter>
-
+ 
  <!-- Keep this comment at the end of the file
  Local variables:
  mode: sgml