Merge from vendor branch DIFFUTILS:
[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.3 2007/03/11 19:05:31 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 hack with a fixed
60 playing ground, usually
61 .Pa /var/games/hackdir .
62 .Pp
63 The
64 .Fl n
65 option suppresses printing of the news.
66 .Pp
67 The
68 .Fl u Ar playername
69 option supplies the answer to the question "Who are you?".
70 When
71 .Ar playername
72 has as suffix one of
73 .Em -T ,
74 .Em -S ,
75 .Em -K ,
76 .Em -F ,
77 .Em -C ,
78 or
79 .Em -W ,
80 then this supplies the answer to the question "What kind of character ... ?".
81 .Pp
82 The
83 .Fl s
84 option will print out the list of your scores.
85 It may be followed by arguments
86 .Fl X
87 where X is one of the letters C, F, K, S, T, W to print the scores of
88 Cavemen, Fighters, Knights, Speleologists, Tourists or Wizards.
89 It may also be followed by one or more player names to print the scores of the
90 players mentioned.
91 .Sh ENVIRONMENT
92 .Bl -tag -width 24n -compact
93 .It Ev USER No or Ev LOGNAME
94 Your login name.
95 .It Ev HOME
96 Your home directory.
97 .It Ev SHELL
98 Your shell.
99 .It Ev TERM
100 The type of your terminal.
101 .It Ev HACKPAGER, PAGER
102 Pager used instead of default pager.
103 .It Ev MAIL
104 Mailbox file.
105 .It Ev MAILREADER
106 Reader used instead of default (probably
107 .Pa /usr/bin/mail ) .
108 .It Ev HACKDIR
109 Playground.
110 .It Ev HACKOPTIONS
111 String predefining several hack options (see help file).
112 .El
113 .Pp
114 Several other environment variables are used in debugging (wizard) mode,
115 like
116 .Ev GENOCIDED ,
117 .Ev INVENT ,
118 .Ev MAGIC
119 and
120 .Ev SHOPTYPE .
121 .Sh FILES
122 .Bl -tag -width 24n -compact
123 .It Pa hack
124 The hack program.
125 .It Pa data, rumors
126 Data files used by hack.
127 .It Pa help, hh
128 Help data files.
129 .It Pa record
130 The list of topscorers.
131 .It Pa save
132 A subdirectory containing the saved games.
133 .It Pa bones_dd
134 Descriptions of the ghost and belongings of a deceased adventurer.
135 .It Pa xlock.dd
136 Description of a dungeon level.
137 .It Pa safelock
138 Lock file for xlock.
139 .It Pa record_lock
140 Lock file for record.
141 .El
142 .Sh AUTHORS
143 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
144 original hack, very much like rogue (but full of bugs).
145 .Pp
146 Andries Brouwer continuously deformed their sources into the current
147 version - in fact an entirely different game.
148 .Sh BUGS
149 Probably infinite.
150 Mail complaints to mcvax!aeb .