New --show-charset mode

[ypp-sc-tools.db-test.git] / pctb / README

diff --git a/pctb/README b/pctb/README
index c747534a1328c770cc373ae5d25de03308575eda..240ff7267400228cbb0916802eca123e862099f3 100644 (file)
--- a/pctb/README
+++ b/pctb/README
@@ -12,6 +12,8 @@ To run it, change to this directory, type `make', and then:
 While it is capturing the screenshots, do not move the mouse or use
 the keyboard.  Keyboard focus must stay in the YPP client window.
 
 While it is capturing the screenshots, do not move the mouse or use
 the keyboard.  Keyboard focus must stay in the YPP client window.
 

+You will probably need to turn off `Use antialiased font' in the YPP
+client.  This is in the Ye panel, Options, tab `General'.

 
 Command-line options
 --------------------
 
 Command-line options
 --------------------


@@ -28,8 +30,12 @@ Options to vary the processing:
   --screenshot-file F   Store or read screenshots in F rather than #pages#.pnm
   --window-id ID        Specified X window is the YPP client - do not search
   --edit-charset        Enable character set editing.  See README.dictionary.
   --screenshot-file F   Store or read screenshots in F rather than #pages#.pnm
   --window-id ID        Specified X window is the YPP client - do not search
   --edit-charset        Enable character set editing.  See README.dictionary.

+  --find-island         Find and print the ocean and island.  Suppresses OCR
+                         and output unless used with result processing option.
+  --test-servers        Set default servers to be the test servers, not
+                         the real live ones (doesn't affect explicit settings).

 
 

-Controlling what happens to the results:
+Controlling what happens to the results - only one at a time:

   --upload (default) Upload to the PCTB server
   --tsv              Print data as clean tab-separated-values file
   --raw-tsv          Dump the raw (not deduped, unsorted) OCR'd data
   --upload (default) Upload to the PCTB server
   --tsv              Print data as clean tab-separated-values file
   --raw-tsv          Dump the raw (not deduped, unsorted) OCR'd data


@@ -94,8 +100,8 @@ The program reads and writes the following files:
 
 These files are all in the current working directory.  There is not
 yet any feature to have them be somewhere else.  The helper programs
 
 These files are all in the current working directory.  There is not
 yet any feature to have them be somewhere else.  The helper programs

-  yppsc-ocr-resolver
-  yppsc-commod-processor
+  dictionary-manager
+  commod-results-processor

 must (currently) also be in the current directory.
 
 Future versions may have more helpers and more data files.
 must (currently) also be in the current directory.
 
 Future versions may have more helpers and more data files.


@@ -112,6 +118,7 @@ This program has quite a few dependencies:
  - pnm command line utilities for image manipulation   netpbm
  - X11 libraries, including dev files for building     libx11-dev
  - XTEST library, including dev files for building     libxtst-dev
  - pnm command line utilities for image manipulation   netpbm
  - X11 libraries, including dev files for building     libx11-dev
  - XTEST library, including dev files for building     libxtst-dev

+ - Perl-compatible regexp library, including dev files  libpcre3-dev

  - Tk interpreter /usr/bin/wish                                tk8.4
  - Perl module XML::Parser                             libxml-parser-perl
  - Perl module JSON::Parser                            libjson-perl
  - Tk interpreter /usr/bin/wish                                tk8.4
  - Perl module XML::Parser                             libxml-parser-perl
  - Perl module JSON::Parser                            libjson-perl