git.maemo.org Git - rfk/blob - debian/manpage.xml.ex

   1 <?xml version='1.0' encoding='ISO-8859-1'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!--
   6
   7 Process this file with an XSLT processor: `xsltproc \
   8 -''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
   9 manpages/docbook.xsl manpage.dbk'.  A manual page
  10 <package>.<section> will be generated.  You may view the
  11 manual page with: nroff -man <package>.<section> | less'.  A
  12 typical entry in a Makefile or Makefile.am is:
  13
  14 DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
  15 manpages/docbook.xsl
  16 XP=xsltproc -''-nonet
  17
  18 manpage.1: manpage.dbk
  19         $(XP) $(DB2MAN) $<
  20
  21 The xsltproc binary is found in the xsltproc package.  The
  22 XSL files are in docbook-xsl.  Please remember that if you
  23 create the nroff version in one of the debian/rules file
  24 targets (such as build), you will need to include xsltproc
  25 and docbook-xsl in your Build-Depends control field.
  26
  27 -->
  28
  29   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  30   <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
  31   <!ENTITY dhsurname   "<surname>SURNAME</surname>">
  32   <!-- Please adjust the date whenever revising the manpage. -->
  33   <!ENTITY dhdate      "<date>March 19, 2009</date>">
  34   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  35        allowed: see man(7), man(1). -->
  36   <!ENTITY dhsection   "<manvolnum>SECTION</manvolnum>">
  37   <!ENTITY dhemail     "<email><tthurman@gnome.org></email>">
  38   <!ENTITY dhusername  "
  39
  40 ">
  41   <!ENTITY dhucpackage "<refentrytitle>RFK</refentrytitle>">
  42   <!ENTITY dhpackage   "rfk">
  43
  44   <!ENTITY debian      "<productname>Debian</productname>">
  45   <!ENTITY gnu         "<acronym>GNU</acronym>">
  46   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  47 ]>
  48
  49 <refentry>
  50   <refentryinfo>
  51     <address>
  52       &dhemail;
  53     </address>
  54     <author>
  55       &dhfirstname;
  56       &dhsurname;
  57     </author>
  58     <copyright>
  59       <year>2003</year>
  60       <holder>&dhusername;</holder>
  61     </copyright>
  62     &dhdate;
  63   </refentryinfo>
  64   <refmeta>
  65     &dhucpackage;
  66
  67     &dhsection;
  68   </refmeta>
  69   <refnamediv>
  70     <refname>&dhpackage;</refname>
  71
  72     <refpurpose>program to do something</refpurpose>
  73   </refnamediv>
  74   <refsynopsisdiv>
  75     <cmdsynopsis>
  76       <command>&dhpackage;</command>
  77
  78       <arg><option>-e <replaceable>this</replaceable></option></arg>
  79
  80       <arg><option>--example <replaceable>that</replaceable></option></arg>
  81     </cmdsynopsis>
  82   </refsynopsisdiv>
  83   <refsect1>
  84     <title>DESCRIPTION</title>
  85
  86     <para>This manual page documents briefly the
  87       <command>&dhpackage;</command> and <command>bar</command>
  88       commands.</para>
  89
  90     <para>This manual page was written for the &debian; distribution
  91       because the original program does not have a manual page.
  92       Instead, it has documentation in the &gnu;
  93       <application>Info</application> format; see below.</para>
  94
  95     <para><command>&dhpackage;</command> is a program that...</para>
  96
  97   </refsect1>
  98   <refsect1>
  99     <title>OPTIONS</title>
 100
 101     <para>These programs follow the usual &gnu; command line syntax,
 102       with long options starting with two dashes (`-').  A summary of
 103       options is included below.  For a complete description, see the
 104       <application>Info</application> files.</para>
 105
 106     <variablelist>
 107       <varlistentry>
 108         <term><option>-h</option>
 109           <option>--help</option>
 110         </term>
 111         <listitem>
 112           <para>Show summary of options.</para>
 113         </listitem>
 114       </varlistentry>
 115       <varlistentry>
 116         <term><option>-v</option>
 117           <option>--version</option>
 118         </term>
 119         <listitem>
 120           <para>Show version of program.</para>
 121         </listitem>
 122       </varlistentry>
 123     </variablelist>
 124   </refsect1>
 125   <refsect1>
 126     <title>SEE ALSO</title>
 127
 128     <para>bar (1), baz (1).</para>
 129
 130     <para>The programs are documented fully by <citetitle>The Rise and
 131       Fall of a Fooish Bar</citetitle> available via the
 132       <application>Info</application> system.</para>
 133   </refsect1>
 134   <refsect1>
 135     <title>AUTHOR</title>
 136
 137     <para>This manual page was written by &dhusername; &dhemail; for
 138       the &debian; system (but may be used by others).  Permission is
 139       granted to copy, distribute and/or modify this document under
 140       the terms of the &gnu; General Public License, Version 2 any
 141           later version published by the Free Software Foundation.
 142     </para>
 143         <para>
 144           On Debian systems, the complete text of the GNU General Public
 145           License can be found in /usr/share/common-licenses/GPL.
 146         </para>
 147
 148   </refsect1>
 149 </refentry>
 150