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