added sntl_init manpage;

v0.5.xx
Alexander Vdolainen 9 years ago
parent fe16a8ffac
commit 729b8b2913

@ -2,4 +2,5 @@ man/sxmsg_rreply.3
man/connections_create.3 man/connections_create.3
man/connections_destroy.3 man/connections_destroy.3
man/connections_free.3 man/connections_free.3
man/connections_init.3 man/connections_init.3
man/sntl_init.3

@ -1 +1,2 @@
man_MANS = sxmsg_rreply.3 connections_create.3 connections_init.3 connections_destroy.3 connections_free.3 man_MANS = sxmsg_rreply.3 connections_create.3 connections_init.3 connections_destroy.3 connections_free.3 \
sntl_init.3

@ -0,0 +1,45 @@
.TH SNTL_INIT 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.SH NAME
sntl_init \- Initialize all required globals to run sntl library functions
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.sp
int *sntl_init(void);
.br
.sp
.SH DESCRIPTION
.B sntl_init
will initialize all globals required to run sntl related functions, it mostly about
openssl library initialization.
.br
.SH RETURN VALUE
Always returns
.B 0
since we cannot track openssl global initialization routines.
.br
.SH ERRORS
None errors might be returned.
.SH BUGS
None known yet.
.SH EXAMPLE
None.
.SH APPLICATION USAGE
Call this function from the main thread before using sntl library. Otherwise it will not works. There are also
useful to know if you are using other openssl functionality there are no need to initialize globals for it.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_create(3)
,
.BI connections_destroy(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br
(c) Askele Group 2013-2015 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)
Loading…
Cancel
Save