2005-01-29 [paul] 1.0.0cvs23.2
[claws.git] / tools / README
index 588ce1828f1395622b23c3af5af52113b94522bb..d7b332bbc9092ec4d041f1794f39d1776d2dd1c8 100644 (file)
-* calypso_convert.pl
+
+--------------------------------------------------------------------------------
+Contents of the tools directory:
+--------------------------------------------------------------------------------
+
+Action scripts:
+  freshmeat_search.pl          Search freshmeat.net for selected text
+  gpg-sign-syl                  Clear-sign current selection
+  google_msgid.pl               Search groups.google.com for selected message-id
+  google_search.pl             Search google.com for selected text
+  multiwebsearch.pl            Search any search engine for the selected text
+  textviewer.sh                        Attempt to view an attachment as plain text
+  uudec                         Decode and display uuencoded images
+
+Addressbook conversion:
+  eud2gc.py                     Convert Eudora address book to Gnomecard
+  kmail2sylpheed.pl             Import a Kmail address book (KDE2)
+  kmail2sylpheed_v2.pl          Import a Kmail address book (KDE3)
+  outlook2sylpheed.pl           Import an Outlook generated contact list
+  tb2sylpheed                   Import The Bat! address books
+  vcard2xml.py                 Import an Evolution vCard
+
+Mailbox conversion:
+  calypso_convert.pl            Import mbox files with attachments from Calypso
+  convert_mbox.pl              Import mbox files
+  maildir2sylpheed.pl          Convert a maildir mailbox to MH format
+
+Other tools:
+  filter_conv.pl                Convert old-style filters to new filtering
+  nautilus2sylpheed.sh         Send files from Nautilus
+  OOo2sylpheed.pl               Send documents from OpenOffice.org
+  sylpheed-switcher             Run either sylpheed or claws (separate configs)
+  sylprint.pl                   Printing engine, explained in README.sylprint
+  update-po                     Update the .po files named on the command line.
+
+Extra tools:
+  gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
+
+--------------------------------------------------------------------------------
+Detailed Descriptions:
+--------------------------------------------------------------------------------
+
+Action scripts
+--------------
+
+* freshmeat_search.pl
+  WORKS ON: selection
+  COMMAND: |freshmeat_search.pl
+  Search freshmeat.net for selected text using the default Sylpheed browser
+
+* google_msgid.pl
+  WORKS ON: selection
+  COMMAND: |google_msgid.pl
+  Lookup selected message-id in google using mozilla. Edit the script to use
+  different browsers.
+
+* google_search.pl
+  WORKS ON: selection
+  COMMAND: |google_search.pl
+  Search google.com for selected text using the default Sylpheed browser
+
+* gpg-sign-syl
+  WORKS ON: selection, whole message
+  COMMAND: |gpg-sign-syl|
+  Clear-sign current selection using gpg.
+
+* multiwebsearch.pl
+  WORKS ON: selection
+  see further down for details
+
+* uudec
+  WORKS ON: current message (or part of multipart message)
+  COMMAND: uudec %f&
+  Decode and display uuencoded images using uudecode.
+
+* textviewer.sh
+  WORKS ON: current message part
+  COMMAND: textviewer.sh %p |
+  Attempt to view an attachment as plain text
+
+* More action examples can be found at
+  http://melvin.hadasht.free.fr/home/sylpheed/actions/
+
+** multiwebsearch.pl **
 
   WHAT IT DOES
+       This is an Actions script that allows you to search
+       websites for the selected text. It uses the default
+       Sylpheed browser as configured through Sylpheed's
+       GUI and specified in ~/.sylpheed/sylpheedrc, and a
+       configuration file called multiwebsearch.conf.
+       
+  CONFIGURATION
+       The configuration file takes the following format:
+       
+       ALIAS|URL PART|URL PART
+       
+       ALIAS is a user-defined name; the first URL PART is the
+       url before the search term; the second URL PART is
+       optional and contains the remaining part of the url which
+       comes after the search term. A sample configuration file
+       is included.
+       
+  HOW TO USE IT
+       Copy 'multiwebsearch.conf' to ~/.sylpheed/
+       
+       Configure an Action:
+       a) pre-configured website 
+          Command: multiwebsearch.pl --where="google" --what="%s"
+       b) dynamic
+          Command: multiwebsearch.pl --where="%u" --what="%s"
+          
+       In type a) "google" refers to one of the configured aliases,
+       this Action will always search the website referred to by
+       the alias "google".
+       
+       In type b) you will be presented with a dialog box into
+       which you type one of your configured aliases
 
