summaryrefslogtreecommitdiffstats
path: root/doc/mutt.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/mutt.sgml')
-rw-r--r--doc/mutt.sgml181
1 files changed, 181 insertions, 0 deletions
diff --git a/doc/mutt.sgml b/doc/mutt.sgml
new file mode 100644
index 00000000..169fe056
--- /dev/null
+++ b/doc/mutt.sgml
@@ -0,0 +1,181 @@
+<!doctype linuxdoc system>
+
+<manpage title="Mutt" sectnum="1">
+
+<sect1>NAME
+<p>
+mutt - The Mutt Mail User Agent
+
+<sect1>SYNOPSIS
+<p>
+mutt &lsqb; -hnpRvxyzZ &rsqb;
+&lsqb; -a <em/file/ &rsqb;
+&lsqb; -b <em/address/ &rsqb;
+&lsqb; -c <em/address/ &rsqb;
+&lsqb; -e <em/command/ &rsqb;
+&lsqb; -f <em/mailbox/ &rsqb;
+&lsqb; -F <em/muttrc/ &rsqb;
+&lsqb; -H <em/draftfile/ &rsqb;
+&lsqb; -i <em/include/ &rsqb;
+&lsqb; -m <em/type/ &rsqb;
+&lsqb; -s <em/subject/ &rsqb;
+&lsqb <em/address/ ... &rsqb;
+
+<sect1>DESCRIPTION
+<p>
+Mutt is a small but very powerful text based program for reading electronic
+mail under unix operating systems, including support color terminals, MIME,
+and a threaded sorting mode.
+
+<sect1>OPTIONS
+<p>
+<descrip>
+<tag>-a <em/file/
+<p>
+Attach a file to your message using MIME.
+<tag>-b <em/address/
+<p>
+Specify a blind-carbon-copy (BCC) recipient
+<tag>-c <em/address/
+<p>
+Specify a carbon-copy (CC) recipient
+<tag>-e <em/command/
+<p>
+Specify a configuration command to be run after processing of initialization
+files.
+<tag>-f <em/mailbox/
+<p>
+Specify which mailbox to load.
+<tag>-F <em/muttrc/
+<p>
+Specify an initialization file to read instead of &tilde;/.muttrc
+<tag>-h
+<p>
+Display help.
+<tag>-H <em/draft/
+<p>
+Specify a draft file which contains header and body to use to send a
+message.
+<tag>-i <em/include/
+<p>
+Specify a file to include into the body of a message.
+<tag>-m <em/type/
+<p>
+specify a default mailbox type
+<tag>-n
+<p>
+Causes Mutt to bypass the system configuration file.
+<tag>-p
+<p>
+Resume a postponed message.
+<tag>-R
+<p>
+Open a mailbox in <em/read-only/ mode.
+<tag>-s <em/subject/
+<p>
+Specify the subject of the message.
+<tag>-v
+<p>
+Display the Mutt version number and compile-time definitions.
+<tag>-x
+<p>
+Emulate the mailx compose mode.
+<tag>-y
+<p>
+Start Mutt with a listing of all mailboxes specified by the <em/mailboxes/
+command.
+<tag>-z
+<p>
+When used with -f, causes Mutt not to start if there are no messages in the
+mailbox.
+<tag>-Z
+<p>
+Causes Mutt to open the first mailbox specified by the <em/mailboxes/
+command which contains new mail.
+</descrip>
+
+<sect1>ENVIRONMENT
+<p>
+<descrip>
+<tag>EDITOR
+<p>
+Editor to invoke when composing a message.
+<tag>HOME
+<p>
+Full path of the user's home directory.
+<tag>MAIL
+<p>
+Full path of the user's spool mailbox.
+<tag>MAILCAPS
+<p>
+Path to search for mailcap files.
+<tag>MM_NOASK
+<p>
+If this variable is set, mailcap are always used without prompting first.
+<tag>PGPPATH
+<p>
+Directory in which the user's PGP public keyring can be found.
+<tag>TMPDIR
+<p>
+Directory in which temporary files are created.
+<tag>REPLYTO
+<p>
+Default Reply-To address.
+<tag>VISUAL
+<p>
+Editor to invoke when the &tilde;v command is given in the builtin editor.
+</descrip>
+
+<sect1>FILES
+<p>
+<descrip>
+<tag>&tilde;/.muttrc
+<p>
+User configuration file.
+<tag>/usr/local/share/Muttrc
+<p>
+System-wide configuration file.
+<tag>/tmp/muttXXXXXX
+<p>
+Temporary files created by Mutt.
+<tag>&tilde;/.mailcap
+<p>
+User definition for handling non-text MIME types.
+<tag>/usr/local/share/mailcap
+<p>
+System definition for handing non-text MIME types.
+<tag>&tilde;/.mime.types
+<p>
+User's personal mapping between MIME types and file extensions.
+<tag>/usr/local/share/mime.types
+<p>
+System mapping between MIME types and file extensions.
+<p>
+</descrip>
+
+<sect1>BUGS
+<p>
+suspend/resume while editing a file with an external editor does not work
+under SunOS 4.x if you use the curses lib in /usr/5lib. It <em/does/ work
+with the S-Lang library, however.
+<p>
+Resizing the screen while using an external pager causes Mutt to go haywire
+on some systems.
+<p>
+suspend/resume does not work under Ultrix.
+<p>
+The help line for the index menu is not updated if you change the bindings
+for one of the functions listed while Mutt is running.
+
+<sect1>SEE ALSO
+<p>
+curses(3), ncurses(3), sendmail(1), smail(1), mailcap(5)
+<p>
+Mutt Home Page: http://www.cs.hmc.edu/&tilde;me/mutt/
+
+<sect1>AUTHOR
+<p>
+Michael Elkins &lt;me@cs.hmc.edu&gt;
+<p>
+http://www.cs.hmc.edu/&tilde;me
+</manpage>