LU-930 utils: add --help option to lfs sub-commands

[fs/lustre-release.git] / lustre / doc / lfs-getstripe.1

diff --git a/lustre/doc/lfs-getstripe.1 b/lustre/doc/lfs-getstripe.1
index 7c4190b..aa3a8df 100644 (file)
--- a/lustre/doc/lfs-getstripe.1
+++ b/lustre/doc/lfs-getstripe.1
@@ -8,9 +8,11 @@ lfs getstripe \- Lustre client command to print layout parameters of a file
       [\fB--component-flags\fR|\fB--comp-flags\fR[\fB=\fIflags\fR]]
       [\fB--component-id\fR|\fB--comp-id\fR[=\fIid\fR]|\fB-I\fR[\fIid\fR]]
       [\fB--component-start\fR[\fB=\fR[\fB+-\fR]\fIstart\fR[\fBKMGTPE\fR]]]
+      [\fB--extension-size\fR|\fB--ext-size\fR|\fB-z\fR]
       [\fB--directory\fR|\fB-d\fR]
 [\fB--fid\fR|\fB-F\fR]
 [\fB--generation\fR|\fB-g\fR]
+[\fB--help\fR|\fB-h\fR]
       [\fB--layout\fR|\fB-L\fR]
 [\fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR]
 [\fB--ost\fR|\fB-O\fR <\fIuuid\fR>]
@@ -20,11 +22,11 @@ lfs getstripe \- Lustre client command to print layout parameters of a file
       [\fB--raw\fR|\fB-R\fR]
 [\fB--stripe-count\fR|\fB-c\fR]
 [\fB--stripe-index\fR|\fB-i\fR]
-      [\fB--stripe-size\fR|\fB-S\fR]
-[[\fB!\fR] \fB--mirror-index\fR=[\fB+-\fR]\fI<index>\fR | [\fB!\fR] \fB--mirror-id\fR=[\fB+-\fR]\fI<id>\fR]
-[\fB--verbose\fR|\fB-v\fR]
+      [\fB--stripe-size\fR|\fB-S\fR] [\fB--mirror-count\fR|\fB-N\fR]
+      [[\fB!\fR] \fB--mirror-index\fR=[\fB+-\fR]\fI<index>\fR | [\fB!\fR] \fB--mirror-id\fR=[\fB+-\fR]\fI<id>\fR]
+      [\fB--verbose\fR|\fB-v\fR]
 [\fB--yaml\fR|\fB-y\fR]
-      <\fIdirname\fR|\fIfilename\fR> ...
+<\fIdirname\fR|\fIfilename\fR> ...
 .SH DESCRIPTION
 .B lfs getstripe
 is used to list the layout/striping information for a given filename or
@@ -33,6 +35,7 @@ and allocated OST objects for each file will be shown. If you only want
 specific layout information to be printed, then the
 .BR --stripe-count ,
 .BR --stripe-size ,
+.BR --extension-size ,
 .BR --stripe-index ,
 .BR --layout ,
 .BR --fid ,
@@ -143,15 +146,48 @@ is used, print components with respectively a larger or smaller
 .I start
 offset.
 .TP
+.BR --directory | -d
+Get striping information for only the specified directory, like
+.RB ' "ls -d" '.
+.TP
+.BR --fid | -F
+Show only the 128-bit unique Lustre File Identifier (FID).
+.TP
+.BR --generation | -g
+Print only the layout generation number.
+.TP
+.BR --help | -h
+Print usage message.
+.TP
+.BR --layout
+Show only the file layout, which is one of:
+.RS 1.2i
+.TP
+.B raid0
+Traditional Lustre RAID-0 striping format.
+.TP
+.B released
+HSM-archived files that are not resident in the filesystem.
+.TP
+.B mdt
+Files that have the first data component on an MDT.
+.RE
+.TP
+.BR --mdt | --mdt-index | -m
+Show the MDT index on which the file or directory inode is located.
+.TP
+.BR --mirror-count | -N
+Print the number of mirrors on the file.
+.TP
 .BR --mirror-index = [\fB+-\fR]\fR<\fIindex\fR>
 Print only the components of \fI<index>\fR-th mirror, based on the order
-that the mirror components are stored in the file layout, The \fIindex\fR
+that the mirror components are stored in the file layout. The \fIindex\fR
 starts at 1. If
 .BI + index
 or
 .BI - index
-is used, print components of mirror(s) respectively a later or earlier
-\fIindex\fR-th mirror.
+is used, print components of mirror(s) respectively later or earlier than
+the \fIindex\fR-th mirror.
 .RS 1.2i
 .TP
 .B !
@@ -162,9 +198,9 @@ neither is used, it means 'equal to \fIindex\fR'.
 .RE
 .TP
 .BR --mirror-id = [\fB+-\fR]\fR<\fIid\fR>
-Print only the component s of the mirror with ID of \fIid\fR. The mirror IDs
-are assigned to new mirrors as they are created, but may not be sequential if
-some mirrors are removed. If
+Print only the components of the mirror with ID of \fIid\fR. The mirror IDs
+are assigned to new mirrors as they are created, but may not be sequential
+if some mirrors are removed. If
 .BI + id
 or
 .BI - id
@@ -180,33 +216,6 @@ than \fIid\fR', - before \fIid\fR means mirror with ID 'smaller than \fIid\fR'.
 If neither is used, it means 'equal to \fIid\fR'.
 .RE
 .TP
-.BR --directory | -d
-Get striping information for only the specified directory, like
-.RB ' "ls -d" '.
-.TP
-.BR --fid | -F
-Show only the 128-bit unique Lustre File Identifier (FID).
-.TP
-.B --generation | -g
-Print only the layout generation number.
-.TP
-.BR --layout
-Show only the file layout, which is one of:
-.RS 1.2i
-.TP
-.B raid0
-Traditional Lustre RAID-0 striping format.
-.TP
-.B released
-HSM-archived files that are not resident in the filesystem.
-.TP
-.B mdt
-Files that have the first data component on an MDT.
-.RE
-.TP
-.BR --mdt | --mdt-index | -m
-Show the MDT index on which the file or directory inode is located.
-.TP
 .BR --ost | -O
 Print the starting OST index for the file layout.
 .TP
@@ -235,6 +244,10 @@ Print the starting OST index for the file layout.
 Print the stripe size in bytes.  For composite files this is the stripe
 size of the last initialized component.
 .TP
+.BR --extension-size | --ext-size | -z
+Print the extension size in bytes. For composite files this is the extension
+size of the first extension component.
+.TP
 .BR --verbose | -v
 Also print the layout magic, FID sequence, FID object ID, and FID, in
 addition to the normally-printed attributes.