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=e52e272ab54bc135ff7713ce09d2e43521a29fe1;hp=6fb21c279e6ca7c09026b80cf2e1b6b3cc04b4fa;hb=792a2a676fb8c320255990e3b7bbc22ea74c6ae6;hpb=7d38bda05d74767d4c8ab7127f72e3704350bf28

diff --git a/yarrg/README.where-vessels b/yarrg/README.where-vessels
index 6fb21c2..e52e272 100644
--- a/yarrg/README.where-vessels
+++ b/yarrg/README.where-vessels
@@ -52,6 +52,12 @@ OPTIONS:
        |COMMAND ARG ARG          command (Tcl list) whose output is the notes
        NOTES-FILE                ordinary file
 
+ --filter-separate-lock-owner
+     In the filter, show two separate 3-button filters for the lock
+     status, and the ship owner, rather than one 9-button filter with
+     an option for each combination.  (If there are no notes, only
+     one 3-button filter, for the lock status, is shown, anyway.)
+
  --vessel-info-source RSYNC-SRC
      Update information about vessels, subclasses, icons, etc. from
      RSYNC-SRC.  Default is yarrg.chiark.net::yarrg/vessel-info.
@@ -69,6 +75,56 @@ OPTIONS:
      Do not fetch ocean map from Yppedia.  Instead, use copy in DIR.
 
 
+USER INTERFACE:
+===============
+
+There are some things that won't be obvious from the user interface.
+
+The black square with the blue square inside it is the panner for the
+map.
+
+If you get an error message from Acquire, or a message about the
+notes, shown as a red, yellow or blue message below the Acquire or
+Reload Notes button, you can click on the message to get a pop-up
+window with the full error message.
+
+Colonised islands are shown with names in black; uncolonised in grey.
+Dotted routes are unpurchaseable charts.  (Information from Yppedia.)
+
+If you click on one of the little white icons on the map, you'll see
+an explanation of what that icon string means appear in the top right.
+Each element of the icon is explained in turn from left to right.
+Then you'll see a list of the ships represented below, ordered by
+owning pirate (if known) and then by name.
+
+The "Show" panel allows you to filter the displayed ships.  If you
+don't select "These:" then none of the other controls in the "Show"
+panel have any effect, so touching any of the latter sets the overall
+filtering style back to "These:".
+
+"Display/combine details" allows the map display to be decluttered by
+squashing together differing ships:
+ * "Size round down": selecting a size means that every ship of that
+   size will be rounded down to the next un-selected size.  Naturally
+   you cannot select sloops for rounding down!
+ * "Lock/owner": "Yours?" simply pretends that all unknown ships are
+   not yours; that is useful if your crew has many ships and you only
+   bother writing about your own ships in the notes.  "For you" shows
+   the vessel lock status, except that if it's your ship and unlocked
+   it shows just that it's yours (and doesn't show whether it's
+   unlocked or crew use).
+ * Flags: See perlop(1) on the tr/// (aka y///) operator.  All
+   characters entered into the boxes are literal; ranges etc. are not
+   supported.
+Filtering done by the "Show" panel takes effect before the collapsing
+done by "Display/combine details", so you can filter on details which
+you are collapsing for display.
+
+If you select (click on) one of the ship names in the list in the top
+right, you'll get an icon string below the vessel list which gives the
+complete information for that vessel, as it was before the collapsing.
+
+
 VESSEL NOTES:
 =============