source: server/mail/exim.xml@ bfb7882

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.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 bfb7882 was bfb7882, checked in by Tushar Teredesai <tushar@…>, 19 years ago

More typo fixes

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