source: networking/mailnews/mutt.xml

trunk
Last change on this file was aaab0a4e, checked in by Ken Moffat <ken@…>, 4 weeks ago

Package updates:

fetchmail-6.4.22,
mutt-2.1.3.

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