X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=pctb%2FREADME;h=c747534a1328c770cc373ae5d25de03308575eda;hb=6a3c0962283d32bc6e5f6c47c929baf37ddc642f;hp=0d83e3931428540292911fe1b4f6b4fa4807d125;hpb=2337ae5465a29659b44037dcbdaf6fa03eb46d84;p=ypp-sc-tools.web-live.git

diff --git a/pctb/README b/pctb/README
index 0d83e39..c747534 100644
--- a/pctb/README
+++ b/pctb/README
@@ -12,12 +12,6 @@ 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.
 
-*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.
-
 
 Command-line options
 --------------------
@@ -33,6 +27,7 @@ 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
+  --edit-charset        Enable character set editing.  See README.dictionary.
 
 Controlling what happens to the results:
   --upload (default) Upload to the PCTB server
@@ -41,6 +36,19 @@ Controlling what happens to the results:
   --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
 -----------------------
@@ -63,9 +71,9 @@ The program reads and writes the following files:
 
  * 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
@@ -81,7 +89,7 @@ The program reads and writes the following files:
 
  * <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
@@ -133,27 +141,24 @@ error messasge.  I'll then be able to understand what's wrong,
 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