filename | debian/manpage.xml.ex |
changeset | 519:ef9a7f176401 |
author | nkeynes |
date | Tue Sep 09 00:51:43 2008 +0000 (15 years ago) |
permissions | -rw-r--r-- |
last change | Add general gl_window_to_system_coords function to convert window system coordinates back into something in the DC range of 640x480, update mouse events to use it |
file | annotate | diff | log | raw |
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +00001.2 +++ b/debian/manpage.xml.ex Tue Sep 09 00:51:43 2008 +00001.3 @@ -0,0 +1,144 @@1.4 +<?xml version='1.0' encoding='ISO-8859-1'?>1.5 +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"1.6 +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [1.7 +1.8 +<!--1.9 +1.10 +Process this file with an XSLT processor: `xsltproc \1.11 +-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\1.12 +manpages/docbook.xsl manpage.dbk'. A manual page1.13 +<package>.<section> will be generated. You may view the1.14 +manual page with: nroff -man <package>.<section> | less'. A1.15 +typical entry in a Makefile or Makefile.am is:1.16 +1.17 +DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\1.18 +manpages/docbook.xsl1.19 +XP=xsltproc -''-nonet1.20 +1.21 +manpage.1: manpage.dbk1.22 + $(XP) $(DB2MAN) $<1.23 +1.24 +The xsltproc binary is found in the xsltproc package. The1.25 +XSL files are in docbook-xsl. Please remember that if you1.26 +create the nroff version in one of the debian/rules file1.27 +targets (such as build), you will need to include xsltproc1.28 +and docbook-xsl in your Build-Depends control field.1.29 +1.30 +-->1.31 +1.32 + <!-- Fill in your name for FIRSTNAME and SURNAME. -->1.33 + <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">1.34 + <!ENTITY dhsurname "<surname>SURNAME</surname>">1.35 + <!-- Please adjust the date whenever revising the manpage. -->1.36 + <!ENTITY dhdate "<date>November 15, 2007</date>">1.37 + <!-- SECTION should be 1-8, maybe w/ subsection other parameters are1.38 + allowed: see man(7), man(1). -->1.39 + <!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">1.40 + <!ENTITY dhemail "<email>nkeynes@lxdream.org</email>">1.41 + <!ENTITY dhusername "Nathan Keynes">1.42 + <!ENTITY dhucpackage "<refentrytitle>LXDREAM</refentrytitle>">1.43 + <!ENTITY dhpackage "lxdream">1.44 +1.45 + <!ENTITY debian "<productname>Debian</productname>">1.46 + <!ENTITY gnu "<acronym>GNU</acronym>">1.47 + <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">1.48 +]>1.49 +1.50 +<refentry>1.51 + <refentryinfo>1.52 + <address>1.53 + &dhemail;1.54 + </address>1.55 + <copyright>1.56 + <year>2007</year>1.57 + <holder>&dhusername;</holder>1.58 + </copyright>1.59 + &dhdate;1.60 + </refentryinfo>1.61 + <refmeta>1.62 + &dhucpackage;1.63 +1.64 + &dhsection;1.65 + </refmeta>1.66 + <refnamediv>1.67 + <refname>&dhpackage;</refname>1.68 +1.69 + <refpurpose>program to do something</refpurpose>1.70 + </refnamediv>1.71 + <refsynopsisdiv>1.72 + <cmdsynopsis>1.73 + <command>&dhpackage;</command>1.74 +1.75 + <arg><option>-e <replaceable>this</replaceable></option></arg>1.76 +1.77 + <arg><option>--example <replaceable>that</replaceable></option></arg>1.78 + </cmdsynopsis>1.79 + </refsynopsisdiv>1.80 + <refsect1>1.81 + <title>DESCRIPTION</title>1.82 +1.83 + <para>This manual page documents briefly the1.84 + <command>&dhpackage;</command> and <command>bar</command>1.85 + commands.</para>1.86 +1.87 + <para>This manual page was written for the &debian; distribution1.88 + because the original program does not have a manual page.1.89 + Instead, it has documentation in the &gnu;1.90 + <application>Info</application> format; see below.</para>1.91 +1.92 + <para><command>&dhpackage;</command> is a program that...</para>1.93 +1.94 + </refsect1>1.95 + <refsect1>1.96 + <title>OPTIONS</title>1.97 +1.98 + <para>These programs follow the usual &gnu; command line syntax,1.99 + with long options starting with two dashes (`-'). A summary of1.100 + options is included below. For a complete description, see the1.101 + <application>Info</application> files.</para>1.102 +1.103 + <variablelist>1.104 + <varlistentry>1.105 + <term><option>-h</option>1.106 + <option>--help</option>1.107 + </term>1.108 + <listitem>1.109 + <para>Show summary of options.</para>1.110 + </listitem>1.111 + </varlistentry>1.112 + <varlistentry>1.113 + <term><option>-v</option>1.114 + <option>--version</option>1.115 + </term>1.116 + <listitem>1.117 + <para>Show version of program.</para>1.118 + </listitem>1.119 + </varlistentry>1.120 + </variablelist>1.121 + </refsect1>1.122 + <refsect1>1.123 + <title>SEE ALSO</title>1.124 +1.125 + <para>bar (1), baz (1).</para>1.126 +1.127 + <para>The programs are documented fully by <citetitle>The Rise and1.128 + Fall of a Fooish Bar</citetitle> available via the1.129 + <application>Info</application> system.</para>1.130 + </refsect1>1.131 + <refsect1>1.132 + <title>AUTHOR</title>1.133 +1.134 + <para>This manual page was written by &dhusername; &dhemail; for1.135 + the &debian; system (but may be used by others). Permission is1.136 + granted to copy, distribute and/or modify this document under1.137 + the terms of the &gnu; General Public License, Version 2 any1.138 + later version published by the Free Software Foundation.1.139 + </para>1.140 + <para>1.141 + On Debian systems, the complete text of the GNU General Public1.142 + License can be found in /usr/share/common-licenses/GPL.1.143 + </para>1.144 +1.145 + </refsect1>1.146 +</refentry>1.147 +
.