xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-project.8 (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1.\" SPDX-License-Identifier: CDDL-1.0
2.\"
3.\" CDDL HEADER START
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or https://opensource.org/licenses/CDDL-1.0.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.\" CDDL HEADER END
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 May 27, 2021
34.Dt ZFS-PROJECT 8
35.Os
36.
37.Sh NAME
38.Nm zfs-project
39.Nd manage projects in ZFS filesystem
40.Sh SYNOPSIS
41.Nm zfs
42.Cm project
43.Oo Fl d Ns | Ns Fl r Ns Oc
44.Ar file Ns | Ns Ar directory Ns …
45.Nm zfs
46.Cm project
47.Fl C
48.Oo Fl kr Ns Oc
49.Ar file Ns | Ns Ar directory Ns …
50.Nm zfs
51.Cm project
52.Fl c
53.Oo Fl 0 Ns Oc
54.Oo Fl d Ns | Ns Fl r Ns Oc
55.Op Fl p Ar id
56.Ar file Ns | Ns Ar directory Ns …
57.Nm zfs
58.Cm project
59.Op Fl p Ar id
60.Oo Fl rs Ns Oc
61.Ar file Ns | Ns Ar directory Ns …
62.
63.Sh DESCRIPTION
64.Bl -tag -width ""
65.It Xo
66.Nm zfs
67.Cm project
68.Oo Fl d Ns | Ns Fl r Ns Oc
69.Ar file Ns | Ns Ar directory Ns …
70.Xc
71List project identifier (ID) and inherit flag of files and directories.
72.Bl -tag -width "-d"
73.It Fl d
74Show the directory project ID and inherit flag, not its children.
75.It Fl r
76List subdirectories recursively.
77.El
78.It Xo
79.Nm zfs
80.Cm project
81.Fl C
82.Oo Fl kr Ns Oc
83.Ar file Ns | Ns Ar directory Ns …
84.Xc
85Clear project inherit flag and/or ID on the files and directories.
86.Bl -tag -width "-k"
87.It Fl k
88Keep the project ID unchanged.
89If not specified, the project ID will be reset to zero.
90.It Fl r
91Clear subdirectories' flags recursively.
92.El
93.It Xo
94.Nm zfs
95.Cm project
96.Fl c
97.Oo Fl 0 Ns Oc
98.Oo Fl d Ns | Ns Fl r Ns Oc
99.Op Fl p Ar id
100.Ar file Ns | Ns Ar directory Ns …
101.Xc
102Check project ID and inherit flag on the files and directories:
103report entries without the project inherit flag, or with project IDs different
104from the
105target directory's project ID or the one specified with
106.Fl p .
107.Bl -tag -width "-p id"
108.It Fl 0
109Delimit filenames with a NUL byte instead of newline, don't output diagnoses.
110.It Fl d
111Check the directory project ID and inherit flag, not its children.
112.It Fl p Ar id
113Compare to
114.Ar id
115instead of the target files and directories' project IDs.
116.It Fl r
117Check subdirectories recursively.
118.El
119.It Xo
120.Nm zfs
121.Cm project
122.Fl p Ar id
123.Oo Fl rs Ns Oc
124.Ar file Ns | Ns Ar directory Ns …
125.Xc
126Set project ID and/or inherit flag on the files and directories.
127.Bl -tag -width "-p id"
128.It Fl p Ar id
129Set the project ID to the given value.
130.It Fl r
131Set on subdirectories recursively.
132.It Fl s
133Set project inherit flag on the given files and directories.
134This is usually used for setting up tree quotas with
135.Fl r .
136In that case, the directory's project ID
137will be set for all its descendants, unless specified explicitly with
138.Fl p .
139.El
140.El
141.
142.Sh SEE ALSO
143.Xr zfs-projectspace 8
144