Merge branch 'debian' into hcoop_489

[hcoop/debian/exim4.git] / doc / exim.8

diff --git a/doc/exim.8 b/doc/exim.8
index 0fccbc7..11f8e6b 100644 (file)
--- a/doc/exim.8
+++ b/doc/exim.8
@@ -163,7 +163,7 @@ continuations. As in Exim's run time configuration, white space at the start of
 continuation lines is ignored. Each argument or data line is passed through the
 string expansion mechanism, and the result is output. Variable values from the
 configuration file (for example, \fI$qualify_domain\fP) are available, but no
 continuation lines is ignored. Each argument or data line is passed through the
 string expansion mechanism, and the result is output. Variable values from the
 configuration file (for example, \fI$qualify_domain\fP) are available, but no

-message\-specific values (such as \fI$sender_domain\fP) are set, because no message
+message\-specific values (such as \fI$message_exim_id\fP) are set, because no message

 is being processed (but see \fB\-bem\fP and \fB\-Mset\fP).
 .sp
 \fBNote\fP: If you use this mechanism to test lookups, and you change the data
 is being processed (but see \fB\-bem\fP and \fB\-Mset\fP).
 .sp
 \fBNote\fP: If you use this mechanism to test lookups, and you change the data


@@ -370,7 +370,8 @@ preference to the address taken from the message. The caller of Exim must be a
 trusted user for the sender of a message to be set in this way.
 .TP 10
 \fB\-bmalware\fP <\fIfilename\fP>
 trusted user for the sender of a message to be set in this way.
 .TP 10
 \fB\-bmalware\fP <\fIfilename\fP>

-This debugging option causes Exim to scan the given file,
+This debugging option causes Exim to scan the given file or directory
+(depending on the used scanner interface),

 using the malware scanning framework.  The option of \fBav_scanner\fP influences
 this option, so if \fBav_scanner\fP's value is dependent upon an expansion then
 the expansion should have defaults which apply to this invocation.  ACLs are
 using the malware scanning framework.  The option of \fBav_scanner\fP influences
 this option, so if \fBav_scanner\fP's value is dependent upon an expansion then
 the expansion should have defaults which apply to this invocation.  ACLs are


@@ -419,8 +420,12 @@ users, the output is as in this example:
 .sp
   mysql_servers = <value not displayable>
 .sp
 .sp
   mysql_servers = <value not displayable>
 .sp

-If \fBconfigure_file\fP is given as an argument, the name of the run time
-configuration file is output.
+If \fBconfig\fP is given as an argument, the config is
+output, as it was parsed, any include file resolved, any comment removed.
+.sp
+If \fBconfig_file\fP is given as an argument, the name of the run time
+configuration file is output. (\fBconfigure_file\fP works too, for
+backward compatibility.)

 If a list of configuration files was supplied, the value that is output here
 is the name of the file that was actually used.
 .sp
 If a list of configuration files was supplied, the value that is output here
 is the name of the file that was actually used.
 .sp


@@ -453,6 +458,10 @@ using one of the words \fBrouter_list\fP, \fBtransport_list\fP, or
 settings can be obtained by using \fBrouters\fP, \fBtransports\fP, or
 \fBauthenticators\fP.
 .sp
 settings can be obtained by using \fBrouters\fP, \fBtransports\fP, or
 \fBauthenticators\fP.
 .sp

+If \fBenvironment\fP is given as an argument, the set of environment
+variables is output, line by line. Using the \fB\-n\fP flag suppresses the value of the
+variables.
+.sp

 If invoked by an admin user, then \fBmacro\fP, \fBmacro_list\fP and \fBmacros\fP
 are available, similarly to the drivers.  Because macros are sometimes used
 for storing passwords, this option is restricted.
 If invoked by an admin user, then \fBmacro\fP, \fBmacro_list\fP and \fBmacros\fP
 are available, similarly to the drivers.  Because macros are sometimes used
 for storing passwords, this option is restricted.


@@ -790,6 +799,7 @@ example:
   exim '\-D ABC = something' ...
 .sp
 \fB\-D\fP may be repeated up to 10 times on a command line.
   exim '\-D ABC = something' ...
 .sp
 \fB\-D\fP may be repeated up to 10 times on a command line.

+Only macro names up to 22 letters long can be set.

 .TP 10
 \fB\-d\fP<\fIdebug options\fP>
 This option causes debugging information to be written to the standard
 .TP 10
 \fB\-d\fP<\fIdebug options\fP>
 This option causes debugging information to be written to the standard


@@ -1003,6 +1013,16 @@ This option is not intended for use by external callers. It is used internally
 by Exim in conjunction with the \fB\-MC\fP option. It signifies that the
 connection to the remote host has been authenticated.
 .TP 10
 by Exim in conjunction with the \fB\-MC\fP option. It signifies that the
 connection to the remote host has been authenticated.
 .TP 10

