Go to file
Michael Buch 120d150594 Add support for cpu and uptime components on FreeBSD 2019-02-05 09:31:06 +01:00
components Add support for cpu and uptime components on FreeBSD 2019-02-05 09:31:06 +01:00
LICENSE Add Ian Remmler to LICENSE 2018-06-04 14:07:20 +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 Add FreeBSD support for temperature and battery components 2019-02-05 09:30:21 +01: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 Consistency with 80 char limit and breaks 2018-07-08 17:42:58 +02:00
slstatus.h Consistent paramter naming for components 2018-07-06 08:08:48 +02:00
util.c Consistency with 80 char limit and breaks 2018-07-08 17:42:58 +02:00
util.h Change uint64_t to uintmax_t 2018-07-07 10:50:25 +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.