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