.\" -*- 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 "hpi_shell 1"
.TH hpi_shell 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
hpi_shell \- An openhpi sample application that allows a user to interactively perform a number of HPI operations.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& hpi_shell [\-D nn] [\-N host[:port]] [\-C <cfgfile>] [\-e] [\-f <file>] [\-X] [\-h]
\& hpi_shell [\-\-domain=nn] [\-\-host=host[:port]] [\-\-cfgfile=file] [\-\-events] [\-\-cmdfile=filename] [\-\-debug] [\-\-help]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
hpi_shell reads commands and performs HPI operations based on those
commands.  This allows it to exercise HPI-managed hardware and do manual
operations on that hardware.
.PP
Once in hpi_shell, use the "help" command for a list of commands, or
"help command" for details on a particular command.
.PP
If no domain or host is selected, ohparam uses the default domain as specified in the openhpiclient.conf file.
.SH OPTIONS
.IX Header "OPTIONS"
.SS "Help Options:"
.IX Subsection "Help Options:"
.Vb 1
\&  \-h, \-\-help                   Show help options
.Ve
.SS "Application Options:"
.IX Subsection "Application Options:"
.IP "\fB\-f\fR \fIfilename\fR, \fB\-\-cmdfile\fR=\fIfilename\fR" 2
.IX Item "-f filename, --cmdfile=filename"
Execute command file
.IP "\fB\-e\fR, \fB\-\-events\fR" 2
.IX Item "-e, --events"
Show short events, discover after subscribe
.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
\&  hpialarms      hpifan         hpipower       hpithres       
\&  hpidomain      hpigensimdata  hpireset       hpitop         
\&  hpiel          hpiinv         hpisensor      hpitree        
\&  hpievents      hpionIBMblade  hpisettime     hpiwdt
\&  hpixml
\&  ohdomainlist   ohhandler      ohparam
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
Author(s) of this man page:
.PP
.Vb 3
\&  Bryan Sutula (sutula@users.sourceforge.net)
\&  Ulrich Kleber (ulikleber@users.sourceforge.net)
\&  Anton Pak (avpak@users.sourceforge.net)
.Ve