read top level mailbox name - presume nothing

[claws.git] / tools / README

diff --git a/tools/README b/tools/README
index 39d8414cfc2e17199149027d3e184bab47794429..449f56ecadf80f8ee59b5c5a0ace8aa607db8e4e 100644 (file)
--- a/tools/README
+++ b/tools/README
@@ -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
 
@@ -5,12 +27,15 @@
 
   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
 
@@ -21,6 +46,43 @@
 
 -----------------------------------------------------------------------
 
+* gif2xface.pl
+
+  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).
+
+  HOW TO USE IT
+
+  After obtaining the desired image for your X-Face you should:
+    * scale it to 48x48 pixels (Image->Scale image on Gimp)
+    * down color depth to b/w (Image->Mode->Indexed selecting "Use
+      Black/White palette" and the desired dithering options (prior to
+      indexing doing Image->Colors->Threshold allows you to select the
+      b/w level if you don't want a dithered (dotty) image))
+    * save file as non-interlaced GIF
+  Then do:
+
+      ./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->
+  Preferences per account, "Send" tab, check "Add user-defined header"
+  then "Edit..." if you want to add it via Sylpheed interface, or do
+
+      echo "0:" `cat filename.xface` > ~/.sylpheed/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
+  they will be lost!).
+
+  Any problems, contact Ricardo Mones Lastra <mones@aic.uniovi.es>
+
+-----------------------------------------------------------------------
+
 * ldif-to-xml.py
 
   WHAT IT DOES
@@ -47,3 +109,4 @@
 
 -----------------------------------------------------------------------
 
+