doc/man/claws-mail.1

   1 .TH "CLAWS MAIL" "1" "March 26, 2017" "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 \-\-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 [dir]\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 .B "Windows only"
 256 .LP
 257 .TP
 258 %TEMP%\\claws\-win32.log
 259 Claws Mail output file when \-\-debug is enabled. If %TEMP% is not set it
 260 defaults to windows directory (usually C:\\Windows) or C:\\ if windows
 261 directory is not available.
 262 .TP
 263 %APPDATA%\\Claws\-mail\\claws.log
 264 Claws Mail log file.
 265
 266 .SH "EXAMPLES"
 267 .LP
 268 To run this program the standard way type:
 269 .LP
 270 claws\-mail
 271 .LP
 272 Alternatively you can run it with the following options:
 273 .TP
 274 \fB\-\-compose [address]\fR
 275 To open a Compose window.
 276 .TP
 277 \fB\-\-compose\-from\-file file
 278 Open composition window with data from the given file. Use \- as file name
 279 for reading from standard input. Content format: headers first (To: header
 280 required) until an empty line is found, then mail body until end of file.
 281 .TP
 282 \fB\-\-subscribe [uri]\fR
 283 Subscribe to the given URI if possible.
 284 .TP
 285 \fB\-\-attach file1 [file2]...\fR
 286 Open composition window with specified files attached.
 287 .TP
 288 \fB\-\-insert file1 [file2]...\fR
 289 Open composition window with specified files inserted.
 290 .TP
 291 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
 292 This syntax can be used in web\-browsers and CLI to open a pre\-populated
 293 Compose window. Possible fields after the destination recipient are: subject,
 294 from, cc, bcc, in\-reply\-to, body, insert (insert a file in body part, needs
 295 an absolute path), attach (attach a file, needs an absolute path, see also:
 296 \-\-attach).
 297 .TP
 298 \fB\-\-receive\fR
 299 Receive new messages.
 300 .TP
 301 \fB\-\-receive\-all\fR
 302 Receive new messages from all accounts.
 303 .TP
 304 \fB\-\-cancel\-receiving\fR
 305 Cancel receiving of messages.
 306 .TP
 307 \fB\-\-cancel\-sending\fR
 308 Cancel sending of messages.
 309 .TP
 310 \fB\-\-send\fR
 311 .br
 312 Send all queued messages.
 313 .TP
 314 \fB\-\-status\fR
 315 Show the total number of messages:
 316 .br
 317 [new][unread][unread answers to marked][total]
 318 .TP
 319 \fB\-\-status folder[/subfolder]\fR
 320 Show the total number of messages in the specified folder:
 321 .br
 322 [new][unread][unread answers to marked][total]
 323 .TP
 324 \fB\-\-status\-full\fR
 325 Show the total number of messages per folder:
 326 .br
 327 [new][unread][unread answers to marked][total]
 328 .TP
 329 \fB\-\-statistics\fR
 330 .br
 331 Show session statistics.
 332 .TP
 333 \fB\-\-reset-statistics\fR
 334 .br
 335 Reset session statistics.
 336 .TP
 337 \fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
 338 On startup, jumps to the specified folder/message.
 339 .TP
 340 \fB\-\-online\fR
 341 Start Claws Mail in (or switch to, if already running) online mode.
 342 .TP
 343 \fB\-\-offline\fR
 344 Start Claws Mail in (or switch to, if already running) offline mode.
 345 .TP
 346 \fB\-\-help\fR
 347 Display the help message and exit.
 348 .TP
 349 \fB\-\-exit\fR
 350 Exit Claws Mail.
 351 .TP
 352 \fB\-\-debug\fR
 353 For debug mode (on Windows systems output is written to a file instead
 354 of standard error output, see \fBWindows only\fR on \fBFILES\fR
 355 section).
 356 .TP
 357 \fB\-\-toggle-debug\fR
 358 Toggle debug mode of the running Claws Mail instance.
 359 .TP
 360 \fB\-\-version\fR
 361 Display version number and exit.
 362 .TP
 363 \fB\-\-version\-full\fR
 364 Display version number and compiled\-in features then exit.
 365 .TP
 366 \fB\-\-config\-dir\fR
 367 Display the CONFIG\-DIR and exit.
 368 .TP
 369 \fB\-\-alternate\-config\-dir [dir]\fR
 370 Start Claws Mail with the configuration stored in the [dir] directory.
 371 .TP
 372 \fB\-\-geometry WxH+X+Y\fR
 373 Set initial X geometry of main window.
 374
 375 .SH "ENVIRONMENT"
 376 .LP
 377 .TP
 378 \fBCLAWS_NO_CRASH\fR
 379 If defined disables crash dialog (only if Claws Mail has been built with
 380 crash dialog feature enabled).
 381 .TP
 382 \fBDISPLAY\fR
 383 Default host and display number to use.
 384 .TP
 385 \fBETPANSERVER\fR, \fBETPANPORT\fR
 386 When using a tunnel command to open server connections these temporary
 387 variables are set to the server name and server port respectively in the
 388 environment of the running command.
 389 .TP
 390 \fBGPG_AGENT_INFO\fR
 391 The information to access the GPG agent if using GPG agent is enabled in
 392 GPG plugin preferences (this is usually set by the agent when launched,
 393 otherwise it likely means the GPG agent is not running).
 394 .TP
 395 \fBG_BROKEN_FILENAMES\fR
 396 Assumes that filenames are in the locale encoding rather than in UTF\-8.
 397 .TP
 398 \fBHOME\fR
 399 Full path of the user's home directory.
 400 .TP
 401 \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLANG\fR
 402 Locale to use for non\-windows systems (the first one not empty is used).
 403 .TP
 404 \fBPILOT_CHARSET\fR
 405 If defined overrides default J\-Pilot charset (CP1252).
 406 .TP
 407 \fBPOSIXLY_CORRECT\fR
 408 If defined regular expressions matching follows POSIX standards.
 409 .TP
 410 \fBSESSION_MANAGER\fR
 411 If defined tries to use the Session Manager (only if Claws Mail has been
 412 built with libSM feature enabled).
 413 .TP
 414 \fBSHELL\fR
 415 If defined overrides default shell "sh" used by Spamassassin plugin to
 416 launch spamc wrappers.
 417 .TP
 418 \fBSSL_CERT_DIR\fR
 419 Use this CA certificates directory instead known system directories.
 420 .TP
 421 \fBSSL_CERT_FILE\fR
 422 Use this CA certificates file instead of searching known system files.
 423 .TP
 424 \fBUSER\fR
 425 Used to initialize default "user_id" preference in newly created accounts.
 426
 427 .SH "BUGS"
 428 .LP
 429 .TP
 430 You can search for existing bugs and report new ones on Claws Mail bugzilla:
 431 .br
 432 <http://www.thewildbeast.co.uk/claws\-mail/bugzilla/>
 433
 434 .SH "COPYRIGHT"
 435 .LP
 436 .TP
 437 1999\-2017 The Claws Mail team and Hiroyuki Yamamoto
 438 .LP
 439 Portions are also Copyright:
 440 .br
 441 (C) 2007\-2009 g10 Code GmbH
 442 .br
 443 (C) 1999\-2005 Nullsoft, Inc.
 444 .br
 445 (C) 1991\-1993, 1996\-2000, 2001 Free Software Foundation, Inc.
 446 .br
 447 (C) 2001 Thomas Link, Hiroyuki Yamamoto
 448 .br
 449 (C) 1995\-1997 Peter Mattis and Spencer Kimball
 450 .br
 451 (C) 1995\-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
 452 .br
 453 (C) 1997\-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
 454 .br
 455 (C) 1999\-2003 Michael Natterer <mitch@gimp.org>
 456 .br
 457 (C) 2000 Evan Martin
 458 .br
 459 (C) 1998 Lars Hamann and Stefan Jeske
 460 .br
 461 (C) 2005, 2006, 2007, 2009 GNOME Foundation
 462 .br
 463 (C) 2004\-2006 Christian Hammond
 464 .br
 465 (C) 2003\-2004 Pawel Salek
 466 .br
 467 (C) 2001, 2002 \- DINH Viet Hoa
 468 .br
 469 (C) 1999\-2000, Gael Roualland <gael.roualland@iname.com>
 470 .br
 471 (C) 1998\-2002 Sendmail, Inc.
 472 .br
 473 (C) 2007\-2008 Juha Kautto (juha at xfce.org)
 474 .br
 475 (C) 1994\-2002 World Wide Web Consortium
 476 .br
 477 (C) 1999 Graham Davison
 478 .br
 479 (C) 1999 Eric Busboom
 480 .br
 481 (C) 2000, Eric Busboom, http://www.softwarestudio.org
 482 .br
 483 (C) 2002\-2007 Randall Hand <yerase@yerot.com>
 484 .br
 485 (C) 2001 by Werner Koch <dd9jn@gnu.org>
 486 .br
 487 (C) 2004 Apache Software Foundation
 488 .br
 489 (C) 2008 Mikkel Kamstrup Erlandsen
 490 .br
 491 (C) 2002  Red Hat, Inc.; Copyright 1998, 2001 Tim Janik
 492 .br
 493 (C) 2008\-2009  Christian Hammond, David Trowbridge
 494 .br
 495 (C) 2003\-2005  Lars Lindner <lars.lindner@gmx.net>
 496 .br
 497 (C) 2004,2005  Nathan J. Conrad <t98502@users.sourceforge.net>
 498 .br
 499 (C) 2004 Karl Soderstrom <ks@xanadunet.net>
 500 .br
 501 (C) 2000 Helix Code, Inc. (www.helixcode.com)
 502
 503 .SH "LICENSE"
 504 .LP
 505 .TP
 506 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.
 507 .TP
 508 See COPYING file on toplevel distribution directory for more license details.
 509
 510 .SH "AUTHORS"
 511 .LP
 512 .TP
 513 .I "The Claws Mail Team"
 514 .LP
 515 .RS 4
 516 Holger Berndt                   <berndth@users.sf.net>
 517 .br
 518 Tristan Chabredier              <wwp@claws\-mail.org>
 519 .br
 520 Andrej Kacian                   <andrej@kacian.sk>
 521 .br
 522 Darko Koruga                    <darko@users.sf.net>
 523 .br
 524 Ricardo Mones Lastra    <ricardo@mones.org>
 525 .br
 526 Charles Lehner                  <charles@claws-mail.org>
 527 .br
 528 Colin Leroy                     <colin@colino.net>
 529 .br
 530 Paul Mangan                     <paul@claws\-mail.org>
 531 .br
 532 Salvatore De Paolis     <iwkse@claws\-mail.org>
 533 .br
 534 Pawel Pekala                    <cOrn@o2.pl>
 535 .br
 536 Michael Rasmussen               <mir@datanom.net>
 537 .RE
 538
 539 .TP
 540 .I "Previous team members"
 541 .LP
 542 .RS 4
 543 Ho\(`a Vi\(^et Dinh, Keith Edmunds, Match Grun, Melvin Hadasht,
 544 Oliver Haertel, Christoph Hohmann, Alfons Hoogervorst, Werner Koch,
 545 Thorsten Maerz, Leandro A. F. Pereira, Luke Plant, Martin Schaaf,
 546 Carsten Schurig, Fabien Vantard, Sergey Vlasov and Hiroyuki Yamamoto.
 547 .RE
 548
 549 .SH "SEE ALSO"
 550 .LP
 551 .TP
 552 Claws Mail Homepage
 553 <http://www.claws\-mail.org>
 554 .TP
 555 Claws Mail frequently asked questions
 556 <http://www.claws\-mail.org/faq>
 557 .TP
 558 Claws Mail online manual
 559 <http://www.claws\-mail.org/manual>
 560 .TP
 561 Claws Mail plugins
 562 <http://www.claws\-mail.org/plugins.php>
 563 .TP
 564 \fIX\fR(7), \fIxwininfo\fR(1).
 565