slstatus

status monitor

Go to file

NRK 0c2b3e5b5c do not rely on obsolete feature function prototype with unspecified argument is obsolete since c99. additionally some of these function which don't take any argument were being called with a `const char ` arg, which is UB. fix both these issues by declararing ALL the components to accept a `const char `, and name the arg "unused" if it's meant to be ignored.		2022-10-26 23:32:43 +02:00
components	do not rely on obsolete feature	2022-10-26 23:32:43 +02:00
LICENSE	Update LICENSE	2022-10-26 21:24:19 +02:00
Makefile	components/*.c: include slstatus.h	2022-10-26 23:32:07 +02:00
README	Add comment about mixer oss module to README	2022-10-26 21:24:20 +02:00
arg.h	Remove unnecessary blank lines after license-notice	2017-08-13 23:31:56 +02:00
config.def.h	Make volume component work on FreeBSD	2022-10-26 21:24:14 +02:00
config.mk	do not rely on obsolete feature	2022-10-26 23:32:43 +02:00
slstatus.1	Add a -1 option flag	2020-11-30 21:23:56 +01:00
slstatus.c	do not rely on obsolete feature	2022-10-26 23:32:43 +02:00
slstatus.h	do not rely on obsolete feature	2022-10-26 23:32:43 +02:00
util.c	Follow International System of Units spacing rules	2019-02-17 16:53:56 +01: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
- WiFi signal percentage and ESSID


Requirements
------------
Currently slstatus works on FreeBSD, Linux and OpenBSD.
In order to build slstatus you need the Xlib header files.

For volume percentage on Linux the kernel module `snd-mixer-oss` must be
loaded.


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 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.


Upcoming
--------

A release (v1.0) will come soon... ;)
After a long phase of inactivity, development has been continued!