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