top: introduced new focus toggle ('F'), man doc & NEWS

[ i also corrected an unrelated typographical error! ]

Signed-off-by: Jim Warner <james.warner@comcast.net>

diff --git a/NEWS b/NEWS
index 94e41f091fe9b9eb382ac57b05fec896efecbce9..55a6f1c13e705fa23d4580dfbb94e033f4dff221 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -14,6 +14,7 @@ procps-ng-NEXT
   * top: added EXE identical to 3.3.17 ps EXE
   * top: exploit some library smaps_rollup provisions      issue #112
   * top: added four new IO accounting fields               issue #184
+  * top: 'F' key is now a new forest view 'focus' toggle
 
 procps-ng-3.3.17
 ---------------

diff --git a/top/top.1 b/top/top.1
index 91b42600dfc048653926d7bda800f8080b7ed740..ec30b2e2f4b2594a26571d1e616f01fd6640381c 100644 (file)
--- a/top/top.1
+++ b/top/top.1
@@ -64,7 +64,7 @@ memory statistics and data for other users requires root privileges
 .
 .\" Document /////////////////////////////////////////////////////////////
 .\" ----------------------------------------------------------------------
-.TH TOP 1 "June 2021" "procps-ng" "User Commands"
+.TH TOP 1 "July 2021" "procps-ng" "User Commands"
 .\" ----------------------------------------------------------------------
 .nh
 
@@ -1193,9 +1193,9 @@ depending on the context in which they are issued.
         C, l, t, m, 1, 2, 3, 4, !
   4c.\fI Task-Area-Commands \fR
         Appearance:  b, J, j, x, y, z
-        Content:     c, f, F, o, O, S, u, U, V, v
+        Content:     c, F, f, O, o, S, U, u, V, v
         Size:        #, i, n
-        Sorting:     <, >, f, F, R
+        Sorting:     <, >, f, R
   4d.\fI Color-Mapping \fR
         <Ret>, a, B, b, H, M, q, S, T, w, z, 0 \- 7
   5b.\fI Commands-for-Windows \fR
@@ -1238,8 +1238,8 @@ those \*(CIs applicable to \*(AM.
 .TP 7
 \ \ \ \fB=\fR\ \ :\fIExit-Display-Limits \fR
 Removes restrictions on what is shown.
-This command will reverse any `i' (idle tasks), `n' (max tasks)
-and `v' (hide children) commands that might be active.
+This command will reverse any `i' (idle tasks), `n' (max tasks),
+`v' (hide children) and `F' focus commands that might be active.
 It also provides for an exit from PID monitoring, User filtering,
 Other filtering, Locate processing and Combine Cpus mode.
 
@@ -1536,7 +1536,7 @@ It requires a terminal with a minimum width of 80 columns.
 If a terminal's width is decreased below the minimum while \*(We
 is running, \*(We reverts to the normal `1' toggle \*F state.
 
-To avoid truncation when displaying detailed \*(Pu statistcs,
+To avoid truncation when displaying detailed \*(Pu statistics,
 as opposed to the graphic representations, a minimum width
 of 165 columns would be required.
 
@@ -1644,14 +1644,28 @@ is currently visible.
 Later, should that field come into view, the change you applied will be seen.
 
 .TP 7
-\ \ \ \fBf\fR | \fBF\fR\ \ :\fIFields-Management \fR
-These keys display a separate screen where you can change which fields are
+\ \ \ \fBF\fR\ \ :\fIMaintain-Parent-Focus\fR toggle \fR
+When in forest view mode, this key serves as a toggle to retain focus
+on a target task, presumably one with forked children.
+If forest view mode is \*F this key has no effect.
+
+The toggle is applied to the first (topmost) process in the \*(CW.
+Once established, that task is always displayed as the first (topmost)
+process along with its forked children.
+All other processes will be suppressed.
+
+\*(NT keys like `i' (idle tasks), `n' (max tasks), `v' (hide children)
+and User/Other filtering remain accessible and can impact what is displayed.
+
+.TP 7
+\ \ \ \fBf\fR\ \ :\fIFields-Management \fR
+This key displays a separate screen where you can change which fields are
 displayed, their order and also designate the sort field.
-For additional information on these \*(CIs
+For additional information on this \*(CI
 \*(Xt 3b. MANAGING Fields.
 
 .TP 7
-\ \ \ \fBo\fR | \fBO\fR\ \ :\fIOther-Filtering \fR
+\ \ \ \fBO\fR | \fBo\fR\ \ :\fIOther-Filtering \fR
 You will be prompted for the selection criteria which then determines
 which tasks will be shown in the \*(CW.
 Your criteria can be made case sensitive or case can be ignored.
@@ -1677,7 +1691,7 @@ If you wish to know in advance whether or not Cumulative mode is in
 effect, simply ask for help and view the window summary on the second line.
 
 .TP 7
-\ \ \ \fBu\fR | \fBU\fR\ \ :\fIShow-Specific-User-Only \fR
+\ \ \ \fBU\fR | \fBu\fR\ \ :\fIShow-Specific-User-Only \fR
 You will be prompted for the\fB uid\fR or\fB name\fR of the user to display.
 The \-u option matches on \fB effective\fR user whereas the \-U option
 matches on\fB any\fR user (real, effective, saved, or filesystem).
@@ -1786,8 +1800,8 @@ The following \*(CIs will\fB always\fR be honored whether or not
 the current sort field is visible.
 
 .TP 7
-\ \ \ \fBf\fR | \fBF\fR\ \ :\fIFields-Management \fR
-These keys display a separate screen where you can change which field
+\ \ \ \fBf\fR\ \ :\fIFields-Management \fR
+This key displays a separate screen where you can change which field
 is used as the sort column, among other functions.
 This can be a convenient way to simply verify the current sort field,
 when running \*(We with column highlighting turned \*F.
@@ -1883,8 +1897,8 @@ as the only display element.
 *\ \ \fB=\fR | \fB+\fR\ \ :\fIEqualize/Reset-Window(s) \fR
 The `=' key forces the \*(CW's \*(TD to be visible.
 It also reverses any active `i' (idle tasks), `n' (max tasks), `u/U'
-(user filter), `o/O' (other filter), `v' (hide children), `L' (locate)
-and `!' (combine cpus) commands.
+(user filter), `o/O' (other filter), `v' (hide children), `F' focused,
+`L' (locate) and `!' (combine cpus) commands.
 Also, if the window had been scrolled, it will be reset with this command.
 \*(XT 5c. SCROLLING a Window for additional information regarding vertical
 and horizontal scrolling.