54 lines
2.5 KiB
Groff
54 lines
2.5 KiB
Groff
'\" t
|
|
.\" Title: nutscan_scan_avahi
|
|
.\" 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 "NUTSCAN_SCAN_AVAHI" "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"
|
|
nutscan_scan_avahi \- Scan network for NUT services via mDNS
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
#include <nut\-scan\&.h>
|
|
.fi
|
|
.sp
|
|
.nf
|
|
nutscan_device_t * nutscan_scan_avahi(long usec_timeout);
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
The \fBnutscan_scan_avahi()\fR function tries to detect the NUT service via mDNS, and its associated devices\&. It uses the Avahi library to do so\&.
|
|
.sp
|
|
You MUST call \fBnutscan_init\fR(3) before using this function\&.
|
|
.sp
|
|
This function waits up to \fIusec_timeout\fR microseconds before considering an IP address to be unresponsive\&.
|
|
.SH "RETURN VALUE"
|
|
.sp
|
|
The \fBnutscan_scan_avahi()\fR function returns a pointer to a nutscan_device_t structure containing all found devices\&. It returns NULL if an error occurs, or if no device is found\&.
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBnutscan_init\fR(3), \fBnutscan_scan_usb\fR(3), \fBnutscan_scan_xml_http\fR(3), \fBnutscan_scan_nut\fR(3), \fBnutscan_scan_snmp\fR(3), \fBnutscan_scan_ipmi\fR(3), \fBnutscan_display_ups_conf\fR(3), \fBnutscan_display_parsable\fR(3), \fBnutscan_new_device\fR(3), \fBnutscan_free_device\fR(3), \fBnutscan_add_option_to_device\fR(3), \fBnutscan_add_device_to_device\fR(3), \fBnutscan_cidr_to_ip\fR(3), \fBnutscan_scan_eaton_serial\fR(3), http://avahi\&.org/
|