[dragonfly.git] / sbin / vquota / vquota.8

.\" Copyright (c) 2011,2012 François Tigeot
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.
.\" Note: The date here should be updated whenever a non-trivial
.\" change is made to the manual page.
.Dd March 23, 2012
.Dt VQUOTA 8
.Os
.Sh NAME
.Nm vquota
.Nd VFS quota system utility
.
.Sh SYNOPSIS
.Nm
.Oo
.Fl D | h
.Oc
.Ar command
.Ar argument
.Sh DESCRIPTION
This manual page documents the
.Nm
utility which provides functions for managing virtual file system
accounting and quotas.
.Pp
The following options are available:
.Bl -tag -width Ds
.It Fl D
Debug flag, show raw messages sent to and received from kernel
.It Fl h
"Human-readable" output. Use unit suffixes: Byte, Kilobyte, Megabyte,
Gigabyte, Terabyte and Petabyte in order to reduce the number of
digits to four or fewer.
.It Fl n
Show raw user and group ids. Normally
.Nm
attempts to resolve and display full user and group names.
.El
.Pp
The commands are as follows:
.Bl -tag -width indent
.\" ==== check ====
.It Cm check Ar directory
Reports the space (in bytes) occupied by files names located in the
directory hierarchy present under
.Ar directory .
.
.\" ==== lsfs ====
.It Cm lsfs
List mounted file systems having space accounting enabled
.
.\" ==== show ====
.It Cm show Ar mount_point
Show file size usage and quota limits for the file system mounted under
.Ar mount_point .
The information is broken down by uid and gid
.
.\" ==== sync ====
.It Cm sync Ar mount_point
Initialize in one go the usage counters for the filesystem
mounted under
.Ar mount_point
with real usage data. This command scans an entire filesystem
directory hierarchy and may be slow to run
.\" ==== limit ====
.It Cm limit Ar mount_point size
Set a global quota of
.Ar size
bytes for the filesystem mounted under
.Ar mount_point .
.\" ==== ulim ====
.It Cm ulim Ar mount_point user size
Set a quota of
.Ar size
bytes for the filesystem mounted under
.Ar mount_point
and the specified
.Ar user .
.\" ==== glim ====
.It Cm glim Ar mount_point group size
Set a quota of
.Ar size
bytes for the filesystem mounted under
.Ar mount_point
and the specified
.Ar group .
.El
.
.Sh EXAMPLES
The following is an example of a typical usage
of the
.Nm
command:
.Pp
.Dl "vquota show /mnt/data"
.
.Sh HISTORY
The
.Nm
utility first appeared in
.Dx 2.13 .
.Sh AUTHORS
.An Francois Tigeot Aq ftigeot@wolfpond.org
Commit	Line	Data
c115b876	1	.\" Copyright (c) 2011,2012 François Tigeot
b3ee253f FT	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\"
	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	14	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	15	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	16	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	17	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	18	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	19	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	20	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	21	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	22	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	23	.\" SUCH DAMAGE.
	24	.\"
dff33cb0	25	.
b3ee253f FT	26	.\" Note: The date here should be updated whenever a non-trivial
b3ee253f FT	27	.\" change is made to the manual page.
c115b876	28	.Dd March 23, 2012
b3ee253f FT	29	.Dt VQUOTA 8
	30	.Os
	31	.Sh NAME
	32	.Nm vquota
	33	.Nd VFS quota system utility
dff33cb0	34	.
b3ee253f FT	35	.Sh SYNOPSIS
b3ee253f FT	36	.Nm
c4d75bef FT	37	.Oo
	38	.Fl D \| h
	39	.Oc
b3ee253f FT	40	.Ar command
	41	.Ar argument
	42	.Sh DESCRIPTION
	43	This manual page documents the
	44	.Nm
	45	utility which provides functions for managing virtual file system
	46	accounting and quotas.
	47	.Pp
c4d75bef FT	48	The following options are available:
	49	.Bl -tag -width Ds
	50	.It Fl D
	51	Debug flag, show raw messages sent to and received from kernel
	52	.It Fl h
	53	"Human-readable" output. Use unit suffixes: Byte, Kilobyte, Megabyte,
	54	Gigabyte, Terabyte and Petabyte in order to reduce the number of
	55	digits to four or fewer.
bc844d36 FT	56	.It Fl n
	57	Show raw user and group ids. Normally
	58	.Nm
	59	attempts to resolve and display full user and group names.
c4d75bef FT	60	.El
c4d75bef FT	61	.Pp
b3ee253f FT	62	The commands are as follows:
	63	.Bl -tag -width indent
	64	.\" ==== check ====
	65	.It Cm check Ar directory
44700357	66	Reports the space (in bytes) occupied by files names located in the
b3ee253f	67	directory hierarchy present under
44700357	68	.Ar directory .
a3dce641 FT	69	.
	70	.\" ==== lsfs ====
	71	.It Cm lsfs
	72	List mounted file systems having space accounting enabled
b4d6d8bb FT	73	.
	74	.\" ==== show ====
	75	.It Cm show Ar mount_point
c115b876	76	Show file size usage and quota limits for the file system mounted under
b4d6d8bb FT	77	.Ar mount_point .
b4d6d8bb FT	78	The information is broken down by uid and gid
88c2e66c FT	79	.
	80	.\" ==== sync ====
	81	.It Cm sync Ar mount_point
	82	Initialize in one go the usage counters for the filesystem
	83	mounted under
	84	.Ar mount_point
	85	with real usage data. This command scans an entire filesystem
	86	directory hierarchy and may be slow to run
c115b876 FT	87	.\" ==== limit ====
	88	.It Cm limit Ar mount_point size
	89	Set a global quota of
	90	.Ar size
	91	bytes for the filesystem mounted under
	92	.Ar mount_point .
c6e8a1bd FT	93	.\" ==== ulim ====
	94	.It Cm ulim Ar mount_point user size
	95	Set a quota of
	96	.Ar size
	97	bytes for the filesystem mounted under
	98	.Ar mount_point
	99	and the specified
	100	.Ar user .
3663c79b FT	101	.\" ==== glim ====
	102	.It Cm glim Ar mount_point group size
	103	Set a quota of
	104	.Ar size
	105	bytes for the filesystem mounted under
	106	.Ar mount_point
	107	and the specified
	108	.Ar group .
dff33cb0 SW	109	.El
dff33cb0 SW	110	.
b4d6d8bb FT	111	.Sh EXAMPLES
	112	The following is an example of a typical usage
	113	of the
	114	.Nm
	115	command:
	116	.Pp
	117	.Dl "vquota show /mnt/data"
	118	.
b3ee253f FT	119	.Sh HISTORY
	120	The
	121	.Nm
	122	utility first appeared in
	123	.Dx 2.13 .
	124	.Sh AUTHORS
	125	.An Francois Tigeot Aq ftigeot@wolfpond.org