tDocumentation updated for -C command line option and boolean config variables … | |
git clone git://src.adamsgaard.dk/vaccinewars | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 9ce607e613167dd3694b404dcda733c148b8a09d | |
parent 81b19143416188eca0c13971a780468b2e1889fb | |
Author: Ben Webb <[email protected]> | |
Date: Mon, 24 Sep 2001 22:09:26 +0000 | |
Documentation updated for -C command line option and boolean config variables | |
Diffstat: | |
M doc/commandline.html | 13 +++++++++++-- | |
M doc/configfile.html | 39 +++++++++++++++++------------… | |
2 files changed, 32 insertions(+), 20 deletions(-) | |
--- | |
diff --git a/doc/commandline.html b/doc/commandline.html | |
t@@ -86,7 +86,7 @@ server, of course (unless it is behind a firewall, or the | |
<a href="configfile.html#MaxClients">maximum number of clients</a> is exceeded… | |
but it makes it harder to find. The connection to the | |
<a href="metaserver.html">metaserver</a> can also be disabled by adding | |
-<a href="configfile.html#MetaServerActive">MetaServer.Active=0</a> to the | |
+<a href="configfile.html#MetaServerActive">MetaServer.Active=FALSE</a> to the | |
configuration files. | |
<dt><b>-g <i>file</i></b> | |
t@@ -122,6 +122,15 @@ used where available, falling back to a text-mode client … | |
<dd>When running a dopewars client, forces the use of a text-mode (curses | |
or console mode) interface, even if graphics are available. | |
+<dt><b>-C <i>file</i></b></a> | |
+<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 | |
+necessary since older versions of dopewars did not identify the high score | |
+files properly, so they cannot be automatically converted. (Such automatic | |
+conversion would also pose a security risk if the dopewars binary is running | |
+setgid.) | |
+ | |
<dt><b>-h</b> | |
<dd>Displays a brief description of the available command line options, and | |
contact details. | |
t@@ -135,6 +144,6 @@ contact details. | |
<ul> | |
<li><a href="index.html">Main index</a> | |
</ul> | |
-<p>Last update: <b>13-05-2001</b></p> | |
+<p>Last update: <b>24-09-2001</b></p> | |
</body> | |
</html> | |
diff --git a/doc/configfile.html b/doc/configfile.html | |
t@@ -25,9 +25,12 @@ directory | |
<li>Options specified on the <a href="commandline.html">command line</a> | |
</ol> | |
-<p>Settings in a configuration file can set numbers, strings or "string lists". | |
-A numerical value is set with a command such as <b>Port=7902</b> (which sets | |
-the TCP port for mulitplayer connections to 7902).</p> | |
+<p>Settings in a configuration file can set numbers, booleans, strings or | |
+"string lists". A numerical value is set with a command such as | |
+<b>Port=7902</b> (which sets the TCP port for mulitplayer connections to | |
+7902). Booleans are "on/off" or "true/false" variables, set with commands | |
+such as <b>Sanitized=TRUE</b> (which removes drug references from random | |
+events in the game).</p> | |
<p>String (text) values are set with commands such as <b>BankName='the bank'</… | |
(which sets the name of the bank). Notice that string values <b>must</b> be | |
t@@ -94,19 +97,19 @@ to store high scores. This can be overridden with the -f | |
<dd>Sets the pager used to display multi-page output in an interactive server | |
to <i>more</i>. ("less" is a popular alternative) | |
-<dt><b>ConfigVerbose=<i>0</i></b> | |
+<dt><b>ConfigVerbose=<i>FALSE</i></b> | |
<dd>Prints extra feedback information when processing the config. file if set | |
-to 1; this only takes affect, of course, after the ConfigVerbose variable is | |
+to TRUE; this only takes affect, of course, after the ConfigVerbose variable is | |
set, and then remains in force until it is reset again. | |
</dl> | |
<h2><a name="metaserver">Metaserver configuration</a></h2> | |
<dl> | |
-<dt><a name="MetaServerActive"><b>MetaServer.Active=<i>1</i></b></a> | |
+<dt><a name="MetaServerActive"><b>MetaServer.Active=<i>TRUE</i></b></a> | |
<dd>Tells the dopewars server to report its status to the | |
-<a href="metaserver.html">metaserver</a>. If <i>1</i> | |
-is replaced by <i>0</i> (zero) the server will not report to the metaserver. | |
-This setting, if set to 1, can be overridden by the -S | |
+<a href="metaserver.html">metaserver</a>. If <i>TRUE</i> | |
+is replaced by <i>FALSE</i> the server will not report to the metaserver. | |
+This setting, if set to TRUE, can be overridden by the -S | |
<a href="commandline.html#privateserver">command line option</a>. | |
<dt><b>MetaServer.Name=<i>"dopewars.sourceforge.net"</i></b> | |
t@@ -228,9 +231,9 @@ the game. | |
<dt><b>Drug[<i>6</i>].MaxPrice=<i>4400</i></b> | |
<dd>Sets the usual maximum price of drug number <i>6</i> to be <i>$4,400</i>. | |
-<dt><b>Drug[<i>1</i>].Cheap=<i>1</i></b> | |
+<dt><b>Drug[<i>1</i>].Cheap=<i>TRUE</i></b> | |
<dd>Tells dopewars that drug <i>1</i> (by default, Acid) can occasionally | |
-be especially cheap (if this is set to 0, zero, this does not happen). | |
+be especially cheap (if this is set to FALSE, this does not happen). | |
<dt><b>Drug[<i>1</i>].CheapStr=<i>"The market is flooded with cheap | |
home-made acid!"</i></b> | |
t@@ -242,9 +245,9 @@ is especially cheap. | |
normal price distribution (between Drug[x].MinPrice and Drug[x].MaxPrice) by | |
<i>4</i>. | |
-<dt><b>Drug[<i>4</i>].Expensive=<i>1</i></b> | |
+<dt><b>Drug[<i>4</i>].Expensive=<i>TRUE</i></b> | |
<dd>Tells dopewars that drug <i>4</i> (normally Heroin) can occasionally be | |
-particuarly expensive (0, zero, cancels this). | |
+particuarly expensive (FALSE cancels this). | |
<dt><b>Drugs.ExpensiveStr1=<i>"Cops made a big %s bust! Prices are | |
outrageous!"</i></b> | |
t@@ -360,8 +363,8 @@ timestamp is added to log messages. | |
<dd>Defines the game to end after <i>31</i> "days" or turns. If this is set | |
to 0 (zero) the game never ends for a player, unless they quit or are killed. | |
-<dt><b>Sanitized=<i>0</i></b> | |
-<dd>If set to 1, this "sanitizes" the game by removing all drug references | |
+<dt><b>Sanitized=<i>FALSE</i></b> | |
+<dd>If set to TRUE, this "sanitizes" the game by removing all drug references | |
from the random events. To completely remove drug references, of course, you | |
must also alter the drug names above. | |
t@@ -490,8 +493,8 @@ see <b>SubwaySaying</b> for more details. | |
<dt><b>NumStoppedTo=<i>5</i></b> | |
<dd>Sets there to be <i>5</i> distinct things which you can stop to do. | |
-<dt><b>DrugValue=<i>1</i></b> | |
-<dd>If non-zero, then the server will keep track of the price you paid for | |
+<dt><b>DrugValue=<i>TRUE</i></b> | |
+<dd>If TRUE, then the server will keep track of the price you paid for | |
any drugs, and clients will display this information if available. | |
</dl> | |
t@@ -500,6 +503,6 @@ any drugs, and clients will display this information if av… | |
<ul> | |
<li><a href="index.html">Main index</a> | |
</ul> | |
-<p>Last update: <b>17-06-2001</b></p> | |
+<p>Last update: <b>23-09-2001</b></p> | |
</body> | |
</html> |