changes to the reply, forward, email/news buttons (popup menu now invoked with right...
[claws.git] / tools / README
index b7c93b77f9e3e6ac382a7c58a69b31aa9c2dc7a6..75c78b2c126d582dab03fb19d084d95c3b3ce999 100644 (file)
@@ -1,3 +1,25 @@
+* eud2gc.py
+
+  WHAT IT DOES
+
+  This python-script is a quick hack to convert an Eudora (v.3?) addressbook
+  to vCard (GnomeCard) format.
+
+  HOW TO USE IT
+
+  You may do whatever you want with it! (Also regarding copying)
+
+  However, the script is intended to use like this:
+
+                       eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
+
+  Be careful not to overwrite your original GnomeCard.gcrd!
+  (But of course you might want to add the converted stuff to it)
+
+  Copyleft some time long ago (around 1999?) by Jeroen Versteeg
+  (j.m.versteeg@student.utwente.nl)
+
+-----------------------------------------------------------------------
 
 * filter_conv.pl
 
 
   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 'filterrc' and outputs 'filteringrc'.
+  in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs 
+  '~/.sylpheed/filteringrc'.
+  
+  Your old filter settings are preserved, if you want to go back to
+  the original filter system simply delete ~/.sylpheed/filteringrc
 
   HOW TO USE IT
 
-  Move 'filter_conv.pl' to the $HOME/.sylpheed directory.
-  From the $HOME/.sylpheed directory, issue the command:
+  Issue the following command from the 'tools' directory:
 
         perl filter_conv.pl
 
   Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
 
 -----------------------------------------------------------------------
+
+* newscache_clean.pl
+
+  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.
+
+  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>
+
+  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
+
+-----------------------------------------------------------------------
+
+* 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).
+
+  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>
+
+  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
+
+-----------------------------------------------------------------------
+
+