52bd76badefde2c5abc50491465e1b94bfbf2264
[claws.git] / doc / man / claws-mail.1
1 .TH "CLAWS MAIL" "1" "June  4, 2015" "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 \[bu] Quick response
16 .br 
17 \[bu] Graceful, and sophisticated interface
18 .br 
19 \[bu] Easy configuration, intuitive operation
20 .br 
21 \[bu] Abundant features
22 \fR
23 .TP 
24 Currently implemented features include:
25 \[bu] POP3 support
26 .br 
27 \[bu] IMAP4rev1 support
28 .br 
29 \[bu] integrated NetNews client
30 .br 
31 \[bu] unlimited multiple account handling
32 .br 
33 \[bu] thread display
34 .br 
35 \[bu] filtering
36 .br 
37 \[bu] MIME (attachments)
38 .br 
39 \[bu] built\-in image view
40 .br 
41 \[bu] X\-Face and (colour) Face support
42 .br 
43 \[bu] multiple MH folder support
44 .br 
45 \[bu] mbox importing / exporting
46 .br 
47 \[bu] external editor support
48 .br 
49 \[bu] message queueing
50 .br 
51 \[bu] automatic mail checking
52 .br 
53 \[bu] draft message function
54 .br 
55 \[bu] template function
56 .br 
57 \[bu] line\-wrapping
58 .br 
59 \[bu] clickable URI
60 .br 
61 \[bu] XML\-based address book
62 .br 
63 \[bu] LDAP, vCard, and JPilot support
64 .br 
65 \[bu] newly arrived and unread message management
66 .br 
67 \[bu] Mew/Wanderlust\-like key bind
68 .br 
69 \[bu] printing
70 .br 
71 \[bu] APOP authentication support
72 .br 
73 \[bu] SMTP AUTH support
74 .br 
75 \[bu] SSL support (POP3, SMTP, IMAP4rev1)
76 .br 
77 \[bu] IPv6 support
78 .br 
79 \[bu] drag & drop (partially implemented)
80 .br 
81 \[bu] GnuPG support
82 .br 
83 \[bu] automake + autoconf support
84 .br 
85 \[bu] internationalization of UI messages by gettext
86 .br 
87 \[bu] support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
88 .br 
89 \[bu] 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 \-\-cancel\-sending\fR
111 .br 
112 \fB \-\-send\fR
113 .br 
114 \fB \-\-status\fR
115 .br 
116 \fB \-\-status folder[/subfolder]\fR
117 .br 
118 \fB \-\-status\-full\fR
119 .br 
120 \fB \-\-statistics\fR
121 .br 
122 \fB \-\-reset-statistics\fR
123 .br 
124 \fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
125 .br 
126 \fB \-\-online\fR
127 .br 
128 \fB \-\-offline\fR
129 .br 
130 \fB \-\-exit\fR
131 .br 
132 \fB \-\-debug\fR
133 .br 
134 \fB \-\-toggle\-debug\fR
135 .br 
136 \fB \-\-help\fR
137 .br 
138 \fB \-\-version\fR
139 .br 
140 \fB \-\-version\-full\fR
141 .br 
142 \fB \-\-config\-dir\fR
143 .br
144 \fB \-\-alternate\-config\-dir [dir]\fR
145
146 .SH "FILES"
147 .LP 
148 .TP 
149 $HOME/Mail
150 Default directory for mail storage
151 .TP 
152 $PREFIX/share/claws\-mail
153 Global program directory
154 .TP 
155 $PREFIX/share/claws\-mail/manual
156 Manual files in HTML, PDF, PostScript and plain text format
157 .TP 
158 $PREFIX/share/claws\-mail/themes
159 Global themes directory
160 .TP 
161 $PREFIX/lib/claws\-mail/plugins
162 Directory for plugins
163 .TP 
164 $PREFIX/include/claws\-mail
165 Directory for header files
166 .TP 
167 $HOME/.claws\-mail
168 Default directory for user's configuration files directory
169 .TP 
170 $HOME/.claws\-mail/addrbook/*
171 Addressbook files
172 .TP 
173 $HOME/.claws\-mail/autofaces/*
174 Automatic Faces and X\-Faces files for accounts
175 .TP 
176 $HOME/.claws\-mail/certs/*
177 SSL certificates received from mail servers
178 .TP 
179 $HOME/.claws\-mail/templates
180 User\-defined templates directory
181 .TP 
182 $HOME/.claws\-mail/themes
183 User's themes directory
184 .TP 
185 $HOME/.claws\-mail/accountrc
186 Configuration for account(s)
187 .TP 
188 $HOME/.claws\-mail/actionsrc
189 User\-defined custom actions
190 .TP 
191 $HOME/.claws\-mail/addressbookcustomattributerc
192 User\-defined address book custom attributes
193 .TP 
194 $HOME/.claws\-mail/claws.log
195 Claws Mail logfile
196 .TP 
197 $HOME/.claws\-mail/clawsrc
198 Main configuration file
199 .TP 
200 $HOME/.claws\-mail/command_history
201 User\-specified commands
202 .TP 
203 $HOME/.claws\-mail/customheaderrc
204 Configuration for custom headers for sending mail
205 .TP 
206 $HOME/.claws\-mail/dispheaderrc
207 Configuration for custom display of headers in message view
208 .TP
209 $HOME/.claws\-mail/extraheaderrc
210 Editable extra headers to be added to compose window combobox
211 .TP 
212 $HOME/.claws\-mail/folderitemrc
213 All folders' attributes
214 .TP 
215 $HOME/.claws\-mail/folderlist.xml
216 Folder hierarchy listing
217 .TP 
218 $HOME/.claws\-mail/matcherrc
219 Filtering and Processing function configuration
220 .TP 
221 $HOME/.claws\-mail/menurc
222 Menu shortcut\-key configuration
223 .TP 
224 $HOME/.claws\-mail/messagesearch_history
225 User\-specified searches in message bodies
226 .TP 
227 $HOME/.claws\-mail/quicksearch_history
228 User\-specified quick\-search list
229 .TP 
230 $HOME/.claws\-mail/messagesearch_history
231 User\-specified searches in message bodies
232 .TP 
233 $HOME/.claws\-mail/summary*_history
234 User\-specified searches in message list
235 .TP 
236 $HOME/.claws\-mail/tagsrc
237 User\-specified tag list
238 .TP 
239 $HOME/.claws\-mail/toolbar*.xml
240 User\-defined custom toolbars
241 .TP
242 .B "Windows only"
243 .LP
244 .TP
245 %TEMP%\\claws\-win32.log
246 Claws Mail output file when \-\-debug is enabled. If %TEMP% is not set it
247 defaults to windows directory (usually C:\\Windows) or C:\\ if windows
248 directory is not available.
249 .TP
250 %APPDATA%\\Claws\-mail\\claws.log
251 Claws Mail log file
252
253 .SH "EXAMPLES"
254 .LP 
255 To run this program the standard way type:
256 .LP 
257 claws\-mail
258 .LP 
259 Alternatively you can run it with the following options:
260 .TP 
261 \fB\-\-compose [address]\fR 
262 to open a Compose window
263 .TP
264 \fB\-\-compose\-from\-file file
265 open composition window with data from given file. Use \- as file name
266 for reading from standard input. Content format: headers first (To: 
267 header required) until an empty line is found, then mail body until
268 end of file.
269 .TP 
270 \fB\-\-subscribe [uri]\fR
271 subscribe to the given URI if possible
272 .TP 
273 \fB\-\-attach file1 [file2]...\fR
274 open composition window with specified files attached
275 .TP 
276 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
277 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window.
278 Possible fields after the destination recipient are: subject, from, cc, bcc, in\-reply\-to,
279 body, insert (insert a file in body part, needs an absolute path), attach (attach a file,
280 needs an absolute path, see also: \-\-attach)
281 .TP 
282 \fB\-\-receive\fR
283 receive new messages
284 .TP 
285 \fB\-\-receive\-all\fR
286 receive new messages from all accounts
287 .TP 
288 \fB\-\-cancel\-receiving\fR
289 cancel receiving of messages
290 .TP 
291 \fB\-\-cancel\-sending\fR
292 cancel sending of messages
293 .TP 
294 \fB\-\-send\fR
295 .br 
296 send all queued messages
297 .TP 
298 \fB\-\-status\fR
299 show the total number of messages
300 .br 
301 [new][unread][unread answers to marked][total]
302 .TP 
303 \fB\-\-status folder[/subfolder]\fR
304 show the total number of messages in specified folder
305 .br 
306 [new][unread][unread answers to marked][total]
307 .TP 
308 \fB\-\-status\-full\fR
309 show the total number of messages per folder
310 .br 
311 [new][unread][unread answers to marked][total]
312 .TP 
313 \fB\-\-statistics\fR
314 .br 
315 show session statistics
316 .TP 
317 \fB\-\-reset-statistics\fR
318 .br 
319 reset session statistics
320 .TP 
321 \fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
322 on startup, jumps to the specified folder/message
323 .TP 
324 \fB\-\-online\fR
325 start Claws Mail in (or switch to, if already running) online mode
326 .TP 
327 \fB\-\-offline\fR
328 start Claws Mail in (or switch to, if already running) offline mode
329 .TP 
330 \fB\-\-help\fR
331 display the help message and exit
332 .TP 
333 \fB\-\-exit\fR
334 exit Claws Mail
335 .TP 
336 \fB\-\-debug\fR
337 for debug mode (on Windows systems output is written to a file instead
338 of standard error output, see \fBWindows only\fR on \fBFILES\fR
339 section)
340 .TP 
341 \fB\-\-toggle-debug\fR
342 toggle debug mode of a running Claws Mail instance
343 .TP 
344 \fB\-\-version\fR
345 display version number and exit
346 .TP 
347 \fB\-\-version\-full\fR
348 display version number and compiled\-in features then exit
349 .TP 
350 \fB\-\-config\-dir\fR
351 display the CONFIG\-DIR and exit
352 .TP
353 \fB\-\-alternate\-config\-dir [dir]\fR
354 start Claws Mail with the configuration stored in [dir] directory
355
356 .SH "ENVIRONMENT"
357 .LP
358 .TP
359 \fBCLAWS_NO_CRASH\fR
360 if defined disables crash dialog (only if Claws Mail has been built with
361 crash dialog feature enabled)
362 .TP
363 \fBDISPLAY\fR
364 default host and display number to use
365 .TP
366 \fBETPANSERVER\fR, \fBETPANPORT\fR
367 when using a tunnel command to open server connections these temporary
368 variables are set to the server name and server port respectively in the
369 environment of the running command
370 .TP
371 \fBGPG_AGENT_INFO\fR
372 the information to access the GPG agent if using GPG agent is enabled in
373 GPG plugin preferences (this is usually set by the agent when launched,
374 otherwise it likely means the GPG agent is not running)
375 .TP
376 \fBG_BROKEN_FILENAMES\fR
377 assumes that filenames are in the locale encoding rather than in UTF\-8
378 .TP
379 \fBHOME\fR
380 full path of the user's home directory
381 .TP
382 \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLANG\fR
383 locale to use for non\-windows systems (the first one not empty is used)
384 .TP
385 \fBPILOT_CHARSET\fR
386 if defined overrides default J\-Pilot charset (CP1252)
387 .TP
388 \fBPOSIXLY_CORRECT\fR
389 if defined regular expressions matching follows POSIX standards
390 .TP
391 \fBSESSION_MANAGER\fR
392 if defined tries to use the Session Manager (only if Claws Mail has been
393 built with libSM feature enabled)
394 .TP
395 \fBSHELL\fR
396 if defined overrides default shell "sh" used by Spamassassin plugin to
397 launch spamc wrappers
398 .TP
399 \fBSSL_CERT_DIR\fR
400 use this CA certificates directory instead known system directories
401 .TP
402 \fBSSL_CERT_FILE\fR
403 use this CA certificates file instead of searching known system files
404 .TP
405 \fBUSER\fR
406 used to initialize default "user_id" preference in newly created accounts
407
408 .SH "BUGS"
409 .LP
410 .TP
411 You can search for existing bugs and report new ones on Claws Mail bugzilla:
412 .br
413 <http://www.thewildbeast.co.uk/claws\-mail/bugzilla/>
414
415 .SH "COPYRIGHT"
416 .LP
417 .TP
418 1999\-2015 Hiroyuki Yamamoto and the Claws Mail team
419 .LP
420 Portions are also Copyright:
421 .br
422 (C) 2007\-2009 g10 Code GmbH
423 .br
424 (C) 1999\-2005 Nullsoft, Inc.
425 .br
426 (C) 1991\-1993, 1996\-2000, 2001 Free Software Foundation, Inc.
427 .br
428 (C) 2001 Thomas Link, Hiroyuki Yamamoto
429 .br
430 (C) 1995\-1997 Peter Mattis and Spencer Kimball
431 .br
432 (C) 1995\-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
433 .br
434 (C) 1997\-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
435 .br
436 (C) 1999\-2003 Michael Natterer <mitch@gimp.org>
437 .br
438 (C) 2000 Evan Martin
439 .br
440 (C) 1998 Lars Hamann and Stefan Jeske
441 .br
442 (C) 2005, 2006, 2007, 2009 GNOME Foundation
443 .br
444 (C) 2004\-2006 Christian Hammond
445 .br
446 (C) 2003\-2004 Pawel Salek
447 .br
448 (C) 2001, 2002 \- DINH Viet Hoa
449 .br
450 (C) 1999\-2000, Gael Roualland <gael.roualland@iname.com>
451 .br
452 (C) 1998\-2002 Sendmail, Inc.
453 .br
454 (C) 2007\-2008 Juha Kautto (juha at xfce.org)
455 .br
456 (C) 1994\-2002 World Wide Web Consortium
457 .br
458 (C) 1999 Graham Davison
459 .br
460 (C) 1999 Eric Busboom
461 .br
462 (C) 2000, Eric Busboom, http://www.softwarestudio.org
463 .br
464 (C) 2002\-2007 Randall Hand <yerase@yerot.com>
465 .br
466 (C) 2001 by Werner Koch <dd9jn@gnu.org>
467 .br
468 (C) 2004 Apache Software Foundation
469 .br
470 (C) 2008 Mikkel Kamstrup Erlandsen
471 .br
472 (C) 2002  Red Hat, Inc.; Copyright 1998, 2001 Tim Janik
473 .br
474 (C) 2008\-2009  Christian Hammond, David Trowbridge
475 .br
476 (C) 2003\-2005  Lars Lindner <lars.lindner@gmx.net>
477 .br
478 (C) 2004,2005  Nathan J. Conrad <t98502@users.sourceforge.net>
479 .br
480 (C) 2004 Karl Soderstrom <ks@xanadunet.net>
481 .br
482 (C) 2000 Helix Code, Inc. (www.helixcode.com)
483
484 .SH "LICENSE"
485 .LP
486 .TP
487 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
488 .TP
489 See COPYING file on toplevel distribution directory for more license details.
490
491 .SH "AUTHORS"
492 .LP 
493 .TP 
494 .I "The Claws Mail Team"
495 .LP
496 .RS 4
497 Holger Berndt                   <berndth@users.sf.net>
498 .br 
499 Tristan Chabredier              <wwp@claws\-mail.org>
500 .br 
501 Andrej Kacian                   <andrej@kacian.sk>
502 .br 
503 Darko Koruga                    <darko@users.sf.net>
504 .br 
505 Ricardo Mones Lastra    <ricardo@mones.org>
506 .br 
507 Colin Leroy                     <colin@colino.net>
508 .br 
509 Paul Mangan                     <paul@claws\-mail.org>
510 .br 
511 Salvatore De Paolis     <iwkse@claws\-mail.org>
512 .br
513 Pawel Pekala                    <cOrn@o2.pl>
514 .br
515 Michael Rasmussen               <mir@datanom.net>
516 .RE
517
518 .TP 
519 .I "Previous team members"
520 .LP
521 .RS 4
522 Ho\(`a Vi\(^et Dinh, Keith Edmunds, Match Grun, Melvin Hadasht,
523 Oliver Haertel, Christoph Hohmann, Alfons Hoogervorst, Werner Koch,
524 Thorsten Maerz, Leandro A. F. Pereira, Luke Plant, Martin Schaaf,
525 Carsten Schurig, Fabien Vantard, Sergey Vlasov, Hiroyuki Yamamoto
526 .RE
527
528 .SH "SEE ALSO"
529 .LP 
530 .TP 
531 Claws Mail Homepage
532 <http://www.claws\-mail.org>
533 .TP
534 Claws Mail frequently asked questions
535 <http://www.claws\-mail.org/faq>
536 .TP
537 Claws Mail online manual
538 <http://www.claws\-mail.org/manual>
539 .TP
540 Claws Mail plugins
541 <http://www.claws\-mail.org/plugins.php>
542