2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 1993
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
.\" California, Berkeley and its contributors.
|
|
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" From: @(#)err.3 8.1 (Berkeley) 6/9/93
|
|
|
|
.\" $FreeBSD: src/lib/libc/gen/err.3,v 1.11.2.5 2001/08/17 15:42:32 ru Exp $
|
|
|
|
.\"
|
2007-12-03 19:59:38 +00:00
|
|
|
.\" 2007-12-08, mtk, Converted from mdoc to man macros
|
2007-12-03 19:53:53 +00:00
|
|
|
.\"
|
2007-12-28 05:38:10 +00:00
|
|
|
.TH ERR 3 2007-12-28 "Linux" "Linux Programmer's Manual"
|
2007-12-03 19:53:53 +00:00
|
|
|
.SH NAME
|
|
|
|
err, verr, errx, verrx, warn, vwarn, warnx, vwarnx \- formatted error messages
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <err.h>
|
|
|
|
.sp
|
|
|
|
.BI "void err(int " eval ", const char *" fmt ", ...);"
|
|
|
|
.sp
|
|
|
|
.BI "void errx(int " eval ", const char *" fmt ", ...);"
|
|
|
|
.sp
|
|
|
|
.BI "void warn(const char *" fmt ", ...);"
|
|
|
|
.sp
|
|
|
|
.BI "void warnx(const char *" fmt ", ...);"
|
|
|
|
.sp
|
|
|
|
.B #include <stdarg.h>
|
|
|
|
.sp
|
|
|
|
.BI "void verr(int " eval ", const char *" fmt ", va_list " args );
|
|
|
|
.sp
|
|
|
|
.BI "void verrx(int " eval ", const char *" fmt ", va_list " args );
|
|
|
|
.sp
|
|
|
|
.BI "void vwarn(const char *" fmt ", va_list " args );
|
|
|
|
.sp
|
|
|
|
.BI "void vwarnx(const char *" fmt ", va_list " args );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR err ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR warn ()
|
2004-11-03 13:51:07 +00:00
|
|
|
family of functions display a formatted error message on the standard
|
|
|
|
error output.
|
|
|
|
In all cases, the last component of the program name, a colon character,
|
|
|
|
and a space are output.
|
|
|
|
If the
|
2007-12-03 19:53:53 +00:00
|
|
|
.I fmt
|
2004-11-03 13:51:07 +00:00
|
|
|
argument is not NULL, the
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR printf (3)-like
|
|
|
|
formatted error message is output.
|
2004-11-03 13:51:07 +00:00
|
|
|
The output is terminated by a newline character.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR err (),
|
|
|
|
.BR verr (),
|
|
|
|
.BR warn (),
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR vwarn ()
|
2004-11-03 13:51:07 +00:00
|
|
|
functions append an error message obtained from
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR strerror (3)
|
2004-11-03 13:51:07 +00:00
|
|
|
based on a code or the global variable
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR errno ,
|
2004-11-03 13:51:07 +00:00
|
|
|
preceded by another colon and space unless the
|
2007-12-03 19:53:53 +00:00
|
|
|
.I fmt
|
2004-11-03 13:51:07 +00:00
|
|
|
argument is
|
2007-12-03 19:53:53 +00:00
|
|
|
NULL.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR err (),
|
|
|
|
.BR verr (),
|
|
|
|
.BR warn (),
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR vwarn ()
|
2004-11-03 13:51:07 +00:00
|
|
|
functions use the global variable
|
2007-12-03 19:53:53 +00:00
|
|
|
.I errno
|
2004-11-03 13:51:07 +00:00
|
|
|
to look up the error message.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR errx ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR warnx ()
|
2004-11-03 13:51:07 +00:00
|
|
|
functions do not append an error message.
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR err (),
|
|
|
|
.BR verr (),
|
|
|
|
.BR errx (),
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR verrx ()
|
2004-11-03 13:51:07 +00:00
|
|
|
functions do not return, but exit with the value of the argument
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR eval .
|
|
|
|
.SH EXAMPLES
|
2008-10-28 16:15:21 +00:00
|
|
|
Display the current
|
|
|
|
.I errno
|
|
|
|
information string and exit:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
if ((p = malloc(size)) == NULL)
|
2007-12-03 19:53:53 +00:00
|
|
|
err(1, NULL);
|
2005-07-06 12:57:38 +00:00
|
|
|
if ((fd = open(file_name, O_RDONLY, 0)) == \-1)
|
2007-12-03 19:53:53 +00:00
|
|
|
err(1, "%s", file_name);
|
|
|
|
.fi
|
|
|
|
.in
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
Display an error message and exit:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
if (tm.tm_hour < START_TIME)
|
2007-12-03 19:53:53 +00:00
|
|
|
errx(1, "too early, wait until %s", start_time_string);
|
|
|
|
.fi
|
|
|
|
.in
|
2007-12-28 05:38:10 +00:00
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
Warn of an error:
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2007-12-03 19:53:53 +00:00
|
|
|
.nf
|
|
|
|
|
2005-07-06 12:57:38 +00:00
|
|
|
if ((fd = open(raw_device, O_RDONLY, 0)) == \-1)
|
2007-12-03 19:53:53 +00:00
|
|
|
warnx("%s: %s: trying the block device",
|
|
|
|
raw_device, strerror(errno));
|
2005-07-06 12:57:38 +00:00
|
|
|
if ((fd = open(block_device, O_RDONLY, 0)) == \-1)
|
2007-12-03 19:53:53 +00:00
|
|
|
err(1, "%s", block_device);
|
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
.SH "CONFORMING TO"
|
accept.2, execve.2, futimesat.2, getresuid.2, getrlimit.2, madvise.2, mq_getsetattr.2, msgctl.2, nice.2, open.2, poll.2, setresuid.2, shmctl.2, sigaction.2, times.2, utimensat.2, __setfpucw.3, atoi.3, endian.3, err.3, euidaccess.3, fenv.3, fopencookie.3, fpurge.3, getgrouplist.3, getutmp.3, j0.3, lgamma.3, netlink.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_cleanup_push_defer_np.3, pthread_getattr_np.3, pthread_kill_other_threads_np.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, pthread_yield.3, random_r.3, readdir.3, rtnetlink.3, scanf.3, setenv.3, significand.3, sigsetops.3, strerror.3, strstr.3, sysv_signal.3, termios.3, timegm.3, unlocked_stdio.3, y0.3, locale.5, bootparam.7, feature_test_macros.7, ip.7, locale.7, pthreads.7, rtld-audit.7, nscd.8: Global fix: s/non-standard/nonstandard/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:37:52 +00:00
|
|
|
These functions are nonstandard BSD extensions.
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" .SH HISTORY
|
2007-11-16 06:34:05 +00:00
|
|
|
.\" The
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" .BR err ()
|
2007-11-16 06:34:05 +00:00
|
|
|
.\" and
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" .BR warn ()
|
2007-11-16 06:34:05 +00:00
|
|
|
.\" functions first appeared in
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" 4.4BSD.
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR error (3),
|
|
|
|
.BR exit (3),
|
|
|
|
.BR perror (3),
|
2008-07-14 15:52:21 +00:00
|
|
|
.BR printf (3),
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR strerror (3)
|