LU-680 manual: documentation for instance <-> path mapping.

A new feature was added to lfs with LU-680. This change records
the usage of this new feature in the manual.

lfs commands are now listed in alphabetical order.

The code changeset is:
http://review.whamcloud.com/#change,1373

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: Ifed7b26193fe219174891cdf79f4401b901750f7

diff --git a/UserUtilities.xml b/UserUtilities.xml
index 9854dba..3dfba45 100644 (file)
--- a/UserUtilities.xml
+++ b/UserUtilities.xml
@@ -41,24 +41,20 @@ lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
    [[!] --gid|-g|--group|-G <gname>|<gid>]
    [[!] --uid|-u|--user|-U <uname>|<uid>]
    <dirname|filename>
-lfs osts [path]
 lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
                    [--count|-c] [--index|-i | --offset|-o]
                    [--size|-s] [--pool|-p] [--directory|-d]
                    [--recursive|-r] <dirname|filename> ...
-lfs setstripe              [--size|-s stripe_size] [--count|-c stripe_cnt] 
-           [--index|-i|--offset|-o start_ost_index] 
-           [--pool|-p <pool>]
-           <dirname|filename>
-lfs setstripe -d <dir>
+lfs getname [-h]|[path...]
+lfs osts [path]
 lfs poollist <filesystem>[.<pool>]|<pathname>
 lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
 lfs quota -t <-u|-g> <filesystem>
 lfs quotacheck [-ug] <filesystem>
 lfs quotachown [-i] <filesystem>
+lfs quotainv [-ug] [-f] <filesystem>
 lfs quotaon [-ugf] <filesystem>
 lfs quotaoff [-ug] <filesystem>
-lfs quotainv [-ug] [-f] <filesystem>
 lfs setquota               <-u|--user|-g|--group> <uname|uid|gname|gid>
                    [--block-softlimit <block-softlimit>]
                    [--block-hardlimit <block-hardlimit>]
@@ -76,6 +72,11 @@ lfs setquota -t <-u|-g>
 lfs setquota -t <-u|-g>
            [-b <block-grace>] [-i <inode-grace>]
            <filesystem>
+lfs setstripe              [--size|-s stripe_size] [--count|-c stripe_cnt] 
+           [--index|-i|--offset|-o start_ost_index] 
+           [--pool|-p <pool>]
+           <dirname|filename>
+lfs setstripe -d <dir>
 lfs help
 </screen>
       <note>
@@ -290,6 +291,15 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
+                <para> <literal>getname [path...]</literal></para>
+              </entry>
+              <entry>
+                  <para>List each Lustre instance associated with each Lustre mount point.
+                      If no path is specified, all Lustre mounts points are interrogated. If a list of paths is provided, the instance of each path is provided. If the path is not a Lustre instance 'No such device' is returned.</para>
+              </entry>
+            </row>
+            <row>
+              <entry nameend="c2" namest="c1">
                 <para> <literal>getstripe</literal></para>
               </entry>
               <entry>
@@ -585,6 +595,8 @@ lfs help
       <screen>$ lfs setstripe -d /mnt/lustre/dir</screen>
       <para>Lists the detailed object allocation of a given file.</para>
       <screen>$ lfs getstripe -v /mnt/lustre/file1</screen>
+      <para>List all the mounted lustre filesystems and corresponding Lustre instances.</para>
+      <screen>$ lfs getname</screen>
       <para>Efficiently lists all files in a given directory and its subdirectories.</para>
       <screen>$ lfs find /mnt/lustre</screen>
       <para>Recursively lists all regular files in a given directory more than 30 days old.</para>