tDocumentation updated to reflect new version 1.5.3 and new server interface - … | |
git clone git://src.adamsgaard.dk/vaccinewars | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit a5f664993758fb2b88986ef8e0cd6e0685456633 | |
parent ed7fb9cd1a09f667ebc6fb3fcd07a684bca1d1aa | |
Author: Ben Webb <[email protected]> | |
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 @@ | |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
<head> | |
-<title>dopewars 1.5.2: Main Index</title> | |
+<title>dopewars 1.5.3: Main Index</title> | |
</head> | |
<body> | |
-<h1>dopewars 1.5.2: Main Index</h1> | |
+<h1>dopewars 1.5.3: Main Index</h1> | |
<table> | |
diff --git a/doc/installation.html b/doc/installation.html | |
t@@ -58,9 +58,9 @@ faults due to library conflicts.</p> | |
<ol> | |
<li>Download the | |
-<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2-1.alpha.rp… | |
+<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.3-1.alpha.rp… | |
Alpha</a> or | |
-<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2-1.i386.rpm… | |
+<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.3-1.i386.rpm… | |
i386 (Intel)</a> 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.)</li> | |
t@@ -71,7 +71,7 @@ up).</li> | |
<li>Change to the directory containing the dopewars rpm, and install it with | |
the command<br /> | |
-<tt><b>rpm -Uvh dopewars-1.5.2-1.<i>xxx</i>.rpm</b></tt><br /> | |
+<tt><b>rpm -Uvh dopewars-1.5.3-1.<i>xxx</i>.rpm</b></tt><br /> | |
(where <b><i>xxx</i></b> is i386 or alpha). This will replace any | |
already-installed earlier version.</li> | |
</ol> | |
t@@ -84,13 +84,13 @@ building the binaries from it on your system.</p> | |
<ol> | |
<li>Download the | |
-<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2-1.src.rpm"> | |
+<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.3-1.src.rpm"> | |
source code RPM</a>.</li> | |
<li>Become root and change to the directory containing the new rpm.</li> | |
<li>Build a binary rpm with the command<br /> | |
-<tt><b>rpm --rebuild dopewars-1.5.2-1.src.rpm</b></tt></li> | |
+<tt><b>rpm --rebuild dopewars-1.5.3-1.src.rpm</b></tt></li> | |
<li>Change to the directory which the binary rpm has been written to (check | |
the output of the above - usually /usr/src/redhat/RPMS/<i>xxx</i>, where | |
t@@ -98,7 +98,7 @@ the output of the above - usually /usr/src/redhat/RPMS/<i>xx… | |
"alpha" on Alphas)</li> | |
<li>Install the binary rpm with the command<br /> | |
-<tt><b>rpm -Uvh dopewars-1.5.2-1.<i>xxx</i>.rpm</b></tt></li> | |
+<tt><b>rpm -Uvh dopewars-1.5.3-1.<i>xxx</i>.rpm</b></tt></li> | |
</ol> | |
<h2><a name="tarball">Tarball installation</a></h2> | |
t@@ -118,15 +118,15 @@ Unix <a href="http://www.gtk.org/download/">here</a> or … | |
<ol> | |
<li>Download the | |
-<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.2.tar.gz"> | |
+<a href="http://prdownloads.sourceforge.net/dopewars/dopewars-1.5.3.tar.gz"> | |
source code tarball</a>.</li> | |
<li>Change to the directory containing the tarball and extract the contents | |
with the command <br /> | |
-<tt><b>tar -xvzf dopewars-1.5.2.tar.gz</b></tt><br /> | |
+<tt><b>tar -xvzf dopewars-1.5.3.tar.gz</b></tt><br /> | |
(or similar).</li> | |
-<li>Change into the dopewars-1.5.2 directory, and read all the important | |
+<li>Change into the dopewars-1.5.3 directory, and read all the important | |
documentation in there ;)</li> | |
<li>Build the binary with the commands<br /> | |
t@@ -140,7 +140,7 @@ should compile cleanly. If you are running the Cygwin tool… | |
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.</p> | |
+more details, read the INSTALL file in the dopewars-1.5.3 directory.</p> | |
<p>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 fi… | |
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 conn… | |
customised server will play this customised game.</p> | |
<ul> | |
-<li><a href="#interactive">Running an interactive server</a></li> | |
-<li><a href="#noninteractive">Non-interactive servers</a></li> | |
+<li><a href="#server">Running a server</a></li> | |
+<li><a href="#interact">Interacting with the text-mode server</a></li> | |
+<li><a href="#ntservice">Running as an NT service</a></li> | |
<li><a href="#metaserver">Private and public: the dopewars metaserver</a></li> | |
</ul> | |
-<h2><a name="interactive">Running an interactive server</a></h2> | |
+<h2><a name="server">Running a server</a></h2> | |
<p>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 <b>-s</b> or | |
-<b>-S</b> <a href="commandline.html">command line option</a>. 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 <a href="servercommands.html">here</a> for a list of the valid commands | |
-in interactive mode.</p> | |
- | |
-<h2><a name="noninteractive">Non-interactive servers</a></h2> | |
- | |
-<p>Usually, however, you will not need to use server commands (most can be | |
-specified in the <a href="configfile.html">configuration files</a> 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:-<br /> | |
-<b>dopewars -s < /dev/null >> /var/log/dopewars.log &</b><br /> | |
-(this writes server output to the logfile <i>/var/log/dopewars.log</i>. | |
-Alternatively you can redirect this output to <i>/dev/null</i>.)</p> | |
+<b>-S</b> <a href="commandline.html">command line option</a>. 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 <a href="servercommands.html">server commands</a> is used | |
+(an "interactive" server) while on Unix systems a text-mode server that | |
+accepts no input ("noninteractive") is used.</p> | |
+ | |
+<h2><a name="interact">Interacting with the text-mode server</a></h2> | |
+ | |
+<p>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 <b>-A</b> | |
+<a href="commandline.html">command line option</a>. (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 <b>-l</b> | |
+option.</p> | |
+ | |
+<h2><a name="ntservice">Running as an NT service</a></h2> | |
+ | |
+<p>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.</p> | |
<h2><a name="metaserver">Private and public: the dopewars metaserver</a></h2> | |
t@@ -91,6 +104,6 @@ information on getting round these difficulties, see the | |
<ul> | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
-<p>Last update: <b>17-06-2001</b></p> | |
+<p>Last update: <b>03-02-2002</b></p> | |
</body> | |
</html> | |
diff --git a/doc/windows.html b/doc/windows.html | |
t@@ -37,18 +37,19 @@ details.</p> | |
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 <b>dopewars-config.txt</b> and the | |
-high score file <b>dopewars.sco</b> 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.)</p> | |
+will look for both the high score file <b>dopewars.sco</b> in the current | |
+directory, and will read a global configuration file <b>dopewars-config.txt</b> | |
+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.)</p> | |
<hr /> | |
<ul> | |
<li><a href="index.html">Main index</a></li> | |
</ul> | |
-<p>Last update: <b>14-10-2001</b></p> | |
+<p>Last update: <b>03-02-2002</b></p> | |
</body> | |
</html> |