Go to file
Quentin Rameau 7fe240856e Flush the output stream instead of arbitrarily disabling buffering
This is (arguably) more elegant and it matches Xlib output logic.
Also use puts instead of printf as we don't do formating there.
2018-05-29 22:26:05 +02:00
components swap: removed unused include 2018-05-29 14:43:14 +02:00
LICENSE Update LICENSE for Tobias 2018-05-28 16:17:03 +02:00
Makefile Don't explicitly list each component-target 2018-05-29 21:25:39 +02:00
README Revert "Add basic backlight percentage support" 2018-05-27 16:46:03 +02:00
arg.h Remove unnecessary blank lines after license-notice 2017-08-13 23:31:56 +02:00
config.def.h Revert "Add basic backlight percentage support" 2018-05-27 16:46:03 +02:00
config.mk Tweak build system a little bit 2018-05-01 20:53:27 +02:00
slstatus.1 Remove o-flag as it is redundant 2018-05-22 13:27:11 +02:00
slstatus.c Flush the output stream instead of arbitrarily disabling buffering 2018-05-29 22:26:05 +02:00
slstatus.h Revert "Add basic backlight percentage support" 2018-05-27 16:46:03 +02:00
util.c Refactor snprintf-usage in util.c 2018-05-23 19:56:04 +02:00
util.h Revert "Add basic backlight percentage support" 2018-05-27 16:46: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/state/time left
- 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
- Keymap
- Load average
- Network speeds (RX and TX)
- 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.