DeforaOS/Mailer
DeforaOS/Mailer
2
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Added a manual page for compose(1)

Browse Source
This commit is contained in:
Pierre Pronchery 2012-09-10 22:10:30 +00:00
parent 214b1642b8
commit 6eea8f48e4
4 changed files with 113 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile
View File

@ -50,6 +50,7 @@ dist:
$(PACKAGE)-$(VERSION)/data/48x48/project.conf \
$(PACKAGE)-$(VERSION)/doc/Makefile \
$(PACKAGE)-$(VERSION)/doc/GRAMMAR \
$(PACKAGE)-$(VERSION)/doc/compose.xml \
$(PACKAGE)-$(VERSION)/doc/docbook.sh \
$(PACKAGE)-$(VERSION)/doc/gtkdoc.sh \
$(PACKAGE)-$(VERSION)/doc/mailer.xml \

14
doc/Makefile
View File

@ -1,5 +1,5 @@
SUBDIRS = gtkdoc
TARGETS = gtkdoc/Mailer.types gtkdoc/tmpl.stamp gtkdoc/sgml.stamp gtkdoc/html.stamp mailer.1 mailer.html
TARGETS = compose.1 compose.html gtkdoc/Mailer.types gtkdoc/tmpl.stamp gtkdoc/sgml.stamp gtkdoc/html.stamp mailer.1 mailer.html
PREFIX = /usr/local
DESTDIR =
RM ?= rm -f
@ -13,6 +13,12 @@ all: subdirs $(TARGETS)
subdirs:
@for i in $(SUBDIRS); do (cd $$i && $(MAKE)) || exit; done
compose.1: compose.xml
./docbook.sh -P "$(PREFIX)" -- "compose.1"
compose.html: compose.xml
./docbook.sh -P "$(PREFIX)" -- "compose.html"
gtkdoc/Mailer.types: ../config.sh
./gtkdoc.sh -P "$(PREFIX)" -- "gtkdoc/Mailer.types"
@ -33,20 +39,22 @@ mailer.html: mailer.xml
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) $(mailer.1_OBJS) $(mailer.html_OBJS)
$(RM) -- $(compose.1_OBJS) $(compose.html_OBJS) $(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) $(mailer.1_OBJS) $(mailer.html_OBJS)
$(RM) -- $(compose.1_OBJS) $(compose.html_OBJS) $(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)
@for i in $(SUBDIRS); do (cd $$i && $(MAKE) install) || exit; done
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "compose.html"
./gtkdoc.sh -P "$(DESTDIR)$(PREFIX)" -i -- "gtkdoc/html.stamp"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "mailer.html"
uninstall:
@for i in $(SUBDIRS); do (cd $$i && $(MAKE) uninstall) || exit; done
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "compose.html"
./gtkdoc.sh -P "$(DESTDIR)$(PREFIX)" -u -- "gtkdoc/html.stamp"
./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "mailer.html"

88
doc/compose.xml Normal file
View File

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY firstname "Pierre">
<!ENTITY surname "Pronchery">
<!ENTITY username "khorben">
<!ENTITY email "khorben@defora.org">
<!ENTITY section "1">
<!ENTITY title "Mailer User Manual">
<!ENTITY package "DeforaOS Mailer">
<!ENTITY name "compose">
<!ENTITY purpose "Mail composer">
]>
<refentry>
<refentryinfo>
<title>&title;</title>
<productname>&package;</productname>
<authorgroup>
<author>
<firstname>&firstname;</firstname>
<surname>&surname;</surname>
<contrib>Code and documentation.</contrib>
<address>
<email>&email;</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2012</year>
<holder>&firstname; &surname; &lt;&email;&gt;</holder>
</copyright>
<legalnotice>
<para>This manual page was written for the DeforaOS project (and may be
used by others).</para>
<para>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.</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&name;</refentrytitle>
<manvolnum>&section;</manvolnum>
</refmeta>
<refnamediv>
<refname>&name;</refname>
<refpurpose>&purpose;</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&name;</command>
<arg choice="opt"><option>-s</option>
<replaceable>subject</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>address</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para><command>&name;</command> is a mail composer.</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>The following options are available:</para>
<variablelist>
<varlistentry>
<term><option>-s</option></term>
<listitem>
<para>The subject of the e-mail to compose.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="bugs">
<title>Bugs</title>
<para>Issues can be listed and reported at <ulink
url="http://www.defora.org/os/project/bug_list/268/Mailer"/>.</para>
</refsect1>
<refsect1 id="see_also">
<title>See also</title>
<para>
<citerefentry>
<refentrytitle>mailer</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->

15
doc/project.conf
View File

@ -1,6 +1,17 @@
subdirs=gtkdoc
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
targets=compose.1,compose.html,gtkdoc/Mailer.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp,mailer.1,mailer.html
dist=Makefile,GRAMMAR,compose.xml,docbook.sh,gtkdoc.sh,mailer.xml
[compose.1]
type=script
script=./docbook.sh
depends=compose.xml
[compose.html]
type=script
script=./docbook.sh
depends=compose.xml
install=
[gtkdoc/Mailer.types]
type=script