xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-wait.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) 2007, Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
24.\" Copyright (c) 2012 Cyril Plisko. All Rights Reserved.
25.\" Copyright (c) 2017 Datto Inc.
26.\" Copyright (c) 2018 George Melikov. All Rights Reserved.
27.\" Copyright 2017 Nexenta Systems, Inc.
28.\" Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
29.\"
30.Dd May 31, 2021
31.Dt ZFS-WAIT 8
32.Os
33.
34.Sh NAME
35.Nm zfs-wait
36.Nd wait for activity in ZFS filesystem to stop
37.Sh SYNOPSIS
38.Nm zfs
39.Cm wait
40.Op Fl t Ar activity Ns Oo , Ns Ar activity Ns Oc Ns …
41.Ar filesystem
42.
43.Sh DESCRIPTION
44Waits until all background activity of the given types has ceased in the given
45filesystem.
46The activity could cease because it has completed or because the filesystem has
47been destroyed or unmounted.
48If no activities are specified, the command waits until background activity of
49every type listed below has ceased.
50If there is no activity of the given types in progress, the command returns
51immediately.
52.Pp
53These are the possible values for
54.Ar activity ,
55along with what each one waits for:
56.Bl -tag -compact -offset Ds -width "deleteq"
57.It Sy deleteq
58The filesystem's internal delete queue to empty
59.El
60.Pp
61Note that the internal delete queue does not finish draining until
62all large files have had time to be fully destroyed and all open file
63handles to unlinked files are closed.
64.
65.Sh SEE ALSO
66.Xr lsof 8
67