Expand PMF_FN_* macros.
[netbsd-mini2440.git] / games / hack / hack.6
blobc2c3c01b131ab97b577b8273b1fe5813b196188c
1 .\"     $NetBSD: hack.6,v 1.14 2004/06/01 10:10:06 wiz Exp $    -*- nroff -*-
2 .\"
3 .\" Copyright (c) 1985, Stichting Centrum voor Wiskunde en Informatica,
4 .\" Amsterdam
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions are
9 .\" met:
10 .\"
11 .\" - Redistributions of source code must retain the above copyright notice,
12 .\" this list of conditions and the following disclaimer.
13 .\"
14 .\" - Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
17 .\"
18 .\" - Neither the name of the Stichting Centrum voor Wiskunde en
19 .\" Informatica, nor the names of its contributors may be used to endorse or
20 .\" promote products derived from this software without specific prior
21 .\" written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
24 .\" IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
26 .\" PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
27 .\" OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 .\" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 .\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 .\"
35 .\"
36 .\" Copyright (c) 1982 Jay Fenlason <hack@gnu.org>
37 .\" All rights reserved.
38 .\"
39 .\" Redistribution and use in source and binary forms, with or without
40 .\" modification, are permitted provided that the following conditions
41 .\" are met:
42 .\" 1. Redistributions of source code must retain the above copyright
43 .\"    notice, this list of conditions and the following disclaimer.
44 .\" 2. Redistributions in binary form must reproduce the above copyright
45 .\"    notice, this list of conditions and the following disclaimer in the
46 .\"    documentation and/or other materials provided with the distribution.
47 .\" 3. The name of the author may not be used to endorse or promote products
48 .\"    derived from this software without specific prior written permission.
49 .\"
50 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
51 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
52 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
53 .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
54 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
55 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
56 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
57 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
58 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
59 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60 .\"
61 .Dd March 31, 1985
62 .Dt HACK 6
63 .Os
64 .Sh NAME
65 .Nm hack
66 .Nd exploring The Dungeons of Doom
67 .Sh SYNOPSIS
68 .Nm
69 .Op Fl d Ar directory
70 .Op Fl n
71 .Op Fl u Ar playername
72 .Nm
73 .Op Fl d Ar directory
74 .Op Fl s
75 .Op Fl X
76 .Op Ar playername ...
77 .Sh DESCRIPTION
78 .Nm
79 is a display oriented dungeons \*[Am] dragons-like game.
80 Both display and command structure resemble rogue.
81 (For a game with the same structure but entirely different display -
82 a real cave instead of dull rectangles - try Quest.)
83 .Pp
84 To get started you really only need to know two commands.
85 The command
86 .Ic \&?
87 will give you a list of the available commands and the command
88 .Ic /
89 will identify the things you see on the screen.
90 .Pp
91 To win the game (as opposed to merely playing to beat other people's high
92 scores) you must locate the Amulet of Yendor which is somewhere below
93 the 20th level of the dungeon and get it out.
94 Nobody has achieved this yet and if somebody does, he will probably go
95 down in history as a hero among heroes.
96 .Pp
97 When the game ends, either by your death, when you quit, or if you escape
98 from the caves,
99 .Nm
100 will give you (a fragment of) the list of top scorers.
101 The scoring is based on many aspects of your behavior but a rough estimate
102 is obtained by taking the amount of gold you've found in the cave plus four
103 times your (real) experience.
104 Precious stones may be worth a lot of gold when brought to the exit.
105 There is a 10% penalty for getting yourself killed.
107 The administration of the game is kept in the directory specified with the
108 .Fl d
109 option, or, if no such option is given, in the directory specified by
110 the environment variable
111 .Ev HACKDIR ,
112 or, if no such variable exists, in the current directory.
113 This same directory contains several auxiliary files such as lockfiles and
114 the list of topscorers and a subdirectory
115 .Pa save
116 where games are saved.
117 The game administrator may however choose to install hack with a fixed
118 playing ground, usually
119 .Pa /var/games/hackdir .
122 .Fl n
123 option suppresses printing of the news.
126 .Fl u
127 .Ar playername
128 option supplies the answer to the question "Who are you?".
129 When
130 .Ar playername
131 has as suffix one of
132 .Em -T ,
133 .Em -S ,
134 .Em -K ,
135 .Em -F ,
136 .Em -C ,
138 .Em -W ,
139 then this supplies the answer to the question "What kind of character ... ?".
142 .Fl s
143 option will print out the list of your scores.
144 It may be followed by arguments
145 .Fl X
146 where X is one of the letters C, F, K, S, T, W to print the scores of
147 Cavemen, Fighters, Knights, Speleologists, Tourists or Wizards.
148 It may also be followed by one or more player names to print the scores of the
149 players mentioned.
150 .Sh ENVIRONMENT
151 .Bl -tag -width 24n -compact
152 .It Ev USER No or Ev LOGNAME
153 Your login name.
154 .It Ev HOME
155 Your home directory.
156 .It Ev SHELL
157 Your shell.
158 .It Ev TERM
159 The type of your terminal.
160 .It Ev HACKPAGER, PAGER
161 Pager used instead of default pager.
162 .It Ev MAIL
163 Mailbox file.
164 .It Ev MAILREADER
165 Reader used instead of default (probably
166 .Pa /usr/bin/mail ) .
167 .It Ev HACKDIR
168 Playground.
169 .It Ev HACKOPTIONS
170 String predefining several hack options (see help file).
173 Several other environment variables are used in debugging (wizard) mode,
174 like
175 .Ev GENOCIDED ,
176 .Ev INVENT ,
177 .Ev MAGIC
179 .Ev SHOPTYPE .
180 .Sh FILES
181 .Bl -tag -width 24n -compact
182 .It Pa hack
183 The hack program.
184 .It Pa data, rumors
185 Data files used by hack.
186 .It Pa help, hh
187 Help data files.
188 .It Pa record
189 The list of topscorers.
190 .It Pa save
191 A subdirectory containing the saved games.
192 .It Pa bones_dd
193 Descriptions of the ghost and belongings of a deceased adventurer.
194 .It Pa xlock.dd
195 Description of a dungeon level.
196 .It Pa safelock
197 Lock file for xlock.
198 .It Pa record_lock
199 Lock file for record.
201 .Sh AUTHORS
202 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
203 original hack, very much like rogue (but full of bugs).
205 Andries Brouwer continuously deformed their sources into the current
206 version - in fact an entirely different game.
207 .Sh BUGS
208 Probably infinite.
209 Mail complaints to mcvax!aeb .