diff options
| author | Mattias Andrée <maandree@kth.se> | 2021-03-01 02:16:25 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2021-03-01 02:16:25 +0100 |
| commit | 4c1a6e380ebe76e256b2af1313cf256d9fea70df (patch) | |
| tree | e20184a304c0ba1160477b644504fbb2e8146319 /libhaiku_strerror.3 | |
| parent | Merge pull request #2 from ayekat/master (diff) | |
| parent | misc + change license + changed behaviour of libhaiku_perror (diff) | |
| download | libhaiku-9ef9f79c78cced50f01f47db89c4b17614f52061.tar.gz libhaiku-9ef9f79c78cced50f01f47db89c4b17614f52061.tar.bz2 libhaiku-9ef9f79c78cced50f01f47db89c4b17614f52061.tar.xz | |
Merge branch 'rewrite'2.0
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libhaiku_strerror.3')
| -rw-r--r-- | libhaiku_strerror.3 | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/libhaiku_strerror.3 b/libhaiku_strerror.3 new file mode 100644 index 0000000..8cea8c2 --- /dev/null +++ b/libhaiku_strerror.3 @@ -0,0 +1,50 @@ +.TH LIBHAIKU_STRERROR 3 LIBHAIKU +.SH NAME +libhaiku_strerror \- Get a poetic error message for a specific error + +.SH SYNOPSIS +.nf +#include <libhaiku.h> + +const char *libhaiku_strerror(int \fIerrnum\fP, int *\fIgenericp\fP); +.fi +.PP +Link with +.IR \-lhaiku . + +.SH DESCRIPTION +The +.BR libhaiku_strerror () +function returns prints an error message in +the form of a haiku, appropriate for the +.B errno +value specified in the +.I errnum +parameter, or if none are available, +a generic one. If +.I errnum +is negative, a generic peom will be printed. +.PP +Unless +.I genericp +is +.IR NULL , +.I *genericp +will be set to 1 if a generic error message +was return, and to 0 otherwise. + +.SH RETURN VALUES +The +.BR libhaiku_strerror () +returns a generic, poetic error message +in the form of a haiku + +.SH ERRORS +Impossible. + +.SH SEE ALSO +.BR strerror (3), +.BR libhaiku (7), +.BR libhaiku_perror (3), +.BR libhaiku_perro2 (3), +.BR libhaiku_generic (3) |