Go to file
parazyd d66e775c8d Add OpenBSD support in volume.c 2018-04-29 15:57:17 +02:00
components Add OpenBSD support in volume.c 2018-04-29 15:57:17 +02:00
LICENSE Update LICENSE for Ali H. Fardan 2018-04-29 13:02:08 +02:00
Makefile Move components into dedicated subdirectory 2017-09-24 17:20:27 +02:00
README Remove ipv{4,6}() from todo in README 2018-04-29 13:00:12 +02:00
arg.h Remove unnecessary blank lines after license-notice 2017-08-13 23:31:56 +02:00
config.def.h Remove non-portable functions from config.def.h 2018-04-16 19:09:07 +02:00
config.mk Add OpenBSD support in volume.c 2018-04-29 15:57:17 +02:00
slstatus.1 Fix man page .Os field 2017-08-13 23:25:44 +02:00
slstatus.c Remove program name from error messages 2018-03-28 18:49:27 +02:00
slstatus.h Rewrite Makefile to accomodate file split 2017-09-17 17:37:49 +02:00
util.c Format error messages properly 2018-03-28 19:46:27 +02:00
util.h Added LICENSE statements to all source files 2017-09-17 17:45:03 +02:00

README

slstatus - suckless status
==========================
slstatus is a suckless status monitor for window managers that use WM_NAME
(e.g. dwm) or stdin to fill the status bar.


Features
--------
- Battery percentage/power/state
- CPU usage
- CPU frequency
- CPU iowait
- Custom shell commands
- Date and time
- Disk status (free storage, percentage, total storage and used storage)
- Available entropy
- Username/GID/UID
- Hostname
- IP address (IPv4 and IPv6)
- Kernel version
- Keyboard indicators
- Load average
- Number of files in a directory (hint: Maildir)
- Memory status (free memory, percentage, total memory and used memory)
- Swap status (free swap, percentage, total swap and used swap)
- Temperature
- Uptime
- Volume percentage (OSS/ALSA)
- WiFi signal percentage and ESSID


Requirements
------------
In order to build slstatus you need the Xlib header files.


Installation
------------
Edit config.mk to match your local setup (slstatus is installed into the
/usr/local namespace by default).

Afterwards enter the following command to build and install slstatus (if
necessary as root):

    make clean install


Running slstatus
----------------
See the man page for details.


Configuration
-------------
slstatus can be customized by creating a custom config.h and (re)compiling the
source code. This keeps it fast, secure and simple.


Todo
----
Porting to OpenBSD is the current goal before thinking about a release.

The following functions are not portable at the moment:
- wifi_{perc,essid}
- cpu_{freq,perc,iowait}
- entropy
- swap_{free,perc,total,used}
- battery_{power,state}
- temp
- vol_perc