cleaned-up doc/man and updated to the 2-naming scheme

git-svn-id: https://svn.code.sf.net/p/speed-dreams/code/trunk@3417 30fe4595-0a0c-4342-8851-515496e4dcbd

Former-commit-id: 34cd501031e55d52bc466bc4e254e76f2983a99f
Former-commit-id: 38d384822533aba496f881ddd0e50394a9bc4544
This commit is contained in:
pouillot 2011-03-05 10:54:03 +00:00
parent c37ecc8feb
commit b75061d61a
16 changed files with 132 additions and 318 deletions

View file

@ -1,18 +0,0 @@
.TH "Need for Speed to AC3d converter" "6" "1.1" "Rudy Godoy" "Games"
.SH "NAME"
.LP
nfs2ac-ng
.SH "DESCRIPTION"
.TP
This manual describes the nfs2ac application that is shipped with the game Speed Dreams.
This is a holder manpage.
.SH "OPTIONS"
.TP
This program does not use arguments.
.SH "SEE ALSO"
.BR Speed Dreams (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian GNU/Linux system (but may be used by others).

View file

@ -1,89 +0,0 @@
.TH "Ac3d Compiler" "6" "1.4" "Rudy Godoy" "Games"
.SH "NAME"
.LP
sd-accc \- Ac3d Compiler
.SH "SYNTAX"
.LP
sd-accc [option] <inputfile> <outputfile> [dist][-order orderstring]
.SH "DESCRIPTION"
.TP
This manual describes the Ac3d compiler application that is shipped with Speed Dreams.
.SH "OPTIONS"
.TP
.B \-strip
stripify any ac3d output models
.TP
.B +o
ac3d to ac3d: the result file is optimized in using groups by zone of
track track must be named TKMNxxx dist is used to determine the distance
of the objects
.TP
.B +om
ac3d to ac3d: the result is a vertex merged unique obj for smooth car
only
.TP
.B -o
ac3d to obj
.B +s
ac3d to ac3d with strips (used for cars)
.TP
.B +es <angle_of_smooth>
ac3d to ac3d with strips (used for cars) and extended ac3d file output
(computed normals) angle is in degrees:
example: \fI+es 80.0 clkdtm_o.ac clkdtm.ac\fP
the output file will also contains the secondary textcoord for the env sliding
.TP
.B +et
ac3d to ac3d with triangles (used for cars) and extended ac3d file output (normals normals)
.TP
.B +etn
ac3d to ac3d with triangles no split and extended ac3d file output (normals normals)
.TP
.B +shad
ac3d to ac3d with triangles, create a new ac3d file used for track shading\n vertical mapping of a single texture
.TP
.B <inputfile>
.TP
.B <outputfile>
.TP
.B -order \fIorderstring\fP
only used with \fB+es\fP , \fB+s\fP and \fB+et\fP \fIorderstring\fP is the order of the objects during the save for example: \fIHB;OB;OBM\fP is the names of the objet separate by a semicolon for imported NFS cars the object name \fIHB\fP must be used instead of: \fIHB\fP
.TP
.B -g <outputfile>
for grouping multilayer ac3d track
.TP
.B -l0 <input filename>
the base geometry
.TP
.B -l1 <input filename>
the base geometry map-tiled
.TP
.B -l2 <input filename>
the base geometry skids/and grass details
.TP
.B -l3 <input filename>
the base geometry shadows
.TP
.B -d3 <val>
the max distance of groups in tkmn
.TP
.B -d2 <val>
the distance of group 2 in tkmn
.TP
.B -d1 <val>
the distance of group 1 in tkmn
.TP
.B -S <val>
the distance of splitting for TERRAIN* objects
.TP
.B -es
for extended ac3d file format for strips
.TP
.B -nts
no texture split (for debug)
.SH "SEE ALSO"
.BR speed-dreams (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian GNU/Linux system (but may be used by others).

View file

@ -1,27 +0,0 @@
.TH "Car Specifications Converter from Need for Speed to Speeed Dreams" "6" "1.1" "Rudy Godoy" "Games"
.SH "NAME"
.LP
sd-nfsperf \- Car Specifications Converter
.SH "SYNTAX"
.LP
sd-nfsperf [-c category.xml] [-i <input carp.txt>] [-o output carp.xml]
.SH "DESCRIPTION"
.TP
This manual describes the Car Specifications Converter application that is shipped with Speed Dreams.
.SH "OPTIONS"
.TP
.B -c \fIcategory.xml\fP
car category description
.TP
.B -i \fIinput carp.txt\fP
input NFS carp.txt
.TP
.B -o \fIoutput carp.xml\fP
converted parameters
.SH "SEE ALSO"
.BR speed-dreams (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian GNU/Linux system (but may be used by others).

View file

@ -1,13 +1,13 @@
.TH "Ac3d Compiler" "6" "1.4" "Rudy Godoy" "Games"
.TH "Ac3d Compiler for Speed Dreams 2" "6" "1.4" "Rudy Godoy" "Games"
.SH "NAME"
.LP
accc-ng \- Ac3d Compiler
sd2-accc \- Ac3d Compiler
.SH "SYNTAX"
.LP
accc [option] <inputfile> <outputfile> [dist][-order orderstring]
sd2-accc [option] <inputfile> <outputfile> [dist][-order orderstring]
.SH "DESCRIPTION"
.TP
This manual describes the Ac3d compiler application that is shipped with the game Speed Dreams.
This manual describes the Ac3d compiler application that is shipped with Speed Dreams 2.
.SH "OPTIONS"
.TP
.B \-strip
@ -82,7 +82,7 @@ for extended ac3d file format for strips
.B -nts
no texture split (for debug)
.SH "SEE ALSO"
.BR Speed Dreams (6)
.BR speed-dreams-2 (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,

View file

@ -1,16 +1,16 @@
.TH "Need for Speed to AC3d converter" "6" "1.1" "Rudy Godoy" "Games"
.SH "NAME"
.LP
sd-nfs2ac
sd2-nfs2ac
.SH "DESCRIPTION"
.TP
This manual describes the nfs2ac application that is shipped with the Speed Dreams.
This manual describes the nfs2ac application that is shipped with Speed Dreams 2.
This is a holder manpage.
.SH "OPTIONS"
.TP
This program does not use arguments.
.SH "SEE ALSO"
.BR speed-dreams (6)
.BR speed-dreams-2 (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,

View file

@ -1,13 +1,13 @@
.TH "Car Specifications Converter from Need for Speed to Speed Dreams" "6" "1.1" "Rudy Godoy" "Games"
.TH "Car Specifications Converter from Need for Speed to Speed Dreams 2" "6" "1.1" "Rudy Godoy" "Games"
.SH "NAME"
.LP
nfsperf-ng \- Car Specifications Converter
sd2-nfsperf \- Car Specifications Converter
.SH "SYNTAX"
.LP
nfsperf [-c category.xml] [-i <input carp.txt>] [-o output carp.xml]
sd2-nfsperf [-c category.xml] [-i <input carp.txt>] [-o output carp.xml]
.SH "DESCRIPTION"
.TP
This manual describes the Car Specifications Converter application that is shipped with the game Speed Dreams.
This manual describes the Car Specifications Converter application that is shipped with Speed Dreams 2.
.SH "OPTIONS"
.TP
.B -c \fIcategory.xml\fP
@ -19,7 +19,7 @@ input NFS carp.txt
.B -o \fIoutput carp.xml\fP
converted parameters
.SH "SEE ALSO"
.BR Speed Dreams (6)
.BR speed-dreams-2 (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,

View file

@ -1,13 +1,13 @@
.TH "Texture Auto Mapper for Speed Dreams" "6" "1.1" "Rudy Godoy" "Games"
.TH "Texture Auto Mapper for Speed Dreams 2" "6" "1.1" "Rudy Godoy" "Games"
.SH "NAME"
.LP
sd-texmapper \- Texture Auto Mapper for Speed Dreams
sd2-texmapper \- Texture Auto Mapper for Speed Dreams 2
.SH "SYNTAX"
.LP
sd-texmapper [options]
sd2-texmapper [options]
.SH "DESCRIPTION"
.TP
This manual describes the use of Texture Auto Mapper application that is shipped with Speed Dreams.
This manual describes the use of Texture Auto Mapper application that is shipped with Speed Dreams 2.
.SH "OPTIONS"
.TP
.B -f \fI<input acfile>\fP
@ -25,7 +25,7 @@ output skin file [skin.rgb]
.B --help
print this message
.SH "SEE ALSO"
.BR speed-dreams (6)
.BR speed-dreams-2 (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,

View file

@ -1,13 +1,13 @@
.TH "Speed Dreams terrain generator for tracks" "6" "1.2" "Rudy Godoy" "Games"
.TH "Speed Dreams 2 terrain generator for tracks" "6" "1.2" "Rudy Godoy" "Games"
.SH "NAME"
.LP
sd-trackgen \- Speed Dreams terrain generator for tracks
sd2-trackgen \- Speed Dreams 2 terrain generator for tracks
.SH "SYNTAX"
.LP
sd-trackgen -c category -n name [-a] [-m] [-s] [-S] [-E <n> [-H <nb>]]
sd2-trackgen -c category -n name [-a] [-m] [-s] [-S] [-E <n> [-H <nb>]]
.SH "DESCRIPTION"
.TP
This manual describes the track terrain generator that is shipped with Speed Dreams.
This manual describes the track terrain generator that is shipped with Speed Dreams 2.
.SH "OPTIONS"
.TP
.B -c \fIcategory\fP
@ -44,7 +44,7 @@ save elevation file n
.B -H \fI<nb>\fP
nb of height steps for 4th elevation file [30]
.SH "SEE ALSO"
.BR speed-dreams (6)
.BR speed-dreams-2 (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,

53
doc/man/speed-dreams-2.6 Normal file
View file

@ -0,0 +1,53 @@
.TH "Speed Dreams 2" "6" "1.2.2" "Rudy Godoy" "Games"
.SH NAME
speed-dreams-2 \- 3D racing cars simulator game using OpenGL
.SH DESCRIPTION
Speed Dreams, an Open Motorsport Simulator, is a car racing simulation, which
allows you to drive in races against opponents simulated by the computer.
You can also develop your own computer-controlled driver (also called a
robot) in C or C++, and even build your own cars and tracks.
.br
Speed Dreams 2 is 'Open Source' (GNU General Public License Version 2 or later).
.SH OPTIONS
.TP
.B \-l <local dir>
Set the run-time user settings folder
(default = ~/.speed-dreams-2,
unless not using the default CMake configuration for building)
.TP
.B \-L <lib dir>
Set the run-time library folder
(default = /usr/local/lib[64]/games/speed-dreams-2,
unless not using the default CMake configuration for building)
.TP
.B \-D <data dir>
Set the run-time data folder
(default = /usr/local/share/games/speed-dreams-2,
unless not using the default CMake configuration for building)
.TP
.B \-B <bin dir>
Set the run-time binary data folder
(default = /usr/local/games,
unless not using the default CMake configuration for building)
.TP
.B \-m
Use hardware mouse cursor
.TP
.B \-t <trace level threshold>
Set the trace level threshold to the given integer value
(0=Fatal, 1=Error, 2=Warning, 3=Info, 4=Trace, 5=Debug, ... ;
default = Debug, unless not using the default CMake configuration for building)
Only traces with lower or equal level will appear in the trace stream
Note: May be disabled if CMake option 'OPTION_DEBUG' is not true at build time)
.TP
.B \-r <trace stream>
Set the target stream for the traces (among 'stdout', 'stderr' or <file name>) ;
default = stderr, unless not using the default CMake configuration for building))
Note: May be disabled if CMake option 'OPTION_DEBUG' is not true at build time)
.SH SEE ALSO
For a more detailed player manual, please see:
.br
http://torcs.sourceforge.net/sections.php?op=viewarticle&artid=10
.SH AUTHOR
This manual page was written by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian project (but may be used by others).

View file

@ -0,0 +1,56 @@
.TH "Speed Dreams 2" "6" "1.2.2" "Rudy Godoy" "Games"
.SH NOMBRE
speed-dreams-2 \- Juego 3D simulador de carrera de autos usando OpenGL
.SH DESCRIPCIÓN
Speed Dreams 2, un "Simulator Abierto de Deporte Mecánico", es una simulación de carrera
de autos que le permite manejar en carreras contra oponentes simulados
por la computadora. Usted también puede construir sus propios conductores
controlados por computadora (también llamados robots) en C o C++,
y también sus propios coches y circuitos.
.br
Speed Dreams 2 es un programa de "código abierto" licenciado bajo la GNU General
Public License Version 2 o posterior.
.SH OPCIONES
Not yet translated into Spanish ...
.TP
.B \-l <local dir>
Set the run-time user settings folder
(default = ~/.speed-dreams-2,
unless not using the default CMake configuration for building)
.TP
.B \-L <lib dir>
Set the run-time library folder
(default = /usr/local/lib[64]/games/speed-dreams-2,
unless not using the default CMake configuration for building)
.TP
.B \-D <data dir>
Set the run-time data folder
(default = /usr/local/share/games/speed-dreams-2,
unless not using the default CMake configuration for building)
.TP
.B \-B <bin dir>
Set the run-time binary data folder
(default = /usr/local/games,
unless not using the default CMake configuration for building)
.TP
.B \-m
Use hardware mouse cursor
.TP
.B \-t <trace level threshold>
Set the trace level threshold to the given integer value
(0=Fatal, 1=Error, 2=Warning, 3=Info, 4=Trace, 5=Debug, ... ;
default = Debug, unless not using the default CMake configuration for building)
Only traces with lower or equal level will appear in the trace stream
Note: May be disabled if CMake option 'OPTION_DEBUG' is not true at build time)
.TP
.B \-r <trace stream>
Set the target stream for the traces (among 'stdout', 'stderr' or <file name>) ;
default = stderr, unless not using the default CMake configuration for building))
Note: May be disabled if CMake option 'OPTION_DEBUG' is not true at build time)
.SH VÉASE TAMBIÉN
Para un manual mas detallado sobre como jugar, por favor véa:
.br
http://torcs.sourceforge.net/sections.php?op=viewarticle&artid=10
.SH AUTOR
Esta página de manual ha sido escrita por Rudy Godoy <rudy@kernel-panik.org>,
para el proyecto Debian (pero puede ser usada por otros).

