Branch HEAD

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

diff --git a/lustre/doc/lfs.1 b/lustre/doc/lfs.1
index bb9a30c..0fca528 100644 (file)
--- a/lustre/doc/lfs.1
+++ b/lustre/doc/lfs.1
@@ -11,8 +11,10 @@ lfs \- Lustre utility to create a file with specific striping pattern, find the
 .br
 .B lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
         \fB[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n pattern]
-        \fB[--print|-p] \fB[--print0|-P] [--obd|-O <uuid>]
+        \fB[--print|-p] \fB[--print0|-P] [--obd|-O <uuid[s]>]
         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
+        \fB[[!] --gid|-g N] [[!] --group|-G <name>]
+        \fB[[!] --uid|-u N] [[!] --user|-U <name>]
         \fB<dirname|filename>\fR
 .br
 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
@@ -55,7 +57,7 @@ Display the status of MDS or OSTs (as specified in the command) or all the serve
 Report filesystem disk space usage or inodes usage of each MDT/OST.
 .TP
 .B find 
-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), \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)). The option \fB--maxdepth\fR allows 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.
+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 allows 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 getstripe
 To list the striping info for a given filename or files in a directory, optionally recursively, for all files in a directory tree: \fB--quiet\fR (don't print object IDs), \fB--verbose\fR (print striping parameters), \fB--recursive\fR (recurse into subdirectories).
@@ -63,8 +65,27 @@ To list the striping info for a given filename or files in a directory, optional
 .B osts 
 List all the OSTs for the filesystem
 .TP
-.B setstripe 
-To create a new file with a specific striping pattern
+.B setstripe [--size stripe-size] [--count stripe-cnt] [--index start-ost]
+To create a new file, or set the directory default, with the specified striping parameters.  The
+.I stripe-count
+is the number of OSTs to stripe a file over. A
+.I stripe-count
+of 0 means to use the filesystem-wide default stripe count (default 1), and a
+.I stripe-count
+of -1 means to stripe over all available OSTs.  The
+.I stripe-size
+is the number of bytes to store on each OST before moving to the next OST.  A
+.I stripe-size
+of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
+.I start-ost
+is the OST index (starting at 0) on which to start striping for this file.  A
+.I start-ost
+of -1 allows the MDS to specify the starting index and it is strongly
+recommended that the starting OST not be given, as this allows space and
+load balancing to be done by the MDS as needed.
+.TP
+.B lfs setstripe -d
+Delete the default striping on the specified directory.
 .TP
 .B quotachown
 To change files' owner and group on OSTs of the specified filesystem
@@ -154,7 +175,7 @@ Show grace times for user quotas on /mnt/lustre
 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
 Report bugs using http://bugzilla.lustre.org.
 .SH AUTHOR
-The lfs command is part of the Lustre filesystem.  Contact info@clusterfs.com.
+The lfs command is part of the Lustre filesystem.  Contact http://www.lustre.org/
 .SH SEE ALSO
 .BR lctl (8),
 .BR lustre (7)