X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Ffrontend_net.xml;h=394b92b31c0f9e596432a9bda5a9e6459a6a49cd;hb=73f37c91c144b070020df2f27472c09b62367acf;hp=c48e539374fa423547880ceca8392a0b42af3727;hpb=235ec6eb8e28884ca223a5d451aa83b18909acd9;p=metaproxy-moved-to-github.git

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
index c48e539..394b92b 100644
--- 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>
@@ -46,6 +51,26 @@
    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>
+  <para>
+   Element <literal>message</literal> is an optional element. If
+   given and non-empty logging is performed by the frontend_net filter
+   (to the log file as given ny option -l).
+  </para>
+  <para>
+   Element <literal>stat-req</literal> is an optional element. It
+   specifies a URL path that triggers a report to be generated by
+   the frontend_net filter. By default this report is disabled (same
+   as empty value). The value itself is the path and should be prefixed
+   with a slash. For example <literal>/fn_stat</literal>.
+  </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>
@@ -53,8 +78,10 @@
    A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="frontend_net">
-     <port>@:9000</port>
      <threads>10</threads>
+     <port>@:9000</port>
+     <message>FN</message>
+     <stat-req>/fn_stat</stat-req>
     </filter>
 ]]>
    </screen>
@@ -75,15 +102,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:
 -->