Search
lxdream.org :: lxdream/debian/manpage.sgml.ex
lxdream 0.9.1
released Jun 29
Download Now
filename debian/manpage.sgml.ex
changeset 519:ef9a7f176401
author nkeynes
date Sat Jun 14 11:54:15 2008 +0000 (15 years ago)
permissions -rw-r--r--
last change Change colour params to float
Convert background processing over to scene structure (fixes some depth issues as well)
Add color unclamp when supported
file annotate diff log raw
nkeynes@519
     1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
nkeynes@519
     2
nkeynes@519
     3
<!-- Process this file with docbook-to-man to generate an nroff manual
nkeynes@519
     4
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
nkeynes@519
     5
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
nkeynes@519
     6
     less'.  A typical entry in a Makefile or Makefile.am is:
nkeynes@519
     7
nkeynes@519
     8
manpage.1: manpage.sgml
nkeynes@519
     9
	docbook-to-man $< > $@
nkeynes@519
    10
nkeynes@519
    11
    
nkeynes@519
    12
	The docbook-to-man binary is found in the docbook-to-man package.
nkeynes@519
    13
	Please remember that if you create the nroff version in one of the
nkeynes@519
    14
	debian/rules file targets (such as build), you will need to include
nkeynes@519
    15
	docbook-to-man in your Build-Depends control field.
nkeynes@519
    16
nkeynes@519
    17
  -->
nkeynes@519
    18
nkeynes@519
    19
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
nkeynes@519
    20
  <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
nkeynes@519
    21
  <!ENTITY dhsurname   "<surname>SURNAME</surname>">
nkeynes@519
    22
  <!-- Please adjust the date whenever revising the manpage. -->
nkeynes@519
    23
  <!ENTITY dhdate      "<date>November 15, 2007</date>">
nkeynes@519
    24
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
nkeynes@519
    25
       allowed: see man(7), man(1). -->
nkeynes@519
    26
  <!ENTITY dhsection   "<manvolnum>SECTION</manvolnum>">
nkeynes@519
    27
  <!ENTITY dhemail     "<email>nkeynes@lxdream.org</email>">
nkeynes@519
    28
  <!ENTITY dhusername  "Nathan Keynes">
nkeynes@519
    29
  <!ENTITY dhucpackage "<refentrytitle>LXDREAM</refentrytitle>">
nkeynes@519
    30
  <!ENTITY dhpackage   "lxdream">
nkeynes@519
    31
nkeynes@519
    32
  <!ENTITY debian      "<productname>Debian</productname>">
nkeynes@519
    33
  <!ENTITY gnu         "<acronym>GNU</acronym>">
nkeynes@519
    34
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
nkeynes@519
    35
]>
nkeynes@519
    36
nkeynes@519
    37
<refentry>
nkeynes@519
    38
  <refentryinfo>
nkeynes@519
    39
    <address>
nkeynes@519
    40
      &dhemail;
nkeynes@519
    41
    </address>
nkeynes@519
    42
    <author>
nkeynes@519
    43
      &dhfirstname;
nkeynes@519
    44
      &dhsurname;
nkeynes@519
    45
    </author>
nkeynes@519
    46
    <copyright>
nkeynes@519
    47
      <year>2003</year>
nkeynes@519
    48
      <holder>&dhusername;</holder>
nkeynes@519
    49
    </copyright>
nkeynes@519
    50
    &dhdate;
nkeynes@519
    51
  </refentryinfo>
nkeynes@519
    52
  <refmeta>
nkeynes@519
    53
    &dhucpackage;
nkeynes@519
    54
nkeynes@519
    55
    &dhsection;
nkeynes@519
    56
  </refmeta>
nkeynes@519
    57
  <refnamediv>
nkeynes@519
    58
    <refname>&dhpackage;</refname>
nkeynes@519
    59
nkeynes@519
    60
    <refpurpose>program to do something</refpurpose>
nkeynes@519
    61
  </refnamediv>
nkeynes@519
    62
  <refsynopsisdiv>
nkeynes@519
    63
    <cmdsynopsis>
nkeynes@519
    64
      <command>&dhpackage;</command>
nkeynes@519
    65
nkeynes@519
    66
      <arg><option>-e <replaceable>this</replaceable></option></arg>
nkeynes@519
    67
nkeynes@519
    68
      <arg><option>--example <replaceable>that</replaceable></option></arg>
nkeynes@519
    69
    </cmdsynopsis>
nkeynes@519
    70
  </refsynopsisdiv>
nkeynes@519
    71
  <refsect1>
nkeynes@519
    72
    <title>DESCRIPTION</title>
