Index for Section 1

Alphabetical listing for E

Bottom of page

evmshow(1)
NAME
  evmshow - Displays an EVM event

SYNOPSIS
  evmshow [[-d | -D | -x] [-t show_template] | -r]
       [-c config_file] [-f filter_expr] [-F]
       [-k skip-count] [-n show-count]
       [filename | -]

OPTIONS
  -c config_file
      Uses config_file as the channel configuration file instead of the
      default file, /etc/evmchannel.conf.  The channel configuration file is
      read when the -d or the -x flag is used.

  -d  Outputs each event as a full multiline detailed display, using the
      details function (fn_details) declared for the event channel in the
      channel configuration file evmchannel.conf.

  -D  Outputs each event as a multiline dump.

  -r  Does not format events, but outputs each event as a raw (binary) event.
      This flag results in an error if stdout is directed to a terminal
      device.

  -x  Outputs the explanation for the event.  This flag requires that an
      explanation function (fn_explain) be declared for the event channel in
      the channel configuration file evmchannel.conf.

  -t show_template
      Outputs each event as a formatted line using the specified
      show_template.  If this flag is used in conjunction with -d, -D or -x
      the formatted line is output first, followed by the multi-line output
      resulting from the other flag.

  -f filter_expr
      Outputs only events that match the filter_expr.  See the EvmFilter(5)
      reference page for the filter syntax.

  -F  Echoes any specified filter string to stdout, and terminates.  If the
      filter specified with the -f option refers to a stored filter, the
      filter is expanded before being displayed.  This feature is useful for
      retrieving filter strings from a file.  This flag cannot be used in
      conjunction with any other output format control flag.

  -k skip-count
      Skips the first skip-count events from the input stream before
      beginning output.	 If skip-count exceeds the number of events in the
      input stream, no output will be produced.

  -n show-count
      Stops producing output after show-count events have been output.	If
      show-count exceeds the number of events in the input stream, all events
      will be output.


OPERANDS
  filename
	Reads events from file filename.  If filename is omitted, or is
	specified as -, events are read from stdin.

DESCRIPTION
  The evmshow command takes as input one or more EVM events and writes them
  to stdout in the requested format.  Events are read from file filename if
  it is specified, or from stdin if - is specified as the file or if no file
  is specified.

  If neither the -d or the -D flag is specified, each event is formatted
  according to the following rules, and written to stdout as a single line of
  text.

  If the -t flag is included, the supplied show-template string is used to
  format the event.  If -t flag is omitted but the variable EVM_SHOW_TEMPLATE
  is present in the environment, the value of the variable is used as the
  show-template.  If no show-template is available, the event is formatted
  using its format data item if present, or a default format otherwise.

  A show-template is a string which may contain event data item specifiers of
  the form @item_name[%width], where item_name is the name of any standard
  event data item, such as timestamp or priority (see the EvmEvent(5)
  reference page for a complete list), and width, if specified, is the
  minimum number of characters the value should occupy.

  If a show-template is available, evmshow replaces each specifier in the
  template with the value of the corresponding data item from the event,
  producing an output string containing only the required items.  Any
  characters in the show_template that are not part of an item specifier are
  output unchanged, providing a convenient way to insert literal strings,
  punctuation and spacing characters.

  The special show-template specifier @@ is replaced with the event's
  formatted text, produced by taking the format data item and replacing any
  embedded variable specifiers (beginning with $) with the corresponding
  variable value, and replacing any data item specifiers (beginning with @)
  with the corresponding data item.

  If an item specified in the show_template is not present in the event, the
  character - is output in its place.  An @ character not associated with a
  valid item name is unchanged in the output.  If it is necessary to have an
  @@ sequence in the output, the @ characters should be escaped with
  backslashes (\).

  The -f flag can be used to specify an EVM filter string, to limit the
  events that are passed through evmshow.  If a filter_expr is supplied, only
  events which match the filter_expr are output.

ENVIRONMENT VARIABLES
  The following environment variables affect the execution of evmshow:

  EVM_SHOW_TEMPLATE
	   This variable contains a string formatted as described for a
	   show-template.  If the -d, -D, -t, and -x flags are omitted, the
	   string is used as the show-template for output.

NOTES
  The -r flag should not be used when output will be sent indirectly to a
  terminal device, such as piping the output of the evmshow command to the
  more command.

RESTRICTIONS
  The evmshow command rejects attempts to output raw events to a terminal
  device.

EXAMPLES
  In the following example, all available events are retrieved and piped to
  evmshow for formatting.  The show-template causes the events to be
  displayed as timestamp value, followed by the event's priority enclosed in
  brackets, followed by the formatted event string.

       evmget | evmshow -t "@timestamp [@priority]  @@"

  This ksh example displays events in the same way as the previous example,
  but the show-template is specified in an environment variable, simplifying
  the evmshow command.

       export EVM_SHOW_TEMPLATE="@timestamp [@priority]	 @@"
       evmget | evmshow

  The following example retrieves all available events and sorts them in
  reverse chronological order (descending timestamp) into a file, then uses
  evmshow to display full details of the first five (most recent) events from
  the file.

       evmget | evmsort -s "@timestamp-" > my_eventfile
       evmshow -n 5 -d my_eventfile | more

  The following example displays the value of the filter named evm, from the
  sys filter file.

       evmshow -f "@sys:evm" -F

  The following example watches for events of priority 600 or greater, and
  mails them in detailed display format to user jim, with a subject line
  which identifies the event:

       evmwatch -f "[priority >= 600]" |
		evmshow -t "Subject: EVENT [@priority] @@" -d | mail jim

EXIT VALUES
  The following exit values are returned:

  0   Successful completion

  not 0
      An error occurred

FILES
  /etc/evmchannel.conf
	     Location of the EVM channel configuration file.

SEE ALSO
  Commands: evmget(1), evminfo(1), evmpost(1), evmsort(1), evmwatch(1)

  Routines: EvmEventFormat(3)

  Files: evmchannel.conf(4), evmfilterfile(4), evmtemplate(4)

  Event Management: EVM(5)

  EVM Events: EvmEvent(5)

  Event Filter: EvmFilter(5)

Index for Section 1

Alphabetical listing for E

Top of page