2005-03-11 [paul] 1.0.3cvs2.1
[claws.git] / tools / README
index 42166f649c84e39f5f29e187518f8cbdfd7d1b9f..d7b332bbc9092ec4d041f1794f39d1776d2dd1c8 100644 (file)
@@ -9,6 +9,7 @@ Action scripts:
   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:
@@ -17,14 +18,16 @@ 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
-  newscache_clean.pl            Clean up news directory
+  nautilus2sylpheed.sh         Send files from Nautilus
   OOo2sylpheed.pl               Send documents from OpenOffice.org
   sylpheed-switcher             Run either sylpheed or claws (separate configs)
   sylprint.pl                   Printing engine, explained in README.sylprint
@@ -32,7 +35,6 @@ Other tools:
 
 Extra tools:
   gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
-  launch_phoenix               Open URLs in Phoenix
 
 --------------------------------------------------------------------------------
 Detailed Descriptions:
@@ -71,6 +73,11 @@ Action scripts
   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/
 
@@ -254,6 +261,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
@@ -304,6 +335,32 @@ Mailbox conversion
 
   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
@@ -313,9 +370,9 @@ Other tools
 
   WHAT IT DOES
        This perl script provides easy conversion of your filtering rules
-       form sylpheed's old filter system to the new filtering system used
-       in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs 
-       '~/.sylpheed/matcherrc'.
+       form sylpheed's old filter system (pre version 0.9.99) to the new
+       filtering system used in sylpheed-claws.
+       It reads '~/.sylpheed/filterrc' and outputs '~/.sylpheed/matcherrc'.
   
   HOW TO USE IT
        Issue the following command from the 'tools' directory:
@@ -328,30 +385,18 @@ Other tools
   Contact: Paul Mangan <claws@thewildbeast.co.uk>
   
 
-* newscache_clean.pl
+* nautilus2sylpheed.sh
 
-  WHAT IT DOES AND WHY IT DOES IT
-       This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
-       the newscache becomes littered with old directories and files - when
-       you subscribe to a newsgroup a sub-directory gets created for it in
-       ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the 
-       group the sub-directory does not get deleted. Until this is done 
-       internally this script will take care of some tidying up.
-  
-       This script removes directory trees of nntp servers that you no longer
-       have an account for. Where an account exists it removes directories
-       and files of those groups to which you are no longer subscribed.
+  WHAT IT DOES
+       This script will recursively attach a number of selected 
+       files/directories from Nautilus to a new blank e-mail.
 
   HOW TO USE IT
-       Issue the following command from the 'tools' directory:
-  
-               perl newscache_clean.pl
-        
-       This script uses the File::Path module, if you don't already have it
-       installed, you can find it at the CPAN search site 
-       <http://search.cpan.org>
-
-  Contact: Paul Mangan <claws@thewildbeast.co.uk>
+       Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x, 
+       and restart nautilus (killall -9 nautilus). You will now have 
+       a right-click menu item: '/Scripts/nautilus2sylpheed.sh'
+       
+  Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
 
 
 * OOo2sylpheed.pl
@@ -361,16 +406,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>
 
@@ -478,20 +534,4 @@ Extra tools
 
   Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
 
-
-* launch_phoenix
-
-  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
-  
-  HOW TO USE IT  
-       In Common Preferences move to the 'Other' tab and enter the
-       following in the 'Web browser' box
-  
-       launch_phoenix '%s'
-  
-  Contact: Mohammed Sameer <Uniball@linux-egypt.org>
-
-
 --------------------------------------------------------------------------------