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