From 43348c8cf6a3000821ff9ccbc51de87e5708b6e6 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Mon, 4 Jan 2016 23:43:37 +0100 Subject: add man pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libhaiku.7 | 34 +++++++++++++++++++++++++++ doc/man/libhaiku_perror.3 | 60 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 doc/man/libhaiku.7 create mode 100644 doc/man/libhaiku_perror.3 (limited to 'doc/man') diff --git a/doc/man/libhaiku.7 b/doc/man/libhaiku.7 new file mode 100644 index 0000000..d6eee8d --- /dev/null +++ b/doc/man/libhaiku.7 @@ -0,0 +1,34 @@ +.TH LIBHAIKU 7 LIBHAIKU +.SH NAME +libhaiku \- Poetic error messages +.SH DESCRIPTION +.B libhaiku +is an API on top of a collection of haiku, thats lets a programmer +make a program print haiku for error messages. Instead of calling +.BR perror (3), +the program should call +.BR libhaiku_perror (3). +.SH "SEE ALSO" +.BR libhaiku_perror (3), +.BR perror (3) +.SH "KNOWN ISSUES" +Must of the haiku uses 5\-7\-5 syllables rather than 5\-7\-5 morae. +This is however of lesser importance, as it is much harder to write +a 5\-7\-5 mora haiku than a 5\-7\-5 syllable haiku. +.SH LICENSE +Copyright \(co 2016 Mattias Andrée +.br +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +.br +There is NO WARRANTY, to the extent permitted by law. +.PP +Copying and distribution of this manual, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. This file is offered as-is, +without any warranty. +.SH BUGS +Please report bugs to +or to . + diff --git a/doc/man/libhaiku_perror.3 b/doc/man/libhaiku_perror.3 new file mode 100644 index 0000000..7c0476d --- /dev/null +++ b/doc/man/libhaiku_perror.3 @@ -0,0 +1,60 @@ +.TH LIBHAIKU_PERROR 3 LIBHAIKU +.SH NAME +libhaiku_perror \- Print a poetic error message +.SH SYNOPSIS +.nf +#include + +void \fBlibhaiku_perror\fP(const char *\fIs\fP); +.fi +.PP +Link with +.IR \-lhaiku . +.SH DESCRIPTION +.B libhaiku_perror +shall print an error message in the format of a haiku, appropriate +for the current value of +.BR errno . +If there is not haiku available for the current value of +.BR errno , +.B libhaiku_perror +shall call +.BR perror (3) +with +.I s +as its argument unless +.I s +is +.BR NULL , +and then print a generic haiku. +.PP +Unlike +.BR perror (3), +.B libhaiku_perror +shall not print anything if +.B errno +is zero. +.SH "SEE ALSO" +.BR libhaiku (7), +.BR perror (3) +.SH "KNOWN ISSUES" +Must of the haiku uses 5\-7\-5 syllables rather than 5\-7\-5 morae. +This is however of lesser importance, as it is much harder to write +a 5\-7\-5 mora haiku than a 5\-7\-5 syllable haiku. +.SH LICENSE +Copyright \(co 2016 Mattias Andrée +.br +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +.br +There is NO WARRANTY, to the extent permitted by law. +.PP +Copying and distribution of this manual, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. This file is offered as-is, +without any warranty. +.SH BUGS +Please report bugs to +or to . + -- cgit v1.2.3-70-g09d2