Add Harep man page
authorMichele Tartara <mtartara@google.com>
Fri, 17 May 2013 15:18:46 +0000 (15:18 +0000)
committerMichele Tartara <mtartara@google.com>
Fri, 17 May 2013 15:45:47 +0000 (16:45 +0100)
Add the man page for the Ganeti auto-repair tool.

Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>

Makefile.am
man/harep.rst [new file with mode: 0644]

index 013e424..ffdee66 100644 (file)
@@ -996,6 +996,7 @@ man_MANS = \
        man/gnt-os.8 \
        man/gnt-storage.8 \
        man/hail.1 \
+       man/harep.1 \
        man/hbal.1 \
        man/hcheck.1 \
        man/hinfo.1 \
diff --git a/man/harep.rst b/man/harep.rst
new file mode 100644 (file)
index 0000000..e07b4db
--- /dev/null
@@ -0,0 +1,39 @@
+HAREP(1) Ganeti | Version @GANETI_VERSION@
+=========================================
+
+NAME
+----
+
+harep - Ganeti auto-repair tool
+
+SYNOPSIS
+--------
+
+**harep** [ [**-L** | **\--luxi** ] = *socket* ] [ --job-delay = *seconds* ]
+
+**harep** \--version
+
+DESCRIPTION
+-----------
+
+harep is the Ganeti auto-repair tool. It is able to detect that an instance is
+broken and to generate a sequence of jobs that will fix it, in accordance to the
+policies set by the administrator.
+
+OPTIONS
+-------
+
+The options that can be passed to the program are as follows:
+
+-L *socket*, \--luxi=*socket*
+  collect data via Luxi, optionally using the given *socket* path.
+
+\--job-delay=*seconds*
+  insert this much delay before the execution of repair jobs to allow the tool
+  to continue processing instances.
+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: