tGNU-style long command line options added; explanation of -A option added; explanation of i18n under Win32 added. - 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
---
(DIR) commit 5471fb80fcc096a94059c1bcba629fed8faaa460
(DIR) parent 0381f309d178d6733dd27c8ca335ccc0e1a7fbd4
(HTM) Author: Ben Webb <ben@salilab.org>
Date: Mon, 4 Feb 2002 15:19:50 +0000
GNU-style long command line options added; explanation of -A option added;
explanation of i18n under Win32 added.
Diffstat:
M doc/commandline.html | 47 +++++++++++++++++++------------
M doc/i18n.html | 19 +++++++++++--------
2 files changed, 40 insertions(+), 26 deletions(-)
---
(DIR) diff --git a/doc/commandline.html b/doc/commandline.html
t@@ -28,32 +28,37 @@ the <b>-g</b> option below).</p>
<p>For a brief description of the command line options, specify the option
<b>-h</b> with the command<br />
<tt><b>dopewars -h</b></tt><br />
-A list of the other command line options is presented below.</p>
+A list of all command line options is presented below. Please note that
+most options have a "short" format (e.g. <b>-p</b>) and a "long" format
+(e.g. <b>--port</b>). The "long" form is only available on systems that
+have GNU getopt; this <b>excludes</b> the Windows version.</p>
<dl>
-<dt><b>-b</b></dt>
+<dt><b>-b</b>, <b>--no-color</b>, <b>--no-colour</b></dt>
<dd>"Black and white". This tells the dopewars client (if that is what
you're running) not to use coloured text (by default, colour is used if the
terminal and curses support it).</dd>
-<dt><a name="singleplayer"><b>-n</b></a></dt>
+<dt><a name="singleplayer"><b>-n</b>, <b>--single-player</b></a></dt>
<dd>If running the client, run in single-player mode. Don't try to connect
to any available dopewars servers.</dd>
-<dt><a name="antique"><b>-a</b></a></dt>
+<dt><a name="antique"><b>-a</b>, <b>--antique</b></a></dt>
<dd>Puts the client into "antique" mode; dopewars is derived from the
earlier game for MS-DOS of the same name, which in turn was based on
"Drug Wars" by John E. Dell. "Antique" mode aims to follow the behaviour
of the MS-DOS dopewars closely, and consequently this entails single-player
mode also.</dd>
-<dt><a name="hiscore"><b>-f <i>file</i></b></a></dt>
+<dt><a name="hiscore"><b>-f <i>file</i></b>, <b>--scorefile=<i>file</i></b>
+</a></dt>
<dd>Specifies the path and name of the file used to store the dopewars
high scores in; this can alternatively be specified in the configuration file
with the <a href="configfile.html#HiScoreFile">HiScoreFile=<i>file</i></a>
option.</dd>
-<dt><a name="server"><b>-o <i>addr</i></b></a></dt>
+<dt><a name="server"><b>-o <i>addr</i></b>, <b>--hostname=<i>addr</i></b>
+</a></dt>
<dd>Gives the name of the machine running a dopewars server, in human
readable (e.g. "nowhere.com") or dotted quad (e.g. 127.0.0.1) form. When the
client is started, if not in single-player mode, it automatically attempts to
t@@ -61,7 +66,7 @@ connect to this server for a multiplayer game. This can also be specified with
the <a href="configfile.html#Server">Server=<i>addr</i></a> configuration file
option.</dd>
-<dt><a name="port"><b>-p <i>port</i></b></a></dt>
+<dt><a name="port"><b>-p <i>port</i></b>, <b>--port=<i>port</i></b></a></dt>
<dd>Specifies the numeric port number which the server uses. This is usually
7902, but some servers may use other port numbers to avoid conflicts with
other services running on the machine. If you are running the dopewars client,
t@@ -72,7 +77,7 @@ setting the port number with the
<a href="configfile.html#Port">Port=<i>port</i></a> configuration file
option.</dd>
-<dt><b>-s</b></dt>
+<dt><b>-s</b>, <b>--public-server</b></dt>
<dd>Runs the <a href="server.html">dopewars server</a>. This mediates
multiplayer games of dopewars, and keeps track of high scores. Any player
wishing to join the game hosted
t@@ -83,7 +88,7 @@ status to the <a href="metaserver.html">metaserver</a>, unless it is set
otherwise in the <a href="configfile.html#MetaServerActive">configuration
file</a>.</dd>
-<dt><a name="privateserver"><b>-S</b></a></dt>
+<dt><a name="privateserver"><b>-S</b>, <b>--private-server</b></a></dt>
<dd>Also runs a dopewars server, but in this case <b>does not</b> report its
status to the metaserver. This does not stop clients from connecting to your
server, of course (unless it is behind a firewall, or the
t@@ -93,7 +98,13 @@ but it makes it harder to find. The connection to the
<a href="configfile.html#MetaServerActive">MetaServer.Active=FALSE</a> to the
configuration files.</dd>
-<dt><b>-g <i>file</i></b></dt>
+<dt><b>-A</b>, <b>--admin</b></dt>
+<dd>Connects to a dopewars server running on this machine, and allows
+<a href="servercommands.html">server commands</a> to be issued. Only the user
+that originally started the server (or the superuser) is permitted to do
+this. Only supported for the text-mode server on Unix systems.</dd>
+
+<dt><b>-g <i>file</i></b>, <b>--config-file=<i>file</i></b></dt>
<dd>Instructs dopewars to read setup information from the
<a href="configfile.html">configuration file</a> named by <b><i>file</i></b>.
This file is read immediately - i.e. at the point at which the -g option is
t@@ -102,18 +113,18 @@ configuration files or by previous command line options. Command line options
occurring <b>after</b> the -g option, or for that matter further -g options,
that change these same settings, will then override them.</dd>
-<dt><b>-r <i>file</i></b></dt>
+<dt><b>-r <i>file</i></b>, <b>--pidfile=<i>file</i></b></dt>
<dd>Maintains a pid file with the specified name while the server is running.
The file is a one-line text file, containing the process ID of the dopewars
server process, and is deleted when the server quits.</dd>
-<dt><a name="computer"><b>-c</b></a></dt>
+<dt><a name="computer"><b>-c</b>, <b>--ai-player</b></a></dt>
<dd>Runs a computerised player. This will connect to the specifed dopewars
server and join in the multiplayer game going on there. When the player
finishes the game (or is eliminated by the other players or the server) the
program finishes.</dd>
-<dt><a name="gui-client"><b>-w</b></a></dt>
+<dt><a name="gui-client"><b>-w</b>, <b>--windowed-client</b></a></dt>
<dd>If running a dopewars client, then this forces the use of a graphical
user interface. Under Microsoft Windows, this is an "ordinary" window, while
under Unix, this uses GTK+. If a suitable environment is not present (e.g.
t@@ -122,11 +133,11 @@ you are not running X) then dopewars will quit with an error. By default,
if neither -w or -t are specified, then a graphical user interface will be
used where available, falling back to a text-mode client in case of error.</dd>
-<dt><a name="text-client"><b>-t</b></a></dt>
+<dt><a name="text-client"><b>-t</b>, <b>--text-client</b></a></dt>
<dd>When running a dopewars client, forces the use of a text-mode (curses
or console mode) interface, even if graphics are available.</dd>
-<dt><b>-C <i>file</i></b></dt>
+<dt><b>-C <i>file</i></b>, <b>--convert=<i>file</i></b></dt>
<dd>Converts a high score file from an older version of dopewars to the format
used by the current version. The old high score file is replaced with a new
file, and a backup copy of the old file is made. This conversion process is
t@@ -135,11 +146,11 @@ files properly, so they cannot be automatically converted. (Such automatic
conversion would also pose a security risk if the dopewars binary is running
setgid.)</dd>
-<dt><b>-h</b></dt>
+<dt><b>-h</b>, <b>--help</b></dt>
<dd>Displays a brief description of the available command line options, and
contact details.</dd>
-<dt><b>-v</b></dt>
+<dt><b>-v</b>, <b>--version</b></dt>
<dd>Displays the current dopewars version number, and then exits.</dd>
</dl>
t@@ -148,6 +159,6 @@ contact details.</dd>
<ul>
<li><a href="index.html">Main index</a></li>
</ul>
-<p>Last update: <b>24-09-2001</b></p>
+<p>Last update: <b>04-02-2002</b></p>
</body>
</html>
(DIR) diff --git a/doc/i18n.html b/doc/i18n.html
t@@ -45,8 +45,10 @@ the following are some possible explanations:-</p>
<li>dopewars cannot find the locale-specific language file - by default, stored
under /usr/local/share/locale/</li>
<li>Your language is not yet supported - why not add it yourself?</li>
-<li>Your system does not have locale support (at present i18n only functions
-properly on Unix systems - not Windows)</li>
+<li>Your system does not have locale support.</li>
+<li>On a Windows system, you need to select the language from the relevant
+section of Control Panel (or set the LANG environment variable, below). i18n
+under Windows is only supported by version 1.5.3 and later.</li>
<li>You haven't set an environment variable to specify your locale (usually
this is done automatically). For example, if you're using the <tt>bash</tt>
shell and want a German translation, the command "<tt>export LANG=de_DE</tt>"
t@@ -148,11 +150,12 @@ version</a></h2>
<p>New versions of dopewars will often change what is printed to the user, and
so may may require changes to the translation. To update an existing
-translation, "<tt>make</tt>" the new version of dopewars. This will create
-a <tt>dopewars.pot</tt> file listing the strings that need translating. Change
-into the <tt>po/</tt> subdirectory, and create a new translation file from
-your "old" translation file (we'll assume it's called <tt>de.po</tt>) and
-<tt>dopewars.pot</tt> with the <tt>msgmerge</tt> command:-<br />
+translation, change into the <tt>po</tt> subdirectory of the dopewars
+source code, and do a "<tt>make dopewars.pot</tt>". This creates the
+<tt>dopewars.pot</tt> file, which lists the strings that need translating.
+Next, create a new translation file from your "old" translation file (we'll
+assume it's called <tt>de.po</tt>) and <tt>dopewars.pot</tt> with the
+<tt>msgmerge</tt> command:-<br />
<tt>msgmerge -o newfile de.po dopewars.pot</tt><br />
Examine this new file <tt>newfile</tt> for translations that need updating
(a search for "fuzzy" should find most of them) and then overwrite your old
t@@ -201,7 +204,7 @@ contributed to the main dopewars distribution!</p>
<ul>
<li><a href="index.html">Main index</a></li>
</ul>
-<p>Last update: <b>16-10-2001</b></p>
+<p>Last update: <b>04-02-2002</b></p>
</body>
</html>