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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 .Nd formatted error messages
52 .Fn err "int eval" "const char *fmt" "..."
54 .Fn err_set_exit "void (*exitf)(int)"
56 .Fn err_set_file "void *vfp"
58 .Fn errc "int eval" "int code" "const char *fmt" "..."
60 .Fn errx "int eval" "const char *fmt" "..."
62 .Fn warn "const char *fmt" "..."
64 .Fn warnc "int code" "const char *fmt" "..."
66 .Fn warnx "const char *fmt" "..."
69 .Fn verr "int eval" "const char *fmt" "va_list args"
71 .Fn verrc "int eval" "int code" "const char *fmt" "va_list args"
73 .Fn verrx "int eval" "const char *fmt" "va_list args"
75 .Fn vwarn "const char *fmt" "va_list args"
77 .Fn vwarnc "int code" "const char *fmt" "va_list args"
79 .Fn vwarnx "const char *fmt" "va_list args"
85 family of functions display a formatted error message on the standard
86 error output, or on another file specified using the
89 In all cases, the last component of the program name, a colon character,
90 and a space are output.
93 argument is not NULL, the
95 -like formatted error message is output.
96 The output is terminated by a newline character.
108 functions append an error message obtained from
110 based on a supplied error code value or the global variable
112 preceded by another colon and space unless the
126 argument is used to look up the error message.
134 functions use the global variable
136 to look up the error message.
142 functions do not append an error message.
152 functions do not return, but exit with the value of the argument
154 It is recommended that the standard values defined in
156 be used for the value of
160 function can be used to specify a function which is called before
162 to perform any necessary cleanup; passing a null function pointer for
164 resets the hook to do nothing.
167 function sets the output stream used by the other functions.
170 argument must be either a pointer to an open stream
171 (possibly already converted to void *)
173 (in which case the output stream is set to standard error).
175 Display the current errno information string and exit:
176 .Bd -literal -offset indent
177 if ((p = malloc(size)) == NULL)
179 if ((fd = open(file_name, O_RDONLY, 0)) == -1)
180 err(EX_NOINPUT, "%s", file_name);
183 Display an error message and exit:
184 .Bd -literal -offset indent
185 if (tm.tm_hour < START_TIME)
186 errx(EX_DATAERR, "too early, wait until %s",
191 .Bd -literal -offset indent
192 if ((fd = open(raw_device, O_RDONLY, 0)) == -1)
193 warnx("%s: %s: trying the block device",
194 raw_device, strerror(errno));
195 if ((fd = open(block_device, O_RDONLY, 0)) == -1)
196 err(EX_OSFILE, "%s", block_device);
199 Warn of an error without using the global variable
201 .Bd -literal -offset indent
202 error = my_function(); /* returns a value from <errno.h> */
204 warnc(error, "my_function");
217 families of functions are
220 As such they should not be used in truly portable code.
223 or similar functions instead.
229 functions first appeared in
235 functions first appeared in
241 functions first appeared in