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