Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pcp.conf(5) [centos man page]

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

NAME

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

SYNOPSIS

       /etc/pcp.conf

DESCRIPTION

       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 inter-
	   preted 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

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

SEE ALSO

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

Performance Co-Pilot							PCP							       PCP.CONF(5)

Check Out this Related Man Page

PMLOADNAMESPACE(3)					     Library Functions Manual						PMLOADNAMESPACE(3)

NAME

       pmLoadNameSpace - load a local PMNS for an application

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmLoadNameSpace(const char *filename);

       cc ... -lpcp

DESCRIPTION

       If  the	application wants to force using a local Performance Metrics Name Space (PMNS) instead of a distributed PMNS then it must load the
       PMNS using pmLoadNameSpace or pmLoadASCIINameSpace(3).  If the application is to use a distributed PMNS, then it should NOT make a call	to
       load the PMNS explicitly.

       The filename argument designates the PMNS of interest.  For applications not requiring a tailored PMNS, the special value PM_NS_DEFAULT may
       be used for filename, to force the default local PMNS to be loaded.

       The default local PMNS is found in the file $PCP_VAR_DIR/pmns/root unless the environment variable PMNS_DEFAULT is set, in which  case  the
       value is assumed to be the pathname to the file containing the default local PMNS.

       Externally a PMNS is stored in an ASCII format as described in pmns(5).

       By  default,  multiple names in the PMNS are not allowed to be associated with a single Performance Metrics Identifier (PMID).  pmLoadASCI-
       INameSpace(3) provides an alternative interface with user-defined control over the processing of duplicate PMIDs in the PMNS.

       pmLoadNameSpace returns zero on success.

FILES

       $PCP_VAR_DIR/pmns/root	the default local PMNS, when the environment variable PMNS_DEFAULT is unset

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 configura-
       tion file, as described in pcp.conf(5).	Values for these variables may be obtained programmatically using the pmGetConfig(3) function.

SEE ALSO

       PMAPI(3), pmGetConfig(3), pmLoadASCIINameSpace(3), pmTrimNameSpace(3), pcp.conf(5), pcp.env(5) and pmns(5).

DIAGNOSTICS

       Syntax and other errors in the parsing of the PMNS are reported on stderr with a message of the form ``Error Parsing ASCII PMNS: ...''.

       PM_ERR_DUPPMNS

	      It is an error to try and load more than one PMNS, or to call either pmLoadNameSpace and/or pmLoadASCIINameSpace(3) more than once.

       PM_ERR_PMNS

	      Syntax error in the PMNS file.

Performance Co-Pilot							PCP							PMLOADNAMESPACE(3)
Man Page