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