Author | Jamozed <[email protected]> |
Date | 2020-11-01 00:44:07 |
Commit | bc682d2c8c0740e739a517a99083628608806d21 |
Parent | 3d8be0f48ab9eb98c74f968b9ee95a3007cb4aa5 |
error: Update manpage formatting
Diffstat
M | man/error.3 | | | 24 | +++++++++++++----------- |
1 files changed, 13 insertions, 11 deletions
diff --git a/man/error.3 b/man/error.3 index 7ca7f76..f047b04 100644 --- a/man/error.3 +++ b/man/error.3 @@ -1,24 +1,26 @@ -.TH ERROR 3 2020-10-29 "OMKOV lib" "OMKOV lib Programmer's Manual" +.TH ERROR 3 2020-11-01 "OMKOV lib" "OMKOV lib Programmer's Manual" .SH NAME error, warn, serr \(em error reporting functions .SH SYNOPSYS -\fB#include <error.h> +#include <error.h> .PP -\fBvoid error(int \fIstatus\fB, const char *\fIformat\fR, ...); +extern char *\fIA0\fR; .PP -\fBvoid warn(const char *\fIformat\fR, ...); -.PP -\fBchar *serr(void); +void \fBerror\fR(int \fIstatus\fR, const char *\fIformat\fR, ...); +.br +void \fBwarn\fR(const char *\fIformat\fR, ...); +.br +char *\fBserr\fR(void); .SH DESCRIPTION -The \fBerror()\fR and \fBwarn()\fR functions print a formatted error message to +The \fBerror\fR() and \fBwarn\fR() functions print a formatted error message to standard error. If the global variable \fIA0\fR is set, it is output, followed by a colon character and a space, in front of the formatted error message. .PP -The \fBerror()\fR function will call the \fBexit()\fR function specified -declared in \fB<stdlib.h>\fR with \fIstatus\fR as its argument after the error -message has been printed. +The \fBerror\fR() function will call the \fBexit\fR() function specified +declared in <stdlib.h> with \fIstatus\fR as its argument after the error message +has been printed. .PP -The \fBserr()\fR function is shorthand for \fBstrerror(\fIerrno\fB)\fR. +The \fBserr\fR() function is shorthand for \fBstrerror\fR(\fIerrno\fR). .SH COPYRIGHT .nf Copyright (C) 2020, Jakob Wakeling