2007-01-08 [paul] 2.6.1cvs118
[claws.git] / doc / man / claws-mail.1
1 .TH "Claws Mail" "1" "" "Hiroyuki Yamamoto & the Claws Mail team" ""
2 .SH "DESCRIPTION"
3 .TP 
4 Claws Mail is an email client (and news reader) based on GTK+, running on X Window System, and aiming for
5 .br 
6 * Quick response
7 .br 
8 * Graceful, and sophisticated interface
9 .br 
10 * Easy configuration, intuitive operation
11 .br 
12 * Abundant features
13 \fR
14 .TP 
15 Currently implemented features include:
16 o POP3 support
17 .br 
18 o IMAP4rev1 support
19 .br 
20 o integrated NetNews client
21 .br 
22 o unlimited multiple account handling
23 .br 
24 o thread display
25 .br 
26 o filtering
27 .br 
28 o MIME (attachments)
29 .br 
30 o built\-in image view
31 .br 
32 o X\-Face support
33 .br 
34 o multiple MH folder support
35 .br 
36 o mbox importing / exporting
37 .br 
38 o external editor support
39 .br 
40 o message queueing
41 .br 
42 o automatic mail checking
43 .br 
44 o draft message function
45 .br 
46 o template function
47 .br 
48 o line\-wrapping
49 .br 
50 o clickable URI
51 .br 
52 o XML\-based address book
53 .br 
54 o LDAP, vCard, and JPilot support
55 .br 
56 o newly arrived and unread message management
57 .br 
58 o Mew/Wanderlust\-like key bind
59 .br 
60 o printing
61 .br 
62 o APOP authentication support
63 .br 
64 o SMTP AUTH support
65 .br 
66 o SSL support (POP3, SMTP, IMAP4rev1)
67 .br 
68 o IPv6 support
69 .br 
70 o drag & drop (partially implemented)
71 .br 
72 o GnuPG support (currently implementing)
73 .br 
74 o automake + autoconf support
75 .br 
76 o internationalization of messages by gettext
77 .br 
78 o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
79 .br 
80 o support for plugins
81 \fR
82 .LP 
83 This list is not complete.
84 .SH "NAME"
85 .LP 
86 Claws Mail \- a GTK+ based fast email and news client
87 .SH "OPTIONS"
88 .LP 
89 \fB \-\-compose\fR [address]
90 .br 
91 \fB \-\-subscribe\fR [uri]
92 .br 
93 \fB \-\-attach file1 [file2]...\fR
94 .br 
95 \fB \-\-receive\fR
96 .br 
97 \fB \-\-receive\-all\fR
98 .br 
99 \fB \-\-send\fR
100 .br 
101 \fB \-\-status\fR
102 .br 
103 \fB \-\-status folder[/subfolder]\fR
104 .br 
105 \fB \-\-status\-full\fR
106 .br 
107 \fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
108 .br 
109 \fB \-\-online\fR
110 .br 
111 \fB \-\-offline\fR
112 .br 
113 \fB \-\-exit\fR
114 .br 
115 \fB \-\-debug\fR
116 .br 
117 \fB \-\-help\fR
118 .br 
119 \fB \-\-version\fR
120 .br 
121 \fB \-\-config\-dir\fR
122 .SH "FILES"
123 .LP 
124 .TP 
125 $HOME/Mail
126 Default directory for mail storage
127 .TP 
128 $PREFIX/share/claws\-mail
129 Global program directory
130 .TP 
131 $PREFIX/share/claws\-mail/manual
132 Manual files in HTML format
133 .TP 
134 $PREFIX/share/claws\-mail/themes
135 Global themes directory
136 .TP 
137 $PREFIX/lib/claws\-mail/plugins
138 Directory for plugins
139 .TP 
140 $PREFIX/include/claws\-mail
141 Directory for header files
142 .TP 
143 $HOME/.claws\-mail
144 Default directory for user's configuration files directory
145 .TP 
146 $HOME/.claws\-mail/themes
147 User's themes directory
148 .TP 
149 $HOME/.claws\-mail/accountrc
150 Configuration for account(s)
151 .TP 
152 $HOME/.claws\-mail/addrbook*
153 Addressbook files
154 .TP 
155 $HOME/.claws\-mail/command_history
156 User\-specified commands
157 .TP 
158 $HOME/.claws\-mail/customheaderrc
159 Configuration for custom headers for sending mail
160 .TP 
161 $HOME/.claws\-mail/dispheaderrc
162 Configuration for custom display of headers in message view
163 .TP 
164 $HOME/.claws\-mail/matcherrc
165 Filtering and Processing function configuration
166 .TP 
167 $HOME/.claws\-mail/folderlist.xml
168 Folder hierarchy listing
169 .TP 
170 $HOME/.claws\-mail/menurc
171 Menu shortcut\-key configuration
172 .TP 
173 $HOME/.claws\-mail/claws.log
174 Claws Mail logfile
175 .TP 
176 $HOME/.claws\-mail/clawsrc
177 Main configuration file
178
179
180 .SH "EXAMPLES"
181 .LP 
182 To run this program the standard way type:
183 .LP 
184 claws\-mail
185 .LP 
186 Alternatively you can run it with the following options:
187 .TP 
188 \fB\-\-compose [address]\fR 
189 to open a Compose window
190 .TP 
191 \fB\-\-subscribe [uri]\fR
192 subscribe to the given URI if possible
193 .TP 
194 \fB\-\-attach file1 [file2]...\fR
195 open composition window with specified files attached
196 .TP 
197 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
198 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window
199 .TP 
200 \fB\-\-receive\fR
201 receive new messages
202 .TP 
203 \fB\-\-receive\-all\fR
204 receive new messages from all accounts
205 .TP 
206 \fB\-\-send\fR
207 .br 
208 send all queued messages
209 .TP 
210 \fB\-\-status\fR
211 show the total number of messages
212 .br 
213 [new][unread][unread answers to marked][total]
214 .TP 
215 \fB\-\-status folder[/subfolder]\fR
216 show the total number of messages in specified folder
217 .br 
218 [new][unread][unread answers to marked][total]
219 .TP 
220 \fB\-\-status\-full\fR
221 show the total number of messages per folder
222 .br 
223 [new][unread][unread answers to marked][total]
224 .TP 
225 \fB\-\-select [mailbox/]folder[/msg|/msgid]\fR
226 On startup, jumps to the specified folder/message
227 .TP 
228 \fB\-\-online\fR
229 Start claws\-mail in (or switch to, if already running) online mode
230 .TP 
231 \fB\-\-offline\fR
232 Start claws\-mail in (or switch to, if already running) offline mode
233 .TP 
234 \fB\-\-help\fR
235 display the help message and exit
236 .TP 
237 \fB\-\-exit\fR
238 exit Claws Mail
239 .TP 
240 \fB\-\-debug\fR
241 for debug mode
242 .TP 
243 \fB\-\-version\fR
244 display version number and exit
245 .TP 
246 \fB\-\-config\-dir\fR
247 display the CONFIG\-DIR and exit
248 .SH "INSTALLATION"
249 .LP 
250 This program requires GTK+ 2.6.x or higher to be compiled.
251 .LP 
252 Please make sure that gtk\-devel and glib\-devel (or similar) packages are
253 installed before the compilation (you may also require flex (lex) and bison
254 (yacc)).
255 .LP 
256 To compile and install, just type:
257 .LP 
258 % ./configure
259 .br 
260 % make
261 .br 
262 % su
263 .br 
264 Password: [Enter password]
265 .br 
266 # make install
267 .LP 
268 Refer to ./configure \-\-help for further information.
269 .SH "AUTHORS"
270 .LP 
271 .TP 
272 The Claws Mail Team
273 Holger Berndt                   <berndth@users.sf.net>
274 .br 
275 Tristan Chabredier              <wwp@claws\-mail.org>
276 .br 
277 Ho\(`a Vi\(^et Dinh                     <hoa@users.sf.net>
278 .br 
279 Werner Koch                     <wk@gnupg.org>
280 .br 
281 Darko Koruga                    <darko@users.sf.net>
282 .br 
283 Ricardo Mones Lastra    <ricardo@mones.org>
284 .br 
285 Colin Leroy                     <colin@colino.net>
286 .br 
287 Paul Mangan                     <paul@claws\-mail.org>
288 .br 
289 Martin Schaaf                   <mascha1@users.sf.net>
290
291 .TP 
292 Previous team members
293 Keith Edmunds
294 .br 
295 Match Grun
296 .br 
297 Melvin Hadasht
298 .br 
299 Oliver Haertel
300 .br 
301 Christoph Hohmann
302 .br 
303 Alfons Hoogervorst
304 .br 
305 Thorsten Maerz
306 .br 
307 Leandro A. F. Pereira
308 .br 
309 Luke Plant
310 .br 
311 Carsten Schurig
312 .br 
313 Sergey Vlasov
314 .br 
315 Hiroyuki Yamamoto
316
317
318 .SH "SEE ALSO"
319 .LP 
320 .TP 
321 Claws Mail Homepage
322 <http://www.claws\-mail.org>