README.claws

   1 README.claws
   2 ------------
   3
   4 Summary:
   5
   6 1. What is Sylpheed Claws?
   7 2. Switching between Sylpheed Claws and Sylpheed
   8    * From Sylpheed to Sylpheed Claws
   9    * From Sylpheed Claws to Sylpheed
  10 3. Things Claws does different
  11    * auto address replacement in summary view
  12    * manual selection of MIME types for attachments
  13    * sharing mail folders
  14    * default to address for folders
  15    * threading mode per folder
  16    * quotation wrapping
  17    * spell checking (with installation instructions)
  18 4. How to contribute
  19 5. How to request features
  20 6. History
  21
  22
  23
  24 1. What is Sylpheed Claws?
  25 --------------------------
  26
  27 Sylpheed Claws is a bleeding edge branch of Sylpheed, a light weight mail
  28 user agent for UNIX. Features in this branch may (or may not) end up in
  29 Sylpheed.
  30
  31 Hiroyuki's ChangeLog is also included in the claws-branch distribution,
  32 so it should be easy to spot which features were merged with Sylpheed
  33 (and which features were not).
  34
  35 For brevity Sylpheed Claws is referred to as Claws, and Sylpheed as either
  36 Sylpheed or Main.
  37
  38
  39
  40 2. Switching between Sylpheed Claws and Sylpheed
  41 ------------------------------------------------
  42
  43   From Sylpheed to Sylpheed Claws
  44   -------------------------------
  45
  46   From the user perspective Claws is just a fancy Sylpheed, so it uses the
  47   same sylpheed setting files located in ~/.sylpheed.
  48
  49   It's always a good idea to back up all files in ~/.sylpheed in case
  50   you want to switch back to Sylpheed. (You don't have to backup the
  51   directories.)
  52
  53   There are some things that frequently come up when switching to Claws:
  54
  55
  56   * Why does the advanced filtering system not work?
  57
  58     Claws uses the new filtering system as soon as you define a new rule for it.
  59     Your old sylpheed filter rules will not be used. In subdirectory tools/ of
  60     the distribution there is a Perl script called filter_conv.pl which convers
  61     old filter rules to the claws filtering system.
  62
  63
  64   * What happened to the compose email and compose news buttons?
  65
  66     There's a composite button for both composing mail and news. You can toggle
  67     between composing mail and news by clicking on the button with the triangle.
  68
  69
  70   * And to the Preferences and Execute buttons?
  71
  72     Sorry, they're not there.
  73
  74
  75   From Sylpheed Claws to Sylpheed
  76   -------------------------------
  77
  78   Moving from Claws to Sylpheed is also simple. Sylpheed should neglect the things
  79   Claws put in the settings files. This also means that the old rules will work
  80   again.
  81
  82   If you want to switch back to Claws at a later time, make sure you back up at least
  83   ~/.sylpheed/filteringrc (the Claws filtering rules), and ~/.sylpheed/sylpheedrc
  84   (which may have some claws specific settings).
  85
  86   When switching back to Sylpheed you will not lose messages or message flags (color
  87   labels, read / unread status of messages).
  88
  89
  90
  91 3. Things Claws does different
  92 ------------------------------
  93
  94 Claws does a lot of things different. Here a quick run-down of things that
  95 are hardly noticable, but deserve mentioning:
  96
  97 * auto address replacement in summary view
  98   This matches a plain email address with a person in the address book. This
  99   feature is enabled in Common Preferences | Tab Display | SummaryView Group |
 100   Display sender using addressbook
 101
 102 * manual selection of MIME types for attachments
 103   You can change the MIME type of an attachment by right-clicking in the
 104   attachment list, selecting Property in the menu. The MIME type list
 105   is a combo box with the known MIME types.
 106
 107 * sharing mail folders
 108   You can also share or use shared mail folders. Right-click a folder and
 109   select Property. Change the Folder chmod setting.
 110
 111 * default to address for folders
 112   Most people filter mailing list mails to separate folders. Claws allows
 113   you to associate a folder with a mailing list or a person. Right-click a
 114   folder, select Property and change the Default To setting. When you
 115   compose a new mail, when this folder is selected the recepient address
 116   will be set to this address.
 117
 118   (NOTE: this is also a shoot-yourself-in-the-foot-setting! If you want
 119    to send a private mail, don't have a folder selected with this setting
 120    set.)
 121
 122 * quotation wrapping
 123   Quotation is wrapped like VIM would wrap it (at least that was the
 124   goal). To enable this feature go to Common preferences->Compose and
 125   make sure Wrap quotation is enabled. The text is automatically
 126   wrapped when you reply to an e-mail if this feature is enabled.
 127
 128 * Spell checker for Sylpheed-Claws
 129
 130   a. Requirements
 131   b. Configuration and installation
 132   c. Usage
 133   d. Known problems
 134
 135   a. Requirements
 136   ---------------
 137
 138   The spell checker in sylpheed requires the Portable Spell Checker
 139   Interface Library pspell (http://pspell.sourceforge.net), version
 140   0.12.2 or newer.
 141
 142   You will need also the actual spell checker.  There are two alternatives:
 143
 144      i) ispell (http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html),
 145         which is found on quasi every distribution.  You have then to
 146         install the pspell-ispell module found at the pspell site.
 147
 148     ii) aspell (http://aspell.sourceforge.net).  This spell checker
 149         must be installed after installing pspell.  The version tested
 150         is .33.7 alpha. It has three different suggestion modes (fast
 151         -default- , normal, bad spellers), has the ability to learn
 152         from mistakes (default).
 153
 154   And, last but not least, do not forget to install the dictionaries. Check
 155   the corresponding spell checker home page for more information on this.
 156
 157   b. Configuring Sylpheed
 158   -----------------------
 159
 160   Spell checking is enabled if you configure sylpheed appropriately. Add
 161   the option '--enable-pspell' when configuring. E.g.:
 162
 163   ./configure --enable-pspell
 164
 165   The configure script needs 'pspell-config' in your path.  If it is
 166   in weird places, use '--with-pspell-prefix' to tell the path to
 167   pspell-config.  E.g., if pspell-config is really
 168   /foo/bar/pspell-config, then use:
 169
 170   ./configure --enable-pspell --with-pspell-prefix=/foo/bar
 171
 172   If you have problems with not found includes or libraries, check
 173   first where these are located, and add either options:
 174
 175   --with-pspell-includes=/foo/bar/include
 176
 177   or
 178
 179   --with-pspell-libs=/foo/bar/lib
 180
 181   as appropriate.
 182
 183   Configure script summarizes the options compiled in. Check that
 184   configure lists 'Pspell = yes'.
 185
 186   Then proceed as usual, with 'make' and 'make install'.
 187
 188   c. Usage
 189   --------
 190
 191   After successful compiling, you need to tell sylpheed where your
 192   dictionaries reside.  First run 'pspell-config pkgdatadir' on the
 193   shell to get their path.
 194
 195   Then run sylpheed and go to Configuration -> Common preferences ->
 196   Compose.  Check the box 'Enable spell checker (EXPERIMENTAL)' and
 197   use the file selector ('...' button) to select the path where the
 198   dictionaries reside.  Within the file selector, go to that directory
 199   and select *any* file in the file lists.  Click ok. You should then
 200   be able to select your default dictionary.
 201
 202   When composing, misspelled words are highlighted.  Click on any
 203   highlighted word with the right mouse button to get a list of
 204   suggestions.  You can also accept the highlighted word to the
 205   session dictionary (equivalent to an 'ignore' option of other spell
 206   checker), or you can add it to you personal dictionary.
 207
 208   If you click with the right mouse button everywhere else, or if you
 209   shift-right-click even on a misspelled word, you get the
 210   configuration  menu.  'Check all' highlights all misspelled words.
 211   With this menu, you can also change the dictionary while editing.
 212   You can change the suggestion mode and toggle the learn from
 213   misktakes 'feature' (useful only with aspell).
 214
 215   d. Known problems
 216   -----------------
 217
 218     i) libtool
 219
 220     The only real known problems until now are configuration and
 221     compilation problems  due to libtool interaction with pspell.
 222
 223     If you do not compile pspell/aspell/pspell-ispell yourself, you
 224     need to install them with their devel packages.
 225
 226     Pspell work with dynamic linking of libraries and thus uses the
 227     libltdl library of libtool.  If you have weird problems when
 228     configuring showing 'libtool', chances are the libtool used when
 229     compiling the pspell package is not compatible with what you have
 230     on your system.  The best solution, is to install the latest
 231     libtool AND compile yourself pspell package.  I can't help more
 232     than that in this issue.
 233
 234     After successfully compiled and used sylpheed with spell checking,
 235     the same problem can appear if you upgrade your libtool to a
 236     version which libltdl is incompatible to your older one.    The
 237     symptoms are a crash when starting to compose.  Disabling spell
 238     checking avoids the problem. The solution should be to recompile pspell.
 239
 240     ii) New installed ispell dictionary are not detected
 241
 242     Installing a new ispell dictionary needs an additional step. Go
 243     to the 'pkgdatadir' and run 'make-ispell-pwli'.  You may need to
 244     su root.
 245
 246
 247 There are a lot more options. If you find one, don't hesitate to
 248 mention it.
 249
 250
 251
 252 4. How to contribute
 253 --------------------
 254
 255 Sylpheed Main:
 256
 257         submit it to the Sylpheed ML, Hiroyuki, or Paul Mangan
 258         (for incorporation on the Sylpheed Patches page)
 259
 260 Sylpheed Claws:
 261
 262         It is highly recommended to use the sourceforge project page
 263         of claws. Check:
 264         http://sourceforge.net/tracker/?atid=384600&group_id=25528&func=browse
 265
 266         If that's too troublesome, either contact Paul Mangan or consider
 267         posting to the sylpheed claws users mailing list.
 268
 269         Bugs can be reported in the same way; the recommended web page:
 270         http://sourceforge.net/tracker/?group_id=25528&atid=384598
 271
 272         Ofcourse you can also post to the sylpheed claws users
 273         mailing list.
 274
 275 Also, we really try to incorporate good contributions, but sometimes we
 276 don't have enough time. If the contribution is really big, or requires
 277 a long time to stabilize, send a mail to Paul Mangan. We can probably
 278 arrange access to the Claws branch.
 279
 280
 281
 282 5. How to request features
 283 --------------------------
 284
 285 Ask around in both Sylpheed ML and Sylpheed Claws Users ML. Note
 286 that some developers may already thought about your feature, may
 287 perhaps be implementing it - or the feature was already discussed
 288 and rejected for whatever reason.  You might want to go ahead and
 289 hack a patch for it. (That would be very cool!) Another
 290 possibility is to use the Feature Request Tracker at the
 291 sourceforge project page.
 292
 293
 294
 295 6. History
 296 ----------
 297
 298 TODO
 299