README (1762B)
1 slstatus - suckless status 2 ========================== 3 slstatus is a small tool for providing system status information to other 4 programs over the EWMH property of the root window (used by dwm(1)) or 5 standard input/output. It is designed to be as efficient as possible by 6 only issuing the minimum of system calls required. 7 8 9 Features 10 -------- 11 - Battery percentage/state/time left 12 - Cat (read file) 13 - CPU usage 14 - CPU frequency 15 - Custom shell commands 16 - Date and time 17 - Disk status (free storage, percentage, total storage and used storage) 18 - Available entropy 19 - Username/GID/UID 20 - Hostname 21 - IP address (IPv4 and IPv6), interface status 22 - Kernel version 23 - Keyboard indicators 24 - Keymap 25 - Load average 26 - Network speeds (RX and TX) 27 - Number of files in a directory (hint: Maildir) 28 - Memory status (free memory, percentage, total memory and used memory) 29 - Swap status (free swap, percentage, total swap and used swap) 30 - Temperature 31 - Uptime 32 - Volume percentage 33 - WiFi signal percentage and ESSID 34 35 36 Requirements 37 ------------ 38 Currently slstatus works on FreeBSD, Linux and OpenBSD. 39 In order to build slstatus you need the Xlib header files. 40 41 - For volume percentage on Linux the kernel module `snd-mixer-oss` must be 42 loaded. 43 - For volume percentage on FreeBSD, `sndio` must be installed. 44 45 46 Installation 47 ------------ 48 Edit config.mk to match your local setup (slstatus is installed into the 49 /usr/local namespace by default). 50 51 Afterwards enter the following command to build and install slstatus (if 52 necessary as root): 53 54 make clean install 55 56 57 Running slstatus 58 ---------------- 59 See the man page for details. 60 61 62 Configuration 63 ------------- 64 slstatus can be customized by creating a custom config.h and (re)compiling the 65 source code. This keeps it fast, secure and simple.