From: Gian-Carlo DeFazio Date: Tue, 7 Apr 2020 01:47:40 +0000 (-0700) Subject: LU-13353 quota: add man page for lfs quota X-Git-Tag: 2.13.54~183 X-Git-Url: https://git.whamcloud.com/?p=fs%2Flustre-release.git;a=commitdiff_plain;h=fba945ca0daa6a442a01f5174a0ba8b6d94294b9;ds=sidebyside LU-13353 quota: add man page for lfs quota Add a man page for lfs-quota and remove quota command from lfs man page. References to quotaon, quotaoff, and quotacheck are removed because these subcommands no longer exist. Test-Parameters: trivial Signed-off-by: Gian-Carlo DeFazio Change-Id: I9321b953e072e7fbb4a5f97f5f9033dd4a3a81dc Reviewed-on: https://review.whamcloud.com/38183 Reviewed-by: Andreas Dilger Tested-by: jenkins Reviewed-by: Olaf Faaland-LLNL Tested-by: Maloo --- diff --git a/lustre/doc/Makefile.am b/lustre/doc/Makefile.am index 54819f0..2896ba2 100644 --- a/lustre/doc/Makefile.am +++ b/lustre/doc/Makefile.am @@ -70,6 +70,7 @@ MANFILES = \ lfs-pcc.1 \ lfs-pcc-detach.1 \ lfs-project.1 \ + lfs-quota.1 \ lfs-rmfid.1 \ lfs-setdirstripe.1 \ lfs-setquota.1 \ diff --git a/lustre/doc/lfs-quota.1 b/lustre/doc/lfs-quota.1 new file mode 100644 index 0000000..0e74700 --- /dev/null +++ b/lustre/doc/lfs-quota.1 @@ -0,0 +1,114 @@ +.TH LFS-QUOTA 1 2020-04-06 "Lustre" "Lustre Utilities" +.SH NAME +lfs quota \- display quota limits and status for users, groups, or projects. +.SH SYNOPSIS +.B lfs quota \fR[\fB-hqv\fR] + [\fB-o <\fIobd_uuid\fR>|\fB-I <\fIost_idx\fR>|\fB-i <\fImdt_idx\fR>] + [\fB-u <\fIuname\fR|\fIuid\fR>|\fB-g <\fIgname\fR|\fIgid\fR>\ +|\fB-p <\fIprojid\fR>] + <\fIfilesystem\fR>\fR + +.br +.B lfs quota \fR[\fB-hq\fR] \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR> +.br + +.br +.B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> <\fIfilesystem\fR> +.br + +.TP +.SH DESCRIPTION +.PP +.B lfs quota <\fIfilesystem\fR>\fR +.TP + +Display disk usage and limits for individual users, groups, and projects. \ +By default the statistics for the entire filesystem are displayed but \ +individual MDTs and OSTs can be specified. \ +A user or group name or an ID can \ +be specified. If user, group and project are omitted, quotas for \ +current uid/gid/projid are shown. +.TP +.B -h +Human readable. This will change the formatting of \ +block storage and time values. Without this option block storage values \ +are in kilobytes and times are in seconds. With this option block storage \ +values use the common metric binary suffixes +.BR k "," M "," G "," T "," P "," E +which specify units of 2^10, 2^20, 2^30, 2^40, 2^50 and 2^60 \ +respectively. +Time values use the "XXwXXdXXhXXmXXs" format. This format specifies \ +weeks, days, hours, minutes, seconds. +.TP +.B -q +Quiet. Display only the line containing the data. \ +The line saying what the data is, and the line with the data +column headers will not be printed. +.TP +.B -v +Verbose. Display per-MDT and per-OST statistics in addition +to the usual system wide data. +.TP +.B -u <\fIuname|uid\fR> +Display user quota information for \fIuname\fR or \fIuid\fR. +.TP +.B -g <\fIgname|gid\fR> +Display group quota information for name \fIgname\fR or \fIgid\fR. +.TP +.B -p <\fIprojid\fR> +Display project quota information for \fIprojid\fR. +.TP +.B -o <\fIobd_uuid\fR> +Display quota information for \fIobd_uuid\fR. +.TP +.B -i <\fImdt_idx\fR> +Display project quota information for \fImdt_idx\fR. +.TP +.B -I <\fIost_idx\fR> +Display project quota information for \fIost_idx\fR. +.TP +.B lfs quota \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR> +.TP +Display default quota values for users, groups, or projects. \ +This command requires super user permissions. +.TP +.B -U <\fIuname|uid\fR> +Display default user quota information for <\fIfilesystem\fR>. +.TP +.B -G <\fIgname|gid\fR> +Display default group quota information for name <\fIfilesystem\fR>. +.TP +.B -P <\fIprojid\fR> +Display default project quota information for <\fIfilesystem\fR>. +.TP +.B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> <\fIfilesystem\fR> +.TP +Display grace times for users, groups, or projects. \ +The format is always "XXwXXdXXhXXmXXs". +.TP +.B -u <\fIuname|uid\fR> +Display default user grace times for <\fIfilesystem\fR>. +.TP +.B -g <\fIgname|gid\fR> +Display default group grace times for name <\fIfilesystem\fR>. +.TP +.B -p <\fIprojid\fR> +Display default project grace times for <\fIfilesystem\fR>. +.TP +.SH EXAMPLES +.TP +.B $ lfs quota /mnt/lustre +Display quotas and usage for current user, group, and project +.TP +.B $ lfs quota -u bob /mnt/lustre +Display quotas and usage for user 'bob' +.TP +.B $ lfs quota -U /mnt/lustre +Display default user quotas +.TP +.B $ lfs quota -t -u /mnt/lustre +Display grace times for user quotas on /mnt/lustre +.TP +.SH SEE ALSO +.BR lfs (1), +.BR lfs-setquota(1) diff --git a/lustre/doc/lfs-setquota.1 b/lustre/doc/lfs-setquota.1 index ffefa6a..620c841 100644 --- a/lustre/doc/lfs-setquota.1 +++ b/lustre/doc/lfs-setquota.1 @@ -124,4 +124,5 @@ Set system default user quota: 1 GB block softlimit and 2 GB block hardlimit Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 \ days for inode quotas .SH SEE ALSO -.BR lfs (1) +.BR lfs (1), +.BR lfs-quota(1) diff --git a/lustre/doc/lfs.1 b/lustre/doc/lfs.1 index f85cc3e..6d8d54f 100644 --- a/lustre/doc/lfs.1 +++ b/lustre/doc/lfs.1 @@ -101,20 +101,6 @@ lfs \- client utility for Lustre-specific file layout and other attributes .br .B lfs pool_list \fR<\fIfilesystem\fR>[\fB.\fR<\fIpool\fR>] | <\fIpathname\fR> .br -.B lfs quota \fR[\fB-qv\fR] [\fB-o \fIobd_uuid\fR|\fB-I \fIost_idx\fR|\fB-i \fImdt_idx\fR] - [\fB-u <\fIuname\fR|\fIuid\fR>|\fB-g <\fIgname\fR|\fIgid\fR>] -[\fB-p <\fIprojid\fR>] <\fIfilesystem\fR> -.br -.B lfs quota -t \fR<\fB-u\fR|\fB-g\fR|\fB-p\fR> <\fIfilesystem\fR> -.br -.B lfs quotacheck \fR[\fB-ug\fR] <\fIfilesystem\fR> -.br -.B lfs quota \fR<\fB-U\fR|\fB-G\fR|\fB-P\fR> <\fIfilesystem\fR> -.br -.B lfs quotaon \fR[\fB-ugf\fR] <\fIfilesystem\fR> -.br -.B lfs quotaoff \fR[\fB-ug\fR] <\fIfilesystem\fR> -.br .B lfs setstripe \fR[\fB--stripe-size\fR|\fB-S <\fIsize\fR>] [\fB--stripe-count\fR|-c <\fIcount\fR>] [\fB--stripe-index\fR|\fB-i <\fIstart_ost_index\fR>] [\fB--pool\fR|\fB-p \fR<\fIpoolname\fR>] [\fB--ost-list\fR|\fB-o <\fIost_indices\fR>] <\fIdirectory\fR|\fIfilename\fR> @@ -201,21 +187,6 @@ or or the OSTs in .IR filesystem.pool . .TP -.B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p ||||] -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 user group and project are omitted quotas for current uid/gid/projid are shown. -v provides more verbose (with per-obd statistics) output. -q disables printing of additional descriptions (including column titles). -.TP -.B quota -t <-u|-g|-p> -To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas -.TP -.B quotacheck [-ugf] (deprecated as of 2.4.0) -To scan the specified filesystem for disk usage, and create or update quota files. Options specify quota for users (-u) groups (-g) and force (-f). Not useful anymore with servers >= 2.4.0 since space accounting is always turned on. -.TP -.B quotaon [-ugf] (deprecated as of 2.4.0) -To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement must be enabled via conf_param (e.g. lctl conf_param ${FSNAME}.quota.=) -.TP -.B quotaoff [-ugf] (deprecated as of 2.4.0) -To turn filesystem quotas off. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement can be turned off (for inode or block) by running the following command on the MGS: lctl conf_param ${FSNAME}.quota.="" -.TP .B swap_layouts Swap the data (layout and OST objects) of two regular files. The two files have to be in the same filesystem, owned by the same user, @@ -262,24 +233,6 @@ List all the OSTs .B $ lfs mdts List all the MDTs .TP -.B $ lfs quota -u bob /mnt/lustre -List quotas of user `bob' -.TP -.B $ lfs quota -U /mnt/lustre -List user quotas of system default setting -.TP -.B $ lfs quota -t -u /mnt/lustre -Show grace times for user quotas on /mnt/lustre -.TP -.B $ lfs quotachown -i /mnt/lustre -Change file owner and group -.TP -.B $ lfs quotacheck -ug /mnt/lustre -Quotacheck for user and group - will turn on quotas after making the check. -.TP -.B $ lfs quotaon -ug /mnt/lustre -Turn quotas of user and group on -.TP .B $ lfs quotaoff -ug /mnt/lustre Turn quotas of user and group off .SH NOTES @@ -303,6 +256,7 @@ The lfs command is part of the Lustre filesystem. .BR lfs_migrate (1), .BR lfs-project (1), .BR lfs-path2fid (1), +.BR lfs-quota (1), .BR lfs-setdirstripe (1), .BR lfs-setquota (1), .BR lfs-setstripe (1),