evmchannel.conf.4 (2010 09)

e
evmchannel.conf(4) evmchannel.conf(4)
name ch_name
Specifies a name to be associated with the event channel. The name can include any print-
able character.
events evt_class
The class of events associated with this channel. The evt_class is a dot delimited field with
the same syntax as an
event name.
When
evmshow is run with the -d
or -x option, it must find an event channel matching
each event it receives, so that it can determine which channel function to run. The program
scans the evt_class value of each configured channel in turn, in the order in which they
appear in the configuration file, searching for a class that exactly matches the first few com-
ponents of the event’s name. It stops searching when it finds the first matching channel, and
does not attempt to find a better match.
If a star (
*) is supplied as the evt_class the channel is regarded as the default channel,
meaning that its functions will be invoked to provide details and explanations for any events
whose names do not match the evt_class for any other channel. The default channel should
be specified as the last channel in the file, since no further searching takes place once this
channel has been found.
fn_get get_function [arguments]
The get_function parameter identifies an executable program that is invoked by the evmget
server program each time evmget is run. The server executes get_function for each chan-
nel in turn, in the order in which the channels appear in the configuration file. If the
fn_get keyword is omitted from a channel definition, no events are retrieved for that chan-
nel.
A get_function program must return a stream of zero or more EVM events to its
stdout
,
directing any error messages to
stderr for display on evmget’s error stream. The pro-
gram is executed as specified in the configuration line, including any arguments, but must
accept an optional -f option and a filter string as trailing arguments. If a filter is supplied,
the program must return only events that match the filter. See EvmFilter (5) for more infor-
mation about filters.
fn_details details_function
[arguments ]
When evmshow is invoked with the -d option, for each event it receives it searches the
configured channels for one whose evt_class matches the event’s name, and then executes
the program defined as the channel’s details_function. The program should output lines of
text giving a detailed view of the contents of the event.
If the
fn_details keyword is omitted from a channel definition, evmshow -d produces a
formatted dump of any events it receives that belong to the channel.
A details_function program must accept EVM events on
stdin, and output text to stdout.
Error messages must be directed to
stderr, for display on evmshow’s error stream. The
program is executed as specified on the configuration line, including any arguments.
fn_explain explain_function
When evmshow is invoked with the -x option, for each event it receives, it searches the
configured channels for one whose evt_class matches the event’s name, and then executes
the program defined as the channel’s explain_function. The program should output lines of
text explaining the meaning of the event and, if appropriate, any necessary action. Error
messages may be written to
stderr, for display by on evmshow’s error stream.
If the
fn_explain keyword is omitted from a channel definition, evmshow -x displays a
message in place of an explanation for any events it receives that belong to the channel.
An explain_function program must support the following command syntax:
my_events_explain event_name [reference]
event_name The event’s name.
reference The event’s
ref data item, if it has one. This value is intended to be used in
conjunction with the event name to retrieve the explanation for the event from
a database of explanation text.
Refer to the EvmEvent (5) manpage for more information about an event’s
name and ref
data items.
2 Hewlett-Packard Company − 2 − HP-UX 11i Version 3: September 2010