Man page for each module.

diff --git a/doc/Makefile.am b/doc/Makefile.am
index e169b1b..116eedf 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,14 +1,18 @@
-## $Id: Makefile.am,v 1.3 2006-03-16 13:20:04 adam Exp $
+## $Id: Makefile.am,v 1.4 2006-03-27 13:41:40 adam Exp $
 docdir=$(datadir)/doc/@PACKAGE@
 
+SUFFIXES=.3mp .1
+
 SUPPORTFILES = html.dsl print.dsl tkl.xsl xml.dcl ref2dbinc.xsl
 
 XMLFILES = main.xml.in book.xml manref.xml copyright.xml
 MAINXML = main.xml
 HTMLFILES = metaproxy.html 
 
-XMLMAN=auth_simple.xml metaproxy.xml
-MANFILES=auth_simple.3mp metaproxy.1
+XMLMAN=auth_simple.xml backend_test.xml frontend_net.xml http_file.xml \
+ log.xml metaproxy.xml multi.xml virt_db.xml z3950_client.xml
+MANFILES=auth_simple.3mp backend_test.3mp frontend_net.3mp http_file.3mp \
+ log.3mp metaproxy.1 multi.3mp virt_db.3mp z3950_client.3mp
 
 PNGFILES=
 EPSFILES=
@@ -24,10 +28,10 @@ EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(REFFILES) \
 $(HTMLFILES): $(XMLFILES) manref.xml 
        jade -E14 -D $(srcdir) -d html.dsl -t sgml $(srcdir)/xml.dcl $(MAINXML)
 
-auth_simple.3mp: auth_simple.xml
+.xml.3mp:
        docbook2man $<
 
-metaproxy.1: metaproxy.xml
+.xml.1:
        docbook2man $<
 
 metaproxy.pdf: $(XMLFILES) manref.xml
@@ -35,6 +39,8 @@ metaproxy.pdf: $(XMLFILES) manref.xml
                if test ! -f $$i; then ln -s $(srcdir)/$$i .; fi; \
        done
        jade -E14 -D $(srcdir) -d print.dsl -t tex $(srcdir)/xml.dcl $(MAINXML)
+       rm -f metaproxy.tex;
+       mv main.tex metaproxy.tex
        pdfjadetex metaproxy.tex >/dev/null
        pdfjadetex metaproxy.tex >/dev/null
        pdfjadetex metaproxy.tex >/dev/null

diff --git a/doc/README b/doc/README
index 087e01d..3d8bad1 100644 (file)
--- a/doc/README
+++ b/doc/README
@@ -1,10 +1,7 @@
 How to add a new manpage.
-For new man page x.xml that you want in x.s (s=section) you have to add:
+For new man page x.xml that you want in x.s (s=man section) you have to add:
 Add to XMLMAN: x.xml 
 Add to MANFILES: x.s
-Add new Rule:
-x.s: x.xml
-       docbook2man $<
 
 Use auth_simple.xml or metaproxy.xml as starting points.
   

diff --git a/doc/auth_simple.xml b/doc/auth_simple.xml
index c3196d9..a6c1483 100644 (file)
--- a/doc/auth_simple.xml
+++ b/doc/auth_simple.xml
@@ -2,16 +2,17 @@
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
 ]>
-<!-- $Id: auth_simple.xml,v 1.1 2006-03-16 13:20:05 adam Exp $ -->
+<!-- $Id: auth_simple.xml,v 1.2 2006-03-27 13:41:40 adam Exp $ -->
 <refentry>
  <refmeta>
   <refentrytitle>auth_simple</refentrytitle>
   <manvolnum>3mp</manvolnum>
+  <refmiscinfo>Metaproxy Module</refmiscinfo>
  </refmeta>
  
  <refnamediv>
   <refname>auth_simple</refname>
-  <refpurpose>Simple authentication and authorisation.</refpurpose>
+  <refpurpose>simple authentication and authorisation.</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>

diff --git a/doc/backend_test.xml b/doc/backend_test.xml
new file mode 100644 (file)
index 0000000..41b16cc
--- /dev/null
+++ b/doc/backend_test.xml
@@ -0,0 +1,50 @@
+<!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: backend_test.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>backend_test</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+  <refmiscinfo>Metaproxy Module</refmiscinfo>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>backend_test</refname>
+  <refpurpose>backend Z39.50 server for testing.</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   A pseudo Z39.50 server for test purposes.. Similar to
+   yaz-ztest.
+  </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:
+-->

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
new file mode 100644 (file)
index 0000000..5d69f53
--- /dev/null
+++ b/doc/frontend_net.xml
@@ -0,0 +1,63 @@
+<!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: frontend_net.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>frontend_net</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+   <refmiscinfo>Metaproxy Module</refmiscinfo>
+</refmeta>
+ 
+ <refnamediv>
+  <refname>frontend_net</refname>
+  <refpurpose>network server</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This is a frontend module. Listens on one or more ports and
+   sends HTTP/Z39.50 messages to other filters.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks as likes:
+   <screen><![CDATA[
+    <filter type="frontend_net">
+     <port>@:9000</port>
+     <threads>10</threads>
+    </filter>
+]]>
+   </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:
+-->

