Document session_shared's session max

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

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
index 852f45c..9d8cdca 100644 (file)
--- a/doc/frontend_net.xml
+++ b/doc/frontend_net.xml
@@ -1,15 +1,20 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
-    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
  <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
 <refentry id="ref-frontend_net">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>frontend_net</refentrytitle>
   <manvolnum>3mp</manvolnum>
-   <refmiscinfo>Metaproxy Module</refmiscinfo>
-</refmeta>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
+ </refmeta>
  
  <refnamediv>
   <refname>frontend_net</refname>
@@ -23,6 +28,38 @@
    sends HTTP/Z39.50 messages to other filters.
   </para>
  </refsect1>
+
+ <refsect1><title>CONFIGURATION</title>
+  <para>
+   Element <literal>port</literal> is a repeating element (1 or more). The
+   text content specifies a listening port.
+  </para>
+  <para>
+   Element <literal>threads</literal> is an optional element. The
+   text content specifies number of worker threads for the following
+   filters to use. The default value is 5 (5 worker threads).
+  </para>
+  <para>
+   Element <literal>timeout</literal> is an optional element. The
+   text content is treated as an integer that specifies the session timeout
+   in seconds for a client session (using the frontend net filter). The
+   default value is 300 (5 minutes).
+  </para>
+  <para>
+   Element <literal>connect-max</literal> is an optional element. The
+   text content is treated as an integer that specifies maximum number
+   of TCP sessions from the same original IP. The special value 0 means
+   : no connection limit. This is also the default if this element is omitted.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_frontend_net.rnc"
+                    xi:parse="text"  
+                    xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
+ </refsect1>
  
  <refsect1><title>EXAMPLES</title>
   <para>
@@ -51,15 +88,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:
 -->