| blob | e54260b411610fb87162571d424208699894d99e |
1 .\" Copyright (c) 1983, 1990, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Robert Elz at The University of Melbourne.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the University nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\" @(#)quotactl.2 8.2 (Berkeley) 3/10/95
32 .\" $FreeBSD: src/lib/libc/sys/quotactl.2,v 1.12.2.7 2002/05/20 09:06:37 roam Exp $
33 .\" $DragonFly: src/lib/libc/sys/quotactl.2,v 1.4 2006/05/26 19:39:37 swildner Exp $
34 .\"
35 .Dd March 5, 1999
36 .Dt QUOTACTL 2
37 .Os
38 .Sh NAME
39 .Nm quotactl
40 .Nd manipulate filesystem quotas
41 .Sh LIBRARY
42 .Lb libc
43 .Sh SYNOPSIS
44 .In sys/types.h
45 .In ufs/ufs/quota.h
46 .Ft int
47 .Fn quotactl "const char *path" "int cmd" "int id" "void *addr"
48 .Sh DESCRIPTION
49 The
50 .Fn quotactl
51 call enables, disables and
52 manipulates filesystem quotas.
53 A quota control command
54 given by
55 .Fa cmd
56 operates on the given filename
57 .Fa path
58 for the given user
59 .Fa id .
60 (NOTE: One should use the QCMD macro defined in
61 .In ufs/ufs/quota.h
62 to formulate the value for
63 .Fa cmd . )
64 The address of an optional command specific data structure,
65 .Fa addr ,
66 may be given; its interpretation
67 is discussed below with each command.
68 .Pp
69 Currently quotas are supported only for the
70 .Dq ufs
71 filesystem.
72 For
73 .Dq ufs ,
74 a command is composed of a primary command (see below)
75 and a command type used to interpret the
76 .Fa id .
77 Types are supported for interpretation of user identifiers (USRQUOTA)
78 and group identifiers (GRPQUOTA).
79 The
80 .Dq ufs
81 specific commands are:
82 .Bl -tag -width Q_QUOTAOFFxx
83 .It Dv Q_QUOTAON
84 Enable disk quotas for the filesystem specified by
85 .Fa path .
86 The command type specifies the type of the quotas being enabled.
87 The
88 .Fa addr
89 argument specifies a file from which to take the quotas.
90 The quota file must exist;
91 it is normally created with the
92 .Xr quotacheck 8
93 program.
94 The
95 .Fa id
96 argument is unused.
97 Only the super-user may turn quotas on.
98 .It Dv Q_QUOTAOFF
99 Disable disk quotas for the filesystem specified by
100 .Fa path .
101 The command type specifies the type of the quotas being disabled.
102 The
103 .Fa addr
104 and
105 .Fa id
106 arguments are unused.
107 Only the super-user may turn quotas off.
108 .It Dv Q_GETQUOTA
109 Get disk quota limits and current usage for the user or group
110 (as determined by the command type) with identifier
111 .Fa id .
112 .Fa Addr
113 is a pointer to a
114 .Fa struct dqblk
115 structure (defined in
116 .In ufs/ufs/quota.h ) .
117 .It Dv Q_SETQUOTA
118 Set disk quota limits for the user or group
119 (as determined by the command type) with identifier
120 .Fa id .
121 .Fa Addr
122 is a pointer to a
123 .Fa struct dqblk
124 structure (defined in
125 .In ufs/ufs/quota.h ) .
126 The usage fields of the
127 .Fa dqblk
128 structure are ignored.
129 This call is restricted to the super-user.
130 .It Dv Q_SETUSE
131 Set disk usage limits for the user or group
132 (as determined by the command type) with identifier
133 .Fa id .
134 .Fa Addr
135 is a pointer to a
136 .Fa struct dqblk
137 structure (defined in
138 .In ufs/ufs/quota.h ) .
139 Only the usage fields are used.
140 This call is restricted to the super-user.
141 .It Dv Q_SYNC
142 Update the on-disk copy of quota usages.
143 The command type specifies which type of quotas are to be updated.
144 The
145 .Fa id
146 and
147 .Fa addr
148 parameters are ignored.
149 .El
150 .Sh RETURN VALUES
151 .Rv -std quotactl
152 .Sh ERRORS
153 A
154 .Fn quotactl
155 call will fail if:
156 .Bl -tag -width Er
157 .It Bq Er EOPNOTSUPP
158 The kernel has not been compiled with the
159 .Dv QUOTA
160 option.
161 .It Bq Er EUSERS
162 The quota table cannot be expanded.
163 .It Bq Er EINVAL
164 .Fa Cmd
165 or the command type is invalid.
166 In
167 .Dv Q_GETQUOTA
168 and
169 .Dv Q_SETQUOTA ,
170 quotas are not currently enabled for this filesystem.
171 .It Bq Er EACCES
172 In
173 .Dv Q_QUOTAON ,
174 the quota file is not a plain file.
175 .It Bq Er EACCES
176 Search permission is denied for a component of a path prefix.
177 .It Bq Er ENOTDIR
178 A component of a path prefix was not a directory.
179 .It Bq Er ENAMETOOLONG
180 A component of either pathname exceeded 255 characters,
181 or the entire length of either path name exceeded 1023 characters.
182 .It Bq Er ENOENT
183 A filename does not exist.
184 .It Bq Er ELOOP
185 Too many symbolic links were encountered in translating a pathname.
186 .It Bq Er EROFS
187 In
188 .Dv Q_QUOTAON ,
189 the quota file resides on a read-only filesystem.
190 .It Bq Er EIO
191 An
192 .Tn I/O
193 error occurred while reading from or writing
194 to a file containing quotas.
195 .It Bq Er EFAULT
196 An invalid
197 .Fa addr
198 was supplied; the associated structure could not be copied in or out
199 of the kernel.
200 .It Bq Er EFAULT
201 .Fa Path
202 points outside the process's allocated address space.
203 .It Bq Er EPERM
204 The call was privileged and the caller was not the super-user.
205 .El
206 .Sh SEE ALSO
207 .Xr quota 1 ,
208 .Xr fstab 5 ,
209 .Xr edquota 8 ,
210 .Xr quotacheck 8 ,
211 .Xr quotaon 8 ,
212 .Xr repquota 8
213 .Sh HISTORY
214 The
215 .Fn quotactl
216 function call appeared in
217 .Bx 4.3 Reno .
218 .Sh BUGS
219 There should be some way to integrate this call with the resource
220 limit interface provided by
221 .Xr setrlimit 2
222 and
223 .Xr getrlimit 2 .