Update script and doc from web's tools dir
[claws.git] / tools / README
index 7222bdbcc5187a4e2062c5a524423d1d9227f727..c6310b5506063c53692da17027afc784c316b6c1 100644 (file)
@@ -4,6 +4,8 @@ Contents of the tools directory:
 --------------------------------------------------------------------------------
 
 Action scripts:
+  cm-reparent.pl                Fix thread parenting for two or more messages
+  cm-break.pl                   Remove thread parenting for one or more messages
   freshmeat_search.pl           Search freshmeat.net for selected text
   google_msgid.pl               Search groups.google.com for selected message-id
   google_search.pl              Search google.com for selected text
@@ -59,10 +61,15 @@ Detailed Descriptions:
 Action scripts
 --------------
 
-* freshmeat_search.pl
-  WORKS ON: selection
-  COMMAND: |freshmeat_search.pl
-  Search freshmeat.net for selected text using the default Claws Mail browser
+* cm-reparent.pl
+  WORKS ON: selected messages (two or more)
+  COMMAND: cm-reparent.pl %F
+  Thread the selected messages based on date, old to new
+
+* cm-break.pl
+  WORKS ON: selected messages (one or more)
+  COMMAND: cm-break.pl %F
+  Break thread references for the selected messages
 
 * google_msgid.pl
   WORKS ON: selection
@@ -585,29 +592,33 @@ Other tools
   Contact: Paul Mangan <paul@claws-mail.org>
   
 
-* fix-date.sh
+* fix_date.sh
 
- WHAT IT DOES
-       Add a 'Date:' header to the selected email(s) when such header is 
-       missing. The correct date is guessed from other headers that contain 
-       timestamp information (preferred: Fetchinfo header if found) or from 
-       the file or system date as a fallback. The order or preference for the
-       date valuereplacement can be changed by editing the script.
-       This script can be used to fix messages that show non RFC-compliant
-       Date headers as well.
-       X-Original-Date is always added too if not already existing (if so,
-       it's left untouched), to keep track of the original value if any.
-       An existing Date: header is not overwritten unless you use the --force
-       switch.
-       Non RFC-compliant dates can be overwritten using the --rfc switch. Use
-       --strict to use strict RFC matching patterns for date values in other
-       headers.
-       
-  HOW TO USE IT
-       fix_date.sh %F
+  Add a 'Date:' header to the selected email(s) when such header is
+  missing.  The correct date is guessed from other headers that
+  contain timestamp information (preferred: Fetchinfo header if found)
+  or from the file or system date as a fallback. The order or
+  preference for the date value replacement can be changed by editing
+  the script.
 
-  Contact: wwp <wwp@claws-mail.org>
+  This script can be used to fix messages that show non RFC-compliant
+  Date headers as well.
 
+  X-Original-Date is always added too if not already existing (if so,
+  it's left untouched), to keep track of the original value if any.
+
+  An existing Date: header is not overwritten unless you use the
+  --force switch.
+
+  Non RFC-compliant dates can be overwritten using the --rfc switch.
+  Use --strict to use strict RFC matching patterns for date values in
+  other headers.
+
+  WORKS ON: selected message(s)
+
+  COMMAND: fix_date.sh %F
+
+  CONTACT: wwp <wwp@claws-mail.org>
 
 * mairix.sh
 
@@ -699,19 +710,26 @@ Other tools
 
   WHAT IT DOES
        This script tries to recognise an attachment by using the 'file'
-       command and/or the file extension and then uses the available Linux
-       utilities to make an effort to display it as text. For example
-               .doc                    antiword -w 72
-               .txt, .diff, .c, .h,
-                 .ic. .ec, .cc, .sh,
-                 .sed, .awk            cat
-               .html                   txt2htm or text2html
-               .xls, .sxc, .csv        xlscat -L
-               .rtf                    rtf2text
-               .pdf                    pdf2text %f -
-               .odt                    ooo2txt
-               .pl, .pm                perltidy -st -se or  cat
-               .bz2                    bzip2 -d < %f | strings
+       command and/or the file extension and then uses the available
+       utilities to make an effort to display it as text.
+
+       $ textview.pl --list
+
+       will show available conversion, the top:
+
+         .awk          cat
+         .bin          strings
+         .bz2          bzip2 -d < %f | strings
+         .c            cat
+         .cc           cat
+         .csv          xlscat -L
+
+       If there are multiple alternatives available, they are listed in
+       the ordder they are tried, like for .xls:
+
+         .xls          xlscat -L
+         .xls          catdoc -x -dutf-8
+         .xls          wvText
 
   HOW TO USE IT
        Go to /Configuration/Message View/External Programs and enter the
@@ -719,7 +737,10 @@ Other tools
        Now when you right-click an attachment and choose 'Display as text'
        this script will be invoked.
 
-       
+       xlscat comes with the perl module Spreadsheet::Read, which is a
+       wrapper module over several parsers and supports ods, sxc, csv, xls,
+       xlsx, and sq.  See https://metacpan.org/release/Spreadsheet-Read
+
   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
 
 
@@ -821,3 +842,54 @@ Extra tools
   Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
 
 --------------------------------------------------------------------------------
+This file is Copyright 1999-2014 by the Claws Mail team.
+See accompanying COPYING file for license details.
+See each included script for copyright and license details.
+
+* cm-reparent.pl
+
+  WHAT IT DOES
+       This script tries to fix thread parenting for two or more messages
+
+  HOW TO USE IT
+       Define an action as
+
+         Menu name:  Reparent (fix threading)
+         Command:    cm-reparent.pl %F
+
+       Then select from the message list all files that should be re-parented
+
+       Then invoke the action
+
+  MORE INFORMATION
+       $ perldoc cm-reparent.pl
+
+  REQUIREMENTS
+       Date::Parse
+       Getopt::Long
+
+  Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
+
+* cm-break.pl
+
+  WHAT IT DOES
+       This script tries to break thread parenting for one or more messages
+
+  HOW TO USE IT
+       Define an action as
+
+         Menu name:  Unthread (break threading)
+         Command:    cm-break.pl %F
+
+       Then select from the message list all files that should be un-threaded
+
+       Then invoke the action
+
+  MORE INFORMATION
+       $ perldoc cm-break.pl
+
+  REQUIREMENTS
+       Date::Parse
+       Getopt::Long
+
+  Contact: H.Merijn Brand <h.m.brand@xs4all.nl>