Improve synchronous action exit code (fixes long delay after action exit on RH9
[claws.git] / tools / README
index 10c1f3fa55ad7613062f5a246fcd4aa3ea7d1ce1..42f5307df10138c5da1e2e5024b7a3e00d0bc668 100644 (file)
@@ -8,6 +8,7 @@ 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
   uudec                         Decode and display uuencoded images
 
 Addressbook conversion:
@@ -19,6 +20,8 @@ Addressbook conversion:
 
 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 +33,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:
@@ -39,10 +42,10 @@ Detailed Descriptions:
 Action scripts
 --------------
 
-* gpg-sign-syl
-  WORKS ON: selection, whole message
-  COMMAND: |gpg-sign-syl|
-  Clear-sign current selection using gpg.
+* 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
@@ -50,6 +53,20 @@ Action scripts
   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&
@@ -58,6 +75,44 @@ Action scripts
 * 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
@@ -143,6 +198,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.
 
@@ -152,9 +209,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>
 
@@ -212,6 +287,45 @@ 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.
+       
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
 --------------------------------------------------------------------------------
 
 Other tools
@@ -387,17 +501,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>