Skip to content

Commit

Permalink
man/man1/pmcheck.1: document -s (status) restrictions when run as a n…
Browse files Browse the repository at this point in the history
…on-root user

See the CAVEAT section near the end of the man page.
  • Loading branch information
kmcdonell committed May 7, 2024
1 parent 7e6187a commit bbd2046
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions man/man1/pmcheck.1
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,19 @@ or
options are used, the success or failure of the reconfiguration is
reported on standard output.
.PD
.SH CAVEAT
Some components have prerequisites that demand additional non-PCP services be
installed, configured and operational, e.g. a database server or a key-value
server.
In these cases, probing the status of the non-PCP service may be subject to
some access controls and if
.B pmcheck
is run as a non-root user, then the output from
.B \-s
(the default)
may be incomplete or misleading; in these circumstances, running
.B pmcheck
as root should provide a more accurate report.
.SH PCP ENVIRONMENT
Environment variables with the prefix \fBPCP_\fP are used to parameterize
the file and directory names used by PCP.
Expand Down

0 comments on commit bbd2046

Please sign in to comment.