From 72de3797771b1133e0a521c3612c814ab0fb6cdf Mon Sep 17 00:00:00 2001 From: adilger Date: Sat, 15 Mar 2008 08:59:52 +0000 Subject: [PATCH] Branch HEAD Update lyx.1 man page: - improve examples - order (almost) alphabetically - add missing "find" options - add SEE ALSO section Remove obsolete lfs.lyx version of man page. --- lustre/doc/lfs.1 | 111 +++++----- lustre/doc/lfs.lyx | 584 ----------------------------------------------------- 2 files changed, 59 insertions(+), 636 deletions(-) delete mode 100644 lustre/doc/lfs.lyx diff --git a/lustre/doc/lfs.1 b/lustre/doc/lfs.1 index d8455bb..bb9a30c 100644 --- a/lustre/doc/lfs.1 +++ b/lustre/doc/lfs.1 @@ -1,21 +1,25 @@ -.TH lfs 1 "2003 Oct 29" Lustre "configuration utilities" +.TH lfs 1 "2008 Mar 15" Lustre "user utilities" .SH NAME lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files .SH SYNOPSIS .br .B lfs .br -.B lfs find [--atime|-A N] [--mtime|-M N] [--ctime|-C N] [--maxdepth|-D N] - \fB[--print0|-P] [--print|-p] [--obd|-O ] \fR +.B lfs check .br -.B lfs find [--quiet|-q] [--verbose|-v] [--recursive|-r] +.B lfs df [-i] [-h] [path] .br -.B lfs getstripe [--obd|-O ] [--quiet|-q] [--verbose|-v] - \fB[--recursive|-r] \fR +.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 ] + \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}] + \fB\fR .br -.B lfs setstripe +.B lfs getstripe [--obd|-O ] [--quiet|-q] [--verbose|-v] + \fB[--recursive|-r] \fR .br -.B lfs setstripe [--size|-s stripe-size] [--index|-i start-ost] [--count|-c stripe-cnt] +.B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt] + \fB[--index|-i start-ost] \fR .br .B lfs setstripe -d .br @@ -27,37 +31,40 @@ lfs \- Lustre utility to create a file with specific striping pattern, find the .br .B lfs quotaoff [-ug] .br -.B lfs setquota [-u|-g] - \fB \fR +.B lfs setquota [-u|-g] + \fB + \fB\fR .br .B lfs setquota -t [-u|-g] .br -.B lfs quota [-o obd_uuid] [-u|-g] +.B lfs quota [-o obd_uuid] [-u|-g] .br .B lfs quota -t [-u|-g] .br -.B lfs check -.br -.B lfs df [-i] [-h] [path] +.B lfs help .SH DESCRIPTION .B lfs -can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and -location) for a specific file. It can be invoked interactively without any -arguments or in a non-interactive mode with one of the arguements supported. +can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and location) for a specific file. It can be invoked interactively without any arguments or in a non-interactive mode with one of the arguements supported. .SH OPTIONS The various options supported by lctl are listed and explained below: .TP -.B setstripe -To create a new file with a specific striping pattern +.B check +Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs) +.TP +.B df +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). 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 and null character correspondingly. Using one of these options works in the new (filename only) mode. +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. .TP -.B find -To list the striping info for a given filename or files in a directory or recursively for all files in a directory tree use one of the following options: \fB[--quiet|-q] [--verbose|-v] [--recursive|-r]\fR. If one of these options is given find works in old (obsolete, please use getstripe instead) filename and striping mode. +.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). .TP -.B getstripe -To list the striping info for given filename or files in a directory or recursively for all files in a directory tree. It can also be used to list the files that have objects on a specific OST. +.B osts +List all the OSTs for the filesystem +.TP +.B setstripe +To create a new file with a specific striping pattern .TP .B quotachown To change files' owner and group on OSTs of the specified filesystem @@ -77,21 +84,12 @@ To set filesystem quotas for users or groups. Limits are specific as blocks and .B setquota -t [-u|-g] To set filesystem quota grace times for users or groups. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer seconds value, see EXAMPLES .TP -.B quota [-o obd_uuid] [-u|-g] +.B quota [-o obd_uuid] [-u|-g] To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name must be specified. .TP .B quota -t [-u|-g] To display block and inode grace times for user (-u) or group (-g) quotas .TP -.B check -Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs) -.TP -.B osts -List all the OSTs for the filesystem -.TP -.B df -Report filesystem disk space usage or inodes usage of each MDT/OST. -.TP .B help Provides brief help on the various arguments .TP @@ -99,23 +97,35 @@ Provides brief help on the various arguments Quit the interactive lfs session .SH EXAMPLES .TP -.B $ lfs setstripe /mnt/lustre/file1 131072 -1 2 +.B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1 This creats a file striped on two OSTs with 128kB on each stripe. .TP .B $ lfs setstripe -d /mnt/lustre/dir This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein. .TP -.B $ lfs find /mnt/lustre/file1 -Lists the object allocation of a given file +.B $ lfs getstripe -v /mnt/lustre/file1 +Lists the detailed object allocation of a given file .TP -.B $ lfs find /mnt/lustre/ -Lists the object allocationss of all files in a given directory +.B $ lfs find /mnt/lustre +Efficiently lists all files in a given directory and its subdirectories .TP -.B $ lfs find -r /mnt/lustre/ -Recursively list the objects of all files in a given directory tree +.B $ lfs find /mnt/lustre -mtime +30 -type f -print +Recursively list all regular files in given directory more than 30 days old .TP -.B $ lfs find -r --obd OST2-UUID /mnt/lustre/ +.B $ lfs find --obd OST2-UUID /mnt/lustre/ Recursively list all files in a given directory that have objects on OST2-UUID. +.tP +.B $ lfs check servers +Check the status of all servers (MDT, OST) +.TP +.B $ lfs osts +List all the OSTs +.TP +.B $ lfs df -h +Lists space usage per OST and MDT in human readable format. +.TP +.B $ lfs df -i +Lists inode usage per OST and MDT .TP .B $ lfs quotachown -i /mnt/lustre Change file owner and group @@ -140,14 +150,11 @@ List quotas of user `bob' .TP .B $ lfs quota -t -u /mnt/lustre Show grace times for user quotas on /mnt/lustre -.TP -.B $ lfs check servers -Check the status of all servers (MDT, OST) -.TP -.B $ lfs osts -List all the OSTs -.TP -.B $ lfs df -i -Lists inode consumpton per OST and MDT .SH BUGS -None are known. +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. +.SH SEE ALSO +.BR lctl (8), +.BR lustre (7) diff --git a/lustre/doc/lfs.lyx b/lustre/doc/lfs.lyx deleted file mode 100644 index d29e62e..0000000 --- a/lustre/doc/lfs.lyx +++ /dev/null @@ -1,584 +0,0 @@ -#LyX 1.4.4 created this file. For more info see http://www.lyx.org/ -\lyxformat 245 -\begin_document -\begin_header -\textclass amsart -\language english -\inputencoding auto -\fontscheme times -\graphics default -\paperfontsize default -\spacing single -\papersize letterpaper -\use_geometry false -\use_amsmath 1 -\cite_engine basic -\use_bibtopic false -\paperorientation portrait -\secnumdepth 3 -\tocdepth 3 -\paragraph_separation skip -\defskip medskip -\quotes_language english -\papercolumns 1 -\papersides 1 -\paperpagestyle default -\tracking_changes false -\output_changes true -\end_header - -\begin_body - -\begin_layout Section -LFS -\end_layout - -\begin_layout Subsection -NAME -\end_layout - -\begin_layout Description -lfs Lustre utility to create a file with specific striping pattern and manipulat -e disk quotas -\end_layout - -\begin_layout Subsection -SYNOPSIS -\end_layout - -\begin_layout Standard - -\series bold -lfs -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -find [--atime|-A N] [--mtime|-M N] [--ctime|-C N] [--maxdepth|-D N] [--print0 -|-P] [--print|-p] [--obd|-O ] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -find [--quiet|-q] [--verbose|-v] [--recursive|-r] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -getstripe [--obd|-O ] [--quiet|-q] [--verbose|-v] [--recursive|-r] - -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -setstripe -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace \space{} -setstripe [--size|-s stripe_size] [--index|-i start_ost] - [--count|-c stripe_cnt] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -setstripe -d -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -check -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -quotachog [-i] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -quotacheck [-ug] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -quotaon [-ugf] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -quotaoff [-ug] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -setquota [-u|-g] - -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -setquota -t [-u|-g] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -quota [-o obd_uuid] [-u|-g] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -df [-i] [-h] [path] -\end_layout - -\begin_layout Standard - -\series bold -lfs\InsetSpace ~ -help -\end_layout - -\begin_layout Subsection -DESCRIPTION -\end_layout - -\begin_layout Standard -This utility can be used to create a new file with a specific striping pattern, - determine the default striping pattern, gather the extended attributes - (object numbers and location) for a specific file, and manipulate disk - quotas. - It can be invoked interactively without any arguments or in a non-interactive - mode with one of the arguements listed and explained below: -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -setstripe -\series default - To create a new file with a specific striping pattern -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -find -\series default - To search the directory tree rooted at the given dir/file name for the - files that match the given parameters: --atime (file was last accessed - N*24 hours ago), --ctime (file's status was last changed N*24 hours ago), - --mtime (file's data was last modified N*24 hours ago), --obd (file has - an object on a specific OST). - The option --maxdepth allows find to decend at most N levels of directory - tree. - The options --print and --print0 print full file name, followed by a newline - and null character correspondingly. -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -find -\series default - To list the striping info for a given filename or files in a directory - or recursively for all files in a directory tree use one of the following - options: [--quiet|-q] [--verbose|-v] [--recursive|-r]. - If one of these options is given find works in old (obsolete, please use - getstripe instead) mode. - -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -getstripe -\series default - To list the striping info for given filename or files in a directory or - recursively for all files in a directory tree. - It can also be used to list the files that have objects on a specific OST. -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -check -\series default -Display the status of MDS or OSTs (as specified in the command) or all the - servers (MDS and OSTs) -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -osts -\series default - List all the OSTs for the filesystem -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -quotachog -\series default - Change files' owner and group on OSTs of the specified filesystem -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -quotacheck -\series default - Scan the specified filesystem for disk usage, and create or update quota - files -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -quotaon -\series default - Turn filesystem quotas on -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -quotaoff -\series default - Turn filesystem quotas off -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -setquota -\series default - Set filesystem quotas -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -quota -\series default - Display disk usage and limits -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -df -\series default - Report filesystem disk space usage or inodes usage of each MDS/OSD. -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -help -\series default - Provides brief help on the various arguments -\end_layout - -\begin_layout List -\labelwidthstring 00.00.0000 - -\series bold -exit/quit -\series default - Quit the interactive lfs session -\end_layout - -\begin_layout Subsection -EXAMPLES -\end_layout - -\begin_layout Description -This creates a file striped on one OST -\end_layout - -\begin_layout LyX-Code - $ lfs setstripe /mnt/lustre/file1 131072 0 1 -\end_layout - -\begin_layout Description -This creates a default stripe pattern on and existing dir for all new files - created therein. -\end_layout - -\begin_layout LyX-Code - $ lfs setstripe /mnt/lustre/dir 131072 0 1 -\end_layout - -\begin_layout Description -This deletes a default stripe pattern on dir. - New files will use the default striping pattern. - created therein. -\end_layout - -\begin_layout LyX-Code - $ lfs setstripe -d /mnt/lustre/dir -\end_layout - -\begin_layout Description -Listing the extended attributes of a given file -\end_layout - -\begin_layout LyX-Code - $ lfs find /mnt/lustre/foo1 -\end_layout - -\begin_layout LyX-Code - OBDS: -\end_layout - -\begin_layout LyX-Code - 0: OST_localhost_UUID -\end_layout - -\begin_layout LyX-Code - /mnt/lustre/foo1 -\end_layout - -\begin_layout LyX-Code - obdidx objid objid group -\end_layout - -\begin_layout LyX-Code - 0 1 0x1 0 -\end_layout - -\begin_layout Description -Listing the extended attributes of all files in a given directory -\end_layout - -\begin_layout LyX-Code - $ lfs find /mnt/lustre/ -\end_layout - -\begin_layout Description -Recursively list the extended attributes of all files in a given directory - tree -\end_layout - -\begin_layout LyX-Code - $ lfs find -r /mnt/lustre/ -\end_layout - -\begin_layout Description -List all the files that have objects on a specific OST -\end_layout - -\begin_layout LyX-Code - $ lfs find -r --obd OST2_UUID /mnt/lustre/ -\end_layout - -\begin_layout Description -Check the status of all servers(mds, osts) -\end_layout - -\begin_layout LyX-Code - $ lfs check servers -\end_layout - -\begin_layout LyX-Code - OSC_localhost.localdomain_OST_localhost_mds1 active. - -\end_layout - -\begin_layout LyX-Code - OSC_localhost.localdomain_OST_localhost_MNT_localhost active. - -\end_layout - -\begin_layout LyX-Code - MDC_localhost.localdomain_mds1_MNT_localhost active. -\end_layout - -\begin_layout LyX-Code - $ -\end_layout - -\begin_layout Description -List all the OSTs -\end_layout - -\begin_layout LyX-Code - $ lfs osts -\end_layout - -\begin_layout LyX-Code - OBDS: -\end_layout - -\begin_layout LyX-Code - 0: OST_localhost_UUID -\end_layout - -\begin_layout LyX-Code - $ -\end_layout - -\begin_layout Description -Change\InsetSpace ~ -file\InsetSpace ~ -owner\InsetSpace ~ -and\InsetSpace ~ -group -\end_layout - -\begin_layout LyX-Code - $lfs quotachog -i /mnt/lustre -\end_layout - -\begin_layout Description -Quotacheck\InsetSpace ~ -for\InsetSpace ~ -user\InsetSpace ~ -and\InsetSpace ~ -group -\end_layout - -\begin_layout LyX-Code - $lfs quotacheck -ug /mnt/lustre -\end_layout - -\begin_layout Description -Turn\InsetSpace ~ -quotas\InsetSpace ~ -of\InsetSpace ~ -user\InsetSpace ~ -and\InsetSpace ~ -group\InsetSpace ~ -on -\end_layout - -\begin_layout LyX-Code - $lfs quotaon -ug /mnt/lustre -\end_layout - -\begin_layout Description -Turn\InsetSpace ~ -quotas\InsetSpace ~ -of\InsetSpace ~ -user\InsetSpace ~ -and\InsetSpace ~ -group\InsetSpace ~ -off -\end_layout - -\begin_layout LyX-Code - $lfs quotaoff -ug /mnt/lustre -\end_layout - -\begin_layout Description -Set\InsetSpace ~ -quotas\InsetSpace ~ -of\InsetSpace ~ -user\InsetSpace ~ -`bob':\InsetSpace ~ -1GB\InsetSpace ~ -block\InsetSpace ~ -quota\InsetSpace ~ -and\InsetSpace ~ -10,000\InsetSpace ~ -file\InsetSpace ~ -quota -\end_layout - -\begin_layout LyX-Code - $lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre -\end_layout - -\begin_layout Description -Set\InsetSpace ~ -grace\InsetSpace ~ -times\InsetSpace ~ -for\InsetSpace ~ -user\InsetSpace ~ -quotas:\InsetSpace ~ -1000\InsetSpace ~ -seconds\InsetSpace ~ -for\InsetSpace ~ -block\InsetSpace ~ -quotas,\InsetSpace ~ -1\InsetSpace ~ -week\InsetSpace ~ -and\InsetSpace ~ -4\InsetSpace ~ -days\InsetSpace ~ -for\InsetSpace ~ -inode\InsetSpace ~ -quotas -\end_layout - -\begin_layout LyX-Code - $lfs setquota -t -u 1000 1w4d /mnt/lustre -\end_layout - -\begin_layout Description -List\InsetSpace ~ -quotas\InsetSpace ~ -of\InsetSpace ~ -user\InsetSpace ~ -`bob' -\end_layout - -\begin_layout LyX-Code - $lfs quota -u bob /mnt/lustre -\end_layout - -\begin_layout Subsection -BUGS -\end_layout - -\begin_layout Standard -None are known. -\end_layout - -\end_body -\end_document -- 1.8.3.1