While it is capturing the screenshots, do not move the mouse or use
the keyboard. Keyboard focus must stay in the YPP client window.
-*IMPORTANT*
-It may put up a window asking about characters it does not understand.
-It is important to get these inputs right or your client may
-misrecognise text in future. You *must* read the documentation in
-README.charset before answering these questions.
-
+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
--------------------
--quiet Suppress progress messages
--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
--best-prices Print best buy and sell price for each commodity
--arbitrage Print arbitrage opportunities
+Privacy options, which control conversations with the dictionary server:
+ --dict-local-only * Do not talk to the server even to fetch new dictionary.
+ --dict-read-only * Only fetch new dictionary, do not submit new entries.
+ --dict-anon Don't quote pirate name if submitting entries.
+ --dict-submit Submit entries quoting my pirate name. (default)
+Please do not use options marked * with --upload. See README.privacy.
+
+Options to override which servers we talk to:
+ --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
-----------------------
* charset-15.txt
- Character set database. For the semantics of the contents of this
+ Character set dictionary. For the semantics of the contents of this
file see README.charset. There is not currently any accurate
- documentation of this database format.
+ 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
* <file>.new
- When any of these tools overwrite one of the persistent database
+ When any of these tools overwrite one of the persistent dictionary
files, they temporarily write to <file>.new.
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.
hopefully.
-Phoning home - privacy
-----------------------
+Privacy
+-------
The main purpose of this program is to connect to the PCTB server and
-upload data. The program does not currently phone home at all in
-modes other than --upload, and when it does it connects to the
-PCTB server not to a system of mine.
+upload data. It will do that if you run it with --upload.
-However, there are some improvements which I may introduce in the
-future which may change this. I am considering:
+This program will also, by default, talk to the dictionary server I
+have set up: to download updated image dictionaries, and to upload new
+dictionary entries which you create with the PCTB client dictionary
+GUI. This feature is mentioned in and controllable in the GUI itself,
+so it won't happen without you knowing about it.
- * Having the ocr character resolver talk to a server run by me
- to look for missing glpyhs, and/or upload those glyphs back
- to that server so that they can be shared.
+The uploads will by default mention your ocean and pirate name; if you
+don't want that, pass the --dict-anon option, or untick the box in the
+GUI.
- * Having the upload client upload a copy of the data to a server run
- by me, when run in --upload mode.
+See README.privacy for full details.
-If I do do this these new functions may be enabled by default, but it
-will be possible to turn them off, or direct them to different
-servers, with command-line options, and they will be documented here.
- Ian Jackson
~yarrgweb / ypp-sc-tools.main.git / blobdiff