Merge ijackson@chiark:/home/ijackson/things/ypp-sc-tools.pctb-dict-test

[ypp-sc-tools.main.git] / pctb / README

diff --git a/pctb/README b/pctb/README
index 12612966d17304005f21794ee100dab017659475..9bb9867e917eba91c99a0c920459c5538ec62788 100644 (file)
--- a/pctb/README
+++ b/pctb/README
@@ -27,15 +27,32 @@ Options to vary the processing:
   --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
   --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-dictionary     Enable dictionary editing.  See README.dictionary.
+  --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
 
   --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
 -----------------------
 
 Files we use and update
 -----------------------


@@ -81,8 +98,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.


@@ -128,27 +145,24 @@ error messasge.  I'll then be able to understand what's wrong,
 hopefully.
 
 
 hopefully.
 
 

-Phoning home - privacy
-----------------------
+Privacy
+-------

 
 The main purpose of this program is to connect to the PCTB server and
 
 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
 
 
  - Ian Jackson