source: server/mail/exim.xml@ 76d61ba

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 76d61ba was 9f12e36, checked in by Randy McMurchy <randy@…>, 18 years ago

Removed 'keywordset' blocks and extra spaces from the XML files (note this was by accident as I meant to do just in the gnome directory but I was in the root of BOOK when I ran the script, but this was going to happen anyway so I don't think it is a big deal)

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