slstatus

mirror of https://github.com/pikami/slstatus.git synced 2024-11-27 13:55:41 +00:00

pikami's slstatus fork

Go to file

Aaron Marcher e3ccac3298 Unify and simplify netspeed logic and types		2018-05-19 13:07:05 +02:00
components	Unify and simplify netspeed logic and types	2018-05-19 13:07:05 +02:00
arg.h	Remove unnecessary blank lines after license-notice	2017-08-13 23:31:56 +02:00
config.def.h	implemented openbsd netspeed functions	2018-05-19 01:44:36 +02:00
config.mk	Tweak build system a little bit	2018-05-01 20:53:27 +02:00
LICENSE	Add he4d to LICENSE	2018-05-16 08:13:09 +02:00
Makefile	Add network speed functions	2018-05-19 00:31:33 +02:00
README	Add network speed functions	2018-05-19 00:31:33 +02:00
slstatus.1	Fix man page .Os field	2017-08-13 23:25:44 +02:00
slstatus.c	Add warn() and die()	2018-05-18 11:13:05 +02:00
slstatus.h	Add network speed functions	2018-05-19 00:31:33 +02:00
util.c	Add fmt_scaled util function	2018-05-18 23:14:10 +02:00
util.h	Add fmt_scaled util function	2018-05-18 23:14:10 +02:00

README

slstatus - suckless status
==========================
slstatus is a suckless status monitor for window managers that use WM_NAME
(e.g. dwm) or stdin to fill the status bar.


Features
--------
- Battery percentage/state/time left
- CPU usage
- CPU frequency
- Custom shell commands
- Date and time
- Disk status (free storage, percentage, total storage and used storage)
- Available entropy
- Username/GID/UID
- Hostname
- IP address (IPv4 and IPv6)
- Kernel version
- Keyboard indicators
- Load average
- Network speeds (RX and TX)
- Number of files in a directory (hint: Maildir)
- Memory status (free memory, percentage, total memory and used memory)
- Swap status (free swap, percentage, total swap and used swap)
- Temperature
- Uptime
- Volume percentage (OSS/ALSA)
- WiFi signal percentage and ESSID


Requirements
------------
In order to build slstatus you need the Xlib header files.


Installation
------------
Edit config.mk to match your local setup (slstatus is installed into the
/usr/local namespace by default). Uncomment OSSLIBS on OpenBSD.

Afterwards enter the following command to build and install slstatus (if
necessary as root):

    make clean install


Running slstatus
----------------
See the man page for details.


Configuration
-------------
slstatus can be customized by creating a custom config.h and (re)compiling the
source code. This keeps it fast, secure and simple.


Todo
----
Cleaning up the whole codebase it the goal before thinking about a release.