xref: /freebsd/usr.sbin/edquota/edquota.8 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
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.\"
37.Dd June 6, 1993
38.Dt EDQUOTA 8
39.Os
40.Sh NAME
41.Nm edquota
42.Nd edit user quotas
43.Sh SYNOPSIS
44.Nm edquota
45.Op Fl u
46.Op Fl p Ar proto-username
47.Ar username ...
48.Nm edquota
49.Fl g
50.Op Fl p Ar proto-groupname
51.Ar groupname ...
52.Nm edquota
53.Fl t
54.Op Fl u
55.Nm edquota
56.Fl t
57.Fl g
58.br
59.Sh DESCRIPTION
60.Nm Edquota
61is a quota editor.
62By default, or if the
63.Fl u
64flag is specified,
65one or more users may be specified on the command line.
66For each user a temporary file is created
67with an
68.Tn ASCII
69representation of the current
70disk quotas for that user.
71The list of filesystems with user quotas is determined from
72.Pa /etc/fstab .
73An editor is invoked on the
74.Tn ASCII
75file.
76The editor invoked is
77.Xr vi 1
78unless the environment variable
79.Ev EDITOR
80specifies otherwise.
81.Pp
82The quotas may then be modified, new quotas added, etc.
83Setting a quota to zero indicates that no quota should be imposed.
84Setting a hard limit to one indicates that no allocations should
85be permitted.
86Setting a soft limit to one with a hard limit of zero
87indicates that allocations should be permitted only on
88a temporary basis (see
89.Fl t
90below).
91The current usage information in the file is for informational purposes;
92only the hard and soft limits can be changed.
93.Pp
94On leaving the editor,
95.Nm
96reads the temporary file and modifies the binary
97quota files to reflect the changes made.
98.Pp
99If the
100.Fl p
101option is specified,
102.Nm
103will duplicate the quotas of the prototypical user
104specified for each user specified.
105This is the normal mechanism used to
106initialize quotas for groups of users.
107If the user given to assign quotas to is a numerical uid
108range (e.g. 1000-2000), then
109.Nm
110will duplicate the quotas of the prototypical user
111for each uid in the range specified.  This allows
112for easy setup of default quotas for a group of users.
113The uids in question do not have to be currently assigned in
114.Pa /etc/passwd .
115.Pp
116If the
117.Fl g
118flag is specified,
119.Nm
120is invoked to edit the quotas of
121one or more groups specified on the command line.
122The
123.Fl p
124flag can be specified in conjunction with
125the
126.Fl g
127flag to specify a prototypical group
128to be duplicated among the listed set of groups.
129.Pp
130Users are permitted to exceed their soft limits
131for a grace period that may be specified per filesystem.
132Once the grace period has expired,
133the soft limit is enforced as a hard limit.
134The default grace period for a filesystem is specified in
135.Pa /usr/include/ufs/ufs/quota.h .
136The
137.Fl t
138flag can be used to change the grace period.
139By default, or when invoked with the
140.Fl u
141flag,
142the grace period is set for all the filesystems with user
143quotas specified in
144.Pa /etc/fstab .
145When invoked with the
146.Fl g
147flag the grace period is
148set for all the filesystems with group quotas specified in
149.Pa /etc/fstab .
150The grace period may be specified in days, hours, minutes, or seconds.
151Setting a grace period to zero indicates that the default
152grace period should be imposed.
153Setting a grace period to one second indicates that no
154grace period should be granted.
155.Pp
156Only the super-user may edit quotas.
157.Sh FILES
158.Bl -tag -width quota.group -compact
159.It Pa quota.user
160at the filesystem root with user quotas
161.It Pa quota.group
162at the filesystem root with group quotas
163.It Pa /etc/fstab
164to find filesystem names and locations
165.El
166.Sh SEE ALSO
167.Xr quota 1 ,
168.Xr fstab 2 ,
169.Xr quotactl 2 ,
170.Xr quotacheck 8 ,
171.Xr quotaon 8 ,
172.Xr repquota 8
173.Sh DIAGNOSTICS
174Various messages about inaccessible files; self-explanatory.
175