Update for different -V output

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

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 969093c..924c6e7 100644 (file)
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -9,7 +9,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: pazpar2_protocol.xml,v 1.15 2007-09-20 08:13:26 adam Exp $ -->
 <refentry id="pazpar2_protocol">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -74,6 +73,17 @@
        </para>
       </listitem>
      </varlistentry>
+
+     <varlistentry>
+      <term>service</term>
+      <listitem>
+       <para>
+        If this is defined it specifies a service ID. Makes the session use
+        the service with this ID. If this is setting is omitted, the
+        session will use the unnamed service in the Pazpar2 configuration.
+       </para>
+      </listitem>
+     </varlistentry>
     </variablelist>
    </para>
   </refsect2>
@@ -281,7 +291,8 @@ search.pz2?session=2044502273&command=stat
        field first. A sort field may be followed by a colon followed by
        the number '0' or '1', indicating whether results should be sorted in
        increasing or decreasing order according to that field. 0==Decreasing is
-       the default.
+       the default. Sort field names can be any field name designated as a sort field
+        in the pazpar2.cfg file, or the special name 'relevance'.
        </para>
       </listitem>
      </varlistentry>
@@ -389,6 +400,18 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
       </listitem>
      </varlistentry>
 
+     <varlistentry>
+      <term>binary</term>
+      <listitem>
+       <para>
+       This optional parameter enables "binary" response for retrieval
+       of a raw record (i.e. when offset is specified). For binary
+       responses the record is <emphasis>not</emphasis> converted to
+       XML and the HTTP content type is application/octet-stream.
+       </para>
+      </listitem>
+     </varlistentry>
+
     </variablelist>
    </para>
    <para>