From 6570686dc178b801b287e0ab155aaf691bbcb1eb Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 17 Feb 2022 15:11:28 +0100 Subject: m + use optimisations '(adds auto-executed function: libar2_init)' MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libar2_init.3 | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 libar2_init.3 (limited to 'libar2_init.3') diff --git a/libar2_init.3 b/libar2_init.3 new file mode 100644 index 0000000..d14b31f --- /dev/null +++ b/libar2_init.3 @@ -0,0 +1,44 @@ +.TH LIBAR2_INIT 3 LIBAR2 +.SH NAME +libar2_init - Initialise libar2 + +.SH SYNOPSIS +.nf +#include + +void libar2_init(void); +.fi +.PP +Link with +.IR -lar2 . + +.SH DESCRIPTION +The +.BR libar2_init () +function initialises the library, specifically +it selects which versions of different functions +the library shall use, based on the capabilities +of the machine that runs the function. +.PP +The +.BR libar2_init () +function is called automatically by the +.BR libar2_hash (3) +function, but it is desirable, but not necessary, +for multi-threaded applications to call it manually, +also depending on the capabilities of the compiler +and linker that was used to create the library, the +.BR libar2_init () +function may be called automatically at load-time. + +.SH RETURN VALUES +None. + +.SH ERRORS +The +.BR libar2_init () +function cannot fail. + +.SH SEE ALSO +.BR libar2 (7), +.BR libar2_hash (3) -- cgit v1.2.3-70-g09d2