slstatus

Go to file

planet36 984f45719e num_files: opendir() returns a directory stream opendir() returns a directory stream, not a file descriptor Co-authored-by: drkhsh <me@drkhsh.at> Signed-off-by: drkhsh <me@drkhsh.at>		2022-12-19 02:44:21 +01:00
components	num_files: opendir() returns a directory stream	2022-12-19 02:44:21 +01:00
LICENSE	Update LICENSE	2022-10-26 21:24:19 +02:00
Makefile	New component: cat	2022-11-24 00:01:52 +01:00
README	Update README	2022-12-19 02:44:21 +01:00
arg.h	radical re-formatting 1/3: Fix spacing	2022-10-28 01:03:31 +02:00
config.def.h	Sort functions by name	2022-12-19 02:44:21 +01: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	radical re-formatting 2/3: Fix blocks	2022-10-28 01:03:38 +02:00
slstatus.h	Sort functions by name	2022-12-19 02:44:21 +01:00
util.c	verr: Remove special "usage" case	2022-12-19 02:44:21 +01:00
util.h	Make LEN macro consistent with other suckless repos	2022-12-19 02:44:21 +01: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
- Cat (read file)
- 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.
- For volume percentage on FreeBSD, `sndio` must be installed.


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 first feature-complete release with official packages for common distributions
will come soon.