yarrg: with --find-window-only, print ocean and pirate parseably to stdout

[ypp-sc-tools.db-live.git] / yarrg / README

diff --git a/yarrg/README b/yarrg/README
index b542a1cca8e33e543853972df9f6845e05eb7ecd..526d466aaf541525b79339e3c39d5cb05102ac6d 100644 (file)
--- a/yarrg/README
+++ b/yarrg/README
@@ -48,12 +48,14 @@ Options to vary the processing:
   --test-servers        Set default servers to be the test servers, not
                          the real live ones (doesn't affect explicit settings).
 
   --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 - only one at a time:
-  --upload (default) Upload to the YARRG and PCTB servers
-  --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
+Controlling what happens to the results - one or more:
+  --upload (default)    Upload to both the YARRG and PCTB servers
+  --upload-pctb         Upload to the PCTB servers
+  --upload-yarrg        Upload to the YARRG servers
+  --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.
 
 Privacy options, which control conversations with the dictionary server:
   --dict-local-only  *  Do not talk to the server even to fetch new dictionary.


@@ -94,7 +96,7 @@ This program has quite a few dependencies:
 On other Linux distros the packages may have different names, but
 these should be roughly right for Debian and its derivatives.  You can
 install them with this rune:
 On other Linux distros the packages may have different names, but
 these should be roughly right for Debian and its derivatives.  You can
 install them with this rune:

-  sudo apt-get install build-essential libnetpbm10-dev netpbm libx11-dev libxtst-dev libpcre3-dev tk8.4 libxml-parser-perl libjson-perl
+  sudo apt-get install git-core build-essential libnetpbm10-dev netpbm libx11-dev libxtst-dev libpcre3-dev tk8.4 libxml-parser-perl libjson-perl

 
 
 The supplied helper programs
 
 
 The supplied helper programs


@@ -165,18 +167,20 @@ Master).
 
 
 This yarrg screenscraper and upload client was written entirely from
 
 
 This yarrg screenscraper and upload client was written entirely from

-scratch by me, Ian Jackson, with assistance from Stephen Early and
-Clare Boothby.  It is part of ypp-sc-tools, a set of third-party tools
-for assisting players of Yohoho Puzzle Pirates.
+scratch by me, Ian Jackson, with assistance from Clare Boothby,
+Stephen Early, and Naath.  It is part of ypp-sc-tools, a set of
+third-party tools for assisting players of Yohoho Puzzle Pirates.

 
 ypp-sc-tools and YARRG are
 Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
 Copyright (C) 2009 Clare Boothby
 Copyright (C) 2009 Steve Early
 
 ypp-sc-tools and YARRG are
 Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
 Copyright (C) 2009 Clare Boothby
 Copyright (C) 2009 Steve Early

+Copyright (C) 2009 Naath Cousins

 
 This program is free software: you can redistribute it and/or modify
 it under the terms of
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of

- (a) for the website code, the GNU Affero General Public License and
+ (a) for the website code including the route searcher,
+      the GNU Affero General Public License and

  (b) for the rest of the code, GNU General Public License
 as published by the Free Software Foundation, either version 3 of
 each applicable the License, or (at your option) any later version.
  (b) for the rest of the code, GNU General Public License
 as published by the Free Software Foundation, either version 3 of
 each applicable the License, or (at your option) any later version.