tripathysagar/man_text huggingface dataset:
# log1p

## NAME



           log1p, log1pf, log1pl -  logarithm of 1 plus argument
    


## LIBRARY



           Math library (_libm_ , _-lm_)
    


## SYNOPSIS



           **#include <math.h>**
    
           **double log1p(double** _x_**);**
           **float log1pf(float** _x_**);**
           **long double log1pl(long double** _x_**);**
    
       Feature Test Macro Requirements for glibc (see
       feature_test_macros(7)):
    
           **log1p**():
               _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
                   || _XOPEN_SOURCE >= 500
                   || /* Since glibc 2.19: */ _DEFAULT_SOURCE
                   || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
    
           **log1pf**(), **log1pl**():
               _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
                   || /* Since glibc 2.19: */ _DEFAULT_SOURCE
                   || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
    


## DESCRIPTION



           These functions return a value equivalent to
    
               log(1 + _x_)
    
           The result is computed in a way that is accurate even if the value
           of _x_ is near zero.
    


## RETURN VALUE



           On success, these functions return the natural logarithm of
           _(1 + x)_.
    
           If _x_ is a NaN, a NaN is returned.
    
           If _x_ is positive infinity, positive infinity is returned.
    
           If _x_ is -1, a pole error occurs, and the functions return
           -**HUGE_VAL** , -**HUGE_VALF** , or -**HUGE_VALL** , respectively.
    
           If _x_ is less than -1 (including negative infinity), a domain error
           occurs, and a NaN (not a number) is returned.
    


## ERRORS



           See math_error(7) for information on how to determine whether an
           error has occurred when calling these functions.
    
           The following errors can occur:
    
           Domain error: _x_ is less than -1.
                  _errno_ is set to **EDOM**(but see BUGS).  An invalid floating-
                  point exception (**FE_INVALID**) is raised.
    
           Pole error: _x_ is -1.
                  _errno_ is set to **ERANGE**(but see BUGS).  A divide-by-zero
                  floating-point exception (**FE_DIVBYZERO**) is raised.
    


## ATTRIBUTES



           For an explanation of the terms used in this section, see
           attributes(7).
           ┌──────────────────────────────────────┬───────────────┬─────────┐
           │ **Interface** │ **Attribute** │ **Value** │
           ├──────────────────────────────────────┼───────────────┼─────────┤
           │ **log1p**(), **log1pf**(), **log1pl**()          │ Thread safety │ MT-Safe │
           └──────────────────────────────────────┴───────────────┴─────────┘
    


## STANDARDS



           C11, POSIX.1-2008.
    


## BUGS



           Before glibc 2.22, the glibc implementation did not set _errno_ to
           **EDOM** when a domain error occurred.
    
           Before glibc 2.22, the glibc implementation did not set _errno_ to
           **ERANGE** when a range error occurred.
    


* * *
# gnutls_x509_crt_get_raw_dn

## NAME



           gnutls_x509_crt_get_raw_dn - API function
    


## SYNOPSIS



           **#include <gnutls/x509.h>**
    
           **int gnutls_x509_crt_get_raw_dn(gnutls_x509_crt_t** _cert_**,**
           **gnutls_datum_t ***_dn_**);**
    


## ARGUMENTS



           gnutls_x509_crt_t cert
                       should contain a **gnutls_x509_crt_t** type
    
           gnutls_datum_t * dn
                       will hold the starting point of the DN
    


## DESCRIPTION



           This function will return a pointer to the DER encoded DN
           structure and the length. This points to allocated data that must
           be free'd using **gnutls_free()**.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error value. or a negative error code on error.
    


* * *
# sync

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           sync — schedule file system updates
    


## SYNOPSIS



           #include <unistd.h>
    
           void sync(void);
    


## DESCRIPTION



           The _sync_() function shall cause all information in memory that
           updates file systems to be scheduled for writing out to all file
           systems.
    
           The writing, although scheduled, is not necessarily complete upon
           return from _sync_().
    


## RETURN VALUE



           The _sync_() function shall not return a value.
    


## ERRORS



           No errors are defined.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           None.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *
# gnutls_certificate_get_issuer

## NAME



           gnutls_certificate_get_issuer - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **int gnutls_certificate_get_issuer(gnutls_certificate_credentials_t**
           _sc_**, gnutls_x509_crt_t** _cert_**, gnutls_x509_crt_t ***_issuer_**, unsigned**
           **int** _flags_**);**
    


## ARGUMENTS



           gnutls_certificate_credentials_t sc
                       is a **gnutls_certificate_credentials_t** type.
    
           gnutls_x509_crt_t cert
                       is the certificate to find issuer for
    
           gnutls_x509_crt_t * issuer
                       Will hold the issuer if any. Should be treated as
                       constant.
    
           unsigned int flags
                       Use zero or **GNUTLS_TL_GET_COPY**
    


