Whamcloud - gitweb
LUDOC-117 cleanup: minor changes to wording and markup.
[doc/manual.git] / UserUtilities.xml
index 5587608..ea242ea 100644 (file)
     <section remap="h5">
       <title>Synopsis</title>
       <screen>lfs
-lfs changelog [--follow] &lt;mdtname&gt; [startrec [endrec]]
-lfs changelog_clear &lt;mdtname&gt; &lt;id&gt; &lt;endrec&gt;
-lfs check &lt;mds|osts|servers&gt;
-lfs df [-i] [-h] [--pool]-p &lt;fsname&gt;[.&lt;pool&gt;] [path]
+lfs changelog [--follow] <replaceable>mdt_name</replaceable> [startrec [endrec]]
+lfs changelog_clear <replaceable>mdt_name id endrec</replaceable>
+lfs check <replaceable>mds|osts|servers</replaceable>
+lfs df [-i] [-h] [--pool]-p <replaceable>fsname</replaceable>[.<replaceable>pool</replaceable>] [<replaceable>path</replaceable>]
 lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
-         [[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n &lt;pattern&gt;]
-         [--print|-p] [--print0|-P] [[!] --obd|-O &lt;uuid[s]&gt;]
+         [[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n <replaceable>pattern</replaceable>]
+         [--print|-p] [--print0|-P] [[!] --obd|-O <replaceable>ost_name</replaceable>[,<replaceable>ost_name...</replaceable>]]
          [[!] --size|-S [+-]N[kMGTPE]] --type |-t {bcdflpsD}]
-         [[!] --gid|-g|--group|-G &lt;gname&gt;|&lt;gid&gt;]
-         [[!] --uid|-u|--user|-U &lt;uname&gt;|&lt;uid&gt;]
-         &lt;dirname|filename&gt;
+         [[!] --gid|-g|--group|-G <replaceable>gname|gid</replaceable>]
+         [[!] --uid|-u|--user|-U <replaceable>uname|uid</replaceable>]
+         <replaceable>dirname|filename</replaceable>
 lfs getname [-h]|[path...]
-lfs getstripe [--obd|-O &lt;uuid&gt;] [--quiet|-q] [--verbose|-v]
+lfs getstripe [--obd|-O <replaceable>ost_name</replaceable>] [--quiet|-q] [--verbose|-v]
               [--count|-c] [--index|-i | --offset|-o]
               [--size|-s] [--pool|-p] [--directory|-d]
-              [--recursive|-r] [--raw|-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;
+              [--recursive|-r] [--raw|-R] [-M] <replaceable>dirname|filename</replaceable> ...
+lfs setstripe [--size|-s stripe_size] [--count|-c <replaceable>stripe_count</replaceable>]
+              [--index|-i|--offset|-o <replaceable>start_ost_index</replaceable>]
+              [--pool|-p <replaceable>pool</replaceable>]
+              <replaceable>dirname|filename</replaceable>
+lfs setstripe -d <replaceable>dir</replaceable>
 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 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;]
-             [--inode-softlimit &lt;inode-softlimit&gt;]
-             [--inode-hardlimit &lt;inode-hardlimit&gt;]
-             &lt;filesystem&gt;
-lfs setquota &lt;-u|--user|-g|--group&gt; &lt;uname|uid|gname|gid&gt;
-             [-b &lt;block-softlimit&gt;] [-B &lt;block-hardlimit&gt;]
-             [-i &lt;inode-softlimit&gt;] [-I &lt;inode-hardlimit&gt;]
-             &lt;filesystem&gt;
-lfs setquota -t &lt;-u|-g&gt;
-             [--block-grace &lt;block-grace&gt;]
-             [--inode-grace &lt;inode-grace&gt;]
-             &lt;filesystem&gt;
-lfs setquota -t &lt;-u|-g&gt;
-             [-b &lt;block-grace&gt;] [-i &lt;inode-grace&gt;]
-             &lt;filesystem&gt;
+lfs poollist <replaceable>filesystem</replaceable>[.<replaceable>pool</replaceable>]|<replaceable>pathname</replaceable>
+lfs quota [-q] [-v] [-o <replaceable>obd_uuid</replaceable>|-I <replaceable>ost_idx</replaceable>|-i <replaceable>mdt_idx</replaceable>]
+          [-u <replaceable>username|uid|-g</replaceable> <replaceable>group|gid</replaceable>]
+          <replaceable>/mount_point</replaceable>
+lfs quota -t -u|-g <replaceable>/mount_point</replaceable>
+lfs quotacheck [-ug] <replaceable>/mount_point</replaceable>
+lfs quotachown [-i] <replaceable>/mount_point</replaceable>
+lfs quotainv [-ug] [-f] <replaceable>/mount_point</replaceable>
+lfs quotaon [-ugf] <replaceable>/mount_point</replaceable>
+lfs quotaoff [-ug] <replaceable>/mount_point</replaceable>
+lfs setquota {-u|--user|-g|--group} <replaceable>uname|uid|gname|gid</replaceable>
+             [--block-softlimit <replaceable>block_softlimit</replaceable>]
+             [--block-hardlimit <replaceable>block_hardlimit</replaceable>]
+             [--inode-softlimit <replaceable>inode_softlimit</replaceable>]
+             [--inode-hardlimit <replaceable>inode_hardlimit</replaceable>]
+             <replaceable>/mount_point</replaceable>
+lfs setquota -u|--user|-g|--group <replaceable>uname|uid|gname|gid</replaceable>
+             [-b <replaceable>block_softlimit</replaceable>] [-B <replaceable>block_hardlimit</replaceable>]
+             [-i <replaceable>inode-softlimit</replaceable>] [-I <replaceable>inode_hardlimit</replaceable>]
+             <replaceable>/mount_point</replaceable>
+lfs setquota -t -u|-g
+             [--block-grace <replaceable>block_grace</replaceable>]
+             [--inode-grace <replaceable>inode_grace</replaceable>]
+             <replaceable>/mount_point</replaceable>
+lfs setquota -t -u|-g
+             [-b <replaceable>block_grace</replaceable>] [-i <replaceable>inode_grace</replaceable>]
+             <replaceable>/mount_point</replaceable>
 lfs help
 </screen>
       <note>
-        <para>In the above example, the <literal>&lt;filesystem&gt;</literal> parameter refers to the mount point of the Lustre file system. The default mount point is <literal>/mnt/lustre</literal></para>
+        <para>In the above example, the <literal><replaceable>/mount_point</replaceable></literal> parameter refers to the mount point of the Lustre file system.</para>
       </note>
       <note>
         <para>The old lfs quota output was very detailed and contained cluster-wide quota statistics (including cluster-wide limits for a user/group and cluster-wide usage for a user/group), as well as statistics for each MDS/OST. Now, <literal>lfs quota</literal> has been updated to provide only cluster-wide statistics, by default. To obtain the full report of cluster-wide limits, usage and statistics, use the <literal>-v</literal> option with <literal>lfs quota</literal>.</para>
@@ -124,7 +124,7 @@ lfs help
                 <para> <literal>changelog_clear</literal></para>
               </entry>
               <entry>
-                <para>Indicates that changelog records previous to <literal>&lt;endrec&gt;</literal> are no longer of interest to a particular consumer <literal>&lt;id&gt;</literal>, potentially allowing the MDT to free up disk space. An <literal>&lt;endrec&gt;</literal> of 0 indicates the current last record. Changelog consumers must be registered on the MDT node using <literal>lctl</literal>.</para>
+                <para>Indicates that changelog records previous to <literal><replaceable>endrec</replaceable></literal> are no longer of interest to a particular consumer <literal><replaceable>id</replaceable></literal>, potentially allowing the MDT to free up disk space. An <literal><replaceable>endrec</replaceable></literal> of 0 indicates the current last record. Changelog consumers must be registered on the MDT node using <literal>lctl</literal>.</para>
               </entry>
             </row>
             <row>
@@ -137,7 +137,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <literal> df [-i] [-h] [--pool|-p &lt;fsname&gt;[.&lt;pool&gt;] [path] </literal>
+                <literal> df [-i] [-h] [--pool|-p <replaceable>fsname</replaceable>[.<replaceable>pool</replaceable>] [<replaceable>path</replaceable>] </literal>
               </entry>
               <entry>
                 <para>Report file system disk space usage or inode usage (with <literal>-i</literal>) of each MDT/OST or a subset of OSTs if a pool is specified with <literal>-p</literal>. By default, prints the usage of all mounted Lustre file systems. Otherwise, if path is specified, prints only the usage of that file system. If <literal>-h</literal> is given, the output is printed in human-readable format, using SI base-2 suffixes for <emphasis role="bold">M</emphasis>ega-, <emphasis role="bold">G</emphasis>iga-, <emphasis role="bold">T</emphasis>era-, <emphasis role="bold">P</emphasis>eta-, or <emphasis role="bold">E</emphasis>xabytes.</para>
@@ -308,6 +308,7 @@ lfs help
                 <para>Lists striping information for a given filename or directory. By default, the stripe count, stripe size and offset are returned.</para>
                 <para>If you only want specific striping information, then the options of <literal>--count</literal>,<literal>--size</literal>,<literal>--index</literal> or <literal>--offset</literal> plus various combinations of these options can be used to retrieve specific information.</para>
                 <para>If the <literal>--raw</literal> option is specified, the stripe information is printed without substituting the filesystem's default values for unspecified fields. If the striping EA is not set, 0, 0, and -1 will be printed for the stripe count, size, and offset respectively.</para>
+                               <para condition='l24'>The <literal>-M</literal> prints the index of the MDT for a given directory. See <xref linkend='dbdoclet.rmremotedir'/>.</para>
               </entry>
             </row>
             <row>
@@ -315,7 +316,7 @@ lfs help
                 <para> &#160;</para>
               </entry>
               <entry>
-                <para> <literal>--obd &lt;uuid&gt;</literal></para>
+                <para> <literal>--obd <replaceable>ost_name</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Lists files that have an object on a specific OST.</para>
@@ -470,7 +471,7 @@ lfs help
                 <para> &#160;</para>
               </entry>
               <entry>
-                <para> <literal>--pool &lt;pool&gt;</literal></para>
+                <para> <literal>--pool <replaceable>pool</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Name of the pre-defined pool of OSTs (see <xref linkend="dbdoclet.50438219_38274"/>) that will be used for striping. The <literal>stripe_cnt</literal>, <literal>stripe_size</literal> and <literal>start_ost</literal> values are used as well. The start-ost value must be part of the pool or an error is returned.</para>
@@ -494,7 +495,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para> <literal>quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g &lt;uname&gt;|&lt;uid&gt;|&lt;gname&gt;|&lt;gid&gt;] &lt;filesystem&gt;</literal></para>
+                <para> <literal>quota [-q] [-v] [-o <replaceable>obd_uuid</replaceable>|-i <replaceable>mdt_idx</replaceable>|-I <replaceable>ost_idx</replaceable>] [-u|-g <replaceable>uname|uid|gname|gid]</replaceable> <replaceable>/mount_point</replaceable></literal></para>
                 <para>&#160;</para>
               </entry>
               <entry>
@@ -503,7 +504,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para> <literal>quota -t &lt;-u|-g&gt; &lt;filesystem&gt;</literal></para>
+                <para> <literal>quota -t <replaceable>-u|-g</replaceable> <replaceable>/mount_point</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Displays block and inode grace times for user (<literal>-u</literal>) or group (<literal>-g</literal>) quotas.</para>
@@ -519,7 +520,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para> <literal>quotacheck [-ugf] &lt;filesystem&gt;</literal></para>
+                <para> <literal>quotacheck [-ugf] <replaceable>/mount_point</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Scans the specified file system for disk usage, and creates or updates quota files. Options specify quota for users (<literal>-u</literal>), groups (<literal>-g</literal>), and force (<literal>-f</literal>).</para>
@@ -527,7 +528,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para> <literal>quotaon [-ugf] &lt;filesystem&gt;</literal></para>
+                <para> <literal>quotaon [-ugf] <replaceable>/mount_point</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Turns on file system quotas. Options specify quota for users (<literal>-u</literal>), groups (<literal>-g</literal>), and force (<literal>-f</literal>).</para>
@@ -535,7 +536,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para> <literal>quotaoff [-ugf] &lt;filesystem&gt;</literal></para>
+                <para> <literal>quotaoff [-ugf] <replaceable>/mount_point</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Turns off file system quotas. Options specify quota for users (<literal>-u</literal>), groups (<literal>-g</literal>), and force (<literal>-f</literal>).</para>
@@ -543,7 +544,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para> <literal>quotainv [-ug] [-f] &lt;filesystem&gt;</literal></para>
+                <para> <literal>quotainv [-ug] [-f] <replaceable>/mount_point</replaceable></literal></para>
               </entry>
               <entry>
                 <para> Clears quota files (administrative quota files if used without <literal>-f</literal>, operational quota files otherwise), all of their quota entries for users (<literal>-u</literal>) or groups (<literal>-g</literal>). After running <literal>quotainv</literal>, you must run <literal>quotacheck</literal> before using quotas.</para>
@@ -554,7 +555,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para> <literal>setquota &lt;-u|-g&gt; &lt;uname&gt;|&lt;uid&gt;|&lt;gname&gt;|&lt;gid&gt; [--block-softlimit &lt;block-softlimit&gt;] [--block-hardlimit &lt;block-hardlimit&gt;] [--inode-softlimit &lt;inode-softlimit&gt;] [--inode-hardlimit &lt;inode-hardlimit&gt;] &lt;filesystem&gt;</literal></para>
+                <para> <literal>setquota -u|-g <replaceable>uname|uid|gname|gid}</replaceable> [--block-softlimit <replaceable>block_softlimit</replaceable>] [--block-hardlimit <replaceable>block_hardlimit</replaceable>] [--inode-softlimit <replaceable>inode_softlimit</replaceable>] [--inode-hardlimit <replaceable>inode_hardlimit</replaceable>] <replaceable>/mount_point</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Sets file system quotas for users or groups. Limits can be specified with <literal>--{block|inode}-{softlimit|hardlimit}</literal> or their short equivalents <literal>-b</literal>, <literal>-B</literal>, <literal>-i</literal>, <literal>-I</literal>. Users can set 1, 2, 3 or 4 limits.<footnote>
@@ -564,7 +565,7 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
-                <para><literal> setquota -t &lt;-u|-g&gt; [--block-grace &lt;block-grace&gt;] [--inode-grace &lt;inode-grace&gt;] &lt;filesystem&gt;</literal></para>
+                <para><literal> setquota -t -u|-g [--block-grace <replaceable>block_grace</replaceable>] [--inode-grace <replaceable>inode_grace</replaceable>] <replaceable>/mount_point</replaceable></literal></para>
               </entry>
               <entry>
                 <para>Sets the file system quota grace times for users or groups. Grace time is specified in &apos;<literal>XXwXXdXXhXXmXXs</literal>&apos; format or as an integer seconds value. See <xref linkend="dbdoclet.50438206_11903"/>.</para>
@@ -613,7 +614,7 @@ lfs help
       <para>Lists inode usage per OST and MDT.</para>
       <screen>$ lfs df -i</screen>
       <para>List space or inode usage for a specific OST pool.</para>
-      <screen>$ lfs df --pool &lt;filesystem&gt;[.&lt;pool&gt;] | &lt;pathname&gt;</screen>
+      <screen>$ lfs df --pool <replaceable>filesystem</replaceable>[.<replaceable>pool</replaceable>] | <replaceable>pathname</replaceable></screen>
       <para>List quotas of user &apos;bob&apos;.</para>
       <screen>$ lfs quota -u bob /mnt/lustre</screen>
       <para>Show grace times for user quotas on /mnt/lustre.</para>
@@ -766,10 +767,10 @@ lfs help
     <para>The <literal>e2fsck</literal> utility is run on each of the local MDS and OST device file systems and verifies that the underlying <literal>ldiskfs</literal> is consistent. After <literal>e2fsck</literal> is run, <literal>lfsck</literal> does distributed coherency checking for the Lustre file system. In most cases, <literal>e2fsck</literal> is sufficient to repair any file system issues and <literal>lfsck</literal> is not required.</para>
     <section remap="h5">
       <title>Synopsis</title>
-      <screen>lfsck [-c|--create] [-d|--delete] [-f|--force] [-h|--help] [-l|--lostfound] [-n|--nofix] [-v|--verbose] --mdsdb mds_database_file --ostdb ost1_database_file [ost2_database_file...] &lt;filesystem&gt;
+      <screen>lfsck [-c|--create] [-d|--delete] [-f|--force] [-h|--help] [-l|--lostfound] [-n|--nofix] [-v|--verbose] --mdsdb <replaceable>mds_database_file</replaceable> --ostdb <replaceable>ost1_database_file</replaceable>[<replaceable>ost2_database_file</replaceable>...] <replaceable>/mount_point</replaceable>
 </screen>
       <note>
-        <para>As shown, the <literal>&lt;filesystem&gt;</literal> parameter refers to the Lustre file system mount point. The default mount point is <literal>/mnt/lustre</literal>.</para>
+        <para>As shown, the <literal><replaceable>/mount_point</replaceable></literal> parameter refers to the Lustre file system mount point. The default mount point is <literal>/mnt/lustre</literal>.</para>
       </note>
       <note>
         <para>For <literal>lfsck</literal>, database filenames must be provided as absolute pathnames. Relative paths do not work, the databases cannot be properly opened.</para>
@@ -847,16 +848,16 @@ lfs help
                 <para><literal>mds_database_file</literal></para>
               </entry>
               <entry>
-                <para>MDS database file created by running <literal>e2fsck</literal> <literal>--mdsdb</literal> <literal>mds_database_file</literal> <literal>&lt;device&gt;</literal> on the MDS backing device. This is required.</para>
+                <para>MDT database file created by running <literal>e2fsck --mdsdb <replaceable>mds_database_file</replaceable> <replaceable>/dev/mdt_device</replaceable></literal> on the MDT backing device. This is required.</para>
               </entry>
             </row>
             <row>
               <entry>
-                <para> <literal>--ostdb ost1_database_file</literal></para>
-                <para><literal>[ost2_database_file...]</literal></para>
+                <para> <literal>--ostdb <replaceable>ost1_database_file</replaceable></literal></para>
+                <para><literal>[<replaceable>ost2_database_file</replaceable>...]</literal></para>
               </entry>
               <entry>
-                <para>OST database files created by running <literal>e2fsck</literal> <literal>--ostdb ost_database_file &lt;device&gt;</literal> on each of the OST backing devices. These are required unless an OST is unavailable, in which case all objects thereon are considered missing.</para>
+                <para>OST database files created by running <literal>e2fsck --ostdb <replaceable>ost_database_file</replaceable> <replaceable>/dev/ost_device</replaceable></literal> on each of the OST backing devices. These are required unless an OST is unavailable, in which case all objects thereon are considered missing.</para>
               </entry>
             </row>
           </tbody>