summaryrefslogtreecommitdiff
path: root/man/man3/pmdadaemon.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/pmdadaemon.3')
-rw-r--r--man/man3/pmdadaemon.3108
1 files changed, 108 insertions, 0 deletions
diff --git a/man/man3/pmdadaemon.3 b/man/man3/pmdadaemon.3
new file mode 100644
index 0000000..e96082d
--- /dev/null
+++ b/man/man3/pmdadaemon.3
@@ -0,0 +1,108 @@
+'\"macro stdmacro
+.\"
+.\" Copyright (c) 2000-2004 Silicon Graphics, Inc. All Rights Reserved.
+.\"
+.\" This program is free software; you can redistribute it and/or modify it
+.\" under the terms of the GNU General Public License as published by the
+.\" Free Software Foundation; either version 2 of the License, or (at your
+.\" option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+.\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+.\" for more details.
+.\"
+.\"
+.TH PMDADAEMON 3 "PCP" "Performance Co-Pilot"
+.SH NAME
+\f3pmdaDaemon\f1 \- initialize the PMDA to run as a daemon
+.SH "C SYNOPSIS"
+.ft 3
+#include <pcp/pmapi.h>
+.br
+#include <pcp/impl.h>
+.br
+#include <pcp/pmda.h>
+.sp
+.ad l
+.hy 0
+.in +8n
+.ti -8n
+void pmdaDaemon(pmdaInterface *\fIdispatch\fP, int \fIinterface\fP, char\ *\fIname\fP, int\ \fIdomain\fP, char\ *\fIlogfile\fP, char\ *\fIhelptext\fP);
+.sp
+.in
+.hy
+.ad
+cc ... \-lpcp_pmda \-lpcp
+.ft 1
+.SH DESCRIPTION
+.B pmdaDaemon
+initializes the
+.B pmdaInterface
+structure to use the
+.I interface
+extensions assuming the
+.BR PMDA (3)
+is to be run as a daemon. The
+.B pmdaInterface
+structure is initialized with:
+.TP 15
+.I name
+The name of the agent.
+.TP
+.I domain
+The default domain number of the agent which uniquely identifies this PMDA
+from other running PMDAs. This may be subsequently changed by a command line
+option
+.B \-d
+(see
+.BR pmdaGetOpt (3)).
+.TP
+.I logfile
+The default path to the log file. This may be replaced by the
+.B \-l
+command line option if using
+.BR pmdaGetOpt .
+.TP
+.I helptext
+The default path to the help text (see
+.BR pmdaText (3).
+This may be replaced by the
+.B \-h
+command line option if using
+.BR pmdaGetOpt (3).
+If no help text is installed, or you are not using
+.BR pmdaText (3),
+then this should be set to NULL.
+.PP
+The callbacks are initialized to
+.BR pmdaProfile (3),
+.BR pmdaFetch (3),
+.BR pmdaDesc (3),
+.BR pmdaText (3),
+.BR pmdaInstance (3)
+and
+.BR pmdaStore (3).
+.SH DIAGNOSTICS
+.TP 15
+.B Unable to allocate memory for pmdaExt structure
+In addition, the
+.I dispatch->status
+field is set to a value less than zero.
+.TP
+.BI "PMDA interface version " interface " not supported"
+The
+.I interface
+version is not supported by
+.BR pmdaDaemon .
+.SH CAVEAT
+The PMDA must be using
+.B PMDA_INTERFACE_2
+or later.
+.SH SEE ALSO
+.BR PMAPI (3),
+.BR PMDA (3),
+.BR pmdaDSO (3),
+.BR pmdaGetOpt (3)
+and
+.BR pmdaText (3).