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 \-\-help\fR
 135 .br
 136 \fB \-\-version\fR
 137 .br
 138 \fB \-\-version\-full\fR
 139 .br
 140 \fB \-\-config\-dir\fR
 141 .br
 142 \fB \-\-alternate\-config\-dir [dir]\fR
 143
 144 .SH "FILES"
 145 .LP
 146 .TP
 147 $HOME/Mail
 148 Default directory for mail storage
 149 .TP
 150 $PREFIX/share/claws\-mail
 151 Global program directory
 152 .TP
 153 $PREFIX/share/claws\-mail/manual
 154 Manual files in HTML, PDF, PostScript and plain text format
 155 .TP
 156 $PREFIX/share/claws\-mail/themes
 157 Global themes directory
 158 .TP
 159 $PREFIX/lib/claws\-mail/plugins
 160 Directory for plugins
 161 .TP
 162 $PREFIX/include/claws\-mail
 163 Directory for header files
 164 .TP
 165 $HOME/.claws\-mail
 166 Default directory for user's configuration files directory
 167 .TP
 168 $HOME/.claws\-mail/addrbook/*
 169 Addressbook files
 170 .TP
 171 $HOME/.claws\-mail/autofaces/*
 172 Automatic Faces and X\-Faces files for accounts
 173 .TP
 174 $HOME/.claws\-mail/certs/*
 175 SSL certificates received from mail servers
 176 .TP
 177 $HOME/.claws\-mail/templates
 178 User\-defined templates directory
 179 .TP
 180 $HOME/.claws\-mail/themes
 181 User's themes directory
 182 .TP
 183 $HOME/.claws\-mail/accountrc
 184 Configuration for account(s)
 185 .TP
 186 $HOME/.claws\-mail/actionsrc
 187 User\-defined custom actions
 188 .TP
 189 $HOME/.claws\-mail/addressbookcustomattributerc
 190 User\-defined address book custom attributes
 191 .TP
 192 $HOME/.claws\-mail/claws.log
 193 Claws Mail logfile
 194 .TP
 195 $HOME/.claws\-mail/claws-win32.log
 196 Claws Mail output file (Windows only)
 197 .TP
 198 $HOME/.claws\-mail/clawsrc
 199 Main configuration file
 200 .TP
 201 $HOME/.claws\-mail/command_history
 202 User\-specified commands
 203 .TP
 204 $HOME/.claws\-mail/customheaderrc
 205 Configuration for custom headers for sending mail
 206 .TP
 207 $HOME/.claws\-mail/dispheaderrc
 208 Configuration for custom display of headers in message view
 209 .TP
 210 $HOME/.claws\-mail/extraheaderrc
 211 Editable extra headers to be added to compose window combobox
 212 .TP
 213 $HOME/.claws\-mail/folderitemrc
 214 All folders' attributes
 215 .TP
 216 $HOME/.claws\-mail/folderlist.xml
 217 Folder hierarchy listing
 218 .TP
 219 $HOME/.claws\-mail/matcherrc
 220 Filtering and Processing function configuration
 221 .TP
 222 $HOME/.claws\-mail/menurc
 223 Menu shortcut\-key configuration
 224 .TP
 225 $HOME/.claws\-mail/messagesearch_history
 226 User\-specified searches in message bodies
 227 .TP
 228 $HOME/.claws\-mail/quicksearch_history
 229 User\-specified quick\-search list
 230 .TP
 231 $HOME/.claws\-mail/messagesearch_history
 232 User\-specified searches in message bodies
 233 .TP
 234 $HOME/.claws\-mail/summary*_history
 235 User\-specified searches in message list
 236 .TP
 237 $HOME/.claws\-mail/tagsrc
 238 User\-specified tag list
 239 .TP
 240 $HOME/.claws\-mail/toolbar*.xml
 241 User\-defined custom toolbars
 242
 243 .SH "EXAMPLES"
 244 .LP
 245 To run this program the standard way type:
 246 .LP
 247 claws\-mail
 248 .LP
 249 Alternatively you can run it with the following options:
 250 .TP
 251 \fB\-\-compose [address]\fR
 252 to open a Compose window
 253 .TP
 254 \fB\-\-compose\-from\-file file
 255 open composition window with data from given file. Use \- as file name
 256 for reading from standard input. Content format: headers first (To:
 257 header required) until an empty line is found, then mail body until
 258 end of file.
 259 .TP
 260 \fB\-\-subscribe [uri]\fR
 261 subscribe to the given URI if possible
 262 .TP
 263 \fB\-\-attach file1 [file2]...\fR
 264 open composition window with specified files attached
 265 .TP
 266 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
 267 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window.
 268 Possible fields after the destination recipient are: subject, from, cc, bcc, in\-reply\-to,
 269 body, insert (insert a file in body part, needs an absolute path), attach (attach a file,
 270 needs an absolute path, see also: \-\-attach)
 271 .TP
 272 \fB\-\-receive\fR
 273 receive new messages
 274 .TP
 275 \fB\-\-receive\-all\fR
 276 receive new messages from all accounts
 277 .TP
 278 \fB\-\-cancel\-receiving\fR
 279 cancel receiving of messages
 280 .TP
 281 \fB\-\-cancel\-sending\fR
 282 cancel sending of messages
 283 .TP
 284 \fB\-\-send\fR
 285 .br
 286 send all queued messages
 287 .TP
 288 \fB\-\-status\fR
 289 show the total number of messages
 290 .br
 291 [new][unread][unread answers to marked][total]
 292 .TP
 293 \fB\-\-status folder[/subfolder]\fR
 294 show the total number of messages in specified folder
 295 .br
 296 [new][unread][unread answers to marked][total]
 297 .TP
 298 \fB\-\-status\-full\fR
 299 show the total number of messages per folder
 300 .br
 301 [new][unread][unread answers to marked][total]
 302 .TP
 303 \fB\-\-statistics\fR
 304 .br
 305 show session statistics
 306 .TP
 307 \fB\-\-reset-statistics\fR
 308 .br
 309 reset session statistics
 310 .TP
 311 \fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
 312 on startup, jumps to the specified folder/message
 313 .TP
 314 \fB\-\-online\fR
 315 start Claws Mail in (or switch to, if already running) online mode
 316 .TP
 317 \fB\-\-offline\fR
 318 start Claws Mail in (or switch to, if already running) offline mode
 319 .TP
 320 \fB\-\-help\fR
 321 display the help message and exit
 322 .TP
 323 \fB\-\-exit\fR
 324 exit Claws Mail
 325 .TP
 326 \fB\-\-debug\fR
 327 for debug mode
 328 .TP
 329 \fB\-\-version\fR
 330 display version number and exit
 331 .TP
 332 \fB\-\-version\-full\fR
 333 display version number and compiled\-in features then exit
 334 .TP
 335 \fB\-\-config\-dir\fR
 336 display the CONFIG\-DIR and exit
 337 .TP
 338 \fB\-\-alternate\-config\-dir [dir]\fR
 339 start Claws Mail with the configuration stored in [dir] directory
 340
 341 .SH "ENVIRONMENT"
 342 .LP
 343 .TP
 344 \fBLC_ALL\fR
 345 .TP
 346 \fBLC_CTYPE\fR
 347 .TP
 348 \fBLANG\fR
 349 locale to use for non-win32 systems (the first one not empty is used)
 350 .TP
 351 \fBSSL_CERT_FILE\fR
 352 use this CA certificates file instead of searching known system files
 353 .TP
 354 \fBSSL_CERT_DIR\fR
 355 use this CA certificates directory instead known system directories
 356 .TP
 357 \fBPOSIXLY_CORRECT\fR
 358 if defined regular expressions matching follows POSIX standards
 359 .TP
 360 \fBHOME\fR
 361 full path of the user's home directory
 362 .TP
 363 \fBCLAWS_NO_CRASH\fR
 364 if defined disables crash dialog (only if Claws Mail has been built with
 365 crash dialog feature enabled)
 366 .TP
 367 \fBG_BROKEN_FILENAMES\fR
 368 assumes that filenames are in the locale encoding rather than in UTF-8
 369 .TP
 370 \fBPILOT_CHARSET\fR
 371 if defined overrides default J-Pilot charset (CP1252)
 372 .TP
 373 \fBSESSION_MANAGER\fR
 374 if defined tries to use the Session Manager (only if Claws Mail has been
 375 built with libSM feature enabled)
 376 .TP
 377 \fBDISPLAY\fR
 378 default host and display number to use
 379 .TP
 380 \fBGPG_AGENT_INFO\fR
 381 the information to access the GPG agent if using GPG agent is enabled in
 382 GPG plugin preferences (this is usually set by the agent when launched,
 383 otherwise it likely means the GPG agent is not running)
 384 .TP
 385 \fBSHELL\fR
 386 if defined overrides default shell "sh" used by Spamassassin plugin to
 387 launch spamc wrappers
 388
 389 .SH "BUGS"
 390 .LP
 391 .TP
 392 You can search for existing bugs and report new ones on Claws Mail bugzilla:
 393 .br
 394 <http://www.thewildbeast.co.uk/claws-mail/bugzilla/>
 395
 396 .SH "COPYRIGHT"
 397 .LP
 398 .TP
 399 1999-2012 Hiroyuki Yamamoto and the Claws Mail team
 400
 401 .SH "AUTHORS"
 402 .LP
 403 .TP
 404 The Claws Mail Team
 405 Holger Berndt                   <berndth@users.sf.net>
 406 .br
 407 Tristan Chabredier              <wwp@claws\-mail.org>
 408 .br
 409 Andrej Kacian                   <andrej@kacian.sk>
 410 .br
 411 Darko Koruga                    <darko@users.sf.net>
 412 .br
 413 Ricardo Mones Lastra    <ricardo@mones.org>
 414 .br
 415 Colin Leroy                     <colin@colino.net>
 416 .br
 417 Paul Mangan                     <paul@claws\-mail.org>
 418 .br
 419 Salvatore De Paolis     <iwkse@claws\-mail.org>
 420
 421 .TP
 422 Previous team members
 423 Ho\(`a Vi\(^et Dinh
 424 .br
 425 Keith Edmunds
 426 .br
 427 Match Grun
 428 .br
 429 Melvin Hadasht
 430 .br
 431 Oliver Haertel
 432 .br
 433 Christoph Hohmann
 434 .br
 435 Alfons Hoogervorst
 436 .br
 437 Werner Koch
 438 .br
 439 Thorsten Maerz
 440 .br
 441 Leandro A. F. Pereira
 442 .br
 443 Luke Plant
 444 .br
 445 Martin Schaaf
 446 .br
 447 Carsten Schurig
 448 .br
 449 Fabien Vantard
 450 .br
 451 Sergey Vlasov
 452 .br
 453 Hiroyuki Yamamoto
 454
 455 .SH "SEE ALSO"
 456 .LP
 457 .TP
 458 Claws Mail Homepage
 459 <http://www.claws\-mail.org>
 460 .TP
 461 Claws Mail online manual
 462 <http://www.claws\-mail.org/manual>
 463 .TP
 464 Claws Mail plugins
 465 <http://www.claws\-mail.org/plugins.php>
 466