add README.claws for things users need to know
[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 will only use the new filtering system when you cleared the Sylpheed
40   filter rules list. 
41
42
43 * What happened to the compose email and compose news buttons? 
44
45   There's a composite button for both composing mail and news. You can toggle
46   between composing mail and news by clicking on the button with the triangle.
47
48
49 * And to the Preferences and Execute buttons?
50
51   Sorry, they're not there.
52
53
54
55 Things Claws does different
56 ---------------------------
57
58 Claws does a lot of things different. Here a quick run-down of things that
59 are hardly noticable, but deserve mentioning:
60
61 * auto address replacement in summary view
62   This matches a plain email address with a person in the address book. This
63   feature is enabled in Common Preferences | Tab Display | SummaryView Group |
64   Display sender using addressbook
65
66 * manual selection of MIME types for attachments
67   You can change the MIME type of an attachment by right-clicking in the
68   attachment list, selecting Property in the menu. The MIME type list
69   is a combo box with the known MIME types.
70
71 * sharing mail folders   
72   You can also share or use shared mail folders. Right-click a folder and
73   select Property. Change the Folder chmod setting.
74
75 * default reply-to address for folders
76   Most people filter mailing list mails to separate folders. Claws allows
77   you to associate a folder with a mailing list. Right-click a folder, 
78   select Property and change the Default To setting.
79
80   (NOTE: this is also a shoot-yourself-in-the-foot-setting! If you want
81    to send a private mail, don't have a folder selected with this setting
82    set.)
83
84 * threading mode per folder
85   Folders can have their own threading and sorting mode. Just select a 
86   folder, and set their threading and sorting mode.
87
88 There are a lot more options. If you find one, don't hesitate to mention
89 it.