chkhelp(1) [centos man page]

CHKHELP(1)						      General Commands Manual							CHKHELP(1)

NAME

       chkhelp - check performance metrics help text files

SYNOPSIS

       $PCP_BINADM_DIR/chkhelp [-eHiOp] [-n pmnsfile] [-v version] helpfile [metricname ...]

DESCRIPTION

       chkhelp checks the consistency of Performance Co-Pilot help text files generated by newhelp(1) and used by Performance Metric Domain Agents
       (PMDAs).  The checking involves scanning the files, and optionally displaying selected entries.

       The files helpfile.dir and helpfile.pag are created by newhelp(1), and are assumed to already exist.

       Without any options or metricname arguments, chkhelp silently verifies the structural integrity of the help files.

       If any metricname arguments are specified, then the help entries for only the corresponding metrics will be processed.

       If no metricname arguments are specified, then at least one of the options -i or -p must be given.  The -i option causes  entries  for  all
       instance  domains to be processed (ignoring entries for performance metrics).  The -p option causes entries for all metrics to be displayed
       (ignoring entries for instance domains).

       When metric entries are to be processed (via either the metricname arguments or the -p option or the -i option),  the  -O  and  -H  options
       request the display of the one-line and verbose help text respectively.	The default is -O.

       Although  historically  there have been multiple help text file formats, the only format currently supported using the -v option is version
       2, and this is the default if no -v flag is provided.

       Normally chkhelp operates on the default Performance Metrics Namespace (PMNS), however if the -n option is specified an alternative  names-
       pace is loaded from the file pmnsfile.

       The  -e option provides an existence check where all of the specified metrics from the PMNS (note, not from helpfile) are scanned, and only
       the names of the metrics for which no help text exists are reported.  The -e option is mutually exclusive with the -i and/or -p options.

PCP ENVIRONMENT

       Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP.  On  each	installation,  the
       file  /etc/pcp.conf contains the local values for these variables.  The $PCP_CONF variable may be used to specify an alternative configura-
       tion file, as described in pcp.conf(5).

SEE ALSO

       newhelp(1), PMAPI(3), pmLookupInDomText(3), pmLookupText(3), pcp.conf(5) and pcp.env(5).

DIAGNOSTICS

       There are all sorts of reasons a help database may be inconsistent, the most likely is that a performance metric in  the  database  is  not
       defined in the loaded PMNS.

Performance Co-Pilot							PCP								CHKHELP(1)

Check Out this Related Man Page

PMTRIMNAMESPACE(3)					     Library Functions Manual						PMTRIMNAMESPACE(3)

NAME

       pmTrimNameSpace - prune a performance metrics name space

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmTrimNameSpace(void);

       cc ... -lpcp

DESCRIPTION

       If  the current Performance Metrics Application Programming Interface (PMAPI) context corresponds to a version 1 archive log of Performance
       Co-Pilot (PCP) performance metrics (as collected by pmlogger(1) -V1), then the currently loaded Performance Metrics Name Space  (PMNS),	is
       trimmed to exclude metrics for which no description can be found in the archive.  The PMNS is further trimmed to remove empty subtrees that
       do not contain any performance metric.

       Since PCP archives usually contain some subset of all metrics named in the default PMNS, pmTrimNameSpace  effectively  trims  the  applica-
       tion's PMNS to contain only the names of the metrics in the archive.

       Since PCP 2.0, pmTrimNameSpace is only needed for dealing with version 1 archives.  Version 2 archives actually store the "trimmed" PMNS.

       Prior to any trimming, the PMNS is restored to the state as of the completion of the last pmLoadASCIINameSpace(3) or pmLoadNameSpace(3), so
       the effects of consecutive calls to pmTrimNameSpace with archive contexts are not additive.

       If the current PMAPI context corresponds to a host and a pmLoadASCIINameSpace(3) or pmLoadNameSpace(3) call was made, then the PMNS reverts
       to all names loaded into the PMNS at the completion of the last pmLoadASCIINameSpace(3) or pmLoadNameSpace(3), i.e. any trimming is undone.

       On success, pmTrimNameSpace returns zero.

SEE ALSO

       pmlogger(1), PMAPI(3), pmLoadASCIINameSpace(3), pmLoadNameSpace(3), pmNewContext(3) and pmns(5).

DIAGNOSTICS

       PM_ERR_NOPMNS
	      you must have loaded a PMNS using pmLoadASCIINameSpace(3) or pmLoadNameSpace(3) before calling pmTrimNameSpace

       PM_ERR_NOCONTEXT
	      the current PMAPI context is invalid

Performance Co-Pilot							PCP							PMTRIMNAMESPACE(3)

Linux and UNIX Man Pages

chkhelp(1) [centos man page]

Check Out this Related Man Page