source: server/mail/exim.xml@ 2df08064

systemd-13485
Last change on this file since 2df08064 was 2df08064, checked in by DJ Lucas <dj@…>, 8 years ago

Merge Section V. from trunk.

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