add convert_mbox.pl script

[claws.git] / tools / README

diff --git a/tools/README b/tools/README
index 10b49a4d92751c88e61985aed6b0ea4b899898a6..42166f649c84e39f5f29e187518f8cbdfd7d1b9f 100644 (file)
--- a/tools/README
+++ b/tools/README
@@ -20,6 +20,7 @@ Addressbook conversion:
 
 Mailbox conversion:
   calypso_convert.pl            Import mbox files with attachments from Calypso
+  convert_mbox.pl              Import mbox files
 
 Other tools:
   filter_conv.pl                Convert old-style filters to new filtering
@@ -196,6 +197,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.
 
@@ -205,9 +208,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>
 
@@ -265,6 +286,24 @@ 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>
+
 --------------------------------------------------------------------------------
 
 Other tools