annotate man/mlk_err_string.3 @ 440:c9bd1ff1ebe1

man: start splitting manual pages
author David Demelier <markand@malikania.fr>
date Tue, 18 Oct 2022 09:04:02 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
440
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .Dd $Mdocdate$
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .Dt MLK_ERR_STRING 3
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .Os
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .Sh NAME
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .Nm mlk_err_string
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .Nd return human readable error string
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .Sh LIBRARY
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 libmlk-core (-lmlk-core)
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .Sh SYNOPSIS
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .In mlk/core/err.h
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .Ft "const char *"
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .Fn mlk_err_string "int e"
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .Sh DESCRIPTION
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 The function
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .Fn mlk_err_string
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 returns a constant string description of the error code
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Fa e .
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Pp
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 See the
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Xr mlk-err 3
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 manual page for a list of error codes.
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Sh SEE ALSO
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .Xr mlk-err 3
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh AUTHORS
c9bd1ff1ebe1 man: start splitting manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .An David Demelier Aq Mt markand@malikania.fr .