source: server/mail/exim.xml@ b960e3ec

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 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 b960e3ec was b960e3ec, checked in by Ken Moffat <ken@…>, 12 years ago

Fix 'other' (g-) indexing, apart from truetype - move that to the end of the section. Also correct xorriso (prog) and bazaar (package).

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