slstatus

Go to file

Laslo Hunhold 42edfea89a Revert component-split this reverts the commits from `92ab9ef52e` up to `d42870d6ca`. 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 19:43:34 +02:00
components	Revert component-split	2018-05-01 19:43:34 +02:00
LICENSE	Revert component-split	2018-05-01 19:43:34 +02:00
Makefile	Revert component-split	2018-05-01 19:43:34 +02:00
README	Revert component-split	2018-05-01 19:43:34 +02:00
arg.h	Remove unnecessary blank lines after license-notice	2017-08-13 23:31:56 +02:00
config.def.h	Remove non-portable functions from config.def.h	2018-04-16 19:09:07 +02:00
config.mk	Revert component-split	2018-05-01 19:43:34 +02:00
slstatus.1	Fix man page .Os field	2017-08-13 23:25:44 +02:00
slstatus.c	Remove program name from error messages	2018-03-28 18:49:27 +02:00
slstatus.h	Rewrite Makefile to accomodate file split	2017-09-17 17:37:49 +02:00
util.c	Format error messages properly	2018-03-28 19:46:27 +02:00
util.h	Added LICENSE statements to all source files	2017-09-17 17:45:03 +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/power/state
- CPU usage
- CPU frequency
- CPU iowait
- 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
- Load average
- 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 (OSS/ALSA)
- WiFi signal percentage and ESSID


Requirements
------------
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). Uncomment OSSLIBS on OpenBSD.

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.


Todo
----
Porting to OpenBSD is the current goal before thinking about a release.

The following functions are not portable at the moment:
- wifi_{perc,essid}
- cpu_{perc,iowait}
- entropy
- swap_{free,perc,total,used}
- battery_{power,state}