source: server/mail/exim.xml@ e20c8110

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since e20c8110 was 4aae2cc, checked in by Bruce Dubbs <bdubbs@…>, 18 years ago

Updated to exim-4.61

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