xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-project.8 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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.\"
21.\"
22.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28.\" Copyright (c) 2014 Integros [integros.com]
29.\" Copyright 2019 Richard Laager. All rights reserved.
30.\" Copyright 2018 Nexenta Systems, Inc.
31.\" Copyright 2019 Joyent, Inc.
32.\"
33.Dd June 30, 2019
34.Dt ZFS-PROJECT 8
35.Os
36.Sh NAME
37.Nm zfs-project
38.Nd List, set, or clear project ID and/or inherit flag on the file(s) or directories.
39.Sh SYNOPSIS
40.Nm zfs
41.Cm project
42.Oo Fl d Ns | Ns Fl r Ns Oc
43.Ar file Ns | Ns Ar directory Ns ...
44.Nm zfs
45.Cm project
46.Fl C
47.Oo Fl kr Ns Oc
48.Ar file Ns | Ns Ar directory Ns ...
49.Nm zfs
50.Cm project
51.Fl c
52.Oo Fl 0 Ns Oc
53.Oo Fl d Ns | Ns Fl r Ns Oc
54.Op Fl p Ar id
55.Ar file Ns | Ns Ar directory Ns ...
56.Nm zfs
57.Cm project
58.Op Fl p Ar id
59.Oo Fl rs Ns Oc
60.Ar file Ns | Ns Ar directory Ns ...
61.Sh DESCRIPTION
62.Bl -tag -width ""
63.It Xo
64.Nm zfs
65.Cm project
66.Oo Fl d Ns | Ns Fl r Ns Oc
67.Ar file Ns | Ns Ar directory Ns ...
68.Xc
69List project identifier (ID) and inherit flag of file(s) or directories.
70.Bl -tag -width "-d"
71.It Fl d
72Show the directory project ID and inherit flag, not its children. It will
73overwrite the former specified
74.Fl r
75option.
76.It Fl r
77Show on subdirectories recursively. It will overwrite the former specified
78.Fl d
79option.
80.El
81.It Xo
82.Nm zfs
83.Cm project
84.Fl C
85.Oo Fl kr Ns Oc
86.Ar file Ns | Ns Ar directory Ns ...
87.Xc
88Clear project inherit flag and/or ID on the file(s) or directories.
89.Bl -tag -width "-k"
90.It Fl k
91Keep the project ID unchanged. If not specified, the project ID will be reset
92as zero.
93.It Fl r
94Clear on subdirectories recursively.
95.El
96.It Xo
97.Nm zfs
98.Cm project
99.Fl c
100.Oo Fl 0 Ns Oc
101.Oo Fl d Ns | Ns Fl r Ns Oc
102.Op Fl p Ar id
103.Ar file Ns | Ns Ar directory Ns ...
104.Xc
105Check project ID and inherit flag on the file(s) or directories, report the
106entries without project inherit flag or with different project IDs from the
107specified (via
108.Fl p
109option) value or the target directory's project ID.
110.Bl -tag -width "-0"
111.It Fl 0
112Print file name with a trailing NUL instead of newline (by default), like
113"find -print0".
114.It Fl d
115Check the directory project ID and inherit flag, not its children. It will
116overwrite the former specified
117.Fl r
118option.
119.It Fl p
120Specify the referenced ID for comparing with the target file(s) or directories'
121project IDs. If not specified, the target (top) directory's project ID will be
122used as the referenced one.
123.It Fl r
124Check on subdirectories recursively. It will overwrite the former specified
125.Fl d
126option.
127.El
128.It Xo
129.Nm zfs
130.Cm project
131.Op Fl p Ar id
132.Oo Fl rs Ns Oc
133.Ar file Ns | Ns Ar directory Ns ...
134.Xc
135Set project ID and/or inherit flag on the file(s) or directories.
136.Bl -tag -width "-p"
137.It Fl p
138Set the file(s)' or directories' project ID with the given value.
139.It Fl r
140Set on subdirectories recursively.
141.It Fl s
142Set project inherit flag on the given file(s) or directories. It is usually used
143for setup tree quota on the directory target with
144.Fl r
145option specified together. When setup tree quota, by default the directory's
146project ID will be set to all its descendants unless you specify the project
147ID via
148.Fl p
149option explicitly.
150.El
151.El
152.Sh SEE ALSO
153.Xr zfs-projectspace 8
154