#
# Copyright (c) 2012 Nathan Scott.  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.
# 
# bash 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
#

@ BASH.0 Instance domain of traced bash processes
An instance domain representing all of the currently running bash
processes which are exporting trace metrics.

@ bash.xtrace.numclients
The number of attached clients.

@ bash.xtrace.maxmem
Maximum number of queued event bytes for each log file.

@ bash.xtrace.queuemem
@ bash.xtrace.count
@ bash.xtrace.records
@ bash.xtrace.parameters.pid
@ bash.xtrace.parameters.parent
@ bash.xtrace.parameters.lineno
@ bash.xtrace.parameters.function
@ bash.xtrace.parameters.command

