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