f0ed0fdafb
This commit is based on exploratory work by Sohaib Mohamed. The end goal is two-fold - to support addition of Meters we build via configuration files for both the PCP platform and for scripts ( https://github.com/htop-dev/htop/issues/526 ) Here, we focus on generic code and the PCP support. A new class DynamicMeter is introduced - it uses the special case 'param' field handling that previously was used only by the CPUMeter, such that every runtime-configured Meter is given a unique identifier. Unlike with the CPUMeter this is used internally only. When reading/writing to htoprc instead of CPU(N) - where N is an integer param (CPU number) - we use the string name for each meter. For example, if we have a configuration for a DynamicMeter for some Redis metrics, we might read and write "Dynamic(redis)". This identifier is subsequently matched (back) up to the configuration file so we're able to re-create arbitrary user configurations. The PCP platform configuration file format is fairly simple. We expand configs from several directories, including the users homedir alongside htoprc (below htop/meters/) and also /etc/pcp/htop/meters. The format will be described via a new pcp-htop(5) man page, but its basically ini-style and each Meter has one or more metric expressions associated, as well as specifications for labels, color and so on via a dot separated notation for individual metrics within the Meter. A few initial sample configuration files are provided below ./pcp/meters that give the general idea. The PCP "derived" metric specification - see pmRegisterDerived(3) - is used as the syntax for specifying metrics in PCP DynamicMeters. |
||
---|---|---|
.github | ||
darwin | ||
docs | ||
dragonflybsd | ||
freebsd | ||
generic | ||
iwyu | ||
linux | ||
netbsd | ||
openbsd | ||
pcp | ||
scripts | ||
solaris | ||
unsupported | ||
zfs | ||
.editorconfig | ||
.gitignore | ||
.travis.yml | ||
AUTHORS | ||
Action.c | ||
Action.h | ||
Affinity.c | ||
Affinity.h | ||
AffinityPanel.c | ||
AffinityPanel.h | ||
AvailableColumnsPanel.c | ||
AvailableColumnsPanel.h | ||
AvailableMetersPanel.c | ||
AvailableMetersPanel.h | ||
BatteryMeter.c | ||
BatteryMeter.h | ||
CONTRIBUTING.md | ||
COPYING | ||
CPUMeter.c | ||
CPUMeter.h | ||
CRT.c | ||
CRT.h | ||
CategoriesPanel.c | ||
CategoriesPanel.h | ||
ChangeLog | ||
ClockMeter.c | ||
ClockMeter.h | ||
ColorsPanel.c | ||
ColorsPanel.h | ||
ColumnsPanel.c | ||
ColumnsPanel.h | ||
CommandLine.c | ||
CommandLine.h | ||
CommandScreen.c | ||
CommandScreen.h | ||
Compat.c | ||
Compat.h | ||
DateMeter.c | ||
DateMeter.h | ||
DateTimeMeter.c | ||
DateTimeMeter.h | ||
DiskIOMeter.c | ||
DiskIOMeter.h | ||
DisplayOptionsPanel.c | ||
DisplayOptionsPanel.h | ||
DynamicMeter.c | ||
DynamicMeter.h | ||
EnvScreen.c | ||
EnvScreen.h | ||
FunctionBar.c | ||
FunctionBar.h | ||
Hashtable.c | ||
Hashtable.h | ||
Header.c | ||
Header.h | ||
HostnameMeter.c | ||
HostnameMeter.h | ||
IncSet.c | ||
IncSet.h | ||
InfoScreen.c | ||
InfoScreen.h | ||
ListItem.c | ||
ListItem.h | ||
LoadAverageMeter.c | ||
LoadAverageMeter.h | ||
Macros.h | ||
MainPanel.c | ||
MainPanel.h | ||
Makefile.am | ||
MemoryMeter.c | ||
MemoryMeter.h | ||
Meter.c | ||
Meter.h | ||
MetersPanel.c | ||
MetersPanel.h | ||
NEWS | ||
NetworkIOMeter.c | ||
NetworkIOMeter.h | ||
Object.c | ||
Object.h | ||
OpenFilesScreen.c | ||
OpenFilesScreen.h | ||
OptionItem.c | ||
OptionItem.h | ||
Panel.c | ||
Panel.h | ||
Process.c | ||
Process.h | ||
ProcessList.c | ||
ProcessList.h | ||
ProcessLocksScreen.c | ||
ProcessLocksScreen.h | ||
ProvideCurses.h | ||
README | ||
README.md | ||
RichString.c | ||
RichString.h | ||
ScreenManager.c | ||
ScreenManager.h | ||
Settings.c | ||
Settings.h | ||
SignalsPanel.c | ||
SignalsPanel.h | ||
SwapMeter.c | ||
SwapMeter.h | ||
SysArchMeter.c | ||
SysArchMeter.h | ||
TESTPLAN | ||
TasksMeter.c | ||
TasksMeter.h | ||
TraceScreen.c | ||
TraceScreen.h | ||
UptimeMeter.c | ||
UptimeMeter.h | ||
UsersTable.c | ||
UsersTable.h | ||
Vector.c | ||
Vector.h | ||
XUtils.c | ||
XUtils.h | ||
autogen.sh | ||
configure.ac | ||
htop.1.in | ||
htop.c | ||
htop.desktop | ||
htop.png | ||
htop.svg | ||
pcp-htop.c | ||
test_spec.lua |
README.md
Introduction
htop
is a cross-platform interactive process viewer.
htop
allows scrolling the list of processes vertically and horizontally to see their full command lines and related information like memory and CPU consumption.
The information displayed is configurable through a graphical setup and can be sorted and filtered interactively.
Tasks related to processes (e.g. killing and renicing) can be done without entering their PIDs.
Running htop
requires ncurses
libraries (typically named libncursesw*).
For more information and details on how to contribute to htop
visit htop.dev.
Build instructions
This program is distributed as a standard GNU autotools-based package.
Compiling htop
requires the header files for ncurses
(libncursesw*-dev). Install these and other required packages for C development from your package manager.
Then, when compiling from a release tarball, run:
./configure && make
Alternatively, for compiling sources downloaded from the Git repository (git clone
or downloads from Github releases),
install the header files for ncurses
(libncursesw*-dev) and other required development packages from your distribution's package manager. Then run:
./autogen.sh && ./configure && make
By default make install
will install into /usr/local
, for changing the path use ./configure --prefix=/some/path
.
Build Options
htop
has several build-time options to enable/disable additional features.
Generic
--enable-unicode
: enable Unicode support dependency: libncursesw default: yes--enable-hwloc
: enable hwloc support for CPU affinity; disables Linux affinity dependency: libhwloc default: no--enable-static
: build a static htop binary; hwloc and delay accounting are not supported default: no--enable-debug
: Enable asserts and internal sanity checks; implies a performance penalty default: no
Linux
--enable-sensors
: enable libsensors(3) support for reading temperature data dependencies: libsensors-dev(build-time), at runtime libsensors is loaded viadlopen(3)
if available default: check--enable-capabilities
: enable Linux capabilities support dependency: libcap default: check--with-proc
: location of a Linux-compatible proc filesystem default: /proc--enable-openvz
: enable OpenVZ support default: no--enable-vserver
: enable VServer support default: no--enable-ancient-vserver
: enable ancient VServer support (implies--enable-vserver
) default: no--enable-linux-affinity
: enable Linuxsched_setaffinity(2)
andsched_getaffinity(2)
for affinity support; conflicts with hwloc default: check--enable-delayacct
: enable Linux delay accounting support dependencies: pkg-config(build-time), libnl-3 and libnl-genl-3 default: check
Usage
See the manual page (man htop
) or the on-line help ('F1' or 'h' inside htop
) for a list of supported key commands.
Support
If you have trouble running htop
please consult your Operating System / Linux distribution documentation for getting support and filing bugs.
Bugs, development feedback
We have a development mailing list. Feel free to subscribe for release announcements or asking questions on the development of htop.
You can also join our IRC channel #htop on Libera.Chat and talk to the developers there.
If you have found an issue with the source of htop, please check whether this has already been reported in our Github issue tracker. If not, please file a new issue describing the problem you have found, the location in the source code you are referring to and a possible fix.
History
htop
was invented, developed and maintained by Hisham Muhammad from 2004 to 2019. His legacy repository has been archived to preserve the history.
In 2020 a team took over the development amicably and continues to maintain htop
collaboratively.
License
GNU General Public License, version 2 (GPL-2.0)