Annotation of cci/usr/src/man/man2/quota.2, revision 1.1.1.1

1.1       root        1: .TH QUOTA 2 "7 July 1983"
                      2: .UC 4
                      3: .SH NAME
                      4: quota \- manipulate disk quotas
                      5: .SH SYNOPSIS
                      6: .nf
                      7: .B #include <sys/quota.h>
                      8: .PP
                      9: .B quota(cmd, uid, arg, addr)
                     10: .B int cmd, uid, arg;
                     11: .B caddr_t addr;
                     12: .fi
                     13: .SH DESCRIPTION
                     14: The
                     15: .I quota
                     16: call manipulates disk quotas for file systems
                     17: which have had quotas enabled with
                     18: .IR setquota (2).
                     19: The
                     20: .I cmd
                     21: parameter indicates a command to be applied to
                     22: the user ID
                     23: .IR uid .
                     24: .I Arg
                     25: is a command specific argument and
                     26: .I addr
                     27: is the address of an optional, command specific, data structure
                     28: which is copied in or out of the system.  The interpretation of
                     29: .I arg
                     30: and
                     31: .I addr
                     32: is given with each command below.
                     33: .TP
                     34: Q_SETDLIM
                     35: Set disc quota limits and current usage for the user with ID
                     36: .IR uid .
                     37: .I Arg
                     38: is a major-minor device indicating a particular file system.
                     39: .I Addr
                     40: is a pointer to a struct dqblk structure (defined in 
                     41: .RI < sys/quota.h >).
                     42: This call is restricted to the super-user.
                     43: .TP
                     44: Q_GETDLIM
                     45: Get disc quota limits and current usage for the user with ID
                     46: .IR uid .
                     47: The remaining parameters are as for Q_SETDLIM.
                     48: .TP
                     49: Q_SETDUSE
                     50: Set disc usage limits for the user with ID
                     51: .IR uid .
                     52: .I Arg
                     53: is a major-minor device indicating a particular file system.
                     54: .I Addr
                     55: is a pointer to a struct dqusage structure (defined in
                     56: .RI < sys/quota.h >).
                     57: This call is restricted to the super-user.
                     58: .TP
                     59: Q_SYNC
                     60: Update the on-disc copy of quota usages.
                     61: The
                     62: .IR uid ,
                     63: .IR arg ,
                     64: and
                     65: .I addr 
                     66: parameters are ignored.
                     67: .TP
                     68: Q_SETUID
                     69: Change the calling process's quota limits to those of the
                     70: user with ID
                     71: .IR uid .
                     72: The 
                     73: .I arg
                     74: and
                     75: .I addr
                     76: parameters are ignored.  This call is restricted to the super-user.
                     77: .TP
                     78: Q_SETWARN
                     79: Alter the disc usage warning limits for the user with ID
                     80: .IR uid .
                     81: .I Arg
                     82: is a major-minor device indicating a particular file system.
                     83: .I Addr
                     84: is a pointer to a struct dqwarn structure (defined in
                     85: .RI < sys/quota.h >).
                     86: This call is restricted to the super-user.
                     87: .TP
                     88: Q_DOWARN
                     89: Warn the user with user ID
                     90: .I uid
                     91: about excessive disc usage.
                     92: This call causes the system to check its current disc usage
                     93: information and print a message on the terminal of
                     94: the caller for each file system on which the user is over quota.
                     95: If the
                     96: .I arg
                     97: parameter is specified as NODEV, all file systems which have
                     98: disc quotas will be checked.  Otherwise, 
                     99: .I arg
                    100: indicates a specific major-minor device to be checked.
                    101: This call is restricted to the super-user.
                    102: .SH "RETURN VALUE"
                    103: A successful call returns 0 and, possibly, more
                    104: information specific to the 
                    105: .I cmd
                    106: performed; when an error occurs, the value \-1
                    107: is returned and 
                    108: .I errno
                    109: is set to indicate the reason.
                    110: .SH ERRORS
                    111: A
                    112: .I quota
                    113: call will fail when one of the following occurs:
                    114: .TP 15
                    115: [EINVAL]
                    116: .I Cmd
                    117: is invalid.
                    118: .TP 15
                    119: [ESRCH]
                    120: No disc quota is found for the indicated user.
                    121: .TP 15
                    122: [EPERM]
                    123: The call is priviledged and the caller was not the super-user.
                    124: .TP 15
                    125: [EINVAL]
                    126: The 
                    127: .I arg
                    128: parameter is being interpreted as a major-minor
                    129: device and it indicates an unmounted file system.
                    130: .TP 15
                    131: [EFAULT]
                    132: An invalid
                    133: .I addr
                    134: is supplied; the associated structure could not be copied in or out
                    135: of the kernel.
                    136: .TP 15
                    137: [EUSERS]
                    138: The quota table is full.
                    139: .SH "SEE ALSO"
                    140: setquota(2), quotaon(8), quotacheck(8)
                    141: .SH BUGS
                    142: There should be someway to integrate this call with the resource
                    143: limit interface provided by
                    144: .IR setrlimit (2)
                    145: and
                    146: .IR getrlimit (2).
                    147: .PP
                    148: The Australian spelling of
                    149: .I disk
                    150: is used throughout the quota facilities in honor of
                    151: the implementors.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.