tidying
[users/heiko/exim.git] / test / README
index f9ee5d0a9d6f57a93ae68803526abb2cd2213ff1..d944b29ac8ec792b96908499f8b84f2275228c66 100644 (file)
@@ -115,7 +115,7 @@ In order to run this test suite, the following requirements must be met:
     is also an IPv6 address, additional tests are run when the Exim binary
     contains IPv6 support. There are checks in the scripts for a running IPv4
     interface; when one is not found, some tests are skipped (with a warning
-    message).  The local net may not be in 10.0/8 as that is used by the suite.
+    message).  The local net may not be in 10.250.0/16 as that is used by the suite.
 
 (9) Exim must be built with TRUSTED_CONFIG_LIST support, so that the test
     configs can be placed into it.  A suitable file location is .../exim/test/trusted_configs
@@ -517,6 +517,9 @@ bin/client-ssl     A script-driven SMTP client simulation with OpenSSL support.
                    This is built only if OpenSSL support is detected on the
                    host.
 
+bin/client-anytls  A symlink to either client-ssl or client-gnutls, if
+                   any is built.
+
 bin/fakens         A fake "nameserver" for DNS tests (see below for details).
 
 bin/fd             A program that outputs details of open file descriptors.
@@ -702,6 +705,11 @@ Commands with no input
 These commands are not followed by any input data, or by a line of asterisks.
 
 
+  ### This is a verbose comment
+
+A line starting with three hashmarks and some space copies the following text to
+both stdout and stderr file being written by the test.
+
   dbmbuild <file1> <file1>
 
 This command runs the exim_dbmbuild utility to build a DBM file. It is used
@@ -724,7 +732,8 @@ scripts.
   exim_lock [options] <file name>
 
 This command runs the exim_lock utility with the given options and file name.
-The file remains locked with the following command (normally exim) is obeyed.
+The file remains locked for following commands until a non-daemon "exim"
+completes.
 
 
   exinext <data>
@@ -969,8 +978,9 @@ connections. Here are some example commands:
 
 The following lines, up to a line of four asterisks, are the server's
 controlling standard input (described below). These lines are read and
-remembered; during the following commands, until an "exim" command is reached,
-the server is run in parallel.
+remembered; during the following commands, until a non-deamon "exim" command
+is reached, the server is run in parallel.  Then the server termination
+is waited for.
 
 
   write <file name> [nxm[=start-of-line-text]]*
@@ -1017,27 +1027,36 @@ one-off things to be done.
 CLIENT SCRIPTS
 --------------
 
-Lines in client scripts are of two kinds:
+Lines in client scripts are of several kinds:
 
 (1) If a line begins with three question marks and a space, the rest of the
     line defines the start of expected output from the server. If what is
     received does not match, the client bombs out with an error message.
 
-(2) If a line starts with three plus signs followed by a space, the rest of the
+(2) If a line begins with three question marks and an asterisk, the server
+    is expected to close the connection.
+
+(3) If a line begins with four question marks, the rest of the line defines
+    the start of one or more possible output lines from the server.  When it
+    matches, the client silently repeats the comparison using the next server
+    line.  When the match fails, the client silently proceeds to the next script
+    line with the then-current server output unconsumed.
+
+(4) If a line starts with three plus signs followed by a space, the rest of the
     line specifies a number of seconds to sleep for before proceeding.
 
-(3) If a line begins with three '>' characters and a space, the rest of the
+(5) If a line begins with three '>' characters and a space, the rest of the
     line is input to be sent to the server.  Backslash escaping is done as
     described below, but no trailing "\r\n" is sent.
 
-(4) If a line begin with three '<' characters and a space, the rest of the
+(6) If a line begin with three '<' characters and a space, the rest of the
     line is a filename; the content of the file is inserted intto the script
     at this point.
 
-(5) Otherwise, the line is an input line line that is sent to the server. Any
+(7) Otherwise, the line is an input line line that is sent to the server. Any
     occurrences of \r and \n in the line are turned into carriage return and
     linefeed, respectively. This is used for testing PIPELINING.
-    Any sequences of \x followed by two hex digits are converted to the equvalent
+    Any sequences of \x followed by two hex digits are converted to the equivalent
     byte value.  Any other character following a \ is sent verbatim.
     The line is sent with a trailing "\r\n".