From 3d95cd0d519f77e20cc5ca7f36b36708f0c56afb Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Tue, 12 Oct 2010 17:50:04 +0200
Subject: [PATCH] Add mising --units in gnt-instance list man page

Also fixes some wrapping issues, and one typo.

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>
(cherry picked from commit f8409165b4e6d24bd160ee6c85ba432ae8afa117)

Conflicts:

	man/gnt-instance.sgml (re-wrapped)
---
 man/gnt-instance.sgml |   37 +++++++++++++++++++++++++++----------
 1 file changed, 27 insertions(+), 10 deletions(-)

diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml
index 560b665..bddd8d2 100644
--- a/man/gnt-instance.sgml
+++ b/man/gnt-instance.sgml
@@ -136,7 +136,7 @@
           interpreted (when no unit is given) in mebibytes. You can
           also use one of the suffixes
           <literal>m</literal>, <literal>g</literal> or
-          <literal>t</literal> to specificy the exact the units used;
+          <literal>t</literal> to specify the exact the units used;
           these suffixes map to mebibytes, gibibytes and tebibytes.
         </para>
 
@@ -633,9 +633,9 @@
               <listitem>
                 <simpara>Valid for the KVM hypervisor.</simpara>
 
-                <simpara>Under security model <quote>user</quote> the username
-                to run the instance under. It must be a valid username
-                existing on the host.
+                <simpara>Under security model <quote>user</quote> the
+                username to run the instance under. It must be a valid
+                username existing on the host.
                 </simpara>
                 <simpara>Cannot be set under security model <quote>none</quote>
                 or <quote>pool</quote>.
@@ -714,13 +714,17 @@
                 <simpara>This boolean option determines wether to run the KVM
                 instance in a chroot directory.
                 </simpara>
-                <para>If it is set to <quote>true</quote>, an empty directory
-                is created before starting the instance and its path is passed
-                via the <option>-chroot</option> flag to kvm.
-                The directory is removed when the instance is stopped.
+
+                <para>If it is set to <quote>true</quote>, an empty
+                directory is created before starting the instance and
+                its path is passed via the <option>-chroot</option>
+                flag to kvm.  The directory is removed when the
+                instance is stopped.
                 </para>
 
-                <simpara>It is set to <quote>false</quote> by default.</simpara>
+                <simpara>It is set to <quote>false</quote> by
+                default.</simpara>
+
               </listitem>
             </varlistentry>
 
@@ -1025,7 +1029,8 @@
         </para>
 
         <para>
-          The command will display the job id for each submitted instance, as follows:
+          The command will display the job id for each submitted
+          instance, as follows:
           <screen>
 # gnt-instance batch-create instances.json
 instance3: 11224
@@ -1092,6 +1097,8 @@ instance5: 11225
           <command>list</command>
           <arg>--no-headers</arg>
           <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
+        <sbr>
+        <arg>--units=<replaceable>UNITS</replaceable></arg>
           <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
           <arg>--roman</arg>
           <arg rep="repeat">instance</arg>
@@ -1111,6 +1118,16 @@ instance5: 11225
         </para>
 
         <para>
+          The units used to display the numeric values in the output
+          varies, depending on the options given. By default, the values
+          will be formatted in the most appropriate unit. If the
+          <option>--separator</option> option is given, then the values
+          are shown in mebibytes to allow parsing by scripts. In both
+          cases, the <option>--units</option> option can be used to
+          enforce a given output unit.
+        </para>
+
+        <para>
           The <option>--roman</option> option allows latin people to better
           understand the cluster instances' status.
         </para>
-- 
1.7.10.4