source: networking/mailnews/mutt.xml@ 37191af

systemd-13485
Last change on this file since 37191af was 37191af, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Sync to trunk r17270. Last round for the night.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17330 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 12.3 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 "&sourceforge-repo;/mutt/mutt-&mutt-version;.tar.gz">-->
8 <!ENTITY mutt-download-http " ">
9 <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/pub/mutt/mutt-&mutt-version;.tar.gz">
10 <!ENTITY mutt-md5sum "d05bb821d7040c61ba89b22d7c2bd388">
11 <!ENTITY mutt-size "3.8 MB">
12 <!ENTITY mutt-buildsize "37 MB (plus a further 5MB for the PDF manual)">
13 <!ENTITY mutt-time "0.3 SBU (plus a further 0.2 SBU to build the PDF manual)">
14]>
15
16<sect1 id="mutt" xreflabel="Mutt-&mutt-version;">
17 <?dbhtml filename="mutt.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Mutt-&mutt-version;</title>
25
26 <indexterm zone="mutt">
27 <primary sortas="a-mutt">mutt</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Mutt</title>
32
33 <para>The <application>Mutt</application> package contains a Mail User
34 Agent. This is useful for reading, writing, replying to, saving, and
35 deleting your email.</para>
36
37 &lfs78_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing='compact'>
41 <listitem>
42 <para>Download (HTTP): <ulink url="&mutt-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&mutt-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &mutt-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &mutt-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &mutt-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &mutt-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <!--<bridgehead renderas="sect3">Additional Downloads</bridgehead>
62 <itemizedlist spacing='compact'>
63 <listitem>
64 <para>Required patch: <ulink
65 url="&patch-root;/mutt-&mutt-version;-upstream_fixes-1.patch"/>
66 </para>
67 </listitem>
68 </itemizedlist>-->
69
70 <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Optional</bridgehead>
73 <para role="optional">
74 <xref linkend="aspell"/>,
75 <xref linkend="cyrus-sasl"/>,
76 <xref linkend="gdb"/>,
77 <xref linkend="gnupg2"/>,
78 <xref linkend="gpgme"/>,
79 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>,
80 <xref linkend="libidn"/>,
81 <xref linkend="mitkrb"/>,
82 <ulink url="http://mixmaster.sourceforge.net/">Mixmaster</ulink>,
83 an <xref linkend="server-mail"/> (that provides a <command>sendmail</command> command),
84 <xref linkend="slang"/>,
85 <xref linkend="openssl"/> or
86 <xref linkend="gnutls"/>,
87 <xref linkend="db"/> or
88 <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
89 <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
90 </para>
91
92 <bridgehead renderas="sect4">Optional (To Regenerate HTML
93 Documentation)</bridgehead>
94 <para role="optional">
95 <xref linkend="libxslt"/> and either
96 <xref linkend="lynx"/>,
97 <xref linkend="w3m"/>, or
98 <ulink url="http://elinks.or.cz/">ELinks</ulink>
99 </para>
100
101 <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
102 <para role="optional">
103 <xref linkend="docbook-dsssl"/>,
104 <xref linkend="openjade"/>, and
105 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
106 </para>
107
108 <para condition="html" role="usernotes">User Notes:
109 <ulink url="&blfs-wiki;/mutt"/></para>
110
111 </sect2>
112
113 <sect2 role="installation">
114 <title>Installation of Mutt</title>
115
116 <para><application>Mutt</application> requires a group named
117 <systemitem class="groupname">mail</systemitem>. You can
118 add this group, if it does not exist, with this command:</para>
119
120<screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
121
122 <para>If you did not install an <xref linkend="server-mail"/>, you need to
123 modify the ownership of <filename class="directory">/var/mail</filename>
124 with this command:</para>
125
126<screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
127
128 <para><application>Mutt</application> will rebuild the html documentation
129 if <application>libxslt</application> is present, then use that to update
130 the text manual - even if none of the specified browsers are present. That
131 will create an empty text file, so we will save the shipped file.
132 </para>
133
134 <para>Install <application>Mutt</application> by running the following
135 commands:</para>
136
137<screen><userinput>cp -v doc/manual.txt{,.shipped} &amp;&amp;
138./configure --prefix=/usr \
139 --sysconfdir=/etc \
140 --with-docdir=/usr/share/doc/mutt-&mutt-version; \
141 --enable-external-dotlock \
142 --enable-pop \
143 --enable-imap \
144 --enable-hcache &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
169 as a regular user (as part of a package management process), you will
170 need 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 </sect2>
178
179 <sect2 role="commands">
180 <title>Command Explanations</title>
181
182 <para><parameter>--enable-external-dotlock</parameter>: In some
183 circumstances the mutt-dotlock program is not created. This switch ensures
184 that it is always created.</para>
185
186 <para><parameter>--enable-pop</parameter>: This switch enables
187 POP3 support.</para>
188
189 <para><parameter>--enable-imap</parameter>: This switch enables
190 IMAP support.</para>
191
192 <para><parameter>--enable-hcache</parameter>: This switch enables
193 header caching.</para>
194
195 <para><option>--enable-smtp</option>: This switch enables
196 SMTP relay support.</para>
197
198 <para><option>--with-ssl</option>: This parameter adds SSL/TLS
199 support from <xref linkend="openssl"/> in POP3/IMAP/SMTP if they are
200 enabled.</para>
201
202 <para><option>--with-sasl</option>: This parameter adds
203 authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
204 if they are enabled. Depending on the server configuration, this may not
205 be needed for POP3 or IMAP. However, it is needed for SMTP
206 authentication.</para>
207
208 <para><parameter>>test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</parameter>:
209 if the text manual is now empty (<application>libxslt</application> is installed,
210 but without any of the specified text browsers), restore it from the copy.</para>
211
212 </sect2>
213
214 <sect2 role="configuration">
215 <title>Configuring Mutt</title>
216
217 <sect3 id="mutt-config">
218 <title>Config Files</title>
219
220 <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
221 <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
222
223 <indexterm zone="mutt mutt-config">
224 <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
225 </indexterm>
226
227 <indexterm zone="mutt mutt-config">
228 <primary sortas="e-AA.muttrc">~/.muttrc</primary>
229 </indexterm>
230
231 <indexterm zone="mutt mutt-config">
232 <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
233 </indexterm>
234
235 <indexterm zone="mutt mutt-config">
236 <primary sortas="e-AA.mime.types">~/.mime.types</primary>
237 </indexterm>
238
239 </sect3>
240
241 <sect3>
242 <title>Configuration Information</title>
243
244 <para>No changes in these files are necessary to begin using
245 <application>Mutt</application>. When you are ready to make changes, the
246 man page for <filename>muttrc</filename> is a good starting place.</para>
247
248 <para>In order to utilize <application>GnuPG</application>, use the following
249 command:</para>
250
251<screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc &gt;&gt; ~/.muttrc</userinput></screen>
252
253 </sect3>
254
255 </sect2>
256
257 <sect2 role="content">
258 <title>Contents</title>
259
260 <segmentedlist>
261 <segtitle>Installed Programs</segtitle>
262 <segtitle>Installed Libraries</segtitle>
263 <segtitle>Installed Directories</segtitle>
264
265 <seglistitem>
266 <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
267 smime_keys</seg>
268 <seg>None</seg>
269 <seg>/usr/share/doc/mutt-&mutt-version;</seg>
270 </seglistitem>
271 </segmentedlist>
272
273 <variablelist>
274 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
275 <?dbfo list-presentation="list"?>
276 <?dbhtml list-presentation="table"?>
277
278 <varlistentry id="flea">
279 <term><command>flea</command></term>
280 <listitem>
281 <para>is a bug submitter for <application>Mutt</application>.</para>
282 <indexterm zone="mutt flea">
283 <primary sortas="b-flea">flea</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 <varlistentry id="mutt-prog">
289 <term><command>mutt</command></term>
290 <listitem>
291 <para>is a Mail User Agent (MUA) which enables you to read, write
292 and delete your email.</para>
293 <indexterm zone="mutt mutt-prog">
294 <primary sortas="b-mutt">mutt</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="mutt_dotlock">
300 <term><command>mutt_dotlock</command></term>
301 <listitem>
302 <para>implements the mail spool file lock.</para>
303 <indexterm zone="mutt mutt_dotlock">
304 <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="muttbug">
310 <term><command>muttbug</command></term>
311 <listitem>
312 <para>is a script that executes <command>flea</command>.</para>
313 <indexterm zone="mutt muttbug">
314 <primary sortas="b-muttbug">muttbug</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="pgpewrap">
320 <term><command>pgpewrap</command></term>
321 <listitem>
322 <para>prepares a command line for the <xref linkend="gnupg2"/>
323 utilities.</para>
324 <indexterm zone="mutt pgpewrap">
325 <primary sortas="b-pgpewrap">pgpewrap</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="pgpring">
331 <term><command>pgpring</command></term>
332 <listitem>
333 <para>is a key ring dumper for <ulink
334 url="http://www.pgp.com/">PGP</ulink>. It is not needed for
335 <xref linkend="gnupg2"/>.</para>
336 <indexterm zone="mutt pgpring">
337 <primary sortas="b-pgpring">pgpring</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="smime_keys">
343 <term><command>smime_keys</command></term>
344 <listitem>
345 <para>manages a keystore for S/MIME certificates.</para>
346 <indexterm zone="mutt smime_keys">
347 <primary sortas="b-smime_keys">smime_keys</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 </variablelist>
353
354 </sect2>
355
356</sect1>
Note: See TracBrowser for help on using the repository browser.