-  This perl script imports mbox files that are exported by Calypso.
-  It recreates the folder structure by scanning the "X-CalypsoFolder"
-  header and reincludes the attachments referenced in the
-  "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
   
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
+--------------------------------------------------------------------------------
+
+Address book conversion
+-----------------------
+
+* eud2gc.py
+
+  WHAT IT DOES
+       This python-script is a quick hack to convert an Eudora (v.3?)
+       addressbook to vCard (GnomeCard) format.
+
   HOW TO USE IT
+       You may do whatever you want with it! (Also regarding copying)
+       However, the script is intended to use like this:
 
-  Export the Calypso mailbox by selecting "Save to archive" and check
-  the "Save attachments" box.
-  Edit the script to set following variables (at the top of the file):
-    $mboxdir  : path to the exported mbox, e.g. 'Archive' or '.'
-    $mboxfile : name of exported mbox, e.g. 'mail.txt'
-    $outdir   : name of the MH folder to create, e.g. 'Calypso'
-  Run the script using
-    perl calypso_convert.pl
-  Finally, import that folder by either selecting "New mailbox" or
-  moving it into your existing directory and recreate the folder
-  structure manually (contentmenu from folderview).
+               eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
 
-  Any questions, comments or problems, contact Thorsten Maerz <torte@netztorte.de>
+       Be careful not to overwrite your original GnomeCard.gcrd!
+       (But of course you might want to add the converted stuff to it)
 
------------------------------------------------------------------------
+  Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
 
-* eud2gc.py
+* kmail2sylpheed.pl
 
   WHAT IT DOES
-
-  This python-script is a quick hack to convert an Eudora (v.3?) addressbook
-  to vCard (GnomeCard) format.
+       This perl script will convert an exported Kmail addressbook into a
+       Sylpheed addressbook. If your version of Kmail is 1.37 or greater
+       and/or your version of KAddressBook is 3.1beta1 or greater, or
+       this script mixes up your definitions and their related data, use
+       'kmail2sylpheed_v2.pl' instead.
 
   HOW TO USE IT
+       (You must run sylpheed at least once before running this script.)
 
-  You may do whatever you want with it! (Also regarding copying)
+       In Kmail's Address book choose '/File/Export List'. This will export
+       your Kmail address book data to a *.csv file.
 
-  However, the script is intended to use like this:
+       If Sylpheed is running, close it.
 
-                       eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
+       From the command line, execute the following:
+               perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
 
-  Be careful not to overwrite your original GnomeCard.gcrd!
-  (But of course you might want to add the converted stuff to it)
+       Your Kmail address book data will now be contained in Sylpheed's
+       address book, under the name 'Kmail Address Book'.
 
-  Copyleft some time long ago (around 1999?) by Jeroen Versteeg
-  (j.m.versteeg@student.utwente.nl)
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
+    
 
------------------------------------------------------------------------
+* kmail2sylpheed_v2.pl
 
-* filter_conv.pl
+  This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
 
   WHAT IT DOES
+       This perl script will convert a Kmail address book that has been
+       exported in csv format into a Sylpheed address book.
 
-  This perl script provides easy conversion of your filtering rules
-  form sylpheed's old filter system to the new filtering system used
-  in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs 
-  '~/.sylpheed/matcherrc'.
-  
   HOW TO USE IT
+       (You must run sylpheed at least once before running this script.)
+  
+       Open Kmail's Addressbook, /File/Address Book
+       In Kmail's Addressbook choose '/File/Export/Export List...'. This 
+       will allow you to export your Kmail addressbook data to a *.csv file.
 
-  Issue the following command from the 'tools' directory:
+       If Sylpheed is running, close it.
 
-        perl filter_conv.pl
+       From the command line, execute the following:
+               perl kmail2sylpheed_v2.pl --kmailfile=/path/to/addressbook.csv
+       
+       You can also use --help to see usage instructions.
 
-  That's it, the new filtering system is now implemented with your
-  previous rules applied.
+       Your Kmail addressbook data will now be contained in Sylpheed's
+       addressbook, under the name 'Kmail address book'.
 
