* Change program logic to not nest needlessly

[bsdgames-darwin.git] / hack / hack.6

diff --git a/hack/hack.6 b/hack/hack.6
index c4c46c30c2e09ab504e7b5baea0bfc622df53758..f77abcdb753c33c858914a838d0838f6316ea5aa 100644 (file)
--- a/hack/hack.6
+++ b/hack/hack.6
@@ -1,155 +1,209 @@
-.TH HACK 6 "31 March 1985"
-.UC 4
-.SH NAME
-hack \- Exploring The Dungeons of Doom
-.SH SYNOPSIS
-.B /usr/games/hack
-[
-.B \-d
-.I directory
-]
-[
-.B \-n
-]
-[
-.B \-u
-.I playername
-]
-.br
-.B /usr/games/hack
-[
-.B \-d
-.I directory
-]
-.B \-s
-[
-.B \-X
-]
-[
-.I playernames
-]
-.SH DESCRIPTION
-.PP
-.I Hack
-is a display oriented dungeons & dragons - like game.
+.\"    $NetBSD: hack.6,v 1.14 2004/06/01 10:10:06 wiz Exp $    -*- nroff -*-
+.\"
+.\" Copyright (c) 1985, Stichting Centrum voor Wiskunde en Informatica,
+.\" Amsterdam
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions are
+.\" met:
+.\"
+.\" - Redistributions of source code must retain the above copyright notice,
+.\" this list of conditions and the following disclaimer.
+.\"
+.\" - Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" - Neither the name of the Stichting Centrum voor Wiskunde en
+.\" Informatica, nor the names of its contributors may be used to endorse or
+.\" promote products derived from this software without specific prior
+.\" written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+.\" IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+.\" PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+.\" OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+.\" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\"
+.\" Copyright (c) 1982 Jay Fenlason <hack@gnu.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
+.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd March 31, 1985
+.Dt HACK 6
+.Os
+.Sh NAME
+.Nm hack
+.Nd exploring The Dungeons of Doom
+.Sh SYNOPSIS
+.Nm
+.Op Fl d Ar directory
+.Op Fl n
+.Op Fl u Ar playername
+.Nm
+.Op Fl d Ar directory
+.Op Fl s
+.Op Fl X
+.Op Ar playername ...
+.Sh DESCRIPTION
+.Nm
+is a display oriented dungeons \*[Am] dragons-like game.

 Both display and command structure resemble rogue.
 (For a game with the same structure but entirely different display -
 a real cave instead of dull rectangles - try Quest.)
 Both display and command structure resemble rogue.
 (For a game with the same structure but entirely different display -
 a real cave instead of dull rectangles - try Quest.)

-.PP
-To get started you really only need to know two commands.  The command
-.B ?
+.Pp
+To get started you really only need to know two commands.
+The command
+.Ic \&?

 will give you a list of the available commands and the command
 will give you a list of the available commands and the command

-.B /
+.Ic /

 will identify the things you see on the screen.
 will identify the things you see on the screen.

-.PP
-To win the game (as opposed to merely playing to beat other people high
+.Pp
+To win the game (as opposed to merely playing to beat other people's high

 scores) you must locate the Amulet of Yendor which is somewhere below
 scores) you must locate the Amulet of Yendor which is somewhere below

-the 20th level of the dungeon and get it out.  Nobody has achieved this
-yet and if somebody does, he will probably go down in history as a hero
-among heros.
-.PP
+the 20th level of the dungeon and get it out.
+Nobody has achieved this yet and if somebody does, he will probably go
+down in history as a hero among heroes.
+.Pp

 When the game ends, either by your death, when you quit, or if you escape
 from the caves,
 When the game ends, either by your death, when you quit, or if you escape
 from the caves,

-.I hack
-will give you (a fragment of) the list of top scorers.  The scoring
-is based on many aspects of your behaviour but a rough estimate is
-obtained by taking the amount of gold you've found in the cave plus four
-times your (real) experience. Precious stones may be worth a lot of gold
-when brought to the exit.
+.Nm
+will give you (a fragment of) the list of top scorers.
+The scoring is based on many aspects of your behavior but a rough estimate
+is obtained by taking the amount of gold you've found in the cave plus four
+times your (real) experience.
+Precious stones may be worth a lot of gold when brought to the exit.

 There is a 10% penalty for getting yourself killed.
 There is a 10% penalty for getting yourself killed.

-.PP
+.Pp

 The administration of the game is kept in the directory specified with the
 The administration of the game is kept in the directory specified with the

-.B \-d
+.Fl d

 option, or, if no such option is given, in the directory specified by
 option, or, if no such option is given, in the directory specified by

-the environment variable HACKDIR, or, if no such variable exists, in
-the current directory. This same directory contains several auxiliary
-files such as lockfiles and the list of topscorers and a subdirectory
-.I save
+the environment variable
+.Ev HACKDIR ,
+or, if no such variable exists, in the current directory.
+This same directory contains several auxiliary files such as lockfiles and
+the list of topscorers and a subdirectory
+.Pa save

 where games are saved.
 The game administrator may however choose to install hack with a fixed
 where games are saved.
 The game administrator may however choose to install hack with a fixed

