Update the documentation

This commit is contained in:
John "Elwin" Edwards 2009-10-24 14:12:26 +00:00
parent 9f9abbf368
commit 4d3813ab4d
3 changed files with 84 additions and 24 deletions

View file

@ -10,18 +10,19 @@
<h2>NAME</h2> <h2>NAME</h2>
<blockquote> <blockquote>
<p>rogue36 &minus; Exploring The Dungeons of Doom</p> <p>rogue3 &minus; Exploring The Dungeons of Doom</p>
</blockquote> </blockquote>
<h2>SYNOPSIS</h2> <h2>SYNOPSIS</h2>
<blockquote> <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> </blockquote>
<h2>DESCRIPTION</h2> <h2>DESCRIPTION</h2>
<blockquote> <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 monsters and get a lot of gold, rather than the puzzle solving orientation
of most computer fantasy games.</p> of most computer fantasy games.</p>
@ -30,7 +31,7 @@
will identify the things you see on the screen.</p> will identify the things you see on the screen.</p>
<p align="justify">To win the game (as opposed to merely playing to beat <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 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 achieved this yet and if somebody does, they will probably go down in history
as a hero among heros.</p> as a hero among heros.</p>
@ -40,24 +41,40 @@
top-ten scorers. The scoring is based entirely upon how much gold you get. top-ten scorers. The scoring is based entirely upon how much gold you get.
There is a 10% penalty for getting yourself killed.</p> There is a 10% penalty for getting yourself killed.</p>
<p align="justify">For more detailed directions, read the document A Guide <p align="justify">For more detailed directions, read the document <u>A Guide
to the Dungeons of Doom.</p> to the Dungeons of Doom</u>.</p>
</blockquote> </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> <h2>FILES</h2>
<blockquote> <blockquote>
<table border="0" id="table1"> <table border="0" id="table1">
<tr> <tr>
<td>rogue36.scr</td> <td>/usr/local/games/roguelike/rogue3.scr</td>
<td width="50">&nbsp;</td> <td width="50">&nbsp;</td>
<td>Score file</td> <td>Score file</td>
</tr> </tr>
<tr> <tr>
<td>rogue36.sav</td> <td>~/rogue3.save</td>
<td>&nbsp;</td> <td>&nbsp;</td>
<td>Default save file</td> <td>Default save file</td>
</tr> </tr>
<tr>
<td>/usr/local/games/roguelike/rogue3save</td>
<td>&nbsp;</td>
<td>System savefiles</td>
</tr>
</table> </table>
</blockquote> </blockquote>
@ -72,7 +89,8 @@ screen in reverse video which may or may not cause a core dump.</p>
<h2>COPYRIGHT</h2> <h2>COPYRIGHT</h2>
Rogue: Exploring the Dungeons of Doom<br> Rogue: Exploring the Dungeons of Doom<br>
Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman <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> </body>
</html> </html>

View file

@ -4,9 +4,13 @@
rogue \- Exploring The Dungeons of Doom rogue \- Exploring The Dungeons of Doom
.SH SYNOPSIS .SH SYNOPSIS
.B rogue .B rogue
[ -s ]
[ [
.I save_file .I save_file
] ]
[ -n
.I playername
]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
.I Rogue .I Rogue
@ -21,7 +25,7 @@ will give you a list of the available commands and the command
.B / .B /
will identify the things you see on the screen. will identify the things you see on the screen.
.PP .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 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 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 yet and if somebody does, they will probably go down in history as a hero
@ -30,17 +34,40 @@ among heros.
When the game ends, either by your death, when you quit, or if you (by When the game ends, either by your death, when you quit, or if you (by
some miracle) manage to win, some miracle) manage to win,
.I rogue .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 upon how much gold you get. There is a 10% penalty for getting yourself
killed. killed.
.PP .PP
For more detailed directions, read the document For more detailed directions, read the document
.I "A Guide to the Dungeons of Doom." .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 .SH FILES
.ta 2i .ta 2i
rogue36.scr Score file /usr/local/games/roguelike/rogue3.scr Score file
.br .br
~/rogue36.sav Default save file ~/rogue3.save Default save file
.br
/usr/local/games/roguelike/rogue3save System savefiles
.DT .DT
.SH SEE ALSO .SH SEE ALSO
Michael C. Toy, Michael C. Toy,
@ -56,3 +83,5 @@ Rogue: Exploring the Dungeons of Doom
Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman
.br .br
All rights reserved. All rights reserved.
.br
License: 3-clause BSD, see LICENSE.txt for details.

View file

@ -6,7 +6,7 @@ NAME
rogue - Exploring The Dungeons of Doom rogue - Exploring The Dungeons of Doom
SYNOPSIS SYNOPSIS
rogue [ save_file ] rogue [ -s ] [ save_file ] [ -n playername ]
DESCRIPTION DESCRIPTION
Rogue is a computer fantasy game with a new twist. It is crt oriented Rogue is a computer fantasy game with a new twist. It is crt oriented
@ -18,23 +18,35 @@ DESCRIPTION
? will give you a list of the available commands and the command / ? will give you a list of the available commands and the command /
will identify the things you see on the screen. will identify the things you see on the screen.
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
scores) you must locate the Amulet of Yendor which is somewhere below high scores) you must locate the Amulet of Yendor which is somewhere
the 20th level of the dungeon and get it out. Nobody has achieved this below the 20th level of the dungeon and get it out. Nobody has
yet and if somebody does, they will probably go down in history as a achieved this yet and if somebody does, they will probably go down in
hero among heros. history as a hero among heros.
When the game ends, either by your death, when you quit, or if you (by 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. scorers. The scoring is based entirely upon how much gold you get.
There is a 10% penalty for getting yourself killed. There is a 10% penalty for getting yourself killed.
For more detailed directions, read the document A Guide to the Dungeons For more detailed directions, read the document A Guide to the Dungeons
of Doom. 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 FILES
rogue36.scr Score file /usr/local/games/roguelike/rogue3.scr Score file
~/rogue36.sav Default save file ~/rogue3.save Default save file
/usr/local/games/roguelike/rogue3save System savefiles
SEE ALSO SEE ALSO
Michael C. Toy, A Guide to the Dungeons of Doom Michael C. Toy, A Guide to the Dungeons of Doom
@ -48,6 +60,7 @@ COPYRIGHT
Rogue: Exploring the Dungeons of Doom Rogue: Exploring the Dungeons of Doom
Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman Copyright (C) 1980, 1981 Michael Toy, Ken Arnold and Glenn Wichman
All rights reserved. All rights reserved.
License: 3-clause BSD, see LICENSE.txt for details.