2012-10-09 [mones] 3.8.1cvs86
[claws.git] / doc / man / claws-mail.1
1 .TH "CLAWS MAIL" "1" "November 1, 2011" "The Claws Mail team" "User Manuals"
2
3 .SH "NAME"
4 .LP 
5 Claws Mail \- a GTK+ based fast email and news client
6
7 .SH "SYNOPSIS"
8 .B claws-mail
9 .RI [ options ]
10
11 .SH "DESCRIPTION"
12 .TP 
13 Claws Mail is an email client (and news reader) based on GTK+, running on the X Window System, and aiming for:
14 .br 
15 * Quick response
16 .br 
17 * Graceful, and sophisticated interface
18 .br 
19 * Easy configuration, intuitive operation
20 .br 
21 * Abundant features
22 \fR
23 .TP 
24 Currently implemented features include:
25 o POP3 support
26 .br 
27 o IMAP4rev1 support
28 .br 
29 o integrated NetNews client
30 .br 
31 o unlimited multiple account handling
32 .br 
33 o thread display
34 .br 
35 o filtering
36 .br 
37 o MIME (attachments)
38 .br 
39 o built\-in image view
40 .br 
41 o X\-Face and (colour) Face support
42 .br 
43 o multiple MH folder support
44 .br 
45 o mbox importing / exporting
46 .br 
47 o external editor support
48 .br 
49 o message queueing
50 .br 
51 o automatic mail checking
52 .br 
53 o draft message function
54 .br 
55 o template function
56 .br 
57 o line\-wrapping
58 .br 
59 o clickable URI
60 .br 
61 o XML\-based address book
62 .br 
63 o LDAP, vCard, and JPilot support
64 .br 
65 o newly arrived and unread message management
66 .br 
67 o Mew/Wanderlust\-like key bind
68 .br 
69 o printing
70 .br 
71 o APOP authentication support
72 .br 
73 o SMTP AUTH support
74 .br 
75 o SSL support (POP3, SMTP, IMAP4rev1)
76 .br 
77 o IPv6 support
78 .br 
79 o drag & drop (partially implemented)
80 .br 
81 o GnuPG support
82 .br 
83 o automake + autoconf support
84 .br 
85 o internationalization of messages by gettext
86 .br 
87 o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
88 .br 
89 o support for plugins
90 \fR
91 .LP 
92 This list is not complete.
93
94 .SH "OPTIONS"
95 .LP 
96 \fB \-\-compose\fR [address]
97 .br 
98 \fB \-\-compose\-from\-file\fR file
99 .br 
100 \fB \-\-subscribe\fR [uri]
101 .br 
102 \fB \-\-attach file1 [file2]...\fR
103 .br 
104 \fB \-\-receive\fR
105 .br 
106 \fB \-\-receive\-all\fR
107 .br 
108 \fB \-\-send\fR
109 .br 
110 \fB \-\-status\fR
111 .br 
112 \fB \-\-status folder[/subfolder]\fR
113 .br 
114 \fB \-\-status\-full\fR
115 .br 
116 \fB \-\-statistics\fR
117 .br 
118 \fB \-\-reset-statistics\fR
119 .br 
120 \fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
121 .br 
122 \fB \-\-online\fR
123 .br 
124 \fB \-\-offline\fR
125 .br 
126 \fB \-\-exit\fR
127 .br 
128 \fB \-\-debug\fR
129 .br 
130 \fB \-\-help\fR
131 .br 
132 \fB \-\-version\fR
133 .br 
134 \fB \-\-version\-full\fR
135 .br 
136 \fB \-\-config\-dir\fR
137 .br
138 \fB \-\-alternate\-config\-dir [dir]\fR
139
140 .SH "FILES"
141 .LP 
142 .TP 
143 $HOME/Mail
144 Default directory for mail storage
145 .TP 
146 $PREFIX/share/claws\-mail
147 Global program directory
148 .TP 
149 $PREFIX/share/claws\-mail/manual
150 Manual files in HTML, PDF, PostScript and plain text format
151 .TP 
152 $PREFIX/share/claws\-mail/themes
153 Global themes directory
154 .TP 
155 $PREFIX/lib/claws\-mail/plugins
156 Directory for plugins
157 .TP 
158 $PREFIX/include/claws\-mail
159 Directory for header files
160 .TP 
161 $HOME/.claws\-mail
162 Default directory for user's configuration files directory
163 .TP 
164 $HOME/.claws\-mail/addrbook/*
165 Addressbook files
166 .TP 
167 $HOME/.claws\-mail/autofaces/*
168 Automatic Faces and X\-Faces files for accounts
169 .TP 
170 $HOME/.claws\-mail/certs/*
171 SSL certificates received from mail servers
172 .TP 
173 $HOME/.claws\-mail/templates
174 User\-defined templates directory
175 .TP 
176 $HOME/.claws\-mail/themes
177 User's themes directory
178 .TP 
179 $HOME/.claws\-mail/accountrc
180 Configuration for account(s)
181 .TP 
182 $HOME/.claws\-mail/actionsrc
183 User\-defined custom actions
184 .TP 
185 $HOME/.claws\-mail/addressbookcustomattributerc
186 User\-defined address book custom attributes
187 .TP 
188 $HOME/.claws\-mail/claws.log
189 Claws Mail logfile
190 .TP 
191 $HOME/.claws\-mail/claws-win32.log
192 Claws Mail output file (Windows only)
193 .TP 
194 $HOME/.claws\-mail/clawsrc
195 Main configuration file
196 .TP 
197 $HOME/.claws\-mail/command_history
198 User\-specified commands
199 .TP 
200 $HOME/.claws\-mail/customheaderrc
201 Configuration for custom headers for sending mail
202 .TP 
203 $HOME/.claws\-mail/dispheaderrc
204 Configuration for custom display of headers in message view
205 .TP
206 $HOME/.claws\-mail/extraheaderrc
207 Editable extra headers to be added to compose window combobox
208 .TP 
209 $HOME/.claws\-mail/folderitemrc
210 All folders' attributes
211 .TP 
212 $HOME/.claws\-mail/folderlist.xml
213 Folder hierarchy listing
214 .TP 
215 $HOME/.claws\-mail/matcherrc
216 Filtering and Processing function configuration
217 .TP 
218 $HOME/.claws\-mail/menurc
219 Menu shortcut\-key configuration
220 .TP 
221 $HOME/.claws\-mail/messagesearch_history
222 User\-specified searches in message bodies
223 .TP 
224 $HOME/.claws\-mail/quicksearch_history
225 User\-specified quick\-search list
226 .TP 
227 $HOME/.claws\-mail/messagesearch_history
228 User\-specified searches in message bodies
229 .TP 
230 $HOME/.claws\-mail/summary*_history
231 User\-specified searches in message list
232 .TP 
233 $HOME/.claws\-mail/tagsrc
234 User\-specified tag list
235 .TP 
236 $HOME/.claws\-mail/toolbar*.xml
237 User\-defined custom toolbars
238
239 .SH "EXAMPLES"
240 .LP 
241 To run this program the standard way type:
242 .LP 
243 claws\-mail
244 .LP 
245 Alternatively you can run it with the following options:
246 .TP 
247 \fB\-\-compose [address]\fR 
248 to open a Compose window
249 .TP
250 \fB\-\-compose\-from\-file file
251 open composition window with data from given file. Use \- as file name
252 for reading from standard input. Content format: headers first (To: 
253 header required) until an empty line is found, then mail body until
254 end of file.
255 .TP 
256 \fB\-\-subscribe [uri]\fR
257 subscribe to the given URI if possible
258 .TP 
259 \fB\-\-attach file1 [file2]...\fR
260 open composition window with specified files attached
261 .TP 
262 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
263 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window.
264 Possible fields after the destination recipient are: subject, from, cc, bcc, in\-reply\-to,
265 body, insert (insert a file in body part, needs an absolute path), attach (attach a file,
266 needs an absolute path, see also: \-\-attach)
267 .TP 
268 \fB\-\-receive\fR
269 receive new messages
270 .TP 
271 \fB\-\-receive\-all\fR
272 receive new messages from all accounts
273 .TP 
274 \fB\-\-send\fR
275 .br 
276 send all queued messages
277 .TP 
278 \fB\-\-status\fR
279 show the total number of messages
280 .br 
281 [new][unread][unread answers to marked][total]
282 .TP 
283 \fB\-\-status folder[/subfolder]\fR
284 show the total number of messages in specified folder
285 .br 
286 [new][unread][unread answers to marked][total]
287 .TP 
288 \fB\-\-status\-full\fR
289 show the total number of messages per folder
290 .br 
291 [new][unread][unread answers to marked][total]
292 .TP 
293 \fB\-\-statistics\fR
294 .br 
295 show session statistics
296 .TP 
297 \fB\-\-reset-statistics\fR
298 .br 
299 reset session statistics
300 .TP 
301 \fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
302 on startup, jumps to the specified folder/message
303 .TP 
304 \fB\-\-online\fR
305 start Claws Mail in (or switch to, if already running) online mode
306 .TP 
307 \fB\-\-offline\fR
308 start Claws Mail in (or switch to, if already running) offline mode
309 .TP 
310 \fB\-\-help\fR
311 display the help message and exit
312 .TP 
313 \fB\-\-exit\fR
314 exit Claws Mail
315 .TP 
316 \fB\-\-debug\fR
317 for debug mode
318 .TP 
319 \fB\-\-version\fR
320 display version number and exit
321 .TP 
322 \fB\-\-version\-full\fR
323 display version number and compiled\-in features then exit
324 .TP 
325 \fB\-\-config\-dir\fR
326 display the CONFIG\-DIR and exit
327 .TP
328 \fB\-\-alternate\-config\-dir [dir]\fR
329 start Claws Mail with the configuration stored in [dir] directory
330
331 .SH "ENVIRONMENT"
332 .LP
333 .TP
334 \fBLC_ALL\fR
335 .TP
336 \fBLC_CTYPE\fR
337 .TP
338 \fBLANG\fR
339 locale to use for non-win32 systems (the first one not empty is used)
340 .TP
341 \fBSSL_CERT_FILE\fR
342 use this CA certificates file instead of searching known system files
343 .TP
344 \fBSSL_CERT_DIR\fR
345 use this CA certificates directory instead known system directories
346 .TP
347 \fBPOSIXLY_CORRECT\fR
348 if defined regular expressions matching follows POSIX standards
349 .TP
350 \fBHOME\fR
351 full path of the user's home directory
352 .TP
353 \fBCLAWS_NO_CRASH\fR
354 if defined disables crash dialog (only if Claws Mail has been built with
355 crash dialog feature enabled)
356 .TP
357 \fBG_BROKEN_FILENAMES\fR
358 assumes that filenames are in the locale encoding rather than in UTF-8
359 .TP
360 \fBPILOT_CHARSET\fR
361 if defined overrides default J-Pilot charset (CP1252)
362 .TP
363 \fBSESSION_MANAGER\fR
364 if defined tries to use the Session Manager (only if Claws Mail has been
365 built with libSM feature enabled)
366 .TP
367 \fBDISPLAY\fR
368 default host and display number to use
369 .TP
370 \fBGPG_AGENT_INFO\fR
371 the information to access the GPG agent if using GPG agent is enabled in
372 GPG plugin preferences (this is usually set by the agent when launched,
373 otherwise it likely means the GPG agent is not running)
374 .TP
375 \fBSHELL\fR
376 if defined overrides default shell "sh" used by Spamassassin plugin to
377 launch spamc wrappers
378
379 .SH "BUGS"
380 .LP
381 .TP
382 You can search for existing bugs and report new ones on Claws Mail bugzilla:
383 .br
384 <http://www.thewildbeast.co.uk/claws-mail/bugzilla/>
385
386 .SH "COPYRIGHT"
387 .LP
388 .TP
389 1999-2011 Hiroyuki Yamamoto and the Claws Mail team
390
391 .SH "AUTHORS"
392 .LP 
393 .TP 
394 The Claws Mail Team
395 Holger Berndt                   <berndth@users.sf.net>
396 .br 
397 Tristan Chabredier              <wwp@claws\-mail.org>
398 .br 
399 Ho\(`a Vi\(^et Dinh                     <hoa@users.sf.net>
400 .br 
401 Andrej Kacian                   <andrej@kacian.sk>
402 .br 
403 Darko Koruga                    <darko@users.sf.net>
404 .br 
405 Ricardo Mones Lastra    <ricardo@mones.org>
406 .br 
407 Colin Leroy                     <colin@colino.net>
408 .br 
409 Paul Mangan                     <paul@claws\-mail.org>
410 .br 
411 Salvatore De Paolis     <iwkse@claws\-mail.org>
412
413 .TP 
414 Previous team members
415 Keith Edmunds
416 .br 
417 Match Grun
418 .br 
419 Melvin Hadasht
420 .br 
421 Oliver Haertel
422 .br 
423 Christoph Hohmann
424 .br 
425 Alfons Hoogervorst
426 .br 
427 Werner Koch
428 .br 
429 Thorsten Maerz
430 .br 
431 Leandro A. F. Pereira
432 .br 
433 Luke Plant
434 .br 
435 Martin Schaaf
436 .br 
437 Carsten Schurig
438 .br 
439 Fabien Vantard
440 .br 
441 Sergey Vlasov
442 .br 
443 Hiroyuki Yamamoto
444
445 .SH "SEE ALSO"
446 .LP 
447 .TP 
448 Claws Mail Homepage
449 <http://www.claws\-mail.org>
450 .TP
451 Claws Mail online manual
452 <http://www.claws\-mail.org/manual>
453 .TP
454 Claws Mail plugins
455 <http://www.claws\-mail.org/plugins.php>
456