Go to file
Aaron Marcher 57aa6a5164
Deleted slstatus.png as it is unnecessary
2017-09-14 22:20:44 +02:00
LICENSE Updated LICENSE 2017-08-12 12:55:53 +02:00
Makefile Added Makefile target for distribution tarballs. 2017-08-13 23:05:22 +02:00
README Added IPv6 address function 2017-08-14 18:00:46 +02:00
arg.h Remove unnecessary blank lines after license-notice 2017-08-13 23:31:56 +02:00
config.def.h slstatus load_avg format string 2017-09-10 14:08:20 +02:00
config.mk Fixed man page path 2017-08-13 22:56:14 +02:00
slstatus.1 Fix man page .Os field 2017-08-13 23:25:44 +02:00
slstatus.c slstatus load_avg format string 2017-09-10 14:08:20 +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
- 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 and optionally ALSA
for volume percentage. PulseAudio is not supported for various reasons.


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.