From f0624bb403e25953700f258d2a41859cb4b64c93 Mon Sep 17 00:00:00 2001 From: pouillot Date: Sun, 26 Feb 2012 13:00:58 +0000 Subject: [PATCH] Fixes #602 Install manpages (after updating the original sources) for our executables git-svn-id: https://svn.code.sf.net/p/speed-dreams/code/trunk@4539 30fe4595-0a0c-4342-8851-515496e4dcbd Former-commit-id: 9402aa859e40a442eae68888a5814a393efe6839 Former-commit-id: 8137df76708c2ed8a9f9ecdeaf6c08ccec329bac --- cmake/macros.cmake | 36 +++++++-- doc/man/sd2-accc.6 | 76 +++++++++++-------- doc/man/sd2-menuview.6 | 83 +++++++++++++++++++++ doc/man/sd2-nfs2ac.6 | 48 ++++++++---- doc/man/sd2-nfsperf.6 | 47 ++++++++---- doc/man/sd2-texmapper.6 | 32 -------- doc/man/sd2-trackgen.6 | 43 ++++++++--- doc/man/speed-dreams-2.6 | 119 +++++++++++++++++++++--------- doc/man/speed-dreams-2.es.6 | 56 -------------- src/main/CMakeLists.txt | 7 +- src/tools/accc/CMakeLists.txt | 11 ++- src/tools/menuview/CMakeLists.txt | 8 +- src/tools/nfs2ac/CMakeLists.txt | 11 ++- src/tools/nfsperf/CMakeLists.txt | 21 ++++-- src/tools/trackgen/CMakeLists.txt | 4 + 15 files changed, 386 insertions(+), 216 deletions(-) create mode 100644 doc/man/sd2-menuview.6 delete mode 100644 doc/man/sd2-texmapper.6 delete mode 100644 doc/man/speed-dreams-2.es.6 diff --git a/cmake/macros.cmake b/cmake/macros.cmake index 196f21019..3625bd09d 100644 --- a/cmake/macros.cmake +++ b/cmake/macros.cmake @@ -80,7 +80,7 @@ MARK_AS_ADVANCED(SD_LOCALDIR) SET(SD_TOOLS_EXECPREFIX "sd2-" CACHE DOC "Prefix for the tools executable names") MARK_AS_ADVANCED(SD_TOOLS_EXECPREFIX) -# Determine the default value of the data, bin and lib folders. +# Determine the default value of the data, bin and lib (and man) folders. IF(IN_SOURCETREE) IF(CMAKE_SIZEOF_VOID_P MATCHES 4) SET(_DEFLIBDIR "lib") @@ -97,19 +97,26 @@ IF(IN_SOURCETREE) SET(SD_DATADIR share/games/speed-dreams-2 CACHE PATH "Place where all the static data files should go") SET(SD_LIBDIR ${_DEFLIBDIR}/games/speed-dreams-2 CACHE PATH "Place where the libraries should go") SET(SD_INCLUDEDIR include/speed-dreams-2 CACHE PATH "Place where the include files should go") + SET(SD_MANDIR share/man CACHE PATH "Place where the manual pages should go") ENDIF(WIN32) MARK_AS_ADVANCED(SD_BINDIR) MARK_AS_ADVANCED(SD_DATADIR) MARK_AS_ADVANCED(SD_LIBDIR) MARK_AS_ADVANCED(SD_INCLUDEDIR) + IF(UNIX) + MARK_AS_ADVANCED(SD_MANDIR) + ENDIF(UNIX) ELSE(IN_SOURCETREE) SET(SD_DATADIR ${SD_DATADIR_ABS}) SET(SD_LIBDIR ${SD_LIBDIR_ABS}) SET(SD_BINDIR ${SD_BINDIR_ABS}) SET(SD_INCLUDEDIR ${SD_INCLUDEDIR_ABS}) + IF(UNIX) + SET(SD_MANDIR ${SD_MANDIR_ABS}) + ENDIF(UNIX) ENDIF(IN_SOURCETREE) -# Determine the aboslute paths of the data, bin and lib folders. +# Determine the aboslute paths of the data, bin and lib (and man) folders. IF(IS_ABSOLUTE ${SD_DATADIR}) GET_FILENAME_COMPONENT(SD_DATADIR_ABS ${SD_DATADIR} ABSOLUTE) ELSE(IS_ABSOLUTE ${SD_DATADIR}) @@ -134,6 +141,14 @@ ELSE(IS_ABSOLUTE ${SD_INCLUDEDIR}) GET_FILENAME_COMPONENT(SD_INCLUDEDIR_ABS ${CMAKE_INSTALL_PREFIX}/${SD_INCLUDEDIR} ABSOLUTE) ENDIF(IS_ABSOLUTE ${SD_INCLUDEDIR}) +IF(UNIX) + IF(IS_ABSOLUTE ${SD_MANDIR}) + GET_FILENAME_COMPONENT(SD_MANDIR_ABS ${SD_MANDIR} ABSOLUTE) + ELSE(IS_ABSOLUTE ${SD_MANDIR}) + GET_FILENAME_COMPONENT(SD_MANDIR_ABS ${CMAKE_INSTALL_PREFIX}/${SD_MANDIR} ABSOLUTE) + ENDIF(IS_ABSOLUTE ${SD_MANDIR}) +ENDIF(UNIX) + STRING(REGEX REPLACE "^(.*[^/])/*$" "\\1" SD_LOCALDIR_TMP ${SD_LOCALDIR}) SET(SD_LOCALDIR ${SD_LOCALDIR_TMP}) @@ -1143,12 +1158,15 @@ ENDMACRO(SD_INSTALL_TRACK TRACKNAME CATEGORY) # Installs bt.so in ${prefix}/${SD_LIBDIR}/drivers/bt # SD_INSTALL_FILES(BIN TARGETS speed-dreams) # Installs the speed-dreams target in ${prefix}/${SD_BINDIR} +# SD_INSTALL_FILES(MAN man6 PREFIX ${SOURCE_DIR}/doc/man FILES sd2-menuview.6) +# Installs ${SOURCE_DIR}/doc/man/sd2-menuview.6 in ${prefix}/${SD_MANDIR}/man6 MACRO(SD_INSTALL_FILES) SET(SD_INSTALL_FILES_SYNTAX "DATA,1,1,IS_DATA,DATA_PATH") SET(SD_INSTALL_FILES_SYNTAX ${SD_INSTALL_FILES_SYNTAX} "LIB,1,1,IS_LIB,LIB_PATH") SET(SD_INSTALL_FILES_SYNTAX ${SD_INSTALL_FILES_SYNTAX} "BIN,0,0,IS_BIN,_") SET(SD_INSTALL_FILES_SYNTAX ${SD_INSTALL_FILES_SYNTAX} "INCLUDE,0,1,IS_INCLUDE,INCLUDE_PATH") + SET(SD_INSTALL_FILES_SYNTAX ${SD_INSTALL_FILES_SYNTAX} "MAN,1,1,IS_MAN,MAN_PATH") SET(SD_INSTALL_FILES_SYNTAX ${SD_INSTALL_FILES_SYNTAX} "USER,1,1,IS_USER,USER_PATH") SET(SD_INSTALL_FILES_SYNTAX ${SD_INSTALL_FILES_SYNTAX} "PREFIX,0,1,HAS_PREFIX,PREFIX") SET(SD_INSTALL_FILES_SYNTAX ${SD_INSTALL_FILES_SYNTAX} "FILES,0,-1,HAS_FILES,FILES") @@ -1156,7 +1174,7 @@ MACRO(SD_INSTALL_FILES) SPLIT_ARGN(${SD_INSTALL_FILES_SYNTAX} ARGUMENTS ${ARGN}) - #MESSAGE(STATUS " SD_INSTALL_FILES: LIB=${IS_LIB}:${LIB_PATH} BIN=${IS_BIN} INCLUDE=${IS_INCLUDE}:${INCLUDE_PATH} DATA=${IS_DATA}:${DATA_PATH} USER=${IS_USER}:${USER_PATH} TARGETS=${HAS_TARGETS}:${TARGETS} FILES=${HAS_FILES}:${FILES}") + #MESSAGE(STATUS " SD_INSTALL_FILES: LIB=${IS_LIB}:${LIB_PATH} BIN=${IS_BIN} INCLUDE=${IS_INCLUDE}:${INCLUDE_PATH} DATA=${IS_DATA}:${DATA_PATH} MAN=${IS_MAN}:${MAN_PATH} USER=${IS_USER}:${USER_PATH} TARGETS=${HAS_TARGETS}:${TARGETS} FILES=${HAS_FILES}:${FILES}") # Fix/Check argument syntax / values IF(NOT DATA_PATH) @@ -1168,6 +1186,9 @@ MACRO(SD_INSTALL_FILES) IF(NOT LIB_PATH) SET(IS_LIB FALSE) ENDIF() + IF(NOT MAN_PATH) + SET(IS_MAN FALSE) + ENDIF() IF(NOT PREFIX) SET(HAS_PREFIX FALSE) ENDIF() @@ -1178,14 +1199,14 @@ MACRO(SD_INSTALL_FILES) SET(HAS_TARGETS FALSE) ENDIF() - IF(IS_DATA OR IS_LIB OR IS_BIN OR IS_INCLUDE) + IF(IS_DATA OR IS_LIB OR IS_BIN OR IS_INCLUDE OR IS_MAN) IF(HAS_PREFIX) IF(NOT HAS_FILES) MESSAGE(FATAL_ERROR "SD_INSTALL_FILES: Expected FILES when PREFIX keyword is present") ENDIF() ENDIF() ELSE() - MESSAGE(FATAL_ERROR "SD_INSTALL_FILES: Expected 1 and only 1 LIB, DATA, BIN or INCLUDE keyword") + MESSAGE(FATAL_ERROR "SD_INSTALL_FILES: Expected 1 and only 1 LIB, DATA, BIN, INCLUDE or MAN keyword") ENDIF() IF(IS_USER) @@ -1206,7 +1227,10 @@ MACRO(SD_INSTALL_FILES) SET(DEST2 "") ELSEIF(IS_INCLUDE) SET(DEST1 ${SD_INCLUDEDIR}) - SET(DEST2 "${INCLUDE_PATH}") + SET(DEST2 ${INCLUDE_PATH}) + ELSEIF(IS_MAN) + SET(DEST1 ${SD_MANDIR}) + SET(DEST2 ${MAN_PATH}) ENDIF() IF(DEST2 STREQUAL "" OR DEST2 STREQUAL "/") diff --git a/doc/man/sd2-accc.6 b/doc/man/sd2-accc.6 index 02c02fc71..f612f37fb 100644 --- a/doc/man/sd2-accc.6 +++ b/doc/man/sd2-accc.6 @@ -1,14 +1,13 @@ -.TH "Ac3d Compiler for Speed Dreams 2" "6" "1.4" "Rudy Godoy" "Games" -.SH "NAME" +.TH "Speed Dreams 2 multi-layer generator for tracks" "6" "March 2012" "Speed Dreams 2.x" "Games" +.SH NAME .LP -sd2-accc \- Ac3d Compiler -.SH "SYNTAX" -.LP -sd2-accc [option] [dist][-order orderstring] -.SH "DESCRIPTION" -.TP -This manual describes the Ac3d compiler application that is shipped with Speed Dreams 2. -.SH "OPTIONS" +sd2-accc \- Speed Dreams 2 multi-layer generator for tracks +.SH SYNOPSIS +\fBsd2-accc\fP [option] < output .acc file> [dist] [-order order-string] +.SH DESCRIPTION +sd2-accc is intended to add multi-texturing to the track models +built in the native Ac3d file format. +.SH OPTIONS .TP .B \-strip stripify any ac3d output models @@ -27,7 +26,7 @@ ac3d to obj .B +s ac3d to ac3d with strips (used for cars) .TP -.B +es +.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 @@ -42,38 +41,34 @@ ac3d to ac3d with triangles no split and extended ac3d file output (normals norm .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 -.TP -.B -.TP -.B -order \fIorderstring\fP +.B -order order-string 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 +.B -g output filename for grouping multilayer ac3d track .TP -.B -l0 +.B -l0 input filename the base geometry .TP -.B -l1 +.B -l1 input filename the base geometry map-tiled .TP -.B -l2 +.B -l2 input filename the base geometry skids/and grass details .TP -.B -l3 +.B -l3 input filename the base geometry shadows .TP -.B -d3 +.B -d3 val the max distance of groups in tkmn .TP -.B -d2 +.B -d2 val the distance of group 2 in tkmn .TP -.B -d1 +.B -d1 val the distance of group 1 in tkmn .TP -.B -S +.B -S val the distance of splitting for TERRAIN* objects .TP .B -es @@ -81,9 +76,28 @@ for extended ac3d file format for strips .TP .B -nts no texture split (for debug) -.SH "SEE ALSO" -.BR speed-dreams-2 (6) -.SH "AUTHOR" -.LP -This manual page was writen by Rudy Godoy , -for the Debian GNU/Linux system (but may be used by others). +.SH LICENSE +sd2-accc is licensed under the GNU General Public License, version 2 or later. +.SH COPYRIGHT +The Speed Dreams Team. +.SH AUTHOR +This manual page was written by Jean-Philippe Meuret , +based on TORCS 1.2.2 version by Rudy Godoy , +for the Debian project ; of course, it may be used by any other. +.SH BUG REPORTS +.br +In case you discover a bug (sure you won't ;-), please report it here: +.br +http://sourceforge.net/apps/trac/speed-dreams/report/3 +.br +of course after checking that it is not already filed. +.SH SEE ALSO +Web site: http://www.speed-dreams.org/ +.br +Community: http://community.speed-dreams.org/ +.br +Sourceforge pages: http://sourceforge.net/projects/speed-dreams/ +.br +Wiki: http://sourceforge.net/apps/trac/speed-dreams/wiki +.br +speed-dreams-2(6), sd2-trackgen(6), sd2-menuview(6), sd2-nfs2ac(6), sd2-nfsperf(6) diff --git a/doc/man/sd2-menuview.6 b/doc/man/sd2-menuview.6 new file mode 100644 index 000000000..14d8da75d --- /dev/null +++ b/doc/man/sd2-menuview.6 @@ -0,0 +1,83 @@ +.TH "Speed Dreams 2 menu viewer" "6" "March 2012" "Speed Dreams 2.x" "Games" +.SH NAME +sd2-menuview \- Menu viewer for Speed Dreams 2 +.SH SYNOPSIS +\fBsd2-menuview\fP [-v|--version] [-h|--help] + [-l|--localdir ] [-L|--libdir ] + [-B|--bindir ] [-D|--datadir ] + [-e|--tracelevel ] [-t|--tracestream stdout|stderr|] + [-m|--hardmouse] + menu-file + +.SH DESCRIPTION +Menu viewer for Speed Dreams 2 +.SH OPTIONS +.TP +\fB-h\fP, \fB--help\fP +Show a short manual about options +.TP +\fB-v\fP, \fB--version\fP +Show the actual game version +.TP +\fB-l\fP, \fB--localdir\fP local dir +Set the run-time user settings folder +(default = ~/.speed-dreams-2, unless not using the default CMake configuration for building) +.TP +\fB-L\fP, \fB--libdir\fP 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 +\fB-D\fP, \fB--datadir\fP 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 +\fB-B\fP, \fB--bindir\fP bin dir +Set the run-time binary data folder +(default = /usr/local/games, unless not using the default CMake configuration for building) +.TP +\fB-m\fP, \fB--hardmouse\fP +Use hardware mouse cursor +.TP +\fB-e\fP, \fB--tracelevel\fP 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 +\fB-t\fP, \fB--tracestream\fP target trace stream +Set the target stream for the traces (among 'stdout', 'stderr' or ) ; + 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) +.TP +\fBmenu-file\fP +Absolute path of the menu XML descriptor file +.SH EXAMPLES +sd2-menuview /home/sd/trunk/data/data/menu/racemanmenu.xml +.SH LICENSE +sd2-menuview is licensed under the GNU General Public License, version 2 or later. +.SH COPYRIGHT +The Speed Dreams Team. +.SH AUTHOR +This manual page was written by Jean-Philippe Meuret , +based on TORCS 1.2.2 version by Rudy Godoy , +for the Debian project ; of course, it may be used by any other. +.SH BUG REPORTS +.br +In case you discover a bug (sure you won't ;-), please report it here: +.br +http://sourceforge.net/apps/trac/speed-dreams/report/3 +.br +of course after checking that it is not already filed. +.SH SEE ALSO +Web site: http://www.speed-dreams.org/ +.br +Community: http://community.speed-dreams.org/ +.br +Sourceforge pages: http://sourceforge.net/projects/speed-dreams/ +.br +User manual: http://sourceforge.net/apps/trac/speed-dreams/wiki/SD2.0Manual +.br +Wiki: http://sourceforge.net/apps/trac/speed-dreams/wiki +.br +speed-dreams-2(6), sd2-trackgen(6), sd2-accc(6), sd2-nfs2ac(6), sd2-nfsperf(6) diff --git a/doc/man/sd2-nfs2ac.6 b/doc/man/sd2-nfs2ac.6 index b47271eb7..1f707c5e5 100644 --- a/doc/man/sd2-nfs2ac.6 +++ b/doc/man/sd2-nfs2ac.6 @@ -1,18 +1,36 @@ -.TH "Need for Speed to AC3d converter" "6" "1.1" "Rudy Godoy" "Games" -.SH "NAME" +.TH "Speed Dreams 2 NFS to AC3d converter" "6" "March 2012" "Speed Dreams 2.x" "Games" +.SH NAME .LP -sd2-nfs2ac -.SH "DESCRIPTION" -.TP +sd2-nfs2ac \- Car model converter from 'Need for Speed' to Ac3d +.SH SYNOPSIS +.LP +\fBsd2-nfs2ac\fP +.SH DESCRIPTION This manual describes the nfs2ac application that is shipped with Speed Dreams 2. -This is a holder manpage. -.SH "OPTIONS" -.TP +.SH OPTIONS This program does not use arguments. -.SH "SEE ALSO" -.BR speed-dreams-2 (6) -.SH "AUTHOR" -.LP -This manual page was writen by Rudy Godoy , -for the Debian GNU/Linux system (but may be used by others). - +.SH LICENSE +sd2-nfs2ac is licensed under the GNU General Public License, version 2 or later. +.SH COPYRIGHT +The Speed Dreams Team. +.SH AUTHOR +This manual page was written by Jean-Philippe Meuret , +based on TORCS 1.2.2 version by Rudy Godoy , +for the Debian project ; of course, it may be used by any other. +.SH BUG REPORTS +.br +In case you discover a bug (sure you won't ;-), please report it here: +.br +http://sourceforge.net/apps/trac/speed-dreams/report/3 +.br +of course after checking that it is not already filed. +.SH SEE ALSO +Web site: http://www.speed-dreams.org/ +.br +Community: http://community.speed-dreams.org/ +.br +Sourceforge pages: http://sourceforge.net/projects/speed-dreams/ +.br +Wiki: http://sourceforge.net/apps/trac/speed-dreams/wiki +.br +sd2-nfsperf(6), sd2-accc(6), speed-dreams-2(6), sd2-menuview(6), sd2-trackgen(6) diff --git a/doc/man/sd2-nfsperf.6 b/doc/man/sd2-nfsperf.6 index cb3966022..63b187ac3 100644 --- a/doc/man/sd2-nfsperf.6 +++ b/doc/man/sd2-nfsperf.6 @@ -1,14 +1,13 @@ -.TH "Car Specifications Converter from Need for Speed to Speed Dreams 2" "6" "1.1" "Rudy Godoy" "Games" -.SH "NAME" +.TH "Speed Dreams 2 car spec converter from NFS" "6" "March 2012" "Speed Dreams 2.x" "Games" +.SH NAME .LP -sd2-nfsperf \- Car Specifications Converter -.SH "SYNTAX" +sd2-nfsperf \- Car Specifications Converter from 'Need for Speed' to Speed Dreams 2 +.SH SYNOPSIS .LP -sd2-nfsperf [-c category.xml] [-i ] [-o output carp.xml] -.SH "DESCRIPTION" -.TP +\fBsd2-nfsperf\fP [-c category.xml] [-i ] [-o output carp.xml] +.SH DESCRIPTION This manual describes the Car Specifications Converter application that is shipped with Speed Dreams 2. -.SH "OPTIONS" +.SH OPTIONS .TP .B -c \fIcategory.xml\fP car category description @@ -18,10 +17,28 @@ input NFS carp.txt .TP .B -o \fIoutput carp.xml\fP converted parameters -.SH "SEE ALSO" -.BR speed-dreams-2 (6) -.SH "AUTHOR" -.LP -This manual page was writen by Rudy Godoy , -for the Debian GNU/Linux system (but may be used by others). - +.SH LICENSE +sd2-nfsperf is licensed under the GNU General Public License, version 2 or later. +.SH COPYRIGHT +The Speed Dreams Team. +.SH AUTHOR +This manual page was written by Jean-Philippe Meuret , +based on TORCS 1.2.2 version by Rudy Godoy , +for the Debian project ; of course, it may be used by any other. +.SH BUG REPORTS +.br +In case you discover a bug (sure you won't ;-), please report it here: +.br +http://sourceforge.net/apps/trac/speed-dreams/report/3 +.br +of course after checking that it is not already filed. +.SH SEE ALSO +Web site: http://www.speed-dreams.org/ +.br +Community: http://community.speed-dreams.org/ +.br +Sourceforge pages: http://sourceforge.net/projects/speed-dreams/ +.br +Wiki: http://sourceforge.net/apps/trac/speed-dreams/wiki +.br +sd2-nfs2ac(6), sd2-accc(6), speed-dreams-2(6), sd2-menuview(6), sd2-trackgen(6) diff --git a/doc/man/sd2-texmapper.6 b/doc/man/sd2-texmapper.6 deleted file mode 100644 index cb82d0b37..000000000 --- a/doc/man/sd2-texmapper.6 +++ /dev/null @@ -1,32 +0,0 @@ -.TH "Texture Auto Mapper for Speed Dreams 2" "6" "1.1" "Rudy Godoy" "Games" -.SH "NAME" -.LP -sd2-texmapper \- Texture Auto Mapper for Speed Dreams 2 -.SH "SYNTAX" -.LP -sd2-texmapper [options] -.SH "DESCRIPTION" -.TP -This manual describes the use of Texture Auto Mapper application that is shipped with Speed Dreams 2. -.SH "OPTIONS" -.TP -.B -f \fI\fP -input model file in AC3D format [car.ac] -.TP -.B -o \fI\fP -ouput model file in AC3D format [car-out.ac] -.TP -.B -p \fI\fP -parameters in XML format [texmapper.xml] -.TP -.B -s \fI\fP -output skin file [skin.rgb] -.TP -.B --help -print this message -.SH "SEE ALSO" -.BR speed-dreams-2 (6) -.SH "AUTHOR" -.LP -This manual page was writen by Rudy Godoy , -for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/sd2-trackgen.6 b/doc/man/sd2-trackgen.6 index e66d5dcb2..b4c2349f2 100644 --- a/doc/man/sd2-trackgen.6 +++ b/doc/man/sd2-trackgen.6 @@ -1,14 +1,14 @@ -.TH "Speed Dreams 2 terrain generator for tracks" "6" "1.2" "Rudy Godoy" "Games" -.SH "NAME" +.TH "Speed Dreams 2 terrain generator for tracks" "6" "March 2012" "Speed Dreams 2.x" "Games" +.SH NAME .LP sd2-trackgen \- Speed Dreams 2 terrain generator for tracks -.SH "SYNTAX" +.SH SYNOPSIS .LP -sd2-trackgen -c category -n name [-a] [-m] [-s] [-S] [-E [-H ]] -.SH "DESCRIPTION" +\fBsd2-trackgen\fP -c category -n name [-a] [-m] [-s] [-S] [-E [-H ]] +.SH DESCRIPTION .TP This manual describes the track terrain generator that is shipped with Speed Dreams 2. -.SH "OPTIONS" +.SH OPTIONS .TP .B -c \fIcategory\fP track category (road, speedway, dirt...) @@ -43,9 +43,28 @@ save elevation file n .TP .B -H \fI\fP nb of height steps for 4th elevation file [30] -.SH "SEE ALSO" -.BR speed-dreams-2 (6) -.SH "AUTHOR" -.LP -This manual page was writen by Rudy Godoy , -for the Debian GNU/Linux system (but may be used by others). +.SH LICENSE +sd2-trackgen is licensed under the GNU General Public License, version 2 or later. +.SH COPYRIGHT +The Speed Dreams Team. +.SH AUTHOR +This manual page was written by Jean-Philippe Meuret , +based on TORCS 1.2.2 version by Rudy Godoy , +for the Debian project ; of course, it may be used by any other. +.SH BUG REPORTS +.br +In case you discover a bug (sure you won't ;-), please report it here: +.br +http://sourceforge.net/apps/trac/speed-dreams/report/3 +.br +of course after checking that it is not already filed. +.SH SEE ALSO +Web site: http://www.speed-dreams.org/ +.br +Community: http://community.speed-dreams.org/ +.br +Sourceforge pages: http://sourceforge.net/projects/speed-dreams/ +.br +Wiki: http://sourceforge.net/apps/trac/speed-dreams/wiki +.br +speed-dreams-2(6), sd2-accc(6), sd2-menuview(6), sd2-nfs2ac(6), sd2-nfsperf(6) diff --git a/doc/man/speed-dreams-2.6 b/doc/man/speed-dreams-2.6 index 403e1b109..821bf2b74 100644 --- a/doc/man/speed-dreams-2.6 +++ b/doc/man/speed-dreams-2.6 @@ -1,53 +1,106 @@ -.TH "Speed Dreams 2" "6" "1.2.2" "Rudy Godoy" "Games" +.TH "Speed Dreams 2" "6" "March 2012" "Speed Dreams 2.x" "Games" .SH NAME -speed-dreams-2 \- 3D racing cars simulator game using OpenGL +speed-dreams-2 \- High-quality 3D racing cars simulator game based on Open GL +.SH SYNOPSIS +\fBspeed-dreams-2\fP [-v|--version] [-h|--help] + [-l|--localdir ] [-L|--libdir ] + [-B|--bindir ] [-D|--datadir ] + [-e|--tracelevel ] [-t|--tracestream stdout|stderr|] + [-m|--hardmouse] + [-s|--startrace [-x|--textonly] ] + .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). +Speed Dreams is a Motorsport Simulator featuring high-quality 3D graphics +and an accurate physics engine, all targeting maximum realism. +Initially forked from TORCS, it has now reached a clearly higher realism level +in visual and physics simulation, thanks to its active development team +and growing community. +It mainly aims to implement exciting new features, cars, tracks and AI opponents +to make a more enjoyable game for the player, while constantly pushing forward +visual and physics realism. +It is also intended for any research, study or teaching activity, around physics and AI, +thanks to its GPL V2+ license, and the clear and modular architecture +of its C/C++ code base. +As everything is open in Speed Dreams, you can also tweak you favorite car physics setup, +create a band new car model, or simply design a new shinning livery for an existing one, +and even create an entire new track with its landscape, or simply improve an existing one. +And even more ... .SH OPTIONS .TP -.B \-l +\fB-h\fP, \fB--help\fP +Show a short manual about options +.TP +\fB-v\fP, \fB--version\fP +Show the actual game version +.TP +\fB-l\fP, \fB--localdir\fP local dir Set the run-time user settings folder -(default = ~/.speed-dreams-2, - unless not using the default CMake configuration for building) +(default = ~/.speed-dreams-2, unless not using the default CMake configuration for building) .TP -.B \-L -Set the run-time library folder -(default = /usr/local/lib[64]/games/speed-dreams-2, - unless not using the default CMake configuration for building) +\fB-L\fP, \fB--libdir\fP 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 -Set the run-time data folder -(default = /usr/local/share/games/speed-dreams-2, - unless not using the default CMake configuration for building) +\fB-D\fP, \fB--datadir\fP 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 +\fB-B\fP, \fB--bindir\fP bin dir Set the run-time binary data folder -(default = /usr/local/games, - unless not using the default CMake configuration for building) +(default = /usr/local/games, unless not using the default CMake configuration for building) .TP -.B \-m +\fB-s\fP, \fB--startrace\fP race mode name +Directly start a new race of the given mode, +as the name without extension of the selected raceman file, +among the .xml files in /config/raceman (no default) +.TP +\fB-x\fP, \fB--textonly\fP +Run the specified race without any GUI (suitable for a headless computer) +.br +Note: Can't be used without -s/--startrace. +.TP +\fB-m\fP, \fB--hardmouse\fP Use hardware mouse cursor .TP -.B \-t +\fB-e\fP, \fB--tracelevel\fP 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) +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 +\fB-t\fP, \fB--tracestream\fP target trace stream Set the target stream for the traces (among 'stdout', 'stderr' or ) ; - default = stderr, unless not using the default CMake configuration for building)) +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 EXAMPLES +speed-dreams-2 +speed-dreams-2 -s quickrace +speed-dreams-2 -x -s practice +.SH LICENSE +Speed Dreams 2 is licensed under the GNU General Public License, version 2 or later. +.SH COPYRIGHT +The Speed Dreams Team. .SH AUTHOR -This manual page was written by Rudy Godoy , -for the Debian project (but may be used by others). +This manual page was written by Jean-Philippe Meuret , +based on TORCS 1.2.2 version by Rudy Godoy , +for the Debian project ; of course, it may be used by any other. +.SH BUG REPORTS +.br +In case you discover a bug (sure you won't ;-), please report it here: +.br +http://sourceforge.net/apps/trac/speed-dreams/report/3 +.br +of course after checking that it is not already filed. +.SH SEE ALSO +Web site: http://www.speed-dreams.org/ +.br +Community: http://community.speed-dreams.org/ +.br +Sourceforge pages: http://sourceforge.net/projects/speed-dreams/ +.br +User manual: http://sourceforge.net/apps/trac/speed-dreams/wiki/SD2.0Manual +.br +Wiki: http://sourceforge.net/apps/trac/speed-dreams/wiki +.br +sd2-trackgen(6), sd2-accc(6), sd2-menuview(6), sd2-nfs2ac(6), sd2-nfsperf(6) diff --git a/doc/man/speed-dreams-2.es.6 b/doc/man/speed-dreams-2.es.6 deleted file mode 100644 index 999c6a67a..000000000 --- a/doc/man/speed-dreams-2.es.6 +++ /dev/null @@ -1,56 +0,0 @@ -.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 -Set the run-time user settings folder -(default = ~/.speed-dreams-2, - unless not using the default CMake configuration for building) -.TP -.B \-L -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 -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 -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 -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 -Set the target stream for the traces (among 'stdout', 'stderr' or ) ; - 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 , -para el proyecto Debian (pero puede ser usada por otros). diff --git a/src/main/CMakeLists.txt b/src/main/CMakeLists.txt index c087ebddd..da0ec61fa 100644 --- a/src/main/CMakeLists.txt +++ b/src/main/CMakeLists.txt @@ -21,9 +21,10 @@ ENDIF(COMMAND CMAKE_POLICY) ADD_EXECUTABLE(${_TARGET_NAME} ${_SOURCES}) ADD_SDLIB_LIBRARY(${_TARGET_NAME} tgf tgfclient tgfdata raceengine) -IF(LINUX) - ADD_DL_LIBRARY(${_TARGET_NAME}) -ENDIF(LINUX) + +IF(UNIX) + SD_INSTALL_FILES(MAN man6 PREFIX ${SOURCE_DIR}/doc/man FILES ${_TARGET_NAME}.6) +ENDIF(UNIX) SD_INSTALL_FILES(BIN TARGETS ${_TARGET_NAME}) diff --git a/src/tools/accc/CMakeLists.txt b/src/tools/accc/CMakeLists.txt index c9b0a3099..d67977ec4 100644 --- a/src/tools/accc/CMakeLists.txt +++ b/src/tools/accc/CMakeLists.txt @@ -1,11 +1,18 @@ INCLUDE(../../../cmake/macros.cmake) + PROJECT(accc) +SET(_TARGET_NAME ${SD_TOOLS_EXECPREFIX}accc) + SET(ACCC_SOURCES ac3dgroup.cpp ac3dload.cpp mainaccc.cpp) ADD_SDLIB_INCLUDEDIR(portability) -ADD_EXECUTABLE(${SD_TOOLS_EXECPREFIX}accc ${ACCC_SOURCES}) +ADD_EXECUTABLE(${_TARGET_NAME} ${ACCC_SOURCES}) -SD_INSTALL_FILES(BIN TARGETS ${SD_TOOLS_EXECPREFIX}accc) +IF(UNIX) + SD_INSTALL_FILES(MAN man6 PREFIX ${SOURCE_DIR}/doc/man FILES ${_TARGET_NAME}.6) +ENDIF(UNIX) + +SD_INSTALL_FILES(BIN TARGETS ${_TARGET_NAME}) diff --git a/src/tools/menuview/CMakeLists.txt b/src/tools/menuview/CMakeLists.txt index 1c4b06738..01211b2a9 100644 --- a/src/tools/menuview/CMakeLists.txt +++ b/src/tools/menuview/CMakeLists.txt @@ -11,9 +11,9 @@ ADD_SDLIB_INCLUDEDIR(robottools tgf tgfclient math portability) ADD_SDL_INCLUDEDIR() #disable developer warning -if (COMMAND CMAKE_POLICY) +IF(COMMAND CMAKE_POLICY) CMAKE_POLICY(SET CMP0003 NEW) -endif(COMMAND CMAKE_POLICY) +ENDIF(COMMAND CMAKE_POLICY) ADD_EXECUTABLE(${_TARGET_NAME} ${_SOURCES}) @@ -28,5 +28,9 @@ ADD_SDL_LIBRARY(${_TARGET_NAME}) ADD_PLIB_LIBRARY(${_TARGET_NAME} sg ssg ul) ADD_DL_LIBRARY(${_TARGET_NAME}) +IF(UNIX) + SD_INSTALL_FILES(MAN man6 PREFIX ${SOURCE_DIR}/doc/man FILES ${_TARGET_NAME}.6) +ENDIF(UNIX) + SD_INSTALL_FILES(BIN TARGETS ${_TARGET_NAME}) diff --git a/src/tools/nfs2ac/CMakeLists.txt b/src/tools/nfs2ac/CMakeLists.txt index 37f10d4fc..26fa35c32 100644 --- a/src/tools/nfs2ac/CMakeLists.txt +++ b/src/tools/nfs2ac/CMakeLists.txt @@ -2,7 +2,14 @@ INCLUDE(../../../cmake/macros.cmake) PROJECT(nfs2ac) +SET(_TARGET_NAME ${SD_TOOLS_EXECPREFIX}nfs2ac) + SET(NFS2AC_SOURCES mainnfs2ac.cpp) -ADD_EXECUTABLE(${SD_TOOLS_EXECPREFIX}nfs2ac ${NFS2AC_SOURCES}) -SD_INSTALL_FILES(BIN TARGETS ${SD_TOOLS_EXECPREFIX}nfs2ac) +ADD_EXECUTABLE(${_TARGET_NAME} ${NFS2AC_SOURCES}) + +IF(UNIX) + SD_INSTALL_FILES(MAN man6 PREFIX ${SOURCE_DIR}/doc/man FILES ${_TARGET_NAME}.6) +ENDIF(UNIX) + +SD_INSTALL_FILES(BIN TARGETS ${_TARGET_NAME}) diff --git a/src/tools/nfsperf/CMakeLists.txt b/src/tools/nfsperf/CMakeLists.txt index 9d2f09863..fbfc0be2a 100644 --- a/src/tools/nfsperf/CMakeLists.txt +++ b/src/tools/nfsperf/CMakeLists.txt @@ -2,19 +2,26 @@ INCLUDE(../../../cmake/macros.cmake) PROJECT(nfsperf) +SET(_TARGET_NAME ${SD_TOOLS_EXECPREFIX}nfsperf) + SET(NFSPERF_SOURCES mainnfsperf.cpp) + ADD_SDLIB_INCLUDEDIR(tgf portability) -IF (COMMAND cmake_policy) - cmake_policy(SET CMP0003 NEW) -ENDIF(COMMAND cmake_policy) +IF(COMMAND CMAKE_POLICY) + CMAKE_POLICY(SET CMP0003 NEW) +ENDIF(COMMAND CMAKE_POLICY) -ADD_EXECUTABLE(${SD_TOOLS_EXECPREFIX}nfsperf ${NFSPERF_SOURCES}) +ADD_EXECUTABLE(${_TARGET_NAME} ${NFSPERF_SOURCES}) -ADD_SDLIB_LIBRARY(${SD_TOOLS_EXECPREFIX}nfsperf tgf txml) +ADD_SDLIB_LIBRARY(${_TARGET_NAME} tgf txml) IF(UNIX) - TARGET_LINK_LIBRARIES(${SD_TOOLS_EXECPREFIX}nfsperf dl) + TARGET_LINK_LIBRARIES(${_TARGET_NAME} dl) ENDIF(UNIX) -SD_INSTALL_FILES(BIN TARGETS ${SD_TOOLS_EXECPREFIX}nfsperf) +IF(UNIX) + SD_INSTALL_FILES(MAN man6 PREFIX ${SOURCE_DIR}/doc/man FILES ${_TARGET_NAME}.6) +ENDIF(UNIX) + +SD_INSTALL_FILES(BIN TARGETS ${_TARGET_NAME}) diff --git a/src/tools/trackgen/CMakeLists.txt b/src/tools/trackgen/CMakeLists.txt index 2902c4086..60a092bce 100644 --- a/src/tools/trackgen/CMakeLists.txt +++ b/src/tools/trackgen/CMakeLists.txt @@ -35,5 +35,9 @@ ADD_SDL_LIBRARY(${_TARGET_NAME}) ADD_PLIB_LIBRARY(${_TARGET_NAME} sg ssg ul) ADD_DL_LIBRARY(${_TARGET_NAME}) +IF(UNIX) + SD_INSTALL_FILES(MAN man6 PREFIX ${SOURCE_DIR}/doc/man FILES ${_TARGET_NAME}.6) +ENDIF(UNIX) + SD_INSTALL_FILES(BIN TARGETS ${_TARGET_NAME})