tDocumentation updated to reflect new version 1.5.3 and new server interface - vaccinewars - be a doctor and try to vaccinate the world
git clone git://src.adamsgaard.dk/vaccinewars
Log
Files
Refs
README
LICENSE
---
commit a5f664993758fb2b88986ef8e0cd6e0685456633
parent ed7fb9cd1a09f667ebc6fb3fcd07a684bca1d1aa
Author: Ben Webb 
Date:   Sun,  3 Feb 2002 20:22:07 +0000

Documentation updated to reflect new version 1.5.3 and new server interface


Diffstat:
  M README                              |      20 ++++++++++----------
  M doc/index.html                      |       4 ++--
  M doc/installation.html               |      20 ++++++++++----------
  M doc/server.html                     |      57 +++++++++++++++++++------------
  M doc/windows.html                    |      15 ++++++++-------

5 files changed, 65 insertions(+), 51 deletions(-)
---
diff --git a/README b/README
t@@ -1,13 +1,13 @@
-This is dopewars 1.5.2, a game simulating the life of a drug dealer in 
+This is dopewars 1.5.3, a game simulating the life of a drug dealer in 
 New York. The aim of the game is to make lots and lots of money...
 unfortunately, you start the game with a hefty debt, accumulating interest,
 and the cops take a rather dim view of drug dealing...
 
 These are brief instructions; see the HTML documentation for full information.
 
-dopewars 1.5.2 servers should handle clients as old as version 1.4.3 with
+dopewars 1.5.3 servers should handle clients as old as version 1.4.3 with
 hardly any visible problems (the reverse is also true). However, it is
-recommended that both clients and servers are upgraded to 1.5.2!
+recommended that both clients and servers are upgraded to 1.5.3!
 
 INSTALLATION
 
t@@ -17,10 +17,10 @@ Either...
    
 Or...
 
-2. Get the tarball dopewars-1.5.2.tar.gz from the same URL
-   Extract it via. tar -xvzf dopewars-1.5.2.tar.gz
+2. Get the tarball dopewars-1.5.3.tar.gz from the same URL
+   Extract it via. tar -xvzf dopewars-1.5.3.tar.gz
    Follow the instructions in the INSTALL file in the newly-created
-      dopewars-1.5.2 directory
+      dopewars-1.5.3 directory
 
 Once you're done, you can safely delete the RPM, tarball and dopewars
 directory. The dopewars binary is all you need!
t@@ -32,10 +32,10 @@ score file can be selected with the -f switch.
 WIN32 INSTALLATION
 
 dopewars now compiles as a console or regular application under Win32
-(Windows 95,98,NT,2000). Almost all functionality of the standard Unix binary
-is retained; for example, all of the same command line switches are supported,
-and configuration files are still looked for in $HOME/.dopewars. However, for
-convenience, the configuration file "dopewars-config.txt" is also read.
+(Windows 95, 98, NT, 2000, XP). Almost all functionality of the standard Unix
+binary is retained; for example, all of the same command line switches are
+supported. However, for convenience, the configuration file is the more
+Windows-friendly "dopewars-config.txt".
 
 The easiest way to install the Win32 version is to download the precompiled
 binary. The supplied configure script, however, should build the binary
diff --git a/doc/index.html b/doc/index.html
t@@ -6,11 +6,11 @@
 
 
 
-dopewars 1.5.2: Main Index
+dopewars 1.5.3: Main Index
 
 
 
-

dopewars 1.5.2: Main Index

+

dopewars 1.5.3: Main Index

diff --git a/doc/installation.html b/doc/installation.html
t@@ -58,9 +58,9 @@ faults due to library conflicts.

  1. Download the - + Alpha or - + i386 (Intel) RPM with your web browser. (If your browser is incorrectly set up, it may try and display the file, in which case tell it explicitly to save the file - Shift+Mouse button 1 in Netscape.)
  2. t@@ -71,7 +71,7 @@ up).
  3. Change to the directory containing the dopewars rpm, and install it with the command
    -rpm -Uvh dopewars-1.5.2-1.xxx.rpm
    +rpm -Uvh dopewars-1.5.3-1.xxx.rpm
    (where xxx is i386 or alpha). This will replace any already-installed earlier version.
t@@ -84,13 +84,13 @@ building the binaries from it on your system.

  1. Download the - + source code RPM.
  2. Become root and change to the directory containing the new rpm.
  3. Build a binary rpm with the command
    -rpm --rebuild dopewars-1.5.2-1.src.rpm
  4. +rpm --rebuild dopewars-1.5.3-1.src.rpm
  5. Change to the directory which the binary rpm has been written to (check the output of the above - usually /usr/src/redhat/RPMS/xxx, where t@@ -98,7 +98,7 @@ the output of the above - usually /usr/src/redhat/RPMS/xxx, where "alpha" on Alphas)
  6. Install the binary rpm with the command
    -rpm -Uvh dopewars-1.5.2-1.xxx.rpm
  7. +rpm -Uvh dopewars-1.5.3-1.xxx.rpm

