source: networking/mailnews/mutt.xml@ 4e1712b

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 4e1712b was 4e1712b, checked in by Ken Moffat <ken@…>, 18 months ago

mutt-1.14.4

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23298 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 15.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 "https://bitbucket.org/mutt/mutt/downloads/mutt-&mutt-version;.tar.gz">
8 <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/pub/mutt/mutt-&mutt-version;.tar.gz">
9 <!ENTITY mutt-md5sum "a1446e9a169e79001c78692c80090ae5">
10 <!ENTITY mutt-size "4.8 MB">
11 <!ENTITY mutt-buildsize "46 MB">
12 <!ENTITY mutt-time "0.3 SBU">
13]>
14
15<sect1 id="mutt" xreflabel="Mutt-&mutt-version;">
16 <?dbhtml filename="mutt.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Mutt-&mutt-version;</title>
24
25 <indexterm zone="mutt">
26 <primary sortas="a-mutt">mutt</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Mutt</title>
31
32 <para>
33 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.
36 </para>
37
38 &lfs91_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing='compact'>
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&mutt-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&mutt-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &mutt-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &mutt-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &mutt-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &mutt-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <!--<bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing='compact'>
76 <listitem>
77 <para>
78 Required patch: <ulink
79 url="&patch-root;/mutt-&mutt-version;-upstream_fixes-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist>-->
83
84 <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
85
86 <bridgehead renderas="sect4">Recommended (for a text version of the manual)</bridgehead>
87 <para role="recommended">
88 <xref linkend="lynx"/>, or
89 <xref linkend="Links"/> (or
90 <ulink url="&w3m-url;">W3m</ulink>, or
91 <ulink url="&elinks-url;">ELinks</ulink>) - please read the Note.
92 </para>
93
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional">
96 <xref linkend="aspell"/>,
97 <xref linkend="cyrus-sasl"/>,
98 <xref linkend="gdb"/>,
99 <xref linkend="gnupg2"/>,
100 <xref linkend="gnutls"/>,
101 <xref linkend="gpgme"/>,
102 <xref linkend="libidn"/>,
103 <xref linkend="mitkrb"/>,
104 an <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
105 <xref linkend="slang"/>,
106 <xref linkend="sqlite"/>,
107 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>,
108 <ulink url="http://mixmaster.sourceforge.net/">Mixmaster</ulink>,
109 <!-- from configure: \-\-with-bdb[=DIR] Use BerkeleyDB4 if gdbm is not
110 available but gdbm is installed in LFS, so do not mention BerkeleyDB
111 <xref linkend="db"/> or -->
112 <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
113 <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
114 </para>
115
116<!--<bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
117 <para role="optional">
118 <xref linkend="docbook-dsssl"/>,
119 <xref linkend="openjade"/>, and
120 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/> with
121 <command>pdfjadetex</command> installed)
122 </para>-->
123
124 <para condition="html" role="usernotes">User Notes:
125 <ulink url="&blfs-wiki;/mutt"/></para>
126
127 </sect2>
128
129 <sect2 role="installation">
130 <title>Installation of Mutt</title>
131
132 <note>
133 <para>
134 <application>Mutt</application> ships with an HTML version of its
135 manual, but the text version is no longer provided because differences
136 in the formatting from different text browsers compared to the shipped
137 version caused complaints. To get a text file, the following are used
138 in order of preference: <application>lynx</application> with overstriking
139 (backspaces) for emphasis, <application>w3m</application> or
140 <application>elinks</application>: the latter two apparently provide
141 plain text. Plain text is generally preferred unless reading the HTML
142 manual, so the instructions below use <application>lynx</application>
143 if available, or else <application>links</application> to produce plain
144 text.
145 </para>
146 </note>
147
148 <para>
149 <application>Mutt</application> requires a group named
150 <systemitem class="groupname">mail</systemitem>. You can
151 add this group, if it does not exist, with this command:
152 </para>
153
154<screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
155
156 <para>
157 If you did not install an <xref linkend="server-mail"/>, you need to
158 modify the ownership of <filename class="directory">/var/mail</filename>
159 with this command:
160 </para>
161
162<screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
163
164 <para>
165 Install <application>Mutt</application> by running the following
166 commands:
167 </para>
168
169 <para>
170 To ensure that a plain text manual is created when using
171 <application>lynx</application> or to otherwise use
172 <application>links</application> to produce it (instead of
173 <application>elinks</application>), run the following command:
174 </para>
175
176<screen><userinput>sed -i -e 's/ -with_backspaces//' -e 's/elinks/links/' \
177 -e 's/-no-numbering -no-references//' doc/Makefile.in</userinput></screen>
178
179 <para>
180 Now configure and build the application:
181 </para>
182
183<screen><userinput>./configure --prefix=/usr \
184 --sysconfdir=/etc \
185 --with-docdir=/usr/share/doc/mutt-&mutt-version; \
186 --with-ssl \
187 --enable-external-dotlock \
188 --enable-pop \
189 --enable-imap \
190 --enable-hcache \
191 --enable-sidebar &amp;&amp;
192make</userinput></screen>
193
194<!-- PDF broken with 1.14.0
195 <para>
196 To generate the PDF manual with <xref linkend="texlive"/>, run
197 the following command:
198 </para>
199
200<screen remap="doc"><userinput>make -C doc manual.pdf</userinput></screen>-->
201
202 <para>
203 This package does not come with a test suite.
204 </para>
205
206 <para>
207 Now, as the <systemitem class="username">root</systemitem> user:
208 </para>
209
210 <screen role='root'><userinput>make install</userinput></screen>
211
212<!--<para>
213 If you generated the PDF manual, install it
214 by issuing the following command as the
215 <systemitem class="username">root</systemitem> user:
216 </para>
217
218<screen role='root' remap='doc'><userinput>install -v -m644 doc/manual.pdf \
219 /usr/share/doc/mutt-&mutt-version;</userinput></screen>-->
220
221 <note>
222 <para>
223 If you used a DESTDIR method to only install to a temporary location as
224 a regular user (as part of a package menagement process), you will need
225 to run the following as the <systemitem class="username">root
226 </systemitem> user after completing the real install:
227 </para>
228
229<screen role="nodump"><userinput>chown root:mail /usr/bin/mutt_dotlock &amp;&amp;
230chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
231
232 <para>
233 An info file is now installed, so you will also need to recreate the
234 <filename>/usr/share/info/dir</filename> as described when
235 <application>Texinfo</application> was installed in LFS.
236 </para>
237 </note>
238
239
240 </sect2>
241
242 <sect2 role="commands">
243 <title>Command Explanations</title>
244
245 <para>
246 <parameter>sed ... -e 's/ -with_backspaces//' ...</parameter>: This turns
247 off the backspaces used for overstriking when <application>lynx</application>
248 is used, resulting in readable plain text when using <command>view</command>.
249 </para>
250
251 <para>
252 <parameter>sed ... -e 's/elinks/links/' ...</parameter>: This allows
253 <command>links</command> to be run instead of <command>elinks</command>
254 which is not in the book.
255 </para>
256
257 <para>
258 <parameter>sed ... -e 's/-no-numbering -no-references//' ...</parameter>:
259 This removes switches which are not understood by <command>links</command>.
260 </para>
261
262 <para>
263 <parameter>--enable-external-dotlock</parameter>: In some circumstances
264 the mutt-dotlock program is not created. This switch ensures it is always
265 created.
266 </para>
267
268 <para>
269 <parameter>--enable-pop</parameter>: This switch enables POP3 support.
270 </para>
271
272 <para>
273 <parameter>--enable-imap</parameter>: This switch enables IMAP support.
274 </para>
275
276 <para>
277 <parameter>--enable-hcache</parameter>: This switch enables
278 header caching.
279 </para>
280
281 <para>
282 <parameter>--enable-sidebar</parameter>: This switch enables support
283 for the sidebar (a list of mailboxes). It is off by default, but can be
284 turned on by <command>:set sidebar_visible</command> in mutt (and off
285 again with ':unset'), or it can be enabled in <filename>
286 ~/.muttrc</filename>.
287 </para>
288
289 <para>
290 <parameter>--with-ssl</parameter>: This parameter adds SSL/TLS
291 support from openssl in POP3/IMAP/SMTP.
292 </para>
293
294 <para>
295 <option>--enable-autocrypt --with-sqlite3</option>: These two
296 switches add support for passive protection against data collection,
297 using gnupg and gpgme (gpgme is enabled by autocrypt). See <ulink
298 url="http://www.mutt.org/doc/manual/#autocryptdoc">The Manual</ulink>.
299 </para>
300
301 <para>
302 <option>--enable-gpgme</option>: This switch enables GPG support
303 through the GPGME package. Use this switch if you want GPG support in
304 Mutt.
305 </para>
306
307 <para>
308 <option>--enable-smtp</option>: This switch enables
309 SMTP relay support.
310 </para>
311
312 <para>
313 <option>--with-idn2</option>: Use this parameter if both libidn and
314 libidn2 have been installed, and you wish to use libidn2 here.
315 </para>
316
317 <para>
318 <option>--with-sasl</option>: This parameter adds authentication support
319 from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP if they are enabled.
320 Depending on the server configuration, this may not be needed for POP3
321 or IMAP. However, it is needed for SMTP authentication.
322 </para>
323
324 <!-- we do not normally list all possible switches. LFS installs ncurses.
325 <para>
326 <option>\-\-with-slang</option>: Use <application>S-Lang
327 </application> instead of <application>Ncurses</application>.
328 </para> -->
329
330 </sect2>
331
332 <sect2 role="configuration">
333 <title>Configuring Mutt</title>
334
335 <sect3 id="mutt-config">
336 <title>Config Files</title>
337
338 <para>
339 <filename>/etc/Muttrc</filename>,
340 <filename>~/.muttrc</filename>,
341 <filename>/etc/mime.types</filename>, and
342 <filename>~/.mime.types</filename>
343 </para>
344
345 <indexterm zone="mutt mutt-config">
346 <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
347 </indexterm>
348
349 <indexterm zone="mutt mutt-config">
350 <primary sortas="e-AA.muttrc">~/.muttrc</primary>
351 </indexterm>
352
353 <indexterm zone="mutt mutt-config">
354 <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
355 </indexterm>
356
357 <indexterm zone="mutt mutt-config">
358 <primary sortas="e-AA.mime.types">~/.mime.types</primary>
359 </indexterm>
360
361 </sect3>
362
363 <sect3>
364 <title>Configuration Information</title>
365
366 <para>
367 No changes in these files are necessary to begin using
368 <application>Mutt</application>. When you are ready to make changes,
369 the man page for <filename>muttrc</filename> is a good starting place.
370 </para>
371
372 <para>
373 In order to utilize <application>GnuPG</application>, use the following
374 command:
375 </para>
376
377<screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc &gt;&gt; ~/.muttrc</userinput></screen>
378
379 </sect3>
380
381 </sect2>
382
383 <sect2 role="content">
384 <title>Contents</title>
385
386 <segmentedlist>
387 <segtitle>Installed Programs</segtitle>
388 <segtitle>Installed Libraries</segtitle>
389 <segtitle>Installed Directories</segtitle>
390
391 <seglistitem>
392 <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
393 smime_keys</seg>
394 <seg>None</seg>
395 <seg>/usr/share/doc/mutt-&mutt-version;</seg>
396 </seglistitem>
397 </segmentedlist>
398
399 <variablelist>
400 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
401 <?dbfo list-presentation="list"?>
402 <?dbhtml list-presentation="table"?>
403
404 <varlistentry id="flea">
405 <term><command>flea</command></term>
406 <listitem>
407 <para>
408 is a script showing where to report bugs.
409 </para>
410 <indexterm zone="mutt flea">
411 <primary sortas="b-flea">flea</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="mutt-prog">
417 <term><command>mutt</command></term>
418 <listitem>
419 <para>
420 is a Mail User Agent (MUA) which enables you to read, write
421 and delete your email.
422 </para>
423 <indexterm zone="mutt mutt-prog">
424 <primary sortas="b-mutt">mutt</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 <varlistentry id="mutt_dotlock">
430 <term><command>mutt_dotlock</command></term>
431 <listitem>
432 <para>
433 implements the mail spool file lock.
434 </para>
435 <indexterm zone="mutt mutt_dotlock">
436 <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="muttbug">
442 <term><command>muttbug</command></term>
443 <listitem>
444 <para>
445 is a script identical to <command>flea</command>.
446 </para>
447 <indexterm zone="mutt muttbug">
448 <primary sortas="b-muttbug">muttbug</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="pgpewrap">
454 <term><command>pgpewrap</command></term>
455 <listitem>
456 <para>
457 prepares a command line for the <xref linkend="gnupg2"/> utilities.
458 </para>
459 <indexterm zone="mutt pgpewrap">
460 <primary sortas="b-pgpewrap">pgpewrap</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="pgpring">
466 <term><command>pgpring</command></term>
467 <listitem>
468 <para>
469 is a key ring dumper for <ulink
470 url="http://www.pgp.com/">PGP</ulink>. It is not needed for
471 <xref linkend="gnupg2"/>.
472 </para>
473 <indexterm zone="mutt pgpring">
474 <primary sortas="b-pgpring">pgpring</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 <varlistentry id="smime_keys">
480 <term><command>smime_keys</command></term>
481 <listitem>
482 <para>
483 manages a keystore for S/MIME certificates.
484 </para>
485 <indexterm zone="mutt smime_keys">
486 <primary sortas="b-smime_keys">smime_keys</primary>
487 </indexterm>
488 </listitem>
489 </varlistentry>
490
491 </variablelist>
492
493 </sect2>
494
495</sect1>
Note: See TracBrowser for help on using the repository browser.