doc/man/claws-mail.1

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