~ubuntu-branches/debian/lenny/exim4/lenny

« back to all changes in this revision

Viewing changes to debian/manpages/update-exim4.conf.8

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Metzler, update-exim4.conf
  • Date: 2008-09-30 20:12:27 UTC
  • mfrom: (2.1.21 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080930201227-2cwrlnv0sa0b4qt3
Tags: 4.69-9
[update-exim4.conf]: Use POSIX character classes [:alnum:] or explicit
listing ("ABCDEF..") instead of a-z, since the latter does not work as
expected in some locales. Closes: #500691

Show diffs side-by-side

added added

removed removed

Lines of Context:
77
77
In either case, before outputting the result
78
78
to /var/lib/exim4/config.autogenerated, 
79
79
.B update\-exim4.conf
80
 
replaces the
81
 
patterns DEBCONFsomethingDEBCONF with the contents of dc_something
82
 
from /etc/exim4/update\-exim4.conf.conf. It makes no other changes.
 
80
generates a number of exim configuration macros from the contents of
 
81
dc_something from /etc/exim4/update\-exim4.conf.conf and inserts them
 
82
into the configuration right after the definition of the exim
 
83
configuration macro UPEX4CmacrosUPEX4C (which is only used as
 
84
placeholder for this case). The macro definitions are bracketed
 
85
with .ifdef clauses to allow the local admin to override the values with
 
86
earlier definitions.
 
87
.B update\-exim4.conf
 
88
makes no other changes to the configuration.
83
89
This makes it very simple to make small changes to the configuration and
84
90
still have the benefits of debconf.
85
91
 
133
139
Change this to 0640 if you are keeping sensitive information (LDAP credentials
134
140
et. al.) in there.
135
141
 
136
 
.SH REPLACEMENT PATTERNS
137
 
.B update\-exim4.conf
138
 
know about these identifiers:
139
 
.TP
140
 
.I DEBCONFconfigtypeDEBCONF
141
 
dc_eximconfig_configtype in /etc/exim4/update\-exim4.conf.conf.
142
 
.TP
143
 
.I DEBCONFheaders_rewriteDEBCONF
144
 
If the system is configured to hide the system mail name, this is
145
 
replaced with a headers_rewrite directive rewriting sender addresses
146
 
from local domains to the visible mail name for use on the transport
147
 
that sends outgoing mail to the smarthost.
148
 
.TP
149
 
.I DEBCONFlistenonpublicDEBCONF
150
 
This is replaced with
151
 
\(lqlocal_interfaces = <value of dc_local_interfaces>\(rq if
152
 
dc_local_interfaces is set to a non-empty value. Otherwise, it is
153
 
replaced with an empty string, causing the exim SMTP listener daemon
154
 
to listen on all local interfaces.
155
 
 
156
 
If dc_local_interfaces is set to a non-empty value, this will cause
157
 
the exim SMTP listener daemon to listen only on the IP addresses
158
 
listed in the option.
159
 
.TP
160
 
.I DEBCONFlocaldeliveryDEBCONF
161
 
is replaced by the contents of dc_localdelivery in
162
 
/etc/exim4/update\-exim4.conf.conf. It should be set to the default
163
 
transport for local delivery, i.e. usually mail_spool or maildir_home. It
164
 
defaults to mail_spool if dc_localdelivery is unset.
165
 
.TP
166
 
.I DEBCONFlocal_domainsDEBCONF
167
 
is internally generated from the contents of dc_other_hostnames in
168
 
/etc/exim4/update\-exim4.conf.conf and localhost.
169
 
.TP
170
 
.I DEBCONFminimaldnsDEBCONF
171
 
is replaced  with \(lqDC_minimaldns = 1\(rq if dc_minimaldns is set to true
172
 
and to an empty string otherwise.
173
 
.TP
174
 
.I DEBCONFnever_usersDEBCONF
175
 
is deleted. (In versions prior 4.30-7 it was used to set the never_users
176
 
option.)
177
 
.TP
178
 
.I DEBCONFpackageversionDEBCONF
179
 
contains the complete Debian version-number of the exim4\-config
180
 
package. You could use this in smtp_banner or received_header_text.
181
 
.TP
182
 
.I DEBCONFreadhostDEBCONF
183
 
corresponds to dc_readhost in /etc/exim4/update\-exim4.conf.conf and holds
184
 
the visible mailname for satellite\-systems.
185
 
.TP
186
 
.I DEBCONFrelay_domainsDEBCONF
187
 
is replaced by the contents of dc_relay_domains in
188
 
/etc/exim4/update\-exim4.conf.conf
189
 
.TP
190
 
.I DEBCONFrelay_netsDEBCONF
191
 
is replaced by the contents of dc_relay_nets in
192
 
/etc/exim4/update\-exim4.conf.conf
193
 
.TP
194
 
.I DEBCONFreturn_pathDEBCONF
195
 
If the system is configured to hide the system mail name, this is
196
 
replaced with a return_path directive setting the return path domain
197
 
name to the visible mail name for use on the transport that sends
198
 
outgoing mail to the smarthost.
199
 
.TP
200
 
.I DEBCONFrewriteemailaddresses_mailnameDEBCONF
201
 
is replaced with this rewriting rule:
202
 
.br
203
 
*@\fImailname\fR ${lookup {${local_part}} lsearch {/etc/email-addresses} {$value} fail } Ffrs
204
 
.br
205
 
with \fImailname\fR being replaced by the contents of /etc/mailname.
206
 
.TP
207
 
.I DEBCONFsmarthostDEBCONF
208
 
corresponds to dc_smarthost in /etc/exim4/update\-exim4.conf.conf and
209
 
contains the name (and Port) of the SMTP smarthost that takes care of
210
 
outgoing mail.
211
 
.TP
212
 
.I DEBCONFvisiblenameDEBCONF
213
 
holds the contents of (the first line of) /etc/mailname
214
 
.TP
215
 
.I DEBCONF_hardcode_primary_hostname_DEBCONF
216
 
If dc_minimaldns is set to true
217
 
.B update\-exim4.conf
218
 
tries to guess the primary hostname using hostname \-\-fqdn and replaces
219
 
this pattern with \(lqprimary_hostname = <guessed value>\(rq.
220
 
 
221
142
.SH CONFIGURATION VARIABLES
 
143
All lists given in configuration variables are semicolon-separated. In
 
144
the past, they used to be colon separated. This was changed to
 
145
semicolon separation to make specification of IPv6 addresses easier.
 
146
Backwards compatibility is preserved, so that old configurations using
 
147
colons as separators do still work. Colons are deprecated and might
 
148
stop working in a later release. If you need to specifiy a single IPv6
 
149
address in a field that are defined as a list of host names or IP
 
150
addresses, please prefix "<;" to explicitly specify the list separator
 
151
as a semicolon. Otherwise, the code cannot tell an IP address from a
 
152
colon-separated list of strange host names.
 
153
 
 
154
Using lookups like "dsearch;something" in update-exim4.conf.conf has
 
155
never been supported and does no longer work! If you need this, please
 
156
convert to directly setting the appropriate macros.
 
157
 
222
158
.B update\-exim4.conf
223
159
evaluates these patterns in
224
160
.B /etc/exim4/update\-exim4.conf.conf:
229
165
.I dc_eximconfig_configtype
230
166
The main configuration type. One of \(lqinternet\(rq, \(lqsmarthost\(rq,
231
167
\(lqsatellite\(rq, \(lqlocal\(rq, \(lqexim3manual\(rq or \(lqnone\(rq.
 
168
Sets macro DC_eximconfig_configtype.
232
169
.TP
233
170
.I dc_hide_mailname
234
171
Boolean option that controls whether the local mailname in the headers of
235
172
outgoing mail should be hidden. (Only effective for \(lqsmarthost\(rq and
236
 
\(lqsatellite\(rq.
 
173
\(lqsatellite\(rq. Sets macro HIDE_MAILNAME.
237
174
.TP
238
175
.I dc_mailname_in_oh
239
176
Internal use only Boolean option that is set by the maintainer scripts
240
177
after adding the contents of /etc/mailname to the dc_other_hostnames
241
178
list. This is a transition helper since it wouldn't otherwise be
242
179
possible to see whether that domain name has been removed from
243
 
dc_other_hostnames on purpose.
 
180
dc_other_hostnames on purpose. This is not used by update-exim4.conf,
 
181
and no macro is set.
244
182
.TP
245
183
.I ue4c_keepcomments
246
184
Boolean option that controls whether
247
185
.B update\-exim4.conf
248
186
strips the comments from the target configuration file (default) or
249
187
leaves them in. This can be overridden by the command line options
250
 
--keepcomments and --removecomments.
 
188
--keepcomments and --removecomments. The value is not written to an
 
189
exim macro.
251
190
.TP
252
191
.I dc_localdelivery
253
192
name of the default transport for local mail delivery. Defaults to mail_spool
254
 
if unset, use maildir_home for delivery to ~/Maildir/. This setting
255
 
does not correspond to a Debconf question and needs to be set manually.
 
193
if unset, use maildir_home for delivery to ~/Maildir/. Sets macro
 
194
LOCAL_DELIVERY.
256
195
.TP
257
196
.I dc_local_interfaces
258
 
Used as the value for 
259
 
.B Exim's
260
 
main configuration option local_interfaces. If the string contains a
261
 
semicolon, the string \(lq<;\(rq is prepended to select the semicolon
262
 
as separator.
 
197
List of IP addresses the Exim daemon should listen on. If this is left
 
198
empty, Exim listens on all interfaces. Sets macro
 
199
MAIN_LOCAL_INTERFACES only if there is a non-empty value.
263
200
.TP
264
201
.I dc_minimaldns
265
202
Boolean option to activate some option to minimize DNS lookups, if set to
266
 
\(lqtrue\(rq a macro DC_minimaldns is defined.
 
203
\(lqtrue\(rq a macro DC_minimaldns is defined. If true, the macro
 
204
DC_minimaldns is set to 1, and the macro
 
205
MAIN_HARDCODE_PRIMARY_HOSTNAME is set to the appropriately
 
206
post-processes output of hostname --fqdn.
267
207
.TP
268
208
.I dc_other_hostnames
269
209
is used to build the local_domains list, together with \(lqlocalhost\(rq.
270
210
This is the list of domains for which this machine should
271
 
consider itself the final destination. 
 
211
consider itself the final destination. The local_domains list ends up
 
212
in the macro MAIN_LOCAL_DOMAINS.
272
213
.TP
273
214
.I dc_readhost
274
215
For \(lqsmarthost\(rq and \(lqsatellite\(rq it is possible to hide the local
275
216
mailname in the headers of outgoing mail and replace it with this value
276
 
instead, using rewriting.
 
217
instead, using rewriting. Sets macro DCreadhost.
277
218
.TP
278
219
.I dc_relay_domains
279
 
is used to populate relay_to_domains, a list of domains for
280
 
which we accept mail from anywhere on the Internet but which are not
281
 
delivered locally, e.g. because this machine serves as secondary MX for
282
 
these domains.
 
220
is a list of domains for which we accept mail from anywhere on the
 
221
Internet but which are not delivered locally, e.g. because this machine
 
222
serves as secondary MX for these domains. Sets MAIN_RELAY_DOMAINS.
283
223
.TP
284
224
.I dc_relay_nets
285
 
A list of machines for which we serve as smarthost. Used to
286
 
populate the relay_from_hosts list. Please note that 127.0.0.1 and ::1
287
 
are always permitted to relay since /usr/lib/sendmail is available anyway
288
 
and relay control doesn't make sense here.  If the string given here contains
289
 
a semicolon, the string \(lq<;\(rq is prepended to select the semicolon
290
 
as separator.
 
225
A list of machines for which we serve as smarthost. Please note that
 
226
127.0.0.1 and ::1 are always permitted to relay since /usr/lib/sendmail
 
227
is available anyway and relay control doesn't make sense here. Sets
 
228
macro MAIN_RELAY_NETS.
291
229
.TP
292
230
.I dc_smarthost
293
231
List of hosts to which all outgoing mail is passed to and that takes care
294
 
of delivering it. Multiple hosts are semicolon separated. Each of the
295
 
hosts is tried, in the order specified (See exim specification,
296
 
chapter 20.5). All deliveries go out to TCP port 25 unless a different
297
 
port is specified after the host name, separated from the host name by
298
 
two colons. Colons in IPv6 addresses need to be doubled. If a port
299
 
number follows, IP addresses may be enclosed in brackets, which might
300
 
be the only possibility to specify delivery to an  IPv6 address and a
301
 
different port. Examples:
 
232
of delivering it. Each of the hosts is tried, in the order specified
 
233
(See exim specification, chapter 20.5). All deliveries go out to TCP
 
234
port 25 unless a different port is specified after the host name,
 
235
separated from the host name by two colons. Colons in IPv6 addresses need
 
236
to be doubled. If a port number follows, IP addresses may be enclosed in
 
237
brackets, which might be the only possibility to specify delivery to an
 
238
IPv6 address and a different port. Examples:
302
239
.br
303
240
.BR host.domain.example
304
241
deliver to host looked up on DNS, tcp/25
327
264
Boolean option that controls whether
328
265
.B update\-exim4.conf
329
266
uses /etc/exim4/exim4.conf.template (\(lqfalse\(rq) or the multiple files
330
 
below /etc/exim4/conf.d (\(lqtrue\(rq) as input.
 
267
below /etc/exim4/conf.d (\(lqtrue\(rq) as input. This does not set any
 
268
macros.
 
269
.TP
 
270
.I The macro MAIN_PACKAGE_VERSION is set to Debian's Version number of
 
271
the package being installed for convenient inclusion in the
 
272
configuration.
331
273
 
332
274
.SH RECOMMENDED USAGE
333
275
If you are running exim as daemon (as it is in the default setup of the
352
294
Exim's main configuration file
353
295
.LP
354
296
.TP
 
297
.B /etc/exim4/exim4.conf
 
298
Optional manually managed Exim main configuration file. Takes precedence over
 
299
debconf managed one if it exists.
 
300
.LP
 
301
.TP
355
302
.B /etc/exim4/update-exim4.conf.conf
356
303
Configuration file being written by exim4-config maintainer scripts,
357
304
which may be hand-edited, and is read as input by update-exim4.conf.
365
312
 
366
313
.SH AUTHOR
367
314
Andreas Metzler <ametzler at downhill.at.eu.org>
 
315
.br
368
316
Marc Haber <mh+debian-packages@zugschlus.de>