diff options
Diffstat (limited to 'debian/manpages')
| -rw-r--r-- | debian/manpages/exicyclog.8 | 67 | ||||
| -rw-r--r-- | debian/manpages/exigrep.8 | 62 | ||||
| -rw-r--r-- | debian/manpages/exim_checkaccess.8 | 73 | ||||
| -rw-r--r-- | debian/manpages/exim_convert4r4.8 | 65 | ||||
| -rw-r--r-- | debian/manpages/exim_db.8 | 162 | ||||
| -rw-r--r-- | debian/manpages/exim_dbmbuild.8 | 98 | ||||
| -rw-r--r-- | debian/manpages/exim_lock.8 | 130 | ||||
| -rw-r--r-- | debian/manpages/eximon.8 | 43 | ||||
| -rw-r--r-- | debian/manpages/exinext.8 | 66 | ||||
| -rw-r--r-- | debian/manpages/exiqgrep.8 | 81 | ||||
| -rw-r--r-- | debian/manpages/exiqsumm.8 | 67 | ||||
| -rw-r--r-- | debian/manpages/exiwhat.8 | 95 | ||||
| -rw-r--r-- | debian/manpages/update-exim4.conf.8 | 134 | ||||
| -rw-r--r-- | debian/manpages/update-exim4defaults.8 | 157 |
14 files changed, 1300 insertions, 0 deletions
diff --git a/debian/manpages/exicyclog.8 b/debian/manpages/exicyclog.8 new file mode 100644 index 0000000..dedc066 --- /dev/null +++ b/debian/manpages/exicyclog.8 @@ -0,0 +1,67 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXICYCLOG 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exicyclog \- Cycle exim's logfiles +.SH SYNOPSIS +.B eximcyclog +.SH DESCRIPTION +The +.B exicyclog +script can be used to cycle (rotate) +.I mainlog +and +.I rejectlog +files. +This is not necessary if only syslog is being used. +Some operating systems have their own standard mechanisms for log cycling, +and these can be used instead of +.B exicyclog +if preferred. + +Each time +.B exicyclog +is run the file names get 'shuffled down' by one. +If the main log file name is mainlog (the default) then when +.B exicyclog +is run mainlog becomes mainlog.01, the previous mainlog.01 becomes mainlog.02 +and so on, up to a limit which is set in the script, and which defaults to 10. +Reject logs are handled similarly. + +If no mainlog file exists, the script does nothing. +Files that 'drop off' the end are deleted. +All files with numbers greater than 01 are compressed, using a compression +command which is configured by the COMPRESS_COMMAND setting in +Local/Makefile. +It is usual to run "exicyclog" daily from a root "crontab" entry of the +form + + 1 0 * * * su exim -c /usr/exim/bin/exicyclog + +assuming you have used the name 'exim' for the Exim user. +You can run +.B exicyclog +as root if you wish, but there is no need. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exigrep.8 b/debian/manpages/exigrep.8 new file mode 100644 index 0000000..4de6422 --- /dev/null +++ b/debian/manpages/exigrep.8 @@ -0,0 +1,62 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIGREP 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +EXIGREP \- Search Exim's main log +.SH SYNOPSIS +.B exigrep +.I [-l] pattern [log file] ... + +.SH DESCRIPTION +The +.B exigrep +utility is a Perl script that searches one or more main log files for +entries that match a given pattern. +When it finds a match, it extracts all the log entries for the relevant +message, not just those that match the pattern. +Thus, +.B exigrep +can extract complete log entries for a given message, or all mail for a given +user, or for a given host, for example. + +The +.I -l +flag means 'literal', that is, treat all characters in the pattern as +standing for themselves. +Otherwise the pattern must be a Perl regular expression. +The pattern match is case-insensitive. +If no file names are given on the command line, the standard input is +read. + +If the location of a +.B zcat +command is known from the definition of ZCAT_COMMAND in Local/Makefile, +.B exigrep +automatically passes any file whose +name ends in COMPRESS_SUFFIX through +.B zcat +as it searches it. +.SH SEE ALSO +.BR exim (8), +.BR perlre (1), +/usr/share/doc/exim4-base/ + + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exim_checkaccess.8 b/debian/manpages/exim_checkaccess.8 new file mode 100644 index 0000000..1062af3 --- /dev/null +++ b/debian/manpages/exim_checkaccess.8 @@ -0,0 +1,73 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIM_CHECKACCESS 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exim_checkaccess \- Check address acceptance from given IP +.SH SYNOPSIS +.B exim_checkaccess +.I IP-address email@address [more Exim options] + +.SH DESCRIPTION +.B Exim's +.I -bh +command line argument allows you to run a fake SMTP session with debugging +output, in order to check what Exim is doing when it is applying policy +controls to incoming SMTP mail. +However, not everybody is sufficiently familiar with the SMTP protocol to +be able to make full use of -bh, and sometimes you just want to answer the +question "Does this address have access?" without bothering with any +further details. + +The +.B exim_checkaccess +utility is a 'packaged' version of +.I -bh. +It takes two arguments, an IP address and an email address: + + exim_checkaccess 10.9.8.7 A.User@a.domain.example + +The utility runs a call to +.B Exim +with the -bh option, to test whether the given email address would be +accepted in a RCPT command in a TCP/IP connection from the host with the +given IP address. +The output of the utility is either the word 'accepted', or the SMTP error +response, for example: + + Rejected: + 550 Relay not permitted + +When running this test, the utility uses "<>" as the envelope sender address +for the MAIL command, but you can change this by providing additional options. +These are passed directly to the Exim command. +For example, to specify that the test is to be run with the sender address +"himself@there.example" you can use: + + exim_checkaccess 10.9.8.7 A.User@a.domain.example \ + -f himself@there.example + +Note that these additional Exim command line items must be given after the +two mandatory arguments. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exim_convert4r4.8 b/debian/manpages/exim_convert4r4.8 new file mode 100644 index 0000000..e9029e1 --- /dev/null +++ b/debian/manpages/exim_convert4r4.8 @@ -0,0 +1,65 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIM_CONVERT4R4 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exim_convert4r4 \- Convert Exim configuration from v3 to v4 format +.SH SYNOPSIS +.B exim_convert4r4 + +.SH DESCRIPTION +This script is provided to assist in updating Exim configuration files. +It reads an Exim 3 configuration file on the standard input, and writes a +modified file on the standard output. +It also writes comments about what it has done to the standard error file. +It assumes that the input is a valid Exim 3 configuration file. +A typical call to the conversion script might be + +.I exim_convert4r4 < /etc/exim/exim.conf > /etc/exim4/exim4.conf.new + +The output file +.B MUST +be checked and tested before trying to use it on a live system. +The conversion script is just an aid which does a lot of the "grunt work". +It does not guarantee to produce an Exim 4 configuration that behaves +exactly the same as the Exim 3 configuration it reads. + +Each option change in the new file is preceded by an identifying comment. +In fact, the conversion script tends to make quite a mess of your +configuration, and you should expect to go through it afterwards and tidy +it up by hand. + +Unless you are running a very straightforward configuration, the automatic +conversion is likely to generate a non-optimal configuration. +You should not only check it thoroughly, but also run as many tests as you +can, to ensure that it is working as you expect. +In particular, you should test address routing, using -bt and -bv, and the +policy controls, using -bh. +If possible, you should also do some live tests (i.e. send and receive +some messages) before putting Exim 4 into service. + +If you have a very complicated configuration, it is possible that +exim_convert4r4 will break it in some situations, which is why thorough +testing is strongly recommended. + +.SH SEE ALSO +.BR exim (8), +the files in /usr/share/doc/exim4-base/, especially Exim4.upgrade.gz + +.SH AUTHOR +This manual page was stitched together from Exim4.upgrade by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exim_db.8 b/debian/manpages/exim_db.8 new file mode 100644 index 0000000..1c823fd --- /dev/null +++ b/debian/manpages/exim_db.8 @@ -0,0 +1,162 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIM_DB 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exim_db \- Manage Exim's hint databases (exim_dumpdb, exim_fixdb, exim_tidydb) +.SH SYNOPSIS +.B exim_dumpdb +.I " spooldir" " database" +.br +.B exim_fixdb +.I " spooldir" " database" +.br +.B exim_tidydb +.I [-f] [-t time] " spooldir" " database" + +.SH DESCRIPTION +Three utility programs are provided for maintaining the DBM files that +Exim uses to contain its delivery hint information. +Each program requires two arguments. +The first specifies the name of Exim's spool directory, and the second is +the name of the database it is to operate on. +These are as follows: +.TP +.B retry +the database of retry information +.TP +.B wait-<transport name> +databases of information about messages waiting for remote hosts +.TP +.B misc +other hints data (for example, for serializing ETRN runs) + +The entire contents of a database are written to the standard output by the +.B exim_dumpdb +program, which has no options or arguments other than the spool +and database names. +For example, to dump the retry database: + +.I exim_dumpdb /var/spool/exim retry + +Two lines of output are produced for each entry: +.nf + T:mail.ref.example:192.168.242.242 146 77 Connection refused + 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 * + +.fi +The first item on the first line is the key of the record. +It starts with one of the letters R, or T, depending on whether it refers +to a routing or transport retry. +For a local delivery, the next part is the local address; for a remote +delivery it is the name of the remote host, followed by its failing IP +address (unless "no_retry_include_ip_address" is set on the smtp +transport). +Then there follows an error code, an additional error code, and a +textual description of the error. + +The three times on the second line are the time of first failure, the time of +the last delivery attempt, and the computed time for the next attempt. +The line ends with an asterisk if the cutoff time for the last retry rule +has been exceeded. + +Each output line from +.B exim_dumpdb +for the +.I wait-"xxx +databases consists of a host name followed by a list of ids for messages +that are or were waiting to be delivered to that host. +If there are a very large number for any one host, continuation records, +with a sequence number added to the host name, may be seen. +The data in these records is often out of date, because a message may be +routed to several alternative hosts, and Exim makes no effort to keep +crossreferences. + +The +.B exim_tidydb +utility program is used to tidy up the contents of the hints databases. +If run with no options, it removes all records from a database that are +more than 30 days old. +The cutoff date can be altered by means of the -t option, which must be +followed by a time. +For example, to remove all records older than a week from the retry +database: + +.I exim_tidydb -t 7d /var/spool/exim retry + +Both the +.I wait-xxx +and +.I retry +databases contain items that involve message ids. +In the former these appear as data in records keyed by host - they were +messages that were waiting for that host - and in the latter they are the +keys for retry information for messages that have suffered certain types +of error. +When "exim_tidydb" is run, a check is made to ensure that message ids in +database records are those of messages that are still on the queue. +Message ids for messages that no longer exist are removed from "wait-"xxx +records, and if this leaves any records empty, they are deleted. +For the "retry" database, records whose keys are non-existent message +ids are removed. +The +.B exim_tidydb +utility outputs comments on the standard output whenever it removes +information from the database. + +Removing records from a DBM file does not normally make the file smaller, but +all the common DBM libraries are able to re-use the space that is released. +It is therefore suggested that +.B exim_tidydb +be run periodically on all the hints databases, but at a quiet time of day, +because it requires a database to be locked (and therefore inaccessible to +Exim) while it does its work. + +The +.B exim_fixdb +program is a utility for interactively modifying databases. +Its main use is for testing Exim, but it might also be occasionally useful +for getting round problems in a live system. +It has no options, and its interface is somewhat crude. +On entry, it prompts for input with a right angle-bracket. +A key of a database record can then be entered, and the data for that +record is displayed. + +If 'd' is typed at the next prompt, the entire record is deleted. +For all except the +.I retry +database, that is the only operation that can be carried out. +For the +.I retry +database, each field is output preceded by a number, and data for individual +fields can be changed by typing the field number followed by new data, for +example: + + > 4 951102:1000 + +resets the time of the next delivery attempt. +Time values are given as a sequence of digit pairs for year, month, day, +hour, and minute. +Colons can be used as optional separators. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exim_dbmbuild.8 b/debian/manpages/exim_dbmbuild.8 new file mode 100644 index 0000000..1e68493 --- /dev/null +++ b/debian/manpages/exim_dbmbuild.8 @@ -0,0 +1,98 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIM_DBMBUILD 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exim_dbmbuild \- Build a DBM file. +.SH SYNOPSIS +.B exim_dbmbuild +.I [-nolc] [-nozero] [-noduperr] [-nowarn] inputfile|- outputfile + +.SH DESCRIPTION +The +.B exim_dbmbuild +program reads an input file containing keys and data in +the format used by the +.I lsearch +lookup (see section 9.1). +It writes a DBM file using the lower-cased alias names as keys and the +remainder of the information as data. +The lower-casing can be prevented by calling the program with the +.I -nolc +option. + +A terminating zero is included as part of the key string. +This is expected by the dbm lookup type. +However, if the option +.I -nozero +is given, +.B exim_dbmbuild +creates files without terminating zeroes in either the key strings or the +data strings. +The +.I dbmnz +lookup type can be used with such files. + +The program requires two arguments: the name of the input file (which can +be a single hyphen to indicate the standard input), and the name of the +output file. +It creates the output under a temporary name, and then renames it if all +went well. +If the native DB interface is in use (USE_DB is set in a compile-time +configuration file - this is common in free versions of Unix) the two file +names must be different, because in this mode the Berkeley DB functions +create a single output file using exactly the name given. +For example, + + exim_dbmbuild /etc/aliases /etc/aliases.db + +reads the system alias file and creates a DBM version of it in +/etc/aliases.db. + +In systems that use the +.I ndbm +routines (mostly proprietary versions of Unix), two files are used, with the +suffixes .dir and .pag. +In this environment, the suffixes are added to the second argument of +.B exim_dbmbuild, +so it can be the same as the first. +This is also the case when the Berkeley functions are used in +compatibility mode (though this is not recommended), because in that case +it adds a .db suffix to the file name. + +If a duplicate key is encountered, the program outputs a warning, and when +it finishes, its return code is 1 rather than zero, unless the +.I -noduperr +option is used. +By default, only the first of a set of duplicates is used - this makes it +compatible with lsearch lookups. +There is an option +.I -lastdup +which causes it to use the data for the last duplicate instead. +There is also an option +.I -nowarn, +which stops it listing duplicate keys to "stderr". +For other errors, where it doesn't actually make a new file, the return +code is 2. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exim_lock.8 b/debian/manpages/exim_lock.8 new file mode 100644 index 0000000..0c49207 --- /dev/null +++ b/debian/manpages/exim_lock.8 @@ -0,0 +1,130 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIM_LOCK 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exim_lock \- Mailbox maintenance +.SH SYNOPSIS +.B exim_lock +.RI [ options ] mailbox-file + +.SH DESCRIPTION +The +.B exim_lock +utility locks a mailbox file using the same algorithm as Exim. +For a discussion of locking issues, see section 25.2. +.B "Exim_lock" +can be used to prevent any modification of a mailbox by Exim or a user +agent while investigating a problem. +The utility requires the name of the file as its first argument. +If the locking is successful, the second argument is run as a command +(using C's "system()" function); if there is no second argument, the value +of the SHELL environment variable is used; if this is unset or empty, +/bin/sh is run. +When the command finishes, the mailbox is unlocked and the utility ends. +The following options are available: +.TP +.I -fcntl +Use "fcntl()" locking on the open mailbox. +.TP +.I -interval +This must be followed by a number, which is a number of seconds; it +sets the interval to sleep between retries (default 3). +.TP +.I -lockfile +Create a lock file before opening the mailbox. +.TP +.I -mbx +Lock the mailbox using MBX rules. +.TP +.I -q +Suppress verification output. +.TP +.I -retries +This must be followed by a number; it sets the number of times to try +to get the lock (default 10). +.TP +.I -timeout +This must be followed by a number, which is a number of seconds; it +sets a timeout to be used with a blocking "fcntl()" lock. +If it is not set (the default), a non-blocking call is used. +.TP +.I -v +Generate verbose output. + +If none of +.I -fcntl, -lockfile +or +.I -mbx +are given, the default is to create a lock file and also use "fcntl()" locking +on the mailbox, which is the same as +.B Exim's +default. +The use of +.I -fcntl +requires that the file be writeable; the use +of +.I -lockfile +requires that the directory containing the file be writeable. +Locking by lock file does not last for ever; Exim assumes that a lock file +is expired if it is more than 30 minutes old. + +The +.I -mbx +option is mutually exclusive with +.I -fcntl. +It causes a shared lock to be taken out on the open mailbox, and an +exclusive lock on the file /tmp/.n.m where n and m are the device number +and inode number of the mailbox file. +When the locking is released, if an exclusive lock can be obtained for the +mailbox, the file in /tmp is deleted. + +The default output contains verification of the locking that takes place. +The +.I -v +option causes some additional information to be given. +The +.I -q +option suppresses all output except error messages. +.PP +A command such as + + exim_lock /var/spool/mail/spqr + +runs an interactive shell while the file is locked, whereas + + exim_lock -q /var/spool/mail/spqr <<End + <some commands> + End + +runs a specific non-interactive sequence of commands while the file is +locked, suppressing all verification output. +A single command can be run by a command such as + + exim_lock -q /var/spool/mail/spqr \ + "cp /var/spool/mail/spqr /some/where" + +Note that if a command is supplied, it must be entirely contained within +the second argument - hence the quotes. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/eximon.8 b/debian/manpages/eximon.8 new file mode 100644 index 0000000..897cbe7 --- /dev/null +++ b/debian/manpages/eximon.8 @@ -0,0 +1,43 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIMON 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +eximon \- Monitor Exim +.SH SYNOPSIS +.B eximon + +.SH DESCRIPTION +The Exim monitor is an application which displays in an X window information +about the state of +.B Exim's +queue and what +.B Exim is doing. +An admin user can perform certain operations on messages from this GUI +interface; however all such facilities are also available from the command +line, and indeed, the monitor itself makes use of the command line to +perform any actions requested. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ +Eximon is documented extensivly in +.B specification of the exim mail transfer agent. + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exinext.8 b/debian/manpages/exinext.8 new file mode 100644 index 0000000..d6d6613 --- /dev/null +++ b/debian/manpages/exinext.8 @@ -0,0 +1,66 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXINEXT 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +eximnext \- Finding individual retry times +.SH SYNOPSIS +.B eximnext +.I address|message-id + +.SH DESCRIPTION +A utility called +.B exinext +(mostly a Perl script) provides the ability to fish specific information +out of the retry database. +Given a mail domain (or a complete address), it looks up the hosts for +that domain, and outputs any retry information for the hosts or for the +domain. +At present, the retry information is obtained by running +.B exim_dumpdb +(see below) and postprocessing the output. +For example: + + exinext piglet@milne.fict.example + kanga.milne.fict.example:192.168.8.1 error 146: Connection refused + first failed: 21-Feb-1996 14:57:34 + last tried: 21-Feb-1996 14:57:34 + next try at: 21-Feb-1996 15:02:34 + roo.milne.fict.example:192.168.8.3 error 146: Connection refused + first failed: 20-Jan-1996 13:12:08 + last tried: 21-Feb-1996 11:42:03 + next try at: 21-Feb-1996 19:42:03 + past final cutoff time + +You can also give +.B exinext +a local part, without a domain, and it will give any retry information for +that local part in your default domain. +A message id can be used to obtain retry information pertaining to a +specific message. +This exists only when an attempt to deliver a message to a remote host +suffers a message-specific error (see section 42.2). +.B exinext +is not particularly efficient, but then it isn't expected to be run very often. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exiqgrep.8 b/debian/manpages/exiqgrep.8 new file mode 100644 index 0000000..e0220b9 --- /dev/null +++ b/debian/manpages/exiqgrep.8 @@ -0,0 +1,81 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIQGREP 8 "February 14, 2003" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exiqgrep \- Search in the exim queue +.SH SYNOPSIS +.B exiqgrep +.I [-a] [-c] + +.SH DESCRIPTION +The +.B exiqgrep +utility is a Perl script which offers possibilities to grep in the +exim queue output. Unlike exiqsumm, it invokes exim -bpu itself and +does not need to be invoked in a pipe. + +.SH OPTIONS +.TP 10 +\fB-h\fR +Print help +.TP +\fB-f <regexp>\fR +Match sender address (field is "< >" wrapped) +.TP +\fB-r <regexp>\fR +Match recipient address +.TP +\fB-s <regexp>\fR +Match against the site field from long output +.TP +\fB-y <seconds>\fR +Message younger than +.TP +\fB-o <seconds>\fR +Message older than +.TP +\fB-z\fR +Frozen messages only (exclude non-frozen) +.TP +\fB-x\fR +Non-frozen messages only (exclude frozen) +.TP +\fB-c\fR +Display match count +.TP +\fB-l\fR +Long Format [Default] +.TP +\fB-i\fR +Message IDs only +.TP +\fB-b\fR +Brief Format +.TP +\fB-R\fR +Reverse order + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from the source code by Marc +Haber <mh+debian-packages@zugschlus.de>, using the exiqsumm man page by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). + diff --git a/debian/manpages/exiqsumm.8 b/debian/manpages/exiqsumm.8 new file mode 100644 index 0000000..ec1c3ce --- /dev/null +++ b/debian/manpages/exiqsumm.8 @@ -0,0 +1,67 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIQSUMM 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +exiqsumm \- Summarising the queue +.SH SYNOPSIS +.B exiqsumm +.I [-a] [-c] + +.SH DESCRIPTION +The +.B exiqsumm +utility is a Perl script which reads the output of +.I exim -bp +and produces a summary of the messages on the queue. +Thus, you use it by running a command such as + + exim -bp | exiqsumm + +The output consists of one line for each domain that has messages waiting +for it, as in the following example: + + 3 2322 74m 66m msn.com.example + +This lists the number of messages for the domain, their total volume, and +the length of time that the oldest and the newest messages have been +waiting. +By default the output is sorted on the domain name, but +.B exiqsumm +has the options +.I -a +and +.I -c, +which cause the output to be sorted by oldest message and by count of +messages, respectively. + +The output of +.I exim -bp +contains the original addresses in the message, so this also applies to +the output from +.B exiqsumm. +No domains from addresses generated by aliasing or forwarding are included +(unless the "one_time" option of the redirect router has been used to +convert them into 'top level' addresses). + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/exiwhat.8 b/debian/manpages/exiwhat.8 new file mode 100644 index 0000000..50000ab --- /dev/null +++ b/debian/manpages/exiwhat.8 @@ -0,0 +1,95 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH EXIWHAT 8 "December 4, 2002" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +eximwhat \- Finding out what Exim processes are doing +.SH SYNOPSIS +.B eximwhat + +.SH DESCRIPTION +On operating systems that can restart a system call after receiving a +signal (most modern OS), an +.B Exim +process responds to the SIGUSR1 signal by writing a line describing what +it is doing to the file exim-process.info in the Exim spool directory. +The +.B exiwhat +script sends the signal to all +.B Exim +processes it can find, having first emptied the file. +It then waits for one second to allow the +.B Exim +processes to react before displaying the results. +In order to run +.B exiwhat +successfully you have to have sufficient privilege to send the signal to +the +.B Exim +processes, so it is normally run as root. + +Unfortunately, the +.B ps +command which +.B exiwhat +uses to find +.B Exim +processes varies in different operating systems. +Not only are different options used, but the format of the output is +different. +For this reason, there are some system configuration options that configure +exactly how +.B exiwhat +works. +If it doesn't seem to be working for you, check the following compile-time +options: +.TP +.I EXIWHAT_PS_CMD +the command for running "ps" +.TP +.I EXIWHAT_PS_ARG +the argument for "ps" +.TP +.I EXIWHAT_EGREP_ARG +the argument for "egrep" to select from "ps" output +.TP +.I EXIWHAT_KILL_ARG +the argument for the "kill" command +.PP +An example of typical output from +.B exiwhat +is + +.nf + 164 daemon: -q1h, listening on port 25 +10483 running queue: waiting for 0tAycK-0002ij-00 (10492) +10492 delivering 0tAycK-0002ij-00 to mail.ref.example [10.19.42.42] + (editor@ref.example) +10592 handling incoming call from [192.168.243.242] +10628 accepting a local non-SMTP message +.fi + +The first number in the output line is the process number. +The third line has been split here, in order to fit it on the page. + +.SH SEE ALSO +.BR exim (8), +/usr/share/doc/exim4-base/ + +.SH AUTHOR +This manual page was stitched together from spec.txt by +Andreas Metzler <ametzler at downhill.at.eu.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/debian/manpages/update-exim4.conf.8 b/debian/manpages/update-exim4.conf.8 new file mode 100644 index 0000000..589bc1b --- /dev/null +++ b/debian/manpages/update-exim4.conf.8 @@ -0,0 +1,134 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH UPDATE-EXIM4.CONF 8 "February 28, 2003" EXIM4 +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +update-exim4.conf \- Generate exim4 configuration files. +.SH SYNOPSIS +.B update-exim4.conf [-v|--verbose] [-h|--help] [--keepcomments] [--removecomments] [-o|--output file] + +.SH OPTIONS +.TP +.I -v|--verbose +Enable verbose mode, tell about ignored, user modified files +.TP +.I -h|--help +Show short help message and exit +.TP +.I --keepcomments +Do not remove comment lines from the output file. +.TP +.I --removecomments +Remove comment lines from the output file. [Default] +.TP +.I -o|--output file +Write output to file instead of /var/lib/exim4/config.autogenerated. Be careful, +.B update-exim4.conf +nevertheless changes files in /etc/exim4/conf.d! + +.SH DESCRIPTION +The script +.B update-exim4.conf +generates the main configuration files +.I /var/lib/exim4/config.autogenerated +for +.B Exim v4 +by merging the data in the template files in the +.I /etc/exim4/conf.d +directory tree and +.I /etc/exim4/update-exim4.conf.conf +to the output file +.I /var/lib/exim4/config.autogenerated. +Additionally the files +.I /var/lib/exim4/masquerade +and +.I /var/lib/exim4/email_addresses +which contain rewriting rules for evaluation of /etc/email-addresses and +for masquerading satellite-systems are managed by this script. +.PP +.B update-exim4.conf +sorts the files in the subdirectories main, acl, router, transport, retry, +rewrite and auth of /etc/exim4/conf.d in the lexical sort order, concatenates +them and replaces the patterns DEBCONFsomethingDEBCONF. +It does not change the other contents of these files. +This makes it very simple to make small changes to the configuration and +still have the benefits of debconf. + +On the other hand if you don't want to manage exim4.conf with debconf +set +.I dc_eximconfig_configtype=none +in /etc/exim4/update-exim4.conf.conf and place your own handcrafted version +in /etc/exim4/exim4.conf. +- Exim will use this file if it exists and ignore the autogenerated one. + +.B update-exim4.conf +exits silently and does nothing if /etc/exim4/exim4.conf exists. + +.B update-exim4.conf +ignores all files in the conf.d directory that have a filename which +does not consist only of letters, numbers, underscores and hyphens +([:alnum:]_-), similar to +.B run-parts(8). +For easy interaction with packages extending Exim additionally +/etc/exim4/conf.d/foo/bar is ignored if +/etc/exim4/conf.d/foo/bar.disabled exists! + +If +.B update-exim4.conf +is called without the option -o it checks the validity of the +freshly generated configurationfile and exits with an error instead +of installing the file to /var/lib/exim4/config.autogenerated. + +.SH EXAMPLES +You want to be able to check exim's queue as normal user: Generate a new +file, e.g. /etc/exim4/conf.d/main/40_local_mailq, containing only the line +.I queue_list_requires_admin = false + +.SH NOTES +.B update-exim4.conf +changes the file permissions of the output file to the value of the environment +variable CFILEMODE, if CFILEMODE is set neither in /etc/default/exim4 nor in +the environment it defaults to 0644. Change this to 0640 if you're keeping +sensible information (LDAP credentials et. al.) in there. + +.SH FILES +At startup /etc/default/exim4 is sourced to get the value of CFILEMODE. +.B update-exim4.conf +manages these files: +.TP +.I /var/lib/exim4/config.autogenerated +Exim's main configuration file +.TP +.I /etc/exim4/conf.d/rewrite/30_exim4-base_email-addresses +rewriting rules for evaluation of /etc/exim4/email-addresses +.TP +.I /etc/exim4/conf.d/rewrite/35_exim4-base_masquerade +rewriting rules targeted for satellite system. +.PP +The files in /etc/ are checked for user modifications and are not updated any +more by update-exim4.conf if the local adminstator has edited them. If you +want to put such a file under update-exim4.conf's control again run +.B md5sum filename +and note its output. Edit the file and add a line at the top of the file +consisting only of a hash-mark (#), followed by a single space-character and +the output of the md5sum command. For example +# d41d8cd98f00b204e9800998ecf8427e + +.SH SEE ALSO +.BR exim (8) + +.SH AUTHOR +Andreas Metzler <ametzler at downhill.at.eu.org> diff --git a/debian/manpages/update-exim4defaults.8 b/debian/manpages/update-exim4defaults.8 new file mode 100644 index 0000000..2d30ad2 --- /dev/null +++ b/debian/manpages/update-exim4defaults.8 @@ -0,0 +1,157 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH UPDATE-EXIM4DEFAULTS 8 "January 17, 2003" EXIM4 +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +update-exim4defaults \- Manage exim4 daemon default file. +.SH SYNOPSIS +.B update-exim4defaults +.I [ --qflags flags ] +.I [ --queuerunner combined|separate|no ] +.I [ --queuetime time ] +.I [ --commonoptions options ] +.I [ --queuerunneroptions options ] +.I [ --smtplisteneroptions options ] +.I [ --remove-common options ] +.I [ --remove-queue options ] +.I [ --remove-smtp options ] +.I [ --force|-f ] +.I [ --help|-h ] +.I [ --init ] + +.SH DESCRIPTION +.B update-exim4defaults +allows to set run parameters for the +.B Exim +daemon in +.I /etc/default/exim4. +Its main purpose is for interaction with packages enhancing +.B Exim +like virus-scanners that need to change the way the exim daemon is started. +.PP + +.SH OPTIONS +.TP +.I --help|-h +Print short usage instructions and exit. +.TP +.I --qflags flags +Set qflags, special flags given to exim directly after the "-q". See +.B exim(8) +for more information. +.TP +.I --queuerunner combined|separate|no +Should the init script start one daemon that listens on the smtp port for +incoming connections and runs the queue at regular intervals +.I (combined) +, or should it start two separate daemons, one listening on the smtp port, +the other running the queue +.I (separate) +, or shouldn't we run the queue at all, for example if you'd rather do this +with +.B cron? +.TP +.I --queuetime time +In which intervals should we run the queue? This passed as option +.I -q<qflags>time +to Exim, e.g. -q30m or -qq1h. +.TP +.I --commonoptions options +Options passed both to queue-running and listening instances of Exim. +.TP +.I --queuerunneroptions options +Options only passed to the instance of Exim running the queue. +.TP +.I --smtplisteneroptions options +Options only passed to the instance of Exim listening on the SMTP port. +.TP +.I --force|-f +Without this option +.B update-exim4defaults +exits with an error if at least one of the options --queuetime, +--commonoptions, --queuerunneroptions or --smtplisteneroptions is used and the +corresponding value in /etc/default/exim4 is +.I already +set to a nonempty value. +.TP +.I --remove-common option +Try to remove the given option from COMMONOPTIONS. +.TP +.I --remove-queue option +Try to remove the given option from QUEUERUNNEROPTIONS. +.TP +.I --remove-smtp option +Try to remove the given option from SMTPLISTENEROPTIONS. +.PP +The --remove-commands cannot be used at the same time as any of --commonoptions, +--queuerunneroptions or --smtplisteneroptions. The --remove-commands will +additionally remove whitespace at the begining and the end of the option and +exchange multiple spaces wi a single one. +.TP +.I --init +create a default /etc/default/exim4 file and exit immediately. Unless +.I ---force +was also specified +.B update-exim4defaults +exits (successfully) without doing anything if /etc/default/exim4 already +exists. All other options are ignored. + +.SH EXIT STATUS +.TP +.I 0 +change was successfull or nothing needed to be done. +.TP +.I 1 +generic error: wrong options, unreadable configuration file, etc. +.TP +.I 2 +QUEUEINTERVAL was already set. +.TP +.I 4 +COMMONOPTIONS was already set. +.TP +.I 8 +QUEUERUNNEROPTIONS was already set. +.TP +.I 16 +SMTPLISTENEROPTIONS was already set. +.TP +.I 32 +QFLAGS was already set. +.TP +.I 64 +--remove-something failed, i.e. the value of the option was not changed. +.PP +Exit codes 2 to 32 will be summed up, if more than one unsuccesful option was +given. + +.SH FILES +.TP +.I /etc/default/exim4 +The configuration file. +.TP +.I /etc/init.d/exim4 +The Exim init-script. +.TP +.I /etc/ppp/ip-up.d/exim4 +The queuerunner in this file also uses COMMONOPTIONS and QUEUERUNNEROPTIONS and +does not run if QUEUERUNNER=no. + +.SH SEE ALSO +.BR exim (8) + +.SH AUTHOR +Andreas Metzler <ametzler at downhill.at.eu.org> |