pmprintf(3) [centos man page]

PMPRINTF(3)						     Library Functions Manual						       PMPRINTF(3)

NAME

       pmprintf, pmflush - print formatted output in a window or to standard error

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmprintf(const char *fmt, ... /*args*/);
       int pmflush(void);

       cc ... -lpcp

DESCRIPTION

       The  combination  of  pmprintf and pmflush produces output in either an xconfirm(1) window, on the standard error stream, or to a file in a
       manner similar to fprintf(3).  The fmt argument is used to control the conversion, formatting, and printing of  the  variable  length  args
       list.  The output technique is controlled via an environment variable.

       pmprintf appends the formatted message string to an internal buffer shared by the two routines, without actually producing any output.

       pmflush	causes	the  internal  buffer to be either displayed in a window, printed on standard error, or flushed to a file and the internal
       buffer to be cleared.

ENVIRONMENT

       The environment variable PCP_STDERR controls the output technique used by pmflush:

	   If PCP_STDERR is unset, the text is written onto the stderr stream of the caller.

	   If PCP_STDERR is set to the literal reserved word DISPLAY then the text will be displayed as a GUI dialog using xconfirm(1).

	   If PCP_STDERR is set to any other value then pmflush interprets the value as a file name and appends the text to that file.	 The  file
	   is created if it doesn't already exist, and in this case if the file creation fails, then stderr is used instead).

FILES

       pmprintf uses the mkstemp(3) function to create a temporary file.  This temporary file is deleted when pmflush is called.

DIAGNOSTICS

       On  successful  completion, pmprintf returns the number of characters transmitted, while pmflush returns a value of zero on successful com-
       pletion.

       For either routine, a negative value is returned if an error was encountered, and this can be passed to pmErrStr(3) to obtain  the  associ-
       ated error message.

SEE ALSO

       pmdbg(1), fprintf(3), mkstemp(3), pmErrStr(3) and PMAPI(3).

Performance Co-Pilot							PCP							       PMPRINTF(3)

PMGETCONFIG(3)						     Library Functions Manual						    PMGETCONFIG(3)

NAME

       pmGetConfig - return Performance Co-Pilot configuration variable

C SYNOPSIS

       #include <pcp/pmapi.h>
       char *pmGetConfig(const char *variable);

       #include <pcp/impl.h>
       char *__pmGetAPIConfig(const char *feature);

       cc ... -lpcp

DESCRIPTION

       The  pmGetConfig function searches for variable first in the environment and then, if not found, in the Performance Co-Pilot (PCP) configu-
       ration file and returns the string result.  If variable is not already in the environment, it is added with  a  call  to  putenv(3)  before
       returning.

       The default location of the PCP configuration file is /etc/pcp.conf but this may be changed by setting PCP_CONF in the environment to a new
       location, as described in pcp.conf(5).

       The internal __pmGetAPIConfig function reports on features of the PCP library.  It can be used to query support for multi-threading,  secu-
       rity extensions, and other features.

       The  pmconfig(1)  utility provides command line access to both of these interfaces, and also provides a mechanism for listing all available
       variables and features that are valid arguments to these routines.

RETURN VALUE

       If variable is not found in either the environment nor the PCP configuration file then the return value is an empty  string.   If  the  PCP
       configuration  file  is	not found then a fatal error message is printed and the process will exit(2) - although this sounds drastic, it is
       the only course of action available because the PCP configuration/installation is fatally flawed.

       If the pmGetConfig function returns a non-empty string, the returned value points into the environment and so changing it is  a	bad  idea.
       This function returns the same type as the getenv(3) function (which should probably be a const char *).

       The  __pmGetAPIConfig  routine  on the other hand returns NULL on failure to lookup the requested feature.  It does not modify the environ-
       ment, and returns a pointer to a static read-only string which also should not be modified or freed by the caller.

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

       PCPIntro(1), pmconfig(1), exit(2), PMAPI(3), getenv(3C), putenv(3C), pcp.conf(5), pcp.env(5) and environ(5).

Performance Co-Pilot							PCP							    PMGETCONFIG(3)