complete commit 61889fd9465da61b0db28d75860a91745b7a51d5
[claws.git] / tools / README
index 1d2bc57d6bf9bdf6c29574860e3f0f91fea092cc..f89e398ccfec3df06bb7ec00d15f404582e9a795 100644 (file)
@@ -4,9 +4,10 @@ Contents of the tools directory:
 --------------------------------------------------------------------------------
 
 Action scripts:
-  freshmeat_search.pl           Search freshmeat.net for selected text
+  cm-reparent.pl                Fix thread parenting for two or more messages
+  cm-break.pl                   Remove thread parenting for one or more messages
+  ddg_search.pl                 Search DuckDuckGo for selected text
   google_msgid.pl               Search groups.google.com for selected message-id
-  google_search.pl              Search google.com for selected text
   multiwebsearch.pl             Search any search engine for the selected text
   textviewer.sh                 Attempt to view an attachment as plain text
   uudec                         Decode and display uuencoded images
@@ -40,7 +41,6 @@ Other tools:
   mairix.sh                     A wrapper to mairix, to enable global searches in
                                 mail folders
   nautilus2claws-mail.sh        Send files from Nautilus
-  OOo2claws-mail.pl             Send documents from OpenOffice.org
   popfile-link.sh               Open messages in POPFile control center to edit
                                 their status
   sylprint.pl                   Printing engine, explained in README.sylprint
@@ -59,17 +59,27 @@ Detailed Descriptions:
 Action scripts
 --------------
 
+* 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
+
+* ddg_search.pl
+  WORKS ON: selection
+  COMMAND: |ddg_search.pl
+  Search duckduckgo.com for selected text using the default Claws Mail browser
+
 * google_msgid.pl
   WORKS ON: selection
   COMMAND: |google_msgid.pl
   Lookup selected message-id in google using mozilla. Edit the script to use
   different browsers.
 
-* google_search.pl
-  WORKS ON: selection
-  COMMAND: |google_search.pl
-  Search google.com for selected text using the default Claws Mail browser
-
 * multiwebsearch.pl
   WORKS ON: selection
   see further down for details
@@ -117,13 +127,13 @@ Action scripts
        
        Configure an Action:
        a) pre-configured website 
-          Command: multiwebsearch.pl --where="google" --what="%s"
+          Command: multiwebsearch.pl --where="ddg" --what="%s"
        b) dynamic
           Command: multiwebsearch.pl --where="%u" --what="%s"
           
-       In type a) "google" refers to one of the configured aliases,
+       In type a) "ddg" refers to one of the configured aliases,
        this Action will always search the website referred to by
-       the alias "google".
+       the alias "ddg".
        
        In type b) you will be presented with a dialog box into
        which you type one of your configured aliases
@@ -580,29 +590,35 @@ 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 value
+       replacement 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.
 
- 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
+       First you have to create an action with the following command:
+
        fix_date.sh %F
 
-  Contact: wwp <wwp@claws-mail.org>
+       On main window's message list, select the messages to be fixed
+       and invoke the created action.
 
+  Contact: wwp <wwp@claws-mail.org>
 
 * mairix.sh
 
@@ -636,44 +652,6 @@ Other tools
   Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
 
 
-* OOo2claws-mail.pl
-
-  WHAT IT DOES
-       This perl script enables OpenOffice.org to send documents to
-       Claws Mail as attachments.
-
-  HOW TO USE IT
-    OpenOffice.org Version 2.0
-    ----------------------------
-       This script is not needed for OOo version 2, which can work
-       directly with Claws Mail.
-       Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
-       in the box.
-
-    OpenOffice.org Version 1.1.0
-    ----------------------------
-       Start up OpenOffice.org.
-       Go to 'Tools/Options/OpenOffice.org/External Programs'
-       Select either ''Mozilla 1.x (Option 1)', or 
-       'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
-       Enter the path to OOo2claws-mail.pl in the 'Path' box
-       or select it by clicking on the '...' button.
-    
-       You can then use 'File/Send/Document as email' to launch
-       claws-mail (if not already launched) and open a new compose
-       window with the document attached.
-
-    OpenOffice.org Version 1.0
-    --------------------------
-       Start up OpenOffice.org.
-       Go to 'Tools/Options/OpenOffice.org/External Programs'
-       Enter the path to OOo2claws-mail.pl in the 'Program' box
-       or select it by clicking on the '...' button.
-
-
-  Contact: Paul Mangan <paul@claws-mail.org>
-
-
 * popfile-link.sh
 
  WHAT IT DOES
@@ -695,18 +673,25 @@ 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
-       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
+       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
@@ -714,7 +699,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>
 
 
@@ -819,3 +807,51 @@ Extra tools
 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>