xref: /dragonfly/sbin/vquota/vquota.8 (revision 7eedf208)
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.\"
25.
26.\" Note: The date here should be updated whenever a non-trivial
27.\" change is made to the manual page.
28.Dd January 19, 2012
29.Dt VQUOTA 8
30.Os
31.Sh NAME
32.Nm vquota
33.Nd VFS quota system utility
34.
35.Sh SYNOPSIS
36.Nm
37.Oo
38.Fl D | h
39.Oc
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
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.It Fl n
57Show raw user and group ids. Normally
58.Nm
59attempts to resolve and display full user and group names.
60.El
61.Pp
62The commands are as follows:
63.Bl -tag -width indent
64.\" ==== check ====
65.It Cm check Ar directory
66Reports the space (in bytes) occupied by files names located in the
67directory hierarchy present under
68.Ar directory .
69.
70.\" ==== lsfs ====
71.It Cm lsfs
72List mounted file systems having space accounting enabled
73.
74.\" ==== show ====
75.It Cm show Ar mount_point
76Show file size usage for the file system mounted under
77.Ar mount_point .
78The information is broken down by uid and gid
79.
80.\" ==== sync ====
81.It Cm sync Ar mount_point
82Initialize in one go the usage counters for the filesystem
83mounted under
84.Ar mount_point
85with real usage data. This command scans an entire filesystem
86directory hierarchy and may be slow to run
87.El
88.
89.Sh EXAMPLES
90The following is an example of a typical usage
91of the
92.Nm
93command:
94.Pp
95.Dl "vquota show /mnt/data"
96.
97.Sh HISTORY
98The
99.Nm
100utility first appeared in
101.Dx 2.13 .
102.Sh AUTHORS
103.An Francois Tigeot Aq ftigeot@wolfpond.org
104