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

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

diff --git a/lustre/doc/lfs-getdirstripe.1 b/lustre/doc/lfs-getdirstripe.1
index b5bcaff..f2a4537 100644 (file)
--- a/lustre/doc/lfs-getdirstripe.1
+++ b/lustre/doc/lfs-getdirstripe.1
@@ -1,48 +1,57 @@
-.TH LFS-GETDIRSTRIPE 1 2014-06-08 "Lustre" "Lustre Utilities"
+.TH LFS-GETDIRSTRIPE 1 2017-11-07 "Lustre" "Lustre Utilities"
 .SH NAME
-lfs getdirstripe \- list the striping pattern of a given directory.
+lfs getdirstripe \- list the layout pattern of a given directory
 .SH SYNOPSIS
-.B lfs getdirstripe
-[\fIOPTION\fR]... \fIDIR\fR...
+.BR "lfs getdirstripe" " [" -cDhHimOrTXvy "]... " \fIDIR\fR...
 .SH DESCRIPTION
-Get the striping pattern information of directories. This lfs utility is
-similar to
-.B lfs getstripe
-, but is used to get directory striping pattern.
-.BP lfs
+Get the layout pattern of striped directories. This
+.BR lfs (1)
+command is similar to
+.BR "lfs getstripe" ,
+but is used for the directory layout.
 .SH OPTIONS
 .TP
-.B \-c, \-\-stripe-count
-Only show the stripe count of the directory.
+.BR \-c ", " \-T ", " \-\-mdt-count
+Only show the number of MDTs the directory is striped across.
 .TP
-.B \-i, \-\-stripe-index
-Only show the stripe index of the directory.
+.BR \-D ", " \-\-default
+Show the default layout used when creating new subdirectories.
 .TP
-.B \-R, \-\-raw
-The striping information is printed without substituting the
-filesystem's default values for unspecified fields. If the striping EA is not
-set, 0, and -1 will be printed for the stripe count, and offset respectively.
+.BR \-h ", " \-\-help
+Print usage message.
 .TP
-.B \-q, \-\-quiet
-Only show the details of the sub-striped directory FID information.
+.BR \-H ", " \-\-mdt-hash
+Only show the hash function being used for this directory.
 .TP
-.B \-v, \-\-verbose
-Additional information will be shown with this option.
-.TP
-.B \-r, \-\-recursive
-The default behavior when a directory is specified is to list the striping
-information for all sub-directories within the specified directory. This
-can be expanded with --recursive, which will recurse into all subdirectories.
+.BR \-i ", " \-m ", " \-\-mdt-index
+Only show the master MDT index of the directory.
 .TP
 \fB\-O\fR, \fB\-\-obd\fR=\fIFSNAME-MDTnnnn_UUID\fR
 Limit the returned directories to those with objects on a specific MDT,
-whose uuid is
+whose UUID is
 .I FSNAME-MDTnnnn_UUID.
+.TP
+.BR \-r ", " \-\-recursive
+The default behavior when a directory is specified is to list the striping
+information for all sub-directories within the specified directory. This
+can be expanded with
+.BR --recursive ,
+which will recurse into all subdirectories.
+.TP
+.BR \-X ",  " \-\-max-inherit
+Show the inherit depth of default layout.
+.TP
+.BR \-y ", " \-\-yaml
+Show the layout in YAML format for easier parsing.
+.TP
+.BR \-\-max-inherit-rr
+Show the inherit depth of default layout to roundrobin mkdir.
 .SH EXAMPLES
 .TP
 .B $ lfs getdirstripe -O lustre-MDT0001_UUID -r /mnt/lustre/dir1
 List the striping information of sub-directories, that are located on MDT1,
-under /mnt/lustre/dir1.
+under
+.BR /mnt/lustre/dir1 .
 .SH AVAILABILTY
 The lfs getdirstripe command is part of the Lustre filesystem.
 .SH SEE ALSO