README (1527B)
1 slstatus - suckless status 2 ========================== 3 slstatus is a suckless status monitor for window managers that use WM_NAME 4 (e.g. dwm) or stdin to fill the status bar. 5 6 7 Features 8 -------- 9 - Battery percentage/state/time left 10 - CPU usage 11 - CPU frequency 12 - Custom shell commands 13 - Date and time 14 - Disk status (free storage, percentage, total storage and used storage) 15 - Available entropy 16 - Username/GID/UID 17 - Hostname 18 - IP address (IPv4 and IPv6) 19 - Kernel version 20 - Keyboard indicators 21 - Keymap 22 - Load average 23 - Network speeds (RX and TX) 24 - Number of files in a directory (hint: Maildir) 25 - Memory status (free memory, percentage, total memory and used memory) 26 - Swap status (free swap, percentage, total swap and used swap) 27 - Temperature 28 - Uptime 29 - Volume percentage (OSS/ALSA) 30 - WiFi signal percentage and ESSID 31 32 33 Requirements 34 ------------ 35 Currently slstatus works on FreeBSD, Linux and OpenBSD. 36 In order to build slstatus you need the Xlib header files. 37 38 39 Installation 40 ------------ 41 Edit config.mk to match your local setup (slstatus is installed into the 42 /usr/local namespace by default). 43 44 Afterwards enter the following command to build and install slstatus (if 45 necessary as root): 46 47 make clean install 48 49 50 Running slstatus 51 ---------------- 52 See the man page for details. 53 54 55 Configuration 56 ------------- 57 slstatus can be customized by creating a custom config.h and (re)compiling the 58 source code. This keeps it fast, secure and simple. 59 60 61 Todo 62 ---- 63 Cleaning up the whole codebase it the goal before thinking about a release.