slstatus

mirror of https://github.com/pikami/slstatus.git synced 2024-11-27 13:55:41 +00:00

pikami's slstatus fork

Go to file

SiIky 9ca1ac62f9 Print unknown_str in case of error func can return NULL in case of error, but no checking is done when printing, and unknown_str wasn't being used anywhere.		2018-02-17 18:08:27 +00:00
components	Fix a bug in wifi_essid().	2018-01-06 23:37:09 +01:00
arg.h	Remove unnecessary blank lines after license-notice	2017-08-13 23:31:56 +02:00
config.def.h	slstatus: add cpu_iowait	2017-09-16 13:46:40 +02:00
config.mk	Small fixes in config.mk	2017-12-03 01:40:38 +01:00
LICENSE	Update LICENSE year for myself.	2018-01-06 23:40:05 +01:00
Makefile	Move components into dedicated subdirectory	2017-09-24 17:20:27 +02:00
README	Added CPU iowait to README	2017-09-16 13:54:28 +02:00
slstatus.1	Fix man page .Os field	2017-08-13 23:25:44 +02:00
slstatus.c	Print unknown_str in case of error	2018-02-17 18:08:27 +00:00
slstatus.h	Rewrite Makefile to accomodate file split	2017-09-17 17:37:49 +02:00
util.c	Added LICENSE statements to all source files	2017-09-17 17:45:03 +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 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.