lib/libc/sys/vquotactl.2

   1 .\" Copyright (c) 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 April 28, 2012
  29 .Dt VQUOTACTL 2
  30 .Os
  31 .Sh NAME
  32 .Nm vquotactl
  33 .Nd set or return VFS quota data
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/vfs_quota.h
  38 .Ft int
  39 .Fn vquotactl "const char *path" "struct plistref *pref"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vquotactl
  43 call serves as the only kernel/userland VFS quota interface.
  44 .Xr proplib 3
  45 messages specific to the
  46 .Fa path
  47 mount point are sent or returned via the
  48 .Fa pref
  49 parameter.
  50 .Pp
  51 To use the
  52 .Fn vquotactl
  53 call, the
  54 .Va vfs.quota_enabled
  55 tunable needs to be set in
  56 .Xr loader.conf 5 .
  57 .Sh RETURN VALUES
  58 .Rv -std vquotactl
  59 .Sh ERRORS
  60 A
  61 .Fn vquotactl
  62 call may return the following error codes:
  63 .Bl -tag -width Er
  64 .It Bq Er EOPNOTSUPP
  65 VFS quota support has not been enabled at system startup
  66 .It Bq Er EINVAL
  67 The message embedded in the
  68 .Fa pref
  69 argument was not understood.
  70 .El
  71 .Sh SEE ALSO
  72 .Xr loader.conf 5 ,
  73 .Xr vquota 8
  74 .Sh HISTORY
  75 The
  76 .Fn vquotactl
  77 function call appeared in
  78 .Dx 2.13 .
  79 .Sh AUTHORS
  80 .An Francois Tigeot