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