File: out-of-order.6.xml

package info (click to toggle)
out-of-order 1.0-3
  • links: PTS, VCS
  • area: non-free
  • in suites: bookworm, bullseye, sid
  • size: 20,728 kB
  • sloc: xml: 194; makefile: 12; sh: 5
file content (256 lines) | stat: -rw-r--r-- 9,644 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!--

`xsltproc -''-nonet \
          -''-param man.charmap.use.subset "0" \
          -''-param make.year.ranges "1" \
          -''-param make.single.year.ranges "1" \
          /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
          manpage.xml'

A manual page <package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A typical entry
in a Makefile or Makefile.am is:

DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"

manpage.1: manpage.xml
        $(XP) $(DB2MAN) $<

The xsltproc binary is found in the xsltproc package. The XSL files are in
docbook-xsl. A description of the parameters you can use can be found in the
docbook-xsl-doc-* packages. Please remember that if you create the nroff
version in one of the debian/rules file targets (such as build), you will need
to include xsltproc and docbook-xsl in your Build-Depends control field.
Alternatively use the xmlto command/package. That will also automatically
pull in xsltproc and docbook-xsl.

Notes for using docbook2x: docbook2x-man does not automatically create the
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
<refsect1> ... </refsect1>.

To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
found in the docbook-xsl-doc-html package.

Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`

General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/

-->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "Tobias">
  <!ENTITY dhsurname   "Hansen">
  <!-- dhusername could also be set to "&firstname; &surname;". -->
  <!ENTITY dhusername  "Tobias Hansen">
  <!ENTITY dhemail     "tobias.han@gmx.de">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1) and
       http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
  <!ENTITY dhsection   "6">
  <!-- TITLE should be something like "User commands" or similar (see
       http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
  <!ENTITY dhtitle     "Out Of Order User Manual">
  <!ENTITY dhucpackage "Out Of Order">
  <!ENTITY dhpackage   "out-of-order">
]>

<refentry>
  <refentryinfo>
    <title>&dhtitle;</title>
    <productname>&dhpackage;</productname>
    <authorgroup>
      <author>
       <firstname>&dhfirstname;</firstname>
        <surname>&dhsurname;</surname>
        <contrib>Wrote this manpage for the Debian system.</contrib>
        <address>
          <email>&dhemail;</email>
        </address>
      </author>
    </authorgroup>
    <copyright>
      <year>2011</year>
      <holder>&dhusername;</holder>
    </copyright>
    <legalnotice>
      <para>This manual page was written for the Debian system
        (and may be used by others).</para>
      <para>Permission is granted to copy, distribute and/or modify this
        document under the terms of the GNU General Public License,
        Version 3 or (at your option) any later version published by
        the Free Software Foundation.</para>
      <para>On Debian systems, the complete text of the GNU General Public
        License can be found in
        <filename>/usr/share/common-licenses/GPL-3</filename>.</para>
    </legalnotice>
  </refentryinfo>
  <refmeta>
    <refentrytitle>&dhucpackage;</refentrytitle>
    <manvolnum>&dhsection;</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>comedy science fiction adventure game</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <!-- These are several examples, how syntaxes could look -->
      <group choice="opt">
        <arg choice="plain"><option>-f</option></arg>
        <arg choice="plain"><option>--fullscreen</option></arg>
        <arg choice="plain"><option>-w</option></arg>
        <arg choice="plain"><option>--window</option></arg>
      </group>

      <arg choice="opt">
        <group choice="req">
          <arg choice="plain"><option>-l</option></arg>
          <arg choice="plain"><option>--language=</option></arg>
        </group>
        <replaceable class="option">number</replaceable>
      </arg>

      <arg choice="opt">
        <group choice="req">
          <arg choice="plain"><option>-a</option></arg>
          <arg choice="plain"><option>--antialias=</option></arg>
        </group>
        <group choice="req">
          <arg choice="plain"><option>-1</option></arg>
          <arg choice="plain"><option>0</option></arg>
          <arg choice="plain"><option>1</option></arg>
        </group>
      </arg>

      <arg choice="opt">
        <group choice="req">
          <arg choice="plain"><option>-d</option></arg>
          <arg choice="plain"><option>--debug=</option></arg>
        </group>
        <group choice="req">
          <arg choice="plain"><option>0</option></arg>
          <arg choice="plain"><option>1</option></arg>
        </group>
      </arg>

      <group choice="opt">
        <arg choice="plain"><option>-h</option></arg>
        <arg choice="plain"><option>--help</option></arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>
    <para>This manual page was written for the Debian distribution
      because the original program does not have a manual page.
      Instead, it has documentation in the html format; see below.</para>
  </refsect1>
  <refsect1 id="options">
    <title>OPTIONS</title>
    <para>The program follows the usual GNU command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>
    <variablelist>
      <!-- Use the variablelist.term.separator and the
           variablelist.term.break.after parameters to
           control the term elements. -->
      <varlistentry>
        <term><option>-f</option></term>
        <term><option>--fullscreen</option></term>
        <listitem>
          <para>Set display mode to fullscreen.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w</option></term>
        <term><option>--window</option></term>
        <listitem>
          <para>Set display mode to windowed.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l <replaceable>number</replaceable></option></term>
        <term><option>--language=<replaceable>number</replaceable></option></term>
        <listitem>
          <para>Set language to <replaceable>number</replaceable> (>=0).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-a <replaceable>number</replaceable></option></term>
        <term><option>--antialias=<replaceable>number</replaceable></option></term>
        <listitem>
          <para>Turn antialiasing on (<replaceable>1</replaceable>) or off (<replaceable>0</replaceable>)
                or choose linear interpolation (<replaceable>-1</replaceable>).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d <replaceable>number</replaceable></option></term>
        <term><option>--debug=<replaceable>number</replaceable></option></term>
        <listitem>
          <para>Turn debug mode on (<replaceable>1</replaceable>) or off (<replaceable>0</replaceable>).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>Print help message.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="keyboard_shortcuts">
    <title>KEYBOARD SHORTCUTS</title>
    <para>Keyboard shortcuts allow changing some options at any time.</para>
    <variablelist>
      <varlistentry>
        <term>Alt+Enter</term>
        <listitem>
          <para>Toggle between fullscreen and windowed mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Alt+A</term>
        <listitem>
          <para>Toggle antialiasing on or off.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="files">
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><filename>${HOME}/.sludge-engine/Out Of Order</filename></term>
        <listitem>
          <para>Configuration and saved games are stored here.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="bugs">
    <!-- Or use this section to tell about upstream BTS. -->
    <title>BUGS</title>
    <para>Please report bugs in the SLUDGE forum at <ulink url="http://opensludge.sourceforge.net"/>.</para>
  </refsect1>
  <refsect1 id="see_also">
    <title>SEE ALSO</title>
    <!-- In alpabetical order. -->
    <para><citerefentry>
        <refentrytitle>sludge-engine</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry></para>
    <para>The Out Of Order documentation is accessed from the file <filename>/usr/share/doc/out-of-order/contents.html</filename>.</para>
  </refsect1>
</refentry>