btop/README.md

1014 lines
31 KiB
Markdown
Raw Normal View History

2021-05-06 20:32:03 +02:00
# ![btop++](Img/logo.png)
2021-09-26 21:12:46 +02:00
<a href="https://repology.org/project/btop/versions">
<img src="https://repology.org/badge/vertical-allrepos/btop.svg" alt="Packaging status" align="right">
</a>
2021-05-06 20:32:03 +02:00
![Linux](https://img.shields.io/badge/-Linux-grey?logo=linux)
![macOS](https://img.shields.io/badge/-OSX-black?logo=apple)
2021-11-14 01:23:12 +01:00
![FreeBSD](https://img.shields.io/badge/-FreeBSD-red?logo=freebsd)
2021-05-06 20:32:03 +02:00
![Usage](https://img.shields.io/badge/Usage-System%20resource%20monitor-yellow)
![c++20](https://img.shields.io/badge/cpp-c%2B%2B20-green)
2021-09-30 22:56:14 +02:00
![latest_release](https://img.shields.io/github/v/tag/aristocratos/btop?label=release)
2021-05-06 20:32:03 +02:00
[![Donate](https://img.shields.io/badge/-Donate-yellow?logo=paypal)](https://paypal.me/aristocratos)
[![Sponsor](https://img.shields.io/badge/-Sponsor-red?logo=github)](https://github.com/sponsors/aristocratos)
[![Coffee](https://img.shields.io/badge/-Buy%20me%20a%20Coffee-grey?logo=Ko-fi)](https://ko-fi.com/aristocratos)
2021-09-26 19:46:27 +02:00
[![btop](https://snapcraft.io/btop/badge.svg)](https://snapcraft.io/btop)
2021-11-14 01:23:12 +01:00
[![Continuous Build Linux](https://github.com/aristocratos/btop/actions/workflows/continuous-build-linux.yml/badge.svg)](https://github.com/aristocratos/btop/actions/workflows/continuous-build-linux.yml)
[![Continuous Build macOS](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml/badge.svg)](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml)
2022-11-06 10:34:05 +01:00
[![Continuous Build FreeBSD](https://github.com/aristocratos/btop/actions/workflows/continuous-build-freebsd.yml/badge.svg)](https://github.com/aristocratos/btop/actions/workflows/continuous-build-freebsd.yml)
2021-10-05 14:01:10 +02:00
2021-05-06 20:32:03 +02:00
## Index
2021-10-05 14:01:10 +02:00
* [News](#news)
* [Documents](#documents)
* [Description](#description)
* [Features](#features)
* [Themes](#themes)
* [Support and funding](#support-and-funding)
* [Prerequisites](#prerequisites) (Read this if you are having issues!)
* [Screenshots](#screenshots)
* [Keybindings](#help-menu)
* [Installation Linux/macOS](#installation)
2021-11-15 21:58:09 +01:00
* [Compilation Linux](#compilation-linux)
* [Compilation macOS](#compilation-macos-osx)
2022-01-16 14:19:31 +01:00
* [Compilation FreeBSD](#compilation-freebsd)
2021-11-14 01:23:12 +01:00
* [Installing the snap](#installing-the-snap)
2021-10-05 14:01:10 +02:00
* [Configurability](#configurability)
* [License](#license)
2021-05-06 20:32:03 +02:00
## News
2022-08-28 20:38:47 +02:00
##### 28 August 2022
[![btop4win](https://github.com/aristocratos/btop4win/raw/master/Img/logo.png)](https://github.com/aristocratos/btop4win)
First release of btop4win available at https://github.com/aristocratos/btop4win
2022-01-16 14:19:31 +01:00
##### 16 January 2022
Release v1.2.0 with FreeBSD support. No release binaries for FreeBSD provided as of yet.
Again a big thanks to [@joske](https://github.com/joske) for his porting efforts!
Since compatibility with Linux, macOS and FreeBSD are done, the focus going forward will be on new features like GPU monitoring.
2021-09-17 22:08:39 +02:00
2021-11-14 01:23:12 +01:00
##### 13 November 2021
Release v1.1.0 with macOS support. Binaries in [continuous-build-macos](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml) are only x86 for now.
macOS binaries + installer are included for both x86 and ARM64 (Apple Silicon) in the releases.
2021-11-14 01:23:12 +01:00
Big thank you to [@joske](https://github.com/joske) who wrote the vast majority of the implementation!
<details>
<summary>More...</summary>
2021-10-30 18:17:18 +02:00
##### 30 October 2021
Work on the OSX [macOS] and FreeBSD branches, both initiated and mostly worked on by [@joske](https://github.com/joske), will likely be completed in the coming weeks.
The OSX [macOS] branch has some memory leaks that needs to be sorted out and both have some issues with the processes cpu usage calculation and other smaller issues that needs fixing.
2021-10-30 18:17:18 +02:00
If you want to help out, test for bugs/fix bugs or just try out the branches:
**macOS / OSX**
2021-10-30 18:17:18 +02:00
```bash
# Install and use Homebrew or MacPorts package managers for easy dependency installation
brew install coreutils make gcc@11
git clone https://github.com/aristocratos/btop.git
2021-10-30 18:17:18 +02:00
cd btop
git checkout OSX
2021-10-30 18:17:18 +02:00
gmake
```
**FreeBSD**
```bash
sudo pkg install gmake gcc11 coreutils git
git clone https://github.com/aristocratos/btop.git
2021-10-30 18:17:18 +02:00
cd btop
git checkout freebsd
gmake
```
Note that GNU make (`gmake`) is recommended but not required for macOS/OSX but it is required on FreeBSD.
2021-10-30 18:17:18 +02:00
2021-10-06 17:16:49 +02:00
##### 6 October 2021
macOS development have been started by [@joske](https://github.com/joske), big thanks :)
2021-10-06 17:16:49 +02:00
See branch [OSX](https://github.com/aristocratos/btop/tree/OSX) for current progress.
##### 18 September 2021
The Linux version of btop++ is complete. Released as version 1.0.0
I will be providing statically compiled binaries for a range of architectures in every release for those having problems compiling.
For compilation GCC 10 is required, GCC 11 preferred.
Please report any bugs to the [Issues](https://github.com/aristocratos/btop/issues/new?assignees=aristocratos&labels=bug&template=bug_report.md&title=%5BBUG%5D) page.
The development plan right now:
* 1.1.0 macOS [OSX] support
* 1.2.0 FreeBSD support
* 1.3.0 Support for GPU monitoring
* 1.X.0 Other platforms and features...
Windows support is not in the plans as of now, but if anyone else wants to take it on, I will try to help.
2021-05-06 20:32:03 +02:00
##### 5 May 2021
2021-05-30 21:46:10 +02:00
This project is gonna take some time until it has complete feature parity with bpytop, since all system information gathering will have to be written from scratch without any external libraries.
And will need some help in the form of code contributions to get complete support for BSD and macOS/OSX.
2021-05-06 20:32:03 +02:00
2021-11-14 01:23:12 +01:00
</details>
2021-05-06 20:32:03 +02:00
## Documents
2021-09-17 22:08:39 +02:00
**[CHANGELOG.md](CHANGELOG.md)**
2021-05-06 20:32:03 +02:00
2021-09-17 22:08:39 +02:00
**[CONTRIBUTING.md](CONTRIBUTING.md)**
2021-05-06 20:32:03 +02:00
2021-09-17 22:08:39 +02:00
**[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)**
2021-05-06 20:32:03 +02:00
## Description
Resource monitor that shows usage and stats for processor, memory, disks, network and processes.
C++ version and continuation of [bashtop](https://github.com/aristocratos/bashtop) and [bpytop](https://github.com/aristocratos/bpytop).
2021-09-17 21:50:14 +02:00
## Features
2021-05-06 20:32:03 +02:00
* Easy to use, with a game inspired menu system.
* Full mouse support, all buttons with a highlighted key is clickable and mouse scroll works in process list and menu boxes.
* Fast and responsive UI with UP, DOWN keys process selection.
* Function for showing detailed stats for selected process.
* Ability to filter processes.
2021-05-06 20:32:03 +02:00
* Easy switching between sorting options.
* Tree view of processes.
* Send any signal to selected process.
2021-05-06 20:32:03 +02:00
* UI menu for changing all config file options.
* Auto scaling graph for network usage.
* Shows IO activity and speeds for disks.
* Battery meter
* Selectable symbols for the graphs.
* Custom presets
* And more...
2021-05-06 20:32:03 +02:00
## Themes
Btop++ uses the same theme files as bpytop and bashtop (some color values missing in bashtop themes) .
2023-05-11 16:09:06 +02:00
See [themes](https://github.com/aristocratos/btop/tree/main/themes) folder for available themes.
2021-05-06 20:32:03 +02:00
The `make install` command places the default themes in `[$PREFIX or /usr/local]/share/btop/themes`.
2021-05-30 21:46:10 +02:00
User created themes should be placed in `$XDG_CONFIG_HOME/btop/themes` or `$HOME/.config/btop/themes`.
2021-05-06 20:32:03 +02:00
Let me know if you want to contribute with new themes.
## Support and funding
You can sponsor this project through github, see [my sponsors page](https://github.com/sponsors/aristocratos) for options.
Or donate through [paypal](https://paypal.me/aristocratos) or [ko-fi](https://ko-fi.com/aristocratos).
Any support is greatly appreciated!
## Prerequisites
For best experience, a terminal with support for:
2021-05-06 20:32:03 +02:00
* 24-bit truecolor ([See list of terminals with truecolor support](https://github.com//termstandard/colors))
* 256-color terminals are supported through 24-bit to 256-color conversion when setting "truecolor" to False in the options or with "-lc/--low-color" arguments.
* 16 color TTY mode will be activated if a real tty device is detected. Can be forced with "-t/--tty_on" arguments.
2021-05-06 20:32:03 +02:00
* Wide characters (Are sometimes problematic in web-based terminals)
Also needs a UTF8 locale and a font that covers:
* Unicode Block “Braille Patterns” U+2800 - U+28FF (Not needed in TTY mode or with graphs set to type: block or tty.)
2021-05-06 20:32:03 +02:00
* Unicode Block “Geometric Shapes” U+25A0 - U+25FF
* Unicode Block "Box Drawing" and "Block Elements" U+2500 - U+259F
2021-09-17 21:50:14 +02:00
### **Notice (Text rendering issues)**
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* If you are having problems with the characters in the graphs not looking like they do in the screenshots, it's likely a problem with your systems configured fallback font not having support for braille characters.
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* See [Terminess Powerline](https://github.com/ryanoasis/nerd-fonts/tree/master/patched-fonts/Terminus/terminus-ttf-4.40.1) for an example of a font that includes the braille symbols.
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* See comments by @sgleizes [link](https://github.com/aristocratos/bpytop/issues/100#issuecomment-684036827) and @XenHat [link](https://github.com/aristocratos/bpytop/issues/100#issuecomment-691585587) in issue #100 for possible solutions.
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* If text are misaligned and you are using Konsole or Yakuake, turning off "Bi-Directional text rendering" is a possible fix.
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* Characters clipping in to each other or text/border misalignments is not bugs caused by btop, but most likely a fontconfig or terminal problem where the braille characters making up the graphs aren't rendered correctly.
2021-09-17 21:50:14 +02:00
* Look to the creators of the terminal emulator you use to fix these issues if the previous mentioned fixes don't work for you.
2021-05-06 20:32:03 +02:00
## Screenshots
2021-09-17 22:08:39 +02:00
#### Main UI showing details for a selected process
2021-09-17 21:50:14 +02:00
![Screenshot 1](Img/normal.png)
2021-09-17 22:08:39 +02:00
#### Main UI in TTY mode
2021-09-17 21:50:14 +02:00
![Screenshot 2](Img/tty.png)
2021-09-17 22:08:39 +02:00
#### Main UI with custom options
2021-09-17 21:50:14 +02:00
![Screenshot 3](Img/alt.png)
2021-09-17 22:08:39 +02:00
#### Main-menu
2021-09-17 21:50:14 +02:00
![Screenshot 3](Img/main-menu.png)
2021-09-17 22:08:39 +02:00
#### Options-menu
2021-09-17 21:50:14 +02:00
![Screenshot 4](Img/options-menu.png)
2021-09-17 22:08:39 +02:00
#### Help-menu
2021-09-17 21:50:14 +02:00
![Screenshot 5](Img/help-menu.png)
2021-11-14 01:30:27 +01:00
## Installation
2021-09-17 21:50:14 +02:00
2021-11-14 01:23:12 +01:00
**Binaries for Linux are statically compiled with musl and works on kernel 2.6.39 and newer**
2021-09-17 21:50:14 +02:00
2021-11-14 01:23:12 +01:00
1. **Download btop-(VERSION)-(ARCH)-(PLATFORM).tbz from [latest release](https://github.com/aristocratos/btop/releases/latest) and unpack to a new folder**
2021-09-17 21:50:14 +02:00
2021-11-03 22:01:49 +01:00
**Notice! Use x86_64 for 64-bit x86 systems, i486 and i686 are 32-bit!**
2021-09-17 21:50:14 +02:00
2. **Install (from created folder)**
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* **Run install.sh or:**
2021-05-06 20:32:03 +02:00
```bash
2021-09-17 21:50:14 +02:00
# use "make install PREFIX=/target/dir" to set target, default: /usr/local
# only use "sudo" when installing to a NON user owned directory
sudo make install
```
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
3. **(Optional) Set suid bit to make btop always run as root (or other user)**
2021-05-06 20:32:03 +02:00
2021-09-18 02:13:35 +02:00
Enables signal sending to any process without starting with `sudo` and can prevent /proc read permissions problems on some systems.
2021-09-17 21:50:14 +02:00
* **Run setuid.sh or:**
```bash
2021-09-17 21:50:14 +02:00
# run after make install and use same PREFIX if any was used at install
# set SU_USER and SU_GROUP to select user and group, default is root:root
sudo make setuid
```
2021-09-17 22:08:39 +02:00
* **Uninstall**
2021-09-17 21:50:14 +02:00
2021-09-17 22:08:39 +02:00
* **Run uninstall.sh or:**
2021-09-17 21:50:14 +02:00
```bash
2021-09-17 21:50:14 +02:00
sudo make uninstall
```
2021-09-18 02:13:35 +02:00
* **Show help**
```bash
make help
```
2021-09-29 06:50:16 +02:00
**Binary release (from native os repo)**
* **openSUSE**
* **Tumbleweed:**
```bash
sudo zypper in btop
```
* For all other versions, see [openSUSE Software: btop](https://software.opensuse.org/package/btop)
2022-07-28 16:26:03 +02:00
* **Fedora**
```bash
sudo dnf install btop
```
* **RHEL/AlmaLinux 8+**
```bash
sudo dnf install epel-release
sudo dnf install btop
```
2022-08-23 04:27:21 +02:00
* **FreeBSD**
```sh
pkg install btop
```
2021-09-29 06:50:16 +02:00
**Binary release on Homebrew (macOS (x86_64 & ARM64) / Linux (x86_64))**
* **[Homebrew](https://formulae.brew.sh/formula/btop)**
```bash
brew install btop
```
2021-11-14 01:23:12 +01:00
## Compilation Linux
2021-09-17 21:50:14 +02:00
2021-09-17 22:08:39 +02:00
Needs GCC 10 or higher, (GCC 11 or above strongly recommended for better CPU efficiency in the compiled binary).
2021-05-06 20:32:03 +02:00
2021-09-18 02:13:35 +02:00
The makefile also needs GNU coreutils and `sed` (should already be installed on any modern distribution).
<details>
<summary>
### With Make
</summary>
2021-10-17 20:25:46 +02:00
2021-09-17 21:50:14 +02:00
1. **Install dependencies (example for Ubuntu 21.04 Hirsute)**
2021-10-17 20:25:46 +02:00
Use gcc-10 g++-10 if gcc-11 isn't available
```bash
2021-09-17 21:50:14 +02:00
sudo apt install coreutils sed git build-essential gcc-11 g++-11
```
2021-05-30 21:46:10 +02:00
2021-09-17 21:50:14 +02:00
2. **Clone repository**
2021-08-28 22:13:03 +02:00
```bash
git clone https://github.com/aristocratos/btop.git
2021-09-17 21:50:14 +02:00
cd btop
```
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
3. **Compile**
2021-05-06 20:32:03 +02:00
2022-10-10 12:34:06 +02:00
Append `VERBOSE=true` to display full compiler/linker commands.
2022-10-10 12:35:30 +02:00
Append `STATIC=true` for static compilation.
2021-09-18 02:13:35 +02:00
2021-10-17 20:25:46 +02:00
Notice! If using LDAP Authentication, usernames will show as UID number for LDAP users if compiling statically with glibc.
Append `QUIET=true` for less verbose output.
Append `STRIP=true` to force stripping of debug symbols (adds `-s` linker flag).
Append `ARCH=<architecture>` to manually set the target architecture.
If omitted the makefile uses the machine triple (output of `-dumpmachine` compiler parameter) to detect the target system.
2021-09-18 02:13:35 +02:00
Use `ADDFLAGS` variable for appending flags to both compiler and linker.
2021-10-17 20:25:46 +02:00
For example: `ADDFLAGS=-march=native` might give a performance boost if compiling only for your own system.
If `g++` is linked to an older version of gcc on your system specify the correct version by appending `CXX=g++-10` or `CXX=g++-11`.
2021-05-06 20:32:03 +02:00
```bash
2021-09-17 21:50:14 +02:00
make
```
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
4. **Install**
2021-08-28 22:13:03 +02:00
2021-10-17 20:25:46 +02:00
Append `PREFIX=/target/dir` to set target, default: `/usr/local`
Notice! Only use "sudo" when installing to a NON user owned directory.
```bash
2021-09-17 21:50:14 +02:00
sudo make install
```
2021-09-17 21:50:14 +02:00
5. **(Optional) Set suid bit to make btop always run as root (or other user)**
2021-09-17 21:50:14 +02:00
No need for `sudo` to enable signal sending to any process and to prevent /proc read permissions problems on some systems.
2021-10-17 20:25:46 +02:00
Run after make install and use same PREFIX if any was used at install.
Set `SU_USER` and `SU_GROUP` to select user and group, default is `root` and `root`
```bash
2021-09-17 21:50:14 +02:00
sudo make setuid
```
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* **Uninstall**
2021-05-06 20:32:03 +02:00
```bash
2021-09-17 21:50:14 +02:00
sudo make uninstall
```
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
* **Remove any object files from source dir**
2021-09-17 21:50:14 +02:00
```bash
make clean
```
* **Remove all object files, binaries and created directories in source dir**
```bash
make distclean
```
2021-09-18 02:13:35 +02:00
* **Show help**
```bash
make help
```
2021-09-26 21:12:46 +02:00
</details>
<details>
<summary>
### With CMake (Community maintained)
</summary>
1. **Install build dependencies**
Requires Clang / GCC, CMake, Ninja and Git
For example, with Debian Bookworm:
```bash
sudo apt install cmake git g++ ninja-build
```
2. **Clone the repository**
```bash
git clone https://github.com/aristocratos/btop.git && cd btop
``````
3. **Compile**
```bash
# Configure
cmake -B build -G Ninja
# Build
cmake --build build
```
This will automatically build a release version of btop.
Some useful options to pass to the configure step:
| Configure flag | Description |
|---------------------------------|-------------------------------------------------------------------------|
| `-DBTOP_STATIC=<ON\|OFF>` | Enables static linking (OFF by default) |
| `-DBTOP_LTO=<ON\|OFF>` | Enables link time optimization (ON by default) |
| `-DBTOP_USE_MOLD=<ON\|OFF>` | Use mold to link btop (OFF by default) |
| `-DBTOP_PEDANTIC=<ON\|OFF>` | Compile with additional warnings (OFF by default) |
| `-DBTOP_WERROR=<ON\|OFF>` | Compile with warnings as errors (OFF by default) |
| `-DCMAKE_INSTALL_PREFIX=<path>` | The installation prefix ('/usr/local' by default) |
To force a compiler, run `CXX=<compiler> cmake -B build -G Ninja`
4. **Install**
```bash
cmake --install build
```
May require root privileges
5. **Uninstall**
CMake doesn't generate an uninstall target by default. To remove installed files, run
```
cat build/install_manifest.txt | xargs rm -irv
```
6. **Cleanup build directory**
```bash
cmake --build build -t clean
```
</details>
## Compilation macOS OSX
2021-11-14 01:23:12 +01:00
Needs GCC 10 or higher, (GCC 11 or above strongly recommended for better CPU efficiency in the compiled binary).
2022-10-28 22:36:24 +02:00
GCC 12 needed for macOS Ventura. If you get linker errors on Ventura you'll need to upgrade your command line tools (Version 14.0) is bugged.
2021-11-14 01:23:12 +01:00
The makefile also needs GNU coreutils and `sed`.
Install and use Homebrew or MacPorts package managers for easy dependency installation
1. **Install dependencies (example for Homebrew)**
```bash
2022-10-28 22:37:53 +02:00
brew install coreutils make gcc@12
2021-11-14 01:23:12 +01:00
```
2. **Clone repository**
```bash
git clone https://github.com/aristocratos/btop.git
2021-11-14 01:23:12 +01:00
cd btop
```
3. **Compile**
2022-10-10 12:34:06 +02:00
Append `VERBOSE=true` to display full compiler/linker commands.
2022-10-10 12:35:30 +02:00
Append `STATIC=true` for static compilation (only libgcc and libstdc++ will be static!).
2021-11-14 01:23:12 +01:00
Append `QUIET=true` for less verbose output.
Append `STRIP=true` to force stripping of debug symbols (adds `-s` linker flag).
Append `ARCH=<architecture>` to manually set the target architecture.
If omitted the makefile uses the machine triple (output of `-dumpmachine` compiler parameter) to detect the target system.
Use `ADDFLAGS` variable for appending flags to both compiler and linker.
For example: `ADDFLAGS=-march=native` might give a performance boost if compiling only for your own system.
```bash
2021-11-14 01:23:12 +01:00
gmake
```
4. **Install**
Append `PREFIX=/target/dir` to set target, default: `/usr/local`
Notice! Only use "sudo" when installing to a NON user owned directory.
```bash
2021-11-14 01:23:12 +01:00
sudo gmake install
```
5. **(Recommended) Set suid bit to make btop always run as root (or other user)**
No need for `sudo` to see information for non user owned processes and to enable signal sending to any process.
Run after make install and use same PREFIX if any was used at install.
Set `SU_USER` and `SU_GROUP` to select user and group, default is `root` and `wheel`
```bash
2021-11-14 01:23:12 +01:00
sudo gmake setuid
```
* **Uninstall**
```bash
2021-11-14 01:23:12 +01:00
sudo gmake uninstall
```
* **Remove any object files from source dir**
```bash
gmake clean
```
* **Remove all object files, binaries and created directories in source dir**
```bash
gmake distclean
```
* **Show help**
```bash
gmake help
```
2022-01-16 14:19:31 +01:00
## Compilation FreeBSD
Needs GCC 10 or higher, (GCC 11 or above strongly recommended for better CPU efficiency in the compiled binary).
Note that GNU make (`gmake`) is required to compile on FreeBSD.
<details>
<summary>
### With gmake
</summary>
2022-01-16 14:19:31 +01:00
1. **Install dependencies**
```bash
2022-01-16 14:19:31 +01:00
sudo pkg install gmake gcc11 coreutils git
```
2. **Clone repository**
```bash
git clone https://github.com/aristocratos/btop.git
2022-01-16 14:19:31 +01:00
cd btop
```
3. **Compile**
2022-10-10 12:34:06 +02:00
Append `VERBOSE=true` to display full compiler/linker commands.
2022-01-16 14:19:31 +01:00
Append `STATIC=true` for static compilation (only libgcc and libstdc++ will be static!).
2022-01-16 14:19:31 +01:00
Append `QUIET=true` for less verbose output.
Append `STRIP=true` to force stripping of debug symbols (adds `-s` linker flag).
Append `ARCH=<architecture>` to manually set the target architecture.
If omitted the makefile uses the machine triple (output of `-dumpmachine` compiler parameter) to detect the target system.
Use `ADDFLAGS` variable for appending flags to both compiler and linker.
For example: `ADDFLAGS=-march=native` might give a performance boost if compiling only for your own system.
```bash
2022-01-16 14:19:31 +01:00
gmake
```
4. **Install**
Append `PREFIX=/target/dir` to set target, default: `/usr/local`
Notice! Only use "sudo" when installing to a NON user owned directory.
```bash
2022-01-16 14:19:31 +01:00
sudo gmake install
```
5. **(Recommended) Set suid bit to make btop always run as root (or other user)**
No need for `sudo` to see information for non user owned processes and to enable signal sending to any process.
Run after make install and use same PREFIX if any was used at install.
Set `SU_USER` and `SU_GROUP` to select user and group, default is `root` and `wheel`
```bash
2022-01-16 14:19:31 +01:00
sudo gmake setuid
```
* **Uninstall**
```bash
2022-01-16 14:19:31 +01:00
sudo gmake uninstall
```
* **Remove any object files from source dir**
```bash
gmake clean
```
* **Remove all object files, binaries and created directories in source dir**
```bash
gmake distclean
```
* **Show help**
```bash
gmake help
```
2021-11-14 01:23:12 +01:00
</details>
<details>
<summary>
### With CMake (Community maintained)
</summary>
1. **Install build dependencies**
Requires Clang / GCC, CMake, Ninja and Git
_**Note:** LLVM's libc++ shipped with FreeBSD 13 is too old and cannot compile btop._
FreeBSD 14 and later:
```bash
pkg install cmake ninja
```
FreeBSD 13:
```bash
pkg install cmake gcc13 ninja
```
2. **Clone the repository**
```bash
git clone https://github.com/aristocratos/btop.git && cd btop
``````
3. **Compile**
FreeBSD 14 and later:
```bash
# Configure
cmake -B build -G Ninja
# Build
cmake --build build
```
FreeBSD 13:
```bash
# Configure
CXX=g++13 cmake -B build -G Ninja
# Build
cmake --build build
```
This will automatically build a release version of btop.
Some useful options to pass to the configure step:
| Configure flag | Description |
|---------------------------------|-------------------------------------------------------------------------|
| `-DBTOP_STATIC=<ON\|OFF>` | Enables static linking (OFF by default) |
| `-DBTOP_LTO=<ON\|OFF>` | Enables link time optimization (ON by default) |
| `-DBTOP_USE_MOLD=<ON\|OFF>` | Use mold to link btop (OFF by default) |
| `-DBTOP_PEDANTIC=<ON\|OFF>` | Compile with additional warnings (OFF by default) |
| `-DBTOP_WERROR=<ON\|OFF>` | Compile with warnings as errors (OFF by default) |
| `-DCMAKE_INSTALL_PREFIX=<path>` | The installation prefix ('/usr/local' by default) |
_**Note:** Static linking does not work with GCC._
To force a compiler, run `CXX=<compiler> cmake -B build -G Ninja`
4. **Install**
```bash
cmake --install build
```
May require root privileges
5. **Uninstall**
CMake doesn't generate an uninstall target by default. To remove installed files, run
```
cat build/install_manifest.txt | xargs rm -irv
```
6. **Cleanup build directory**
```bash
cmake --build build -t clean
```
</details>
2021-11-14 01:23:12 +01:00
## Installing the snap
2021-09-26 19:46:27 +02:00
[![btop](https://snapcraft.io/btop/badge.svg)](https://snapcraft.io/btop)
2022-08-23 17:24:11 +02:00
### Note: there are now two snaps available: `btop` and `btop-desktop`. The desktop version is much larger and includes the desktop entries needed to allow for launching `btop` with a click.
* **Install the snap**
2021-09-26 19:46:27 +02:00
```bash
sudo snap install btop
2022-08-23 17:24:11 +02:00
or
sudo snap install btop-desktop
2021-09-26 19:46:27 +02:00
```
2022-01-29 00:28:55 +01:00
* **Install the latest snap from the edge channel**
```
sudo snap install btop --edge
2022-08-23 17:24:11 +02:00
or
sudo snap install btop-desktop --edge
2022-01-29 00:28:55 +01:00
```
2022-02-13 00:51:35 +01:00
2022-01-29 00:28:55 +01:00
* **Connect the interface**
```bash
2022-01-29 00:28:55 +01:00
sudo snap connect btop:removable-media
or
2022-08-23 17:24:11 +02:00
sudo snap connect btop-desktop:removable-media
2021-09-26 19:46:27 +02:00
```
2021-09-26 21:12:46 +02:00
2021-09-18 02:13:35 +02:00
2021-05-06 20:32:03 +02:00
## Configurability
All options changeable from within UI.
2021-05-30 21:46:10 +02:00
Config and log files stored in `$XDG_CONFIG_HOME/btop` or `$HOME/.config/btop` folder
2021-05-06 20:32:03 +02:00
2022-02-13 19:43:27 +01:00
#### btop.conf: (auto generated if not found)
2021-05-06 20:32:03 +02:00
```bash
2022-02-13 00:51:35 +01:00
#? Config file for btop v. 1.2.2
2021-09-17 21:50:14 +02:00
#* Name of a btop++/bpytop/bashtop formatted ".theme" file, "Default" and "TTY" for builtin themes.
#* Themes should be placed in "../share/btop/themes" relative to binary or "$HOME/.config/btop/themes"
color_theme = "Default"
#* If the theme set background should be shown, set to False if you want terminal background transparency.
2022-02-13 00:51:35 +01:00
theme_background = True
2021-09-17 21:50:14 +02:00
#* Sets if 24-bit truecolor should be used, will convert 24-bit colors to 256 color (6x6x6 color cube) if false.
truecolor = True
#* Set to true to force tty mode regardless if a real tty has been detected or not.
#* Will force 16-color mode and TTY theme, set all graph symbols to "tty" and swap out other non tty friendly symbols.
force_tty = False
#* Define presets for the layout of the boxes. Preset 0 is always all boxes shown with default settings. Max 9 presets.
#* Format: "box_name:P:G,box_name:P:G" P=(0 or 1) for alternate positions, G=graph symbol to use for box.
2022-10-16 03:19:50 +02:00
#* Use whitespace " " as separator between different presets.
#* Example: "cpu:0:default,mem:0:tty,proc:1:default cpu:0:braille,proc:0:tty"
presets = "cpu:1:default,proc:0:default cpu:0:default,mem:0:default,net:0:default cpu:0:block,net:0:tty"
2022-02-21 18:15:38 +01:00
#* Set to True to enable "h,j,k,l,g,G" keys for directional control in lists.
2022-02-13 00:51:35 +01:00
#* Conflicting keys for h:"help" and k:"kill" is accessible while holding shift.
vim_keys = False
2021-09-17 21:50:14 +02:00
#* Rounded corners on boxes, is ignored if TTY mode is ON.
rounded_corners = True
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
#* Default symbols to use for graph creation, "braille", "block" or "tty".
#* "braille" offers the highest resolution but might not be included in all fonts.
#* "block" has half the resolution of braille but uses more common characters.
#* "tty" uses only 3 different symbols but will work with most fonts and should work in a real TTY.
#* Note that "tty" only has half the horizontal resolution of the other two, so will show a shorter historical view.
graph_symbol = "braille"
2021-05-06 20:32:03 +02:00
2021-09-17 21:50:14 +02:00
# Graph symbol to use for graphs in cpu box, "default", "braille", "block" or "tty".
graph_symbol_cpu = "default"
# Graph symbol to use for graphs in cpu box, "default", "braille", "block" or "tty".
graph_symbol_mem = "default"
# Graph symbol to use for graphs in cpu box, "default", "braille", "block" or "tty".
graph_symbol_net = "default"
# Graph symbol to use for graphs in cpu box, "default", "braille", "block" or "tty".
graph_symbol_proc = "default"
#* Manually set which boxes to show. Available values are "cpu mem net proc", separate values with whitespace.
2022-02-13 00:51:35 +01:00
shown_boxes = "proc cpu mem net"
2021-09-17 21:50:14 +02:00
#* Update time in milliseconds, recommended 2000 ms or above for better sample times for graphs.
2022-02-13 00:51:35 +01:00
update_ms = 1500
2021-09-17 21:50:14 +02:00
#* Processes sorting, "pid" "program" "arguments" "threads" "user" "memory" "cpu lazy" "cpu responsive",
#* "cpu lazy" sorts top process over time (easier to follow), "cpu responsive" updates top process directly.
proc_sorting = "cpu lazy"
#* Reverse sorting order, True or False.
proc_reversed = False
#* Show processes as a tree.
proc_tree = False
#* Use the cpu graph colors in the process list.
proc_colors = True
#* Use a darkening gradient in the process list.
proc_gradient = True
#* If process cpu usage should be of the core it's running on or usage of the total available cpu power.
proc_per_core = True
#* Show process memory as bytes instead of percent.
proc_mem_bytes = True
#* Use /proc/[pid]/smaps for memory information in the process info box (very slow but more accurate)
proc_info_smaps = False
#* Show proc box on left side of screen instead of right.
proc_left = False
#* Sets the CPU stat shown in upper half of the CPU graph, "total" is always available.
#* Select from a list of detected attributes from the options menu.
cpu_graph_upper = "total"
#* Sets the CPU stat shown in lower half of the CPU graph, "total" is always available.
#* Select from a list of detected attributes from the options menu.
cpu_graph_lower = "total"
#* Toggles if the lower CPU graph should be inverted.
cpu_invert_lower = True
#* Set to True to completely disable the lower CPU graph.
cpu_single_graph = False
#* Show cpu box at bottom of screen instead of top.
cpu_bottom = False
#* Shows the system uptime in the CPU box.
show_uptime = True
#* Show cpu temperature.
check_temp = True
#* Which sensor to use for cpu temperature, use options menu to select from list of available sensors.
cpu_sensor = "Auto"
#* Show temperatures for cpu cores also if check_temp is True and sensors has been found.
show_coretemp = True
#* Set a custom mapping between core and coretemp, can be needed on certain cpus to get correct temperature for correct core.
#* Use lm-sensors or similar to see which cores are reporting temperatures on your machine.
#* Format "x:y" x=core with wrong temp, y=core with correct temp, use space as separator between multiple entries.
#* Example: "4:0 5:1 6:3"
cpu_core_map = ""
#* Which temperature scale to use, available values: "celsius", "fahrenheit", "kelvin" and "rankine".
temp_scale = "celsius"
2022-02-13 00:51:35 +01:00
#* Use base 10 for bits/bytes sizes, KB = 1000 instead of KiB = 1024.
base_10_sizes = False
2021-09-17 21:50:14 +02:00
#* Show CPU frequency.
show_cpu_freq = True
#* Draw a clock at top of screen, formatting according to strftime, empty string to disable.
#* Special formatting: /host = hostname | /user = username | /uptime = system uptime
clock_format = "%H:%M"
#* Update main ui in background when menus are showing, set this to false if the menus is flickering too much for comfort.
background_update = True
#* Custom cpu model name, empty string to disable.
custom_cpu_name = ""
#* Optional filter for shown disks, should be full path of a mountpoint, separate multiple values with whitespace " ".
#* Begin line with "exclude=" to change to exclude filter, otherwise defaults to "most include" filter. Example: disks_filter="exclude=/boot /home/user".
disks_filter = "exclude=/boot"
#* Show graphs instead of meters for memory values.
mem_graphs = True
#* Show mem box below net box instead of above.
mem_below_net = False
#* Count ZFS ARC in cached and available memory.
zfs_arc_cached = True
2021-09-17 21:50:14 +02:00
#* If swap memory should be shown in memory box.
show_swap = True
#* Show swap as a disk, ignores show_swap value above, inserts itself after first disk.
swap_disk = True
#* If mem box should be split to also show disks info.
show_disks = True
#* Filter out non physical disks. Set this to False to include network disks, RAM disks and similar.
only_physical = True
#* Read disks list from /etc/fstab. This also disables only_physical.
use_fstab = False
2022-02-13 00:51:35 +01:00
#* Set to true to show available disk space for privileged users.
disk_free_priv = False
2021-09-17 21:50:14 +02:00
#* Toggles if io activity % (disk busy time) should be shown in regular disk usage view.
show_io_stat = True
#* Toggles io mode for disks, showing big graphs for disk read/write speeds.
io_mode = False
#* Set to True to show combined read/write io graphs in io mode.
io_graph_combined = False
#* Set the top speed for the io graphs in MiB/s (100 by default), use format "mountpoint:speed" separate disks with whitespace " ".
#* Example: "/mnt/media:100 /:20 /boot:1".
io_graph_speeds = ""
#* Set fixed values for network graphs in Mebibits. Is only used if net_auto is also set to False.
net_download = 100
net_upload = 100
#* Use network graphs auto rescaling mode, ignores any values set above and rescales down to 10 Kibibytes at the lowest.
net_auto = True
#* Sync the auto scaling for download and upload to whichever currently has the highest scale.
net_sync = False
#* Starts with the Network Interface specified here.
net_iface = "br0"
#* Show battery stats in top right if battery is present.
show_battery = True
2022-02-13 00:51:35 +01:00
#* Which battery to use if multiple are present. "Auto" for auto detection.
selected_battery = "Auto"
#* Set loglevel for "~/.config/btop/btop.log" levels are: "ERROR" "WARNING" "INFO" "DEBUG".
2021-09-17 21:50:14 +02:00
#* The level set includes all lower levels, i.e. "DEBUG" will show all logging info.
log_level = "DEBUG"
2021-05-06 20:32:03 +02:00
```
2021-09-17 22:08:39 +02:00
#### Command line options
2021-05-06 20:32:03 +02:00
```text
2021-09-18 17:33:02 +02:00
usage: btop [-h] [-v] [-/+t] [-p <id>] [--utf-force] [--debug]
2021-09-17 21:50:14 +02:00
optional arguments:
-h, --help show this help message and exit
-v, --version show version info and exit
-lc, --low-color disable truecolor, converts 24-bit colors to 256-color
-t, --tty_on force (ON) tty mode, max 16 colors and tty friendly graph symbols
+t, --tty_off force (OFF) tty mode
2021-09-18 20:31:47 +02:00
-p, --preset <id> start with preset, integer value between 0-9
--utf-force force start even if no UTF-8 locale was detected
2021-09-17 21:50:14 +02:00
--debug start in DEBUG mode: shows microsecond timer for information collect
and screen draw functions and sets loglevel to DEBUG
2021-05-06 20:32:03 +02:00
```
## LICENSE
[Apache License 2.0](LICENSE)