## DESCRIPTION



           This function will return the issuer of a given certificate.  If
           the flag **GNUTLS_TL_GET_COPY** is specified a copy of the issuer will
           be returned which must be freed using **gnutls_x509_crt_deinit()**.
           In that case the provided  _issuer_ must not be initialized.
    
           As with **gnutls_x509_trust_list_get_issuer()** this function requires
           the **GNUTLS_TL_GET_COPY** flag in order to operate with PKCS**11** trust
           lists in a thread-safe way.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error value.
    


## SINCE



           3.0
    


* * *
# function::qsq_throughput

## NAME



           function::qsq_throughput - Number of requests served per unit time
    


## SYNOPSIS



               qsq_throughput:long(qname:string,scale:long)
    


## ARGUMENTS



           _qname_
               queue name
    
           _scale_
               scale variable to take account for interval fraction
    


## DESCRIPTION



           This function returns the average number or requests served per
           microsecond.
    


* * *
# io_uring_register_sync_cancel

## NAME



           io_uring_register_sync_cancel - issue a synchronous cancelation
           request
    


## SYNOPSIS



           **#include <liburing.h>**
    
           **int io_uring_register_sync_cancel(struct io_uring ***_ring_**,**
                                             **struct io_uring_sync_cancel_reg ***_reg_**);**
    


## DESCRIPTION



           The io_uring_register_sync_cancel(3) function performs a
           synchronous cancelation request based on the parameters specified
           in _reg ._
    
           The _reg_ argument must be filled in with the appropriate
           information for the cancelation request. It looks as follows:
    
               struct io_uring_sync_cancel_reg {
                   __u64 addr;
                   __s32 fd;
                   __u32 flags;
                   struct __kernel_timespec timeout;
                   __u8 opcode;
                   __u8 pad[7];
                   __u64 pad2[3];
               };
    
           The arguments largely mirror what the async prep functions
           support, see io_uring_prep_cancel(3) for details. Similarly, the
           return value is the same. The exception is the _timeout_ argument,
           which can be used to limit the time that the kernel will wait for
           cancelations to be successful. If the _tv_sec_ and _tv_nsec_ values
           are set to anything but **-1UL ,** then they indicate a relative
           timeout upon which cancelations should be completed by.
    
           The _pad_ values must be zero filled.
    


## RETURN VALUE



           See io_uring_prep_cancel(3) for details on the return value. If
           _timeout_ is set to indicate a timeout, then **-ETIME** will be returned
           if exceeded. If an unknown value is set in the request, or if the
           pad values are not cleared to zero, then _-EINVAL_ is returned.
    


* * *
# wcschr

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           wcschr — wide-character string scanning operation
    


## SYNOPSIS



           #include <wchar.h>
    
           wchar_t *wcschr(const wchar_t *_ws_ , wchar_t _wc_);
    


## DESCRIPTION



           The functionality described on this reference page is aligned with
           the ISO C standard. Any conflict between the requirements
           described here and the ISO C standard is unintentional. This
           volume of POSIX.1‐2017 defers to the ISO C standard.
    
           The _wcschr_() function shall locate the first occurrence of _wc_ in
           the wide-character string pointed to by _ws_.  The application shall
           ensure that the value of _wc_ is a character representable as a type
           **wchar_t** and a wide-character code corresponding to a valid
           character in the current locale. The terminating null wide-
           character code is considered to be part of the wide-character
           string.
    


## RETURN VALUE



           Upon completion, _wcschr_() shall return a pointer to the wide-
           character code, or a null pointer if the wide-character code is
           not found.
    


## ERRORS



           No errors are defined.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           None.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *
# ibv_alloc_td

## NAME



           ibv_alloc_td(), ibv_dealloc_td() - allocate and deallocate thread
           domain object
    


## SYNOPSIS



           **#include <infiniband/verbs.h>**
    
           **struct ibv_td *ibv_alloc_td(struct ibv_context** _*context_**,**
                                       **struct ibv_td_init_attr** _*init_attr_**);**
    
           **int ibv_dealloc_td(struct ibv_td** _*td_**);**
    


## DESCRIPTION



           **ibv_alloc_td()** allocates a thread domain object for the RDMA
           device context _context_.
    
           The thread domain object defines how the verbs libraries and
           provider will use locks and additional hardware capabilities to
           achieve best performance for handling multi-thread or single-
           thread protection.  An application assigns verbs resources to a
           thread domain when it creates a verbs object.
    
           If the _ibv_td_ object is specified then any objects created under
           this thread domain will disable internal locking designed to
           protect against concurrent access to that object from multiple
           user threads. By default all verbs objects are safe for multi-
           threaded access, whether or not a thread domain is specified.
    
           A _struct ibv_td_ can be added to a parent domain via
           **ibv_alloc_parent_domain()** and then the parent domain can be used
           to create verbs objects.
    
           **ibv_dealloc_td()** will deallocate the thread domain _td_.  All
           resources created with the _td_ should be destroyed prior to
           deallocating the _td_.
    


