tDocumentation updated for -C command line option and boolean config variables - vaccinewars - be a doctor and try to vaccinate the world
git clone git://src.adamsgaard.dk/vaccinewars
Log
Files
Refs
README
LICENSE
---
commit 9ce607e613167dd3694b404dcda733c148b8a09d
parent 81b19143416188eca0c13971a780468b2e1889fb
Author: Ben Webb 
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
 maximum number of clients is exceeded),
 but it makes it harder to find. The connection to the
 metaserver can also be disabled by adding
-MetaServer.Active=0 to the
+MetaServer.Active=FALSE to the
 configuration files.
 
 
-g file
t@@ -122,6 +122,15 @@ used where available, falling back to a text-mode client in case of error.
 
When running a dopewars client, forces the use of a text-mode (curses
 or console mode) interface, even if graphics are available.
 
+
-C file
+
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.)
+
 
-h
 
Displays a brief description of the available command line options, and
 contact details.
t@@ -135,6 +144,6 @@ contact details.
 
-
Last update: 13-05-2001

+
Last update: 24-09-2001

 
 
diff --git a/doc/configfile.html b/doc/configfile.html
t@@ -25,9 +25,12 @@ directory
 
  • Options specified on the command line
 
 
-
    Settings in a configuration file can set numbers, strings or "string lists".
-A numerical value is set with a command such as Port=7902 (which sets
-the TCP port for mulitplayer connections to 7902).
    
+
    Settings in a configuration file can set numbers, booleans, strings or
+"string lists". A numerical value is set with a command such as
+Port=7902 (which sets the TCP port for mulitplayer connections to
+7902). Booleans are "on/off" or "true/false" variables, set with commands
+such as Sanitized=TRUE (which removes drug references from random
+events in the game).
    
 
 
    String (text) values are set with commands such as BankName='the bank'
 (which sets the name of the bank). Notice that string values must be
t@@ -94,19 +97,19 @@ to store high scores. This can be overridden with the -f
 
    Sets the pager used to display multi-page output in an interactive server
 to more. ("less" is a popular alternative)
 
-
    ConfigVerbose=0
+
    ConfigVerbose=FALSE
 
    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.
 
 
 
    Metaserver configuration
    
 
    
-
    MetaServer.Active=1
+
    MetaServer.Active=TRUE
 
    Tells the dopewars server to report its status to the
-metaserver. If 1
-is replaced by 0 (zero) the server will not report to the metaserver.
-This setting, if set to 1, can be overridden by the -S
+metaserver. If TRUE
+is replaced by FALSE the server will not report to the metaserver.
+This setting, if set to TRUE, can be overridden by the -S
 command line option.
 
 
    MetaServer.Name="dopewars.sourceforge.net"
t@@ -228,9 +231,9 @@ the game.
 
    Drug[6].MaxPrice=4400
 
    Sets the usual maximum price of drug number 6 to be $4,400.
 
-
    Drug[1].Cheap=1
+
    Drug[1].Cheap=TRUE
 
    Tells dopewars that drug 1 (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).
 
 
    Drug[1].CheapStr="The market is flooded with cheap
 home-made acid!"
t@@ -242,9 +245,9 @@ is especially cheap.
 normal price distribution (between Drug[x].MinPrice and Drug[x].MaxPrice) by
 4.
 
-
    Drug[4].Expensive=1
+
    Drug[4].Expensive=TRUE
 
    Tells dopewars that drug 4 (normally Heroin) can occasionally be
-particuarly expensive (0, zero, cancels this).
+particuarly expensive (FALSE cancels this).
 
 
    Drugs.ExpensiveStr1="Cops made a big %s bust! Prices are
 outrageous!"
t@@ -360,8 +363,8 @@ timestamp is added to log messages.
 
    Defines the game to end after 31 "days" or turns. If this is set
 to 0 (zero) the game never ends for a player, unless they quit or are killed.
 
-
    Sanitized=0
-
    If set to 1, this "sanitizes" the game by removing all drug references
+
    Sanitized=FALSE
+
    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 SubwaySaying for more details.
 
    NumStoppedTo=5
 
    Sets there to be 5 distinct things which you can stop to do.
 
-
    DrugValue=1
-
    If non-zero, then the server will keep track of the price you paid for
+
    DrugValue=TRUE
+
    If TRUE, then the server will keep track of the price you paid for
 any drugs, and clients will display this information if available.
 
 
    
t@@ -500,6 +503,6 @@ any drugs, and clients will display this information if available.
 
-
    Last update: 17-06-2001
    
+
    Last update: 23-09-2001