README

   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 - CPU usage
  11 - CPU frequency
  12 - Custom shell commands
  13 - Date and time
  14 - Disk status (free storage, percentage, total storage and used storage)
  15 - Available entropy
  16 - Username/GID/UID
  17 - Hostname
  18 - IP address (IPv4 and IPv6)
  19 - Kernel version
  20 - Keyboard indicators
  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 (OSS/ALSA)
  29 - WiFi signal percentage and ESSID
  30
  31
  32 Requirements
  33 ------------
  34 In order to build slstatus you need the Xlib header files.
  35
  36
  37 Installation
  38 ------------
  39 Edit config.mk to match your local setup (slstatus is installed into the
  40 /usr/local namespace by default). Uncomment OSSLIBS on OpenBSD.
  41
  42 Afterwards enter the following command to build and install slstatus (if
  43 necessary as root):
  44
  45     make clean install
  46
  47
  48 Running slstatus
  49 ----------------
  50 See the man page for details.
  51
  52
  53 Configuration
  54 -------------
  55 slstatus can be customized by creating a custom config.h and (re)compiling the
  56 source code. This keeps it fast, secure and simple.
  57
  58
  59 Todo
  60 ----
  61 Cleaning up the whole codebase it the goal before thinking about a release.