RAPI client: Add job status constants
[ganeti-local] / man / hail.rst
index ef5b62e..e5a5156 100644 (file)
@@ -1,5 +1,5 @@
-HAIL(1) htools | Ganeti H-tools
-===============================
+HAIL(1) Ganeti | Version @GANETI_VERSION@
+=========================================
 
 NAME
 ----
@@ -9,7 +9,7 @@ hail - Ganeti IAllocator plugin
 SYNOPSIS
 --------
 
-**hail** *input-file*
+**hail** [ **-t** *datafile* | **--simulate** *spec* ] *input-file*
 
 **hail** --version
 
@@ -48,6 +48,26 @@ them using the single-instance relocation algorithm.
 
 In all cases, the cluster scoring is identical to the hbal algorithm.
 
+OPTIONS
+-------
+
+The options that can be passed to the program are as follows:
+
+-p, --print-nodes
+  Prints the before and after node status, in a format designed to
+  allow the user to understand the node's most important
+  parameters. See the man page **hbal**(1) for more details about this
+  field.
+
+-t *datafile*, --text-data=*datafile*
+  The name of the file holding cluster information, to override the
+  data in the JSON request itself. This is mostly used for debugging.
+
+--simulate *description*
+  Similar to the **-t** option, this allows overriding the cluster
+  data with a simulated cluster. For details about the description,
+  see the man page **hspace**(1).
+
 CONFIGURATION
 -------------
 
@@ -63,25 +83,13 @@ all instance tags of the form **service:X** will be considered as
 exclusion tags, meaning that (e.g.) two instances which both have a
 tag **service:foo** will not be placed on the same primary node.
 
+OPTIONS
+-------
+
+The options that can be passed to the program are as follows:
+
 EXIT STATUS
 -----------
 
 The exist status of the command will be zero, unless for some reason
 the algorithm fatally failed (e.g. wrong node or instance data).
-
-SEE ALSO
---------
-
-**hbal**(1), **hspace**(1), **hscan**(1), **ganeti**(7),
-**gnt-instance**(8), **gnt-node**(8)
-
-COPYRIGHT
----------
-
-Copyright (C) 2009, 2010 Google Inc. Permission is granted to copy,
-distribute and/or modify under the terms of the GNU General Public
-License as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-
-On Debian systems, the complete text of the GNU General Public License
-can be found in /usr/share/common-licenses/GPL.