summaryrefslogtreecommitdiff
path: root/doc/man/ap_init.3
diff options
context:
space:
mode:
authordimitri staessens <[email protected]>2017-04-13 12:00:09 +0200
committerdimitri staessens <[email protected]>2017-04-13 12:14:24 +0200
commitb43e8cd0f0858e78486752007c3640b70bf44c8d (patch)
treeb07a8c54f0e2cdcf258fba38ae77edc02e3d17d1 /doc/man/ap_init.3
parent72c28d6173ade511e9dc6969e0fc66db2dbba38a (diff)
downloadouroboros-b43e8cd0f0858e78486752007c3640b70bf44c8d.tar.gz
ouroboros-b43e8cd0f0858e78486752007c3640b70bf44c8d.zip
include, lib: Rename ap_init/ap_fini
Fixes #35
Diffstat (limited to 'doc/man/ap_init.3')
-rw-r--r--doc/man/ap_init.367
1 files changed, 0 insertions, 67 deletions
diff --git a/doc/man/ap_init.3 b/doc/man/ap_init.3
deleted file mode 100644
index c5b93764..00000000
--- a/doc/man/ap_init.3
+++ /dev/null
@@ -1,67 +0,0 @@
-.\" Ouroboros man pages (C) 2017
-.\" Dimitri Staessens <[email protected]>
-.\" Sander Vrijders <[email protected]>
-
-.TH AP_INIT 3 2017-04-10 GNU "Ouroboros Programmer's Manual"
-
-.SH NAME
-
-ap_init, ap_fini \- initialize and finalize an application for using
-Ouroboros
-
-.SH SYNOPSIS
-
-.B #include <ouroboros/dev.h>
-
-\fBint ap_init(char * \fIapn\fB);\fR
-
-\fBvoid ap_fini(void);\fR
-
-Compile and link with \fI-louroboros\fR.
-
-.SH DESCRIPTION
-
-The \fBap_init\fR() call initializes an application process instance
-for using the Ouroboros IPC infrastructure. If the application is a
-server or peer, a \fBchar * \fIapn\fR has to be provided indicating the
-application process that this instance belongs to. This is usually
-argv[0]. A client application may pass NULL. The \fBap_fini\fR() call
-will release all resources allocated by \fBap_fini\fR().
-
-\fBap_init\fR() and \fBap_fini\fR() should be called only once in the
-application.
-
-.SH RETURN VALUE
-
-On success, \fBap_init\fR() returns 0. On failure, a negative value
-indicating the error will be returned. The \fBap_fini\fR() function
-has no return value.
-
-.SH ERRORS
-
-\fBap_init\fR() can return the following errors:
-
-.B -EIRMD
-Failed to contact an IRMd instance.
-
-.B -ENOMEM
-Insufficient system resources to intialize the application.
-
-.SH ATTRIBUTES
-
-For an explanation of the terms used in this section, see \fBattributes\fR(7).
-
-.TS
-box, tab(&);
-LB|LB|LB
-L|L|L.
-Interface & Attribute & Value
-_
-\fBap_init\fR() & Thread safety & MT-Safe
-_
-\fBap_fini\fR() & Thread safety & MT-Safe
-.TE
-
-.SH COLOPHON
-This page is part of the Ouroboros project, found at
-https://bitbucket.org/ouroboros-rina/ouroboros