2011-09-29 18:14:46 +00:00
'\" t
. \" Title: nutscan_scan_usb
. \" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
2013-11-24 15:00:12 +00:00
. \" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
. \" Date: 09/13/2013
2011-09-29 18:14:46 +00:00
. \" Manual: NUT Manual
2013-11-24 15:00:12 +00:00
. \" Source: Network UPS Tools 2.7.1-pre1
2011-09-29 18:14:46 +00:00
. \" Language: English
. \"
2013-11-24 15:00:12 +00:00
.TH "NUTSCAN_SCAN_USB" "3" "09/13/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
2011-09-29 18:14:46 +00:00
. \" -----------------------------------------------------------------
. \" * 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_usb \- Scan NUT compatible USB devices\& .
.SH "SYNOPSIS"
.sp
.nf
#include <nut\- scan\& .h>
.fi
.sp
.nf
nutscan_device_t * nutscan_scan_usb();
.fi
.SH "DESCRIPTION"
.sp
The \fB nutscan_scan_usb()\fR function try to detect NUT compatible USB devices\& .
2012-01-24 10:22:33 +00:00
.sp
You MUST call \fB nutscan_init\fR (3) before using this function\& .
2011-09-29 18:14:46 +00:00
.SH "RETURN VALUE"
.sp
The \fB nutscan_scan_usb()\fR function returns a pointer to a nutscan_device_t structure containing all found devices or NULL if an error occurs or no device is found\& .
.SH "SEE ALSO"
.sp
2013-11-24 15:00:12 +00:00
\fB nutscan_init\fR (3), \fB nutscan_scan_snmp\fR (3), \fB nutscan_scan_xml_http\fR (3), \fB nutscan_scan_nut\fR (3), \fB nutscan_scan_avahi\fR (3), \fB nutscan_scan_ipmi\fR (3), \fB nutscan_display_ups_conf\fR (3), \fB nutscan_display_parsable\fR (3), \fB nutscan_new_device\fR (3), \fB nutscan_free_device\fR (3), \fB nutscan_add_option_to_device\fR (3), \fB nutscan_add_device_to_device\fR (3), \fB nutscan_scan_eaton_serial\fR (3)