## RETURN VALUE



           **ibv_alloc_td()** returns a pointer to the allocated struct _ibv_td_
           object, or NULL if the request fails (and sets errno to indicate
           the failure reason).
    
           **ibv_dealloc_td()** returns 0 on success, or the value of errno on
           failure (which indicates the failure reason).
    


* * *
# gnutls_pkcs12_bag_get_friendly_name

## NAME



           gnutls_pkcs12_bag_get_friendly_name - API function
    


## SYNOPSIS



           **#include <gnutls/pkcs12.h>**
    
           **int gnutls_pkcs12_bag_get_friendly_name(gnutls_pkcs12_bag_t** _bag_**,**
           **unsigned** _indx_**, char ****_name_**);**
    


## ARGUMENTS



           gnutls_pkcs12_bag_t bag
                       The bag
    
           unsigned indx
                       The bag's element to add the id
    
           char ** name
                       will hold a pointer to the name (to be treated as
                       const)
    


## DESCRIPTION



           This function will return the friendly name, of the specified bag
           element.  The key ID is usually used to distinguish the local
           private key and the certificate pair.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error value. or a negative error code on error.
    


* * *
# sem_init

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           sem_init — initialize an unnamed semaphore
    


## SYNOPSIS



           #include <semaphore.h>
    
           int sem_init(sem_t *_sem_ , int _pshared_ , unsigned _value_);
    


## DESCRIPTION



           The _sem_init_() function shall initialize the unnamed semaphore
           referred to by _sem_.  The value of the initialized semaphore shall
           be _value_.  Following a successful call to _sem_init_(), the
           semaphore may be used in subsequent calls to _sem_wait_(),
           _sem_timedwait_(), _sem_trywait_(), _sem_post_(), and _sem_destroy_().
           This semaphore shall remain usable until the semaphore is
           destroyed.
    
           If the _pshared_ argument has a non-zero value, then the semaphore
           is shared between processes; in this case, any process that can
           access the semaphore _sem_ can use _sem_ for performing _sem_wait_(),
           _sem_timedwait_(), _sem_trywait_(), _sem_post_(), and _sem_destroy_()
           operations.
    
           If the _pshared_ argument is zero, then the semaphore is shared
           between threads of the process; any thread in this process can use
           _sem_ for performing _sem_wait_(), _sem_timedwait_(), _sem_trywait_(),
           _sem_post_(), and _sem_destroy_() operations.
    
           See _Section 2.9.9_ , _Synchronization Object Copies and Alternative_
           _Mappings_ for further requirements.
    
           Attempting to initialize an already initialized semaphore results
           in undefined behavior.
    


## RETURN VALUE



           Upon successful completion, the _sem_init_() function shall
           initialize the semaphore in _sem_ and return 0. Otherwise, it shall
           return -1 and set _errno_ to indicate the error.
    


## ERRORS



           The _sem_init_() function shall fail if:
    
           **EINVAL** The _value_ argument exceeds {SEM_VALUE_MAX}.
    
           **ENOSPC** A resource required to initialize the semaphore has been
                  exhausted, or the limit on semaphores ({SEM_NSEMS_MAX}) has
                  been reached.
    
           **EPERM** The process lacks appropriate privileges to initialize the
                  semaphore.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           None.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *
# gnutls_ecc_curve_get_pk

## NAME



           gnutls_ecc_curve_get_pk - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **gnutls_pk_algorithm_t gnutls_ecc_curve_get_pk(gnutls_ecc_curve_t**
           _curve_**);**
    


## ARGUMENTS



           gnutls_ecc_curve_t curve
                       is an ECC curve
    


## RETURNS



           the public key algorithm associated with the named curve or
           **GNUTLS_PK_UNKNOWN**.
    


## SINCE



           3.5.0
    


* * *
# gnutls_pkcs12_bag_init

## NAME



           gnutls_pkcs12_bag_init - API function
    


## SYNOPSIS



           **#include <gnutls/pkcs12.h>**
    
           **int gnutls_pkcs12_bag_init(gnutls_pkcs12_bag_t ***_bag_**);**
    


## ARGUMENTS



           gnutls_pkcs12_bag_t * bag
                       A pointer to the type to be initialized
    


## DESCRIPTION



           This function will initialize a PKCS12 bag structure. PKCS12 Bags
           usually contain private keys, lists of X.509 Certificates and
           X.509 Certificate revocation lists.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, otherwise a negative
           error value.
    


* * *
# probe::ioscheduler_trace.unplug_io

## NAME



           probe::ioscheduler_trace.unplug_io - Fires when a request queue is
           unplugged;
    


## SYNOPSIS



           ioscheduler_trace.unplug_io
    


## VALUES



           _rq_queue_
               request queue
    
           _name_
               Name of the probe point
    


## DESCRIPTION



           Either, when number of pending requests in the queue exceeds
           threshold or, upon expiration of timer that was activated when
           queue was plugged.
    


* * *
# ibv_destroy_counters

## NAME



           **ibv_create_counters** , **ibv_destroy_counters** - Create or destroy a
           counters handle
    


## SYNOPSIS



                  #include <infiniband/verbs.h>
    
                  struct ibv_counters *
                  ibv_create_counters(struct ibv_context *context,
                                      struct ibv_counters_init_attr *init_attr);
    
                  int ibv_destroy_counters(struct ibv_counters *counters);
    


## DESCRIPTION



           **ibv_create_counters**() creates a new counters handle for the RDMA
           device context.
    
           An ibv_counters handle can be attached to a verbs resource (e.g.:
           QP, WQ, Flow) statically when these are created.
    
           For example attach an ibv_counters statically to a Flow (struct
           ibv_flow) during creation of a new Flow by calling
           **ibv_create_flow()**.
    
           Counters are cleared upon creation and values will be
           monotonically increasing.
    
           **ibv_destroy_counters**() releases the counters handle, user should
           detach the counters object before destroying it.
    


## ARGUMENTS



           _context_
                  RDMA device context to create the counters on.
    
           _init_attr_
                  Is an ibv_counters_init_attr struct, as defined in verbs.h.
    
       _**init_attr** _Argument
                  struct ibv_counters_init_attr {
                      int comp_mask;
                  };
    
           _comp_mask_
                  Bitmask specifying what fields in the structure are valid.
    


## RETURN VALUE



           **ibv_create_counters**() returns a pointer to the allocated
           ibv_counters object, or NULL if the request fails (and sets errno
           to indicate the failure reason)
    
           **ibv_destroy_counters**() returns 0 on success, or the value of errno
           on failure (which indicates the failure reason)
    


## ERRORS



           EOPNOTSUPP
                  **ibv_create_counters**() is not currently supported on this
                  device (ENOSYS may sometimes be returned by old versions of
                  libibverbs).
    
           ENOMEM **ibv_create_counters**() could not create ibv_counters object,
                  not enough memory
    
           EINVAL invalid parameter supplied **ibv_destroy_counters**()
    


## EXAMPLE



           An example of use of ibv_counters is shown in **ibv_read_counters**
    


* * *
# getnetbyaddr

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           getnetbyaddr, getnetbyname, getnetent — network database functions
    


## SYNOPSIS



           #include <netdb.h>
    
           struct netent *getnetbyaddr(uint32_t _net_ , int _type_);
           struct netent *getnetbyname(const char *_name_);
           struct netent *getnetent(void);
    


## DESCRIPTION



           Refer to endnetent(3p).
    


* * *
# selinux_restorecon_set_alt_rootpath

## NAME



           selinux_restorecon_set_alt_rootpath - set an alternate rootpath.
    


## SYNOPSIS



           **#include <selinux/restorecon.h>**
    
           **int selinux_restorecon_set_alt_rootpath(const char ***_alt_rootpath_**);**
    


## DESCRIPTION



           **selinux_restorecon_set_alt_rootpath**() passes to
           selinux_restorecon(3) a pointer containing an alternate rootpath
           _alt_rootpath_.
    
           **selinux_restorecon_set_alt_rootpath**() must be called prior to
           selinux_restorecon(3).
    


## RETURN VALUE



           On success, zero is returned.  On error, -1 is returned and _errno_
           is set appropriately.
    


* * *
# gnutls_x509_crq_get_key_usage

## NAME



           gnutls_x509_crq_get_key_usage - API function
    


## SYNOPSIS



           **#include <gnutls/x509.h>**
    
           **int gnutls_x509_crq_get_key_usage(gnutls_x509_crq_t** _crq_**, unsigned**
           **int ***_key_usage_**, unsigned int ***_critical_**);**
    


## ARGUMENTS



           gnutls_x509_crq_t crq
                       should contain a **gnutls_x509_crq_t** type
    
           unsigned int * key_usage
                       where the key usage bits will be stored
    
           unsigned int * critical
                       will be non-zero if the extension is marked as
                       critical
    


## DESCRIPTION



           This function will return certificate's key usage, by reading the
           keyUsage X.509 extension (2.5.29.15).  The key usage value will
           ORed values of the: **GNUTLS_KEY_DIGITAL_SIGNATURE** ,
           **GNUTLS_KEY_NON_REPUDIATION** , **GNUTLS_KEY_KEY_ENCIPHERMENT** ,
           **GNUTLS_KEY_DATA_ENCIPHERMENT** , **GNUTLS_KEY_KEY_AGREEMENT** ,
           **GNUTLS_KEY_KEY_CERT_SIGN** , **GNUTLS_KEY_CRL_SIGN** ,
           **GNUTLS_KEY_ENCIPHER_ONLY** , **GNUTLS_KEY_DECIPHER_ONLY**.
    


## RETURNS



           the certificate key usage, or a negative error code in case of
           parsing error.  If the certificate does not contain the keyUsage
           extension **GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE** will be returned.
    


## SINCE



           2.8.0
    


* * *
# vfwscanf

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           vfwscanf, vswscanf, vwscanf — wide-character formatted input of a
           stdarg argument list
    


## SYNOPSIS



           #include <stdarg.h>
           #include <stdio.h>
           #include <wchar.h>
    
           int vfwscanf(FILE *restrict _stream_ , const wchar_t *restrict _format_ ,
               va_list _arg_);
           int vswscanf(const wchar_t *restrict _ws_ , const wchar_t *restrict _format_ ,
               va_list _arg_);
           int vwscanf(const wchar_t *restrict _format_ , va_list _arg_);
    


## DESCRIPTION



           The functionality described on this reference page is aligned with
           the ISO C standard. Any conflict between the requirements
           described here and the ISO C standard is unintentional. This
           volume of POSIX.1‐2017 defers to the ISO C standard.
    
           The _vfwscanf_(), _vswscanf_(), and _vwscanf_() functions shall be
           equivalent to the _fwscanf_(), _swscanf_(), and _wscanf_() functions,
           respectively, except that instead of being called with a variable
           number of arguments, they are called with an argument list as
           defined in the _< stdarg.h>_ header. These functions shall not invoke
           the _va_end_ macro. As these functions invoke the _va_arg_ macro, the
           value of _ap_ after the return is unspecified.
    


## RETURN VALUE



           Refer to fwscanf(3p).
    


## ERRORS



           Refer to fwscanf(3p).
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           Applications using these functions should call _va_end_(_ap_)
           afterwards to clean up.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *
# gnutls_session_set_verify_cert

## NAME



           gnutls_session_set_verify_cert - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **void gnutls_session_set_verify_cert(gnutls_session_t** _session_**,**
           **const char ***_hostname_**, unsigned** _flags_**);**
    


## ARGUMENTS



           gnutls_session_t session
                       is a gnutls session
    
           const char * hostname
                       is the expected name of the peer; may be **NULL**
    
           unsigned flags
                       flags for certificate verification --
                       **gnutls_certificate_verify_flags**
    


## DESCRIPTION



           This function instructs GnuTLS to verify the peer's certificate
           using the provided hostname. If the verification fails the
           handshake will also fail with
           **GNUTLS_E_CERTIFICATE_VERIFICATION_ERROR**. In that case the
           verification result can be obtained using
           **gnutls_session_get_verify_cert_status()**.
    
           The  _hostname_ pointer provided must remain valid for the lifetime
           of the session. More precisely it should be available during any
           subsequent handshakes. If no hostname is provided, no hostname
           verification will be performed. For a more advanced verification
           function check **gnutls_session_set_verify_cert2()**.
    
           If  _flags_ is provided which contain a profile, this function
           should be called after any session priority setting functions.
    
           The **gnutls_session_set_verify_cert()** function is intended to be
           used by TLS clients to verify the server's certificate.
    


## SINCE



           3.4.6
    


* * *
# gnutls_handshake_set_post_client_hello_function

## NAME



           gnutls_handshake_set_post_client_hello_function - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **void**
           **gnutls_handshake_set_post_client_hello_function(gnutls_session_t**
           _session_**, gnutls_handshake_simple_hook_func** _func_**);**
    


## ARGUMENTS



           gnutls_session_t session
                       is a **gnutls_session_t** type.
    
           gnutls_handshake_simple_hook_func func
                       is the function to be called
    


## DESCRIPTION



           This function will set a callback to be called after the client
           hello has been received (callback valid in server side only). This
           allows the server to adjust settings based on received extensions.
    
           Those settings could be ciphersuites, requesting certificate, or
           anything else except for version negotiation (this is done before
           the hello message is parsed).
    
           This callback must return 0 on success or a gnutls error code to
           terminate the handshake.
    
           Since GnuTLS 3.3.5 the callback is allowed to return
           **GNUTLS_E_AGAIN** or **GNUTLS_E_INTERRUPTED** to put the handshake on
           hold. In that case **gnutls_handshake()** will return
           **GNUTLS_E_INTERRUPTED** and can be resumed when needed.
    


## WARNING



           You should not use this function to terminate the handshake based
           on client input unless you know what you are doing. Before the
           handshake is finished there is no way to know if there is a
           man-in-the-middle attack being performed.
    


* * *
# sd-device

## NAME



           sd-device - API for enumerating and introspecting local devices
    


## SYNOPSIS



           **#include <systemd/sd-device.h>**
    
           **pkg-config --cflags --libs libsystemd**
    


## DESCRIPTION



           sd-device.h is part of libsystemd(3) and provides an API to
           introspect and enumerate devices on the local system. It provides
           a programmatic interface to the database of devices and their
           properties mananaged by systemd-udevd.service(8). This API is a
           replacement for libudev(3) and libudev.h.
    
           See
               sd_device_get_syspath(3),
               sd_device_ref(3)
           for more information about the functions available.
    


## NOTES



           Functions described here are available as a shared library, which
           can be compiled against and linked to with the
           **libsystemd pkg-config**(1) file.
    
           The code described here uses getenv(3), which is declared to be
           not multi-thread-safe. This means that the code calling the
           functions described here must not call setenv(3) from a parallel
           thread. It is recommended to only do calls to **setenv()** from an
           early phase of the program when no other threads have been
           started.
    


