Update documentation for the text backend

diff --git a/README b/README
index d1cdfc5..25b152a 100644 (file)
--- a/README
+++ b/README
@@ -72,15 +72,11 @@ special setup (just needs to be installed in the right directory).
 For generating the text files, a separate tool (``hscan``) is provided
 to automate their gathering if RAPI is available, which is better since
 it can extract more precise information. In case RAPI is not usable for
-whatever reason, the following two commands should be run::
+whatever reason, ``gnt-node list`` and ``gnt-instance list`` could be
+used, and their output concatenated in a single file, separated by one
+blank line. If you need to do this manually, you'll need to check the
+sources to see which fields are needed exactly.
 
-    gnt-node list -oname,mtotal,mnode,mfree,dtotal,dfree,ctotal,offline \
-      --separator '|' --no-headers > nodes
-    gnt-instance list -oname,be/memory,sda_size,be/vcpus,status,pnode,snodes \
-      --separator '|' --no-head > instances
-
-These two files should be saved under the names of *nodes* and
-*instances*.
 
 The ``hail`` program gets its data automatically from Ganeti when used
 as described in its section.

diff --git a/hbal.1 b/hbal.1
index 6b289af..cf2782d 100644 (file)
--- a/hbal.1
+++ b/hbal.1
@@ -17,8 +17,7 @@ Backend options:
 |
 .BI "[ -L[" path "] [-X]]"
 |
-.BI "[ -n " nodes-file " ]"
-.BI "[ -i " instances-file " ]"
+.BI "[ -t " data-file " ]"
 
 .TP
 Algorithm options:
@@ -422,20 +421,14 @@ and thus the influence of the dynamic utilisation will be practically
 insignificant.
 
 .TP
-.BI "-n" nodefile ", --nodes=" nodefile
-The name of the file holding node information (if not collecting via
-RAPI), instead of the default \fInodes\fR file (but see below how to
-customize the default value via the environment).
-
-.TP
-.BI "-i" instancefile ", --instances=" instancefile
-The name of the file holding instance information (if not collecting
-via RAPI), instead of the default \fIinstances\fR file (but see below
-how to customize the default value via the environment).
+.BI "-t" datafile ", --text-data=" datafile
+The name of the file holding node and instance information (if not
+collecting via RAPI or LUXI). This or one of the other backends must
+be selected.
 
 .TP
 .BI "-m" cluster
-Collect data not from files but directly from the
+Collect data directly from the
 .I cluster
 given as an argument via RAPI. If the argument doesn't contain a colon
 (:), then it is converted into a fully\(hybuilt URL via prepending
@@ -444,11 +437,11 @@ considered a fully\(hyspecified URL and is used as\(hyis.
 
 .TP
 .BI "-L[" path "]"
-Collect data not from files but directly from the master daemon, which
-is to be contacted via the luxi (an internal Ganeti protocol). An
-optional \fIpath\fR argument is interpreted as the path to the unix
-socket on which the master daemon listens; otherwise, the default path
-used by ganeti when installed with \fI--localstatedir=/var\fR is used.
+Collect data directly from the master daemon, which is to be contacted
+via the luxi (an internal Ganeti protocol). An optional \fIpath\fR
+argument is interpreted as the path to the unix socket on which the
+master daemon listens; otherwise, the default path used by ganeti when
+installed with \fI--localstatedir=/var\fR is used.
 
 .TP
 .B "-X"

diff --git a/hspace.1 b/hspace.1
index ae3ac6e..4cbedb9 100644 (file)
--- a/hspace.1
+++ b/hspace.1
@@ -19,8 +19,7 @@ Backend options:
 |
 .BI " -L[" path "]"
 |
-.BI " -n " nodes-file
-.BI " -i " instances-file
+.BI " -t " data-file
 |
 .BI " --simulate " spec
 
@@ -306,20 +305,14 @@ numeric fields.
 .RE
 
 .TP
-.BI "-n" nodefile ", --nodes=" nodefile
-The name of the file holding node information (if not collecting via
-RAPI), instead of the default \fInodes\fR file (but see below how to
-customize the default value via the environment).
-
-.TP
-.BI "-i" instancefile ", --instances=" instancefile
-The name of the file holding instance information (if not collecting
-via RAPI), instead of the default \fIinstances\fR file (but see below
-how to customize the default value via the environment).
+.BI "-t" datafile ", --text-data=" datafile
+The name of the file holding node and instance information (if not
+collecting via RAPI or LUXI). This or one of the other backends must
+be selected.
 
 .TP
 .BI "-m" cluster
-Collect data not from files but directly from the
+Collect data directly from the
 .I cluster
 given as an argument via RAPI. If the argument doesn't contain a colon
 (:), then it is converted into a fully\(hybuilt URL via prepending
@@ -328,11 +321,11 @@ considered a fully\(hyspecified URL and is used as\(hyis.
 
 .TP
 .BI "-L[" path "]"
-Collect data not from files but directly from the master daemon, which
-is to be contacted via the luxi (an internal Ganeti protocol). An
-optional \fIpath\fR argument is interpreted as the path to the unix
-socket on which the master daemon listens; otherwise, the default path
-used by ganeti when installed with \fI--localstatedir=/var\fR is used.
+Collect data directly from the master daemon, which is to be contacted
+via the luxi (an internal Ganeti protocol). An optional \fIpath\fR
+argument is interpreted as the path to the unix socket on which the
+master daemon listens; otherwise, the default path used by ganeti when
+installed with \fI--localstatedir=/var\fR is used.
 
 .TP
 .BI "--simulate " description