1CHKHELP(1) General Commands Manual CHKHELP(1)
2
3
4
6 chkhelp - check performance metrics help text files
7
9 $PCP_BINADM_DIR/chkhelp [-HiOp] [-n pmnsfile] [-v version] helpfile
10 [metricname ...]
11
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 Although historically there have been multiple help text file formats,
39 the only format currently supported using the -v option is version 2,
40 and this is the default if no -v flag is provided.
41
42 Normally chkhelp operates on the default Performance Metrics Namespace
43 (PMNS), however if the -n option is specified an alternative namespace
44 is loaded from the file pmnsfile.
45
47 Environment variables with the prefix PCP_ are used to parameterize the
48 file and directory names used by PCP. On each installation, the file
49 /etc/pcp.conf contains the local values for these variables. The
50 $PCP_CONF variable may be used to specify an alternative configuration
51 file, as described in pcp.conf(4).
52
54 newhelp(1), PMAPI(3), pmLookupInDomText(3), pmLookupText(3),
55 pcp.conf(4) and pcp.env(4).
56
58 There are all sorts of reasons a help database may be inconsistent, the
59 most likely is that a performance metric in the database is not defined
60 in the loaded PMNS.
61
62
63
64Performance Co-Pilot SGI CHKHELP(1)