correct changelog entry
[claws.git] / tools / README
1 * calypso_convert.pl
2
3   WHAT IT DOES
4
5   This perl script imports mbox files that are exported by Calypso.
6   It recreates the folder structure by scanning the "X-CalypsoFolder"
7   header and reincludes the attachments referenced in the
8   "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
9   
10   HOW TO USE IT
11
12   Export the Calypso mailbox by selecting "Save to archive" and check
13   the "Save attachments" box.
14   Edit the script to set following variables (at the top of the file):
15     $mboxdir  : path to the exported mbox, e.g. 'Archive' or '.'
16     $mboxfile : name of exported mbox, e.g. 'mail.txt'
17     $outdir   : name of the MH folder to create, e.g. 'Calypso'
18   Run the script using
19     perl calypso_convert.pl
20   Finally, import that folder by either selecting "New mailbox" or
21   moving it into your existing directory and recreate the folder
22   structure manually (contentmenu from folderview).
23
24   Any questions, comments or problems, contact Thorsten Maerz <torte@netztorte.de>
25
26 -----------------------------------------------------------------------
27
28 * eud2gc.py
29
30   WHAT IT DOES
31
32   This python-script is a quick hack to convert an Eudora (v.3?) addressbook
33   to vCard (GnomeCard) format.
34
35   HOW TO USE IT
36
37   You may do whatever you want with it! (Also regarding copying)
38
39   However, the script is intended to use like this:
40
41                         eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
42
43   Be careful not to overwrite your original GnomeCard.gcrd!
44   (But of course you might want to add the converted stuff to it)
45
46   Copyleft some time long ago (around 1999?) by Jeroen Versteeg
47   (j.m.versteeg@student.utwente.nl)
48
49 -----------------------------------------------------------------------
50
51 * filter_conv.pl
52
53   WHAT IT DOES
54
55   This perl script provides easy conversion of your filtering rules
56   form sylpheed's old filter system to the new filtering system used
57   in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs 
58   '~/.sylpheed/matcherrc'.
59   
60   HOW TO USE IT
61
62   Issue the following command from the 'tools' directory:
63
64         perl filter_conv.pl
65
66   That's it, the new filtering system is now implemented with your
67   previous rules applied.
68
69   Any problems, contact Torsten Schoenfeld <kaffeetisch@web.de>
70
71 -----------------------------------------------------------------------
72
73 * gif2xface.pl
74
75   WHAT IT DOES
76
77   This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
78   into an X-Face graphic suitable for inclusion into custom headers of
79   Sylpheed. An X-Face allows to quickly identify (or be identified as)
80   the sender of a mail message in a xface-capable MUA (like sylpheed).
81
82   HOW TO USE IT
83
84   After obtaining the desired image for your X-Face you should:
85     * scale it to 48x48 pixels (Image->Scale image on Gimp)
86     * down color depth to b/w (Image->Mode->Indexed selecting "Use
87       Black/White palette" and the desired dithering options (prior to
88       indexing doing Image->Colors->Threshold allows you to select the
89       b/w level if you don't want a dithered (dotty) image))
90     * save file as non-interlaced GIF
91   Then do:
92
93       ./gif2xface < filename.gif > filename.xface
94
95   In filename.xface will be the X-Face header ready to use.
96   You can add a custom header in Sylpheed through Configuration->
97   Preferences per account, "Send" tab, check "Add user-defined header"
98   then "Edit..." if you want to add it via Sylpheed interface, or do
99
100       echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
101
102   if you want to create the custom headers file yourself (Warning: this
103   method is valid only if you don't have any other custom header set or
104   they will be lost!).
105
106   Any problems, contact Ricardo Mones Lastra <mones@aic.uniovi.es>
107
108 -----------------------------------------------------------------------
109
110 * kmail2sylpheed.pl
111
112   WHAT IT DOES
113
114   This perl script will convert an exported Kmail addressbook into a
115   Sylpheed addressbook. If your version of Kmail is 1.37 or greater
116   and/or your version of KAddressBook is 3.1beta1 or greater, or
117   this script mixes up your definitions and their related data, use
118   'kmail2sylpheed_v2.pl' instead.
119
120   HOW TO USE IT
121
122   (You must run sylpheed at least once before running this script.)
123
124   In Kmail's Addressbook choose '/File/Export List'. This will export
125   your Kmail addressbook data to a *.csv file.
126
127   If Sylpheed is running, close it.
128
129   From the command line, execute the following:
130  
131         perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
132
133   Your Kmail addressbook data will now be contained in Sylpheed's
134   addressbook, under the name 'Kmail Address Book'.
135
136   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
137
138 -----------------------------------------------------------------------
139
140 * kmail2sylpheed_v2.pl
141
142   This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
143
144   WHAT IT DOES
145
146   This perl script will convert a Kmail addressbook that has been
147   exported in csv format into a Sylpheed addressbook.
148
149   HOW TO USE IT
150
151   (You must run sylpheed at least once before running this script.)
152   
153   Open Kmail's Addressbook, /File/Address Book
154   In Kmail's Addressbook choose '/File/Export/Export List...'. This 
155   will allow you to export your Kmail addressbook data to a *.csv file.
156
157   If Sylpheed is running, close it.
158
159   From the command line, execute the following:
160  
161         perl kmail2sylpheed_v2.pl --kmailfile=/path/to/addressbook.csv
162         
163   You can also use --help to see usage instructions.
164
165   Your Kmail addressbook data will now be contained in Sylpheed's
166   addressbook, under the name 'Kmail address book'.
167
168   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
169
170 -----------------------------------------------------------------------
171
172 * newscache_clean.pl
173
174   WHAT IT DOES AND WHY IT DOES IT
175
176   This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
177   the newscache becomes littered with old directories and files - when
178   you subscribe to a newsgroup a sub-directory gets created for it in
179   ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the 
180   group the sub-directory does not get deleted. Until this is done 
181   internally this script will take care of some tidying up.
182   
183   This script removes directory trees of nntp servers that you no longer
184   have an account for. Where an account exists it removes directories
185   and files of those groups to which you are no longer subscribed.
186
187   HOW TO USE IT
188
189   Issue the following command from the 'tools' directory:
190   
191         perl newscache_clean.pl
192         
193   This script uses the File::Path module, if you don't already have it
194   installed, you can find it at the CPAN search site <http://search.cpan.org>
195
196   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
197
198 -----------------------------------------------------------------------
199
200 * OOo2sylpheed.pl
201
202   WHAT IT DOES
203   
204   This perl script enables OpenOffice.org to send documents to sylpheed
205   as attachments.
206
207   HOW TO USE IT
208   
209   Edit line 29 of the script so that it contains the correct path:
210   exec "/usr/local/bin/sylpheed --attach $ARGV";
211   
212   Start up OpenOffice.org.
213   Go to 'Tools/Options/OpenOffice.org/External Programs'
214   Enter the path to this script in the 'Program' box
215   or select it by clicking on the '...' button.
216
217   You can then use 'File/Send/Document as email' to launch sylpheed
218   (if not already launched) and open a new compose window with the
219   document attached.
220
221   Tested with OpenOffice.org version 1.0
222   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
223
224 -----------------------------------------------------------------------
225
226 * outlook2sylpheed.pl
227
228   WHAT IT DOES
229   
230   This perl script converts an Outlook generated contact list into a 
231   Sylpheed XML address book.
232
233   HOW TO USE IT
234   
235   You must export Outlook Express contact list as TXT file, choosing
236   only "Name" and "Address" fields to export.
237
238   You must exit Sylpheed before converting the contact list.
239
240   From the command line, execute the following:
241
242         outlook2sylpheed.pl fullpathname
243
244   BUGS
245
246   Only works with fields described above. If you have more complex
247   examples send them to me, and I'll try to enhance the script.
248
249   Any questions, comments or problems, contact 
250   Ricardo Mones Lastra <mones@aic.uniovi.es>
251
252 -----------------------------------------------------------------------
253
254 * sylpheed-switcher
255
256   WHAT IT DOES
257   
258   This perl script is for users who like to move between the main
259   sylpheed branch and the claws branch. Because of some differences
260   between the stored options it is better IMO to use two separate
261   '.sylpheed' directory trees. Doing that manually could prove to
262   be tiresome, and so I've written this script to automate the task.
263
264   The first time you run this script you enter the full paths,
265   including the executable itself, to both the main version of
266   sylpheed and the claws version. This information is then stored
267   in a file in your $HOME directory called '.sylpheed-switcher'
268
269   During this initial set-up, your '~/.sylpheed' directory
270   is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
271   
272   When you run sylpheed via this script, your '~/.sylpheed' directory
273   is deleted and replaced with a symbolic link to either ~/.sylpheed-main'
274   or '~/sylpheed-claws', depending on the option you choose.
275   (On subsequent usage the symbolic link is deleted and replaced with
276   a new symbolic link).
277
278   HOW TO USE IT
279   
280   Initial set-up
281   Enter the full paths to the executable, including the executable itself,
282   example:
283   
284         ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed --main-path=
285         /usr/bin/sylpheed
286         
287   After the initial set-up, use the following:
288   
289         ./sylpheed-switcher --claws     (to run sylpheed-claws)
290         ./sylpheed-switcher --main      (to run sylpheed main)
291         
292   Additionally you can append --debug to run in debug mode.
293   Use --help for more info.     
294  
295   This script uses the File::Path and Getopt::Long modules, if you don't already 
296   have them installed, you can find them at the CPAN search site 
297   <http://search.cpan.org>
298
299   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
300
301 -----------------------------------------------------------------------
302
303 * tb2sylpheed
304
305   WHAT IT DOES
306   
307   This perl script will convert an addressbook exported from The Bat! into 
308   a Sylpheed addressbook.
309
310   HOW TO USE IT
311
312   (You must run sylpheed at least once before running this script.)
313
314   If Sylpheed is running, close it.
315
316   Export The Bat! Address Book to CSV file format with all fields 
317   selected to YES and then start:
318
319   tb2sylpheed --tbfile=/full/path/to/thebat/addressbook.csv
320  
321   The Bat! addressbook data will now be contained in Sylpheed's
322   addressbook, under the name 'The Bat! Address Book'.
323
324   Any questions, comments or problems, contact Urke MMI <urke@gmx.net>  
325
326 -----------------------------------------------------------------------
327 * update-po
328
329   WHAT IT DOES
330   
331   This script is a message catalog translator's tool, it updates the .po 
332   files named on the command line.
333
334   HOW TO USE IT
335
336   This script needs to be copied to and run from the 'po' directory.
337   
338         ./update-po lang.po lang2.po ...
339
340   to update one or more <yourlang>.po files from the sourcecode files
341   named in POTFILES.in. The old .po file is save in a .po.old file.
342
343   For example, when you want to update fr.po, run ./update-po fr.po, 
344   then edit fr.po to update your translation.
345
346   Author: Wilbert Berendsen <wilbert@oswf.org>
347
348 -----------------------------------------------------------------------
349
350