slstatus

Go to file

Laslo Hunhold 958c34052a Convert slstatus.1 to mandoc, simplify it and remove -h We also change the semantics of -v to only return the version information. There is now no need for usage() to exit with anything other than 1.		2017-08-10 22:32:28 +02:00
arg.h	new arg.h version by frign	2017-08-10 11:31:57 +02:00
config.def.h	add num_files() function for maildirs ;)	2017-08-06 15:02:16 +02:00
config.mk	Refactor build system	2017-08-10 22:32:14 +02:00
LICENSE	Moved contributors to LICENSE	2017-08-10 21:06:48 +02:00
Makefile	Refactor build system	2017-08-10 22:32:14 +02:00
README	New README in plain text	2017-08-10 21:49:37 +02:00
slstatus.1	Convert slstatus.1 to mandoc, simplify it and remove -h	2017-08-10 22:32:28 +02:00
slstatus.c	Convert slstatus.1 to mandoc, simplify it and remove -h	2017-08-10 22:32:28 +02:00
slstatus.png	added my fancy icon	2016-09-09 21:12:13 +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
- 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 dmenu (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.