changeset 9:38acf3eb27e6

Update the documentation
author edwarj4
date Sat, 24 Oct 2009 14:12:26 +0000
parents 78df7025783b
children b343f42c1f01
files rogue3/readme36.html rogue3/rogue.6 rogue3/rogue36.cat
diffstat 3 files changed, 84 insertions(+), 24 deletions(-) [+]
line wrap: on
line diff
--- a/rogue3/readme36.html	Fri Oct 23 01:38:53 2009 +0000
+++ b/rogue3/readme36.html	Sat Oct 24 14:12:26 2009 +0000
@@ -10,18 +10,19 @@
 
 <h2>NAME</h2>
 <blockquote>
-	<p>rogue36 &minus; Exploring The Dungeons of Doom</p>
+	<p>rogue3 &minus; Exploring The Dungeons of Doom</p>
 </blockquote>
 
 <h2>SYNOPSIS</h2>
 <blockquote>
-	<p><b>rogue36</b> [ <i>save_file</i> ]</p>
+	<p><b>rogue3</b> [ -s ] [ <i>save_file</i> ] [ -n <i>playername</i> ]</p>
 </blockquote>
 
 <h2>DESCRIPTION</h2>
 <blockquote>
 
-	<p align="justify"><u>Rogue</u> is a computer fantasy game with a new twist. It is crt oriented and the object of the game is to survive the attacks of various 
+	<p align="justify"><u>Rogue</u> is a computer fantasy game with a new twist.
+	It is crt oriented and the object of the game is to survive the attacks of various 
 	monsters and get a lot of gold, rather than the puzzle solving orientation
 	of most computer fantasy games.</p>
 
@@ -30,7 +31,7 @@
 	will identify the things you see on the screen.</p>
 
 	<p align="justify">To win the game (as opposed to merely playing to beat 
-	other people high scores) you must locate the Amulet of Yendor which is 
+	other people's high scores) you must locate the Amulet of Yendor which is 
 	somewhere below the 20th level of the dungeon and get it out. Nobody has 
 	achieved this yet and if somebody does, they will probably go down in history
 	as a hero among heros.</p>
@@ -40,24 +41,40 @@
 	top-ten scorers. The scoring is based entirely upon how much gold you get.
 	There is a 10% penalty for getting yourself killed.</p>
 
-	<p align="justify">For more detailed directions, read the document A Guide 
-	to the Dungeons of Doom.</p>
+	<p align="justify">For more detailed directions, read the document <u>A Guide 
+	to the Dungeons of Doom</u>.</p>
+
+</blockquote>
 
+<h2>OPTIONS</h2>
+<blockquote>
+
+	<p align="justify">If a <i>save_file</i> argument is given, <u>rogue</u> will attempt 
+	to load  a  previously saved game from that file.</p>
+	<p align="justify">With  the  <b>-n</b>  option,  <u>rogue</u> will load a game with the 
+	name <i>playername</i> from a location defined at compile time.  If no such
+	game  exists,  it will start one.</p>
+	<p align="justify">The <b>-s</b> option prints the top-ten scores list and exits.</p>
 </blockquote>
 
 <h2>FILES</h2>
 <blockquote>
 	<table border="0" id="table1">
 		<tr>
-			<td>rogue36.scr</td>
+			<td>/usr/local/games/roguelike/rogue3.scr</td>
 			<td width="50">&nbsp;</td>
 			<td>Score file</td>
 		</tr>
 		<tr>
-			<td>rogue36.sav</td>
+			<td>~/rogue3.save</td>
 			<td>&nbsp;</td>
 			<td>Default save file</td>
 		</tr>
+		<tr>
+			<td>/usr/local/games/roguelike/rogue3save</td>
+			<td>&nbsp;</td>
+			<td>System savefiles</td>
+		</tr>
 	</table>
 </blockquote>
 
@@ -72,7 +89,8 @@
 <h2>COPYRIGHT</h2>
 Rogue: Exploring the Dungeons of Doom<br>
 Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman <br>
-All rights reserved.
+All rights reserved.<br>
+License: 3-clause BSD, see LICENSE.txt for details.
 
 </body>
 </html>
\ No newline at end of file
--- a/rogue3/rogue.6	Fri Oct 23 01:38:53 2009 +0000
+++ b/rogue3/rogue.6	Sat Oct 24 14:12:26 2009 +0000
@@ -4,9 +4,13 @@
 rogue \- Exploring The Dungeons of Doom
 .SH SYNOPSIS
 .B rogue
+[ -s ]
 [
 .I save_file
 ]
+[ -n
+.I playername
+]
 .SH DESCRIPTION
 .PP
 .I Rogue
