Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/dockingsystem2/contrib/orxonox.manpage.xml @ 9018

Last change on this file since 9018 was 8093, checked in by adrfried, 14 years ago

add desktop-file, icon and manpage

File size: 9.7 KB
Line 
1<?xml version='1.0' encoding='UTF-8'?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
5<!--
6
7`xsltproc -''-nonet \
8          -''-param man.charmap.use.subset "0" \
9          -''-param make.year.ranges "1" \
10          -''-param make.single.year.ranges "1" \
11          /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
12          manpage.xml'
13
14A manual page <package>.<section> will be generated. You may view the
15manual page with: nroff -man <package>.<section> | less'. A typical entry
16in a Makefile or Makefile.am is:
17
18DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
19XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
20
21manpage.1: manpage.xml
22        $(XP) $(DB2MAN) $<
23
24The xsltproc binary is found in the xsltproc package. The XSL files are in
25docbook-xsl. A description of the parameters you can use can be found in the
26docbook-xsl-doc-* packages. Please remember that if you create the nroff
27version in one of the debian/rules file targets (such as build), you will need
28to include xsltproc and docbook-xsl in your Build-Depends control field.
29Alternatively use the xmlto command/package. That will also automatically
30pull in xsltproc and docbook-xsl.
31
32Notes for using docbook2x: docbook2x-man does not automatically create the
33AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
34<refsect1> ... </refsect1>.
35
36To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
37read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
38found in the docbook-xsl-doc-html package.
39
40Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
41
42General documentation about man-pages and man-page-formatting:
43man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
44
45-->
46
47  <!ENTITY dhfirstname "Adrian">
48  <!ENTITY dhsurname   "Friedli">
49  <!ENTITY dhusername  "&dhfirstname; &dhsurname;">
50  <!ENTITY dhemail     "adi@koalatux.ch">
51  <!ENTITY dhsection   "6">
52  <!ENTITY dhtitle     "orxonox Gamer Manual">
53  <!ENTITY dhucpackage "ORXONOX">
54  <!ENTITY dhpackage   "orxonox">
55]>
56
57<refentry>
58  <refentryinfo>
59    <title>&dhtitle;</title>
60    <productname>&dhpackage;</productname>
61    <authorgroup>
62      <author>
63       <firstname>&dhfirstname;</firstname>
64        <surname>&dhsurname;</surname>
65        <contrib>Wrote this manpage for the Debian system.</contrib>
66        <address>
67          <email>&dhemail;</email>
68        </address>
69      </author>
70    </authorgroup>
71    <copyright>
72      <year>2010</year>
73      <holder>&dhusername;</holder>
74    </copyright>
75    <legalnotice>
76      <para>This manual page was written for the Debian system
77        (and may be used by others).</para>
78      <para>Permission is granted to copy, distribute and/or modify this
79        document under the terms of the GNU General Public License,
80        Version 2 or (at your option) any later version published by
81        the Free Software Foundation.</para>
82      <para>On Debian systems, the complete text of the GNU General Public
83        License can be found in
84        <filename>/usr/share/common-licenses/GPL-2</filename>.</para>
85    </legalnotice>
86  </refentryinfo>
87  <refmeta>
88    <refentrytitle>&dhucpackage;</refentrytitle>
89    <manvolnum>&dhsection;</manvolnum>
90  </refmeta>
91  <refnamediv>
92    <refname>&dhpackage;</refname>
93    <refpurpose>a spacecraft shooter</refpurpose>
94  </refnamediv>
95  <refsynopsisdiv>
96    <cmdsynopsis>
97      <command>&dhpackage;</command>
98      <arg choice="opt"><replaceable class="option">options</replaceable></arg>
99    </cmdsynopsis>
100    <cmdsynopsis>
101      <command>&dhpackage;</command>
102      <arg choice="plain"><option>--standalone</option></arg>
103      <arg choice="opt">
104        <group choice="req">
105          <arg choice="plain"><option>-l</option></arg>
106          <arg choice="plain"><option>--level</option></arg>
107        </group>
108        <arg choice="plain"><replaceable>file</replaceable></arg>
109      </arg>
110    </cmdsynopsis>
111    <cmdsynopsis>
112      <command>&dhpackage;</command>
113      <arg choice="plain"><option>--client</option></arg>
114      <arg choice="opt"><option>--dest <replaceable>address</replaceable></option></arg>
115      <arg choice="opt">
116        <group choice="req">
117          <arg choice="plain"><option>-p</option></arg>
118          <arg choice="plain"><option>--port</option></arg>
119        </group>
120        <arg choice="plain"><replaceable>port</replaceable></arg>
121      </arg>
122    </cmdsynopsis>
123    <cmdsynopsis>
124      <command>&dhpackage;</command>
125      <group choice="req">
126        <arg choice="plain"><option>--dedicated</option></arg>
127        <arg choice="plain"><option>--server</option></arg>
128      </group>
129      <arg choice="opt">
130        <group choice="req">
131          <arg choice="plain"><option>-p</option></arg>
132          <arg choice="plain"><option>--port</option></arg>
133        </group>
134        <arg choice="plain"><replaceable>port</replaceable></arg>
135      </arg>
136      <arg choice="opt">
137        <group choice="req">
138          <arg choice="plain"><option>-l</option></arg>
139          <arg choice="plain"><option>--level</option></arg>
140        </group>
141        <arg choice="plain"><replaceable>file</replaceable></arg>
142      </arg>
143    </cmdsynopsis>
144  </refsynopsisdiv>
145  <refsect1 id="description">
146    <title>DESCRIPTION</title>
147    <para>This manual page documents briefly the
148      <command>&dhpackage;</command> command.</para>
149    <para><command>&dhpackage;</command> is a spacecraft shooter that plays in
150      the post-apocalyptic world of our future. Humanity struggles to survive
151      under the threat of wars, economic and ecological disasters. A lot of
152      people search for their luck in the vast space of the solar system. But
153      the human race faces extinction when they realize they are not alone in
154      the galaxy. The Noxons, an evil alien species, believes the human race
155      must be destroyed to free themselves from their cruel god Nox.</para>
156  </refsect1>
157  <refsect1 id="options">
158    <title>OPTIONS</title>
159    <variablelist>
160      <varlistentry>
161        <term><option>--client</option></term>
162        <listitem>
163          <para>Start in client mode.</para>
164        </listitem>
165      </varlistentry>
166      <varlistentry>
167        <term><option>--console</option></term>
168        <listitem>
169          <para>Start in console mode (text IO only).</para>
170        </listitem>
171      </varlistentry>
172      <varlistentry>
173        <term><option>--dedicated</option></term>
174        <listitem>
175          <para>Start in dedicated server mode.</para>
176        </listitem>
177      </varlistentry>
178      <varlistentry>
179        <term><option>--externalDataPath <replaceable>path</replaceable></option></term>
180        <listitem>
181          <para>Path to the external data files.</para>
182        </listitem>
183      </varlistentry>
184      <varlistentry>
185          <term><option>--dest <replaceable>address</replaceable></option></term>
186        <listitem>
187          <para>Server hostname/IP (IP in the form of #.#.#.#).</para>
188        </listitem>
189      </varlistentry>
190      <varlistentry>
191        <term><option>--keyboard_no_grab</option></term>
192        <listitem>
193          <para>Whether not to exclusively grab the keyboard.</para>
194        </listitem>
195      </varlistentry>
196      <varlistentry>
197        <term><option>-l <replaceable>file</replaceable></option></term>
198        <term><option>--level <replaceable>file</replaceable></option></term>
199        <listitem>
200          <para>Default level file (overrides LevelManager::defaultLevelName_ configValue).</para>
201        </listitem>
202      </varlistentry>
203      <varlistentry>
204        <term><option>--noIOConsole</option></term>
205        <listitem>
206          <para>Use this if you don't want to use the IOConsole (for instance for Lua debugging).</para>
207        </listitem>
208      </varlistentry>
209      <varlistentry>
210        <term><option>-p <replaceable>port</replaceable></option></term>
211        <term><option>--port <replaceable>port</replaceable></option></term>
212        <listitem>
213          <para>Network communication port to be used 0-65535 (default: 55556).</para>
214        </listitem>
215      </varlistentry>
216      <varlistentry>
217        <term><option>--server</option></term>
218        <listitem>
219          <para>Start in server mode.</para>
220        </listitem>
221      </varlistentry>
222      <varlistentry>
223        <term><option>--settingsFile <replaceable>file</replaceable></option></term>
224        <listitem>
225          <para>THE configuration file.</para>
226        </listitem>
227      </varlistentry>
228      <varlistentry>
229        <term><option>--standalone</option></term>
230        <listitem>
231          <para>Start in standalone mode.</para>
232        </listitem>
233      </varlistentry>
234      <varlistentry>
235        <term><option>--writingPathSuffix <replaceable>suffix</replaceable></option></term>
236        <listitem>
237          <para>Additional subfolder for config and log files.</para>
238        </listitem>
239      </varlistentry>
240    </variablelist>
241  </refsect1>
242  <refsect1 id="files">
243    <title>FILES</title>
244    <variablelist>
245      <varlistentry>
246        <term><filename>${HOME}/.orxonox/config/</filename></term>
247        <listitem>
248          <para>Per-user configuration files to control the
249            behaviour of <application>&dhpackage;</application>.</para>
250        </listitem>
251      </varlistentry>
252      <varlistentry>
253        <term><filename>${HOME}/.orxonox/log/</filename></term>
254        <listitem>
255          <para>Log files of <application>&dhpackage;</application>.</para>
256        </listitem>
257      </varlistentry>
258    </variablelist>
259  </refsect1>
260  <refsect1 id="bugs">
261    <title>BUGS</title>
262    <para>The upstreams "<acronym>BTS</acronym>" can be found
263      at <ulink url="http://forum.orxonox.net/viewforum.php?f=6"/>.</para>
264  </refsect1>
265</refentry>
Note: See TracBrowser for help on using the repository browser.