-  Any problems, contact Torsten Schoenfeld <kaffeetisch@web.de>
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>  
 
------------------------------------------------------------------------
 
-* gif2xface.pl
+* outlook2sylpheed.pl
 
   WHAT IT DOES
-
-  This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
-  into an X-Face graphic suitable for inclusion into custom headers of
-  Sylpheed. An X-Face allows to quickly identify (or be identified as)
-  the sender of a mail message in a xface-capable MUA (like sylpheed).
+       This perl script converts an Outlook generated contact list into a 
+       Sylpheed XML address book.
 
   HOW TO USE IT
+       For text files:
+       --------------
+       You must export Outlook Express contact list as TXT file, choosing
+       only "Name" and "Address" fields to export.
 
-  After obtaining the desired image for your X-Face you should:
-    * scale it to 48x48 pixels (Image->Scale image on Gimp)
-    * down color depth to b/w (Image->Mode->Indexed selecting "Use
-      Black/White palette" and the desired dithering options (prior to
-      indexing doing Image->Colors->Threshold allows you to select the
-      b/w level if you don't want a dithered (dotty) image))
-    * save file as non-interlaced GIF
-  Then do:
+       You must exit Sylpheed before converting the contact list.
 
-      ./gif2xface < filename.gif > filename.xface
+       From the command line, execute the following:
 
-  In filename.xface will be the X-Face header ready to use.
-  You can add a custom header in Sylpheed through Configuration->
-  Preferences per account, "Send" tab, check "Add user-defined header"
-  then "Edit..." if you want to add it via Sylpheed interface, or do
+               outlook2sylpheed.pl fullpathname
 
-      echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
+       For csv files:
+       -------------
+       You must export Outlook contact list as CSV file, choosing ALL the
+       fields available for exporting.
 
-  if you want to create the custom headers file yourself (Warning: this
-  method is valid only if you don't have any other custom header set or
-  they will be lost!).
+       You must exit Sylpheed before converting the contact list.
 
-  Any problems, contact Ricardo Mones Lastra <mones@aic.uniovi.es>
+       From the command line, execute the following:
 
------------------------------------------------------------------------
+               outlook2sylpheed.pl --csv fullpathname
 
-* kmail2sylpheed.pl
+  LIMITATIONS
+       For text files only works with fields described above. If you have 
+       more complex examples send them to me, and I'll try to enhance the 
+       script.
 
-  WHAT IT DOES
+       For csv files you must export all fields (but only non empty fields
+       are added to the created Sylpheed address book) and the number of
+       fields expected is harcoded. Look for the $nboffields variable in
+       the script and change its value if you are sure you exported all
+       fields and script gives the 'unknown csv file format' error.
 
-  This perl script will convert an exported Kmail addressbook into a
-  Sylpheed addressbook.
+  Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
 
-  HOW TO USE IT
 
-  (You must run sylpheed at least once before running this script.)
+* tb2sylpheed
 
-  In Kmail's Addressbook choose '/File/Export List'. This will export
-  your Kmail addressbook data to a *.csv file.
+  WHAT IT DOES
+       This perl script will convert an address book exported from The Bat! 
+       into a Sylpheed address book.
+
+  HOW TO USE IT
+       (You must run sylpheed at least once before running this script.)
 
-  If Sylpheed is running, close it.
+       If Sylpheed is running, close it.
 
-  From the command line, execute the following:
-       perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
+       Export The Bat! Address Book to CSV file format with all fields 
+       selected to YES and then start:
 
-  Your Kmail addressbook data will now be contained in Sylpheed's
-  addressbook, under the name 'Kmail Address Book'.
+               tb2sylpheed --tbfile=/full/path/to/thebat/addressbook.csv
+       The Bat! addressbook data will now be contained in Sylpheed's
+       addressbook, under the name 'The Bat! Address Book'.
 
-  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
+  Contact: Urke MMI <urke@gmx.net>  
 
------------------------------------------------------------------------
 
-* ldif-to-xml.py
+* vcard2xml.py
 
   WHAT IT DOES
-
-  This python script converts the netscape ldif format address book to
-  the sylpheed xml format.
+       This python script will convert an Evolution vCard into a Sylpheed
+       address book.
 
   HOW TO USE IT
+       (You must run sylpheed at least once before running this script.)
 
-  Inside Netscape export your address book to a file.
-  From the command line, execute:
-
-      ./ldif-to-xml.py <path/filename>
-
-  In case of trouble, just invoke your python interpreter directly:
-
-      python ldif-to-xml.py <path/filename>
+       If Sylpheed is running, close it.
+       From the command line, execute the following:
 
-  Either way a file called addressbook.xml will be generated in the current
-  directory. This xml file should be merged with or simply placed in the
-  $HOME/.sylpheed directory.
+               vcard2xml.py source_file [destination_file]
+       When only <source_file> is specified it will overwrite (and
+       create a backup of) the existing addressbook. 
+       When both arguments are suplied it will create a new additional 
+       addressbook named as <destination_file>.
+       If the script encounters an error it will attempt to roll back
+       the changes and restore the original files.
 
-  Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
+  Contact: Bogdan Sumanariu <bsumanariu@one5.ro> 
 
------------------------------------------------------------------------
+--------------------------------------------------------------------------------
 
-* newscache_clean.pl
+Mailbox conversion
+------------------
 
-  WHAT IT DOES AND WHY IT DOES IT
+* calypso_convert.pl
 
-  This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
-  the newscache becomes littered with old directories and files - when
-  you subscribe to a newsgroup a sub-directory gets created for it in
-  ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the 
-  group the sub-directory does not get deleted. Until this is done 
-  internally this script will take care of some tidying up.
+  WHAT IT DOES
+       This perl script imports mbox files that are exported by Calypso.
+       It recreates the folder structure by scanning the "X-CalypsoFolder"
+       header and reincludes the attachments referenced in the
+       "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
   
-  This script removes directory trees of nntp servers that you no longer
-  have an account for. Where an account exists it removes directories
-  and files of those groups to which you are no longer subscribed.
-
   HOW TO USE IT
+       Export the Calypso mailbox by selecting "Save to archive" and check
+       the "Save attachments" box.
+       
+       Edit the script to set following variables (at the top of the file):
+          $mboxdir  : path to the exported mbox, e.g. 'Archive' or '.'
+          $mboxfile : name of exported mbox, e.g. 'mail.txt'
+          $outdir   : name of the MH folder to create, e.g. 'Calypso'
+          
+        Run the script using
+        
+               perl calypso_convert.pl
+               
+       Finally, import that folder by either selecting "New mailbox" or
+       moving it into your existing directory and recreate the folder
+       structure manually (contentmenu from folderview).
+
+  Contact: Thorsten Maerz <torte@netztorte.de>
+
+* convert_mbox.pl
 
-  Issue the following command from the 'tools' directory:
+  WHAT IT DOES
+       This perl script converts an mbox directory's contents into 
+       Sylpheed's MH format.
   
-       perl newscache_clean.pl
-        
-  This script uses the File::Path module, if you don't already have it
-  installed, you can find it at the CPAN search site <http://search.cpan.org>
-
-  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
+  HOW TO USE IT
+  
+       Run the script using:
+        
+               perl convert_mbox.pl MBOX MH_DIR
+               
+       Move the outputted MH_DIR and its contents into your Sylpheed
+       Mail folder; in Sylpheed right-click the top-level folder
+       and choose 'Rebuild folder tree' from the popup menu.   
 
------------------------------------------------------------------------
+  Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
 
-* OOo2sylpheed.pl
+* maildir2sylpheed.pl
 
   WHAT IT DOES
+       This perl script converts a mailbox in maildir format into
+       Sylpheed's MH format.
   
-  This perl script enables OpenOffice.org to send documents to sylpheed
-  as attachments.
-
   HOW TO USE IT
   
-  Start up OpenOffice.org.
-  Go to 'Tools/Options/OpenOffice.org/External Programs'
-  Enter the path to this script in the 'Program' box
-  or select it by clicking on the '...' button.
+       Exit Sylpheed if running.
+       
+       Run the script using:
+        
+               perl maildir2sylpheed.pl --kmaildir=mail_folder_name
+               
+       Start Sylpheed and right-click the toplevel mailbox, i.e
+       "Mailbox (MH)", and select 'Rebuild folder tree'.
+       You may also need to run '/File/Folder/Check for new messages
+       in all folders'
+       Your maildir directory will be backed-up.
+       
+       Additional options:
+               --debug         debug mode
+               --dry-run       test mode, nothing is actually written
+               --help          brief usage info
+       
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
+--------------------------------------------------------------------------------
+
+Other tools
+-----------
 
-  You can then use 'File/Send/Document as email' to launch sylpheed
-  (if not already launched) and open a new compose window with the
-  document attached.
+* filter_conv.pl
 
-  Tested with OpenOffice.org version 1.0
-  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
+  WHAT IT DOES
+       This perl script provides easy conversion of your filtering rules
+       form sylpheed's old filter system (pre version 0.9.99) to the new
+       filtering system used in sylpheed-claws.
+       It reads '~/.sylpheed/filterrc' and outputs '~/.sylpheed/matcherrc'.
+  
+  HOW TO USE IT
+       Issue the following command from the 'tools' directory:
 
------------------------------------------------------------------------
+        perl filter_conv.pl
 
-* outlook2sylpheed.pl
+       That's it, the new filtering system is now implemented with your
+       previous rules applied.
 
-  WHAT IT DOES
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
   
-  This perl script converts an Outlook generated contact list into a 
-  Sylpheed XML address book.
 
-  HOW TO USE IT
-  
-  You must export Outlook Express contact list as TXT file, choosing
-  only "Name" and "Address" fields to export.
+* nautilus2sylpheed.sh
 
-  You must exit Sylpheed before converting the contact list.
+  WHAT IT DOES
+       This script will recursively attach a number of selected 
+       files/directories from Nautilus to a new blank e-mail.
 
-  From the command line, execute the following:
+  HOW TO USE IT
+       Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x, 
+       and restart nautilus (killall -9 nautilus). You will now have 
+       a right-click menu item: '/Scripts/nautilus2sylpheed.sh'
+       
+  Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
 
-       outlook2sylpheed.pl fullpathname
 
-  BUGS
+* OOo2sylpheed.pl
 
-  Only works with fields described above. If you have more complex
-  examples send them to me, and I'll try to enhance the script.
+  WHAT IT DOES
+       This perl script enables OpenOffice.org to send documents to sylpheed
+       as attachments.
 
-  Any questions, comments or problems, contact 
-  Ricardo Mones Lastra <mones@aic.uniovi.es>
+  HOW TO USE IT
+    OpenOffice.org Version 1.0
+    --------------------------
+       Start up OpenOffice.org.
+       Go to 'Tools/Options/OpenOffice.org/External Programs'
+       Enter the path to OOo2sylpheed.pl in the 'Program' box
+       or select it by clicking on the '...' button.
+
+    OpenOffice.org Version 1.1.0
+    ----------------------------
+       Start up OpenOffice.org.
+       Go to 'Tools/Options/OpenOffice.org/External Programs'
+       Select either ''Mozilla 1.x (Option 1)', or 
+       'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
+       Enter the path to OOo2sylpheed.pl in the 'Path' box
+       or select it by clicking on the '...' button.
+    
+       You can then use 'File/Send/Document as email' to launch sylpheed
+       (if not already launched) and open a new compose window with the
+       document attached.
+
+       Tested with OpenOffice.org versions 1.0, 1.1.0
+  
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
 
------------------------------------------------------------------------
 
 * sylpheed-switcher
 
   WHAT IT DOES
+       This perl script is for users who like to move between the main
+       sylpheed branch and the claws branch. Because of some differences
+       between the stored options it is better IMO to use two separate
+       '.sylpheed' directory trees. Doing that manually could prove to
+       be tiresome, and so I've written this script to automate the task.
+
+       The first time you run this script you enter the full paths,
+       including the executable itself, to both the main version of
+       sylpheed and the claws version. This information is then stored
+       in a file in your $HOME directory called '.sylpheed-switcher'
+
+       During this initial set-up, your '~/.sylpheed' directory
+       is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
   
-  This perl script is for users who like to move between the main
-  sylpheed branch and the claws branch. Because of some differences
-  between the stored options it is better IMO to use two separate
-  '.sylpheed' directory trees. Doing that manually could prove to
-  be tiresome, and so I've written this script to automate the task.
-
-  The first time you run this script you enter the full paths,
-  including the executable itself, to both the main version of
-  sylpheed and the claws version. This information is then stored
-  in a file in your $HOME directory called '.sylpheed-switcher'
-
-  During this initial set-up, your '~/.sylpheed' directory
-  is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
-  
-  When you run sylpheed via this script, your '~/.sylpheed' directory
-  is deleted and replaced with a symbolic link to either ~/.sylpheed-main'
-  or '~/sylpheed-claws', depending on the option you choose.
-  (On subsequent usage the symbolic link is deleted and replaced with
-  a new symbolic link).
+       When you run sylpheed via this script, your '~/.sylpheed' directory
+       is deleted and replaced with a symbolic link to either 
+       ~/.sylpheed-main' or '~/sylpheed-claws', depending on the option you 
+       choose. (On subsequent usage the symbolic link is deleted and replaced 
+       with a new symbolic link).
 
   HOW TO USE IT
+       Initial set-up
+       Enter the full paths to the executable, including the executable itself,
+       example:
   
-  Initial set-up
-  Enter the full paths to the executable, including the executable itself,
-  example:
-  
-       ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed --main-path=
-        /usr/bin/sylpheed
+               ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed 
+               --main-path=/usr/bin/sylpheed
         
-  After the initial set-up, use the following:
+       After the initial set-up, use the following:
   
-       ./sylpheed-switcher --claws     (to run sylpheed-claws)
-        ./sylpheed-switcher --main     (to run sylpheed main)
+               ./sylpheed-switcher --claws     (to run sylpheed-claws)
+               ./sylpheed-switcher --main      (to run sylpheed main)
         
-  Additionally you can append --debug to run in debug mode.
-  Use --help for more info.    
+       Additionally you can append --debug to run in debug mode.
+       Use --help for more info.       
  
-  This script uses the File::Path and Getopt::Long modules, if you don't already 
-  have them installed, you can find them at the CPAN search site 
-  <http://search.cpan.org>
+       This script uses the File::Path and Getopt::Long modules, if you don't
+       already have them installed, you can find them at the CPAN search site 
+       <http://search.cpan.org>
 
-  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
 
------------------------------------------------------------------------
 
 * update-po
 
   WHAT IT DOES
-  
-  This script is a message catalog translator's tool, it updates the .po 
-  files named on the command line.
+       This script is a message catalog translator's tool, it updates the .po 
+       files named on the command line.
 
   HOW TO USE IT
-
-  This script needs to be copied to and run from the 'po' directory.
+       This script needs to be copied to and run from the 'po' directory.
   
-       ./update-po lang.po lang2.po ...
+               ./update-po lang.po lang2.po ...
+
+       to update one or more <yourlang>.po files from the sourcecode files
+        named in POTFILES.in. The old .po file is save in a .po.old file.
+
+       For example, when you want to update fr.po, run ./update-po fr.po, 
+       then edit fr.po to update your translation.
+
+  Contact: Wilbert Berendsen <wilbert@oswf.org>
+
+--------------------------------------------------------------------------------
+
+Extra tools
+-----------
+
+* gif2xface.pl
+
+  WHAT IT DOES
+       This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
+       into an X-Face graphic suitable for inclusion into custom headers of
+       Sylpheed. An X-Face allows to quickly identify (or be identified as)
+       the sender of a mail message in a xface-capable MUA (like sylpheed).
+
+  HOW TO USE IT
+       After obtaining the desired image for your X-Face you should:
+         * scale it to 48x48 pixels (Image->Scale image on Gimp)
+         * down color depth to b/w (Image->Mode->Indexed selecting "Use
+           Black/White palette" and the desired dithering options (prior to
+           indexing doing Image->Colors->Threshold allows you to select the
+           b/w level if you don't want a dithered (dotty) image))
+         * save file as non-interlaced GIF
+       Then do:
 
-  to update one or more <yourlang>.po files from the sourcecode files
-  named in POTFILES.in. The old .po file is save in a .po.old file.
+               ./gif2xface < filename.gif > filename.xface
 
-  For example, when you want to update fr.po, run ./update-po fr.po, 
-  then edit fr.po to update your translation.
+       In filename.xface will be the X-Face header ready to use.
+       You can add a custom header in Sylpheed through Configuration->
+       Preferences per account, "Send" tab, check "Add user-defined header"
+       then "Edit..." if you want to add it via Sylpheed interface, or do
 
-  Author: Wilbert Berendsen <wilbert@oswf.org>
+               echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
 
------------------------------------------------------------------------
+       if you want to create the custom headers file yourself (Warning: this
+       method is valid only if you don't have any other custom header set or
+       they will be lost!).
 
+  Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
 
+--------------------------------------------------------------------------------