Minor documentation updates.

[metaproxy-moved-to-github.git] / doc / session_shared.xml

diff --git a/doc/session_shared.xml b/doc/session_shared.xml
index e903343..a9af324 100644 (file)
--- a/doc/session_shared.xml
+++ b/doc/session_shared.xml
@@ -61,12 +61,23 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry><term>Session max</term>
+     <listitem>
+      <para>
+       Specifiers maximum number of sessions to any particular
+       target. If this number (limit) is reached, the session_shared
+       module will re-use result sets even if TTL is not met.
+       Failing that the session_shared will return a diagnostic.
+       Default value is 100 sessions.
+      </para>
+     </listitem>
+    </varlistentry>
     <varlistentry><term>Result-Set TTL</term>
      <listitem>
       <para>
        When a backend session result-set is not in use for more than this
        amount of time, given in seconds, it will be deleted/reused.
-       Default value is 10 seconds.
+       Default value is 30 seconds.
       </para>
      </listitem>
     </varlistentry>
@@ -80,6 +91,17 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry><term>Result-Set restart</term>
+     <listitem>
+      <para>
+       Boolean which specifies whether session_shared should to try to
+       recover a failed search. If a search results in diagnostic 2:
+       temporary system error, or a negative hit count, the search
+       will be performed once again on another or new Z39.50 session.
+       Default value is true (enabled).
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
@@ -97,8 +119,8 @@
    Configuration:
    <screen><![CDATA[
     <filter type="session_shared">
-     <resultset ttl="10" max="3"/>
-     <session ttl="30"/>
+     <resultset ttl="10" max="3" restart="true"/>
+     <session ttl="30" max="100"/>
     </filter>
 ]]>
    </screen>
@@ -119,15 +141,7 @@
 
 <!-- Keep this comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
 End:
 -->