source: server/mail/exim.xml@ e695e4a0

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 e695e4a0 was e695e4a0, checked in by Randy McMurchy <randy@…>, 17 years ago

Updated the Exim instructions documentation links

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