2006-08-25 [mones] 2.4.0cvs88
[claws.git] / tools / README
index be61a1508e60ab993c4f03f5c73f1c31159d56c1..02d59916d807dcbea0159bd2b83f6873c1f1dbb8 100644 (file)
@@ -5,7 +5,6 @@ Contents of the tools directory:
 
 Action scripts:
   freshmeat_search.pl          Search freshmeat.net for selected text
-  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
@@ -24,18 +23,19 @@ 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
+  tbird2syl.py                 Integrate a Thunderbird folder tree into Claws
 
 Other tools:
-  filter_conv.pl                Convert old-style filters to new filtering
-  newscache_clean.pl            Clean up news directory
+  acroread2sylpheed.pl         Send PDFs from Adobe Reader 7
+  filter_conv_new.pl           Convert new-style Sylpheed filters to filtering
+  filter_conv.pl                Convert old-style Sylpheed filters to filtering
+  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
   update-po                     Update the .po files named on the command line.
 
 Extra tools:
   gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
-  launch_firebird              Open URLs in mozilla-firebird
 
 --------------------------------------------------------------------------------
 Detailed Descriptions:
@@ -47,7 +47,7 @@ Action scripts
 * freshmeat_search.pl
   WORKS ON: selection
   COMMAND: |freshmeat_search.pl
-  Search freshmeat.net for selected text using the default Sylpheed browser
+  Search freshmeat.net for selected text using the default Sylpheed-Claws browser
 
 * google_msgid.pl
   WORKS ON: selection
@@ -58,12 +58,7 @@ Action scripts
 * 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.
+  Search google.com for selected text using the default Sylpheed-Claws browser
 
 * multiwebsearch.pl
   WORKS ON: selection
@@ -87,9 +82,9 @@ Action scripts
   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.
+       Sylpheed-Claws browser as configured through Sylpheed
+       -Claws' GUI and specified in ~/.sylpheed-claws/sylpheedrc,
+       and a configuration file called multiwebsearch.conf.
        
   CONFIGURATION
        The configuration file takes the following format:
@@ -103,7 +98,7 @@ Action scripts
        is included.
        
   HOW TO USE IT
-       Copy 'multiwebsearch.conf' to ~/.sylpheed/
+       Copy 'multiwebsearch.conf' to ~/.sylpheed-claws/
        
        Configure an Action:
        a) pre-configured website 
@@ -146,24 +141,24 @@ Address book conversion
 
   WHAT IT DOES
        This perl script will convert an exported Kmail addressbook into a
-       Sylpheed addressbook. If your version of Kmail is 1.37 or greater
-       and/or your version of KAddressBook is 3.1beta1 or greater, or
-       this script mixes up your definitions and their related data, use
+       Sylpheed-Claws addressbook. If your version of Kmail is 1.37 or
+       greater and/or your version of KAddressBook is 3.1beta1 or greater,
+       or this script mixes up your definitions and their related data, use
        'kmail2sylpheed_v2.pl' instead.
 
   HOW TO USE IT
-       (You must run sylpheed at least once before running this script.)
+       (You must run sylpheed-claws at least once before running this script.)
 
        In Kmail's Address book choose '/File/Export List'. This will export
        your Kmail address book data to a *.csv file.
 
-       If Sylpheed is running, close it.
+       If Sylpheed-Claws is running, close it.
 
        From the command line, execute the following:
  
                perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
 
-       Your Kmail address book data will now be contained in Sylpheed's
+       Your Kmail address book data will now be contained in Sylpheed-Claws'
        address book, under the name 'Kmail Address Book'.
 
   Contact: Paul Mangan <claws@thewildbeast.co.uk>
@@ -175,16 +170,16 @@ Address book conversion
 
   WHAT IT DOES
        This perl script will convert a Kmail address book that has been
-       exported in csv format into a Sylpheed address book.
+       exported in csv format into a Sylpheed-Claws address book.
 
   HOW TO USE IT
-       (You must run sylpheed at least once before running this script.)
+       (You must run sylpheed-claws at least once before running this script.)
   
        Open Kmail's Addressbook, /File/Address Book
        In Kmail's Addressbook choose '/File/Export/Export List...'. This 
        will allow you to export your Kmail addressbook data to a *.csv file.
 
-       If Sylpheed is running, close it.
+       If Sylpheed-Claws is running, close it.
 
        From the command line, execute the following:
  
@@ -192,7 +187,7 @@ Address book conversion
        
        You can also use --help to see usage instructions.
 
-       Your Kmail addressbook data will now be contained in Sylpheed's
+       Your Kmail addressbook data will now be contained in Sylpheed-Claws'
        addressbook, under the name 'Kmail address book'.
 
   Contact: Paul Mangan <claws@thewildbeast.co.uk>  
