From 876c762cf6f82451a6036f1cc0fb632a9cee7daa Mon Sep 17 00:00:00 2001 From: Pierre Pronchery Date: Sun, 8 Jul 2012 18:49:52 +0000 Subject: [PATCH] Added a manual page for mailer(1) --- Makefile | 2 + doc/.cvsignore | 2 + doc/Makefile | 12 +++-- doc/docbook.sh | 130 +++++++++++++++++++++++++++++++++++++++++++++++ doc/mailer.xml | 77 ++++++++++++++++++++++++++++ doc/project.conf | 14 ++++- 6 files changed, 232 insertions(+), 5 deletions(-) create mode 100644 doc/.cvsignore create mode 100755 doc/docbook.sh create mode 100644 doc/mailer.xml diff --git a/Makefile b/Makefile index c2292d9..574a529 100644 --- a/Makefile +++ b/Makefile @@ -50,7 +50,9 @@ dist: $(PACKAGE)-$(VERSION)/data/48x48/project.conf \ $(PACKAGE)-$(VERSION)/doc/Makefile \ $(PACKAGE)-$(VERSION)/doc/GRAMMAR \ + $(PACKAGE)-$(VERSION)/doc/docbook.sh \ $(PACKAGE)-$(VERSION)/doc/gtkdoc.sh \ + $(PACKAGE)-$(VERSION)/doc/mailer.xml \ $(PACKAGE)-$(VERSION)/doc/project.conf \ $(PACKAGE)-$(VERSION)/doc/gtkdoc/Makefile \ $(PACKAGE)-$(VERSION)/doc/gtkdoc/Mailer-docs.xml \ diff --git a/doc/.cvsignore b/doc/.cvsignore new file mode 100644 index 0000000..a567175 --- /dev/null +++ b/doc/.cvsignore @@ -0,0 +1,2 @@ +mailer.1 +mailer.html diff --git a/doc/Makefile b/doc/Makefile index 5ca83c8..685a1eb 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,5 +1,5 @@ SUBDIRS = gtkdoc -TARGETS = gtkdoc/Mailer.types gtkdoc/tmpl.stamp gtkdoc/sgml.stamp gtkdoc/html.stamp +TARGETS = gtkdoc/Mailer.types gtkdoc/tmpl.stamp gtkdoc/sgml.stamp gtkdoc/html.stamp mailer.1 mailer.html PREFIX = /usr/local DESTDIR = RM ?= rm -f @@ -25,13 +25,19 @@ gtkdoc/sgml.stamp: gtkdoc/tmpl.stamp gtkdoc/html.stamp: gtkdoc/Mailer-docs.xml gtkdoc/sgml.stamp ./gtkdoc.sh -P "$(PREFIX)" -- "gtkdoc/html.stamp" +mailer.1: mailer.xml + ./docbook.sh -P "$(PREFIX)" -- "mailer.1" + +mailer.html: mailer.xml + ./docbook.sh -P "$(PREFIX)" -- "mailer.html" + clean: @for i in $(SUBDIRS); do (cd $$i && $(MAKE) clean) || exit; done - $(RM) -- $(gtkdoc/Mailer.types_OBJS) $(gtkdoc/tmpl.stamp_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(gtkdoc/html.stamp_OBJS) + $(RM) -- $(gtkdoc/Mailer.types_OBJS) $(gtkdoc/tmpl.stamp_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(gtkdoc/html.stamp_OBJS) $(mailer.1_OBJS) $(mailer.html_OBJS) distclean: @for i in $(SUBDIRS); do (cd $$i && $(MAKE) distclean) || exit; done - $(RM) -- $(gtkdoc/Mailer.types_OBJS) $(gtkdoc/tmpl.stamp_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(gtkdoc/html.stamp_OBJS) + $(RM) -- $(gtkdoc/Mailer.types_OBJS) $(gtkdoc/tmpl.stamp_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(gtkdoc/html.stamp_OBJS) $(mailer.1_OBJS) $(mailer.html_OBJS) $(RM) -- $(TARGETS) install: $(TARGETS) diff --git a/doc/docbook.sh b/doc/docbook.sh new file mode 100755 index 0000000..977c34a --- /dev/null +++ b/doc/docbook.sh @@ -0,0 +1,130 @@ +#!/bin/sh +#$Id$ +#Copyright (c) 2012 Pierre Pronchery +# +#Redistribution and use in source and binary forms, with or without +#modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this +# list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +#AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +#IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +#FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +#DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +#SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +#CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +#OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + +#variables +PREFIX="/usr/local" +. "../config.sh" +DEBUG="_debug" +INSTALL="install -m 0644" +MKDIR="mkdir -p" +RM="rm -f" +XSLTPROC="xsltproc --nonet --xinclude" + + +#functions +#debug +_debug() +{ + echo $@ + $@ +} + + +#usage +_usage() +{ + echo "Usage: docbook.sh [-i|-u][-P prefix] target" 1>&2 + return 1 +} + + +#main +install=0 +uninstall=0 +while getopts "iuP:" "name"; do + case "$name" in + i) + uninstall=0 + install=1 + ;; + u) + install=0 + uninstall=1 + ;; + P) + PREFIX="$2" + ;; + ?) + _usage + exit $? + ;; + esac +done +shift $((OPTIND - 1)) +if [ $# -eq 0 ]; then + _usage + exit $? +fi + +[ -z "$DATADIR" ] && DATADIR="$PREFIX/share" +[ -z "$MANDIR" ] && MANDIR="$DATADIR/man" + +while [ $# -gt 0 ]; do + target="$1" + source="${target%.*}.xml" + shift + + #determine the type + ext="${target##*.}" + ext="${ext##.}" + case "$ext" in + html) + XSL="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl" + [ -f "${target%.*}.xsl" ] && XSL="${target%.*}.xsl" + instdir="$DATADIR/doc/$ext/$PACKAGE" + ;; + 1|2|3|4|5|6|7|8|9) + XSL="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl" + instdir="$MANDIR/man$ext" + ;; + *) + echo "$0: $target: Unknown type" 1>&2 + exit 2 + ;; + esac + + #uninstall + if [ "$uninstall" -eq 1 ]; then + $DEBUG $RM -- "$instdir/$target" || exit 2 + continue + fi + + #install + if [ "$install" -eq 1 ]; then + $DEBUG $MKDIR -- "$instdir" || exit 2 + $DEBUG $INSTALL -- "$target" "$instdir/$target" || exit 2 + continue + fi + + #create + $DEBUG $XSLTPROC -o "$target" "$XSL" "$source" + #XXX ignore errors + if [ $? -ne 0 ]; then + echo "$0: $target: Could not create page" 1>&2 + $RM -- "$target" + break + fi +done diff --git a/doc/mailer.xml b/doc/mailer.xml new file mode 100644 index 0000000..b1a3112 --- /dev/null +++ b/doc/mailer.xml @@ -0,0 +1,77 @@ + + + + + + + + + + + +]> + + + &title; + &package; + + + &firstname; + &surname; + Code and documentation. +
+ &email; +
+ + + + 2012 + &firstname; &surname; <&email;> + + + This manual page was written for the DeforaOS project (and may be + used by others). + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU General Public License, + Version 3 as published by the Free Software Foundation. + + + + &name; + §ion; + + + &name; + &purpose; + + + + &name; + + + + Description + &name; is a mail client. + + + Options + This program does not expect any option on the command line. + + + Bugs + Issues can be listed and reported at . + + + See also + + + compose + 1 + + + + + diff --git a/doc/project.conf b/doc/project.conf index bea697e..e39f7d8 100644 --- a/doc/project.conf +++ b/doc/project.conf @@ -1,6 +1,6 @@ subdirs=gtkdoc -targets=gtkdoc/Mailer.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp -dist=Makefile,GRAMMAR,gtkdoc.sh +targets=gtkdoc/Mailer.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp,mailer.1,mailer.html +dist=Makefile,GRAMMAR,docbook.sh,gtkdoc.sh,mailer.xml [gtkdoc/Mailer.types] type=script @@ -22,3 +22,13 @@ type=script script=./gtkdoc.sh depends=gtkdoc/Mailer-docs.xml,gtkdoc/sgml.stamp install= + +[mailer.1] +type=script +script=./docbook.sh +depends=mailer.xml + +[mailer.html] +type=script +script=./docbook.sh +depends=mailer.xml