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

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