aboutsummaryrefslogtreecommitdiffstats
path: root/libhaiku_perror.3
diff options
context:
space:
mode:
Diffstat (limited to 'libhaiku_perror.3')
-rw-r--r--libhaiku_perror.345
1 files changed, 45 insertions, 0 deletions
diff --git a/libhaiku_perror.3 b/libhaiku_perror.3
new file mode 100644
index 0000000..9530397
--- /dev/null
+++ b/libhaiku_perror.3
@@ -0,0 +1,45 @@
+.TH LIBHAIKU_PERROR 3 LIBHAIKU
+.SH NAME
+libhaiku_perror \- Print a poetic error message for the current error
+
+.SH SYNOPSIS
+.nf
+#include <libhaiku.h>
+
+inline void libhaiku_perror(const char *\fIprefix\fP);
+.fi
+.PP
+Link with
+.IR \-lhaiku .
+
+.SH DESCRIPTION
+The
+.BR libhaiku_perror ()
+function prints an error message in the form of
+a haiku, appropriate for the current value of
+.BR errno ,
+or if none are available, a generic one.
+.PP
+Unless
+.I NULL
+or empty, each line will be prefixed by the
+string specified in the
+.I prefix
+parameter, followed by a colon and a space.
+
+.SH RETURN VALUES
+None.
+
+.SH ERRORS
+Errors are not detected, but can be checked by calling
+.BR ferror (3)
+for
+.BR stderr (3)
+afterwards.
+
+.SH SEE ALSO
+.BR perror (3),
+.BR libhaiku (7),
+.BR libhaiku_perror2 (3),
+.BR libhaiku_generic (3),
+.BR libhaiku_strerror (3)