X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=pctb%2FREADME;h=986338ad659dcd1c4669589149e9ec1ce1b0a771;hb=cde017ed6b76840ce2ae1aa5fc740a6e06352f92;hp=12612966d17304005f21794ee100dab017659475;hpb=27ae0b4c6d571104f553d5bf863998fd478feb45;p=ypp-sc-tools.main.git diff --git a/pctb/README b/pctb/README index 1261296..986338a 100644 --- a/pctb/README +++ b/pctb/README @@ -27,7 +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-dictionary Enable dictionary editing. See README.dictionary. + --edit-charset Enable character set editing. See README.dictionary. Controlling what happens to the results: --upload (default) Upload to the PCTB server @@ -36,6 +36,18 @@ 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-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. + Files we use and update ----------------------- @@ -128,27 +140,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