source: networking/mailnews/mutt.xml@ 17aa21c

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 17aa21c was 17aa21c, checked in by Xi Ruoyao <xry111@…>, 15 months ago

Change all http://*.sourceforge.net/ URLs to https

Now all sourceforge.net subdomains have a valid SSL certificate. The
changes are automatically done via a sed. I've reviewed the changes and
reverted the changes in archive/*, pst/xml/docbook-xsl.xml, and
stylesheets/lfs-xsl/lfs-l10n.xml. Other changes should (hopefully) be
fine.

  • 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 "14cbaec4cc88ad8147fbe6df8a2d48fd">
10 <!ENTITY mutt-size "5.3 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
19 <title>Mutt-&mutt-version;</title>
20
21 <indexterm zone="mutt">
22 <primary sortas="a-mutt">mutt</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Mutt</title>
27
28 <para>
29 The <application>Mutt</application> package contains a Mail User
30 Agent. This is useful for reading, writing, replying to, saving, and
31 deleting your email.
32 </para>
33
34 &lfs112_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing='compact'>
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&mutt-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&mutt-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &mutt-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &mutt-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &mutt-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &mutt-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70<!--<bridgehead renderas="sect3">Additional Downloads</bridgehead>
71 <itemizedlist spacing='compact'>
72 <listitem>
73 <para>
74 Required patch: <ulink
75 url="&patch-root;/mutt-&mutt-version;-memleak-1.patch"/>
76 </para>
77 </listitem>
78 </itemizedlist>-->
79
80 <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
81
82 <bridgehead renderas="sect4">Recommended (for a text version of the manual)</bridgehead>
83 <para role="recommended">
84 <xref linkend="lynx"/>, or
85 <xref linkend="Links"/> (or
86 <ulink url="&w3m-url;">W3m</ulink>, or
87 <ulink url="&elinks-url;">ELinks</ulink>) - please read the Note.
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref linkend="aspell"/>,
93 <xref linkend="cyrus-sasl"/>,
94 <xref linkend="docbook-utils"/>,
95 <xref linkend="gdb"/>,
96 <xref linkend="gnupg2"/>,
97 <xref linkend="gnutls"/>,
98 <xref linkend="gpgme"/>,
99 <xref linkend="libidn"/>,
100 <xref linkend="mitkrb"/>,
101 an <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
102 <xref linkend="slang"/>,
103 <xref linkend="sqlite"/>,
104 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>,
105 <ulink url="https://mixmaster.sourceforge.net/">Mixmaster</ulink>,
106 <!-- from configure: \-\-with-bdb[=DIR] Use BerkeleyDB4 if gdbm is not
107 available but gdbm is installed in LFS, so do not mention BerkeleyDB
108 <xref linkend="db"/> or -->
109 <ulink url="https://dbmx.net/qdbm/">QDBM</ulink> or
110 <ulink url="https://dbmx.net/tokyocabinet/">Tokyo Cabinet</ulink>
111 </para>
112
113<!--<bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
114 <para role="optional">
115 <xref linkend="docbook-dsssl"/>,
116 <xref linkend="openjade"/>, and
117 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/> with
118 <command>pdfjadetex</command> installed)
119 </para>-->
120
121 <para condition="html" role="usernotes">User Notes:
122 <ulink url="&blfs-wiki;/mutt"/></para>
123
124 </sect2>
125
126 <sect2 role="installation">
127 <title>Installation of Mutt</title>
128
129 <note>
130 <para>
131 <application>Mutt</application> ships with an HTML version of its
132 manual, but the text version is no longer provided because differences
133 in the formatting from different text browsers compared to the shipped
134 version caused complaints. To get a text file, the following are used
135 in order of preference: <application>lynx</application> with overstriking
136 (backspaces) for emphasis, <application>w3m</application> or
137 <application>elinks</application>: the latter two apparently provide
138 plain text. Plain text is generally preferred unless reading the HTML
139 manual, so the instructions below use <application>lynx</application>
140 if available, or else <application>links</application> to produce plain
141 text.
142 </para>
143 </note>
144
145 <para>
146 <application>Mutt</application> requires a group named
147 <systemitem class="groupname">mail</systemitem>. You can
148 add this group, if it does not exist, with this command:
149 </para>
150
151<screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
152
153 <para>
154 If you did not install an <xref linkend="server-mail"/>, you need to
155 modify the ownership of <filename class="directory">/var/mail</filename>
156 with this command:
157 </para>
158
159<screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
160
161 <para>
162 Install <application>Mutt</application> by running the following
163 commands:
164 </para>
165
166<!--<para>
167 First apply the patch to prevent a memory leak:
168 </para>
169
170<screen><userinput>patch -Np1 -i ../mutt-&mutt-version;-memleak-1.patch</userinput></screen>-->
171
172 <para>
173 To ensure that a plain text manual is created when using
174 <application>lynx</application> or to otherwise use
175 <application>links</application> to produce it (instead of
176 <application>elinks</application>), run the following command:
177 </para>
178
179<screen><userinput>sed -e 's/ -with_backspaces//' \
180 -e 's/elinks/links/' \
181 -e 's/-no-numbering -no-references//' \
182 -i 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 management 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, mutt_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="mutt_pgpring">
471 <term><command>pgpring</command></term>
472 <listitem>
473 <para>
474 is a key ring dumper for
475 <ulink url="https://www.openpgp.org/about/">PGP</ulink>. It is not
476 needed for <xref linkend="gnupg2"/>
477 </para>
478 <indexterm zone="mutt mutt_pgpring">
479 <primary sortas="b-mutt_pgpring">mutt_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.