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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
.\"
.\" 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_putchar
.cp 0 \" Solaris defaults to ''.cp 1'', sheesh.
.TH explain_putchar 3
.SH NAME
explain_putchar \- explain putchar(3) errors
.if require_index \{
.XX "explain_putchar(3)" "explain putchar(3) errors"
.\}
.SH SYNOPSIS
#include <libexplain/putchar.h>
.sp 0.3
const char *explain_putchar(int c);
.br
const char *explain_errno_putchar(int errnum, int c);
.br
void explain_message_putchar(char *message, int message_size, int c);
.br
void explain_message_errno_putchar(char *message, int message_size,
int errnum, int c);
.SH DESCRIPTION
These functions may be used to obtain explanations for
errors returned by the \f[I]putchar\fP(3) system call.
.\" ----------------------------------------------------
.SS explain_putchar
const char *explain_putchar(int c);
.PP
The \f[B]explain_putchar\fP function is
used to obtain an explanation of an error returned by the \f[I]putchar\fP(3)
system call. The least the message will contain is the
value of \f[CW]strerror(errno)\fP, but usually it will
do much better, and indicate the underlying cause in more
detail.
.PP
The \f[I]errno\fP global variable will be used to obtain
the error value to be decoded.
.PP
This function is intended to be used in a fashion
similar to the following example:
.RS
.ft CW
.nf
if (putchar(c) == EOF)
{
fprintf(stderr, "%s\en", explain_putchar(c));
exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.TP 8n
\f[I]c\fP
The original c, exactly as passed to the \f[I]putchar\fP(3) system call.
.TP 8n
Returns:
The message explaining the error. This message buffer is
shared by all libexplain functions which do not supply a
buffer in their argument list. This will be overwritten
by the next call to any libexplain function which shares
this buffer, including other threads.
.PP
\f[B]Note:\fP
This function is \f[B]not\fP thread safe, because it
shares a return buffer across all threads, and many other
functions in this library.
.\" ----------------------------------------------------
.SS explain_errno_putchar
const char *explain_errno_putchar(int errnum, int c);
.PP
The \f[B]explain_errno_putchar\fP function
is used to obtain an explanation of an error returned by
the \f[I]putchar\fP(3) system call.
The least the message will contain is the value of
\f[CW]strerror(errnum)\fP, but usually it will do much
better, and indicate the underlying cause in more detail.
.PP
This function is intended to be used in a fashion
similar to the following example:
.RS
.ft CW
.nf
if (putchar(c) == EOF)
{
int err = errno;
fprintf(stderr, "%s\en", explain_errno_putchar(err, c));
exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.TP 8n
\f[I]errnum\fP
The error value to be decoded, usually obtained from
the \f[I]errno\fP global variable just before this
function is called. This is necessary if you need to call
\f[B]any\fP code between the system call to be explained
and this function, because many libc functions will alter
the value of \f[I]errno\fP.
.TP 8n
\f[I]c\fP
The original c, exactly as passed to the \f[I]putchar\fP(3) system call.
.TP 8n
Returns:
The message explaining the error. This message buffer is
shared by all libexplain functions which do not supply a
buffer in their argument list. This will be overwritten
by the next call to any libexplain function which shares
this buffer, including other threads.
.PP
\f[B]Note:\fP
This function is \f[B]not\fP thread safe, because it
shares a return buffer across all threads, and many other
functions in this library.
.\" ----------------------------------------------------
.SS explain_message_putchar
void explain_message_putchar(char *message, int message_size, int c);
.PP
The \f[B]explain_message_putchar\fP
function may be used to obtain an explanation of an error
returned by the
\f[I]putchar\fP(3) system call.
The least the message will contain is the value of
\f[CW]strerror(errno)\fP, but usually it will do much
better, and indicate the underlying cause in more detail.
.PP
The \f[I]errno\fP global variable will be used to obtain
the error value to be decoded.
.PP
This function is intended to be used in a fashion
similar to the following example:
.RS
.ft CW
.nf
if (putchar(c) == EOF)
{
char message[3000];
explain_message_putchar(message, sizeof(message), c);
fprintf(stderr, "%s\en", message);
exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.TP 8n
\f[I]message\fP
The location in which to store the returned message.
If a suitable message return buffer is supplied, this
function is thread safe.
.TP 8n
\f[I]message_size\fP
The size in bytes of the location in which to
store the returned message.
.TP 8n
\f[I]c\fP
The original c, exactly as passed to the \f[I]putchar\fP(3) system call.
.\" ----------------------------------------------------
.SS explain_message_errno_putchar
void explain_message_errno_putchar(char *message, int message_size,
int errnum, int c);
.PP
The \f[B]explain_message_errno_putchar\fP
function may be used to obtain an explanation of an error
returned by the
\f[I]putchar\fP(3) system call.
The least the message will contain is the value of
\f[CW]strerror(errnum)\fP, but usually it will do much
better, and indicate the underlying cause in more detail.
.PP
This function is intended to be used in a fashion
similar to the following example:
.RS
.ft CW
.nf
if (putchar(c) == EOF)
{
int err = errno;
char message[3000];
explain_message_errno_putchar(message, sizeof(message), err, c);
fprintf(stderr, "%s\en", message);
exit(EXIT_FAILURE);
}
.fi
.ft R
.RE
.TP 8n
\f[I]message\fP
The location in which to store the returned message.
If a suitable message return buffer is supplied, this
function is thread safe.
.TP 8n
\f[I]message_size\fP
The size in bytes of the location in which to
store the returned message.
.TP 8n
\f[I]errnum\fP
The error value to be decoded, usually obtained from
the \f[I]errno\fP global variable just before this
function is called. This is necessary if you need to call
\f[B]any\fP code between the system call to be explained
and this function, because many libc functions will alter
the value of \f[I]errno\fP.
.TP 8n
\f[I]c\fP
The original c, exactly as passed to the \f[I]putchar\fP(3) system call.
.\" ----------------------------------------------------
.SH SEE ALSO
.TP 8n
\f[I]putchar\fP(3)
output of characters
.TP 8n
\f[I]explain_putchar_or_die\fP(3)
output of characters and report errors
.\" ----------------------------------------------------
.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
|
