source: networking/mailnews/mutt.xml@ c1f025f3

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since c1f025f3 was c1f025f3, checked in by Ken Moffat <ken@…>, 4 years ago

fetchmail-6.4.3,
mutt-1.13.5.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22972 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 14.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 "86f6f3e55f3af32ea55ce64da799b784">
10 <!ENTITY mutt-size "4.7 MB">
11 <!ENTITY mutt-buildsize "48 MB (add 6MB for the PDF manual)">
12 <!ENTITY mutt-time "0.3 SBU (add 0.2 SBU for the PDF manual)">
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">Optional</bridgehead>
87 <para role="optional">
88 <xref linkend="aspell"/>,
89 <xref linkend="cyrus-sasl"/>,
90 <xref linkend="gdb"/>,
91 <xref linkend="gnupg2"/>,
92 <xref linkend="gnutls"/>,
93 <xref linkend="gpgme"/>,
94 <xref linkend="libidn"/>,
95 <xref linkend="mitkrb"/>,
96 an <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
97 <xref linkend="slang"/>,
98 <xref linkend="sqlite"/>,
99 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>,
100 <ulink url="http://mixmaster.sourceforge.net/">Mixmaster</ulink>,
101 <!-- from configure: \-\-with-bdb[=DIR] Use BerkeleyDB4 if gdbm is not
102 available but gdbm is installed in LFS, so do not mention BerkeleyDB
103 <xref linkend="db"/> or -->
104 <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
105 <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
106 </para>
107
108 <bridgehead renderas="sect4">Optional (To Regenerate HTML
109 Documentation)</bridgehead>
110 <para role="optional">
111 <xref linkend="libxslt"/> and either
112 <xref linkend="lynx"/>,
113 <ulink url="&w3m-url;">W3m</ulink>, or
114 <ulink url="&elinks-url;">ELinks</ulink>
115 </para>
116
117 <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
118 <para role="optional">
119 <xref linkend="docbook-dsssl"/>,
120 <xref linkend="openjade"/>, and
121 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/> with
122 <command>pdfjadetex</command> installed)
123 </para>
124
125 <para condition="html" role="usernotes">User Notes:
126 <ulink url="&blfs-wiki;/mutt"/></para>
127
128 </sect2>
129
130 <sect2 role="installation">
131 <title>Installation of Mutt</title>
132
133 <para>
134 <application>Mutt</application> requires a group named
135 <systemitem class="groupname">mail</systemitem>. You can
136 add this group, if it does not exist, with this command:
137 </para>
138
139<screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
140
141 <para>
142 If you did not install an <xref linkend="server-mail"/>, you need to
143 modify the ownership of <filename class="directory">/var/mail</filename>
144 with this command:
145 </para>
146
147<screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
148
149 <para>
150 <application>Mutt</application> will rebuild the html documentation
151 if <application>libxslt</application> is present, then use that to update
152 the text manual - even if none of the specified browsers are present. That
153 will create an empty text file, so we will save the shipped file.
154 </para>
155
156 <para>
157 Install <application>Mutt</application> by running the following
158 commands:
159 </para>
160
161<screen><userinput>cp -v doc/manual.txt{,.shipped} &amp;&amp;
162./configure --prefix=/usr \
163 --sysconfdir=/etc \
164 --with-docdir=/usr/share/doc/mutt-&mutt-version; \
165 --with-ssl \
166 --enable-external-dotlock \
167 --enable-pop \
168 --enable-imap \
169 --enable-hcache \
170 --enable-sidebar &amp;&amp;
171make</userinput></screen>
172
173 <para>
174 To generate the PDF manual with <xref linkend="texlive"/>, run
175 the following command:
176 </para>
177
178<screen remap="doc"><userinput>make -C doc manual.pdf</userinput></screen>
179
180 <para>
181 This package does not come with a test suite.
182 </para>
183
184 <para>
185 Now, as the <systemitem class="username">root</systemitem> user:
186 </para>
187
188 <screen role='root'><userinput>make install &amp;&amp;
189test -s doc/manual.txt ||
190 install -v -m644 doc/manual.txt.shipped \
191 /usr/share/doc/mutt-&mutt-version;/manual.txt</userinput></screen>
192
193 <para>
194 If you generated the PDF manual, install it
195 by issuing the following command as the
196 <systemitem class="username">root</systemitem> user:
197 </para>
198
199<screen role='root' remap='doc'><userinput>install -v -m644 doc/manual.pdf \
200 /usr/share/doc/mutt-&mutt-version;</userinput></screen>
201
202 <note>
203 <para>
204 If you used a DESTDIR method to only install to a temporary location as
205 a regular user (as part of a package menagement process), you will need
206 to run the following as the <systemitem class="username">root
207 </systemitem> user after completing the real install:
208 </para>
209
210<screen role="nodump"><userinput>chown root:mail /usr/bin/mutt_dotlock &amp;&amp;
211chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
212
213 <para>
214 An info file is now installed, so you will also need to recreate the
215 <filename>/usr/share/info/dir</filename> as described when
216 <application>Texinfo</application> was installed in LFS.
217 </para>
218 </note>
219
220
221 </sect2>
222
223 <sect2 role="commands">
224 <title>Command Explanations</title>
225
226 <para>
227 <parameter>--enable-external-dotlock</parameter>: In some circumstances
228 the mutt-dotlock program is not created. This switch ensures it is always
229 created.
230 </para>
231
232 <para>
233 <parameter>--enable-pop</parameter>: This switch enables POP3 support.
234 </para>
235
236 <para>
237 <parameter>--enable-imap</parameter>: This switch enables IMAP support.
238 </para>
239
240 <para>
241 <parameter>--enable-hcache</parameter>: This switch enables
242 header caching.
243 </para>
244
245 <para>
246 <parameter>--enable-sidebar</parameter>: This switch enables support
247 for the sidebar (a list of mailboxes). It is off by default, but can be
248 turned on by <command>:set sidebar_visible</command> in mutt (and off
249 again with ':unset'), or it can be enabled in <filename>
250 ~/.muttrc</filename>.
251 </para>
252
253 <para>
254 <parameter>--with-ssl</parameter>: This parameter adds SSL/TLS
255 support from openssl in POP3/IMAP/SMTP.
256 </para>
257
258 <para>
259 <option>--enable-autocrypt --with-sqlite3</option>: These two
260 switches add support for passive protection against data collection,
261 using gnupg and gpgme (gpgme is enabled by autocrypt). See <ulink
262 url="http://www.mutt.org/doc/manual/#autocryptdoc">The Manual</ulink>.
263 </para>
264
265 <para>
266 <option>--enable-gpgme</option>: This switch enables GPG support
267 through the GPGME package. Use this switch if you want GPG support in
268 Mutt.
269 </para>
270
271 <para>
272 <option>--enable-smtp</option>: This switch enables
273 SMTP relay support.
274 </para>
275
276 <para>
277 <option>--with-idn2</option>: Use this parameter if both libidn and
278 libidn2 have been installed, and you wish to use libidn2 here.
279 </para>
280
281 <para>
282 <option>--with-sasl</option>: This parameter adds authentication support
283 from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP if they are enabled.
284 Depending on the server configuration, this may not be needed for POP3
285 or IMAP. However, it is needed for SMTP authentication.
286 </para>
287
288 <!-- we do not normally list all possible switches. LFS installs ncurses.
289 <para>
290 <option>\-\-with-slang</option>: Use <application>S-Lang
291 </application> instead of <application>Ncurses</application>.
292 </para> -->
293
294 <para>
295 <command>test -s doc/manual.txt || install -v -m644 doc/manual.txt.shipped ...</command>:
296 if the text manual is now empty (<application>libxslt</application> is
297 installed, but without any of the specified text browsers), install the
298 saved copy <emphasis>after</emphasis> running 'make install'
299 <emphasis>(which would itself empty manual.txt if the shipped file had
300 already been copied back)</emphasis>.
301 </para>
302
303 </sect2>
304
305 <sect2 role="configuration">
306 <title>Configuring Mutt</title>
307
308 <sect3 id="mutt-config">
309 <title>Config Files</title>
310
311 <para>
312 <filename>/etc/Muttrc</filename>,
313 <filename>~/.muttrc</filename>,
314 <filename>/etc/mime.types</filename>, and
315 <filename>~/.mime.types</filename>
316 </para>
317
318 <indexterm zone="mutt mutt-config">
319 <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
320 </indexterm>
321
322 <indexterm zone="mutt mutt-config">
323 <primary sortas="e-AA.muttrc">~/.muttrc</primary>
324 </indexterm>
325
326 <indexterm zone="mutt mutt-config">
327 <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
328 </indexterm>
329
330 <indexterm zone="mutt mutt-config">
331 <primary sortas="e-AA.mime.types">~/.mime.types</primary>
332 </indexterm>
333
334 </sect3>
335
336 <sect3>
337 <title>Configuration Information</title>
338
339 <para>
340 No changes in these files are necessary to begin using
341 <application>Mutt</application>. When you are ready to make changes,
342 the man page for <filename>muttrc</filename> is a good starting place.
343 </para>
344
345 <para>
346 In order to utilize <application>GnuPG</application>, use the following
347 command:
348 </para>
349
350<screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc &gt;&gt; ~/.muttrc</userinput></screen>
351
352 </sect3>
353
354 </sect2>
355
356 <sect2 role="content">
357 <title>Contents</title>
358
359 <segmentedlist>
360 <segtitle>Installed Programs</segtitle>
361 <segtitle>Installed Libraries</segtitle>
362 <segtitle>Installed Directories</segtitle>
363
364 <seglistitem>
365 <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
366 smime_keys</seg>
367 <seg>None</seg>
368 <seg>/usr/share/doc/mutt-&mutt-version;</seg>
369 </seglistitem>
370 </segmentedlist>
371
372 <variablelist>
373 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
374 <?dbfo list-presentation="list"?>
375 <?dbhtml list-presentation="table"?>
376
377 <varlistentry id="flea">
378 <term><command>flea</command></term>
379 <listitem>
380 <para>
381 is a script showing where to report bugs.
382 </para>
383 <indexterm zone="mutt flea">
384 <primary sortas="b-flea">flea</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="mutt-prog">
390 <term><command>mutt</command></term>
391 <listitem>
392 <para>
393 is a Mail User Agent (MUA) which enables you to read, write
394 and delete your email.
395 </para>
396 <indexterm zone="mutt mutt-prog">
397 <primary sortas="b-mutt">mutt</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="mutt_dotlock">
403 <term><command>mutt_dotlock</command></term>
404 <listitem>
405 <para>
406 implements the mail spool file lock.
407 </para>
408 <indexterm zone="mutt mutt_dotlock">
409 <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="muttbug">
415 <term><command>muttbug</command></term>
416 <listitem>
417 <para>
418 is a script identical to <command>flea</command>.
419 </para>
420 <indexterm zone="mutt muttbug">
421 <primary sortas="b-muttbug">muttbug</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="pgpewrap">
427 <term><command>pgpewrap</command></term>
428 <listitem>
429 <para>
430 prepares a command line for the <xref linkend="gnupg2"/> utilities.
431 </para>
432 <indexterm zone="mutt pgpewrap">
433 <primary sortas="b-pgpewrap">pgpewrap</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="pgpring">
439 <term><command>pgpring</command></term>
440 <listitem>
441 <para>
442 is a key ring dumper for <ulink
443 url="http://www.pgp.com/">PGP</ulink>. It is not needed for
444 <xref linkend="gnupg2"/>.
445 </para>
446 <indexterm zone="mutt pgpring">
447 <primary sortas="b-pgpring">pgpring</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="smime_keys">
453 <term><command>smime_keys</command></term>
454 <listitem>
455 <para>
456 manages a keystore for S/MIME certificates.
457 </para>
458 <indexterm zone="mutt smime_keys">
459 <primary sortas="b-smime_keys">smime_keys</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 </variablelist>
465
466 </sect2>
467
468</sect1>
Note: See TracBrowser for help on using the repository browser.