]>
Commit | Line | Data |
---|---|---|
870fc32f RW |
1 | .\" |
2 | .\" CDDL HEADER START | |
3 | .\" | |
4 | .\" The contents of this file are subject to the terms of the | |
5 | .\" Common Development and Distribution License (the "License"). | |
6 | .\" You may not use this file except in compliance with the License. | |
7 | .\" | |
8 | .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE | |
9 | .\" or http://www.opensolaris.org/os/licensing. | |
10 | .\" See the License for the specific language governing permissions | |
11 | .\" and limitations under the License. | |
12 | .\" | |
13 | .\" When distributing Covered Code, include this CDDL HEADER in each | |
14 | .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. | |
15 | .\" If applicable, add the following below this CDDL HEADER, with the | |
16 | .\" fields enclosed by brackets "[]" replaced with your own identifying | |
17 | .\" information: Portions Copyright [yyyy] [name of copyright owner] | |
18 | .\" | |
19 | .\" CDDL HEADER END | |
20 | .\" | |
870fc32f RW |
21 | .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. |
22 | .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org> | |
23 | .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved. | |
24 | .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved. | |
25 | .\" Copyright (c) 2014, Joyent, Inc. All rights reserved. | |
26 | .\" Copyright (c) 2014 by Adam Stevko. All rights reserved. | |
27 | .\" Copyright (c) 2014 Integros [integros.com] | |
28 | .\" Copyright 2019 Richard Laager. All rights reserved. | |
29 | .\" Copyright 2018 Nexenta Systems, Inc. | |
30 | .\" Copyright 2019 Joyent, Inc. | |
31 | .\" | |
32 | .Dd June 30, 2019 | |
33 | .Dt ZFS-USERSPACE 8 | |
6706552e | 34 | .Os |
f84fe3fc | 35 | . |
870fc32f | 36 | .Sh NAME |
1e36af8c | 37 | .Nm zfs-userspace |
f84fe3fc | 38 | .Nd display space and quotas of ZFS dataset |
870fc32f | 39 | .Sh SYNOPSIS |
1e36af8c | 40 | .Nm zfs |
870fc32f RW |
41 | .Cm userspace |
42 | .Op Fl Hinp | |
f84fe3fc AZ |
43 | .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc |
44 | .Oo Fl s Ar field Oc Ns … | |
45 | .Oo Fl S Ar field Oc Ns … | |
46 | .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc | |
cf266775 | 47 | .Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path |
1e36af8c | 48 | .Nm zfs |
870fc32f RW |
49 | .Cm groupspace |
50 | .Op Fl Hinp | |
f84fe3fc AZ |
51 | .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc |
52 | .Oo Fl s Ar field Oc Ns … | |
53 | .Oo Fl S Ar field Oc Ns … | |
54 | .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc | |
cf266775 | 55 | .Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path |
1e36af8c | 56 | .Nm zfs |
870fc32f RW |
57 | .Cm projectspace |
58 | .Op Fl Hp | |
f84fe3fc AZ |
59 | .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc |
60 | .Oo Fl s Ar field Oc Ns … | |
61 | .Oo Fl S Ar field Oc Ns … | |
cf266775 | 62 | .Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path |
f84fe3fc | 63 | . |
870fc32f RW |
64 | .Sh DESCRIPTION |
65 | .Bl -tag -width "" | |
66 | .It Xo | |
1e36af8c | 67 | .Nm zfs |
870fc32f RW |
68 | .Cm userspace |
69 | .Op Fl Hinp | |
f84fe3fc AZ |
70 | .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc |
71 | .Oo Fl s Ar field Oc Ns … | |
72 | .Oo Fl S Ar field Oc Ns … | |
73 | .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc | |
cf266775 | 74 | .Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path |
870fc32f | 75 | .Xc |
cf266775 AJ |
76 | Displays space consumed by, and quotas on, each user in the specified filesystem, |
77 | snapshot, or path. | |
78 | If a path is given, the filesystem that contains that path will be used. | |
870fc32f RW |
79 | This corresponds to the |
80 | .Sy userused@ Ns Em user , | |
81 | .Sy userobjused@ Ns Em user , | |
f84fe3fc | 82 | .Sy userquota@ Ns Em user , |
870fc32f RW |
83 | and |
84 | .Sy userobjquota@ Ns Em user | |
85 | properties. | |
f84fe3fc | 86 | .Bl -tag -width "-S field" |
870fc32f RW |
87 | .It Fl H |
88 | Do not print headers, use tab-delimited output. | |
89 | .It Fl S Ar field | |
90 | Sort by this field in reverse order. | |
91 | See | |
92 | .Fl s . | |
93 | .It Fl i | |
94 | Translate SID to POSIX ID. | |
95 | The POSIX ID may be ephemeral if no mapping exists. | |
96 | Normal POSIX interfaces | |
f84fe3fc | 97 | .Pq like Xr stat 2 , Nm ls Fl l |
870fc32f RW |
98 | perform this translation, so the |
99 | .Fl i | |
100 | option allows the output from | |
101 | .Nm zfs Cm userspace | |
102 | to be compared directly with those utilities. | |
103 | However, | |
104 | .Fl i | |
105 | may lead to confusion if some files were created by an SMB user before a | |
106 | SMB-to-POSIX name mapping was established. | |
107 | In such a case, some files will be owned by the SMB entity and some by the POSIX | |
108 | entity. | |
109 | However, the | |
110 | .Fl i | |
111 | option will report that the POSIX entity has the total usage and quota for both. | |
112 | .It Fl n | |
113 | Print numeric ID instead of user/group name. | |
f84fe3fc | 114 | .It Fl o Ar field Ns Oo , Ns Ar field Oc Ns … |
870fc32f RW |
115 | Display only the specified fields from the following set: |
116 | .Sy type , | |
117 | .Sy name , | |
118 | .Sy used , | |
119 | .Sy quota . | |
120 | The default is to display all fields. | |
121 | .It Fl p | |
122 | Use exact | |
123 | .Pq parsable | |
124 | numeric output. | |
125 | .It Fl s Ar field | |
126 | Sort output by this field. | |
127 | The | |
128 | .Fl s | |
129 | and | |
130 | .Fl S | |
131 | flags may be specified multiple times to sort first by one field, then by | |
132 | another. | |
133 | The default is | |
134 | .Fl s Sy type Fl s Sy name . | |
f84fe3fc | 135 | .It Fl t Ar type Ns Oo , Ns Ar type Oc Ns … |
870fc32f RW |
136 | Print only the specified types from the following set: |
137 | .Sy all , | |
138 | .Sy posixuser , | |
139 | .Sy smbuser , | |
140 | .Sy posixgroup , | |
141 | .Sy smbgroup . | |
142 | The default is | |
f84fe3fc | 143 | .Fl t Sy posixuser , Ns Sy smbuser . |
870fc32f RW |
144 | The default can be changed to include group types. |
145 | .El | |
146 | .It Xo | |
1e36af8c | 147 | .Nm zfs |
870fc32f RW |
148 | .Cm groupspace |
149 | .Op Fl Hinp | |
f84fe3fc AZ |
150 | .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc |
151 | .Oo Fl s Ar field Oc Ns … | |
152 | .Oo Fl S Ar field Oc Ns … | |
153 | .Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns … Oc | |
870fc32f RW |
154 | .Ar filesystem Ns | Ns Ar snapshot |
155 | .Xc | |
156 | Displays space consumed by, and quotas on, each group in the specified | |
157 | filesystem or snapshot. | |
158 | This subcommand is identical to | |
159 | .Cm userspace , | |
160 | except that the default types to display are | |
f84fe3fc | 161 | .Fl t Sy posixgroup , Ns Sy smbgroup . |
870fc32f | 162 | .It Xo |
1e36af8c | 163 | .Nm zfs |
870fc32f RW |
164 | .Cm projectspace |
165 | .Op Fl Hp | |
f84fe3fc AZ |
166 | .Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns … Oc |
167 | .Oo Fl s Ar field Oc Ns … | |
168 | .Oo Fl S Ar field Oc Ns … | |
cf266775 | 169 | .Ar filesystem Ns | Ns Ar snapshot Ns | Ns Ar path |
870fc32f RW |
170 | .Xc |
171 | Displays space consumed by, and quotas on, each project in the specified | |
f84fe3fc AZ |
172 | filesystem or snapshot. |
173 | This subcommand is identical to | |
870fc32f | 174 | .Cm userspace , |
f84fe3fc AZ |
175 | except that the project identifier is a numeral, not a name. |
176 | So need neither the option | |
177 | .Fl i | |
870fc32f | 178 | for SID to POSIX ID nor |
f84fe3fc | 179 | .Fl n |
870fc32f | 180 | for numeric ID, nor |
f84fe3fc | 181 | .Fl t |
870fc32f RW |
182 | for types. |
183 | .El | |
f84fe3fc | 184 | . |
870fc32f | 185 | .Sh SEE ALSO |
2badb345 AZ |
186 | .Xr zfsprops 7 , |
187 | .Xr zfs-set 8 |