xref: /freebsd/bin/pwait/pwait.1 (revision 1c05a6ea6b849ff95e539c31adea887c644a6a01)
1.\"
2.\" Copyright (c) 2004-2009, Jilles Tjoelker
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with
6.\" or without modification, are permitted provided that the
7.\" following conditions are met:
8.\"
9.\" 1. Redistributions of source code must retain the above
10.\"    copyright notice, this list of conditions and the
11.\"    following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the
13.\"    above copyright notice, this list of conditions and
14.\"    the following disclaimer in the documentation and/or
15.\"    other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18.\" CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
19.\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
21.\" PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
23.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
30.\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
31.\" OF SUCH DAMAGE.
32.\"
33.\" $FreeBSD$
34.\"
35.Dd March 7, 2017
36.Dt PWAIT 1
37.Os
38.Sh NAME
39.Nm pwait
40.Nd wait for processes to terminate
41.Sh SYNOPSIS
42.Nm
43.Op Fl t Ar duration
44.Op Fl v
45.Ar pid
46\&...
47.Sh DESCRIPTION
48The
49.Nm
50utility will wait until each of the given processes has terminated.
51.Pp
52The following option is available:
53.Bl -tag -width indent
54.It Fl t Ar duration
55If any process is still running after
56.Ar duration ,
57.Nm
58will exit.
59The
60.Ar duration
61value can be integer or decimal numbers.
62Values without unit symbols are interpreted as seconds.
63.Pp
64Supported unit symbols are:
65.Bl -tag -width indent -compact
66.It s
67seconds
68.It m
69minutes
70.It h
71hours
72.El
73.It Fl v
74Print the exit status when each process terminates.
75.El
76.Sh EXIT STATUS
77The
78.Nm
79utility exits 0 on success, and >0 if an error occurs.
80.Pp
81If the
82.Fl t
83flag is specified and a timeout occurs, the exit status will be 124.
84.Pp
85Invalid pids elicit a warning message but are otherwise ignored.
86.Sh SEE ALSO
87.Xr kill 1 ,
88.Xr pkill 1 ,
89.Xr ps 1 ,
90.Xr wait 1 ,
91.Xr kqueue 2
92.Sh NOTES
93.Nm
94is not a substitute for the
95.Xr wait 1
96builtin
97as it will not clean up any zombies or state in the parent process.
98.Sh HISTORY
99A
100.Nm
101command first appeared in SunOS 5.8.
102