diff options
| author | Thomas Ulmer <thomasmulmer02@gmail.com> | 2026-02-04 14:33:05 -0800 |
|---|---|---|
| committer | Thomas Ulmer <thomasmulmer02@gmail.com> | 2026-02-04 14:33:05 -0800 |
| commit | be7fb7b57a97147b40b5d8203f6241015755a51d (patch) | |
| tree | 79bb694f714d5861c3dd6f6cc548986fce5f1429 /tree/src/slstatus/slstatus-1.1/README | |
| parent | b378cb8f0e774b3e21671fca22de20b71cbac214 (diff) | |
suckless includes
Diffstat (limited to 'tree/src/slstatus/slstatus-1.1/README')
| -rw-r--r-- | tree/src/slstatus/slstatus-1.1/README | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/tree/src/slstatus/slstatus-1.1/README b/tree/src/slstatus/slstatus-1.1/README new file mode 100644 index 0000000..4d592bb --- /dev/null +++ b/tree/src/slstatus/slstatus-1.1/README @@ -0,0 +1,65 @@ +slstatus - suckless status +========================== +slstatus is a small tool for providing system status information to other +programs over the EWMH property of the root window (used by dwm(1)) or +standard input/output. It is designed to be as efficient as possible by +only issuing the minimum of system calls required. + + +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), interface status +- 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. |