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