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

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules 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 17c023d9 was 17c023d9, checked in by Ken Moffat <ken@…>, 6 years ago

mutt-1.9.5

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20111 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 13.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 " ">
8 <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/pub/mutt/mutt-&mutt-version;.tar.gz">
9 <!ENTITY mutt-md5sum "9694baaa9cbfb033334efb5f4d830ad4">
10 <!ENTITY mutt-size "4.1 MB">
11 <!ENTITY mutt-buildsize "40 MB (plus a further 5MB for the PDF manual)">
12 <!ENTITY mutt-time "0.3 SBU (plus a further 0.2 SBU to build 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 &lfs82_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 <xref linkend="w3m"/>, or
96 <ulink url="http://elinks.or.cz/">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"/>)
104 </para>
105
106 <para condition="html" role="usernotes">User Notes:
107 <ulink url="&blfs-wiki;/mutt"/></para>
108
109 </sect2>
110
111 <sect2 role="installation">
112 <title>Installation of Mutt</title>
113
114 <para><application>Mutt</application> requires a group named
115 <systemitem class="groupname">mail</systemitem>. You can
116 add this group, if it does not exist, with this command:</para>
117
118<screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
119
120 <para>If you did not install an <xref linkend="server-mail"/>, you need to
121 modify the ownership of <filename class="directory">/var/mail</filename>
122 with this command:</para>
123
124<screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
125
126 <para><application>Mutt</application> will rebuild the html documentation
127 if <application>libxslt</application> is present, then use that to update
128 the text manual - even if none of the specified browsers are present. That
129 will create an empty text file, so we will save the shipped file.
130 </para>
131
132 <para>Install <application>Mutt</application> by running the following
133 commands:</para>
134
135<screen><userinput>cp -v doc/manual.txt{,.shipped} &amp;&amp;
136./configure --prefix=/usr \
137 --sysconfdir=/etc \
138 --with-docdir=/usr/share/doc/mutt-&mutt-version; \
139 --with-ssl \
140 --enable-external-dotlock \
141 --enable-pop \
142 --enable-imap \
143 --enable-hcache \
144 --enable-sidebar &amp;&amp;
145make &amp;&amp;</userinput></screen>
146
147 <para>To generate the PDF manual with <xref linkend="texlive"/>, run
148 the following command:</para>
149
150<screen><userinput>make -C doc manual.pdf</userinput></screen>
151
152 <para>This package does not come with a test suite.</para>
153
154 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
155
156 <screen role='root'><userinput>
157make 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'><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 </note>
180
181
182 </sect2>
183
184 <sect2 role="commands">
185 <title>Command Explanations</title>
186
187 <para><parameter>--enable-external-dotlock</parameter>: In some circumstances
188 the mutt-dotlock program is not created. This switch ensures it is always
189 created.</para>
190
191 <para><parameter>--enable-pop</parameter>: This switch enables
192 POP3 support.</para>
193
194 <para><parameter>--enable-imap</parameter>: This switch enables
195 IMAP support.</para>
196
197 <para><parameter>--enable-hcache</parameter>: This switch enables
198 header caching.</para>
199
200 <para><parameter>--enable-sidebar</parameter>: This switch enables support
201 for the sidebar (a list of mailboxes). It is off by default, but can be
202 turned on by <command>:set sidebar_visible</command> in mutt (and off again
203 with ':unset'), or it can be enabled in <filename>~/.muttrc</filename>.</para>
204
205 <para><parameter>--with-ssl</parameter>: This parameter adds SSL/TLS
206 support from openssl in POP3/IMAP/SMTP.</para>
207
208 <para><option>--enable-smtp</option>: This switch enables
209 SMTP relay support.</para>
210
211 <para><option>--with-sasl</option>: This parameter adds
212 authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
213 if they are enabled. Depending on the server configuration, this may not
214 be needed for POP3 or IMAP. However, it is needed for SMTP
215 authentication.</para>
216
217 <!-- we do not normally list all possible switches. LFS installs ncurses.
218 <para><option>\-\-with-slang</option>: Use <application>S-Lang
219 </application> instead of <application>Ncurses</application>.</para> -->
220
221 <para><command>test -s doc/manual.txt || install -v -m644 doc/manual.txt.shipped ...</command>:
222 if the text manual is now empty (<application>libxslt</application> is
223 installed, but without any of the specified text browsers), install the
224 saved copy <emphasis>after</emphasis> running 'make install'
225 <emphasis>(which would itself empty manual.txt if the shipped file had
226 already been copied back)</emphasis>.</para>
227
228 </sect2>
229
230 <sect2 role="configuration">
231 <title>Configuring Mutt</title>
232
233 <sect3 id="mutt-config">
234 <title>Config Files</title>
235
236 <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
237 <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
238
239 <indexterm zone="mutt mutt-config">
240 <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
241 </indexterm>
242
243 <indexterm zone="mutt mutt-config">
244 <primary sortas="e-AA.muttrc">~/.muttrc</primary>
245 </indexterm>
246
247 <indexterm zone="mutt mutt-config">
248 <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
249 </indexterm>
250
251 <indexterm zone="mutt mutt-config">
252 <primary sortas="e-AA.mime.types">~/.mime.types</primary>
253 </indexterm>
254
255 </sect3>
256
257 <sect3>
258 <title>Configuration Information</title>
259
260 <para>No changes in these files are necessary to begin using
261 <application>Mutt</application>. When you are ready to make changes, the
262 man page for <filename>muttrc</filename> is a good starting place.</para>
263
264 <para>In order to utilize <application>GnuPG</application>, use the following
265 command:</para>
266
267<screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc &gt;&gt; ~/.muttrc</userinput></screen>
268
269 </sect3>
270
271 </sect2>
272
273 <sect2 role="content">
274 <title>Contents</title>
275
276 <segmentedlist>
277 <segtitle>Installed Programs</segtitle>
278 <segtitle>Installed Libraries</segtitle>
279 <segtitle>Installed Directories</segtitle>
280
281 <seglistitem>
282 <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
283 smime_keys</seg>
284 <seg>None</seg>
285 <seg>/usr/share/doc/mutt-&mutt-version;</seg>
286 </seglistitem>
287 </segmentedlist>
288
289 <variablelist>
290 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
291 <?dbfo list-presentation="list"?>
292 <?dbhtml list-presentation="table"?>
293
294 <varlistentry id="flea">
295 <term><command>flea</command></term>
296 <listitem>
297 <para>is a script showing where to report bugs.</para>
298 <indexterm zone="mutt flea">
299 <primary sortas="b-flea">flea</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="mutt-prog">
305 <term><command>mutt</command></term>
306 <listitem>
307 <para>is a Mail User Agent (MUA) which enables you to read, write
308 and delete your email.</para>
309 <indexterm zone="mutt mutt-prog">
310 <primary sortas="b-mutt">mutt</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="mutt_dotlock">
316 <term><command>mutt_dotlock</command></term>
317 <listitem>
318 <para>implements the mail spool file lock.</para>
319 <indexterm zone="mutt mutt_dotlock">
320 <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="muttbug">
326 <term><command>muttbug</command></term>
327 <listitem>
328 <para>is a script identical to <command>flea</command>.</para>
329 <indexterm zone="mutt muttbug">
330 <primary sortas="b-muttbug">muttbug</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="pgpewrap">
336 <term><command>pgpewrap</command></term>
337 <listitem>
338 <para>prepares a command line for the <xref linkend="gnupg2"/>
339 utilities.</para>
340 <indexterm zone="mutt pgpewrap">
341 <primary sortas="b-pgpewrap">pgpewrap</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="pgpring">
347 <term><command>pgpring</command></term>
348 <listitem>
349 <para>is a key ring dumper for <ulink
350 url="http://www.pgp.com/">PGP</ulink>. It is not needed for
351 <xref linkend="gnupg2"/>.</para>
352 <indexterm zone="mutt pgpring">
353 <primary sortas="b-pgpring">pgpring</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="smime_keys">
359 <term><command>smime_keys</command></term>
360 <listitem>
361 <para>manages a keystore for S/MIME certificates.</para>
362 <indexterm zone="mutt smime_keys">
363 <primary sortas="b-smime_keys">smime_keys</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 </variablelist>
369
370 </sect2>
371
372</sect1>
Note: See TracBrowser for help on using the repository browser.