1CHKHELP(1)                  General Commands Manual                 CHKHELP(1)
2
3
4

NAME

6       chkhelp - check performance metrics help text files
7

SYNOPSIS

9       $PCP_BINADM_DIR/chkhelp  [-eHiOp?]   [-n pmnsfile] helpfile [metricname
10       ...]
11

DESCRIPTION

13       chkhelp checks the consistency of Performance Co-Pilot help text  files
14       generated  by  newhelp(1)  and used by Performance Metric Domain Agents
15       (PMDAs).  The checking involves scanning the files, and optionally dis‐
16       playing selected entries.
17
18       The  files helpfile.dir and helpfile.pag are created by newhelp(1), and
19       are assumed to already exist.
20
21       Without any options or metricname arguments, chkhelp silently  verifies
22       the structural integrity of the help files.
23
24       If  any  metricname  arguments are specified, then the help entries for
25       only the corresponding metrics will be processed.
26
27       If no metricname arguments are specified, then  at  least  one  of  the
28       options  -i  or -p must be given.  The -i option causes entries for all
29       instance domains to be processed (ignoring entries for performance met‐
30       rics).   The  -p  option causes entries for all metrics to be displayed
31       (ignoring entries for instance domains).
32
33       When metric entries are to be  processed  (via  either  the  metricname
34       arguments  or  the  -p  option or the -i option), the -O and -H options
35       request the display of the one-line and verbose help text respectively.
36       The default is -O.
37
38       Normally chkhelp operates on the default Performance Metrics Name Space
39       (PMNS), however if the -n option is specified an alternative  namespace
40       is loaded from the file pmnsfile.
41
42       The  -e  option  provides an existence check where all of the specified
43       metrics from the PMNS (note, not from helpfile) are scanned,  and  only
44       the  names  of  the metrics for which no help text exists are reported.
45       The -e option is mutually exclusive with the -i and/or -p options.
46

OPTIONS

48       The available command line options are:
49
50       -e   Report metrics with no help text.
51
52       -H   Display verbose help text and exit.
53
54       -i   Process all the instance domains.
55
56       -n pmnsfile
57            Load an alternative Performance Metrics Name Space (PMNS(5))  from
58            the file pmnsfile.
59
60       -O   Display the one line help summary.
61
62       -p   Process all the metrics (PMIDs).
63
64       -?   Display usage message and exit.
65

DIAGNOSTICS

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

PCP ENVIRONMENT

72       Environment variables with the prefix PCP_ are used to parameterize the
73       file and directory names used by PCP.  On each installation,  the  file
74       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
75       $PCP_CONF variable may be used to specify an alternative  configuration
76       file, as described in pcp.conf(5).
77
78       For environment variables affecting PCP tools, see pmGetOptions(3).
79

SEE ALSO

81       newhelp(1),     PMAPI(3),     pmLookupInDomText(3),    pmLookupText(3),
82       pcp.conf(5), pcp.env(5) and PMNS(5).
83
84
85
86Performance Co-Pilot                  PCP                           CHKHELP(1)
Impressum