From 0e676861b71b8a17fdf0b968ef32751e2df30444 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 10 May 2020 17:26:03 +0200 Subject: Documentation + return -1 screen when not specified MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libaxl_create.3 | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 libaxl_create.3 (limited to 'libaxl_create.3') diff --git a/libaxl_create.3 b/libaxl_create.3 new file mode 100644 index 0000000..00417dc --- /dev/null +++ b/libaxl_create.3 @@ -0,0 +1,46 @@ +.TH libaxl_create 3 libaxl +.SH NAME +libaxl_create - Create connection record +.SH SYNOPSIS +.nf +#include + +LIBAXL_CONNECTION *libaxl_create(int \fIfd\fP); +.fi +.SH DESCRIPTION +The +.BR libaxl_create () +function creates a connection record context, +for a connection to the display server. The +connection does not have to be established +yet, but they socket for the connection should +have been created and should be specified in the +.I fd +parameter. +.SH RETURN VALUE +The +.BR libaxl_create () +returns the connection record on success +completion, or +.I NULL +on failure. +.SH ERRORS +The +.BR libaxl_create () +function can only fail if enough memory +cannot be allocates for the process, +which is corresponds to the +.I ENOMEM +error number and the +.I LIBAXL_ERROR_SYSTEM +libaxl error number. +.SH NOTES +None. +.SH SEE ALSO +.BR libaxl_connect (3), +.BR libaxl_parse_display (3), +.BR libaxl_send_handshake (3), +.BR libaxl_close (3), +.BR libaxl_detach (3), +.BR libaxl_attach (3), +.BR libaxl_context_create (3) -- cgit v1.2.3-70-g09d2