Test Coverage -- lots of new pieces of actions.c

[open-adventure.git] / advent.adoc

diff --git a/advent.adoc b/advent.adoc
index 7280b03b29e7eb72d0f70af8a7d0b4e00acf2d41..2ce8962dfaacaa5a21e57b1a4bc5fbf56301eea9 100644 (file)
--- a/advent.adoc
+++ b/advent.adoc
@@ -5,11 +5,11 @@
 advent - Colossal Cave Adventure
 
 == SYNOPSIS ==
-*advent* [-l logfile] [-o]
+*advent* [-l logfile] [-o] [-r savefile] [-s]
 
 == DESCRIPTION ==
-The original Colossal Cave Adventure from 1976 was the origin of all
-text adventures, dungeon-crawl (computer) games, and computer-hosted
+The original Colossal Cave Adventure from 1976-77 was the origin of all
+later text adventures, dungeon-crawl (computer) games, and computer-hosted
 roleplaying games.
 
 This is the last version released by Crowther & Woods, its original
@@ -25,15 +25,32 @@ PDP-10 on which it originally ran limited filenames to 6 characters.
 This version is released as open source with the permission and
 encouragement of the original authors.
 
+Unlike the original, this version supports use of your arrow keys to edit
+your command line in place.  Basic Emacs keystrokes are supported, and
+your up/down arrows access a command history.
+
+To exit the game, type Ctrl-D (EOF).
+
+There have been no gameplay changes.
+
 == OPTIONS ==
 
 -l:: Log commands to specified file.
 
--o:: Old-style.  Restores original interface, no prompt.
+-s:: Suppress Emacs-like line editing and command history.
+
+-r:: Restore game from specified file
+
+-o:: Old-style.  Restores original interface, no prompt or line editing.
+
+== BUGS ==
+
+The binary save file format is fragile, dependent on your machine word
+size and endianness, and unlikely to survive through version bumps.
 
 == REPORTING BUGS ==
 Report bugs to Eric S. Raymond <esr@thyrsus.com>.  The project page is
-at http://catb.org/~esr/advent
+at http://catb.org/~esr/open-adventure
 
 == SEE ALSO ==
 wumpus(6), adventure(6), zork(6), rogue(6), nethack(6).