slstatus

Go to file

Laslo Hunhold 0efd64ffaa Explicitly list component-objects in the Makefile There was a long tinkering process at farbfeld about this, but the sad truth is that it's the only way to make the Makefile truly portable. Listing it just as $(COM:=.o): config.mk $(REQ:=.h) omits the dependency on the c-file itself, which incurs that strictly speaking the object file is not depending on the source file, which is nonsense. You don't see strictly Posix compliant Makefiles around very often and most use nasty GNU-extensions everywhere. It is a good idea to go ahead as a fitting example and show how to write them portably.		2018-05-27 22:55:15 +02:00
components	Use E-notation for large powers of 10	2018-05-27 19:53:36 +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
LICENSE	Add Michael Buch to LICENSE	2018-05-23 10:12:20 +02:00
Makefile	Explicitly list component-objects in the Makefile	2018-05-27 22:55:15 +02:00
README	Revert "Add basic backlight percentage support"	2018-05-27 16:46:03 +02:00
slstatus.1	Remove o-flag as it is redundant	2018-05-22 13:27:11 +02:00
slstatus.c	Use E-notation for large powers of 10	2018-05-27 19:53:36 +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.