.\" -*- 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 "hpitop 1"
.TH hpitop 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
hpitop \- A openhpi sample application that displays highlevel topology for a managed openHPI complex.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\& hpitop [\-D nn] [\-N host[:port]] [\-C <cfgfile>] [\-rscwiafd] [\-n nn] [\-X] [\-h]
\& hpitop [\-\-domain=nn] [\-\-host=host[:port]] [\-\-cfgfile=file] [\-\-rpts] [\-\-sensors]
\&        [\-\-controls] [\-\-watchdogs] [\-\-inventories] [\-\-annunciators] [\-\-fumis] [\-\-dimis] 
\&        [\-\-resource=nn] [\-\-debug] [\-\-help]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
hpitop walks the Resource Present Table (RPT) of the managed openHPI complex and displays all the resources and resources' management instruments.
.PP
If no domain or host is selected, hpitop uses the default domain as specified in the openhpiclient.conf file.
.SH OPTIONS
.IX Header "OPTIONS"
(No Option) Display system topology via default domain: rpt & rdr headers
.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\-r\fR, \fB\-\-rpts\fR" 2
.IX Item "-r, --rpts"
Display only rpts
.IP "\fB\-s\fR, \fB\-\-sensors\fR" 2
.IX Item "-s, --sensors"
Display only sensors
.IP "\fB\-c\fR, \fB\-\-controls\fR" 2
.IX Item "-c, --controls"
Display only controls
.IP "\fB\-w\fR, \fB\-\-watchdogs\fR" 2
.IX Item "-w, --watchdogs"
Display only watchdogs
.IP "\fB\-i\fR, \fB\-\-inventories\fR" 2
.IX Item "-i, --inventories"
Display only inventories
.IP "\fB\-a\fR, \fB\-\-annunciators\fR" 2
.IX Item "-a, --annunciators"
Display only annunciators
.IP "\fB\-f\fR, \fB\-\-fumis\fR" 2
.IX Item "-f, --fumis"
Display only fumis
.IP "\fB\-d\fR, \fB\-\-dimis\fR" 2
.IX Item "-d, --dimis"
Display only dimis
.IP "\fB\-n\fR \fInn\fR, \fB\-\-resource\fR=\fInn\fR" 2
.IX Item "-n nn, --resource=nn"
Display only resource \fInn\fR and its topology
.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 "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 6
\&         hpi_shell
\&         hpialarms      hpifan         hpipower       hpithres
\&         hpidomain      hpigensimdata  hpireset       hpitree
\&         hpiel          hpiiinv        hpisensor      hpiwdt
\&         hpievents      hpionIBMblade  hpisettime     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