mg-allocate: Document -U and <duration> options

Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>

diff --git a/mg-allocate b/mg-allocate
index 3730c23a9306f3c623cd8fc95c992c020ed34a09..10a83ebc158b0c49b7be49a835f66c39a32db5fa 100755 (executable)
--- a/mg-allocate
+++ b/mg-allocate
@@ -1,6 +1,9 @@
 #!/usr/bin/perl -w
 #
-# resource syntax:
+# usage:
+#  ./mg-allocate [<options>] <resource-spec>...
+#
+# <resource-spec> syntax:
 #   [!][<type>/]<name>[/<share>]      type defaults to 'host'
 #                                     type=='S' means 'shared-host'
 #                                     share defaults to *
@@ -9,6 +12,17 @@
 #                                       any one of those options
 #                                     option={flag,flag...} means anything
 #                                       with all those flags
+#
+# <options>:
+#
+#   <duration>     Participate in the resource planning system.
+#                  <duration> is <integer>[<units>], that the resource
+#                  is expected to be used for.  <units> is one of
+#                   d (days)  h (hours)  m (minutes)  s (seconds)
+#                  where seconds is the default.
+#
+#   -U             allocate with high priority (makes sense with
+#                  specified duration only)
 
 # This is part of "osstest", an automated testing framework for Xen.
 # Copyright (C) 2009-2013 Citrix Inc.