detect loops across several messages
[claws.git] / tools / README
index ba14dd160ddbe7e5b3c9808e5ac1124e4e04107a..bf066f9c6e369304a57b3e95296e147bd86a00e7 100644 (file)
@@ -1,3 +1,87 @@
+
+Contents of the tools directory:
+-----------------------------------------------------------------------
+
+Action scripts:
+  gpg-sign-syl                  Clear-sign current selection
+  google_msgid.pl               Lookup selected message-id in google
+  uudec                         Decode and display uuencoded images
+
+Addressbook conversion:
+  eud2gc.py                     Convert Eudora addressbook to Gnomecard
+  kmail2sylpheed.pl             Import a Kmail addressbook
+  kmail2sylpheed_v2.pl          Import an exported Kmail addressbook csv file
+  outlook2sylpheed.pl           Import an Outlook generated contact list
+  tb2sylpheed                   Import The Bat! address books
+
+Mailbox conversion:
+  calypso_convert.pl            Import mbox files with attachments from Calypso
+
+Other tools:
+  gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
+  OOo2sylpheed.pl               Send documents from OpenOffice.org
+  sylprint.pl                   Printing engine, explained in README.sylprint
+
+Sylpheed specific tools:
+  filter_conv.pl                Convert old-style filters to new filtering
+  newscache_clean.pl            Clean up news directory
+  sylpheed-switcher             Run either sylpheed or claws (separate configs)
+  update-po                     Update the .po files named on the command line.
+
+
+Detailed Descriptions:
+-----------------------------------------------------------------------
+
+Action scripts:
+
+* gpg-sign-syl
+  WORKS ON: selection, whole message
+  COMMAND: |gpg-sign-syl|
+  Clear-sign current selection using gpg.
+
+* 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.
+
+* uudec
+  WORKS ON: current message (or part of multipart message)
+  COMMAND: uudec %f&
+  Decode and display uuencoded images using uudecode.
+
+* More action examples can be found at
+  http://melvin.hadasht.free.fr/home/sylpheed/actions/
+
+-----------------------------------------------------------------------
+
+* calypso_convert.pl
+
+  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.
+  
+  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).
+
+  Any questions, comments or problems, contact Thorsten Maerz <torte@netztorte.de>
+
+-----------------------------------------------------------------------
+
 * eud2gc.py
 
   WHAT IT DOES
   That's it, the new filtering system is now implemented with your
   previous rules applied.
 
-  Any problems, contact Paul <claws@thewildbeast.co.uk>
+  Any problems, contact Torsten Schoenfeld <kaffeetisch@web.de>
 
 -----------------------------------------------------------------------
 
 
 -----------------------------------------------------------------------
 
-* ldif-to-xml.py
+* kmail2sylpheed.pl
 
   WHAT IT DOES
 
-  This python script converts the netscape ldif format address book to
-  the sylpheed xml 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
 
-  Inside Netscape export your address book to a file.
-  From the command line, execute:
+  (You must run sylpheed at least once before running this script.)
 
-      ./ldif-to-xml.py <path/filename>
+  In Kmail's Addressbook choose '/File/Export List'. This will export
+  your Kmail addressbook data to a *.csv file.
 
-  In case of trouble, just invoke your python interpreter directly:
+  If Sylpheed is running, close it.
 
-      python ldif-to-xml.py <path/filename>
+  From the command line, execute the following:
+       perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
 
-  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.
+  Your Kmail addressbook data will now be contained in Sylpheed's
+  addressbook, under the name 'Kmail Address Book'.
 
-  Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
+  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
+
+-----------------------------------------------------------------------
+
+* kmail2sylpheed_v2.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 addressbook that has been
+  exported in csv format into a Sylpheed addressbook.
+
+  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.
+
+  If Sylpheed is running, close it.
+
+  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.
+
+  Your Kmail addressbook data will now be contained in Sylpheed's
+  addressbook, under the name 'Kmail address book'.
+
+  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
 
 -----------------------------------------------------------------------
 
 
 -----------------------------------------------------------------------
 
+* OOo2sylpheed.pl
+
+  WHAT IT DOES
+  
+  This perl script enables OpenOffice.org to send documents to sylpheed
+  as attachments.
+
+  HOW TO USE IT
+  
+  Edit line 29 of the script so that it contains the correct path:
+  exec "/usr/local/bin/sylpheed --attach $ARGV";
+  
+  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.
+
+  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 version 1.0
+  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
+
+-----------------------------------------------------------------------
+
+* outlook2sylpheed.pl
+
+  WHAT IT DOES
+  
+  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.
+
+  You must exit Sylpheed before converting the contact list.
+
+  From the command line, execute the following:
+
+       outlook2sylpheed.pl fullpathname
+
+  BUGS
+
+  Only works with fields described above. If you have more complex
+  examples send them to me, and I'll try to enhance the script.
+
+  Any questions, comments or problems, contact 
+  Ricardo Mones Lastra <mones@aic.uniovi.es>
+
+-----------------------------------------------------------------------
+
 * sylpheed-switcher
 
   WHAT IT DOES
 
 -----------------------------------------------------------------------
 
+* tb2sylpheed
+
+  WHAT IT DOES
+  
+  This perl script will convert an addressbook exported from The Bat! into 
+  a Sylpheed addressbook.
+
+  HOW TO USE IT
+
+  (You must run sylpheed at least once before running this script.)
+
+  If Sylpheed is running, close it.
+
+  Export The Bat! Address Book to CSV file format with all fields 
+  selected to YES and then start:
+
+  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 Urke MMI <urke@gmx.net>  
+
+-----------------------------------------------------------------------
+* update-po
+
+  WHAT IT DOES
+  
+  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.
+  
+       ./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.
+
+  Author: Wilbert Berendsen <wilbert@oswf.org>
+
+-----------------------------------------------------------------------
+