293 useradd/del/mod should be ZFS-aware
[illumos-gate.git] / usr / src / man / man1m / edquota.1m
blob59b801b2614275a582a5453921a7eb906e76925f
1 '\" te
2 .\"  Copyright 1989 AT&T  Copyright (c) 2003 Sun Microsystems, Inc.  All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH EDQUOTA 1M "Feb 14, 2003"
7 .SH NAME
8 edquota \- edit user quotas for ufs file system
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBedquota\fR [\fB-p\fR \fIproto_user\fR] \fIusername\fR...
13 .fi
15 .LP
16 .nf
17 \fBedquota\fR \fB-t\fR
18 .fi
20 .SH DESCRIPTION
21 .sp
22 .LP
23 \fBedquota\fR is a quota editor.  One or more users may be specified on the
24 command line. For each user a temporary file is created with an \fBASCII\fR
25 representation of the current disk quotas for that user for each mounted ufs
26 file system that has a \fBquotas\fR file, and an editor is then invoked on the
27 file. The quotas may then be modified, new quotas added, etc. Upon leaving the
28 editor, \fBedquota\fR reads the temporary file and modifies the binary quota
29 files to reflect the changes made.
30 .sp
31 .LP
32 The editor invoked is \fBvi\fR(1) unless the \fBEDITOR\fR environment variable
33 specifies otherwise.
34 .sp
35 .LP
36 Only the super-user may edit quotas.  In order for quotas to be established on
37 a file system, the root directory of the file system must contain a file, owned
38 by root, called \fBquotas\fR. (See \fBquotaon\fR(1M).)
39 .sp
40 .LP
41 \fIproto_user\fR and \fIusername\fR can be numeric, corresponding to the
42 \fBUID\fR of a user. Unassigned UIDs may be specified; unassigned names may
43 not. In this way, default quotas can be established for users who are later
44 assigned a UID.
45 .sp
46 .LP
47 If no options are specified, the temporary file created will have one or more
48 lines of the format, where a block is considered to be a 1024 byte (1K) block:
49 .sp
50 .in +2
51 .nf
52 fs\fI mount_point\fR blocks (soft =\fInumber\fR, \e
53      hard =\fInumber\fR ) inodes (soft =\fInumber\fR, \e
54      hard =\fInumber\fR)
55 .fi
56 .in -2
57 .sp
59 .sp
60 .LP
61 The  \fInumber\fR fields may be modified to reflect desired values.
62 .SH OPTIONS
63 .sp
64 .LP
65 The following options are supported:
66 .sp
67 .ne 2
68 .na
69 \fB\fB-p\fR\fR
70 .ad
71 .RS 6n
72 Duplicate the quotas of the \fIproto_user\fR specified for each \fIusername\fR
73 specified. This is the normal mechanism used to initialize quotas for groups of
74 users.
75 .RE
77 .sp
78 .ne 2
79 .na
80 \fB\fB-t\fR\fR
81 .ad
82 .RS 6n
83 Edit the soft time limits for each file system. If the time limits are zero,
84 the default time limits in \fB/usr/include/sys/fs/ufs_quota.h\fR are used. The
85 temporary file created will have one or more lines of the form
86 .sp
87 fs \fImount_point\fR blocks time limit = \fInumber tmunit\fR,  files time limit
88 = \fInumber tmunit\fR
89 .RE
91 .sp
92 .LP
93 \fItmunit\fR may be one of ``month'', ``week'', ``day'', ``hour'', ``min'' or
94 ``sec''; characters appended to these keywords are ignored, so you may write
95 ``months'' or ``minutes'' if you prefer. The \fInumber\fR and\fI tmunit\fR
96 fields may be modified to set desired values. Time limits are printed in the
97 greatest possible time unit such that the value is greater than or equal to
98 one. If ``default'' is printed after the \fItmunit\fR, this indicates that the
99 value shown is zero (the default).
100 .SH USAGE
103 See \fBlargefile\fR(5) for the description of the behavior of \fBedquota\fR
104 when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
105 .SH FILES
107 .ne 2
109 \fB\fBquotas\fR\fR
111 .RS 15n
112 quota file at the file system root
116 .ne 2
118 \fB\fB/etc/mnttab\fR\fR
120 .RS 15n
121 table of mounted file systems
124 .SH SEE ALSO
127 \fBvi\fR(1), \fBquota\fR(1M), \fBquotacheck\fR(1M), \fBquotaon\fR(1M),
128 \fBrepquota\fR(1M), \fBattributes\fR(5), \fBlargefile\fR(5), \fBquotactl\fR(7I)
129 .SH NOTES
132 All \fBUID\fRs can be assigned quotas.