source: server/mail/exim.xml@ 5254d12

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

Standardized the id tag name of the Bootscripts package

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