slstatus

Go to file

Laslo Hunhold c83b388a3f Properly handle *snprintf() errors Posix guarantees that the resulting string is null-terminated, even if we have an overflow. Instead of doing what has already been done, properly warn when there has been an error or overflow, so the user can do something about it.		2018-05-17 23:26:56 +02:00
components	Remove UNUSED macro	2018-05-17 20:05:57 +02:00
LICENSE	Add he4d to LICENSE	2018-05-16 08:13:09 +02:00
Makefile	Tweak build system a little bit	2018-05-01 20:53:27 +02:00
README	Update README	2018-05-16 23:19:33 +02:00
arg.h	Remove unnecessary blank lines after license-notice	2017-08-13 23:31:56 +02:00
config.def.h	Change interval to unsigned int	2018-05-17 17:25:31 +02:00
config.mk	Tweak build system a little bit	2018-05-01 20:53:27 +02:00
slstatus.1	Fix man page .Os field	2017-08-13 23:25:44 +02:00
slstatus.c	Properly handle *snprintf() errors	2018-05-17 23:26:56 +02:00
slstatus.h	Remove cpu_iowait	2018-05-06 21:11:50 +02:00
util.c	Properly handle *snprintf() errors	2018-05-17 23:26:56 +02:00
util.h	Remove UNUSED macro	2018-05-17 20:05:57 +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/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.


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

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
----
Cleaning up the whole codebase it the goal before thinking about a release.