aboutsummaryrefslogtreecommitdiffstats
path: root/htop.1.in
diff options
context:
space:
mode:
authorDaniel Lange <DLange@git.local>2020-08-27 07:48:10 +0200
committerDaniel Lange <DLange@git.local>2020-08-27 07:48:10 +0200
commitf3147ea2d1598914c2db53e8cfb34c8ff81e2ff4 (patch)
tree3ee82b2af2ab3d38b6e4b07f3994516aac72f742 /htop.1.in
parentdf568a576f7b44ac5a2b9b7222c7f39d9932f626 (diff)
downloaddebian_htop-f3147ea2d1598914c2db53e8cfb34c8ff81e2ff4.tar.gz
debian_htop-f3147ea2d1598914c2db53e8cfb34c8ff81e2ff4.tar.bz2
debian_htop-f3147ea2d1598914c2db53e8cfb34c8ff81e2ff4.zip
New upstream version 3.0.0upstream/3.0.0
Diffstat (limited to 'htop.1.in')
-rw-r--r--htop.1.in122
1 files changed, 73 insertions, 49 deletions
diff --git a/htop.1.in b/htop.1.in
index 774bc09..9ef0761 100644
--- a/htop.1.in
+++ b/htop.1.in
@@ -1,31 +1,40 @@
-.TH "HTOP" "1" "2015" "@PACKAGE_STRING@" "Utils"
+.TH "HTOP" "1" "2020" "@PACKAGE_STRING@" "User Commands"
.SH "NAME"
htop \- interactive process viewer
.SH "SYNOPSIS"
-.LP
-.B htop [\fI\-dChustv\fR]
+.LP
+.B htop
+.RB [ \-dChpustv ]
.SH "DESCRIPTION"
-.LP
-Htop is a free (GPL) ncurses-based process viewer for Linux.
.LP
-It is similar to top, but allows you to scroll vertically and horizontally,
-so you can see all the processes running on the system, along with their full
-command lines, as well as viewing them as a process tree, selecting multiple
-processes and acting on them all at once.
+.B htop
+is a cross-platform ncurses-based process viewer.
+.LP
+It is similar to
+.BR top ,
+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.
.LP
Tasks related to processes (killing, renicing) can be done without
entering their PIDs.
-.br
+.br
.SH "COMMAND-LINE OPTIONS"
.LP
Mandatory arguments to long options are mandatory for short options too.
-.LP
+.LP
.TP
\fB\-d \-\-delay=DELAY\fR
-Delay between updates, in tenths of seconds
+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
+is greater than 100, it is decreased to 100, i.e. 10 seconds.
.TP
\fB\-C \-\-no-color \-\-no-colour\fR
-Start htop in monochrome mode
+Start
+.B htop
+in monochrome mode
.TP
\fB\-h \-\-help
Display a help message and exit
@@ -44,12 +53,11 @@ Output version information and exit
.TP
\fB\-t \-\-tree
Show processes in tree view
-.PP
-.br
.SH "INTERACTIVE COMMANDS"
-.LP
-The following commands are supported while in htop:
-.LP
+.LP
+The following commands are supported while in
+.BR htop :
+.LP
.TP 5
.B Up, Alt-k
Select (highlight) the previous process in the process list. Scroll the list
@@ -85,8 +93,13 @@ Tag or untag a process. Commands that can operate on multiple processes,
like "kill", will then apply over the list of tagged processes, instead
of the currently highlighted one.
.TP
+.B c
+Tag the current process and its children. Commands that can operate on multiple
+processes, like "kill", will then apply over the list of tagged processes,
+instead of the currently highlighted one.
+.TP
.B U
-Untag all processes (remove all tags added with the Space key).
+Untag all processes (remove all tags added with the Space or c keys).
.TP
.B s
Trace process system calls: if strace(1) is installed, pressing this key
@@ -146,7 +159,7 @@ 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.
.TP
@@ -189,19 +202,22 @@ Refresh: redraw screen and recalculate values.
.B Numbers
PID search: type in process ID and the selection highlight will be moved to it.
.PD
-
.SH "COLUMNS"
-.LP
+.LP
The following columns can display data about each process. A value of '\-' in
all the rows indicates that a column is unsupported on your system, or
-currently unimplemented in htop. The names below are the ones used in the
+currently unimplemented in
+.BR htop .
+The names below are the ones used in the
"Available Columns" section of the setup screen. If a different name is
-shown in htop's main screen, it is shown below in parenthesis.
-.LP
+shown in
+.BR htop 's
+main screen, it is shown below in parenthesis.
+.LP
.TP 5
.B Command
The full command line of the process (i.e. program name and arguments).
-.TP
+.TP
.B PID
The process ID.
.TP
@@ -222,7 +238,7 @@ The process's group ID.
.TP
.B SESSION (SID)
The process's session ID.
-.TP
+.TP
.B TTY_NR (TTY)
The controlling terminal of the process.
.TP
@@ -384,36 +400,44 @@ The percentage of time spent swapping in pages. Requires CAP_NET_ADMIN.
.TP
.B All other flags
Currently unsupported (always displays '-').
-
.SH "CONFIG FILE"
-.LP
-By default htop reads its configuration from the XDG-compliant path
-~/.config/htop/htoprc -- the configuration file is overwritten by htop's
-in-program Setup configuration, so it should not be hand-edited. If no
-user configuration exists htop tries to read the system-wide configuration
-from @sysconfdir@/htoprc and as a last resort, falls back to its
-hard coded defaults.
+.LP
+By default
+.B htop
+reads its configuration from the XDG-compliant path
+.IR ~/.config/htop/htoprc .
+The configuration file is overwritten by
+.BR htop 's
+in-program Setup configuration, so it should not be hand-edited.
+If no user configuration exists
+.B htop
+tries to read the system-wide configuration from
+.I @sysconfdir@/htoprc
+and as a last resort, falls back to its hard coded defaults.
.LP
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).
-
.SH "MEMORY SIZES"
.LP
-Memory sizes in htop are displayed as they are in tools from the GNU Coreutils
-(when ran with the --human-readable option). This means that sizes are printed
-in powers of 1024. (e.g., 1023M = 1072693248 Bytes)
+Memory sizes in
+.B htop
+are displayed in a human-readable form.
+Sizes are printed in powers of 1024. (e.g., 1023M = 1072693248 Bytes)
.LP
-The decision to use this convention was made in order to conserve screen space
-and make memory size representations consistent throughout htop.
-
+The decision to use this convention was made in order to conserve screen
+space and make memory size representations consistent throughout
+.BR htop .
.SH "SEE ALSO"
-proc(5), top(1), free(1), ps(1), uptime(1), limits.conf(5)
-
+.BR proc (5),
+.BR top (1),
+.BR free (1),
+.BR ps (1),
+.BR uptime (1)
+and
+.BR limits.conf (5).
.SH "AUTHORS"
-.LP
-htop is developed by Hisham Muhammad <hisham@gobolinux.org>.
.LP
-This man page was written by Bartosz Fenski <fenio@o2.pl> for the Debian
-GNU/Linux distribution (but it may be used by others). It was updated by Hisham
-Muhammad, and later by Vincent Launchbury, who wrote the 'Columns' section.
+.B htop
+was originally developed by Hisham Muhammad.
+Nowadays it is maintained by the community at <htop@groups.io>.

© 2014-2024 Faster IT GmbH | imprint | privacy policy