doc/man/claws-mail.1

   1 .TH "Claws Mail" "1" "January 09, 2009" "Hiroyuki Yamamoto & the Claws Mail team"
   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 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 \-\-subscribe\fR [uri]
  99 .br
 100 \fB \-\-attach file1 [file2]...\fR
 101 .br
 102 \fB \-\-receive\fR
 103 .br
 104 \fB \-\-receive\-all\fR
 105 .br
 106 \fB \-\-send\fR
 107 .br
 108 \fB \-\-status\fR
 109 .br
 110 \fB \-\-status folder[/subfolder]\fR
 111 .br
 112 \fB \-\-status\-full\fR
 113 .br
 114 \fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
 115 .br
 116 \fB \-\-online\fR
 117 .br
 118 \fB \-\-offline\fR
 119 .br
 120 \fB \-\-exit\fR
 121 .br
 122 \fB \-\-debug\fR
 123 .br
 124 \fB \-\-help\fR
 125 .br
 126 \fB \-\-version\fR
 127 .br
 128 \fB \-\-version\-full\fR
 129 .br
 130 \fB \-\-config\-dir\fR
 131 .br
 132 \fB \-\-alternate\-config\-dir [dir]\fR
 133
 134 .SH "FILES"
 135 .LP
 136 .TP
 137 $HOME/Mail
 138 Default directory for mail storage
 139 .TP
 140 $PREFIX/share/claws\-mail
 141 Global program directory
 142 .TP
 143 $PREFIX/share/claws\-mail/manual
 144 Manual files in HTML, PDF, PostScript and plain text format
 145 .TP
 146 $PREFIX/share/claws\-mail/themes
 147 Global themes directory
 148 .TP
 149 $PREFIX/lib/claws\-mail/plugins
 150 Directory for plugins
 151 .TP
 152 $PREFIX/include/claws\-mail
 153 Directory for header files
 154 .TP
 155 $HOME/.claws\-mail
 156 Default directory for user's configuration files directory
 157 .TP
 158 $HOME/.claws\-mail/addrbook/*
 159 Addressbook files
 160 .TP
 161 $HOME/.claws\-mail/templates
 162 User\-defined templates directory
 163 .TP
 164 $HOME/.claws\-mail/themes
 165 User's themes directory
 166 .TP
 167 $HOME/.claws\-mail/accountrc
 168 Configuration for account(s)
 169 .TP
 170 $HOME/.claws\-mail/actionsrc
 171 User\-defined custom actions
 172 .TP
 173 $HOME/.claws\-mail/addressbookcustomattributerc
 174 User\-defined address book custom attributes
 175 .TP
 176 $HOME/.claws\-mail/claws.log
 177 Claws Mail logfile
 178 .TP
 179 $HOME/.claws\-mail/claws-win32.log
 180 Claws Mail output file (Windows only)
 181 .TP
 182 $HOME/.claws\-mail/clawsrc
 183 Main configuration file
 184 .TP
 185 $HOME/.claws\-mail/command_history
 186 User\-specified commands
 187 .TP
 188 $HOME/.claws\-mail/customheaderrc
 189 Configuration for custom headers for sending mail
 190 .TP
 191 $HOME/.claws\-mail/dispheaderrc
 192 Configuration for custom display of headers in message view
 193 .TP
 194 $HOME/.claws\-mail/folderitemrc
 195 All folders' attributes
 196 .TP
 197 $HOME/.claws\-mail/folderlist.xml
 198 Folder hierarchy listing
 199 .TP
 200 $HOME/.claws\-mail/matcherrc
 201 Filtering and Processing function configuration
 202 .TP
 203 $HOME/.claws\-mail/menurc
 204 Menu shortcut\-key configuration
 205 .TP
 206 $HOME/.claws\-mail/messagesearch_history
 207 User\-specified searches in message bodies
 208 .TP
 209 $HOME/.claws\-mail/quicksearch_history
 210 User\-specified quick-search list
 211 .TP
 212 $HOME/.claws\-mail/messagesearch_history
 213 User\-specified searches in message bodies
 214 .TP
 215 $HOME/.claws\-mail/summary*_history
 216 User\-specified searches in message list
 217 .TP
 218 $HOME/.claws\-mail/tagsrc
 219 User\-specified tag list
 220 .TP
 221 $HOME/.claws\-mail/toolbar*.xml
 222 User\-defined custom toolbars
 223
 224 .SH "EXAMPLES"
 225 .LP
 226 To run this program the standard way type:
 227 .LP
 228 claws\-mail
 229 .LP
 230 Alternatively you can run it with the following options:
 231 .TP
 232 \fB\-\-compose [address]\fR
 233 to open a Compose window
 234 .TP
 235 \fB\-\-subscribe [uri]\fR
 236 subscribe to the given URI if possible
 237 .TP
 238 \fB\-\-attach file1 [file2]...\fR
 239 open composition window with specified files attached
 240 .TP
 241 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
 242 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window
 243 .TP
 244 \fB\-\-receive\fR
 245 receive new messages
 246 .TP
 247 \fB\-\-receive\-all\fR
 248 receive new messages from all accounts
 249 .TP
 250 \fB\-\-send\fR
 251 .br
 252 send all queued messages
 253 .TP
 254 \fB\-\-status\fR
 255 show the total number of messages
 256 .br
 257 [new][unread][unread answers to marked][total]
 258 .TP
 259 \fB\-\-status folder[/subfolder]\fR
 260 show the total number of messages in specified folder
 261 .br
 262 [new][unread][unread answers to marked][total]
 263 .TP
 264 \fB\-\-status\-full\fR
 265 show the total number of messages per folder
 266 .br
 267 [new][unread][unread answers to marked][total]
 268 .TP
 269 \fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
 270 On startup, jumps to the specified folder/message
 271 .TP
 272 \fB\-\-online\fR
 273 Start claws\-mail in (or switch to, if already running) online mode
 274 .TP
 275 \fB\-\-offline\fR
 276 Start claws\-mail in (or switch to, if already running) offline mode
 277 .TP
 278 \fB\-\-help\fR
 279 display the help message and exit
 280 .TP
 281 \fB\-\-exit\fR
 282 exit Claws Mail
 283 .TP
 284 \fB\-\-debug\fR
 285 for debug mode
 286 .TP
 287 \fB\-\-version\fR
 288 display version number and exit
 289 .TP
 290 \fB\-\-version-full\fR
 291 display version number and compiled-in features then exit
 292 .TP
 293 \fB\-\-config\-dir\fR
 294 display the CONFIG\-DIR and exit
 295 .TP
 296 \fB\-\-alternate\-config\-dir [dir]\fR
 297 start Claws Mail with the configuration stored in [dir] directory
 298
 299 .SH "INSTALLATION"
 300 .LP
 301 This program requires GTK+ 2.6.x or higher to be compiled.
 302 .LP
 303 Please make sure that gtk\-devel and glib\-devel (or similar) packages are
 304 installed before the compilation (you may also require flex (lex) and bison
 305 (yacc)).
 306 .LP
 307 To compile and install, just type:
 308 .LP
 309 % ./configure
 310 .br
 311 % make
 312 .br
 313 % su
 314 .br
 315 Password: [Enter password]
 316 .br
 317 # make install
 318 .LP
 319 Refer to ./configure \-\-help for further information.
 320
 321 .SH "AUTHORS"
 322 .LP
 323 .TP
 324 The Claws Mail Team
 325 Holger Berndt                   <berndth@users.sf.net>
 326 .br
 327 Tristan Chabredier              <wwp@claws\-mail.org>
 328 .br
 329 Ho\(`a Vi\(^et Dinh                     <hoa@users.sf.net>
 330 .br
 331 Andrej Kacian                   <andrej@kacian.sk>
 332 .br
 333 Darko Koruga                    <darko@users.sf.net>
 334 .br
 335 Ricardo Mones Lastra    <ricardo@mones.org>
 336 .br
 337 Colin Leroy                     <colin@colino.net>
 338 .br
 339 Paul Mangan                     <paul@claws\-mail.org>
 340 .br
 341 Salvatore De Paolis     <iwkse@claws\-mail.org>
 342
 343 .TP
 344 Previous team members
 345 Keith Edmunds
 346 .br
 347 Match Grun
 348 .br
 349 Melvin Hadasht
 350 .br
 351 Oliver Haertel
 352 .br
 353 Christoph Hohmann
 354 .br
 355 Alfons Hoogervorst
 356 .br
 357 Werner Koch
 358 .br
 359 Thorsten Maerz
 360 .br
 361 Leandro A. F. Pereira
 362 .br
 363 Luke Plant
 364 .br
 365 Martin Schaaf
 366 .br
 367 Carsten Schurig
 368 .br
 369 Fabien Vantard
 370 .br
 371 Sergey Vlasov
 372 .br
 373 Hiroyuki Yamamoto
 374
 375 .SH "SEE ALSO"
 376 .LP
 377 .TP
 378 Claws Mail Homepage
 379 <http://www.claws\-mail.org>