@@ -21,7 +25,7 @@
 .B /
 will identify the things you see on the screen.
 .PP
-To win the game (as opposed to merely playing to beat other people high
+To win the game (as opposed to merely playing to beat other people's high
 scores) you must locate the Amulet of Yendor which is somewhere below
 the 20th level of the dungeon and get it out.  Nobody has achieved this
 yet and if somebody does, they will probably go down in history as a hero
@@ -30,17 +34,40 @@
 When the game ends, either by your death, when you quit, or if you (by
 some miracle) manage to win,
 .I rogue
-will give you alist of the top-ten scorers.  The scoring is based entirely
+will give you a list of the top-ten scorers.  The scoring is based entirely
 upon how much gold you get.  There is a 10% penalty for getting yourself
 killed.
 .PP
 For more detailed directions, read the document
 .I "A Guide to the Dungeons of Doom."
+.SH OPTIONS
+.PP
+If a
+.I save_file
+argument is given,
+.I rogue
+will attempt to load a previously saved game from that file.
+.PP
+With the
+.B -n
+option,
+.I rogue
+will load a game with the name
+.I playername
+from a location defined at compile time.  If no such game exists, it will 
+start one.
+.PP
+The
+.B -s
+option prints the top-ten scores list and exits.
+
 .SH FILES
 .ta 2i
-rogue36.scr                  Score file
+/usr/local/games/roguelike/rogue3.scr   Score file
 .br
-~/rogue36.sav                Default save file
+~/rogue3.save                           Default save file
+.br
+/usr/local/games/roguelike/rogue3save   System savefiles
 .DT
 .SH SEE ALSO
 Michael C. Toy,
@@ -56,3 +83,5 @@
 Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman
 .br
 All rights reserved.
+.br
+License: 3-clause BSD, see LICENSE.txt for details.
--- a/rogue3/rogue36.cat	Fri Oct 23 01:38:53 2009 +0000
+++ b/rogue3/rogue36.cat	Sat Oct 24 14:12:26 2009 +0000
@@ -6,7 +6,7 @@
        rogue - Exploring The Dungeons of Doom
 
 SYNOPSIS
-       rogue [ save_file ]
+       rogue [ -s ] [ save_file ] [ -n playername ]
 
 DESCRIPTION
        Rogue  is a computer fantasy game with a new twist.  It is crt oriented
@@ -18,36 +18,49 @@
        ?   will  give  you  a list of the available commands and the command /
        will identify the things you see on the screen.
 
-       To win the game (as opposed to merely playing to beat other people high
-       scores)  you  must locate the Amulet of Yendor which is somewhere below
-       the 20th level of the dungeon and get it out.  Nobody has achieved this
-       yet  and  if  somebody does, they will probably go down in history as a
-       hero among heros.
+       To win the game (as opposed to merely playing to  beat  other  people's
+       high  scores)  you  must locate the Amulet of Yendor which is somewhere
+       below the 20th level of  the  dungeon  and  get  it  out.   Nobody  has
+       achieved  this  yet and if somebody does, they will probably go down in
+       history as a hero among heros.
 
        When the game ends, either by your death, when you quit, or if you  (by
-       some  miracle)  manage to win, rogue will give you alist of the top-ten
+       some  miracle) manage to win, rogue will give you a list of the top-ten
        scorers.  The scoring is based entirely upon how  much  gold  you  get.
        There is a 10% penalty for getting yourself killed.
 
        For more detailed directions, read the document A Guide to the Dungeons
        of Doom.
 
+OPTIONS
+       If a save_file argument is given, rogue will attempt to load  a  previ-
+       ously saved game from that file.
+
+       With  the  -n  option,  rogue will load a game with the name playername
+       from a location defined at compile time.  If no such  game  exists,  it
+       will start one.
+
+       The -s option prints the top-ten scores list and exits.
+
+
 FILES
-       rogue36.scr                  Score file
-       ~/rogue36.sav                Default save file
+       /usr/local/games/roguelike/rogue3.scr   Score file
+       ~/rogue3.save                           Default save file
+       /usr/local/games/roguelike/rogue3save   System savefiles
 
 SEE ALSO
        Michael C. Toy, A Guide to the Dungeons of Doom
 
 BUGS
-       Probably infinite.  Currently known bugs are: Sometimes you  are  still
-       hungry  even  after you eat food and sometimes you get a monster on the
+       Probably  infinite.   Currently known bugs are: Sometimes you are still
+       hungry even after you eat food and sometimes you get a monster  on  the
        screen in reverse video which may or may not cause a core dump.
 
 COPYRIGHT
        Rogue: Exploring the Dungeons of Doom
        Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman
        All rights reserved.
+       License: 3-clause BSD, see LICENSE.txt for details.