Search
lxdream.org :: lxdream/debian/manpage.sgml.ex :: diff
lxdream 0.9.1
released Jun 29
Download Now
filename debian/manpage.sgml.ex
changeset 519:ef9a7f176401
author nkeynes
date Sun Jun 22 08:59:39 2008 +0000 (15 years ago)
permissions -rw-r--r--
last change Add a tidy summary at the end of the configure script
file annotate diff log raw
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/debian/manpage.sgml.ex Sun Jun 22 08:59:39 2008 +0000
1.3 @@ -0,0 +1,156 @@
1.4 +<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
1.5 +
1.6 +<!-- Process this file with docbook-to-man to generate an nroff manual
1.7 + page: `docbook-to-man manpage.sgml > manpage.1'. You may view
1.8 + the manual page with: `docbook-to-man manpage.sgml | nroff -man |
1.9 + less'. A typical entry in a Makefile or Makefile.am is:
1.10 +
1.11 +manpage.1: manpage.sgml
1.12 + docbook-to-man $< > $@
1.13 +
1.14 +
1.15 + The docbook-to-man binary is found in the docbook-to-man package.
1.16 + Please remember that if you create the nroff version in one of the
1.17 + debian/rules file targets (such as build), you will need to include
1.18 + docbook-to-man in your Build-Depends control field.
1.19 +
1.20 + -->
1.21 +
1.22 + <!-- Fill in your name for FIRSTNAME and SURNAME. -->
1.23 + <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
1.24 + <!ENTITY dhsurname "<surname>SURNAME</surname>">
1.25 + <!-- Please adjust the date whenever revising the manpage. -->
1.26 + <!ENTITY dhdate "<date>November 15, 2007</date>">
1.27 + <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
1.28 + allowed: see man(7), man(1). -->
1.29 + <!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">
1.30 + <!ENTITY dhemail "<email>nkeynes@lxdream.org</email>">
1.31 + <!ENTITY dhusername "Nathan Keynes">
1.32 + <!ENTITY dhucpackage "<refentrytitle>LXDREAM</refentrytitle>">
1.33 + <!ENTITY dhpackage "lxdream">
1.34 +
1.35 + <!ENTITY debian "<productname>Debian</productname>">
1.36 + <!ENTITY gnu "<acronym>GNU</acronym>">
1.37 + <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
1.38 +]>
1.39 +
1.40 +<refentry>
1.41 + <refentryinfo>
1.42 + <address>
1.43 + &dhemail;
1.44 + </address>
1.45 + <author>
1.46 + &dhfirstname;
1.47 + &dhsurname;
1.48 + </author>
1.49 + <copyright>
1.50 + <year>2003</year>
1.51 + <holder>&dhusername;</holder>
1.52 + </copyright>
1.53 + &dhdate;
1.54 + </refentryinfo>
1.55 + <refmeta>
1.56 + &dhucpackage;
1.57 +
1.58 + &dhsection;
1.59 + </refmeta>
1.60 + <refnamediv>
1.61 + <refname>&dhpackage;</refname>
1.62 +
1.63 + <refpurpose>program to do something</refpurpose>
1.64 + </refnamediv>
1.65 + <refsynopsisdiv>
1.66 + <cmdsynopsis>
1.67 + <command>&dhpackage;</command>
1.68 +
1.69 + <arg><option>-e <replaceable>this</replaceable></option></arg>
1.70 +
1.71 + <arg><option>--example <replaceable>that</replaceable></option></arg>
1.72 + </cmdsynopsis>
1.73 + </refsynopsisdiv>
1.74 + <refsect1>
1.75 + <title>DESCRIPTION</title>
1.76 +
1.77 + <para>This manual page documents briefly the
1.78 + <command>&dhpackage;</command> and <command>bar</command>
1.79 + commands.</para>
1.80 +
1.81 + <para>This manual page was written for the &debian; distribution
1.82 + because the original program does not have a manual page.
1.83 + Instead, it has documentation in the &gnu;
1.84 + <application>Info</application> format; see below.</para>
1.85 +
1.86 + <para><command>&dhpackage;</command> is a program that...</para>
1.87 +
1.88 + </refsect1>
1.89 + <refsect1>
1.90 + <title>OPTIONS</title>
1.91 +
1.92 + <para>These programs follow the usual &gnu; command line syntax,
1.93 + with long options starting with two dashes (`-'). A summary of
1.94 + options is included below. For a complete description, see the
1.95 + <application>Info</application> files.</para>
1.96 +
1.97 + <variablelist>
1.98 + <varlistentry>
1.99 + <term><option>-h</option>
1.100 + <option>--help</option>
1.101 + </term>
1.102 + <listitem>
1.103 + <para>Show summary of options.</para>
1.104 + </listitem>
1.105 + </varlistentry>
1.106 + <varlistentry>
1.107 + <term><option>-v</option>
1.108 + <option>--version</option>
1.109 + </term>
1.110 + <listitem>
1.111 + <para>Show version of program.</para>
1.112 + </listitem>
1.113 + </varlistentry>
1.114 + </variablelist>
1.115 + </refsect1>
1.116 + <refsect1>
1.117 + <title>SEE ALSO</title>
1.118 +
1.119 + <para>bar (1), baz (1).</para>
1.120 +
1.121 + <para>The programs are documented fully by <citetitle>The Rise and
1.122 + Fall of a Fooish Bar</citetitle> available via the
1.123 + <application>Info</application> system.</para>
1.124 + </refsect1>
1.125 + <refsect1>
1.126 + <title>AUTHOR</title>
1.127 +
1.128 + <para>This manual page was written by &dhusername; &dhemail; for
1.129 + the &debian; system (but may be used by others). Permission is
1.130 + granted to copy, distribute and/or modify this document under
1.131 + the terms of the &gnu; General Public License, Version 2 any
1.132 + later version published by the Free Software Foundation.
1.133 + </para>
1.134 + <para>
1.135 + On Debian systems, the complete text of the GNU General Public
1.136 + License can be found in /usr/share/common-licenses/GPL.
1.137 + </para>
1.138 +
1.139 + </refsect1>
1.140 +</refentry>
1.141 +
1.142 +<!-- Keep this comment at the end of the file
1.143 +Local variables:
1.144 +mode: sgml
1.145 +sgml-omittag:t
1.146 +sgml-shorttag:t
1.147 +sgml-minimize-attributes:nil
1.148 +sgml-always-quote-attributes:t
1.149 +sgml-indent-step:2
1.150 +sgml-indent-data:t
1.151 +sgml-parent-document:nil
1.152 +sgml-default-dtd-file:nil
1.153 +sgml-exposed-tags:nil
1.154 +sgml-local-catalogs:nil
1.155 +sgml-local-ecat-files:nil
1.156 +End:
1.157 +-->
1.158 +
1.159 +
.