chiark / gitweb /
where-vessels: No notes is default. Better treatment of lack of notes/ownership
[ypp-sc-tools.main.git] / yarrg / README.where-vessels
index 190b7b3..6fb21c2 100644 (file)
@@ -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