Add -a option to synopsis.
[open-adventure.git] / advent.adoc
1 = advent(6) =
2 :doctype: manpage
3 // SPDX-FileCopyrightText: Copyright Eric S. Raymond <esr@thyrsus.com>
4 // SPDX-License-Identifier: CC-BY-4.0
5
6 == NAME ==
7 advent - Colossal Cave Adventure
8
9 == SYNOPSIS ==
10 *advent* [-l logfile] [-o] [-r savefile] [-a savefile] [script...]
11
12 == DESCRIPTION ==
13 The original Colossal Cave Adventure from 1976-1977 was the origin of all
14 later text adventures, dungeon-crawl (computer) games, and computer-hosted
15 roleplaying games.
16
17 This is the last version released by Crowther & Woods, its original
18 authors, in 1995.  It has been known as "adventure 2.5" and "430-point
19 adventure".  To learn more about the changes since the 350-point
20 original, type 'news' at the command prompt.
21
22 There is an 'adventure' in the BSD games package that is a C port by
23 Jim Gillogly of the Don Woods's 1977 version of this game.  To avoid a name
24 collision, this game builds as 'advent', reflecting the fact that the
25 PDP-10 on which the game originally ran limited filenames to 6 characters.
26
27 This version is released as open source with the permission and
28 encouragement of the original authors.
29
30 Unlike the original, this version has a command prompt and supports
31 use of your arrow keys to edit your command line in place.  Basic
32 Emacs keystrokes are supported, and your up/down arrows access a
33 command history.
34
35 Some minor bugs and message typos have been fixed.  Otherwise, the
36 "version" command is almost the only way to tell you're not running
37 Don's 1977 version.
38
39 To exit the game, type Ctrl-D (EOF).
40
41 There have been no gameplay changes.
42
43 == OPTIONS ==
44
45 -l:: Log commands to specified file.
46
47 -r:: Restore game from specified file
48
49 -a:: Load from specified file and autosave to it on exit or signal.
50
51 -o:: Old-style.  Reverts some minor cosmetic fixes in game
52      messages. Restores original interface, no prompt or line editing.
53      Also ignores new-school one-letter commands l, x, g, z, i. Also
54      case-smashes and truncates unrecognized text when echoed.
55
56 Normally, game input is taken from standard input.  If script file
57 arguments are given, input is taken from them instead.  A script file
58 argument of '-' is taken as a directive to read from standard input.
59
60 == BUGS ==
61
62 The binary save file format is fragile, dependent on your machine word
63 size and endianness, and unlikely to survive through version bumps. There
64 is a version check.
65
66 The input parser was the first attempt *ever* at natural-language
67 parsing in a game and has some known deficiencies.  While later text
68 adventures distinguished between transitive and intransitive verbs,
69 Adventure's grammar distinguishes only between motion and action
70 verbs. Motions are always immediate in their behavior, so both ACTION
71 MOTION and MOTION ACTION (and even MOTION NOUN and MOTION MOTION) are
72 invariably equivalent to MOTION (thus GO NORTH means NORTH and JUMP
73 DOWN means JUMP). Whereas, with actions and nouns, the parser collects
74 words until it's seen one of each, and then dispatches; if it reaches
75 the end of the command without seeing a noun, it'll dispatch an
76 "intransitive" action. This makes ACTION1 ACTION2 equivalent to
77 ACTION2 (thus TAKE INVENTORY means INVENTORY), and NOUN ACTION
78 equivalent to ACTION NOUN.
79
80 Thus you get anomalies like "eat building" interpreted as a command
81 to move to the building. These should not be reported as bugs; instead,
82 consider them historical curiosities.
83
84 == REPORTING BUGS ==
85 Report bugs to Eric S. Raymond <esr@thyrsus.com>.  The project page is
86 at http://catb.org/~esr/open-adventure
87
88 == SEE ALSO ==
89 wumpus(6), adventure(6), zork(6), rogue(6), nethack(6).