Updates to pz:authentication documentation

[pazpar2-moved-to-github.git] / doc / pazpar2_protocol.xml

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 4c525fb..968a799 100644 (file)
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -42,12 +42,18 @@
   <para>
    Each command is described in sub sections to follow.
   </para>
+  <refsect2 id="command-info">
+   <title>info</title>
+   <para>
+    Returns version and statistics about the Pazpar2 instance.
+   </para>
+  </refsect2>
   <refsect2 id="command-init">
    <title>init</title>
    <para>
     Initializes a session.
     Returns session ID to be used in subsequent requests. If
-    a server ID is given in the Pazpar2 server section, then a
+    a server ID is given in the Pazpar2 server section, then
     that is included in the session ID as suffix after a period (.).
    </para>
    <para>
@@ -248,7 +254,7 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
        <para>
        Specifies the first record to retrieve from each target.
        The first record in a result set for a target is numbered 0, next
-       record is numbered 2. By default maxrecs is 0.
+       record is numbered 1. By default startrecs is 0.
        </para>
       </listitem>
      </varlistentry>
@@ -273,8 +279,13 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
        the number '0' (decreasing) or '1' (increasing).  Default
         sort order is decreasing.
        Sort field names can be any field name designated as a sort field
-        in the pazpar2.cfg file, or the special names 'relevance' and
-       'position'.
+        in the pazpar2.cfg file, or the special names 'relevance',
+       'retrieval' and 'position'.
+       </para>
+       <para>
+       Sort type 'position' sorts by position/offset for each database.
+       Sort type 'retrieval' sorts by position of retrieval (first record
+       retrieved is 1, second record is 2, etc.).
        </para>
        <para>
        If not specified here or as
@@ -287,7 +298,7 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
        supports native sorting in order to get best results. Pazpar2
        will trigger a new search if search criteria changes from Pazpar2
        to target-based sorting or visa-versa.
-       </para>
+       </para>
       </listitem>
      </varlistentry>
 
@@ -429,6 +440,11 @@ search.pz2?session=2044502273&command=stat
        ready to display. Use this to show first records rapidly without
        requiring rapid polling.
        </para>
+       <para>
+       If block is set to <literal>preferred</literal>, the command will
+       wait until records have been received from all databases with preferred
+       setting
+       </para>
       </listitem>
      </varlistentry>
 
@@ -442,8 +458,13 @@ search.pz2?session=2044502273&command=stat
        the number '0' (decreasing) or '1' (increasing).  Default
         sort order is decreasing.
        Sort field names can be any field name designated as a sort field
-        in the pazpar2.cfg file, or the special names 'relevance' and
-       'position'.
+        in the pazpar2.cfg file, or the special names 'relevance',
+       'retrieval' and 'position'.
+       </para>
+       <para>
+       Sort type 'position' sorts by position/offset for each database.
+       Sort type 'retrieval' sorts by position of retrieval (first record
+       retrieved is 1, second record is 2, etc.).
        </para>
        <para>
        If not specified here or as
@@ -706,6 +727,13 @@ search.pz2?session=605047297&command=record&id=3
    </para>
   </refsect2>
 
+  <refsect2 id="command-stop">
+   <title>stop</title>
+   <para>
+    Makes Pazpar2 stop further search &amp; retrieval for busy databases.
+   </para>
+  </refsect2>
+
   <refsect2 id="command-termlist">
    <title>termlist</title>
    <para>