Describe filter,maxrecs,startrecs

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 924c6e7..009635b 100644 (file)
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -177,7 +177,36 @@
       <term>filter</term>
       <listitem>
        <para>
-       Filtering.
+       Limits the search to a given set of targets specified by the
+       filter. The filter consists a comma separated list of
+       setting+operator+args pairs. The setting is a Pazpar2 setting
+       (such as <literal>pz:id</literal>).
+       The operator is either = (string match)
+       or ~ (substring match). The args is a list of values separated
+       by | (or , one of the values). The idea is that only targets
+       with a setting matching one of the values given will be included
+       in the search.
+       </para>
+      </listitem>
+     </varlistentry>
+     <varlistentry>
+      <term>startrecs</term>
+      <listitem>
+       <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.
+       </para>
+      </listitem>
+     </varlistentry>
+     <varlistentry>
+      <term>maxrecs</term>
+      <listitem>
+       <para>
+       Specifies the maximum number of records to retrieve from each
+       target. The default value is 100. This setting has same meaning
+       as per-target setting pz:maxrecs . If pz:maxrecs is set, it takes
+       precedence over argument maxrecs.
        </para>
       </listitem>
      </varlistentry>