2017-08-10 21:49:37 +02:00
|
|
|
slstatus - suckless status
|
|
|
|
|
==========================
|
2023-04-23 23:48:47 +02:00
|
|
|
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.
|
2017-08-10 21:49:37 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Features
|
|
|
|
|
--------
|
2018-05-18 17:25:09 +02:00
|
|
|
- Battery percentage/state/time left
|
2022-11-23 23:59:51 +01:00
|
|
|
- Cat (read file)
|
2017-08-10 21:49:37 +02:00
|
|
|
- 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
|
2017-08-14 18:00:46 +02:00
|
|
|
- IP address (IPv4 and IPv6)
|
2017-08-10 21:49:37 +02:00
|
|
|
- Kernel version
|
|
|
|
|
- Keyboard indicators
|
2018-05-23 11:50:08 +02:00
|
|
|
- Keymap
|
2017-08-10 21:49:37 +02:00
|
|
|
- Load average
|
2018-05-19 00:31:33 +02:00
|
|
|
- Network speeds (RX and TX)
|
2017-08-10 21:49:37 +02:00
|
|
|
- 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
|
2020-11-30 21:32:14 +01:00
|
|
|
- Volume percentage
|
2017-08-10 21:49:37 +02:00
|
|
|
- WiFi signal percentage and ESSID
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Requirements
|
|
|
|
|
------------
|
2019-02-16 17:05:04 +01:00
|
|
|
Currently slstatus works on FreeBSD, Linux and OpenBSD.
|
2018-03-26 18:09:30 +02:00
|
|
|
In order to build slstatus you need the Xlib header files.
|
2017-08-10 21:49:37 +02:00
|
|
|
|
2022-10-28 00:47:06 +02:00
|
|
|
- For volume percentage on Linux the kernel module `snd-mixer-oss` must be
|
|
|
|
|
loaded.
|
|
|
|
|
- For volume percentage on FreeBSD, `sndio` must be installed.
|
2022-10-26 12:57:12 +02:00
|
|
|
|
2017-08-10 21:49:37 +02:00
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
Revert component-split
this reverts the commits from 92ab9ef52ebcb097add97d9f78e67ad1c1d6a6ec up to
d42870d6ca7fb587b38f8cf6d6821ae33a53a696.
After heavy consideration, the component split has more disadvantages
than advantages, especially given there will be utility-functions
sharing quite a lot of code that would then need to be duplicated, as it
does not fit into the util.c due to its speciality.
One big advantage of the component-wise build is readability, and
without doubt, this was achieved here. This point will be addressed
with a different approach that will be visible in the upcoming commits.
One big disadvantage of the component build is the fact that it
introduces state to the build process which is not necessary. Before its
introduction, the only influencing factors where the system-defines
__linux__ and __OpenBSD__. With the components, we are also relying on
the output of uname(1).
Additionally, if the os.mk is not present, make gives the output
$ make
Makefile:5: os.mk: No such file or directory
make: *** No rule to make target 'os.mk'. Stop.
This could easily be fixed by providing some sort of meta-rule for this
file, however, it indicates the problem we have here, and this entire
statefulness will heavily complicate packaging of this tool and makes
the build process much more complex than it actually has to be.
2018-05-01 18:10:39 +02:00
|
|
|
Edit config.mk to match your local setup (slstatus is installed into the
|
2019-02-08 15:37:17 +01:00
|
|
|
/usr/local namespace by default).
|
2017-08-10 21:49:37 +02:00
|
|
|
|
2017-08-12 13:37:12 +02:00
|
|
|
Afterwards enter the following command to build and install slstatus (if
|
|
|
|
|
necessary as root):
|
2017-08-10 21:49:37 +02:00
|
|
|
|
|
|
|
|
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.
|
2018-03-18 22:51:51 +01:00
|
|
|
|
|
|
|
|
|
2020-11-30 21:32:14 +01:00
|
|
|
Upcoming
|
|
|
|
|
--------
|
2022-12-19 02:41:19 +01:00
|
|
|
A first feature-complete release with official packages for common distributions
|
|
|
|
|
will come soon.
|