Improved usage message

[ypp-sc-tools.web-live.git] / ypp-restock-rum

diff --git a/ypp-restock-rum b/ypp-restock-rum
index 569f461e36ee9bbe649b5c20ba386a5cded916f9..ab56abd3f14fd1ca862d0619dedad5c28fb905a9 100755 (executable)
--- a/ypp-restock-rum
+++ b/ypp-restock-rum
@@ -14,13 +14,20 @@ where <information> is
   price  <swill> <grog>  <fine> [<shot>]
 
 Each of which may appear only once, except \`have' which may appear
-more than once which case we calculate the differences and the profit
-for each one.
-
-If <shot> is not specified at all, relevant information about shot is
-not reported.  For have and want, missing entries count as zero.
+more than once which case we calculate the financial implications
+at each stage.
 
+Missing entries count as zero (and zeroes are not displayed in the output).
 In price, \`x' means the commodity is unavailable.
+
+The intended use is that at the start of the pillage you run:
+   ypp-restock-rum have ... want ...
+to check that stocks are sufficient, or perhaps:
+   ypp-restock-rum have ... want ... price ...
+if you want to stock up some more.  At the end of the pillage,
+run the same thing again with some extra parameters:
+   ypp-restock-rum have .. want ... have ... price ...
+and it will tell you how you did and what the restock should be like.
 END
 ;