added gif2xface tool
[claws.git] / tools / README
1
2 * filter_conv.pl
3
4   WHAT IT DOES
5
6   This perl script provides easy conversion of your filtering rules
7   form sylpheed's old filter system to the new filtering system used
8   in sylpheed-claws. It reads 'filterrc' and outputs 'filteringrc'.
9
10   HOW TO USE IT
11
12   Move 'filter_conv.pl' to the $HOME/.sylpheed directory.
13   From the $HOME/.sylpheed directory, issue the command:
14
15         perl filter_conv.pl
16
17   That's it, the new filtering system is now implemented with your
18   previous rules applied.
19
20   Any problems, contact Paul <claws@thewildbeast.co.uk>
21
22 -----------------------------------------------------------------------
23
24 * gif2xface.pl
25
26   WHAT IT DOES
27
28   This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
29   into an X-Face graphic suitable for inclusion into custom headers of
30   Sylpheed. An X-Face allows to quickly identify (or be identified as)
31   the sender of a mail message in a xface-capable MUA (like sylpheed).
32
33   HOW TO USE IT
34
35   After obtaining the desired image for your X-Face you should:
36     * scale it to 48x48 pixels (Image->Scale image on Gimp)
37     * down color depth to b/w (Image->Mode->Indexed selecting "Use
38       Black/White palette" and the desired dithering options (prior to
39       indexing doing Image->Colors->Threshold allows you to select the
40       b/w level if you don't want a dithered (dotty) image))
41     * save file as non-interlaced GIF
42   Then do:
43
44       ./gif2xface < filename.gif > filename.xface
45
46   In filename.xface will be the X-Face header ready to use.
47   You can add a custom header in Sylpheed through Configuration->
48   Preferences per account, "Send" tab, check "Add user-defined header"
49   then "Edit..." if you want to add it via Sylpheed interface, or do
50
51       echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
52
53   if you want to create the custom headers file yourself (Warning: this
54   method is valid only if you don't have any other custom header set or
55   they will be lost!).
56
57   Any problems, contact Ricardo Mones Lastra <mones@aic.uniovi.es>
58
59 -----------------------------------------------------------------------
60
61 * ldif-to-xml.py
62
63   WHAT IT DOES
64
65   This python script converts the netscape ldif format address book to
66   the sylpheed xml format.
67
68   HOW TO USE IT
69
70   Inside Netscape export your address book to a file.
71   From the command line, execute:
72
73       ./ldif-to-xml.py <path/filename>
74
75   In case of trouble, just invoke your python interpreter directly:
76
77       python ldif-to-xml.py <path/filename>
78
79   Either way a file called addressbook.xml will be generated in the current
80   directory. This xml file should be merged with or simply placed in the
81   $HOME/.sylpheed directory.
82
83   Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
84
85 -----------------------------------------------------------------------