source: server/mail/exim.xml@ 1258125

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 1258125 was 1258125, checked in by DJ Lucas <dj@…>, 8 years ago

[Systemd merge] - Section V

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17481 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 21.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!-- This URL frequently becomes broken. Please, do not "fix' it back,
8 unless you decided to take care of and monitor it.
9 <!ENTITY exim-download-http "http://ftp.exim.org/pub/exim/exim4/exim-&exim-version;.tar.bz2"> -->
10
11 <!ENTITY exim-download-http "http://mirrors-usa.go-parts.com/eximftp/exim/exim4/exim-&exim-version;.tar.bz2">
12 <!ENTITY exim-download-ftp "ftp://ftp.exim.org/pub/exim/exim4/exim-&exim-version;.tar.bz2">
13 <!-- if above don't work, please use one of the official mirrors at
14 http://www.exim.org/mirmon/ftp_mirrors.html -->
15 <!ENTITY exim-md5sum "2effc2bd47ad2dc010f655c11a1b1173">
16 <!ENTITY exim-size "1.7 MB">
17 <!ENTITY exim-buildsize "17 MB">
18 <!ENTITY exim-time "0.2 SBU">
19
20
21
22 <!ENTITY exim-daemon-version "&exim-version;-3">
23]>
24
25<sect1 id="exim" xreflabel="Exim-&exim-version;">
26 <?dbhtml filename="exim.html"?>
27
28 <sect1info>
29 <othername>$LastChangedBy$</othername>
30 <date>$Date$</date>
31 </sect1info>
32
33 <title>Exim-&exim-version;</title>
34
35 <indexterm zone="exim">
36 <primary sortas="a-Exim">Exim</primary>
37 </indexterm>
38
39 <sect2 role="package">
40 <title>Introduction to Exim</title>
41
42 <para>The <application>Exim</application> package contains a Mail
43 Transport Agent written by the University of Cambridge, released
44 under the GNU Public License.</para>
45
46 &lfs79_checked;
47
48 <bridgehead renderas="sect3">Package Information</bridgehead>
49 <itemizedlist spacing="compact">
50 <listitem>
51 <para>Download (HTTP): <ulink url="&exim-download-http;"/></para>
52 </listitem>
53 <listitem>
54 <para>Download (FTP): <ulink url="&exim-download-ftp;"/></para>
55 </listitem>
56 <listitem>
57 <para>Download MD5 sum: &exim-md5sum;</para>
58 </listitem>
59 <listitem>
60 <para>Download size: &exim-size;</para>
61 </listitem>
62 <listitem>
63 <para>Estimated disk space required: &exim-buildsize;</para>
64 </listitem>
65 <listitem>
66 <para>Estimated build time: &exim-time;</para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
71 <itemizedlist spacing="compact">
72 <listitem>
73 <para>Additional formats of the documentation (text-based docs are
74 shipped with the sources) can be downloaded by following the links
75 shown at <ulink url="http://exim.org/docs.html"/>.</para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">Exim Dependencies</bridgehead>
80
81 <bridgehead renderas="sect4">Required</bridgehead>
82 <para role="required">
83 <xref linkend="pcre"/>
84 </para>
85
86 <bridgehead renderas="sect4">Optional</bridgehead>
87 <para role="optional">
88 <xref linkend="db"/> or
89 <ulink url="http://sourceforge.net/projects/tdb">TDB</ulink>
90 (alternatives to GDBM, built in LFS),
91 <xref linkend="cyrus-sasl"/>,
92 <xref linkend="libidn"/>,
93 <xref linkend="linux-pam"/>,
94 <xref linkend="mariadb"/> or
95 <ulink url="http://www.mysql.com/">MySQL</ulink>,
96 <xref linkend="openldap"/>,
97 <xref linkend="openssl"/> or <xref linkend="gnutls"/>,
98 <xref linkend="postgresql"/>,
99 <xref linkend="sqlite"/>,
100 <xref linkend="x-window-system"/>, and
101 <ulink url="http://www.trusteddomain.org/opendmarc/">OpenDMARC</ulink>
102 </para>
103
104 <para condition="html" role="usernotes">User Notes:
105 <ulink url="&blfs-wiki;/exim"/></para>
106
107 </sect2>
108
109 <sect2 role="installation">
110 <title>Installation of Exim</title>
111
112 <para>Before building <application>Exim</application>, as the
113 <systemitem class="username">root</systemitem> user you should create
114 the group and user <systemitem class="username">exim</systemitem> which
115 will run the <command>exim</command> daemon:</para>
116
117<screen role="root"><userinput>groupadd -g 31 exim &amp;&amp;
118useradd -d /dev/null -c "Exim Daemon" -g exim -s /bin/false -u 31 exim</userinput></screen>
119
120 <para>Install <application>Exim</application> with the following
121 commands:</para>
122
123<screen><userinput>sed -e 's,^BIN_DIR.*$,BIN_DIRECTORY=/usr/sbin,' \
124 -e 's,^CONF.*$,CONFIGURE_FILE=/etc/exim.conf,' \
125 -e 's,^EXIM_USER.*$,EXIM_USER=exim,' \
126 -e 's,^EXIM_MONITOR,#EXIM_MONITOR,' src/EDITME > Local/Makefile &amp;&amp;
127printf "USE_GDBM = yes\nDBMLIB = -lgdbm\n" >> Local/Makefile &amp;&amp;
128make</userinput></screen>
129
130 <para>This package does not come with a test suite.</para>
131
132 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
133
134<!-- dev note: make INSTALL_ARG=-no_chown DESTDIR=<DESTDIR> install -->
135
136<screen role="root"><userinput>make install &amp;&amp;
137install -v -m644 doc/exim.8 /usr/share/man/man8 &amp;&amp;
138install -v -d -m755 /usr/share/doc/exim-&exim-version; &amp;&amp;
139install -v -m644 doc/* /usr/share/doc/exim-&exim-version; &amp;&amp;
140ln -sfv exim /usr/sbin/sendmail &amp;&amp;
141install -v -d -m750 -o exim -g exim /var/spool/exim</userinput></screen>
142
143 </sect2>
144
145 <sect2 role="commands">
146 <title>Command Explanations</title>
147
148 <para><command>sed -e ... > Local/Makefile</command>: Most of
149 <application>Exim</application>'s configuration options are compiled in using
150 the directives in <filename>Local/Makefile</filename> which is created from
151 the <filename>src/EDITME</filename> file. This command specifies the minimum
152 set of options. Descriptions for the options are listed below.</para>
153
154 <para><command>printf ... > Local/Makefile</command>: Setting those
155 variables allows to use GDBM instead of the default Berkeley DB. Remove
156 this command if you have installed <xref linkend="db"/>.</para>
157
158 <para><parameter>BIN_DIRECTORY=/usr/sbin</parameter>: This installs all of
159 <application>Exim</application>'s binaries and scripts in
160 <filename class='directory'>/usr/sbin</filename>.</para>
161
162 <para><parameter>CONFIGURE_FILE=/etc/exim.conf</parameter>: This installs
163 <application>Exim</application>'s main configuration file in
164 <filename class='directory'>/etc</filename>.</para>
165
166 <para><parameter>EXIM_USER=exim</parameter>: This tells
167 <application>Exim</application> that after the daemon no longer needs
168 <systemitem class="username">root</systemitem> privileges, the process
169 hands off the daemon to the <systemitem
170 class="username">exim</systemitem> user.</para>
171
172 <para><parameter>#EXIM_MONITOR</parameter>: This defers building the
173 <application>Exim</application> monitor program, as it requires
174 <application>X Window System</application> support, by commenting out the
175 <parameter>EXIM_MONITOR</parameter> line in the <filename>Makefile</filename>.
176 If you wish to build the monitor program, omit this <command>sed</command>
177 command and issue the following command before building the package (modify
178 <filename>Local/eximon.conf</filename>, if necessary):
179 <command>cp exim_monitor/EDITME Local/eximon.conf</command>.</para>
180
181 <para><command>ln -sfv exim /usr/sbin/sendmail</command>: Creates a link to
182 <command>sendmail</command> for applications which need it.
183 <application>Exim</application> will accept most
184 <application>Sendmail</application> command-line options.</para>
185
186 <para><command>install -v -m750 -o exim -g exim /var/spool/exim</command>:
187 Since /var/spool is owned by root and this version of <command>exim</command>
188 drops <systemitem class="username">root</systemitem> privileges early, to
189 run as user <systemitem class="username">exim</systemitem>, it cannot create
190 the <filename class="directory">/var/spool/exim</filename> directory. As a
191 work around, it is created manually.</para>
192
193 </sect2>
194
195 <sect2 role="commands">
196 <title>Adding Additional Functionality</title>
197
198 <para>To utilize some or all of the dependency packages, you'll need to
199 modify <filename>Local/Makefile</filename> to include the appropriate
200 directives and parameters to link additional libraries before you build
201 <application>Exim</application>. <filename>Local/Makefile</filename> is
202 heavily commented with instructions on how to do this. Listed below is
203 additional information to help you link these dependency packages or
204 add additional functionality.</para>
205
206 <para>If you wish to build and install the
207 <filename class='extension'>.info</filename> documentation, refer to <ulink
208 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECTinsinfdoc"/>.</para>
209
210 <para>If you wish to build in Exim's interfaces for calling virus and spam
211 scanning software directly from access control lists, uncomment the
212 <option>WITH_CONTENT_SCAN=yes</option> parameter and review the information
213 found at <ulink
214 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch41.html"/>.</para>
215
216 <para>To use a backend database other than <application>Berkeley
217 DB</application>, see the instructions at <ulink
218 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECTdb"/>.</para>
219
220 <para>For SSL functionality, see the instructions at <ulink
221 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECTinctlsssl"/>
222 and <ulink
223 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch39.html"/>.</para>
224
225 <para>For <application>tcpwrappers</application> functionality, see the
226 instructions at <ulink
227 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch04.html#SECID27"/>.</para>
228
229 <para>For information about adding authentication mechanisms to the
230 build, see chapters 33-37 of <ulink
231 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/index.html"/>.</para>
232
233 <para>For information about linking <application>Linux-PAM</application>,
234 refer to the instructions <ulink
235 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch11.html#SECTexpcond"/>.</para>
236
237 <para>For information about linking database engine libraries used for
238 <application>Exim</application> name lookups, see the instructions at <ulink
239 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch09.html"/>.</para>
240
241 <para>If you wish to add <application>Readline</application> support to
242 <application>Exim</application> when invoked in <quote>test expansion</quote>
243 (<option>-be</option>) mode, see the information in the <option>-be</option>
244 section of <ulink
245 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch05.html#id2525974"/>.</para>
246
247 <para>You may wish to modify the default configuration and send log files to
248 syslog instead of the default
249 <filename class='directory'>/var/spool/exim/log</filename> directory. See the
250 information at <ulink
251 url="http://exim.org/exim-html-&exim-version;/doc/html/spec_html/ch49.html"/>.</para>
252
253 </sect2>
254
255 <sect2 role="configuration">
256 <title>Configuring Exim</title>
257
258 <sect3 id="exim-config">
259 <title>Config Files</title>
260
261 <para><filename>/etc/exim.conf</filename> and
262 <filename>/etc/aliases</filename></para>
263
264 <indexterm zone="exim exim-config">
265 <primary sortas="e-etc-exim.conf">/etc/exim.conf</primary>
266 </indexterm>
267
268 <indexterm zone="exim exim-config">
269 <primary sortas="e-etc-aliases">/etc/aliases</primary>
270 </indexterm>
271
272 </sect3>
273
274 <sect3>
275 <title>Configuration Information</title>
276
277 <para>A default (nothing but comments) <filename>/etc/aliases</filename>
278 file is installed during the package installation if this file did not
279 exist on your system. Create the necessary aliases and start the
280 <application>Exim</application> daemon using the following commands:</para>
281
282<screen role="root"><userinput>cat &gt;&gt; /etc/aliases &lt;&lt; "EOF"
283<literal>postmaster: root
284MAILER-DAEMON: root</literal>
285EOF
286exim -v -bi &amp;&amp;
287/usr/sbin/exim -bd -q15m</userinput></screen>
288
289 <note>
290 <para>To protect an existing <filename>/etc/aliases</filename> file,
291 the command above appends these aliases to it. This file should be
292 checked and duplicate aliases removed, if present.</para>
293 </note>
294
295 <para>The <command>/usr/sbin/exim -bd -q15m</command> command starts
296 the <application>Exim</application> daemon with a 15 minute interval
297 in processing the mail queue. Adjust this parameter to suit your
298 desires.</para>
299
300 </sect3>
301
302 <sect3 id="exim-init">
303 <title><phrase revision="sysv">Boot Script</phrase>
304 <phrase revision="systemd">Systemd Unit</phrase></title>
305
306 <para>To automatically start <command>exim</command> at boot,
307 install the
308 <phrase revision="sysv"><filename>/etc/rc.d/init.d/exim</filename>
309 init script</phrase>
310 <phrase revision="systemd"><filename>exim.service</filename> unit</phrase>
311 included in the <xref linkend="bootscripts" revision="sysv"/>
312 <xref linkend="systemd-units" revision="systemd"/> package.</para>
313
314 <indexterm zone="exim exim-init">
315 <primary sortas="f-exim">exim</primary>
316 </indexterm>
317
318<screen role="root"><userinput>make install-exim</userinput></screen>
319
320 <para revision="sysv">The bootscript also starts the
321 <application>Exim</application> daemon and dispatches a queue runner
322 process every 15 minutes. Modify the
323 <option>-q<replaceable>&lt;time interval&gt;</replaceable></option>
324 parameter in <filename>/etc/rc.d/init.d/exim</filename>, if necessary
325 for your installation.</para>
326
327 </sect3>
328
329 </sect2>
330
331 <sect2 role="content">
332 <title>Contents</title>
333
334 <segmentedlist>
335 <segtitle>Installed Programs</segtitle>
336 <segtitle>Installed Libraries</segtitle>
337 <segtitle>Installed Directories</segtitle>
338
339 <seglistitem>
340 <seg>exicyclog, exigrep, exim, exim-&exim-daemon-version;, exim_checkaccess,
341 exim_dbmbuild, exim_dumpdb, exim_fixdb, exim_lock, exim_tidydb,
342 eximstats, exinext, exipick, exiqgrep, exiqsumm, exiwhat, and
343 optionally, eximon, eximon.bin, and sendmail (symlink)</seg>
344 <seg>None</seg>
345 <seg>/usr/share/doc/exim-&exim-version; and /var/spool/exim</seg>
346 </seglistitem>
347 </segmentedlist>
348
349 <variablelist>
350 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
351 <?dbfo list-presentation="list"?>
352 <?dbhtml list-presentation="table"?>
353
354 <varlistentry id="exicyclog">
355 <term><command>exicyclog</command></term>
356 <listitem>
357 <para>cycles <application>Exim</application> log files.</para>
358 <indexterm zone="exim exicyclog">
359 <primary sortas="b-exicyclog">exicyclog</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="exigrep">
365 <term><command>exigrep</command></term>
366 <listitem>
367 <para>searches <application>Exim</application> log files.</para>
368 <indexterm zone="exim exigrep">
369 <primary sortas="b-exigrep">exigrep</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="exim-prog">
375 <term><command>exim</command></term>
376 <listitem>
377 <para>is a symlink to the <command>exim-&exim-daemon-version;</command>
378 MTA daemon.</para>
379 <indexterm zone="exim exim-prog">
380 <primary sortas="b-exim">exim</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="exim-current_version">
386 <term><command>exim-&exim-daemon-version;</command></term>
387 <listitem>
388 <para>is the <application>Exim</application> mail transport
389 agent daemon.</para>
390 <indexterm zone="exim exim-current_version">
391 <primary sortas="b-exim-&exim-daemon-version;">exim-&exim-daemon-version;</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="exim_checkaccess">
397 <term><command>exim_checkaccess</command></term>
398 <listitem>
399 <para>states whether a given recipient address from a given host is
400 acceptable or not.</para>
401 <indexterm zone="exim exim_checkaccess">
402 <primary sortas="b-exim_checkaccess">exim_checkaccess</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="exim_dbmbuild">
408 <term><command>exim_dbmbuild</command></term>
409 <listitem>
410 <para> creates and rebuilds <application>Exim</application>
411 databases.</para>
412 <indexterm zone="exim exim_dbmbuild">
413 <primary sortas="b-exim_dbmbuild">exim_dbmbuild</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="exim_dumpdb">
419 <term><command>exim_dumpdb</command></term>
420 <listitem>
421 <para> writes the contents of <application>Exim</application>
422 databases to the standard output.</para>
423 <indexterm zone="exim exim_dumpdb">
424 <primary sortas="b-exim_dumpdb">exim_dumpdb</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 <varlistentry id="exim_fixdb">
430 <term><command>exim_fixdb</command></term>
431 <listitem>
432 <para>modifies data in <application>Exim</application>
433 databases.</para>
434 <indexterm zone="exim exim_fixdb">
435 <primary sortas="b-exim_fixdb">exim_fixdb</primary>
436 </indexterm>
437 </listitem>
438 </varlistentry>
439
440 <varlistentry id="exim_lock">
441 <term><command>exim_lock</command></term>
442 <listitem>
443 <para>locks a mailbox file.</para>
444 <indexterm zone="exim exim_lock">
445 <primary sortas="b-exim_lock">exim_lock</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="exim_tidydb">
451 <term><command>exim_tidydb</command></term>
452 <listitem>
453 <para>removes old records from <application>Exim</application>
454 databases.</para>
455 <indexterm zone="exim exim_tidydb">
456 <primary sortas="b-exim_tidydb">exim_tidydb</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="eximstats">
462 <term><command>eximstats</command></term>
463 <listitem>
464 <para>generates mail statistics from <application>Exim</application>
465 log files.</para>
466 <indexterm zone="exim eximstats">
467 <primary sortas="b-eximstats">eximstats</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="exinext">
473 <term><command>exinext</command></term>
474 <listitem>
475 <para>queries remote host retry times.</para>
476 <indexterm zone="exim exinext">
477 <primary sortas="b-exinext">exinext</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="exipick">
483 <term><command>exipick</command></term>
484 <listitem>
485 <para>selects messages based on various criteria.</para>
486 <indexterm zone="exim exipick">
487 <primary sortas="b-exipick">exipick</primary>
488 </indexterm>
489 </listitem>
490 </varlistentry>
491
492 <varlistentry id="exiqgrep">
493 <term><command>exiqgrep</command></term>
494 <listitem>
495 <para>is a utility for selective queue listing.</para>
496 <indexterm zone="exim exiqgrep">
497 <primary sortas="b-exiqgrep">exiqgrep</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="exiqsumm">
503 <term><command>exiqsumm</command></term>
504 <listitem>
505 <para>produces a summary of the messages in the mail queue.</para>
506 <indexterm zone="exim exiqsumm">
507 <primary sortas="b-exiqsumm">exiqsumm</primary>
508 </indexterm>
509 </listitem>
510 </varlistentry>
511
512 <varlistentry id="exiwhat">
513 <term><command>exiwhat</command></term>
514 <listitem>
515 <para>queries running <application>Exim</application>
516 processes.</para>
517 <indexterm zone="exim exiwhat">
518 <primary sortas="b-exiwhat">exiwhat</primary>
519 </indexterm>
520 </listitem>
521 </varlistentry>
522
523 <varlistentry id="eximon">
524 <term><command>eximon</command></term>
525 <listitem>
526 <para>is a start-up shell script for <command>eximon.bin</command>
527 used to set the required environment variables before running the
528 program.</para>
529 <indexterm zone="exim eximon">
530 <primary sortas="b-eximon">eximon</primary>
531 </indexterm>
532 </listitem>
533 </varlistentry>
534
535 <varlistentry id="eximon.bin">
536 <term><command>eximon.bin</command></term>
537 <listitem>
538 <para>is a monitor program which displays current information in an
539 <application>X</application> window, and also contains a menu interface
540 to <application>Exim</application>'s command line administration
541 options.</para>
542 <indexterm zone="exim eximon.bin">
543 <primary sortas="b-eximon.bin">eximon.bin</primary>
544 </indexterm>
545 </listitem>
546 </varlistentry>
547
548 </variablelist>
549
550 </sect2>
551
552</sect1>
Note: See TracBrowser for help on using the repository browser.