source: networking/mailnews/mutt.xml@ 6fd5c057

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 9.0 9.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 6fd5c057 was fb19657a, checked in by Ken Moffat <ken@…>, 5 years ago

tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22041 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 13.6 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 "http://ftp.mutt.org/pub/mutt/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 "f77586a895f12d19de9c5250a4dfd034">
10 <!ENTITY mutt-size "4.5 MB">
11 <!ENTITY mutt-buildsize "46 MB (add 6MB for the PDF manual)">
12 <!ENTITY mutt-time "0.4 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>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.</para>
35
36 &lfs90_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing='compact'>
40 <listitem>
41 <para>Download (HTTP): <ulink url="&mutt-download-http;"/></para>
42 </listitem>
43 <listitem>
44 <para>Download (FTP): <ulink url="&mutt-download-ftp;"/></para>
45 </listitem>
46 <listitem>
47 <para>Download MD5 sum: &mutt-md5sum;</para>
48 </listitem>
49 <listitem>
50 <para>Download size: &mutt-size;</para>
51 </listitem>
52 <listitem>
53 <para>Estimated disk space required: &mutt-buildsize;</para>
54 </listitem>
55 <listitem>
56 <para>Estimated build time: &mutt-time;</para>
57 </listitem>
58 </itemizedlist>
59
60 <!--<bridgehead renderas="sect3">Additional Downloads</bridgehead>
61 <itemizedlist spacing='compact'>
62 <listitem>
63 <para>Required patch: <ulink
64 url="&patch-root;/mutt-&mutt-version;-upstream_fixes-1.patch"/>
65 </para>
66 </listitem>
67 </itemizedlist>-->
68
69 <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
70
71 <bridgehead renderas="sect4">Optional</bridgehead>
72 <para role="optional">
73 <xref linkend="aspell"/>,
74 <xref linkend="cyrus-sasl"/>,
75 <xref linkend="gdb"/>,
76 <xref linkend="gnupg2"/>,
77 <xref linkend="gpgme"/>,
78 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>,
79 <xref linkend="libidn"/>,
80 <xref linkend="mitkrb"/>,
81 <ulink url="http://mixmaster.sourceforge.net/">Mixmaster</ulink>,
82 an <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
83 <xref linkend="slang"/>,
84 <xref linkend="gnutls"/>,
85 <xref linkend="db"/> or
86 <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
87 <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
88 </para>
89
90 <bridgehead renderas="sect4">Optional (To Regenerate HTML
91 Documentation)</bridgehead>
92 <para role="optional">
93 <xref linkend="libxslt"/> and either
94 <xref linkend="lynx"/>,
95 <ulink url="&w3m-url;">W3m</ulink>, or
96 <ulink url="&elinks-url;">ELinks</ulink>
97 </para>
98
99 <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
100 <para role="optional">
101 <xref linkend="docbook-dsssl"/>,
102 <xref linkend="openjade"/>, and
103 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/> with
104 <command>pdfjadetex</command> installed)
105 </para>
106
107 <para condition="html" role="usernotes">User Notes:
108 <ulink url="&blfs-wiki;/mutt"/></para>
109
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of Mutt</title>
114
115 <para><application>Mutt</application> requires a group named
116 <systemitem class="groupname">mail</systemitem>. You can
117 add this group, if it does not exist, with this command:</para>
118
119<screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
120
121 <para>If you did not install an <xref linkend="server-mail"/>, you need to
122 modify the ownership of <filename class="directory">/var/mail</filename>
123 with this command:</para>
124
125<screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
126
127 <para><application>Mutt</application> will rebuild the html documentation
128 if <application>libxslt</application> is present, then use that to update
129 the text manual - even if none of the specified browsers are present. That
130 will create an empty text file, so we will save the shipped file.
131 </para>
132
133 <para>Install <application>Mutt</application> by running the following
134 commands:</para>
135
136<screen><userinput>cp -v doc/manual.txt{,.shipped} &amp;&amp;
137./configure --prefix=/usr \
138 --sysconfdir=/etc \
139 --with-docdir=/usr/share/doc/mutt-&mutt-version; \
140 --with-ssl \
141 --enable-external-dotlock \
142 --enable-pop \
143 --enable-imap \
144 --enable-hcache \
145 --enable-sidebar &amp;&amp;
146make</userinput></screen>
147
148 <para>To generate the PDF manual with <xref linkend="texlive"/>, run
149 the following command:</para>
150
151<screen remap="doc"><userinput>make -C doc manual.pdf</userinput></screen>
152
153 <para>This package does not come with a test suite.</para>
154
155 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
156
157 <screen role='root'><userinput>make install &amp;&amp;
158test -s doc/manual.txt ||
159 install -v -m644 doc/manual.txt.shipped \
160 /usr/share/doc/mutt-&mutt-version;/manual.txt</userinput></screen>
161
162 <para>If you generated the PDF manual, install it
163 by issuing the following command as the
164 <systemitem class="username">root</systemitem> user:</para>
165
166<screen role='root' remap='doc'><userinput>install -v -m644 doc/manual.pdf \
167 /usr/share/doc/mutt-&mutt-version;</userinput></screen>
168
169 <note>
170 <para>
171 If you used a DESTDIR method to only install to a temporary location as
172 a regular user (as part of a package menagement process), you will need
173 to run the following as the <systemitem class="username">root</systemitem>
174 user after completing the real install:
175 </para>
176
177<screen role="nodump"><userinput>chown root:mail /usr/bin/mutt_dotlock &amp;&amp;
178chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
179
180 <para>
181 An info file is now installed, so you will also need to recreate the
182 <filename>/usr/share/info/dir</filename> as described when
183 <application>Texinfo</application> was installed in LFS.
184 </para>
185 </note>
186
187
188 </sect2>
189
190 <sect2 role="commands">
191 <title>Command Explanations</title>
192
193 <para><parameter>--enable-external-dotlock</parameter>: In some circumstances
194 the mutt-dotlock program is not created. This switch ensures it is always
195 created.</para>
196
197 <para><parameter>--enable-pop</parameter>: This switch enables
198 POP3 support.</para>
199
200 <para><parameter>--enable-imap</parameter>: This switch enables
201 IMAP support.</para>
202
203 <para><parameter>--enable-hcache</parameter>: This switch enables
204 header caching.</para>
205
206 <para><parameter>--enable-sidebar</parameter>: This switch enables support
207 for the sidebar (a list of mailboxes). It is off by default, but can be
208 turned on by <command>:set sidebar_visible</command> in mutt (and off again
209 with ':unset'), or it can be enabled in <filename>~/.muttrc</filename>.</para>
210
211 <para><parameter>--with-ssl</parameter>: This parameter adds SSL/TLS
212 support from openssl in POP3/IMAP/SMTP.</para>
213
214 <para><option>--enable-gpgme</option>: This switch enables GPG support
215 through the GPGME package. Use this switch if you want GPG support in
216 Mutt.</para>
217
218 <para><option>--enable-smtp</option>: This switch enables
219 SMTP relay support.</para>
220
221 <para><option>--with-idn2</option>: Use this parameter if both libidn and
222 libidn2 have been installed, and you wish to use libidn2 here.</para>
223
224 <para><option>--with-sasl</option>: This parameter adds
225 authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
226 if they are enabled. Depending on the server configuration, this may not
227 be needed for POP3 or IMAP. However, it is needed for SMTP
228 authentication.</para>
229
230 <!-- we do not normally list all possible switches. LFS installs ncurses.
231 <para><option>\-\-with-slang</option>: Use <application>S-Lang
232 </application> instead of <application>Ncurses</application>.</para> -->
233
234 <para><command>test -s doc/manual.txt || install -v -m644 doc/manual.txt.shipped ...</command>:
235 if the text manual is now empty (<application>libxslt</application> is
236 installed, but without any of the specified text browsers), install the
237 saved copy <emphasis>after</emphasis> running 'make install'
238 <emphasis>(which would itself empty manual.txt if the shipped file had
239 already been copied back)</emphasis>.</para>
240
241 </sect2>
242
243 <sect2 role="configuration">
244 <title>Configuring Mutt</title>
245
246 <sect3 id="mutt-config">
247 <title>Config Files</title>
248
249 <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
250 <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
251
252 <indexterm zone="mutt mutt-config">
253 <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
254 </indexterm>
255
256 <indexterm zone="mutt mutt-config">
257 <primary sortas="e-AA.muttrc">~/.muttrc</primary>
258 </indexterm>
259
260 <indexterm zone="mutt mutt-config">
261 <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
262 </indexterm>
263
264 <indexterm zone="mutt mutt-config">
265 <primary sortas="e-AA.mime.types">~/.mime.types</primary>
266 </indexterm>
267
268 </sect3>
269
270 <sect3>
271 <title>Configuration Information</title>
272
273 <para>No changes in these files are necessary to begin using
274 <application>Mutt</application>. When you are ready to make changes, the
275 man page for <filename>muttrc</filename> is a good starting place.</para>
276
277 <para>In order to utilize <application>GnuPG</application>, use the following
278 command:</para>
279
280<screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc &gt;&gt; ~/.muttrc</userinput></screen>
281
282 </sect3>
283
284 </sect2>
285
286 <sect2 role="content">
287 <title>Contents</title>
288
289 <segmentedlist>
290 <segtitle>Installed Programs</segtitle>
291 <segtitle>Installed Libraries</segtitle>
292 <segtitle>Installed Directories</segtitle>
293
294 <seglistitem>
295 <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
296 smime_keys</seg>
297 <seg>None</seg>
298 <seg>/usr/share/doc/mutt-&mutt-version;</seg>
299 </seglistitem>
300 </segmentedlist>
301
302 <variablelist>
303 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
304 <?dbfo list-presentation="list"?>
305 <?dbhtml list-presentation="table"?>
306
307 <varlistentry id="flea">
308 <term><command>flea</command></term>
309 <listitem>
310 <para>is a script showing where to report bugs.</para>
311 <indexterm zone="mutt flea">
312 <primary sortas="b-flea">flea</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="mutt-prog">
318 <term><command>mutt</command></term>
319 <listitem>
320 <para>is a Mail User Agent (MUA) which enables you to read, write
321 and delete your email.</para>
322 <indexterm zone="mutt mutt-prog">
323 <primary sortas="b-mutt">mutt</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="mutt_dotlock">
329 <term><command>mutt_dotlock</command></term>
330 <listitem>
331 <para>implements the mail spool file lock.</para>
332 <indexterm zone="mutt mutt_dotlock">
333 <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="muttbug">
339 <term><command>muttbug</command></term>
340 <listitem>
341 <para>is a script identical to <command>flea</command>.</para>
342 <indexterm zone="mutt muttbug">
343 <primary sortas="b-muttbug">muttbug</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="pgpewrap">
349 <term><command>pgpewrap</command></term>
350 <listitem>
351 <para>prepares a command line for the <xref linkend="gnupg2"/>
352 utilities.</para>
353 <indexterm zone="mutt pgpewrap">
354 <primary sortas="b-pgpewrap">pgpewrap</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="pgpring">
360 <term><command>pgpring</command></term>
361 <listitem>
362 <para>is a key ring dumper for <ulink
363 url="http://www.pgp.com/">PGP</ulink>. It is not needed for
364 <xref linkend="gnupg2"/>.</para>
365 <indexterm zone="mutt pgpring">
366 <primary sortas="b-pgpring">pgpring</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="smime_keys">
372 <term><command>smime_keys</command></term>
373 <listitem>
374 <para>manages a keystore for S/MIME certificates.</para>
375 <indexterm zone="mutt smime_keys">
376 <primary sortas="b-smime_keys">smime_keys</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 </variablelist>
382
383 </sect2>
384
385</sect1>
Note: See TracBrowser for help on using the repository browser.