From e243721f227a7d35f6c13baeda47e9b09a001511 Mon Sep 17 00:00:00 2001 From: Jim Warner Date: Tue, 4 Jan 2022 00:00:00 +0100 Subject: [PATCH] doc: updated 3 man pages for 'LIBPROC_HIDE_KERNEL' var MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This patch was prompted by Björn Fischer's merge #147 request referenced below. And since the library change may impact all users, multiple man pages were updated. [ and thanks to Björn for initiating this extension ] Reference(s): https://gitlab.com/procps-ng/procps/-/merge_requests/147 Prototyped-by: Björn Fischer Signed-off-by: Jim Warner --- doc/procps_pids.3 | 8 ++++++++ ps/ps.1 | 9 ++++++++- top/top.1 | 21 +++++++++++++++------ 3 files changed, 31 insertions(+), 7 deletions(-) diff --git a/doc/procps_pids.3 b/doc/procps_pids.3 index d06ee2dd..e044b44f 100644 --- a/doc/procps_pids.3 +++ b/doc/procps_pids.3 @@ -205,6 +205,14 @@ This verification feature incurs substantial overhead. Therefore, it is important that it \fInot\fR be activated for a production/release build. +.SH ENVIRONMENT VARIABLE(S) +The value set for the following is unimportant, just its presence. + +.IP LIBPROC_HIDE_KERNEL +This will hide kernel threads which would otherwise be returned with a +.BR procps_get ", " procps_select " or " procps_reap +call. + .SH SEE ALSO .BR procps (3) .BR procps_misc (3) diff --git a/ps/ps.1 b/ps/ps.1 index 2cebcee4..ab02b0ad 100644 --- a/ps/ps.1 +++ b/ps/ps.1 @@ -4,7 +4,7 @@ .\" Quick hack conversion by Albert Cahalan, 1998. .\" Licensed under version 2 of the Gnu General Public License. .\" -.TH PS "1" "2021-06-16" "procps-ng" "User Commands" +.TH PS "1" "January 2022" "procps-ng" "User Commands" .\" .\" To render this page: .\" groff -t -b -man -X -P-resolution -P100 -Tps ps.1 & @@ -1949,6 +1949,13 @@ Force obsolete command line interpretation. .B LC_TIME Date format. .TP +.B LIBPROC_HIDE_KERNEL +Set this to any value to hide kernel threads normally displayed with the +.B -e +option. This is equivalent to selecting +.B --ppid 2 -p 2 --deselect +instead. Also works in BSD mode. +.TP .B PS_COLORS Not currently supported. .TP diff --git a/top/top.1 b/top/top.1 index 53cbbc1d..e1ffd4fc 100644 --- a/top/top.1 +++ b/top/top.1 @@ -131,12 +131,13 @@ The remaining Table of Contents b. ADDING INSPECT Entries c. SYSTEM Configuration File d. SYSTEM Restrictions File - 7. STUPID TRICKS Sampler + 7. ENVIRONMENT VARIABLE(S) + 8. STUPID TRICKS Sampler a. Kernel Magic b. Bouncing Windows c. The Big Bird Window d. The Ol' Switcheroo - 8. BUGS, 9. SEE Also + 9. BUGS, 10. SEE Also .fi .\" ...................................................................... @@ -2518,9 +2519,17 @@ It should have exactly two lines, as shown in this example: 5.0 # line 2: delay interval in seconds .fi -.\" ...................................................................... .\" ---------------------------------------------------------------------- -.SH 7. STUPID TRICKS Sampler +.SH 7. ENVIRONMENT VARIABLE(S) +.\" ---------------------------------------------------------------------- +The value set for the following is unimportant, just its presence. + +.IP LIBPROC_HIDE_KERNEL +This will prevent display of any kernel threads and exclude such processes +from the \*(SA Tasks/Threads counts. + +.\" ---------------------------------------------------------------------- +.SH 8. STUPID TRICKS Sampler .\" ---------------------------------------------------------------------- Many of these tricks work best when you give \*(We a scheduling boost. So plan on starting him with a nice value of \-10, assuming you've got @@ -2641,14 +2650,14 @@ of travel for the command lines being shown. eventually all lines will Switcheroo, and move right .\" ---------------------------------------------------------------------- -.SH 8. BUGS +.SH 9. BUGS .\" ---------------------------------------------------------------------- Please send bug reports to .UR procps@freelists.org .UE . \" ---------------------------------------------------------------------- -.SH 9. SEE Also +.SH 10. SEE Also .\" ---------------------------------------------------------------------- .BR free (1), .BR ps (1),