98 lines
2.1 KiB
Groff
98 lines
2.1 KiB
Groff
'\"macro stdmacro
|
|
.nr X
|
|
.if \nX=0 .ds x} PMCD_WAIT 1 "Performance Co-Pilot" "\&"
|
|
.if \nX=1 .ds x} PMCD_WAIT 1 "Performance Co-Pilot"
|
|
.if \nX=2 .ds x} PMCD_WAIT 1 "" "\&"
|
|
.if \nX=3 .ds x} PMCD_WAIT "" "" "\&"
|
|
.TH \*(x}
|
|
.SH NAME
|
|
\f3pmcd_wait\f1 \- wait for PMCD to accept client connections
|
|
.\" literals use .B or \f3
|
|
.\" arguments use .I or \f2
|
|
.SH SYNOPSIS
|
|
\f3/usr/pcp/bin/pmcd_wait\f1
|
|
[\f3-h\f1 \f2host\f1]
|
|
[\f3-t\f1 \f2interval\f1]
|
|
[\f3\-v\f1]
|
|
.SH DESCRIPTION
|
|
.B pmcd_wait
|
|
waits for the Performance
|
|
Metrics Collector Daemon (PMCD) to be running and accepting client connections.
|
|
.P
|
|
Unless directed to another host by the
|
|
.B \-h
|
|
option,
|
|
.B pmcd_wait
|
|
will try to contact
|
|
.BR pmcd (1)
|
|
on the local host.
|
|
.P
|
|
.B pmcd_wait
|
|
will timeout and abandon the attempt to connect to
|
|
.B pmcd
|
|
after 60 seconds. This default timeout interval
|
|
may be changed using the
|
|
.B \-t
|
|
option, where the
|
|
.I interval
|
|
argument follows the syntax described in
|
|
.BR PCPIntro (1)
|
|
and in the simplest form may be an unsigned integer (the implied
|
|
units in this case are seconds).
|
|
.P
|
|
On successful connection to
|
|
.B pmcd
|
|
an exit status of zero is returned.
|
|
.PP
|
|
If an error or timeout occurs, then a non-zero exit status is returned
|
|
as described below.
|
|
.PP
|
|
The other options are as follows:
|
|
.TP
|
|
.B \-v
|
|
This option turns the verbose mode on.
|
|
With the verbose mode off
|
|
(which is the default), no output will be generated.
|
|
With verbose mode on, error messages will be output on
|
|
.IR stderr .
|
|
.SH SEE ALSO
|
|
.BR pmcd (1),
|
|
.BR PCPIntro (1)
|
|
.SH DIAGNOSTICS
|
|
Error messages will be output to
|
|
.I stderr
|
|
only if the verbose mode is on.
|
|
.P
|
|
The following exit status codes are returned:
|
|
.TP
|
|
.B 0
|
|
.B pmcd_wait
|
|
was able to successfully connect to
|
|
.B pmcd
|
|
within the timeout period.
|
|
.TP
|
|
.B 1
|
|
A usage error occurred, use
|
|
.B \-v
|
|
for more details.
|
|
.TP
|
|
.B 2
|
|
No connection was made in the timeout interval.
|
|
This will happen if
|
|
.B pmcd
|
|
is running but
|
|
takes too long to complete the client connection, or if
|
|
.B pmcd
|
|
is not running and all connection attempts in the timeout
|
|
interval failed with the error ECONNREFUSED.
|
|
.TP
|
|
.B 3
|
|
A U\s-2NIX\s+2 error occurred, use
|
|
.B \-v
|
|
for more details.
|
|
.TP
|
|
.B 4
|
|
A PCP error occurred, use
|
|
.B \-v
|
|
for more details.
|