xref: /netbsd/usr.sbin/edquota/edquota.8 (revision bf9ec67e)
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.\"	from: @(#)edquota.8	8.2 (Berkeley) 4/27/95
36.\"	$NetBSD: edquota.8,v 1.8 2002/01/19 03:11:34 wiz Exp $
37.\"
38.Dd April 27, 1995
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 p Ar proto-username
48.Ar username ...
49.Nm ""
50.Fl g
51.Op Fl p Ar proto-groupname
52.Ar groupname ...
53.Nm ""
54.Fl t
55.Op Fl u
56.Nm ""
57.Fl t
58.Fl g
59.Sh DESCRIPTION
60.Nm
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 ASCII representation of the current
68disk quotas for that user.
69The list of filesystems with user quotas is determined from
70.Pa /etc/fstab .
71An editor is invoked on the ASCII file.
72The editor invoked is
73.Xr vi 1
74unless the environment variable
75.Ev EDITOR
76specifies otherwise.
77.Pp
78The quotas may then be modified, new quotas added, etc.
79Setting a quota to zero indicates that no quota should be imposed.
80Setting a hard limit to one indicates that no allocations should
81be permitted.
82Setting a soft limit to one with a hard limit of zero
83indicates that allocations should be permitted on
84only a temporary basis (see
85.Fl t
86below).
87The current usage information in the file is for informational purposes;
88only the hard and soft limits can be changed.
89.Pp
90On leaving the editor,
91.Nm
92reads the temporary file and modifies the binary
93quota files to reflect the changes made.
94.Pp
95If the
96.Fl p
97flag is specified,
98.Nm
99will duplicate the quotas of the prototypical user
100specified for each user specified.
101This is the normal mechanism used to
102initialize quotas for groups of users.
103.Pp
104If the
105.Fl g
106flag is specified,
107.Nm
108is invoked to edit the quotas of
109one or more groups specified on the command line.
110The
111.Fl p
112flag can be specified in conjunction with
113the
114.Fl g
115flag to specify a prototypical group
116to be duplicated among the listed set of groups.
117.Pp
118Users are permitted to exceed their soft limits
119for a grace period that may be specified per filesystem.
120Once the grace period has expired,
121the soft limit is enforced as a hard limit.
122The default grace period for a filesystem is specified in
123.Pa /usr/include/ufs/ufs/quota.h .
124The
125.Fl t
126flag can be used to change the grace period.
127By default, or when invoked with the
128.Fl u
129flag, the grace period is set for all the filesystems with user
130quotas specified in
131.Pa /etc/fstab .
132When invoked with the
133.Fl g
134flag the grace period is
135set for all the filesystems with group quotas specified in
136.Pa /etc/fstab .
137The grace period may be specified in days, hours, minutes, or seconds.
138Setting a grace period to zero indicates that the default
139grace period should be imposed.
140Setting a grace period to one second indicates that no
141grace period should be granted.
142.Pp
143Only the super-user may edit quotas.
144.Sh FILES
145.Bl -tag -width 24n -compact
146.It Pa quota.user
147at the filesystem root with user quotas
148.It Pa quota.group
149at the filesystem root with group quotas
150.It Pa /etc/fstab
151to find filesystem names and locations
152.El
153.Sh DIAGNOSTICS
154Various messages about inaccessible files; self-explanatory.
155.Sh SEE ALSO
156.Xr quota 1 ,
157.Xr quotactl 2 ,
158.Xr fstab 5 ,
159.Xr quotacheck 8 ,
160.Xr quotaon 8 ,
161.Xr repquota 8
162