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