README 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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. 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. Requirements
  33. ------------
  34. Currently slstatus works on FreeBSD, Linux and OpenBSD.
  35. In order to build slstatus you need the Xlib header files.
  36. - For volume percentage on Linux the kernel module `snd-mixer-oss` must be
  37. loaded.
  38. - For volume percentage on FreeBSD, `sndio` must be installed.
  39. Installation
  40. ------------
  41. Edit config.mk to match your local setup (slstatus is installed into the
  42. /usr/local namespace by default).
  43. Afterwards enter the following command to build and install slstatus (if
  44. necessary as root):
  45. make clean install
  46. Running slstatus
  47. ----------------
  48. See the man page for details.
  49. Configuration
  50. -------------
  51. slstatus can be customized by creating a custom config.h and (re)compiling the
  52. source code. This keeps it fast, secure and simple.