annotate rogue4/rogue.6.in @ 223:0e99eade579c

Generate text documentation from the troff source files. This is done by make, in the 'docs' target, which is now part of the normal build process. Unfortunately, not all the games include troff sources. Getting decent HTML output from groff is still a difficult process which will not be attempted at this time. There are a few bugs in the 'install' and 'uninstall' rules. Not to mention that the documentation is sometimes inaccurate.
author John "Elwin" Edwards
date Sun, 21 Feb 2016 20:47:12 -0500
parents a1dc75e38e73
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
51
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
1 .TH ROGUE 6 "1 April 1981"
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
2 .UC 4
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
3 .SH NAME
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
4 rogue \- Exploring The Dungeons of Doom
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
5 .SH SYNOPSIS
223
0e99eade579c Generate text documentation from the troff source files.
John "Elwin" Edwards
parents: 51
diff changeset
6 .B @PROGRAM@
51
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
7 [
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
8 .I save_file
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
9 ]
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
10 .SH DESCRIPTION
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
11 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
12 .I Rogue
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
13 is a computer fantasy game with a new twist. It is crt oriented and the
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
14 object of the game is to survive the attacks of various monsters and get
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
15 a lot of gold, rather than the puzzle solving orientation of most computer
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
16 fantasy games.
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
17 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
18 To get started you really only need to know two commands. The command
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
19 .B ?
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
20 will give you a list of the available commands and the command
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
21 .B /
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
22 will identify the things you see on the screen.
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
23 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
24 To win the game (as opposed to merely playing to beat other people high
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
25 scores) you must locate the Amulet of Yendor which is somewhere below
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
26 the 20th level of the dungeon and get it out. Nobody has achieved this
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
27 yet and if somebody does, they will probably go down in history as a hero
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
28 among heros.
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
29 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
30 When the game ends, either by your death, when you quit, or if you (by
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
31 some miracle) manage to win,
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
32 .I rogue
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
33 will give you alist of the top-ten scorers. The scoring is based entirely
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
34 upon how much gold you get. There is a 10% penalty for getting yourself
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
35 killed.
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
36 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
37 For more detailed directions, read the document
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
38 .I "A Guide to the Dungeons of Doom."
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
39 .SH FILES
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
40 .DT
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
41 .B Score file is searched for in these directories:
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
42 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
43 $ROGUEHOME/rogue52.scr
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
44 .br
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
45 /var/games/roguelike/rogue52.scr
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
46 .br
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
47 /var/lib/roguelike/rogue52.scr
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
48 .br
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
49 /var/roguelike/rogue52.scr
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
50 .br
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
51 /usr/games/lib/rogue52.scr
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
52 .br
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
53 /games/roguelik/rogue52.scr
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
54 .br
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
55 rogue52.scr
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
56 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
57 .B Default save file
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
58 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
59 ~/rogue.sav
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
60 .SH SEE ALSO
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
61 Michael C. Toy,
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
62 .I "A guide to the Dungeons of Doom"
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
63 .SH BUGS
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
64 .PP
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
65 Probably infinite. Currently known bugs are: Sometimes you are still hungry
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
66 even after you eat food and sometimes you get a monster on the screen in
a1dc75e38e73 rogue4: ported to autoconf.
elwin
parents:
diff changeset
67 reverse video which may or may not cause a core dump.