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/power/state
  10 - CPU usage
  11 - CPU frequency
  12 - CPU iowait
  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 - Load average
  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 and optionally ALSA
  35 for volume percentage. PulseAudio is not supported for various reasons.
  36
  37
  38 Installation
  39 ------------
  40 Edit config.mk to match your local setup (slstatus is installed into the
  41 /usr/local namespace by default).
  42
  43 Afterwards enter the following command to build and install slstatus (if
  44 necessary as root):
  45
  46     make clean install
  47
  48
  49 Running slstatus
  50 ----------------
  51 See the man page for details.
  52
  53
  54 Configuration
  55 -------------
  56 slstatus can be customized by creating a custom config.h and (re)compiling the
  57 source code. This keeps it fast, secure and simple.
  58
  59
  60 Todo
  61 ----
  62 Porting to OpenBSD is the current goal before thinking about a release.
  63
  64 The following functions are not portable at the moment:
  65 - ipv{4,6}
  66 - ram_{free,perc,total,used}
  67 - wifi_{perc,essid}
  68 - cpu_{freq,perc,iowait}
  69 - entropy
  70 - swap_{free,perc,total,used}
  71 - battery_{power,state}
  72 - temp
  73 - vol_perc