debian man page for libnuclient

LIBNUCLIENT(3)															    LIBNUCLIENT(3)

NAME
       libnuclient - NUFW client authentication library

SYNOPSIS
       #include <nuclient.h>

       NuAuth  * nu_client_init (const char *nptr,  char *username,  unsigned long userid,  char * password,  char * hostname,	unsigned int port,
       char protocol,  char ssl_on);

       int nu_client_check (NuAuth * session);

       void nu_client_free (NuAuth *session);

DESCRIPTION
       This manual page documents the libnuclient library.

       Use nu_client_init to initialize a authentication session. Then call nu_client_check at regular interval to send authentication	packet	to
       the gateway (if needed). When you're finished, call nu_client_free to free the session.

       Original packaging and informations and help can be found from http://www.nufw.org/

RETURN VALUE
       nu_client_init returns an authentication session usable by nu_client_check or nu_client_free.

       nu_client_check	returns  the  number  of  packets authenticated to the nuauth server during the call. It returns -1 if an error occur when
       sending authentication packet. Applications MUST considered that the session is unusable when they receive this error.

ERRORS
       nu_client_init return NULL it a problem occur during initiation

SEE ALSO
       nuauth(8)

AUTHOR
       Nufw was designed and coded by Eric Leblond, aka Regit (<regit@inl.fr>) , and Vincent Deffontaines, aka gryzor (<vincent@inl.fr>). Original
       idea in 2001, while working on NSM Ldap support.

       This manual page was written by Eric Leblond

       Permission  is  granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 2 as
       published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts.

								   12 mars 2007 						    LIBNUCLIENT(3)