doc/man/claws-mail.1

   1 .TH "CLAWS MAIL" "1" "November 1, 2011" "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 * Quick response
  16 .br
  17 * Graceful, and sophisticated interface
  18 .br
  19 * Easy configuration, intuitive operation
  20 .br
  21 * Abundant features
  22 \fR
  23 .TP
  24 Currently implemented features include:
  25 o POP3 support
  26 .br
  27 o IMAP4rev1 support
  28 .br
  29 o integrated NetNews client
  30 .br
  31 o unlimited multiple account handling
  32 .br
  33 o thread display
  34 .br
  35 o filtering
  36 .br
  37 o MIME (attachments)
  38 .br
  39 o built\-in image view
  40 .br
  41 o X\-Face and (colour) Face support
  42 .br
  43 o multiple MH folder support
  44 .br
  45 o mbox importing / exporting
  46 .br
  47 o external editor support
  48 .br
  49 o message queueing
  50 .br
  51 o automatic mail checking
  52 .br
  53 o draft message function
  54 .br
  55 o template function
  56 .br
  57 o line\-wrapping
  58 .br
  59 o clickable URI
  60 .br
  61 o XML\-based address book
  62 .br
  63 o LDAP, vCard, and JPilot support
  64 .br
  65 o newly arrived and unread message management
  66 .br
  67 o Mew/Wanderlust\-like key bind
  68 .br
  69 o printing
  70 .br
  71 o APOP authentication support
  72 .br
  73 o SMTP AUTH support
  74 .br
  75 o SSL support (POP3, SMTP, IMAP4rev1)
  76 .br
  77 o IPv6 support
  78 .br
  79 o drag & drop (partially implemented)
  80 .br
  81 o GnuPG support
  82 .br
  83 o automake + autoconf support
  84 .br
  85 o internationalization of messages by gettext
  86 .br
  87 o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
  88 .br
  89 o 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/templates
 180 User\-defined templates directory
 181 .TP
 182 $HOME/.claws\-mail/themes
 183 User's themes directory
 184 .TP
 185 $HOME/.claws\-mail/accountrc
 186 Configuration for account(s)
 187 .TP
 188 $HOME/.claws\-mail/actionsrc
 189 User\-defined custom actions
 190 .TP
 191 $HOME/.claws\-mail/addressbookcustomattributerc
 192 User\-defined address book custom attributes
 193 .TP
 194 $HOME/.claws\-mail/claws.log
 195 Claws Mail logfile
 196 .TP
 197 $HOME/.claws\-mail/claws-win32.log
 198 Claws Mail output file (Windows only)
 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
 245 .SH "EXAMPLES"
 246 .LP
 247 To run this program the standard way type:
 248 .LP
 249 claws\-mail
 250 .LP
 251 Alternatively you can run it with the following options:
 252 .TP
 253 \fB\-\-compose [address]\fR
 254 to open a Compose window
 255 .TP
 256 \fB\-\-compose\-from\-file file
 257 open composition window with data from given file. Use \- as file name
 258 for reading from standard input. Content format: headers first (To:
 259 header required) until an empty line is found, then mail body until
 260 end of file.
 261 .TP
 262 \fB\-\-subscribe [uri]\fR
 263 subscribe to the given URI if possible
 264 .TP
 265 \fB\-\-attach file1 [file2]...\fR
 266 open composition window with specified files attached
 267 .TP
 268 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
 269 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window.
 270 Possible fields after the destination recipient are: subject, from, cc, bcc, in\-reply\-to,
 271 body, insert (insert a file in body part, needs an absolute path), attach (attach a file,
 272 needs an absolute path, see also: \-\-attach)
 273 .TP
 274 \fB\-\-receive\fR
 275 receive new messages
 276 .TP
 277 \fB\-\-receive\-all\fR
 278 receive new messages from all accounts
 279 .TP
 280 \fB\-\-cancel\-receiving\fR
 281 cancel receiving of messages
 282 .TP
 283 \fB\-\-cancel\-sending\fR
 284 cancel sending of messages
 285 .TP
 286 \fB\-\-send\fR
 287 .br
 288 send all queued messages
 289 .TP
 290 \fB\-\-status\fR
 291 show the total number of messages
 292 .br
 293 [new][unread][unread answers to marked][total]
 294 .TP
 295 \fB\-\-status folder[/subfolder]\fR
 296 show the total number of messages in specified folder
 297 .br
 298 [new][unread][unread answers to marked][total]
 299 .TP
 300 \fB\-\-status\-full\fR
 301 show the total number of messages per folder
 302 .br
 303 [new][unread][unread answers to marked][total]
 304 .TP
 305 \fB\-\-statistics\fR
 306 .br
 307 show session statistics
 308 .TP
 309 \fB\-\-reset-statistics\fR
 310 .br
 311 reset session statistics
 312 .TP
 313 \fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
 314 on startup, jumps to the specified folder/message
 315 .TP
 316 \fB\-\-online\fR
 317 start Claws Mail in (or switch to, if already running) online mode
 318 .TP
 319 \fB\-\-offline\fR
 320 start Claws Mail in (or switch to, if already running) offline mode
 321 .TP
 322 \fB\-\-help\fR
 323 display the help message and exit
 324 .TP
 325 \fB\-\-exit\fR
 326 exit Claws Mail
 327 .TP
 328 \fB\-\-debug\fR
 329 for debug mode
 330 .TP
 331 \fB\-\-toggle-debug\fR
 332 toggle debug mode of a running Claws Mail instance
 333 .TP
 334 \fB\-\-version\fR
 335 display version number and exit
 336 .TP
 337 \fB\-\-version\-full\fR
 338 display version number and compiled\-in features then exit
 339 .TP
 340 \fB\-\-config\-dir\fR
 341 display the CONFIG\-DIR and exit
 342 .TP
 343 \fB\-\-alternate\-config\-dir [dir]\fR
 344 start Claws Mail with the configuration stored in [dir] directory
 345
 346 .SH "ENVIRONMENT"
 347 .LP
 348 .TP
 349 \fBLC_ALL\fR
 350 .TP
 351 \fBLC_CTYPE\fR
 352 .TP
 353 \fBLANG\fR
 354 locale to use for non-win32 systems (the first one not empty is used)
 355 .TP
 356 \fBSSL_CERT_FILE\fR
 357 use this CA certificates file instead of searching known system files
 358 .TP
 359 \fBSSL_CERT_DIR\fR
 360 use this CA certificates directory instead known system directories
 361 .TP
 362 \fBPOSIXLY_CORRECT\fR
 363 if defined regular expressions matching follows POSIX standards
 364 .TP
 365 \fBHOME\fR
 366 full path of the user's home directory
 367 .TP
 368 \fBCLAWS_NO_CRASH\fR
 369 if defined disables crash dialog (only if Claws Mail has been built with
 370 crash dialog feature enabled)
 371 .TP
 372 \fBG_BROKEN_FILENAMES\fR
 373 assumes that filenames are in the locale encoding rather than in UTF-8
 374 .TP
 375 \fBPILOT_CHARSET\fR
 376 if defined overrides default J-Pilot charset (CP1252)
 377 .TP
 378 \fBSESSION_MANAGER\fR
 379 if defined tries to use the Session Manager (only if Claws Mail has been
 380 built with libSM feature enabled)
 381 .TP
 382 \fBDISPLAY\fR
 383 default host and display number to use
 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 \fBSHELL\fR
 391 if defined overrides default shell "sh" used by Spamassassin plugin to
 392 launch spamc wrappers
 393
 394 .SH "BUGS"
 395 .LP
 396 .TP
 397 You can search for existing bugs and report new ones on Claws Mail bugzilla:
 398 .br
 399 <http://www.thewildbeast.co.uk/claws-mail/bugzilla/>
 400
 401 .SH "COPYRIGHT"
 402 .LP
 403 .TP
 404 1999-2013 Hiroyuki Yamamoto and the Claws Mail team
 405
 406 .SH "AUTHORS"
 407 .LP
 408 .TP
 409 The Claws Mail Team
 410 Holger Berndt                   <berndth@users.sf.net>
 411 .br
 412 Tristan Chabredier              <wwp@claws\-mail.org>
 413 .br
 414 Andrej Kacian                   <andrej@kacian.sk>
 415 .br
 416 Darko Koruga                    <darko@users.sf.net>
 417 .br
 418 Ricardo Mones Lastra    <ricardo@mones.org>
 419 .br
 420 Colin Leroy                     <colin@colino.net>
 421 .br
 422 Paul Mangan                     <paul@claws\-mail.org>
 423 .br
 424 Salvatore De Paolis     <iwkse@claws\-mail.org>
 425
 426 .TP
 427 Previous team members
 428 Ho\(`a Vi\(^et Dinh
 429 .br
 430 Keith Edmunds
 431 .br
 432 Match Grun
 433 .br
 434 Melvin Hadasht
 435 .br
 436 Oliver Haertel
 437 .br
 438 Christoph Hohmann
 439 .br
 440 Alfons Hoogervorst
 441 .br
 442 Werner Koch
 443 .br
 444 Thorsten Maerz
 445 .br
 446 Leandro A. F. Pereira
 447 .br
 448 Luke Plant
 449 .br
 450 Martin Schaaf
 451 .br
 452 Carsten Schurig
 453 .br
 454 Fabien Vantard
 455 .br
 456 Sergey Vlasov
 457 .br
 458 Hiroyuki Yamamoto
 459
 460 .SH "SEE ALSO"
 461 .LP
 462 .TP
 463 Claws Mail Homepage
 464 <http://www.claws\-mail.org>
 465 .TP
 466 Claws Mail online manual
 467 <http://www.claws\-mail.org/manual>
 468 .TP
 469 Claws Mail plugins
 470 <http://www.claws\-mail.org/plugins.php>
 471