sync with 0.9.11cvs17 HEAD
[claws.git] / tools / README
index 4d2beb854fe46e58105823e660498e2262160b43..be61a1508e60ab993c4f03f5c73f1c31159d56c1 100644 (file)
@@ -8,6 +8,8 @@ Action scripts:
   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:
@@ -16,9 +18,12 @@ Addressbook conversion:
   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
@@ -30,7 +35,7 @@ Other tools:
 
 Extra tools:
   gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
-  launch_phoenix               Open URLs in Phoenix
+  launch_firebird              Open URLs in mozilla-firebird
 
 --------------------------------------------------------------------------------
 Detailed Descriptions:
@@ -60,14 +65,61 @@ Action scripts
   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
+
+  
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
 --------------------------------------------------------------------------------
 
 Address book conversion
@@ -153,6 +205,8 @@ Address book conversion
        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.
 
@@ -162,9 +216,27 @@ Address book conversion
 
                outlook2sylpheed.pl fullpathname
 
+       For csv files:
+       -------------
+       You must export Outlook contact list as CSV file, choosing ALL the
+       fields available for exporting.
+
+       You must exit Sylpheed before converting the contact list.
+
+       From the command line, execute the following:
+
+               outlook2sylpheed.pl --csv fullpathname
+
   LIMITATIONS
-       Only works with fields described above. If you have more complex
-       examples send them to me, and I'll try to enhance the script.
+       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.
+
+       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.
 
   Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
 
@@ -190,6 +262,30 @@ Address book conversion
 
   Contact: Urke MMI <urke@gmx.net>  
 
+
+* vcard2xml.py
+
+  WHAT IT DOES
+       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.)
+
+       If Sylpheed is running, close it.
+       From the command line, execute the following:
+
+               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.
+
+  Contact: Bogdan Sumanariu <bsumanariu@one5.ro> 
+
 --------------------------------------------------------------------------------
 
 Mailbox conversion
@@ -222,6 +318,50 @@ Mailbox conversion
 
   Contact: Thorsten Maerz <torte@netztorte.de>
 
+* convert_mbox.pl
+
+  WHAT IT DOES
+       This perl script converts an mbox directory's contents into 
+       Sylpheed's MH format.
+  
+  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>
+
+* maildir2sylpheed.pl
+
+  WHAT IT DOES
+       This perl script converts a mailbox in maildir format into
+       Sylpheed's MH format.
+  
+  HOW TO USE IT
+  
+       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
@@ -279,16 +419,27 @@ Other tools
        as attachments.
 
   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 version 1.0
+       Tested with OpenOffice.org versions 1.0, 1.1.0
   
   Contact: Paul Mangan <claws@thewildbeast.co.uk>
 
@@ -397,17 +548,17 @@ Extra tools
   Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
 
 
-* launch_phoenix
+* launch_firebird
 
   WHAT IT DOES
-       Check for a running phoenix process and and open a new tab with a 
-       given URL, or execute phoenix with that URL
+       Check for a running mozilla-firebird process and and open a new tab 
+       with a given URL, or execute mozilla-firebird with that URL
   
   HOW TO USE IT  
        In Common Preferences move to the 'Other' tab and enter the
        following in the 'Web browser' box
   
-       launch_phoenix '%s'
+       launch_firebird '%s'
   
   Contact: Mohammed Sameer <Uniball@linux-egypt.org>