.\" -*-nroff-*-
.\"
.\" Manual for reporting errors
.\"
.\" (c) 1999, 2001, 2005, 2009, 2024 Straylight/Edgeware
.\"
.
.\"----- Licensing notice ---------------------------------------------------
.\"
.\" This file is part of the mLib utilities library.
.\"
.\" mLib is free software: you can redistribute it and/or modify it under
.\" the terms of the GNU Library General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or (at
.\" your option) any later version.
.\"
.\" mLib 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 Library General Public
.\" License for more details.
.\"
.\" You should have received a copy of the GNU Library General Public
.\" License along with mLib.  If not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
.\" USA.
.
.\"--------------------------------------------------------------------------
.so ../defs.man \" @@@PRE@@@
.
.\"--------------------------------------------------------------------------
.TH report 3mLib "20 June 1999" "Straylight/Edgeware" "mLib utilities library"
.\" @moan
.\" @die
.
.\"--------------------------------------------------------------------------
.SH NAME
report \- report errors
.
.\"--------------------------------------------------------------------------
.SH SYNOPSIS
.
.nf
.B "#include <mLib/report.h>"
.PP
.BI "void moan(const char *" f ", ...);"
.BI "void die(int " status ", const char *" f ", ...);"
.fi
.
.\"--------------------------------------------------------------------------
.SH DESCRIPTION
The
.B moan
function emits a message to the standard error stream consisting of the
program's name (as read by the
.B quis
function; see
.BR quis (3) for details),
a colon, a space, and the
.BR printf -style
formatted string
.I f
followed by a newline.  This is a handy way to report nonfatal errors in
a program.
.PP
The
.B die
function emits a message to the standard error stream, just as for
.B moan
above, and then calls the
.B exit
function with argument
.I status
to halt the program.  This is a handy way to report fatal errors in a
program.
.
.\"--------------------------------------------------------------------------
.SH SEE ALSO
.
.BR exit (3),
.BR quis (3),
.BR mLib (3).
.
.\"--------------------------------------------------------------------------
.SH AUTHOR
.
Mark Wooding, <mdw@distorted.org.uk>
.
.\"----- That's all, folks --------------------------------------------------