two new scripts in 'tools'
[claws.git] / tools / README
1 * eud2gc.py
2
3   WHAT IT DOES
4
5   This python-script is a quick hack to convert an Eudora (v.3?) addressbook
6   to vCard (GnomeCard) format.
7
8   HOW TO USE IT
9
10   You may do whatever you want with it! (Also regarding copying)
11
12   However, the script is intended to use like this:
13
14                         eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
15
16   Be careful not to overwrite your original GnomeCard.gcrd!
17   (But of course you might want to add the converted stuff to it)
18
19   Copyleft some time long ago (around 1999?) by Jeroen Versteeg
20   (j.m.versteeg@student.utwente.nl)
21
22 -----------------------------------------------------------------------
23
24 * filter_conv.pl
25
26   WHAT IT DOES
27
28   This perl script provides easy conversion of your filtering rules
29   form sylpheed's old filter system to the new filtering system used
30   in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs 
31   '~/.sylpheed/filteringrc'.
32   
33   Your old filter settings are preserved, if you want to go back to
34   the original filter system simply delete ~/.sylpheed/filteringrc
35
36   HOW TO USE IT
37
38   Issue the following command from the 'tools' directory:
39
40         perl filter_conv.pl
41
42   That's it, the new filtering system is now implemented with your
43   previous rules applied.
44
45   Any problems, contact Paul <claws@thewildbeast.co.uk>
46
47 -----------------------------------------------------------------------
48
49 * gif2xface.pl
50
51   WHAT IT DOES
52
53   This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
54   into an X-Face graphic suitable for inclusion into custom headers of
55   Sylpheed. An X-Face allows to quickly identify (or be identified as)
56   the sender of a mail message in a xface-capable MUA (like sylpheed).
57
58   HOW TO USE IT
59
60   After obtaining the desired image for your X-Face you should:
61     * scale it to 48x48 pixels (Image->Scale image on Gimp)
62     * down color depth to b/w (Image->Mode->Indexed selecting "Use
63       Black/White palette" and the desired dithering options (prior to
64       indexing doing Image->Colors->Threshold allows you to select the
65       b/w level if you don't want a dithered (dotty) image))
66     * save file as non-interlaced GIF
67   Then do:
68
69       ./gif2xface < filename.gif > filename.xface
70
71   In filename.xface will be the X-Face header ready to use.
72   You can add a custom header in Sylpheed through Configuration->
73   Preferences per account, "Send" tab, check "Add user-defined header"
74   then "Edit..." if you want to add it via Sylpheed interface, or do
75
76       echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
77
78   if you want to create the custom headers file yourself (Warning: this
79   method is valid only if you don't have any other custom header set or
80   they will be lost!).
81
82   Any problems, contact Ricardo Mones Lastra <mones@aic.uniovi.es>
83
84 -----------------------------------------------------------------------
85
86 * ldif-to-xml.py
87
88   WHAT IT DOES
89
90   This python script converts the netscape ldif format address book to
91   the sylpheed xml format.
92
93   HOW TO USE IT
94
95   Inside Netscape export your address book to a file.
96   From the command line, execute:
97
98       ./ldif-to-xml.py <path/filename>
99
100   In case of trouble, just invoke your python interpreter directly:
101
102       python ldif-to-xml.py <path/filename>
103
104   Either way a file called addressbook.xml will be generated in the current
105   directory. This xml file should be merged with or simply placed in the
106   $HOME/.sylpheed directory.
107
108   Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
109
110 -----------------------------------------------------------------------
111
112 * newscache_clean.pl
113
114   WHAT IT DOES AND WHY IT DOES IT
115
116   This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
117   the newscache becomes littered with old directories and files - when
118   you subscribe to a newsgroup a sub-directory gets created for it in
119   ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the 
120   group the sub-directory does not get deleted. Until this is done 
121   internally this script will take care of some tidying up.
122   
123   This script removes directory trees of nntp servers that you no longer
124   have an account for. Where an account exists it removes directories
125   and files of those groups to which you are no longer subscribed.
126
127   HOW TO USE IT
128
129   Issue the following command from the 'tools' directory:
130   
131         perl newscache_clean.pl
132         
133   This script uses the File::Path module, if you don't already have it
134   installed, you can find it at the CPAN search site <http://search.cpan.org>
135
136   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
137
138 -----------------------------------------------------------------------
139
140 * sylpheed-switcher
141
142   WHAT IT DOES
143   
144   This perl script is for users who like to move between the main
145   sylpheed branch and the claws branch. Because of some differences
146   between the stored options it is better IMO to use two separate
147   '.sylpheed' directory trees. Doing that manually could prove to
148   be tiresome, and so I've written this script to automate the task.
149
150   The first time you run this script you enter the full paths,
151   including the executable itself, to both the main version of
152   sylpheed and the claws version. This information is then stored
153   in a file in your $HOME directory called '.sylpheed-switcher'
154
155   During this initial set-up, your '~/.sylpheed' directory
156   is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
157   
158   When you run sylpheed via this script, your '~/.sylpheed' directory
159   is deleted and replaced with a symbolic link to either ~/.sylpheed-main'
160   or '~/sylpheed-claws', depending on the option you choose.
161   (On subsequent usage the symbolic link is deleted and replaced with
162   a new symbolic link).
163
164   HOW TO USE IT
165   
166   Initial set-up
167   Enter the full paths to the executable, including the executable itself,
168   example:
169   
170         ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed --main-path=
171         /usr/bin/sylpheed
172         
173   After the initial set-up, use the following:
174   
175         ./sylpheed-switcher --claws     (to run sylpheed-claws)
176         ./sylpheed-switcher --main      (to run sylpheed main)
177         
178   Additionally you can append --debug to run in debug mode.
179   Use --help for more info.     
180  
181   This script uses the File::Path and Getopt::Long modules, if you don't already 
182   have them installed, you can find them at the CPAN search site 
183   <http://search.cpan.org>
184
185   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
186
187 -----------------------------------------------------------------------
188
189