doc/man/claws-mail.1

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