diff options
Diffstat (limited to 'debian/manpages/update-exim4.conf.8')
-rw-r--r-- | debian/manpages/update-exim4.conf.8 | 134 |
1 files changed, 134 insertions, 0 deletions
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> |