complete commit 61889fd9465da61b0db28d75860a91745b7a51d5
[claws.git] / tools / README
1
2 --------------------------------------------------------------------------------
3 Contents of the tools directory:
4 --------------------------------------------------------------------------------
5
6 Action scripts:
7   cm-reparent.pl                Fix thread parenting for two or more messages
8   cm-break.pl                   Remove thread parenting for one or more messages
9   ddg_search.pl                 Search DuckDuckGo for selected text
10   google_msgid.pl               Search groups.google.com for selected message-id
11   multiwebsearch.pl             Search any search engine for the selected text
12   textviewer.sh                 Attempt to view an attachment as plain text
13   uudec                         Decode and display uuencoded images
14   uuooffice                     Decode uuencoded attachments and open them with
15                                 OpenOffice
16
17 Addressbook conversion:
18   csv2addressbook.pl            Import Becky, Thunderbird, Kmail, Gmail and Fox
19                                 Mail address books
20   eud2gc.py                     Convert Eudora address book to Gnomecard
21   kmail2claws-mail.pl           Import a Kmail address book (KDE2)
22   kmail2claws-mail_v2.pl        Import a Kmail address book (KDE3)
23   mew2claws-mail.pl             Import a Mew address book
24   outlook2claws-mail.pl         Import an Outlook generated contact list
25   tb2claws-mail                 Import The Bat! address books
26   vcard2xml.py                  Import an Evolution vCard
27
28 Mailbox conversion:
29   calypso_convert.pl            Import mbox files with attachments from Calypso
30   convert_mbox.pl               Import mbox files
31   kmail-mailbox2claws-mail.pl   Convert a kmail mailbox to a Claws Mail mailbox
32   tbird2claws.py                Integrate a Thunderbird folder tree into Claws
33
34 Other tools:
35   acroread2claws-mail.pl        Send PDFs from Adobe Reader 7
36   claws-mail-compose-insert-files.pl
37                                 Insert files into a new Compose window
38   filter_conv_new.pl            Convert new-style Sylpheed filters to filtering
39   filter_conv.pl                Convert old-style Sylpheed filters to filtering
40   fix-date.sh                   Replace/Add a message's Date field
41   mairix.sh                     A wrapper to mairix, to enable global searches in
42                                 mail folders
43   nautilus2claws-mail.sh        Send files from Nautilus
44   popfile-link.sh               Open messages in POPFile control center to edit
45                                 their status
46   sylprint.pl                   Printing engine, explained in README.sylprint
47   textviewer.pl                 Display various attachments as text
48   thunderbird-filters-convertor.pl
49                                 Convert Thunderbird filtering rules
50
51 Extra tools:
52   gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
53   update-po                     Update the .po files named on the command line.
54
55 --------------------------------------------------------------------------------
56 Detailed Descriptions:
57 --------------------------------------------------------------------------------
58
59 Action scripts
60 --------------
61
62 * cm-reparent.pl
63   WORKS ON: selected messages (two or more)
64   COMMAND: cm-reparent.pl %F
65   Thread the selected messages based on date, old to new
66
67 * cm-break.pl
68   WORKS ON: selected messages (one or more)
69   COMMAND: cm-break.pl %F
70   Break thread references for the selected messages
71
72 * ddg_search.pl
73   WORKS ON: selection
74   COMMAND: |ddg_search.pl
75   Search duckduckgo.com for selected text using the default Claws Mail browser
76
77 * google_msgid.pl
78   WORKS ON: selection
79   COMMAND: |google_msgid.pl
80   Lookup selected message-id in google using mozilla. Edit the script to use
81   different browsers.
82
83 * multiwebsearch.pl
84   WORKS ON: selection
85   see further down for details
86
87 * textviewer.sh
88   WORKS ON: current message part
89   COMMAND: textviewer.sh %p |
90   Attempt to view an attachment as plain text
91
92 * uudec
93   WORKS ON: current message (or part of multipart message)
94   COMMAND: uudec %f&
95   Decode and display uuencoded images using uudecode.
96
97 * uuooffice
98   WORKS ON: current message (or part of multipart message)
99   COMMAND: uuooffice %f&
100   Decode uuencoded attachments and open them with OpenOffice
101
102 * More action examples can be found at the Claws Mail FAQ
103   http://www.claws-mail.org/faq/index.php/Actions
104
105 ** multiwebsearch.pl **
106
107   WHAT IT DOES
108         This is an Actions script that allows you to search
109         websites for the selected text. It uses the default
110         Claws Mail browser as configured through Claws Mail's 
111         GUI and specified in ~/.claws-mail/clawsrc, and a
112         configuration file called multiwebsearch.conf.
113         
114   CONFIGURATION
115         The configuration file takes the following format:
116         
117         ALIAS|URL PART|URL PART
118         
119         ALIAS is a user-defined name; the first URL PART is the
120         url before the search term; the second URL PART is
121         optional and contains the remaining part of the url which
122         comes after the search term. A sample configuration file
123         is included.
124         
125   HOW TO USE IT
126         Copy 'multiwebsearch.conf' to ~/.claws-mail/
127         
128         Configure an Action:
129         a) pre-configured website 
130            Command: multiwebsearch.pl --where="ddg" --what="%s"
131         b) dynamic
132            Command: multiwebsearch.pl --where="%u" --what="%s"
133            
134         In type a) "ddg" refers to one of the configured aliases,
135         this Action will always search the website referred to by
136         the alias "ddg".
137         
138         In type b) you will be presented with a dialog box into
139         which you type one of your configured aliases
140
141   
142   Contact: Paul Mangan <paul@claws-mail.org>
143 --------------------------------------------------------------------------------
144
145 Address book conversion
146 -----------------------
147
148 * csv2addressbook.pl
149
150   WHAT IT DOES
151         This perl script will import a Becky, Thunderbird, Kmail, Gmail and
152         Fox Mail address book.
153
154   HOW TO USE IT
155         (You must run claws-mail at least once before running this script.)
156
157         Becky >= 2.41
158         -------------
159         In Becky you need to do a CSV full export with titles of your
160         address book.
161
162         Run the script with the following options:
163
164         perl csv2addressbook.pl --type=becky --csv=/full/path/to/file.csv
165
166         Addtionally you can use the option '--name="My address book"', if
167         you don't use this option the new Claws address book will be
168         called 'Becky address book'.
169
170
171         Thunderbird >= 2.0.0.6
172         ----------------------
173         In Thunderbird you need to export your address book as 'comma
174         separated'.
175
176         Run the script with the following options:
177
178         perl csv2addressbook.pl --type=thunderbird --csv=/full/path/to/file.csv
179
180         Addtionally you can use the option '--name="My address book"', if
181         you don't use this option the new Claws address book will be
182         called 'Thunderbird address book'.
183
184         Kmail >= 1.9.7 / Kaddressbook >= 3.5.7
185         --------------------------------------
186         In Kaddressbook you need to export your address book as 'CSV List'.
187
188         Run the script with the following options:
189
190         perl csv2addressbook.pl --type=kmail --csv=/full/path/to/file.csv
191
192         Addtionally you can use the option '--name="My address book"', if
193         you don't use this option the new Claws address book will be
194         called 'Kmail address book'.
195
196         WARNING: Kmail/Kaddressbook has a bug whereby it exports badly
197         formatted CSV if the values are quoted.
198
199         Gmail
200         -----
201         In the Gmail web interface you need to export your address book
202         as Outlook CSV format.
203
204         Run the script with the following options:
205
206         perl csv2addressbook.pl --type=gmail --csv=/full/path/to/file.csv
207
208         Addtionally you can use the option '--name="My address book"', if
209         you don't use this option the new Claws address book will be
210         called 'gmail address book'.
211
212         Fox Mail
213         --------
214         Export your Fox Mail address book as CSV with all possible headers.
215
216         Run the script with the following options:
217
218         perl csv2addressbook.pl --type=foxmail --csv=/full/path/to/file.csv
219
220         Addtionally you can use the option '--name="My address book"', if
221         you don't use this option the new Claws address book will be
222         called 'foxmail address book'.
223
224         You can also run the script with '--help' to get a brief usage message.
225
226   Contact: Paul Mangan <paul@claws-mail.org>
227
228 * eud2gc.py
229
230   WHAT IT DOES
231         This python-script is a quick hack to convert an Eudora (v.3?)
232         addressbook to vCard (GnomeCard) format.
233
234   HOW TO USE IT
235         You may do whatever you want with it! (Also regarding copying)
236         However, the script is intended to use like this:
237
238                 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
239
240         Be careful not to overwrite your original GnomeCard.gcrd!
241         (But of course you might want to add the converted stuff to it)
242
243   Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
244
245 * kmail2claws-mail.pl
246
247   WHAT IT DOES
248         This perl script will convert an exported Kmail addressbook into a
249         Claws Mail addressbook. If your version of Kmail is 1.37 or
250         greater and/or your version of KAddressBook is 3.1beta1 or greater,
251         or this script mixes up your definitions and their related data, use
252         'kmail2claws-mail_v2.pl' instead.
253
254   HOW TO USE IT
255         (You must run claws-mail at least once before running this script.)
256
257         In Kmail's Address book choose '/File/Export List'. This will export
258         your Kmail address book data to a *.csv file.
259
260         If Claws Mail is running, close it.
261
262         From the command line, execute the following:
263  
264                 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
265
266         Your Kmail address book data will now be contained in Claws Mail'
267         address book, under the name 'Kmail Address Book'.
268
269   Contact: Paul Mangan <paul@claws-mail.org>
270     
271
272 * kmail2claws-mail_v2.pl
273
274   This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
275
276   WHAT IT DOES
277         This perl script will convert a Kmail address book that has been
278         exported in csv format into a Claws Mail address book.
279
280   HOW TO USE IT
281         (You must run claws-mail at least once before running this script.)
282   
283         Open Kmail's Addressbook, /File/Address Book
284         In Kmail's Addressbook choose '/File/Export/Export List...'. This 
285         will allow you to export your Kmail addressbook data to a *.csv file.
286
287         If Claws Mail is running, close it.
288
289         From the command line, execute the following:
290  
291                 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
292         
293         You can also use --help to see usage instructions.
294
295         Your Kmail addressbook data will now be contained in Claws Mail'
296         addressbook, under the name 'Kmail address book'.
297
298   Contact: Paul Mangan <paul@claws-mail.org>
299
300 * mew2claws-mail.pl
301
302   WHAT IT DOES
303         This perl script will convert a Mew address book into a Claws Mail
304         address book.
305
306   HOW TO USE IT
307         (You must run claws-mail at least once before running this script.)
308   
309         If Claws Mail is running, close it.
310
311         From the command line, execute the following:
312  
313                 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
314         
315         You can also use --help to see usage instructions.
316
317         Your Mew addressbook data will now be contained in Claws Mail's
318         addressbook, under the name 'Mew Address Book'.
319
320   Contact: Jérôme Lelong <jerome.lelong@gmail.com>
321
322 * outlook2claws-mail.pl
323
324   WHAT IT DOES
325         This perl script converts an Outlook generated contact list into a 
326         Claws Mail XML address book.
327
328   HOW TO USE IT
329         For text files:
330         --------------
331         You must export Outlook Express contact list as TXT file, choosing
332         only "Name" and "Address" fields to export.
333
334         You must exit Claws Mail before converting the contact list.
335
336         From the command line, execute the following:
337
338                 outlook2claws-mail.pl fullpathname
339
340         For csv files:
341         -------------
342         You must export Outlook contact list as CSV file, choosing ALL the
343         fields available for exporting.
344
345         You must exit Claws Mail before converting the contact list.
346
347         From the command line, execute the following:
348
349                 outlook2claws-mail.pl --csv fullpathname
350
351   LIMITATIONS
352         For text files only works with fields described above. If you have 
353         more complex examples send them to me, and I'll try to enhance the 
354         script.
355
356         For csv files you must export all fields (but only non empty fields
357         are added to the created Claws Mail address book) and the number
358         of fields expected is harcoded. Look for the $nboffields variable in
359         the script and change its value if you are sure you exported all
360         fields and script gives the 'unknown csv file format' error.
361
362   Contact: Ricardo Mones <ricardo@mones.org>
363
364
365 * tb2claws-mail
366
367   WHAT IT DOES
368         This perl script will convert an address book exported from The Bat! 
369         into a Claws Mail address book.
370
371   HOW TO USE IT
372         (You must run claws-mail at least once before running this script.)
373
374         If Claws Mail is running, close it.
375
376         Export The Bat! Address Book to CSV file format with all fields 
377         selected to YES and then start:
378
379                 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
380  
381         The Bat! addressbook data will now be contained in Claws Mail'
382         addressbook, under the name 'The Bat! Address Book'.
383
384   Contact: Urke MMI <urke@gmx.net>  
385
386
387 * vcard2xml.py
388
389   WHAT IT DOES
390         This python script will convert an Evolution vCard into a Claws Mail
391         address book.
392
393   HOW TO USE IT
394         (You must run claws-mail at least once before running this script.)
395
396         If Claws Mail is running, close it.
397         From the command line, execute the following:
398
399                 vcard2xml.py source_file [destination_file]
400  
401         When only <source_file> is specified it will overwrite (and
402         create a backup of) the existing addressbook. 
403         When both arguments are suplied it will create a new additional 
404         addressbook named as <destination_file>.
405         If the script encounters an error it will attempt to roll back
406         the changes and restore the original files.
407
408   Contact: Bogdan Sumanariu <bsumanariu@one5.ro> 
409
410 --------------------------------------------------------------------------------
411
412 Mailbox conversion
413 ------------------
414
415 * calypso_convert.pl
416
417   WHAT IT DOES
418         This perl script imports mbox files that are exported by Calypso.
419         It recreates the folder structure by scanning the "X-CalypsoFolder"
420         header and reincludes the attachments referenced in the
421         "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
422   
423   HOW TO USE IT
424         Export the Calypso mailbox by selecting "Save to archive" and check
425         the "Save attachments" box.
426         
427         Edit the script to set following variables (at the top of the file):
428            $mboxdir  : path to the exported mbox, e.g. 'Archive' or '.'
429            $mboxfile : name of exported mbox, e.g. 'mail.txt'
430            $outdir   : name of the MH folder to create, e.g. 'Calypso'
431            
432          Run the script using
433          
434                 perl calypso_convert.pl
435                 
436         Finally, import that folder by either selecting "New mailbox" or
437         moving it into your existing directory and recreate the folder
438         structure manually (contentmenu from folderview).
439
440   Contact: Thorsten Maerz <torte@netztorte.de>
441
442 * convert_mbox.pl
443
444   WHAT IT DOES
445         This perl script converts an mbox directory's contents into 
446         Claws Mail' MH format.
447   
448   HOW TO USE IT
449   
450         Run the script using:
451          
452                 perl convert_mbox.pl MBOX MH_DIR
453                 
454         Move the outputted MH_DIR and its contents into your Claws Mail
455         Mail folder; in Claws Mail right-click the top-level folder and
456         choose 'Rebuild folder tree' from the popup menu.
457
458   Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
459
460 * kmail-mailbox2claws-mail.pl
461
462   WHAT IT DOES
463         This perl script converts a kmail mailbox  into Claws Mail' mailbox.
464   
465   HOW TO USE IT
466   
467         Exit Claws Mail if running.
468         
469         Run the script using:
470          
471                 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
472                 
473         Start Claws Mail and right-click the toplevel mailbox, i.e
474         "Mailbox (MH)", and select 'Rebuild folder tree'.
475         You may also need to run '/File/Folder/Check for new messages
476         in all folders'
477         
478         Additional options:
479                 --debug         debug mode
480                 --dry-run       test mode, nothing is actually written
481                 --help          brief usage info
482         
483   Contact: Paul Mangan <paul@claws-mail.org>
484
485 * tbird2claws.py
486
487   WHAT IT DOES
488         This python script integrates a Thunderbird folder tree into 
489         Claws Mail.
490   
491   HOW TO USE IT
492   
493         The script receives two parameters from command-line:
494         <Thunderbird folder path> <Claws Mail folder path>
495
496         The best way to use it is to go to inside your Thunderbird
497         root mailfolder directory and invoke it as:
498
499                 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
500
501   Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
502
503 --------------------------------------------------------------------------------
504
505 Other tools
506 -----------
507
508 * acroread2claws-mail.pl
509
510   WHAT IT DOES
511         This perl script enables Adobe Reader 7 to send documents to
512         Claws Mail as attachments.
513
514   HOW TO USE IT
515         Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
516         Start up Adobe Reader 7 (acroread)
517         Go to /Edit/Preferences/SendMail
518         Select any email client except 'System Mail (mail)'
519         Enter the path to this script in the alternate location box  
520
521         You can then use 'File/Email' or the Email toolbar button to launch
522         claws-mail (if not already launched) and open a new compose window
523         with the PDF attached.
524   
525   Contact: Paul Mangan <paul@claws-mail.org>
526
527 * claws-mail-compose-insert-files.pl
528
529   WHAT IT DOES
530         This script enables inserting files into the message body of a new 
531         Claws Mail Compose window from the command line. Additionally To,
532         Cc, Bcc, Subject and files to attach to the message can be specified. 
533
534   HOW TO USE IT
535         claws-mail-compose-insert-files.pl [options]
536         Options:
537                 --help -h
538                 --to "Person One <mail@address.net>"
539                 --cc "Person One <mail@address.net>"
540                 --bcc "Person One <mail@address.net>"
541                 --subject "My subject"
542                 --attach FILE
543                 --insert FILE
544
545         For multiple recipients separate the addresses with ','
546         e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
547         --attach and --insert can be used multiple times
548   
549   Contact: Paul Mangan <paul@claws-mail.org>
550
551 * filter_conv_new.pl
552
553   WHAT IT DOES
554         This perl script provides easy conversion of your filtering rules from
555         sylpheed's new filter system (>= 0.9.99) to the filtering system used in
556         Claws Mail.
557         It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
558         writes '~/[CLAWS CONFIG DIR]/matcherrc'
559   
560   HOW TO USE IT
561         Issue the following command from the 'tools' directory:
562
563         perl filter_conv_new.pl
564
565         That's it, the claws' filtering system is now implemented with your
566         previous rules applied.
567
568   REQUIREMENTS
569         XML::SimpleObject
570
571   Contact: Paul Mangan <paul@claws-mail.org>
572   
573
574 * filter_conv.pl
575
576   WHAT IT DOES
577         This perl script provides easy conversion of your filtering rules
578         from sylpheed's old filter system (< 0.9.99) to the filtering system
579         used in Claws Mail.
580         It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
581   
582   HOW TO USE IT
583         Issue the following command from the 'tools' directory:
584
585         perl filter_conv.pl
586
587         That's it, the new filtering system is now implemented with your
588         previous rules applied.
589
590   Contact: Paul Mangan <paul@claws-mail.org>
591   
592
593 * fix_date.sh
594
595   WHAT IT DOES
596         Add a 'Date:' header to the selected email(s) when such header
597         is missing.  The correct date is guessed from other headers
598         that contain timestamp information (preferred: Fetchinfo
599         header if found) or from the file or system date as a
600         fallback. The order or preference for the date value
601         replacement can be changed by editing the script.
602         This script can be used to fix messages that show non
603         RFC-compliant Date headers as well.
604         X-Original-Date is always added too if not already existing
605         (if so, it's left untouched), to keep track of the original
606         value if any.
607         An existing Date: header is not overwritten unless you use the
608         --force switch.
609         Non RFC-compliant dates can be overwritten using the --rfc
610         switch. Use --strict to use strict RFC matching patterns for
611         date values in other headers.
612
613   HOW TO USE IT
614         First you have to create an action with the following command:
615
616         fix_date.sh %F
617
618         On main window's message list, select the messages to be fixed
619         and invoke the created action.
620
621   Contact: wwp <wwp@claws-mail.org>
622
623 * mairix.sh
624
625  WHAT IT DOES
626         It's a wrapper to mairix, a tool that makes indexed searches
627         and shows search results in a virtual folder. Maildir, MH and
628         mbox formats are supported, see:
629         http://www.rpcurnow.force9.co.uk/mairix/
630
631   HOW TO USE IT
632         mairix.sh
633         mairix.sh <mairix rcfile> [<mairix options>..]
634     
635     For instance:    
636     mairix.sh ~/.mairixrc s:word1,word2
637
638   Contact: wwp <wwp@claws-mail.org>
639
640
641 * nautilus2claws-mail.sh
642
643   WHAT IT DOES
644         This script will recursively attach a number of selected 
645         files/directories from Nautilus to a new blank e-mail.
646
647   HOW TO USE IT
648         Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x, 
649         and restart nautilus (killall -9 nautilus). You will now have 
650         a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
651         
652   Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
653
654
655 * popfile-link.sh
656
657  WHAT IT DOES
658         Open selected messages in POPFile control center to edit their
659         status. Requires that POPFile is running and that the messages
660         have been processed by it (X-POPFile-Link: header is expected).
661         POPFile control center opens with the web browser set in
662         Claws Mail prefs.
663
664   HOW TO USE IT
665         popfile-link.sh <filename> [<filename>..]
666     
667
668   Contact: wwp <wwp@claws-mail.org>
669
670
671 * textviewer.pl
672
673   WHAT IT DOES
674         This script tries to recognise an attachment by using the 'file'
675         command and/or the file extension and then uses the available
676         utilities to make an effort to display it as text.
677
678         $ textview.pl --list
679
680         will show available conversion, the top:
681
682           .awk          cat
683           .bin          strings
684           .bz2          bzip2 -d < %f | strings
685           .c            cat
686           .cc           cat
687           .csv          xlscat -L
688
689         If there are multiple alternatives available, they are listed in
690         the ordder they are tried, like for .xls:
691
692           .xls          xlscat -L
693           .xls          catdoc -x -dutf-8
694           .xls          wvText
695
696   HOW TO USE IT
697         Go to /Configuration/Message View/External Programs and enter the
698         path to the script in the "Command for 'Display as text'" box.
699         Now when you right-click an attachment and choose 'Display as text'
700         this script will be invoked.
701
702         xlscat comes with the perl module Spreadsheet::Read, which is a
703         wrapper module over several parsers and supports ods, sxc, csv, xls,
704         xlsx, and sq.  See https://metacpan.org/release/Spreadsheet-Read
705
706   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
707
708
709 * thunderbird-filters-convertor.pl
710
711   WHAT IT DOES
712         This perl script converts Thunderbird filtering rules into Claws Mail
713         filtering rules. It can be run several times, once for each filter
714         configuration file in Thunderbird.
715
716   HOW TO USE IT
717         The script takes 3 arguments:
718
719         --tbird-file=PATH TO FILE       The full path to the file to be converted
720         --mailbox-name=NAME             The name of the Claws Mail mailbox
721         --account-name=NAME             The name of the account to be used (optional)   
722
723         --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
724         that you want to convert, it must contain the full path to the file.
725         --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
726         if the top-level folder is 'Mailbox (MH)' then this option should be
727         'Mailbox'.
728         --account-name is optional, only needed if you are creating account-specific
729         rules. This is the name of your account in Claws Mail, which should
730         correspond to an account that you had in Thunderbird, e.g. the acount whose
731         rules you are converting.
732
733         This script presumes that your folder hierarchy in Claws Mail matches the
734         one that you had in Thunderbird. If you used the tbird2claws.py script to
735         convert your Thunderbird mailbox, then the folder hierarchy should match.
736
737         If the Claws Mail filtering configuration file (matcherrc) does not exist,
738         the script will create it; if it does exist, the newly converted rules will
739         be appended to it.
740
741   REQUIREMENTS
742         Getopt::Long
743         URI::Escape
744
745   Contact: Paul Mangan <paul@claws-mail.org>
746
747 --------------------------------------------------------------------------------
748
749 Extra tools
750 -----------
751
752 * gif2xface.pl
753
754   WHAT IT DOES
755         This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
756         into an X-Face graphic suitable for inclusion into custom headers of
757         Claws Mail. An X-Face allows to quickly identify (or be identified
758         as) the sender of a mail message in a xface-capable MUA (like Claws
759         Mail).
760
761   HOW TO USE IT
762         After obtaining the desired image for your X-Face you should:
763           * scale it to 48x48 pixels (Image->Scale image on Gimp)
764           * down color depth to b/w (Image->Mode->Indexed selecting "Use
765             Black/White palette" and the desired dithering options (prior to
766             indexing doing Image->Colors->Threshold allows you to select the
767             b/w level if you don't want a dithered (dotty) image))
768           * save file as non-interlaced GIF
769         Then do:
770
771                 ./gif2xface < filename.gif > filename.xface
772
773         In filename.xface will be the X-Face header ready to use.
774         You can add a custom header in Claws Mail through Configuration->
775         Preferences per account, "Send" tab, check "Add user-defined header"
776         then "Edit..." if you want to add it via the Claws Mail interface, or do
777
778                 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
779
780         if you want to create the custom headers file yourself (Warning: this
781         method is valid only if you don't have any other custom header set or
782         they will be lost!).
783
784   Contact: Ricardo Mones <ricardo@mones.org>
785
786
787 * update-po
788
789   WHAT IT DOES
790         This script is a message catalog translator's tool, it updates the .po 
791         files named on the command line.
792
793   HOW TO USE IT
794         This script needs to be copied to and run from the 'po' directory.
795   
796                 ./update-po lang.po lang2.po ...
797
798         to update one or more <yourlang>.po files from the sourcecode files
799          named in POTFILES.in. The old .po file is save in a .po.old file.
800
801         For example, when you want to update fr.po, run ./update-po fr.po, 
802         then edit fr.po to update your translation.
803
804   Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
805
806 --------------------------------------------------------------------------------
807 This file is Copyright 1999-2014 by the Claws Mail team.
808 See accompanying COPYING file for license details.
809 See each included script for copyright and license details.
810
811 * cm-reparent.pl
812
813   WHAT IT DOES
814         This script tries to fix thread parenting for two or more messages
815
816   HOW TO USE IT
817         Define an action as
818
819           Menu name:  Reparent (fix threading)
820           Command:    cm-reparent.pl %F
821
822         Then select from the message list all files that should be re-parented
823
824         Then invoke the action
825
826   MORE INFORMATION
827         $ perldoc cm-reparent.pl
828
829   REQUIREMENTS
830         Date::Parse
831         Getopt::Long
832
833   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
834
835 * cm-break.pl
836
837   WHAT IT DOES
838         This script tries to break thread parenting for one or more messages
839
840   HOW TO USE IT
841         Define an action as
842
843           Menu name:  Unthread (break threading)
844           Command:    cm-break.pl %F
845
846         Then select from the message list all files that should be un-threaded
847
848         Then invoke the action
849
850   MORE INFORMATION
851         $ perldoc cm-break.pl
852
853   REQUIREMENTS
854         Date::Parse
855         Getopt::Long
856
857   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>