66 lines
2.8 KiB
Groff
66 lines
2.8 KiB
Groff
'\" t
|
|
.\" Title: libnutclient_commands
|
|
.\" 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_COMMAND" "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_commands, nutclient_get_device_commands, nutclient_has_device_command, nutclient_get_device_command_description, nutclient_execute_device_command \- Instant command related 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
|
|
strarr nutclient_get_device_commands(NUTCLIENT_t client, const char* dev);
|
|
int nutclient_has_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
|
|
char* nutclient_get_device_command_description(NUTCLIENT_t client, const char* dev, const char* cmd);
|
|
void nutclient_execute_device_command(NUTCLIENT_t client, const char* dev, const char* cmd);
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
These functions allow to manage instant commands of devices\&.
|
|
.sp
|
|
The \fBnutclient_get_device_commands()\fR function retrieve the list of command names for a device\&. The returned strarr must be freed by \fIstrarr_free\fR\&.
|
|
.sp
|
|
The \fBnutclient_has_device_command\fR function test if the specified command is supported by the device\&. Return 1 is supported and 0 if not\&.
|
|
.sp
|
|
The \fBnutclient_get_device_command_description\fR function retrieve the command description, if any\&. The resturned string must be freed\&.
|
|
.sp
|
|
The \fBnutclient_execute_device_command\fR intend to execute the instant command\&.
|
|
.sp
|
|
\fIdev\fR is the device name\&.
|
|
.sp
|
|
\fIcmd\fR is the instant command name\&.
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBlibnutclient\fR(3) \fBlibnutclient_devices\fR(3) \fBlibnutclient_general\fR(3)
|