slstatus

Go to file

michaelbuch12@gmail.com 77bfb76a97 Fix RAM component on FreeBSD The current implementation uses the wrong type for given sysctl calls leading to overflow and incorrectly reported RAM usage. The fix is to use 'unsigned int' which is what FreeBSD expects.		2022-10-26 21:24:11 +02:00
components	Fix RAM component on FreeBSD	2022-10-26 21:24:11 +02:00
LICENSE	Update LICENSE	2020-11-30 21:26:40 +01:00
Makefile	Add separator module	2020-11-30 21:15:13 +01:00
README	Update README	2020-11-30 21:32:14 +01:00
arg.h	Remove unnecessary blank lines after license-notice	2017-08-13 23:31:56 +02:00
config.def.h	Use the sioctl_open(3) OpenBSD API to access vol	2020-11-30 21:24:33 +01:00
config.mk	Add comment for FreeBSD to config.mk	2020-11-30 21:24:34 +01:00
slstatus.1	Add a -1 option flag	2020-11-30 21:23:56 +01:00
slstatus.c	Add a -1 option flag	2020-11-30 21:23:56 +01:00
slstatus.h	Fix keyboard_indicators() prototype	2022-10-26 21:24:09 +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.


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!