source: networking/mailnews/mutt.xml@ 8ccc682

10.0 10.1 11.0 11.1 11.2 8.4 9.0 9.1 bdubbs/svn elogind lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 8ccc682 was 8ccc682, checked in by Ken Moffat <ken@…>, 4 years ago

Mutt-1.11.0 - the fix for pdfjadetex is now in the release - and add CXX=g++ to quiten clang++ messages from building cups.

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

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