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://downloads.sourceforge.net/mutt/mutt-&mutt-version;.tar.gz">
|
---|
8 | <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/mutt/devel/mutt-&mutt-version;.tar.gz">
|
---|
9 | <!ENTITY mutt-md5sum "49387458be0cb52b85ae0d73af699aae">
|
---|
10 | <!ENTITY mutt-size "3.5 MB">
|
---|
11 | <!ENTITY mutt-buildsize "25.4 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 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Mutt-&mutt-version;</title>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to Mutt</title>
|
---|
27 |
|
---|
28 | <para>The <application>Mutt</application> package contains a Mail User
|
---|
29 | Agent. This is useful for reading, writing, replying to, saving, and
|
---|
30 | deleting your email.</para>
|
---|
31 |
|
---|
32 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
33 | <itemizedlist spacing='compact'>
|
---|
34 | <listitem>
|
---|
35 | <para>Download (HTTP): <ulink url="&mutt-download-http;"/></para>
|
---|
36 | </listitem>
|
---|
37 | <listitem>
|
---|
38 | <para>Download (FTP): <ulink url="&mutt-download-ftp;"/></para>
|
---|
39 | </listitem>
|
---|
40 | <listitem>
|
---|
41 | <para>Download MD5 sum: &mutt-md5sum;</para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>Download size: &mutt-size;</para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>Estimated disk space required: &mutt-buildsize;</para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>Estimated build time: &mutt-time;</para>
|
---|
51 | </listitem>
|
---|
52 | </itemizedlist>
|
---|
53 |
|
---|
54 | <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
|
---|
55 |
|
---|
56 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
57 | <para role="optional"><xref linkend="gnupg"/> or <xref linkend="gnupg2"/>,
|
---|
58 | <xref linkend="openssl"/> or <xref linkend="gnutls"/>,
|
---|
59 | an <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
|
---|
60 | <xref linkend="aspell"/>,
|
---|
61 | <xref linkend="mitkrb"/> or <xref linkend="heimdal"/>,
|
---|
62 | <xref linkend="cyrus-sasl"/>,
|
---|
63 | <xref linkend="slang"/>,
|
---|
64 | <xref linkend="libidn"/>,
|
---|
65 | <!-- <xref linkend="db"/> -->
|
---|
66 | <xref linkend="gdbm"/> or
|
---|
67 | <ulink url="http://qdbm.sourceforge.net/">QDBM</ulink>, and
|
---|
68 | <ulink url="http://www.gnu.org/software/gdb/gdb.html">GDB</ulink>
|
---|
69 | </para>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Optional (To Regenerate HTML
|
---|
72 | Documentation)</bridgehead>
|
---|
73 | <para role="optional"><xref linkend="libxslt"/> and either
|
---|
74 | <xref linkend="lynx"/>,
|
---|
75 | <xref linkend="w3m"/> or
|
---|
76 | <ulink url="http://elinks.or.cz/">ELinks</ulink></para>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
|
---|
79 | <para role="optional"><xref linkend="jadetex"/> and
|
---|
80 | <xref linkend="docbook-dsssl"/></para>
|
---|
81 |
|
---|
82 | <para condition="html" role="usernotes">User Notes:
|
---|
83 | <ulink url="&blfs-wiki;/mutt"/></para>
|
---|
84 |
|
---|
85 | </sect2>
|
---|
86 |
|
---|
87 | <sect2 role="installation">
|
---|
88 | <title>Installation of Mutt</title>
|
---|
89 |
|
---|
90 | <note>
|
---|
91 | <para>This version of <application>Mutt</application> is a development
|
---|
92 | release. The BLFS staff has determined that it provides a stable
|
---|
93 | program and fixes two issues in the current stable version of
|
---|
94 | <application>Mutt</application>: a segmentation fault that occurs under
|
---|
95 | certain conditions and a compilation problem when building with
|
---|
96 | <application>GCC-&gcc-version;</application>. To find the current
|
---|
97 | stable release, please refer to the
|
---|
98 | <ulink url="http://www.mutt.org/">Mutt home page</ulink>.</para>
|
---|
99 | </note>
|
---|
100 |
|
---|
101 | <caution>
|
---|
102 | <para>If you choose to link <application>Mutt</application> against
|
---|
103 | <xref linkend="gnutls"/>,
|
---|
104 | you won't have SSL client certificate support. Specifically the
|
---|
105 | <envar>ssl_client_cert</envar> configuration variable is recognized
|
---|
106 | as invalid. That means you will lose the ability to use
|
---|
107 | <command>mutt</command> via SMTP over TLS or in the case when
|
---|
108 | a client certification is required for authentication on an IMAP server.
|
---|
109 | For these reasons it is recommended to link <application>Mutt</application>
|
---|
110 | against <xref linkend="openssl"/> if you want SSL/TLS support.</para>
|
---|
111 | </caution>
|
---|
112 |
|
---|
113 | <para><application>Mutt</application> requires a group named
|
---|
114 | <systemitem class="groupname">mail</systemitem>. You can
|
---|
115 | add this group, if it does not exist, with this command:</para>
|
---|
116 |
|
---|
117 | <screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
|
---|
118 |
|
---|
119 | <para>If you did not install an MTA, such as <xref linkend="postfix"/> or
|
---|
120 | <xref linkend="sendmail"/>, you need to modify the ownership of
|
---|
121 | <filename class="directory">/var/mail</filename> with this command:</para>
|
---|
122 |
|
---|
123 | <screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
|
---|
124 |
|
---|
125 | <para>Install <application>Mutt</application> by running the following
|
---|
126 | commands:</para>
|
---|
127 |
|
---|
128 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
129 | --with-docdir=/usr/share/doc/mutt-&mutt-version; \
|
---|
130 | --enable-pop --enable-imap \
|
---|
131 | --enable-hcache --without-qdbm \
|
---|
132 | --without-gdbm --with-bdb &&
|
---|
133 | make</userinput></screen>
|
---|
134 |
|
---|
135 | <para>If you have the necessary dependencies installed and would like
|
---|
136 | to rebuild the HTML documentation, issue the following commands:</para>
|
---|
137 |
|
---|
138 | <screen><userinput>make -C doc clean &&
|
---|
139 | make -C doc</userinput></screen>
|
---|
140 |
|
---|
141 | <para>To generate the PDF manual with <xref linkend="jadetex"/>, run
|
---|
142 | the following command:</para>
|
---|
143 |
|
---|
144 | <screen><userinput>make -C doc manual.pdf</userinput></screen>
|
---|
145 |
|
---|
146 | <para>This package does not come with a test suite.</para>
|
---|
147 |
|
---|
148 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
149 |
|
---|
150 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
151 |
|
---|
152 | <para>If you generated the PDF manual, install it and the source TeX
|
---|
153 | file by issuing the following command as the
|
---|
154 | <systemitem class="username">root</systemitem> user:</para>
|
---|
155 |
|
---|
156 | <screen role='root'><userinput>install -v -m644 doc/manual.{pdf,tex} \
|
---|
157 | /usr/share/doc/mutt-&mutt-version;</userinput></screen>
|
---|
158 |
|
---|
159 | </sect2>
|
---|
160 |
|
---|
161 | <sect2 role="commands">
|
---|
162 | <title>Command Explanations</title>
|
---|
163 |
|
---|
164 | <para><parameter>--enable-pop</parameter>: This switch enables
|
---|
165 | POP3 support.</para>
|
---|
166 |
|
---|
167 | <para><parameter>--enable-imap</parameter>: This switch enables
|
---|
168 | IMAP support.</para>
|
---|
169 |
|
---|
170 | <para><parameter>--enable-hcache</parameter>: This switch enables
|
---|
171 | header caching.</para>
|
---|
172 |
|
---|
173 | <para><parameter>--without-qdbm</parameter>: This switch disables
|
---|
174 | <application>QDBM</application> as the header cache backend.</para>
|
---|
175 |
|
---|
176 | <para><parameter>--without-gdbm</parameter>: This switch disables
|
---|
177 | <application>GDBM</application> as the header cache backend.</para>
|
---|
178 |
|
---|
179 | <para><parameter>--with-bdb</parameter>: This switch enables
|
---|
180 | <application>Berkeley DB</application> as the header cache backend.</para>
|
---|
181 |
|
---|
182 | <para><parameter>--enable-smtp</parameter>: This switch enables
|
---|
183 | SMTP relay support.</para>
|
---|
184 |
|
---|
185 | <para><parameter>--with-ssl</parameter>: This parameter adds SSL/TLS
|
---|
186 | support from <xref linkend="openssl"/> in POP3/IMAP/SMTP if they are
|
---|
187 | enabled.</para>
|
---|
188 |
|
---|
189 | <para><parameter>--with-sasl</parameter>: This parameter adds
|
---|
190 | authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
|
---|
191 | if they are enabled. Depending on the server configuration, this may not
|
---|
192 | be needed for POP3 or IMAP. However, it is needed for SMTP
|
---|
193 | authentication.</para>
|
---|
194 |
|
---|
195 | </sect2>
|
---|
196 |
|
---|
197 | <sect2 role="configuration">
|
---|
198 | <title>Configuring Mutt</title>
|
---|
199 |
|
---|
200 | <sect3 id="mutt-config">
|
---|
201 | <title>Config Files</title>
|
---|
202 |
|
---|
203 | <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
|
---|
204 | <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
|
---|
205 |
|
---|
206 | <indexterm zone="mutt mutt-config">
|
---|
207 | <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
|
---|
208 | </indexterm>
|
---|
209 |
|
---|
210 | <indexterm zone="mutt mutt-config">
|
---|
211 | <primary sortas="e-AA.muttrc">~/.muttrc</primary>
|
---|
212 | </indexterm>
|
---|
213 |
|
---|
214 | <indexterm zone="mutt mutt-config">
|
---|
215 | <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
|
---|
216 | </indexterm>
|
---|
217 |
|
---|
218 | <indexterm zone="mutt mutt-config">
|
---|
219 | <primary sortas="e-AA.mime.types">~/.mime.types</primary>
|
---|
220 | </indexterm>
|
---|
221 |
|
---|
222 | </sect3>
|
---|
223 |
|
---|
224 | <sect3>
|
---|
225 | <title>Configuration Information</title>
|
---|
226 |
|
---|
227 | <para>No changes in these files are necessary to begin using
|
---|
228 | <application>Mutt</application>. When you are ready to make changes, the
|
---|
229 | man page for <filename>muttrc</filename> is a good starting place.</para>
|
---|
230 |
|
---|
231 | <para>In order to utilize <application>GnuPG</application>, use the following
|
---|
232 | command:</para>
|
---|
233 |
|
---|
234 | <screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc >> ~/.muttrc</userinput></screen>
|
---|
235 |
|
---|
236 | </sect3>
|
---|
237 |
|
---|
238 | </sect2>
|
---|
239 |
|
---|
240 | <sect2 role="content">
|
---|
241 | <title>Contents</title>
|
---|
242 |
|
---|
243 | <segmentedlist>
|
---|
244 | <segtitle>Installed Programs</segtitle>
|
---|
245 | <segtitle>Installed Libraries</segtitle>
|
---|
246 | <segtitle>Installed Directories</segtitle>
|
---|
247 |
|
---|
248 | <seglistitem>
|
---|
249 | <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
|
---|
250 | smime_keys</seg>
|
---|
251 | <seg>None</seg>
|
---|
252 | <seg>/usr/share/doc/mutt-&mutt-version;</seg>
|
---|
253 | </seglistitem>
|
---|
254 | </segmentedlist>
|
---|
255 |
|
---|
256 | <variablelist>
|
---|
257 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
258 | <?dbfo list-presentation="list"?>
|
---|
259 | <?dbhtml list-presentation="table"?>
|
---|
260 |
|
---|
261 | <varlistentry id="flea">
|
---|
262 | <term><command>flea</command></term>
|
---|
263 | <listitem>
|
---|
264 | <para>is a bug submitter for <application>Mutt</application>.</para>
|
---|
265 | <indexterm zone="mutt flea">
|
---|
266 | <primary sortas="b-flea">flea</primary>
|
---|
267 | </indexterm>
|
---|
268 | </listitem>
|
---|
269 | </varlistentry>
|
---|
270 |
|
---|
271 | <varlistentry id="mutt-prog">
|
---|
272 | <term><command>mutt</command></term>
|
---|
273 | <listitem>
|
---|
274 | <para>is a Mail User Agent (MUA) which enables you to read, write
|
---|
275 | and delete your email.</para>
|
---|
276 | <indexterm zone="mutt mutt-prog">
|
---|
277 | <primary sortas="b-mutt">mutt</primary>
|
---|
278 | </indexterm>
|
---|
279 | </listitem>
|
---|
280 | </varlistentry>
|
---|
281 |
|
---|
282 | <varlistentry id="mutt_dotlock">
|
---|
283 | <term><command>mutt_dotlock</command></term>
|
---|
284 | <listitem>
|
---|
285 | <para>implements the mail spool file lock.</para>
|
---|
286 | <indexterm zone="mutt mutt_dotlock">
|
---|
287 | <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
|
---|
288 | </indexterm>
|
---|
289 | </listitem>
|
---|
290 | </varlistentry>
|
---|
291 |
|
---|
292 | <varlistentry id="muttbug">
|
---|
293 | <term><command>muttbug</command></term>
|
---|
294 | <listitem>
|
---|
295 | <para>is a script that executes <command>flea</command>.</para>
|
---|
296 | <indexterm zone="mutt muttbug">
|
---|
297 | <primary sortas="c-muttbug">muttbug</primary>
|
---|
298 | </indexterm>
|
---|
299 | </listitem>
|
---|
300 | </varlistentry>
|
---|
301 |
|
---|
302 | <varlistentry id="pgpewrap">
|
---|
303 | <term><command>pgpewrap</command></term>
|
---|
304 | <listitem>
|
---|
305 | <para>prepares a command line for the <xref linkend="gnupg"/>
|
---|
306 | utilities.</para>
|
---|
307 | <indexterm zone="mutt pgpewrap">
|
---|
308 | <primary sortas="c-pgpewrap">pgpewrap</primary>
|
---|
309 | </indexterm>
|
---|
310 | </listitem>
|
---|
311 | </varlistentry>
|
---|
312 |
|
---|
313 | <varlistentry id="pgpring">
|
---|
314 | <term><command>pgpring</command></term>
|
---|
315 | <listitem>
|
---|
316 | <para>is a key ring dumper for <ulink
|
---|
317 | url="http://www.pgp.com/">PGP</ulink>. It is not needed for
|
---|
318 | <xref linkend="gnupg"/>.</para>
|
---|
319 | <indexterm zone="mutt pgpring">
|
---|
320 | <primary sortas="c-pgpring">pgpring</primary>
|
---|
321 | </indexterm>
|
---|
322 | </listitem>
|
---|
323 | </varlistentry>
|
---|
324 |
|
---|
325 | <varlistentry id="smime_keys">
|
---|
326 | <term><command>smime_keys</command></term>
|
---|
327 | <listitem>
|
---|
328 | <para>manages a keystore for S/MIME certificates.</para>
|
---|
329 | <indexterm zone="mutt smime_keys">
|
---|
330 | <primary sortas="c-smime_keys">smime_keys</primary>
|
---|
331 | </indexterm>
|
---|
332 | </listitem>
|
---|
333 | </varlistentry>
|
---|
334 |
|
---|
335 | </variablelist>
|
---|
336 |
|
---|
337 | </sect2>
|
---|
338 |
|
---|
339 | </sect1>
|
---|