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
22 calypso_convert.pl Import mbox files with attachments from Calypso
23 convert_mbox.pl Import mbox files
24 maildir2sylpheed.pl Convert a maildir mailbox to MH format
27 filter_conv.pl Convert old-style filters to new filtering
28 newscache_clean.pl Clean up news directory
29 OOo2sylpheed.pl Send documents from OpenOffice.org
30 sylpheed-switcher Run either sylpheed or claws (separate configs)
31 sylprint.pl Printing engine, explained in README.sylprint
32 update-po Update the .po files named on the command line.
35 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
36 launch_firebird Open URLs in mozilla-firebird
38 --------------------------------------------------------------------------------
39 Detailed Descriptions:
40 --------------------------------------------------------------------------------
47 COMMAND: |freshmeat_search.pl
48 Search freshmeat.net for selected text using the default Sylpheed browser
52 COMMAND: |google_msgid.pl
53 Lookup selected message-id in google using mozilla. Edit the script to use
58 COMMAND: |google_search.pl
59 Search google.com for selected text using the default Sylpheed browser
62 WORKS ON: selection, whole message
63 COMMAND: |gpg-sign-syl|
64 Clear-sign current selection using gpg.
68 see further down for details
71 WORKS ON: current message (or part of multipart message)
73 Decode and display uuencoded images using uudecode.
75 * More action examples can be found at
76 http://melvin.hadasht.free.fr/home/sylpheed/actions/
78 ** multiwebsearch.pl **
81 This is an Actions script that allows you to search
82 websites for the selected text. It uses the default
83 Sylpheed browser as configured through Sylpheed's
84 GUI and specified in ~/.sylpheed/sylpheedrc, and a
85 configuration file called multiwebsearch.conf.
88 The configuration file takes the following format:
90 ALIAS|URL PART|URL PART
92 ALIAS is a user-defined name; the first URL PART is the
93 url before the search term; the second URL PART is
94 optional and contains the remaining part of the url which
95 comes after the search term. A sample configuration file
99 Copy 'multiwebsearch.conf' to ~/.sylpheed/
102 a) pre-configured website
103 Command: multiwebsearch.pl --where="google" --what="%s"
105 Command: multiwebsearch.pl --where="%u" --what="%s"
107 In type a) "google" refers to one of the configured aliases,
108 this Action will always search the website referred to by
111 In type b) you will be presented with a dialog box into
112 which you type one of your configured aliases
115 Contact: Paul Mangan <claws@thewildbeast.co.uk>
116 --------------------------------------------------------------------------------
118 Address book conversion
119 -----------------------
124 This python-script is a quick hack to convert an Eudora (v.3?)
125 addressbook to vCard (GnomeCard) format.
128 You may do whatever you want with it! (Also regarding copying)
129 However, the script is intended to use like this:
131 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
133 Be careful not to overwrite your original GnomeCard.gcrd!
134 (But of course you might want to add the converted stuff to it)
136 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
141 This perl script will convert an exported Kmail addressbook into a
142 Sylpheed addressbook. If your version of Kmail is 1.37 or greater
143 and/or your version of KAddressBook is 3.1beta1 or greater, or
144 this script mixes up your definitions and their related data, use
145 'kmail2sylpheed_v2.pl' instead.
148 (You must run sylpheed at least once before running this script.)
150 In Kmail's Address book choose '/File/Export List'. This will export
151 your Kmail address book data to a *.csv file.
153 If Sylpheed is running, close it.
155 From the command line, execute the following:
157 perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
159 Your Kmail address book data will now be contained in Sylpheed's
160 address book, under the name 'Kmail Address Book'.
162 Contact: Paul Mangan <claws@thewildbeast.co.uk>
165 * kmail2sylpheed_v2.pl
167 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
170 This perl script will convert a Kmail address book that has been
171 exported in csv format into a Sylpheed address book.
174 (You must run sylpheed at least once before running this script.)
176 Open Kmail's Addressbook, /File/Address Book
177 In Kmail's Addressbook choose '/File/Export/Export List...'. This
178 will allow you to export your Kmail addressbook data to a *.csv file.
180 If Sylpheed is running, close it.
182 From the command line, execute the following:
184 perl kmail2sylpheed_v2.pl --kmailfile=/path/to/addressbook.csv
186 You can also use --help to see usage instructions.
188 Your Kmail addressbook data will now be contained in Sylpheed's
189 addressbook, under the name 'Kmail address book'.
191 Contact: Paul Mangan <claws@thewildbeast.co.uk>
194 * outlook2sylpheed.pl
197 This perl script converts an Outlook generated contact list into a
198 Sylpheed XML address book.
203 You must export Outlook Express contact list as TXT file, choosing
204 only "Name" and "Address" fields to export.
206 You must exit Sylpheed before converting the contact list.
208 From the command line, execute the following:
210 outlook2sylpheed.pl fullpathname
214 You must export Outlook contact list as CSV file, choosing ALL the
215 fields available for exporting.
217 You must exit Sylpheed before converting the contact list.
219 From the command line, execute the following:
221 outlook2sylpheed.pl --csv fullpathname
224 For text files only works with fields described above. If you have
225 more complex examples send them to me, and I'll try to enhance the
228 For csv files you must export all fields (but only non empty fields
229 are added to the created Sylpheed address book) and the number of
230 fields expected is harcoded. Look for the $nboffields variable in
231 the script and change its value if you are sure you exported all
232 fields and script gives the 'unknown csv file format' error.
234 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
240 This perl script will convert an address book exported from The Bat!
241 into a Sylpheed address book.
244 (You must run sylpheed at least once before running this script.)
246 If Sylpheed is running, close it.
248 Export The Bat! Address Book to CSV file format with all fields
249 selected to YES and then start:
251 tb2sylpheed --tbfile=/full/path/to/thebat/addressbook.csv
253 The Bat! addressbook data will now be contained in Sylpheed's
254 addressbook, under the name 'The Bat! Address Book'.
256 Contact: Urke MMI <urke@gmx.net>
258 --------------------------------------------------------------------------------
266 This perl script imports mbox files that are exported by Calypso.
267 It recreates the folder structure by scanning the "X-CalypsoFolder"
268 header and reincludes the attachments referenced in the
269 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
272 Export the Calypso mailbox by selecting "Save to archive" and check
273 the "Save attachments" box.
275 Edit the script to set following variables (at the top of the file):
276 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
277 $mboxfile : name of exported mbox, e.g. 'mail.txt'
278 $outdir : name of the MH folder to create, e.g. 'Calypso'
282 perl calypso_convert.pl
284 Finally, import that folder by either selecting "New mailbox" or
285 moving it into your existing directory and recreate the folder
286 structure manually (contentmenu from folderview).
288 Contact: Thorsten Maerz <torte@netztorte.de>
293 This perl script converts an mbox directory's contents into
294 Sylpheed's MH format.
298 Run the script using:
300 perl convert_mbox.pl MBOX MH_DIR
302 Move the outputted MH_DIR and its contents into your Sylpheed
303 Mail folder; in Sylpheed right-click the top-level folder
304 and choose 'Rebuild folder tree' from the popup menu.
306 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
308 * maildir2sylpheed.pl
311 This perl script converts a mailbox in maildir format into
312 Sylpheed's MH format.
316 Exit Sylpheed if running.
318 Run the script using:
320 perl maildir2sylpheed.pl --kmaildir=mail_folder_name
322 Start Sylpheed and right-click the toplevel mailbox, i.e
323 "Mailbox (MH)", and select 'Rebuild folder tree'.
324 You may also need to run '/File/Folder/Check for new messages
326 Your maildir directory will be backed-up.
328 Contact: Paul Mangan <claws@thewildbeast.co.uk>
329 --------------------------------------------------------------------------------
337 This perl script provides easy conversion of your filtering rules
338 form sylpheed's old filter system to the new filtering system used
339 in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs
340 '~/.sylpheed/matcherrc'.
343 Issue the following command from the 'tools' directory:
347 That's it, the new filtering system is now implemented with your
348 previous rules applied.
350 Contact: Paul Mangan <claws@thewildbeast.co.uk>
355 WHAT IT DOES AND WHY IT DOES IT
356 This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
357 the newscache becomes littered with old directories and files - when
358 you subscribe to a newsgroup a sub-directory gets created for it in
359 ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the
360 group the sub-directory does not get deleted. Until this is done
361 internally this script will take care of some tidying up.
363 This script removes directory trees of nntp servers that you no longer
364 have an account for. Where an account exists it removes directories
365 and files of those groups to which you are no longer subscribed.
368 Issue the following command from the 'tools' directory:
370 perl newscache_clean.pl
372 This script uses the File::Path module, if you don't already have it
373 installed, you can find it at the CPAN search site
374 <http://search.cpan.org>
376 Contact: Paul Mangan <claws@thewildbeast.co.uk>
382 This perl script enables OpenOffice.org to send documents to sylpheed
386 Start up OpenOffice.org.
387 Go to 'Tools/Options/OpenOffice.org/External Programs'
388 Enter the path to OOo2sylpheed.pl in the 'Program' box
389 or select it by clicking on the '...' button.
391 You can then use 'File/Send/Document as email' to launch sylpheed
392 (if not already launched) and open a new compose window with the
395 Tested with OpenOffice.org version 1.0
397 Contact: Paul Mangan <claws@thewildbeast.co.uk>
403 This perl script is for users who like to move between the main
404 sylpheed branch and the claws branch. Because of some differences
405 between the stored options it is better IMO to use two separate
406 '.sylpheed' directory trees. Doing that manually could prove to
407 be tiresome, and so I've written this script to automate the task.
409 The first time you run this script you enter the full paths,
410 including the executable itself, to both the main version of
411 sylpheed and the claws version. This information is then stored
412 in a file in your $HOME directory called '.sylpheed-switcher'
414 During this initial set-up, your '~/.sylpheed' directory
415 is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
417 When you run sylpheed via this script, your '~/.sylpheed' directory
418 is deleted and replaced with a symbolic link to either
419 ~/.sylpheed-main' or '~/sylpheed-claws', depending on the option you
420 choose. (On subsequent usage the symbolic link is deleted and replaced
421 with a new symbolic link).
425 Enter the full paths to the executable, including the executable itself,
428 ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed
429 --main-path=/usr/bin/sylpheed
431 After the initial set-up, use the following:
433 ./sylpheed-switcher --claws (to run sylpheed-claws)
434 ./sylpheed-switcher --main (to run sylpheed main)
436 Additionally you can append --debug to run in debug mode.
437 Use --help for more info.
439 This script uses the File::Path and Getopt::Long modules, if you don't
440 already have them installed, you can find them at the CPAN search site
441 <http://search.cpan.org>
443 Contact: Paul Mangan <claws@thewildbeast.co.uk>
449 This script is a message catalog translator's tool, it updates the .po
450 files named on the command line.
453 This script needs to be copied to and run from the 'po' directory.
455 ./update-po lang.po lang2.po ...
457 to update one or more <yourlang>.po files from the sourcecode files
458 named in POTFILES.in. The old .po file is save in a .po.old file.
460 For example, when you want to update fr.po, run ./update-po fr.po,
461 then edit fr.po to update your translation.
463 Contact: Wilbert Berendsen <wilbert@oswf.org>
465 --------------------------------------------------------------------------------
473 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
474 into an X-Face graphic suitable for inclusion into custom headers of
475 Sylpheed. An X-Face allows to quickly identify (or be identified as)
476 the sender of a mail message in a xface-capable MUA (like sylpheed).
479 After obtaining the desired image for your X-Face you should:
480 * scale it to 48x48 pixels (Image->Scale image on Gimp)
481 * down color depth to b/w (Image->Mode->Indexed selecting "Use
482 Black/White palette" and the desired dithering options (prior to
483 indexing doing Image->Colors->Threshold allows you to select the
484 b/w level if you don't want a dithered (dotty) image))
485 * save file as non-interlaced GIF
488 ./gif2xface < filename.gif > filename.xface
490 In filename.xface will be the X-Face header ready to use.
491 You can add a custom header in Sylpheed through Configuration->
492 Preferences per account, "Send" tab, check "Add user-defined header"
493 then "Edit..." if you want to add it via Sylpheed interface, or do
495 echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
497 if you want to create the custom headers file yourself (Warning: this
498 method is valid only if you don't have any other custom header set or
501 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
507 Check for a running mozilla-firebird process and and open a new tab
508 with a given URL, or execute mozilla-firebird with that URL
511 In Common Preferences move to the 'Other' tab and enter the
512 following in the 'Web browser' box
516 Contact: Mohammed Sameer <Uniball@linux-egypt.org>
519 --------------------------------------------------------------------------------