tag 186307 patch thanks Included is a manpage for error(). Please consider including it.
.\" Copyright (C) 2006 Justin Pryzby <[EMAIL PROTECTED]> .\" .\" Permission is hereby granted, free of charge, to any person obtaining .\" a copy of this software and associated documentation files (the .\" "Software"), to deal in the Software without restriction, including .\" without limitation the rights to use, copy, modify, merge, publish, .\" distribute, sublicense, and/or sell copies of the Software, and to .\" permit persons to whom the Software is furnished to do so, subject to .\" the following conditions: .\" .\" The above copyright notice and this permission notice shall be .\" included in all copies or substantial portions of the Software. .\" .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. .\" IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY .\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, .\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE .\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .\" .\" References: .\" glibc manual and source .TH ERROR 3 "25 April 2006" GNU .\" Please adjust this date whenever revising the manpage. .SH NAME error \- glibc error handling functions .SH SYNOPSIS \fBextern void error(int \fIstatus, \fBint\fI errnum, \fBconst char *\fIformat, \fB ...); \fBextern void error_at_line (int \fIstatus, \fBint \fIerrnum, \fBconst char *\fIfname, \fBunsigned int \fIlineno, \fBconst char *\fIformat, \fB...); \fBextern unsigned int \fIerror_message_count\fP; \fBextern void (* \fIerror_print_progname\fB) (void); .SH DESCRIPTION \fBerror\fP is a glibc\-specific error handling function. It outputs to stderr the program name, a colon, the message specified by the printf format string \fIformat\fP, and, if \fIerrnum\fP is nonzero, a second colon followed by the string given by \fBperror(\fIerrnum\fB)\fR. A newline is printed in all cases. If \fIstatus\fP is set nonzero, then the program terminates with that value as the exit status. If \fBerror_one_per_line\fP is set nonzero, and the \fBerror_at_line\fP variant is used, then a series of consecutive errors with the same value of \fIfname\fP and \fIlineno\fP causes only one message to be output. The preprocessor values \fB__LINE__\fP and \fB__FILE__\fP may be useful here, but other values can be used to suppress other sets of messages. For example, \fIfname\fP could be the name of an input file being processed, rather than the name of the source file. \fIerror_message_count\fP is the count of times that \fBerror\fP has been called. This variable can be used to defer and unify error handling for a large code block to a single common handler. If \fIerror_print_progname\fP is set nonnull, then it is called instead of prefixing the message with the program name and colon. Note that when \fIerror_print_progname\fP is unset, \fIstdout\fP is cleared before printing to \fIstderr\fP. .SH NOTES If output from \fBerror\fP is supressed by \fBerror_one_per_line\fP, then \fBerror_message_count\fP is not increased, but this seems to be undocumented behaviour and could change in the future, so should not be relied upon. .SH "CONFORMING TO" These functions and variables are GNU extensions, and should not be used in programs intending to be portable. .SH SEE ALSO .BR errno (3), .BR strerror (3), .BR err (3), .BR exit (3) .br The \fIGNU C Library Reference Manual\fP, available via the Info system. .SH AUTHOR glibc is a product of the \fIFree Software Foundation\fP. This manual page was written by Justin Pryzby \fI<[EMAIL PROTECTED]>\fP. -- To UNSUBSCRIBE, email to [EMAIL PROTECTED] with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
