72 lines
2.8 KiB
Groff
72 lines
2.8 KiB
Groff
|
'\" t
|
||
|
|
.\" Title: libnutclient_misc
|
||
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
||
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
||
|
|
.\" Date: 09/13/2013
|
||
|
|
.\" Manual: NUT Manual
|
||
|
|
.\" Source: Network UPS Tools 2.7.1-pre1
|
||
|
|
.\" Language: English
|
||
|
|
.\"
|
||
|
|
.TH "LIBNUTCLIENT_MISC" "3" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * Define some portability stuff
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.\" http://bugs.debian.org/507673
|
||
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * set default formatting
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" disable hyphenation
|
||
|
|
.nh
|
||
|
|
.\" disable justification (adjust text to left margin only)
|
||
|
|
.ad l
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * MAIN CONTENT STARTS HERE *
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.SH "NAME"
|
||
|
|
libnutclient_misc, nutclient_authenticate, nutclient_logout, nutclient_device_login, nutclient_get_device_num_logins, nutclient_device_master, nutclient_device_forced_shutdown \- Miscelaneous functions in Network UPS Tools high\-level client access library
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
#include <nutclient\&.h>
|
||
|
|
.fi
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
typedef void* NUTCLIENT_t;
|
||
|
|
.fi
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
void nutclient_authenticate(NUTCLIENT_t client, const char* login, const char* passwd);
|
||
|
|
void nutclient_logout(NUTCLIENT_t client);
|
||
|
|
void nutclient_device_login(NUTCLIENT_t client, const char* dev);
|
||
|
|
int nutclient_get_device_num_logins(NUTCLIENT_t client, const char* dev);
|
||
|
|
void nutclient_device_master(NUTCLIENT_t client, const char* dev);
|
||
|
|
void nutclient_device_forced_shutdown(NUTCLIENT_t client, const char* dev);
|
||
|
|
.fi
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.sp
|
||
|
|
The \fBnutclient_authenticate()\fR function authenticate the user\&.
|
||
|
|
.sp
|
||
|
|
\fIlogin\fR is the user name\&.
|
||
|
|
.sp
|
||
|
|
\fIpasswd\fR is the user password\&.
|
||
|
|
.sp
|
||
|
|
The \fBnutclient_logout()\fR function disconnect gracefully from the server\&.
|
||
|
|
.sp
|
||
|
|
The \fBnutclient_device_login()\fR function log the fact that a system is drawing power from this UPS\&.
|
||
|
|
.sp
|
||
|
|
The \fBnutclient_get_device_num_logins()\fR function retrieve the number of clients which have been logged for this device\&.
|
||
|
|
.sp
|
||
|
|
The \fBnutclient_device_master()\fR function make sure that master\-level functions like FSD are available if necessary\&.
|
||
|
|
.sp
|
||
|
|
The \fBnutclient_device_forced_shutdown()\fR function sets the "forced shutdown" flag on the device\&.
|
||
|
|
.sp
|
||
|
|
\fIdev\fR is the device name\&.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.sp
|
||
|
|
\fBlibnutclient\fR(3)
|