Tarball installation

t@@ -118,15 +118,15 @@ Unix here or for Windows
  1. Download the - + source code tarball.
  2. Change to the directory containing the tarball and extract the contents with the command
    -tar -xvzf dopewars-1.5.2.tar.gz
    +tar -xvzf dopewars-1.5.3.tar.gz
    (or similar).
  3. -
  4. Change into the dopewars-1.5.2 directory, and read all the important +
  5. Change into the dopewars-1.5.3 directory, and read all the important documentation in there ;)
  6. Build the binary with the commands
    t@@ -140,7 +140,7 @@ should compile cleanly. If you are running the Cygwin tools under Microsoft Windows, the script should detect this and allow you to build a native Windows binary; this will then run on any Win32 system, even one without Cygwin installed. The configure script supports a number of configurable options; for -more details, read the INSTALL file in the dopewars-1.5.2 directory.

    +more details, read the INSTALL file in the dopewars-1.5.3 directory.

    If you cannot become root, run the configure script specifying directories for which you have write access for both the dopewars binary and high score file

diff --git a/doc/server.html b/doc/server.html
t@@ -31,33 +31,46 @@ home city rather than New York. Any players that then connect to your
 customised server will play this customised game.

-

Running an interactive server

+

Running a server

All the code for the dopewars server is included in the same binary as the standard client. To run the binary in server mode, specify the -s or --S command line option. By default, -this runs the server in "interactive" mode; that is to say that the server -functions as normal, but in addition responds to typed commands from you. -Click here for a list of the valid commands -in interactive mode.

- -

Non-interactive servers

- -

Usually, however, you will not need to use server commands (most can be -specified in the configuration files anyway) -and so will want a non-interactive server. This will sit in the background -and quietly deal with dopewars games without disturbing you, the user. To -"persuade" the server to be non-interactive, you must redirect standard -input and output, and use your shell's job control to put it in the background, -with a command similar to the following:-
-dopewars -s < /dev/null >> /var/log/dopewars.log &
-(this writes server output to the logfile /var/log/dopewars.log. -Alternatively you can redirect this output to /dev/null.)

+-S command line option. The type of +server that runs depends on how you configured the binary; by default, on +Windows systems a simple graphical window containing the server output and +a line for entering server commands is used +(an "interactive" server) while on Unix systems a text-mode server that +accepts no input ("noninteractive") is used.

+ +

Interacting with the text-mode server

+ +

Once started, the text-mode server does not accept commands directly. This +is problematic if you want to adjust settings, eject players, etc. To send +commands to a running server, run dopewars with the -A +command line option. (This should only work +from the machine running the dopewars server, not over the network, and only +for the user that started the server, as it uses a Unix-domain socket for the +communication.) Also, by default the text-mode server sends its log output to +standard output; you may wish to instead log to a file with the -l +option.

+ +

Running as an NT service

+ +

On Windows systems, the graphical server has one major drawback; it can +only run while you are logged on. As soon as you log out, the server is +killed. To get around this limitation, dopewars supports being run as an +"NT Service" under Windows NT and later systems (e.g. 2000, XP). The install +program should set up the service; users with suitable access rights can then +start or stop the service via. the Control Panel. The disadvantage of the +server in this configuration is that server commands cannot be issued once +the server is running. This limitation should be fixed in a future release +of dopewars.

Private and public: the dopewars metaserver

t@@ -91,6 +104,6 @@ information on getting round these difficulties, see the -

Last update: 17-06-2001

+

Last update: 03-02-2002

diff --git a/doc/windows.html b/doc/windows.html
t@@ -37,18 +37,19 @@ details.

identical. Both will accept the same command line parameters and configuration options. However, since the standard Unix paths for the high score file and configuration files do not translate well to Windows, by default the program -will look for both the configuration file dopewars-config.txt and the -high score file dopewars.sco in the current directory. (N.B. The -standard Unix-like configuration files \Etc\Dopewars and $HOME\.Dopewars will -be read before dopewars-config.txt if they are present, and if you build -the program by hand, you'll need to use --datadir="." as an option to -configure in order to get this behaviour for the high score file.)

+will look for both the high score file dopewars.sco in the current +directory, and will read a global configuration file dopewars-config.txt +from the directory in which the dopewars binary was installed, followed by +a per-user configuration file of the same name in the working directory. +(If you build the program from source code by hand, you'll need to use +--datadir="." as an option to configure in order to get this behaviour for +the high score file.)


-

Last update: 14-10-2001

+

Last update: 03-02-2002