NAME | SYNOPSIS | DESCRIPTION | ENVIRONMENT | SEE ALSO | COLOPHON

PCP.CONF(5)                  File Formats Manual                 PCP.CONF(5)

NAME         top

       pcp.conf  -  the  Performance  Co-Pilot configuration and environment
       file

SYNOPSIS         top

       /etc/pcp.conf

DESCRIPTION         top

       When using Performance Co-Pilot (PCP) tools and utilities and when
       calling PCP library functions, a standard set of environment
       variables are defined in /etc/pcp.conf.  These variables are
       generally used to specify the location of various PCP pieces in the
       file system and may be loaded into shell scripts by sourcing the
       /etc/pcp.env(5) shell script and queried by C/C++ programs using the
       pmGetConfig(3) library function.  If a variable is already defined in
       the environment, the values in pcp.conf do not override those values,
       i.e. the values in pcp.conf serve as installation defaults only.

       Both the pcp.env and pcp.conf files are expected to be found in /etc
       by default.  If required, the pcp.conf file may be relocated and
       PCP_CONF set in the environment to specify the full path to the new
       location.  The pcp.env file can not be relocated (this is the only
       hard coded path required by PCP).

       The syntax rules for pcp.conf are as follows :

       1.  the general syntax is
                    PCP_VARIABLE_NAME=variable value to end of line

       2.  lines that begin with # and all blank lines are ignored.

       3.  all variables must be prefixed with PCP_.  This is a security
           issue - variables that do not have this prefix will be silently
           ignored.

       4.  there should be no space between the variable name and the
           literal = and no space between the = and the variable value
           (unless the value actually starts with a space).  This is
           required because the pcp.conf file may be sourced directly by
           Makefiles as well as interpreted by the pcp.env script and the
           pmGetConfig function.

       5.  variable values may contain spaces and should not be quoted.  The
           pcp.env script automatically quotes all variable values from the
           character immediately following the = through to the end of the
           line.

       For further details and an explanation of the use of each variable,
       see the comments in the /etc/pcp.conf file itself.

ENVIRONMENT         top

       The PCP_CONF environment variable specifies an alternative path to
       the pcp.conf file.

SEE ALSO         top

       PCPIntro(1), pmconfig(1), PCPIntro(3), PMAPI(3), pmGetConfig(3) and
       pcp.env(5).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨http://www.pcp.io/⟩.
       If you have a bug report for this manual page, send it to
       pcp@oss.sgi.com.  This page was obtained from the project's upstream
       Git repository ⟨git://git.pcp.io/pcp⟩ on 2017-05-03.  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org

Performance Co-Pilot                 PCP                         PCP.CONF(5)

Pages that refer to this page: autofsd-probe(1)chkhelp(1)collectl2pcp(1)dbpmda(1)ganglia2pcp(1)genpmda(1)iostat2pcp(1)mkaf(1)mrtg2pcp(1)newhelp(1)pcp(1)pcp2graphite(1)pcp2influxdb(1)pcp-collectl(1)pcpintro(1)pcp-iostat(1)pcp-python(1)pcp-tapestat(1)pmafm(1)pmcd(1)pmcd_wait(1)pmchart(1)pmclient(1)pmconfig(1)pmcpp(1)pmdaactivemq(1)pmdaapache(1)pmdabash(1)pmdabind2(1)pmdabonding(1)pmdacifs(1)pmdacisco(1)pmdadbping(1)pmdadm(1)pmdadocker(1)pmdads389(1)pmdads389log(1)pmdaelasticsearch(1)pmdagfs2(1)pmdagluster(1)pmdagpfs(1)pmdajbd2(1)pmdajson(1)pmdakernel(1)pmdakvm(1)pmdalibvirt(1)pmdalio(1)pmdalmsensors(1)pmdalogger(1)pmdalustre(1)pmdalustrecomm(1)pmdamailq(1)pmdamemcache(1)pmdamic(1)pmdammv(1)pmdamounts(1)pmdamysql(1)pmdanetfilter(1)pmdanfsclient(1)pmdanginx(1)pmdanutcracker(1)pmdanvidia(1)pmdaoracle(1)pmdapapi(1)pmdaperfevent(1)pmdapipe(1)pmdapostfix(1)pmdapostgresql(1)pmdaproc(1)pmdaredis(1)pmdaroomtemp(1)pmdaroot(1)pmdarpm(1)pmdarsyslog(1)pmdasample(1)pmdasendmail(1)pmdashping(1)pmdasimple(1)pmdaslurm(1)pmdasummary(1)pmdasystemd(1)pmdate(1)pmdatrace(1)pmdatrivial(1)pmdatxmon(1)pmdaunbound(1)pmdaweblog(1)pmdaxfs(1)pmdazimbra(1)pmdazswap(1)pmdbg(1)pmdiff(1)pmdumplog(1)pmdumptext(1)pmerr(1)pmfind(1)pmgenmap(1)pmgetopt(1)pmhostname(1)pmie(1)pmie2col(1)pmie_check(1)pmieconf(1)pmiestatus(1)pminfo(1)pmlc(1)pmlogcheck(1)pmlogconf(1)pmlogextract(1)pmlogger(1)pmlogger_check(1)pmloglabel(1)pmlogreduce(1)pmlogrewrite(1)pmlogsummary(1)pmmgr(1)pmnewlog(1)pmnsadd(1)pmnscomp(1)pmnsdel(1)pmnsmerge(1)pmpost(1)pmprobe(1)pmproxy(1)pmpython(1)pmquery(1)pmrep(1)pmsignal(1)pmstat(1)pmstore(1)pmtrace(1)pmval(1)pmview(1)pmwebd(1)sar2pcp(1)sheet2pcp(1)telnet-probe(1)pcpintro(3)pmapi(3)pmda(3)pmdaopenlog(3)pmdatrace(3)pmdiscoverservices(3)pmgetarchiveend(3)pmgetarchivelabel(3)pmgetchildren(3)pmgetchildrenstatus(3)pmgetconfig(3)pmgetcontexthostname(3)pmgetindom(3)pmgetindomarchive(3)pmgetoptions(3)pmgetpmnslocation(3)pmidstr(3)pmindomstr(3)pmloadasciinamespace(3)pmloadnamespace(3)pmlocaltime(3)pmlookupdesc(3)pmlookupindom(3)pmlookupindomarchive(3)pmlookupindomtext(3)pmlookupname(3)pmlookuptext(3)pmnameall(3)pmnameid(3)pmnameindom(3)pmnameindomarchive(3)pmnewcontext(3)pmnewcontextzone(3)pmnewzone(3)mmv(5)pcp-archive(5)pcp.env(5)pmns(5)