README 1.7 KB

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