.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "hpiel 1"
.TH hpiel 1 2024-03-21 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 <cfgfile>] [\-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 RPT (Resource Present Table) for resources with SAHPI_CAPABILITY_EVENT_LOG 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 RDR info along with log entry
.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
.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 URL (host:port).
This option overrides the OPENHPI_DAEMON_HOST and OPENHPI_DAEMON_PORT environment variables.
If host contains ':' (for example IPv6 address) then enclose it in square brackets.
For example: \fI"[::1]"\fR or \fI"[::1]:4743"\fR.
.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 OPENHPICLIENT_CONF environment variable.
.PP
If neither \fB\-d\fR or \fB\-E\fR \fI"epath"\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 SAHPI_API saHpiEventLogInfoGet (
    SAHPI_IN  SaHpiSessionIdT     SessionId,
    SAHPI_IN  SaHpiResourceIdT    ResourceId,
    SAHPI_OUT SaHpiEventLogInfoT  *Info
);
.Sp
SaErrorT SAHPI_API saHpiEventLogEntryGet (
    SAHPI_IN    SaHpiSessionIdT          SessionId,
    SAHPI_IN    SaHpiResourceIdT         ResourceId,
    SAHPI_IN    SaHpiEventLogEntryIdT    EntryId,
    SAHPI_OUT   SaHpiEventLogEntryIdT    *PrevEntryId,
    SAHPI_OUT   SaHpiEventLogEntryIdT    *NextEntryId,
    SAHPI_OUT   SaHpiEventLogEntryT      *EventLogEntry,
    SAHPI_INOUT SaHpiRdrT                *Rdr,
    SAHPI_INOUT SaHpiRptEntryT           *RptEntry
);
.Sp
SaErrorT SAHPI_API saHpiEventLogClear (
    SAHPI_IN  SaHpiSessionIdT     SessionId,
    SAHPI_IN  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