X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Ffrontend_net.xml;h=c48e539374fa423547880ceca8392a0b42af3727;hb=0a6a1372034e33c098e390473278330a61a28d38;hp=5d69f5353e3d0928a3c3eea6bb5b10daff4b6a81;hpb=a7d0816d8e587b0743cdfda1cbb2321315be7946;p=metaproxy-moved-to-github.git

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
index 5d69f53..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.1 2006-03-27 13:41:40 adam 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,10 +23,34 @@
    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>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="frontend_net">
      <port>@:9000</port>