source: networking/mailnews/fetchmail.xml@ 3e63daa9

systemd-13485
Last change on this file since 3e63daa9 was 3e63daa9, checked in by DJ Lucas <dj@…>, 9 years ago

Merge Chapters 18 and 19 from trunk.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16881 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 6.4 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 fetchmail-download-http "&sourceforge-repo;/fetchmail/fetchmail-&fetchmail-version;.tar.xz">
8 <!ENTITY fetchmail-download-ftp "ftp://ftp.at.gnucash.org/pub/infosys/mail/fetchmail/fetchmail-&fetchmail-version;.tar.xz">
9 <!ENTITY fetchmail-md5sum "61b66faad044afa26e142bb1791aa2b3">
10 <!ENTITY fetchmail-size "1.2 MB">
11 <!ENTITY fetchmail-buildsize "14 MB">
12 <!ENTITY fetchmail-time "0.1 SBU">
13]>
14
15<sect1 id="fetchmail" xreflabel="fetchmail-&fetchmail-version;">
16 <?dbhtml filename="fetchmail.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Fetchmail-&fetchmail-version;</title>
24
25 <indexterm zone="fetchmail">
26 <primary sortas="a-Fetchmail">Fetchmail</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Fetchmail</title>
31
32 <para>The <application>Fetchmail</application> package contains a mail
33 retrieval program. It retrieves mail from remote mail servers and
34 forwards it to the local (client) machine's delivery system, so it can then be
35 read by normal mail user agents.</para>
36
37 &lfs78_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing='compact'>
41 <listitem>
42 <para>Download (HTTP): <ulink url="&fetchmail-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&fetchmail-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &fetchmail-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &fetchmail-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &fetchmail-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &fetchmail-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">Fetchmail Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Recommended</bridgehead>
64 <para role="recommended">
65 <xref linkend="openssl"/> and
66 a local MDA (<xref linkend="procmail"/>)
67 </para>
68
69 <bridgehead renderas="sect4">Optional</bridgehead>
70 <para role="optional">
71 <xref linkend="python2"/> and
72 <xref linkend="tk"/>
73 </para>
74
75 <para condition="html" role="usernotes">User Notes:
76 <ulink url="&blfs-wiki;/fetchmail"/></para>
77
78 </sect2>
79
80 <sect2 role="installation">
81 <title>Installation of Fetchmail</title>
82
83 <para>Install <application>Fetchmail</application> by running the following
84 commands:</para>
85
86<screen><userinput>./configure --prefix=/usr --with-ssl --enable-fallback=procmail &amp;&amp;
87make</userinput></screen>
88
89 <para>This package does not come with a test suite.</para>
90
91 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
92
93<screen role='root'><userinput>make install</userinput></screen>
94
95 </sect2>
96
97 <sect2 role="commands">
98 <title>Command Explanations</title>
99
100 <para><parameter>--with-ssl</parameter>: This enables SSL support, so that
101 you can handle connections to secure POP3 and IMAP servers.</para>
102
103 <para><parameter>--enable-fallback=procmail</parameter>: This tells
104 <application>Fetchmail</application> to hand incoming mail to
105 <application>Procmail</application> for delivery, if the port 25 mail server is
106 not present or not responding.</para>
107
108 </sect2>
109
110 <sect2 role="configuration">
111 <title>Configuring Fetchmail</title>
112
113 <sect3 id="fetchmail-config">
114 <title>Config Files</title>
115
116 <para><filename>~/.fetchmailrc</filename></para>
117
118 <indexterm zone="fetchmail fetchmail-config">
119 <primary sortas="e-AA.fetchmailrc">~/.fetchmailrc</primary>
120 </indexterm>
121
122 </sect3>
123
124 <sect3>
125 <title>Configuration Information</title>
126
127<screen><userinput>cat &gt; ~/.fetchmailrc &lt;&lt; "EOF"
128<literal>set logfile /var/log/fetchmail.log
129set no bouncemail
130set postmaster root
131
132poll SERVERNAME :
133 user <replaceable>&lt;username&gt;</replaceable> pass <replaceable>&lt;password&gt;</replaceable>;
134 mda "/usr/bin/procmail -f %F -d %T";</literal>
135EOF
136
137chmod -v 0600 ~/.fetchmailrc</userinput></screen>
138
139 <para>This is an example configuration that should suffice for most people.
140 You can add as many users and servers as you need using the same syntax.</para>
141
142 <para><command>man fetchmail</command>: Look for the section near the
143 bottom named <emphasis>CONFIGURATION EXAMPLES</emphasis>. It gives some
144 quick examples. There are countless other configuration options once you
145 get used to it.</para>
146
147 </sect3>
148
149 </sect2>
150
151 <sect2 role="content">
152 <title>Contents</title>
153
154 <segmentedlist>
155 <segtitle>Installed Programs</segtitle>
156 <segtitle>Installed Libraries</segtitle>
157 <segtitle>Installed Directories</segtitle>
158
159 <seglistitem>
160 <seg>fetchmail and fetchmailconf</seg>
161 <seg>None</seg>
162 <seg>None</seg>
163 </seglistitem>
164 </segmentedlist>
165
166 <variablelist>
167 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
168 <?dbfo list-presentation="list"?>
169 <?dbhtml list-presentation="table"?>
170
171 <varlistentry id="fetchmail-prog">
172 <term><command>fetchmail</command></term>
173 <listitem>
174 <para>when executed as a user, this will source
175 <filename>~/.fetchmailrc</filename> and download the appropriate mail.
176 </para>
177 <indexterm zone="fetchmail fetchmail-prog">
178 <primary sortas="b-fetchmail">fetchmail</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="fetchmailconf">
184 <term><command>fetchmailconf</command></term>
185 <listitem>
186 <para>it will assist you in setting up and editing a
187 <filename>~/.fetchmailrc</filename> configuration file, by using
188 a <application>Tk</application> GUI interface. It requires
189 <application>Python</application> and it must have the Tkinker module
190 available.</para>
191 <indexterm zone="fetchmail fetchmailconf">
192 <primary sortas="b-fetchmailconf">fetchmailconf</primary>
193 </indexterm>
194 </listitem>
195 </varlistentry>
196
197 </variablelist>
198
199 </sect2>
200
201</sect1>
Note: See TracBrowser for help on using the repository browser.