nkeynes@519
    73
nkeynes@519
    74
    <para>This manual page documents briefly the
nkeynes@519
    75
      <command>&dhpackage;</command> and <command>bar</command>
nkeynes@519
    76
      commands.</para>
nkeynes@519
    77
nkeynes@519
    78
    <para>This manual page was written for the &debian; distribution
nkeynes@519
    79
      because the original program does not have a manual page.
nkeynes@519
    80
      Instead, it has documentation in the &gnu;
nkeynes@519
    81
      <application>Info</application> format; see below.</para>
nkeynes@519
    82
nkeynes@519
    83
    <para><command>&dhpackage;</command> is a program that...</para>
nkeynes@519
    84
nkeynes@519
    85
  </refsect1>
nkeynes@519
    86
  <refsect1>
nkeynes@519
    87
    <title>OPTIONS</title>
nkeynes@519
    88
nkeynes@519
    89
    <para>These programs follow the usual &gnu; command line syntax,
nkeynes@519
    90
      with long options starting with two dashes (`-').  A summary of
nkeynes@519
    91
      options is included below.  For a complete description, see the
nkeynes@519
    92
      <application>Info</application> files.</para>
nkeynes@519
    93
nkeynes@519
    94
    <variablelist>
nkeynes@519
    95
      <varlistentry>
nkeynes@519
    96
        <term><option>-h</option>
nkeynes@519
    97
          <option>--help</option>
nkeynes@519
    98
        </term>
nkeynes@519
    99
        <listitem>
nkeynes@519
   100
          <para>Show summary of options.</para>
nkeynes@519
   101
        </listitem>
nkeynes@519
   102
      </varlistentry>
nkeynes@519
   103
      <varlistentry>
nkeynes@519
   104
        <term><option>-v</option>
nkeynes@519
   105
          <option>--version</option>
nkeynes@519
   106
        </term>
nkeynes@519
   107
        <listitem>
nkeynes@519
   108
          <para>Show version of program.</para>
nkeynes@519
   109
        </listitem>
nkeynes@519
   110
      </varlistentry>
nkeynes@519
   111
    </variablelist>
nkeynes@519
   112
  </refsect1>
nkeynes@519
   113
  <refsect1>
nkeynes@519
   114
    <title>SEE ALSO</title>
nkeynes@519
   115
nkeynes@519
   116
    <para>bar (1), baz (1).</para>
nkeynes@519
   117
nkeynes@519
   118
    <para>The programs are documented fully by <citetitle>The Rise and
nkeynes@519
   119
      Fall of a Fooish Bar</citetitle> available via the
nkeynes@519
   120
      <application>Info</application> system.</para>
nkeynes@519
   121
  </refsect1>
nkeynes@519
   122
  <refsect1>
nkeynes@519
   123
    <title>AUTHOR</title>
nkeynes@519
   124
nkeynes@519
   125
    <para>This manual page was written by &dhusername; &dhemail; for
nkeynes@519
   126
      the &debian; system (but may be used by others).  Permission is
nkeynes@519
   127
      granted to copy, distribute and/or modify this document under
nkeynes@519
   128
      the terms of the &gnu; General Public License, Version 2 any 
nkeynes@519
   129
	  later version published by the Free Software Foundation.
nkeynes@519
   130
    </para>
nkeynes@519
   131
	<para>
nkeynes@519
   132
	  On Debian systems, the complete text of the GNU General Public
nkeynes@519
   133
	  License can be found in /usr/share/common-licenses/GPL.
nkeynes@519
   134
	</para>
nkeynes@519
   135
nkeynes@519
   136
  </refsect1>
nkeynes@519
   137
</refentry>
nkeynes@519
   138
nkeynes@519
   139
<!-- Keep this comment at the end of the file
nkeynes@519
   140
Local variables:
nkeynes@519
   141
mode: sgml
nkeynes@519
   142
sgml-omittag:t
nkeynes@519
   143
sgml-shorttag:t
nkeynes@519
   144
sgml-minimize-attributes:nil
nkeynes@519
   145
sgml-always-quote-attributes:t
nkeynes@519
   146
sgml-indent-step:2
nkeynes@519
   147
sgml-indent-data:t
nkeynes@519
   148
sgml-parent-document:nil
nkeynes@519
   149
sgml-default-dtd-file:nil
nkeynes@519
   150
sgml-exposed-tags:nil
nkeynes@519
   151
sgml-local-catalogs:nil
nkeynes@519
   152
sgml-local-ecat-files:nil
nkeynes@519
   153
End:
nkeynes@519
   154
-->
nkeynes@519
   155
nkeynes@519
   156
.