diff options
| author | Mattias Andrée <maandree@kth.se> | 2022-04-22 22:25:58 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2022-04-22 22:25:58 +0200 |
| commit | 61e837a2b5ec28f0864871b6aef494493f6262d4 (patch) | |
| tree | 557fe093ce75b22522acc48ee7b70b4f71e88eae /man3/LIBAXL_CONNECTION.3 | |
| parent | m (diff) | |
| download | libaxl-61e837a2b5ec28f0864871b6aef494493f6262d4.tar.gz libaxl-61e837a2b5ec28f0864871b6aef494493f6262d4.tar.bz2 libaxl-61e837a2b5ec28f0864871b6aef494493f6262d4.tar.xz | |
Documentation
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
| -rw-r--r-- | man3/LIBAXL_CONNECTION.3 | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/man3/LIBAXL_CONNECTION.3 b/man3/LIBAXL_CONNECTION.3 new file mode 100644 index 0000000..c8ebd66 --- /dev/null +++ b/man3/LIBAXL_CONNECTION.3 @@ -0,0 +1,35 @@ +.TH LIBAXL_CONNECTION 3 libaxl +.SH NAME +LIBAXL_CONNECTION - Connection to display server +.SH SYNOPSIS +.nf +#include <libaxl.h> + +typedef struct libaxl_connection LIBAXL_CONNECTION; +.fi +.SH DESCRIPTION +The +.B LIBAXL_CONNECTION +type definition (also known as +.BR "struct libaxl_connection" ) +is used by the libaxl library to store the +state of a connection to an X display server, +as well as the connection itself to the +display server. +.PP +The library only exposes an incomplete +definition to of the structure because it +should be regarded as opaque as it may change +between versions of the library. +.PP +Using the +.BR libaxl_connect (3) +function is the easiest way to create a +connection to the display server; it can +be disposed with the +.BR libaxl_close (3) +function. +.SH SEE ALSO +.BR libaxl_connect (3), +.BR libaxl_close (3), +.BR LIBAXL_CONTEXT (3) |