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>November 11, 2008</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>little_miry@yahoo.es</email>">
  28   <!ENTITY dhusername  "Miriam Ruiz">
  29   <!ENTITY dhucpackage "<refentrytitle>VIRTUOSO</refentrytitle>">
  30   <!ENTITY dhpackage   "virtuoso">
  31
  32   <!ENTITY debian      "<productname>Debian</productname>">
  33   <!ENTITY gnu         "<acronym>GNU</acronym>">
  34   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  35 ]>
  36
  37 <refentry>
  38   <refentryinfo>
  39     <address>
  40       &dhemail;
  41     </address>
  42     <author>
  43       &dhfirstname;
  44       &dhsurname;
  45     </author>
  46     <copyright>
  47       <year>2003</year>
  48       <holder>&dhusername;</holder>
  49     </copyright>
  50     &dhdate;
  51   </refentryinfo>
  52   <refmeta>
  53     &dhucpackage;
  54
  55     &dhsection;
  56   </refmeta>
  57   <refnamediv>
  58     <refname>&dhpackage;</refname>
  59
  60     <refpurpose>program to do something</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhpackage;</command>
  65
  66       <arg><option>-e <replaceable>this</replaceable></option></arg>
  67
  68       <arg><option>--example <replaceable>that</replaceable></option></arg>
  69     </cmdsynopsis>
  70   </refsynopsisdiv>
  71   <refsect1>
  72     <title>DESCRIPTION</title>
  73
  74     <para>This manual page documents briefly the
  75       <command>&dhpackage;</command> and <command>bar</command>
  76       commands.</para>
  77
  78     <para>This manual page was written for the &debian; distribution
  79       because the original program does not have a manual page.
  80       Instead, it has documentation in the &gnu;
  81       <application>Info</application> format; see below.</para>
  82
  83     <para><command>&dhpackage;</command> is a program that...</para>
  84
  85   </refsect1>
  86   <refsect1>
  87     <title>OPTIONS</title>
  88
  89     <para>These programs follow the usual &gnu; command line syntax,
  90       with long options starting with two dashes (`-').  A summary of
  91       options is included below.  For a complete description, see the
  92       <application>Info</application> files.</para>
  93
  94     <variablelist>
  95       <varlistentry>
  96         <term><option>-h</option>
  97           <option>--help</option>
  98         </term>
  99         <listitem>
 100           <para>Show summary of options.</para>
 101         </listitem>
 102       </varlistentry>
 103       <varlistentry>
 104         <term><option>-v</option>
 105           <option>--version</option>
 106         </term>
 107         <listitem>
 108           <para>Show version of program.</para>
 109         </listitem>
 110       </varlistentry>
 111     </variablelist>
 112   </refsect1>
 113   <refsect1>
 114     <title>SEE ALSO</title>
 115
 116     <para>bar (1), baz (1).</para>
 117
 118     <para>The programs are documented fully by <citetitle>The Rise and
 119       Fall of a Fooish Bar</citetitle> available via the
 120       <application>Info</application> system.</para>
 121   </refsect1>
 122   <refsect1>
 123     <title>AUTHOR</title>
 124
 125     <para>This manual page was written by &dhusername; &dhemail; for
 126       the &debian; system (but may be used by others).  Permission is
 127       granted to copy, distribute and/or modify this document under
 128       the terms of the &gnu; General Public License, Version 2 any
 129           later version published by the Free Software Foundation.
 130     </para>
 131         <para>
 132           On Debian systems, the complete text of the GNU General Public
 133           License can be found in /usr/share/common-licenses/GPL.
 134         </para>
 135
 136   </refsect1>
 137 </refentry>
 138
 139 <!-- Keep this comment at the end of the file
 140 Local variables:
 141 mode: sgml
 142 sgml-omittag:t
 143 sgml-shorttag:t
 144 sgml-minimize-attributes:nil
 145 sgml-always-quote-attributes:t
 146 sgml-indent-step:2
 147 sgml-indent-data:t
 148 sgml-parent-document:nil
 149 sgml-default-dtd-file:nil
 150 sgml-exposed-tags:nil
 151 sgml-local-catalogs:nil
 152 sgml-local-ecat-files:nil
 153 End:
 154 -->
 155
 156