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 "b51efb48df5cbe4f91e55a75fef19b71">
|
---|
10 | <!ENTITY mutt-size "5.3 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 | &lfs111_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 -e 's/ -with_backspaces//' \
|
---|
182 | -e 's/elinks/links/' \
|
---|
183 | -e 's/-no-numbering -no-references//' \
|
---|
184 | -i doc/Makefile.in</userinput></screen>
|
---|
185 |
|
---|
186 | <para>
|
---|
187 | Now configure and build the application:
|
---|
188 | </para>
|
---|
189 |
|
---|
190 | <screen><userinput>./configure --prefix=/usr \
|
---|
191 | --sysconfdir=/etc \
|
---|
192 | --with-docdir=/usr/share/doc/mutt-&mutt-version; \
|
---|
193 | --with-ssl \
|
---|
194 | --enable-external-dotlock \
|
---|
195 | --enable-pop \
|
---|
196 | --enable-imap \
|
---|
197 | --enable-hcache \
|
---|
198 | --enable-sidebar &&
|
---|
199 | make</userinput></screen>
|
---|
200 |
|
---|
201 | <!-- PDF broken with 1.14.0
|
---|
202 | <para>
|
---|
203 | To generate the PDF manual with <xref linkend="texlive"/>, run
|
---|
204 | the following command:
|
---|
205 | </para>
|
---|
206 |
|
---|
207 | <screen remap="doc"><userinput>make -C doc manual.pdf</userinput></screen>-->
|
---|
208 |
|
---|
209 | <para>
|
---|
210 | This package does not come with a test suite.
|
---|
211 | </para>
|
---|
212 |
|
---|
213 | <para>
|
---|
214 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
215 | </para>
|
---|
216 |
|
---|
217 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
218 |
|
---|
219 | <!--<para>
|
---|
220 | If you generated the PDF manual, install it
|
---|
221 | by issuing the following command as the
|
---|
222 | <systemitem class="username">root</systemitem> user:
|
---|
223 | </para>
|
---|
224 |
|
---|
225 | <screen role='root' remap='doc'><userinput>install -v -m644 doc/manual.pdf \
|
---|
226 | /usr/share/doc/mutt-&mutt-version;</userinput></screen>-->
|
---|
227 |
|
---|
228 | <note>
|
---|
229 | <para>
|
---|
230 | If you used a DESTDIR method to only install to a temporary location as
|
---|
231 | a regular user (as part of a package management process), you will need
|
---|
232 | to run the following as the <systemitem class="username">root
|
---|
233 | </systemitem> user after completing the real install:
|
---|
234 | </para>
|
---|
235 |
|
---|
236 | <screen role="nodump"><userinput>chown root:mail /usr/bin/mutt_dotlock &&
|
---|
237 | chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
|
---|
238 |
|
---|
239 | <para>
|
---|
240 | An info file is now installed, so you will also need to recreate the
|
---|
241 | <filename>/usr/share/info/dir</filename> as described when
|
---|
242 | <application>Texinfo</application> was installed in LFS.
|
---|
243 | </para>
|
---|
244 | </note>
|
---|
245 |
|
---|
246 |
|
---|
247 | </sect2>
|
---|
248 |
|
---|
249 | <sect2 role="commands">
|
---|
250 | <title>Command Explanations</title>
|
---|
251 |
|
---|
252 | <para>
|
---|
253 | <parameter>sed ... -e 's/ -with_backspaces//' ...</parameter>: This turns
|
---|
254 | off the backspaces used for overstriking when <application>lynx</application>
|
---|
255 | is used, resulting in readable plain text when using <command>view</command>.
|
---|
256 | </para>
|
---|
257 |
|
---|
258 | <para>
|
---|
259 | <parameter>sed ... -e 's/elinks/links/' ...</parameter>: This allows
|
---|
260 | <command>links</command> to be run instead of <command>elinks</command>
|
---|
261 | which is not in the book.
|
---|
262 | </para>
|
---|
263 |
|
---|
264 | <para>
|
---|
265 | <parameter>sed ... -e 's/-no-numbering -no-references//' ...</parameter>:
|
---|
266 | This removes switches which are not understood by <command>links</command>.
|
---|
267 | </para>
|
---|
268 |
|
---|
269 | <para>
|
---|
270 | <parameter>--enable-external-dotlock</parameter>: In some circumstances
|
---|
271 | the mutt-dotlock program is not created. This switch ensures it is always
|
---|
272 | created.
|
---|
273 | </para>
|
---|
274 |
|
---|
275 | <para>
|
---|
276 | <parameter>--enable-pop</parameter>: This switch enables POP3 support.
|
---|
277 | </para>
|
---|
278 |
|
---|
279 | <para>
|
---|
280 | <parameter>--enable-imap</parameter>: This switch enables IMAP support.
|
---|
281 | </para>
|
---|
282 |
|
---|
283 | <para>
|
---|
284 | <parameter>--enable-hcache</parameter>: This switch enables
|
---|
285 | header caching.
|
---|
286 | </para>
|
---|
287 |
|
---|
288 | <para>
|
---|
289 | <parameter>--enable-sidebar</parameter>: This switch enables support
|
---|
290 | for the sidebar (a list of mailboxes). It is off by default, but can be
|
---|
291 | turned on by <command>:set sidebar_visible</command> in mutt (and off
|
---|
292 | again with ':unset'), or it can be enabled in <filename>
|
---|
293 | ~/.muttrc</filename>.
|
---|
294 | </para>
|
---|
295 |
|
---|
296 | <para>
|
---|
297 | <parameter>--with-ssl</parameter>: This parameter adds SSL/TLS
|
---|
298 | support from openssl in POP3/IMAP/SMTP.
|
---|
299 | </para>
|
---|
300 |
|
---|
301 | <para>
|
---|
302 | <option>--enable-autocrypt --with-sqlite3</option>: These two
|
---|
303 | switches add support for passive protection against data collection,
|
---|
304 | using gnupg and gpgme (gpgme is enabled by autocrypt). See <ulink
|
---|
305 | url="http://www.mutt.org/doc/manual/#autocryptdoc">The Manual</ulink>.
|
---|
306 | </para>
|
---|
307 |
|
---|
308 | <para>
|
---|
309 | <option>--enable-gpgme</option>: This switch enables GPG support
|
---|
310 | through the GPGME package. Use this switch if you want GPG support in
|
---|
311 | Mutt.
|
---|
312 | </para>
|
---|
313 |
|
---|
314 | <para>
|
---|
315 | <option>--enable-smtp</option>: This switch enables
|
---|
316 | SMTP relay support.
|
---|
317 | </para>
|
---|
318 |
|
---|
319 | <para>
|
---|
320 | <option>--with-idn2</option>: Use this parameter if both libidn and
|
---|
321 | libidn2 have been installed, and you wish to use libidn2 here.
|
---|
322 | </para>
|
---|
323 |
|
---|
324 | <para>
|
---|
325 | <option>--with-sasl</option>: This parameter adds authentication support
|
---|
326 | from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP if they are enabled.
|
---|
327 | Depending on the server configuration, this may not be needed for POP3
|
---|
328 | or IMAP. However, it is needed for SMTP authentication.
|
---|
329 | </para>
|
---|
330 |
|
---|
331 | <!-- we do not normally list all possible switches. LFS installs ncurses.
|
---|
332 | <para>
|
---|
333 | <option>\-\-with-slang</option>: Use <application>S-Lang
|
---|
334 | </application> instead of <application>Ncurses</application>.
|
---|
335 | </para> -->
|
---|
336 |
|
---|
337 | </sect2>
|
---|
338 |
|
---|
339 | <sect2 role="configuration">
|
---|
340 | <title>Configuring Mutt</title>
|
---|
341 |
|
---|
342 | <sect3 id="mutt-config">
|
---|
343 | <title>Config Files</title>
|
---|
344 |
|
---|
345 | <para>
|
---|
346 | <filename>/etc/Muttrc</filename>,
|
---|
347 | <filename>~/.muttrc</filename>,
|
---|
348 | <filename>/etc/mime.types</filename>, and
|
---|
349 | <filename>~/.mime.types</filename>
|
---|
350 | </para>
|
---|
351 |
|
---|
352 | <indexterm zone="mutt mutt-config">
|
---|
353 | <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
|
---|
354 | </indexterm>
|
---|
355 |
|
---|
356 | <indexterm zone="mutt mutt-config">
|
---|
357 | <primary sortas="e-AA.muttrc">~/.muttrc</primary>
|
---|
358 | </indexterm>
|
---|
359 |
|
---|
360 | <indexterm zone="mutt mutt-config">
|
---|
361 | <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
|
---|
362 | </indexterm>
|
---|
363 |
|
---|
364 | <indexterm zone="mutt mutt-config">
|
---|
365 | <primary sortas="e-AA.mime.types">~/.mime.types</primary>
|
---|
366 | </indexterm>
|
---|
367 |
|
---|
368 | </sect3>
|
---|
369 |
|
---|
370 | <sect3>
|
---|
371 | <title>Configuration Information</title>
|
---|
372 |
|
---|
373 | <para>
|
---|
374 | No changes in these files are necessary to begin using
|
---|
375 | <application>Mutt</application>. When you are ready to make changes,
|
---|
376 | the man page for <filename>muttrc</filename> is a good starting place.
|
---|
377 | </para>
|
---|
378 |
|
---|
379 | <para>
|
---|
380 | In order to utilize <application>GnuPG</application>, use the following
|
---|
381 | command:
|
---|
382 | </para>
|
---|
383 |
|
---|
384 | <screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc >> ~/.muttrc</userinput></screen>
|
---|
385 |
|
---|
386 | </sect3>
|
---|
387 |
|
---|
388 | </sect2>
|
---|
389 |
|
---|
390 | <sect2 role="content">
|
---|
391 | <title>Contents</title>
|
---|
392 |
|
---|
393 | <segmentedlist>
|
---|
394 | <segtitle>Installed Programs</segtitle>
|
---|
395 | <segtitle>Installed Libraries</segtitle>
|
---|
396 | <segtitle>Installed Directories</segtitle>
|
---|
397 |
|
---|
398 | <seglistitem>
|
---|
399 | <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
|
---|
400 | smime_keys</seg>
|
---|
401 | <seg>None</seg>
|
---|
402 | <seg>/usr/share/doc/mutt-&mutt-version;</seg>
|
---|
403 | </seglistitem>
|
---|
404 | </segmentedlist>
|
---|
405 |
|
---|
406 | <variablelist>
|
---|
407 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
408 | <?dbfo list-presentation="list"?>
|
---|
409 | <?dbhtml list-presentation="table"?>
|
---|
410 |
|
---|
411 | <varlistentry id="flea">
|
---|
412 | <term><command>flea</command></term>
|
---|
413 | <listitem>
|
---|
414 | <para>
|
---|
415 | is a script showing where to report bugs
|
---|
416 | </para>
|
---|
417 | <indexterm zone="mutt flea">
|
---|
418 | <primary sortas="b-flea">flea</primary>
|
---|
419 | </indexterm>
|
---|
420 | </listitem>
|
---|
421 | </varlistentry>
|
---|
422 |
|
---|
423 | <varlistentry id="mutt-prog">
|
---|
424 | <term><command>mutt</command></term>
|
---|
425 | <listitem>
|
---|
426 | <para>
|
---|
427 | is a Mail User Agent (MUA) which enables you to read, write
|
---|
428 | and delete your email
|
---|
429 | </para>
|
---|
430 | <indexterm zone="mutt mutt-prog">
|
---|
431 | <primary sortas="b-mutt">mutt</primary>
|
---|
432 | </indexterm>
|
---|
433 | </listitem>
|
---|
434 | </varlistentry>
|
---|
435 |
|
---|
436 | <varlistentry id="mutt_dotlock">
|
---|
437 | <term><command>mutt_dotlock</command></term>
|
---|
438 | <listitem>
|
---|
439 | <para>
|
---|
440 | implements the mail spool file lock
|
---|
441 | </para>
|
---|
442 | <indexterm zone="mutt mutt_dotlock">
|
---|
443 | <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
|
---|
444 | </indexterm>
|
---|
445 | </listitem>
|
---|
446 | </varlistentry>
|
---|
447 |
|
---|
448 | <varlistentry id="muttbug">
|
---|
449 | <term><command>muttbug</command></term>
|
---|
450 | <listitem>
|
---|
451 | <para>
|
---|
452 | is a script identical to <command>flea</command>
|
---|
453 | </para>
|
---|
454 | <indexterm zone="mutt muttbug">
|
---|
455 | <primary sortas="b-muttbug">muttbug</primary>
|
---|
456 | </indexterm>
|
---|
457 | </listitem>
|
---|
458 | </varlistentry>
|
---|
459 |
|
---|
460 | <varlistentry id="pgpewrap">
|
---|
461 | <term><command>pgpewrap</command></term>
|
---|
462 | <listitem>
|
---|
463 | <para>
|
---|
464 | prepares a command line for the <xref linkend="gnupg2"/> utilities
|
---|
465 | </para>
|
---|
466 | <indexterm zone="mutt pgpewrap">
|
---|
467 | <primary sortas="b-pgpewrap">pgpewrap</primary>
|
---|
468 | </indexterm>
|
---|
469 | </listitem>
|
---|
470 | </varlistentry>
|
---|
471 |
|
---|
472 | <varlistentry id="pgpring">
|
---|
473 | <term><command>pgpring</command></term>
|
---|
474 | <listitem>
|
---|
475 | <para>
|
---|
476 | is a key ring dumper for
|
---|
477 | <ulink url="http://www.pgp.com/">PGP</ulink>. It is not needed for
|
---|
478 | <xref linkend="gnupg2"/>
|
---|
479 | </para>
|
---|
480 | <indexterm zone="mutt pgpring">
|
---|
481 | <primary sortas="b-pgpring">pgpring</primary>
|
---|
482 | </indexterm>
|
---|
483 | </listitem>
|
---|
484 | </varlistentry>
|
---|
485 |
|
---|
486 | <varlistentry id="smime_keys">
|
---|
487 | <term><command>smime_keys</command></term>
|
---|
488 | <listitem>
|
---|
489 | <para>
|
---|
490 | manages a keystore for S/MIME certificates
|
---|
491 | </para>
|
---|
492 | <indexterm zone="mutt smime_keys">
|
---|
493 | <primary sortas="b-smime_keys">smime_keys</primary>
|
---|
494 | </indexterm>
|
---|
495 | </listitem>
|
---|
496 | </varlistentry>
|
---|
497 |
|
---|
498 | </variablelist>
|
---|
499 |
|
---|
500 | </sect2>
|
---|
501 |
|
---|
502 | </sect1>
|
---|