diff --git a/doc/http_file.xml b/doc/http_file.xml
new file mode 100644 (file)
index 0000000..04a9411
--- /dev/null
+++ b/doc/http_file.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: http_file.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>http_file</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+   <refmiscinfo>Metaproxy Module</refmiscinfo>
+</refmeta>
+ 
+ <refnamediv>
+  <refname>http_file</refname>
+  <refpurpose>network server</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This module enables file access via the HTTP protocol.
+   All URLs with a given prefix are directed to a specific
+   documentroot (on local file storage). The module only serves
+   static content.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks as likes:
+   <screen><![CDATA[
+   <filter type="http_file">
+    <mimetypes>/etc/mime.types</mimetypes>
+    <documentroot>/var/www/metaproxy/html</port>
+    <prefix>/etc</prefixs>
+   </filter>
+]]>
+   </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:
+-->

diff --git a/doc/log.xml b/doc/log.xml
new file mode 100644 (file)
index 0000000..34be60e
--- /dev/null
+++ b/doc/log.xml
@@ -0,0 +1,61 @@
+<!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: log.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>log</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+   <refmiscinfo>Metaproxy Module</refmiscinfo>
+</refmeta>
+ 
+ <refnamediv>
+  <refname>log</refname>
+  <refpurpose>logs packages</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This filter logs packages sent - and received . 
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks as likes:
+   <screen><![CDATA[
+    <filter type="log">
+     <message>B</message>
+    </filter>
+]]>
+   </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:
+-->

diff --git a/doc/multi.xml b/doc/multi.xml
new file mode 100644 (file)
index 0000000..db80beb
--- /dev/null
+++ b/doc/multi.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: multi.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>multi</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+   <refmiscinfo>Metaproxy Module</refmiscinfo>
+</refmeta>
+ 
+ <refnamediv>
+  <refname>multi</refname>
+  <refpurpose>package multiplexer</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This filter multiplexes packages.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks as likes:
+   <screen><![CDATA[
+    <filter type="multi">
+    </filter>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>metaproxy</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+  <para>
+   <citerefentry>
+    <refentrytitle>virt_db</refentrytitle>
+    <manvolnum>3mp</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:
+-->

diff --git a/doc/virt_db.xml b/doc/virt_db.xml
new file mode 100644 (file)
index 0000000..497ab37
--- /dev/null
+++ b/doc/virt_db.xml
@@ -0,0 +1,80 @@
+<!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: virt_db.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>virt_db</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+   <refmiscinfo>Metaproxy Module</refmiscinfo>
+</refmeta>
+ 
+ <refnamediv>
+  <refname>virt_db</refname>
+  <refpurpose>virtual database(s)</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This filter allows one Z39.50 database to be me mapped to
+   another target; or even multiple targets..
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks as likes:
+   <screen><![CDATA[
+    <filter type="virt_db">
+      <virtual>
+        <database>db1</database>
+        <target>localhost:9999/Default</target>
+      </virtual>
+      <virtual>
+        <database>db2</database>
+        <target>indexdata.dk/gils</target>
+      </virtual>
+      <virtual>
+        <database>combined</database>
+        <target>indexdata.dk/gils</target>
+        <target>localhost:9999/Default</target>
+      </virtual>
+    </filter>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>metaproxy</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+  <para>
+   <citerefentry>
+    <refentrytitle>multi</refentrytitle>
+    <manvolnum>3mp</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:
+-->

diff --git a/doc/z3950_client.xml b/doc/z3950_client.xml
new file mode 100644 (file)
index 0000000..56ac2f8
--- /dev/null
+++ b/doc/z3950_client.xml
@@ -0,0 +1,67 @@
+<!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: z3950_client.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>z3950_client</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+   <refmiscinfo>Metaproxy Module</refmiscinfo>
+</refmeta>
+ 
+ <refnamediv>
+  <refname>z3950_client</refname>
+  <refpurpose>backend module Z39.50 client</refpurpose>
+ </refnamediv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This backend filter is a Z39.50 client.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks as likes:
+   <screen><![CDATA[
+    <filter type="z3950_client">
+     <timeout>30</timeout>
+    </filter>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ 
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>metaproxy</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+  <para>
+   <citerefentry>
+    <refentrytitle>backend_test</refentrytitle>
+    <manvolnum>3mp</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:
+-->