add script that eases the creation of *.po files
[claws.git] / tools / README
index 449f56ecadf80f8ee59b5c5a0ace8aa607db8e4e..2e7460bddf6a5521a96cbcf1af6ee6c2b371ad6c 100644 (file)
   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/filteringrc'.
+  '~/.sylpheed/matcherrc'.
   
-  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
 
   Issue the following command from the 'tools' directory:
 
 -----------------------------------------------------------------------
 
+* kmail2sylpheed.pl
+
+  WHAT IT DOES
+
+  This perl script will convert an exported Kmail addressbook into a
+  Sylpheed addressbook.
+
+  HOW TO USE IT
+
+  (You must run sylpheed at least once before running this script.)
+
+  In Kmail's Addressbook choose '/File/Export List'. This will export
+  your Kmail addressbook data to a *.csv file.
+
+  If Sylpheed is running, close it.
+
+  From the command line, execute the following:
+       perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
+
+  Your Kmail addressbook data will now be contained in Sylpheed's
+  addressbook, under the name 'Kmail Address Book'.
+
+  Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>  
+
+-----------------------------------------------------------------------
+
 * ldif-to-xml.py
 
   WHAT IT DOES
 
 -----------------------------------------------------------------------
 
+* 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>
+
+-----------------------------------------------------------------------
+
+* update-po
+
+  WHAT IT DOES
+  
+  This script is a message catalog translator's tool, it updates the .po 
+  files named on the command line.
+
+  HOW TO USE IT
+
+  This script needs to be copied to and run from the 'po' directory.
+  
+       ./update-po lang.po lang2.po ...
+
+  to update one or more <yourlang>.po files from the sourcecode files
+  named in POTFILES.in. The old .po file is save in a .po.old file.
+
+  For example, when you want to update fr.po, run ./update-po fr.po, 
+  then edit fr.po to update your translation.
+
+  Author: Wilbert Berendsen <wilbert@oswf.org>
+
+-----------------------------------------------------------------------
+