Initial commit to Gerrit
[profile/ivi/quota.git] / quotaon.8
1 .TH QUOTAON 8
2 .UC 4
3 .SH NAME
4 quotaon, quotaoff \- turn filesystem quotas on and off
5 .SH SYNOPSIS
6 .B /usr/sbin/quotaon
7 [
8 .B \-vugfp
9 ] [
10 .B \-F
11 .I format-name
12 ]
13 .IR filesystem .\|.\|.
14 .br
15 .B /usr/sbin/quotaon
16 [
17 .B \-avugfp
18 ] [
19 .B \-F
20 .I format-name
21 ]
22 .LP
23 .B /usr/sbin/quotaoff
24 [
25 .B \-vugp
26 ]
27 [
28 .B \-x
29 .I state
30 ]
31 .IR filesystem .\|.\|.
32 .br
33 .B /usr/sbin/quotaoff
34 [
35 .B \-avugp
36 ]
37 .SH DESCRIPTION
38 .SS quotaon
39 .IX  "quotaon command"  ""  "\fLquotaon\fP \(em turn filesystem quotas on"
40 .IX  "user quotas"  "quotaon command"  ""  "\fLquotaon\fP \(em turn filesystem quotas on"
41 .IX  "disk quotas"  "quotaon command"  ""  "\fLquotaon\fP \(em turn filesystem quotas on"
42 .IX  "quotas"  "quotaon command"  ""  "\fLquotaon\fP \(em turn filesystem quotas on"
43 .IX  "filesystem"  "quotaon command"  ""  "\fLquotaon\fP \(em turn filesystem quotas on"
44 .LP
45 .B quotaon
46 announces to the system that disk quotas should be enabled on one or
47 more filesystems. The filesystem quota files must be present in the root
48 directory of the specified filesystem and be named either
49 .IR aquota.user
50 (for version 2 user quota),
51 .IR quota.user
52 (for version 1 user quota),
53 .IR aquota.group
54 (for version 2 group quota), or
55 .IR quota.group
56 (for version 1 group quota).
57 .PP
58 XFS filesystems are a special case - XFS considers quota
59 information as filesystem metadata and uses journaling to provide
60 a higher level guarantee of consistency.
61 There are two components to the XFS disk quota system:
62 accounting and limit enforcement.
63 XFS filesystems require that quota accounting be turned on at mount time.
64 It is possible to enable and disable limit enforcement on an XFS
65 filesystem after quota accounting is already turned on.
66 The default is to turn on both accounting and enforcement.
67 .PP
68 The XFS quota implementation does not maintain quota information in
69 user-visible files, but rather stores this information internally.
70 .SS quotaoff
71 .IX  "quotaoff command"  ""  "\fLquotaoff\fP \(em turn filesystem quotas off"
72 .IX  "user quotas"  "quotaoff command"  ""  "\fLquotaoff\fP \(em turn filesystem quotas off"
73 .IX  "disk quotas"  "quotaoff command"  ""  "\fLquotaoff\fP \(em turn filesystem quotas off"
74 .IX  "quotas"  "quotaoff command"  ""  "\fLquotaoff\fP \(em turn filesystem quotas off"
75 .IX  "filesystem"  "quotaoff command"  ""  "\fLquotaoff\fP \(em turn filesystem quotas off"
76 .LP
77 .B quotaoff
78 announces to the system that the specified filesystems should
79 have any disk quotas turned off.
80 .SH OPTIONS
81 .SS quotaon
82 .TP
83 .B -F, --format=\f2format-name\f1
84 Report quota for specified format (ie. don't perform format autodetection).
85 Possible format names are:
86 .B vfsold
87 Original quota format with 16-bit UIDs / GIDs,
88 .B vfsv0
89 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits,
90 .B vfsv1
91 Quota format with 64-bit quota limits and usage,
92 .B xfs
93 (quota on XFS filesystem)
94 .TP
95 .B -a, --all
96 All automatically mounted (no
97 .B noauto
98 option) non-NFS filesystems in
99 .B /etc/fstab
100 with quotas will have their quotas turned on.
101 This is normally used at boot time to enable quotas.
102 .TP
103 .B -v, --verbose
104 Display a message for each filesystem where quotas are turned on.
105 .TP
106 .B -u, --user
107 Manipulate user quotas. This is the default.
108 .TP
109 .B -g, --group
110 Manipulate group quotas.
111 .TP
112 .B -p, --print-state
113 Instead of turning quotas on just print state of quotas (ie. whether. quota is on or off)
114 .TP
115 .B -f, --off
116 Make
117 .B quotaon
118 behave like being called as
119 .BR quotaoff .
120 .SS quotaoff
121 .TP
122 .B -F, --format=\f2format-name\f1
123 Report quota for specified format (ie. don't perform format autodetection).
124 Possible format names are:
125 .B vfsold
126 (version 1 quota),
127 .B vfsv0
128 (version 2 quota),
129 .B xfs
130 (quota on XFS filesystem)
131 .TP
132 .B -a, --all
133 Force all filesystems in
134 .B /etc/fstab
135 to have their quotas disabled.
136 .TP
137 .B -v, --verbose
138 Display a message for each filesystem affected.
139 .TP
140 .B -u, --user
141 Manipulate user quotas. This is the default.
142 .TP
143 .B -g, --group
144 Manipulate group quotas.
145 .TP
146 .B -p, --print-state
147 Instead of turning quotas off just print state of quotas (ie. whether. quota is on or off)
148 .TP
149 .B -x, --xfs-command delete
150 Free up the space used to hold quota information (maintained
151 internally) within XFS.
152 This option is only applicable to XFS, and is silently
153 ignored for other filesystem types.
154 It can only be used on a filesystem with quota previously turned off.
155 .TP
156 .B -x, --xfs-command enforce
157 Switch on/off limit enforcement for XFS filesystems (perform
158 quota accounting only).
159 This option is only applicable to XFS, and is silently
160 ignored for other filesystem types.
161 .SH "NOTES ON XFS FILESYSTEMS"
162 To enable quotas on an XFS filesystem, use
163 .IR mount (8)
164 or
165 .B /etc/fstab
166 quota option to enable both accounting and limit enforcement.
167 .B quotaon
168 utility cannot be used for this purpose.
169 .PP
170 Turning on quotas on an XFS root filesystem requires the quota mount
171 options be passed into the kernel at boot time through the Linux
172 .B rootflags
173 boot option.
174 .PP
175 To turn off quota limit enforcement on any XFS filesystem, first make
176 sure that quota accounting and enforcement are both turned on using
177 .B "repquota -v"
178 .IR filesystem .
179 Then, use
180 .B "quotaoff -v
181 .I filesystem
182 to disable limit enforcement.
183 This may be done while the filesystem is mounted.
184 .PP
185 Turning on quota limit enforcement on an XFS filesystem is
186 achieved using
187 .B "quotaon -v"
188 .IR filesystem .
189 This may be done while the filesystem is mounted.
190 .SH FILES
191 .PD 0
192 .TP 20
193 .B aquota.user or aquota.group
194 quota file at the filesystem root (version 2 quota, non-XFS filesystems)
195 .TP
196 .B quota.user or quota.group
197 quota file at the filesystem root (version 1 quota, non-XFS filesystems)
198 .TP
199 .B /etc/fstab
200 default filesystems
201 .PD
202 .SH "SEE ALSO"
203 .BR quotactl (2),
204 .BR fstab (5),
205 .BR quota_nld (8),
206 .BR repquota (8),
207 .BR warnquota (8)