summaryrefslogtreecommitdiff
path: root/man/man1/pmerr.1
blob: 8814290e5e08bc31027e2f17f8eadddad4f57ad9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
'\"macro stdmacro
.\"
.\" Copyright (c) 2000 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 PMERR 1 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pmerr\f1 \- translate Performance Co-Pilot error codes into error messages
.\" literals use .B or \f3
.\" arguments use .I or \f2
.SH SYNOPSIS
.B pmerr
.I code
\&...
.br
.B pmerr
\f3\-l\f1
.SH DESCRIPTION
.B pmerr
accepts
standard Performance Co-Pilot (PCP)
error codes via the
.I code
argument(s) and generates the corresponding error text.
.PP
Each
.I code
may be an integer, a hexadecimal value or a hexadecimal value prefixed
by either ``0x'' or ``0X''.
.PP
Error codes must be less than zero, so if
.I code
is a positive number, a warning message is produced, and the
negated value is used.
.PP
The alternative use of the
.B \-l
option causes all known error codes to be listed, along with their
symbolic names and error text.
.SH "PCP ENVIRONMENT"
Environment variables with the prefix
.B PCP_
are used to parameterize the file and directory names
used by PCP.
On each installation, the file
.I /etc/pcp.conf
contains the local values for these variables.
The
.B $PCP_CONF
variable may be used to specify an alternative
configuration file,
as described in
.BR pcp.conf (5).
.SH SEE ALSO
.BR PMAPI (3),
.BR pmErrStr (3),
.BR pcp.conf (5)
and
.BR pcp.env (5).