8c3f199cbafa7f58e128a9251065d7bf93e5b026
[claws.git] / README.claws
1
2 What is Sylpheed Claws?
3 ----------------------
4
5 Sylpheed Claws is a bleeding edge branch of Sylpheed, a light weight mail 
6 user agent for UNIX. Features in this branch may (or may not) end up in 
7 Sylpheed. 
8
9 Hiroyuki's ChangeLog is also included in the claws-branch distribution, 
10 so it should be easy to spot which features were merged with Sylpheed
11 (and which features were not).
12
13 For brevity Sylpheed Claws is referred to as Claws, and Sylpheed as either
14 Sylpheed or Main.
15
16
17 Switching to Claws
18 ------------------
19
20 From the user perspective Claws is just a fancy Sylpheed, so it uses the
21 same sylpheed setting files located in ~/.sylpheed.
22
23 It's always a good idea to back up all files in ~/.sylpheed in case
24 you want to switch back to Sylpheed. (You don't have to backup the
25 directories.)
26
27 There are some things that frequently come up when switching to Claws:
28
29
30 * When replying, the original sender's text is not quoted anymore.
31
32   Claws has a different quote format handler. Add either %Q or %q to the
33   quote format text. Also click the button "Description of symbols"
34   for more quotation symbols.
35
36
37 * Why does the advanced filtering system not work?
38
39   Claws uses the new filtering system as soon as you define a new rule for it.
40   Your old sylpheed filter rules will not be used. In subdirectory tools/ of
41   the distribution there is a Perl script called filter_conv.pl which convers
42   old filter rules to the claws filtering system.
43   
44
45 * What happened to the compose email and compose news buttons? 
46
47   There's a composite button for both composing mail and news. You can toggle
48   between composing mail and news by clicking on the button with the triangle.
49
50
51 * And to the Preferences and Execute buttons?
52
53   Sorry, they're not there.
54
55
56
57 Things Claws does different
58 ---------------------------
59
60 Claws does a lot of things different. Here a quick run-down of things that
61 are hardly noticable, but deserve mentioning:
62
63 * auto address replacement in summary view
64   This matches a plain email address with a person in the address book. This
65   feature is enabled in Common Preferences | Tab Display | SummaryView Group |
66   Display sender using addressbook
67
68 * manual selection of MIME types for attachments
69   You can change the MIME type of an attachment by right-clicking in the
70   attachment list, selecting Property in the menu. The MIME type list
71   is a combo box with the known MIME types.
72
73 * sharing mail folders   
74   You can also share or use shared mail folders. Right-click a folder and
75   select Property. Change the Folder chmod setting.
76
77 * default to address for folders
78   Most people filter mailing list mails to separate folders. Claws allows
79   you to associate a folder with a mailing list or a person. Right-click a
80   folder, select Property and change the Default To setting. When you
81   compose a new mail, when this folder is selected the recepient address
82   will be set to this address.
83
84   (NOTE: this is also a shoot-yourself-in-the-foot-setting! If you want
85    to send a private mail, don't have a folder selected with this setting
86    set.)
87
88 * threading mode per folder
89   Folders can have their own threading and sorting mode. Just select a 
90   folder, and set their threading and sorting mode.
91
92 * spell checking
93   Spell checking using pspell library (http://pspell.sourceforge.net)
94   can can be compiled in. You must have dictionaries available. You can
95   use aspell (http://aspell.sourceforge.net) or ispell dictionaries. For
96   the former, you have to install aspell. For the latter, you have to
97   install the pspell-ispell module (see pspell home page) in addition
98   to ispell.  Spell checking can then enabled in Configuration |Common
99   Preferences | Compose. Use the file selector and select any file in
100   the directory where the dictionaries (*.pwli) are. Do not simply enter
101   the path in the text entry. You can select the default dictionary.
102   When composing, use the right-button click.
103
104 * quotation wrapping
105   Quotation is wrapped like VIM would wrap it (at least that was the
106   goal). To enable this feature go to Common preferences->Compose and
107   make sure Wrap quotation is enabled. The text is automatically
108   wrapped when you reply to an e-mail if this feature is enabled.
109
110 There are a lot more options. If you find one, don't hesitate to
111 mention it.
112
113
114 How to contribute
115 -----------------
116
117 Sylpheed Main: 
118
119         submit it to the Sylpheed ML, Hiroyuki, or Paul Mangan
120         (for incorporation on the Sylpheed Patches page)
121
122 Sylpheed Claws:
123
124         It is highly recommended to use the sourceforge project page
125         of claws. Check: 
126         http://sourceforge.net/tracker/?atid=384600&group_id=25528&func=browse
127
128         If that's too troublesome, either contact Paul Mangan or consider
129         posting to the sylpheed claws users mailing list.
130
131         Bugs can be reported in the same way; the recommended web page:
132         http://sourceforge.net/tracker/?group_id=25528&atid=384598
133
134         Ofcourse you can also post to the sylpheed claws users
135         mailing list.
136
137 Also, we really try to incorporate good contributions, but sometimes we
138 don't have enough time. If the contribution is really big, or requires
139 a long time to stabilize, send a mail to Paul Mangan. We can probably
140 arrange access to the Claws branch.
141
142
143 How to request features
144 -----------------------
145
146 Ask around in both Sylpheed ML and Sylpheed Claws Users ML. Note
147 that some developers may already thought about your feature, may
148 perhaps be implementing it - or the feature was already discussed
149 and rejected for whatever reason.  You might want to go ahead and 
150 hack a patch for it. (That would be very cool!) Another
151 possibility is to use the Feature Request Tracker at the
152 sourceforge project page.