@@ -202,7 +197,7 @@ Address book conversion
 
   WHAT IT DOES
        This perl script converts an Outlook generated contact list into a 
-       Sylpheed XML address book.
+       Sylpheed-Claws XML address book.
 
   HOW TO USE IT
        For text files:
@@ -210,7 +205,7 @@ Address book conversion
        You must export Outlook Express contact list as TXT file, choosing
        only "Name" and "Address" fields to export.
 
-       You must exit Sylpheed before converting the contact list.
+       You must exit Sylpheed-Claws before converting the contact list.
 
        From the command line, execute the following:
 
@@ -221,7 +216,7 @@ Address book conversion
        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.
+       You must exit Sylpheed-Claws before converting the contact list.
 
        From the command line, execute the following:
 
@@ -233,8 +228,8 @@ Address book conversion
        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
+       are added to the created Sylpheed-Claws 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.
 
@@ -245,19 +240,19 @@ Address book conversion
 
   WHAT IT DOES
        This perl script will convert an address book exported from The Bat! 
-       into a Sylpheed address book.
+       into a Sylpheed-Claws address book.
 
   HOW TO USE IT
-       (You must run sylpheed at least once before running this script.)
+       (You must run sylpheed-claws at least once before running this script.)
 
-       If Sylpheed is running, close it.
+       If Sylpheed-Claws is running, close it.
 
        Export The Bat! Address Book to CSV file format with all fields 
        selected to YES and then start:
 
                tb2sylpheed --tbfile=/full/path/to/thebat/addressbook.csv
  
-       The Bat! addressbook data will now be contained in Sylpheed's
+       The Bat! addressbook data will now be contained in Sylpheed-Claws'
        addressbook, under the name 'The Bat! Address Book'.
 
   Contact: Urke MMI <urke@gmx.net>  
@@ -266,13 +261,13 @@ Address book conversion
 * vcard2xml.py
 
   WHAT IT DOES
-       This python script will convert an Evolution vCard into a Sylpheed
+       This python script will convert an Evolution vCard into a Sylpheed-Claws
        address book.
 
   HOW TO USE IT
-       (You must run sylpheed at least once before running this script.)
+       (You must run sylpheed-claws at least once before running this script.)
 
-       If Sylpheed is running, close it.
+       If Sylpheed-Claws is running, close it.
        From the command line, execute the following:
 
                vcard2xml.py source_file [destination_file]
@@ -322,7 +317,7 @@ Mailbox conversion
 
   WHAT IT DOES
        This perl script converts an mbox directory's contents into 
-       Sylpheed's MH format.
+       Sylpheed-Claws' MH format.
   
   HOW TO USE IT
   
@@ -330,9 +325,9 @@ Mailbox conversion
         
                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.   
+       Move the outputted MH_DIR and its contents into your Sylpheed-Claws
+       Mail folder; in Sylpheed-Claws right-click the top-level folder and
+       choose 'Rebuild folder tree' from the popup menu.
 
   Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
 
@@ -340,17 +335,17 @@ Mailbox conversion
 
   WHAT IT DOES
        This perl script converts a mailbox in maildir format into
-       Sylpheed's MH format.
+       Sylpheed-Claws' MH format.
   
   HOW TO USE IT
   
-       Exit Sylpheed if running.
+       Exit Sylpheed-Claws if running.
        
        Run the script using:
         
                perl maildir2sylpheed.pl --kmaildir=mail_folder_name
                
-       Start Sylpheed and right-click the toplevel mailbox, i.e
+       Start Sylpheed-Claws 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'
@@ -362,18 +357,80 @@ Mailbox conversion
                --help          brief usage info
        
   Contact: Paul Mangan <claws@thewildbeast.co.uk>
+
+* tbird2syl.py
+
+  WHAT IT DOES
+       This python script integrates a Thunderbird folder tree into 
+        Sylpheed-Claws.
+  
+  HOW TO USE IT
+  
+       The script receives two parameters from command-line:
+       <Thunderbird folder path> <Sylpheed folder path>
+
+       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 sylpheed>\Mail
+
+  Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
+
 --------------------------------------------------------------------------------
 
 Other tools
 -----------
 
