← Back to branch summary

~iheino+ub/+junk/nut-upsconf-docfix

« back to all changes in this revision

Viewing changes to docs/man/nutscan_add_option_to_device.txt

  • Committer: Tuomas Heino
  • Author(s): Laurent Bigonville
  • Date: 2014-04-22 20:46:12 UTC
  • Revision ID: iheino+ub@cc.hut.fi-20140422204612-1x2gh3nkezfsdao4
Tags: upstream-2.7.2
Import upstream version 2.7.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/nutscan_add_option_to_device.txt
 
1
NUTSCAN_ADD_OPTION_TO_DEVICE(3)
 
2
===============================
 
3
 
 
4
NAME
 
5
----
 
6
 
 
7
nutscan_add_option_to_device - Add option data to the specified device.
 
8
 
 
9
SYNOPSIS
 
10
--------
 
11
 
 
12
 #include <nut-scan.h>
 
13
 
 
14
 void nutscan_add_option_to_device(nutscan_device_t * device,char * option_name, char * value);
 
15
 
 
16
 
 
17
DESCRIPTION
 
18
-----------
 
19
 
 
20
The `nutscan_device_t` contains the following variables:
 
21
 
 
22
        nutscan_device_type_t   type;
 
23
        char *          driver;
 
24
        char *          port;
 
25
        nutscan_options_t       opt;
 
26
        struct nutscan_device * prev;
 
27
        struct nutscan_device * next;
 
28
 
 
29
This is a double linked list of device. Each device is described by its `type`, its `driver` name, its `port` and any number of optional data.
 
30
 
 
31
The *nutscan_add_option_to_device()* adds an optional data in the given devcie. Optional data are made of an 'option_name' and an associated 'value'. Copies of 'option_name' and 'value' are stored in the device, so the caller can safely free both of them.
 
32
 
 
33
SEE ALSO
 
34
--------
 
35
linkman:nutscan_scan_usb[3], linkman:nutscan_scan_xml_http[3], 
 
36
linkman:nutscan_scan_nut[3], linkman:nutscan_scan_avahi[3], 
 
37
linkman:nutscan_scan_ipmi[3], linkman:nutscan_scan_snmp[3],
 
38
linkman:nutscan_display_ups_conf[3], linkman:nutscan_display_parsable[3],
 
39
linkman:nutscan_new_device[3], linkman:nutscan_free_device[3],
 
40
linkman:nutscan_add_device_to_device[3]