tcommandline.html - vaccinewars - be a doctor and try to vaccinate the world
(HTM) git clone git://src.adamsgaard.dk/vaccinewars
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
tcommandline.html (8864B)
---
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
4 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
5
6 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
7
8 <head>
9 <title>dopewars command line options</title>
10 <meta charset="utf-8"/>
11 </head>
12
13 <body>
14 <h1>dopewars command line options</h1>
15
16 <p>Once you have <a href="installation.html">installed</a> dopewars, you should
17 be able to run the binary just by typing<br />
18 <tt><b>dopewars</b></tt><br />
19 (unless you have installed the binary in a directory which is not in your
20 path, in which case precede it with the path). Run without any options,
21 the dopewars binary runs as a dopewars client.</p>
22
23 <p>Command line options can be used to configure common aspects of dopewars.
24 More exhaustive configuration is possible by editing the dopewars
25 <a href="configfile.html">configuration files</a>; note, however, that
26 command line options can be used to override some of these settings (also see
27 the <b>-g</b> option below).</p>
28
29 <p>For a brief description of the command line options, specify the option
30 <b>-h</b> with the command<br />
31 <tt><b>dopewars -h</b></tt><br />
32 A list of all command line options is presented below. Please note that
33 most options have a "short" format (e.g. <b>-p</b>) and a "long" format
34 (e.g. <b>--port</b>). The "long" form is only available on systems that
35 have GNU getopt; this <b>excludes</b> the Windows version.</p>
36
37 <dl>
38 <dt><b>-b</b>, <b>--no-color</b>, <b>--no-colour</b></dt>
39 <dd>"Black and white". This tells the dopewars client (if that is what
40 you're running) not to use coloured text (by default, colour is used if the
41 terminal and curses support it).</dd>
42
43 <dt><a id="singleplayer"><b>-n</b>, <b>--single-player</b></a></dt>
44 <dd>If running the client, run in single-player mode. Don't try to connect
45 to any available dopewars servers.</dd>
46
47 <dt><a id="antique"><b>-a</b>, <b>--antique</b></a></dt>
48 <dd>Puts the client into "antique" mode; dopewars is derived from the
49 earlier game for MS-DOS of the same name, which in turn was based on
50 "Drug Wars" by John E. Dell. "Antique" mode aims to follow the behaviour
51 of the MS-DOS dopewars closely, and consequently this entails single-player
52 mode also.</dd>
53
54 <dt><a id="hiscore"><b>-f <i>file</i></b>, <b>--scorefile=<i>file</i></b>
55 </a></dt>
56 <dd>Specifies the path and name of the file used to store the dopewars
57 high scores in; this can alternatively be specified in the configuration file
58 with the <a href="configfile.html#HiScoreFile">HiScoreFile=<i>file</i></a>
59 option. (N.B. This option cannot be used to get dopewars to open a high
60 score file with privilege when running setuid/setgid; all privileges are
61 dropped by this point for security.)</dd>
62
63 <dt><a id="server"><b>-o <i>addr</i></b>, <b>--hostname=<i>addr</i></b>
64 </a></dt>
65 <dd>Gives the name of the machine running a dopewars server, in human
66 readable (e.g. "nowhere.com") or dotted quad (e.g. 127.0.0.1) form. When the
67 client is started, if not in single-player mode, it automatically attempts to
68 connect to this server for a multiplayer game. This can also be specified with
69 the <a href="configfile.html#Server">Server=<i>addr</i></a> configuration file
70 option.</dd>
71
72 <dt><a id="port"><b>-p <i>port</i></b>, <b>--port=<i>port</i></b></a></dt>
73 <dd>Specifies the numeric port number which the server uses. This is usually
74 7902, but some servers may use other port numbers to avoid conflicts with
75 other services running on the machine. If you are running the dopewars client,
76 it will search for a server on this port; if you are running the server, it
77 will bind to this port and wait for connections from clients (the clients
78 must also be instructed to use this port, of course). This is equivalent to
79 setting the port number with the
80 <a href="configfile.html#Port">Port=<i>port</i></a> configuration file
81 option.</dd>
82
83 <dt><b>-s</b>, <b>--public-server</b></dt>
84 <dd>Runs the <a href="server.html">dopewars server</a>. This mediates
85 multiplayer games of dopewars, and keeps track of high scores. Any player
86 wishing to join the game hosted
87 by this server must connect to your machine using the dopewars client and the
88 port number which you have chosen, and can then interact with other players
89 who have done the same thing. By default, a dopewars server will report its
90 status to the <a href="metaserver.html">metaserver</a>, unless it is set
91 otherwise in the <a href="configfile.html#MetaServerActive">configuration
92 file</a>.</dd>
93
94 <dt><a id="privateserver"><b>-S</b>, <b>--private-server</b></a></dt>
95 <dd>Also runs a dopewars server, but in this case <b>does not</b> report its
96 status to the metaserver. This does not stop clients from connecting to your
97 server, of course (unless it is behind a firewall, or the
98 <a href="configfile.html#MaxClients">maximum number of clients</a> is exceeded),
99 but it makes it harder to find. The connection to the
100 <a href="metaserver.html">metaserver</a> can also be disabled by adding
101 <a href="configfile.html#MetaServerActive">MetaServer.Active=FALSE</a> to the
102 configuration files.</dd>
103
104 <dt><b>-A</b>, <b>--admin</b></dt>
105 <dd>Connects to a dopewars server running on this machine, and allows
106 <a href="servercommands.html">server commands</a> to be issued. Only the user
107 that originally started the server (or the superuser) is permitted to do
108 this. Only supported for the text-mode server on Unix systems.</dd>
109
110 <dt><b>-g <i>file</i></b>, <b>--config-file=<i>file</i></b></dt>
111 <dd>Instructs dopewars to read setup information from the
112 <a href="configfile.html">configuration file</a> named by <b><i>file</i></b>.
113 This file is read immediately - i.e. at the point at which the -g option is
114 encountered - and so these settings will override any set in the default
115 configuration files or by previous command line options. Command line options
116 occurring <b>after</b> the -g option, or for that matter further -g options,
117 that change these same settings, will then override them.</dd>
118
119 <dt><b>-r <i>file</i></b>, <b>--pidfile=<i>file</i></b></dt>
120 <dd>Maintains a pid file with the specified name while the server is running.
121 The file is a one-line text file, containing the process ID of the dopewars
122 server process, and is deleted when the server quits.</dd>
123
124 <dt><a id="computer"><b>-c</b>, <b>--ai-player</b></a></dt>
125 <dd>Runs a computerised player. This will connect to the specifed dopewars
126 server and join in the multiplayer game going on there. When the player
127 finishes the game (or is eliminated by the other players or the server) the
128 program finishes.</dd>
129
130 <dt><a id="gui-client"><b>-w</b>, <b>--windowed-client</b></a></dt>
131 <dd>If running a dopewars client, then this forces the use of a graphical
132 user interface. Under Microsoft Windows, this is an "ordinary" window, while
133 under Unix, this uses GTK+. If a suitable environment is not present (e.g.
134 the binary was compiled without graphical support, or - in the case of GTK+ -
135 you are not running X) then dopewars will quit with an error. By default,
136 if neither -w or -t are specified, then a graphical user interface will be
137 used where available, falling back to a text-mode client in case of error.</dd>
138
139 <dt><a id="text-client"><b>-t</b>, <b>--text-client</b></a></dt>
140 <dd>When running a dopewars client, forces the use of a text-mode (curses
141 or console mode) interface, even if graphics are available.</dd>
142
143 <dt><b>-P <i>name</i></b>, <b>--player=<i>name</i></b></dt>
144 <dd>Sets the default player name.</dd>
145
146 <dt><b>-C <i>file</i></b>, <b>--convert=<i>file</i></b></dt>
147 <dd>Converts a high score file from an older version of dopewars to the format
148 used by the current version. The old high score file is replaced with a new
149 file, and a backup copy of the old file is made. This conversion process is
150 necessary since older versions of dopewars did not identify the high score
151 files properly, so they cannot be automatically converted. (Such automatic
152 conversion would also pose a security risk if the dopewars binary is running
153 setgid.)</dd>
154
155 <dt><b>-u <i>name</i></b>, <b>--plugin=<i>name</i></b></dt>
156 <dd>Uses the named plugin for sound output. Valid options are "none" (for
157 no sound) plus any name registered by plugins found on your system. (These
158 are currently "winmm" for the Windows multimedia system plugin, and "esd"
159 and "sdl" for Unix plugins using the ESound and SDL libraries.) If no such
160 option is given, the first valid sound plugin to be found is used.</dd>
161
162 <dt><b>-h</b>, <b>--help</b></dt>
163 <dd>Displays a brief description of the available command line options, and
164 contact details.</dd>
165
166 <dt><b>-v</b>, <b>--version</b></dt>
167 <dd>Displays the current dopewars version number, and then exits.</dd>
168
169 </dl>
170
171 <hr />
172 <ul>
173 <li><a href="index.html">Main index</a></li>
174 </ul>
175 <p>
176 Last update: <b>02-06-2003</b><br />
177 Valid <a href="http://validator.w3.org/check/referer">XHTML 1.1</a>
178 </p>
179 </body>
180 </html>