1PCP.CONF(5)                   File Formats Manual                  PCP.CONF(5)
2
3
4

NAME

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

SYNOPSIS

9       /etc/pcp.conf
10

DESCRIPTION

12       When  using  Performance  Co-Pilot  (PCP)  tools and utilities and when
13       calling PCP library functions, a standard set of environment  variables
14       are  defined  in  /etc/pcp.conf.  These variables are generally used to
15       specify the location of various PCP pieces in the file system  and  may
16       be  loaded  into  shell  scripts  by sourcing the /etc/pcp.env(5) shell
17       script and queried by C/C++ programs using the  pmGetConfig(3)  library
18       function.   If  a  variable  is already defined in the environment, the
19       values in pcp.conf do not override those values,  i.e.  the  values  in
20       pcp.conf serve as installation defaults only.
21
22       Both the pcp.env and pcp.conf files are expected to be found in /etc by
23       default.  If required, the pcp.conf file may be relocated and  PCP_CONF
24       set  in  the  environment to specify the full path to the new location.
25       The pcp.env file can not be relocated (this is the only hard coded path
26       required by PCP).
27
28       The syntax rules for pcp.conf are as follows :
29
30       1.  the general syntax is
31                     PCP_VARIABLE_NAME=variable value to end of line
32
33       2.  lines that begin with # and all blank lines are ignored.
34
35       3.  all variables must be prefixed with PCP_.  This is a security issue
36           - variables that do not have this prefix will be silently ignored.
37
38       4.  there should be no space between the variable name and the  literal
39           =  and  no  space  between the = and the variable value (unless the
40           value actually starts with a space).  This is required because  the
41           pcp.conf  file  may  be  sourced  directly  by Makefiles as well as
42           interpreted by the pcp.env script and the pmGetConfig function.
43
44       5.  variable values may contain spaces and should not be  quoted.   The
45           pcp.env  script  automatically  quotes all variable values from the
46           character immediately following the = through to  the  end  of  the
47           line.
48
49       For further details and an explanation of the use of each variable, see
50       the comments in the /etc/pcp.conf file itself.
51

ENVIRONMENT

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

SEE ALSO

57       PCPIntro(1),  pmconfig(1),  PCPIntro(3),  PMAPI(3),  pmGetConfig(3) and
58       pcp.env(5).
59
60
61
62Performance Co-Pilot                  PCP                          PCP.CONF(5)
Impressum