Clarify what happens when the player aborts commands
authorMarkus Armbruster <armbru@pond.sub.org>
Tue, 7 Feb 2012 06:26:57 +0000 (07:26 +0100)
committerMarkus Armbruster <armbru@pond.sub.org>
Tue, 21 Feb 2012 17:11:13 +0000 (18:11 +0100)
doc/clients-howto

index 1dee5e7123cafe3078a5bd2f293dc76534102584..cb17bfb0f42e4293f2dde6f99939044e86114c8f 100644 (file)
@@ -49,7 +49,7 @@ clients.  Likewise, overlong or malformed UTF-8 sequences should not
 occur and may be ignored.
 
 The server prompts for input.  Each prompt `consumes' one line of
-input (except for C_EXECUTE, and when the update aborts a command, as
+input (except for C_EXECUTE, and when a command is aborted, as
 described below).  Input lines are arbitrary text, terminated by line
 feed, which is optionally preceded by carriage return (decimal 13).
 Lines should not contain ASCII control characters other than
@@ -198,8 +198,12 @@ The following ids occur:
 * Argument prompt C_FLUSH
 
   The server consumes a line of input and passes it to the currently
-  executing command.  Commands usually fail on interrupt.  The server
-  terminates the session on EOF (but see C_EXECUTE for an exception).
+  executing command.
+
+  The server aborts the command on interrupt and EOF.  Any argument
+  prompts it may send before the next command prompt do not consume
+  input.  On EOF, the server then terminates the session (but see
+  C_EXECUTE for an exception).
 
   If an update runs while the server waits for the line of input to
   arrive, the current command is aborted.  Whether the server consumes