From: Richard Henwood <rhenwood@whamcloud.com>
Date: Tue, 13 Dec 2011 19:25:53 +0000 (-0600)
Subject: LU-680 manual: documentation for instance <-> path mapping.
X-Git-Tag: 2.2.0~17
X-Git-Url: https://git.whamcloud.com/?p=doc%2Fmanual.git;a=commitdiff_plain;h=8ca8850c909421f17f63ce486f4b415448ea5fc1

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
--- a/UserUtilities.xml
+++ b/UserUtilities.xml
@@ -41,24 +41,20 @@ lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
    [[!] --gid|-g|--group|-G &lt;gname&gt;|&lt;gid&gt;]
    [[!] --uid|-u|--user|-U &lt;uname&gt;|&lt;uid&gt;]
    &lt;dirname|filename&gt;
-lfs osts [path]
 lfs getstripe [--obd|-O &lt;uuid&gt;] [--quiet|-q] [--verbose|-v]
                    [--count|-c] [--index|-i | --offset|-o]
                    [--size|-s] [--pool|-p] [--directory|-d]
                    [--recursive|-r] &lt;dirname|filename&gt; ...
-lfs setstripe              [--size|-s stripe_size] [--count|-c stripe_cnt] 
-           [--index|-i|--offset|-o start_ost_index] 
-           [--pool|-p &lt;pool&gt;]
-           &lt;dirname|filename&gt;
-lfs setstripe -d &lt;dir&gt;
+lfs getname [-h]|[path...]
+lfs osts [path]
 lfs poollist &lt;filesystem&gt;[.&lt;pool&gt;]|&lt;pathname&gt;
 lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u &lt;uname&gt;| -u &lt;uid&gt;|-g &lt;gname&gt;| -g &lt;gid&gt;] &lt;filesystem&gt;
 lfs quota -t &lt;-u|-g&gt; &lt;filesystem&gt;
 lfs quotacheck [-ug] &lt;filesystem&gt;
 lfs quotachown [-i] &lt;filesystem&gt;
+lfs quotainv [-ug] [-f] &lt;filesystem&gt;
 lfs quotaon [-ugf] &lt;filesystem&gt;
 lfs quotaoff [-ug] &lt;filesystem&gt;
-lfs quotainv [-ug] [-f] &lt;filesystem&gt;
 lfs setquota               &lt;-u|--user|-g|--group&gt; &lt;uname|uid|gname|gid&gt;
                    [--block-softlimit &lt;block-softlimit&gt;]
                    [--block-hardlimit &lt;block-hardlimit&gt;]
@@ -76,6 +72,11 @@ lfs setquota -t &lt;-u|-g&gt;
 lfs setquota -t &lt;-u|-g&gt;
            [-b &lt;block-grace&gt;] [-i &lt;inode-grace&gt;]
            &lt;filesystem&gt;
+lfs setstripe              [--size|-s stripe_size] [--count|-c stripe_cnt] 
+           [--index|-i|--offset|-o start_ost_index] 
+           [--pool|-p &lt;pool&gt;]
+           &lt;dirname|filename&gt;
+lfs setstripe -d &lt;dir&gt;
 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>