vquota(8): add a -h flag
[dragonfly.git] / sbin / vquota / vquota.8
CommitLineData
b3ee253f
FT
1.\" Copyright (c) 2011 Fran├žois Tigeot
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
27.\" change is made to the manual page.
28.Dd December 2, 2011
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
36.Nm
c4d75bef
FT
37.Oo
38.Fl D | h
39.Oc
b3ee253f
FT
40.Ar command
41.Ar argument
42.Sh DESCRIPTION
43This manual page documents the
44.Nm
45utility which provides functions for managing virtual file system
46accounting and quotas.
47.Pp
c4d75bef
FT
48The following options are available:
49.Bl -tag -width Ds
50.It Fl D
51Debug flag, show raw messages sent to and received from kernel
52.It Fl h
53"Human-readable" output. Use unit suffixes: Byte, Kilobyte, Megabyte,
54Gigabyte, Terabyte and Petabyte in order to reduce the number of
55digits to four or fewer.
56.El
57.Pp
b3ee253f
FT
58The commands are as follows:
59.Bl -tag -width indent
60.\" ==== check ====
61.It Cm check Ar directory
44700357 62Reports the space (in bytes) occupied by files names located in the
b3ee253f 63directory hierarchy present under
44700357 64.Ar directory .
a3dce641
FT
65.
66.\" ==== lsfs ====
67.It Cm lsfs
68List mounted file systems having space accounting enabled
b4d6d8bb
FT
69.
70.\" ==== show ====
71.It Cm show Ar mount_point
72Show file size usage for the file system mounted under
73.Ar mount_point .
74The information is broken down by uid and gid
dff33cb0
SW
75.El
76.
b4d6d8bb
FT
77.Sh EXAMPLES
78The following is an example of a typical usage
79of the
80.Nm
81command:
82.Pp
83.Dl "vquota show /mnt/data"
84.
b3ee253f
FT
85.Sh HISTORY
86The
87.Nm
88utility first appeared in
89.Dx 2.13 .
90.Sh AUTHORS
91.An Francois Tigeot Aq ftigeot@wolfpond.org