tools/README

   1 * calypso_import.pl
   2
   3   WHAT IT DOES
   4
   5   This perl script imports mbox files that are exported by Calypso.
   6   It recreates the folder structure by scanning the "X-CalypsoFolder"
   7   header and reincludes the attachments referenced in the
   8   "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
   9
  10   HOW TO USE IT
  11
  12   Export the Calypso mailbox by selecting "Save to archive" and check
  13   the "Save attachments" box.
  14   Edit the script to set following variables (at the top of the file):
  15     $mboxdir  : path to the exported mbox, e.g. 'Archive' or '.'
  16     $mboxfile : name of exported mbox, e.g. 'mail.txt'
  17     $outdir   : name of the MH folder to create, e.g. 'Calypso'
  18   Run the script using
  19     perl calypso_import.pl
  20   Finally, import that folder by either selecting "New mailbox" or
  21   moving it into your existing directory and recreate the folder
  22   structure manually (contentmenu from folderview).
  23
  24   Any questions, comments or problems, contact Thorsten Maerz <torte@netztorte.de>
  25
  26 -----------------------------------------------------------------------
  27
  28 * eud2gc.py
  29
  30   WHAT IT DOES
  31
  32   This python-script is a quick hack to convert an Eudora (v.3?) addressbook
  33   to vCard (GnomeCard) format.
  34
  35   HOW TO USE IT
  36
  37   You may do whatever you want with it! (Also regarding copying)
  38
  39   However, the script is intended to use like this:
  40
  41                         eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
  42
  43   Be careful not to overwrite your original GnomeCard.gcrd!
  44   (But of course you might want to add the converted stuff to it)
  45
  46   Copyleft some time long ago (around 1999?) by Jeroen Versteeg
  47   (j.m.versteeg@student.utwente.nl)
  48
  49 -----------------------------------------------------------------------
  50
  51 * filter_conv.pl
  52
  53   WHAT IT DOES
  54
  55   This perl script provides easy conversion of your filtering rules
  56   form sylpheed's old filter system to the new filtering system used
  57   in sylpheed-claws. It reads '~/.sylpheed/filterrc' and outputs
  58   '~/.sylpheed/matcherrc'.
  59
  60   HOW TO USE IT
  61
  62   Issue the following command from the 'tools' directory:
  63
  64         perl filter_conv.pl
  65
  66   That's it, the new filtering system is now implemented with your
  67   previous rules applied.
  68
  69   Any problems, contact Torsten Schoenfeld <kaffeetisch@web.de>
  70
  71 -----------------------------------------------------------------------
  72
  73 * gif2xface.pl
  74
  75   WHAT IT DOES
  76
  77   This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
  78   into an X-Face graphic suitable for inclusion into custom headers of
  79   Sylpheed. An X-Face allows to quickly identify (or be identified as)
  80   the sender of a mail message in a xface-capable MUA (like sylpheed).
  81
  82   HOW TO USE IT
  83
  84   After obtaining the desired image for your X-Face you should:
  85     * scale it to 48x48 pixels (Image->Scale image on Gimp)
  86     * down color depth to b/w (Image->Mode->Indexed selecting "Use
  87       Black/White palette" and the desired dithering options (prior to
  88       indexing doing Image->Colors->Threshold allows you to select the
  89       b/w level if you don't want a dithered (dotty) image))
  90     * save file as non-interlaced GIF
  91   Then do:
  92
  93       ./gif2xface < filename.gif > filename.xface
  94
  95   In filename.xface will be the X-Face header ready to use.
  96   You can add a custom header in Sylpheed through Configuration->
  97   Preferences per account, "Send" tab, check "Add user-defined header"
  98   then "Edit..." if you want to add it via Sylpheed interface, or do
  99
 100       echo "0:" `cat filename.xface` > ~/.sylpheed/customheaderrc
 101
 102   if you want to create the custom headers file yourself (Warning: this
 103   method is valid only if you don't have any other custom header set or
 104   they will be lost!).
 105
 106   Any problems, contact Ricardo Mones Lastra <mones@aic.uniovi.es>
 107
 108 -----------------------------------------------------------------------
 109
 110 * kmail2sylpheed.pl
 111
 112   WHAT IT DOES
 113
 114   This perl script will convert an exported Kmail addressbook into a
 115   Sylpheed addressbook.
 116
 117   HOW TO USE IT
 118
 119   (You must run sylpheed at least once before running this script.)
 120
 121   In Kmail's Addressbook choose '/File/Export List'. This will export
 122   your Kmail addressbook data to a *.csv file.
 123
 124   If Sylpheed is running, close it.
 125
 126   From the command line, execute the following:
 127
 128         perl kmail2sylpheed.pl --kmailfile=/path/to/addressbook.csv
 129
 130   Your Kmail addressbook data will now be contained in Sylpheed's
 131   addressbook, under the name 'Kmail Address Book'.
 132
 133   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
 134
 135 -----------------------------------------------------------------------
 136
 137 * ldif-to-xml.py
 138
 139   WHAT IT DOES
 140
 141   This python script converts the netscape ldif format address book to
 142   the sylpheed xml format.
 143
 144   HOW TO USE IT
 145
 146   Inside Netscape export your address book to a file.
 147   From the command line, execute:
 148
 149       ./ldif-to-xml.py <path/filename>
 150
 151   In case of trouble, just invoke your python interpreter directly:
 152
 153       python ldif-to-xml.py <path/filename>
 154
 155   Either way a file called addressbook.xml will be generated in the current
 156   directory. This xml file should be merged with or simply placed in the
 157   $HOME/.sylpheed directory.
 158
 159   Any problems, contact Rod Senra <rodrigo.senra@ic.unicamp.br>
 160
 161 -----------------------------------------------------------------------
 162
 163 * newscache_clean.pl
 164
 165   WHAT IT DOES AND WHY IT DOES IT
 166
 167   This perl script cleans up in '$HOME/.sylpheed/newscache'. Currently
 168   the newscache becomes littered with old directories and files - when
 169   you subscribe to a newsgroup a sub-directory gets created for it in
 170   ~/.sylpheed/newscache/[nntpserver], should you unsubscribe from the
 171   group the sub-directory does not get deleted. Until this is done
 172   internally this script will take care of some tidying up.
 173
 174   This script removes directory trees of nntp servers that you no longer
 175   have an account for. Where an account exists it removes directories
 176   and files of those groups to which you are no longer subscribed.
 177
 178   HOW TO USE IT
 179
 180   Issue the following command from the 'tools' directory:
 181
 182         perl newscache_clean.pl
 183
 184   This script uses the File::Path module, if you don't already have it
 185   installed, you can find it at the CPAN search site <http://search.cpan.org>
 186
 187   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
 188
 189 -----------------------------------------------------------------------
 190
 191 * sylpheed-switcher
 192
 193   WHAT IT DOES
 194
 195   This perl script is for users who like to move between the main
 196   sylpheed branch and the claws branch. Because of some differences
 197   between the stored options it is better IMO to use two separate
 198   '.sylpheed' directory trees. Doing that manually could prove to
 199   be tiresome, and so I've written this script to automate the task.
 200
 201   The first time you run this script you enter the full paths,
 202   including the executable itself, to both the main version of
 203   sylpheed and the claws version. This information is then stored
 204   in a file in your $HOME directory called '.sylpheed-switcher'
 205
 206   During this initial set-up, your '~/.sylpheed' directory
 207   is copied to '~/.sylpheed-main' and '~/.sylpheed-claws'.
 208
 209   When you run sylpheed via this script, your '~/.sylpheed' directory
 210   is deleted and replaced with a symbolic link to either ~/.sylpheed-main'
 211   or '~/sylpheed-claws', depending on the option you choose.
 212   (On subsequent usage the symbolic link is deleted and replaced with
 213   a new symbolic link).
 214
 215   HOW TO USE IT
 216
 217   Initial set-up
 218   Enter the full paths to the executable, including the executable itself,
 219   example:
 220
 221         ./sylpheed-switcher --claws-path=/usr/local/bin/sylpheed --main-path=
 222         /usr/bin/sylpheed
 223
 224   After the initial set-up, use the following:
 225
 226         ./sylpheed-switcher --claws     (to run sylpheed-claws)
 227         ./sylpheed-switcher --main      (to run sylpheed main)
 228
 229   Additionally you can append --debug to run in debug mode.
 230   Use --help for more info.
 231
 232   This script uses the File::Path and Getopt::Long modules, if you don't already
 233   have them installed, you can find them at the CPAN search site
 234   <http://search.cpan.org>
 235
 236   Any questions, comments or problems, contact Paul <claws@thewildbeast.co.uk>
 237
 238 -----------------------------------------------------------------------
 239
 240 * update-po
 241
 242   WHAT IT DOES
 243
 244   This script is a message catalog translator's tool, it updates the .po
 245   files named on the command line.
 246
 247   HOW TO USE IT
 248
 249   This script needs to be copied to and run from the 'po' directory.
 250
 251         ./update-po lang.po lang2.po ...
 252
 253   to update one or more <yourlang>.po files from the sourcecode files
 254   named in POTFILES.in. The old .po file is save in a .po.old file.
 255
 256   For example, when you want to update fr.po, run ./update-po fr.po,
 257   then edit fr.po to update your translation.
 258
 259   Author: Wilbert Berendsen <wilbert@oswf.org>
 260
 261 -----------------------------------------------------------------------
 262
 263