+* acroread2sylpheed.pl
+
+  WHAT IT DOES
+       This perl script enables Adobe Reader 7 to send documents to
+       Sylpheed-Claws 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-claws (if not already launched) and open a new compose window
+       with the PDF attached.
+  
+  Contact: Paul Mangan <claws@thewildbeast.co.uk>
+
+
+* filter_conv_new.pl
+
+  WHAT IT DOES
+       This perl script provides easy conversion of your filtering rules from
+       sylpheed's new filter system (>= 0.9.99) to the filtering system used in
+       sylpheed-claws. (Disabled rules are ignored)
+       It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
+       writes '~/[CLAWS CONFIG DIR]/matcherrc'
+  
+  HOW TO USE IT
+       Issue the following command from the 'tools' directory:
+
+        perl filter_conv_new.pl
+
+       That's it, the claws' filtering system is now implemented with your
+       previous rules applied.
+
+  REQUIREMENTS
+       XML::SimpleObject
+
+  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'.
+       from sylpheed's old filter system (< 0.9.99) to the filtering system
+       used in sylpheed-claws.
+       It reads '~/.sylpheed/filterrc' and writes '~/.sylpheed-claws/matcherrc'
   
   HOW TO USE IT
        Issue the following command from the 'tools' directory:
@@ -386,45 +443,33 @@ 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
 
   WHAT IT DOES
-       This perl script enables OpenOffice.org to send documents to sylpheed
-       as attachments.
+       This perl script enables OpenOffice.org to send documents to
+       Sylpheed-Claws 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 2.0
+    ----------------------------
+       This script is not needed for OOo version 2, which can work
+       directly with Sylpheed-Claws.
+       Go to 'Tools/Options/Internet/E-mail' and enter 'sylpheed-claws'
+       in the box.
 
     OpenOffice.org Version 1.1.0
     ----------------------------
@@ -435,57 +480,17 @@ Other tools
        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 versions 1.0, 1.1.0
-  
-  Contact: Paul Mangan <claws@thewildbeast.co.uk>
-
+       You can then use 'File/Send/Document as email' to launch
+       sylpheed-claws (if not already launched) and open a new compose
+       window with the document attached.
 
-* sylpheed-switcher
-
-  WHAT IT DOES
-       This perl script is for users who like to move between the main
-       sylpheed branch and the claws branch. Because of some differences
-       between the stored options it is better IMO to use two separate
-       '.sylpheed' directory trees. Doing that manually could prove to
-       be tiresome, and so I've written this script to automate the task.
-
-       The first time you run this script you enter the full paths,
-       including the executable itself, to both the main version of
-       sylpheed and the claws version. This information is then stored
-       in a file in your $HOME directory called '.sylpheed-switcher'
-
-       During this initial set-up, your '~/.sylpheed' directory
-       is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
-  
-       When you run sylpheed via this script, your '~/.sylpheed' directory
-       is deleted and replaced with a symbolic link to either 
-       ~/.sylpheed-main' or '~/sylpheed-claws', depending on the option you 
-       choose. (On subsequent usage the symbolic link is deleted and replaced 
-       with a new symbolic link).
+    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.
 
-  HOW TO USE IT
-       Initial set-up
-       Enter the full paths to the executable, including the executable itself,
-       example:
-  
-               ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed 
-               --main-path=/usr/bin/sylpheed
-        
-       After the initial set-up, use the following:
-  
-               ./sylpheed-switcher --claws     (to run sylpheed-claws)
-               ./sylpheed-switcher --main      (to run sylpheed main)
-        
-       Additionally you can append --debug to run in debug mode.
-       Use --help for more info.       
-       This script uses the File::Path and Getopt::Long modules, if you don't
-       already have them installed, you can find them at the CPAN search site 
-       <http://search.cpan.org>
 
   Contact: Paul Mangan <claws@thewildbeast.co.uk>
 
@@ -519,8 +524,9 @@ Extra tools
   WHAT IT DOES
        This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
        into an X-Face graphic suitable for inclusion into custom headers of
-       Sylpheed. An X-Face allows to quickly identify (or be identified as)
-       the sender of a mail message in a xface-capable MUA (like sylpheed).
+       Sylpheed-Claws. 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).
 
   HOW TO USE IT
        After obtaining the desired image for your X-Face you should:
@@ -535,11 +541,11 @@ Extra tools
                ./gif2xface < filename.gif > filename.xface
 
        In filename.xface will be the X-Face header ready to use.
-       You can add a custom header in Sylpheed through Configuration->
+       You can add a custom header in Sylpheed-Claws through Configuration->
        Preferences per account, "Send" tab, check "Add user-defined header"
-       then "Edit..." if you want to add it via Sylpheed interface, or do
+       then "Edit..." if you want to add it via Sylpheed -Claws interface, or do
 
-               echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
+               echo "0:" `cat filename.xface` > ~/.sylpheed-claws/customheaderrc
 
        if you want to create the custom headers file yourself (Warning: this
        method is valid only if you don't have any other custom header set or
@@ -547,20 +553,4 @@ Extra tools
 
   Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
 
-
-* launch_firebird
-
-  WHAT IT DOES
-       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_firebird '%s'
-  
-  Contact: Mohammed Sameer <Uniball@linux-egypt.org>
-
-
 --------------------------------------------------------------------------------