filter_conv.pl now writes to matcherrc
[claws.git] / tools / README
1 * eud2gc.py
2
3   WHAT IT DOES
4
5   This python-script is a quick hack to convert an Eudora (v.3?) addressbook
6   to vCard (GnomeCard) format.
7
8   HOW TO USE IT
9
10   You may do whatever you want with it! (Also regarding copying)
11
12   However, the script is intended to use like this:
13
14                         eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
15
16   Be careful not to overwrite your original GnomeCard.gcrd!
17   (But of course you might want to add the converted stuff to it)
18
19   Copyleft some time long ago (around 1999?) by Jeroen Versteeg
20   (j.m.versteeg@student.utwente.nl)
21
22 -----------------------------------------------------------------------
23
24 * filter_conv.pl
25
26   WHAT IT DOES
27
28   This perl script provides easy conversion of your filtering rules
29   form sylpheed's old filter system to the new filtering system used
30   in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs 
31   '~/.sylpheed/matcherrc'.
32   
33   HOW TO USE IT
34
35   Issue the following command from the 'tools' directory:
36
37         perl filter_conv.pl
38
39   That's it, the new filtering system is now implemented with your
40   previous rules applied.
41
42   Any problems, contact Paul <claws@thewildbeast.co.uk>
43
44 -----------------------------------------------------------------------
45
46 * gif2xface.pl
47
48   WHAT IT DOES
49
50   This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
51   into an X-Face graphic suitable for inclusion into custom headers of
52   Sylpheed. An X-Face allows to quickly identify (or be identified as)
53   the sender of a mail message in a xface-capable MUA (like sylpheed).
54
55   HOW TO USE IT
56
57   After obtaining the desired image for your X-Face you should:
58     * scale it to 48x48 pixels (Image->Scale image on Gimp)
59     * down color depth to b/w (Image->Mode->Indexed selecting "Use
60       Black/White palette" and the desired dithering options (prior to
61       indexing doing Image->Colors->Threshold allows you to select the
62       b/w level if you don't want a dithered (dotty) image))
63     * save file as non-interlaced GIF
64   Then do:
65
66       ./gif2xface < filename.gif > filename.xface
67
68   In filename.xface will be the X-Face header ready to use.
69   You can add a custom header in Sylpheed through Configuration->
70   Preferences per account, "Send" tab, check "Add user-defined header"
71   then "Edit..." if you want to add it via Sylpheed interface, or do
72
73       echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
74
75   if you want to create the custom headers file yourself (Warning: this
76   method is valid only if you don't have any other custom header set or
77   they will be lost!).
78
79   Any problems, contact Ricardo Mones Lastra <mones@aic.uniovi.es>
80
81 -----------------------------------------------------------------------
82
83 * ldif-to-xml.py
84
85   WHAT IT DOES
86
87   This python script converts the netscape ldif format address book to
88   the sylpheed xml format.
89
90   HOW TO USE IT
91
92   Inside Netscape export your address book to a file.
93   From the command line, execute:
94
95       ./ldif-to-xml.py <path/filename>
96
97   In case of trouble, just invoke your python interpreter directly:
98
99       python ldif-to-xml.py <path/filename>
100
101   Either way a file called addressbook.xml will be generated in the current
102   directory. This xml file should be merged with or simply placed in the
103   $HOME/.sylpheed directory.
104
105   Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
106
107 -----------------------------------------------------------------------
108
109 * newscache_clean.pl
110
111   WHAT IT DOES AND WHY IT DOES IT
112
113   This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
114   the newscache becomes littered with old directories and files - when
115   you subscribe to a newsgroup a sub-directory gets created for it in
116   ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the 
117   group the sub-directory does not get deleted. Until this is done 
118   internally this script will take care of some tidying up.
119   
120   This script removes directory trees of nntp servers that you no longer
121   have an account for. Where an account exists it removes directories
122   and files of those groups to which you are no longer subscribed.
123
124   HOW TO USE IT
125
126   Issue the following command from the 'tools' directory:
127   
128         perl newscache_clean.pl
129         
130   This script uses the File::Path module, if you don't already have it
131   installed, you can find it at the CPAN search site <http://search.cpan.org>
132
133   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
134
135 -----------------------------------------------------------------------
136
137 * sylpheed-switcher
138
139   WHAT IT DOES
140   
141   This perl script is for users who like to move between the main
142   sylpheed branch and the claws branch. Because of some differences
143   between the stored options it is better IMO to use two separate
144   '.sylpheed' directory trees. Doing that manually could prove to
145   be tiresome, and so I've written this script to automate the task.
146
147   The first time you run this script you enter the full paths,
148   including the executable itself, to both the main version of
149   sylpheed and the claws version. This information is then stored
150   in a file in your $HOME directory called '.sylpheed-switcher'
151
152   During this initial set-up, your '~/.sylpheed' directory
153   is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
154   
155   When you run sylpheed via this script, your '~/.sylpheed' directory
156   is deleted and replaced with a symbolic link to either ~/.sylpheed-main'
157   or '~/sylpheed-claws', depending on the option you choose.
158   (On subsequent usage the symbolic link is deleted and replaced with
159   a new symbolic link).
160
161   HOW TO USE IT
162   
163   Initial set-up
164   Enter the full paths to the executable, including the executable itself,
165   example:
166   
167         ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed --main-path=
168         /usr/bin/sylpheed
169         
170   After the initial set-up, use the following:
171   
172         ./sylpheed-switcher --claws     (to run sylpheed-claws)
173         ./sylpheed-switcher --main      (to run sylpheed main)
174         
175   Additionally you can append --debug to run in debug mode.
176   Use --help for more info.     
177  
178   This script uses the File::Path and Getopt::Long modules, if you don't already 
179   have them installed, you can find them at the CPAN search site 
180   <http://search.cpan.org>
181
182   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
183
184 -----------------------------------------------------------------------
185
186