Whamcloud - gitweb
b=24037 Remove iopen ldiskfs patch for rhel5.
[fs/lustre-release.git] / lustre / doc / lfs.1
index 99bf69f..40ec5dc 100644 (file)
@@ -19,18 +19,19 @@ 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
+.RB [ path ]
 .br
 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
         \fB[--count | -c ] [--index | -i | --offset | -o ]
         \fB[--size | -s ] [--pool | -p ] [--directory | -d ]
-        \fB[--recursive|-r] <dirname|filename> ...\fR
+        \fB[--recursive | -r] <directory|filename> ...\fR
 .br
 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
         \fB[--index|-i|--offset|-o start_ost_index ] [--pool|-p <pool>]
-        \fB<dirname|filename>\fR
+        \fB<directory|filename>\fR
 .br
 .B lfs setstripe -d <dir>
 .br
@@ -102,14 +103,45 @@ for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
 To search the directory tree rooted at the given dir/file name for the files that match the given parameters: \fB--atime\fR (file was last accessed N*24 hours ago), \fB--ctime\fR (file's status was last changed N*24 hours ago), \fB--mtime\fR (file's data was last modified N*24 hours ago), \fB--obd\fR (file has an object on a specific OST or OSTs), \fB--size\fR (file has size in bytes, or \fBk\fRilo-, \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes if a suffix is given), \fB--type\fR (file has the type: \fBb\fRlock, \fBc\fRharacter, \fBd\fRirectory, \fBp\fRipe, \fBf\fRile, sym\fBl\fRink, \fBs\fRocket, or \fBD\fRoor (Solaris)), \fB--uid\fR (file has specific numeric user ID), \fB--user\fR (file owned by specific user, numeric user ID allowed), \fB--gid\fR (file has specific group ID), \fB--group\fR (file belongs to specific group, numeric group ID allowed). The option \fB--maxdepth\fR limits find to decend at most N levels of directory tree. The options \fB--print\fR and \fB--print0\fR print full file name, followed by a newline or NUL character correspondingly.  Using \fB!\fR before an option negates its meaning (\fIfiles NOT matching the parameter\fR).  Using \fB+\fR before a numeric value means \fIfiles with the parameter OR MORE\fR, while \fB-\fR before a numeric value means \fIfiles with the parameter OR LESS\fR.
 .TP
 .B osts 
-List all the OSTs for the filesystem
+.RB [ path ]
+List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
+that is located on a lustre mounted file system then only the OSTs belonging
+to that filesystem are displayed.
 .TP
 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
         \fB[--count | -c ] [--index | -i | --offset | -o  ]
         \fB[--pool | -p ] [--size | -s ] [--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 [--count|-c stripe_cnt] [--size|-s stripe_size]
         \fB[--index|-i|--offset|-o start_ost_index] [--pool <pool>]
@@ -130,11 +162,14 @@ of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
 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 
 .B lctl
 ) that will be used for striping. The 
-.I stripe_count, stripe_size, and start_ost_index
+.IR stripe_count ,
+.IR stripe_size ,
+and
+.I start_ost_index
 will be used as well; the 
 .I start_ost_index
 must be part of the pool or an error will be returned. 
@@ -142,8 +177,14 @@ must be part of the pool or an error will be returned.
 .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 quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name or an ID can be specified. If both user and group are omitted quotas for current uid/gid are shown. -v provides more verbose (with per-obd statistics) output. -q disables printing of additional descriptions (including column titles).