2007-11-04 [paul] 3.0.2cvs115
[claws.git] / tools / README
index e385ba262e24462943d329370d5c8f1afbf7fc90..ea9387b2afb1dd77eca7975e3be7c6ce5d79c60f 100644 (file)
@@ -4,40 +4,47 @@ Contents of the tools directory:
 --------------------------------------------------------------------------------
 
 Action scripts:
-  freshmeat_search.pl          Search freshmeat.net for selected text
+  freshmeat_search.pl           Search freshmeat.net for selected text
   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
+  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
-  uuooffice                    Decode uuencoded attachments and open them with
-                               OpenOffice
+  uuooffice                     Decode uuencoded attachments and open them with
+                                OpenOffice
 
 Addressbook conversion:
   eud2gc.py                     Convert Eudora address book to Gnomecard
   kmail2claws-mail.pl           Import a Kmail address book (KDE2)
   kmail2claws-mail_v2.pl        Import a Kmail address book (KDE3)
+  mew2claws-mail.pl            Import a Mew address book
   outlook2claws-mail.pl         Import an Outlook generated contact list
   tb2claws-mail                 Import The Bat! address books
-  vcard2xml.py                 Import an Evolution vCard
+  vcard2xml.py                  Import an Evolution vCard
 
 Mailbox conversion:
   calypso_convert.pl            Import mbox files with attachments from Calypso
-  convert_mbox.pl              Import mbox files
-  kmail-mailbox2claws-mail.pl  Convert a kmail mailbox to a Claws Mail mailbox
-  tbird2claws.py               Integrate a Thunderbird folder tree into Claws
+  convert_mbox.pl               Import mbox files
+  kmail-mailbox2claws-mail.pl   Convert a kmail mailbox to a Claws Mail mailbox
+  tbird2claws.py                Integrate a Thunderbird folder tree into Claws
 
 Other tools:
-  acroread2claws-mail.pl       Send PDFs from Adobe Reader 7
-  filter_conv_new.pl           Convert new-style Sylpheed filters to filtering
+  acroread2claws-mail.pl        Send PDFs from Adobe Reader 7
+  claws-mail-compose-insert-files.pl
+                                Insert files into a new Compose window
+  filter_conv_new.pl            Convert new-style Sylpheed filters to filtering
   filter_conv.pl                Convert old-style Sylpheed filters to filtering
-  fix-date.sh                  Replace/Add a message's Date field
-  nautilus2claws-mail.sh       Send files from Nautilus
+  fix-date.sh                   Replace/Add a message's Date field
+  mairix.sh                     A wrapper to mairix, to enable global searches in
+                                mail folders
+  nautilus2claws-mail.sh        Send files from Nautilus
   OOo2claws-mail.pl             Send documents from OpenOffice.org
+  popfile-link.sh               Open messages in POPFile control center to edit
+                                their status
   sylprint.pl                   Printing engine, explained in README.sylprint
-  textviewer.pl                        Display various attachments as text
+  textviewer.pl                 Display various attachments as text
   thunderbird-filters-convertor.pl
-                               Convert Thunderbird filtering rules
+                                Convert Thunderbird filtering rules
 
 Extra tools:
   gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
@@ -203,6 +210,27 @@ Address book conversion
 
   Contact: Paul Mangan <paul@claws-mail.org>
 
+* mew2claws-mail.pl
+
+  WHAT IT DOES
+       This perl script will convert a Mew address book into a Claws Mail
+       address book.
+
+  HOW TO USE IT
+       (You must run claws-mail at least once before running this script.)
+  
+       If Claws Mail is running, close it.
+
+       From the command line, execute the following:
+               perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
+       
+       You can also use --help to see usage instructions.
+
+       Your Mew addressbook data will now be contained in Claws Mail's
+       addressbook, under the name 'Mew Address Book'.
+
+  Contact: Jérôme Lelong <jerome.lelong@gmail.com>
 
 * outlook2claws-mail.pl
 
@@ -367,7 +395,7 @@ Mailbox conversion
        
   Contact: Paul Mangan <paul@claws-mail.org>
 
-* tbird2syl.py
+* tbird2claws.py
 
   WHAT IT DOES
        This python script integrates a Thunderbird folder tree into 
@@ -381,7 +409,7 @@ Mailbox conversion
        The best way to use it is to go to inside your Thunderbird
        root mailfolder directory and invoke it as:
 
-               <path>\python2.4 <path>\tbird2syl.py . <path to Claws Mail>\Mail
+               <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
 
   Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
 
@@ -409,6 +437,29 @@ Other tools
   
   Contact: Paul Mangan <paul@claws-mail.org>
 
+* claws-mail-compose-insert-files.pl
+
+  WHAT IT DOES
+       This script enables inserting files into the message body of a new 
+       Claws Mail Compose window from the command line. Additionally To,
+       Cc, Bcc, Subject and files to attach to the message can be specified. 
+
+  HOW TO USE IT
+       claws-mail-compose-insert-files.pl [options]
+       Options:
+               --help -h
+               --to "Person One <mail@address.net>"
+               --cc "Person One <mail@address.net>"
+                       --bcc "Person One <mail@address.net>"
+               --subject "My subject"
+               --attach FILE
+               --insert FILE
+
+       For multiple recipients separate the addresses with ','
+       e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
+       --attach and --insert can be used multiple times
+  
+  Contact: Paul Mangan <paul@claws-mail.org>
 
 * filter_conv_new.pl
 
@@ -467,6 +518,24 @@ Other tools
   Contact: wwp <wwp@claws-mail.org>
 
 
+* mairix.sh
+
+ WHAT IT DOES
+       It's a wrapper to mairix, a tool that makes indexed searches
+       and shows search results in a virtual folder. Maildir, MH and
+       mbox formats are supported, see:
+       http://www.rpcurnow.force9.co.uk/mairix/
+
+  HOW TO USE IT
+       mairix.sh
+       mairix.sh <mairix rcfile> [<mairix options>..]
+    
+    For instance:    
+    mairix.sh ~/.mairixrc s:word1,word2
+
+  Contact: wwp <wwp@claws-mail.org>
+
+
 * nautilus2claws-mail.sh
 
   WHAT IT DOES
@@ -519,6 +588,22 @@ Other tools
   Contact: Paul Mangan <paul@claws-mail.org>
 
 
+* popfile-link.sh
+
+ WHAT IT DOES
+       Open selected messages in POPFile control center to edit their
+       status. Requires that POPFile is running and that the messages
+       have been processed by it (X-POPFile-Link: header is expected).
+       POPFile control center opens with the web browser set in
+       Claws Mail prefs.
+
+  HOW TO USE IT
+       popfile-link.sh <filename> [<filename>..]
+    
+
+  Contact: wwp <wwp@claws-mail.org>
+
+
 * textviewer.pl
 
   WHAT IT DOES
@@ -596,8 +681,8 @@ Extra tools
        This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
        into an X-Face graphic suitable for inclusion into custom headers of
        Claws Mail. An X-Face allows to quickly identify (or be identified
-       as) the sender of a mail message in a xface-capable MUA (like sylpheed
-       -claws).
+       as) the sender of a mail message in a xface-capable MUA (like Claws
+       Mail).
 
   HOW TO USE IT
        After obtaining the desired image for your X-Face you should: