slstatus/README

70 lines
1.7 KiB
Plaintext
Raw Normal View History

2017-08-10 20:49:37 +01: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/time left
- Cat (read file)
2017-08-10 20:49:37 +01: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 20:49:37 +01:00
- Kernel version
- Keyboard indicators
2018-05-23 10:50:08 +01:00
- Keymap
2017-08-10 20:49:37 +01:00
- Load average
2018-05-18 23:31:33 +01:00
- Network speeds (RX and TX)
2017-08-10 20:49:37 +01:00
- 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
2020-11-30 20:32:14 +00:00
- Volume percentage
2017-08-10 20:49:37 +01:00
- WiFi signal percentage and ESSID
Requirements
------------
2019-02-16 16:05:04 +00:00
Currently slstatus works on FreeBSD, Linux and OpenBSD.
In order to build slstatus you need the Xlib header files.
2017-08-10 20:49:37 +01:00
- For volume percentage on Linux the kernel module `snd-mixer-oss` must be
loaded.
- For volume percentage on FreeBSD, `sndio` must be installed.
2017-08-10 20:49:37 +01:00
Installation
------------
Edit config.mk to match your local setup (slstatus is installed into the
/usr/local namespace by default).
2017-08-10 20:49:37 +01:00
2017-08-12 12:37:12 +01:00
Afterwards enter the following command to build and install slstatus (if
necessary as root):
2017-08-10 20:49:37 +01: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 21:51:51 +00:00
2020-11-30 20:32:14 +00:00
Upcoming
--------
2022-12-19 01:41:19 +00:00
A first feature-complete release with official packages for common distributions
will come soon.