man: added sntl_finalize description;

v0.5.xx
Alexander Vdolainen 10 years ago
parent ac9134e0b6
commit eae148b2fe

@ -0,0 +1 @@
sntl_init.3

@ -2,11 +2,14 @@
.SH NAME
sntl_init \- Initialize all required globals to run sntl library functions
.br
sntl_finalize \- Destroy all allocated resources for SNTL operation
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.sp
int *sntl_init(void);
int sntl_init(void);
void sntl_finalize(void);
.br
.sp
.SH DESCRIPTION
@ -14,6 +17,8 @@ int *sntl_init(void);
will initialize all globals required to run sntl related functions, it mostly about
openssl library initialization.
.br
.B sntl_finalize
will destroy all resources allocated for SNTL library operation.
.SH RETURN VALUE
Always returns
.B 0
@ -28,6 +33,10 @@ 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.
.br
If you are using openssl, don't call
.B sntl_finalize
until you will finish with them.
.SH RATIONALE
None.
.SH SEE ALSO

Loading…
Cancel
Save