File: libfreeipmi.3.pre.in

package info (click to toggle)
freeipmi 1.4.11-1.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 21,952 kB
  • ctags: 18,990
  • sloc: ansic: 299,490; sh: 11,087; makefile: 1,958; perl: 1,078
file content (131 lines) | stat: -rw-r--r-- 4,345 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
.TH LIBFREEIPMI 3 "@ISODATE" "libfreeipmi @PACKAGE_VERSION@" "LIBFREEIPMI"
.SH "NAME"
libfreeipmi - FreeIPMI library
.SH "Introduction"
Libfreeipmi is the primary library that most of the FreeIPMI tools are based
upon.  The following describe the sub-sections of the library.
.TP
.B api
The highest level API provided by libfreeipmi.  It abstracts away the
details of inband and outofband protocols from the user.  It also
provides useful error codes for the user to easily interpret IPMI
problems.  'api' is used by most FreeIPMI tools and libraries, such as
.B bmc-info(8),
.B ipmi-sensors(8), 
and 
.B libipmimonitoring(3).
.TP
.B cmds
Provides fiid templates and 'fill' functions for IPMI
commands.  Also provides macros definining common parameters for
IPMI commands.  The cmds are used by most other portions of
libfreeipmi including the 'api' sub-section and tools such as
.B ipmipower(8) 
and 
.B ipmiconsole(8).
.TP
.B debug
Provides various packet/record dumping utility functions.
Utilized by the 'api' subsection and by tools such as 
.B ipmipower(8) 
and
.B ipmiconsole(8).
.TP
.B driver
Provides APIs for in-band IPMI communication.  Currently supported
drivers are KCS, SSIF, OpenIPMI, and SUNBMC.  The 'driver' subsction
is used by tools such as
.B bmc-watchdog(8) 
and the 'api' sub-section.
.TP
.B fiid
The "FreeIPMI Interface Definition" provides an API used for
the construction/deconstruction of packets in libfreeipmi.  The API
works around fiid-templates, which are then used to create
fiid-objects.  Fiid-templates are used to describe packets through
a string-name to bit-field mapping.  The API allows users to
read/write fields in an object using the string to bit-field
mapping.  Marshalling, packing, endian, and various other network
issues are handled within 'fiid'.  Fiid objects are used throughout
libfreeipmi, including the 'api' sub-section, 'cmds' sub-sections,
and various tools.
.TP
.B fru-parse
Provides an API for parsing Field Replaceable Unit (FRU) records.
Utilized by tools such as ipmi-fru(8).
.TP
.B interface
Provides 'assemble' and 'disassemble' functions for building packets
for individual in-band or out-of-band protocols.  Also provides all
necessary fiid templates, 'fill' functions, and other utility
functions necessary to communicate on an IPMI interface.  Utilized by
the 'api' sub-section and tools such as 
.B ipmipower(8) and 
.B ipmiconsole(8).
.TP
.B interpret
Provides an API for interpreting sensor events by mapping them into
Nominal, Warning, or Critical states.  Utilized by FreeIPMI tools and
libraries such as
.B ipmi-sensors(8)
and
.B libipmimonitoring(3).
.TP
.B locate
Provides an API to probe several standards to find default values for
in-band IPMI communication.  Utilized by the 'api' sub-section and the
.B ipmi-locate(8) 
tool.
.TP
.B record-format
Provides macros, fiid-templates, and information on records used in
IPMI.  Utilized by the 'sdr-cache' subsection and tools like 
.B ipmi-sensors(8).
.TP
.B sdr-cache
Provides an API for creating, caching, reading, and parsing a sensor
data repository (SDR).  Utilized by tools such as
.B ipmi-fru(8)
and
.B ipmi-sensors(8).
.TP
.B sdr-parse
Provides an API for parsing SDR records.  Utilized by tools such as
.B ipmi-fru(8)
and
.B ipmi-sensors(8)
.TP
.B sel-parse
Provides an API for reading and parsing System Event Log (SEL) entries.
Utilized by tools such as 
.B ipmi-sel(8).
.TP
.B sensor-read
Provides an API for reading a sensor.  Utilized by tools such as
.B ipmi-sensors(8).
.TP
.B spec
Provides macros and arrays for various other definitions and tables in
IPMI.  Utilized by tools such as 
.B ipmi-sensors(8).
.TP
.B util
Provides various utility functions for the calculation of keys, sensor
readings, etc.  Utilized by most of the rest of FreeIPMI.

.SH "FILES"
/usr/include/freeipmi.h
.PP
/usr/include/freeipmi/

.SH "COPYRIGHT"
Copyright \(co 2003-2014 FreeIPMI Core Team.  
#include <@top_srcdir@/man/manpage-common-gpl-library-text.man>

.SH "SEE ALSO"
libipmiconsole(3), libipmidetect(3), libipmimonitoring(3),
freeipmi(7), bmc-info(8), bmc-watchdog(8), ipmi-chassis(8),
ipmi-config(8), ipmi-fru(8), ipmi-locate(8), ipmi-oem(8), ipmi-raw(8),
ipmi-sel(8), ipmi-sensors(8), ipmiconsole(8), ipmidetect(8),
ipmiping(8), ipmipower(8), rmcpping(8)
#include <@top_srcdir@/man/manpage-common-homepage.man>