View file

@ -1,19 +0,0 @@
.TH "Speed Dreams" "6" "1.2.2" "Rudy Godoy" "Games"
.SH NAME
speed-dreams \- 3D racing cars simulator game using OpenGL
.SH DESCRIPTION
Speed Dreams, an Open Motorsport Simulator, is a car racing simulation, which
allows you to drive in races against opponents simulated by the computer.
You can also develop your own computer-controlled driver (also called a
robot) in C or C++, and even build your own cars and tracks.
.br
Speed Dreams is "Open Source" (GNU General Public License Version 2 or later).
.SH OPTIONS
This program doesn't have any option.
.SH SEE ALSO
For a more detailed player manual, please see:
.br
http://torcs.sourceforge.net/sections.php?op=viewarticle&artid=10
.SH AUTHOR
This manual page was written by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian project (but may be used by others).

View file

@ -1,20 +0,0 @@
.TH "Speed Dreams" "6" "1.2.2" "Rudy Godoy" "Games"
.SH NOMBRE
speed-dreams \- Juego 3D simulador de carrera de autos usando OpenGL
.SH DESCRIPCIÓN
Speed Dreams, El simulador de carrera de autos, generation siguiente, es una simulación de carrera de
autos que le permite manejar en carreras contra oponentes simulados por
la computadora. Usted también puede construir sus propios conductores
contolados por computadora (también llamados robots) en C o C++, y también sus propios coches y circuitos.
.br
Speed Dreams es un programa de "código abierto" licenciado bajo la GNU General
Public License Version 2 o posterior.
.SH OPCIONES
Este programma no tiéne ninguna option
.SH VÉASE TAMBIÉN
Para un manual mas detallado sobre como jugar, por favor véa:
.br
http://torcs.sourceforge.net/sections.php?op=viewarticle&artid=10
.SH AUTOR
Esta página de manual ha sido escrita por Rudy Godoy <rudy@kernel-panik.org>,
para el proyecto Debian (pero puede ser usada por otros).

