.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "hpiel 1" .TH hpiel 1 "2018-09-13" "3.8.0" "OpenHPI" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" hpiel \- An openhpi sample application that displays HPI event log entries. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& hpiel [\-D nn] [\-N host[:port]] [\-C ] [\-d] [\-E entity\-path] [\-c \-p \-r \-X \-h ] \& hpiel [\-\-domain=nn] [\-\-host=host[:port]] [\-\-cfgfile=file] \& [\-\-del] [\-\-entity\-path="entitypath"] [\-\-clear \-\-resource \-\-rdr \-\-debug \-\-help] .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" hpiel searches the \s-1RPT\s0 (Resource Present Table) for resources with \s-1SAHPI_CAPABILITY_EVENT_LOG\s0 and displays event log entries for resources found. .PP If no domain is selected, hpiel uses a session with the default domain. The selected domain id must be configured via the openhpidclient.conf file specified in the environment. .SH "OPTIONS" .IX Header "OPTIONS" .SS "Help Options:" .IX Subsection "Help Options:" .IP "\fB\-h\fR, \fB\-\-help\fR" 2 .IX Item "-h, --help" Show help options .SS "Application Options:" .IX Subsection "Application Options:" .IP "\fB\-d\fR, \fB\-\-del\fR" 2 .IX Item "-d, --del" Display domain event log entries .IP "\fB\-c\fR, \fB\-\-clear\fR" 2 .IX Item "-c, --clear" Clear log before reading event log entries .IP "\fB\-p\fR, \fB\-\-resource\fR" 2 .IX Item "-p, --resource" Pull resource info along with log entry .IP "\fB\-r\fR, \fB\-\-rdr\fR" 2 .IX Item "-r, --rdr" Pull \s-1RDR\s0 info along with log entry .ie n .IP "\fB\-E\fR \fI""epath""\fR, \fB\-\-entity\-path\fR=\fI""epath""\fR" 2 .el .IP "\fB\-E\fR \fI``epath''\fR, \fB\-\-entity\-path\fR=\fI``epath''\fR" 2 .IX Item "-E epath, --entity-path=epath" Use entity path epath and display resource .IP "\fB\-D\fR \fInn\fR, \fB\-\-domain\fR=\fInn\fR" 2 .IX Item "-D nn, --domain=nn" Select domain id \fInn\fR .IP "\fB\-X\fR, \fB\-\-debug\fR" 2 .IX Item "-X, --debug" Display debug messages .ie n .IP "\fB\-N\fR \fI""host[:port]""\fR, \fB\-\-host\fR=\fI""host[:port]""\fR" 2 .el .IP "\fB\-N\fR \fI``host[:port]''\fR, \fB\-\-host\fR=\fI``host[:port]''\fR" 2 .IX Item "-N host[:port], --host=host[:port]" Open session to the domain served by the daemon at the specified \s-1URL\s0 (host:port). This option overrides the \s-1OPENHPI_DAEMON_HOST\s0 and \s-1OPENHPI_DAEMON_PORT\s0 environment variables. If host contains ':' (for example IPv6 address) then enclose it in square brackets. For example: \fI\*(L"[::1]\*(R"\fR or \fI\*(L"[::1]:4743\*(R"\fR. .ie n .IP "\fB\-C\fR \fI""file""\fR, \fB\-\-cfgfile\fR=\fI""file""\fR" 2 .el .IP "\fB\-C\fR \fI``file''\fR, \fB\-\-cfgfile\fR=\fI``file''\fR" 2 .IX Item "-C file, --cfgfile=file" Use passed file as client configuration file. This option overrides the \s-1OPENHPICLIENT_CONF\s0 environment variable. .PP If neither \fB\-d\fR or \fB\-E\fR \fI\*(L"epath\*(R"\fR are specified, event log entries will be shown for all supporting resources by default. .SH "HPI APIs uniquely used in this application" .IX Header "HPI APIs uniquely used in this application" .RS 2 SaErrorT \s-1SAHPI_API\s0 saHpiEventLogInfoGet ( \s-1SAHPI_IN\s0 SaHpiSessionIdT SessionId, \s-1SAHPI_IN\s0 SaHpiResourceIdT ResourceId, \s-1SAHPI_OUT\s0 SaHpiEventLogInfoT *Info ); .Sp SaErrorT \s-1SAHPI_API\s0 saHpiEventLogEntryGet ( \s-1SAHPI_IN\s0 SaHpiSessionIdT SessionId, \s-1SAHPI_IN\s0 SaHpiResourceIdT ResourceId, \s-1SAHPI_IN\s0 SaHpiEventLogEntryIdT EntryId, \s-1SAHPI_OUT\s0 SaHpiEventLogEntryIdT *PrevEntryId, \s-1SAHPI_OUT\s0 SaHpiEventLogEntryIdT *NextEntryId, \s-1SAHPI_OUT\s0 SaHpiEventLogEntryT *EventLogEntry, \s-1SAHPI_INOUT\s0 SaHpiRdrT *Rdr, \s-1SAHPI_INOUT\s0 SaHpiRptEntryT *RptEntry ); .Sp SaErrorT \s-1SAHPI_API\s0 saHpiEventLogClear ( \s-1SAHPI_IN\s0 SaHpiSessionIdT SessionId, \s-1SAHPI_IN\s0 SaHpiResourceIdT ResourceId ); .RE .SH "SEE ALSO" .IX Header "SEE ALSO" .Vb 6 \& hpi_shell \& hpialarms hpigensimdata hpireset hpitop \& hpidomain hpiinv hpisensor hpitree \& hpievents hpionIBMblade hpisettime hpiwdt \& hpifan hpipower hpithres hpixml \& ohdomainlist ohhandler ohparam .Ve .SH "AUTHORS" .IX Header "AUTHORS" Authors of this man page: .PP .Vb 3 \& Peter D Phan (pdphan@users.sourceforge.net) \& Ulrich Kleber (ulikleber@users.sourceforge.net) \& Anton Pak (avpak@users.sourceforge.net) .Ve