Initial commit to Gerrit
[profile/ivi/quota.git] / edquota.8
1 .TH EDQUOTA 8
2 .SH NAME
3 edquota \- edit user quotas
4 .SH SYNOPSIS
5 .B edquota
6 [
7 .B \-p
8 .I protoname
9 ] [
10 .BR \-u \ |
11 .B \-g
12 ] [
13 .B \-rm
14 ] [
15 .B \-F
16 .I format-name
17 ] [
18 .B \-f
19 .I filesystem
20 ]
21 .IR username .\|.\|.
22 .LP
23 .B edquota
24 [
25 .BR \-u \ |
26 .B \-g
27 ] [
28 .B \-F
29 .I format-name
30 ] [
31 .B \-f
32 .I filesystem
33 ]
34 .B \-t
35 .LP
36 .B edquota
37 [
38 .BR \-u \ |
39 .B \-g
40 ] [
41 .B \-F
42 .I format-name
43 ] [
44 .B \-f
45 .I filesystem
46 ]
47 .B \-T
48 .IR username \ |
49 .IR groupname .\|.\|.
50 .SH DESCRIPTION
51 .IX  "edquota command"  ""  "\fLedquota\fP \(em edit user quotas"
52 .IX  edit "user quotas \(em \fLedquota\fP"
53 .IX  "user quotas"  "edquota command"  ""  "\fLedquota\fP \(em edit user quotas"
54 .IX  "disk quotas"  "edquota command"  ""  "\fLedquota\fP \(em edit user quotas"
55 .IX  "quotas"  "edquota command"  ""  "\fLedquota\fP \(em edit user quotas"
56 .IX  "filesystem"  "edquota command"  ""  "\fLedquota\fP \(em edit user quotas"
57 .B edquota
58 is a quota editor.  One or more users or groups may be specified on the command
59 line. If a number is given in the place of user/group name it is treated as
60 an UID/GID. For each user or group a temporary file is created with an
61 .SM ASCII
62 representation of the current disk quotas for that user or group and an editor
63 is then invoked on the file.  The quotas may then be modified, new
64 quotas added, etc.
65 Setting a quota to zero indicates that no quota should be imposed.
66 .PP
67 Users are permitted to exceed their soft limits for a grace period that
68 may be specified per filesystem.  Once the grace period has expired, the
69 soft limit is enforced as a hard limit.
70 .PP
71 The current usage information in the file is for informational purposes;
72 only the hard and soft limits can be changed.
73 .PP
74 Upon leaving the editor,
75 .B edquota
76 reads the temporary file and modifies the binary quota files to reflect
77 the changes made.
78 .LP
79 The editor invoked is
80 .BR vi (1)
81 unless either the
82 .SB EDITOR
83 or the
84 .SB VISUAL
85 environment variable specifies otherwise.
86 .LP
87 Only the super-user may edit quotas.
88 .SH OPTIONS
89 .TP
90 .B -r, --remote
91 Edit also non-local quota use rpc.rquotad on remote server to set quota.
92 This option is available only if quota tools were compiled with enabled
93 support for setting quotas over RPC.
94 The
95 .B -n
96 option is equivalent, and is maintained for backward compatibility.
97 .TP
98 .B -m, --no-mixed-pathnames
99 Currently, pathnames of NFSv4 mountpoints are sent without leading slash in the path.
100 .BR rpc.rquotad
101 uses this to recognize NFSv4 mounts and properly prepend pseudoroot of NFS filesystem
102 to the path. If you specify this option, 
103 .BR setquota 
104 will always send paths with a trailing slash. This can be useful for legacy reasons but
105 be aware that quota over RPC will stop working if you are using new
106 .BR rpc.rquotad .
107 .TP
108 .B -u, --user
109 Edit the user quota. This is the default.
110 .TP
111 .B -g, --group
112 Edit the group quota.
113 .TP
114 .B -p, --prototype=\f2protoname\f1
115 Duplicate the quotas of the prototypical user
116 specified for each user specified.  This is the normal
117 mechanism used to initialize quotas for groups of users.
118 .TP
119 .B -F, --format=\f2format-name\f1
120 Edit quota for specified format (ie. don't perform format autodetection).
121 Possible format names are:
122 .B vfsold
123 Original quota format with 16-bit UIDs / GIDs,
124 .B vfsv0
125 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits,
126 .B vfsv1
127 Quota format with 64-bit quota limits and usage,
128 .B rpc
129 (quota over NFS),
130 .B xfs
131 (quota on XFS filesystem)
132 .TP
133 .B \-f, --filesystem \f2filesystem\f1
134 Perform specified operations only for given filesystem (default is to perform
135 operations for all filesystems with quota).
136 .TP
137 .B \-t, --edit-period
138 Edit the soft time limits for each filesystem.
139 In old quota format if the time limits are zero, the default time limits in
140 .B <linux/quota.h>
141 are used. In new quota format time limits must be specified (there is no default
142 value set in kernel). Time units of 'seconds', 'minutes', 'hours', and 'days'
143 are understood. Time limits are printed in the greatest possible time unit such that
144 the value is greater than or equal to one.
145 .TP
146 .B \-T, --edit-times
147 Edit time for the user/group when softlimit is enforced. Possible values
148 are 'unset' or number and unit. Units are the same as in
149 .B \-t
150 option.
151 .SH FILES
152 .PD 0
153 .TP 20
154 .BR aquota.user " or " aquota.group
155 quota file at the filesystem root (version 2 quota, non-XFS filesystems)
156 .TP
157 .BR quota.user " or " quota.group
158 quota file at the filesystem root (version 1 quota, non-XFS filesystems)
159 .TP
160 .B /etc/mtab
161 mounted filesystems table
162 .PD
163 .SH SEE ALSO
164 .BR quota (1),
165 .BR vi (1),
166 .BR quotactl (2),
167 .BR quotacheck (8),
168 .BR quotaon (8),
169 .BR repquota (8),
170 .BR setquota (8)