xref: /freebsd/usr.sbin/edquota/edquota.8 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1.\" Copyright (c) 1983, 1990, 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. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)edquota.8	8.1 (Berkeley) 6/6/93
36.\" $FreeBSD$
37.\"
38.Dd June 6, 1993
39.Dt EDQUOTA 8
40.Os
41.Sh NAME
42.Nm edquota
43.Nd edit user quotas
44.Sh SYNOPSIS
45.Nm edquota
46.Op Fl u
47.Op Fl p Ar proto-username
48.Ar username ...
49.Nm edquota
50.Fl g
51.Op Fl p Ar proto-groupname
52.Ar groupname ...
53.Nm edquota
54.Fl t
55.Op Fl u
56.Nm edquota
57.Fl t
58.Fl g
59.br
60.Sh DESCRIPTION
61.Nm Edquota
62is a quota editor.
63By default, or if the
64.Fl u
65flag is specified,
66one or more users may be specified on the command line.
67For each user a temporary file is created
68with an
69.Tn ASCII
70representation of the current
71disk quotas for that user.
72The list of filesystems with user quotas is determined from
73.Pa /etc/fstab .
74An editor is invoked on the
75.Tn ASCII
76file.
77The editor invoked is
78.Xr vi 1
79unless the environment variable
80.Ev EDITOR
81specifies otherwise.
82.Pp
83The quotas may then be modified, new quotas added, etc.
84Setting a quota to zero indicates that no quota should be imposed.
85Setting a hard limit to one indicates that no allocations should
86be permitted.
87Setting a soft limit to one with a hard limit of zero
88indicates that allocations should be permitted only on
89a temporary basis (see
90.Fl t
91below).
92The current usage information in the file is for informational purposes;
93only the hard and soft limits can be changed.
94.Pp
95On leaving the editor,
96.Nm
97reads the temporary file and modifies the binary
98quota files to reflect the changes made.
99.Pp
100If the
101.Fl p
102option is specified,
103.Nm
104will duplicate the quotas of the prototypical user
105specified for each user specified.
106This is the normal mechanism used to
107initialize quotas for groups of users.
108If the user given to assign quotas to is a numerical uid
109range (e.g. 1000-2000), then
110.Nm
111will duplicate the quotas of the prototypical user
112for each uid in the range specified.  This allows
113for easy setup of default quotas for a group of users.
114The uids in question do not have to be currently assigned in
115.Pa /etc/passwd .
116.Pp
117If the
118.Fl g
119flag is specified,
120.Nm
121is invoked to edit the quotas of
122one or more groups specified on the command line.
123The
124.Fl p
125flag can be specified in conjunction with
126the
127.Fl g
128flag to specify a prototypical group
129to be duplicated among the listed set of groups.
130.Pp
131Users are permitted to exceed their soft limits
132for a grace period that may be specified per filesystem.
133Once the grace period has expired,
134the soft limit is enforced as a hard limit.
135The default grace period for a filesystem is specified in
136.Pa /usr/include/ufs/ufs/quota.h .
137The
138.Fl t
139flag can be used to change the grace period.
140By default, or when invoked with the
141.Fl u
142flag,
143the grace period is set for all the filesystems with user
144quotas specified in
145.Pa /etc/fstab .
146When invoked with the
147.Fl g
148flag the grace period is
149set for all the filesystems with group quotas specified in
150.Pa /etc/fstab .
151The grace period may be specified in days, hours, minutes, or seconds.
152Setting a grace period to zero indicates that the default
153grace period should be imposed.
154Setting a grace period to one second indicates that no
155grace period should be granted.
156.Pp
157Only the super-user may edit quotas.
158.Sh FILES
159.Bl -tag -width quota.group -compact
160.It Pa quota.user
161at the filesystem root with user quotas
162.It Pa quota.group
163at the filesystem root with group quotas
164.It Pa /etc/fstab
165to find filesystem names and locations
166.El
167.Sh SEE ALSO
168.Xr quota 1 ,
169.Xr quotactl 2 ,
170.Xr fstab 5 ,
171.Xr quotacheck 8 ,
172.Xr quotaon 8 ,
173.Xr repquota 8
174.Sh DIAGNOSTICS
175Various messages about inaccessible files; self-explanatory.
176