Whamcloud - gitweb
LU-930 utils: add --help option to lfs sub-commands
[fs/lustre-release.git] / lustre / doc / lfs-getdirstripe.1
1 .TH LFS-GETDIRSTRIPE 1 2017-11-07 "Lustre" "Lustre Utilities"
2 .SH NAME
3 lfs getdirstripe \- list the layout pattern of a given directory
4 .SH SYNOPSIS
5 .BR "lfs getdirstripe" " [" -cDhHimOrTXvy "]... " \fIDIR\fR...
6 .SH DESCRIPTION
7 Get the layout pattern of striped directories. This
8 .BR lfs (1)
9 command is similar to
10 .BR "lfs getstripe" ,
11 but is used for the directory layout.
12 .SH OPTIONS
13 .TP
14 .BR \-c ", " \-T ", " \-\-mdt-count
15 Only show the number of MDTs the directory is striped across.
16 .TP
17 .BR \-D ", " \-\-default
18 Show the default layout used when creating new subdirectories.
19 .TP
20 .BR \-h ", " \-\-help
21 Print usage message.
22 .TP
23 .BR \-H ", " \-\-mdt-hash
24 Only show the hash function being used for this directory.
25 .TP
26 .BR \-i ", " \-m ", " \-\-mdt-index
27 Only show the master MDT index of the directory.
28 .TP
29 \fB\-O\fR, \fB\-\-obd\fR=\fIFSNAME-MDTnnnn_UUID\fR
30 Limit the returned directories to those with objects on a specific MDT,
31 whose UUID is
32 .I FSNAME-MDTnnnn_UUID.
33 .TP
34 .BR \-r ", " \-\-recursive
35 The default behavior when a directory is specified is to list the striping
36 information for all sub-directories within the specified directory. This
37 can be expanded with
38 .BR --recursive ,
39 which will recurse into all subdirectories.
40 .TP
41 .BR \-X ",  " \-\-max-inherit
42 Show the inherit depth of default layout.
43 .TP
44 .BR \-y ", " \-\-yaml
45 Show the layout in YAML format for easier parsing.
46 .TP
47 .BR \-\-max-inherit-rr
48 Show the inherit depth of default layout to roundrobin mkdir.
49 .SH EXAMPLES
50 .TP
51 .B $ lfs getdirstripe -O lustre-MDT0001_UUID -r /mnt/lustre/dir1
52 List the striping information of sub-directories, that are located on MDT1,
53 under
54 .BR /mnt/lustre/dir1 .
55 .SH AVAILABILTY
56 The lfs getdirstripe command is part of the Lustre filesystem.
57 .SH SEE ALSO
58 .BR lfs (1),
59 .BR lfs-setdirstripe (1),
60 .BR lfs-getstripe (1),
61 .BR lustre (7)