.\" -*- 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 "hpialarms 1"
.TH hpialarms 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
hpialarms \- A openhpi sample application that shows "Alarm Control" management instruments
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\& hpialarms [\-D id] [\-N host[:port]] [\-C <cfgfile>]
\&           [\-a 1|0][\-b 1|0][\-c 1|0][\-m 1|0][\-n 1|0][\-p 1|0][\-i n][\-o][\-X][\-h]
\& hpialarms [\-\-domain=id] [\-\-host=host[:port]] [\-\-cfgfile=file] 
\&           [\-\-diska=1|0] [\-\-diskb=1|0] [\-\-critical=1|0] [\-\-major=1|0]
\&           [\-\-minor=1|0] [\-\-power=1|0] [\-\-chassisid=n] [\-\-all] [\-\-debug] [\-\-help]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
hpialarms walks the RPT (Resource Presence Table) for resources that have 
"Alarm Control" management instruments (SAHPI_CTRL_LED).
.PP
If no domain or host is selected, hpialarms uses the default domain as specified in the openhpiclient.conf file.
.SH OPTIONS
.IX Header "OPTIONS"
(No Option) Display alarm states
.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\-c\fR \fI1|0\fR, \-\fB\-critical\fR=\fI1|0\fR" 2
.IX Item "-c 1|0, --critical=1|0"
Set critical alarm on|off
.IP "\fB\-m\fR \fI1|0\fR, \-\fB\-major\fR=\fI1|0\fR" 2
.IX Item "-m 1|0, --major=1|0"
Set major alarm on|off
.IP "\fB\-n\fR \fI1|0\fR, \-\fB\-minor\fR=\fI1|0\fR" 2
.IX Item "-n 1|0, --minor=1|0"
Set minor alarm on|off
.IP "\fB\-a\fR \fI1|0\fR, \-\fB\-diska\fR=\fI1|0\fR" 2
.IX Item "-a 1|0, --diska=1|0"
Set diska alarm on|off
.IP "\fB\-b\fR \fI1|0\fR, \-\fB\-diskb\fR=\fI1|0\fR" 2
.IX Item "-b 1|0, --diskb=1|0"
Set diskb alarm on|off
.IP "\fB\-p\fR \fI1|0\fR, \-\fB\-power\fR=\fI1|0\fR" 2
.IX Item "-p 1|0, --power=1|0"
Set power alarm on|off
.IP "\fB\-i\fR \fIn\fR, \-\fB\-chassisid\fR=\fIn\fR" 2
.IX Item "-i n, --chassisid=n"
Set chassis id on for \fIn\fR seconds
.IP "\fB\-o\fR, \-\fB\-all\fR" 2
.IX Item "-o, --all"
Set all alarms off
.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 "SAMPLE OUTPUT"
.IX Header "SAMPLE OUTPUT"
.Vb 9
\& hpialarmpanel ver 0.6
\& RptInfo: UpdateCount = 5, UpdateTime = 8a2dc6c0
\& rptentry[0] resourceid=1 tag: Mullins
\& RDR[45]: ctltype=2:1 oem=0  Chassis Identify Control
\& RDR[48]: ctltype=0:1 oem=10 Front Panel Power Alarm LED         state = off
\& RDR[51]: ctltype=0:1 oem=13 Front Panel Minor Alarm LED         state = ON
\& RDR[46]: ctltype=0:0 oem=0  Cold Reset Control
\& RDR[49]: ctltype=0:1 oem=11 Front Panel Critical Alarm LED      state = off
\& RDR[50]: ctltype=0:1 oem=12 Front Panel Major Alarm LED         state = off
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 6
\&         hpi_shell
\&         hpidomain      hpigensimdata  hpireset       hpitop
\&         hpiel          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