2 --------------------------------------------------------------------------------
3 Contents of the tools directory:
4 --------------------------------------------------------------------------------
7 freshmeat_search.pl Search freshmeat.net for selected text
8 gpg-sign-syl Clear-sign current selection
9 google_msgid.pl Search groups.google.com for selected message-id
10 google_search.pl Search google.com for selected text
11 multiwebsearch.pl Search any search engine for the selected text
12 uudec Decode and display uuencoded images
14 Addressbook conversion:
15 eud2gc.py Convert Eudora address book to Gnomecard
16 kmail2sylpheed.pl Import a Kmail address book (KDE2)
17 kmail2sylpheed_v2.pl Import a Kmail address book (KDE3)
18 outlook2sylpheed.pl Import an Outlook generated contact list
19 tb2sylpheed Import The Bat! address books
20 vcard2xml.py Import an Evolution vCard
23 calypso_convert.pl Import mbox files with attachments from Calypso
24 convert_mbox.pl Import mbox files
25 maildir2sylpheed.pl Convert a maildir mailbox to MH format
28 filter_conv.pl Convert old-style filters to new filtering
29 newscache_clean.pl Clean up news directory
30 OOo2sylpheed.pl Send documents from OpenOffice.org
31 sylpheed-switcher Run either sylpheed or claws (separate configs)
32 sylprint.pl Printing engine, explained in README.sylprint
33 update-po Update the .po files named on the command line.
36 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
37 launch_firebird Open URLs in mozilla-firebird
39 --------------------------------------------------------------------------------
40 Detailed Descriptions:
41 --------------------------------------------------------------------------------
48 COMMAND: |freshmeat_search.pl
49 Search freshmeat.net for selected text using the default Sylpheed browser
53 COMMAND: |google_msgid.pl
54 Lookup selected message-id in google using mozilla. Edit the script to use
59 COMMAND: |google_search.pl
60 Search google.com for selected text using the default Sylpheed browser
63 WORKS ON: selection, whole message
64 COMMAND: |gpg-sign-syl|
65 Clear-sign current selection using gpg.
69 see further down for details
72 WORKS ON: current message (or part of multipart message)
74 Decode and display uuencoded images using uudecode.
76 * More action examples can be found at
77 http://melvin.hadasht.free.fr/home/sylpheed/actions/
79 ** multiwebsearch.pl **
82 This is an Actions script that allows you to search
83 websites for the selected text. It uses the default
84 Sylpheed browser as configured through Sylpheed's
85 GUI and specified in ~/.sylpheed/sylpheedrc, and a
86 configuration file called multiwebsearch.conf.
89 The configuration file takes the following format:
91 ALIAS|URL PART|URL PART
93 ALIAS is a user-defined name; the first URL PART is the
94 url before the search term; the second URL PART is
95 optional and contains the remaining part of the url which
96 comes after the search term. A sample configuration file
100 Copy 'multiwebsearch.conf' to ~/.sylpheed/
103 a) pre-configured website
104 Command: multiwebsearch.pl --where="google" --what="%s"
106 Command: multiwebsearch.pl --where="%u" --what="%s"
108 In type a) "google" refers to one of the configured aliases,
109 this Action will always search the website referred to by
112 In type b) you will be presented with a dialog box into
113 which you type one of your configured aliases
116 Contact: Paul Mangan <claws@thewildbeast.co.uk>
117 --------------------------------------------------------------------------------
119 Address book conversion
120 -----------------------
125 This python-script is a quick hack to convert an Eudora (v.3?)
126 addressbook to vCard (GnomeCard) format.
129 You may do whatever you want with it! (Also regarding copying)
130 However, the script is intended to use like this:
132 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
134 Be careful not to overwrite your original GnomeCard.gcrd!
135 (But of course you might want to add the converted stuff to it)
137 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
142 This perl script will convert an exported Kmail addressbook into a
143 Sylpheed addressbook. If your version of Kmail is 1.37 or greater
144 and/or your version of KAddressBook is 3.1beta1 or greater, or
145 this script mixes up your definitions and their related data, use
146 'kmail2sylpheed_v2.pl' instead.
149 (You must run sylpheed at least once before running this script.)
151 In Kmail's Address book choose '/File/Export List'. This will export
152 your Kmail address book data to a *.csv file.
154 If Sylpheed is running, close it.
156 From the command line, execute the following:
158 perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
160 Your Kmail address book data will now be contained in Sylpheed's
161 address book, under the name 'Kmail Address Book'.
163 Contact: Paul Mangan <claws@thewildbeast.co.uk>
166 * kmail2sylpheed_v2.pl
168 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
171 This perl script will convert a Kmail address book that has been
172 exported in csv format into a Sylpheed address book.
175 (You must run sylpheed at least once before running this script.)
177 Open Kmail's Addressbook, /File/Address Book
178 In Kmail's Addressbook choose '/File/Export/Export List...'. This
179 will allow you to export your Kmail addressbook data to a *.csv file.
181 If Sylpheed is running, close it.
183 From the command line, execute the following:
185 perl kmail2sylpheed_v2.pl --kmailfile=/path/to/addressbook.csv
187 You can also use --help to see usage instructions.
189 Your Kmail addressbook data will now be contained in Sylpheed's
190 addressbook, under the name 'Kmail address book'.
192 Contact: Paul Mangan <claws@thewildbeast.co.uk>
195 * outlook2sylpheed.pl
198 This perl script converts an Outlook generated contact list into a
199 Sylpheed XML address book.
204 You must export Outlook Express contact list as TXT file, choosing
205 only "Name" and "Address" fields to export.
207 You must exit Sylpheed before converting the contact list.
209 From the command line, execute the following:
211 outlook2sylpheed.pl fullpathname
215 You must export Outlook contact list as CSV file, choosing ALL the
216 fields available for exporting.
218 You must exit Sylpheed before converting the contact list.
220 From the command line, execute the following:
222 outlook2sylpheed.pl --csv fullpathname
225 For text files only works with fields described above. If you have
226 more complex examples send them to me, and I'll try to enhance the
229 For csv files you must export all fields (but only non empty fields
230 are added to the created Sylpheed address book) and the number of
231 fields expected is harcoded. Look for the $nboffields variable in
232 the script and change its value if you are sure you exported all
233 fields and script gives the 'unknown csv file format' error.
235 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
241 This perl script will convert an address book exported from The Bat!
242 into a Sylpheed address book.
245 (You must run sylpheed at least once before running this script.)
247 If Sylpheed is running, close it.
249 Export The Bat! Address Book to CSV file format with all fields
250 selected to YES and then start:
252 tb2sylpheed --tbfile=/full/path/to/thebat/addressbook.csv
254 The Bat! addressbook data will now be contained in Sylpheed's
255 addressbook, under the name 'The Bat! Address Book'.
257 Contact: Urke MMI <urke@gmx.net>
263 This python script will convert an Evolution vCard into a Sylpheed
267 (You must run sylpheed at least once before running this script.)
269 If Sylpheed is running, close it.
270 From the command line, execute the following:
272 vcard2xml.py source_file [destination_file]
274 When only <source_file> is specified it will overwrite (and
275 create a backup of) the existing addressbook.
276 When both arguments are suplied it will create a new additional
277 addressbook named as <destination_file>.
278 If the script encounters an error it will attempt to roll back
279 the changes and restore the original files.
281 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
283 --------------------------------------------------------------------------------
291 This perl script imports mbox files that are exported by Calypso.
292 It recreates the folder structure by scanning the "X-CalypsoFolder"
293 header and reincludes the attachments referenced in the
294 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
297 Export the Calypso mailbox by selecting "Save to archive" and check
298 the "Save attachments" box.
300 Edit the script to set following variables (at the top of the file):
301 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
302 $mboxfile : name of exported mbox, e.g. 'mail.txt'
303 $outdir : name of the MH folder to create, e.g. 'Calypso'
307 perl calypso_convert.pl
309 Finally, import that folder by either selecting "New mailbox" or
310 moving it into your existing directory and recreate the folder
311 structure manually (contentmenu from folderview).
313 Contact: Thorsten Maerz <torte@netztorte.de>
318 This perl script converts an mbox directory's contents into
319 Sylpheed's MH format.
323 Run the script using:
325 perl convert_mbox.pl MBOX MH_DIR
327 Move the outputted MH_DIR and its contents into your Sylpheed
328 Mail folder; in Sylpheed right-click the top-level folder
329 and choose 'Rebuild folder tree' from the popup menu.
331 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
333 * maildir2sylpheed.pl
336 This perl script converts a mailbox in maildir format into
337 Sylpheed's MH format.
341 Exit Sylpheed if running.
343 Run the script using:
345 perl maildir2sylpheed.pl --kmaildir=mail_folder_name
347 Start Sylpheed and right-click the toplevel mailbox, i.e
348 "Mailbox (MH)", and select 'Rebuild folder tree'.
349 You may also need to run '/File/Folder/Check for new messages
351 Your maildir directory will be backed-up.
355 --dry-run test mode, nothing is actually written
356 --help brief usage info
358 Contact: Paul Mangan <claws@thewildbeast.co.uk>
359 --------------------------------------------------------------------------------
367 This perl script provides easy conversion of your filtering rules
368 form sylpheed's old filter system to the new filtering system used
369 in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs
370 '~/.sylpheed/matcherrc'.
373 Issue the following command from the 'tools' directory:
377 That's it, the new filtering system is now implemented with your
378 previous rules applied.
380 Contact: Paul Mangan <claws@thewildbeast.co.uk>
385 WHAT IT DOES AND WHY IT DOES IT
386 This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
387 the newscache becomes littered with old directories and files - when
388 you subscribe to a newsgroup a sub-directory gets created for it in
389 ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the
390 group the sub-directory does not get deleted. Until this is done
391 internally this script will take care of some tidying up.
393 This script removes directory trees of nntp servers that you no longer
394 have an account for. Where an account exists it removes directories
395 and files of those groups to which you are no longer subscribed.
398 Issue the following command from the 'tools' directory:
400 perl newscache_clean.pl
402 This script uses the File::Path module, if you don't already have it
403 installed, you can find it at the CPAN search site
404 <http://search.cpan.org>
406 Contact: Paul Mangan <claws@thewildbeast.co.uk>
412 This perl script enables OpenOffice.org to send documents to sylpheed
416 Start up OpenOffice.org.
417 Go to 'Tools/Options/OpenOffice.org/External Programs'
418 Enter the path to OOo2sylpheed.pl in the 'Program' box
419 or select it by clicking on the '...' button.
421 You can then use 'File/Send/Document as email' to launch sylpheed
422 (if not already launched) and open a new compose window with the
425 Tested with OpenOffice.org version 1.0
427 Contact: Paul Mangan <claws@thewildbeast.co.uk>
433 This perl script is for users who like to move between the main
434 sylpheed branch and the claws branch. Because of some differences
435 between the stored options it is better IMO to use two separate
436 '.sylpheed' directory trees. Doing that manually could prove to
437 be tiresome, and so I've written this script to automate the task.
439 The first time you run this script you enter the full paths,
440 including the executable itself, to both the main version of
441 sylpheed and the claws version. This information is then stored
442 in a file in your $HOME directory called '.sylpheed-switcher'
444 During this initial set-up, your '~/.sylpheed' directory
445 is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
447 When you run sylpheed via this script, your '~/.sylpheed' directory
448 is deleted and replaced with a symbolic link to either
449 ~/.sylpheed-main' or '~/sylpheed-claws', depending on the option you
450 choose. (On subsequent usage the symbolic link is deleted and replaced
451 with a new symbolic link).
455 Enter the full paths to the executable, including the executable itself,
458 ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed
459 --main-path=/usr/bin/sylpheed
461 After the initial set-up, use the following:
463 ./sylpheed-switcher --claws (to run sylpheed-claws)
464 ./sylpheed-switcher --main (to run sylpheed main)
466 Additionally you can append --debug to run in debug mode.
467 Use --help for more info.
469 This script uses the File::Path and Getopt::Long modules, if you don't
470 already have them installed, you can find them at the CPAN search site
471 <http://search.cpan.org>
473 Contact: Paul Mangan <claws@thewildbeast.co.uk>
479 This script is a message catalog translator's tool, it updates the .po
480 files named on the command line.
483 This script needs to be copied to and run from the 'po' directory.
485 ./update-po lang.po lang2.po ...
487 to update one or more <yourlang>.po files from the sourcecode files
488 named in POTFILES.in. The old .po file is save in a .po.old file.
490 For example, when you want to update fr.po, run ./update-po fr.po,
491 then edit fr.po to update your translation.
493 Contact: Wilbert Berendsen <wilbert@oswf.org>
495 --------------------------------------------------------------------------------
503 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
504 into an X-Face graphic suitable for inclusion into custom headers of
505 Sylpheed. An X-Face allows to quickly identify (or be identified as)
506 the sender of a mail message in a xface-capable MUA (like sylpheed).
509 After obtaining the desired image for your X-Face you should:
510 * scale it to 48x48 pixels (Image->Scale image on Gimp)
511 * down color depth to b/w (Image->Mode->Indexed selecting "Use
512 Black/White palette" and the desired dithering options (prior to
513 indexing doing Image->Colors->Threshold allows you to select the
514 b/w level if you don't want a dithered (dotty) image))
515 * save file as non-interlaced GIF
518 ./gif2xface < filename.gif > filename.xface
520 In filename.xface will be the X-Face header ready to use.
521 You can add a custom header in Sylpheed through Configuration->
522 Preferences per account, "Send" tab, check "Add user-defined header"
523 then "Edit..." if you want to add it via Sylpheed interface, or do
525 echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
527 if you want to create the custom headers file yourself (Warning: this
528 method is valid only if you don't have any other custom header set or
531 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
537 Check for a running mozilla-firebird process and and open a new tab
538 with a given URL, or execute mozilla-firebird with that URL
541 In Common Preferences move to the 'Other' tab and enter the
542 following in the 'Web browser' box
546 Contact: Mohammed Sameer <Uniball@linux-egypt.org>
549 --------------------------------------------------------------------------------