From bf4020471356938b9181a33984f511ffdd7ff25b Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 22 Oct 2019 18:59:27 +0200 Subject: Change license, change style, clean up, flat file hier, clean valgrind output in test MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libcoopgamma_get_methods.3 | 65 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 libcoopgamma_get_methods.3 (limited to 'libcoopgamma_get_methods.3') diff --git a/libcoopgamma_get_methods.3 b/libcoopgamma_get_methods.3 new file mode 100644 index 0000000..b2ce807 --- /dev/null +++ b/libcoopgamma_get_methods.3 @@ -0,0 +1,65 @@ +.TH LIBCOOPGAMMA_GET_METHODS 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_get_methods - List all recognised adjustment method +.SH "SYNOPSIS" +.nf +#include + +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) -- cgit v1.2.3-70-g09d2