]> git.pond.sub.org Git - empserver/blobdiff - doc/clients-howto
client: Unbreak standalone build
[empserver] / doc / clients-howto
index 64c92b678ee3270528c46bfede547a68c2e514cd..ad4767473093334ca69cc8aeec244c0eb15cf74e 100644 (file)
@@ -17,13 +17,13 @@ The server sends lines of output.  Each output line starts with an
 identification string, followed by a space, then arbitrary text, then
 a line feed.
 
 identification string, followed by a space, then arbitrary text, then
 a line feed.
 
-Identification strings encode small integers called output ids as base
+Identification strings encode small integers called output IDs as base
 36 numbers.  Characters '0' to '9' represent digits 0 to 9, and 'a' to
 36 numbers.  Characters '0' to '9' represent digits 0 to 9, and 'a' to
-'z' represent 10..35, as do 'A' to 'Z'.  Symbolic names for ids are
+'z' represent 10..35, as do 'A' to 'Z'.  Symbolic names for IDs are
 defined in proto.h.
 
 defined in proto.h.
 
-empire-client versions before version 4.3.11 parse large output ids
-incorrectly.  Such ids do not currently occur.
+empire-client versions before version 4.3.11 parse large output IDs
+incorrectly.  Such IDs do not currently occur.
 
 Clients shall be able to safely handle output lines of arbitrary
 length.  Naturally, a client may not be able to handle a sufficiently
 
 Clients shall be able to safely handle output lines of arbitrary
 length.  Naturally, a client may not be able to handle a sufficiently
@@ -36,6 +36,7 @@ The following control characters have a defined meaning:
 
   ASCII name        decimal  meaning
   ----------------------------------------------------
 
   ASCII name        decimal  meaning
   ----------------------------------------------------
+  bell                  7    ring the bell
   horizontal tab        9    move to next tab stop(1)
   line feed            10    end of line
   shift out            14    begin highlighting(2)
   horizontal tab        9    move to next tab stop(1)
   line feed            10    end of line
   shift out            14    begin highlighting(2)
@@ -184,7 +185,7 @@ empire-client signals `EOF' when it encounters an end-of-file
 condition while reading player input.  It signals `interrupt' when it
 catches SIGINT, which is normally triggered by Ctrl-C.
 
 condition while reading player input.  It signals `interrupt' when it
 catches SIGINT, which is normally triggered by Ctrl-C.
 
-The following ids occur:
+The following IDs occur:
 
 * Command prompt C_PROMPT
 
 
 * Command prompt C_PROMPT
 
@@ -263,7 +264,7 @@ The following ids occur:
   rejects redirections in batch files.
 
   Certain bad failures make the server ignore the rest of the batch
   rejects redirections in batch files.
 
   Certain bad failures make the server ignore the rest of the batch
-  file file.  This feature is too hard to predict to be really useful.
+  file.  This feature is too hard to predict to be really useful.
 
   Protocol flaw: strictly asynchronous clients cannot support
   C_EXECUTE correctly.  By the time C_EXECUTE arrives, the client may
 
   Protocol flaw: strictly asynchronous clients cannot support
   C_EXECUTE correctly.  By the time C_EXECUTE arrives, the client may
@@ -285,7 +286,7 @@ The following ids occur:
 
   empire-client prints the text verbatim, prepended by a line feed.
   This is clearly sub-optimal, because it can be inserted in the
 
   empire-client prints the text verbatim, prepended by a line feed.
   This is clearly sub-optimal, because it can be inserted in the
-  middle of user input.  Clients wishing to to display asynchronous
+  middle of user input.  Clients wishing to display asynchronous
   messages together with normal I/O should insert them before the
   current prompt.
 
   messages together with normal I/O should insert them before the
   current prompt.
 
@@ -350,12 +351,12 @@ The following ids occur:
 
   The security considerations on C_PIPE apply to C_REDIR as well.
 
 
   The security considerations on C_PIPE apply to C_REDIR as well.
 
-* Other ids
+* Other IDs
 
 
-  Other ids do not occur currently.  Clients shall deal gracefully
-  with ids they don't know.
+  Other IDs do not occur currently.  Clients shall deal gracefully
+  with IDs they don't know.
 
 
-  empire-client treats unknown ids like C_DATA.  Versions before
+  empire-client treats unknown IDs like C_DATA.  Versions before
   4.3.11 prepend "Aborted\n" to C_ABORT lines, and "Error; " to
   C_CMDERR and C_BADCMD lines for historical reasons.
 
   4.3.11 prepend "Aborted\n" to C_ABORT lines, and "Error; " to
   C_CMDERR and C_BADCMD lines for historical reasons.