pctb/README

   1 This tool can:
   2   - screenscrape the commodities trading screen
   3   - produce the results as a tab separated values file
   4   - **TODO** upload the results to PCTB
   5
   6 To run it, change to this directory, type `make', and then:
   7   ./ypp-commodities --tsv >commods.tsv
   8
   9 It may put up a window asking about characters it does not understand.
  10 It is important to get these inputs right or it may misrecognise
  11 things in future.  **TODO** write actual useful instructuions to cover the
  12 subtleties.  The results are stored in the file `charset-15.txt'.
  13
  14 If you need to report a bug, please be sure to remember the exact
  15 error message and circumstances.  Also, for recognition problems there
  16 will probably be a very useful screenshot file called `#pages#.pnm'.
  17 This is likely to be very large so don't just email it to me, but if
  18 you can put it up on a webpage for me to download that will help.
  19
  20 Options available:
  21
  22  Setting the operation mode:
  23    --find-window-only       Just check that we can find the YPP client window.
  24    --screenshot-only        Page through and take screenshots, do not OCR
  25    --analyse-only | --same  Process previously taken screenshots
  26    --everything (default)   Take screenshots and process them
  27
  28  Options to vary the processing:
  29    --single-page         One screenful, no paging - results will be incomplete
  30    --quiet               Suppress progress messages
  31    --screenshot-file F   Store or read screenshots in F rather than #pages#.pnm
  32    --window-id ID        Specified X window is the YPP client - do not search
  33
  34  Setting the output processing:
  35    --raw-tsv          Dump the raw not deduped unsorted OCR'd data
  36    --upload (default) Upload to the PCTB server
  37    --tsv              Print data as clean tab-separated-values file
  38    --best-prices      Print best buy and sell price for each commodity
  39    --arbitrage        Print arbitrage opportunityes
  40