1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
.\"
.\" libexplain - Explain errno values returned by libc functions
.\" Copyright (C) 2008, 2009, 2011 Peter Miller
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or (at
.\" your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.ds n) explain_waitpid_or_die
.cp 0 \" Solaris defaults to ''.cp 1'', sheesh.
.TH explain_waitpid_or_die 3
.SH NAME
explain_waitpid_or_die \- wait for process to change state and report errors
.if require_index \{
.XX "explain_waitpid_or_die(3)" \
"wait for process to change state and report errors"
.\}
.SH SYNOPSIS
#include <libexplain/waitpid.h>
.sp 0.3
int pid = explain_waitpid_or_die(int pid, int *status, int options);
.SH DESCRIPTION
The \f[B]explain_waitpid_or_die\fP function
is used to call the \f[I]waitpid\fP(2) system
call. On failure an explanation will be
printed to \f[I]stderr\fP,
obtained from \f[I]explain_waitpid\fP(3),
and then the process terminates
by calling \f[CW]exit(EXIT_FAILURE)\fP.
.PP
This function is intended to be used in a fashion
similar to the following example:
.RS
.ft CW
.nf
explain_waitpid_or_die(pid, status, options);
.fi
.ft R
.RE
.TP 8n
\f[I]pid\fP
The pid, exactly as to be passed to the \f[I]waitpid\fP(2) system call.
.TP 8n
\f[I]status\fP
The status, exactly as to be passed to the \f[I]waitpid\fP(2) system call.
.TP 8n
\f[I]options\fP
The options, exactly as to be passed to the \f[I]waitpid\fP(2) system call.
.TP 8n
Returns:
This function only returns on success.
On failure, prints an explanation and exits.
.\" ----------------------------------------------------
.SH SEE ALSO
.TP 8n
\f[I]waitpid\fP(2)
wait for process to change state
.TP 8n
\f[I]explain_waitpid\fP(3)
explain \f[I]waitpid\fP(2) errors
.TP 8n
\f[I]exit\fP(2)
terminate the calling process
.\" ----------------------------------------------------
.SH COPYRIGHT
.so etc/version.so
.if n .ds C) (C)
.if t .ds C) \(co
libexplain version \*(v)
.br
Copyright \*(C) 2008 Peter Miller
|
