hinfo: Adding man page

Signed-off-by: René Nussbaumer <rn@google.com>
Reviewed-by: Iustin Pop <iustin@google.com>

diff --git a/Makefile.am b/Makefile.am
index bcce5ea..aa0d2f9 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -650,6 +650,7 @@ man_MANS = \
        man/gnt-os.8 \
        man/hail.1 \
        man/hbal.1 \
+       man/hinfo.1 \
        man/hscan.1 \
        man/hspace.1 \
        man/htools.1

diff --git a/man/footer.rst b/man/footer.rst
index 2ded5ba..a774f05 100644 (file)
--- a/man/footer.rst
+++ b/man/footer.rst
@@ -25,12 +25,13 @@ daemon), **ganeti-masterd**(8) (master daemon), **ganeti-rapi**(8)
 
 Ganeti htools: **htools**(1) (generic binary), **hbal**(1) (cluster
 balancer), **hspace**(1) (capacity calculation), **hail**(1) (IAllocator
-plugin), **hscan**(1) (data gatherer from remote clusters).
+plugin), **hscan**(1) (data gatherer from remote clusters), **hinfo**(1)
+(cluster information printer).
 
 COPYRIGHT
 ---------
 
-Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google
+Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 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

diff --git a/man/hinfo.rst b/man/hinfo.rst
new file mode 100644 (file)
index 0000000..ec1789a
--- /dev/null
+++ b/man/hinfo.rst
@@ -0,0 +1,51 @@
+HINFO(1) Ganeti | Version @GANETI_VERSION@
+=========================================
+
+NAME
+----
+
+hinfo \- Cluster information printer
+
+SYNOPSIS
+--------
+
+**hinfo** {backend options...} [algorithm options...] [reporting options...]
+
+**hinfo** \--version
+
+
+Backend options:
+
+{ **-m** *cluster* | **-L[** *path* **] [-X]** | **-t** *data-file* }
+
+Algorithm options:
+
+**[ -O *name...* ]**
+
+Reporting options:
+
+**[ -p[ *fields* ] ]**
+**[ \--print-instances ]**
+**[ -v... | -q ]**
+
+
+DESCRIPTION
+-----------
+
+hinfo is the cluster information printer. It prints information about
+the current cluster state and its residing nodes/instances. It's
+similar to the output of **hbal** except that it doesn't take any action
+is just for information purpose. This information might be useful for
+debugging a certain cluster state.
+
+OPTIONS
+-------
+
+For a detailed description about the options listed above have a look at
+**htools(7)** and **hbal(1)**.
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: