.\" -*- 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 "ohdomainlist 1"
.TH ohdomainlist 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
ohdomainlist \- A openhpi sample application that shows information about domains on the
level of the openhpi base library.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& hpidomain [\-h \-V \-X]
\& hpidomain [\-\-help] [\-\-verbose] [\-\-debug]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
ohdomainlist displays the list of domains known to the openhpi base library.
In verbose mode, it displays more information about those domains.
Clients can only access domains known to the library.
.PP
Please note that ohdomainlist can only display the domains defined in the 
openhpiclient.conf file as specified in the OPENHPICLIEN_CONF environment 
variable.
Dynamic changes of the domain list done using the oHpiDomainAdd and oHpiDomainAddById
API are valid only for the life-time of the client library.
.PP
If no domain or host is selected, ohdomainlist lists the domains 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\-D\fR, \fB\-\-domain\fR=\fInn\fR" 2
.IX Item "-D, --domain=nn"
Select domain id nn
.IP "\fB\-X\fR, \fB\-\-debug\fR" 2
.IX Item "-X, --debug"
Display debug messages
.IP "\fB\-V\fR, \fB\-\-verbose\fR" 2
.IX Item "-V, --verbose"
Verbose mode
.IP "\fB\-N\fR, \fB\-\-host\fR=\fI""host[:port]""\fR" 2
.IX Item "-N, --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.
.IP "\fB\-C\fR, \fB\-\-cfgfile\fR=\fI""file""\fR" 2
.IX Item "-C, --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 7
\&         hpi_shell
\&         hpialarms      hpifan         hpipower       hpithres
\&         hpidomain      hpigensimdata  hpireset       hpitop
\&         hpiel          hpiiinv        hpisensor      hpitree
\&         hpievents      hpionIBMblade  hpisettime     hpiwdt
\&         hpixml
\&         ohhandler      ohparam
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
Authors of this man page:
.PP
.Vb 2
\& Ulrich Kleber (ulikleber@users.sourceforge.net)
\& Anton Pak (avpak@users.sourceforge.net)
.Ve