Documentation ownership tweaks

[users/heiko/exim.git] / test / README

diff --git a/test/README b/test/README
index 232b9e96c66389917c5a898ba60e6dcf47ced3fc..c1398329df67b430aeac93bf4c08eabe009c92ba 100644 (file)
--- a/test/README
+++ b/test/README
@@ -1,12 +1,12 @@
-$Cambridge: exim/test/README,v 1.4 2006/07/26 14:39:13 ph10 Exp $
+$Cambridge: exim/test/README,v 1.8 2007/02/20 15:58:02 ph10 Exp $

 
 EXPORTABLE EXIM TEST SUITE
 --------------------------
 
 This document last updated for:
 
 
 EXPORTABLE EXIM TEST SUITE
 --------------------------
 
 This document last updated for:
 

-Test Suite Version: 4.63
-Date: 25 July 2006
+Test Suite Version: 4.67
+Date: 20 February 2007

 
 
 BACKGROUND
 
 
 BACKGROUND


@@ -436,7 +436,11 @@ bin/iefbr14        A program that does nothing, and returns 0. It's just like
 
 bin/loaded         Some dynamically loaded functions for testing dlfunc support.
 
 
 bin/loaded         Some dynamically loaded functions for testing dlfunc support.
 

-bin/server         A script-driven SMTP server simulation.
+bin/mtpscript      A script-driven SMTP/LMTP server simulation, on std{in,out}.
+
+bin/server         A script-driven SMTP server simulation, over a socket.
+
+bin/showids        Output the current uid, gid, euid, egid.

 
 The runtest script also makes use of a number of ordinary commands such as
 "cp", "kill", "more", and "rm", via the system() call. In some cases these are
 
 The runtest script also makes use of a number of ordinary commands such as
 "cp", "kill", "more", and "rm", via the system() call. In some cases these are


@@ -602,6 +606,7 @@ Commands with no input
 
 These commands are not followed by any input data, or by a line of asterisks.
 
 
 These commands are not followed by any input data, or by a line of asterisks.
 

+

   dbmbuild <file1> <file1>
 
 This command runs the exim_dbmbuild utility to build a DBM file. It is used
   dbmbuild <file1> <file1>
 
 This command runs the exim_dbmbuild utility to build a DBM file. It is used


@@ -609,19 +614,41 @@ only when DBM support is available in Exim, and typically follows the use of a
 "write" command (see below) that creates the input file.
 
 
 "write" command (see below) that creates the input file.
 
 

+  dumpdb <dbname>
+
+This command runs the exim_dumpdb utility on the testing spool directory, using
+the database name given, for example: "dumpdb retry".
+
+

   echo <text>
 
 The text is written to the screen; this is used to output comments from
 scripts.
 
 
   echo <text>
 
 The text is written to the screen; this is used to output comments from
 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.
+
+
+  exinext <data>
+
+This command runs the exinext utility with the given argument data.
+
+
+  exigrep <data>
+
+This command runs the exigrep utility with the given data (the search pattern)
+on the current mainlog file.
+
+

   gnutls
 
 This command is present at the start of all but one of the tests that use
 GnuTLS. It copies a pre-existing parameter file into the spool directory, so
 that Exim does not have to re-create the file each time. The first GnuTLS test
   gnutls
 
 This command is present at the start of all but one of the tests that use
 GnuTLS. It copies a pre-existing parameter file into the spool directory, so
 that Exim does not have to re-create the file each time. The first GnuTLS test

-does not do this, in order to test that Exim can create the file (it takes some
-time).
+does not do this, in order to test that Exim can create the file.

 
 
   killdaemon
 
 
   killdaemon


@@ -676,6 +703,7 @@ If this command is encountered anywhere in the script, message log files that
 are still in existence at the end of the run (for messages that were not
 delivered) are not compared with saved versions.
 
 are still in existence at the end of the run (for messages that were not
 delivered) are not compared with saved versions.
 

+

   no_stderr_check
 
 If this command is encountered anywhere in the script, the stderr output from
   no_stderr_check
 
 If this command is encountered anywhere in the script, the stderr output from


@@ -712,9 +740,9 @@ deliveries because on different systems the processes may terminate in a
 different order.
 
 
 different order.
 
 

-A number of standard file management commands are recognized. These are cat,
-chmod, chown, cp, ln, ls, du, mkdir, mkfifo, rm, rmdir, and touch. Some are run
-as root using "sudo".
+A number of standard file management commands are also recognized. These are
+cat, chmod, chown, cp, du, ln, ls, du, mkdir, mkfifo, rm, rmdir, and touch.
+Some are run as root using "sudo".

 
 
 Commands with input
 
 
 Commands with input


@@ -737,9 +765,12 @@ as well as to the named file.
 
 This command runs the auxiliary "client" program that simulates an SMTP client.
 It is controlled by a script read from its standard input, details of which are
 
 This command runs the auxiliary "client" program that simulates an SMTP client.
 It is controlled by a script read from its standard input, details of which are

-given below. The only option is -t, which must be followed by a number, to
-specify the command timeout in seconds. The program connects to the given IP
-address and port, using the specified interface, if one is given.
+given below. There are two options. One is -t, which must be followed directly
+by a number, to specify the command timeout in seconds (e.g. -t5). The default
+timeout is 1 second. The other option is -tls-on-connect, which causes the
+client to try to start up a TLS session as soon as it has connected, without
+using the STARTTLS command. The client program connects to the given IP address
+and port, using the specified interface, if one is given.

 
 
   client-ssl [<options>] <ip address> <port> [<outgoing interface>] \
 
 
   client-ssl [<options>] <ip address> <port> [<outgoing interface>] \


@@ -933,7 +964,7 @@ are of the following kinds:
     may start with '<', which is not taken as part of the input data. If the
     input does not match, the server bombs out with an error message.
 
     may start with '<', which is not taken as part of the input data. If the
     input does not match, the server bombs out with an error message.
 

-Here is a simple server example:
+Here is a simple example of server use in a test script:

 
   server PORT_S
   220 Greetings
 
   server PORT_S
   220 Greetings


@@ -956,6 +987,11 @@ After a "server" command in a test script, the server runs in parallel until an
 messages to port PORT_S on the local host. When it has finished, the test
 script waits for the "server" process to finish.
 
 messages to port PORT_S on the local host. When it has finished, the test
 script waits for the "server" process to finish.
 

+The "mtpscript" program is like "server", except that it uses stdin/stdout for
+its input and output instead of a script. However, it is not called from test
+scripts; instead it is used as the command for pipe transports in some
+configurations, to simulate non-socket LMTP servers.
+

 
 AUXILIARY DATA FILES
 --------------------
 
 AUXILIARY DATA FILES
 --------------------