htop - an interactive process viewer
Go to file
Nathan Scott 04da92dfd1 docs: updates and new manual page for pcp-htop
Add some words about pcp-htop to the main man page, and add a
new man page describing the pcp-htop configuration files that
allow new meters and columns to be defined at runtime.
2021-08-03 14:11:21 +10:00
.github Do not install recommended packages by default for the CI 2021-06-12 15:27:52 +02:00
darwin Pointer indication aligned to typename 2021-07-15 06:57:24 +02:00
docs Add a section on PRs for the styleguide 2021-06-26 11:11:13 +02:00
dragonflybsd DragonFlyBSD: fixup: ProcessList_new declaration & definition mismatch 2021-07-18 12:41:11 +02:00
freebsd Code indentation 2021-07-15 06:57:24 +02:00
generic Align descriptive comments 2021-07-15 06:57:24 +02:00
iwyu Add sys/dirent.h to iwyu/htop.imp 2020-12-11 20:57:19 +01:00
linux Use PATH lookup for systemctl in systemd meter 2021-07-15 10:21:12 +02:00
netbsd Fix indentation style 2021-07-21 21:06:58 +02:00
openbsd Whitespace around operators 2021-07-15 06:57:24 +02:00
pcp PCP: fixup: missing setter for isUserlandThread 2021-07-18 10:28:52 +02:00
scripts Track file descriptors in valgrind script 2020-11-25 22:09:39 +01:00
solaris Align descriptive comments 2021-07-15 06:57:24 +02:00
unsupported Pointer indication aligned to typename 2021-07-15 06:57:24 +02:00
zfs platform-dependent files included relative to main source directory 2021-05-10 18:40:53 +02:00
.editorconfig Add `trim_trailing_whitespace` to editorconfig 2019-10-31 11:39:57 -05:00
.gitignore docs: updates and new manual page for pcp-htop 2021-08-03 14:11:21 +10:00
.travis.yml travis CI: drop macOS and Linux builds 2020-12-08 16:07:45 +01:00
AUTHORS Update AUTHORS file with htop-dev team 2020-12-05 11:07:32 +01:00
Action.c Whitespace around operators 2021-07-15 06:57:24 +02:00
Action.h Use MainPanel type in State struct 2021-02-05 14:12:49 +01:00
Affinity.c Use `#if defined()` syntax when `#elif defined()` is present 2021-03-21 21:49:04 +01:00
Affinity.h Use unsigned types for CPU counts and associated variables 2021-03-19 23:30:54 +01:00
AffinityPanel.c Use unsigned types for CPU counts and associated variables 2021-03-19 23:30:54 +01:00
AffinityPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
AvailableColumnsPanel.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
AvailableColumnsPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
AvailableMetersPanel.c Pointer indication aligned to typename 2021-07-15 06:57:24 +02:00
AvailableMetersPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
BatteryMeter.c Save text buffer in Meter 2021-03-04 23:57:45 +01:00
BatteryMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
CONTRIBUTING.md Adjust to current label reality and the fact that Github can't search for multiple labels ORed ... yet. 2021-05-14 11:29:29 +02:00
COPYING Remove trailing whitespaces 2020-08-21 10:37:33 +02:00
CPUMeter.c Add a new DynamicMeter class for runtime Meter extension 2021-07-07 10:59:36 +10:00
CPUMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
CRT.c netbsd: Support curses libraries without ncurses mouse support 2021-07-15 19:09:08 +02:00
CRT.h Add a new DynamicMeter class for runtime Meter extension 2021-07-07 10:59:36 +10:00
CategoriesPanel.c Allow to pass '/' for item search 2020-12-03 22:41:31 +01:00
CategoriesPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
ChangeLog Change 3.0.6-dev -> 3.1.0-dev 2021-06-18 07:52:44 +02:00
ClockMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
ClockMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
ColorsPanel.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
ColorsPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
ColumnsPanel.c Mark several non-modified pointer variables const 2021-01-11 20:12:34 +01:00
ColumnsPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
CommandLine.c Disable mouse option when support is unavailable 2021-07-15 19:09:08 +02:00
CommandLine.h Abstract htop main function to allow for a platform binary 2021-03-25 15:56:15 +11:00
CommandScreen.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
CommandScreen.h Make all required includes explicit 2020-10-18 20:09:05 +02:00
Compat.c DragonFlyBSD: resolve sign comparison 2021-04-14 17:29:56 +02:00
Compat.h Request the realtime and monotonic clock times once per sample 2021-04-05 23:41:07 +02:00
DateMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
DateMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
DateTimeMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
DateTimeMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
DiskIOMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
DiskIOMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
DisplayOptionsPanel.c Disable mouse option when support is unavailable 2021-07-15 19:09:08 +02:00
DisplayOptionsPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
DynamicMeter.c PCP: fixup: Missing headers for DynamicMeter 2021-07-18 09:36:59 +02:00
DynamicMeter.h PCP: fixup: Missing headers for DynamicMeter 2021-07-18 09:36:59 +02:00
EnvScreen.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
EnvScreen.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
FunctionBar.c Rework drawing of FunctionBar 2020-12-20 17:01:50 +01:00
FunctionBar.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
Hashtable.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
Hashtable.h Hashtable: widen size from int to size_t 2021-01-06 16:59:28 +01:00
Header.c Ensure PCP dynamic metric configuration definition uniqueness 2021-07-14 11:58:46 +10:00
Header.h Ensure we do not attempt to add a DynamicMeter via the 2021-07-14 11:58:31 +10:00
HostnameMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
HostnameMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
IncSet.c Mark several non-modified pointer variables const 2021-01-11 20:12:34 +01:00
IncSet.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
InfoScreen.c netbsd: Support curses libraries without ncurses mouse support 2021-07-15 19:09:08 +02:00
InfoScreen.h InfoScreen: drop unused member 2020-12-21 22:34:50 +01:00
ListItem.c Code indentation 2021-07-15 06:57:24 +02:00
ListItem.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
LoadAverageMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
LoadAverageMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
Macros.h Check for alloc_size attribute in configure.ac 2021-07-06 17:20:32 +02:00
MainPanel.c Make MainPanel_pidSearch a static function 2021-04-21 20:58:28 +02:00
MainPanel.h Make MainPanel_pidSearch a static function 2021-04-21 20:58:28 +02:00
Makefile.am Add a new DynamicMeter class for runtime Meter extension 2021-07-07 10:59:36 +10:00
MemoryMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
MemoryMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
Meter.c Whitespace around operators 2021-07-15 06:57:24 +02:00
Meter.h Pointer indication aligned to typename 2021-07-15 06:57:24 +02:00
MetersPanel.c Mark several non-modified pointer variables const 2021-01-11 23:47:00 +01:00
MetersPanel.h Make all required includes explicit 2020-10-18 20:09:05 +02:00
NEWS Remove trailing whitespaces 2020-08-21 10:37:33 +02:00
NetworkIOMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
NetworkIOMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
Object.c Allow meters in text mode to span empty neighbors to the right 2021-01-23 15:20:47 +01:00
Object.h Object: always include stdbool.h 2021-03-12 16:38:36 +01:00
OpenFilesScreen.c Make Infoscreens the correct height 2021-01-11 12:53:07 +01:00
OpenFilesScreen.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
OptionItem.c Use RichString_appendnAscii where possible 2021-04-26 17:51:45 +02:00
OptionItem.h Add support to change numeric options in settings screen 2020-11-25 20:46:27 +01:00
Panel.c Whitespace around operators 2021-07-15 06:57:24 +02:00
Panel.h Mark several non-modified pointer variables const 2021-01-11 20:12:34 +01:00
Process.c Respect "Show custom thread names" setting 2021-07-17 20:59:50 +02:00
Process.h Respect "Show custom thread names" setting 2021-07-17 20:59:50 +02:00
ProcessList.c Pointer indication aligned to typename 2021-07-15 06:57:24 +02:00
ProcessList.h Add a new DynamicMeter class for runtime Meter extension 2021-07-07 10:59:36 +10:00
ProcessLocksScreen.c Make Infoscreens the correct height 2021-01-11 12:53:07 +01:00
ProcessLocksScreen.h IWYU update (Linux) 2020-11-19 23:51:50 +01:00
ProvideCurses.h Use consistent style for include check 2021-03-19 22:39:06 +01:00
README Minor README wordsmithing on review of recent deps/build changes 2021-07-16 12:48:07 +10:00
README.md Add README.md for Github 2014-02-03 09:11:39 -02:00
RichString.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
RichString.h Enclose macro argument 2021-05-10 17:48:05 +02:00
ScreenManager.c netbsd: Support curses libraries without ncurses mouse support 2021-07-15 19:09:08 +02:00
ScreenManager.h Mark several non-modified pointer variables const 2021-01-11 20:12:34 +01:00
Settings.c Disable mouse option when support is unavailable 2021-07-15 19:09:08 +02:00
Settings.h Disable mouse option when support is unavailable 2021-07-15 19:09:08 +02:00
SignalsPanel.c Panel_new: reorder arguments 2021-01-04 23:12:43 +01:00
SignalsPanel.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
SwapMeter.c Remove Linux-specific cpp conditional in SwapMeter.c 2021-07-07 14:24:32 +10:00
SwapMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
SysArchMeter.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
SysArchMeter.h [#480] SysArchMeter to view kernel/arch info 2021-01-31 20:08:09 +01:00
TESTPLAN Small update to test plan 2021-02-13 14:04:15 +01:00
TasksMeter.c Use RichString_appendnAscii where possible 2021-04-26 17:51:45 +02:00
TasksMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
TraceScreen.c cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
TraceScreen.h Mark several non-modified pointer variables const 2021-01-11 20:12:34 +01:00
UptimeMeter.c Save text buffer in Meter 2021-03-04 23:57:45 +01:00
UptimeMeter.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
UsersTable.c Hashtable: use dynamic growth and use primes as size 2020-11-17 02:01:02 +01:00
UsersTable.h cleaned up includes with iwyu 2021-05-10 18:40:53 +02:00
Vector.c Avoid calling Object_isA from inside Vector_isConsistent 2020-11-17 08:06:02 +01:00
Vector.h Code indentation 2021-07-15 06:57:24 +02:00
XUtils.c Pointer indication aligned to typename 2021-07-15 06:57:24 +02:00
XUtils.h Pointer indication aligned to typename 2021-07-15 06:57:24 +02:00
autogen.sh autotools: enable warnings and cleanup 2020-09-17 21:45:11 +02:00
configure.ac docs: updates and new manual page for pcp-htop 2021-08-03 14:11:21 +10:00
htop.1.in docs: updates and new manual page for pcp-htop 2021-08-03 14:11:21 +10:00
htop.c Abstract htop main function to allow for a platform binary 2021-03-25 15:56:15 +11:00
htop.desktop Add danish translation to htop.desktop 2019-02-19 01:25:52 +01:00
htop.png Update htop logo, provide .svg file as well 2020-12-05 13:46:34 +01:00
htop.svg Update htop logo, provide .svg file as well 2020-12-05 13:46:34 +01:00
pcp-htop.5.in docs: updates and new manual page for pcp-htop 2021-08-03 14:11:21 +10:00
pcp-htop.c Resolve some Coverity scan misfires in PCP platform code 2021-06-09 17:09:29 +10:00
test_spec.lua Remove trailing whitespaces 2020-08-21 10:37:33 +02:00

README.md

htop

CI Coverity Scan Build Status Mailing List IRC #htop Github Release

Screenshot of htop

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

Prerequisite

List of build-time dependencies:

  • build-essential standard GNU autotools-based
  • autoconf
  • autotools
  • ncurses

Note about ncurses:

htop requires ncurses 6.0. Be aware the appropriate package is sometimes still called libncurses5 (on Debian/Ubuntu). Also ncurses 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

Compiling htop requires the header files for ncurses . Install these and other required packages for C development from your package manager.

Debian/Ubuntu

sudo apt install libncursesw5-dev autotools-dev autoconf

Fedora/RHEL

sudo dnf install ncurses-devel automake autoconf

Compiling from source:

To compile from sources downloaded from the Git repository (git clone or downloads from Github releases), then run:

./autogen.sh && ./configure && make

By default make install will install into /usr/local, for changing the path use ./configure --prefix=/some/path.

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-pcp: enable Performance Co-Pilot support via a new pcp-htop utility dependency: libpcp default: no
  • --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 via dlopen(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 Linux sched_setaffinity(2) and sched_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

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:

  • libdl, if not building static and support for some of the optional libraries is enabled, is always required when support for to optionally load dependencies (i.e. libsensors, systemd) is present.
  • libcap, user-space interfaces to the POSIX 1003.1e, is always required when --enable-capabilities was used to configure htop.
  • libsensors, readout of temperatures and CPU speeds, is optional even when --enable-sensors was used to configure htop.
  • systemd is optional when --enable-static was not used to configure htop (Linux only). If building statically and libsystemd is not found by configure support for the SystemD meter is disabled entirely.

htop checks for the availability of the actual runtime lib as htop runs.

BSD On most *BSD systems you also have kvm as a static requirement to read all the kernel information.

More information on required and optional dependencies can be found in configure.ac.

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)