xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-wait.8 (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
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) 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 August 9, 2019
31.Dt ZFS-WAIT 8
32.Os
33.Sh NAME
34.Nm zfs-wait
35.Nd Wait for background activity to stop in a ZFS filesystem
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 fs
41.Sh DESCRIPTION
42.Bl -tag -width Ds
43.It Xo
44.Nm zfs
45.Cm wait
46.Op Fl t Ar activity Ns Oo , Ns Ar activity Ns Oc Ns ...
47.Ar fs
48.Xc
49Waits until all background activity of the given types has ceased in the given
50filesystem.
51The activity could cease because it has completed or because the filesystem has
52been destroyed or unmounted.
53If no activities are specified, the command waits until background activity of
54every type listed below has ceased.
55If there is no activity of the given types in progress, the command returns
56immediately.
57.Pp
58These are the possible values for
59.Ar activity ,
60along with what each one waits for:
61.Bd -literal
62        deleteq       The filesystem's internal delete queue to empty
63.Ed
64.Pp
65Note that the internal delete queue does not finish draining until
66all large files have had time to be fully destroyed and all open file
67handles to unlinked files are closed.
68.El
69.El
70.Sh SEE ALSO
71.Xr lsof  8
72