source: networking/mailnews/mutt.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: 12.8 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 mutt-download-http "&sourceforge-repo;/mutt/mutt-&mutt-version;.tar.gz">-->
8 <!ENTITY mutt-download-http " ">
9 <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/pub/mutt/mutt-&mutt-version;.tar.gz">
10 <!ENTITY mutt-md5sum "7f25d27f3c7c82285ac07aac35f5f0f2">
11 <!ENTITY mutt-size "3.8 MB">
12 <!ENTITY mutt-buildsize "36 MB (plus a further 8MB for the PDF manual)">
13 <!ENTITY mutt-time "0.3 SBU (plus a further 0.2 SBU to build the PDF manual)">
14]>
15
16<sect1 id="mutt" xreflabel="Mutt-&mutt-version;">
17 <?dbhtml filename="mutt.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Mutt-&mutt-version;</title>
25
26 <indexterm zone="mutt">
27 <primary sortas="a-mutt">mutt</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Mutt</title>
32
33 <para>The <application>Mutt</application> package contains a Mail User
34 Agent. This is useful for reading, writing, replying to, saving, and
35 deleting your email.</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="&mutt-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&mutt-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &mutt-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &mutt-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &mutt-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &mutt-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <!--<bridgehead renderas="sect3">Additional Downloads</bridgehead>
62 <itemizedlist spacing='compact'>
63 <listitem>
64 <para>Required patch: <ulink
65 url="&patch-root;/mutt-&mutt-version;-upstream_fixes-1.patch"/>
66 </para>
67 </listitem>
68 </itemizedlist>-->
69
70 <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Optional</bridgehead>
73 <para role="optional">
74 <xref linkend="aspell"/>,
75 <xref linkend="cyrus-sasl"/>,
76 <xref linkend="gdb"/>,
77 <xref linkend="gnupg2"/>,
78 <xref linkend="gpgme"/>,
79 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>,
80 <xref linkend="libidn"/>,
81 <xref linkend="mitkrb"/>,
82 <ulink url="http://mixmaster.sourceforge.net/">Mixmaster</ulink>,
83 an <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
84 <xref linkend="slang"/>,
85 <xref linkend="openssl"/> or
86 <xref linkend="gnutls"/>,
87 <xref linkend="db"/> or
88 <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
89 <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
90 </para>
91
92 <bridgehead renderas="sect4">Optional (To Regenerate HTML
93 Documentation)</bridgehead>
94 <para role="optional">
95 <xref linkend="libxslt"/> and either
96 <xref linkend="lynx"/>,
97 <xref linkend="w3m"/>, or
98 <ulink url="http://elinks.or.cz/">ELinks</ulink>
99 </para>
100
101 <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
102 <para role="optional">
103 <xref linkend="docbook-dsssl"/>,
104 <xref linkend="openjade"/>, and
105 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
106 </para>
107
108 <para condition="html" role="usernotes">User Notes:
109 <ulink url="&blfs-wiki;/mutt"/></para>
110
111 </sect2>
112
113 <sect2 role="installation">
114 <title>Installation of Mutt</title>
115
116 <note>
117 <para>This version of <application>Mutt</application> is a development
118 release. The BLFS editors have determined that it provides a stable
119 program and fixes two issues in the current stable version of
120 <application>Mutt</application>: a segmentation fault that occurs under
121 certain conditions and a compilation problem when building with recent
122 versions of <application>GCC</application>.
123 </para>
124 </note>
125
126 <para><application>Mutt</application> requires a group named
127 <systemitem class="groupname">mail</systemitem>. You can
128 add this group, if it does not exist, with this command:</para>
129
130<screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
131
132 <para>If you did not install an <xref linkend="server-mail"/>, you need to
133 modify the ownership of <filename class="directory">/var/mail</filename>
134 with this command:</para>
135
136<screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
137
138 <para><application>Mutt</application> will rebuild the html documentation
139 if <application>libxslt</application> is present, then use that to update
140 the text manual - even if none of the specified browsers are present. That
141 will create an empty text file, so we will save the shipped file.
142 </para>
143
144 <para>Install <application>Mutt</application> by running the following
145 commands:</para>
146
147<screen><userinput>cp -v doc/manual.txt{,.shipped} &amp;&amp;
148./configure --prefix=/usr \
149 --sysconfdir=/etc \
150 --with-docdir=/usr/share/doc/mutt-&mutt-version; \
151 --enable-pop \
152 --enable-imap \
153 --enable-hcache \
154 --without-qdbm \
155 --with-gdbm \
156 --without-bdb \
157 --without-tokyocabinet &amp;&amp;
158make &amp;&amp;
159test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</userinput></screen>
160
161 <para>To generate the PDF manual with <xref linkend="texlive"/>, run
162 the following command:</para>
163
164<screen><userinput>make -C doc manual.pdf</userinput></screen>
165
166 <para>This package does not come with a test suite.</para>
167
168 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
169
170<screen role='root'><userinput>make install</userinput></screen>
171
172 <para>If you generated the PDF manual, install it and the source TeX
173 file by issuing the following command as the
174 <systemitem class="username">root</systemitem> user:</para>
175
176<screen role='root'><userinput>install -v -m644 doc/manual.{pdf,tex} \
177 /usr/share/doc/mutt-&mutt-version;</userinput></screen>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para><parameter>--enable-pop</parameter>: This switch enables
185 POP3 support.</para>
186
187 <para><parameter>--enable-imap</parameter>: This switch enables
188 IMAP support.</para>
189
190 <para><parameter>--enable-hcache</parameter>: This switch enables
191 header caching.</para>
192
193 <para><parameter>--without-qdbm</parameter>: This switch disables
194 <application>QDBM</application> as the header cache backend.</para>
195
196 <para><parameter>--without-tokyocabinet</parameter>: This switch disables
197 <application>Tokyo Cabinet</application> as the header cache backend.</para>
198
199 <para><parameter>--with-gdbm</parameter>: This switch enables
200 <application>GDBM</application> as the header cache backend.</para>
201
202 <para><parameter>--without-bdb</parameter>: This switch disables
203 <application>Berkeley DB</application> as the header cache backend.</para>
204
205 <para><option>--enable-smtp</option>: This switch enables
206 SMTP relay support.</para>
207
208 <para><option>--with-ssl</option>: This parameter adds SSL/TLS
209 support from <xref linkend="openssl"/> in POP3/IMAP/SMTP if they are
210 enabled.</para>
211
212 <para><option>--with-sasl</option>: This parameter adds
213 authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
214 if they are enabled. Depending on the server configuration, this may not
215 be needed for POP3 or IMAP. However, it is needed for SMTP
216 authentication.</para>
217
218 <para><option>--with-slang</option>: Use <application>S-Lang
219 </application> instead of <application>Ncurses</application>.</para>
220
221 <para><option>test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</option>:
222 if the text manual is now empty (<application>libxslt</application> is installed,
223 but without any of the specified text browsers), restore it from the copy.</para>
224
225 </sect2>
226
227 <sect2 role="configuration">
228 <title>Configuring Mutt</title>
229
230 <sect3 id="mutt-config">
231 <title>Config Files</title>
232
233 <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
234 <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
235
236 <indexterm zone="mutt mutt-config">
237 <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
238 </indexterm>
239
240 <indexterm zone="mutt mutt-config">
241 <primary sortas="e-AA.muttrc">~/.muttrc</primary>
242 </indexterm>
243
244 <indexterm zone="mutt mutt-config">
245 <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
246 </indexterm>
247
248 <indexterm zone="mutt mutt-config">
249 <primary sortas="e-AA.mime.types">~/.mime.types</primary>
250 </indexterm>
251
252 </sect3>
253
254 <sect3>
255 <title>Configuration Information</title>
256
257 <para>No changes in these files are necessary to begin using
258 <application>Mutt</application>. When you are ready to make changes, the
259 man page for <filename>muttrc</filename> is a good starting place.</para>
260
261 <para>In order to utilize <application>GnuPG</application>, use the following
262 command:</para>
263
264<screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc &gt;&gt; ~/.muttrc</userinput></screen>
265
266 </sect3>
267
268 </sect2>
269
270 <sect2 role="content">
271 <title>Contents</title>
272
273 <segmentedlist>
274 <segtitle>Installed Programs</segtitle>
275 <segtitle>Installed Libraries</segtitle>
276 <segtitle>Installed Directories</segtitle>
277
278 <seglistitem>
279 <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
280 smime_keys</seg>
281 <seg>None</seg>
282 <seg>/usr/share/doc/mutt-&mutt-version;</seg>
283 </seglistitem>
284 </segmentedlist>
285
286 <variablelist>
287 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
288 <?dbfo list-presentation="list"?>
289 <?dbhtml list-presentation="table"?>
290
291 <varlistentry id="flea">
292 <term><command>flea</command></term>
293 <listitem>
294 <para>is a bug submitter for <application>Mutt</application>.</para>
295 <indexterm zone="mutt flea">
296 <primary sortas="b-flea">flea</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="mutt-prog">
302 <term><command>mutt</command></term>
303 <listitem>
304 <para>is a Mail User Agent (MUA) which enables you to read, write
305 and delete your email.</para>
306 <indexterm zone="mutt mutt-prog">
307 <primary sortas="b-mutt">mutt</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="mutt_dotlock">
313 <term><command>mutt_dotlock</command></term>
314 <listitem>
315 <para>implements the mail spool file lock.</para>
316 <indexterm zone="mutt mutt_dotlock">
317 <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="muttbug">
323 <term><command>muttbug</command></term>
324 <listitem>
325 <para>is a script that executes <command>flea</command>.</para>
326 <indexterm zone="mutt muttbug">
327 <primary sortas="b-muttbug">muttbug</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="pgpewrap">
333 <term><command>pgpewrap</command></term>
334 <listitem>
335 <para>prepares a command line for the <xref linkend="gnupg2"/>
336 utilities.</para>
337 <indexterm zone="mutt pgpewrap">
338 <primary sortas="b-pgpewrap">pgpewrap</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="pgpring">
344 <term><command>pgpring</command></term>
345 <listitem>
346 <para>is a key ring dumper for <ulink
347 url="http://www.pgp.com/">PGP</ulink>. It is not needed for
348 <xref linkend="gnupg2"/>.</para>
349 <indexterm zone="mutt pgpring">
350 <primary sortas="b-pgpring">pgpring</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="smime_keys">
356 <term><command>smime_keys</command></term>
357 <listitem>
358 <para>manages a keystore for S/MIME certificates.</para>
359 <indexterm zone="mutt smime_keys">
360 <primary sortas="b-smime_keys">smime_keys</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 </variablelist>
366
367 </sect2>
368
369</sect1>
Note: See TracBrowser for help on using the repository browser.