2012-11-15 [wwp] 3.9.0cvs3
[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 \-\-cancel\-receiving\fR
109 .br 
110 \fB \-\-send\fR
111 .br 
112 \fB \-\-status\fR
113 .br 
114 \fB \-\-status folder[/subfolder]\fR
115 .br 
116 \fB \-\-status\-full\fR
117 .br 
118 \fB \-\-statistics\fR
119 .br 
120 \fB \-\-reset-statistics\fR
121 .br 
122 \fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
123 .br 
124 \fB \-\-online\fR
125 .br 
126 \fB \-\-offline\fR
127 .br 
128 \fB \-\-exit\fR
129 .br 
130 \fB \-\-debug\fR
131 .br 
132 \fB \-\-help\fR
133 .br 
134 \fB \-\-version\fR
135 .br 
136 \fB \-\-version\-full\fR
137 .br 
138 \fB \-\-config\-dir\fR
139 .br
140 \fB \-\-alternate\-config\-dir [dir]\fR
141
142 .SH "FILES"
143 .LP 
144 .TP 
145 $HOME/Mail
146 Default directory for mail storage
147 .TP 
148 $PREFIX/share/claws\-mail
149 Global program directory
150 .TP 
151 $PREFIX/share/claws\-mail/manual
152 Manual files in HTML, PDF, PostScript and plain text format
153 .TP 
154 $PREFIX/share/claws\-mail/themes
155 Global themes directory
156 .TP 
157 $PREFIX/lib/claws\-mail/plugins
158 Directory for plugins
159 .TP 
160 $PREFIX/include/claws\-mail
161 Directory for header files
162 .TP 
163 $HOME/.claws\-mail
164 Default directory for user's configuration files directory
165 .TP 
166 $HOME/.claws\-mail/addrbook/*
167 Addressbook files
168 .TP 
169 $HOME/.claws\-mail/autofaces/*
170 Automatic Faces and X\-Faces files for accounts
171 .TP 
172 $HOME/.claws\-mail/certs/*
173 SSL certificates received from mail servers
174 .TP 
175 $HOME/.claws\-mail/templates
176 User\-defined templates directory
177 .TP 
178 $HOME/.claws\-mail/themes
179 User's themes directory
180 .TP 
181 $HOME/.claws\-mail/accountrc
182 Configuration for account(s)
183 .TP 
184 $HOME/.claws\-mail/actionsrc
185 User\-defined custom actions
186 .TP 
187 $HOME/.claws\-mail/addressbookcustomattributerc
188 User\-defined address book custom attributes
189 .TP 
190 $HOME/.claws\-mail/claws.log
191 Claws Mail logfile
192 .TP 
193 $HOME/.claws\-mail/claws-win32.log
194 Claws Mail output file (Windows only)
195 .TP 
196 $HOME/.claws\-mail/clawsrc
197 Main configuration file
198 .TP 
199 $HOME/.claws\-mail/command_history
200 User\-specified commands
201 .TP 
202 $HOME/.claws\-mail/customheaderrc
203 Configuration for custom headers for sending mail
204 .TP 
205 $HOME/.claws\-mail/dispheaderrc
206 Configuration for custom display of headers in message view
207 .TP
208 $HOME/.claws\-mail/extraheaderrc
209 Editable extra headers to be added to compose window combobox
210 .TP 
211 $HOME/.claws\-mail/folderitemrc
212 All folders' attributes
213 .TP 
214 $HOME/.claws\-mail/folderlist.xml
215 Folder hierarchy listing
216 .TP 
217 $HOME/.claws\-mail/matcherrc
218 Filtering and Processing function configuration
219 .TP 
220 $HOME/.claws\-mail/menurc
221 Menu shortcut\-key configuration
222 .TP 
223 $HOME/.claws\-mail/messagesearch_history
224 User\-specified searches in message bodies
225 .TP 
226 $HOME/.claws\-mail/quicksearch_history
227 User\-specified quick\-search list
228 .TP 
229 $HOME/.claws\-mail/messagesearch_history
230 User\-specified searches in message bodies
231 .TP 
232 $HOME/.claws\-mail/summary*_history
233 User\-specified searches in message list
234 .TP 
235 $HOME/.claws\-mail/tagsrc
236 User\-specified tag list
237 .TP 
238 $HOME/.claws\-mail/toolbar*.xml
239 User\-defined custom toolbars
240
241 .SH "EXAMPLES"
242 .LP 
243 To run this program the standard way type:
244 .LP 
245 claws\-mail
246 .LP 
247 Alternatively you can run it with the following options:
248 .TP 
249 \fB\-\-compose [address]\fR 
250 to open a Compose window
251 .TP
252 \fB\-\-compose\-from\-file file
253 open composition window with data from given file. Use \- as file name
254 for reading from standard input. Content format: headers first (To: 
255 header required) until an empty line is found, then mail body until
256 end of file.
257 .TP 
258 \fB\-\-subscribe [uri]\fR
259 subscribe to the given URI if possible
260 .TP 
261 \fB\-\-attach file1 [file2]...\fR
262 open composition window with specified files attached
263 .TP 
264 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
265 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window.
266 Possible fields after the destination recipient are: subject, from, cc, bcc, in\-reply\-to,
267 body, insert (insert a file in body part, needs an absolute path), attach (attach a file,
268 needs an absolute path, see also: \-\-attach)
269 .TP 
270 \fB\-\-receive\fR
271 receive new messages
272 .TP 
273 \fB\-\-receive\-all\fR
274 receive new messages from all accounts
275 .TP 
276 \fB\-\-cancel\-receiving\fR
277 cancel receiving of messages
278 .TP 
279 \fB\-\-send\fR
280 .br 
281 send all queued messages
282 .TP 
283 \fB\-\-status\fR
284 show the total number of messages
285 .br 
286 [new][unread][unread answers to marked][total]
287 .TP 
288 \fB\-\-status folder[/subfolder]\fR
289 show the total number of messages in specified folder
290 .br 
291 [new][unread][unread answers to marked][total]
292 .TP 
293 \fB\-\-status\-full\fR
294 show the total number of messages per folder
295 .br 
296 [new][unread][unread answers to marked][total]
297 .TP 
298 \fB\-\-statistics\fR
299 .br 
300 show session statistics
301 .TP 
302 \fB\-\-reset-statistics\fR
303 .br 
304 reset session statistics
305 .TP 
306 \fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
307 on startup, jumps to the specified folder/message
308 .TP 
309 \fB\-\-online\fR
310 start Claws Mail in (or switch to, if already running) online mode
311 .TP 
312 \fB\-\-offline\fR
313 start Claws Mail in (or switch to, if already running) offline mode
314 .TP 
315 \fB\-\-help\fR
316 display the help message and exit
317 .TP 
318 \fB\-\-exit\fR
319 exit Claws Mail
320 .TP 
321 \fB\-\-debug\fR
322 for debug mode
323 .TP 
324 \fB\-\-version\fR
325 display version number and exit
326 .TP 
327 \fB\-\-version\-full\fR
328 display version number and compiled\-in features then exit
329 .TP 
330 \fB\-\-config\-dir\fR
331 display the CONFIG\-DIR and exit
332 .TP
333 \fB\-\-alternate\-config\-dir [dir]\fR
334 start Claws Mail with the configuration stored in [dir] directory
335
336 .SH "ENVIRONMENT"
337 .LP
338 .TP
339 \fBLC_ALL\fR
340 .TP
341 \fBLC_CTYPE\fR
342 .TP
343 \fBLANG\fR
344 locale to use for non-win32 systems (the first one not empty is used)
345 .TP
346 \fBSSL_CERT_FILE\fR
347 use this CA certificates file instead of searching known system files
348 .TP
349 \fBSSL_CERT_DIR\fR
350 use this CA certificates directory instead known system directories
351 .TP
352 \fBPOSIXLY_CORRECT\fR
353 if defined regular expressions matching follows POSIX standards
354 .TP
355 \fBHOME\fR
356 full path of the user's home directory
357 .TP
358 \fBCLAWS_NO_CRASH\fR
359 if defined disables crash dialog (only if Claws Mail has been built with
360 crash dialog feature enabled)
361 .TP
362 \fBG_BROKEN_FILENAMES\fR
363 assumes that filenames are in the locale encoding rather than in UTF-8
364 .TP
365 \fBPILOT_CHARSET\fR
366 if defined overrides default J-Pilot charset (CP1252)
367 .TP
368 \fBSESSION_MANAGER\fR
369 if defined tries to use the Session Manager (only if Claws Mail has been
370 built with libSM feature enabled)
371 .TP
372 \fBDISPLAY\fR
373 default host and display number to use
374 .TP
375 \fBGPG_AGENT_INFO\fR
376 the information to access the GPG agent if using GPG agent is enabled in
377 GPG plugin preferences (this is usually set by the agent when launched,
378 otherwise it likely means the GPG agent is not running)
379 .TP
380 \fBSHELL\fR
381 if defined overrides default shell "sh" used by Spamassassin plugin to
382 launch spamc wrappers
383
384 .SH "BUGS"
385 .LP
386 .TP
387 You can search for existing bugs and report new ones on Claws Mail bugzilla:
388 .br
389 <http://www.thewildbeast.co.uk/claws-mail/bugzilla/>
390
391 .SH "COPYRIGHT"
392 .LP
393 .TP
394 1999-2012 Hiroyuki Yamamoto and the Claws Mail team
395
396 .SH "AUTHORS"
397 .LP 
398 .TP 
399 The Claws Mail Team
400 Holger Berndt                   <berndth@users.sf.net>
401 .br 
402 Tristan Chabredier              <wwp@claws\-mail.org>
403 .br 
404 Andrej Kacian                   <andrej@kacian.sk>
405 .br 
406 Darko Koruga                    <darko@users.sf.net>
407 .br 
408 Ricardo Mones Lastra    <ricardo@mones.org>
409 .br 
410 Colin Leroy                     <colin@colino.net>
411 .br 
412 Paul Mangan                     <paul@claws\-mail.org>
413 .br 
414 Salvatore De Paolis     <iwkse@claws\-mail.org>
415
416 .TP 
417 Previous team members
418 Ho\(`a Vi\(^et Dinh
419 .br
420 Keith Edmunds
421 .br 
422 Match Grun
423 .br 
424 Melvin Hadasht
425 .br 
426 Oliver Haertel
427 .br 
428 Christoph Hohmann
429 .br 
430 Alfons Hoogervorst
431 .br 
432 Werner Koch
433 .br 
434 Thorsten Maerz
435 .br 
436 Leandro A. F. Pereira
437 .br 
438 Luke Plant
439 .br 
440 Martin Schaaf
441 .br 
442 Carsten Schurig
443 .br 
444 Fabien Vantard
445 .br 
446 Sergey Vlasov
447 .br 
448 Hiroyuki Yamamoto
449
450 .SH "SEE ALSO"
451 .LP 
452 .TP 
453 Claws Mail Homepage
454 <http://www.claws\-mail.org>
455 .TP
456 Claws Mail online manual
457 <http://www.claws\-mail.org/manual>
458 .TP
459 Claws Mail plugins
460 <http://www.claws\-mail.org/plugins.php>
461