+\fB\-MCD\fP
+This option is not intended for use by external callers. It is used internally
+by Exim in conjunction with the \fB\-MC\fP option. It signifies that the
+remote host supports the ESMTP DSN extension.
+.TP 10
+\fB\-MCG\fP
+This option is not intended for use by external callers. It is used internally
+by Exim in conjunction with the \fB\-MC\fP option. It signifies that an
+alternate queue is used, named by the following option.
+.TP 10

 \fB\-MCP\fP
 This option is not intended for use by external callers. It is used internally
 by Exim in conjunction with the \fB\-MC\fP option. It signifies that the server to
 \fB\-MCP\fP
 This option is not intended for use by external callers. It is used internally
 by Exim in conjunction with the \fB\-MC\fP option. It signifies that the server to


@@ -1141,7 +1161,8 @@ for that message.
 \fB\-n\fP
 This option is interpreted by Sendmail to mean "no aliasing".
 For normal modes of operation, it is ignored by Exim.
 \fB\-n\fP
 This option is interpreted by Sendmail to mean "no aliasing".
 For normal modes of operation, it is ignored by Exim.

-When combined with \fB\-bP\fP it suppresses the name of an option from being output.
+When combined with \fB\-bP\fP it makes the output more terse (suppresses
+option names, environment values and config pretty printing).

 .TP 10
 \fB\-O\fP <\fIdata\fP>
 This option is interpreted by Sendmail to mean set option. It is ignored by
 .TP 10
 \fB\-O\fP <\fIdata\fP>
 This option is interpreted by Sendmail to mean set option. It is ignored by


@@ -1404,7 +1425,8 @@ configuration option called \fBprod_requires_admin\fP which can be set false to
 relax this restriction (and also the same requirement for the \fB\-M\fP, \fB\-R\fP,
 and \fB\-S\fP options).
 .sp
 relax this restriction (and also the same requirement for the \fB\-M\fP, \fB\-R\fP,
 and \fB\-S\fP options).
 .sp

-The \fB\-q\fP option starts one queue runner process. This scans the queue of
+If other commandline options do not specify an action,
+the \fB\-q\fP option starts one queue runner process. This scans the queue of

 waiting messages, and runs a delivery process for each one in turn. It waits
 for each delivery process to finish before starting the next one. A delivery
 process may not actually do any deliveries if the retry times for the addresses
 waiting messages, and runs a delivery process for each one in turn. It waits
 for each delivery process to finish before starting the next one. A delivery
 process may not actually do any deliveries if the retry times for the addresses


@@ -1469,6 +1491,21 @@ The \fIl\fP (the letter "ell") flag specifies that only local deliveries are to
 be done. If a message requires any remote deliveries, it remains on the queue
 for later delivery.
 .TP 10
 be done. If a message requires any remote deliveries, it remains on the queue
 for later delivery.
 .TP 10

+\fB\-q[q][i][f[f]][l][G<name>[/<time>]]]\fP
+If the \fIG\fP flag and a name is present, the queue runner operates on the
+queue with the given name rather than the default queue.
+The name should not contain a \fI/\fP character.
+For a periodic queue run (see below)
+append to the name a slash and a time value.
+.sp
+If other commandline options specify an action, a \fI\-qG<name>\fP option
+will specify a queue to operate on.
+For example:
+.sp
+  exim \-bp \-qGquarantine
+  mailq \-qGquarantine
+  exim \-qGoffpeak \-Rf @special.domain.example
+.TP 10

 \fB\-q\fP<\fIqflags\fP> <\fIstart id\fP> <\fIend id\fP>
 When scanning the queue, Exim can be made to skip over messages whose ids are
 lexically less than a given value by following the \fB\-q\fP option with a
 \fB\-q\fP<\fIqflags\fP> <\fIstart id\fP> <\fIend id\fP>
 When scanning the queue, Exim can be made to skip over messages whose ids are
 lexically less than a given value by following the \fB\-q\fP option with a


@@ -1634,6 +1671,12 @@ this option.
 \fB\-X\fP <\fIlogfile\fP>
 This option is interpreted by Sendmail to cause debug information to be sent
 to the named file.  It is ignored by Exim.
 \fB\-X\fP <\fIlogfile\fP>
 This option is interpreted by Sendmail to cause debug information to be sent
 to the named file.  It is ignored by Exim.

+.TP 10
+\fB\-z\fP <\fIlog\-line\fP>
+This option writes its argument to Exim's logfile.
+Use is restricted to administrators; the intent is for operational notes.
+Quotes should be used to maintain a multi\-word item as a single argument,
+under most shells.

 .sp
 .
 .SH "SEE ALSO"
 .sp
 .
 .SH "SEE ALSO"