diff options
Diffstat (limited to 'htop.1.in')
| -rw-r--r-- | htop.1.in | 127 |
1 files changed, 112 insertions, 15 deletions
@@ -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. @@ -14,17 +18,30 @@ but allows you to scroll vertically and horizontally, and interact using a pointing device (mouse). You can observe all processes running on the system, along with their command line arguments, as well as view them in a tree format, select -multiple processes and acting on them all at once. +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 to extend +.B htop +to display values 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. .TP \fB\-d \-\-delay=DELAY\fR -Delay between updates, in tenths of seconds. If the delay value is -less than 1 it is increased to 1, i.e. 1/10 second. If the delay value +Delay between updates, in tenths of a second. If the delay value is +less than 1, it is increased to 1, i.e. 1/10 second. If the delay value is greater than 100, it is decreased to 100, i.e. 10 seconds. .TP \fB\-C \-\-no-color \-\-no-colour\fR @@ -54,6 +71,9 @@ Do not use unicode but ASCII characters for graph meters \fB\-M \-\-no-mouse\fR Disable support of mouse control .TP +\fB\-\-readonly\fR +Disable all system and process changing features +.TP \fB\-V \-\-version Output version information and exit .TP @@ -63,6 +83,14 @@ requesting a sort order with -s. .TP \fB\-H \-\-highlight-changes=DELAY\fR Highlight new and old processes +.TP +\fB \-\-drop-capabilities[=off|basic|strict]\fR +Linux only; requires libcap support. +.br +Drop unneeded Linux capabilities. +In strict mode features like killing, changing process priorities, and reading +process delay accounting information will not work, due to less capabilities +held. .SH "INTERACTIVE COMMANDS" The following commands are supported while in .BR htop : @@ -165,6 +193,13 @@ This can only be done by the superuser. .B F8, [ Decrease the selected process's priority (add to 'nice' value) .TP +.B Shift-F7, } +Increase the selected process's autogroup priority (subtract from autogroup 'nice' value). +This can only be done by the superuser. +.TP +.B Shift-F8, { +Decrease the selected process's autogroup priority (add to autogroup 'nice' value) +.TP .B F9, k "Kill" process: sends a signal which is selected in a menu, to one or a group of processes. If processes were tagged, sends the signal to all tagged processes. @@ -177,9 +212,11 @@ Quit Invert the sort order: if sort order is increasing, switch to decreasing, and vice-versa. .TP -.B +, \- +.B +, \-, * When in tree view mode, expand or collapse subtree. When a subtree is collapsed a "+" sign shows to the left of the process name. +Pressing "*" will expand or collapse all children of PIDs without parents, so +typically PID 1 (init) and PID 2 (kthreadd on Linux, if kernel threads are shown). .TP .B a (on multiprocessor machines) Set CPU affinity: mark which CPUs a process is allowed to use. @@ -241,10 +278,14 @@ shown in main screen, it is shown below in parenthesis. .TP 5 .B Command -The full command line of the process (i.e. program name and arguments). If the -option 'Merge exe, comm and cmdline in Command' (toggled by the 'm' key) is set, -and if readable, the executable path (/proc/[pid]/exe) and the command name -(/proc/[pid]/comm) are also shown merged with the command line. +The full command line of the process (i.e. program name and arguments). + +If the option 'Merge exe, comm and cmdline in Command' (toggled by the 'm' key) +is active, the executable path (/proc/[pid]/exe) and the command name +(/proc/[pid]/comm) are also shown merged with the command line, if available. + +The program basename is highlighted if set in the configuration. Additional +highlighting can be configured for stale executables (cf. Exe column below). .TP .B Comm The command name of the process obtained from /proc/[pid]/comm, if readable. @@ -253,6 +294,10 @@ The command name of the process obtained from /proc/[pid]/comm, if readable. The abbreviated basename of the executable of the process, obtained from /proc/[pid]/exe, if readable. htop is able to read this file on linux for ALL the processes only if it has the capability CAP_SYS_PTRACE or root privileges. + +The basename is marked in red if the executable used to run the process has +been replaced or deleted on disk since the process started. This additional +markup can be configured. .TP .B PID The process ID. @@ -275,7 +320,7 @@ The process's group ID. .B SESSION (SID) The process's session ID. .TP -.B TTY_NR (TTY) +.B TTY The controlling terminal of the process. .TP .B TPGID @@ -347,9 +392,6 @@ except the process's executable instructions). .B M_LRS (LIB) The library size of the process. .TP -.B M_DT (DIRTY) -The size of the dirty pages of the process. -.TP .B M_SWAP (SWAP) The size of the process's swapped pages. .TP @@ -366,6 +408,15 @@ The user ID of the process owner. .TP .B PERCENT_CPU (CPU%) The percentage of the CPU time that the process is currently using. +This is the default way to represent CPU usage in Linux. Each process can +consume up to 100% which means the full capacity of the core it is running +on. This is sometimes called "Irix mode" e.g. in +.BR top (1). +.TP +.B PERCENT_NORM_CPU (NCPU%) +The percentage of the CPU time that the process is currently using normalized +by CPU count. This is sometimes called "Solaris mode" e.g. in +.BR top (1). .TP .B PERCENT_MEM (MEM%) The percentage of memory the process is currently using (based on the process's @@ -380,7 +431,7 @@ The time, measured in clock ticks that the process has spent in user and system time (see UTIME, STIME above). .TP .B NLWP -The number of threads in the process. +The number of Light-Weight Processes (=threads) in the process. .TP .B TGID The thread group ID. @@ -454,6 +505,12 @@ The command name for the process. Requires Linux kernel 2.6.33 or newer. .B EXE The executable file of the process as reported by the kernel. Requires CAP_SYS_PTRACE and PTRACE_MODE_READ_FSCRED. .TP +.B AGRP +The autogroup identifier for the process. Requires Linux CFS to be enabled. +.TP +.B ANI +The autogroup nice value for the process autogroup. Requires Linux CFS to be enabled. +.TP .B All other flags Currently unsupported (always displays '-'). .SH "EXTERNAL LIBRARIES" @@ -497,7 +554,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 @@ -514,6 +571,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 @@ -531,7 +618,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 <htop@groups.io>. +.LP +.B pcp-htop +is maintained as a collaboration between the <htop@groups.io> and <pcp@groups.io> +communities, and forms part of the Performance Co-Pilot suite of tools. |