[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 |
|
---|
[30910871] | 7 | <!ENTITY mutt-download-http " ">
|
---|
[7e39ba39] | 8 | <!ENTITY mutt-download-ftp "ftp://ftp.mutt.org/pub/mutt/mutt-&mutt-version;.tar.gz">
|
---|
[320084b] | 9 | <!ENTITY mutt-md5sum "2cfaabbf0c0ef74cff9af2a0a30de30d">
|
---|
[75353b0] | 10 | <!ENTITY mutt-size "4.1 MB">
|
---|
[07b1366e] | 11 | <!ENTITY mutt-buildsize "39 MB (plus a further 5MB for the PDF manual)">
|
---|
[320084b] | 12 | <!ENTITY mutt-time "0.3 SBU (plus a further 0.2 SBU to build the PDF manual)">
|
---|
[bfe245f] | 13 | ]>
|
---|
| 14 |
|
---|
[377584f] | 15 | <sect1 id="mutt" xreflabel="Mutt-&mutt-version;">
|
---|
[6b9cfc9] | 16 | <?dbhtml filename="mutt.html"?>
|
---|
[481b3e8] | 17 |
|
---|
[6b9cfc9] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[481b3e8] | 22 |
|
---|
[6b9cfc9] | 23 | <title>Mutt-&mutt-version;</title>
|
---|
[481b3e8] | 24 |
|
---|
[8134bed] | 25 | <indexterm zone="mutt">
|
---|
| 26 | <primary sortas="a-mutt">mutt</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
[6b9cfc9] | 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Mutt</title>
|
---|
[481b3e8] | 31 |
|
---|
[2561ad9e] | 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>
|
---|
[481b3e8] | 35 |
|
---|
[6d2249e] | 36 | &lfs82_checked;
|
---|
[06f76d2c] | 37 |
|
---|
[6b9cfc9] | 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>
|
---|
[481b3e8] | 59 |
|
---|
[7e39ba39] | 60 | <!--<bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
[128db10c] | 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>
|
---|
[7e39ba39] | 67 | </itemizedlist>-->
|
---|
[128db10c] | 68 |
|
---|
[6b9cfc9] | 69 | <bridgehead renderas="sect3">Mutt Dependencies</bridgehead>
|
---|
[481b3e8] | 70 |
|
---|
[6b9cfc9] | 71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[f82ac3f] | 72 | <para role="optional">
|
---|
| 73 | <xref linkend="aspell"/>,
|
---|
| 74 | <xref linkend="cyrus-sasl"/>,
|
---|
[05b0caac] | 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>,
|
---|
[f82ac3f] | 79 | <xref linkend="libidn"/>,
|
---|
[05b0caac] | 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"/>,
|
---|
[f82ac3f] | 85 | <xref linkend="db"/> or
|
---|
[05b0caac] | 86 | <ulink url="http://fallabs.com/qdbm/">QDBM</ulink> or
|
---|
| 87 | <ulink url="http://fallabs.com/tokyocabinet/">Tokyo Cabinet</ulink>
|
---|
[4d91d36c] | 88 | </para>
|
---|
[481b3e8] | 89 |
|
---|
[2561ad9e] | 90 | <bridgehead renderas="sect4">Optional (To Regenerate HTML
|
---|
| 91 | Documentation)</bridgehead>
|
---|
[f82ac3f] | 92 | <para role="optional">
|
---|
| 93 | <xref linkend="libxslt"/> and either
|
---|
| 94 | <xref linkend="lynx"/>,
|
---|
[aadebdcc] | 95 | <xref linkend="w3m"/>, or
|
---|
[f82ac3f] | 96 | <ulink url="http://elinks.or.cz/">ELinks</ulink>
|
---|
| 97 | </para>
|
---|
[2561ad9e] | 98 |
|
---|
| 99 | <bridgehead renderas="sect4">Optional (To Generate PDF Manual)</bridgehead>
|
---|
[3f8a5e2] | 100 | <para role="optional">
|
---|
[05b0caac] | 101 | <xref linkend="docbook-dsssl"/>,
|
---|
[aadebdcc] | 102 | <xref linkend="openjade"/>, and
|
---|
[f720ace1] | 103 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
|
---|
[3f8a5e2] | 104 | </para>
|
---|
[8ae8678b] | 105 |
|
---|
[061ec9d] | 106 | <para condition="html" role="usernotes">User Notes:
|
---|
| 107 | <ulink url="&blfs-wiki;/mutt"/></para>
|
---|
| 108 |
|
---|
[6b9cfc9] | 109 | </sect2>
|
---|
[481b3e8] | 110 |
|
---|
[6b9cfc9] | 111 | <sect2 role="installation">
|
---|
| 112 | <title>Installation of Mutt</title>
|
---|
[481b3e8] | 113 |
|
---|
| 114 | <para><application>Mutt</application> requires a group named
|
---|
| 115 | <systemitem class="groupname">mail</systemitem>. You can
|
---|
[6b9cfc9] | 116 | add this group, if it does not exist, with this command:</para>
|
---|
[481b3e8] | 117 |
|
---|
[b785ab29] | 118 | <screen role="root"><userinput>groupadd -g 34 mail</userinput></screen>
|
---|
[481b3e8] | 119 |
|
---|
[af8e3ea3] | 120 | <para>If you did not install an <xref linkend="server-mail"/>, you need to
|
---|
| 121 | modify the ownership of <filename class="directory">/var/mail</filename>
|
---|
| 122 | with this command:</para>
|
---|
[481b3e8] | 123 |
|
---|
[e3353b3] | 124 | <screen role="root"><userinput>chgrp -v mail /var/mail</userinput></screen>
|
---|
[481b3e8] | 125 |
|
---|
[7e39ba39] | 126 | <para><application>Mutt</application> will rebuild the html documentation
|
---|
| 127 | if <application>libxslt</application> is present, then use that to update
|
---|
| 128 | the text manual - even if none of the specified browsers are present. That
|
---|
| 129 | will create an empty text file, so we will save the shipped file.
|
---|
| 130 | </para>
|
---|
| 131 |
|
---|
[481b3e8] | 132 | <para>Install <application>Mutt</application> by running the following
|
---|
[6b9cfc9] | 133 | commands:</para>
|
---|
[481b3e8] | 134 |
|
---|
[75353b0] | 135 | <screen><userinput>./configure --prefix=/usr \
|
---|
[0f0774a] | 136 | --sysconfdir=/etc \
|
---|
[2188f69] | 137 | --with-docdir=/usr/share/doc/mutt-&mutt-version; \
|
---|
[0f0774a] | 138 | --enable-external-dotlock \
|
---|
| 139 | --enable-pop \
|
---|
| 140 | --enable-imap \
|
---|
[a1494226] | 141 | --enable-hcache \
|
---|
| 142 | --enable-sidebar &&
|
---|
[75353b0] | 143 | make</userinput></screen>
|
---|
[2561ad9e] | 144 |
|
---|
[3f8a5e2] | 145 | <para>To generate the PDF manual with <xref linkend="texlive"/>, run
|
---|
[25f9f1f] | 146 | the following command:</para>
|
---|
[2561ad9e] | 147 |
|
---|
| 148 | <screen><userinput>make -C doc manual.pdf</userinput></screen>
|
---|
| 149 |
|
---|
[46441976] | 150 | <para>This package does not come with a test suite.</para>
|
---|
| 151 |
|
---|
| 152 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 153 |
|
---|
| 154 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
[481b3e8] | 155 |
|
---|
[0f0774a] | 156 | <para>If you generated the PDF manual, install it
|
---|
| 157 | by issuing the following command as the
|
---|
[25f9f1f] | 158 | <systemitem class="username">root</systemitem> user:</para>
|
---|
[2561ad9e] | 159 |
|
---|
[0f0774a] | 160 | <screen role='root'><userinput>install -v -m644 doc/manual.pdf \
|
---|
[2561ad9e] | 161 | /usr/share/doc/mutt-&mutt-version;</userinput></screen>
|
---|
| 162 |
|
---|
[0f0774a] | 163 | <note>
|
---|
| 164 | <para>
|
---|
| 165 | If you used a DESTDIR method to only install to a temporary location as
|
---|
| 166 | a regular user (as part of a package menagement process), you will need
|
---|
| 167 | to run the following as the <systemitem class="username">root</systemitem>
|
---|
| 168 | user after completing the real install:
|
---|
| 169 | </para>
|
---|
| 170 |
|
---|
| 171 | <screen role="nodump"><userinput>chown root:mail /usr/bin/mutt_dotlock &&
|
---|
[51cfeac9] | 172 | chmod -v 2755 /usr/bin/mutt_dotlock</userinput></screen>
|
---|
[0f0774a] | 173 | </note>
|
---|
| 174 |
|
---|
| 175 |
|
---|
[6b9cfc9] | 176 | </sect2>
|
---|
[481b3e8] | 177 |
|
---|
[6b9cfc9] | 178 | <sect2 role="commands">
|
---|
[e3353b3] | 179 | <title>Command Explanations</title>
|
---|
[481b3e8] | 180 |
|
---|
[0f0774a] | 181 | <para><parameter>--enable-external-dotlock</parameter>: In some circumstances
|
---|
| 182 | the mutt-dotlock program is not created. This switch ensures it is always
|
---|
| 183 | created.</para>
|
---|
| 184 |
|
---|
[6b9cfc9] | 185 | <para><parameter>--enable-pop</parameter>: This switch enables
|
---|
[481b3e8] | 186 | POP3 support.</para>
|
---|
| 187 |
|
---|
[6b9cfc9] | 188 | <para><parameter>--enable-imap</parameter>: This switch enables
|
---|
[481b3e8] | 189 | IMAP support.</para>
|
---|
[fd7e0ed6] | 190 |
|
---|
[4d91d36c] | 191 | <para><parameter>--enable-hcache</parameter>: This switch enables
|
---|
| 192 | header caching.</para>
|
---|
| 193 |
|
---|
[a1494226] | 194 | <para><parameter>--enable-sidebar</parameter>: This switch enables support
|
---|
| 195 | for the sidebar (a list of mailboxes). It is off by default, but can be
|
---|
| 196 | turned on by <command>:set sidebar_visible</command> in mutt (and off again
|
---|
| 197 | with ':unset'), or it can be enabled in <filename>~/.muttrc</filename>.</para>
|
---|
| 198 |
|
---|
[a93934d2] | 199 | <para><option>--enable-smtp</option>: This switch enables
|
---|
[2561ad9e] | 200 | SMTP relay support.</para>
|
---|
| 201 |
|
---|
[a93934d2] | 202 | <para><option>--with-ssl</option>: This parameter adds SSL/TLS
|
---|
[94b42903] | 203 | support from openssl in POP3/IMAP/SMTP.</para>
|
---|
[156638b] | 204 |
|
---|
[a93934d2] | 205 | <para><option>--with-sasl</option>: This parameter adds
|
---|
[156638b] | 206 | authentication support from <xref linkend="cyrus-sasl"/> in POP3/IMAP/SMTP
|
---|
| 207 | if they are enabled. Depending on the server configuration, this may not
|
---|
| 208 | be needed for POP3 or IMAP. However, it is needed for SMTP
|
---|
| 209 | authentication.</para>
|
---|
[a41f643] | 210 |
|
---|
[0f0774a] | 211 | <!-- we do not normally list all possible switches. LFS installs ncurses.
|
---|
| 212 | <para><option>\-\-with-slang</option>: Use <application>S-Lang
|
---|
| 213 | </application> instead of <application>Ncurses</application>.</para> -->
|
---|
[126e7ea2] | 214 |
|
---|
[0b7a940] | 215 | <para><command>test -s doc/manual.txt || mv -v doc/manual.txt{.shipped,}</command>:
|
---|
[f7841987] | 216 | if the text manual is now empty (<application>libxslt</application> is
|
---|
| 217 | installed, but without any of the specified text browsers), restore it
|
---|
| 218 | from the copy.</para>
|
---|
[7e39ba39] | 219 |
|
---|
[6b9cfc9] | 220 | </sect2>
|
---|
[481b3e8] | 221 |
|
---|
[6b9cfc9] | 222 | <sect2 role="configuration">
|
---|
| 223 | <title>Configuring Mutt</title>
|
---|
[481b3e8] | 224 |
|
---|
[6b9cfc9] | 225 | <sect3 id="mutt-config">
|
---|
[e3353b3] | 226 | <title>Config Files</title>
|
---|
[481b3e8] | 227 |
|
---|
[6b9cfc9] | 228 | <para><filename>/etc/Muttrc</filename>, <filename>~/.muttrc</filename>,
|
---|
| 229 | <filename>/etc/mime.types</filename>, <filename>~/.mime.types</filename></para>
|
---|
[481b3e8] | 230 |
|
---|
[6b9cfc9] | 231 | <indexterm zone="mutt mutt-config">
|
---|
| 232 | <primary sortas="e-etc-Muttrc">/etc/Muttrc</primary>
|
---|
| 233 | </indexterm>
|
---|
[481b3e8] | 234 |
|
---|
[6b9cfc9] | 235 | <indexterm zone="mutt mutt-config">
|
---|
| 236 | <primary sortas="e-AA.muttrc">~/.muttrc</primary>
|
---|
| 237 | </indexterm>
|
---|
[481b3e8] | 238 |
|
---|
[6b9cfc9] | 239 | <indexterm zone="mutt mutt-config">
|
---|
| 240 | <primary sortas="e-etc-mime.types">/etc/mime.types</primary>
|
---|
| 241 | </indexterm>
|
---|
[481b3e8] | 242 |
|
---|
[6b9cfc9] | 243 | <indexterm zone="mutt mutt-config">
|
---|
| 244 | <primary sortas="e-AA.mime.types">~/.mime.types</primary>
|
---|
| 245 | </indexterm>
|
---|
[481b3e8] | 246 |
|
---|
[6b9cfc9] | 247 | </sect3>
|
---|
[481b3e8] | 248 |
|
---|
[6b9cfc9] | 249 | <sect3>
|
---|
| 250 | <title>Configuration Information</title>
|
---|
[481b3e8] | 251 |
|
---|
[6b9cfc9] | 252 | <para>No changes in these files are necessary to begin using
|
---|
[481b3e8] | 253 | <application>Mutt</application>. When you are ready to make changes, the
|
---|
[6b9cfc9] | 254 | man page for <filename>muttrc</filename> is a good starting place.</para>
|
---|
[481b3e8] | 255 |
|
---|
| 256 | <para>In order to utilize <application>GnuPG</application>, use the following
|
---|
[6b9cfc9] | 257 | command:</para>
|
---|
[481b3e8] | 258 |
|
---|
[2561ad9e] | 259 | <screen><userinput>cat /usr/share/doc/mutt-&mutt-version;/samples/gpg.rc >> ~/.muttrc</userinput></screen>
|
---|
[481b3e8] | 260 |
|
---|
[6b9cfc9] | 261 | </sect3>
|
---|
[481b3e8] | 262 |
|
---|
[6b9cfc9] | 263 | </sect2>
|
---|
[481b3e8] | 264 |
|
---|
[6b9cfc9] | 265 | <sect2 role="content">
|
---|
| 266 | <title>Contents</title>
|
---|
[481b3e8] | 267 |
|
---|
[6b9cfc9] | 268 | <segmentedlist>
|
---|
| 269 | <segtitle>Installed Programs</segtitle>
|
---|
| 270 | <segtitle>Installed Libraries</segtitle>
|
---|
| 271 | <segtitle>Installed Directories</segtitle>
|
---|
[481b3e8] | 272 |
|
---|
[6b9cfc9] | 273 | <seglistitem>
|
---|
[320084b] | 274 | <seg>mutt, mutt_dotlock, pgpewrap, pgpring, and
|
---|
[2561ad9e] | 275 | smime_keys</seg>
|
---|
[6b9cfc9] | 276 | <seg>None</seg>
|
---|
[2561ad9e] | 277 | <seg>/usr/share/doc/mutt-&mutt-version;</seg>
|
---|
[6b9cfc9] | 278 | </seglistitem>
|
---|
| 279 | </segmentedlist>
|
---|
[481b3e8] | 280 |
|
---|
[6b9cfc9] | 281 | <variablelist>
|
---|
| 282 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 283 | <?dbfo list-presentation="list"?>
|
---|
| 284 | <?dbhtml list-presentation="table"?>
|
---|
[481b3e8] | 285 |
|
---|
[6b9cfc9] | 286 | <varlistentry id="mutt-prog">
|
---|
| 287 | <term><command>mutt</command></term>
|
---|
| 288 | <listitem>
|
---|
[2561ad9e] | 289 | <para>is a Mail User Agent (MUA) which enables you to read, write
|
---|
| 290 | and delete your email.</para>
|
---|
[6b9cfc9] | 291 | <indexterm zone="mutt mutt-prog">
|
---|
| 292 | <primary sortas="b-mutt">mutt</primary>
|
---|
| 293 | </indexterm>
|
---|
| 294 | </listitem>
|
---|
| 295 | </varlistentry>
|
---|
[481b3e8] | 296 |
|
---|
[6b9cfc9] | 297 | <varlistentry id="mutt_dotlock">
|
---|
| 298 | <term><command>mutt_dotlock</command></term>
|
---|
| 299 | <listitem>
|
---|
| 300 | <para>implements the mail spool file lock.</para>
|
---|
| 301 | <indexterm zone="mutt mutt_dotlock">
|
---|
| 302 | <primary sortas="b-mutt_dotlock">mutt_dotlock</primary>
|
---|
| 303 | </indexterm>
|
---|
| 304 | </listitem>
|
---|
| 305 | </varlistentry>
|
---|
[481b3e8] | 306 |
|
---|
[2561ad9e] | 307 | <varlistentry id="pgpewrap">
|
---|
| 308 | <term><command>pgpewrap</command></term>
|
---|
| 309 | <listitem>
|
---|
[f82ac3f] | 310 | <para>prepares a command line for the <xref linkend="gnupg2"/>
|
---|
[2561ad9e] | 311 | utilities.</para>
|
---|
| 312 | <indexterm zone="mutt pgpewrap">
|
---|
[e2abad8e] | 313 | <primary sortas="b-pgpewrap">pgpewrap</primary>
|
---|
[2561ad9e] | 314 | </indexterm>
|
---|
| 315 | </listitem>
|
---|
| 316 | </varlistentry>
|
---|
| 317 |
|
---|
| 318 | <varlistentry id="pgpring">
|
---|
| 319 | <term><command>pgpring</command></term>
|
---|
| 320 | <listitem>
|
---|
| 321 | <para>is a key ring dumper for <ulink
|
---|
| 322 | url="http://www.pgp.com/">PGP</ulink>. It is not needed for
|
---|
[f82ac3f] | 323 | <xref linkend="gnupg2"/>.</para>
|
---|
[2561ad9e] | 324 | <indexterm zone="mutt pgpring">
|
---|
[e2abad8e] | 325 | <primary sortas="b-pgpring">pgpring</primary>
|
---|
[2561ad9e] | 326 | </indexterm>
|
---|
| 327 | </listitem>
|
---|
| 328 | </varlistentry>
|
---|
| 329 |
|
---|
| 330 | <varlistentry id="smime_keys">
|
---|
| 331 | <term><command>smime_keys</command></term>
|
---|
| 332 | <listitem>
|
---|
| 333 | <para>manages a keystore for S/MIME certificates.</para>
|
---|
| 334 | <indexterm zone="mutt smime_keys">
|
---|
[e2abad8e] | 335 | <primary sortas="b-smime_keys">smime_keys</primary>
|
---|
[2561ad9e] | 336 | </indexterm>
|
---|
| 337 | </listitem>
|
---|
| 338 | </varlistentry>
|
---|
| 339 |
|
---|
[6b9cfc9] | 340 | </variablelist>
|
---|
[481b3e8] | 341 |
|
---|
[6b9cfc9] | 342 | </sect2>
|
---|
[481b3e8] | 343 |
|
---|
[f45b1953] | 344 | </sect1>
|
---|