View file

@ -1,32 +0,0 @@
.TH "Texture Auto Mapper for Speed Dreams" "6" "1.1" "Rudy Godoy" "Games"
.SH "NAME"
.LP
texmapper-ng \- Texture Auto Mapper for Speed Dreams
.SH "SYNTAX"
.LP
texmapper [options]
.SH "DESCRIPTION"
.TP
This manual describes the use of Texture Auto Mapper application that is shipped with Speed Dreams game.
.SH "OPTIONS"
.TP
.B -f \fI<input acfile>\fP
input model file in AC3D format [car.ac]
.TP
.B -o \fI<output acfile>\fP
ouput model file in AC3D format [car-out.ac]
.TP
.B -p \fI<parameters>\fP
parameters in XML format [texmapper.xml]
.TP
.B -s \fI<file>\fP
output skin file [skin.rgb]
.TP
.B --help
print this message
.SH "SEE ALSO"
.BR Speed Dreams (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian GNU/Linux system (but may be used by others).

View file

@ -1,19 +0,0 @@
.TH "Speed Dreams" "6" "1.2.2" "Rudy Godoy" "Games"
.SH NAME
Speed Dreams \- 3D racing cars simulator game using OpenGL
.SH DESCRIPTION
Speed Dreams, An Open Motorsport Simulator, is a car racing simulation, which
allows you to drive in races against opponents simulated by the computer.
You can also develop your own computer-controlled driver (also called a
robot) in C or C++, and even build your own cars and tracks.
.br
Speed Dreams is "Open Source" (GNU General Public License Version 2 or later).
.SH OPTIONS
This program doesn't have any option.
.SH SEE ALSO
For a more detailed player manual, please see:
.br
http://torcs.sourceforge.net/sections.php?op=viewarticle&artid=10
.SH AUTHOR
This manual page was written by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian project (but may be used by others).

View file

@ -1,20 +0,0 @@
.TH "Speed Dreams" "6" "1.2.2" "Rudy Godoy" "Games"
.SH NOMBRE
Speed Dreams \- Juego 3D simulador de carrera de autos usando OpenGL
.SH DESCRIPCIÓN
Speed Dreams, Un simulador de carrera de autos, es una simulación de carrera de
autos que le permite manejar en carreras contra oponentes simulados por
la computadora. Usted también puede construir sus propios conductores
contolados por computadora (también llamados robots) en C o C++, y también sus propios coches y circuitos.
.br
TORCS es un programa de "código abierto" licenciado bajo la GNU General
Public License Version 2 o posterior.
.SH OPCIONES
Este programma no tiéne ninguna option
.SH VÉASE TAMBIÉN
Para un manual mas detallado sobre como jugar, por favor véa:
.br
http://torcs.sourceforge.net/sections.php?op=viewarticle&artid=10
.SH AUTOR
Esta página de manual ha sido escrita por Rudy Godoy <rudy@kernel-panik.org>,
para el proyecto Debian (pero puede ser usada por otros).

View file

@ -1,51 +0,0 @@
.TH "Speed Dreams terrain generator for tracks" "6" "1.2" "Rudy Godoy" "Games"
.SH "NAME"
.LP
trackgen-ng \- Speed Dreams terrain generator for tracks
.SH "SYNTAX"
.LP
trackgen -c category -n name [-a] [-m] [-s] [-S] [-E <n> [-H <nb>]]
.SH "DESCRIPTION"
.TP
This manual describes the track terrain generator that is shipped with the game TORCS.
.SH "OPTIONS"
.TP
.B -c \fIcategory\fP
track category (road, oval, dirt...)
.TP
.B -n \fIname\fP
track name
.TP
.B -b
draw bump track
.TP
.B -B
Don't use terrain border (relief supplied int clockwise, ext CC)
.TP
.B -a
draw all (default is track only)
.TP
.B -s
split the track and the terrain
.TP
.B -S
split all
.TP
.B -E \fI<n>\fP
save elevation file n
.RS 4
.IP "0: all elevatation files" 4
.IP "1: elevation file of terrain + track" 4
.IP "2: elevation file of terrain with track white"
.IP "3: track only"
.IP "4: track elevations with height steps" 4
.RE
.TP
.B -H \fI<nb>\fP
nb of height steps for 4th elevation file [30]
.SH "SEE ALSO"
.BR Speed Dreams (6)
.SH "AUTHOR"
.LP
This manual page was writen by Rudy Godoy <rudy@kernel-panik.org>,
for the Debian GNU/Linux system (but may be used by others).