m + use optimisations '(adds auto-executed function: libar2_init)'

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 44 insertions, 0 deletions

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 <libar2.h>
+
+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)