Search
lxdream.org :: lxdream/debian/manpage.xml.ex
lxdream 0.9.1
released Jun 29
Download Now
filename debian/manpage.xml.ex
changeset 519:ef9a7f176401
author nkeynes
date Wed Jul 30 03:00:40 2008 +0000 (11 years ago)
permissions -rw-r--r--
last change Add debian changelog file
view annotate diff log raw
     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" [
     5 <!--
     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:
    14 DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
    15 manpages/docbook.xsl
    16 XP=xsltproc -''-nonet
    18 manpage.1: manpage.dbk
    19         $(XP) $(DB2MAN) $<
    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.
    27 -->
    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>November 15, 2007</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>nkeynes@lxdream.org</email>">
    38   <!ENTITY dhusername  "Nathan Keynes">
    39   <!ENTITY dhucpackage "<refentrytitle>LXDREAM</refentrytitle>">
    40   <!ENTITY dhpackage   "lxdream">
    42   <!ENTITY debian      "<productname>Debian</productname>">
    43   <!ENTITY gnu         "<acronym>GNU</acronym>">
    44   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
    45 ]>
    47 <refentry>
    48   <refentryinfo>
    49     <address>
    50       &dhemail;
    51     </address>
    52     <copyright>
    53       <year>2007</year>
    54       <holder>&dhusername;</holder>
    55     </copyright>
    56     &dhdate;
    57   </refentryinfo>
    58   <refmeta>
    59     &dhucpackage;
    61     &dhsection;
    62   </refmeta>
    63   <refnamediv>
    64     <refname>&dhpackage;</refname>
    66     <refpurpose>program to do something</refpurpose>
    67   </refnamediv>
    68   <refsynopsisdiv>
    69     <cmdsynopsis>
    70       <command>&dhpackage;</command>
    72       <arg><option>-e <replaceable>this</replaceable></option></arg>
    74       <arg><option>--example <replaceable>that</replaceable></option></arg>
    75     </cmdsynopsis>
    76   </refsynopsisdiv>
    77   <refsect1>
    78     <title>DESCRIPTION</title>
    80     <para>This manual page documents briefly the
    81       <command>&dhpackage;</command> and <command>bar</command>
    82       commands.</para>
    84     <para>This manual page was written for the &debian; distribution
    85       because the original program does not have a manual page.
    86       Instead, it has documentation in the &gnu;
    87       <application>Info</application> format; see below.</para>
    89     <para><command>&dhpackage;</command> is a program that...</para>
    91   </refsect1>
    92   <refsect1>
    93     <title>OPTIONS</title>
    95     <para>These programs follow the usual &gnu; command line syntax,
    96       with long options starting with two dashes (`-').  A summary of
    97       options is included below.  For a complete description, see the
    98       <application>Info</application> files.</para>
   100     <variablelist>
   101       <varlistentry>
   102         <term><option>-h</option>
   103           <option>--help</option>
   104         </term>
   105         <listitem>
   106           <para>Show summary of options.</para>
   107         </listitem>
   108       </varlistentry>
   109       <varlistentry>
   110         <term><option>-v</option>
   111           <option>--version</option>
   112         </term>
   113         <listitem>
   114           <para>Show version of program.</para>
   115         </listitem>
   116       </varlistentry>
   117     </variablelist>
   118   </refsect1>
   119   <refsect1>
   120     <title>SEE ALSO</title>
   122     <para>bar (1), baz (1).</para>
   124     <para>The programs are documented fully by <citetitle>The Rise and
   125       Fall of a Fooish Bar</citetitle> available via the
   126       <application>Info</application> system.</para>
   127   </refsect1>
   128   <refsect1>
   129     <title>AUTHOR</title>
   131     <para>This manual page was written by &dhusername; &dhemail; for
   132       the &debian; system (but may be used by others).  Permission is
   133       granted to copy, distribute and/or modify this document under
   134       the terms of the &gnu; General Public License, Version 2 any 
   135 	  later version published by the Free Software Foundation.
   136     </para>
   137 	<para>
   138 	  On Debian systems, the complete text of the GNU General Public
   139 	  License can be found in /usr/share/common-licenses/GPL.
   140 	</para>
   142   </refsect1>
   143 </refentry>
.