-playing ground, usually /usr/games/lib/hackdir.
-.PP
+playing ground, usually
+.Pa /var/games/hackdir .
+.Pp

 The
 The

-.B \-n
+.Fl n

 option suppresses printing of the news.
 option suppresses printing of the news.

-.PP
+.Pp

 The
 The

-.B \-u
-.I playername
+.Fl u
+.Ar playername

 option supplies the answer to the question "Who are you?".
 When
 option supplies the answer to the question "Who are you?".
 When

-.I playername
+.Ar playername

 has as suffix one of
 has as suffix one of

-.B \-T \-S \-K \-F \-C \-W
+.Em -T ,
+.Em -S ,
+.Em -K ,
+.Em -F ,
+.Em -C ,
+or
+.Em -W ,

 then this supplies the answer to the question "What kind of character ... ?".
 then this supplies the answer to the question "What kind of character ... ?".

-.PP
+.Pp

 The
 The

-.B \-s
-option will print out the list of your scores. It may be followed by arguments
-.B \-X
+.Fl s
+option will print out the list of your scores.
+It may be followed by arguments
+.Fl X

 where X is one of the letters C, F, K, S, T, W to print the scores of
 Cavemen, Fighters, Knights, Speleologists, Tourists or Wizards.
 It may also be followed by one or more player names to print the scores of the
 players mentioned.
 where X is one of the letters C, F, K, S, T, W to print the scores of
 Cavemen, Fighters, Knights, Speleologists, Tourists or Wizards.
 It may also be followed by one or more player names to print the scores of the
 players mentioned.

-.SH AUTHORS
+.Sh AUTHORS

 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
 original hack, very much like rogue (but full of bugs).
 .br
 Andries Brouwer continuously deformed their sources into the current
 version - in fact an entirely different game.
 Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the
 original hack, very much like rogue (but full of bugs).
 .br
 Andries Brouwer continuously deformed their sources into the current
 version - in fact an entirely different game.

-.SH FILES
-.DT
-.ta \w'data, rumors\ \ \ 'u
-hack   The hack program.
-.br
-data, rumors   Data files used by hack.
-.br
-help, hh       Help data files.
-.br
-record The list of topscorers.
-.br
-save   A subdirectory containing the saved
-.br
-       games.
-.br
-bones_dd       Descriptions of the ghost and
-.br
-       belongings of a deceased adventurer.
-.br
-xlock.dd       Description of a dungeon level.
-.br
-safelock       Lock file for xlock.
-.br
-record_lock    Lock file for record.
-.SH ENVIRONMENT
-.DT
-.ta \w'HACKPAGER, PAGER\ \ \ 'u
-USER or LOGNAME        Your login name.
-.br
-HOME           Your home directory.
-.br
-SHELL          Your shell.
-.br
-TERM           The type of your terminal.
-.br
-HACKPAGER, PAGER       Pager used instead of default pager.
-.br
-MAIL   Mailbox file.
-.br
-MAILREADER     Reader used instead of default
-.br
-       (probably /bin/mail or /usr/ucb/mail).
-.br
-HACKDIR        Playground.
-.br
-HACKOPTIONS    String predefining several hack options
-.br
-       (see help file).
-.br
-
+.Sh FILES
+.Bl -tag -width 24n -compact
+.It Pa hack
+The hack program.
+.It Pa data, rumors
+Data files used by hack.
+.It Pa help, hh
+Help data files.
+.It Pa record
+The list of topscorers.
+.It Pa save
+A subdirectory containing the saved games.
+.It Pa bones_dd
+Descriptions of the ghost and belongings of a deceased adventurer.
+.It Pa xlock.dd
+Description of a dungeon level.
+.It Pa safelock
+Lock file for xlock.
+.It Pa record_lock
+Lock file for record.
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width 24n -compact
+.It Ev USER No or Ev LOGNAME
+Your login name.
+.It Ev HOME
+Your home directory.
+.It Ev SHELL
+Your shell.
+.It Ev TERM
+The type of your terminal.
+.It Ev HACKPAGER, PAGER
+Pager used instead of default pager.
+.It Ev MAIL
+Mailbox file.
+.It Ev MAILREADER
+Reader used instead of default (probably
+.Pa /usr/bin/mail ) .
+.It Ev HACKDIR
+Playground.
+.It Ev HACKOPTIONS
+String predefining several hack options (see help file).
+.El
+.Pp

 Several other environment variables are used in debugging (wizard) mode,
 Several other environment variables are used in debugging (wizard) mode,

-like GENOCIDED, INVENT, MAGIC and SHOPTYPE.
-.SH BUGS
-.PP
+like
+.Ev GENOCIDED ,
+.Ev INVENT ,
+.Ev MAGIC
+and
+.Ev SHOPTYPE .
+.Sh BUGS

 Probably infinite.
 Mail complaints to mcvax!aeb .
 Probably infinite.
 Mail complaints to mcvax!aeb .