source: networking/mailnews/mutt.xml@ 07b1366e

10.0 10.1 11.0 11.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 07b1366e was 07b1366e, checked in by Ken Moffat <ken@…>, 5 years ago

mutt-1.9.0

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19201 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 12.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 " ">
8 <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/pub/mutt/mutt-&mutt-version;.tar.gz">
9 <!ENTITY mutt-md5sum "6ae8c1691bbad562a8b46618207f07c2">
10 <!ENTITY mutt-size "4.0 MB">
11 <!ENTITY mutt-buildsize "39 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 &lfs81_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="openssl"/> or
85 <xref linkend="gnutls"/>,
86 <xref linkend="db"/> or
87 <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
88 <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
89 </para>
90
91 <bridgehead renderas="sect4">Optional (To Regenerate HTML
92 Documentation)</bridgehead>
93 <para role="optional">
94 <xref linkend="libxslt"/> and either
95 <xref linkend="lynx"/>,
96 <xref linkend="w3m"/>, or
97 <ulink url="http://elinks.or.cz/">ELinks</ulink>
98 </para>
99
100 <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
101 <para role="optional">
102 <xref linkend="docbook-dsssl"/>,
103 <xref linkend="openjade"/>, and
104 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
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 --enable-external-dotlock \
141 --enable-pop \
142 --enable-imap \
143 --enable-hcache \
144 --enable-sidebar &amp;&amp;
145make &amp;&amp;
146test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</userinput></screen>
147
148 <para>To generate the PDF manual with <xref linkend="texlive"/>, run
149 the following command:</para>
150
151<screen><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</userinput></screen>
158
159 <para>If you generated the PDF manual, install it
160 by issuing the following command as the
161 <systemitem class="username">root</systemitem> user:</para>
162
163<screen role='root'><userinput>install -v -m644 doc/manual.pdf \
164 /usr/share/doc/mutt-&mutt-version;</userinput></screen>
165
166 <note>
167 <para>
168 If you used a DESTDIR method to only install to a temporary location as
169 a regular user (as part of a package menagement process), you will need
170 to run the following as the <systemitem class="username">root</systemitem>
171 user after completing the real install:
172 </para>
173
174<screen role="nodump"><userinput>chown root:mail /usr/bin/mutt_dotlock &amp;&amp;
175chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
176 </note>
177
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para><parameter>--enable-external-dotlock</parameter>: In some circumstances
185 the mutt-dotlock program is not created. This switch ensures it is always
186 created.</para>
187
188 <para><parameter>--enable-pop</parameter>: This switch enables
189 POP3 support.</para>
190
191 <para><parameter>--enable-imap</parameter>: This switch enables
192 IMAP support.</para>
193
194 <para><parameter>--enable-hcache</parameter>: This switch enables
195 header caching.</para>
196
197 <para><parameter>--enable-sidebar</parameter>: This switch enables support
198 for the sidebar (a list of mailboxes). It is off by default, but can be
199 turned on by <command>:set sidebar_visible</command> in mutt (and off again
200 with ':unset'), or it can be enabled in <filename>~/.muttrc</filename>.</para>
201
202 <para><option>--enable-smtp</option>: This switch enables
203 SMTP relay support.</para>
204
205 <para><option>--with-ssl</option>: This parameter adds SSL/TLS
206 support from <xref linkend="openssl"/> in POP3/IMAP/SMTP if they are
207 enabled.</para>
208
209 <para><option>--with-sasl</option>: This parameter adds
210 authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
211 if they are enabled. Depending on the server configuration, this may not
212 be needed for POP3 or IMAP. However, it is needed for SMTP
213 authentication.</para>
214
215 <!-- we do not normally list all possible switches. LFS installs ncurses.
216 <para><option>\-\-with-slang</option>: Use <application>S-Lang
217 </application> instead of <application>Ncurses</application>.</para> -->
218
219 <para><command>test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</command>:
220 if the text manual is now empty (<application>libxslt</application> is
221 installed, but without any of the specified text browsers), restore it
222 from the copy.</para>
223
224 </sect2>
225
226 <sect2 role="configuration">
227 <title>Configuring Mutt</title>
228
229 <sect3 id="mutt-config">
230 <title>Config Files</title>
231
232 <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
233 <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
234
235 <indexterm zone="mutt mutt-config">
236 <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
237 </indexterm>
238
239 <indexterm zone="mutt mutt-config">
240 <primary sortas="e-AA.muttrc">~/.muttrc</primary>
241 </indexterm>
242
243 <indexterm zone="mutt mutt-config">
244 <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
245 </indexterm>
246
247 <indexterm zone="mutt mutt-config">
248 <primary sortas="e-AA.mime.types">~/.mime.types</primary>
249 </indexterm>
250
251 </sect3>
252
253 <sect3>
254 <title>Configuration Information</title>
255
256 <para>No changes in these files are necessary to begin using
257 <application>Mutt</application>. When you are ready to make changes, the
258 man page for <filename>muttrc</filename> is a good starting place.</para>
259
260 <para>In order to utilize <application>GnuPG</application>, use the following
261 command:</para>
262
263<screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc &gt;&gt; ~/.muttrc</userinput></screen>
264
265 </sect3>
266
267 </sect2>
268
269 <sect2 role="content">
270 <title>Contents</title>
271
272 <segmentedlist>
273 <segtitle>Installed Programs</segtitle>
274 <segtitle>Installed Libraries</segtitle>
275 <segtitle>Installed Directories</segtitle>
276
277 <seglistitem>
278 <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
279 smime_keys</seg>
280 <seg>None</seg>
281 <seg>/usr/share/doc/mutt-&mutt-version;</seg>
282 </seglistitem>
283 </segmentedlist>
284
285 <variablelist>
286 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
287 <?dbfo list-presentation="list"?>
288 <?dbhtml list-presentation="table"?>
289
290 <varlistentry id="flea">
291 <term><command>flea</command></term>
292 <listitem>
293 <para>is a bug submitter for <application>Mutt</application>.</para>
294 <indexterm zone="mutt flea">
295 <primary sortas="b-flea">flea</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 <varlistentry id="mutt-prog">
301 <term><command>mutt</command></term>
302 <listitem>
303 <para>is a Mail User Agent (MUA) which enables you to read, write
304 and delete your email.</para>
305 <indexterm zone="mutt mutt-prog">
306 <primary sortas="b-mutt">mutt</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="mutt_dotlock">
312 <term><command>mutt_dotlock</command></term>
313 <listitem>
314 <para>implements the mail spool file lock.</para>
315 <indexterm zone="mutt mutt_dotlock">
316 <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="muttbug">
322 <term><command>muttbug</command></term>
323 <listitem>
324 <para>is a script that executes <command>flea</command>.</para>
325 <indexterm zone="mutt muttbug">
326 <primary sortas="b-muttbug">muttbug</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="pgpewrap">
332 <term><command>pgpewrap</command></term>
333 <listitem>
334 <para>prepares a command line for the <xref linkend="gnupg2"/>
335 utilities.</para>
336 <indexterm zone="mutt pgpewrap">
337 <primary sortas="b-pgpewrap">pgpewrap</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="pgpring">
343 <term><command>pgpring</command></term>
344 <listitem>
345 <para>is a key ring dumper for <ulink
346 url="http://www.pgp.com/">PGP</ulink>. It is not needed for
347 <xref linkend="gnupg2"/>.</para>
348 <indexterm zone="mutt pgpring">
349 <primary sortas="b-pgpring">pgpring</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="smime_keys">
355 <term><command>smime_keys</command></term>
356 <listitem>
357 <para>manages a keystore for S/MIME certificates.</para>
358 <indexterm zone="mutt smime_keys">
359 <primary sortas="b-smime_keys">smime_keys</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 </variablelist>
365
366 </sect2>
367
368</sect1>
Note: See TracBrowser for help on using the repository browser.