b=23409 add -i to the setstripe usage and man page

Add the "-i" option to the "lfs setstripe" usage and man page.
Fix nroff formatting in the "lfs setstripe" and "lfs getstripe".

i=sheila.barthel

diff --git a/lustre/doc/lfs.1 b/lustre/doc/lfs.1
index d9729a1..92c5a4b 100644 (file)
--- a/lustre/doc/lfs.1
+++ b/lustre/doc/lfs.1
@@ -15,18 +15,18 @@ lfs \- Lustre utility to create a file with specific striping pattern, find the
         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
         \fB[[!] --gid|-g|--group|-G <gname>|<gid>]
         \fB[[!] --uid|-u|--user|-U <uname>|<uid>]
-        \fB<dirname|filename>\fR
+        \fB<directory|filename>\fR
 .br
 .B lfs osts
 .br
 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
-        \fB[--count | -c ] [--size | -s ] [--index | -i ]
-        \fB[--offset | -o ] [--pool | -p ] [--directory | -d ]
-        \fB[--recursive|-r] <dirname|filename>\fR
+        \fB[--count | -c ] [--index | -i | --offset | -o ]
+        \fB[--size | -s ] [--pool | -p ] [--directory | -d ]
+        \fB[--recursive|-r] <dirname|filename> ...\fR
 .br
 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
-        \fB[--offset|-o start-ost] [--pool|-p <pool>]
-        \fB<dir|filename>\fR
+        \fB[--index|-i|--offset|-o start_ost_index ] [--pool|-p <pool>]
+        \fB<directory|filename>\fR
 .br
 .B lfs setstripe -d <dir>
 .br
@@ -96,40 +96,77 @@ List all the OSTs for the filesystem
         \fB[--offset | -o ] [--pool | -p ] [--directory | -d ]
         \fB[--recursive|-r] <dirname|filename>\fR
 .br
-To list the striping information for a given filename or directory. By default the stripe count, size, and offset will be returned. If you only want specific striping information then the options of \fB--count\fR,\fB--size\fR,\fB--index\fR or \fB--offset\fR plus various combinations of these options can be used to retrieve only what you want. What pools a file belong to can also be obtained with \fB--pool\fR. In the case where you only want details about the files object id information then the \fB--quiet\fR option is used. Additional information available about striping can be displayed with \fB--verbose\fR. The default behavior of lfs getstripe used to retrieve data about a directory is to list all the contents of that directory. If you wish to inquire only about that directory then \fB--directory\fR,can be used to list directory entries instead of its contents in the same manner as ls -d. This can be expanded with \fB--recursive\fR which will recurse into all subdirectories. You can filter the search to return only files that has a object on a specific OST with \fB--obd\fR.
+List the striping information for a given filename or directory tree.
+By default the stripe count, size, and offset will be returned. If you
+only want specific striping information then the options of
+.BR --count ,
+.BR --size ,
+.BR --index ,
+.BR --offset ,
+or
+.B --pool  
+can be used to return only the specific fields.
+.br
+In the case where you only want details about the files' object id
+information then the
+.B --quiet
+option is used. Additional information available about striping can be
+displayed with
+.BR --verbose .
+The default behavior when a directory is specified is to list the striping
+information for all files within the specified directory (like
+.RB ' "ls -l" ') .
+This can be expanded with
+.B --recursive
+which will recurse into all subdirectories.
+If you wish to get striping information for only the specified directory, then
+.B --directory
+can be used to limit the information, like
+.RB ' "ls -d" ').
+You can limit the returned files to those with objects on a specific OST with
+.BR --obd .
 .TP
 .B setstripe [--size stripe-size] [--count stripe-cnt] 
-       \fB[--offset start-ost] [--pool <pool>]\fR
+       \fB[--offset start-ost] [--pool <pool>] {directory|filename}\fR
 .br
 To create a new file, or set the directory default, with the specified striping parameters.  The
-.I stripe-count
+.I stripe_count
 is the number of OSTs to stripe a file over. A
-.I stripe-count
+.I stripe_count
 of 0 means to use the filesystem-wide default stripe count (default 1), and a
