source: server/mail/exim.xml@ 3cb0c57

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

Added the 'User Notes' wiki link to each package page; changed all instances of .[so,a] to .{so,a} (brackets changed to braces); changed all replaceable tags to use angle brackets instead of square brackets to encapsulate the text - commit #9

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