BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / quotactl.2

diff --git a/usr/src/lib/libc/sys/quotactl.2 b/usr/src/lib/libc/sys/quotactl.2
index 5d2129d..e277452 100644 (file)
--- a/usr/src/lib/libc/sys/quotactl.2
+++ b/usr/src/lib/libc/sys/quotactl.2
@@ -1,159 +1,213 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1990, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)quotactl.2  6.5 (Berkeley) %G%
+.\" This code is derived from software contributed to Berkeley by
+.\" Robert Elz at The University of Melbourne.

 .\"
 .\"

-.TH QUOTA 2 ""
-.UC 5
-.SH NAME
-quota \- manipulate disk quotas
-.SH SYNOPSIS
-.nf
-.B #include <sys/quota.h>
-.PP
-.B quota(cmd, uid, arg, addr)
-.B int cmd, uid, arg;
-.B caddr_t addr;
-.fi
-.SH DESCRIPTION
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)quotactl.2  6.13 (Berkeley) 7/23/91
+.\"
+.Dd July 23, 1991
+.Dt QUOTACTL 2
+.Os
+.Sh NAME
+.Nm quotactl
+.Nd manipulate filesystem quotas
+.Sh SYNOPSIS
+.Ft #include <ufs/quota.h>     /* for ufs quotas */
+.Ft int
+.Fn quotactl "const char *path" "int cmd" "int id" "char *addr"
+.Sh DESCRIPTION
+The
+.Fn quotactl
+call enables, disables and
+manipulates filesystem quotas.
+A quota control command
+given by
+.Fa cmd
+operates on the given filename
+.Fa path
+for the given user
+.Fa id .
+The address of an optional command specific data structure,
+.Fa addr ,
+may be given; its interpretation
+is discussed below with each command.
+.Pp
+Currently quotas are supported only for the ``ufs'' filesystem.
+For ``ufs'',
+a command is composed of a primary command (see below)
+and a command type used to interpret the
+.Fa id .
+Types are supported for interpretation of user identifiers
+and group identifiers.
+The ``ufs'' specific commands are:
+.Bl -tag -width Q_QUOTAON
+.It Dv Q_QUOTAON
+Enable disk quotas for the filesystem specified by
+.Fa path .
+The command type specifies the type of the quotas being enabled.
+The
+.Fa addr
+argument specifies a file from which to take the quotas.
+The quota file must exist;
+it is normally created with the 
+.Xr quotacheck 8
+program.

 The
 The

-.I quota
-call manipulates disk quotas for file systems
-that have had quotas enabled with
-.IR setquota (2).
+.Fa id
+argument is unused.
+Only the super-user may turn quotas on.
+.It Dv Q_QUOTAOFF
+Disable disk quotas for the filesystem specified by
+.Fa path .
+The command type specifies the type of the quotas being disabled.

 The
 The

-.I cmd
-parameter indicates a command to be applied to
-the user ID
-.IR uid .
-.I Arg
-is a command specific argument and
-.I addr
-is the address of an optional, command specific, data structure
-that is copied in or out of the system.  The interpretation of
-.I arg
+.Fa addr

 and
 and

-.I addr
-is given with each command below.
-.TP
-Q_SETDLIM
-Set disc quota limits and current usage for the user with ID
-.IR uid .
-.I Arg
-is a major-minor device indicating a particular file system.
-.I Addr
-is a pointer to a struct dqblk structure (defined in 
-.RI < sys/quota.h >).
+.Fa id
+arguments are unused.
+Only the super-user may turn quotas off.
+.It Dv Q_GETQUOTA
+Get disk quota limits and current usage for the user or group
+(as determined by the command type) with identifier
+.Fa id .
+.Fa Addr
+is a pointer to a
+.Fa struct dqblk
+structure (defined in 
+.Ao Pa ufs/quota.h Ac ) .
+.It Dv Q_SETQUOTA
+Set disk quota limits for the user or group
+(as determined by the command type) with identifier
+.Fa id .
+.Fa Addr
+is a pointer to a
+.Fa struct dqblk
+structure (defined in 
+.Ao Pa ufs/quota.h Ac ) .
+The usage fields of the
+.Fa dqblk
+structure are ignored.

 This call is restricted to the super-user.
 This call is restricted to the super-user.

-.TP
-Q_GETDLIM
-Get disc quota limits and current usage for the user with ID
-.IR uid .
-The remaining parameters are as for Q_SETDLIM.
-.TP
-Q_SETDUSE
-Set disc usage limits for the user with ID
-.IR uid .
-.I Arg
-is a major-minor device indicating a particular file system.
-.I Addr
-is a pointer to a struct dqusage structure (defined in
-.RI < sys/quota.h >).
+.It Dv Q_SETUSE
+Set disk usage limits for the user or group
+(as determined by the command type) with identifier
+.Fa id .
+.Fa Addr
+is a pointer to a
+.Fa struct dqblk
+structure (defined in
+.Ao Pa ufs/quota.h Ac ) .
+Only the usage fields are used.

 This call is restricted to the super-user.
 This call is restricted to the super-user.

