Document frontend_net's: message, stat-req

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

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
index 702de7c..394b92b 100644 (file)
--- a/doc/frontend_net.xml
+++ b/doc/frontend_net.xml
@@ -51,6 +51,18 @@
    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>
@@ -66,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>
@@ -88,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:
 -->