Add Manpage (DocBook and rendered)
[smime-smtp-proxy.git] / smime-smtp-filter.1.xml
1 <?xml version='1.0' encoding='UTF-8'?>
2 <?xml-stylesheet type="text/xsl"
3         href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
5         "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
6
7 <!-- Process this file with an XSLT processor, e.g. xsltproc:    -->
8 <!-- `xsltproc \
9       -''-nonet \
10       -''-param man.charmap.use.subset "0" \
11       -''-param make.year.ranges "1" \
12       -''-param make.single.year.ranges "1" \
13       manpage.xml'                                               -->
14
15   <!-- Fill in your name for FIRSTNAME and SURNAME.              -->
16   <!ENTITY dhfirstname "Joachim">
17   <!ENTITY dhsurname   "Breitner">
18   <!ENTITY dhemail     "joachim.breitner@itomig.de">
19   <!-- dhusername could also be set to "&firstname; &surname;".  -->
20   <!ENTITY dhusername  "&dhfirstname; &dhsurname;">
21
22   <!-- The version information can also be suppressed (just      -->
23   <!-- remove it or comment it out.                              -->
24   <!-- <!ENTITY dhrelease   "0.1.2"> -->
25
26   <!-- TITLE should be something like "User commands",           -->
27   <!-- "&dhpackage; command-line reference" or similar (see e.g. -->
28   <!-- http://www.tldp.org/HOWTO/Man-Page/q2.html). But limit    -->
29   <!-- the length to 30 chars.                                   -->
30   <!ENTITY dhtitle     "User Manuals">
31   
32   <!-- This is the application/package name.                     -->
33   <!ENTITY dhucpackage "SMIME-SMTP-FILTER">
34   <!ENTITY dhpackage   "smime-smtp-filter">
35
36   <!-- If the application e.g. belongs to a package like X.org,  -->
37   <!-- this should be set to the package/suite name instead of   -->
38   <!-- dhpackage.                                                -->
39   <!ENTITY dhproduct   "&dhpackage;">
40
41   <!-- SECTION should be 1-8, maybe w/ subsection other          -->
42   <!-- parameters are allowed: see man(7), man(1) and            -->
43   <!-- http://www.tldp.org/HOWTO/Man-Page/q2.html.               -->
44   <!ENTITY dhsection   "1">
45
46 ]>
47
48 <refentry>
49         <refentryinfo>
50                 <title>&dhtitle;</title>
51                 <!-- Better put a suite name instead of &dhpackage; into productname -->
52                 <productname>&dhproduct;</productname>
53                 <!-- <releaseinfo role="version">&dhrelease;</releaseinfo> -->
54                 <authorgroup>
55                         <author>
56                                 <firstname>&dhfirstname;</firstname>
57                                 <surname>&dhsurname;</surname>
58                                 <contrib>Original author of smime-smtp-proxy.</contrib>
59                                 <address>
60                                         <email>&dhemail;</email>
61                                 </address>
62                         </author>
63                 </authorgroup>
64                 <copyright>
65                         <year>2008</year>
66                         <year>2009</year>
67                         <holder>&dhusername;</holder>
68                 </copyright>
69         </refentryinfo>
70         <refmeta>
71                 <refentrytitle>&dhucpackage;</refentrytitle>
72                 <manvolnum>&dhsection;</manvolnum>
73         </refmeta>
74         <refnamediv>
75                 <refname>&dhpackage;</refname>
76                 <refpurpose>digitally signs outgoing e-mail messages</refpurpose>
77         </refnamediv>
78         <refsynopsisdiv>
79                 <cmdsynopsis>
80                         <command>&dhpackage;</command>
81                         <group choice="req">
82                                 <arg choice="plain"><option>-k <replaceable>file.pem</replaceable></option></arg>
83                                 <arg choice="plain"><option>--keyfile <replaceable>file.pem</replaceable></option></arg>
84                         </group>
85                 </cmdsynopsis>
86                 <cmdsynopsis>
87                         <command>&dhpackage;</command>
88       <!-- Normally the help and version options make the programs stop
89                              right after outputting the requested information. -->
90                         <group choice="req">
91                                 <arg choice="plain"><option>-h</option></arg>
92                                 <arg choice="plain"><option>--help</option></arg>
93                         </group>
94                 </cmdsynopsis>
95         </refsynopsisdiv>
96         <refsect1 id="description">
97                 <title>DESCRIPTION</title>
98                 <para><command>&dhpackage;</command> reads an e-mail message from the standard input, signs it using the given S/MIME key, and passes it to standard output. It is meant to be useed as a filter for <citerefentry><refentrytitle>proxsmtp</refentrytitle><manvolnum>8</manvolnum></citerefentry>. </para>
99         </refsect1>
100         <refsect1 id="options">
101                 <title>OPTIONS</title>
102                 <variablelist>
103                         <!-- Use the variablelist.term.separator and the
104                              variablelist.term.break.after parameters to
105                              control the term elements. -->
106                         <varlistentry>
107                                 <term><option>-k <replaceable class="parameter">file.pem</replaceable></option></term>
108                                 <term><option>--keyfile <replaceable class="parameter">file.pem</replaceable></option></term>
109                                 <listitem>
110                                         <para>Required. PEM certificate to use to sign the e-mail messages.</para>
111                                 </listitem>
112                         </varlistentry>
113                 </variablelist>
114         </refsect1>
115         <refsect1 id="see_also">
116                 <title>SEE ALSO</title>
117                 <!-- In alpabetical order. -->
118                 <para><citerefentry>
119                                 <refentrytitle>proxsmtp</refentrytitle>
120                                 <manvolnum>8</manvolnum>
121                         </citerefentry></para>
122         </refsect1>
123 </refentry>