* * *
# pcre2_convert_context_copy

## NAME



           PCRE2 - Perl-compatible regular expressions (revised API)
    


## SYNOPSIS



    
           **#include <pcre2.h>**
    
           **pcre2_convert_context *pcre2_convert_context_copy(**
             **pcre2_convert_context ***_cvcontext_**);**
    


## DESCRIPTION



    
           This function is part of an experimental set of pattern conversion
           functions.  It makes a new copy of a convert context, using the
           memory allocation function that was used for the original context.
           The result is NULL if the memory cannot be obtained.
    
           The pattern conversion functions are described in the **pcre2convert**
           documentation.
    


* * *
# getloadavg

## NAME



           getloadavg - get system load averages
    


## LIBRARY



           Standard C library (_libc_ , _-lc_)
    


## SYNOPSIS



           **#include <stdlib.h>**
    
           **int getloadavg(double** _loadavg[]_**, int** _n_**);**
    
       Feature Test Macro Requirements for glibc (see
       feature_test_macros(7)):
    
           **getloadavg**():
               Since glibc 2.19:
                   _DEFAULT_SOURCE
               In glibc up to and including 2.19:
                   _BSD_SOURCE
    


## DESCRIPTION



           The **getloadavg**() function returns the number of processes in the
           system run queue averaged over various periods of time.  Up to _n_
           samples are retrieved and assigned to successive elements of
           _loadavg[]_.  The system imposes a maximum of 3 samples,
           representing averages over the last 1, 5, and 15 minutes,
           respectively.
    


## RETURN VALUE



           If the load average was unobtainable, -1 is returned; otherwise,
           the number of samples actually retrieved is returned.
    


## ATTRIBUTES



           For an explanation of the terms used in this section, see
           attributes(7).
           ┌──────────────────────────────────────┬───────────────┬─────────┐
           │ **Interface** │ **Attribute** │ **Value** │
           ├──────────────────────────────────────┼───────────────┼─────────┤
           │ **getloadavg**()                         │ Thread safety │ MT-Safe │
           └──────────────────────────────────────┴───────────────┴─────────┘
    


## STANDARDS



           BSD.
    


* * *
# gnutls_x509_crl_verify

## NAME



           gnutls_x509_crl_verify - API function
    


## SYNOPSIS



           **#include <gnutls/x509.h>**
    
           **int gnutls_x509_crl_verify(gnutls_x509_crl_t** _crl_**, const**
           **gnutls_x509_crt_t ***_trusted_cas_**, unsigned** _tcas_size_**, unsigned int**
           _flags_**, unsigned int ***_verify_**);**
    


## ARGUMENTS



           gnutls_x509_crl_t crl
                       is the crl to be verified
    
           const gnutls_x509_crt_t * trusted_cas
                       is a certificate list that is considered to be trusted
                       one
    
           unsigned tcas_size
                       holds the number of CA certificates in CA_list
    
           unsigned int flags
                       Flags that may be used to change the verification
                       algorithm. Use OR of the
                       gnutls_certificate_verify_flags enumerations.
    
           unsigned int * verify
                       will hold the crl verification output.
    


## DESCRIPTION



           This function will try to verify the given crl and return its
           verification status.  See **gnutls_x509_crt_list_verify()** for a
           detailed description of return values. Note that since GnuTLS
           3.1.4 this function includes the time checks.
    
           Note that value in  _verify_ is set only when the return value of
           this function is success (i.e, failure to trust a CRL a
           certificate does not imply a negative return value).
    
           Before GnuTLS 3.5.7 this function would return zero or a positive
           number on success.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0), otherwise a negative error
           value.
    


* * *
# acl_to_text

## NAME



           **acl_to_text** — convert an ACL to text
    


## LIBRARY



           Linux Access Control Lists library (libacl, -lacl).
    


## SYNOPSIS



           <_sys/types.h_ > <_sys/acl.h_ > _char *_ **acl_to_text**(_acl_t acl_ , _ssize_t_
           _*len_p_)
    


## DESCRIPTION



           The **acl_to_text**() function translates the ACL pointed to by the
           argument _acl_ into a **NULL** terminated character string.  If the
           pointer _len_p_ is not **NULL** , then the function returns the length of
           the string (not including the **NULL** terminator) in the location
           pointed to by _len_p_.  The format of the text string returned by
           **acl_to_text**() is the long text form defined in _acl_(5).  The ACL
           referred to by _acl_ is not changed.
    
           This function allocates any memory necessary to contain the string
           and returns a pointer to the string.  The caller should free any
           releasable memory, when the new string is no longer required, by
           calling _acl_free_(3) with the _(void*)char_ returned by **acl_to_text**()
           as an argument.
    


## RETURN VALUE



           On success, this function returns a pointer to the long text form
           of the ACL.  On error, a value of **(char *)NULL** is returned, and
           _errno_ is set appropriately.
    


