diff options
Diffstat (limited to 'doc')
59 files changed, 0 insertions, 4310 deletions
diff --git a/doc/man/libcoopgamma.7 b/doc/man/libcoopgamma.7 deleted file mode 100644 index 2e11d27..0000000 --- a/doc/man/libcoopgamma.7 +++ /dev/null @@ -1,46 +0,0 @@ -.TH LIBCOOPGAMMA 7 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma - Cooperative gamma library -.SH "DESCRIPTION" -.B libcoopgamma -is a C library that enables programs to communicate with -.BR coopgammad (1), -and eventually -.BR mds-coopgamma (1). -The advantage of using -.B libcoopgamma -over directly communicating with the display server is -you get support for multiple display servers transparently -(just like with -.BR libgamma (7)), -more importantly, all programs that use libcoopgamma can -change the gamma ramps without overriding each others -changes, they add their own filters. Filters are ordered -by their selected priority and chained together by the -cooperative gamma server -.RB ( coopgammad (1) -or -.BR mds-coopgamma (1)) -and the result is applied. A third advantage is that you -can choose when the filter shall be removed, this can -either be not until it is explicitly requested, or until -the client that add (or lasted modified) the filter -disconnects from the server or when explicitly requested, -whichever comes first. -.P -.B libcoopgamma -prints warnings and errors, that cannot be returned, -to stderr. It is preferred that you have a non-static -.I "char *" -with the name -.I argv0 -where the name of the process -.RI ( argv[0] ) -is stored. -.SH "RATIONALE" -One program cannot do everything and still be user friendly. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR coopgammad (1), -.BR gc-tools (7), -.BR libclut (7) diff --git a/doc/man/libcoopgamma.h.0 b/doc/man/libcoopgamma.h.0 deleted file mode 100644 index 73a0b8a..0000000 --- a/doc/man/libcoopgamma.h.0 +++ /dev/null @@ -1,479 +0,0 @@ -.TH LIBCOOPGAMMA.H 0 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma.h - Cooperative gamma library header -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> -.fi -.SH "DESCRIPTION" -The -.B <libcoopgamma.h> -header includes the -.BR <limits.h> , -.BR <stddef.h> , -and -.BR <stdint.h> -headers. -.P -The -.B <libcoopgamma.h> -header defines the macros which expands to integer -constant expressions with distinct values: -.TP -.BR LIBCOOPGAMMA_SUCCESS " = 0" -Unmarshal was successful. -.TP -.BR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " > 0" -Unmarshal failed. The marshalled data was created -with a older version of libcoopgamma that does not -marshall the data in a compatible way. -.TP -.BR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " > 0" -Unmarshal failed. The marshalled data was created with -a newer version libcoopgamma that does not marshall -the data in a compatible way. -.TP -.BR LIBCOOPGAMMA_ERRNO_SET " < 0 (-1)" -Unmarshal failed because of an error, -.I errno -has been set appropriately. -.P -The -.B <libcoopgamma.h> -header defines -.I "enum libcoopgamma_support" -with the alias -.I libcoopgamma_support_t -and the following distinct values: -.TP -.BR LIBCOOPGAMMA_NO " = 0" -Gamma adjustments are not supported. -.TP -.BR LIBCOOPGAMMA_MAYBE " = 1" -Don't know whether gamma adjustments are supported. -.TP -.BR LIBCOOPGAMMA_YES " = 2" -Gamma adjustments are supported. -.P -The -.B <libcoopgamma.h> -header defines -.I "enum libcoopgamma_depth" -with the alias -.I libcoopgamma_depth_t -and the following distinct values: -.TP -.BR LIBCOOPGAMMA_UINT8 " = 8" -Gamma ramps with -.I uint8_t -as the stop-type are used -.RI ( libcoopgamma_ramps8_t ). -.TP -.BR LIBCOOPGAMMA_UINT16 " = 16" -Gamma ramps with -.I uint16_t -as the stop-type are used -.RI ( libcoopgamma_ramps16_t ). -.TP -.BR LIBCOOPGAMMA_UINT32 " = 32" -Gamma ramps with -.I uint32_t -as the stop-type are used -.RI ( libcoopgamma_ramps32_t ). -.TP -.BR LIBCOOPGAMMA_UINT64 " = 64" -Gamma ramps with -.I uint64_t -as the stop-type are used -.RI ( libcoopgamma_ramps64_t ). -.TP -.BR LIBCOOPGAMMA_FLOAT " < 0" -Gamma ramps with -.I float -as the stop-type are used -.RI ( libcoopgamma_rampsf_t ). -.TP -.BR LIBCOOPGAMMA_DOUBLE " < 0" -Gamma ramps with -.I double -as the stop-type are used -.RI ( libcoopgamma_rampsd_t ). -.P -The -.B <libcoopgamma.h> -header defines -.I "enum libcoopgamma_lifespan" -with the alias -.I libcoopgamma_lifespan_t -and the following distinct values: -.TP -.BR LIBCOOPGAMMA_REMOVE " = 0" -Remove the filter now. -.TP -.BR LIBCOOPGAMMA_UNTIL_DEATH " > 0" -Remove the filter when disconnecting from the coopgamma -server, or even explicitly removed, whichever comes first. -.TP -.BR LIBCOOPGAMMA_UNTIL_REMOVAL " > 0" -Only remove the filter when it is explicitly requested. -.P -The -.B <libcoopgamma.h> -header defines -.I "enum libcoopgamma_colourspace" -with the alias -.I libcoopgamma_colourspace_t -and the following distinct values: -.TP -.BR LIBCOOPGAMMA_UNKNOWN " = 0" -The monitor's colourspace is unknown. -.TP -.BR LIBCOOPGAMMA_SRGB " > 0" -The monitor uses sRGB as its colourspace. -.TP -.BR LIBCOOPGAMMA_RGB " > 0" -The monitor uses an RGB colourspace other than sRGB. -.TP -.BR LIBCOOPGAMMA_NON_RGB " > 0" -The monitor uses a non-RGB multicolour colourspace. -.TP -.BR LIBCOOPGAMMA_GREY " > 0" -The monitor uses a singlecolour scale colourspace, -possibility greyscale, or is monochrome. -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_ramps8" -.RI ( libcoopgamma_ramps8_t ), -.I "struct libcoopgamma_ramps16" -.RI ( libcoopgamma_ramps16_t ), -.I "struct libcoopgamma_ramps32" -.RI ( libcoopgamma_ramps32_t ), -.I "struct libcoopgamma_ramps64" -.RI ( libcoopgamma_ramps64_t ), -.I "struct libcoopgamma_rampsf" -.RI ( libcoopgamma_rampsf_t ), -.I "struct libcoopgamma_rampsd" -.RI ( libcoopgamma_rampsd_t ), -with the following members, -where -.I type -is -.IR uint8_t , -.IR uint16_t , -.IR uint32_t , -.IR uint64_t , -.IR float , -and -.I double -for the respective structures: -.TP -.B "size_t red_size" - The number of stops in the red ramp. -.TP -.B "size_t green_size" -The number of stops in the green ramp. -.TP -.B "size_t blue_size" -The number of stops in the blue ramp. -.TP -.IB type " *red" -The red ramp. -.TP -.IB type " *green" -The green ramp. -.TP -.IB type " *blue" -The blue ramp. -.P -The -.B <libcoopgamma.h> -header defines -.I "union libcoopgamma_ramps" -with alias -.I libcoopgamma_ramps_t -and the follow members: -.TP -.B "libcoopgamma_ramps8_t u8" -.TP -.B "libcoopgamma_ramps16_t u16" -.TP -.B "libcoopgamma_ramps32_t u32" -.TP -.B "libcoopgamma_ramps64_t u64" -.TP -.B "libcoopgamma_rampsf_t f" -.TP -.B "libcoopgamma_rampsd_t d" -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_filter" -with alias -.I libcoopgamma_filter_t -and the follow members: -.TP -.B "int64_t priority" -The priority of the filter, higher priority is applied first. -The gamma correction should have priority 0. -.TP -.B "char *crtc" -The CRTC for which this filter shall be applied. -.TP -.B "char *class" -Identifier for the filter. The syntax must be -\(aq\fI${PACKAGE_NAME}\fP\fB::\fP\fI${COMMAND_NAME}\fP\fB::\fP\fI${RULE}\fP\(aq. -.TP -.B "enum libcoopgamma_lifespan lifespan" -When shall the filter be removed? -If this member's value is -.IR LIBCOOPGAMMA_REMOVE , -only -.I .crtc -and -.I .class -need also be defined. -.TP -.B "enum libcoopgamma_depth depth" -The data type and bit-depth of the ramp stops. -.TP -.B "union libcoopgamma_ramps ramps" -The gamma ramp adjustments of the filter. -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_crtc_info" -with alias -.I libcoopgamma_crtc_info_t -and the follow members: -.TP -.B "int cooperative" -Is cooperative gamma server running? -.TP -.B "enum libcoopgamma_depth depth" -The data type and bit-depth of the ramp stops. -.TP -.B "enum libcoopgamma_support supported" -Is gamma adjustments supported on the CRTC? -If not, -.IR .depth , -.IR .red_size , -.IR .green_size , -and -.I .blue_size -are undefined. -.TP -.B "size_t red_size" - The number of stops in the red ramp. -.TP -.B "size_t green_size" -The number of stops in the green ramp. -.TP -.B "size_t blue_size" -The number of stops in the blue ramp. -.TP -.B "enum libcoopgamma_colourspace colourspace" -The monitor's colurspace. -.TP -.B "int have_gamut" -Is the gamut of the monitor known? -If, and only if, so, -.IR .red_x , -.IR .red_y , -.IR .green_x , -.IR .green_y , -.IR .blue_x , -.IR .blue_y , -.IR .white_x , -and -.IR .white_y -are set. Unless the monitor uses an -RGB colourspace, this value should -be false, but there is no guarantee -of this, you have to check that the -colourspace is an RGB colourspace. -.TP -.B "unsigned red_x" -The x-value (CIE xyY) of the monitor's -red colour, multiplied by 1024. -.TP -.B "unsigned red_y" -The y-value (CIE xyY) of the monitor's -red colour, multiplied by 1024. -.TP -.B "unsigned green_x" -The x-value (CIE xyY) of the monitor's -green colour, multiplied by 1024. -.TP -.B "unsigned green_y" -The y-value (CIE xyY) of the monitor's -green colour, multiplied by 1024. -.TP -.B "unsigned blue_x" -The x-value (CIE xyY) of the monitor's -blue colour, multiplied by 1024. -.TP -.B "unsigned blue_y" -The y-value (CIE xyY) of the monitor's -blue colour, multiplied by 1024. -.TP -.B "unsigned white_x" -The x-value (CIE xyY) of the monitor's -default white point, multiplied by 1024. -.TP -.B "unsigned white_y" -The y-value (CIE xyY) of the monitor's -default white point, multiplied by 1024. -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_filter_query" -with alias -.I libcoopgamma_filter_query_t -and the follow members: -.TP -.B "int64_t high_priority" -Do no return filters with higher priority than this value. -.TP -.B "int64_t low_priority" -Do no return filters with lower priority than this value. -.TP -.B "char *crtc" -The CRTC for which the the current filters shall returned -.TP -.B "int coalesce" -Shall all selected filters be coalesced into one gamma ramp triplet? -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_queried_filter" -with alias -.I libcoopgamma_queried_filter_t -and the follow members: -.TP -.B "int64_t priority" -The filter's priority. -.TP -.B "char *class" -The filter's class. -.TP -.B "union libcoopgamma_ramps ramps" -The gamma ramp adjustments of the filter -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_filter_table" -with alias -.I libcoopgamma_filter_table_t -and the follow members: -.TP -.B "size_t red_size" -The number of stops in the red ramp. -.TP -.B "size_t green_size" -The number of stops in the green ramp. -.TP -.B "size_t blue_size" -The number of stops in the blue ramp. -.TP -.B "size_t filter_count" -The number of filters. -.TP -.B "struct libcoopgamma_queried_filter_t *filters" -The filters, should be ordered by priority -in descending order (applied first goes first, -applied last goes last), lest there is something -wrong with the coopgamma server. - -If filter coalition was requested, there will -be exactly one filter -.I "(.filter_count == 1)" -and -.I ".filters->class == NULL" -and -.I ".filters->priority" -is undefined. -.TP -.B "enum libcoopgamma_depth depth" -The data type and bit-depth of the ramp stops. -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_error" -with alias -.I libcoopgamma_error_t -and the follow members: -.TP -.B "uint64_t number" -Error code. - -If -.I ".custom" -is false, 0 indicates success, -otherwise, 0 indicates that no -error code has been assigned. -.TP -.B "int custom" -Is this a custom error? -.TP -.B "int server_side" -Did the error occur on the server-side? -.TP -.B "char *description" -Error message, can be, and usually is, -.I NULL -if -.I ".custom" -is false. -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_context" -with alias -.I libcoopgamma_context_t -and the follow members and a lot -if internal unlisted members: -.TP -.B "struct libcoopgamma_error error" -The error of the last failed function call -to function that documents that this member -will be set on failure. - -This member is undefined after successful -function call. -.TP -.B "int fd" -File descriptor for the socket that connects -the client to the server. -.P -The -.B <libcoopgamma.h> -header defines -.I "struct libcoopgamma_async_context" -with alias -.I libcoopgamma_async_context_t. -This structure has only internal members. -.SH "SEE ALSO" -.BR libcoopgamma (7), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3), -.BR libcoopgamma_get_methods (3), -.BR libcoopgamma_get_method_and_site (3), -.BR libcoopgamma_get_pid_file (3), -.BR libcoopgamma_get_socket_file (3), -.BR libcoopgamma_connect (3) diff --git a/doc/man/libcoopgamma_async_context_destroy.3 b/doc/man/libcoopgamma_async_context_destroy.3 deleted file mode 100644 index 154ad77..0000000 --- a/doc/man/libcoopgamma_async_context_destroy.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH LIBCOOPGAMMA_ASYNC_CONTEXT_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_async_context_destroy - Deinitialise a libcoopgamma_async_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_async_context_destroy(libcoopgamma_async_context_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_async_context_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.SH "SEE ALSO" -.BR libcoopgamma_async_context_initialise (3), -.BR libcoopgamma_async_context_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_context_destroy (3) diff --git a/doc/man/libcoopgamma_async_context_initialise.3 b/doc/man/libcoopgamma_async_context_initialise.3 deleted file mode 100644 index 24cf859..0000000 --- a/doc/man/libcoopgamma_async_context_initialise.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH LIBCOOPGAMMA_ASYNC_CONTEXT_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_async_context_initialise - Initialise a libcoopgamma_async_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_async_context_initialise(libcoopgamma_async_context_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_async_context_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_async_context_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_async_context_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_async_context_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_async_context_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3) diff --git a/doc/man/libcoopgamma_async_context_marshal.3 b/doc/man/libcoopgamma_async_context_marshal.3 deleted file mode 100644 index e7197b8..0000000 --- a/doc/man/libcoopgamma_async_context_marshal.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH LIBCOOPGAMMA_ASYNC_CONTEXT_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_async_context_marshal - Marshal a libcoopgamma_async_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_async_context_marshal(libcoopgamma_async_context_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_async_context_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.SH "RETURN VALUES" -The -.BR libcoopgamma_async_context_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_async_context_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_context_marshal (3) diff --git a/doc/man/libcoopgamma_async_context_unmarshal.3 b/doc/man/libcoopgamma_async_context_unmarshal.3 deleted file mode 100644 index 5930980..0000000 --- a/doc/man/libcoopgamma_async_context_unmarshal.3 +++ /dev/null @@ -1,83 +0,0 @@ -.TH LIBCOOPGAMMA_ASYNC_CONTEXT_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_async_context_unmarshal - Unmarshal a libcoopgamma_async_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_async_context_unmarshal(libcoopgamma_async_context_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_async_context_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_async_context_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_async_context_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_async_context_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -No error is specified for the -.BR libcoopgamma_async_context_marshal () -function. -.SH "SEE ALSO" -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_async_context_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_connect.3 b/doc/man/libcoopgamma_connect.3 deleted file mode 100644 index 594d43f..0000000 --- a/doc/man/libcoopgamma_connect.3 +++ /dev/null @@ -1,78 +0,0 @@ -.TH LIBCOOPGAMMA_CONNECT 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_connect - Connect to a coopgamma server -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_connect(const char *restrict \fImethod\fP, const char *restrict \fIsite\fP, - libcoopgamma_context_t *restrict \fIctx\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_connect () -function connects to the instance coopgamma server -for the selected adjustment -.I method -and -.IR site . -If the server is not already running, it will be started. If -.I method -or -.I site -is -.IR NULL , -the it will selected automatically. -The state of the connection is stored in -.IR ctx , -which must be initialised but not already connected. -.I ctx -can be initialised with -.BR libcoopgamma_context_initialise (3). -.P -For the duration of the function call, -.I SIGCHLD -most neither be ignored nor blocked. It is the -user of this library's responsibility to ensure -this. The -.BR libcoopgamma_connect () -function will not temporarily reset handling of -.I SIGCHLD -itself. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_connect () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_connect () -function may fail for any reason specified for -.BR libcoopgamma_get_socket_file (3), -.BR socket (3), -.BR waitpid (3), -and -.BR connect (3). -The function may also fail for any of the -following reasons: -.TP -.B ENAMETOOLONG -The pathname of the socket was too long. -.TP -.B 0 -The server failed to initialise. -.SH "SEE ALSO" -.BR libcoopgamma_get_methods (3), -.BR libcoopgamma_get_pid_file (3), -.BR libcoopgamma_get_socket_file (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_set_gamma_send (3) diff --git a/doc/man/libcoopgamma_context_destroy.3 b/doc/man/libcoopgamma_context_destroy.3 deleted file mode 100644 index 0d144a8..0000000 --- a/doc/man/libcoopgamma_context_destroy.3 +++ /dev/null @@ -1,38 +0,0 @@ -.TH LIBCOOPGAMMA_CONTEXT_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_context_destroy - Deinitialise a libcoopgamma_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_context_destroy(libcoopgamma_context_t *restrict \fIthis\fP, int \fIdisconnect\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_context_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.P -If and only if -.I disconnect -is a nonzero value, the function will -disconnect from the coopgamma server. -.SH "SEE ALSO" -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_context_initialise.3 b/doc/man/libcoopgamma_context_initialise.3 deleted file mode 100644 index 367c0a9..0000000 --- a/doc/man/libcoopgamma_context_initialise.3 +++ /dev/null @@ -1,45 +0,0 @@ -.TH LIBCOOPGAMMA_CONTEXT_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_context_initialise - Initialise a libcoopgamma_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_context_initialise(libcoopgamma_context_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_context_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_context_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_context_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_context_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_async_context_initialise (3), -.BR libcoopgamma_connect (3) diff --git a/doc/man/libcoopgamma_context_marshal.3 b/doc/man/libcoopgamma_context_marshal.3 deleted file mode 100644 index aa7feea..0000000 --- a/doc/man/libcoopgamma_context_marshal.3 +++ /dev/null @@ -1,52 +0,0 @@ -.TH LIBCOOPGAMMA_CONTEXT_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_context_marshal - Marshal a libcoopgamma_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_context_marshal(libcoopgamma_context_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_context_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -However, it is probably nonsensical to send the -marshalled data to any other process than the -process itself since it contains a file descriptor. -.SH "RETURN VALUES" -The -.BR libcoopgamma_context_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_context_unmarshal.3 b/doc/man/libcoopgamma_context_unmarshal.3 deleted file mode 100644 index f805163..0000000 --- a/doc/man/libcoopgamma_context_unmarshal.3 +++ /dev/null @@ -1,86 +0,0 @@ -.TH LIBCOOPGAMMA_CONTEXT_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_context_unmarshal - Unmarshal a libcoopgamma_context_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_context_unmarshal(libcoopgamma_context_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_context_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_context_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_context_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_context_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -The -.BR libcoopgamma_context_marshal () -function may fail, and returned -.I LIBCOOPGAMMA_ERRNO_SET -for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_crtc_info_destroy.3 b/doc/man/libcoopgamma_crtc_info_destroy.3 deleted file mode 100644 index c67e81c..0000000 --- a/doc/man/libcoopgamma_crtc_info_destroy.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH LIBCOOPGAMMA_CRTC_INFO_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_crtc_info_destroy - Deinitialise a libcoopgamma_crtc_info_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_crtc_info_destroy(libcoopgamma_crtc_info_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_crtc_info_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.SH "SEE ALSO" -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_crtc_info_initialise.3 b/doc/man/libcoopgamma_crtc_info_initialise.3 deleted file mode 100644 index 84f167d..0000000 --- a/doc/man/libcoopgamma_crtc_info_initialise.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH LIBCOOPGAMMA_CRTC_INFO_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_crtc_info_initialise - Initialise a libcoopgamma_crtc_info_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_crtc_info_initialise(libcoopgamma_crtc_info_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_crtc_info_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_crtc_info_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_crtc_info_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_crtc_info_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3) diff --git a/doc/man/libcoopgamma_crtc_info_marshal.3 b/doc/man/libcoopgamma_crtc_info_marshal.3 deleted file mode 100644 index 2a8b294..0000000 --- a/doc/man/libcoopgamma_crtc_info_marshal.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH LIBCOOPGAMMA_CRTC_INFO_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_crtc_info_marshal - Marshal a libcoopgamma_crtc_info_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_crtc_info_marshal(libcoopgamma_crtc_info_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_crtc_info_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.SH "RETURN VALUES" -The -.BR libcoopgamma_crtc_info_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_crtc_info_unmarshal.3 b/doc/man/libcoopgamma_crtc_info_unmarshal.3 deleted file mode 100644 index 964b3b0..0000000 --- a/doc/man/libcoopgamma_crtc_info_unmarshal.3 +++ /dev/null @@ -1,83 +0,0 @@ -.TH LIBCOOPGAMMA_CRTC_INFO_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_crtc_info_unmarshal - Unmarshal a libcoopgamma_crtc_info_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_crtc_info_unmarshal(libcoopgamma_crtc_info_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_crtc_info_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_crtc_info_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_crtc_info_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_crtc_info_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -No error is specified for the -.BR libcoopgamma_crtc_info_marshal () -function. -.SH "SEE ALSO" -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_error_destroy.3 b/doc/man/libcoopgamma_error_destroy.3 deleted file mode 100644 index 978d0ad..0000000 --- a/doc/man/libcoopgamma_error_destroy.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH LIBCOOPGAMMA_ERROR_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_error_destroy - Deinitialise a libcoopgamma_error_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_error_destroy(libcoopgamma_error_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_error_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.SH "SEE ALSO" -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_error_initialise.3 b/doc/man/libcoopgamma_error_initialise.3 deleted file mode 100644 index fba20cf..0000000 --- a/doc/man/libcoopgamma_error_initialise.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH LIBCOOPGAMMA_ERROR_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_error_initialise - Initialise a libcoopgamma_error_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_error_initialise(libcoopgamma_error_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_error_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_error_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_error_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_error_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3) diff --git a/doc/man/libcoopgamma_error_marshal.3 b/doc/man/libcoopgamma_error_marshal.3 deleted file mode 100644 index f168a1c..0000000 --- a/doc/man/libcoopgamma_error_marshal.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH LIBCOOPGAMMA_ERROR_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_error_marshal - Marshal a libcoopgamma_error_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_error_marshal(libcoopgamma_error_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_error_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.SH "RETURN VALUES" -The -.BR libcoopgamma_error_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_error_unmarshal.3 b/doc/man/libcoopgamma_error_unmarshal.3 deleted file mode 100644 index b780cb2..0000000 --- a/doc/man/libcoopgamma_error_unmarshal.3 +++ /dev/null @@ -1,86 +0,0 @@ -.TH LIBCOOPGAMMA_ERROR_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_error_unmarshal - Unmarshal a libcoopgamma_error_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_error_unmarshal(libcoopgamma_error_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_error_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_error_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_error_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_error_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -The -.BR libcoopgamma_error_marshal () -function may fail, and returned -.I LIBCOOPGAMMA_ERRNO_SET -for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_filter_destroy.3 b/doc/man/libcoopgamma_filter_destroy.3 deleted file mode 100644 index e246da3..0000000 --- a/doc/man/libcoopgamma_filter_destroy.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_destroy - Deinitialise a libcoopgamma_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_filter_destroy(libcoopgamma_filter_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.SH "SEE ALSO" -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_filter_initialise.3 b/doc/man/libcoopgamma_filter_initialise.3 deleted file mode 100644 index d2889b4..0000000 --- a/doc/man/libcoopgamma_filter_initialise.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_initialise - Initialise a libcoopgamma_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_filter_initialise(libcoopgamma_filter_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_filter_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_filter_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_filter_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3) diff --git a/doc/man/libcoopgamma_filter_marshal.3 b/doc/man/libcoopgamma_filter_marshal.3 deleted file mode 100644 index 982802d..0000000 --- a/doc/man/libcoopgamma_filter_marshal.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_marshal - Marshal a libcoopgamma_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_filter_marshal(libcoopgamma_filter_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.SH "RETURN VALUES" -The -.BR libcoopgamma_filter_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_filter_query_destroy.3 b/doc/man/libcoopgamma_filter_query_destroy.3 deleted file mode 100644 index 83e5561..0000000 --- a/doc/man/libcoopgamma_filter_query_destroy.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_QUERY_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_query_destroy - Deinitialise a libcoopgamma_filter_query_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_filter_query_destroy(libcoopgamma_filter_query_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_query_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.SH "SEE ALSO" -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_filter_query_initialise.3 b/doc/man/libcoopgamma_filter_query_initialise.3 deleted file mode 100644 index e2a8903..0000000 --- a/doc/man/libcoopgamma_filter_query_initialise.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_QUERY_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_query_initialise - Initialise a libcoopgamma_filter_query_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_filter_query_initialise(libcoopgamma_filter_query_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_query_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_filter_query_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_filter_query_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_filter_query_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3) diff --git a/doc/man/libcoopgamma_filter_query_marshal.3 b/doc/man/libcoopgamma_filter_query_marshal.3 deleted file mode 100644 index 83d560d..0000000 --- a/doc/man/libcoopgamma_filter_query_marshal.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_QUERY_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_query_marshal - Marshal a libcoopgamma_filter_query_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_filter_query_marshal(libcoopgamma_filter_query_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_query_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.SH "RETURN VALUES" -The -.BR libcoopgamma_filter_query_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_filter_query_unmarshal.3 b/doc/man/libcoopgamma_filter_query_unmarshal.3 deleted file mode 100644 index 8adc09a..0000000 --- a/doc/man/libcoopgamma_filter_query_unmarshal.3 +++ /dev/null @@ -1,86 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_QUERY_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_query_unmarshal - Unmarshal a libcoopgamma_filter_query_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_filter_query_unmarshal(libcoopgamma_filter_query_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_query_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_filter_query_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_filter_query_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_filter_query_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -The -.BR libcoopgamma_filter_query_marshal () -function may fail, and returned -.I LIBCOOPGAMMA_ERRNO_SET -for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_filter_table_destroy.3 b/doc/man/libcoopgamma_filter_table_destroy.3 deleted file mode 100644 index 9fa4d61..0000000 --- a/doc/man/libcoopgamma_filter_table_destroy.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_TABLE_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_table_destroy - Deinitialise a libcoopgamma_filter_table_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_filter_table_destroy(libcoopgamma_filter_table_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_table_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.SH "SEE ALSO" -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_filter_table_initialise.3 b/doc/man/libcoopgamma_filter_table_initialise.3 deleted file mode 100644 index 79ee8cf..0000000 --- a/doc/man/libcoopgamma_filter_table_initialise.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_TABLE_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_table_initialise - Initialise a libcoopgamma_filter_table_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_filter_table_initialise(libcoopgamma_filter_table_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_table_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_filter_table_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_filter_table_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_filter_table_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3) diff --git a/doc/man/libcoopgamma_filter_table_marshal.3 b/doc/man/libcoopgamma_filter_table_marshal.3 deleted file mode 100644 index bc17c8a..0000000 --- a/doc/man/libcoopgamma_filter_table_marshal.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_TABLE_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_table_marshal - Marshal a libcoopgamma_filter_table_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_filter_table_marshal(libcoopgamma_filter_table_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_table_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.SH "RETURN VALUES" -The -.BR libcoopgamma_filter_table_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_filter_table_unmarshal.3 b/doc/man/libcoopgamma_filter_table_unmarshal.3 deleted file mode 100644 index 3dd5cd2..0000000 --- a/doc/man/libcoopgamma_filter_table_unmarshal.3 +++ /dev/null @@ -1,86 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_TABLE_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_table_unmarshal - Unmarshal a libcoopgamma_filter_table_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_filter_table_unmarshal(libcoopgamma_filter_table_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_table_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_filter_table_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_filter_table_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_filter_table_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -The -.BR libcoopgamma_filter_table_marshal () -function may fail, and returned -.I LIBCOOPGAMMA_ERRNO_SET -for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_filter_unmarshal.3 b/doc/man/libcoopgamma_filter_unmarshal.3 deleted file mode 100644 index d9f1ee8..0000000 --- a/doc/man/libcoopgamma_filter_unmarshal.3 +++ /dev/null @@ -1,86 +0,0 @@ -.TH LIBCOOPGAMMA_FILTER_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_filter_unmarshal - Unmarshal a libcoopgamma_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_filter_unmarshal(libcoopgamma_filter_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_filter_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_filter_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_filter_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_filter_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -The -.BR libcoopgamma_filter_marshal () -function may fail, and returned -.I LIBCOOPGAMMA_ERRNO_SET -for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_flush.3 b/doc/man/libcoopgamma_flush.3 deleted file mode 100644 index 8ffaae2..0000000 --- a/doc/man/libcoopgamma_flush.3 +++ /dev/null @@ -1,58 +0,0 @@ -.TH LIBCOOPGAMMA_FLUSH 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_flush - Send all pending outbound data -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_flush(libcoopgamma_context_t *restrict \fIctx\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_flush () -function sends all data on -.I ctx -that have not yet been sent because of -interruption or similar. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_flush () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_flush () -function may fail for any reason specified for -.BR send (3). -Particularly interesting exceptional -conditions, that are not errors proper, include -those indicated by the following values on -.IR errno : -.TP -.B EINTR -The function was interrupted by a signal. When -this happens, just resume be calling the functon -again. -.TP -.BR EAGAIN " or " EWOULDBLOCK -The communication is nonblocking and the buffer -between the server and the client is full, -and no more data can be queued without blocking. -When this happens, wait a short period of time -and call the function again to resume. -.BR select (3) -or similar function can be used to wait until -.I ctx->fd -is writable. -.SH "SEE ALSO" -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_connect (3), -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_set_gamma_send (3) diff --git a/doc/man/libcoopgamma_get_crtcs_recv.3 b/doc/man/libcoopgamma_get_crtcs_recv.3 deleted file mode 100644 index 02f8daa..0000000 --- a/doc/man/libcoopgamma_get_crtcs_recv.3 +++ /dev/null @@ -1,63 +0,0 @@ -.TH LIBCOOPGAMMA_GET_CRTCS_RECV 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_crtcs_recv - Receive a list of all available CRTC:s -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -char **libcoopgamma_get_crtcs_recv(libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_crtcs_recv () -function parses the response for the requests -sent using the -.BR libcoopgamma_get_crtcs_send () -function with the same -.I ctx -and -.I async -arguments. The -.I async -must have been selected by the last call to the -.BR libcoopgamma_synchronise (3) -function. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_crtcs_recv () -function returns a -.I NULL -terminated -list of all available CRTC:s. If possible, -the CRTC:s are named by the connected -monitors' EDID:s. None of the elements can -contain a NUL or LF byte. The elements in -the list are subpointers of the returned -pointer. The user shall free the returned -pointer, which effectively frees all its -elements. On error, -.I NULL -is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_crtcs_recv () -function may fail for any reason specified for -.BR malloc (3). -The function may also fail for the following reasons: -.TP -.B EBADMSG -The received message was corrupt. -.SH "SEE ALSO" -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_crtcs_sync (3), -.BR libcoopgamma_get_gamma_info_recv (3), -.BR libcoopgamma_get_gamma_recv (3), -.BR libcoopgamma_set_gamma_recv (3) diff --git a/doc/man/libcoopgamma_get_crtcs_send.3 b/doc/man/libcoopgamma_get_crtcs_send.3 deleted file mode 100644 index 6afeed0..0000000 --- a/doc/man/libcoopgamma_get_crtcs_send.3 +++ /dev/null @@ -1,77 +0,0 @@ -.TH LIBCOOPGAMMA_GET_CRTCS_SEND 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_crtcs_send - Send a request for an enumeration of all available CRTC:s -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_crtcs_send(libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_crtcs_send () -function sends a request over the connection of -.I ctx -to the server for an enumeration of all available -CRTC:s (roughly, display devices). Information -about the request is stored in -.IR *async , -this information is used by -.BR libcoopgamma_synchronise (3) -to identify the response, and by -.BR libcoopgamma_get_crtcs_recv (3) -to parse the response. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_crtcs_send () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_crtcs_send () -function may fail for any reason specified for -.BR malloc (3), -.BR realloc (3), -or -.BR libcoopgamma_flush (3). -Particularly interesting exceptional -conditions, that are not errors proper, include -those indicated by the following values on -.IR errno : -.TP -.B EINTR -The function was interrupted by a signal. When -this happens, call -.BR libcoopgamma_flush (3) -to resume. -.TP -.BR EAGAIN " or " EWOULDBLOCK -The communication is nonblocking and the buffer -between the server and the client is full, -and no more data can be queued without blocking. -When this happens, wait a short period of time -and call -.BR libcoopgamma_flush (3) -to resume. -.BR select (3) -or similar function can be used to wait until -.I ctx->fd -is readable. -.TP -.B ECONNREST -The connection to the server has closed. -.SH "SEE ALSO" -.BR libcoopgamma_async_context_initialise (3), -.BR libcoopgamma_flush (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_get_crtcs_recv (3), -.BR libcoopgamma_get_crtcs_sync (3), -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_set_gamma_send (3) diff --git a/doc/man/libcoopgamma_get_crtcs_sync.3 b/doc/man/libcoopgamma_get_crtcs_sync.3 deleted file mode 100644 index 3a3eebf..0000000 --- a/doc/man/libcoopgamma_get_crtcs_sync.3 +++ /dev/null @@ -1,53 +0,0 @@ -.TH LIBCOOPGAMMA_GET_CRTCS_SYNC 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_crtcs_sync - Synchronously retrieve a list of all available CRTC:s -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -char **libcoopgamma_get_crtcs_sync(libcoopgamma_context_t *restrict \fIctx\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_crtcs_sync () -function synchronously retrieves a -list of all available CRTC:s over the -connection of -.I ctx -to the server. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_crtcs_sync () -function returns a -.I NULL -terminated -list of all available CRTC:s. If possible, -the CRTC:s are named by the connected -monitors' EDID:s. None of the elements can -contain a NUL or LF byte. The elements in -the list are subpointers of the returned -pointer. The user shall free the returned -pointer, which effectively frees all its -elements. On error, -.I NULL -is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_crtcs_send () -function may fail for any reason specified for -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_crtcs_recv (3), -.BR libcoopgamma_flush (3), -or -.BR libcoopgamma_synchronise (3). -.SH "SEE ALSO" -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_crtcs_recv (3), -.BR libcoopgamma_get_gamma_info_sync (3), -.BR libcoopgamma_get_gamma_sync (3), -.BR libcoopgamma_set_gamma_sync (3) diff --git a/doc/man/libcoopgamma_get_gamma_info_recv.3 b/doc/man/libcoopgamma_get_gamma_info_recv.3 deleted file mode 100644 index 1307fe5..0000000 --- a/doc/man/libcoopgamma_get_gamma_info_recv.3 +++ /dev/null @@ -1,150 +0,0 @@ -.TH LIBCOOPGAMMA_GET_GAMMA_INFO_RECV 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_gamma_info_recv - Receive metainformation about a CRTC's gamma ramps -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_gamma_info_recv(libcoopgamma_crtc_info_t *restrict \fIinfo\fP, - libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_gamma_info_recv () -function parses the response for the requests -sent using the -.BR libcoopgamma_get_gamma_info_send () -function with the same -.I ctx -and -.I async -arguments. The -.I async -must have been selected by the last call to the -.BR libcoopgamma_synchronise (3) -function. -.P -The information about the CRTC's gamma ramps -will be stored in -.IR *info . -In particular, -.I info->cooperative -will be set to nonzero (actually 1) if there is -a coopgamma server running, -.I info->supported -will be set to -.IR LIBCOOPGAMMA_NO , -.IR LIBCOOPGAMMA_MAYBE , -or -.IR LIBCOOPGAMMA_YES , -which ever describes the state of gamma ramp -support on the CRTC. Unless -.I info->supported -is -.IR LIBCOOPGAMMA_NO , -the following will also be set: -.TP -.I info->red_size -The number of stops on the red gamma ramp. -.TP -.I info->green_size -The number of stops on the green gamma ramp. -.TP -.I info->blue_size -The number of stops on the blue gamma ramp. -.TP -.I info->depth -Describes the gamma ramp types used for the CRTC. -.P -The -.BR libcoopgamma_get_gamma_info_recv () -will also store monitor's colourspace information in -.IR *info . -In particular, -.I info->colourspace -will be set to -.IR LIBCOOPGAMMA_SRGB , -.IR LIBCOOPGAMMA_RGB , -.IR LIBCOOPGAMMA_NON_RGB , -.IR LIBCOOPGAMMA_GREY , -or -.IR LIBCOOPGAMMA_UNKNOWN , -and -.I info->have_gamut -will be set to 1 or 0. -.I info->have_gamut -should be set to 0 unless -.I info->colourspace -is set to -.I LIBCOOPGAMMA_SRGB -or -.IR LIBCOOPGAMMA_RGB , -and it should be set to 1 if -.I info->colourspace -is set to -.I LIBCOOPGAMMA_SRGB , -however there are no guarantees that -this is true. If -.I info->have_gamut -is non-zero, the following will also be set: -.TP -.I info->red_x -The x-value (CIE xyY) of the monitor's -red colour, multiplied by 1024. -.TP -.I info->red_y -The y-value (CIE xyY) of the monitor's -red colour, multiplied by 1024. -.TP -.I info->green_x -The x-value (CIE xyY) of the monitor's -green colour, multiplied by 1024. -.TP -.I info->green_y -The y-value (CIE xyY) of the monitor's -green colour, multiplied by 1024. -.TP -.I info->blue_x -The x-value (CIE xyY) of the monitor's -blue colour, multiplied by 1024. -.TP -.I info->blue_y -The y-value (CIE xyY) of the monitor's -blue colour, multiplied by 1024. -.TP -.I info->white_x -The x-value (CIE xyY) of the monitor's -default white point, multiplied by 1024. -.TP -.I info->white_y -The y-value (CIE xyY) of the monitor's -default white point, multiplied by 1024. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_gamma_info_recv () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_gamma_info_recv () -function may fail for any reason specified for -.BR malloc (3). -The function may also fail for the following reasons: -.TP -.B EBADMSG -The received message was corrupt. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_get_gamma_info_sync (3), -.BR libcoopgamma_get_crtcs_recv (3), -.BR libcoopgamma_get_gamma_recv (3), -.BR libcoopgamma_set_gamma_recv (3) diff --git a/doc/man/libcoopgamma_get_gamma_info_send.3 b/doc/man/libcoopgamma_get_gamma_info_send.3 deleted file mode 100644 index 16a312d..0000000 --- a/doc/man/libcoopgamma_get_gamma_info_send.3 +++ /dev/null @@ -1,79 +0,0 @@ -.TH LIBCOOPGAMMA_GET_GAMMA_INFO_SEND 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_gamma_info_send - Send a request for metainfomation for a CRTC's gamma ramps -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_gamma_info_send(const char *restrict \fIcrtc\fP, libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_gamma_info_send () -function sends a request over the connection of -.I ctx -to the server for metainformation about a the -CRTC, with the name given in the -.I crtc -parameter, gamma ramps. Information about the -request is stored in -.IR *async , -this information is used by -.BR libcoopgamma_synchronise (3) -to identify the response, and by -.BR libcoopgamma_get_gamma_info_recv (3) -to parse the response. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_gamma_info_send () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_gamma_info_send () -function may fail for any reason specified for -.BR malloc (3), -.BR realloc (3), -or -.BR libcoopgamma_flush (3). -Particularly interesting exceptional -conditions, that are not errors proper, include -those indicated by the following values on -.IR errno : -.TP -.B EINTR -The function was interrupted by a signal. When -this happens, call -.BR libcoopgamma_flush (3) -to resume. -.TP -.BR EAGAIN " or " EWOULDBLOCK -The communication is nonblocking and the buffer -between the server and the client is full, -and no more data can be queued without blocking. -When this happens, wait a short period of time -and call -.BR libcoopgamma_flush (3) -to resume. -.BR select (3) -or similar function can be used to wait until -.I ctx->fd -is readable. -.TP -.B ECONNREST -The connection to the server has closed. -.SH "SEE ALSO" -.BR libcoopgamma_async_context_initialise (3), -.BR libcoopgamma_flush (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_get_gamma_info_recv (3), -.BR libcoopgamma_get_gamma_info_sync (3), -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_set_gamma_send (3) diff --git a/doc/man/libcoopgamma_get_gamma_info_sync.3 b/doc/man/libcoopgamma_get_gamma_info_sync.3 deleted file mode 100644 index 3187231..0000000 --- a/doc/man/libcoopgamma_get_gamma_info_sync.3 +++ /dev/null @@ -1,142 +0,0 @@ -.TH LIBCOOPGAMMA_GET_GAMMA_INFO_SYNC 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_gamma_info_sync - Synchronously retrieve metainformation about a CRTC's gamma ramps -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_gamma_info_sync(const char* restrict \fIcrtc\fP, - libcoopgamma_crtc_info_t* restrict \fIinfo\fP, - libcoopgamma_context_t *restrict \fIctx\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_gamma_info_sync () -function synchronously retrieves metainformation -about the CRTC's, whose name is -.IR crtc , -gamma ramps over the connection of -.I ctx -to the server. -.P -The information about the CRTC's gamma ramps -will be stored in -.IR *info . -In particular, -.I info->cooperative -will be set to nonzero (actually 1) if there is -a coopgamma server running, -.I info->supported -will be set to -.IR LIBCOOPGAMMA_NO , -.IR LIBCOOPGAMMA_MAYBE , -or -.IR LIBCOOPGAMMA_YES , -which ever describes the state of gamma ramp -support on the CRTC. Unless -.I info->supported -is -.IR LIBCOOPGAMMA_NO , -the following will also be set: -.TP -.I info->red_size -The number of stops on the red gamma ramp. -.TP -.I info->green_size -The number of stops on the green gamma ramp. -.TP -.I info->blue_size -The number of stops on the blue gamma ramp. -.TP -.I info->depth -Describes the gamma ramp types used for the CRTC. -.P -The -.BR libcoopgamma_get_gamma_info_sync () -will also store monitor's colourspace information in -.IR *info . -In particular, -.I info->colourspace -will be set to -.IR LIBCOOPGAMMA_SRGB , -.IR LIBCOOPGAMMA_RGB , -.IR LIBCOOPGAMMA_NON_RGB , -.IR LIBCOOPGAMMA_GREY , -or -.IR LIBCOOPGAMMA_UNKNOWN , -and -.I info->have_gamut -will be set to 1 or 0. -.I info->have_gamut -should be set to 0 unless -.I info->colourspace -is set to -.I LIBCOOPGAMMA_SRGB -or -.IR LIBCOOPGAMMA_RGB , -and it should be set to 1 if -.I info->colourspace -is set to -.I LIBCOOPGAMMA_SRGB , -however there are no guarantees that -this is true. If -.I info->have_gamut -is non-zero, the following will also be set: -.TP -.I info->red_x -The x-value (CIE xyY) of the monitor's -red colour, multiplied by 1024. -.TP -.I info->red_y -The y-value (CIE xyY) of the monitor's -red colour, multiplied by 1024. -.TP -.I info->green_x -The x-value (CIE xyY) of the monitor's -green colour, multiplied by 1024. -.TP -.I info->green_y -The y-value (CIE xyY) of the monitor's -green colour, multiplied by 1024. -.TP -.I info->blue_x -The x-value (CIE xyY) of the monitor's -blue colour, multiplied by 1024. -.TP -.I info->blue_y -The y-value (CIE xyY) of the monitor's -blue colour, multiplied by 1024. -.TP -.I info->white_x -The x-value (CIE xyY) of the monitor's -default white point, multiplied by 1024. -.TP -.I info->white_y -The y-value (CIE xyY) of the monitor's -default white point, multiplied by 1024. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_gamma_info_recv () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_gamma_info_send () -function may fail for any reason specified for -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_get_gamma_info_recv (3), -.BR libcoopgamma_flush (3), -or -.BR libcoopgamma_synchronise (3). -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_get_gamma_info_recv (3), -.BR libcoopgamma_get_crtcs_sync (3), -.BR libcoopgamma_get_gamma_sync (3), -.BR libcoopgamma_set_gamma_sync (3) diff --git a/doc/man/libcoopgamma_get_gamma_recv.3 b/doc/man/libcoopgamma_get_gamma_recv.3 deleted file mode 100644 index 5697a86..0000000 --- a/doc/man/libcoopgamma_get_gamma_recv.3 +++ /dev/null @@ -1,98 +0,0 @@ -.TH LIBCOOPGAMMA_GET_GAMMA_RECV 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_gamma_recv - Receive the gamma filter table for a CRTC -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_gamma_recv(libcoopgamma_filter_table_t *restrict \fItable\fP, - libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_gamma_recv () -function parses the response for the requests -sent using the -.BR libcoopgamma_get_gamma_send () -function with the same -.I ctx -and -.I async -arguments. The -.I async -must have been selected by the last call to the -.BR libcoopgamma_synchronise (3) -function. -.P -The filters will be stored in -.IR *table . -In particular, the number of filter (1 if coalesced) -will be stored to -.IR table->filter_count , -the filters themselves will be stored in -.IR table->filters . -Some metainformation sent by the server will also -be stored in -.IR *table : -.TP -.I info->red_size -The number of stops on the red gamma ramp. -.TP -.I info->green_size -The number of stops on the green gamma ramp. -.TP -.I info->blue_size -The number of stops on the blue gamma ramp. -.TP -.I info->depth -Describes the gamma ramp types used for the CRTC. -.P -For all -.I i -from 0 up to but exclusing -.IR table->filter_count , -Information about the filter applied -.IR i :th -is stored in -.IR table->filters[i] . -.I table->filters[i].ramps -is the gamma ramps for -.I i :th -the filter. Unless coalesced, -.I table->filters[i].priority -and -.I table->filters[i].class -is also set. -.I table->filters[i].priority -is the prority of the filter, and -.I table->filters[i].class -is the class (identifier) of the filter. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_gamma_recv () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_gamma_recv () -function may fail for any reason specified for -.BR malloc (3). -The function may also fail for the following reasons: -.TP -.B EBADMSG -The received message was corrupt. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_get_gamma_sync (3), -.BR libcoopgamma_get_crtcs_recv (3), -.BR libcoopgamma_get_gamma_info_recv (3), -.BR libcoopgamma_set_gamma_recv (3) diff --git a/doc/man/libcoopgamma_get_gamma_send.3 b/doc/man/libcoopgamma_get_gamma_send.3 deleted file mode 100644 index ee202da..0000000 --- a/doc/man/libcoopgamma_get_gamma_send.3 +++ /dev/null @@ -1,93 +0,0 @@ -.TH LIBCOOPGAMMA_GET_GAMMA_SEND 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_gamma_send - Send a request to retrieve a CRTC's gamma ramp filters -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_gamma_send(const libcoopgamma_filter_query_t *restrict \fIquery\fP, - libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_gamma_send () -function sends a request over the connection of -.I ctx -to the server to retrieve the -CRTC's, with the name given in -.IR query->crtc , -applied filters. Information about the -request is stored in -.IR *async , -this information is used by -.BR libcoopgamma_synchronise (3) -to identify the response, and by -.BR libcoopgamma_get_gamma_recv (3) -to parse the response. -.P -The response will include all filter with a -priority between -.I query->low_priority -and -.IR query->high_priority, -inclusively. If and only if -.I query->coalesce -is nonzero, the, from the selected filters, -resulting gamma ramps are returned -rather than a list of all selected filters. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_gamma_send () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_gamma_send () -function may fail for any reason specified for -.BR malloc (3), -.BR realloc (3), -or -.BR libcoopgamma_flush (3). -Particularly interesting exceptional -conditions, that are not errors proper, include -those indicated by the following values on -.IR errno : -.TP -.B EINTR -The function was interrupted by a signal. When -this happens, call -.BR libcoopgamma_flush (3) -to resume. -.TP -.BR EAGAIN " or " EWOULDBLOCK -The communication is nonblocking and the buffer -between the server and the client is full, -and no more data can be queued without blocking. -When this happens, wait a short period of time -and call -.BR libcoopgamma_flush (3) -to resume. -.BR select (3) -or similar function can be used to wait until -.I ctx->fd -is readable. -.TP -.B ECONNREST -The connection to the server has closed. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_async_context_initialise (3), -.BR libcoopgamma_flush (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_get_gamma_recv (3), -.BR libcoopgamma_get_gamma_sync (3), -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_set_gamma_send (3) diff --git a/doc/man/libcoopgamma_get_gamma_sync.3 b/doc/man/libcoopgamma_get_gamma_sync.3 deleted file mode 100644 index e46cecf..0000000 --- a/doc/man/libcoopgamma_get_gamma_sync.3 +++ /dev/null @@ -1,102 +0,0 @@ -.TH LIBCOOPGAMMA_GET_GAMMA_SYNC 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_gamma_sync - Synchronously retrieve a CRTC's filter table -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_gamma_sync(const libcoopgamma_filter_query_t* restrict \fIquery\fP, - libcoopgamma_filter_table_t* restrict \fItable\fpP, - libcoopgamma_context_t *restrict \fIctx\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_get_gamma_sync () -function synchronously retrieves the gamma ramp filter -table for the CRTC, whose name is -.IR query->crtc , -over the connection of -.I ctx -to the server. -.P -The response will include all filter with a -priority between -.I query->low_priority -and -.IR query->high_priority, -inclusively. If and only if -.I query->coalesce -is nonzero, the, from the selected filters, -resulting gamma ramps are returned -rather than a list of all selected filters. -.P -The filters will be stored in -.IR *table . -In particular, the number of filter (1 if coalesced) -will be stored to -.IR table->filter_count , -the filters themselves will be stored in -.IR table->filters . -Some metainformation sent by the server will also -be stored in -.IR *table : -.TP -.I info->red_size -The number of stops on the red gamma ramp. -.TP -.I info->green_size -The number of stops on the green gamma ramp. -.TP -.I info->blue_size -The number of stops on the blue gamma ramp. -.TP -.I info->depth -Describes the gamma ramp types used for the CRTC. -.P -For all -.I i -from 0 up to but exclusing -.IR table->filter_count , -Information about the filter applied -.IR i :th -is stored in -.IR table->filters[i] . -.I table->filters[i].ramps -is the gamma ramps for -.I i :th -the filter. Unless coalesced, -.I table->filters[i].priority -and -.I table->filters[i].class -is also set. -.I table->filters[i].priority -is the prority of the filter, and -.I table->filters[i].class -is the class (identifier) of the filter. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_gamma_recv () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_gamma_send () -function may fail for any reason specified for -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_get_gamma_recv (3), -.BR libcoopgamma_flush (3), -or -.BR libcoopgamma_synchronise (3). -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_get_gamma_recv (3), -.BR libcoopgamma_get_crtcs_sync (3), -.BR libcoopgamma_get_gamma_info_sync (3), -.BR libcoopgamma_set_gamma_sync (3) diff --git a/doc/man/libcoopgamma_get_method_and_site.3 b/doc/man/libcoopgamma_get_method_and_site.3 deleted file mode 100644 index 654db03..0000000 --- a/doc/man/libcoopgamma_get_method_and_site.3 +++ /dev/null @@ -1,105 +0,0 @@ -.TH LIBCOOPGAMMA_GET_METHOD_AND_SITE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_method_and_site - Get the adjustment method and site -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_get_method_and_site(const char *restrict \fImethod\fP, const char *restrict \fIsite\fP, - char **restrict \fImethodp\fP, char **restrict \fIsitep\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -Newcomers need not concern themselves with the -.BR libcoopgamma_get_method_and_site () -function. -.P -The -.BR libcoopgamma_get_method_and_site () -function consults -.BR coopgammad (1) -to get the names the selected adjustment -.I method -and -.IR site . -If -.I method -or -.I site -is -.IR NULL , -the it will selected automatically. -.P -The name of selected adjustment method is -stored in -.I *methodp -unless -.I methodp -is -.IR NULL . -If the selected selected adjustment method does -not exist, the function fail unless the given -.I method -.P -The name of selected site is stored in -.I *sitep -unless -.I sitep -is -.IR NULL . -is a positive number. -.P -The user should free -.I *methodp -and -.IR *sitep . -.P -For the duration of the function call, -.I SIGCHLD -most neither be ignored nor blocked. It is the -user of this library's responsibility to ensure -this. The -.BR libcoopgamma_get_method_and_site () -function will not temporarily reset handling of -.I SIGCHLD -itself. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_method_and_site () -function returns 0. On error, -1 -is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_method_and_site () -function may fail for any reason specified for -.BR pipe (3), -.BR fork (3), -.BR dup2 (3), -.BR execvp (3), -.BR malloc (3), -.BR realloc (3), -.BR read (3) -(other than -.IR EINTR ), -and -.BR waitpid (3). -The function may also fail for any of the -following reasons: -.TP -.B EINVAL -If -.I method -contain an invalid adjustment method name. -.TP -.B EBADMSG -.BR coopgammad (1) -output invalid data to stdout. -.SH "SEE ALSO" -.BR libcoopgamma_get_methods (3), -.BR libcoopgamma_get_pid_file (3), -.BR libcoopgamma_get_socket_file (3), -.BR libcoopgamma_context_initialise (3) diff --git a/doc/man/libcoopgamma_get_methods.3 b/doc/man/libcoopgamma_get_methods.3 deleted file mode 100644 index b2ce807..0000000 --- a/doc/man/libcoopgamma_get_methods.3 +++ /dev/null @@ -1,65 +0,0 @@ -.TH LIBCOOPGAMMA_GET_METHODS 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_methods - List all recognised adjustment method -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -char **libcoopgamma_get_methods(void); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -Newcomers are advices to postpone learning the -.BR libcoopgamma_get_methods () -function until they have a functional program. -.P -The -.BR libcoopgamma_get_methods () -function consults -.BR coopgammad (1) -to construct a list of all adjustment method name -recognised by -.BR coopgammad (1). -.P -For the duration of the function call, -.I SIGCHLD -most neither be ignored nor blocked. It is the -user of this library's responsibility to ensure -this. The -.BR libcoopgamma_get_methods () -function will not temporarily reset handling of -.I SIGCHLD -itself. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_methods () -function returns a list of recognised -adjustment method name. The list is terminated -by a -.I NULL -element and will contain no other -.I NULL -elements. Elements in the list are subpointers -of the returned pointer and most not be freed. -The user shall however free the returned pointer, -effectively freeing all elements stored in the list. -On error, -.I NULL -is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_methods () -function may fail for any reason specified for -.BR malloc (3), -.BR realloc (3), -and -.BR libcoopgamma_get_method_and_site (3). -.SH "SEE ALSO" -.BR libcoopgamma_get_method_and_site (3), -.BR libcoopgamma_get_pid_file (3), -.BR libcoopgamma_get_socket_file (3), -.BR libcoopgamma_context_initialise (3) diff --git a/doc/man/libcoopgamma_get_pid_file.3 b/doc/man/libcoopgamma_get_pid_file.3 deleted file mode 100644 index 3d312ef..0000000 --- a/doc/man/libcoopgamma_get_pid_file.3 +++ /dev/null @@ -1,85 +0,0 @@ -.TH LIBCOOPGAMMA_GET_PID_FILE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_pid_file - Get the PID file of the coopgamma server -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -char *libcoopgamma_get_pid_file(const char *restrict \fImethod\fP, const char *restrict \fIsite\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -Newcomers need not concern themselves with the -.BR libcoopgamma_get_pid_file () -function. -.P -The -.BR libcoopgamma_get_pid_file () -function consults -.BR coopgammad (1) -to get the pathname of the PID file for the -.BR coopgammad (1) -instance for the selected adjustment -.I method -and -.IR site . -If -.I method -or -.I site -is -.IR NULL , -the it will selected automatically. -.P -For the duration of the function call, -.I SIGCHLD -most neither be ignored nor blocked. It is the -user of this library's responsibility to ensure -this. The -.BR libcoopgamma_get_pid_file () -function will not temporarily reset handling of -.I SIGCHLD -itself. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_pid_file () -function returns the pathname of the PID file. -Success does not mean that the server is necessarily -running at the moment. The user should free -the returned pointer. On error, -.I NULL -is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_pid_file () -function may fail for any reason specified for -.BR pipe (3), -.BR fork (3), -.BR dup2 (3), -.BR execvp (3), -.BR malloc (3), -.BR realloc (3), -.BR read (3) -(other than -.IR EINTR ), -and -.BR waitpid (3). -The function may also fail for any of the -following reasons: -.TP -.B EINVAL -If -.I method -contain an invalid adjustment method name. -.TP -.B EBADMSG -.BR coopgammad (1) -output invalid data to stdout. -.SH "SEE ALSO" -.BR libcoopgamma_get_methods (3), -.BR libcoopgamma_get_socket_file (3), -.BR libcoopgamma_context_initialise (3) diff --git a/doc/man/libcoopgamma_get_socket_file.3 b/doc/man/libcoopgamma_get_socket_file.3 deleted file mode 100644 index f73f0ca..0000000 --- a/doc/man/libcoopgamma_get_socket_file.3 +++ /dev/null @@ -1,86 +0,0 @@ -.TH LIBCOOPGAMMA_GET_SOCKET_FILE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_get_socket_file - Get the socket file of the coopgamma server -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -char *libcoopgamma_get_socket_file(const char *restrict \fImethod\fP, const char *restrict \fIsite\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -Newcomers need not concern themselves with the -.BR libcoopgamma_get_socket_file () -function. -.P -The -.BR libcoopgamma_get_socket_file () -function consults -.BR coopgammad (1) -to get the pathname of the socket for -communicating with the -.BR coopgammad (1) -instance for the selected adjustment -.I method -and -.IR site . -If -.I method -or -.I site -is -.IR NULL , -the it will selected automatically. -.P -For the duration of the function call, -.I SIGCHLD -most neither be ignored nor blocked. It is the -user of this library's responsibility to ensure -this. The -.BR libcoopgamma_get_socket_file () -function will not temporarily reset handling of -.I SIGCHLD -itself. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_get_socket_file () -function returns the pathname of the socket. -Success does not mean that the server is necessarily -running at the moment. The user should free -the returned pointer. On error, -.I NULL -is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_get_socket_file () -function may fail for any reason specified for -.BR pipe (3), -.BR fork (3), -.BR dup2 (3), -.BR execvp (3), -.BR malloc (3), -.BR realloc (3), -.BR read (3) -(other than -.IR EINTR ), -and -.BR waitpid (3). -The function may also fail for any of the -following reasons: -.TP -.B EINVAL -If -.I method -contain an invalid adjustment method name. -.TP -.B EBADMSG -.BR coopgammad (1) -output invalid data to stdout. -.SH "SEE ALSO" -.BR libcoopgamma_get_methods (3), -.BR libcoopgamma_get_pid_file (3), -.BR libcoopgamma_context_initialise (3) diff --git a/doc/man/libcoopgamma_queried_filter_destroy.3 b/doc/man/libcoopgamma_queried_filter_destroy.3 deleted file mode 100644 index 6847ac4..0000000 --- a/doc/man/libcoopgamma_queried_filter_destroy.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH LIBCOOPGAMMA_QUERIED_FILTER_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_queried_filter_destroy - Deinitialise a libcoopgamma_queried_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_queried_filter_destroy(libcoopgamma_queried_filter_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_queried_filter_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.SH "SEE ALSO" -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_queried_filter_initialise.3 b/doc/man/libcoopgamma_queried_filter_initialise.3 deleted file mode 100644 index 79f2c59..0000000 --- a/doc/man/libcoopgamma_queried_filter_initialise.3 +++ /dev/null @@ -1,44 +0,0 @@ -.TH LIBCOOPGAMMA_QUERIED_FILTER_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_queried_filter_initialise - Initialise a libcoopgamma_queried_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_queried_filter_initialise(libcoopgamma_queried_filter_t *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_queried_filter_initialise () -function initialises -.IR this . -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_queried_filter_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_queried_filter_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -There are no errors specified for the -.BR libcoopgamma_queried_filter_initialise () -function. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3) diff --git a/doc/man/libcoopgamma_queried_filter_marshal.3 b/doc/man/libcoopgamma_queried_filter_marshal.3 deleted file mode 100644 index 10b7ff7..0000000 --- a/doc/man/libcoopgamma_queried_filter_marshal.3 +++ /dev/null @@ -1,55 +0,0 @@ -.TH LIBCOOPGAMMA_QUERIED_FILTER_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_queried_filter_marshal - Marshal a libcoopgamma_queried_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_queried_filter_marshal(libcoopgamma_queried_filter_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, libcoopgamma_depth_t \fIdepth\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_queried_filter_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.I depth -must describe the ramps in -.IR this , -or be 0. If -.I depth -is 0, the ramps are not marshalled. -.SH "RETURN VALUES" -The -.BR libcoopgamma_queried_filter_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_queried_filter_unmarshal.3 b/doc/man/libcoopgamma_queried_filter_unmarshal.3 deleted file mode 100644 index 01f1867..0000000 --- a/doc/man/libcoopgamma_queried_filter_unmarshal.3 +++ /dev/null @@ -1,91 +0,0 @@ -.TH LIBCOOPGAMMA_QUERIED_FILTER_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_queried_filter_unmarshal - Unmarshal a libcoopgamma_queried_filter_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_queried_filter_unmarshal(libcoopgamma_queried_filter_t *restrict \fIthis\fP, - void *restrict \fIbuffer\fP, size_t *restrict \fIn\fP, - libcoopgamma_depth_t \fIdepth\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_queried_filter_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.I depth -must be the same value the parameter with the same -name had in the corresponding call to -.BR libcoopgamma_queried_filter_marshal (3). -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_queried_filter_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_queried_filter_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_queried_filter_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -The -.BR libcoopgamma_queried_filter_marshal () -function may fail, and returned -.I LIBCOOPGAMMA_ERRNO_SET -for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_ramps_destroy.3 b/doc/man/libcoopgamma_ramps_destroy.3 deleted file mode 100644 index 3d78d5d..0000000 --- a/doc/man/libcoopgamma_ramps_destroy.3 +++ /dev/null @@ -1,43 +0,0 @@ -.TH LIBCOOPGAMMA_RAMPS_DESTROY 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_ramps_destroy - Deinitialise a libcoopgamma_ramps_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_ramps_destroy(void *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_ramps_destroy () -function releases all resources allocated -to -.IR this . -The function does however not free the -allocation of the pointer -.IR this -itself. -.I this -must be of any of the following types: -.IR libcoopgamma_ramps_t , -.IR libcoopgamma_ramps8_t , -.IR libcoopgamma_ramps16_t , -.IR libcoopgamma_ramps32_t , -.IR libcoopgamma_ramps64_t , -.IR libcoopgamma_rampsf_t , -or -.IR libcoopgamma_rampsd_t . -.SH "SEE ALSO" -.BR libcoopgamma_ramps_initialise (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_destroy (3), -.BR libcoopgamma_crtc_info_destroy (3), -.BR libcoopgamma_filter_query_destroy (3), -.BR libcoopgamma_queried_filter_destroy (3), -.BR libcoopgamma_filter_table_destroy (3), -.BR libcoopgamma_error_destroy (3), -.BR libcoopgamma_context_destroy (3), -.BR libcoopgamma_async_context_destroy (3) diff --git a/doc/man/libcoopgamma_ramps_initialise.3 b/doc/man/libcoopgamma_ramps_initialise.3 deleted file mode 100644 index f6ee3d2..0000000 --- a/doc/man/libcoopgamma_ramps_initialise.3 +++ /dev/null @@ -1,62 +0,0 @@ -.TH LIBCOOPGAMMA_RAMPS_INITIALISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_ramps_initialise - Initialise a member type of libcoopgamma_ramps_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_ramps_initialise(void *restrict \fIthis\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_ramps_initialise () -function initialises -.IR this . -.I this -must be of any of the following types, and not casted -to any other type such as -.I void* -or -.IR libcoopgamma_ramps_t: -.IR libcoopgamma_ramps8_t , -.IR libcoopgamma_ramps16_t , -.IR libcoopgamma_ramps32_t , -.IR libcoopgamma_ramps64_t , -.IR libcoopgamma_rampsf_t , -or -.IR libcoopgamma_rampsd_t . -.P -The -.BR libcoopgamma_ramps_initialise () -function is defined as a macro. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_ramps_destroy (3). -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_ramps_initialise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_ramps_initialise () -function may fail for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_crtc_info_initialise (3), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_queried_filter_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_error_initialise (3), -.BR libcoopgamma_context_initialise (3), -.BR libcoopgamma_async_context_initialise (3) diff --git a/doc/man/libcoopgamma_ramps_marshal.3 b/doc/man/libcoopgamma_ramps_marshal.3 deleted file mode 100644 index aed8509..0000000 --- a/doc/man/libcoopgamma_ramps_marshal.3 +++ /dev/null @@ -1,66 +0,0 @@ -.TH LIBCOOPGAMMA_RAMPS_MARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_ramps_marshal - Marshal a member type of libcoopgamma_ramps_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -size_t libcoopgamma_ramps_marshal(void *restrict \fIthis\fP, void *restrict \fIbuffer\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_ramps_marshal () -function marshals -.I this -into a -.I buffer -that can be sent to another process on any computer -with a compatible processor. A compatible processor -is any processor with the same endianness, encoding -and sizes of the intrinsic data types and -.IR size_t . -.P -.I this -must be of any of the following types, and not casted -to any other type such as -.I void* -or -.IR libcoopgamma_ramps_t: -.IR libcoopgamma_ramps8_t , -.IR libcoopgamma_ramps16_t , -.IR libcoopgamma_ramps32_t , -.IR libcoopgamma_ramps64_t , -.IR libcoopgamma_rampsf_t , -or -.IR libcoopgamma_rampsd_t . -.P -The -.BR libcoopgamma_ramps_marshal () -function is defined as a macro. -.SH "RETURN VALUES" -The -.BR libcoopgamma_ramps_marshal () -function returns the number of bytes stored in the -.IR buffer , -or if -.I buffer -is -.IR NULL , -the the number of bytes that would have -been written if it was not -.IR NULL . -The function is always successful. -.SH "SEE ALSO" -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_ramps_unmarshal (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_crtc_info_marshal (3), -.BR libcoopgamma_filter_query_marshal (3), -.BR libcoopgamma_queried_filter_marshal (3), -.BR libcoopgamma_filter_table_marshal (3), -.BR libcoopgamma_error_marshal (3), -.BR libcoopgamma_context_marshal (3), -.BR libcoopgamma_async_context_marshal (3) diff --git a/doc/man/libcoopgamma_ramps_unmarshal.3 b/doc/man/libcoopgamma_ramps_unmarshal.3 deleted file mode 100644 index 34393cf..0000000 --- a/doc/man/libcoopgamma_ramps_unmarshal.3 +++ /dev/null @@ -1,100 +0,0 @@ -.TH LIBCOOPGAMMA_RAMPS_UNMARSHAL 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_ramps_unmarshal - Unmarshal a member type of libcoopgamma_ramps_t -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_ramps_unmarshal(void *restrict \fIthis\fP, void *restrict \fIbuffer\fP, - size_t *restrict \fIn\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_ramps_unmarshal () -function unmarshals -.I this -from a -.I buffer . -The number of read bytes from -.I buffer -is stored in -.I *n -on success. -.P -.I this -must be of any of the following types, and not casted -to any other type such as -.I void* -or -.IR libcoopgamma_ramps_t: -.IR libcoopgamma_ramps8_t , -.IR libcoopgamma_ramps16_t , -.IR libcoopgamma_ramps32_t , -.IR libcoopgamma_ramps64_t , -.IR libcoopgamma_rampsf_t , -or -.IR libcoopgamma_rampsd_t . -.P -None if the parameters may be -.IR NULL . -.I this -does not have to be initialised. -.P -On failure, -.I this -should be deinitialised using -.BR libcoopgamma_ramps_destroy (3). -.P -Undefined behaviour is invoked if the -beginning of -.I buffer -does not contain data stored by -.BR libcoopgamma_ramps_marshal (3). -.SH "RETURN VALUES" -The -.BR libcoopgamma_ramps_unmarshal () -function returns one of the following -values: -.TP -.IR LIBCOOPGAMMA_SUCCESS " (= 0)" -The function was successful. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_DOWNGRADE " (> 0)" -The data in -.I buffer -was stored by an earlier version of -.BR libcoopgamma (7) -that is no longer supported. -.TP -.IR LIBCOOPGAMMA_INCOMPATIBLE_UPGRADE " (> 0)" -The data in -.I buffer -was stored by a newer version of -.BR libcoopgamma (7) -that stores the data in an incompatible format. -.TP -.IR LIBCOOPGAMMA_ERRNO_SET "(= -1)" -An other error was encountered. -.I errno -has been set appropriately. -.SH "ERROR" -The -.BR libcoopgamma_ramps_marshal () -function may fail, and returned -.I LIBCOOPGAMMA_ERRNO_SET -for any reason specified for -.BR malloc (3). -.SH "SEE ALSO" -.BR libcoopgamma_ramps_destroy (3), -.BR libcoopgamma_ramps_marshal (3), -.BR libcoopgamma_filter_unmarshal (3), -.BR libcoopgamma_crtc_info_unmarshal (3), -.BR libcoopgamma_filter_query_unmarshal (3), -.BR libcoopgamma_queried_filter_unmarshal (3), -.BR libcoopgamma_filter_table_unmarshal (3), -.BR libcoopgamma_error_unmarshal (3), -.BR libcoopgamma_context_unmarshal (3), -.BR libcoopgamma_async_context_unmarshal (3) diff --git a/doc/man/libcoopgamma_set_gamma_recv.3 b/doc/man/libcoopgamma_set_gamma_recv.3 deleted file mode 100644 index 073343b..0000000 --- a/doc/man/libcoopgamma_set_gamma_recv.3 +++ /dev/null @@ -1,52 +0,0 @@ -.TH LIBCOOPGAMMA_SET_GAMMA_RECV 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_set_gamma_recv - Check whether a request to modify the filter table for a CRTC succeeded -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_set_gamma_recv(libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_set_gamma_recv () -function parses the response for the requests -sent using the -.BR libcoopgamma_set_gamma_send () -function with the same -.I ctx -and -.I async -arguments. The -.I async -must have been selected by the last call to the -.BR libcoopgamma_synchronise (3) -function. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_set_gamma_recv () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_set_gamma_recv () -function may fail for any reason specified for -.BR malloc (3). -The function may also fail for the following reasons: -.TP -.B EBADMSG -The received message was corrupt. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_async_context_destroy (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_set_gamma_send (3), -.BR libcoopgamma_set_gamma_sync (3), -.BR libcoopgamma_get_crtcs_recv (3), -.BR libcoopgamma_get_gamma_info_recv (3), -.BR libcoopgamma_get_gamma_recv (3) diff --git a/doc/man/libcoopgamma_set_gamma_send.3 b/doc/man/libcoopgamma_set_gamma_send.3 deleted file mode 100644 index 18c13f0..0000000 --- a/doc/man/libcoopgamma_set_gamma_send.3 +++ /dev/null @@ -1,140 +0,0 @@ -.TH LIBCOOPGAMMA_SET_GAMMA_SEND 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_set_gamma_send - Send a request to add, update, or remove a gamma ramp filter for CRTC -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_set_gamma_send(const libcoopgamma_filter_t *restrict \fIfilter\fP, - libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIasync\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_set_gamma_send () -function sends a request over the connection of -.I ctx -to add, update, or remove a gamma ramp filter for -the CRTC with the name given in -.IR filter->crtc . -Information about the request is stored in -.IR *async , -this information is used by -.BR libcoopgamma_synchronise (3) -to identify the response, and by -.BR libcoopgamma_get_gamma_recv (3) -to parse the response. -.P -A filter with the class (identifier) -.I filter->class -is removed if -.I filter->lifespan -is -.IR LIBCOOPGAMMA_REMOVE . -If -.I filter->lifespan -is not -.IR LIBCOOPGAMMA_REMOVE , -a filter with matching class is updated -if such filter exists, otherwise the filter is -added. The fitler, unless it is removed, is -inserted or moved to the priority specified by -.IR filter->priority . -.I filter->priority -is isregarded when -.I filter->lifespan -is -.IR LIBCOOPGAMMA_REMOVE . -A filter with high priority is applied before -a fitler with low priority. The filter is removed -when it is explicit removed used -.IR LIBCOOPGAMMA_REMOVE , -or if -.I filter->lifespan -is -.IR LIBCOOPGAMMA_UNTIL_DEATH , -when the client that last added or updated -the filter disconnects from the server, which -ever comes first. Note that, when updating a -filter, the lifespan is updated to -.IR filter->lifespan . -.P -The class -.RI ( filter->class ) -must be of the format -\fI${PACKAGE_NAME}\fP\fB::\fP\fI${COMMAND_NAME}\fP\fB::\fP\fI${RULE}\fP, -where -.I ${PACKAGE_NAME} -is the name of the package as installed on the system, -the program should make it easy to adjust this; -.I ${COMMAND_NAME} -is the name of the program, this too should not -easily adjustable, and -.I ${RULE} -is a string that identifies filter uniquely within -the program, or can be hardcoded or runtime -configurable. -.P -Unless -.I filter->lifespan -is -.IR LIBCOOPGAMMA_REMOVE , -.I filter->depth -and -.I filter->ramps -must be configured to specified the desired ramp values. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_set_gamma_send () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_set_gamma_send () -function may fail for any reason specified for -.BR malloc (3), -.BR realloc (3), -or -.BR libcoopgamma_flush (3). -Particularly interesting exceptional -conditions, that are not errors proper, include -those indicated by the following values on -.IR errno : -.TP -.B EINTR -The function was interrupted by a signal. When -this happens, call -.BR libcoopgamma_flush (3) -to resume. -.TP -.BR EAGAIN " or " EWOULDBLOCK -The communication is nonblocking and the buffer -between the server and the client is full, -and no more data can be queued without blocking. -When this happens, wait a short period of time -and call -.BR libcoopgamma_flush (3) -to resume. -.BR select (3) -or similar function can be used to wait until -.I ctx->fd -is readable. -.TP -.B ECONNREST -The connection to the server has closed. -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_initialise (3), -.BR libcoopgamma_async_context_initialise (3), -.BR libcoopgamma_flush (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_set_gamma_recv (3), -.BR libcoopgamma_set_gamma_sync (3), -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_set_gamma_send (3) diff --git a/doc/man/libcoopgamma_set_gamma_sync.3 b/doc/man/libcoopgamma_set_gamma_sync.3 deleted file mode 100644 index e65e345..0000000 --- a/doc/man/libcoopgamma_set_gamma_sync.3 +++ /dev/null @@ -1,105 +0,0 @@ -.TH LIBCOOPGAMMA_SET_GAMMA_SYNC 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_set_gamma_sync - Synchronously modify a CRTC's filter table -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_set_gamma_sync(const libcoopgamma_filter_t* restrict \fIfilter\fP, - libcoopgamma_context_t *restrict \fIctx\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_set_gamma_sync () -function synchronously adds, updates, or removes -a filter to, in, or from the CTRC's, whose name is -.IR filter->crtc , -filter table, over the connection of -.I ctx -to the server. -.P -A filter with the class (identifier) -.I filter->class -is removed if -.I filter->lifespan -is -.IR LIBCOOPGAMMA_REMOVE . -If -.I filter->lifespan -is not -.IR LIBCOOPGAMMA_REMOVE , -a filter with matching class is updated -if such filter exists, otherwise the filter is -added. The fitler, unless it is removed, is -inserted or moved to the priority specified by -.IR filter->priority . -.I filter->priority -is isregarded when -.I filter->lifespan -is -.IR LIBCOOPGAMMA_REMOVE . -A filter with high priority is applied before -a fitler with low priority. The filter is removed -when it is explicit removed used -.IR LIBCOOPGAMMA_REMOVE , -or if -.I filter->lifespan -is -.IR LIBCOOPGAMMA_UNTIL_DEATH , -when the client that last added or updated -the filter disconnects from the server, which -ever comes first. Note that, when updating a -filter, the lifespan is updated to -.IR filter->lifespan . -.P -The class -.RI ( filter->class ) -must be of the format -\fI${PACKAGE_NAME}\fP\fB::\fP\fI${COMMAND_NAME}\fP\fB::\fP\fI${RULE}\fP, -where -.I ${PACKAGE_NAME} -is the name of the package as installed on the system, -the program should make it easy to adjust this; -.I ${COMMAND_NAME} -is the name of the program, this too should not -easily adjustable, and -.I ${RULE} -is a string that identifies filter uniquely within -the program, or can be hardcoded or runtime -configurable. -.P -Unless -.I filter->lifespan -is -.IR LIBCOOPGAMMA_REMOVE , -.I filter->depth -and -.I filter->ramps -must be configured to specified the desired ramp values. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_set_gamma_recv () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_set_gamma_send () -function may fail for any reason specified for -.BR libcoopgamma_set_gamma_send (3), -.BR libcoopgamma_set_gamma_recv (3), -.BR libcoopgamma_flush (3), -or -.BR libcoopgamma_synchronise (3). -.SH "SEE ALSO" -.BR libcoopgamma.h (0), -.BR libcoopgamma_filter_query_initialise (3), -.BR libcoopgamma_filter_table_initialise (3), -.BR libcoopgamma_set_gamma_send (3), -.BR libcoopgamma_set_gamma_recv (3), -.BR libcoopgamma_get_crtcs_sync (3), -.BR libcoopgamma_get_gamma_info_sync (3), -.BR libcoopgamma_get_gamma_sync (3) diff --git a/doc/man/libcoopgamma_set_nonblocking.3 b/doc/man/libcoopgamma_set_nonblocking.3 deleted file mode 100644 index 7e6ceb6..0000000 --- a/doc/man/libcoopgamma_set_nonblocking.3 +++ /dev/null @@ -1,49 +0,0 @@ -.TH LIBCOOPGAMMA_SET_NONBLOCKING 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_set_nonblocking - Switch to or from nonblocking communication -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_set_nonblocking(libcoopgamma_context_t *restrict \fIctx\fP, int \fInonblocking\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_set_nonblocking () -function sets the communication with the server for -the connection of -.I ctx -to be nonblocking if -.I nonblocking -is nonzero, -and to be block otherwise. -.I ctx -must already be connected to the server, -which is achieved by calling the -.BR libcoopgamma_connect (3) -functon. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_set_nonblocking () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_connect () -function may fail for any reason specified for -.BR fcntl (3) -with -.I F_GETFL -or -.I F_SETFL -as the second argument. -.SH "SEE ALSO" -.BR libcoopgamma_connect (3), -.BR libcoopgamma_get_crtcs_send (3), -.BR libcoopgamma_get_gamma_info_send (3), -.BR libcoopgamma_get_gamma_send (3), -.BR libcoopgamma_set_gamma_send (3) diff --git a/doc/man/libcoopgamma_skip_message.3 b/doc/man/libcoopgamma_skip_message.3 deleted file mode 100644 index 13eb6cc..0000000 --- a/doc/man/libcoopgamma_skip_message.3 +++ /dev/null @@ -1,30 +0,0 @@ -.TH LIBCOOPGAMMA_SKIP_MESSAGE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_skip_message - Skip a received message -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -void libcoopgamma_skip_message(libcoopgamma_context_t *restrict \fIctx\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_skip_message () -function is used to tell the library that you -are not interested in a message recieved for -.IR ctx . -This can be the case if -.BR libcoopgamma_synchronise (3) -selected an asynchronous call context that -is inactive. -.SH "SEE ALSO" -.BR libcoopgamma_flush (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_synchronise (3), -.BR libcoopgamma_get_crtcs_sync (3), -.BR libcoopgamma_get_gamma_info_sync (3), -.BR libcoopgamma_get_gamma_sync (3), -.BR libcoopgamma_set_gamma_sync (3) diff --git a/doc/man/libcoopgamma_synchronise.3 b/doc/man/libcoopgamma_synchronise.3 deleted file mode 100644 index 70d2f63..0000000 --- a/doc/man/libcoopgamma_synchronise.3 +++ /dev/null @@ -1,94 +0,0 @@ -.TH LIBCOOPGAMMA_SYNCHRONISE 3 LIBCOOPGAMMA -.SH "NAME" -libcoopgamma_synchronise - Wait for the next message to be received -.SH "SYNOPSIS" -.nf -#include <libcoopgamma.h> - -int libcoopgamma_synchronise(libcoopgamma_context_t *restrict \fIctx\fP, - libcoopgamma_async_context_t *restrict \fIpending\fP, - size_t \fIn\fP, size_t *restrict \fIselected\fP); -.fi -.P -Link with -.IR -lcoopgamma . -.SH "DESCRIPTION" -The -.BR libcoopgamma_synchronise () -function waits until the next message for -.I ctx -to be received and selects the context for the -asynchronous call for which the received message -is a response. -.I pending -shall list thes contexts for all pending asynchronous -call. The number of pending asynchronous call shall be -passed to the function via the -.I n -parameter. Once a full message as been received -.I *selected -is set to the index of the context in -.I pending -representing the context for the asynchronous call -to which the received message is a response. -.SH "RETURN VALUES" -Upon successful completion, the -.BR libcoopgamma_synchronise () -function returns 0. On error, -1 is returned and -.I errno -is set appropriately. -.SH "ERRORS" -The -.BR libcoopgamma_synchronise () -function may fail for any reason specified for -.BR realloc (3), -or -.BR recv (3). -Particularly interesting exceptional -conditions, that are not errors proper, include -those indicated by the following values on -.IR errno : -.TP -.B EINTR -The function was interrupted by a signal. When -this happens, just resume be calling the functon -again. -.TP -.BR EAGAIN " or " EWOULDBLOCK -The communication is nonblocking and no more -data is ready to be read, the buffer between -the server and the client has been depleted, -When this happens, wait a short period of time -and call the function again to resume. -.BR select (3) -or similar function can be used to wait until -.I ctx->fd -is readable. -.TP -.B ECONNREST -The connection to the server has closed. -.P -The function may also fail for the following reasons: -.TP -.B EBADMSG -A corrupt message has been received. Call the -function again to ge the next message. -.TP -.B ENOTRECOVERABLE -A corrupt message has been received. The corruption -is too severe for recovery. You may either exit -or disconnection and connection again. -.TP -0 -The receive message does not match any of the -.I n -first contexts in -.IR pending . -.SH "SEE ALSO" -.BR libcoopgamma_flush (3), -.BR libcoopgamma_set_nonblocking (3), -.BR libcoopgamma_skip_message (3), -.BR libcoopgamma_get_crtcs_recv (3), -.BR libcoopgamma_get_gamma_info_recv (3), -.BR libcoopgamma_get_gamma_recv (3), -.BR libcoopgamma_set_gamma_recv (3) |