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 "f1564f81ed5f8bacb7e041edc71d5347">
|
---|
10 | <!ENTITY mutt-size "4.1 MB">
|
---|
11 | <!ENTITY mutt-buildsize "42 MB (plus a further 6MB 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 | &lfs83_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"/> 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>If you intend to create the PDF version of the manual, apply the
|
---|
134 | following sed:</para>
|
---|
135 |
|
---|
136 | <screen><userinput>sed -i 's/\(pdfjadetex manual.tex;\)/\1 \1 \1/' doc/Makefile.in</userinput></screen>
|
---|
137 |
|
---|
138 | <para>Install <application>Mutt</application> by running the following
|
---|
139 | commands:</para>
|
---|
140 |
|
---|
141 | <screen><userinput>cp -v doc/manual.txt{,.shipped} &&
|
---|
142 | ./configure --prefix=/usr \
|
---|
143 | --sysconfdir=/etc \
|
---|
144 | --with-docdir=/usr/share/doc/mutt-&mutt-version; \
|
---|
145 | --with-ssl \
|
---|
146 | --enable-external-dotlock \
|
---|
147 | --enable-pop \
|
---|
148 | --enable-imap \
|
---|
149 | --enable-hcache \
|
---|
150 | --enable-sidebar &&
|
---|
151 | make &&</userinput></screen>
|
---|
152 |
|
---|
153 | <para>To generate the PDF manual with <xref linkend="texlive"/>, run
|
---|
154 | the following command:</para>
|
---|
155 |
|
---|
156 | <screen><userinput>make -C doc manual.pdf</userinput></screen>
|
---|
157 |
|
---|
158 | <para>This package does not come with a test suite.</para>
|
---|
159 |
|
---|
160 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
161 |
|
---|
162 | <screen role='root'><userinput>make install &&
|
---|
163 | test -s doc/manual.txt ||
|
---|
164 | install -v -m644 doc/manual.txt.shipped \
|
---|
165 | /usr/share/doc/mutt-&mutt-version;/manual.txt</userinput></screen>
|
---|
166 |
|
---|
167 | <para>If you generated the PDF manual, install it
|
---|
168 | by issuing the following command as the
|
---|
169 | <systemitem class="username">root</systemitem> user:</para>
|
---|
170 |
|
---|
171 | <screen role='root'><userinput>install -v -m644 doc/manual.pdf \
|
---|
172 | /usr/share/doc/mutt-&mutt-version;</userinput></screen>
|
---|
173 |
|
---|
174 | <note>
|
---|
175 | <para>
|
---|
176 | If you used a DESTDIR method to only install to a temporary location as
|
---|
177 | a regular user (as part of a package menagement process), you will need
|
---|
178 | to run the following as the <systemitem class="username">root</systemitem>
|
---|
179 | user after completing the real install:
|
---|
180 | </para>
|
---|
181 |
|
---|
182 | <screen role="nodump"><userinput>chown root:mail /usr/bin/mutt_dotlock &&
|
---|
183 | chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
|
---|
184 | </note>
|
---|
185 |
|
---|
186 |
|
---|
187 | </sect2>
|
---|
188 |
|
---|
189 | <sect2 role="commands">
|
---|
190 | <title>Command Explanations</title>
|
---|
191 |
|
---|
192 | <para><parameter>sed -i 's/\(pdfjadetex manual.tex;\)/\1 \1 \1/'
|
---|
193 | doc/Makefile.in</parameter>: TeX engines sometimes need to be run
|
---|
194 | multiple times to fix up references. In this case the engine
|
---|
195 | has to run three times to fix page references in the Table of Contents
|
---|
196 | and the List of Tables.</para>
|
---|
197 |
|
---|
198 | <para><parameter>--enable-external-dotlock</parameter>: In some circumstances
|
---|
199 | the mutt-dotlock program is not created. This switch ensures it is always
|
---|
200 | created.</para>
|
---|
201 |
|
---|
202 | <para><parameter>--enable-pop</parameter>: This switch enables
|
---|
203 | POP3 support.</para>
|
---|
204 |
|
---|
205 | <para><parameter>--enable-imap</parameter>: This switch enables
|
---|
206 | IMAP support.</para>
|
---|
207 |
|
---|
208 | <para><parameter>--enable-hcache</parameter>: This switch enables
|
---|
209 | header caching.</para>
|
---|
210 |
|
---|
211 | <para><parameter>--enable-sidebar</parameter>: This switch enables support
|
---|
212 | for the sidebar (a list of mailboxes). It is off by default, but can be
|
---|
213 | turned on by <command>:set sidebar_visible</command> in mutt (and off again
|
---|
214 | with ':unset'), or it can be enabled in <filename>~/.muttrc</filename>.</para>
|
---|
215 |
|
---|
216 | <para><parameter>--with-ssl</parameter>: This parameter adds SSL/TLS
|
---|
217 | support from openssl in POP3/IMAP/SMTP.</para>
|
---|
218 |
|
---|
219 | <para><option>--enable-smtp</option>: This switch enables
|
---|
220 | SMTP relay support.</para>
|
---|
221 |
|
---|
222 | <para><option>--with-idn2</option>: Use this parameter if both libidn and
|
---|
223 | libidn2 have been installed, and you wish to use libidn2 here.</para>
|
---|
224 |
|
---|
225 | <para><option>--with-sasl</option>: This parameter adds
|
---|
226 | authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
|
---|
227 | if they are enabled. Depending on the server configuration, this may not
|
---|
228 | be needed for POP3 or IMAP. However, it is needed for SMTP
|
---|
229 | authentication.</para>
|
---|
230 |
|
---|
231 | <!-- we do not normally list all possible switches. LFS installs ncurses.
|
---|
232 | <para><option>\-\-with-slang</option>: Use <application>S-Lang
|
---|
233 | </application> instead of <application>Ncurses</application>.</para> -->
|
---|
234 |
|
---|
235 | <para><command>test -s doc/manual.txt || install -v -m644 doc/manual.txt.shipped ...</command>:
|
---|
236 | if the text manual is now empty (<application>libxslt</application> is
|
---|
237 | installed, but without any of the specified text browsers), install the
|
---|
238 | saved copy <emphasis>after</emphasis> running 'make install'
|
---|
239 | <emphasis>(which would itself empty manual.txt if the shipped file had
|
---|
240 | already been copied back)</emphasis>.</para>
|
---|
241 |
|
---|
242 | </sect2>
|
---|
243 |
|
---|
244 | <sect2 role="configuration">
|
---|
245 | <title>Configuring Mutt</title>
|
---|
246 |
|
---|
247 | <sect3 id="mutt-config">
|
---|
248 | <title>Config Files</title>
|
---|
249 |
|
---|
250 | <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
|
---|
251 | <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
|
---|
252 |
|
---|
253 | <indexterm zone="mutt mutt-config">
|
---|
254 | <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
|
---|
255 | </indexterm>
|
---|
256 |
|
---|
257 | <indexterm zone="mutt mutt-config">
|
---|
258 | <primary sortas="e-AA.muttrc">~/.muttrc</primary>
|
---|
259 | </indexterm>
|
---|
260 |
|
---|
261 | <indexterm zone="mutt mutt-config">
|
---|
262 | <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
|
---|
263 | </indexterm>
|
---|
264 |
|
---|
265 | <indexterm zone="mutt mutt-config">
|
---|
266 | <primary sortas="e-AA.mime.types">~/.mime.types</primary>
|
---|
267 | </indexterm>
|
---|
268 |
|
---|
269 | </sect3>
|
---|
270 |
|
---|
271 | <sect3>
|
---|
272 | <title>Configuration Information</title>
|
---|
273 |
|
---|
274 | <para>No changes in these files are necessary to begin using
|
---|
275 | <application>Mutt</application>. When you are ready to make changes, the
|
---|
276 | man page for <filename>muttrc</filename> is a good starting place.</para>
|
---|
277 |
|
---|
278 | <para>In order to utilize <application>GnuPG</application>, use the following
|
---|
279 | command:</para>
|
---|
280 |
|
---|
281 | <screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc >> ~/.muttrc</userinput></screen>
|
---|
282 |
|
---|
283 | </sect3>
|
---|
284 |
|
---|
285 | </sect2>
|
---|
286 |
|
---|
287 | <sect2 role="content">
|
---|
288 | <title>Contents</title>
|
---|
289 |
|
---|
290 | <segmentedlist>
|
---|
291 | <segtitle>Installed Programs</segtitle>
|
---|
292 | <segtitle>Installed Libraries</segtitle>
|
---|
293 | <segtitle>Installed Directories</segtitle>
|
---|
294 |
|
---|
295 | <seglistitem>
|
---|
296 | <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
|
---|
297 | smime_keys</seg>
|
---|
298 | <seg>None</seg>
|
---|
299 | <seg>/usr/share/doc/mutt-&mutt-version;</seg>
|
---|
300 | </seglistitem>
|
---|
301 | </segmentedlist>
|
---|
302 |
|
---|
303 | <variablelist>
|
---|
304 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
305 | <?dbfo list-presentation="list"?>
|
---|
306 | <?dbhtml list-presentation="table"?>
|
---|
307 |
|
---|
308 | <varlistentry id="flea">
|
---|
309 | <term><command>flea</command></term>
|
---|
310 | <listitem>
|
---|
311 | <para>is a script showing where to report bugs.</para>
|
---|
312 | <indexterm zone="mutt flea">
|
---|
313 | <primary sortas="b-flea">flea</primary>
|
---|
314 | </indexterm>
|
---|
315 | </listitem>
|
---|
316 | </varlistentry>
|
---|
317 |
|
---|
318 | <varlistentry id="mutt-prog">
|
---|
319 | <term><command>mutt</command></term>
|
---|
320 | <listitem>
|
---|
321 | <para>is a Mail User Agent (MUA) which enables you to read, write
|
---|
322 | and delete your email.</para>
|
---|
323 | <indexterm zone="mutt mutt-prog">
|
---|
324 | <primary sortas="b-mutt">mutt</primary>
|
---|
325 | </indexterm>
|
---|
326 | </listitem>
|
---|
327 | </varlistentry>
|
---|
328 |
|
---|
329 | <varlistentry id="mutt_dotlock">
|
---|
330 | <term><command>mutt_dotlock</command></term>
|
---|
331 | <listitem>
|
---|
332 | <para>implements the mail spool file lock.</para>
|
---|
333 | <indexterm zone="mutt mutt_dotlock">
|
---|
334 | <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
|
---|
335 | </indexterm>
|
---|
336 | </listitem>
|
---|
337 | </varlistentry>
|
---|
338 |
|
---|
339 | <varlistentry id="muttbug">
|
---|
340 | <term><command>muttbug</command></term>
|
---|
341 | <listitem>
|
---|
342 | <para>is a script identical to <command>flea</command>.</para>
|
---|
343 | <indexterm zone="mutt muttbug">
|
---|
344 | <primary sortas="b-muttbug">muttbug</primary>
|
---|
345 | </indexterm>
|
---|
346 | </listitem>
|
---|
347 | </varlistentry>
|
---|
348 |
|
---|
349 | <varlistentry id="pgpewrap">
|
---|
350 | <term><command>pgpewrap</command></term>
|
---|
351 | <listitem>
|
---|
352 | <para>prepares a command line for the <xref linkend="gnupg2"/>
|
---|
353 | utilities.</para>
|
---|
354 | <indexterm zone="mutt pgpewrap">
|
---|
355 | <primary sortas="b-pgpewrap">pgpewrap</primary>
|
---|
356 | </indexterm>
|
---|
357 | </listitem>
|
---|
358 | </varlistentry>
|
---|
359 |
|
---|
360 | <varlistentry id="pgpring">
|
---|
361 | <term><command>pgpring</command></term>
|
---|
362 | <listitem>
|
---|
363 | <para>is a key ring dumper for <ulink
|
---|
364 | url="http://www.pgp.com/">PGP</ulink>. It is not needed for
|
---|
365 | <xref linkend="gnupg2"/>.</para>
|
---|
366 | <indexterm zone="mutt pgpring">
|
---|
367 | <primary sortas="b-pgpring">pgpring</primary>
|
---|
368 | </indexterm>
|
---|
369 | </listitem>
|
---|
370 | </varlistentry>
|
---|
371 |
|
---|
372 | <varlistentry id="smime_keys">
|
---|
373 | <term><command>smime_keys</command></term>
|
---|
374 | <listitem>
|
---|
375 | <para>manages a keystore for S/MIME certificates.</para>
|
---|
376 | <indexterm zone="mutt smime_keys">
|
---|
377 | <primary sortas="b-smime_keys">smime_keys</primary>
|
---|
378 | </indexterm>
|
---|
379 | </listitem>
|
---|
380 | </varlistentry>
|
---|
381 |
|
---|
382 | </variablelist>
|
---|
383 |
|
---|
384 | </sect2>
|
---|
385 |
|
---|
386 | </sect1>
|
---|