adderet extra doc info on bounce filter

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

diff --git a/doc/bounce.xml b/doc/bounce.xml
new file mode 100644 (file)
index 0000000..bdeeab1
--- /dev/null
+++ b/doc/bounce.xml
@@ -0,0 +1,66 @@
+<!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">
+]>
+<!-- $Id: bounce.xml,v 1.1 2006-09-08 14:12:28 marc Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>bounce</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+  <refmiscinfo>Metaproxy Module</refmiscinfo>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>bounce</refname>
+  <refpurpose>bouncing package sink for all kind of metaproxy packages</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   A sink that swallows all packages, and returns them almost
+   unprocessed. It never sends any package of any type further down
+   the row, but sets Z39.50 packages to Z_Close, and HTTP_Request
+   packages to HTTP_Response err code 400 packages, and adds a
+   suitable bounce message. The bounce filter is added at the end of
+   filter routes to prevent infinite hanging of yet unprocessed
+   packages. When a package is bounced, the client connection is
+   closed as well. 
+  </para>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks like this:
+   <screen><![CDATA[
+    <filter type="bounce"/>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>metaproxy</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+ </refsect1>
+ 
+ &copyright;
+</refentry>
+
+<!-- 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
+End:
+-->