replace filter conversion script with reimplemeted version
[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 Torsten Schoenfeld <kaffeetisch@web.de>
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 * kmail2sylpheed.pl
84
85   WHAT IT DOES
86
87   This perl script will convert an exported Kmail addressbook into a
88   Sylpheed addressbook.
89
90   HOW TO USE IT
91
92   (You must run sylpheed at least once before running this script.)
93
94   In Kmail's Addressbook choose '/File/Export List'. This will export
95   your Kmail addressbook data to a *.csv file.
96
97   If Sylpheed is running, close it.
98
99   From the command line, execute the following:
100  
101         perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
102
103   Your Kmail addressbook data will now be contained in Sylpheed's
104   addressbook, under the name 'Kmail Address Book'.
105
106   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
107
108 -----------------------------------------------------------------------
109
110 * ldif-to-xml.py
111
112   WHAT IT DOES
113
114   This python script converts the netscape ldif format address book to
115   the sylpheed xml format.
116
117   HOW TO USE IT
118
119   Inside Netscape export your address book to a file.
120   From the command line, execute:
121
122       ./ldif-to-xml.py <path/filename>
123
124   In case of trouble, just invoke your python interpreter directly:
125
126       python ldif-to-xml.py <path/filename>
127
128   Either way a file called addressbook.xml will be generated in the current
129   directory. This xml file should be merged with or simply placed in the
130   $HOME/.sylpheed directory.
131
132   Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
133
134 -----------------------------------------------------------------------
135
136 * newscache_clean.pl
137
138   WHAT IT DOES AND WHY IT DOES IT
139
140   This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
141   the newscache becomes littered with old directories and files - when
142   you subscribe to a newsgroup a sub-directory gets created for it in
143   ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the 
144   group the sub-directory does not get deleted. Until this is done 
145   internally this script will take care of some tidying up.
146   
147   This script removes directory trees of nntp servers that you no longer
148   have an account for. Where an account exists it removes directories
149   and files of those groups to which you are no longer subscribed.
150
151   HOW TO USE IT
152
153   Issue the following command from the 'tools' directory:
154   
155         perl newscache_clean.pl
156         
157   This script uses the File::Path module, if you don't already have it
158   installed, you can find it at the CPAN search site <http://search.cpan.org>
159
160   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
161
162 -----------------------------------------------------------------------
163
164 * sylpheed-switcher
165
166   WHAT IT DOES
167   
168   This perl script is for users who like to move between the main
169   sylpheed branch and the claws branch. Because of some differences
170   between the stored options it is better IMO to use two separate
171   '.sylpheed' directory trees. Doing that manually could prove to
172   be tiresome, and so I've written this script to automate the task.
173
174   The first time you run this script you enter the full paths,
175   including the executable itself, to both the main version of
176   sylpheed and the claws version. This information is then stored
177   in a file in your $HOME directory called '.sylpheed-switcher'
178
179   During this initial set-up, your '~/.sylpheed' directory
180   is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
181   
182   When you run sylpheed via this script, your '~/.sylpheed' directory
183   is deleted and replaced with a symbolic link to either ~/.sylpheed-main'
184   or '~/sylpheed-claws', depending on the option you choose.
185   (On subsequent usage the symbolic link is deleted and replaced with
186   a new symbolic link).
187
188   HOW TO USE IT
189   
190   Initial set-up
191   Enter the full paths to the executable, including the executable itself,
192   example:
193   
194         ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed --main-path=
195         /usr/bin/sylpheed
196         
197   After the initial set-up, use the following:
198   
199         ./sylpheed-switcher --claws     (to run sylpheed-claws)
200         ./sylpheed-switcher --main      (to run sylpheed main)
201         
202   Additionally you can append --debug to run in debug mode.
203   Use --help for more info.     
204  
205   This script uses the File::Path and Getopt::Long modules, if you don't already 
206   have them installed, you can find them at the CPAN search site 
207   <http://search.cpan.org>
208
209   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
210
211 -----------------------------------------------------------------------
212
213 * update-po
214
215   WHAT IT DOES
216   
217   This script is a message catalog translator's tool, it updates the .po 
218   files named on the command line.
219
220   HOW TO USE IT
221
222   This script needs to be copied to and run from the 'po' directory.
223   
224         ./update-po lang.po lang2.po ...
225
226   to update one or more <yourlang>.po files from the sourcecode files
227   named in POTFILES.in. The old .po file is save in a .po.old file.
228
229   For example, when you want to update fr.po, run ./update-po fr.po, 
230   then edit fr.po to update your translation.
231
232   Author: Wilbert Berendsen <wilbert@oswf.org>
233
234 -----------------------------------------------------------------------
235
236