2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" From: @(#)err.3 8.1 (Berkeley) 6/9/93
33 .\" $FreeBSD: src/lib/libc/gen/err.3,v 1.11.2.6 2001/12/14 18:33:51 ru Exp $
34 .\" $DragonFly: src/lib/libc/gen/err.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
54 .Nd formatted error messages
60 .Fn err "int eval" "const char *fmt" "..."
62 .Fn err_set_exit "void (*exitf)(int)"
64 .Fn err_set_file "void *vfp"
66 .Fn errc "int eval" "int code" "const char *fmt" "..."
68 .Fn errx "int eval" "const char *fmt" "..."
70 .Fn warn "const char *fmt" "..."
72 .Fn warnc "int code" "const char *fmt" "..."
74 .Fn warnx "const char *fmt" "..."
77 .Fn verr "int eval" "const char *fmt" "va_list args"
79 .Fn verrc "int eval" "int code" "const char *fmt" "va_list args"
81 .Fn verrx "int eval" "const char *fmt" "va_list args"
83 .Fn vwarn "const char *fmt" "va_list args"
85 .Fn vwarnc "int code" "const char *fmt" "va_list args"
87 .Fn vwarnx "const char *fmt" "va_list args"
93 family of functions display a formatted error message on the standard
94 error output, or on another file specified using the
97 In all cases, the last component of the program name, a colon character,
98 and a space are output.
101 argument is not NULL, the
103 -like formatted error message is output.
104 The output is terminated by a newline character.
116 functions append an error message obtained from
118 based on a code or the global variable
120 preceded by another colon and space unless the
134 argument is used to look up the error message.
142 functions use the global variable
144 to look up the error message.
150 functions do not append an error message.
160 functions do not return, but exit with the value of the argument
164 function can be used to specify a function which is called before
166 to perform any necessary cleanup; passing a null function pointer for
168 resets the hook to do nothing.
171 function sets the output stream used by the other functions.
174 argument must be either a pointer to an open stream
175 (possibly already converted to void *)
177 (in which case the output stream is set to standard error).
179 Display the current errno information string and exit:
180 .Bd -literal -offset indent
181 if ((p = malloc(size)) == NULL)
183 if ((fd = open(file_name, O_RDONLY, 0)) == -1)
184 err(1, "%s", file_name);
187 Display an error message and exit:
188 .Bd -literal -offset indent
189 if (tm.tm_hour < START_TIME)
190 errx(1, "too early, wait until %s", start_time_string);
194 .Bd -literal -offset indent
195 if ((fd = open(raw_device, O_RDONLY, 0)) == -1)
196 warnx("%s: %s: trying the block device",
197 raw_device, strerror(errno));
198 if ((fd = open(block_device, O_RDONLY, 0)) == -1)
199 err(1, "%s", block_device);
202 Warn of an error without using the global variable
204 .Bd -literal -offset indent
205 error = my_function(); /* returns a value from <errno.h> */
207 warnc(error, "my_function");
218 functions first appeared in
224 functions first appeared in
230 functions first appeared in