sbin/vquota/vquota.8

   1 .\" Copyright (c) 2011,2012 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 March 28, 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
  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 To use the
  49 .Nm
  50 utility, the
  51 .Va vfs.quota_enabled
  52 tunable needs to be set in
  53 .Xr loader.conf 5 .
  54 .Pp
  55 The following options are available:
  56 .Bl -tag -width Ds
  57 .It Fl D
  58 Debug flag, show raw messages sent to and received from kernel
  59 .It Fl h
  60 "Human-readable" output. Use unit suffixes: Byte, Kilobyte, Megabyte,
  61 Gigabyte, Terabyte and Petabyte in order to reduce the number of
  62 digits to four or fewer.
  63 .It Fl n
  64 Show raw user and group ids. Normally
  65 .Nm
  66 attempts to resolve and display full user and group names.
  67 .El
  68 .Pp
  69 The commands are as follows:
  70 .Bl -tag -width indent
  71 .\" ==== check ====
  72 .It Cm check Ar directory
  73 Reports the space (in bytes) occupied by files names located in the
  74 directory hierarchy present under
  75 .Ar directory .
  76 .
  77 .\" ==== lsfs ====
  78 .It Cm lsfs
  79 List mounted file systems having space accounting enabled
  80 .
  81 .\" ==== show ====
  82 .It Cm show Ar mount_point
  83 Show file size usage and quota limits for the file system mounted under
  84 .Ar mount_point .
  85 The information is broken down by uid and gid and is expressed by default
  86 in bytes.
  87 .
  88 .\" ==== sync ====
  89 .It Cm sync Ar mount_point
  90 Initialize in one go the usage counters for the filesystem
  91 mounted under
  92 .Ar mount_point
  93 with real usage data. This command scans an entire filesystem
  94 directory hierarchy and may be slow to run
  95 .\" ==== limit ====
  96 .It Cm limit Ar mount_point size
  97 Set a global quota of
  98 .Ar size
  99 bytes for the filesystem mounted under
 100 .Ar mount_point .
 101 .\" ==== ulim ====
 102 .It Cm ulim Ar mount_point user 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 user .
 109 .\" ==== glim ====
 110 .It Cm glim Ar mount_point group size
 111 Set a quota of
 112 .Ar size
 113 bytes for the filesystem mounted under
 114 .Ar mount_point
 115 and the specified
 116 .Ar group .
 117 .El
 118 .Pp
 119 A limit of 0 effectively means checks are disabled.
 120 .
 121 .Sh EXAMPLES
 122 The following is an example of a typical usage
 123 of the
 124 .Nm
 125 command:
 126 .Pp
 127 .Dl "vquota show /mnt/data"
 128 .
 129 .Sh SEE ALSO
 130 .Xr vquotactl 2 ,
 131 .Xr loader.conf 5
 132 .Sh HISTORY
 133 The
 134 .Nm
 135 utility first appeared in
 136 .Dx 2.13 .
 137 .Sh AUTHORS
 138 .An Francois Tigeot Aq ftigeot@wolfpond.org