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   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  13   <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
  14   <!ENTITY dhsurname   "<surname>SURNAME</surname>">
  15   <!-- Please adjust the date whenever revising the manpage. -->
  16   <!ENTITY dhdate      "<date>April 12, 2001</date>">
  17   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  18        allowed: see man(7), man(1). -->
  19   <!ENTITY dhsection   "<manvolnum>SECTION</manvolnum>">
  20   <!ENTITY dhemail     "<email>ivan-debian@420.am</email>">
  21   <!ENTITY dhusername  "Ivan Kohler">
  22   <!ENTITY dhucpackage "<refentrytitle>FREESIDE</refentrytitle>">
  23   <!ENTITY dhpackage   "freeside">
  24
  25   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  26   <!ENTITY gnu         "<acronym>GNU</acronym>">
  27 ]>
  28
  29 <refentry>
  30   <refentryinfo>
  31     <address>
  32       &dhemail;
  33     </address>
  34     <author>
  35       &dhfirstname;
  36       &dhsurname;
  37     </author>
  38     <copyright>
  39       <year>2001</year>
  40       <holder>&dhusername;</holder>
  41     </copyright>
  42     &dhdate;
  43   </refentryinfo>
  44   <refmeta>
  45     &dhucpackage;
  46
  47     &dhsection;
  48   </refmeta>
  49   <refnamediv>
  50     <refname>&dhpackage;</refname>
  51
  52     <refpurpose>program to do something</refpurpose>
  53   </refnamediv>
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>&dhpackage;</command>
  57
  58       <arg><option>-e <replaceable>this</replaceable></option></arg>
  59
  60       <arg><option>--example <replaceable>that</replaceable></option></arg>
  61     </cmdsynopsis>
  62   </refsynopsisdiv>
  63   <refsect1>
  64     <title>DESCRIPTION</title>
  65
  66     <para>This manual page documents briefly the
  67       <command>&dhpackage;</command> and <command>bar</command>
  68       commands.</para>
  69
  70     <para>This manual page was written for the &debian; distribution
  71       because the original program does not have a manual page.
  72       Instead, it has documentation in the &gnu;
  73       <application>Info</application> format; see below.</para>
  74
  75     <para><command>&dhpackage;</command> is a program that...</para>
  76
  77   </refsect1>
  78   <refsect1>
  79     <title>OPTIONS</title>
  80
  81     <para>These programs follow the usual GNU command line syntax,
  82       with long options starting with two dashes (`-').  A summary of
  83       options is included below.  For a complete description, see the
  84       <application>Info</application> files.</para>
  85
  86     <variablelist>
  87       <varlistentry>
  88         <term><option>-h</option>
  89           <option>--help</option>
  90         </term>
  91         <listitem>
  92           <para>Show summary of options.</para>
  93         </listitem>
  94       </varlistentry>
  95       <varlistentry>
  96         <term><option>-v</option>
  97           <option>--version</option>
  98         </term>
  99         <listitem>
 100           <para>Show version of program.</para>
 101         </listitem>
 102       </varlistentry>
 103     </variablelist>
 104   </refsect1>
 105   <refsect1>
 106     <title>SEE ALSO</title>
 107
 108     <para>bar (1), baz (1).</para>
 109
 110     <para>The programs are documented fully by <citetitle>The Rise and
 111       Fall of a Fooish Bar</citetitle> available via the
 112       <application>Info</application> system.</para>
 113   </refsect1>
 114   <refsect1>
 115     <title>AUTHOR</title>
 116
 117     <para>This manual page was written by &dhusername; &dhemail; for
 118       the &debian; system (but may be used by others).  Permission is
 119       granted to copy, distribute and/or modify this document under
 120       the terms of the <acronym>GNU</acronym> Free Documentation
 121       License, Version 1.1 or any later version published by the Free
 122       Software Foundation; with no Invariant Sections, no Front-Cover
 123       Texts and no Back-Cover Texts.</para>
 124
 125   </refsect1>
 126 </refentry>
 127
 128 <!-- Keep this comment at the end of the file
 129 Local variables:
 130 mode: sgml
 131 sgml-omittag:t
 132 sgml-shorttag:t
 133 sgml-minimize-attributes:nil
 134 sgml-always-quote-attributes:t
 135 sgml-indent-step:2
 136 sgml-indent-data:t
 137 sgml-parent-document:nil
 138 sgml-default-dtd-file:nil
 139 sgml-exposed-tags:nil
 140 sgml-local-catalogs:nil
 141 sgml-local-ecat-files:nil
 142 End:
 143 -->