source: networking/mailnews/mutt.xml@ ce6806c

10.1 11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since ce6806c was ce6806c, checked in by Ken Moffat <ken@…>, 21 months ago

A few tags.

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

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