Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add manpage #211

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions man/btop.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.TH BTOP 1 "December 2021" "1.1.3"
.SH NAME
BTOP \- Resource monitor that shows usage and stats for processor, memory, disks, network and processes.
.SH SYNOPSIS
.B btop [-h] [-v] [-/+t] [-p <id>] [--utf-force] [--debug]

.SH DESCRIPTION
btop is a modern and colorful command line resource monitor that shows usage and stats for processor,
memory, disks, network and processes.

btop beatures:
- 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.
- Easy switching between sorting options.
- Tree view of processes.
- Send any signal to selected process.
- 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...
.SH "COMMAND-LINE OPTIONS"

optional arguments:
.TP
\fB\-h, \-\-help
show this help message and exit
.TP
\fB\-v, \-\-version
show version info and exit
.TP
\fB\-lc, \-\-low-color
disable truecolor, converts 24-bit colors to 256-color
.TP
\fB\-t, \-\-tty_on
force (ON) tty mode, max 16 colors and tty friendly graph symbols
.TP
+t, \-\-tty_off
force (OFF) tty mode
.TP
\fB\-p, \-\-preset <id>
start with preset, integer value between 0-9
.TP
\fB\-\-utf-force
force start even if no UTF-8 locale was detected
.TP
\fB\-\-debug
start in DEBUG mode: shows microsecond timer for information collect
and screen draw functions and sets loglevel to DEBUG

.SH SEE ALSO
.BR https://github.com/aristocratos/btop
.SH AUTHOR
btop was written by Aristocratos.