## ERRORS



           If any of the following conditions occur, the **acl_to_text**()
           function returns a value of **(char *)NULL** and sets _errno_ to the
           corresponding value:
    
           [EINVAL]           The argument _acl_ is not a valid pointer to an
                              ACL.
    
                              The ACL referenced by _acl_ contains one or more
                              improperly formed ACL entries, or for some
                              other reason cannot be translated into a text
                              form of an ACL.
    
           [ENOMEM]           The character string to be returned requires
                              more memory than is allowed by the hardware or
                              system-imposed memory management constraints.
    


## STANDARDS



           IEEE Std 1003.1e draft 17 (“POSIX.1e”, abandoned)
    


* * *
# ausearch_add_regex

## NAME



           ausearch_add_regex - use regular expression search rule
    


## SYNOPSIS



           **#include <auparse.h>**
    
           **int ausearch_add_regex(auparse_state_t ***_au,_**const** _char_***"**_regexp);"_
    


## DESCRIPTION



           ausearch_add_regex adds one search condition based on a regular
           expression to the current audit search expression. The search
           conditions can then be used to scan logs, files, or buffers for
           something of interest. The regular expression follows the posix
           extended regular expression conventions, and is matched against
           the full record (without interpreting field values).
    
           If an existing search expression _E_ is already defined, this
           function replaces it by **(**_E_ **& & **_this_regexp_**)**.
    


## RETURN VALUE



           Returns -1 if an error occurs; otherwise, 0 for success.
    


* * *
# sd_bus_set_close_on_exit

## NAME



           sd_bus_set_close_on_exit, sd_bus_get_close_on_exit - Control
           whether to close the bus connection during the event loop exit
           phase
    


## SYNOPSIS



           **#include <systemd/sd-bus.h>**
    
           **int sd_bus_set_close_on_exit(sd_bus ***_bus_**, int** _b_**);**
    
           **int sd_bus_get_close_on_exit(sd_bus ***_bus_**);**
    


## DESCRIPTION



           **sd_bus_set_close_on_exit()** may be used to enable or disable
           whether the bus connection is automatically flushed (as in
           sd_bus_flush(3)) and closed (as in sd_bus_close(3)) during the
           exit phase of the event loop. This logic only applies to bus
           connections that are attached to an sd-event(3) event loop, see
           sd_bus_attach_event(3). By default, this mechanism is enabled and
           makes sure that any pending messages that have not been written to
           the bus connection are written out when the event loop is shutting
           down. In some cases this behaviour is not desirable, for example
           when the bus connection shall remain usable until after the event
           loop exited. If _b_ is true, the feature is enabled (which is the
           default), otherwise disabled.
    
           **sd_bus_get_close_on_exit()** may be used to query the current
           setting of this feature. It returns zero when the feature is
           disabled, and positive if enabled.
    


## RETURN VALUE



           On success, **sd_bus_set_close_on_exit()** returns a non-negative
           integer. On failure, it returns a negative errno-style error code.
    
           **sd_bus_get_close_on_exit()** returns 0 if the feature is currently
           disabled or a positive integer if it is enabled. On failure, it
           returns a negative errno-style error code.
    
       **Errors**
           Returned errors may indicate the following problems:
    
           **-ECHILD**
               The bus connection was created in a different process, library
               or module instance.
    


## NOTES



           Functions described here are available as a shared library, which
           can be compiled against and linked to with the
           **libsystemd pkg-config**(1) file.
    
           The code described here uses getenv(3), which is declared to be
           not multi-thread-safe. This means that the code calling the
           functions described here must not call setenv(3) from a parallel
           thread. It is recommended to only do calls to **setenv()** from an
           early phase of the program when no other threads have been
           started.
    


* * *
# function::caller_addr

## NAME



           function::caller_addr - Return caller address
    


## SYNOPSIS



               caller_addr:long()
    


## ARGUMENTS



           None
    


## DESCRIPTION



           This function returns the address of the calling function.
    


* * *
# audit_log_user_comm_message

## NAME



           audit_log_user_comm_message - log a user message from a console
           app
    


## SYNOPSIS



           **#include <libaudit.h>**
    
           **int**
           **audit_log_user_comm_message(int** _audit_fd,_**int"**_type,_**const** _char_***"**_message,_**const** _char_***"**_comm,_**const** _char_***"**_hostname,_**const** _char_***"**_addr,_**const** _char_***"**_tty,_**int"**_result);"_
    


## DESCRIPTION



           This function will log a message to the audit system using a
           predefined message format. This function should be used by all
           non-ELF console apps that do not manipulate accounts, groups, or
           need to log execution of a script. An example would be a Python
           script recording an event. The function parameters are as follows:
    
           _audit_fd_ - The fd returned by audit_open
           _type_ - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
           _message_ - the message text being sent
           _comm_ - the program command line name, NULL if unknown
           _hostname_ - the hostname if known, NULL if unknown
           _addr_ - The network address of the user, NULL if unknown
           _tty_ - The tty of the user, if NULL will attempt to figure out
           _result_ - 1 is "success" and 0 is "failed"
    


## RETURN VALUE



           It returns the sequence number which is > 0 on success or <= 0 on
           error.
    


## ERRORS



           This function returns -1 on failure. Examine errno for more info.
    


* * *
# pmdatext

## NAME



           **pmdaText** - extract metric help text for a PMDA
    


## C SYNOPSIS



           **#include <pcp/pmapi.h>**
           **#include <pcp/pmda.h>**
    
           **int pmdaText(int** _ident_**, int** _type_**, char ****_buffer_**, pmdaExt ***_pmda_**);**
    
           **cc ... -lpcp_pmda -lpcp**
    


## DESCRIPTION



           As  part  of  the Performance Metrics Domain Agent (PMDA) API (see
           PMDA(3)), **pmdaText** uses the standard PMDA(3)  data  structures  to
           return  the  help  text for metric _ident_ in _buffer_.  The help text
           must be located in help text files created  with  newhelp(1),  and
           the associated files are automatically opened by pmdaInit(3).
    
           The  path  to  the (basename of the) help text files can be set in
           the calls to pmdaDSO(3) or pmdaDaemon(3) and overridden by the  **-h**
           command line option in pmdaGetOpt(3).
    
           The  encoding  of _ident_ follows the internal scheme used below the
           routines pmLookupText(3) and  pmLookupInDomText(3),  namely  _ident_
           encodes either a metric identifier or an instance domain identifi‐
           er, according to the value of _type_.
    
           The _type_ argument is a bit mask that encodes the interpretation of
           _ident_  and  the  requested  form  of help text, as follows: either
           **PM_TEXT_PMID** if _ident_ is a metric identifier, or **PM_TEXT_INDOM** if
           _ident_  is  an instance domain identifier, plus either **PM_TEXT_ONE‐**
           **LINE** for the one line help text or **PM_TEXT_HELP** for the full  help
           text.
    
           The  _buffer_  is  managed internally (usually it is cached), and it
           should **not** be released or freed by the caller of **pmdaText**.
    


## CAVEAT



           The PMDA must be using **PMDA_INTERFACE_2** or later, as specified  in
           the call to pmdaDSO(3) or pmdaDaemon(3).
    


## DIAGNOSTICS



           If  the  requested  help text could not be obtained, **pmdaText** will
           return **PM_ERR_TEXT**.
    


* * *
# wcspbrk

## PROLOG



           This manual page is part of the POSIX Programmer's Manual.  The
           Linux implementation of this interface may differ (consult the
           corresponding Linux manual page for details of Linux behavior), or
           the interface may not be implemented on Linux.
    


## NAME



           wcspbrk — scan a wide-character string for a wide-character code
    


## SYNOPSIS



           #include <wchar.h>
    
           wchar_t *wcspbrk(const wchar_t *_ws1_ , const wchar_t *_ws2_);
    


## DESCRIPTION



           The functionality described on this reference page is aligned with
           the ISO C standard. Any conflict between the requirements
           described here and the ISO C standard is unintentional. This
           volume of POSIX.1‐2017 defers to the ISO C standard.
    
           The _wcspbrk_() function shall locate the first occurrence in the
           wide-character string pointed to by _ws1_ of any wide-character code
           from the wide-character string pointed to by _ws2_.
    


## RETURN VALUE



           Upon successful completion, _wcspbrk_() shall return a pointer to
           the wide-character code or a null pointer if no wide-character
           code from _ws2_ occurs in _ws1_.
    


## ERRORS



           No errors are defined.
    
           _The following sections are informative._
    


## EXAMPLES



           None.
    


## APPLICATION USAGE



           None.
    


## RATIONALE



           None.
    


## FUTURE DIRECTIONS



           None.
    


* * *
# gnutls_srp_set_client_credentials

## NAME



           gnutls_srp_set_client_credentials - API function
    


## SYNOPSIS



           **#include <gnutls/gnutls.h>**
    
           **int**
           **gnutls_srp_set_client_credentials(gnutls_srp_client_credentials_t**
           _res_**, const char ***_username_**, const char ***_password_**);**
    


## ARGUMENTS



           gnutls_srp_client_credentials_t res
                       is a **gnutls_srp_client_credentials_t** type.
    
           const char * username
                       is the user's userid
    
           const char * password
                       is the user's password
    


## DESCRIPTION



           This function sets the username and password, in a
           **gnutls_srp_client_credentials_t** type.  Those will be used in SRP
           authentication.   _username_ should be an ASCII string or UTF-8
           string. In case of a UTF-8 string it is recommended to be
           following the PRECIS framework for usernames (rfc8265). The
           password can be in ASCII format, or normalized using
           **gnutls_utf8_password_normalize()**.
    


## RETURNS



           On success, **GNUTLS_E_SUCCESS**(0) is returned, or an error code.
    


* * *