Revert "Remove 'version' test. Framework plays badly with variable output."

[open-adventure.git] / advent.adoc

diff --git a/advent.adoc b/advent.adoc
index a53ccd3c77eb56287740c10f046ea869dca1bf89..c95758e7ca4ac09e1f453283ac366852fca9631c 100644 (file)
--- a/advent.adoc
+++ b/advent.adoc
@@ -5,7 +5,7 @@
 advent - Colossal Cave Adventure
 
 == SYNOPSIS ==
 advent - Colossal Cave Adventure
 
 == SYNOPSIS ==

-*advent* [-l logfile] [-o]
+*advent* [-l logfile] [-o] [-r savefile] [-s]

 
 == DESCRIPTION ==
 The original Colossal Cave Adventure from 1976-77 was the origin of all
 
 == DESCRIPTION ==
 The original Colossal Cave Adventure from 1976-77 was the origin of all


@@ -20,21 +20,37 @@ original, type 'news' at the command prompt.
 There is an 'adventure' in the BSD games package that is a C port by
 Jim Gillogly of the 1976 ancestor of this game.  To avoid a name
 collision, this game builds as 'advent', reflecting the fact that the
 There is an 'adventure' in the BSD games package that is a C port by
 Jim Gillogly of the 1976 ancestor of this game.  To avoid a name
 collision, this game builds as 'advent', reflecting the fact that the

-PDP-10 on which it originally ran limited filenames to 6 characters.
+PDP-10 on which the game originally ran limited filenames to 6 characters.

 
 This version is released as open source with the permission and
 encouragement of the original authors.
 
 
 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.
+
+Otherwise, the "version" command is about the only way to tell you're not
+running Don's original.
+
+To exit the game, type Ctrl-D (EOF).
+
+There have been no gameplay changes.
+

 == OPTIONS ==
 
 -l:: Log commands to specified file.
 
 == OPTIONS ==
 
 -l:: Log commands to specified file.
 

--o:: Old-style.  Restores original interface, no prompt.
+-r:: Restore game from specified file
+
+-o:: Old-style.  Restores original interface, no prompt or line editing.
+     Also ignores new-school one-letter commands l, x, g, z, i. Also
+     case-smashes and truncates unrecognized text when echoed.

 
 == BUGS ==
 
 
 == BUGS ==
 

-The binary save file format is fragile and unlikely to survive
-through version bumps.
+The binary save file format is fragile, dependent on your machine word
+size and endianness, and unlikely to survive through version bumps. There
+is a version check.

 
 == REPORTING BUGS ==
 Report bugs to Eric S. Raymond <esr@thyrsus.com>.  The project page is
 
 == REPORTING BUGS ==
 Report bugs to Eric S. Raymond <esr@thyrsus.com>.  The project page is