a7fa134b1ff61e4092036cbafd0fedc60435393c
[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.
116
117   HOW TO USE IT
118
119   (You must run sylpheed at least once before running this script.)
120
121   In Kmail's Addressbook choose '/File/Export List'. This will export
122   your Kmail addressbook data to a *.csv file.
123
124   If Sylpheed is running, close it.
125
126   From the command line, execute the following:
127  
128         perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
129
130   Your Kmail addressbook data will now be contained in Sylpheed's
131   addressbook, under the name 'Kmail Address Book'.
132
133   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
134
135 -----------------------------------------------------------------------
136
137 * newscache_clean.pl
138
139   WHAT IT DOES AND WHY IT DOES IT
140
141   This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
142   the newscache becomes littered with old directories and files - when
143   you subscribe to a newsgroup a sub-directory gets created for it in
144   ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the 
145   group the sub-directory does not get deleted. Until this is done 
146   internally this script will take care of some tidying up.
147   
148   This script removes directory trees of nntp servers that you no longer
149   have an account for. Where an account exists it removes directories
150   and files of those groups to which you are no longer subscribed.
151
152   HOW TO USE IT
153
154   Issue the following command from the 'tools' directory:
155   
156         perl newscache_clean.pl
157         
158   This script uses the File::Path module, if you don't already have it
159   installed, you can find it at the CPAN search site <http://search.cpan.org>
160
161   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
162
163 -----------------------------------------------------------------------
164
165 * OOo2sylpheed.pl
166
167   WHAT IT DOES
168   
169   This perl script enables OpenOffice.org to send documents to sylpheed
170   as attachments.
171
172   HOW TO USE IT
173   
174   Edit line 29 of the script so that it contains the correct path:
175   exec "/usr/local/bin/sylpheed --attach $ARGV";
176   
177   Start up OpenOffice.org.
178   Go to 'Tools/Options/OpenOffice.org/External Programs'
179   Enter the path to this script in the 'Program' box
180   or select it by clicking on the '...' button.
181
182   You can then use 'File/Send/Document as email' to launch sylpheed
183   (if not already launched) and open a new compose window with the
184   document attached.
185
186   Tested with OpenOffice.org version 1.0
187   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
188
189 -----------------------------------------------------------------------
190
191 * outlook2sylpheed.pl
192
193   WHAT IT DOES
194   
195   This perl script converts an Outlook generated contact list into a 
196   Sylpheed XML address book.
197
198   HOW TO USE IT
199   
200   You must export Outlook Express contact list as TXT file, choosing
201   only "Name" and "Address" fields to export.
202
203   You must exit Sylpheed before converting the contact list.
204
205   From the command line, execute the following:
206
207         outlook2sylpheed.pl fullpathname
208
209   BUGS
210
211   Only works with fields described above. If you have more complex
212   examples send them to me, and I'll try to enhance the script.
213
214   Any questions, comments or problems, contact 
215   Ricardo Mones Lastra <mones@aic.uniovi.es>
216
217 -----------------------------------------------------------------------
218
219 * sylpheed-switcher
220
221   WHAT IT DOES
222   
223   This perl script is for users who like to move between the main
224   sylpheed branch and the claws branch. Because of some differences
225   between the stored options it is better IMO to use two separate
226   '.sylpheed' directory trees. Doing that manually could prove to
227   be tiresome, and so I've written this script to automate the task.
228
229   The first time you run this script you enter the full paths,
230   including the executable itself, to both the main version of
231   sylpheed and the claws version. This information is then stored
232   in a file in your $HOME directory called '.sylpheed-switcher'
233
234   During this initial set-up, your '~/.sylpheed' directory
235   is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
236   
237   When you run sylpheed via this script, your '~/.sylpheed' directory
238   is deleted and replaced with a symbolic link to either ~/.sylpheed-main'
239   or '~/sylpheed-claws', depending on the option you choose.
240   (On subsequent usage the symbolic link is deleted and replaced with
241   a new symbolic link).
242
243   HOW TO USE IT
244   
245   Initial set-up
246   Enter the full paths to the executable, including the executable itself,
247   example:
248   
249         ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed --main-path=
250         /usr/bin/sylpheed
251         
252   After the initial set-up, use the following:
253   
254         ./sylpheed-switcher --claws     (to run sylpheed-claws)
255         ./sylpheed-switcher --main      (to run sylpheed main)
256         
257   Additionally you can append --debug to run in debug mode.
258   Use --help for more info.     
259  
260   This script uses the File::Path and Getopt::Long modules, if you don't already 
261   have them installed, you can find them at the CPAN search site 
262   <http://search.cpan.org>
263
264   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
265
266 -----------------------------------------------------------------------
267
268 * tb2sylpheed
269
270   WHAT IT DOES
271   
272   This perl script will convert an addressbook exported from The Bat! into 
273   a Sylpheed addressbook.
274
275   HOW TO USE IT
276
277   (You must run sylpheed at least once before running this script.)
278
279   If Sylpheed is running, close it.
280
281   Export The Bat! Address Book to CSV file format with all fields 
282   selected to YES and then start:
283
284   tb2sylpheed --tbfile=/full/path/to/thebat/addressbook.csv
285  
286   The Bat! addressbook data will now be contained in Sylpheed's
287   addressbook, under the name 'The Bat! Address Book'.
288
289   Any questions, comments or problems, contact Urke MMI <urke@gmx.net>  
290
291 -----------------------------------------------------------------------
292 * update-po
293
294   WHAT IT DOES
295   
296   This script is a message catalog translator's tool, it updates the .po 
297   files named on the command line.
298
299   HOW TO USE IT
300
301   This script needs to be copied to and run from the 'po' directory.
302   
303         ./update-po lang.po lang2.po ...
304
305   to update one or more <yourlang>.po files from the sourcecode files
306   named in POTFILES.in. The old .po file is save in a .po.old file.
307
308   For example, when you want to update fr.po, run ./update-po fr.po, 
309   then edit fr.po to update your translation.
310
311   Author: Wilbert Berendsen <wilbert@oswf.org>
312
313 -----------------------------------------------------------------------
314
315