« back to all changes in this revision
Viewing changes to debian/manpage.xml
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Takuo KITAME
- Date: 2009-09-09 20:40:07 UTC
- Revision ID: james.westby@ubuntu.com-20090909204007-236xrsmmy4cen5kb
Tags: upstream-0.9.2
Import upstream version 0.9.2
added
removed
debian/manpage.xml
1
<?xml version='1.0' encoding='UTF-8'?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
5
<!--
6
7
`xsltproc -''-nonet \
8
-''-param man.charmap.use.subset "0" \
9
-''-param make.year.ranges "1" \
10
-''-param make.single.year.ranges "1" \
11
/usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
12
manpage.xml'
13
14
A manual page <package>.<section> will be generated. You may view the
15
manual page with: nroff -man <package>.<section> | less'. A typical entry
16
in a Makefile or Makefile.am is:
17
18
DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
19
XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
20
21
manpage.1: manpage.xml
22
$(XP) $(DB2MAN) $<
23
24
The xsltproc binary is found in the xsltproc package. The XSL files are in
25
docbook-xsl. A description of the parameters you can use can be found in the
26
docbook-xsl-doc-* packages. Please remember that if you create the nroff
27
version in one of the debian/rules file targets (such as build), you will need
28
to include xsltproc and docbook-xsl in your Build-Depends control field.
29
Alternatively use the xmlto command/package. That will also automatically
30
pull in xsltproc and docbook-xsl.
31
32
Notes for using docbook2x: docbook2x-man does not automatically create the
33
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
34
<refsect1> ... </refsect1>.
35
36
To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
37
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
38
found in the docbook-xsl-doc-html package.
39
40
Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
41
42
General documentation about man-pages and man-page-formatting:
43
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
44
45
-->
46
47
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
48
<!ENTITY dhfirstname "Takuo">
49
<!ENTITY dhsurname "Kitame">
50
<!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
51
<!ENTITY dhusername "Takuo Kitame">
52
<!ENTITY dhemail "kitame@debian.org">
53
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
54
allowed: see man(7), man(1) and
55
http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
56
<!ENTITY dhsection "1">
57
<!-- TITLE should be something like "User commands" or similar (see
58
http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
59
<!ENTITY dhtitle "IMAProwl User Manual">
60
<!ENTITY dhucpackage "imaprowl">
61
<!ENTITY dhpackage "imaprowl">
62
]>
63
64
<refentry>
65
<refentryinfo>
66
<title>&dhtitle;</title>
67
<productname>&dhpackage;</productname>
68
<authorgroup>
69
<author>
70
<firstname>&dhfirstname;</firstname>
71
<surname>&dhsurname;</surname>
72
<contrib>Wrote this manpage for the Debian system.</contrib>
73
<address>
74
<email>&dhemail;</email>
75
</address>
76
</author>
77
</authorgroup>
78
<copyright>
79
<year>2009</year>
80
<holder>&dhusername;</holder>
81
</copyright>
82
<legalnotice>
83
<para>This manual page was written for the Debian system
84
(and may be used by others).</para>
85
<para>Permission is granted to copy, distribute and/or modify this
86
document under the terms of the GNU General Public License,
87
Version 2 or (at your option) any later version published by
88
the Free Software Foundation.</para>
89
<para>On Debian systems, the complete text of the GNU General Public
90
License can be found in
91
<filename>/usr/share/common-licenses/GPL</filename>.</para>
92
</legalnotice>
93
</refentryinfo>
94
<refmeta>
95
<refentrytitle>&dhucpackage;</refentrytitle>
96
<manvolnum>&dhsection;</manvolnum>
97
</refmeta>
98
<refnamediv>
99
<refname>&dhpackage;</refname>
100
<refpurpose> IMAP new mail notification utility for iPhone using Prowl Public API</refpurpose>
101
</refnamediv>
102
<refsynopsisdiv>
103
<cmdsynopsis>
104
<command>&dhpackage;</command>
105
<!-- These are several examples, how syntaxes could look -->
106
<arg choice="plain"><option>-c <replaceable>FILENAME</replaceable></option></arg>
107
<arg choice="opt"><option>--config <parameter>FILENAME</parameter></option></arg>
108
<arg choice="opt">
109
<group choice="req">
110
<arg choice="plain"><option>-q</option></arg>
111
<arg choice="plain"><option>--daemon</option></arg>
112
</group>
113
</arg>
114
<arg choice="opt">
115
<group choice="req">
116
<arg choice="plain"><option>-d</option></arg>
117
<arg choice="plain"><option>--debug</option></arg>
118
</group>
119
</arg>
120
</cmdsynopsis>
121
<cmdsynopsis>
122
<command>&dhpackage;</command>
123
<!-- Normally the help and version options make the programs stop
124
right after outputting the requested information. -->
125
<group choice="opt">
126
<arg choice="plain">
127
<group choice="req">
128
<arg choice="plain"><option>-h</option></arg>
129
<arg choice="plain"><option>--help</option></arg>
130
</group>
131
</arg>
132
<arg choice="plain">
133
<group choice="req">
134
<arg choice="plain"><option>-v</option></arg>
135
<arg choice="plain"><option>--version</option></arg>
136
</group>
137
</arg>
138
</group>
139
</cmdsynopsis>
140
</refsynopsisdiv>
141
<refsect1 id="description">
142
<title>DESCRIPTION</title>
143
<para>This manual page documents briefly the
144
<command>&dhpackage;</command> command.</para>
145
<para>This manual page was written for the Debian distribution
146
because the original program does not have a manual page.</para>
147
<para><command>&dhpackage;</command> is an IMAP new mail notification utility for iPhone using Prowl Public API</para>
148
<para>Prowl is a service and an App for iPhone's Push Notification service.(APNs) See <ulink ulr="http://prowl.weks.net/"/> for more about Prowl.</para>
149
<para>IMAProwl is an utility script to notify new mail of IMAP server with Prowl
150
service.
151
It's very useful to push notification of GMail or any other IMAP mail service to your iPhone.</para>
152
<para>This program uses IMAP/IDLE(RFC2177) or IMAP/NOOP to check the new mail on IMAP server and uses Prowl Public API via HTTPS.</para>
153
</refsect1>
154
<refsect1 id="requirements">
155
<title>REQUIREMENTS</title>
156
<para>Ruby script language version >= 1.9.0</para>
157
<para>OpenSSL extenstion library for Ruby</para>
158
<para>IMAP server must support SSL/TLS connection.</para>
159
<para>The Prowl service account. It's free, you can register at <ulink url="http://prowl.weks.net/"/></para>
160
<para>Your iPhone deveice and the Prowl.app from AppStore.</para>
161
</refsect1>
162
<refsect1 id="options">
163
<title>OPTIONS</title>
164
<para>The program follows the usual GNU command line syntax,
165
with long options starting with two dashes (`-'). A summary of
166
options is included below.</para>
167
<variablelist>
168
<!-- Use the variablelist.term.separator and the
169
variablelist.term.break.after parameters to
170
control the term elements. -->
171
<varlistentry>
172
<term><option>-c <replaceable>FILENAME</replaceable></option></term>
173
<term><option>--config <replaceable>FILENAME</replaceable></option></term>
174
<listitem>
175
<para>Configuration file to load.</para>
176
</listitem>
177
</varlistentry>
178
179
<varlistentry>
180
<term><option>-q</option></term>
181
<term><option>--daemon</option></term>
182
<listitem>
183
<para>Enable daemon mode. &dhpackage; will launch as background process.</para>
184
</listitem>
185
</varlistentry>
186
187
<varlistentry>
188
<term><option>-d</option></term>
189
<term><option>--debug</option></term>
190
<listitem>
191
<para>Enable debug output.</para>
192
</listitem>
193
</varlistentry>
194
195
<varlistentry>
196
<term><option>-h</option></term>
197
<term><option>--help</option></term>
198
<listitem>
199
<para>Show summary of options.</para>
200
</listitem>
201
</varlistentry>
202
<varlistentry>
203
<term><option>-v</option></term>
204
<term><option>--version</option></term>
205
<listitem>
206
<para>Show version of program.</para>
207
</listitem>
208
</varlistentry>
209
</variablelist>
210
</refsect1>
211
<refsect1 id="files">
212
<title>FILES</title>
213
<variablelist>
214
<varlistentry>
215
<term><filename>${HOME}/.imaprowl.conf</filename></term>
216
<listitem>
217
<para>The per-user configuration file to control the
218
behaviour of <application>&dhpackage;</application>. See
219
/usr/share/doc/&dhpackage;/examples/config.yml
220
for further details.</para>
221
</listitem>
222
</varlistentry>
223
</variablelist>
224
</refsect1>
225
226
<refsect1 id="bugs">
227
<!-- Or use this section to tell about upstream BTS. -->
228
<title>ISSUES</title>
229
<para>The program is currently limited to only work
230
with the <package>ruby1.9</package>.</para>
231
<para>The upstreams <acronym>Issue tracker</acronym> can be found
232
at <ulink url="http://github.com/takuo/IMAProwl/issues"/>.</para>
233
</refsect1>
234
</refentry>
235
Loggerhead is a web-based interface for Breezy
Version: 2.0.1