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
--------------------
--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
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
it. Don't try `display vid:#pages#.pnm' as this will consume
truly stupendous quantities of RAM - it wedged my laptop.
- * charset-15.txt
+ * #master-char*#.txt #local-char*#.txt
+ #master-pixmap#.txt #local-pixmap#.txt
- Character set dictionary. For the semantics of the contents of this
- file see README.charset. There is not currently any accurate
+ Character set and image dictionaries. For the semantics of the
+ char* files README.charset. There is not currently any accurate
documentation of this dictionary format.
- If you delete this file you'll have to re-enter a lot of glyph data
- (and probably get it wrong and make the program misrecognise
- things). If you want to undo any mistakes you may have made
- answering OCR questions you can safely revert this to the version
- I've supplied.
+ #master-*#.txt contain the centrally defined and approved data.
+ They are downloaded automatically from the SC PCTB server and
+ updated each run. You can safely delete this file, if everything
+ is online, if you want to fetch a fresh copy.
+
+ #local-*#.txt are a local copy of your submissions, so that they
+ will be used by your client pending approval by me. You can delete
+ this file if you think you may have made a mistake.
+
+ See README.privacy for details of the communications with the SC
+ server about the contents of these dictionaries.
* #commodmap#.tsv
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.
- 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