| 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 December 2, 2011 |
| 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 |
| 43 | This manual page documents the |
| 44 | .Nm |
| 45 | utility which provides functions for managing virtual file system |
| 46 | accounting and quotas. |
| 47 | .Pp |
| 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. |
| 56 | .El |
| 57 | .Pp |
| 58 | The commands are as follows: |
| 59 | .Bl -tag -width indent |
| 60 | .\" ==== check ==== |
| 61 | .It Cm check Ar directory |
| 62 | Reports the space (in bytes) occupied by files names located in the |
| 63 | directory hierarchy present under |
| 64 | .Ar directory . |
| 65 | . |
| 66 | .\" ==== lsfs ==== |
| 67 | .It Cm lsfs |
| 68 | List mounted file systems having space accounting enabled |
| 69 | . |
| 70 | .\" ==== show ==== |
| 71 | .It Cm show Ar mount_point |
| 72 | Show file size usage for the file system mounted under |
| 73 | .Ar mount_point . |
| 74 | The information is broken down by uid and gid |
| 75 | . |
| 76 | .\" ==== sync ==== |
| 77 | .It Cm sync Ar mount_point |
| 78 | Initialize in one go the usage counters for the filesystem |
| 79 | mounted under |
| 80 | .Ar mount_point |
| 81 | with real usage data. This command scans an entire filesystem |
| 82 | directory hierarchy and may be slow to run |
| 83 | .El |
| 84 | . |
| 85 | .Sh EXAMPLES |
| 86 | The following is an example of a typical usage |
| 87 | of the |
| 88 | .Nm |
| 89 | command: |
| 90 | .Pp |
| 91 | .Dl "vquota show /mnt/data" |
| 92 | . |
| 93 | .Sh HISTORY |
| 94 | The |
| 95 | .Nm |
| 96 | utility first appeared in |
| 97 | .Dx 2.13 . |
| 98 | .Sh AUTHORS |
| 99 | .An Francois Tigeot Aq ftigeot@wolfpond.org |