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