xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-project.8 (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
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 https://opensource.org/licenses/CDDL-1.0.
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.\" 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 May 27, 2021
33.Dt ZFS-PROJECT 8
34.Os
35.
36.Sh NAME
37.Nm zfs-project
38.Nd manage projects in ZFS filesystem
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.
62.Sh DESCRIPTION
63.Bl -tag -width ""
64.It Xo
65.Nm zfs
66.Cm project
67.Oo Fl d Ns | Ns Fl r Ns Oc
68.Ar file Ns | Ns Ar directory Ns …
69.Xc
70List project identifier (ID) and inherit flag of files and directories.
71.Bl -tag -width "-d"
72.It Fl d
73Show the directory project ID and inherit flag, not its children.
74.It Fl r
75List subdirectories recursively.
76.El
77.It Xo
78.Nm zfs
79.Cm project
80.Fl C
81.Oo Fl kr Ns Oc
82.Ar file Ns | Ns Ar directory Ns …
83.Xc
84Clear project inherit flag and/or ID on the files and directories.
85.Bl -tag -width "-k"
86.It Fl k
87Keep the project ID unchanged.
88If not specified, the project ID will be reset to zero.
89.It Fl r
90Clear subdirectories' flags recursively.
91.El
92.It Xo
93.Nm zfs
94.Cm project
95.Fl c
96.Oo Fl 0 Ns Oc
97.Oo Fl d Ns | Ns Fl r Ns Oc
98.Op Fl p Ar id
99.Ar file Ns | Ns Ar directory Ns …
100.Xc
101Check project ID and inherit flag on the files and directories:
102report entries without the project inherit flag, or with project IDs different
103from the
104target directory's project ID or the one specified with
105.Fl p .
106.Bl -tag -width "-p id"
107.It Fl 0
108Delimit filenames with a NUL byte instead of newline, don't output diagnoses.
109.It Fl d
110Check the directory project ID and inherit flag, not its children.
111.It Fl p Ar id
112Compare to
113.Ar id
114instead of the target files and directories' project IDs.
115.It Fl r
116Check subdirectories recursively.
117.El
118.It Xo
119.Nm zfs
120.Cm project
121.Fl p Ar id
122.Oo Fl rs Ns Oc
123.Ar file Ns | Ns Ar directory Ns …
124.Xc
125Set project ID and/or inherit flag on the files and directories.
126.Bl -tag -width "-p id"
127.It Fl p Ar id
128Set the project ID to the given value.
129.It Fl r
130Set on subdirectories recursively.
131.It Fl s
132Set project inherit flag on the given files and directories.
133This is usually used for setting up tree quotas with
134.Fl r .
135In that case, the directory's project ID
136will be set for all its descendants, unless specified explicitly with
137.Fl p .
138.El
139.El
140.
141.Sh SEE ALSO
142.Xr zfs-projectspace 8
143