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