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