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

PMNSDEL(1)						      General Commands Manual							PMNSDEL(1)

NAME

       pmnsdel - delete a subtree of names from the Performance Co-Pilot PMNS

SYNOPSIS

       $PCP_BINADM_DIR/pmnsdel [-d] [-n namespace] metricpath [ ... ]

DESCRIPTION

       pmnsdel	removes  subtrees  of  names  from  a Performance Metrics Name Space (PMNS), as used by the components of the Performance Co-Pilot
       (PCP).

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

       The  default  PMNS is found in the file $PCP_VAR_DIR/pmns/root unless the environment variable PMNS_DEFAULT is set, in which case the value
       is assumed to be the pathname to the file containing the default PMNS.

       The metric names to be deleted are all those for which one of the metricpath arguments is a prefix in the PMNS, see pmns(5).

       All of the files defining the PMNS must be located within the directory that contains the root of the PMNS, and	this  would  typically	be
       $PCP_VAR_DIR/pmns for the default PMNS, and this would typically imply running pmnsdel as root.

       Provided  some  initial	integrity  checks are satisfied, pmnsdel will update the necessary PMNS files.	Should an error be encountered the
       original namespace is restored.	Note that any PMNS files that are no longer referenced by the modified namespace will not be removed, even
       though their contents are not part of the new namespace.

       The  -d option allows the resultant PMNS to optionally contain duplicate PMIDs with different names in the PMNS.  By default this condition
       is considered an error.

CAVEAT

       Once the writing of the new namespace file has begun, the signals SIGINT, SIGHUP and SIGTERM will be ignored to protect	the  integrity	of
       the new files.

FILES

       $PCP_VAR_DIR/pmns/root	the default PMNS, when then environment variable PMNS_DEFAULT is unset

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

       pmnsadd(1), pmnsmerge(1), pcp.conf(5), pcp.env(5) and pmns(5).

Performance Co-Pilot							PCP								PMNSDEL(1)

Linux and UNIX Man Pages

chkhelp(1) [centos man page]

Check Out this Related Man Page