README 1.5 KB

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