-.TP
-Q_SYNC
-Update the on-disc copy of quota usages.
-.I Arg
-is a major-minor device indicating the file system to be sync'ed.
-If the
-.I arg
-parameter is specified as NODEV, all file systems that have
-disc quotas will be sync'ed.
-The \fIuid\fP and \fIaddr\fP parameters are ignored.
-.TP
-Q_SETUID
-Change the calling process's quota limits to those of the
-user with ID
-.IR uid .
-The 
-.I arg
+.It Dv Q_SYNC
+Update the on-disk copy of quota usages.
+The command type specifies which type of quotas are to be updated.
+The
+.Fa id

 and
 and

-.I addr
-parameters are ignored.  This call is restricted to the super-user.
-.TP
-Q_SETWARN
-Alter the disc usage warning limits for the user with ID
-.IR uid .
-.I Arg
-is a major-minor device indicating a particular file system.
-.I Addr
-is a pointer to a struct dqwarn structure (defined in
-.RI < sys/quota.h >).
-This call is restricted to the super-user.
-.TP
-Q_DOWARN
-Warn the user with user ID
-.I uid
-about excessive disc usage.
-This call causes the system to check its current disc usage
-information and print a message on the terminal of
-the caller for each file system on which the user is over quota.
-If the user is under quota, his warning count is reset to MAX_*_WARN
-(defined in
-.RI < sys/quota.h >).
-If the
-.I arg
-parameter is specified as NODEV, all file systems that have
-disc quotas will be checked.  Otherwise, 
-.I arg
-indicates a specific major-minor device to be checked.
-This call is restricted to the super-user.
-.SH "RETURN VALUE"
+.Fa addr
+parameters are ignored.
+.El
+.Sh RETURN VALUES

 A successful call returns 0,
 A successful call returns 0,

-otherwise the value \-1 is returned and the global variable
-.I errno
+otherwise the value -1 is returned and the global variable
+.Va errno

 indicates the reason for the failure.
 indicates the reason for the failure.

-.SH ERRORS
-A \fIquota\fP call will fail when one of the following occurs:
-.TP 15
-[EINVAL]
-The kernel has not been compiled with the QUOTA option.
-.TP 15
-[EINVAL]
-.I Cmd
-is invalid.
-.TP 15
-[ESRCH]
-No disc quota is found for the indicated user.
-.TP 15
-[EPERM]
-The call is priviledged and the caller was not the super-user.
-.TP 15
-[ENODEV]
-The 
-.I arg
-parameter is being interpreted as a major-minor
-device and it indicates an unmounted file system.
-.TP 15
-[EFAULT]
+.Sh ERRORS
+A
+.Fn quotactl
+call will fail if:
+.Bl -tag -width ENAMETOOLONGAA
+.It Bq Er EOPNOTSUPP
+The kernel has not been compiled with the
+.Dv QUOTA
+option.
+.It Bq Er EUSERS
+The quota table cannot be expanded.
+.It Bq Er EINVAL
+.Fa Cmd
+or the command type is invalid.
+.It Bq Er EINVAL
+A pathname contains a character with the high-order bit set.
+.It Bq Er EACCES
+In
+.Dv Q_QUOTAON ,
+the quota file is not a plain file.
+.It Bq Er EACCES
+Search permission is denied for a component of a path prefix.
+.It Bq Er ENOTDIR
+A component of a path prefix was not a directory.
+.It Bq Er ENAMETOOLONG
+A component of either pathname exceeded 255 characters,
+or the entire length of either path name exceeded 1023 characters.
+.It Bq Er ENOENT
+A filename does not exist.
+.It Bq Er ELOOP
+Too many symbolic links were encountered in translating a pathname.
+.It Bq Er EROFS
+In
+.Dv Q_QUOTAON ,
+the quota file resides on a read-only filesystem.
+.It Bq Er EIO
+An
+.Tn I/O
+error occurred while reading from or writing
+to a file containing quotas.
+.It Bq Er EFAULT

 An invalid
 An invalid

-.I addr
-is supplied; the associated structure could not be copied in or out
+.Fa addr
+was supplied; the associated structure could not be copied in or out

 of the kernel.
 of the kernel.

-.TP 15
-[EUSERS]
-The quota table is full.
-.SH "SEE ALSO"
-setquota(2), quotaon(8), quotacheck(8)
-.SH BUGS
-There should be someway to integrate this call with the resource
+.It Bq Er EFAULT
+.Fa Path
+points outside the process's allocated address space.
+.It Bq Er EPERM
+The call was privileged and the caller was not the super-user.
+.El
+.Sh SEE ALSO
+.Xr quota 1 ,
+.Xr fstab 5 ,
+.Xr edquota 8 ,
+.Xr quotacheck 8 ,
+.Xr quotaon 8 ,
+.Xr repquota 8
+.Sh BUGS
+There should be some way to integrate this call with the resource

 limit interface provided by
 limit interface provided by

-.IR setrlimit (2)
+.Xr setrlimit 2

 and
 and

-.IR getrlimit (2).
-.PP
-The Australian spelling of
-.I disk
-is used throughout the quota facilities in honor of
-the implementors.
+.Xr getrlimit 2 .
+.Sh HISTORY
+The
+.Nm quotactl
+function call appeared in
+.Bx 4.3 Reno .