slstatus/README

61 lines
1.4 KiB
Plaintext
Raw Normal View History

2017-08-10 15:49:37 -04:00
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
2017-08-10 15:49:37 -04:00
- 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)
2017-08-10 15:49:37 -04:00
- Kernel version
- Keyboard indicators
- Load average
- 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.
2017-08-10 15:49:37 -04:00
Installation
------------
Edit config.mk to match your local setup (slstatus is installed into the
/usr/local namespace by default). Uncomment OSSLIBS on OpenBSD.
2017-08-10 15:49:37 -04:00
2017-08-12 07:37:12 -04:00
Afterwards enter the following command to build and install slstatus (if
necessary as root):
2017-08-10 15:49:37 -04:00
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.
2018-03-18 17:51:51 -04:00
Todo
----
2018-05-16 17:19:33 -04:00
Cleaning up the whole codebase it the goal before thinking about a release.