public/libsxmp
public/libsxmp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

man: added sntl_finalize description;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-08-05 11:38:44 +03:00
parent ac9134e0b6
commit eae148b2fe
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
man/sntl_finalize.3 Symbolic link
View File

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

11
man/sntl_init.3
View File

@ -2,11 +2,14 @@
.SH NAME .SH NAME
sntl_init \- Initialize all required globals to run sntl library functions sntl_init \- Initialize all required globals to run sntl library functions
.br .br
sntl_finalize \- Destroy all allocated resources for SNTL operation
.br
.SH SYNOPSIS .SH SYNOPSIS
.B #include <sntl/sntllv2.h> .B #include <sntl/sntllv2.h>
.sp .sp
int *sntl_init(void); int sntl_init(void);
void sntl_finalize(void);
.br .br
.sp .sp
.SH DESCRIPTION .SH DESCRIPTION
@ -14,6 +17,8 @@ int *sntl_init(void);
will initialize all globals required to run sntl related functions, it mostly about will initialize all globals required to run sntl related functions, it mostly about
openssl library initialization. openssl library initialization.
.br .br
.B sntl_finalize
will destroy all resources allocated for SNTL library operation.
.SH RETURN VALUE .SH RETURN VALUE
Always returns Always returns
.B 0 .B 0
@ -28,6 +33,10 @@ None.
.SH APPLICATION USAGE .SH APPLICATION USAGE
Call this function from the main thread before using sntl library. Otherwise it will not works. There are also 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. 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 .SH RATIONALE
None. None.
.SH SEE ALSO .SH SEE ALSO