debian/manpage.xml.ex
changeset 74 adf33377005c
parent 73 e2559ee78cb3
equal deleted inserted replaced
73:e2559ee78cb3 74:adf33377005c
     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>Januar  1, 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>heiko@schlittermann.de</email>">
       
    38   <!ENTITY dhusername  "Heiko Schlittermann">
       
    39   <!ENTITY dhucpackage "<refentrytitle>EXIGREY</refentrytitle>">
       
    40   <!ENTITY dhpackage   "exigrey">
       
    41 
       
    42   <!ENTITY debian      "<productname>Debian</productname>">
       
    43   <!ENTITY gnu         "<acronym>GNU</acronym>">
       
    44   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
       
    45 ]>
       
    46 
       
    47 <refentry>
       
    48   <refentryinfo>
       
    49     <address>
       
    50       &dhemail;
       
    51     </address>
       
    52     <author>
       
    53       &dhfirstname;
       
    54       &dhsurname;
       
    55     </author>
       
    56     <copyright>
       
    57       <year>2003</year>
       
    58       <holder>&dhusername;</holder>
       
    59     </copyright>
       
    60     &dhdate;
       
    61   </refentryinfo>
       
    62   <refmeta>
       
    63     &dhucpackage;
       
    64 
       
    65     &dhsection;
       
    66   </refmeta>
       
    67   <refnamediv>
       
    68     <refname>&dhpackage;</refname>
       
    69 
       
    70     <refpurpose>program to do something</refpurpose>
       
    71   </refnamediv>
       
    72   <refsynopsisdiv>
       
    73     <cmdsynopsis>
       
    74       <command>&dhpackage;</command>
       
    75 
       
    76       <arg><option>-e <replaceable>this</replaceable></option></arg>
       
    77 
       
    78       <arg><option>--example <replaceable>that</replaceable></option></arg>
       
    79     </cmdsynopsis>
       
    80   </refsynopsisdiv>
       
    81   <refsect1>
       
    82     <title>DESCRIPTION</title>
       
    83 
       
    84     <para>This manual page documents briefly the
       
    85       <command>&dhpackage;</command> and <command>bar</command>
       
    86       commands.</para>
       
    87 
       
    88     <para>This manual page was written for the &debian; distribution
       
    89       because the original program does not have a manual page.
       
    90       Instead, it has documentation in the &gnu;
       
    91       <application>Info</application> format; see below.</para>
       
    92 
       
    93     <para><command>&dhpackage;</command> is a program that...</para>
       
    94 
       
    95   </refsect1>
       
    96   <refsect1>
       
    97     <title>OPTIONS</title>
       
    98 
       
    99     <para>These programs follow the usual &gnu; command line syntax,
       
   100       with long options starting with two dashes (`-').  A summary of
       
   101       options is included below.  For a complete description, see the
       
   102       <application>Info</application> files.</para>
       
   103 
       
   104     <variablelist>
       
   105       <varlistentry>
       
   106         <term><option>-h</option>
       
   107           <option>--help</option>
       
   108         </term>
       
   109         <listitem>
       
   110           <para>Show summary of options.</para>
       
   111         </listitem>
       
   112       </varlistentry>
       
   113       <varlistentry>
       
   114         <term><option>-v</option>
       
   115           <option>--version</option>
       
   116         </term>
       
   117         <listitem>
       
   118           <para>Show version of program.</para>
       
   119         </listitem>
       
   120       </varlistentry>
       
   121     </variablelist>
       
   122   </refsect1>
       
   123   <refsect1>
       
   124     <title>SEE ALSO</title>
       
   125 
       
   126     <para>bar (1), baz (1).</para>
       
   127 
       
   128     <para>The programs are documented fully by <citetitle>The Rise and
       
   129       Fall of a Fooish Bar</citetitle> available via the
       
   130       <application>Info</application> system.</para>
       
   131   </refsect1>
       
   132   <refsect1>
       
   133     <title>AUTHOR</title>
       
   134 
       
   135     <para>This manual page was written by &dhusername; &dhemail; for
       
   136       the &debian; system (but may be used by others).  Permission is
       
   137       granted to copy, distribute and/or modify this document under
       
   138       the terms of the &gnu; General Public License, Version 2 any 
       
   139 	  later version published by the Free Software Foundation.
       
   140     </para>
       
   141 	<para>
       
   142 	  On Debian systems, the complete text of the GNU General Public
       
   143 	  License can be found in /usr/share/common-licenses/GPL.
       
   144 	</para>
       
   145 
       
   146   </refsect1>
       
   147 </refentry>
       
   148