X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.main.git;a=blobdiff_plain;f=yarrg%2FREADME.where-vessels;h=6fb21c279e6ca7c09026b80cf2e1b6b3cc04b4fa;hp=190b7b3cabdba527296b29ec8f5b452b3c179060;hb=7d38bda05d74767d4c8ab7127f72e3704350bf28;hpb=a2368f803f45f33f403e122428b9b493ca458986 diff --git a/yarrg/README.where-vessels b/yarrg/README.where-vessels index 190b7b3..6fb21c2 100644 --- a/yarrg/README.where-vessels +++ b/yarrg/README.where-vessels @@ -17,7 +17,7 @@ USAGE: In where-vessels, click "Acquire" -You will probably want to create a "vessel-notes" file to get the best +You may well want to create a "vessel-notes" file to get the best use out of where-vessels, see below. If you don't have exactly one YPP client open and logged in then you @@ -31,15 +31,26 @@ information about the problem. OPTIONS: ======== - --pirate PIRATE Treat vessels belonging to PIRATE as your own - --ocean OCEAN Use map of OCEAN + --ocean OCEAN + Use map of OCEAN. Default is to guess by looking for an + open Puzzle Pirates client on the same display (logged on + as PIRATE, if --pirate was used). + + --pirate PIRATE + Supplies the name of your pirate. If you also supply a notes + file (see below) where-vessels will treat ships belonging to + PIRATE as your own. An empty argument means do not care about + vessel ownership. Default is not to care about ownership without + notes; with notes, default is to look for a Puzzle Pirates client + on the same display (on OCEAN, if --ocean was used). --notes SOURCE - Use SOURCE as the vessel notes; default is "vessel-notes" in the - current directory. See below. SOURCE may be of the following forms: - SCHEME:... eg http:... URL, fetched with Tcl's http package - |COMMAND ARG ARG command (Tcl list) whose output is the notes - NOTES-FILE ordinary file + Use SOURCE as the vessel notes. See below. + SOURCE may be of the following forms: + empty argument No notes, this is the default + SCHEME:... eg http:... URL, fetched with Tcl's http package + |COMMAND ARG ARG command (Tcl list) whose output is the notes + NOTES-FILE ordinary file --vessel-info-source RSYNC-SRC Update information about vessels, subclasses, icons, etc. from