From cb2467a71f98decd7adbaf768d3a1c0a1df65bdf Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Thu, 16 Mar 2006 13:20:04 +0000 Subject: [PATCH] Two man pages added. More to come. --- configure.ac | 2 +- doc/Makefile.am | 28 ++++++++++----- doc/README | 10 ++++++ doc/auth_simple.xml | 70 ++++++++++++++++++++++++++++++++++++ doc/book.xml | 10 ++++-- doc/copyright.xml | 6 ++++ doc/main.xml.in | 26 ++++++++++++++ doc/metaproxy.xml | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/metaproxy.xml.in | 25 ------------- doc/ref2dbinc.xsl | 38 ++++++++++++++++++++ 10 files changed, 277 insertions(+), 36 deletions(-) create mode 100644 doc/README create mode 100644 doc/auth_simple.xml create mode 100644 doc/copyright.xml create mode 100644 doc/main.xml.in create mode 100644 doc/metaproxy.xml delete mode 100644 doc/metaproxy.xml.in create mode 100644 doc/ref2dbinc.xsl diff --git a/configure.ac b/configure.ac index c4816b8..a200724 100644 --- a/configure.ac +++ b/configure.ac @@ -134,7 +134,7 @@ AC_CONFIG_FILES([ src/Makefile src/Jamfile doc/Makefile - doc/metaproxy.xml + doc/main.xml doc/print.dsl doc/html.dsl doc/tkl.xsl diff --git a/doc/Makefile.am b/doc/Makefile.am index f3c1057..e169b1b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,13 +1,15 @@ -## $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= @@ -19,10 +21,16 @@ man_MANS = $(MANFILES) 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 @@ -31,9 +39,13 @@ metaproxy.pdf: $(XMLFILES) 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 diff --git a/doc/README b/doc/README new file mode 100644 index 0000000..087e01d --- /dev/null +++ b/doc/README @@ -0,0 +1,10 @@ +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. + diff --git a/doc/auth_simple.xml b/doc/auth_simple.xml new file mode 100644 index 0000000..c3196d9 --- /dev/null +++ b/doc/auth_simple.xml @@ -0,0 +1,70 @@ + +]> + + + + auth_simple + 3mp + + + + auth_simple + Simple authentication and authorisation. + + + DESCRIPTION + + Simple authentication and authorisation. The configuration + specifies the name of a file that is the user register, which + lists username:password + 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. + + + ### discuss authorisation phase + + + + EXAMPLES + + A typical configuration looks as likes: + + example.target-auth + + +]]> + + ### Show and describe examle.target-auth here ### + + + + SEE ALSO + + + metaproxy + 1 + + + + + ©right; + + + diff --git a/doc/book.xml b/doc/book.xml index 03032af..d6ec440 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -1,4 +1,4 @@ - + Metaproxy - User's Guide and Reference @@ -498,7 +498,13 @@ - + + Module Reference + + The material in this chapter includes the man pages material + + &manref; + Classes in the Metaproxy source code diff --git a/doc/copyright.xml b/doc/copyright.xml new file mode 100644 index 0000000..a006371 --- /dev/null +++ b/doc/copyright.xml @@ -0,0 +1,6 @@ + +COPYRIGHT + + Copyright (c) 2005-2006, Index Data ApS + + diff --git a/doc/main.xml.in b/doc/main.xml.in new file mode 100644 index 0000000..b13d016 --- /dev/null +++ b/doc/main.xml.in @@ -0,0 +1,26 @@ + + + + + +]> + + + &book; + + diff --git a/doc/metaproxy.xml b/doc/metaproxy.xml new file mode 100644 index 0000000..0e494bb --- /dev/null +++ b/doc/metaproxy.xml @@ -0,0 +1,98 @@ + +]> + + + + metaproxy + 1 + + + + metaproxy + Metaproxy - daemon + + + + + metaproxy + + + + + + DESCRIPTION + + + metaproxy is the Metaproxy daemon + + + + + OPTIONS + + + + --help + + Displays help message. + + + + + --config config + + Specify the configuation. + + + + + + + EXAMPLES + + Start server with configuration in my.xml. + + metaproxy --config my.xml + + + + + FILES + + None important. + + + + SEE ALSO + + + auth_simple + 3mp + , + + + The Metaproxy + manual. + + + + ©right; + + + + diff --git a/doc/metaproxy.xml.in b/doc/metaproxy.xml.in deleted file mode 100644 index 9880590..0000000 --- a/doc/metaproxy.xml.in +++ /dev/null @@ -1,25 +0,0 @@ - - - - -]> - - - &book; - - diff --git a/doc/ref2dbinc.xsl b/doc/ref2dbinc.xsl new file mode 100644 index 0000000..31e4fd0 --- /dev/null +++ b/doc/ref2dbinc.xsl @@ -0,0 +1,38 @@ + + + + + + + +
+ + <xsl:value-of select="refmeta/refentrytitle"/> + + +
+ + + + + + + + + + + + + + + + +
+ +
+ + + + -- 1.7.10.4