doc/man/claws-mail.1

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