README

!bashtop

!Linux
!OSX
!FreeBSD
!Usage
!Bash
!Python
!bashtop_version





 C++ Version

 18 September 2021

!btop++

The C++ version of bashtop - btop++ is available.

Get it at https://github.com/aristocratos/btop



 Index

 Documents
 Description
 Features
 Themes
 Support and funding
 Prerequisites
 Dependencies
 Screenshots
 Installation
 Configurability
 TODO
 License


 Documents

 CHANGELOG.md

 CONTRIBUTING.md

 CODE_OF_CONDUCT.md

 Description

Resource monitor that shows usage and stats for processor, memory, disks, network and processes.

 Features

 Easy to use, with a game inspired menu system.
 Fast and "mostly" responsive UI with UP, DOWN keys process selection.
 Function for showing detailed stats for selected process.
 Ability to filter processes.
 Easy switching between sorting options.
 Send SIGTERM, SIGKILL, SIGINT to selected process.
 UI menu for changing all config file options.
 Auto scaling graph for network usage.
 Shows message in menu if new version is available
 Shows current read and write speeds for disks
 Multiple data collection methods which can be switched if running on Linux

 Themes

Bashtop now has theme support and a function to download missing local themes from repository.

See themes folder for available themes.

The builtin theme downloader places the default themes in $HOME/.config/bashtop/themes.
User created themes should be placed in $HOME/.config/bashtop/user_themes to be safe from overwrites.

Let me know if you want to contribute with new themes.

 Support and funding

Bug fixes and updates might be slow during normal workdays since I work full time as an industrial worker and don't have much time or energy left during the week.
I'm looking into ways of funding this project that would allow me to take off time from my day job to work on this.

Any advice on how to get funding for open source projects is very welcome!

 Update

You can now sponsor this project through github, see my sponsors page for options.

Also added donation links for paypal and ko-fi.

Any support is greatly appreciated!

 Prerequisites

 Mac Os X

Will not display correctly in the standard terminal!
Recommended alternative iTerm2

Will also need to be run as superuser to display stats for processes not owned by user.

 Linux, Mac Os X and FreeBSD

For correct display, a terminal with support for:

 24-bit truecolor (See list of terminals with truecolor support)
 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
 Unicode Block “Geometric Shapes” U+25A0 - U+25FF
 Unicode Block "Box Drawing" and "Block Elements" U+2500 - U+259F

 Notice

Dropbear seems to not be able to set correct locale. So if accessing bashtop over ssh, OpenSSH is recommended.

 Dependencies

 Linux, OSX and FreeBSD

bash (v4.4 or later) Script functionality will most probably break with earlier versions.
Bash version 5 is highly recommended