Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/SuperOxoBros_FS17/contrib/orxonox.manpage.xml @ 11364

Last change on this file since 11364 was 8351, checked in by rgrieder, 9 years ago

Merged kicklib2 branch back to trunk (includes former branches ois_update, mac_osx and kicklib).

Notes for updating

Linux:
You don't need an extra package for CEGUILua and Tolua, it's already shipped with CEGUI.
However you do need to make sure that the OgreRenderer is installed too with CEGUI 0.7 (may be a separate package).
Also, Orxonox now recognises if you install the CgProgramManager (a separate package available on newer Ubuntu on Debian systems).

Windows:
Download the new dependency packages versioned 6.0 and use these. If you have problems with that or if you don't like the in game console problem mentioned below, you can download the new 4.3 version of the packages (only available for Visual Studio 2005/2008).

Key new features:

  • *Support for Mac OS X*
  • Visual Studio 2010 support
  • Bullet library update to 2.77
  • OIS library update to 1.3
  • Support for CEGUI 0.7 —> Support for Arch Linux and even SuSE
  • Improved install target
  • Compiles now with GCC 4.6
  • Ogre Cg Shader plugin activated for Linux if available
  • And of course lots of bug fixes

There are also some regressions:

  • No support for CEGUI 0.5, Ogre 1.4 and boost 1.35 - 1.39 any more
  • In game console is not working in main menu for CEGUI 0.7
  • Tolua (just the C lib, not the application) and CEGUILua libraries are no longer in our repository. —> You will need to get these as well when compiling Orxonox
  • And of course lots of new bugs we don't yet know about
  • Property svn:eol-style set to native
File size: 10.0 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    <cmdsynopsis>
145      <command>&dhpackage;</command>
146      <arg choice="plain"><option>--masterserver</option></arg>
147    </cmdsynopsis>
148  </refsynopsisdiv>
149  <refsect1 id="description">
150    <title>DESCRIPTION</title>
151    <para>This manual page documents briefly the
152      <command>&dhpackage;</command> command.</para>
153    <para><command>&dhpackage;</command> is a spacecraft shooter that plays in
154      the post-apocalyptic world of our future. Humanity struggles to survive
155      under the threat of wars, economic and ecological disasters. A lot of
156      people search for their luck in the vast space of the solar system. But
157      the human race faces extinction when they realize they are not alone in
158      the galaxy. The Noxons, an evil alien species, believes the human race
159      must be destroyed to free themselves from their cruel god Nox.</para>
160  </refsect1>
161  <refsect1 id="options">
162    <title>OPTIONS</title>
163    <variablelist>
164      <varlistentry>
165        <term><option>--client</option></term>
166        <listitem>
167          <para>Start in client mode.</para>
168        </listitem>
169      </varlistentry>
170      <varlistentry>
171        <term><option>--console</option></term>
172        <listitem>
173          <para>Start in console mode (text IO only).</para>
174        </listitem>
175      </varlistentry>
176      <varlistentry>
177        <term><option>--dedicated</option></term>
178        <listitem>
179          <para>Start in dedicated server mode.</para>
180        </listitem>
181      </varlistentry>
182      <varlistentry>
183        <term><option>--externalDataPath <replaceable>path</replaceable></option></term>
184        <listitem>
185          <para>Path to the external data files.</para>
186        </listitem>
187      </varlistentry>
188      <varlistentry>
189          <term><option>--dest <replaceable>address</replaceable></option></term>
190        <listitem>
191          <para>Server hostname/IP (IP in the form of #.#.#.#).</para>
192        </listitem>
193      </varlistentry>
194      <varlistentry>
195        <term><option>--keyboard_no_grab</option></term>
196        <listitem>
197          <para>Whether not to exclusively grab the keyboard.</para>
198        </listitem>
199      </varlistentry>
200      <varlistentry>
201        <term><option>-l <replaceable>file</replaceable></option></term>
202        <term><option>--level <replaceable>file</replaceable></option></term>
203        <listitem>
204          <para>Default level file (overrides LevelManager::defaultLevelName_ configValue).</para>
205        </listitem>
206      </varlistentry>
207      <varlistentry>
208        <term><option>--masterserver</option></term>
209        <listitem>
210          <para>Start in master server mode.</para>
211        </listitem>
212      </varlistentry>
213      <varlistentry>
214        <term><option>--noIOConsole</option></term>
215        <listitem>
216          <para>Use this if you don't want to use the IOConsole (for instance for Lua debugging).</para>
217        </listitem>
218      </varlistentry>
219      <varlistentry>
220        <term><option>-p <replaceable>port</replaceable></option></term>
221        <term><option>--port <replaceable>port</replaceable></option></term>
222        <listitem>
223          <para>Network communication port to be used 0-65535 (default: 55556).</para>
224        </listitem>
225      </varlistentry>
226      <varlistentry>
227        <term><option>--server</option></term>
228        <listitem>
229          <para>Start in server mode.</para>
230        </listitem>
231      </varlistentry>
232      <varlistentry>
233        <term><option>--settingsFile <replaceable>file</replaceable></option></term>
234        <listitem>
235          <para>THE configuration file.</para>
236        </listitem>
237      </varlistentry>
238      <varlistentry>
239        <term><option>--standalone</option></term>
240        <listitem>
241          <para>Start in standalone mode.</para>
242        </listitem>
243      </varlistentry>
244      <varlistentry>
245        <term><option>--writingPathSuffix <replaceable>suffix</replaceable></option></term>
246        <listitem>
247          <para>Additional subfolder for config and log files.</para>
248        </listitem>
249      </varlistentry>
250    </variablelist>
251  </refsect1>
252  <refsect1 id="files">
253    <title>FILES</title>
254    <variablelist>
255      <varlistentry>
256        <term><filename>${HOME}/.orxonox/config/</filename></term>
257        <listitem>
258          <para>Per-user configuration files to control the
259            behaviour of <application>&dhpackage;</application>.</para>
260        </listitem>
261      </varlistentry>
262      <varlistentry>
263        <term><filename>${HOME}/.orxonox/log/</filename></term>
264        <listitem>
265          <para>Log files of <application>&dhpackage;</application>.</para>
266        </listitem>
267      </varlistentry>
268    </variablelist>
269  </refsect1>
270  <refsect1 id="bugs">
271    <title>BUGS</title>
272    <para>The upstreams "<acronym>BTS</acronym>" can be found
273      at <ulink url="http://forum.orxonox.net/viewforum.php?f=6"/>.</para>
274  </refsect1>
275</refentry>
Note: See TracBrowser for help on using the repository browser.