[bfe245f] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[bfe245f] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[85a52e67] | 7 | <!-- <!ENTITY mutt-download-http "&sourceforge-repo;/mutt/mutt-&mutt-version;.tar.gz">-->
|
---|
[30910871] | 8 | <!ENTITY mutt-download-http " ">
|
---|
[3e63daa9] | 9 | <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/pub/mutt/mutt-&mutt-version;.tar.gz">
|
---|
[37191af] | 10 | <!ENTITY mutt-md5sum "d05bb821d7040c61ba89b22d7c2bd388">
|
---|
[1adf07d] | 11 | <!ENTITY mutt-size "3.8 MB">
|
---|
[37191af] | 12 | <!ENTITY mutt-buildsize "37 MB (plus a further 5MB for the PDF manual)">
|
---|
[3e63daa9] | 13 | <!ENTITY mutt-time "0.3 SBU (plus a further 0.2 SBU to build the PDF manual)">
|
---|
[bfe245f] | 14 | ]>
|
---|
| 15 |
|
---|
[377584f] | 16 | <sect1 id="mutt" xreflabel="Mutt-&mutt-version;">
|
---|
[6b9cfc9] | 17 | <?dbhtml filename="mutt.html"?>
|
---|
[481b3e8] | 18 |
|
---|
[6b9cfc9] | 19 | <sect1info>
|
---|
| 20 | <othername>$LastChangedBy$</othername>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect1info>
|
---|
[481b3e8] | 23 |
|
---|
[6b9cfc9] | 24 | <title>Mutt-&mutt-version;</title>
|
---|
[481b3e8] | 25 |
|
---|
[8134bed] | 26 | <indexterm zone="mutt">
|
---|
| 27 | <primary sortas="a-mutt">mutt</primary>
|
---|
| 28 | </indexterm>
|
---|
| 29 |
|
---|
[6b9cfc9] | 30 | <sect2 role="package">
|
---|
| 31 | <title>Introduction to Mutt</title>
|
---|
[481b3e8] | 32 |
|
---|
[2561ad9e] | 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>
|
---|
[481b3e8] | 36 |
|
---|
[3e63daa9] | 37 | &lfs78_checked;
|
---|
[06f76d2c] | 38 |
|
---|
[6b9cfc9] | 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>
|
---|
[481b3e8] | 60 |
|
---|
[3e63daa9] | 61 | <!--<bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
[ac38e9dc] | 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>
|
---|
[3e63daa9] | 68 | </itemizedlist>-->
|
---|
[ac38e9dc] | 69 |
|
---|
[6b9cfc9] | 70 | <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
|
---|
[481b3e8] | 71 |
|
---|
[6b9cfc9] | 72 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[f82ac3f] | 73 | <para role="optional">
|
---|
| 74 | <xref linkend="aspell"/>,
|
---|
| 75 | <xref linkend="cyrus-sasl"/>,
|
---|
[05b0caac] | 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>,
|
---|
[f82ac3f] | 80 | <xref linkend="libidn"/>,
|
---|
[05b0caac] | 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"/>,
|
---|
[3e63daa9] | 85 | <xref linkend="openssl"/> or
|
---|
[05b0caac] | 86 | <xref linkend="gnutls"/>,
|
---|
[f82ac3f] | 87 | <xref linkend="db"/> or
|
---|
[05b0caac] | 88 | <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
|
---|
| 89 | <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
|
---|
[4d91d36c] | 90 | </para>
|
---|
[481b3e8] | 91 |
|
---|
[2561ad9e] | 92 | <bridgehead renderas="sect4">Optional (To Regenerate HTML
|
---|
| 93 | Documentation)</bridgehead>
|
---|
[f82ac3f] | 94 | <para role="optional">
|
---|
| 95 | <xref linkend="libxslt"/> and either
|
---|
| 96 | <xref linkend="lynx"/>,
|
---|
[ac38e9dc] | 97 | <xref linkend="w3m"/>, or
|
---|
[f82ac3f] | 98 | <ulink url="http://elinks.or.cz/">ELinks</ulink>
|
---|
| 99 | </para>
|
---|
[2561ad9e] | 100 |
|
---|
| 101 | <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
|
---|
[3f8a5e2] | 102 | <para role="optional">
|
---|
[05b0caac] | 103 | <xref linkend="docbook-dsssl"/>,
|
---|
[ac38e9dc] | 104 | <xref linkend="openjade"/>, and
|
---|
| 105 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
|
---|
[3f8a5e2] | 106 | </para>
|
---|
[8ae8678b] | 107 |
|
---|
[061ec9d] | 108 | <para condition="html" role="usernotes">User Notes:
|
---|
| 109 | <ulink url="&blfs-wiki;/mutt"/></para>
|
---|
| 110 |
|
---|
[6b9cfc9] | 111 | </sect2>
|
---|
[481b3e8] | 112 |
|
---|
[6b9cfc9] | 113 | <sect2 role="installation">
|
---|
| 114 | <title>Installation of Mutt</title>
|
---|
[481b3e8] | 115 |
|
---|
| 116 | <para><application>Mutt</application> requires a group named
|
---|
| 117 | <systemitem class="groupname">mail</systemitem>. You can
|
---|
[6b9cfc9] | 118 | add this group, if it does not exist, with this command:</para>
|
---|
[481b3e8] | 119 |
|
---|
[b785ab29] | 120 | <screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
|
---|
[481b3e8] | 121 |
|
---|
[af8e3ea3] | 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>
|
---|
[481b3e8] | 125 |
|
---|
[e3353b3] | 126 | <screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
|
---|
[481b3e8] | 127 |
|
---|
[3e63daa9] | 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.
|
---|
[1adf07d] | 132 | </para>
|
---|
| 133 |
|
---|
[481b3e8] | 134 | <para>Install <application>Mutt</application> by running the following
|
---|
[6b9cfc9] | 135 | commands:</para>
|
---|
[481b3e8] | 136 |
|
---|
[3e63daa9] | 137 | <screen><userinput>cp -v doc/manual.txt{,.shipped} &&
|
---|
[37191af] | 138 | ./configure --prefix=/usr \
|
---|
| 139 | --sysconfdir=/etc \
|
---|
[2188f69] | 140 | --with-docdir=/usr/share/doc/mutt-&mutt-version; \
|
---|
[37191af] | 141 | --enable-external-dotlock \
|
---|
| 142 | --enable-pop \
|
---|
| 143 | --enable-imap \
|
---|
| 144 | --enable-hcache &&
|
---|
[1adf07d] | 145 | make &&
|
---|
| 146 | test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</userinput></screen>
|
---|
[2561ad9e] | 147 |
|
---|
[3f8a5e2] | 148 | <para>To generate the PDF manual with <xref linkend="texlive"/>, run
|
---|
[25f9f1f] | 149 | the following command:</para>
|
---|
[2561ad9e] | 150 |
|
---|
| 151 | <screen><userinput>make -C doc manual.pdf</userinput></screen>
|
---|
| 152 |
|
---|
[46441976] | 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>
|
---|
[481b3e8] | 158 |
|
---|
[37191af] | 159 | <para>If you generated the PDF manual, install it
|
---|
| 160 | by issuing the following command as the
|
---|
[25f9f1f] | 161 | <systemitem class="username">root</systemitem> user:</para>
|
---|
[2561ad9e] | 162 |
|
---|
[37191af] | 163 | <screen role='root'><userinput>install -v -m644 doc/manual.pdf \
|
---|
[2561ad9e] | 164 | /usr/share/doc/mutt-&mutt-version;</userinput></screen>
|
---|
| 165 |
|
---|
[37191af] | 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 &&
|
---|
| 175 | chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
|
---|
| 176 | </note>
|
---|
[6b9cfc9] | 177 | </sect2>
|
---|
[481b3e8] | 178 |
|
---|
[6b9cfc9] | 179 | <sect2 role="commands">
|
---|
[e3353b3] | 180 | <title>Command Explanations</title>
|
---|
[481b3e8] | 181 |
|
---|
[37191af] | 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 |
|
---|
[6b9cfc9] | 186 | <para><parameter>--enable-pop</parameter>: This switch enables
|
---|
[481b3e8] | 187 | POP3 support.</para>
|
---|
| 188 |
|
---|
[6b9cfc9] | 189 | <para><parameter>--enable-imap</parameter>: This switch enables
|
---|
[481b3e8] | 190 | IMAP support.</para>
|
---|
[fd7e0ed6] | 191 |
|
---|
[4d91d36c] | 192 | <para><parameter>--enable-hcache</parameter>: This switch enables
|
---|
| 193 | header caching.</para>
|
---|
| 194 |
|
---|
[a93934d2] | 195 | <para><option>--enable-smtp</option>: This switch enables
|
---|
[2561ad9e] | 196 | SMTP relay support.</para>
|
---|
| 197 |
|
---|
[a93934d2] | 198 | <para><option>--with-ssl</option>: This parameter adds SSL/TLS
|
---|
[156638b] | 199 | support from <xref linkend="openssl"/> in POP3/IMAP/SMTP if they are
|
---|
| 200 | enabled.</para>
|
---|
| 201 |
|
---|
[a93934d2] | 202 | <para><option>--with-sasl</option>: This parameter adds
|
---|
[156638b] | 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>
|
---|
[a41f643] | 207 |
|
---|
[37191af] | 208 | <para><parameter>>test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</parameter>:
|
---|
[3e63daa9] | 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 |
|
---|
[6b9cfc9] | 212 | </sect2>
|
---|
[481b3e8] | 213 |
|
---|
[6b9cfc9] | 214 | <sect2 role="configuration">
|
---|
| 215 | <title>Configuring Mutt</title>
|
---|
[481b3e8] | 216 |
|
---|
[6b9cfc9] | 217 | <sect3 id="mutt-config">
|
---|
[e3353b3] | 218 | <title>Config Files</title>
|
---|
[481b3e8] | 219 |
|
---|
[6b9cfc9] | 220 | <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
|
---|
| 221 | <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
|
---|
[481b3e8] | 222 |
|
---|
[6b9cfc9] | 223 | <indexterm zone="mutt mutt-config">
|
---|
| 224 | <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
|
---|
| 225 | </indexterm>
|
---|
[481b3e8] | 226 |
|
---|
[6b9cfc9] | 227 | <indexterm zone="mutt mutt-config">
|
---|
| 228 | <primary sortas="e-AA.muttrc">~/.muttrc</primary>
|
---|
| 229 | </indexterm>
|
---|
[481b3e8] | 230 |
|
---|
[6b9cfc9] | 231 | <indexterm zone="mutt mutt-config">
|
---|
| 232 | <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
|
---|
| 233 | </indexterm>
|
---|
[481b3e8] | 234 |
|
---|
[6b9cfc9] | 235 | <indexterm zone="mutt mutt-config">
|
---|
| 236 | <primary sortas="e-AA.mime.types">~/.mime.types</primary>
|
---|
| 237 | </indexterm>
|
---|
[481b3e8] | 238 |
|
---|
[6b9cfc9] | 239 | </sect3>
|
---|
[481b3e8] | 240 |
|
---|
[6b9cfc9] | 241 | <sect3>
|
---|
| 242 | <title>Configuration Information</title>
|
---|
[481b3e8] | 243 |
|
---|
[6b9cfc9] | 244 | <para>No changes in these files are necessary to begin using
|
---|
[481b3e8] | 245 | <application>Mutt</application>. When you are ready to make changes, the
|
---|
[6b9cfc9] | 246 | man page for <filename>muttrc</filename> is a good starting place.</para>
|
---|
[481b3e8] | 247 |
|
---|
| 248 | <para>In order to utilize <application>GnuPG</application>, use the following
|
---|
[6b9cfc9] | 249 | command:</para>
|
---|
[481b3e8] | 250 |
|
---|
[2561ad9e] | 251 | <screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc >> ~/.muttrc</userinput></screen>
|
---|
[481b3e8] | 252 |
|
---|
[6b9cfc9] | 253 | </sect3>
|
---|
[481b3e8] | 254 |
|
---|
[6b9cfc9] | 255 | </sect2>
|
---|
[481b3e8] | 256 |
|
---|
[6b9cfc9] | 257 | <sect2 role="content">
|
---|
| 258 | <title>Contents</title>
|
---|
[481b3e8] | 259 |
|
---|
[6b9cfc9] | 260 | <segmentedlist>
|
---|
| 261 | <segtitle>Installed Programs</segtitle>
|
---|
| 262 | <segtitle>Installed Libraries</segtitle>
|
---|
| 263 | <segtitle>Installed Directories</segtitle>
|
---|
[481b3e8] | 264 |
|
---|
[6b9cfc9] | 265 | <seglistitem>
|
---|
[2561ad9e] | 266 | <seg>flea, mutt, mutt_dotlock, muttbug, pgpewrap, pgpring, and
|
---|
| 267 | smime_keys</seg>
|
---|
[6b9cfc9] | 268 | <seg>None</seg>
|
---|
[2561ad9e] | 269 | <seg>/usr/share/doc/mutt-&mutt-version;</seg>
|
---|
[6b9cfc9] | 270 | </seglistitem>
|
---|
| 271 | </segmentedlist>
|
---|
[481b3e8] | 272 |
|
---|
[6b9cfc9] | 273 | <variablelist>
|
---|
| 274 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 275 | <?dbfo list-presentation="list"?>
|
---|
| 276 | <?dbhtml list-presentation="table"?>
|
---|
[481b3e8] | 277 |
|
---|
[6b9cfc9] | 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>
|
---|
[481b3e8] | 287 |
|
---|
[6b9cfc9] | 288 | <varlistentry id="mutt-prog">
|
---|
| 289 | <term><command>mutt</command></term>
|
---|
| 290 | <listitem>
|
---|
[2561ad9e] | 291 | <para>is a Mail User Agent (MUA) which enables you to read, write
|
---|
| 292 | and delete your email.</para>
|
---|
[6b9cfc9] | 293 | <indexterm zone="mutt mutt-prog">
|
---|
| 294 | <primary sortas="b-mutt">mutt</primary>
|
---|
| 295 | </indexterm>
|
---|
| 296 | </listitem>
|
---|
| 297 | </varlistentry>
|
---|
[481b3e8] | 298 |
|
---|
[6b9cfc9] | 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>
|
---|
[481b3e8] | 308 |
|
---|
[6b9cfc9] | 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">
|
---|
[e2abad8e] | 314 | <primary sortas="b-muttbug">muttbug</primary>
|
---|
[6b9cfc9] | 315 | </indexterm>
|
---|
| 316 | </listitem>
|
---|
| 317 | </varlistentry>
|
---|
[481b3e8] | 318 |
|
---|
[2561ad9e] | 319 | <varlistentry id="pgpewrap">
|
---|
| 320 | <term><command>pgpewrap</command></term>
|
---|
| 321 | <listitem>
|
---|
[f82ac3f] | 322 | <para>prepares a command line for the <xref linkend="gnupg2"/>
|
---|
[2561ad9e] | 323 | utilities.</para>
|
---|
| 324 | <indexterm zone="mutt pgpewrap">
|
---|
[e2abad8e] | 325 | <primary sortas="b-pgpewrap">pgpewrap</primary>
|
---|
[2561ad9e] | 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
|
---|
[f82ac3f] | 335 | <xref linkend="gnupg2"/>.</para>
|
---|
[2561ad9e] | 336 | <indexterm zone="mutt pgpring">
|
---|
[e2abad8e] | 337 | <primary sortas="b-pgpring">pgpring</primary>
|
---|
[2561ad9e] | 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">
|
---|
[e2abad8e] | 347 | <primary sortas="b-smime_keys">smime_keys</primary>
|
---|
[2561ad9e] | 348 | </indexterm>
|
---|
| 349 | </listitem>
|
---|
| 350 | </varlistentry>
|
---|
| 351 |
|
---|
[6b9cfc9] | 352 | </variablelist>
|
---|
[481b3e8] | 353 |
|
---|
[6b9cfc9] | 354 | </sect2>
|
---|
[481b3e8] | 355 |
|
---|
[f45b1953] | 356 | </sect1>
|
---|