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