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