Added description for subject simplifing which is a very useful option.
[claws.git] / 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    * spell checking (with installation instructions)
17    * simplify subject string
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 * Spell checker for Sylpheed-Claws
123   
124   a. Requirements
125   b. Configuration and installation
126   c. Usage
127   d. Known problems
128
129   a. Requirements
130   ---------------
131
132   The spell checker in sylpheed requires the Portable Spell Checker
133   Interface Library pspell (http://pspell.sourceforge.net), version
134   0.12.2 or newer.
135
136   You will need also the actual spell checker.  There are two alternatives:
137
138      i) ispell (http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html),
139         which is found on quasi every distribution.  You have then to
140         install the pspell-ispell module found at the pspell site.
141
142     ii) aspell (http://aspell.sourceforge.net).  This spell checker
143         must be installed after installing pspell.  The version tested
144         is .33.7 alpha. It has three different suggestion modes (fast
145         -default- , normal, bad spellers), has the ability to learn
146         from mistakes (default). 
147
148   And, last but not least, do not forget to install the dictionaries. Check
149   the corresponding spell checker home page for more information on this.
150
151   b. Configuring Sylpheed
152   -----------------------
153
154   Spell checking is enabled if you configure sylpheed appropriately. Add
155   the option '--enable-pspell' when configuring. E.g.:
156
157   ./configure --enable-pspell
158
159   The configure script needs 'pspell-config' in your path.  If it is
160   in weird places, use '--with-pspell-prefix' to tell the path to
161   pspell-config.  E.g., if pspell-config is really
162   /foo/bar/pspell-config, then use:
163
164   ./configure --enable-pspell --with-pspell-prefix=/foo/bar
165
166   If you have problems with not found includes or libraries, check
167   first where these are located, and add either options:
168
169   --with-pspell-includes=/foo/bar/include
170
171   or 
172
173   --with-pspell-libs=/foo/bar/lib
174
175   as appropriate.
176
177   Configure script summarizes the options compiled in. Check that
178   configure lists 'Pspell = yes'.
179
180   Then proceed as usual, with 'make' and 'make install'.
181
182   c. Usage
183   --------
184
185   NOTE: if you upgraded from 0.7.0claws, please reselect your default
186   dictionary in the preferences.
187
188   After successful compiling, you need to tell sylpheed where your
189   dictionaries reside.  First run 'pspell-config pkgdatadir' on the
190   shell to get their path.
191
192   Then run sylpheed and go to Configuration -> Common preferences ->
193   Spell Checker.  Check the box 'Enable spell checker (EXPERIMENTAL)' and
194   use the file selector ('...' button) to select the path where the
195   dictionaries reside.  Within the file selector, go to that directory
196   and select *any* file in the file lists.  Click ok. You should then
197   be able to select your default dictionary.
198
199   When composing, misspelled words are highlighted.  Click on any
200   highlighted word with the right mouse button to get a list of
201   suggestions.  The first entry of the menu just displays the unknown
202   word.  Selecting "Accept in this session" (or hitting MOD1-Space, 
203   where MOD1 is usually the ALT key), will ignore this word and accept
204   it in this message.  Selecting the next entry "Add to dictionary", which
205   is bound to MOD1-Enter combination will add the unknown word to the
206   dictionary to learn it.  The next entries are the suggested words. 
207   The first 15 suggestions can be accessed typing one of the first letters
208   of latin alphabet (if this does not suit your language, please send
209   a mail to melvin.hadasht@free.fr).  If you are using an aspell 
210   dictionary, you can use its 'learn from mistake' feature, by pressing
211   the MOD1 key and selecting the suggestion (with the keyboard or with
212   the mouse).  See pspell manual ยง4.7.1 for an explanation of this 
213   feature. 
214
215   If you click with the right mouse button everywhere else, or if you
216   shift-right-click even on a misspelled word, you get the
217   configuration  menu.  'Check all' highlights all misspelled words.
218   With this menu, you can also change the dictionary while editing.
219   FInally, you can change the suggestion mode misktakes 'feature' 
220   (useful only with aspell).
221
222   Spell checking can also be done using keyboard shortcuts.  In the
223   "Edit" menu of the compose window, there are two menus "Check backwards
224   misspelled word" and "Forward to next misspelled word".  Add to them 
225   appropriate keyboard shortcuts.  "Check backwards misspelled word" 
226   checks backwards from cursor position for the first misspelled word.
227   If it finds one, it displays the suggestions lists which can be handled
228   with the keyboard as described before. When the suggestion menu is 
229   closed, the cursor returns to its original position to be able to 
230   continue editing.  The "Forward to next misspelled word" do the same 
231   thing in the other direction but moves the cursor at the end of the
232   misspelled word.  This way, you can spell check easily a whole message
233   starting from its beginning and using the "Forward to next misspelled
234   word" keyboard short cut.
235   
236
237   d. Known problems
238   -----------------
239
240     i) libtool
241
242     The only real known problems until now are configuration and
243     compilation problems  due to libtool interaction with pspell. 
244
245     If you do not compile pspell/aspell/pspell-ispell yourself, you
246     need to install them with their devel packages.
247
248     Pspell work with dynamic linking of libraries and thus uses the
249     libltdl library of libtool.  If you have weird problems when
250     configuring showing 'libtool', chances are the libtool used when
251     compiling the pspell package is not compatible with what you have
252     on your system.  The best solution, is to install the latest
253     libtool AND compile yourself pspell package.  I can't help more
254     than that in this issue.
255
256     After successfully compiled and used sylpheed with spell checking,
257     the same problem can appear if you upgrade your libtool to a
258     version which libltdl is incompatible to your older one.    The
259     symptoms are a crash when starting to compose.  Disabling spell
260     checking avoids the problem. The solution should be to recompile pspell.
261
262     ii) New installed ispell dictionary are not detected
263
264     Installing a new ispell dictionary needs an additional step. Go
265     to the 'pkgdatadir' and run 'make-ispell-pwli'.  You may need to
266     su root.
267
268
269 There are a lot more options. If you find one, don't hesitate to
270 mention it.
271
272
273 * simplify subject string
274     It is possible to remove parts of string from the subject line.
275     Example: [Sylpheed-claws-users] This is a test
276     becomes: This is a test
277     This is a per folder property. Right click on a folder and select
278     property, enable Simplify Subject RegExp check box. Example
279     regexp for the above is: \[Sylpheed-claws-(devel|users)\]
280     Another example for the Sylpheed mailing list (not claws!) is:
281     \[sylpheed:[0-9]{5}\]
282
283
284 4. How to contribute
285 --------------------
286
287 Sylpheed Main: 
288
289         submit it to the Sylpheed ML, Hiroyuki, or Paul Mangan
290         (for incorporation on the Sylpheed Patches page)
291
292 Sylpheed Claws:
293
294         It is highly recommended to use the sourceforge project page
295         of claws. Check: 
296         http://sourceforge.net/tracker/?atid=384600&group_id=25528&func=browse
297
298         If that's too troublesome, either contact Paul Mangan or consider
299         posting to the sylpheed claws users mailing list.
300
301         Bugs can be reported in the same way; the recommended web page:
302         http://sourceforge.net/tracker/?group_id=25528&atid=384598
303
304         Ofcourse you can also post to the sylpheed claws users
305         mailing list.
306
307 Also, we really try to incorporate good contributions, but sometimes we
308 don't have enough time. If the contribution is really big, or requires
309 a long time to stabilize, send a mail to Paul Mangan. We can probably
310 arrange access to the Claws branch.
311
312
313
314 5. How to request features
315 --------------------------
316
317 Ask around in both Sylpheed ML and Sylpheed Claws Users ML. Note
318 that some developers may already thought about your feature, may
319 perhaps be implementing it - or the feature was already discussed
320 and rejected for whatever reason.  You might want to go ahead and 
321 hack a patch for it. (That would be very cool!) Another
322 possibility is to use the Feature Request Tracker at the
323 sourceforge project page.
324
325
326
327 6. History
328 ----------
329
330 TODO
331