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 Name Space
   (PMNS), however if the -n option is specified an alternative  namespace
   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 configuration
   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.

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.