From 04da92dfd16ebe7c667d650cbf960c72c91f8c9e Mon Sep 17 00:00:00 2001 From: Nathan Scott Date: Fri, 23 Jul 2021 11:50:28 +1000 Subject: docs: updates and new manual page for pcp-htop Add some words about pcp-htop to the main man page, and add a new man page describing the pcp-htop configuration files that allow new meters and columns to be defined at runtime. --- htop.1.in | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 59 insertions(+), 2 deletions(-) (limited to 'htop.1.in') diff --git a/htop.1.in b/htop.1.in index 9b81a210..b4cde44f 100644 --- a/htop.1.in +++ b/htop.1.in @@ -1,9 +1,13 @@ .TH "HTOP" "1" "2020" "@PACKAGE_STRING@" "User Commands" .SH "NAME" -htop \- interactive process viewer +htop, pcp-htop \- interactive process viewer .SH "SYNOPSIS" .B htop .RB [ \-dCFhpustvH ] +.br +.B pcp\ htop +.RB [ \-dCFhpustvH ] +.RB [ \-\-host/-h\ host ] .SH "DESCRIPTION" .B htop is a cross-platform ncurses-based process viewer. @@ -18,6 +22,19 @@ multiple processes and act on them all at once. .LP Tasks related to processes (killing, renicing) can be done without entering their PIDs. +.LP +.B pcp-htop +is a version of +.B htop +built using the Performance Co-Pilot (PCP) Metrics API (see \c +.BR PCPIntro (1), +.BR PMAPI (3)), +allowing values not built into +.B htop +to be displayed from arbitrary metrics. +See the section below titled +.B "CONFIG FILES" +for further details. .br .SH "COMMAND-LINE OPTIONS" Mandatory arguments to long options are mandatory for short options too. @@ -527,7 +544,7 @@ Summary: build time dependency on C header files, optional runtime dependency on .B libsensors(3) via dynamic loading. -.SH "CONFIG FILE" +.SH "CONFIG FILES" By default .B htop reads its configuration from the XDG-compliant path @@ -544,6 +561,36 @@ and as a last resort, falls back to its hard coded defaults. You may override the location of the configuration file using the $HTOPRC environment variable (so you can have multiple configurations for different machines that share the same home directory, for example). +.LP +The +.B pcp-htop +utility makes use of +.I htoprc +in exactly the same way. +In addition, it supports additional configuration files allowing +new meters and columns to be added to the display via the usual +Setup function, which will display additional Available Meters +and Available Column entries for each runtime configured meter +or column. +.LP +These +.B pcp-htop +configuration files are read once at startup. +The format of these files is described in detail in the +.BR pcp-htop (5) +manual page. +.LP +This functionality makes available many thousands of Performance +Co-Pilot metrics for display by +.BR pcp-htop , +as well as the ability to display custom metrics added at individual sites. +Applications and services instrumented using the OpenMetrics format +.B https://openmetrics.io +can also be displayed by +.B pcp-htop +if the +.BR pmdaopenmetrics (1) +component is configured. .SH "MEMORY SIZES" Memory sizes in .B htop @@ -561,7 +608,17 @@ space and make memory size representations consistent throughout .BR uptime (1) and .BR limits.conf (5). +.SH "SEE ALSO FOR PCP" +.BR pmdaopenmetrics (1), +.BR PCPIntro (1), +.BR PMAPI (3), +and +.BR pcp-htop (5). .SH "AUTHORS" .B htop was originally developed by Hisham Muhammad. Nowadays it is maintained by the community at . +.LP +.B pcp-htop +is maintained as a collaboration between the and +communities, and forms part of the Performance Co-Pilot suite of tools. -- cgit v1.2.3