.\" -*- 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 "hpievents 1"
.TH hpievents 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
hpievents \- An openhpi sample application that polls for events.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& hpievents [ \-D <value> ] [\-N host[:port]] [\-C <cfgfile>] [ \-t BLOCK|SAHPI_TIMEOUT_BLOCK|n ] [ \-d \-X \-h ]
\& hpievents [\-\-domain=nn] [\-\-host=host[:port]] [\-\-cfgfile=file]
\&           [\-\-timeout=BLOCK|SAHPI_TIMEOUT_BLOCK|n ] [\-\-discover] [\-\-debug] [\-\-help]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
hpievents polls for events in an opened HPI session.  User can specify wait time for the event. User can also select the order between hpi resource (resource event) discovery and hpi event subscription.
.PP
If no domain or host is selected, hpievents polls for events in the default domain as specified in the openhpiclient.conf file.
.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\-t\fR \fIn|BLOCK\fR, \fB\-\-timeout\fR=\fIn|BLOCK\fR" 2
.IX Item "-t n|BLOCK, --timeout=n|BLOCK"
Wait \fIn\fR seconds for event or infinite wait (\fIBLOCK\fR)
.IP "\fB\-d\fR, \fB\-\-discover\fR" 2
.IX Item "-d, --discover"
Call \fBsaHpiDiscover()\fR after \fBsaHpiSubscribe()\fR
.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.
.SH "HPI APIs uniquely used in this application"
.IX Header "HPI APIs uniquely used in this application"
.RS 2
SaErrorT SAHPI_API saHpiSubscribe (
    SAHPI_IN SaHpiSessionIdT      SessionId
);
.Sp
SaErrorT SAHPI_API saHpiUnsubscribe (
    SAHPI_IN SaHpiSessionIdT  SessionId
);
.Sp
SaErrorT SAHPI_API saHpiEventGet (
    SAHPI_IN SaHpiSessionIdT            SessionId,
    SAHPI_IN SaHpiTimeoutT              Timeout,
    SAHPI_OUT SaHpiEventT               *Event,
    SAHPI_INOUT SaHpiRdrT               *Rdr,
    SAHPI_INOUT SaHpiRptEntryT          *RptEntry,
    SAHPI_INOUT SaHpiEvtQueueStatusT    *EventQueueStatus
);
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 6
\&         hpi_shell
\&         hpialarms      hpigensimdata  hpireset       hpitop
\&         hpidomain      hpiinv         hpisensor      hpitree
\&         hpiel          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