source: networking/mailnews/mutt.xml@ 75e3e09

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 xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since 75e3e09 was 75e3e09, checked in by Xi Ruoyao <xry111@…>, 20 months ago

networking: URL update

Also change all "http://sphinx-doc.org" to "https://www.sphinx-doc.org".
Without "www." I get a connection time out for some reason...

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