← Back to branch summary

~ivantis/armagetronad/sty+ct+ivantis

« back to all changes in this revision

Viewing changes to src/doc/install_result.html.m4

  • Committer: ivantis
  • Date: 2008-09-09 21:33:18 UTC
  • Revision ID: ivantis@ivantis.net-20080909213318-k43y6yuq0zd6wbsa
first commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/doc/install_result.html.m4
 
1
define(FI,<tr><td><strong>$1</strong></td><td> ($2)</td></tr>)
 
2
define(FIS,<strong>$1</strong><br>)
 
3
 
 
4
PARAGRAPH([
 
5
The contents of the installation directory should be something like this:
 
6
])
 
7
 
 
8
TABLE([
 
9
ifelse(DOCSTYLE_RESULT,unix,
 
10
FI(bin,the directory with the executables and scripts),
 
11
FI(PROGNAME.exe,the main executable))
 
12
FI(models,the directory for the cycle models)
 
13
FI(sound,the directory for sound files)
 
14
FI(textures,the directory for textures and the icon)
 
15
FI(resources,the directory for maps)
 
16
FI(doc,the documentation you are just reading)
 
17
FI(language,the game's text messages)
 
18
ifelse(DOCSTYLE_RESUT,unix,,
 
19
[FI(config,static configuration files)]
 
20
)
 
21
dnl FI(var,game logs and custom configuration)
 
22
])
 
23
 
 
24
ifelse(DOCSTYLE_RESULT,unix,
 
25
[
 
26
PARAGRAPH([
 
27
The system wide configuration is stored in 
 
28
ifelse(DOCSTYLE,web,
 
29
[FILE([CONFIGPATH_ETC]) (default) or FILE([CONFIGPATH_NOETC]), depending on your distributors choice.],
 
30
[FILE([CONFIGPATH]).],
 
31
,)
 
32
])
 
33
])
 
34
 
 
35
PARAGRAPH([
 
36
Additionally, if you installed the moviepack/moviesounds
 
37
from the ELINK(WEBBASE/addons.html,addons page),
 
38
you'll see the two directories
 
39
])
 
40
 
 
41
FIS(moviepack)
 
42
FIS(moviesounds)
 
43
 
 
44
define(VAR, ifelse( DOCSTYLE_RESULT,unix, FILE(~/.armagetron/var), the FILE(var) subdirectory))
 
45
 
 
46
 
 
47
PARAGRAPH([
 
48
containing ONLY files and no subdirectories.
 
49
When you have run PROGTITLE, you'll see the additional files
 
50
])
 
51
 
 
52
<table>
 
53
FI([highscores.txt,ladder.txt,won_matches.txt and won_rounds.txt],
 
54
score statistics files)
 
55
FI(user.cfg,PROGTITLE custom configuration file)
 
56
</table>
 
57
 
 
58
PARAGRAPH([
 
59
Inside VAR,
 
60
You may want to create your own 
 
61
<a href="config.html#files">configuration files</a>
 
62
])
 
63
 
 
64
<table>
 
65
FI(autoexec.cfg,config file read at every start)
 
66
</table>
 
67
inside VAR or the 
 
68
FILE(config) subdirectory for your 
 
69
custom modifications; that way, they don't get overwritten by the defaults the
 
70
next time you install an update.
 
71
 
 
72
define(CL,<tr><td valign=top width=200><strong>$1</strong> </td><td>$2</td></tr>)
 
73
 
 
74
<a name=cl>SUBSECTION(Command line switches)</a>
 
75
<table>
 
76
CL([-h, +h, --help              ] ,[ get help and other available command line options])
 
77
CL([-v, +v, --version           ], [ print version number ])
 
78
CL(,) 
 
79
CL([--datadir <Directory>       ], [ systemwide data directory; read game data (textures, sounds and text) from this directory. ] )
 
80
CL([--userdatadir <Directory>   ], [ user data dir; try to read all game data from this directory first. ])
 
81
CL([--configdir <Directory>     ], [ read game configuration (.cfg-files) from this directory.])
 
82
CL([--userconfigdir <Directory> ], [ user configuration directory; try to read the configuration from here first. ])
 
83
CL([--vardir <Directory>        ], [ save game logs, highscores and user configuration in this directory. ])
 
84
CL(,) 
 
85
CL([-f, +f, --fullscreen        ], [ start in fullscreen mode])
 
86
CL([-w, +w, --window, --windowed], [ start in windowed mode  ])
 
87
CL(,) 
 
88
ifelse(DOCSTYLE_RESULT,windows,[
 
89
CL([+directx, -directx          ], [ enable/disable usage of DirectX for screen initialisation]) 
 
90
],[
 
91
CL([-d, +d, --daemon            ], [allow the dedicated server to run as a daemon (will not poll for input on stdin)])
 
92
])
 
93
</table>
 
94
 
 
95
PARAGRAPH([
 
96
The various directories you can set have the following impact on how the game loads and saves files.
 
97
(Usually, you don't have to bother about it; there are reasonable defaults. But if you want to do
 
98
some meddling with the data, these options are your ticket.)
 
99
])
 
100
 
 
101
SUBSUBSECTION([Data])
 
102
PARAGRAPH([
 
103
Sounds, textures and models will be first looked for in the directory specified with OPTION(--userdatadir). If they are not
 
104
found there or if OPTION(--userdatadir) was not used, they are looked for in the directory specified with OPTION(--datadir).
 
105
This directory defaults to the current directory if not specified. 
 
106
])
 
107
 
 
108
SUBSUBSECTION([Configuration])
 
109
PARAGRAPH([
 
110
(I'll leave out the bits about "if option xxx is not set" from now on )
 
111
Configuration files are first looked for in OPTION(--userconfigdir), then OPTION(--userdatadir/config) ( the dir passed to OPTION(--userdatadir), appended with FILE(/config) ),
 
112
then OPTION(--configdir) and finally OPTION(--datadir/config).
 
113
])
 
114
 
 
115
SUBSUBSECTION([Logs and user configuration])
 
116
PARAGRAPH([
 
117
Log files ( game results, the settings made in the in game menu )  are loaded from OPTION(--vardir), then, if not found there, from OPTION(--userdatadir/var) and finally from OPTION(--datadir/var).
 
118
They are only saved in the first of these directories that was specified.
 
119
])
 
120
 
 
121
ifelse(DOCSTYLE_RESULT, unix,
 
122
PARAGRAPH([
 
123
[The starter scripts will use the options OPTION([--datadir PREFIX/games/PROGNAME --userdatadir ~/.PROGNAME --configdir CONFIGPATH]). So, your personal configuration will sit in FILE([~.armagetron/var]).
 
124
])
 
125
])