From a7d0816d8e587b0743cdfda1cbb2321315be7946 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Mon, 27 Mar 2006 13:41:40 +0000 Subject: [PATCH] Man page for each module. --- doc/Makefile.am | 16 ++++++---- doc/README | 5 +--- doc/auth_simple.xml | 5 ++-- doc/backend_test.xml | 50 +++++++++++++++++++++++++++++++ doc/frontend_net.xml | 63 +++++++++++++++++++++++++++++++++++++++ doc/http_file.xml | 66 +++++++++++++++++++++++++++++++++++++++++ doc/log.xml | 61 ++++++++++++++++++++++++++++++++++++++ doc/multi.xml | 66 +++++++++++++++++++++++++++++++++++++++++ doc/virt_db.xml | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/z3950_client.xml | 67 ++++++++++++++++++++++++++++++++++++++++++ 10 files changed, 468 insertions(+), 11 deletions(-) create mode 100644 doc/backend_test.xml create mode 100644 doc/frontend_net.xml create mode 100644 doc/http_file.xml create mode 100644 doc/log.xml create mode 100644 doc/multi.xml create mode 100644 doc/virt_db.xml create mode 100644 doc/z3950_client.xml diff --git a/doc/Makefile.am b/doc/Makefile.am index e169b1b..116eedf 100644 --- 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 --- 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 --- 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" [ ]> - + auth_simple 3mp + Metaproxy Module auth_simple - Simple authentication and authorisation. + simple authentication and authorisation. DESCRIPTION diff --git a/doc/backend_test.xml b/doc/backend_test.xml new file mode 100644 index 0000000..41b16cc --- /dev/null +++ b/doc/backend_test.xml @@ -0,0 +1,50 @@ + +]> + + + + backend_test + 3mp + Metaproxy Module + + + + backend_test + backend Z39.50 server for testing. + + + DESCRIPTION + + A pseudo Z39.50 server for test purposes.. Similar to + yaz-ztest. + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml new file mode 100644 index 0000000..5d69f53 --- /dev/null +++ b/doc/frontend_net.xml @@ -0,0 +1,63 @@ + +]> + + + + frontend_net + 3mp + Metaproxy Module + + + + frontend_net + network server + + + DESCRIPTION + + This is a frontend module. Listens on one or more ports and + sends HTTP/Z39.50 messages to other filters. + + + + EXAMPLES + + A typical configuration looks as likes: + + @:9000 + 10 + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/http_file.xml b/doc/http_file.xml new file mode 100644 index 0000000..04a9411 --- /dev/null +++ b/doc/http_file.xml @@ -0,0 +1,66 @@ + +]> + + + + http_file + 3mp + Metaproxy Module + + + + http_file + network server + + + DESCRIPTION + + 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. + + + + EXAMPLES + + A typical configuration looks as likes: + + /etc/mime.types + /var/www/metaproxy/html + /etc + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/log.xml b/doc/log.xml new file mode 100644 index 0000000..34be60e --- /dev/null +++ b/doc/log.xml @@ -0,0 +1,61 @@ + +]> + + + + log + 3mp + Metaproxy Module + + + + log + logs packages + + + DESCRIPTION + + This filter logs packages sent - and received . + + + + EXAMPLES + + A typical configuration looks as likes: + + B + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/multi.xml b/doc/multi.xml new file mode 100644 index 0000000..db80beb --- /dev/null +++ b/doc/multi.xml @@ -0,0 +1,66 @@ + +]> + + + + multi + 3mp + Metaproxy Module + + + + multi + package multiplexer + + + DESCRIPTION + + This filter multiplexes packages. + + + + EXAMPLES + + A typical configuration looks as likes: + + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + virt_db + 3mp + + + + + ©right; + + + diff --git a/doc/virt_db.xml b/doc/virt_db.xml new file mode 100644 index 0000000..497ab37 --- /dev/null +++ b/doc/virt_db.xml @@ -0,0 +1,80 @@ + +]> + + + + virt_db + 3mp + Metaproxy Module + + + + virt_db + virtual database(s) + + + DESCRIPTION + + This filter allows one Z39.50 database to be me mapped to + another target; or even multiple targets.. + + + + EXAMPLES + + A typical configuration looks as likes: + + + db1 + localhost:9999/Default + + + db2 + indexdata.dk/gils + + + combined + indexdata.dk/gils + localhost:9999/Default + + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + multi + 3mp + + + + + ©right; + + + diff --git a/doc/z3950_client.xml b/doc/z3950_client.xml new file mode 100644 index 0000000..56ac2f8 --- /dev/null +++ b/doc/z3950_client.xml @@ -0,0 +1,67 @@ + +]> + + + + z3950_client + 3mp + Metaproxy Module + + + + z3950_client + backend module Z39.50 client + + + DESCRIPTION + + This backend filter is a Z39.50 client. + + + + EXAMPLES + + A typical configuration looks as likes: + + 30 + +]]> + + + + + SEE ALSO + + + metaproxy + 1 + + + + + backend_test + 3mp + + + + + ©right; + + + -- 1.7.10.4