X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Ffrontend_net.xml;h=c48e539374fa423547880ceca8392a0b42af3727;hb=bdd5283295ee58a15784958e5448a08a6500d5a3;hp=d02d901aef007dcd4f044817472628ba5b1c0f95;hpb=271eaaa60ec419d64669cf0e9b5753d05365b798;p=metaproxy-moved-to-github.git

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
index d02d901..c48e539 100644
--- a/doc/frontend_net.xml
+++ b/doc/frontend_net.xml
@@ -1,9 +1,10 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: frontend_net.xml,v 1.3 2006-04-24 12:50:24 marc Exp $ -->
-<refentry>
+<refentry id="ref-frontend_net">
  <refmeta>
   <refentrytitle>frontend_net</refentrytitle>
   <manvolnum>3mp</manvolnum>
@@ -12,7 +13,8 @@
  
  <refnamediv>
   <refname>frontend_net</refname>
-  <refpurpose>network server</refpurpose>
+  <refpurpose>Metaproxy Network Server module that accepts Z39.50 and
+  HTTP requests</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>
@@ -21,6 +23,30 @@
    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>EXAMPLES</title>
   <para>
@@ -47,9 +73,17 @@
  &copyright;
 </refentry>
 
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
 Local variables:
-mode: nxml
+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
 End:
 -->
-