-.I stripe-count
+.I stripe_count
 of -1 means to stripe over all available OSTs.  The
-.I stripe-size
+.I stripe_size
 is the number of bytes to store on each OST before moving to the next OST.  A
-.I stripe-size
+.I stripe_size
 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
-.I start-ost
-is the OST index (base 10, starting at 0) on which to start striping for this file.  A
-.I start-ost
+.I start_ost_index
+is the OST index (starting at 0) on which to start striping for this file.  A
+.I start_ost_index
 of -1 allows the MDS to choose the starting index and it is strongly recommended, as this allows space and load balancing to be done by the MDS as needed.  The
-.I pool
+.I poolname
 is the name of a predefined pool of OSTs (see 
-.I lctl
+.B lctl
 ) that will be used for striping. The 
-.I stripe-count, stripe-size, start-ost
+.IR stripe_count ,
+.IR stripe_size ,
+and
+.I start_ost_index
 will be used as well; the 
-.I start-ost
+.I start_ost_index
 must be part of the pool or an error will be returned. 
 .TP
 .B setstripe -d
 Delete the default striping on the specified directory.
 .TP
-.B poollist <filesystem>[.<pool>] | <pathname>
-List the pools in \fBfilesystem\fR or \fBpathname\fR, or the OSTs in \fBfilesystem.pool\fR
+.B poollist
+.RI { filesystem }[ .poolname "] | {" pathname }
+List the pools in 
+.I filesystem
+or
+.IR pathname ,
+or the OSTs in
+.IR filesystem.pool .
 .TP
 .B quotachown
 To change files' owner and group on OSTs of the specified filesystem

diff --git a/lustre/utils/lfs.c b/lustre/utils/lfs.c
index 29a3bdf..4544a11 100644 (file)
--- a/lustre/utils/lfs.c
+++ b/lustre/utils/lfs.c
@@ -105,24 +105,24 @@ command_t cmdlist[] = {
          "Create a new file with a specific striping pattern or\n"
          "set the default striping pattern on an existing directory or\n"
          "delete the default striping pattern from an existing directory\n"
-         "usage: setstripe [--size|-s stripe_size] [--offset|-o start_ost]\n"
-         "                 [--count|-c stripe_count] [--pool|-p <pool>]\n"
-         "                 <dir|filename>\n"
+         "usage: setstripe [--size|-s stripe_size] [--count|-c stripe_count]\n"
+        "                 [--index|-i|--offset|-o start_ost_index]\n"
+         "                 [--pool|-p <pool>] <directory|filename>\n"
          "       or \n"
-         "       setstripe -d <dir>   (to delete default striping)\n"
+         "       setstripe -d <directory>   (to delete default striping)\n"
          "\tstripe_size:  Number of bytes on each OST (0 filesystem default)\n"
          "\t              Can be specified with k, m or g (in KB, MB and GB\n"
          "\t              respectively)\n"
-         "\tstart_ost:    OST index of first stripe (-1 filesystem default)\n"
+         "\tstart_ost_index: OST index of first stripe (-1 default)\n"
          "\tstripe_count: Number of OSTs to stripe over (0 default, -1 all)\n"
-         "\tpool:         Name of OST pool"},
+         "\tpool:         Name of OST pool to use (default none)"},
         {"getstripe", lfs_getstripe, 0,
          "To list the striping info for a given file or files in a\n"
          "directory or recursively for all files in a directory tree.\n"
          "usage: getstripe [--obd|-O <uuid>] [--quiet | -q] [--verbose | -v]\n"
-         "                 [--count | -c ] [--size | -s ] [--index | -i ]\n"
-         "                 [--offset | -o ] [--pool | -p ]\n"
-         "                 [--recursive | -r] <dir|file> ..."},
+         "                 [--count | -c ] [--index | -i | --offset | -o]\n"
+         "                 [--size | -s ] [--pool | -p ] [--directory | -d]\n"
+         "                 [--recursive | -r] <directory|filename> ..."},
         {"pool_list", lfs_poollist, 0,
          "List pools or pool OSTs\n"
          "usage: pool_list <fsname>[.<pool>] | <pathname>\n"},