break out char_start_define_text into a proc

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

diff --git a/pctb/README b/pctb/README
index 986338ad659dcd1c4669589149e9ec1ce1b0a771..e2452ddec32dd8a85a93f04a0390588c2e301ebf 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.
 
+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
 --------------------
@@ -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.
+  --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
@@ -44,9 +50,10 @@ Privacy options, which control conversations with the dictionary server:
 Please do not use options marked * with --upload.  See README.privacy.
 
 Options to override which servers we talk to:
-  --pctb-url HOST|URL    Talk to the PCTB server at HOST or URL.
-  --dict-submit-url URL  Submit dictionary entries with HTTP POST under URL.
-  --dict-update-url URL  Fetch updated master dictionary with rsync from URL.
+  --pctb-server HOST|URL  Talk to the PCTB server at HOST or URL.
+  --dict-submit-url URL   Submit dictionary entries with HTTP POST under URL.
+  --dict-update-from SRC  Fetch updated master dictionary with rsync from SRC.
+Or set the environment variables YPPSC_PCTB{_PCTB, _DICT_UPDATE, _DICT_SUBMIT}
 
 
 Files we use and update
@@ -93,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
-  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.