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