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
  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 - 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
  30
  31 Requirements
  32 ------------
  33 In order to build slstatus you need the Xlib header files.
  34
  35
  36 Installation
  37 ------------
  38 Edit config.mk to match your local setup (slstatus is installed into the
  39 /usr/local namespace by default). Uncomment OSSLIBS on OpenBSD.
  40
  41 Afterwards enter the following command to build and install slstatus (if
  42 necessary as root):
  43
  44     make clean install
  45
  46
  47 Running slstatus
  48 ----------------
  49 See the man page for details.
  50
  51
  52 Configuration
  53 -------------
  54 slstatus can be customized by creating a custom config.h and (re)compiling the
  55 source code. This keeps it fast, secure and simple.
  56
  57
  58 Todo
  59 ----
  60 Porting to OpenBSD is the current goal before thinking about a release.
  61
  62 The following functions are not portable at the moment:
  63 - wifi_{perc,essid}