src/Makefile
src/Jamfile
doc/Makefile
- doc/metaproxy.xml
+ doc/main.xml
doc/print.dsl
doc/html.dsl
doc/tkl.xsl
-## $Id: Makefile.am,v 1.2 2006-03-16 12:03:39 adam Exp $
+## $Id: Makefile.am,v 1.3 2006-03-16 13:20:04 adam Exp $
docdir=$(datadir)/doc/@PACKAGE@
-SUPPORTFILES = html.dsl print.dsl tkl.xsl xml.dcl
-
-XMLFILES = metaproxy.xml.in book.xml
-MAINXML = metaproxy.xml
+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
+
PNGFILES=
EPSFILES=
EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(REFFILES) \
$(doc_DATA) $(EPSFILES) $(man_MANS) $(REFFILES)
-$(HTMLFILES): $(XMLFILES)
+$(HTMLFILES): $(XMLFILES) manref.xml
jade -E14 -D $(srcdir) -d html.dsl -t sgml $(srcdir)/xml.dcl $(MAINXML)
-metaproxy.pdf: $(XMLFILES)
+auth_simple.3mp: auth_simple.xml
+ docbook2man $<
+
+metaproxy.1: metaproxy.xml
+ docbook2man $<
+
+metaproxy.pdf: $(XMLFILES) manref.xml
for i in $(PNGFILES); do \
if test ! -f $$i; then ln -s $(srcdir)/$$i .; fi; \
done
pdfjadetex metaproxy.tex >/dev/null
pdfjadetex metaproxy.tex >/dev/null
-index.tkl: $(XMLFILES) tkl.xsl
+index.tkl: $(XMLFILES) tkl.xsl manref.xml
xsltproc tkl.xsl $(MAINXML)
+manref.xml: $(XMLMAN) ref2dbinc.xsl
+ rm -f manref.xml
+ for i in $(XMLMAN); do xsltproc ref2dbinc.xsl $$i >>manref.xml; done
+
clean-data-hook:
rm -f [0-9]* *.bak
--- /dev/null
+How to add a new manpage.
+For new man page x.xml that you want in x.s (s=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.
+
--- /dev/null
+<!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: auth_simple.xml,v 1.1 2006-03-16 13:20:05 adam Exp $ -->
+<refentry>
+ <refmeta>
+ <refentrytitle>auth_simple</refentrytitle>
+ <manvolnum>3mp</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>auth_simple</refname>
+ <refpurpose>Simple authentication and authorisation.</refpurpose>
+ </refnamediv>
+
+ <refsect1><title>DESCRIPTION</title>
+ <para>
+ Simple authentication and authorisation. The configuration
+ specifies the name of a file that is the user register, which
+ lists <varname>username</varname>:<varname>password</varname>
+ pairs, one per line, colon separated. When a session begins, it
+ is rejected unless username and passsword are supplied, and match
+ a pair in the register.
+ </para>
+ <para>
+ ### discuss authorisation phase
+ </para>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+ <para>
+ A typical configuration looks as likes:
+ <screen><![CDATA[
+ <filter type="auth_simple">
+ <targetRegister>example.target-auth</targetRegister>
+ <discardUnauthorisedTargets/>
+ </filter>
+]]>
+ </screen>
+ ### Show and describe examle.target-auth here ###
+ </para>
+ </refsect1>
+
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>metaproxy</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+
+ ©right;
+</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:
+-->
-<!-- $Id: book.xml,v 1.1 2006-03-16 12:03:39 adam Exp $ -->
+<!-- $Id: book.xml,v 1.2 2006-03-16 13:20:05 adam Exp $ -->
<bookinfo>
<title>Metaproxy - User's Guide and Reference</title>
<author>
</section>
</chapter>
-
+ <chapter id="moduleref">
+ <title>Module Reference</title>
+ <para>
+ The material in this chapter includes the man pages material
+ </para>
+ &manref;
+ </chapter>
<chapter id="classes">
<title>Classes in the Metaproxy source code</title>
--- /dev/null
+<!-- $Id: copyright.xml,v 1.1 2006-03-16 13:20:05 adam Exp $ -->
+<refsect1><title>COPYRIGHT</title>
+ <para>
+ Copyright (c) 2005-2006, Index Data ApS
+ </para>
+</refsect1>
--- /dev/null
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "@DTD_DIR@/docbookx.dtd" [
+ <!ENTITY oslash "ø"> <!-- CIRCLED DIVISION SLASH -->
+ <!ENTITY book SYSTEM "book.xml">
+ <!ENTITY manref SYSTEM "manref.xml">
+ <!ENTITY version "@VERSION@">
+]>
+<!-- $Id: main.xml.in,v 1.1 2006-03-16 13:20:05 adam Exp $ -->
+<book id="metaproxy">
+ &book;
+</book>
+<!-- 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:
+-->
--- /dev/null
+<!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: metaproxy.xml,v 1.1 2006-03-16 13:20:05 adam Exp $ -->
+<refentry>
+ <refmeta>
+ <refentrytitle>metaproxy</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>metaproxy</refname>
+ <refpurpose>Metaproxy - daemon</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>metaproxy</command>
+ <arg choice="opt"><option>--help</option></arg>
+ <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>DESCRIPTION</title>
+
+ <para>
+ <command>metaproxy</command> is the Metaproxy daemon
+ </para>
+
+ </refsect1>
+
+ <refsect1><title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>--help</term>
+ <listitem><para>
+ Displays help message.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--config <replaceable>config</replaceable></term>
+ <listitem><para>
+ Specify the configuation.
+ </para></listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+ <para>
+ Start server with configuration in <filename>my.xml</filename>.
+ <screen>
+ metaproxy --config my.xml
+ </screen>
+ </para>
+ </refsect1>
+
+ <refsect1><title>FILES</title>
+ <para>
+ None important.
+ </para>
+ </refsect1>
+
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>auth_simple</refentrytitle>
+ <manvolnum>3mp</manvolnum>
+ </citerefentry>,
+ </para>
+ <para>
+ The Metaproxy
+ <ulink url="http://www.indexdata.com/metaproxy/doc/">manual</ulink>.
+ </para>
+ </refsect1>
+
+ ©right;
+
+</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:
+-->
+++ /dev/null
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "@DTD_DIR@/docbookx.dtd" [
- <!ENTITY oslash "ø"> <!-- CIRCLED DIVISION SLASH -->
- <!ENTITY book SYSTEM "book.xml">
- <!ENTITY version "@VERSION@">
-]>
-<!-- $Id: metaproxy.xml.in,v 1.1 2006-03-16 12:03:39 adam Exp $ -->
-<book id="metaproxy">
- &book;
-</book>
-<!-- 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:
--->
--- /dev/null
+<?xml version="1.0"?>
+<!-- $Id: ref2dbinc.xsl,v 1.1 2006-03-16 13:20:05 adam Exp $ -->
+<xsl:stylesheet
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ version="1.0">
+
+ <xsl:output method="xml" encoding="UTF-8"/>
+
+<xsl:template match="/refentry">
+ <section>
+ <title>
+ <xsl:value-of select="refmeta/refentrytitle"/>
+ </title>
+ <xsl:apply-templates/>
+ </section>
+</xsl:template>
+
+<xsl:template match="refnamediv">
+ <para>
+ <xsl:value-of select="refpurpose"/>
+ </para>
+</xsl:template>
+
+<xsl:template match="refmeta">
+</xsl:template>
+
+<xsl:template match="refsynopsisdiv">
+ <xsl:copy-of select="cmdsynopsis"/>
+</xsl:template>
+
+<xsl:template match="refsect1">
+ <section>
+ <xsl:copy-of select="*"/>
+ </section>
+</xsl:template>
+
+</xsl:stylesheet>
+