Movatterモバイル変換

pmdatext(3) — Linux manual page

PMDATEXT(3)              Library Functions ManualPMDATEXT(3)

NAME        top

pmdaText- extract metric help text for a PMDA

C SYNOPSIS        top

#include <pcp/pmapi.h>#include <pcp/pmda.h>int pmdaText(intident, inttype, char **buffer, pmdaExt *pmda);cc ... -lpcp_pmda -lpcp

DESCRIPTION        top

       As  part  of  the Performance Metrics Domain Agent (PMDA) API (seePMDA(3)),pmdaTextuses the standardPMDA(3)  data  structures  to       return  the  help  text for metricident inbuffer.  The help text       must be located in help text files created  withnewhelp(1),  and       the associated files are automatically opened bypmdaInit(3).       The  path  to  the (basename of the) help text files can be set in       the calls topmdaDSO(3) orpmdaDaemon(3) and overridden by the-h       command line option inpmdaGetOpt(3).       The  encoding  ofident follows the internal scheme used below the       routinespmLookupText(3) andpmLookupInDomText(3),  namelyident       encodes either a metric identifier or an instance domain identifi‐       er, according to the value oftype.       Thetype argument is a bit mask that encodes the interpretation ofident  and  the  requested  form  of help text, as follows: eitherPM_TEXT_PMIDifident is a metric identifier, orPM_TEXT_INDOMifident  is  an instance domain identifier, plus eitherPM_TEXT_ONE‐LINEfor the one line help text orPM_TEXT_HELPfor the full  help       text.       Thebuffer  is  managed internally (usually it is cached), and it       shouldnotbe released or freed by the caller ofpmdaText.

CAVEAT        top

       The PMDA must be usingPMDA_INTERFACE_2or later, as specified  in       the call topmdaDSO(3) orpmdaDaemon(3).

DIAGNOSTICS        top

       If  the  requested  help text could not be obtained,pmdaTextwill       returnPM_ERR_TEXT.

SEE ALSO        top

newhelp(1),malloc(3),PMAPI(3),PMDA(3),pmdaDaemon(3),pmdaDSO(3),pmdaInit(3),pmLookupInDomText(3) andpmLookupText(3).

COLOPHON        top

       This  page is part of thePCP (Performance Co-Pilot) project.  In‐       formation 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@groups.io.  This page was obtained from the project's upstream       Git repository ⟨https://github.com/performancecopilot/pcp.git⟩  on       2025-08-11.   (At  that  time,  the date of the most recent commit       that was found in the repository was 2025-08-11.)  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 isnot part of the original manual page),  send  a       mail to man-pages@man7.orgPerformance Co-Pilot               PCPPMDATEXT(3)

Pages that refer to this page:pmda(3), pmdadaemon(3), pmdadso(3), pmdagetoptions(3), pmdahelp(3), pmdainit(3), pmdamain(3)

HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH.