61227793de
htop has been licensed as GPLv2 but there was inconsistency regarding the option to choose "any later version" as granted by the license. This commit clarifies the htop dev team is fine with that choice. |
||
---|---|---|
.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 | ||
DynamicColumn.c | ||
DynamicColumn.h | ||
DynamicMeter.c | ||
DynamicMeter.h | ||
EnvScreen.c | ||
EnvScreen.h | ||
FunctionBar.c | ||
FunctionBar.h | ||
Hashtable.c | ||
Hashtable.h | ||
Header.c | ||
Header.h | ||
HeaderLayout.h | ||
HeaderOptionsPanel.c | ||
HeaderOptionsPanel.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 | ||
MemorySwapMeter.c | ||
MemorySwapMeter.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.5.in | ||
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.
Also system wide information, like load average or swap usage, is shown.
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 libncurses(w).
htop
is written in C.
For more information and details visit htop.dev.
Build instructions
Prerequisite
List of build-time dependencies:
- standard GNU autotools-based C toolchain
- C99 compliant compiler
autoconf
autotools
ncurses
Note about ncurses
:
htop
requiresncurses
6.0. Be aware the appropriate package is sometimes still called libncurses5 (on Debian/Ubuntu). Alsoncurses
usually comes in two flavours:
- With Unicode support.
- Without Unicode support.
This is also something that is reflected in the package name on Debian/Ubuntu (via the additional 'w' - 'w'ide character support).
List of additional build-time dependencies (based on feature flags):
sensors
hwloc
libcap
libnl-3
Install these and other required packages for C development from your package manager.
Debian/Ubuntu
sudo apt install libncursesw5-dev autotools-dev autoconf build-essential
Fedora/RHEL
sudo dnf install ncurses-devel automake autoconf gcc
Compile from source:
To compile from source, download from the Git repository (git clone
or downloads from GitHub releases), then run:
./autogen.sh && ./configure && make
Install
To install on the local system run make install
. By default make install
installs into /usr/local
. To change this 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-affinity
: enablesched_setaffinity(2)
andsched_getaffinity(2)
for affinity support; conflicts with hwloc- default: check
--enable-hwloc
: enable hwloc support for CPU affinity; disables affinity support- 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
Performance Co-Pilot
--enable-pcp
: enable Performance Co-Pilot support via a new pcp-htop utility- dependency: libpcp
- default: no
Linux
--enable-sensors
: enable libsensors(3) support for reading temperature data- dependencies: libsensors-dev(build-time), at runtime libsensors is loaded via
dlopen(3)
if available - default: check
- dependencies: libsensors-dev(build-time), at runtime libsensors is loaded via
--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-delayacct
: enable Linux delay accounting support- dependencies: pkg-config(build-time), libnl-3 and libnl-genl-3
- default: check
Runtime dependencies:
htop
has a set of fixed minimum runtime dependencies, which is kept as minimal as possible:
ncurses
libraries for terminal handling (wide character support).
Runtime optional dependencies:
htop
has a set of fixed optional dependencies, depending on build/configure option used:
Linux
libdl
, if not building a static binary, is always required when support for optional dependencies (i.e.libsensors
,libsystemd
) is present.libcap
, user-space interfaces to POSIX 1003.1e capabilities, is always required when--enable-capabilities
was used to configurehtop
.libsensors
, readout of temperatures and CPU speeds, is optional even when--enable-sensors
was used to configurehtop
.libsystemd
is optional when--enable-static
was not used to configurehtop
. If building statically andlibsystemd
is not found byconfigure
, support for the systemd meter is disabled entirely.
htop
checks for the availability of the actual runtime libraries as htop
runs.
BSD
On most BSD systems kvm
is a requirement to read kernel information.
More information on required and optional dependencies can be found in configure.ac.
Usage
See the manual page (man htop
) or the help menu (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 within 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 potential location in the source code you are referring to and a possible fix if available.
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) or, at your option, any later version.