Nico Golde
[apps/madmutt.git] / doc / mutt.man
1 .\" -*-nroff-*-
2 .\"
3 .\"
4 .\"     Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu>
5 .\" 
6 .\"     This program is free software; you can redistribute it and/or modify
7 .\"     it under the terms of the GNU General Public License as published by
8 .\"     the Free Software Foundation; either version 2 of the License, or
9 .\"     (at your option) any later version.
10 .\" 
11 .\"     This program is distributed in the hope that it will be useful,
12 .\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
13 .\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 .\"     GNU General Public License for more details.
15 .\" 
16 .\"     You should have received a copy of the GNU General Public License
17 .\"     along with this program; if not, write to the Free Software
18 .\"     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
19 .\"
20 .TH mutt-ng 1 Unix "User Manuals"
21 .SH NAME
22 mutt-ng \- The Mutt-ng Mail User Agent
23 .SH SYNOPSIS
24 .PP
25 .B muttng
26 [-GnRyzZ] 
27 [-e \fIcmd\fP] [-F \fIfile\fP] [-g \fIserver\fP] [-m \fItype\fP] [-f \fIfile\fP]
28 .PP
29 .B muttng 
30 [-nx] 
31 [-e \fIcmd\fP] 
32 [-a \fIfile\fP]
33 [-F \fIfile\fP]
34 [-H \fIfile\fP]
35 [-i \fIfile\fP]
36 [-s \fIsubj\fP]
37 [-b \fIaddr\fP]
38 [-c \fIaddr\fP] \fIaddr\fP [...]
39 .PP
40 .B muttng
41 [-n] [-e \fIcmd\fP] [-F \fIfile\fP] -p
42 .PP
43 .B muttng
44 [-n] [-e \fIcmd\fP] [-F \fIfile\fP] -Q \fIquery\fP
45 .PP
46 .B muttng
47 [-n] [-e \fIcmd\fP] [-F \fIfile\fP] -A \fIalias\fP
48 .PP
49 .B muttng
50 -v[v]
51 .SH DESCRIPTION
52 .PP
53 Mutt-ng is a small but very powerful text based program for reading electronic
54 mail under unix operating systems, including support color terminals, MIME,
55 and a threaded sorting mode.
56 .SH OPTIONS
57 .PP
58 .IP "-A \fIalias\fP"
59 An expanded version of the given alias is passed to stdout.
60 .IP "-a \fIfile\fP"
61 Attach a file to your message using MIME.
62 .IP "-b \fIaddress\fP"
63 Specify a blind-carbon-copy (BCC) recipient
64 .IP "-c \fIaddress\fP"
65 Specify a carbon-copy (CC) recipient
66 .IP "-e \fIcommand\fP"
67 Specify a configuration command to be run after processing of initialization
68 files.
69 .IP "-f \fImailbox\fP"
70 Specify which mailbox to load.
71 .IP "-F \fImuttngrc\fP"
72 Specify an initialization file to read instead of ~/.muttngrc
73 .IP "-g \fIserver\fP"
74 Start Mutt-ng with a listing of subscribed newsgroups at specified newsserver.
75 .IP "-G"
76 Start Mutt-ng with a listing of subscribed newsgroups.
77 .IP "-h"
78 Display help.
79 .IP "-H \fIdraft\fP"
80 Specify a draft file which contains header and body to use to send a
81 message.
82 .IP "-i \fIinclude\fP"
83 Specify a file to include into the body of a message.
84 .IP "-m \fItype\fP       "
85 specify a default mailbox type
86 .IP "-n"
87 Causes Mutt-ng to bypass the system configuration file.
88 .IP "-p"
89 Resume a postponed message.
90 .IP "-Q \fIquery\fP"
91 Query a configuration variables value.  The query is executed after
92 all configuration files have been parsed, and any commands given on
93 the command line have been executed.
94 .IP "-R"
95 Open a mailbox in \fIread-only\fP mode.
96 .IP "-s \fIsubject\fP"
97 Specify the subject of the message.
98 .IP "-v"
99 Display the Mutt-ng version number and compile-time definitions.
100 .IP "-x"
101 Emulate the mailx compose mode.
102 .IP "-y"
103 Start Mutt-ng with a listing of all mailboxes specified by the \fImailboxes\fP
104 command.
105 .IP "-z"
106 When used with -f, causes Mutt-ng not to start if there are no messages in the
107 mailbox.
108 .IP "-Z"
109 Causes Mutt-ng to open the first mailbox specified by the \fImailboxes\fP
110 command which contains new mail.
111 .SH ENVIRONMENT
112 .PP
113 .IP "EDITOR"
114 Specifies the editor to use if VISUAL is unset.
115 .IP "EMAIL"
116 The user's e-mail address.
117 .IP "HOME"
118 Full path of the user's home directory.
119 .IP "MAIL"
120 Full path of the user's spool mailbox.
121 .IP "MAILDIR"
122 Full path of the user's spool mailbox.  Commonly used when the spool
123 mailbox is a 
124 .B maildir (5)
125 folder.
126 .IP "MAILCAPS"
127 Path to search for mailcap files.
128 .IP "MM_NOASK"
129 If this variable is set, mailcap are always used without prompting first.
130 .IP "PGPPATH"
131 Directory in which the user's PGP public keyring can be found.
132 .IP "TMPDIR"
133 Directory in which temporary files are created.
134 .IP "REPLYTO"
135 Default Reply-To address.
136 .IP "VISUAL"
137 Specifies the editor to use when composing messages.
138 .SH FILES
139 .PP
140 .IP "~/.muttngrc or ~/.muttng/muttngrc"
141 User configuration file.
142 .IP "/etc/Muttngrc"
143 System-wide configuration file.
144 .IP "/tmp/muttXXXXXX"
145 Temporary files created by Mutt-ng.
146 .IP "~/.mailcap"
147 User definition for handling non-text MIME types.
148 .IP "/etc/mailcap"
149 System definition for handling non-text MIME types.
150 .IP "~/.mime.types"
151 User's personal mapping between MIME types and file extensions.
152 .IP "/etc/mime.types"
153 System mapping between MIME types and file extensions.
154 .IP "/usr/local/bin/muttng_dotlock"
155 The privileged dotlocking program.
156 .IP "/usr/local/doc/muttng/manual.txt"
157 The Mutt-ng manual.
158 .SH BUGS
159 .PP
160 None.  Mutts have fleas, not bugs.
161 .SH FLEAS
162 .PP
163 Suspend/resume while editing a file with an external editor does not work
164 under SunOS 4.x if you use the curses lib in /usr/5lib.  It \fIdoes\fP work
165 with the S-Lang library, however.
166 .PP
167 Resizing the screen while using an external pager causes Mutt-ng to go haywire
168 on some systems.
169 .PP
170 suspend/resume does not work under Ultrix.
171 .PP
172 The help line for the index menu is not updated if you change the bindings
173 for one of the functions listed while Mutt-ng is running.
174 .PP
175 For a more up-to-date list of bugs, errm, fleas, please visit the
176 mutt-ng project's bug tracking system under http://developer.berlios.de/projects/mutt-ng/.  To
177 report a bug, please use the
178 .BR flea (1)
179 program.
180 .SH NO WARRANTIES
181 This program is distributed in the hope that it will be useful,
182 but WITHOUT ANY WARRANTY; without even the implied warranty of
183 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
184 GNU General Public License for more details.
185 .SH SEE ALSO
186 .PP
187 .BR curses (3),
188 .BR flea (1),
189 .BR mailcap (5),
190 .BR maildir (5),
191 .BR mbox (5),
192 .BR muttng_dotlock (1),
193 .BR muttngrc (5),
194 .BR ncurses (3),
195 .BR sendmail (1),
196 .BR smail (1)
197 .PP
198 Mutt-ng Home Page: http://mutt-ng.berlios.de
199 .PP
200 The Mutt-ng manual
201 .PP
202 The GNU General Public License.
203 .SH AUTHOR
204 .PP
205 Michael Elkins, and others.  Use <mutt-ng-devel@lists.berlios.de> to contact
206 the developers.