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

fixed sxmp_* man;

Browse Source
This commit is contained in:
Alexander Vdolainen 2015-10-25 03:22:03 +02:00
parent dc237989c6
commit 2a3fd5d70a
4 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/Makefile.am
View File

@ -1,7 +1,7 @@
man_MANS = sxmsg_rreply.3 connections_create.3 connections_init.3 connections_destroy.3 connections_free.3 \
sntl_init.3 connections_setsslserts.3 connections_set_priv.3 connections_get_priv.3 \
sxmp_init.3 connections_setsslserts.3 connections_set_priv.3 connections_get_priv.3 \
connections_set_ondestroy.3 connections_set_onpulse.3 connections_set_sslvalidate.3 \
connections_set_authcheck.3 connections_set_rpcvalidator.3 connections_set_channelcall.3 \
connection_master_link.3 connection_link.3 connection_close.3 sxchannel_open.3 \
sxchannel_close.3 sxmsg_send.3 sxmsg_send_pp.3 sxmsg_clean.3 sntl_finalize.3 sxmsg_pulse.3 \
sxchannel_close.3 sxmsg_send.3 sxmsg_send_pp.3 sxmsg_clean.3 sxmp_finalize.3 sxmsg_pulse.3 \
sxmsg_reply.3 sxmsg_reply_pp.3 sxmsg_return.3 sxmsg_return_pp.3

1
man/sntl_finalize.3
View File

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

1
man/sxmp_finalize.3 Symbolic link
View File

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

28
man/sntl_init.3 → man/sxmp_init.3
View File

@ -1,24 +1,24 @@
.TH SNTL_INIT 3 "20 July 2015" "SNTLLv2" "SNTL Library Manual"
.TH SXMP_INIT 3 "20 July 2015" "SXMPLv2" "SXMP Library Manual"
.SH NAME
sntl_init \- Initialize all required globals to run sntl library functions
sxmp_init \- Initialize all required globals to run sxmp library functions
.br
sntl_finalize \- Destroy all allocated resources for SNTL operation
sxmp_finalize \- Destroy all allocated resources for SXMP operation
.br
.SH SYNOPSIS
.B #include <sntl/sntllv2.h>
.B #include <sxmp/sxmp.h>
.sp
int sntl_init(void);
int sxmp_init(void);
void sntl_finalize(void);
void sxmp_finalize(void);
.br
.sp
.SH DESCRIPTION
.B sntl_init
will initialize all globals required to run sntl related functions, it mostly about
.B sxmp_init
will initialize all globals required to run sxmp related functions, it mostly about
openssl library initialization.
.br
.B sntl_finalize
will destroy all resources allocated for SNTL library operation.
.B sxmp_finalize
will destroy all resources allocated for SXMP library operation.
.SH RETURN VALUE
Always returns
.B 0
@ -31,18 +31,18 @@ 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
Call this function from the main thread before using sxmp 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
.B sxmp_finalize
until you will finish with them.
.SH RATIONALE
None.
.SH SEE ALSO
.BI connections_create(3)
.BI sxhub_create(3)
,
.BI connections_destroy(3)
.BI sxhub_destroy(3)
.SH COPYRIGHT
This is a proprietary software. See COPYING for further details.
.br