doc/man/sylpheed-claws.1

   1 .TH "Sylpheed-Claws" "1" "" "Hiroyuki Yamamoto & the Sylpheed-Claws team" ""
   2 .SH "NAME"
   3 .LP
   4 Sylpheed\-Claws \- a GTK+ based fast email and news client
   5 .SH "DESCRIPTION"
   6 .TP
   7 Sylpheed\-Claws is an email client (and news reader) based on GTK+, running on X Window System, and aiming for
   8 .br
   9 * Quick response
  10 .br
  11 * Graceful, and sophisticated interface
  12 .br
  13 * Easy configuration, intuitive operation
  14 .br
  15 * Abundant features
  16 \fR
  17 .TP
  18 Currently implemented features include:
  19 o POP3 support
  20 .br
  21 o IMAP4rev1 support
  22 .br
  23 o integrated NetNews client
  24 .br
  25 o unlimited multiple account handling
  26 .br
  27 o thread display
  28 .br
  29 o filtering
  30 .br
  31 o MIME (attachments)
  32 .br
  33 o built\-in image view
  34 .br
  35 o X\-Face support
  36 .br
  37 o multiple MH folder support
  38 .br
  39 o mbox importing / exporting
  40 .br
  41 o external editor support
  42 .br
  43 o message queueing
  44 .br
  45 o automatic mail checking
  46 .br
  47 o draft message function
  48 .br
  49 o template function
  50 .br
  51 o line\-wrapping
  52 .br
  53 o clickable URI
  54 .br
  55 o XML\-based address book
  56 .br
  57 o LDAP, vCard, and JPilot support
  58 .br
  59 o newly arrived and unread message management
  60 .br
  61 o Mew/Wanderlust\-like key bind
  62 .br
  63 o printing
  64 .br
  65 o APOP authentication support
  66 .br
  67 o SMTP AUTH support
  68 .br
  69 o SSL support (POP3, SMTP, IMAP4rev1)
  70 .br
  71 o IPv6 support
  72 .br
  73 o drag & drop (partially implemented)
  74 .br
  75 o GnuPG support (currently implementing)
  76 .br
  77 o automake + autoconf support
  78 .br
  79 o internationalization of messages by gettext
  80 .br
  81 o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
  82 .br
  83 o support for plugins
  84 \fR
  85 .LP
  86 This list is not complete.
  87 .SH "OPTIONS"
  88 .LP
  89 \fB \-\-compose\fR [address]
  90 .br
  91 \fB \-\-subscribe\fR [uri]
  92 .br
  93 \fB \-\-attach file1 [file2]...\fR
  94 .br
  95 \fB \-\-receive\fR
  96 .br
  97 \fB \-\-receive\-all\fR
  98 .br
  99 \fB \-\-send\fR
 100 .br
 101 \fB \-\-status\fR
 102 .br
 103 \fB \-\-status folder[/subfolder]\fR
 104 .br
 105 \fB \-\-status\-full\fR
 106 .br
 107 \fB \-\-select folder[/msg]\fR
 108 .br
 109 \fB \-\-online\fR
 110 .br
 111 \fB \-\-offline\fR
 112 .br
 113 \fB \-\-exit\fR
 114 .br
 115 \fB \-\-debug\fR
 116 .br
 117 \fB \-\-help\fR
 118 .br
 119 \fB \-\-version\fR
 120 .br
 121 \fB \-\-config\-dir\fR
 122 .SH "FILES"
 123 .LP
 124 .TP
 125 $HOME/Mail
 126 Default directory for mail storage
 127 .TP
 128 $PREFIX/share/sylpheed\-claws
 129 Global program directory
 130 .TP
 131 $PREFIX/share/sylpheed\-claws/manual
 132 Manual files in HTML format
 133 .TP
 134 $PREFIX/share/sylpheed\-claws/themes
 135 Global themes directory
 136 .TP
 137 $PREFIX/lib/sylpheed\-claws/plugins
 138 Directory for plugins
 139 .TP
 140 $PREFIX/include/sylpheed\-claws
 141 Directory for header files
 142 .TP
 143 $HOME/.sylpheed\-claws
 144 Default directory for user's configuration files directory
 145 .TP
 146 $HOME/.sylpheed\-claws/themes
 147 User's themes directory
 148 .TP
 149 $HOME/.sylpheed\-claws/accountrc
 150 Configuration for account(s)
 151 .TP
 152 $HOME/.sylpheed\-claws/addrbook*
 153 Addressbook files
 154 .TP
 155 $HOME/.sylpheed\-claws/command_history
 156 User\-specified commands
 157 .TP
 158 $HOME/.sylpheed\-claws/customheaderrc
 159 Configuration for custom headers for sending mail
 160 .TP
 161 $HOME/.sylpheed\-claws/dispheaderrc
 162 Configuration for custom display of headers in message view
 163 .TP
 164 $HOME/.sylpheed\-claws/matcherrc
 165 Filtering and Processing function configuration
 166 .TP
 167 $HOME/.sylpheed\-claws/folderlist.xml
 168 Folder hierarchy listing
 169 .TP
 170 $HOME/.sylpheed\-claws/menurc
 171 Menu shortcut\-key configuration
 172 .TP
 173 $HOME/.sylpheed\-claws/sylpheed\-claws.log
 174 Sylpheed logfile
 175 .TP
 176 $HOME/.sylpheed\-claws/sylpheedrc
 177 Main configuration file
 178
 179
 180 .SH "EXAMPLES"
 181 .LP
 182 To run this program the standard way type:
 183 .LP
 184 sylpheed\-claws
 185 .LP
 186 Alternatively you can run it with the following options:
 187 .TP
 188 \fB\-\-compose [address]\fR
 189 to open a Compose window
 190 .TP
 191 \fB\-\-subscribe [uri]\fR
 192 subscribe to the given URI if possible
 193 .TP
 194 \fB\-\-attach file1 [file2]...\fR
 195 open composition window with specified files attached
 196 .TP
 197 \fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
 198 this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window
 199 .TP
 200 \fB\-\-receive\fR
 201 receive new messages
 202 .TP
 203 \fB\-\-receive\-all\fR
 204 receive new messages from all accounts
 205 .TP
 206 \fB\-\-send\fR
 207 .br
 208 send all queued messages
 209 .TP
 210 \fB\-\-status\fR
 211 show the total number of messages
 212 .br
 213 [new][unread][unread answers to marked][total]
 214 .TP
 215 \fB\-\-status folder[/subfolder]\fR
 216 show the total number of messages in specified folder
 217 .br
 218 [new][unread][unread answers to marked][total]
 219 .TP
 220 \fB\-\-status\-full\fR
 221 show the total number of messages per folder
 222 .br
 223 [new][unread][unread answers to marked][total]
 224 .TP
 225 \fB\-\-select folder[/msg]\fR
 226 On startup, jumps to the specified folder/message
 227 .TP
 228 \fB\-\-online\fR
 229 Start sylpheed-claws in (or switch to, if already running) online mode
 230 .TP
 231 \fB\-\-offline\fR
 232 Start sylpheed-claws in (or switch to, if already running) offline mode
 233 .TP
 234 \fB\-\-help\fR
 235 display the help message and exit
 236 .TP
 237 \fB\-\-exit\fR
 238 exit Sylpheed-Claws
 239 .TP
 240 \fB\-\-debug\fR
 241 for debug mode
 242 .TP
 243 \fB\-\-version\fR
 244 display version number and exit
 245 .TP
 246 \fB\-\-config\-dir\fR
 247 display the CONFIG\-DIR and exit
 248 .SH "INSTALLATION"
 249 .LP
 250 This program requires GTK+ 2.4.x or higher to be compiled.
 251 .LP
 252 Please make sure that gtk\-devel and glib\-devel (or similar) packages are
 253 installed before the compilation (you may also require flex (lex) and bison
 254 (yacc)).
 255 .LP
 256 To compile and install, just type:
 257 .LP
 258 % ./configure
 259 .br
 260 % make
 261 .br
 262 % su
 263 .br
 264 Password: [Enter password]
 265 .br
 266 # make install
 267 .LP
 268 Refer to ./configure \-\-help for further information.
 269 .SH "AUTHORS"
 270 .LP
 271 .TP
 272 The Sylpheed\-Claws Team
 273 Holger Berndt                   <berndth@users.sf.net>
 274 .br
 275 Ho\(`a Vi\(^et Dinh                     <hoa@users.sf.net>
 276 .br
 277 Werner Koch                     <wk@gnupg.org>
 278 .br
 279 Darko Koruga                    <darko@users.sf.net>
 280 .br
 281 Ricardo Mones Lastra    <mones@users.sf.net>
 282 .br
 283 Colin Leroy                     <colinleroy@users.sf.net>
 284 .br
 285 Paul Mangan                     <twb@users.sf.net>
 286 .br
 287 Martin Schaaf                   <mascha1@users.sf.net>
 288 .br
 289 Tristan Chabredier              <wwp@users.sf.net>
 290
 291 .TP
 292 Previous team members
 293 Keith Edmunds
 294 .br
 295 Match Grun
 296 .br
 297 Melvin Hadasht
 298 .br
 299 Oliver Haertel
 300 .br
 301 Christoph Hohmann
 302 .br
 303 Alfons Hoogervorst
 304 .br
 305 Thorsten Maerz
 306 .br
 307 Leandro A. F. Pereira
 308 .br
 309 Luke Plant
 310 .br
 311 Carsten Schurig
 312 .br
 313 Sergey Vlasov
 314 .br
 315 Hiroyuki Yamamoto
 316
 317
 318 .SH "SEE ALSO"
 319 .LP
 320 .TP
 321 Sylpheed\-Claws Homepage
 322 <http://www.sylpheed-claws.net>