#
# Copyright (c) 2000-2004 Silicon Graphics, Inc.  All Rights Reserved.
# 
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version.
# 
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# for more details.
# 
# denki PMDA help file in the ASCII format
#
# lines beginning with a # are ignored
# lines beginning @ introduce a new entry of the form
#  @ metric_name oneline-text
#  help text goes
#  here over multiple lines
#  ...
#
# the metric_name is decoded against the default PMNS -- as a special case,
# a name of the form NNN.MM (for numeric NNN and MM) is interpreted as an
# instance domain identification, and the text describes the instance domain
#
# blank lines before the @ line are ignored
#

@ 156.0 all RAPL components available via /sys filesystem

@ 156.1 all RAPL components available via MSR registers

@ 156.2 set of all batteries reporting charge level

@ 156.3 set of all batteries reporting power

@ 156.4 set of all batteries reporting capacity

@ denki.rapl.sysfs cummulative energy consumption of RAPL components
Cummulative electrical power consumption of x86 hardware components
in units of Joules.

When consecutive samples are rate converted, the units become
Joules / second, or Watts.

The RAPL modules offered by the system are available as metric
instances.

@ denki.rapl.msr cummulative energy consumption of RAPL components
Cummulative electrical power consumption of x86 hardware components
in units of Joules.

When consecutive samples are rate converted, the units become
Joules / second, or Watts.

The RAPL modules offered by the system are available as metric
instances.

@ denki.bat.energy_now battery reported charge level
The current charge level as reported by the battery.  This can
be used to calculate overall power consumption of longer running
compute loads, with high accuracy.

@ denki.bat.power_now system calculated energy consumption
Systems current energy consumption, calculated by the system.
Only available while discharging, or charging the battery.

@ denki.bat.capacity system calculated capacity
Battery capacity, calculated by the driver.