README (1712B)
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 - Cat (read file) 11 - CPU usage 12 - CPU frequency 13 - Custom shell commands 14 - Date and time 15 - Disk status (free storage, percentage, total storage and used storage) 16 - Available entropy 17 - Username/GID/UID 18 - Hostname 19 - IP address (IPv4 and IPv6) 20 - Kernel version 21 - Keyboard indicators 22 - Keymap 23 - Load average 24 - Network speeds (RX and TX) 25 - Number of files in a directory (hint: Maildir) 26 - Memory status (free memory, percentage, total memory and used memory) 27 - Swap status (free swap, percentage, total swap and used swap) 28 - Temperature 29 - Uptime 30 - Volume percentage 31 - WiFi signal percentage and ESSID 32 33 34 Requirements 35 ------------ 36 Currently slstatus works on FreeBSD, Linux and OpenBSD. 37 In order to build slstatus you need the Xlib header files. 38 39 - For volume percentage on Linux the kernel module `snd-mixer-oss` must be 40 loaded. 41 - For volume percentage on FreeBSD, `sndio` must be installed. 42 43 44 Installation 45 ------------ 46 Edit config.mk to match your local setup (slstatus is installed into the 47 /usr/local namespace by default). 48 49 Afterwards enter the following command to build and install slstatus (if 50 necessary as root): 51 52 make clean install 53 54 55 Running slstatus 56 ---------------- 57 See the man page for details. 58 59 60 Configuration 61 ------------- 62 slstatus can be customized by creating a custom config.h and (re)compiling the 63 source code. This keeps it fast, secure and simple. 64 65 66 Upcoming 67 -------- 68 A first feature-complete release with official packages for common distributions 69 will come soon.