slstatus/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.
New README in plain text 2017-08-10 19:49:37 +00:00			`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`
			`--------`
Port battery_remaining to Linux Additionally unify the format of battery_state and uptime 2018-05-18 15:25:09 +00:00			`- Battery percentage/state/time left`
New component: cat Generically reads an arbitrary file natively. Saves a few layers of execution in comparison to using `run_command` with an argument like `cat ./file`. 2022-11-23 22:59:51 +00:00			`- Cat (read file)`
New README in plain text 2017-08-10 19:49:37 +00: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`
Added IPv6 address function - Renamed "ip" function to "ipv4" - Added "ipv6" function - Adjusted README and config.def.h accordingly 2017-08-14 16:00:46 +00:00			`- IP address (IPv4 and IPv6)`
New README in plain text 2017-08-10 19:49:37 +00:00			`- Kernel version`
			`- Keyboard indicators`
Add keymap to README 2018-05-23 09:50:08 +00:00			`- Keymap`
New README in plain text 2017-08-10 19:49:37 +00:00			`- Load average`
Add network speed functions 2018-05-18 22:31:33 +00:00			`- Network speeds (RX and TX)`
New README in plain text 2017-08-10 19:49:37 +00: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`
Update README 2020-11-30 20:32:14 +00:00			`- Volume percentage`
New README in plain text 2017-08-10 19:49:37 +00:00			`- WiFi signal percentage and ESSID`


			`Requirements`
			`------------`
Add OS-support notice to README 2019-02-16 16:05:04 +00:00			`Currently slstatus works on FreeBSD, Linux and OpenBSD.`
Remove ALSA dependency from README ALSA is not a dependency anymore as we use /dev/mixer. The corresponding notice about PulseAudio is thus not necessary too. 2018-03-26 16:09:30 +00:00			`In order to build slstatus you need the Xlib header files.`
New README in plain text 2017-08-10 19:49:37 +00:00
README: Add note about FreeBSD sndio dep 2022-10-27 22:47:06 +00:00			- For volume percentage on Linux the kernel module `snd-mixer-oss` must be
			`loaded.`
			- For volume percentage on FreeBSD, `sndio` must be installed.
Add comment about mixer oss module to README 2022-10-26 10:57:12 +00:00
New README in plain text 2017-08-10 19:49:37 +00: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 16:10:39 +00:00			`Edit config.mk to match your local setup (slstatus is installed into the`
Add native OpenBSD support for mute/volume Based on functionality in dstat by Joerg Jung. 2019-02-08 14:37:17 +00:00			`/usr/local namespace by default).`
New README in plain text 2017-08-10 19:49:37 +00:00
slstatus != dmenu lol 2017-08-12 11:37:12 +00:00			`Afterwards enter the following command to build and install slstatus (if`
			`necessary as root):`
New README in plain text 2017-08-10 19:49:37 +00: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.`
README: Add Todo 2018-03-18 21:51:51 +00:00

Update README 2020-11-30 20:32:14 +00:00			`Upcoming`
			`--------`
Update README 2022-12-19 01:41:19 +00:00			`A first feature-complete release with official packages for common distributions`
			`will come soon.`