add script to send pdfs as attachments from Adobe Reader 7
[claws.git] / tools / README
index 10b49a4d92751c88e61985aed6b0ea4b899898a6..4b2e5fdba704abd1f69d6ad72d3fe5d679c2a606 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,13 +18,17 @@ 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:
+  acroread2sylpheed.pl         Send PDFs from Adobe Reader 7
   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
@@ -31,7 +36,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:
@@ -70,6 +74,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/
 
@@ -196,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.
 
@@ -205,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>
 
@@ -233,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
@@ -265,18 +318,82 @@ 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
 -----------
 
+* acroread2sylpheed.pl
+
+  WHAT IT DOES
+       This perl script enables Adobe Reader 7 to send documents to sylpheed
+       as attachments.
+
+  HOW TO USE IT
+       Make sure that the script is executable (chmod +x acroread2sylpheed.pl)
+       Start up Adobe Reader 7 (acroread)
+       Go to /Edit/Preferences/SendMail
+       Select any email client except 'System Mail (mail)'
+       Enter the path to this script in the alternate location box  
+
+       You can then use 'File/Email' or the Email toolbar button to launch
+       sylpheed (if not already launched) and open a new compose window with
+       the PDF attached.
+  
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
+
+
 * filter_conv.pl
 
   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:
@@ -289,30 +406,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
@@ -322,16 +427,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>
 
@@ -439,20 +555,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>
-
-
 --------------------------------------------------------------------------------