Use .Nm
[dragonfly.git] / games / hack / hack.6
1 .\" $FreeBSD: src/games/hack/hack.6,v 1.2.8.1 2001/07/22 11:01:22 dd Exp $
2 .\" $DragonFly: src/games/hack/hack.6,v 1.4 2007/10/20 17:56:47 swildner Exp $
3 .Dd March 31, 1985
4 .Dt HACK 6
5 .Os
6 .Sh NAME
7 .Nm hack
8 .Nd exploring The Dungeons of Doom
9 .Sh SYNOPSIS
10 .Nm
11 .Op Fl d Ar directory
12 .Op Fl n
13 .Op Fl u Ar playername
14 .Nm
15 .Op Fl d Ar directory
16 .Op Fl s
17 .Op Fl X
18 .Op Ar playername ...
19 .Sh DESCRIPTION
20 .Nm
21 is a display oriented dungeons \*[Am] dragons-like game.
22 Both display and command structure resemble rogue.
23 (For a game with the same structure but entirely different display -
24 a real cave instead of dull rectangles - try Quest.)
25 .Pp
26 To get started you really only need to know two commands.
27 The command
28 .Ic \&?
29 will give you a list of the available commands and the command
30 .Ic /
31 will identify the things you see on the screen.
32 .Pp
33 To win the game (as opposed to merely playing to beat other people's high
34 scores) you must locate the Amulet of Yendor which is somewhere below
35 the 20th level of the dungeon and get it out.
36 Nobody has achieved this yet and if somebody does, he will probably go
37 down in history as a hero among heroes.
38 .Pp
39 When the game ends, either by your death, when you quit, or if you escape
40 from the caves,
41 .Nm
42 will give you (a fragment of) the list of top scorers.
43 The scoring is based on many aspects of your behavior but a rough estimate
44 is obtained by taking the amount of gold you've found in the cave plus four
45 times your (real) experience.
46 Precious stones may be worth a lot of gold when brought to the exit.
47 There is a 10% penalty for getting yourself killed.
48 .Pp
49 The administration of the game is kept in the directory specified with the
50 .Fl d
51 option, or, if no such option is given, in the directory specified by
52 the environment variable
53 .Ev HACKDIR ,
54 or, if no such variable exists, in the current directory.
55 This same directory contains several auxiliary files such as lockfiles and
56 the list of topscorers and a subdirectory
57 .Pa save
58 where games are saved.
59 The game administrator may however choose to install
60 .Nm
61 with a fixed playing ground, usually
62 .Pa /var/games/hackdir .
63 .Pp
64 The
65 .Fl n
66 option suppresses printing of the news.
67 .Pp
68 The
69 .Fl u Ar playername
70 option supplies the answer to the question "Who are you?".
71 When
72 .Ar playername
73 has as suffix one of
74 .Em -T ,
75 .Em -S ,
76 .Em -K ,
77 .Em -F ,
78 .Em -C ,
79 or
80 .Em -W ,
81 then this supplies the answer to the question "What kind of character ... ?".
82 .Pp
83 The
84 .Fl s
85 option will print out the list of your scores.
86 It may be followed by arguments
87 .Fl X
88 where X is one of the letters C, F, K, S, T, W to print the scores of
89 Cavemen, Fighters, Knights, Speleologists, Tourists or Wizards.
90 It may also be followed by one or more player names to print the scores of the
91 players mentioned.
92 .Sh ENVIRONMENT
93 .Bl -tag -width 24n -compact
94 .It Ev USER No or Ev LOGNAME
95 Your login name.
96 .It Ev HOME
97 Your home directory.
98 .It Ev SHELL
99 Your shell.
100 .It Ev TERM
101 The type of your terminal.
102 .It Ev HACKPAGER, PAGER
103 Pager used instead of default pager.
104 .It Ev MAIL
105 Mailbox file.
106 .It Ev MAILREADER
107 Reader used instead of default (probably
108 .Pa /usr/bin/mail ) .
109 .It Ev HACKDIR
110 Playground.
111 .It Ev HACKOPTIONS
112 String predefining several
113 .Nm
114 options (see help file).
115 .El
116 .Pp
117 Several other environment variables are used in debugging (wizard) mode,
118 like
119 .Ev GENOCIDED ,
120 .Ev INVENT ,
121 .Ev MAGIC
122 and
123 .Ev SHOPTYPE .
124 .Sh FILES
125 .Bl -tag -width 24n -compact
126 .It Pa hack
127 The
128 .Nm
129 program.
130 .It Pa data, rumors
131 Data files used by
132 .Nm .
133 .It Pa help, hh
134 Help data files.
135 .It Pa record
136 The list of topscorers.
137 .It Pa save
138 A subdirectory containing the saved games.
139 .It Pa bones_dd
140 Descriptions of the ghost and belongings of a deceased adventurer.
141 .It Pa xlock.dd
142 Description of a dungeon level.
143 .It Pa safelock
144 Lock file for xlock.
145 .It Pa record_lock
146 Lock file for record.
147 .El
148 .Sh AUTHORS
149 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
150 original
151 .Nm hack ,
152 very much like
153 .Xr rogue 6
154 (but full of bugs).
155 .Pp
156 Andries Brouwer continuously deformed their sources into the current
157 version - in fact an entirely different game.
158 .Sh BUGS
159 Probably infinite.
160 Mail complaints to mcvax!aeb .